Struct psyche_utils::grid::GridSamplerDistance

pub struct GridSamplerDistance {
    pub center: (Scalar, Scalar),
    pub range: Scalar,
    pub cell_size: (Scalar, Scalar),
}

Grid sampler that uses field distance to center and maximum range - each field is scaled by weight produced from that distance-in-range equation.

Note

Weight component of sampling result equals sum of weights of each sampled fields.

Example

use psyche_utils::grid::{Grid, GridSamplerDistance};

let grid = Grid::new(2, 2, 1.0);
let sampler = GridSamplerDistance::new((0.0, 0.0), 1.0, (1.0, 1.0));
assert_eq!(grid.sample(sampler).unwrap(), (1.0, 1.0));

Fields

center: (Scalar, Scalar)

XY scalar position of sampler center.

range: Scalar

Range of sampling.

cell_size: (Scalar, Scalar)

Scale mapping between grid cell and world cell.

Methods

impl GridSamplerDistance

pub fn new(
    center: (Scalar, Scalar),
    range: Scalar,
    cell_size: (Scalar, Scalar)
) -> Self

Trait Implementations

impl<T> GridSampler<T, f64> for GridSamplerDistance where
    T: GridSampleZeroValue<T> + Add<Output = T> + Clone + Mul<Scalar, Output = T>, 

fn sample(self, grid: &Grid<T>) -> Option<(T, Scalar)>

Sample value and weight from given grid.

impl PartialEq<GridSamplerDistance> for GridSamplerDistance

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Clone for GridSamplerDistance

fn clone(&self) -> GridSamplerDistance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GridSamplerDistance

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

Formats the value using the given formatter.