Package ome.codecs
Class CodecOptions
java.lang.Object
ome.codecs.CodecOptions
- Direct Known Subclasses:
HuffmanCodecOptions,JPEG2000CodecOptions,MJPBCodecOptions
Options for compressing and decompressing data.
-
Field Summary
FieldsModifier and TypeFieldDescriptionintNumber of bits per channel.intNumber of channels.Color model to use when constructing an image (WRITE).booleanWhether or not use chroma subsampling.intHeight, in pixels, of the image.booleanIndicates whether or not channels are interleaved.booleanIndicates endianness of pixel data.booleanUsed with codecs allowing lossy and lossless compression.intIf compressing, this is the maximum number of raw bytes to compress.byte[]Pixels for preceding image (READ/WRITE).doubleCompression quality level as it would be provided to:ImageWriteParam.compressionQuality(WRITE).booleanIndicates whether or not the pixel data is signed.intHorizontal offset of the tile grid as it would be provided to:ImageWriteParam.setTiling(int, int, int, int)(WRITE).intVertical offset of the tile grid as it would be provided to:ImageWriteParam.setTiling(int, int, int, int)(WRITE).intTile height as it would be provided to:ImageWriteParam.setTiling(int, int, int, int)(WRITE).intTile width as it would be provided to:ImageWriteParam.setTiling(int, int, int, int)(WRITE).intWidth, in pixels, of the image.booleanWhether or not the decompressed data will be stored as YCbCr. -
Constructor Summary
ConstructorsConstructorDescriptionConstruct a new CodecOptions.CodecOptions(CodecOptions options) Construct a new CodecOptions using the given CodecOptions. -
Method Summary
Modifier and TypeMethodDescriptionstatic CodecOptionsReturn CodecOptions with reasonable default values.
-
Field Details
-
width
public int widthWidth, in pixels, of the image. (READ/WRITE) -
height
public int heightHeight, in pixels, of the image. (READ/WRITE) -
channels
public int channelsNumber of channels. (READ/WRITE) -
bitsPerSample
public int bitsPerSampleNumber of bits per channel. (READ/WRITE) -
littleEndian
public boolean littleEndianIndicates endianness of pixel data. (READ/WRITE) -
interleaved
public boolean interleavedIndicates whether or not channels are interleaved. (READ/WRITE) -
signed
public boolean signedIndicates whether or not the pixel data is signed. (READ/WRITE) -
tileWidth
public int tileWidthTile width as it would be provided to:ImageWriteParam.setTiling(int, int, int, int)(WRITE). -
tileHeight
public int tileHeightTile height as it would be provided to:ImageWriteParam.setTiling(int, int, int, int)(WRITE). -
tileGridXOffset
public int tileGridXOffsetHorizontal offset of the tile grid as it would be provided to:ImageWriteParam.setTiling(int, int, int, int)(WRITE). -
tileGridYOffset
public int tileGridYOffsetVertical offset of the tile grid as it would be provided to:ImageWriteParam.setTiling(int, int, int, int)(WRITE). -
maxBytes
public int maxBytesIf compressing, this is the maximum number of raw bytes to compress. If decompressing, this is the maximum number of raw bytes to return. (READ/WRITE). -
previousImage
public byte[] previousImagePixels for preceding image (READ/WRITE). -
lossless
public boolean losslessUsed with codecs allowing lossy and lossless compression. Default is set to true (WRITE). -
colorModel
Color model to use when constructing an image (WRITE). -
quality
public double qualityCompression quality level as it would be provided to:ImageWriteParam.compressionQuality(WRITE). -
ycbcr
public boolean ycbcrWhether or not the decompressed data will be stored as YCbCr. -
disableChromaSubsampling
public boolean disableChromaSubsamplingWhether or not use chroma subsampling.
-
-
Constructor Details
-
CodecOptions
public CodecOptions()Construct a new CodecOptions. -
CodecOptions
Construct a new CodecOptions using the given CodecOptions.
-
-
Method Details
-
getDefaultOptions
Return CodecOptions with reasonable default values.
-