Struct CellSize 

pub struct CellSize { /* private fields */ }

Cell dimensions of a regular grid.

Both x and y are in the same linear units as the elevation values (typically meters). For geographic DEMs whose native units are degrees, convert to meters first or use approximate meter-equivalent values.

Examples

use terrand::CellSize;

// 30-meter SRTM grid
let cs = CellSize::square(30.0).unwrap();
assert_eq!(cs.x(), 30.0);
assert_eq!(cs.y(), 30.0);

// Non-square pixels
let cs = CellSize::new(25.0, 30.0).unwrap();

Implementations

impl CellSize

pub fn new(x: f64, y: f64) -> Result<Self>

Create a cell size with independent x and y dimensions.

Both dimensions must be positive and finite.

Errors

Returns Error::InvalidCellSize if either dimension is zero, negative, NaN, or infinite.

pub fn square(size: f64) -> Result<Self>

Create a square cell size where x and y are equal.

The dimension must be positive and finite.

Errors

Returns Error::InvalidCellSize if size is zero, negative, NaN, or infinite.

pub fn x(&self) -> f64

Cell width in the x (column) direction.

pub fn y(&self) -> f64

Cell height in the y (row) direction.

Trait Implementations

impl Clone for CellSize

fn clone(&self) -> CellSize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CellSize

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

Formats the value using the given formatter.

impl PartialEq for CellSize

fn eq(&self, other: &CellSize) -> bool

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

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

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

impl Copy for CellSize

impl StructuralPartialEq for CellSize