OpenStructure
Public Member Functions | Static Public Member Functions | Protected Member Functions
NullData Class Reference

#include <null_data.hh>

Inherits Data.

Public Member Functions

virtual DataType GetType () const
 
virtual DataDomain GetDomain () const
 
virtual Extent GetExtent () const
 
virtual Real GetReal (const Point &p) const
 
virtual Complex GetComplex (const Point &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
 
virtual void Apply (NonModAlgorithm &a) const
 
virtual void ApplyIP (NonModAlgorithm &a) const
 
virtual void SetSpatialOrigin (const Point &o)
 
virtual Point GetSpatialOrigin () const
 
virtual void Attach (DataObserver *o) const
 
virtual void Detach (DataObserver *o) const
 
virtual void Notify () const
 
virtual ImageHandle Crop (const Extent &e) const
 
- Public Member Functions inherited from Data
 Data ()
 
virtual ~Data ()
 
void SetPixelSampling (const Vec3 &)
 
void SetPixelSampling (Real d)
 
void SetSpatialSampling (const Vec3 &)
 
void SetSpatialSampling (Real d)
 
- 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
 

Static Public Member Functions

static DataInstance ()
 

Protected Member Functions

virtual PixelSamplingSampling ()
 
virtual const PixelSamplingSampling () const
 
- Protected Member Functions inherited from Data
 Data (const Data &d)
 
Dataoperator= (const Data &d)
 
- Protected Member Functions inherited from ConstData
void CalcIntpolWeights (Vec3 v, Real w[8], Point p[8]) const
 
 ConstData (const ConstData &d)
 
ConstDataoperator= (const ConstData &d)
 

Detailed Description

null data singleton

Provides a full implementation of the Data interface, but without providing any real functionality; all writes are ignored, and all reads return zero or otherwise null defaults.

Definition at line 44 of file null_data.hh.

Member Function Documentation

◆ Apply()

virtual void Apply ( NonModAlgorithm a) const
inlinevirtual

Algorithm interface: NonModAlgorithm.

Implements Data.

Definition at line 65 of file null_data.hh.

◆ ApplyIP()

virtual void ApplyIP ( NonModAlgorithm a) const
inlinevirtual

Implements Data.

Definition at line 66 of file null_data.hh.

◆ Attach()

virtual void Attach ( DataObserver o) const
inlinevirtual

DataObserver interface: attach observer.

Implements ConstData.

Definition at line 72 of file null_data.hh.

◆ Crop()

virtual ImageHandle Crop ( const Extent e) const
inlinevirtual

Definition at line 78 of file null_data.hh.

◆ Detach()

virtual void Detach ( DataObserver o) const
inlinevirtual

DataObserver interface: detach observer.

Implements ConstData.

Definition at line 74 of file null_data.hh.

◆ GetComplex()

virtual Complex GetComplex ( const Point p) const
inlinevirtual

Get explicit complex value.

Implements ConstData.

Definition at line 55 of file null_data.hh.

◆ GetDomain()

virtual DataDomain GetDomain ( ) const
inlinevirtual

Return domain: SPATIAL, FREQUENCY or HALF_FREQUENCY.

Implements ConstData.

Definition at line 49 of file null_data.hh.

◆ GetExtent()

virtual Extent GetExtent ( ) const
inlinevirtual

Return (logical) extent of data.

Implements ConstData.

Definition at line 51 of file null_data.hh.

◆ GetIntpolComplex() [1/3]

virtual Complex GetIntpolComplex ( const Real d) const
inlinevirtual

Implements ConstData.

Definition at line 63 of file null_data.hh.

◆ GetIntpolComplex() [2/3]

virtual Complex GetIntpolComplex ( const Vec2 &  v) const
inlinevirtual

Implements ConstData.

Definition at line 62 of file null_data.hh.

◆ GetIntpolComplex() [3/3]

virtual Complex GetIntpolComplex ( const Vec3 &  v) const
inlinevirtual

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

Implements ConstData.

Definition at line 61 of file null_data.hh.

◆ GetIntpolReal() [1/3]

virtual Real GetIntpolReal ( const Real d) const
inlinevirtual

Implements ConstData.

Definition at line 59 of file null_data.hh.

◆ GetIntpolReal() [2/3]

virtual Real GetIntpolReal ( const Vec2 &  v) const
inlinevirtual

Implements ConstData.

Definition at line 58 of file null_data.hh.

◆ GetIntpolReal() [3/3]

virtual Real GetIntpolReal ( const Vec3 &  v) const
inlinevirtual

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

Implements ConstData.

Definition at line 57 of file null_data.hh.

◆ GetReal()

virtual Real GetReal ( const Point p) const
inlinevirtual

Get explicit real value.

Implements ConstData.

Definition at line 53 of file null_data.hh.

◆ GetSpatialOrigin()

virtual Point GetSpatialOrigin ( ) const
inlinevirtual

Retrieve spatial origin.

Implements ConstData.

Definition at line 70 of file null_data.hh.

◆ GetType()

virtual DataType GetType ( ) const
inlinevirtual

Return type of data: REAL or COMPLEX.

Implements ConstData.

Definition at line 47 of file null_data.hh.

◆ Instance()

static Data& Instance ( )
inlinestatic

Definition at line 82 of file null_data.hh.

◆ Notify()

virtual void Notify ( ) const
inlinevirtual

Notify each observer that state has changed.

Implements ConstData.

Definition at line 76 of file null_data.hh.

◆ Sampling() [1/2]

virtual PixelSampling& Sampling ( )
inlineprotectedvirtual

Implements ConstData.

Definition at line 88 of file null_data.hh.

◆ Sampling() [2/2]

virtual const PixelSampling& Sampling ( ) const
inlineprotectedvirtual

Implements ConstData.

Definition at line 91 of file null_data.hh.

◆ SetSpatialOrigin()

virtual void SetSpatialOrigin ( const Point o)
inlinevirtual

Set the spatial origin.

Implements Data.

Definition at line 68 of file null_data.hh.


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