Skip to main content

SamplingPlane

Struct SamplingPlane 

Source
pub struct SamplingPlane { /* private fields */ }
Expand description

A finite rectangular sampling plane embedded in three-dimensional space.

origin is the corner before the first cell. Columns advance along u and rows advance along v. A cell at (row, column) is sampled at its centre:

origin + (column + 1/2) * extent_u / columns * u + (row + 1/2) * extent_v / rows * v.

Construction validates the orthonormal frame, dimensions, derived cell sizes, and rows * columns before any caller needs to allocate grid storage.

Implementations§

Source§

impl SamplingPlane

Source

pub fn new( origin: Point3M, u_axis: UnitVector3, v_axis: UnitVector3, extent_u: PositiveMetres, extent_v: PositiveMetres, rows: usize, columns: usize, ) -> Result<Self, InterferenceError>

Constructs a checked finite sampling plane.

Source

pub fn origin(self) -> Point3M

Returns the corner before the first cell.

Source

pub fn u_axis(self) -> UnitVector3

Returns the direction in which columns advance.

Source

pub fn v_axis(self) -> UnitVector3

Returns the direction in which rows advance.

Source

pub fn normal(self) -> UnitVector3

Returns the right-handed unit normal u cross v.

Source

pub fn extent_u(self) -> PositiveMetres

Returns the physical u extent.

Source

pub fn extent_v(self) -> PositiveMetres

Returns the physical v extent.

Source

pub fn rows(self) -> usize

Returns the number of rows along v.

Source

pub fn columns(self) -> usize

Returns the number of columns along u.

Source

pub fn cell_count(self) -> usize

Returns the checked product rows * columns.

Source

pub fn cell_size_u_m(self) -> f64

Returns the centre-to-centre spacing along u in metres.

Source

pub fn cell_size_v_m(self) -> f64

Returns the centre-to-centre spacing along v in metres.

Source

pub fn point_at( self, row: usize, column: usize, ) -> Result<Point3M, InterferenceError>

Returns the exact centre defined for one sampling cell.

Trait Implementations§

Source§

impl Clone for SamplingPlane

Source§

fn clone(&self) -> SamplingPlane

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SamplingPlane

Source§

impl Debug for SamplingPlane

Source§

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

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

impl PartialEq for SamplingPlane

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SamplingPlane

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.