cartodata  4.5.0
carto::VolumeRef< T > Class Template Reference

Convenient handle for a Volume - this is normally the entry point for all volumes handling. More...

#include <cartodata/io/volumeformatreader.h>

Inheritance diagram for carto::VolumeRef< T >:
Collaboration diagram for carto::VolumeRef< T >:

Public Types

typedef T datatype
 
typedef Volume< T >::Position4Di Position4Di
 
typedef Volume< T >::iterator iterator
 
typedef Volume< T >::const_iterator const_iterator
 
- Public Types inherited from carto::rc_ptr< Volume< T > >
typedef Volume< T > referenced_type
 
- Public Types inherited from carto::const_ref< T >
typedef T referenced_type
 

Public Member Functions

 VolumeRef ()
 
 VolumeRef (Volume< T > *x)
 
 VolumeRef (const rc_ptr< Volume< T > > &x)
 
virtual ~VolumeRef ()
 
Volume< T > & operator* ()
 
const Volume< T > & operator* () const
 
 VolumeRef (int sizeX, int sizeY=1, int sizeZ=1, int sizeT=1, const AllocatorContext &allocatorContext=AllocatorContext(), bool allocated=true)
 
 VolumeRef (const Position4Di &size, const AllocatorContext &allocatorContext=AllocatorContext(), bool allocated=true)
 
 VolumeRef (int sizeX, int sizeY, int sizeZ, int sizeT, int bordersize, const AllocatorContext &allocatorContext=AllocatorContext(), bool allocated=true)
 
 VolumeRef (const Position4Di &size, int bordersize, const AllocatorContext &allocatorContext=AllocatorContext(), bool allocated=true)
 
 VolumeRef (int sizeX, int sizeY, int sizeZ, int sizeT, const Position4Di &border, const AllocatorContext &allocatorContext=AllocatorContext(), bool allocated=true)
 
 VolumeRef (const Position4Di &size, const Position4Di &border, const AllocatorContext &allocatorContext=AllocatorContext(), bool allocated=true)
 
 VolumeRef (rc_ptr< Volume< T > > other, const Position4Di &pos, const Position4Di &size=Position4Di(-1,-1,-1,-1), const AllocatorContext &allocContext=AllocatorContext())
 
std::vector< int > getSize () const
 
int getSizeX () const
 
int getSizeY () const
 
int getSizeZ () const
 
int getSizeT () const
 
const PropertySetheader () const
 
PropertySetheader ()
 
const PropertySetgetPropertySet () const __attribute__((__deprecated__("use header() instead")))
 
PropertySetgetPropertySet () __attribute__((__deprecated__("use header() instead")))
 
std::vector< float > getVoxelSize () const
 
virtual void copyHeaderFrom (const PropertySet &other)
 
virtual void copyHeaderFrom (const Object &other)
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
const T & operator() (long x, long y=0, long z=0, long t=0) const
 
T & operator() (long x, long y=0, long z=0, long t=0)
 
const T & at (long x, long y=0, long z=0, long t=0) const
 
T & at (long x, long y=0, long z=0, long t=0)
 
const T & operator() (const Position4Di &position) const
 
T & operator() (const Position4Di &position)
 
const T & at (const Position4Di &position) const
 
T & at (const Position4Di &position)
 
virtual void initialize ()
 
const AllocatorContext & allocatorContext () const
 
void allocate ()
 
virtual void reallocate (int sizeX=1, int sizeY=1, int sizeZ=1, int sizeT=1, bool keepcontents=false, const AllocatorContext &allocatorContext=AllocatorContext(), bool allocate=true)
 
VolumeRef< T > copy () const
 
template<typename OUTP >
VolumeRef< OUTP > copy () const
 
VolumeRef< T > deepcopy () const
 
template<typename OUTP >
VolumeRef< OUTP > deepcopy () const
 
VolumeRef< T > copyStructure () const
 
template<typename OUTP >
VolumeRef< OUTP > copyStructure () const
 
template<typename OUTP >
 operator VolumeRef< OUTP > () const
 
rc_ptr< Volume< T > > refVolume () const
 
void setRefVolume (const rc_ptr< Volume< T > > &refvol)
 
const Position4Di posInRefVolume () const
 
void setPosInRefVolume (const Position4Di &pos)
 
std::vector< int > getBorders () const
 
std::vector< size_t > getStrides () const
 
bool all () const
 True if all values compare to true. More...
 
bool any () const
 True if at least one value compares to true. More...
 
min () const
 
max () const
 
sum () const
 
template<typename OUTP >
OUTP sum () const
 
void fill (const T &value)
 Fills the volume with a given value. More...
 
VolumeRef< T > & operator= (const T &value)
 
VolumeRef< T > view (const Position4Di &pos, const Position4Di &size)
 
const VolumeRef< T > view (const Position4Di &pos, const Position4Di &size) const
 
- Public Member Functions inherited from carto::rc_ptr< Volume< T > >
 rc_ptr ()
 
 rc_ptr (Volume< T > *p)
 
 rc_ptr (Volume< T > *p, bool externalowner)
 
void reset (Volume< T > *p=NULL)
 
Volume< T > * get () const
 
bool operator< (const rc_ptr< Volume< T > > &other) const
 
 operator insipid * () const
 
 ref ()
 
 ref (Volume< T > *pObject)
 
 ref (Volume< T > *pObject, bool externalowner)
 
 ref (const ref< Volume< T > > &other)
 
 ref (const ref< R > &other)
 
 ~ref ()
 
Volume< T > * release ()
 
ref< Volume< T > > & operator= (const ref< Volume< T > > &other)
 
Volume< T > * operator-> () const
 
Volume< T > & operator* () const
 
Volume< T > * pointer () const
 
- Public Member Functions inherited from carto::const_ref< T >
 const_ref ()
 
 const_ref (const T *pObject)
 
 const_ref (const T *pObject, bool externalowner)
 
 const_ref (const ref< T > &other)
 
 const_ref (const const_ref< T > &other)
 
 const_ref (const ref< R > &o)
 
 const_ref (const const_ref< R > &other)
 
 ~const_ref ()
 
const_ref< T > & operator= (const ref< T > &other)
 
const_ref< T > & operator= (const const_ref< T > &other)
 
bool isNull () const
 
bool operator== (const ref< T > &other) const
 
bool operator== (const T *pointer) const
 
bool operator== (const const_ref< T > &other) const
 
bool operator!= (const ref< T > &other) const
 
bool operator!= (const const_ref< T > &other) const
 
bool operator!= (const T *pointer) const
 
const T * operator-> () const
 
const T & operator* () const
 
const T * pointer () const
 
int refCount () const
 
int count () const
 

Detailed Description

template<typename T>
class carto::VolumeRef< T >

Convenient handle for a Volume - this is normally the entry point for all volumes handling.

See Volume for more documentation

Definition at line 51 of file volumeformatreader.h.

Member Typedef Documentation

template<typename T>
typedef Volume<T>::const_iterator carto::VolumeRef< T >::const_iterator

Definition at line 95 of file volumeref.h.

template<typename T>
typedef T carto::VolumeRef< T >::datatype

Definition at line 85 of file volumeref.h.

template<typename T>
typedef Volume<T>::iterator carto::VolumeRef< T >::iterator

Definition at line 94 of file volumeref.h.

template<typename T>
typedef Volume<T>::Position4Di carto::VolumeRef< T >::Position4Di

Definition at line 93 of file volumeref.h.

Constructor & Destructor Documentation

template<typename T >
carto::VolumeRef< T >::VolumeRef ( )

Definition at line 47 of file volumeref_d_inline.h.

template<typename T >
carto::VolumeRef< T >::VolumeRef ( Volume< T > *  x)

Definition at line 52 of file volumeref_d_inline.h.

template<typename T >
carto::VolumeRef< T >::VolumeRef ( const rc_ptr< Volume< T > > &  x)

Definition at line 57 of file volumeref_d_inline.h.

template<typename T >
carto::VolumeRef< T >::~VolumeRef ( )
virtual

Definition at line 62 of file volumeref_d_inline.h.

template<typename T >
carto::VolumeRef< T >::VolumeRef ( int  sizeX,
int  sizeY = 1,
int  sizeZ = 1,
int  sizeT = 1,
const AllocatorContext &  allocatorContext = AllocatorContext(),
bool  allocated = true 
)
explicit

Definition at line 71 of file volumeref_d_inline.h.

template<typename T >
carto::VolumeRef< T >::VolumeRef ( const Position4Di size,
const AllocatorContext &  allocatorContext = AllocatorContext(),
bool  allocated = true 
)
explicit

Definition at line 79 of file volumeref_d_inline.h.

template<typename T >
carto::VolumeRef< T >::VolumeRef ( int  sizeX,
int  sizeY,
int  sizeZ,
int  sizeT,
int  bordersize,
const AllocatorContext &  allocatorContext = AllocatorContext(),
bool  allocated = true 
)
explicit

Definition at line 86 of file volumeref_d_inline.h.

template<typename T >
carto::VolumeRef< T >::VolumeRef ( const Position4Di size,
int  bordersize,
const AllocatorContext &  allocatorContext = AllocatorContext(),
bool  allocated = true 
)
explicit

Definition at line 95 of file volumeref_d_inline.h.

template<typename T >
carto::VolumeRef< T >::VolumeRef ( int  sizeX,
int  sizeY,
int  sizeZ,
int  sizeT,
const Position4Di border,
const AllocatorContext &  allocatorContext = AllocatorContext(),
bool  allocated = true 
)
explicit

Definition at line 102 of file volumeref_d_inline.h.

template<typename T >
carto::VolumeRef< T >::VolumeRef ( const Position4Di size,
const Position4Di border,
const AllocatorContext &  allocatorContext = AllocatorContext(),
bool  allocated = true 
)
explicit

Definition at line 111 of file volumeref_d_inline.h.

template<typename T >
carto::VolumeRef< T >::VolumeRef ( rc_ptr< Volume< T > >  other,
const Position4Di pos,
const Position4Di size = Position4Di( -1, -1, -1, -1 ),
const AllocatorContext &  allocContext = AllocatorContext() 
)
explicit

Definition at line 119 of file volumeref_d_inline.h.

Member Function Documentation

template<typename T >
bool carto::VolumeRef< T >::all ( ) const
inline

True if all values compare to true.

Definition at line 54 of file volumeref_d_operators.h.

template<typename T >
void carto::VolumeRef< T >::allocate ( )
inline

Definition at line 308 of file volumeref_d_inline.h.

template<typename T >
const AllocatorContext & carto::VolumeRef< T >::allocatorContext ( ) const
inline

Definition at line 301 of file volumeref_d_inline.h.

template<typename T >
bool carto::VolumeRef< T >::any ( ) const
inline

True if at least one value compares to true.

Definition at line 61 of file volumeref_d_operators.h.

template<typename T >
const T & carto::VolumeRef< T >::at ( long  x,
long  y = 0,
long  z = 0,
long  t = 0 
) const
inline
template<typename T >
T & carto::VolumeRef< T >::at ( long  x,
long  y = 0,
long  z = 0,
long  t = 0 
)
inline

Definition at line 256 of file volumeref_d_inline.h.

template<typename T >
const T & carto::VolumeRef< T >::at ( const Position4Di position) const
inline

Definition at line 277 of file volumeref_d_inline.h.

template<typename T >
T & carto::VolumeRef< T >::at ( const Position4Di position)
inline

Definition at line 284 of file volumeref_d_inline.h.

template<typename T >
VolumeRef< T >::iterator carto::VolumeRef< T >::begin ( )
inline

Definition at line 204 of file volumeref_d_inline.h.

template<typename T >
VolumeRef< T >::const_iterator carto::VolumeRef< T >::begin ( ) const
inline

Definition at line 218 of file volumeref_d_inline.h.

template<typename T >
VolumeRef< OUTP > carto::VolumeRef< T >::copy ( ) const
inline

Definition at line 131 of file volumeref_d_operators.h.

template<typename T>
template<typename OUTP >
VolumeRef<OUTP> carto::VolumeRef< T >::copy ( ) const
template<typename T >
void carto::VolumeRef< T >::copyHeaderFrom ( const PropertySet other)
inlinevirtual

Definition at line 384 of file volumeref_d_inline.h.

template<typename T >
void carto::VolumeRef< T >::copyHeaderFrom ( const Object other)
virtual

Definition at line 65 of file volumeref_d.h.

template<typename T >
VolumeRef< OUTP > carto::VolumeRef< T >::copyStructure ( ) const
inline

Definition at line 161 of file volumeref_d_operators.h.

template<typename T>
template<typename OUTP >
VolumeRef<OUTP> carto::VolumeRef< T >::copyStructure ( ) const
template<typename T >
VolumeRef< OUTP > carto::VolumeRef< T >::deepcopy ( ) const
inline

Definition at line 146 of file volumeref_d_operators.h.

template<typename T>
template<typename OUTP >
VolumeRef<OUTP> carto::VolumeRef< T >::deepcopy ( ) const
template<typename T >
VolumeRef< T >::iterator carto::VolumeRef< T >::end ( )
inline

Definition at line 211 of file volumeref_d_inline.h.

template<typename T >
VolumeRef< T >::const_iterator carto::VolumeRef< T >::end ( ) const
inline

Definition at line 225 of file volumeref_d_inline.h.

template<typename T >
void carto::VolumeRef< T >::fill ( const T &  value)
inline

Fills the volume with a given value.

Definition at line 111 of file volumeref_d_operators.h.

template<typename T >
std::vector< int > carto::VolumeRef< T >::getBorders ( ) const
inline

Definition at line 370 of file volumeref_d_inline.h.

template<typename T >
const PropertySet & carto::VolumeRef< T >::getPropertySet ( ) const
inline

Definition at line 180 of file volumeref_d_inline.h.

template<typename T >
PropertySet & carto::VolumeRef< T >::getPropertySet ( )
inline

Definition at line 187 of file volumeref_d_inline.h.

template<typename T >
std::vector< int > carto::VolumeRef< T >::getSize ( ) const
inline

Definition at line 131 of file volumeref_d_inline.h.

template<typename T >
int carto::VolumeRef< T >::getSizeT ( ) const
inline
template<typename T >
int carto::VolumeRef< T >::getSizeX ( ) const
inline
template<typename T >
int carto::VolumeRef< T >::getSizeY ( ) const
inline
template<typename T >
int carto::VolumeRef< T >::getSizeZ ( ) const
inline
template<typename T >
std::vector< size_t > carto::VolumeRef< T >::getStrides ( ) const
inline

Definition at line 377 of file volumeref_d_inline.h.

template<typename T >
std::vector< float > carto::VolumeRef< T >::getVoxelSize ( ) const
inline

Definition at line 194 of file volumeref_d_inline.h.

template<typename T >
const PropertySet & carto::VolumeRef< T >::header ( ) const
inline
template<typename T >
PropertySet & carto::VolumeRef< T >::header ( )
inline

Definition at line 173 of file volumeref_d_inline.h.

template<typename T >
void carto::VolumeRef< T >::initialize ( )
inlinevirtual

Definition at line 294 of file volumeref_d_inline.h.

template<typename T >
T carto::VolumeRef< T >::max ( ) const
inline

Definition at line 84 of file volumeref_d_operators.h.

template<typename T >
T carto::VolumeRef< T >::min ( ) const
inline

Definition at line 77 of file volumeref_d_operators.h.

template<typename T >
template<typename OUTP >
carto::VolumeRef< T >::operator VolumeRef< OUTP > ( ) const
inline

Definition at line 177 of file volumeref_d_operators.h.

template<typename T >
const T & carto::VolumeRef< T >::operator() ( long  x,
long  y = 0,
long  z = 0,
long  t = 0 
) const
inline

Definition at line 235 of file volumeref_d_inline.h.

template<typename T >
T & carto::VolumeRef< T >::operator() ( long  x,
long  y = 0,
long  z = 0,
long  t = 0 
)
inline

Definition at line 242 of file volumeref_d_inline.h.

template<typename T >
const T & carto::VolumeRef< T >::operator() ( const Position4Di position) const
inline

Definition at line 263 of file volumeref_d_inline.h.

template<typename T >
T & carto::VolumeRef< T >::operator() ( const Position4Di position)
inline

Definition at line 270 of file volumeref_d_inline.h.

template<typename T>
Volume<T>& carto::VolumeRef< T >::operator* ( )
inline

Definition at line 72 of file volumeref.h.

template<typename T>
const Volume<T>& carto::VolumeRef< T >::operator* ( ) const
inline

Definition at line 77 of file volumeref.h.

template<typename T >
VolumeRef< T > & carto::VolumeRef< T >::operator= ( const T &  value)
inline

Definition at line 118 of file volumeref_d_operators.h.

template<typename T >
const VolumeRef< T >::Position4Di carto::VolumeRef< T >::posInRefVolume ( ) const
inline

Definition at line 356 of file volumeref_d_inline.h.

template<typename T >
void carto::VolumeRef< T >::reallocate ( int  sizeX = 1,
int  sizeY = 1,
int  sizeZ = 1,
int  sizeT = 1,
bool  keepcontents = false,
const AllocatorContext &  allocatorContext = AllocatorContext(),
bool  allocate = true 
)
inlinevirtual

Definition at line 315 of file volumeref_d_inline.h.

template<typename T >
rc_ptr< Volume< T > > carto::VolumeRef< T >::refVolume ( ) const
inline

Definition at line 342 of file volumeref_d_inline.h.

template<typename T >
void carto::VolumeRef< T >::setPosInRefVolume ( const Position4Di pos)
inline

Definition at line 363 of file volumeref_d_inline.h.

template<typename T >
void carto::VolumeRef< T >::setRefVolume ( const rc_ptr< Volume< T > > &  refvol)
inline

Definition at line 349 of file volumeref_d_inline.h.

template<typename T >
OUTP carto::VolumeRef< T >::sum ( ) const
inline

Definition at line 91 of file volumeref_d_operators.h.

template<typename T>
template<typename OUTP >
OUTP carto::VolumeRef< T >::sum ( ) const
template<typename T >
VolumeRef< T > carto::VolumeRef< T >::view ( const Position4Di pos,
const Position4Di size 
)
inline

Definition at line 397 of file volumeref_d_inline.h.

template<typename T >
const VolumeRef< T > carto::VolumeRef< T >::view ( const Position4Di pos,
const Position4Di size 
) const
inline

Definition at line 404 of file volumeref_d_inline.h.


The documentation for this class was generated from the following files: