Struct DirectionList 

pub struct DirectionList { /* private fields */ }

Wavelength-independent incident propagation directions in sample coordinates.

Unit vectors are the canonical stored and serialized form. Directions must have non-negative z; the on-axis direction is (0, 0, 1).

Implementations

impl DirectionList

pub fn from_unit_vectors(unit_vectors: Vec<[f64; 3]>) -> Result<Self>

Validates and stores already normalized propagation directions.

pub fn from_vectors(vectors: Vec<[f64; 3]>, normalize: bool) -> Result<Self>

Stores propagation vectors, optionally normalizing each input vector.

pub fn from_direction_cosines(values: Vec<[f64; 2]>) -> Result<Self>

Constructs directions from transverse direction cosines (dx, dy).

pub fn from_component_angles_radians(values: Vec<[f64; 2]>) -> Result<Self>

Constructs directions from independent component angles (theta_x, theta_y) in radians.

pub fn from_component_angles_degrees(values: Vec<[f64; 2]>) -> Result<Self>

Constructs directions from independent component angles in degrees.

pub fn from_polar_angles_radians(values: Vec<[f64; 2]>) -> Result<Self>

Constructs directions from polar angle theta and azimuth phi, in radians.

pub fn from_polar_angles_degrees(values: Vec<[f64; 2]>) -> Result<Self>

Constructs directions from polar angle theta and azimuth phi, in degrees.

pub fn source_count(&self) -> usize

Returns the number of directions.

pub fn unit_vectors(&self) -> &[[f64; 3]]

Borrows the canonical propagation unit vectors.

pub fn direction_cosines(&self) -> Vec<[f64; 2]>

Allocates transverse direction cosines (dx, dy).

pub fn component_angles_rad(&self) -> Vec<[f64; 2]>

Allocates independent component angles (asin(dx), asin(dy)) in radians.

pub fn component_angles_deg(&self) -> Vec<[f64; 2]>

Allocates independent component angles in degrees.

pub fn polar_angles_rad(&self) -> Vec<[f64; 2]>

Allocates polar (theta, phi) angles in radians.

pub fn polar_angles_deg(&self) -> Vec<[f64; 2]>

Allocates polar (theta, phi) angles in degrees.

pub fn resolve(&self, optics: &Optics) -> Result<ResolvedSources>

Resolves directions with the illumination wavenumber from optics.

Trait Implementations

impl Clone for DirectionList

fn clone(&self) -> DirectionList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DirectionList

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DirectionList

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DirectionList> for SourceGeometry

fn from(value: DirectionList) -> Self

Converts to this type from the input type.

impl PartialEq for DirectionList

fn eq(&self, other: &DirectionList) -> 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 Serialize for DirectionList

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DirectionList