Struct openexr::deep::deep_tiled_input_part::DeepTiledInputPart

#[repr(transparent)]
pub struct DeepTiledInputPart<'a> { /* fields omitted */ }

Implementations

impl<'a> DeepTiledInputPart<'a>

pub fn new(
    multi_part_file: &MultiPartInputFile,
    part_number: i32
) -> Result<DeepTiledInputPart<'_>, Error>

Get an interface to the part part_number of the MultiPartInputFile multi_part_file.

pub fn header(&self) -> HeaderRef<'_>

Access to the file Header

pub fn version(&self) -> i32

Access to the file format version

pub fn set_frame_buffer(
    &mut self,
    frame_buffer: &DeepFrameBuffer
) -> Result<(), Error>

Set the current frame buffer – copies the DeepFrameBuffer object into the DeepTiledInputPart object.

The current frame buffer is the destination for the pixel data read from the file. The current frame buffer must be set at least once before read_pixels() is called. The current frame buffer can be changed after each call to read_pixels().

Errors

• Error::InvalidArgument - if the sampling factors do not match or if the frame buffer does not have a sample count slice.

pub fn frame_buffer(&self) -> DeepFrameBufferRef<'_>

Access to the current frame buffer

pub fn is_complete(&self) -> bool

Check if all pixels in the data window are present in the input file

pub fn tile_x_size(&self) -> u32

Get the tiles’ x dimension

pub fn tile_y_size(&self) -> u32

Get the tiles’ y dimension

pub fn level_mode(&self) -> LevelMode

Get the level mode

pub fn level_rounding_mode(&self) -> LevelRoundingMode

Get the level rounding mode

pub fn num_levels(&self) -> Result<i32, Error>

Get the number of levels in the file

Returns

• Ok(1) if level_mode() == LevelMode::OneLevel
• Ok(rfunc (log (max (w, h)) / log (2)) + 1) if level_mode() == LevelMode::MipmapLevels
• Err(Error::Logic) if level_mode() == LevelMode::RipmapLevels

where rfunc is either floor() or ceil() depending on whether level_rounding_mode() is LevelRoundingMode::RoundUp or LevelRoundingMode::RoundDown

pub fn num_x_levels(&self) -> i32

Get the number of levels in the file in the x axis

Returns

• 1 if level_mode() == LevelMode::OneLevel
• rfunc (log (max (w, h)) / log (2)) + 1 if level_mode() == LevelMode::MipmapLevels
• rfunc (log (w) / log (2)) + 1 if level_mode() == LevelMode::RipmapLevels

where rfunc is either floor() or ceil() depending on whether level_rounding_mode() is LevelRoundingMode::RoundUp or LevelRoundingMode::RoundDown

pub fn num_y_levels(&self) -> i32

Get the number of levels in the file in the y axis

Returns

• 1 if level_mode() == LevelMode::OneLevel
• rfunc (log (max (w, h)) / log (2)) + 1 if level_mode()DeepTiledInputPart::mode()] == LevelMode::MipmapLevels
• rfunc (log (h) / log (2)) + 1 if level_mode() == LevelMode::RipmapLevels

where rfunc is either floor() or ceil() depending on whether level_rounding_mode() is LevelRoundingMode::RoundUp or LevelRoundingMode::RoundDown

pub fn is_valid_level(&self, lx: i32, ly: i32) -> bool

Returns true if the file contains a level with level number (lx, ly), false otherwise.

pub fn level_width(&self, lx: i32) -> Result<i32, Error>

Returns the width of the level with level number (lx, *), where * is any number.

Returns

• max (1, rfunc (w / pow (2, lx)))

where rfunc is either floor() or ceil() depending on whether level_rounding_mode() is LevelRoundingMode::RoundUp or LevelRoundingMode::RoundDown

Errors

*Error::Base - If any error occurs

pub fn level_height(&self, ly: i32) -> Result<i32, Error>

Returns the height of the level with level number (*, ly), where * is any number.

Returns

• max (1, rfunc (h / pow (2, ly)))

where rfunc is either floor() or ceil() depending on whether level_rounding_mode() is LevelRoundingMode::RoundUp or LevelRoundingMode::RoundDown

Errors

*Error::Base - If any error occurs

pub fn num_x_tiles(&self, lx: i32) -> Result<i32, Error>

Get the number of tiles in the x axis that cover a level with level number (lx, *) where * is any number

Returns

*(level_width(lx) + tile_x_size() - 1) / tile_x_size()

Errors

*Error::InvalidArgument - If lx is not a valid level

pub fn num_y_tiles(&self, ly: i32) -> Result<i32, Error>

Get the number of tiles in the y axis that cover a level with level number (*, ly) where * is any number

Returns

• (level_height(ly) + tile_y_size() - 1) / tile_y_size()

Errors

*Error::InvalidArgument - If lx is not a valid level

pub fn data_window_for_level<B: Bound2<i32>>(
    &self,
    lx: i32,
    ly: i32
) -> Result<B, Error>

Returns a 2-dimensional region of valid pixel coordinates for a level with level number (lx, ly)

Errors

*Error::Base - if any error occurs

pub fn data_window_for_tile<B: Bound2<i32>>(
    &self,
    dx: i32,
    dy: i32,
    lx: i32,
    ly: i32
) -> Result<B, Error>

Returns a 2-dimensional region of valid pixel coordinates for a level with tile coordinates (dx, dy) and level number (lx, ly)

Errors

• Error::InvalidArgument - if the passed tile coordinates are invalid
• Error::Base - if any other error occurs

pub fn read_tile(
    &mut self,
    dx: i32,
    dy: i32,
    lx: i32,
    ly: i32
) -> Result<(), Error>

Reads the tile with tile coordinates (dx, dy), and level number (lx, ly), and stores it in the current frame buffer.

Errors

• Error::InvalidArgument - if dx does not lie in the interval [0, num_x_tiles(lx)-1]

• Error::InvalidArgument - if dy does not lie in the interval [0, num_y_tiles(ly)-1]

• Error::InvalidArgument -if lx does not lie in the interval [0, num_x_levels()-1]

• Error::InvalidArgument -if ly does not lie in the inverval [0, num_y_levels()-1]

• Error::Io - if there is an error reading data from the file

• Error::Base - if any other error occurs

pub fn read_tiles(
    &mut self,
    dx1: i32,
    dx2: i32,
    dy1: i32,
    dy2: i32,
    lx: i32,
    ly: i32
) -> Result<(), Error>

Reads the sample counts in tile range with coordinates (dx1, dy1), to (dx2, dy2) and level number (lx, ly), and stores it in the current frame buffer.

Errors

• Error::InvalidArgument - if dx does not lie in the interval [0, num_x_tiles(lx)-1]

• Error::InvalidArgument - if dy does not lie in the interval [0, num_y_tiles(ly)-1]

• Error::InvalidArgument -if lx does not lie in the interval [0, num_x_levels()-1]

• Error::InvalidArgument -if ly does not lie in the inverval [0, num_y_levels()-1]

• Error::Io - if there is an error reading data from the file

• Error::Base - if any other error occurs

pub fn read_pixel_sample_count(
    &mut self,
    dx: i32,
    dy: i32,
    lx: i32,
    ly: i32
) -> Result<(), Error>

Reads the tile with tile coordinates (dx, dy), and level number (lx, ly), and stores it in the current frame buffer.

Errors

• Error::InvalidArgument - if dx does not lie in the interval [0, num_x_tiles(lx)-1]

• Error::InvalidArgument - if dy does not lie in the interval [0, num_y_tiles(ly)-1]

• Error::InvalidArgument -if lx does not lie in the interval [0, num_x_levels()-1]

• Error::InvalidArgument -if ly does not lie in the inverval [0, num_y_levels()-1]

• Error::Input - if the file has an unexpected structure

• Error::Base - if any other error occurs

pub fn read_pixel_sample_counts(
    &mut self,
    dx1: i32,
    dx2: i32,
    dy1: i32,
    dy2: i32,
    lx: i32,
    ly: i32
) -> Result<(), Error>

Reads the sample counts in tile range with coordinates (dx1, dy1), to (dx2, dy2) and level number (lx, ly), and stores it in the current frame buffer.

Errors

• Error::InvalidArgument - if dx does not lie in the interval [0, num_x_tiles(lx)-1]

• Error::InvalidArgument - if dy does not lie in the interval [0, num_y_tiles(ly)-1]

• Error::InvalidArgument -if lx does not lie in the interval [0, num_x_levels()-1]

• Error::InvalidArgument -if ly does not lie in the inverval [0, num_y_levels()-1]

• Error::Input - if the file has an unexpected structure

• Error::Base - if any other error occurs