Struct GeoTIFFImage 

pub struct GeoTIFFImage<T: Reader> { /* private fields */ }

GeoTIFF Image Container

Description

A Container for a GeoTIFF image

Usage

The methods you have access to:

• GeoTIFFImage::new: Create a new GeoTIFFImage
• GeoTIFFImage::width: Get the image width
• GeoTIFFImage::height: Get the image height
• GeoTIFFImage::tile_width: Get the tile width
• GeoTIFFImage::tile_height: Get the tile height
• GeoTIFFImage::block_width: Get the block width
• GeoTIFFImage::block_height: Get the block height
• GeoTIFFImage::bytes_per_pixel: Calculates the number of bytes for each pixel across all samples.
• GeoTIFFImage::samples_per_pixel: The number of samples per pixel
• GeoTIFFImage::get_sample_format: Returns the sample format
• GeoTIFFImage::get_bits_per_sample: Returns the number of bits per sample
• GeoTIFFImage::raster_array_type: Convert the data format and bits per sample to the appropriate array type
• GeoTIFFImage::get_tie_point: Returns an array of tiepoints.
• GeoTIFFImage::origin: Returns the image origin as a XYZ-vector.
• GeoTIFFImage::origin_ll: Returns the image origin as a XYZ-vector in lon-lat space.
• GeoTIFFImage::resolution: Returns the image resolution as a XYZ-vector.
• GeoTIFFImage::resolution_ll: Returns the image resolution as a XYZ-vector in lon-lat space.
• GeoTIFFImage::pixel_is_area: Returns whether or not the pixels of the image depict an area (or point).
• GeoTIFFImage::get_bbox: Returns the image bounding box as an array of 4 values: min-x, min-y, max-x and max-y.
• GeoTIFFImage::raster_data: Returns the raster data of the image.
• GeoTIFFImage::get_rgba: Returns the RGBA raster data of the image.
• GeoTIFFImage::get_multi_point_vector: Build a vector feature from the image

The methods you probably care about are get_bbox, raster_data, get_rgba, and get_multi_point_vector

Implementations

impl<T: Reader> GeoTIFFImage<T>

pub fn new( reader: Rc<RefCell<T>>, image_directory: ImageDirectory, transformer: Rc<RefCell<Transformer>>, little_endian: bool, ) -> Self

Create a new GeoTIFFImage

pub fn width(&self) -> usize

Get the image width

pub fn height(&self) -> usize

Get the image height

pub fn tile_width(&self) -> usize

Get the tile width

pub fn tile_height(&self) -> usize

Get the tile height

pub fn block_width(&self) -> usize

Get the block width

pub fn block_height(&self, y: usize) -> usize

Get the block height

pub fn bytes_per_pixel(&self) -> usize

Calculates the number of bytes for each pixel across all samples. Only full bytes are supported, an exception is thrown when this is not the case.

Returns

the bytes per pixel

pub fn samples_per_pixel(&self) -> usize

Returns

The number of samples per pixel

pub fn get_sample_format(&self, sample_index: Option<usize>) -> u16

Returns the sample format

Parameters

• sample_index: the sample index to start at

Returns

The sample format code

pub fn get_bits_per_sample(&self, sample_index: Option<usize>) -> u16

Returns the number of bits per sample

Parameters

• sample_index: the sample index to start at

Returns

The number of bits per sample at the sample index

pub fn raster_array_type(&self) -> GTiffDataType

Convert the data format and bits per sample to the appropriate array type

Parameters

• raster: the data

Returns

The array

pub fn get_tie_point(&self) -> GeoTiePoint

Returns an array of tiepoints.

pub fn origin(&self) -> VectorPoint<()>

Returns the image origin as a XYZ-vector. When the image has no affine transformation, then an exception is thrown.

Returns

The origin as a vector

pub fn origin_ll(&self) -> VectorPoint<()>

Returns the image origin as a XYZ-vector in lon-lat space. When the image has no affine transformation, then an exception is thrown.

Returns

The origin as a lon-lat vector

pub fn resolution(&self) -> VectorPoint<()>

Returns the image resolution as a XYZ-vector. When the image has no affine transformation, then an exception is thrown. in cases when the current image does not have the required tags on its own.

Returns

The resolution as a vector

pub fn resolution_ll(&self) -> VectorPoint<()>

Returns the image resolution as a XYZ-vector in lon-lat space. When the image has no affine transformation, then an exception is thrown. in cases when the current image does not have the required tags on its own.

Returns

The resolution as a lon-lat vector

pub fn pixel_is_area(&self) -> bool

Returns whether or not the pixels of the image depict an area (or point).

Returns

Whether the pixels are a point

pub fn get_bbox(&mut self, transform: bool) -> BBox

Returns the image bounding box as an array of 4 values: min-x, min-y, max-x and max-y. When the image has no affine transformation, then an exception is thrown.

Parameters

• transform: apply affine transformation or proj4 transformation

Returns

The bounding box

pub fn raster_data(&mut self, samples: Option<Vec<u16>>) -> Raster

Returns the raster data of the image.

Parameters

• samples: Samples to read from the image

Returns

The raster data

pub fn get_rgba(&mut self) -> Raster

Returns the RGBA raster data of the image.

Returns

The RGBA raster data

pub fn get_multi_point_vector(&mut self) -> GeoTIFFVectorFeature

Build a vector feature from the image

Returns

The vector feature with rgba values incoded into the points

Trait Implementations

impl<T: Clone + Reader> Clone for GeoTIFFImage<T>

fn clone(&self) -> GeoTIFFImage<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Reader> Debug for GeoTIFFImage<T>

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

Formats the value using the given formatter.

impl<T: Default + Reader> Default for GeoTIFFImage<T>

fn default() -> GeoTIFFImage<T>

Returns the “default value” for a type.