ZstandardCompression (N5 Zstandard 2.0.0 API)

java.lang.Object
- org.janelia.scicomp.n5.zstandard.ZstandardCompression

All Implemented Interfaces:

Serializable, org.janelia.saalfeldlab.n5.codec.CodecInfo, org.janelia.saalfeldlab.n5.codec.DataCodec, org.janelia.saalfeldlab.n5.codec.DataCodecInfo, org.janelia.saalfeldlab.n5.Compression
```
public class ZstandardCompression
extends Object
implements org.janelia.saalfeldlab.n5.Compression
```
Zstandard compression for N5 Implementation wrapper around zstd-jni. See the Zstandard manual for details on parameters.

Author:

mkitti

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.janelia.saalfeldlab.n5.Compression
  org.janelia.saalfeldlab.n5.Compression.CompressionParameter, org.janelia.saalfeldlab.n5.Compression.CompressionType

Field Summary

Fields
Modifier and Type Field and Description

static int ZSTD_CLEVEL_DEFAULT

Fields
Modifier and Type	Field and Description
`static int`	`ZSTD_CLEVEL_DEFAULT`

Constructor Summary

Constructors
Constructor and Description
`ZstandardCompression()` Create ZstandardCompression with level equal to the constant ZSTD_CLEVEL_DEFAULT (value: ) Note that this uses a default compression level of 3 matching the C library.
`ZstandardCompression(int level)` Create ZstandardCompression with the specified compression level.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.janelia.saalfeldlab.n5.readdata.ReadData`	`decode(org.janelia.saalfeldlab.n5.readdata.ReadData readData)`
`org.janelia.saalfeldlab.n5.readdata.ReadData`	`encode(org.janelia.saalfeldlab.n5.readdata.ReadData readData)`
`com.github.luben.zstd.BufferPool`	`getBufferPool()` Get how buffers are recycled
`int`	`getChainLog()` Get the size of the multi-probe search table, as a power of 2 Default: 0
`byte[]`	`getDict()` Get the dictionary for compression as a byte array Default: null (no dictionary)
`int`	`getHashLog()` Set the size of the initial probe table, as a power of 2 Default: 0
`int`	`getJobSize()` Get the size of a compression job.
`int`	`getLevel()`
`int`	`getMinMatch()` Get the minimum size of searched matches Default: 0
`int`	`getNbWorkers()` Get the Number of Worker Threads to spawn Default: 0 (do not spawn any workers)
`int`	`getOverlapLog()` Get the overlap size, as a fraction of window size Default: 0
`int`	`getSearchLog()` Get the number of search attempts, as a power of 2 Default: 0
`int`	`getStrategy()` See ZSTD_strategy enum definition Default: 0
`int`	`getTargetLength()` Impact of this field depends on strategy Default: 0
`int`	`getWindowLog()` Get the maximum allowed back-reference distance, expressed as a power of 2 Default: 0
`boolean`	`isSetCloseFrameOnFlush()` Check if closing the frame on flush is enabled..
`boolean`	`isUseChecksums()` Check if checksums are used for the compressed stream Default: false
`void`	`setBufferPool(com.github.luben.zstd.BufferPool bufferPool)` Configure how buffers are recycled
`void`	`setChainLog(int chainLog)` Set the size of the multi-probe search table, as a power of 2 Default: 0
`void`	`setDict(byte[] dict)` Set the dictionary for compression as a byte array Default: null (no dictionary)
`void`	`setHashLog(int hashLog)` Get the size of the initial probe table, as a power of 2 Default: 0
`void`	`setJobSize(int jobSize)` Set the size of a compression job.
`void`	`setLevel(int level)` Set the compression level The standard compression levels are normally between 1 to 22.
`void`	`setMinMatch(int minMatch)` Set the minimum size of searched matches Default: 0
`void`	`setNbWorkers(int nbWorkers)` Set the Number of Worker Threads to spawn Default: 0 (do not spawn any workers)
`void`	`setOverlapLog(int overlapLog)` Set the overlap size, as a fraction of window size Default: 0
`void`	`setSearchLog(int searchLog)` Set the number of search attempts, as a power of 2 Default: 0
`void`	`setSetCloseFrameOnFlush(boolean setCloseFrameOnFlush)` Enable or disable closing the frame on flush.
`void`	`setStrategy(int strategy)` See ZSTD_strategy enum definition Default: 0
`void`	`setTargetLength(int targetLength)` Impact of setting this field depends on strategy Default: 0
`void`	`setUseChecksums(boolean useChecksums)` Enable or disable checksums for the compressed stream Default: false (disabled)
`void`	`setWindowLog(int windowLog)` Set the maximum allowed back-reference distance, expressed as a power of 2 Default: 0
`void`	`useRecyclingBufferPool(boolean useRecycling)` Configure how buffers are recycled

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.janelia.saalfeldlab.n5.Compression
create, getType

Methods inherited from interface org.janelia.saalfeldlab.n5.codec.DataCodec
concatenate, create

- Field Detail
  - ZSTD_CLEVEL_DEFAULT
```
public static final int ZSTD_CLEVEL_DEFAULT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ZstandardCompression
```
public ZstandardCompression()
```
    Create ZstandardCompression with level equal to the constant ZSTD_CLEVEL_DEFAULT (value: ) Note that this uses a default compression level of 3 matching the C library. Some libraries such as numcodecs use a default compression level of 1.
  - ZstandardCompression
```
public ZstandardCompression(int level)
```
    Create ZstandardCompression with the specified compression level.
    
    Parameters:
    
    level - The standard compression levels are normally between 1 to 22. Negative compression levels offer greater speed. The default value is .
- Method Detail
  - getLevel
```
public int getLevel()
```
  - setLevel
```
public void setLevel(int level)
```
    Set the compression level The standard compression levels are normally between 1 to 22. Negative compression levels offer greater speed.
  - getNbWorkers
```
public int getNbWorkers()
```
    Get the Number of Worker Threads to spawn Default: 0 (do not spawn any workers)
  - setNbWorkers
```
public void setNbWorkers(int nbWorkers)
```
    Set the Number of Worker Threads to spawn Default: 0 (do not spawn any workers)
  - getWindowLog
```
public int getWindowLog()
```
    Get the maximum allowed back-reference distance, expressed as a power of 2 Default: 0
  - setWindowLog
```
public void setWindowLog(int windowLog)
```
    Set the maximum allowed back-reference distance, expressed as a power of 2 Default: 0
  - getHashLog
```
public int getHashLog()
```
    Set the size of the initial probe table, as a power of 2 Default: 0
  - setHashLog
```
public void setHashLog(int hashLog)
```
    Get the size of the initial probe table, as a power of 2 Default: 0
  - getChainLog
```
public int getChainLog()
```
    Get the size of the multi-probe search table, as a power of 2 Default: 0
  - setChainLog
```
public void setChainLog(int chainLog)
```
    Set the size of the multi-probe search table, as a power of 2 Default: 0
  - getSearchLog
```
public int getSearchLog()
```
    Get the number of search attempts, as a power of 2 Default: 0
  - setSearchLog
```
public void setSearchLog(int searchLog)
```
    Set the number of search attempts, as a power of 2 Default: 0
  - getMinMatch
```
public int getMinMatch()
```
    Get the minimum size of searched matches Default: 0
  - setMinMatch
```
public void setMinMatch(int minMatch)
```
    Set the minimum size of searched matches Default: 0
  - getTargetLength
```
public int getTargetLength()
```
    Impact of this field depends on strategy Default: 0
  - setTargetLength
```
public void setTargetLength(int targetLength)
```
    Impact of setting this field depends on strategy Default: 0
  - getStrategy
```
public int getStrategy()
```
    See ZSTD_strategy enum definition Default: 0
  - setStrategy
```
public void setStrategy(int strategy)
```
    See ZSTD_strategy enum definition Default: 0
  - getJobSize
```
public int getJobSize()
```
    Get the size of a compression job. This value is enforced only when nbWorkers >= 1 Default: 0
  - setJobSize
```
public void setJobSize(int jobSize)
```
    Set the size of a compression job. This value is enforced only when nbWorkers >= 1 Default: 0
  - getOverlapLog
```
public int getOverlapLog()
```
    Get the overlap size, as a fraction of window size Default: 0
  - setOverlapLog
```
public void setOverlapLog(int overlapLog)
```
    Set the overlap size, as a fraction of window size Default: 0
  - isUseChecksums
```
public boolean isUseChecksums()
```
    Check if checksums are used for the compressed stream Default: false
  - setUseChecksums
```
public void setUseChecksums(boolean useChecksums)
```
    Enable or disable checksums for the compressed stream Default: false (disabled)
  - isSetCloseFrameOnFlush
```
public boolean isSetCloseFrameOnFlush()
```
    Check if closing the frame on flush is enabled.. Default: false
  - setSetCloseFrameOnFlush
```
public void setSetCloseFrameOnFlush(boolean setCloseFrameOnFlush)
```
    Enable or disable closing the frame on flush. Default: false
  - getDict
```
public byte[] getDict()
```
    Get the dictionary for compression as a byte array Default: null (no dictionary)
  - setDict
```
public void setDict(byte[] dict)
```
    Set the dictionary for compression as a byte array Default: null (no dictionary)
  - getBufferPool
```
public com.github.luben.zstd.BufferPool getBufferPool()
```
    Get how buffers are recycled
  - useRecyclingBufferPool
```
public void useRecyclingBufferPool(boolean useRecycling)
```
    Configure how buffers are recycled
  - setBufferPool
```
public void setBufferPool(com.github.luben.zstd.BufferPool bufferPool)
```
    Configure how buffers are recycled
  - decode
```
public org.janelia.saalfeldlab.n5.readdata.ReadData decode(org.janelia.saalfeldlab.n5.readdata.ReadData readData)
```
    Specified by:
    
    decode in interface org.janelia.saalfeldlab.n5.codec.DataCodec
  - encode
```
public org.janelia.saalfeldlab.n5.readdata.ReadData encode(org.janelia.saalfeldlab.n5.readdata.ReadData readData)
```
    Specified by:
    
    encode in interface org.janelia.saalfeldlab.n5.codec.DataCodec

Class ZstandardCompression

Nested Class Summary

Nested classes/interfaces inherited from interface org.janelia.saalfeldlab.n5.Compression

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.janelia.saalfeldlab.n5.Compression

Methods inherited from interface org.janelia.saalfeldlab.n5.codec.DataCodec

Field Detail

ZSTD_CLEVEL_DEFAULT

Constructor Detail

ZstandardCompression

ZstandardCompression

Method Detail

getLevel

setLevel

getNbWorkers

setNbWorkers

getWindowLog

setWindowLog

getHashLog

setHashLog

getChainLog

setChainLog

getSearchLog

setSearchLog

getMinMatch

setMinMatch

getTargetLength

setTargetLength

getStrategy

setStrategy

getJobSize

setJobSize

getOverlapLog

setOverlapLog

isUseChecksums

setUseChecksums

isSetCloseFrameOnFlush

setSetCloseFrameOnFlush

getDict

setDict

getBufferPool

useRecyclingBufferPool

setBufferPool

decode

encode