Struct Posvol

pub struct Posvol {
    pub dimensions: Dimensions,
    pub cells: Vec<i32>,
}
Expand description

Representation of data in a UKAEA CuV posvol file

The byte layout is very simple. The 6 dimension values in the first block are stored as Dimensions.

<block byte length>
    <resolution i> <resolution j> <resolution k>
    <iints+1> <jints+1> <kints+1>
<block byte length>

The second block contains all cell data in a continuous array, and is stored as a vector of cell values (Vec<i32>).

<block byte length>
    <voxel 0, subvoxel 0> <voxel 0, subvoxel 1>  <voxel 0, subvoxel 2> ...
    <voxel 1, subvoxel 0> <voxel 1, subvoxel 1>  <voxel 1, subvoxel 2> ...
    ... and so on
<block byte length>

Fields§

§dimensions: Dimensions

The dimensions given in the first block of data

§cells: Vec<i32>

List of dominant cells for every subvoxel

Implementations§

§

impl Posvol

pub fn subvoxels(&self) -> Vec<&[i32]>

Vector of subvoxel cell groups

Extremely common to iterate over the voxels in chunks of subvoxel cells.

pub fn number_of_voxels(&self) -> usize

Number of voxels expected in the file

pub fn number_of_subvoxels(&self) -> usize

Number of samples per voxel expected in the file

pub fn number_of_cells(&self) -> usize

Total number of cells expected in the file

Trait Implementations§

§

impl Debug for Posvol

§

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

Formats the value using the given formatter. Read more
§

impl Default for Posvol

§

fn default() -> Posvol

Returns the “default value” for a type. Read more
§

impl Display for Posvol

§

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

Formats the value using the given formatter. Read more
§

impl Serialize for Posvol

§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Posvol

§

impl RefUnwindSafe for Posvol

§

impl Send for Posvol

§

impl Sync for Posvol

§

impl Unpin for Posvol

§

impl UnwindSafe for Posvol

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.