Field3D
EmptyField< Data_T > Class Template Reference

This subclass of Field does not store any data. More...

#include <EmptyField.h>

Inheritance diagram for EmptyField< Data_T >:
ResizableField< Data_T > WritableField< Data_T > Field< Data_T > FieldRes FieldBase RefBase

Public Types

typedef EmptyField< Data_T > class_type
 
typedef boost::intrusive_ptr< EmptyFieldPtr
 
typedef std::vector< PtrVec
 
- Public Types inherited from ResizableField< Data_T >
typedef ResizableField< Data_T > class_type
 
typedef boost::intrusive_ptr< ResizableFieldPtr
 
- Public Types inherited from WritableField< Data_T >
typedef WritableField< Data_T > class_type
 
typedef boost::intrusive_ptr< WritableFieldPtr
 
- Public Types inherited from Field< Data_T >
typedef Field< Data_T > class_type
 
typedef boost::intrusive_ptr< FieldPtr
 
typedef Data_T value_type
 Allows us to reference the template class. More...
 
typedef std::vector< PtrVec
 This is a convenience typedef for the list that Field3DInputFile::readScalarLayers() and Field3DInputFile::readVectorLayers() will return its data in. More...
 
- Public Types inherited from FieldRes
typedef FieldRes class_type
 
typedef boost::intrusive_ptr< FieldResPtr
 
typedef std::vector< PtrVec
 
- Public Types inherited from FieldBase
typedef FieldBase class_type
 
typedef boost::intrusive_ptr< FieldBasePtr
 
- Public Types inherited from RefBase
typedef boost::intrusive_ptr< RefBasePtr
 

Public Member Functions

virtual void clear (const Data_T &value)
 Clears all the voxels in the storage. More...
 
const Data_T & constantvalue () const
 Returns the constant value. More...
 
void setConstantvalue (const Data_T &val)
 Sets the constant value. More...
 
Constructors & destructor
 EmptyField ()
 Constructs an empty buffer. More...
 
From Field
virtual Data_T value (int i, int j, int k) const
 Read access to a voxel. The coordinates are in integer voxel space . More...
 
virtual long long int memSize () const
 Returns the memory usage (in bytes) More...
 
From WritableField
virtual Data_T & lvalue (int i, int j, int k)
 Write access to a voxel. The coordinates are global coordinates. More...
 
From FieldBase
virtual std::string className () const
 Returns the class name of the object. Used by the class pool and when writing the data to disk. More...
 
virtual FieldBase::Ptr clone () const
 Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it. More...
 
- Public Member Functions inherited from ResizableField< Data_T >
void copyFrom (typename Field< Data_T >::Ptr other)
 Copies the data from another Field, also resizes. More...
 
template<class Data_T2 >
void copyFrom (typename Field< Data_T2 >::Ptr other)
 Copies the data from another Field of another template class, also resizes. More...
 
void matchDefinition (FieldRes::Ptr fieldToMatch)
 Sets up this field so that resolution and mapping matches the other. More...
 
void setSize (const V3i &size)
 Resizes the object. More...
 
void setSize (const Box3i &extents)
 Resizes the object. More...
 
void setSize (const Box3i &extents, const Box3i &dataWindow)
 Resizes the object. More...
 
void setSize (const V3i &size, int padding)
 Resizes the object with padding. More...
 
- Public Member Functions inherited from WritableField< Data_T >
iterator begin ()
 Iterator to first element. More...
 
iterator begin (const Box3i &subset)
 Iterator to first element of specific subset. More...
 
iterator end ()
 Iterator pointing one element past the last valid one. More...
 
iterator end (const Box3i &subset)
 Iterator pointing one element past the last valid one (for a subset) More...
 
- Public Member Functions inherited from Field< Data_T >
const_iterator cbegin () const
 Const iterator to first element. "cbegin" matches the tr1 c++ standard. More...
 
const_iterator cbegin (const Box3i &subset) const
 Const iterator to first element of specific subset. More...
 
const_iterator cend () const
 Const iterator pointing one element past the last valid one. More...
 
const_iterator cend (const Box3i &subset) const
 Const iterator pointing one element past the last valid one (for a subset) More...
 
virtual std::string dataTypeString () const
 
virtual ~Field ()
 Dtor. More...
 
- Public Member Functions inherited from FieldRes
V3i const dataResolution () const
 
const Box3idataWindow () const
 Returns the data window. Any coordinate inside this window is safe to pass to value() in the Field subclass. More...
 
const Box3iextents () const
 Returns the extents of the data. This signifies the relevant area that the data exists over. However, the data window (below) may be smaller than the extents, in which case it is only safe to call value() for those coordinate inside the data window. More...
 
 FieldRes ()
 This constructor ensures that we have a valid mapping at all times. More...
 
 FieldRes (const FieldRes &src)
 Base class copy constructor. More...
 
bool isInBounds (int i, int j, int k) const
 Returns true is the indicies are in bounds of the data window. More...
 
FieldMapping::Ptr mapping ()
 Returns a pointer to the mapping. More...
 
const FieldMapping::Ptr mapping () const
 Returns a pointer to the mapping. More...
 
void setMapping (FieldMapping::Ptr mapping)
 Sets the field's mapping. More...
 
- Public Member Functions inherited from FieldBase
 FieldBase ()
 Constructor. More...
 
 FieldBase (const FieldBase &)
 Copy Constructor. More...
 
virtual ~FieldBase ()
 Destructor. More...
 
FieldMetadata< FieldBase > & metadata ()
 accessor to the m_metadata class More...
 
const FieldMetadata< FieldBase > & metadata () const
 Read only access to the m_metadata class. More...
 
virtual void metadataHasChanged (const std::string &)
 This function should implemented by concrete classes to get the callback when metadata changes. More...
 
void copyMetadata (const FieldBase &field)
 Copies the metadata from a second field. More...
 
- Public Member Functions inherited from RefBase
void ref () const
 Used by boost::intrusive_pointer. More...
 
size_t refcnt ()
 Used by boost::intrusive_pointer. More...
 
void unref () const
 Used by boost::intrusive_pointer. More...
 
 RefBase ()
 
 RefBase (const RefBase &)
 Copy constructor. More...
 
RefBaseoperator= (const RefBase &)
 Assignment operator. More...
 
virtual ~RefBase ()
 Destructor. More...
 
virtual bool checkRTTI (const char *typenameStr)=0
 This function is only implemented by concrete classes and triggers the actual RTTI check through matchRTTI();. More...
 
bool matchRTTI (const char *typenameStr)
 Performs a check to see if the given typename string matches this class' This needs to be implemented in -all- subclasses, even abstract ones. More...
 

Static Public Member Functions

static DEFINE_FIELD_RTTI_CONCRETE_CLASS const char * classType ()
 RTTI replacement. More...
 
- Static Public Member Functions inherited from ResizableField< Data_T >
static const char * classType ()
 
static const char * staticClassName ()
 
- Static Public Member Functions inherited from WritableField< Data_T >
static const char * classType ()
 
static const char * staticClassName ()
 
- Static Public Member Functions inherited from Field< Data_T >
static const char * classType ()
 
static const char * staticClassName ()
 
- Static Public Member Functions inherited from FieldRes
static const char * classType ()
 
static const char * staticClassName ()
 
- Static Public Member Functions inherited from FieldBase
static const char * classType ()
 
static const char * staticClassName ()
 
- Static Public Member Functions inherited from RefBase
static const char * classType ()
 

Protected Attributes

Data_T m_constantData
 Field constant value. More...
 
Data_T m_default
 Field default value. More...
 
Data_T m_ignoredData
 Dummy variable for assignment. More...
 
- Protected Attributes inherited from FieldRes
Box3i m_dataWindow
 Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval. More...
 
Box3i m_extents
 Defines the extents of the the storage. This may be larger or smaller than the data window, and in the case where it is larger, care must be taken not to access voxels outside the data window. This should be treated as a closed (i.e. inclusive) interval. More...
 
FieldMapping::Ptr m_mapping
 Pointer to the field's mapping. More...
 

Private Types

typedef ResizableField< Data_T > base
 

Additional Inherited Members

- Public Attributes inherited from ResizableField< Data_T >
 DEFINE_FIELD_RTTI_ABSTRACT_CLASS
 
- Public Attributes inherited from WritableField< Data_T >
 DEFINE_FIELD_RTTI_ABSTRACT_CLASS
 
- Public Attributes inherited from Field< Data_T >
 DEFINE_FIELD_RTTI_ABSTRACT_CLASS
 
- Public Attributes inherited from FieldRes
 DEFINE_FIELD_RTTI_ABSTRACT_CLASS
 
- Public Attributes inherited from FieldBase
std::string attribute
 Optional name of the attribute the field represents. More...
 
std::string name
 Optional name of the field. More...
 
- Protected Types inherited from ResizableField< Data_T >
typedef WritableField< Data_T > base
 
- Protected Types inherited from FieldRes
typedef MatrixFieldMapping default_mapping
 
- Protected Member Functions inherited from ResizableField< Data_T >
virtual void sizeChanged ()
 Subclasses should re-implement this if they need to perform memory allocations, etc. every time the size of the storage changes. More...
 
- Static Protected Attributes inherited from ResizableField< Data_T >
static TemplatedFieldType< ResizableField< Data_T > > ms_classType
 

Detailed Description

template<class Data_T>
class EmptyField< Data_T >

This subclass of Field does not store any data.

Its primary purpose is to be used as a proxy field. It can carry the same resolution, metadata and mapping as a regular field.

Usage is similar to a DenseField, except that it does not contain any data. It stores a default value that may be set and queried, so it can be treated as a constant field.

Definition at line 81 of file EmptyField.h.

Member Typedef Documentation

◆ Ptr

template<class Data_T>
typedef boost::intrusive_ptr<EmptyField> EmptyField< Data_T >::Ptr

Definition at line 88 of file EmptyField.h.

◆ Vec

template<class Data_T>
typedef std::vector<Ptr> EmptyField< Data_T >::Vec

Definition at line 89 of file EmptyField.h.

◆ class_type

template<class Data_T>
typedef EmptyField<Data_T> EmptyField< Data_T >::class_type

Definition at line 121 of file EmptyField.h.

◆ base

template<class Data_T>
typedef ResizableField<Data_T> EmptyField< Data_T >::base
private

Definition at line 165 of file EmptyField.h.

Constructor & Destructor Documentation

◆ EmptyField()

template<class Data_T >
EmptyField< Data_T >::EmptyField ( )

Constructs an empty buffer.

Definition at line 174 of file EmptyField.h.

Referenced by EmptyField< Data_T >::clone().

175  : base()
176 {
177  // Empty
178 }
ResizableField< Data_T > base
Definition: EmptyField.h:165

Member Function Documentation

◆ clear()

template<class Data_T >
void EmptyField< Data_T >::clear ( const Data_T &  value)
virtual

Clears all the voxels in the storage.

Reimplemented from WritableField< Data_T >.

Definition at line 183 of file EmptyField.h.

References EmptyField< Data_T >::m_constantData, EmptyField< Data_T >::m_default, and EmptyField< Data_T >::value().

184 {
186 }
virtual Data_T value(int i, int j, int k) const
Read access to a voxel. The coordinates are in integer voxel space .
Definition: EmptyField.h:191
Data_T m_default
Field default value.
Definition: EmptyField.h:155
Data_T m_constantData
Field constant value.
Definition: EmptyField.h:159

◆ constantvalue()

template<class Data_T >
const Data_T & EmptyField< Data_T >::constantvalue ( ) const
inline

Returns the constant value.

Definition at line 248 of file EmptyField.h.

References EmptyField< Data_T >::m_constantData.

249 {
250  return m_constantData;
251 }
Data_T m_constantData
Field constant value.
Definition: EmptyField.h:159

◆ setConstantvalue()

template<class Data_T >
void EmptyField< Data_T >::setConstantvalue ( const Data_T &  val)
inline

Sets the constant value.

Definition at line 240 of file EmptyField.h.

References EmptyField< Data_T >::m_constantData.

241 {
242  m_constantData = val;
243 }
Data_T m_constantData
Field constant value.
Definition: EmptyField.h:159

◆ value()

template<class Data_T >
Data_T EmptyField< Data_T >::value ( int  i,
int  j,
int  k 
) const
virtual

Read access to a voxel. The coordinates are in integer voxel space .

Note
Before the internal storage is accessed, the subclass must compute the data window coordinates by looking at Field::m_dataWindow.
Virtual functions are known not to play nice with threading. Therefor, concrete classes can implement (by convention) fastValue() as a non-virtual function.

Implements Field< Data_T >.

Definition at line 191 of file EmptyField.h.

References FieldRes::m_dataWindow, EmptyField< Data_T >::m_default, and UNUSED.

Referenced by EmptyField< Data_T >::clear().

192 {
193  assert (i >= base::m_dataWindow.min.x);
194  assert (i <= base::m_dataWindow.max.x);
195  assert (j >= base::m_dataWindow.min.y);
196  assert (j <= base::m_dataWindow.max.y);
197  assert (k >= base::m_dataWindow.min.z);
198  assert (k <= base::m_dataWindow.max.z);
199 
200  UNUSED(i);
201  UNUSED(j);
202  UNUSED(k);
203 
204  // Access data
205  return m_default;
206 }
#define UNUSED(p)
Definition: EmptyField.h:62
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:299
Data_T m_default
Field default value.
Definition: EmptyField.h:155

◆ memSize()

template<class Data_T >
long long int EmptyField< Data_T >::memSize ( ) const
virtual

Returns the memory usage (in bytes)

Note
This needs to be re-implemented for any subclass that adds data members. Those classes should also call their superclass and add the combined memory use.

Reimplemented from FieldRes.

Definition at line 211 of file EmptyField.h.

References FieldRes::memSize().

212 {
213  long long int superClassMemSize = base::memSize();
214  return sizeof(*this) + superClassMemSize;
215 }
virtual long long int memSize() const
Returns the memory usage (in bytes)
Definition: Field.h:281

◆ classType()

template<class Data_T>
static DEFINE_FIELD_RTTI_CONCRETE_CLASS const char* EmptyField< Data_T >::classType ( )
inlinestatic

RTTI replacement.

Definition at line 125 of file EmptyField.h.

References EmptyField< Data_T >::lvalue().

Referenced by EmptyField< Data_T >::className().

126  {
127  return "EmptyField";
128  }

◆ lvalue()

template<class Data_T >
Data_T & EmptyField< Data_T >::lvalue ( int  i,
int  j,
int  k 
)
virtual

Write access to a voxel. The coordinates are global coordinates.

Note
Before the internal storage is accessed, the subclass must compute the crop window coordinates by looking at Field::m_dataWindow.
This is named differently from the const value so that non-const objects still have a clear way of accessing data in a const way.
Virtual functions are known not to play nice with threading. Therefor, concrete classes can implement (by convention) fastLValue() as a non-virtual function.

Implements WritableField< Data_T >.

Definition at line 220 of file EmptyField.h.

References FieldRes::m_dataWindow, EmptyField< Data_T >::m_ignoredData, and UNUSED.

Referenced by EmptyField< Data_T >::classType().

221 {
222  assert (i >= base::m_dataWindow.min.x);
223  assert (i <= base::m_dataWindow.max.x);
224  assert (j >= base::m_dataWindow.min.y);
225  assert (j <= base::m_dataWindow.max.y);
226  assert (k >= base::m_dataWindow.min.z);
227  assert (k <= base::m_dataWindow.max.z);
228 
229  UNUSED(i);
230  UNUSED(j);
231  UNUSED(k);
232 
233  // Access data
234  return m_ignoredData;
235 }
#define UNUSED(p)
Definition: EmptyField.h:62
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:299
Data_T m_ignoredData
Dummy variable for assignment.
Definition: EmptyField.h:157

◆ className()

template<class Data_T>
virtual std::string EmptyField< Data_T >::className ( ) const
inlinevirtual

Returns the class name of the object. Used by the class pool and when writing the data to disk.

Note
This is different from classType for any templated class, as classType() will include the template parameter(s) but className remains just the name of the template itself.

Implements FieldBase.

Definition at line 142 of file EmptyField.h.

References EmptyField< Data_T >::classType().

143  { return std::string(classType()); }
static DEFINE_FIELD_RTTI_CONCRETE_CLASS const char * classType()
RTTI replacement.
Definition: EmptyField.h:125

◆ clone()

template<class Data_T>
virtual FieldBase::Ptr EmptyField< Data_T >::clone ( ) const
inlinevirtual

Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it.

Implements FieldBase.

Definition at line 145 of file EmptyField.h.

References EmptyField< Data_T >::EmptyField().

146  { return Ptr(new EmptyField(*this)); }
EmptyField()
Constructs an empty buffer.
Definition: EmptyField.h:174
boost::intrusive_ptr< EmptyField > Ptr
Definition: EmptyField.h:88

Member Data Documentation

◆ m_default

template<class Data_T>
Data_T EmptyField< Data_T >::m_default
protected

Field default value.

Definition at line 155 of file EmptyField.h.

Referenced by EmptyField< Data_T >::clear(), and EmptyField< Data_T >::value().

◆ m_ignoredData

template<class Data_T>
Data_T EmptyField< Data_T >::m_ignoredData
protected

Dummy variable for assignment.

Definition at line 157 of file EmptyField.h.

Referenced by EmptyField< Data_T >::lvalue().

◆ m_constantData

template<class Data_T>
Data_T EmptyField< Data_T >::m_constantData
protected

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