Struct VoxelTallyGrid 

pub struct VoxelTallyGrid { /* private fields */ }

The regular grid a VoxelTally bins on: dims voxels of edge spacing_m starting at origin_m. Voxel (i, j, k) has the flat index i + nx (j + ny k) (x fastest, as in VoxelGrid).

Implementations

impl VoxelTallyGrid

pub fn new( origin_m: [f64; 3], spacing_m: [f64; 3], dims: [usize; 3], ) -> Result<Self, VoxelTallyError>

A grid of dims voxels of edge lengths spacing_m whose lowest corner is origin_m. Every dimension must be nonzero, every spacing finite and positive, the origin finite, and the voxel count must fit in u64.

pub fn from_voxel_grid(grid: &VoxelGrid) -> Self

The grid of the voxels of grid (origin at the corner of the front face), so a tally voxel is a target voxel.

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

Lowest corner [x, y, z], m.

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

Voxel edge lengths [hx, hy, hz], m.

pub fn dims(&self) -> [usize; 3]

Voxels per axis [nx, ny, nz].

pub fn n_voxels(&self) -> u64

Total number of voxels nx ny nz.

pub fn locate(&self, pos: [f64; 3]) -> Option<[usize; 3]>

The voxel [i, j, k] containing pos, or None outside the grid (or for a non-finite position). Voxels are half-open, so a point on an interior face belongs to the voxel with the higher index and a point on the far end of the grid is outside.

pub fn flat_index(&self, ijk: [usize; 3]) -> u64

Flat index i + nx (j + ny k) of voxel ijk.

pub fn unflatten(&self, flat: u64) -> [usize; 3]

The voxel [i, j, k] of flat index flat (the inverse of Self::flat_index).

pub fn corner_m(&self, ijk: [usize; 3]) -> [f64; 3]

Lowest corner of voxel ijk, m.

pub fn center_m(&self, ijk: [usize; 3]) -> [f64; 3]

Centre of voxel ijk, m.

Trait Implementations

impl Clone for VoxelTallyGrid

fn clone(&self) -> VoxelTallyGrid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VoxelTallyGrid

impl Debug for VoxelTallyGrid

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VoxelTallyGrid

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VoxelTallyGrid

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for VoxelTallyGrid

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 VoxelTallyGrid