Struct TiffFile 

pub struct TiffFile { /* private fields */ }

A memory-mapped TIFF file handle.

Implementations

impl TiffFile

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a TIFF file from disk using memory-mapped I/O.

pub fn open_with_options<P: AsRef<Path>>( path: P, options: OpenOptions, ) -> Result<Self>

Open a TIFF file from disk with explicit decoder options.

pub fn from_bytes(data: Vec<u8>) -> Result<Self>

Open a TIFF file from an owned byte buffer (WASM-compatible).

pub fn from_bytes_with_options( data: Vec<u8>, options: OpenOptions, ) -> Result<Self>

Open a TIFF file from bytes with explicit decoder options.

pub fn from_source(source: SharedSource) -> Result<Self>

Open a TIFF file from an arbitrary random-access source.

pub fn from_source_with_options( source: SharedSource, options: OpenOptions, ) -> Result<Self>

Open a TIFF file from an arbitrary random-access source with options.

pub fn byte_order(&self) -> ByteOrder

Returns the byte order of the TIFF file.

pub fn is_bigtiff(&self) -> bool

Returns true if this is a BigTIFF file.

pub fn ifd_count(&self) -> usize

Returns the number of IFDs (images/pages) in the file.

pub fn ifd(&self, index: usize) -> Result<&Ifd>

Returns the IFD at the given index.

pub fn ifds(&self) -> &[Ifd]

Returns all parsed IFDs.

pub fn raw_bytes(&self) -> Option<&[u8]>

Returns the raw file bytes.

pub fn source(&self) -> &dyn TiffSource

Returns the backing source.

pub fn read_image_bytes(&self, ifd_index: usize) -> Result<Vec<u8>>

Decode an image into native-endian interleaved sample bytes.

pub fn read_window_bytes( &self, ifd_index: usize, row_off: usize, col_off: usize, rows: usize, cols: usize, ) -> Result<Vec<u8>>

Decode a pixel window into native-endian interleaved sample bytes.

pub fn read_window<T: TiffSample>( &self, ifd_index: usize, row_off: usize, col_off: usize, rows: usize, cols: usize, ) -> Result<ArrayD<T>>

Decode a window into a typed ndarray.

Single-band rasters are returned as shape [rows, cols]. Multi-band rasters are returned as shape [rows, cols, samples_per_pixel].

pub fn read_image<T: TiffSample>(&self, ifd_index: usize) -> Result<ArrayD<T>>

Decode an image into a typed ndarray.

Single-band rasters are returned as shape [height, width]. Multi-band rasters are returned as shape [height, width, samples_per_pixel].