Public Member Functions | Protected Attributes | List of all members
hanalysis::_stafield< T > Class Template Reference

represents spherical tensor fields More...

#include <stafield.h>

Inheritance diagram for hanalysis::_stafield< T >:
hanalysis::stafield< T > hanalysis::stafieldGPU< T >

Public Member Functions

bool operator== (const _stafield &field) const
 
bool operator!= (const _stafield &field) const
 
const std::size_t * getShape () const
 
bool ownMemory () const
 
int getRank () const
 

Protected Attributes

std::size_t shape [3]
 image shape
 
hanalysis::STA_FIELD_STORAGE field_storage
 must be either STA_FIELD_STORAGE_C, STA_FIELD_STORAGE_R or STA_FIELD_STORAGE_RF
 
hanalysis::STA_FIELD_TYPE field_type
 must be either STA_OFIELD_SINGLE, STA_OFIELD_FULL, STA_OFIELD_EVEN or STA_OFIELD_ODD
 
int L
 tensor rank $ \mathbf{stafield} \in \mathcal T_{L}$
 

Detailed Description

template<typename T>
class hanalysis::_stafield< T >

represents spherical tensor fields

Member Function Documentation

template<typename T >
int hanalysis::_stafield< T >::getRank ( ) const
inline
Returns
$ L \in \mathbb N $, the tensor rank
template<typename T >
const std::size_t* hanalysis::_stafield< T >::getShape ( ) const
inline
Returns
constant pointer to the objects shape structure
template<typename T >
bool hanalysis::_stafield< T >::operator!= ( const _stafield< T > &  field) const
inline

returns false if shape, field_storage, field_type and tensor rank L are equal, else false

template<typename T >
bool hanalysis::_stafield< T >::operator== ( const _stafield< T > &  field) const
inline

returns true if shape, field_storage, field_type and tensor rank L are equal, else false

template<typename T >
bool hanalysis::_stafield< T >::ownMemory ( ) const
inline
Returns
true if objects has allocated its own memory, else false

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