Struct GeoTiffFile 

pub struct GeoTiffFile { /* private fields */ }

A GeoTIFF file handle with geospatial metadata.

Implementations

impl GeoTiffFile

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

Open a GeoTIFF file from disk.

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

Open a GeoTIFF file from disk with explicit TIFF decoder options.

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

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

Safety

The caller must guarantee that the mapped file is not mutated or truncated while the returned GeoTiffFile is alive. This includes writes through other file handles and writes from other processes.

pub unsafe fn open_mmap_with_options<P: AsRef<Path>>( path: P, options: GeoTiffOpenOptions, ) -> Result<Self>

Open a GeoTIFF file from disk using memory-mapped I/O with explicit TIFF decoder options.

Safety

The caller must guarantee that the mapped file is not mutated or truncated while the returned GeoTiffFile is alive. This includes writes through other file handles and writes from other processes.

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

Open a GeoTIFF from an owned byte buffer.

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

Open a GeoTIFF from bytes with explicit TIFF decoder options.

pub fn tiff(&self) -> &TiffFile

Returns the underlying TIFF file.

pub fn metadata(&self) -> &GeoMetadata

Returns the parsed GeoTIFF metadata.

pub fn epsg(&self) -> Option<u32>

Returns the EPSG code of the coordinate reference system, if present.

pub fn crs(&self) -> &CrsInfo

Returns the extracted CRS information.

pub fn geokeys(&self) -> &GeoKeyDirectory

Returns the parsed GeoKey directory.

pub fn transform(&self) -> Option<&GeoTransform>

Returns the affine transform, if present.

pub fn geo_bounds(&self) -> Option<[f64; 4]>

Returns the geographic bounds as (min_x, min_y, max_x, max_y).

pub fn pixel_to_geo(&self, col: f64, row: f64) -> Option<(f64, f64)>

Convert a pixel coordinate to map coordinates.

pub fn geo_to_pixel(&self, x: f64, y: f64) -> Option<(f64, f64)>

Convert map coordinates to pixel coordinates.

pub fn width(&self) -> u32

Returns the image width in pixels.

pub fn height(&self) -> u32

Returns the image height in pixels.

pub fn band_count(&self) -> u32

Returns the number of bands.

pub fn nodata(&self) -> Option<&str>

Returns the nodata value, if set.

pub fn overview_count(&self) -> usize

Returns the number of internal overview IFDs.

pub fn overview_ifd_index(&self, overview_index: usize) -> Result<usize>

Returns the top-level TIFF IFD index of the requested overview.

Overviews stored in SubIFDs return Error::OverviewHasNoTopLevelIfdIndex.

pub fn overview_ifd(&self, overview_index: usize) -> Result<&Ifd>

Returns the parsed TIFF IFD metadata for the requested overview.

pub fn base_ifd_index(&self) -> usize

Returns the TIFF IFD index of the base-resolution image.

pub fn read_raster<T: TiffSample>(&self) -> Result<ArrayD<T>>

Decode the base-resolution raster into storage-domain typed samples.

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

Decode a base-resolution pixel window into storage-domain typed samples.

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

Decode one base-resolution storage-domain band into a typed [height, width] ndarray.

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

Decode a base-resolution window from one storage-domain band into a typed [rows, cols] ndarray.

pub fn read_decoded_raster<T: TiffSample>(&self) -> Result<ArrayD<T>>

Decode the base-resolution raster into color-decoded typed pixels.

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

Decode a base-resolution pixel window into color-decoded typed pixels.

pub fn read_raster_samples<T: TiffSample>(&self) -> Result<ArrayD<T>>

Decode the base-resolution raster into storage-domain typed samples.

This is an explicit alias for Self::read_raster.

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

Decode a base-resolution pixel window into storage-domain typed samples.

This is an explicit alias for Self::read_window.

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

Decode an overview raster into storage-domain typed samples.

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

Decode an overview raster into color-decoded typed pixels.

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

Decode an overview raster into storage-domain typed samples.

This is an explicit alias for Self::read_overview.

pub fn read_overview_band<T: TiffSample>( &self, overview_index: usize, band_index: usize, ) -> Result<ArrayD<T>>

Decode one overview storage-domain band into a typed [height, width] ndarray.

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

Decode an overview pixel window into storage-domain typed samples.

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

Decode an overview pixel window into color-decoded typed pixels.

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

Decode an overview pixel window from one storage-domain band into a typed [rows, cols] ndarray.

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

Decode an overview pixel window into storage-domain typed samples.

This is an explicit alias for Self::read_overview_window.