ConstImageHandle Class Reference

#include <image_handle.hh>

Inherits ConstData.

Public Member Functions
	operator const Data & () const
	ConstImageHandle ()
	ConstImageHandle (const ConstImageHandle &h)
	ConstImageHandle (const ImageHandle &h)
ConstImageHandle &	operator= (const ConstImageHandle &h)
ConstImageHandle &	operator= (const ImageHandle &h)
Vec3	GetAbsoluteOrigin () const
Vec3	IndexToCoord (const Point &p) const
Vec3	CoordToIndex (const Vec3 &c) const
Vec3	FractionalIndexToCoord (const Vec3 &p) const
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
const ImageStateBasePtr &	ImageStatePtr () const
ImageHandle	Copy (bool cc=true) const
ImageHandle	Extract (const Extent &e) const
bool	IsValid () const
long	MemSize () const
Properties interface
DataType	GetType () const
DataDomain	GetDomain () const
Extent	GetExtent () const
Point	GetSpatialOrigin () const
Value access
Real	GetReal (const Point &p) const
Complex	GetComplex (const Point &p) const
DataObserver interface
void	Attach (DataObserver *o) const
void	Detach (DataObserver *o) const
void	Notify () const
void	Notify (const Extent &e) const
void	Notify (const Point &p) const
DataAlgorithm interface
Only the out-of-place functionality is available
void	Apply (NonModAlgorithm &a) const
void	ApplyIP (NonModAlgorithm &a) const
ImageHandle	Apply (ModIPAlgorithm &a) const
ImageHandle	Apply (const ConstModIPAlgorithm &a) const
ImageHandle	Apply (ModOPAlgorithm &a) const
ImageHandle	Apply (const ConstModOPAlgorithm &a) const
StateVisitor interface
Only the out-of-place functionality is available
void	StateApply (ImageStateNonModVisitorBase &v) const
ImageHandle	StateApply (ImageStateModIPVisitorBase &v) const
ImageHandle	StateApply (const ImageStateConstModIPVisitorBase &v) const
ImageHandle	StateApply (ImageStateModOPVisitorBase &v) const
ImageHandle	StateApply (const ImageStateConstModOPVisitorBase &v) const
ImageHandle	StateApply (ImageStateMorphVisitorBase &v) const
ExtentIterator	GetIterator () const
Comparison
bool	operator== (const ConstImageHandle &ih) const
bool	operator== (const ImageHandle &ih) const
bool	operator!= (const ConstImageHandle &ih) const
bool	operator!= (const ImageHandle &ih) const
Public Member Functions inherited from ConstData
	ConstData ()
virtual	~ConstData ()
bool	IsSpatial () const
bool	IsFrequency () const
bool	IsReal () const
bool	IsComplex () const
Size	GetSize () const
virtual Real	OverallDifference (const ConstData &d) const
virtual Real	NormDifference (const ConstData &d) const
Vec3	GetPixelSampling () const
Vec3	GetSpatialSampling () const
Vec3	GetFrequencySampling () const

Protected Member Functions
PixelSampling &	Sampling ()
const PixelSampling &	Sampling () const
Protected Member Functions inherited from ConstData
	ConstData (const ConstData &d)
ConstData &	operator= (const ConstData &d)
void	CalcIntpolWeights (Vec3 v, Real w[8], Point p[8]) const

Friends
class	ImageHandle

---

Detailed Description

read-only ImageHandle implementation

ConstImageHandle offers only the read-only (const) interface of ImageHandle. Any sort of out-of-place manipulation will return the result as a non-const ImageHandle again!

ConstImageHandle provides two different 'upcasting' characteristics. First, it is derived from ConstData, and may thus be used as such. Second, it provides an implicit conversion to const Data&.

Definition at line 516 of file image_handle.hh.

---

Constructor & Destructor Documentation

ConstImageHandle

(

)

Empty, ie invalid handle.

ConstImageHandle

(

const ConstImageHandle &

h

)

Initialize with an existing handle.

The newly created handle will share the image with the existing one

ConstImageHandle

(

const ImageHandle &

h

)

Initialize with an existing non-const handle.

Provides implicit ImageHandle -> ConstImageHandle conversion. The newly created const handle will still share the image with the non-const one.

---

Member Function Documentation

void Apply ( NonModAlgorithm &  a ) const

virtual

see ImageHandle::Apply(NonModAlgorithm&)

Implements ConstData.

ImageHandle Apply

(

ModIPAlgorithm &

a

)

const

see ImageHandle::Apply(ModIPAlgorithm&)

ImageHandle Apply

(

const ConstModIPAlgorithm &

a

)

const

see ImageHandle::Apply(const ConstModIPAlgorithm&)

ImageHandle Apply

(

ModOPAlgorithm &

a

)

const

see ImageHandle::Apply(ModOPAlgorithm)

ImageHandle Apply

(

const ConstModOPAlgorithm &

a

)

const

see ImageHandle::Apply(const ConstModOPAlgorithm)

void ApplyIP ( NonModAlgorithm &  a ) const

virtual

Implements ConstData.

void Attach ( DataObserver *  o ) const

virtual

see ImageHandle::Attach()

Implements ConstData.

Vec3 CoordToIndex

(

const Vec3 &

c

)

const

see ImageHandle::CoordToIndex()

ImageHandle Copy

(

bool

cc = true

)

const

see ImageHandle::Copy(bool)

void Detach ( DataObserver *  o ) const

virtual

see ImageHandle::Detach()

Implements ConstData.

ImageHandle Extract

(

const Extent &

e

)

const

see ImageHandle::Copy(const Extent&)

Vec3 FractionalIndexToCoord

(

const Vec3 &

p

)

const

See ImageHandle::FractionalIndexToCoord()

Vec3 GetAbsoluteOrigin

(

)

const

see ImageHandle::GetAbsoluteOrigin()

Complex GetComplex ( const Point &  p ) const

virtual

see ImageHandle::GetComplex()

Implements ConstData.

DataDomain GetDomain ( ) const

virtual

see ImageHandle::GetDomain()

Implements ConstData.

Extent GetExtent ( ) const

virtual

see ImageHandle::GetExtent()

Implements ConstData.

virtual Complex GetIntpolComplex ( const Vec3 &  v ) const

virtual

Get interpolated complex value from 3D,2D or 1D vec.

Implements ConstData.

virtual Complex GetIntpolComplex ( const Vec2 &  v ) const

virtual

Implements ConstData.

virtual Complex GetIntpolComplex ( const Real &  d ) const

virtual

Implements ConstData.

virtual Real GetIntpolReal ( const Vec3 &  v ) const

virtual

Get interpolated real value from 3D,2D or 1D vec.

Implements ConstData.

virtual Real GetIntpolReal ( const Vec2 &  v ) const

virtual

Implements ConstData.

virtual Real GetIntpolReal ( const Real &  d ) const

virtual

Implements ConstData.

ExtentIterator GetIterator

(

)

const

Get ExtentIterator.

Real GetReal ( const Point &  p ) const

virtual

see ImageHandle::GetReal()

Implements ConstData.

Point GetSpatialOrigin ( ) const

virtual

see ImageHandle::GetSpatialOrigin()

Implements ConstData.

DataType GetType ( ) const

virtual

see ImageHandle::GetType()

Implements ConstData.

const ImageStateBasePtr& ImageStatePtr

(

)

const

Vec3 IndexToCoord

(

const Point &

p

)

const

see ImageHandle::IndexToCoord()

bool IsValid

(

)

const

Returns true if handle is valid.

long MemSize

(

)

const

Returns size in bytes of allocated memory.

void Notify ( ) const

virtual

see ImageHandle::Notify()

Implements ConstData.

void Notify

(

const Extent &

e

)

const

void Notify

(

const Point &

p

)

const

operator const Data & ( ) const

inline

pseudo 'upcasting' to const Data&

Definition at line 520 of file image_handle.hh.

bool operator!=

(

const ConstImageHandle &

ih

)

const

bool operator!=

(

const ImageHandle &

ih

)

const

ConstImageHandle& operator=

(

const ConstImageHandle &

h

)

Assign another image based on handle.

The reference count the the previously shared images is decreased and the one of the assignee is increased

ConstImageHandle& operator=

(

const ImageHandle &

h

)

Assign another image based on a non-const handle.

Implicit conversion of non-const to const image handle.

bool operator==

(

const ConstImageHandle &

ih

)

const

bool operator==

(

const ImageHandle &

ih

)

const

PixelSampling& Sampling ( )

protectedvirtual

see ImageHandle::Sampling()

Implements ConstData.

const PixelSampling& Sampling ( ) const

protectedvirtual

see ImageHandle::Sampling()

Implements ConstData.

void StateApply

(

ImageStateNonModVisitorBase &

v

)

const

see ImageHandle::StateApply(ImageStateNonModVisitorBase&)

ImageHandle StateApply

(

ImageStateModIPVisitorBase &

v

)

const

see ImageHandle::StateApply(ImageStateModIPVisitorBase&)

ImageHandle StateApply

(

const ImageStateConstModIPVisitorBase &

v

)

const

see ImageHandle::StateApply(ImageStateConstModIPVisitorBase&)

ImageHandle StateApply

(

ImageStateModOPVisitorBase &

v

)

const

see ImageHandle::StateApply(ImageStateModOPVisitorBase&)

ImageHandle StateApply

(

const ImageStateConstModOPVisitorBase &

v

)

const

see ImageHandle::StateApply(ImageStateConstModOPVisitorBase&)

ImageHandle StateApply

(

ImageStateMorphVisitorBase &

v

)

const

see ImageHandle::StateApply(ImageStateMorphVisitorBase&)

---

Friends And Related Function Documentation

friend class ImageHandle

friend

Definition at line 517 of file image_handle.hh.

---

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

• stage/include/ost/img/image_handle.hh