Struct ChunkOpts 

pub struct ChunkOpts {

    pub byte_order: ByteOrder,
    pub image_width: u32,
    pub image_height: u32,
    pub bits_per_sample: u8,
    pub samples: u16,
    pub sample_format: SampleFormat,
    pub photometric_interpretation: PhotometricInterpretation,
    pub compression_method: CompressionMethod,
    pub predictor: Predictor,
    pub jpeg_tables: Option<Arc<Vec<u8>>>,
    pub planar_config: PlanarConfiguration,
    pub chunk_type: ChunkType,
    pub strip_decoder: Option<StripDecodeState>,
    pub tile_attributes: Option<TileAttributes>,
}

Struct that holds all relevant metadata that is needed to decode a chunk (strip or tile). this does not include chunkoffsets or -bytes, since those may be partial and then mutated. once we implement partial tags

Fields

byte_order: ByteOrder

tiff byte order

image_width: u32

width of the image in pixels

image_height: u32

height of the image in pixels

bits_per_sample: u8

bits per sample

samples: u16

samples per pixel

sample_format: SampleFormat

datatype of samples

photometric_interpretation: PhotometricInterpretation

photometric interpretation

compression_method: CompressionMethod

compression method

supported decoding:

• LZW
• ModernJPEG
• Deflate
• `PackBits``

predictor: Predictor

horizontal predictor type

Allows for more efficient compression

jpeg_tables: Option<Arc<Vec<u8>>>

Jpeg tables

In case of ModernJPEG compression, the compression infomation can be in this tag, where it is prepended to chunks before decoding. still an Arc, because we want to do error sharing.

planar_config: PlanarConfiguration

Planar configuration:

example: RGB

• Chunky: [RGBRGBRGB]
• Planar: [RRR] [GGG] [BBB]

chunk_type: ChunkType

Chunk type

Either Strip or Tile Strip => Some(StripDecoder) && None Tile => None && Some(TileAttributes)

strip_decoder: Option<StripDecodeState>

tile_attributes: Option<TileAttributes>

Implementations

impl ChunkOpts

pub fn samples_per_pixel(&self) -> usize

Samples per pixel within chunk.

In planar config, samples are stored in separate strips/chunks, also called bands.

Example with bits_per_sample = [8, 8, 8] and PhotometricInterpretation::RGB:

• PlanarConfiguration::Chunky -> 3 (RGBRGBRGB…)
• PlanarConfiguration::Planar -> 1 (RRR…) (GGG…) (BBB…)

pub fn output_row_stride(&self, chunk_index: u32) -> TiffResult<usize>

The length of a chunk row in bytes, taking padding into account.

pub fn chunk_dimensions(&self) -> TiffResult<(u32, u32)>

dimensions of a chunk, not taking padding into account.

Can be directly deduced from ChunkType and corresponding data

pub fn chunk_data_dimensions(&self, chunk_index: u32) -> TiffResult<(u32, u32)>

return the dimensions of an expanded chunk, taking into account padding at the bottom and right side of the file.

pub fn colortype(&self) -> TiffResult<ColorType>

Derive colortype from info

TODO: fix:

• RGB++
• TransparencyMask
• CIELab

Trait Implementations

impl Clone for ChunkOpts

fn clone(&self) -> ChunkOpts

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChunkOpts

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ChunkOpts

fn eq(&self, other: &ChunkOpts) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ChunkOpts