Struct NDArrayInfo 

pub struct NDArrayInfo {

    pub total_bytes: usize,
    pub bytes_per_element: usize,
    pub num_elements: usize,
    pub x_size: usize,
    pub y_size: usize,
    pub color_size: usize,
    pub x_dim: usize,
    pub y_dim: usize,
    pub color_dim: usize,
    pub x_stride: usize,
    pub y_stride: usize,
    pub color_stride: usize,
    pub color_mode: NDColorMode,
}

Computed info about an NDArray’s layout (matching C++ NDArrayInfo_t).

Fields

total_bytes: usize

bytes_per_element: usize

num_elements: usize

x_size: usize

y_size: usize

color_size: usize

x_dim: usize

Which dimension index is X.

y_dim: usize

Which dimension index is Y.

color_dim: usize

Which dimension index is color (0 if mono).

x_stride: usize

Elements between successive X values.

y_stride: usize

Elements between successive Y values.

color_stride: usize

Elements between successive color values.

color_mode: NDColorMode

Resolved color mode.

Implementations

impl NDArrayInfo

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

C++ userDims = {xDim, yDim, colorDim} (NDPluginROI.cpp:80-82, NDPluginTransform.cpp:492-494): the map from a logical image axis (0 = X, 1 = Y, 2 = color) to the physical NDArray::dims slot that carries it.

Any plugin whose user-facing Dim0/Dim1/Dim2 mean X/Y/color must reach dims through this map and never with the logical index itself: the two only coincide for Mono/Bayer/YUV and RGB3 layouts. For RGB1 the array is [color, x, y], so the X axis lives in dims[1] — indexing dims[0] for “Dim0” hands back the color axis.

Trait Implementations

impl Clone for NDArrayInfo

fn clone(&self) -> NDArrayInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NDArrayInfo

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

Formats the value using the given formatter.