OpenStructure
Public Types | Public Member Functions | Protected Member Functions
ImageStateImpl< T, D > Class Template Reference

#include <image_state_impl.hh>

Inherits ImageStateBase.

Public Types

typedef ImageStateImpl< T, D > StateType
 
typedef boost::shared_ptr< ImageStateImpl< T, D > > SharedPtrType
 

Public Member Functions

 ImageStateImpl ()
 
 ImageStateImpl (const ImageStateImpl< T, D > &s)
 
ImageStateImpl< T, D > & operator= (const ImageStateImpl< T, D > &s)
 
 ImageStateImpl (const Extent &e, const PixelSampling &s)
 
 ImageStateImpl (const Extent &e, const PixelSampling &s, const Vec3 &c)
 
virtual ~ImageStateImpl ()
 
SharedPtrType CloneState (bool cc=true) const
 
virtual ImageStateBasePtr Clone (bool cc=true) const
 
virtual std::size_t MemSize () const
 
virtual DataType GetType () const
 
virtual DataDomain GetDomain () const
 
virtual void SetSpatialOrigin (const Point &o)
 
virtual void CenterSpatialOrigin ()
 
virtual Point GetSpatialOrigin () const
 
virtual Extent GetExtent () const
 
virtual Extent GetLogicalExtent () const
 
virtual Real GetReal (const Point &p) const
 
virtual void SetReal (const Point &p, const Real &r)
 
virtual Complex GetComplex (const Point &p) const
 
virtual void SetComplex (const Point &p, const Complex &c)
 
virtual Real GetIntpolReal (const Vec3 &v) const
 
virtual Real GetIntpolReal (const Vec2 &v) const
 
virtual Real GetIntpolReal (const Real &d) const
 
virtual Complex GetIntpolComplex (const Vec3 &v) const
 
virtual Complex GetIntpolComplex (const Vec2 &v) const
 
virtual Complex GetIntpolComplex (const Real &d) const
 
virtual PixelSamplingGetSampling ()
 
virtual const PixelSamplingGetSampling () const
 
virtual void SetSampling (const PixelSampling &s)
 
virtual Vec3 GetAbsoluteOrigin () const
 
virtual void SetAbsoluteOrigin (const Vec3 &c)
 
virtual Vec3 IndexToCoord (const Point &p) const
 
virtual Vec3 CoordToIndex (const Vec3 &c) const
 
virtual Vec3 FractionalIndexToCoord (const Vec3 &p) const
 
void AdjustPhaseOrigin (const Point &p)
 
T & Value (const Point &p)
 
const T & Value (const Point &p) const
 
GetCheckedValue (const Point &p) const
 
void SetCheckedValue (const Point &p, const T &v)
 
CalcIntpolValue (const Vec3 &v) const
 
CalcIntpolValue (const Vec2 &v) const
 
CalcIntpolValue (const Real &v) const
 
T & Value (const Index &i)
 
const T & Value (const Index &i) const
 
T & Value (std::size_t i)
 
const T & Value (std::size_t i) const
 
ValueHolder< T > & Data ()
 
const ValueHolder< T > & Data () const
 
Size GetSize () const
 
virtual void ApplyIP (ImageStateNonModVisitorBase &v) const
 
virtual void Apply (ImageStateNonModVisitorBase &v) const
 
virtual void ApplyIP (ImageStateModIPVisitorBase &v)
 
virtual void ApplyIP (const ImageStateConstModIPVisitorBase &v)
 
virtual ImageStateBasePtr Apply (ImageStateModIPVisitorBase &v) const
 
virtual ImageStateBasePtr Apply (const ImageStateConstModIPVisitorBase &v) const
 
virtual ImageStateBasePtr Apply (ImageStateModOPVisitorBase &v) const
 
virtual ImageStateBasePtr Apply (const ImageStateConstModOPVisitorBase &v) const
 
virtual ImageStateBasePtr Apply (ImageStateMorphVisitorBase &v)
 
virtual ImageStateBaseoperator+= (Real v)
 
virtual ImageStateBaseoperator+= (const Complex &v)
 
virtual ImageStateBaseoperator-= (Real v)
 
virtual ImageStateBaseoperator-= (const Complex &v)
 
virtual ImageStateBaseoperator*= (Real v)
 
virtual ImageStateBaseoperator*= (const Complex &v)
 
virtual ImageStateBaseoperator/= (Real v)
 
virtual ImageStateBaseoperator/= (const Complex &v)
 
- Public Member Functions inherited from ImageStateBase
virtual ~ImageStateBase ()
 
ImageStateBaseoperator+= (const ImageStateBase &b)
 
ImageStateBaseoperator-= (const ImageStateBase &b)
 
ImageStateBaseoperator*= (const ImageStateBase &b)
 
ImageStateBaseoperator/= (const ImageStateBase &b)
 

Protected Member Functions

template<typename U >
void add_scalar (const U &v)
 
template<typename U >
void mul_scalar (const U &v)
 
- Protected Member Functions inherited from ImageStateBase
 ImageStateBase ()
 
 ImageStateBase (const ImageStateBase &s)
 

Detailed Description

template<typename T, class D>
class ost::img::image_state::ImageStateImpl< T, D >

Definition at line 59 of file image_state_impl.hh.

Member Typedef Documentation

◆ SharedPtrType

typedef boost::shared_ptr<ImageStateImpl<T,D> > SharedPtrType

Definition at line 63 of file image_state_impl.hh.

◆ StateType

typedef ImageStateImpl<T,D> StateType

Definition at line 62 of file image_state_impl.hh.

Constructor & Destructor Documentation

◆ ImageStateImpl() [1/4]

◆ ImageStateImpl() [2/4]

ImageStateImpl ( const ImageStateImpl< T, D > &  s)

◆ ImageStateImpl() [3/4]

ImageStateImpl ( const Extent e,
const PixelSampling s 
)

◆ ImageStateImpl() [4/4]

ImageStateImpl ( const Extent e,
const PixelSampling s,
const Vec3 &  c 
)

◆ ~ImageStateImpl()

virtual ~ImageStateImpl ( )
virtual

Member Function Documentation

◆ add_scalar()

void add_scalar ( const U &  v)
protected

◆ AdjustPhaseOrigin()

void AdjustPhaseOrigin ( const Point p)

◆ Apply() [1/6]

virtual ImageStateBasePtr Apply ( const ImageStateConstModIPVisitorBase v) const
virtual

Implements ImageStateBase.

◆ Apply() [2/6]

virtual ImageStateBasePtr Apply ( const ImageStateConstModOPVisitorBase v) const
virtual

Implements ImageStateBase.

◆ Apply() [3/6]

virtual ImageStateBasePtr Apply ( ImageStateModIPVisitorBase v) const
virtual

Implements ImageStateBase.

◆ Apply() [4/6]

virtual ImageStateBasePtr Apply ( ImageStateModOPVisitorBase v) const
virtual

Implements ImageStateBase.

◆ Apply() [5/6]

virtual ImageStateBasePtr Apply ( ImageStateMorphVisitorBase v)
virtual

Implements ImageStateBase.

◆ Apply() [6/6]

virtual void Apply ( ImageStateNonModVisitorBase v) const
virtual

Implements ImageStateBase.

◆ ApplyIP() [1/3]

virtual void ApplyIP ( const ImageStateConstModIPVisitorBase v)
virtual

Implements ImageStateBase.

◆ ApplyIP() [2/3]

virtual void ApplyIP ( ImageStateModIPVisitorBase v)
virtual

Implements ImageStateBase.

◆ ApplyIP() [3/3]

virtual void ApplyIP ( ImageStateNonModVisitorBase v) const
virtual

Implements ImageStateBase.

◆ CalcIntpolValue() [1/3]

T CalcIntpolValue ( const Real v) const

◆ CalcIntpolValue() [2/3]

T CalcIntpolValue ( const Vec2 &  v) const

◆ CalcIntpolValue() [3/3]

T CalcIntpolValue ( const Vec3 &  v) const

◆ CenterSpatialOrigin()

virtual void CenterSpatialOrigin ( )
virtual

◆ Clone()

virtual ImageStateBasePtr Clone ( bool  cc = true) const
virtual

Implements ImageStateBase.

◆ CloneState()

SharedPtrType CloneState ( bool  cc = true) const

◆ CoordToIndex()

virtual Vec3 CoordToIndex ( const Vec3 &  c) const
virtual

Implements ImageStateBase.

◆ Data() [1/2]

ValueHolder<T>& Data ( )

direct access to value holder

◆ Data() [2/2]

const ValueHolder<T>& Data ( ) const

direct access to value holder

◆ FractionalIndexToCoord()

virtual Vec3 FractionalIndexToCoord ( const Vec3 &  p) const
virtual

Implements ImageStateBase.

◆ GetAbsoluteOrigin()

virtual Vec3 GetAbsoluteOrigin ( ) const
virtual

Implements ImageStateBase.

◆ GetCheckedValue()

T GetCheckedValue ( const Point p) const

retrieve boundary checked value

◆ GetComplex()

virtual Complex GetComplex ( const Point p) const
virtual

Implements ImageStateBase.

◆ GetDomain()

virtual DataDomain GetDomain ( ) const
virtual

Retrieve domain.

Implements ImageStateBase.

◆ GetExtent()

virtual Extent GetExtent ( ) const
virtual

Retrieve Extent.

Given by size, spatial origin and data domain, therefore the extent is a read-only property. The extent that is returned here corresponds to the physical extent, ie for half-frequency data only one half

Implements ImageStateBase.

◆ GetIntpolComplex() [1/3]

virtual Complex GetIntpolComplex ( const Real d) const
virtual

Implements ImageStateBase.

◆ GetIntpolComplex() [2/3]

virtual Complex GetIntpolComplex ( const Vec2 &  v) const
virtual

Implements ImageStateBase.

◆ GetIntpolComplex() [3/3]

virtual Complex GetIntpolComplex ( const Vec3 &  v) const
virtual

Implements ImageStateBase.

◆ GetIntpolReal() [1/3]

virtual Real GetIntpolReal ( const Real d) const
virtual

Implements ImageStateBase.

◆ GetIntpolReal() [2/3]

virtual Real GetIntpolReal ( const Vec2 &  v) const
virtual

Implements ImageStateBase.

◆ GetIntpolReal() [3/3]

virtual Real GetIntpolReal ( const Vec3 &  v) const
virtual

Implements ImageStateBase.

◆ GetLogicalExtent()

virtual Extent GetLogicalExtent ( ) const
virtual

Retrieve logical extent.

For half-frequency data, returns the full, virtual extent. For spatial and frequency domain equivalent to GetExtent().

Implements ImageStateBase.

◆ GetReal()

virtual Real GetReal ( const Point p) const
virtual

retrieve value at Point as Real

This call is potentially slow, but boundary checked

Implements ImageStateBase.

◆ GetSampling() [1/2]

virtual PixelSampling& GetSampling ( )
virtual

Implements ImageStateBase.

◆ GetSampling() [2/2]

virtual const PixelSampling& GetSampling ( ) const
virtual

Implements ImageStateBase.

◆ GetSize()

Size GetSize ( ) const

◆ GetSpatialOrigin()

virtual Point GetSpatialOrigin ( ) const
virtual

Retrieve spatial origin.

Implements ImageStateBase.

◆ GetType()

virtual DataType GetType ( ) const
virtual

Retrieve data type: REAL or COMPLEX.

Implements ImageStateBase.

◆ IndexToCoord()

virtual Vec3 IndexToCoord ( const Point p) const
virtual

Implements ImageStateBase.

◆ MemSize()

virtual std::size_t MemSize ( ) const
virtual

Implements ImageStateBase.

◆ mul_scalar()

void mul_scalar ( const U &  v)
protected

◆ operator*=() [1/2]

virtual ImageStateBase& operator*= ( const Complex v)
virtual

Implements ImageStateBase.

◆ operator*=() [2/2]

virtual ImageStateBase& operator*= ( Real  v)
virtual

Implements ImageStateBase.

◆ operator+=() [1/2]

virtual ImageStateBase& operator+= ( const Complex v)
virtual

Implements ImageStateBase.

◆ operator+=() [2/2]

virtual ImageStateBase& operator+= ( Real  v)
virtual

Implements ImageStateBase.

◆ operator-=() [1/2]

virtual ImageStateBase& operator-= ( const Complex v)
virtual

Implements ImageStateBase.

◆ operator-=() [2/2]

virtual ImageStateBase& operator-= ( Real  v)
virtual

Implements ImageStateBase.

◆ operator/=() [1/2]

virtual ImageStateBase& operator/= ( const Complex v)
virtual

Implements ImageStateBase.

◆ operator/=() [2/2]

virtual ImageStateBase& operator/= ( Real  v)
virtual

Implements ImageStateBase.

◆ operator=()

ImageStateImpl<T,D>& operator= ( const ImageStateImpl< T, D > &  s)

◆ SetAbsoluteOrigin()

virtual void SetAbsoluteOrigin ( const Vec3 &  c)
virtual

Implements ImageStateBase.

◆ SetCheckedValue()

void SetCheckedValue ( const Point p,
const T &  v 
)

set boundary checked value

◆ SetComplex()

virtual void SetComplex ( const Point p,
const Complex c 
)
virtual

set complex value at Point

This call is potentially slow, but boundary checked

Implements ImageStateBase.

◆ SetReal()

virtual void SetReal ( const Point p,
const Real r 
)
virtual

set real value at Point

This call is potentially slow, but boundary checked

Implements ImageStateBase.

◆ SetSampling()

virtual void SetSampling ( const PixelSampling s)
virtual

Implements ImageStateBase.

◆ SetSpatialOrigin()

virtual void SetSpatialOrigin ( const Point o)
virtual

Set spatial origin.

Implements ImageStateBase.

◆ Value() [1/6]

T& Value ( const Index i)

◆ Value() [2/6]

const T& Value ( const Index i) const

◆ Value() [3/6]

T& Value ( const Point p)
inline

Definition at line 145 of file image_state_impl.hh.

◆ Value() [4/6]

const T& Value ( const Point p) const
inline

Definition at line 152 of file image_state_impl.hh.

◆ Value() [5/6]

T& Value ( std::size_t  i)

◆ Value() [6/6]

const T& Value ( std::size_t  i) const

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