aimsdata 6.0.0
Neuroimaging data handling
Public Member Functions | Protected Attributes | List of all members
AimsFlip< T > Class Template Reference

The template object function for flipping. More...

#include <aims/utility/flip.h>

Collaboration diagram for AimsFlip< T >:
Collaboration graph
[legend]

Public Member Functions

 AimsFlip ()
 
virtual ~AimsFlip ()
 
carto::VolumeRef< T > doXX (const carto::rc_ptr< carto::Volume< T > > &thing)
 function which returns the XX flipped data
 
carto::VolumeRef< T > doYY (const carto::rc_ptr< carto::Volume< T > > &thing)
 function which returns the YY flipped data
 
carto::VolumeRef< T > doZZ (const carto::rc_ptr< carto::Volume< T > > &thing)
 function which returns the ZZ flipped data
 
carto::VolumeRef< T > doXXZZ (const carto::rc_ptr< carto::Volume< T > > &thing)
 function which returns the XXZZ flipped data
 
carto::VolumeRef< T > doXXYY (const carto::rc_ptr< carto::Volume< T > > &thing)
 function which returns the XXYY flipped data
 
carto::VolumeRef< T > doYYZZ (const carto::rc_ptr< carto::Volume< T > > &thing)
 function which returns the YYZZ flipped data
 
carto::VolumeRef< T > doXXYYZZ (const carto::rc_ptr< carto::Volume< T > > &thing)
 function which returns the XXYYZZ flipped data
 
carto::VolumeRef< T > doXY (const carto::rc_ptr< carto::Volume< T > > &thing)
 function which returns the XY flipped data
 
carto::VolumeRef< T > doXZ (const carto::rc_ptr< carto::Volume< T > > &thing)
 function which returns the XZ flipped data
 
carto::VolumeRef< T > doYZ (const carto::rc_ptr< carto::Volume< T > > &thing)
 function which returns the YZ flipped data
 
carto::VolumeRef< T > flip (const carto::rc_ptr< carto::Volume< T > > &thing, const std::string &orient)
 returns the flipped data in the given orientation
 
bool useSharedView () const
 
void setUseSharedView (bool x)
 
bool updateTransforms () const
 
void setUpdateTransforms (bool x)
 
bool flipMemory () const
 
void setFlipMemory (bool x)
 
std::string centerRefertential () const
 
void setCenterReferential (const std::string &x)
 

Protected Attributes

bool _shared_view
 
bool _update_transforms
 
bool _flip_memory
 
std::string _center_ref
 

Detailed Description

template<class T>
class AimsFlip< T >

The template object function for flipping.

This object function returns the flipped data. The template argument is the basic data type.

Definition at line 50 of file flip.h.

Constructor & Destructor Documentation

◆ AimsFlip()

template<class T>
AimsFlip< T >::AimsFlip ( )
inline

Definition at line 53 of file flip.h.

References _flip_memory, _shared_view, and _update_transforms.

◆ ~AimsFlip()

template<class T>
virtual AimsFlip< T >::~AimsFlip ( )
inlinevirtual

Definition at line 55 of file flip.h.

Member Function Documentation

◆ centerRefertential()

template<class T>
std::string AimsFlip< T >::centerRefertential ( ) const
inline

Definition at line 101 of file flip.h.

References _center_ref.

◆ doXX()

template<class T>
carto::VolumeRef< T > AimsFlip< T >::doXX ( const carto::rc_ptr< carto::Volume< T > > & thing)
inline

function which returns the XX flipped data

Definition at line 250 of file flip.h.

References flip().

◆ doXXYY()

template<class T>
carto::VolumeRef< T > AimsFlip< T >::doXXYY ( const carto::rc_ptr< carto::Volume< T > > & thing)
inline

function which returns the XXYY flipped data

Definition at line 277 of file flip.h.

References flip().

◆ doXXYYZZ()

template<class T>
carto::VolumeRef< T > AimsFlip< T >::doXXYYZZ ( const carto::rc_ptr< carto::Volume< T > > & thing)
inline

function which returns the XXYYZZ flipped data

Definition at line 314 of file flip.h.

References flip().

◆ doXXZZ()

template<class T>
carto::VolumeRef< T > AimsFlip< T >::doXXZZ ( const carto::rc_ptr< carto::Volume< T > > & thing)
inline

function which returns the XXZZ flipped data

Definition at line 271 of file flip.h.

References flip().

◆ doXY()

template<class T>
carto::VolumeRef< T > AimsFlip< T >::doXY ( const carto::rc_ptr< carto::Volume< T > > & thing)
inline

function which returns the XY flipped data

Definition at line 291 of file flip.h.

References flip().

◆ doXZ()

template<class T>
carto::VolumeRef< T > AimsFlip< T >::doXZ ( const carto::rc_ptr< carto::Volume< T > > & thing)
inline

function which returns the XZ flipped data

Definition at line 298 of file flip.h.

References flip().

◆ doYY()

template<class T>
carto::VolumeRef< T > AimsFlip< T >::doYY ( const carto::rc_ptr< carto::Volume< T > > & thing)
inline

function which returns the YY flipped data

Definition at line 257 of file flip.h.

References flip().

◆ doYYZZ()

template<class T>
carto::VolumeRef< T > AimsFlip< T >::doYYZZ ( const carto::rc_ptr< carto::Volume< T > > & thing)
inline

function which returns the YYZZ flipped data

Definition at line 284 of file flip.h.

References flip().

◆ doYZ()

template<class T>
carto::VolumeRef< T > AimsFlip< T >::doYZ ( const carto::rc_ptr< carto::Volume< T > > & thing)
inline

function which returns the YZ flipped data

Definition at line 306 of file flip.h.

References flip().

◆ doZZ()

template<class T>
carto::VolumeRef< T > AimsFlip< T >::doZZ ( const carto::rc_ptr< carto::Volume< T > > & thing)
inline

function which returns the ZZ flipped data

Definition at line 264 of file flip.h.

References flip().

◆ flip()

template<class T>
carto::VolumeRef< T > AimsFlip< T >::flip ( const carto::rc_ptr< carto::Volume< T > > & thing,
const std::string & orient )
inline

returns the flipped data in the given orientation

Orientation conventions are those of the carto::Referential class.

Definition at line 113 of file flip.h.

References _center_ref, _flip_memory, _shared_view, _update_transforms, carto::VolumeRef< typename T >::copyHeaderFrom(), flip(), soma::AffineTransformationBase::getInverse(), carto::PropertySet::getProperty(), carto::PropertySet::hasProperty(), carto::VolumeRef< typename T >::header(), soma::AffineTransformationBase::matrix(), soma::AffineTransformationBase::order(), carto::PropertySet::removeProperty(), carto::rc_ptr< typename T >::reset(), carto::PropertySet::setProperty(), soma::AffineTransformationBase::toVector(), and soma::Transformation::vsub().

Referenced by doXX(), doXXYY(), doXXYYZZ(), doXXZZ(), doXY(), doXZ(), doYY(), doYYZZ(), doYZ(), doZZ(), and flip().

◆ flipMemory()

template<class T>
bool AimsFlip< T >::flipMemory ( ) const
inline

Definition at line 99 of file flip.h.

References _flip_memory.

◆ setCenterReferential()

template<class T>
void AimsFlip< T >::setCenterReferential ( const std::string & x)
inline

Definition at line 102 of file flip.h.

References _center_ref.

◆ setFlipMemory()

template<class T>
void AimsFlip< T >::setFlipMemory ( bool x)
inline

Definition at line 100 of file flip.h.

References _flip_memory.

◆ setUpdateTransforms()

template<class T>
void AimsFlip< T >::setUpdateTransforms ( bool x)
inline

Definition at line 98 of file flip.h.

References _update_transforms.

◆ setUseSharedView()

template<class T>
void AimsFlip< T >::setUseSharedView ( bool x)
inline

Definition at line 96 of file flip.h.

References _shared_view.

◆ updateTransforms()

template<class T>
bool AimsFlip< T >::updateTransforms ( ) const
inline

Definition at line 97 of file flip.h.

References _update_transforms.

◆ useSharedView()

template<class T>
bool AimsFlip< T >::useSharedView ( ) const
inline

Definition at line 95 of file flip.h.

References _shared_view.

Member Data Documentation

◆ _center_ref

template<class T>
std::string AimsFlip< T >::_center_ref
protected

Definition at line 108 of file flip.h.

Referenced by centerRefertential(), flip(), and setCenterReferential().

◆ _flip_memory

template<class T>
bool AimsFlip< T >::_flip_memory
protected

Definition at line 107 of file flip.h.

Referenced by AimsFlip(), flip(), flipMemory(), and setFlipMemory().

◆ _shared_view

template<class T>
bool AimsFlip< T >::_shared_view
protected

Definition at line 105 of file flip.h.

Referenced by AimsFlip(), flip(), setUseSharedView(), and useSharedView().

◆ _update_transforms

template<class T>
bool AimsFlip< T >::_update_transforms
protected

Definition at line 106 of file flip.h.

Referenced by AimsFlip(), flip(), setUpdateTransforms(), and updateTransforms().

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