GeoTIFFReader

Struct GeoTIFFReader 

Source
pub struct GeoTIFFReader<T: Reader> {
    pub header: GeoTIFFHeaderReader,
    /* private fields */
}
Expand description

§GeoTIFF Reader

§Description

This class reads a GeoTIFF file and returns a list of GeoTIFF images.

Implements the FeatureReader trait

§Usage

The methods you have access to:

§File Reader

use gistools::{
    parsers::{FeatureReader, FileReader},
    readers::{GeoTIFFReader, GeoTIFFOptions},
};
use std::path::PathBuf;

let mut path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
path.push("tests/readers/geotiff/fixtures/ycbcr.tif");
let geotiff = GeoTIFFReader::new(FileReader::from(path), None);

{
    // you can pull in the image directly
    let mut image = geotiff.get_image(None).unwrap();
    // read the raster data as any data format
    let raster = image.raster_data(None);
    // or read in the RGB data as RGBA u8 linear encoded
    let rgb = image.get_rgba();
}

// Or you can just pull in the all the grids
let grids: Vec<_> = geotiff.iter().collect();
assert_eq!(grids.len(), 1);

§Buffer Reader

use gistools::{
    parsers::{FeatureReader, BufferReader},
    readers::{GeoTIFFReader, GeoTIFFOptions},
};

// Ignore this, used to setup example
use std::path::PathBuf;
let mut path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
path.push("tests/readers/geotiff/fixtures/ycbcr.tif");
let bytes: Vec<u8> = std::fs::read(path).unwrap();

// read in the data and build the grid
let geotiff = GeoTIFFReader::new(BufferReader::from(bytes), None);
let grid: Vec<_> = geotiff.iter().collect();
assert_eq!(grid.len(), 1);

Fields§

§header: GeoTIFFHeaderReader

The GeoTIFF header

Implementations§

Source§

impl<T: Reader> GeoTIFFReader<T>

Source

pub fn new(reader: T, options: Option<GeoTIFFOptions>) -> GeoTIFFReader<T>

Create a new GeoTIFFReader

Source

pub fn is_empty(&self) -> bool

Check if the reader is empty

Source

pub fn len(&self) -> usize

Get the length of internal subfiles

Source

pub fn get_image(&self, index: Option<usize>) -> Option<GeoTIFFImage<T>>

Get the nth internal subfile of an image. By default, the first is returned.

§Parameters
  • index: the index of the image to get [Default=0]
§Returns

The image at the given index

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn default() -> GeoTIFFReader<T>

Returns the “default value” for a type. Read more
Source§

impl<T: Reader> FeatureReader<GeoTIFFMetadata, Map<String, ValueType>, RGBA> for GeoTIFFReader<T>

A feature reader trait with a callback-based approach

Source§

type FeatureIterator<'a> = GeoTIFFIterator<'a, T> where T: 'a

The Feature Reader should implement an iterator of some kind
Source§

fn iter(&self) -> Self::FeatureIterator<'_>

All readers have an iter function that returns a Iterator struct
Source§

fn par_iter( &self, pool_size: usize, thread_id: usize, ) -> Self::FeatureIterator<'_>

All readers have a par_iter function that returns a ParallelIterator struct
Source§

impl<T: PartialEq + Reader> PartialEq for GeoTIFFReader<T>

Source§

fn eq(&self, other: &GeoTIFFReader<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: Reader> StructuralPartialEq for GeoTIFFReader<T>

Auto Trait Implementations§

§

impl<T> Freeze for GeoTIFFReader<T>

§

impl<T> !RefUnwindSafe for GeoTIFFReader<T>

§

impl<T> !Send for GeoTIFFReader<T>

§

impl<T> !Sync for GeoTIFFReader<T>

§

impl<T> Unpin for GeoTIFFReader<T>

§

impl<T> !UnwindSafe for GeoTIFFReader<T>

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V