Array3d Class Reference

#include <DataAnalysis/DataStructures/array3d.h>

Inheritance diagram for Array3d:

Public Member Functions
	~Array3d () override=default
virtual qint64	cacheKey () const =0
Array3d *	clone () const override=0
virtual unsigned	dimension (unsigned i) const =0
virtual bool	empty () const =0
virtual QVector3D	getCellSpacing () const
virtual QVector3D	getOrigin () const
virtual void	setCellSpacing (const QVector3D &size)
virtual void	setOrigin (const QVector3D &origin)
virtual unsigned	size () const =0
Public Member Functions inherited from Clonable
virtual	~Clonable ()=default
virtual Clonable *	clone () const =0

Detailed Description

Base interface for accessing a data matrix, irrespective of its implementation.

Constructor & Destructor Documentation

~Array3d()

~Array3d ( )

overridedefault

Member Function Documentation

cacheKey()

virtual qint64 cacheKey ( ) const

pure virtual

Implemented in Array3dNullTyped< T >, Array3dNull, Array3dTypedAdaptor< ContainerType, T, Reader, Writer, DeepCopier >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dTyped, double >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dData< CSIRO::Rendering::WSGLSparseOctree::Cell >, QRgb >, Array3dTypedAdaptor< Array3dScalar, QRgb, ImageReader, ImageWriter >, and NdTo3dAdaptor.

clone()

Array3d * clone ( ) const

overridepure virtual

Returns

A clone of this object.

Note

Subclasses would normally return their own type rather than the Clonable type. The C++ language rules allow a more derived type to be returned from a virtual function and the compiler will still treat it as a valid override.

Implements Clonable.

Implemented in Array3dNullTyped< T >, Array3dNull, Array3dTypedAdaptor< ContainerType, T, Reader, Writer, DeepCopier >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dTyped, double >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dData< CSIRO::Rendering::WSGLSparseOctree::Cell >, QRgb >, Array3dTypedAdaptor< Array3dScalar, QRgb, ImageReader, ImageWriter >, NdTo3dAdaptor, Array3dTyped< T >, Array3dTyped< double >, and Array3dTyped< QRgb >.

dimension()

virtual unsigned dimension ( unsigned  i ) const

pure virtual

Implemented in Array3dNull, Array3dTypedAdaptor< ContainerType, T, Reader, Writer, DeepCopier >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dTyped, double >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dData< CSIRO::Rendering::WSGLSparseOctree::Cell >, QRgb >, Array3dTypedAdaptor< Array3dScalar, QRgb, ImageReader, ImageWriter >, NdTo3dAdaptor, and Array3dNullTyped< T >.

empty()

virtual bool empty ( ) const

pure virtual

Implemented in Array3dNullTyped< T >, Array3dNull, Array3dTypedAdaptor< ContainerType, T, Reader, Writer, DeepCopier >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dTyped, double >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dData< CSIRO::Rendering::WSGLSparseOctree::Cell >, QRgb >, Array3dTypedAdaptor< Array3dScalar, QRgb, ImageReader, ImageWriter >, and NdTo3dAdaptor.

getCellSpacing()

QVector3D getCellSpacing ( ) const

virtual

Returns

The spacing between voxels in the dataset in each dimension; i.e., the distance from the centre of each voxel to the centre of the next voxel.

Reimplemented in Array3dTypedAdaptor< ContainerType, T, Reader, Writer, DeepCopier >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dTyped, double >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dData< CSIRO::Rendering::WSGLSparseOctree::Cell >, QRgb >, and Array3dTypedAdaptor< Array3dScalar, QRgb, ImageReader, ImageWriter >.

getOrigin()

QVector3D getOrigin ( ) const

virtual

The origin of the Array in world coordinates. This is useful if the array is not offset. Default value is [0,0,0].

Reimplemented in Array3dTypedAdaptor< ContainerType, T, Reader, Writer, DeepCopier >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dTyped, double >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dData< CSIRO::Rendering::WSGLSparseOctree::Cell >, QRgb >, and Array3dTypedAdaptor< Array3dScalar, QRgb, ImageReader, ImageWriter >.

setCellSpacing()

void setCellSpacing ( const QVector3D &  size )

virtual

Sets the cell spacing: the distance from the centre of one voxel to the centre of the next voxel in each dimension.

Reimplemented in Array3dTypedAdaptor< ContainerType, T, Reader, Writer, DeepCopier >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dTyped, double >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dData< CSIRO::Rendering::WSGLSparseOctree::Cell >, QRgb >, and Array3dTypedAdaptor< Array3dScalar, QRgb, ImageReader, ImageWriter >.

setOrigin()

void setOrigin ( const QVector3D &  origin )

virtual

Parameters

origin

The desired origin of the array in world coordinates. Default value is [0,0,0].

Useful alongside setCellSpacing to define the extent of the array's data in world coordinates. This is needed for some algorithms where the shape of each voxel and its location needs to be known prior to execution.

Reimplemented in Array3dTypedAdaptor< ContainerType, T, Reader, Writer, DeepCopier >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dTyped, double >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dData< CSIRO::Rendering::WSGLSparseOctree::Cell >, QRgb >, and Array3dTypedAdaptor< Array3dScalar, QRgb, ImageReader, ImageWriter >.

size()

virtual unsigned size ( ) const

pure virtual

Implemented in Array3dNullTyped< T >, Array3dNull, Array3dTypedAdaptor< ContainerType, T, Reader, Writer, DeepCopier >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dTyped, double >, Array3dTypedAdaptor< CSIRO::DataAnalysis::Array3dData< CSIRO::Rendering::WSGLSparseOctree::Cell >, QRgb >, Array3dTypedAdaptor< Array3dScalar, QRgb, ImageReader, ImageWriter >, and NdTo3dAdaptor.