Struct n5::DatasetAttributes

pub struct DatasetAttributes { /* fields omitted */ }

Attributes of a tensor dataset.

Implementations

impl DatasetAttributes

pub fn coord_iter(&self) -> impl Iterator<Item = Vec<u64>> + ExactSizeIterator

pub fn bounded_coord_iter(
    &self,
    bbox: &BoundingBox
) -> impl Iterator<Item = Vec<u64>> + ExactSizeIterator

pub fn get_bounds(&self) -> BoundingBox

pub fn get_block_bounds(&self, coord: &GridCoord) -> BoundingBox

impl DatasetAttributes

pub fn new(
    dimensions: GridCoord,
    block_size: BlockCoord,
    data_type: DataType,
    compression: CompressionType
) -> DatasetAttributes

pub fn get_dimensions(&self) -> &[u64]

pub fn get_block_size(&self) -> &[u32]

pub fn get_data_type(&self) -> &DataType

pub fn get_compression(&self) -> &CompressionType

pub fn get_ndim(&self) -> usize

pub fn get_num_elements(&self) -> usize

Get the total number of elements possible given the dimensions.

pub fn get_block_num_elements(&self) -> usize

Get the total number of elements possible in a block.

pub fn get_grid_extent(&self) -> GridCoord

Get the upper bound extent of grid coordinates.

pub fn get_num_blocks(&self) -> u64

Get the total number of blocks.

use n5::prelude::*;
use n5::smallvec::smallvec;
let attrs = DatasetAttributes::new(
    smallvec![50, 40, 30],
    smallvec![11, 10, 10],
    DataType::UINT8,
    n5::compression::CompressionType::default(),
);
assert_eq!(attrs.get_num_blocks(), 60);

pub fn in_bounds(&self, grid_position: &GridCoord) -> bool

Check whether a block grid position is in the bounds of this dataset.

use n5::prelude::*;
use n5::smallvec::smallvec;
let attrs = DatasetAttributes::new(
    smallvec![50, 40, 30],
    smallvec![11, 10, 10],
    DataType::UINT8,
    n5::compression::CompressionType::default(),
);
assert!(attrs.in_bounds(&smallvec![4, 3, 2]));
assert!(!attrs.in_bounds(&smallvec![5, 3, 2]));

Trait Implementations

impl Clone for DatasetAttributes

fn clone(&self) -> DatasetAttributes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DatasetAttributes

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DatasetAttributes

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<DatasetAttributes> for DatasetAttributes

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for DatasetAttributes

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 DatasetAttributes