pub struct ImageFileDirectory { /* private fields */ }Expand description
An ImageFileDirectory representing Image content
Implementations§
Source§impl ImageFileDirectory
impl ImageFileDirectory
Create a new ImageFileDirectory from tag data
Sourcepub fn new_subfile_type(&self) -> Option<u32>
pub fn new_subfile_type(&self) -> Option<u32>
A general indication of the kind of data contained in this subfile. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/newsubfiletype.html
Sourcepub fn image_width(&self) -> u32
pub fn image_width(&self) -> u32
The number of columns in the image, i.e., the number of pixels per row. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/imagewidth.html
Sourcepub fn image_height(&self) -> u32
pub fn image_height(&self) -> u32
The number of rows of pixels in the image. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/imagelength.html
Sourcepub fn bits_per_sample(&self) -> &[u16]
pub fn bits_per_sample(&self) -> &[u16]
Number of bits per component. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/bitspersample.html
Sourcepub fn compression(&self) -> Compression
pub fn compression(&self) -> Compression
Compression scheme used on the image data. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/compression.html
Sourcepub fn photometric_interpretation(&self) -> PhotometricInterpretation
pub fn photometric_interpretation(&self) -> PhotometricInterpretation
The color space of the image data. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/photometricinterpretation.html
Sourcepub fn document_name(&self) -> Option<&str>
pub fn document_name(&self) -> Option<&str>
Document name.
Sourcepub fn image_description(&self) -> Option<&str>
pub fn image_description(&self) -> Option<&str>
A string that describes the subject of the image. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/imagedescription.html
Sourcepub fn strip_offsets(&self) -> Option<&[u64]>
pub fn strip_offsets(&self) -> Option<&[u64]>
For each strip, the byte offset of that strip. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/stripoffsets.html
Sourcepub fn orientation(&self) -> Option<u16>
pub fn orientation(&self) -> Option<u16>
The orientation of the image with respect to the rows and columns. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/orientation.html
Sourcepub fn samples_per_pixel(&self) -> u16
pub fn samples_per_pixel(&self) -> u16
The number of components per pixel.
SamplesPerPixel is usually 1 for bilevel, grayscale, and palette-color images. SamplesPerPixel is usually 3 for RGB images. If this value is higher, ExtraSamples should give an indication of the meaning of the additional channels.
Sourcepub fn rows_per_strip(&self) -> Option<u32>
pub fn rows_per_strip(&self) -> Option<u32>
The number of rows per strip. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/rowsperstrip.html
Sourcepub fn strip_byte_counts(&self) -> Option<&[u64]>
pub fn strip_byte_counts(&self) -> Option<&[u64]>
For each strip, the number of bytes in the strip after compression. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/stripbytecounts.html
Sourcepub fn min_sample_value(&self) -> Option<&[u16]>
pub fn min_sample_value(&self) -> Option<&[u16]>
The minimum component value used. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/minsamplevalue.html
Sourcepub fn max_sample_value(&self) -> Option<&[u16]>
pub fn max_sample_value(&self) -> Option<&[u16]>
The maximum component value used. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/maxsamplevalue.html
Sourcepub fn x_resolution(&self) -> Option<f64>
pub fn x_resolution(&self) -> Option<f64>
The number of pixels per ResolutionUnit in the ImageWidth direction. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/xresolution.html
Sourcepub fn y_resolution(&self) -> Option<f64>
pub fn y_resolution(&self) -> Option<f64>
The number of pixels per ResolutionUnit in the ImageLength direction. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/yresolution.html
Sourcepub fn planar_configuration(&self) -> PlanarConfiguration
pub fn planar_configuration(&self) -> PlanarConfiguration
How the components of each pixel are stored.
The specification defines these values:
- Chunky format. The component values for each pixel are stored contiguously. For example, for RGB data, the data is stored as RGBRGBRGB
- Planar format. The components are stored in separate component planes. For example, RGB data is stored with the Red components in one component plane, the Green in another, and the Blue in another.
The specification adds a warning that PlanarConfiguration=2 is not in widespread use and that Baseline TIFF readers are not required to support it.
If SamplesPerPixel is 1, PlanarConfiguration is irrelevant, and need not be included.
Sourcepub fn resolution_unit(&self) -> Option<ResolutionUnit>
pub fn resolution_unit(&self) -> Option<ResolutionUnit>
The unit of measurement for XResolution and YResolution. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/resolutionunit.html
Sourcepub fn software(&self) -> Option<&str>
pub fn software(&self) -> Option<&str>
Name and version number of the software package(s) used to create the image. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/software.html
Sourcepub fn date_time(&self) -> Option<&str>
pub fn date_time(&self) -> Option<&str>
Date and time of image creation.
The format is: “YYYY:MM:DD HH:MM:SS”, with hours like those on a 24-hour clock, and one space character between the date and the time. The length of the string, including the terminating NUL, is 20 bytes.
Sourcepub fn artist(&self) -> Option<&str>
pub fn artist(&self) -> Option<&str>
Person who created the image. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/artist.html
Sourcepub fn host_computer(&self) -> Option<&str>
pub fn host_computer(&self) -> Option<&str>
The computer and/or operating system in use at the time of image creation. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/hostcomputer.html
Sourcepub fn predictor(&self) -> Option<Predictor>
pub fn predictor(&self) -> Option<Predictor>
A mathematical operator that is applied to the image data before an encoding scheme is applied. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/predictor.html
Sourcepub fn tile_width(&self) -> Option<u32>
pub fn tile_width(&self) -> Option<u32>
The tile width in pixels. This is the number of columns in each tile. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/tilewidth.html
Sourcepub fn tile_height(&self) -> Option<u32>
pub fn tile_height(&self) -> Option<u32>
The tile length (height) in pixels. This is the number of rows in each tile. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/tilelength.html
Sourcepub fn tile_offsets(&self) -> Option<&[u64]>
pub fn tile_offsets(&self) -> Option<&[u64]>
For each tile, the byte offset of that tile, as compressed and stored on disk. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/tileoffsets.html
Sourcepub fn tile_byte_counts(&self) -> Option<&[u64]>
pub fn tile_byte_counts(&self) -> Option<&[u64]>
For each tile, the number of (compressed) bytes in that tile. https://web.archive.org/web/20240329145339/https://www.awaresystems.be/imaging/tiff/tifftags/tilebytecounts.html
Sourcepub fn extra_samples(&self) -> Option<&[ExtraSamples]>
pub fn extra_samples(&self) -> Option<&[ExtraSamples]>
Description of extra components. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/extrasamples.html
Sourcepub fn sample_format(&self) -> &[SampleFormat]
pub fn sample_format(&self) -> &[SampleFormat]
Specifies how to interpret each data sample in a pixel. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/sampleformat.html
Sourcepub fn jpeg_tables(&self) -> Option<&[u8]>
pub fn jpeg_tables(&self) -> Option<&[u8]>
JPEG quantization and/or Huffman tables. https://web.archive.org/web/20240329145250/https://www.awaresystems.be/imaging/tiff/tifftags/jpegtables.html
Sourcepub fn geo_key_directory(&self) -> Option<&GeoKeyDirectory>
pub fn geo_key_directory(&self) -> Option<&GeoKeyDirectory>
Sourcepub fn model_pixel_scale(&self) -> Option<&[f64]>
pub fn model_pixel_scale(&self) -> Option<&[f64]>
Used in interchangeable GeoTIFF files. https://web.archive.org/web/20240329145238/https://www.awaresystems.be/imaging/tiff/tifftags/modelpixelscaletag.html
Sourcepub fn model_tiepoint(&self) -> Option<&[f64]>
pub fn model_tiepoint(&self) -> Option<&[f64]>
Used in interchangeable GeoTIFF files. https://web.archive.org/web/20240329145303/https://www.awaresystems.be/imaging/tiff/tifftags/modeltiepointtag.html
Sourcepub fn model_transformation(&self) -> Option<&[f64]>
pub fn model_transformation(&self) -> Option<&[f64]>
Stores a full 4×4 affine transformation matrix that maps pixel/line coordinates directly into model (map) coordinates.
Sourcepub fn gdal_nodata(&self) -> Option<&str>
pub fn gdal_nodata(&self) -> Option<&str>
GDAL NoData value https://gdal.org/en/stable/drivers/raster/gtiff.html#nodata-value
Sourcepub fn gdal_metadata(&self) -> Option<&str>
pub fn gdal_metadata(&self) -> Option<&str>
GDAL Metadata XML information
Non standard metadata items are grouped together into a XML string stored in the non
standard TIFFTAG_GDAL_METADATA ASCII tag (code 42112).
Tags for which this crate doesn’t have a hard-coded enum variant.
Sourcepub fn lerc_parameters(&self) -> Option<&[u32]>
pub fn lerc_parameters(&self) -> Option<&[u32]>
LERC parameters, used in LERC-compressed TIFFs.
Sourcepub fn colormap(&self) -> Option<&Arc<[u16]>>
pub fn colormap(&self) -> Option<&Arc<[u16]>>
A color map for palette color images.
This field defines a Red-Green-Blue color map (often called a lookup table) for palette-color images. In a palette-color image, a pixel value is used to index into an RGB lookup table. For example, a palette-color pixel having a value of 0 would be displayed according to the 0th Red, Green, Blue triplet.
In a TIFF ColorMap, all the Red values come first, followed by the Green values, then the
Blue values. The number of values for each color is 2**BitsPerSample. Therefore, the
ColorMap field for an 8-bit palette-color image would have 3 * 256 values. The width of
each value is 16 bits, as implied by the type of SHORT. 0 represents the minimum intensity,
and 65535 represents the maximum intensity. Black is represented by 0,0,0, and white by
65535, 65535, 65535.
ColorMap must be included in all palette-color images.
Sourcepub fn tile_byte_range(&self, x: usize, y: usize) -> Option<TileByteRange>
pub fn tile_byte_range(&self, x: usize, y: usize) -> Option<TileByteRange>
Find the byte range(s) for the tile located at x column and y row.
Sourcepub fn tiles_byte_ranges(
&self,
xy: &[(usize, usize)],
) -> Option<TilesByteRanges>
pub fn tiles_byte_ranges( &self, xy: &[(usize, usize)], ) -> Option<TilesByteRanges>
Find the byte ranges for the tiles located at x column and y row.
Sourcepub async fn fetch_tile(
&self,
x: usize,
y: usize,
reader: &dyn AsyncFileReader,
) -> AsyncTiffResult<Tile>
pub async fn fetch_tile( &self, x: usize, y: usize, reader: &dyn AsyncFileReader, ) -> AsyncTiffResult<Tile>
Fetch the tile located at x column and y row using the provided reader.
For planar configuration TIFFs, this automatically fetches all bands for the tile at position (x, y) and combines them into a single Tile.
Sourcepub async fn fetch_tiles(
&self,
xy: &[(usize, usize)],
reader: &dyn AsyncFileReader,
) -> AsyncTiffResult<Vec<Tile>>
pub async fn fetch_tiles( &self, xy: &[(usize, usize)], reader: &dyn AsyncFileReader, ) -> AsyncTiffResult<Vec<Tile>>
Fetch the tiles located at x column and y row using the provided reader.
Sourcepub fn tile_count(&self) -> Option<(usize, usize)>
pub fn tile_count(&self) -> Option<(usize, usize)>
Return the number of x/y tiles in the IFD
Returns None if this is not a tiled TIFF
Trait Implementations§
Source§impl Clone for ImageFileDirectory
impl Clone for ImageFileDirectory
Source§fn clone(&self) -> ImageFileDirectory
fn clone(&self) -> ImageFileDirectory
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more