ConstImageHandle Class Reference

read-only ImageHandle implementation More...

#include <image_handle.hh>

Inherits ost::img::ConstData.

Public Member Functions

 operator const Data & () const
 ConstImageHandle ()
 ConstImageHandle (const ConstImageHandle &h)
 ConstImageHandle (const ImageHandle &h)
ConstImageHandleoperator= (const ConstImageHandle &h)
ConstImageHandleoperator= (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

Protected Member Functions

PixelSamplingSampling ()
const PixelSamplingSampling () 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

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

ImageHandle Apply ( const ConstModOPAlgorithm a  )  const

see ImageHandle::Apply(const ConstModOPAlgorithm)

ImageHandle Apply ( ModOPAlgorithm a  )  const

see ImageHandle::Apply(ModOPAlgorithm)

ImageHandle Apply ( const ConstModIPAlgorithm a  )  const

see ImageHandle::Apply(const ConstModIPAlgorithm&)

ImageHandle Apply ( ModIPAlgorithm a  )  const

see ImageHandle::Apply(ModIPAlgorithm&)

void Apply ( NonModAlgorithm a  )  const [virtual]

see ImageHandle::Apply(NonModAlgorithm&)

Implements ConstData.

void ApplyIP ( NonModAlgorithm a  )  const [virtual]

Implements ConstData.

void Attach ( DataObserver o  )  const [virtual]
Vec3 CoordToIndex ( const Vec3 &  c  )  const
ImageHandle Copy ( bool  cc = true  )  const

see ImageHandle::Copy(bool)

void Detach ( DataObserver o  )  const [virtual]
ImageHandle Extract ( const Extent e  )  const

see ImageHandle::Copy(const Extent&)

Vec3 FractionalIndexToCoord ( const Vec3 &  p  )  const
Vec3 GetAbsoluteOrigin (  )  const
Complex GetComplex ( const Point p  )  const [virtual]
DataDomain GetDomain (  )  const [virtual]
Extent GetExtent (  )  const [virtual]
virtual Complex GetIntpolComplex ( const Real d  )  const [virtual]

Implements ConstData.

virtual Complex GetIntpolComplex ( const Vec2 &  v  )  const [virtual]

Implements ConstData.

virtual Complex GetIntpolComplex ( const Vec3 &  v  )  const [virtual]

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

Implements ConstData.

virtual Real GetIntpolReal ( const Real d  )  const [virtual]

Implements ConstData.

virtual Real GetIntpolReal ( const Vec2 &  v  )  const [virtual]

Implements ConstData.

virtual Real GetIntpolReal ( const Vec3 &  v  )  const [virtual]

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

Implements ConstData.

ExtentIterator GetIterator (  )  const
Real GetReal ( const Point p  )  const [virtual]
Point GetSpatialOrigin (  )  const [virtual]
DataType GetType (  )  const [virtual]
const ImageStateBasePtr& ImageStatePtr (  )  const
Vec3 IndexToCoord ( const Point p  )  const
bool IsValid (  )  const

Returns true if handle is valid.

long MemSize (  )  const

Returns size in bytes of allocated memory.

void Notify ( const Point p  )  const
void Notify ( const Extent e  )  const
void Notify (  )  const [virtual]
operator const Data & (  )  const [inline]

pseudo 'upcasting' to const Data&

Definition at line 520 of file image_handle.hh.

bool operator!= ( const ImageHandle ih  )  const
bool operator!= ( const ConstImageHandle ih  )  const
ConstImageHandle& operator= ( const ImageHandle h  ) 

Assign another image based on a non-const handle.

Implicit conversion of non-const to const image handle.

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

Reimplemented from ConstData.

bool operator== ( const ImageHandle ih  )  const
bool operator== ( const ConstImageHandle ih  )  const
const PixelSampling& Sampling (  )  const [protected, virtual]
PixelSampling& Sampling (  )  [protected, virtual]
ImageHandle StateApply ( ImageStateMorphVisitorBase &  v  )  const

see ImageHandle::StateApply(ImageStateMorphVisitorBase&)

ImageHandle StateApply ( const ImageStateConstModOPVisitorBase &  v  )  const

see ImageHandle::StateApply(ImageStateConstModOPVisitorBase&)

ImageHandle StateApply ( ImageStateModOPVisitorBase &  v  )  const

see ImageHandle::StateApply(ImageStateModOPVisitorBase&)

ImageHandle StateApply ( const ImageStateConstModIPVisitorBase &  v  )  const

see ImageHandle::StateApply(ImageStateConstModIPVisitorBase&)

ImageHandle StateApply ( ImageStateModIPVisitorBase &  v  )  const

see ImageHandle::StateApply(ImageStateModIPVisitorBase&)

void StateApply ( ImageStateNonModVisitorBase &  v  )  const

see ImageHandle::StateApply(ImageStateNonModVisitorBase&)


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:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Generated on 6 Dec 2017 for OpenStructure by  doxygen 1.6.1