Field3D
ResizableField< Data_T > Class Template Reference

#include <Field.h>

Inheritance diagram for ResizableField< Data_T >:
WritableField< Data_T > Field< Data_T > FieldRes FieldBase RefBase MetadataCallback DenseField< Data_T > EmptyField< Data_T > MACField< Data_T > SparseField< Data_T >

Public Types

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
 
typedef boost::weak_ptr< RefBaseWeakPtr
 

Public Member Functions

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 Box3i &extents)
 Resizes the object. More...
 
void setSize (const Box3i &extents, const Box3i &dataWindow)
 Resizes the object. More...
 
void setSize (const V3i &size)
 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...
 
virtual void clear (const Data_T &value)
 Clears all the voxels in the storage. Should be re-implemented by subclasses that can provide a more efficient version. 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...
 
virtual Data_T & lvalue (int i, int j, int k)=0
 Write access to a voxel. The coordinates are global coordinates. 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 Data_T value (int i, int j, int k) const =0
 Read access to a voxel. The coordinates are in integer voxel space . More...
 
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...
 
virtual void mappingChanged ()
 Tells the subclass that the mapping changed. More...
 
virtual long long int memSize () const
 Returns the memory usage (in bytes) More...
 
void setMapping (FieldMapping::Ptr mapping)
 Sets the field's mapping. More...
 
virtual size_t voxelCount () const
 Counts the number of voxels. For most fields, this is just the volume of the data window, but sparse data structures can override this to return a better value. More...
 
- Public Member Functions inherited from FieldBase
 FieldBase ()
 Constructor. More...
 
 FieldBase (const FieldBase &)
 Copy Constructor. More...
 
virtual ~FieldBase ()
 Destructor. More...
 
virtual std::string className () const =0
 Returns the class name of the object. Used by the class pool and when writing the data to disk. More...
 
virtual std::string classType () const =0
 Returns the full class type string. More...
 
virtual Ptr clone () const =0
 Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it. More...
 
FieldMetadatametadata ()
 accessor to the m_metadata class More...
 
const FieldMetadatametadata () const
 Read only access to the m_metadata class. 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...
 
WeakPtr weakPtr () const
 
 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...
 
- Public Member Functions inherited from MetadataCallback
virtual void metadataHasChanged (const std::string &)
 Alerts the callback holder that the metadata has changed. More...
 

Static Public Member Functions

static const char * staticClassName ()
 
static const char * staticClassType ()
 
- Static Public Member Functions inherited from WritableField< Data_T >
static const char * staticClassName ()
 
static const char * staticClassType ()
 
- Static Public Member Functions inherited from Field< Data_T >
static const char * staticClassName ()
 
static const char * staticClassType ()
 
- Static Public Member Functions inherited from FieldRes
static const char * staticClassName ()
 
static const char * staticClassType ()
 
- Static Public Member Functions inherited from FieldBase
static const char * staticClassName ()
 
static const char * staticClassType ()
 
- Static Public Member Functions inherited from RefBase
static const char * staticClassType ()
 

Public Attributes

 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

typedef WritableField< Data_T > base
 
- Protected Types inherited from FieldRes
typedef MatrixFieldMapping default_mapping
 

Protected Member Functions

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

static TemplatedFieldType< ResizableField< Data_T > > ms_classType
 

Additional Inherited Members

- 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...
 

Detailed Description

template<class Data_T>
class ResizableField< Data_T >

This class adds the ability to resize the data storage object. Most Field subclasses will derive from this class. Only classes that cannot implement sizeChanged() in a reasonable manner should derive from Field or WritableField.

Definition at line 833 of file Field.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 840 of file Field.h.

◆ class_type

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

Definition at line 844 of file Field.h.

◆ base

template<class Data_T >
typedef WritableField<Data_T> ResizableField< Data_T >::base
protected

Definition at line 894 of file Field.h.

Member Function Documentation

◆ staticClassName()

template<class Data_T >
static const char* ResizableField< Data_T >::staticClassName ( )
inlinestatic

Definition at line 847 of file Field.h.

848  {
849  return "ResizableField";
850  }

◆ staticClassType()

template<class Data_T >
static const char* ResizableField< Data_T >::staticClassType ( )
inlinestatic

Definition at line 852 of file Field.h.

853  {
855  }

References FieldBase::name.

◆ setSize() [1/4]

template<class Data_T >
void ResizableField< Data_T >::setSize ( const V3i size)

Resizes the object.

Warning
Never call this from a constructor. It calls the virtual function sizeChanged().

Definition at line 913 of file Field.h.

914 {
915  assert(size.x >= 0);
916  assert(size.y >= 0);
917  assert(size.z >= 0);
918 
919  Field<Data_T>::m_extents.min = V3i(0);
920  Field<Data_T>::m_extents.max = size - V3i(1);
922 
923  // Tell subclasses that the size changed so they can update themselves.
924  sizeChanged();
925 }

Referenced by convertCellCenteredToMAC(), Field3DInputFile::readProxyLayer(), and Field3DInputFileHDF5::readProxyLayer().

◆ setSize() [2/4]

template<class Data_T >
void ResizableField< Data_T >::setSize ( const Box3i extents)

Resizes the object.

Warning
Never call this from a constructor. It calls the virtual function sizeChanged().

Definition at line 930 of file Field.h.

931 {
934  // Tell subclasses that the size changed so they can update themselves.
935  sizeChanged();
936 }

◆ setSize() [3/4]

template<class Data_T >
void ResizableField< Data_T >::setSize ( const Box3i extents,
const Box3i dataWindow 
)

Resizes the object.

Warning
Never call this from a constructor. It calls the virtual function sizeChanged().

Definition at line 941 of file Field.h.

943 {
946  // Tell subclasses that the size changed so they can update themselves.
947  sizeChanged();
948 }

◆ setSize() [4/4]

template<class Data_T >
void ResizableField< Data_T >::setSize ( const V3i size,
int  padding 
)

Resizes the object with padding.

Warning
Never call this from a constructor. It calls the virtual function sizeChanged().

Definition at line 953 of file Field.h.

954 {
955  assert(size.x >= 0);
956  assert(size.y >= 0);
957  assert(size.z >= 0);
958  assert(padding >= 0);
959 
960  setSize(Box3i(V3i(0), size - V3i(1)),
961  Box3i(V3i(-padding), size + V3i(padding - 1)));
962 }

◆ copyFrom() [1/2]

template<class Data_T >
void ResizableField< Data_T >::copyFrom ( typename Field< Data_T >::Ptr  other)

Copies the data from another Field, also resizes.

Definition at line 967 of file Field.h.

968 {
969  // Set mapping
970  FieldRes::setMapping(other->mapping());
971  // Set size to match
972  setSize(other->extents(), other->dataWindow());
973 
974  // Copy over the data
975  typename base::iterator i = base::begin();
976  typename base::iterator end = base::end();
977  typename Field<Data_T>::const_iterator c = other->cbegin();
978  for (; i != end; ++i, ++c)
979  *i = *c;
980 }

References Field< Data_T >::cbegin(), FieldRes::dataWindow(), FieldRes::extents(), FieldRes::mapping(), and FieldRes::setMapping().

◆ copyFrom() [2/2]

template<class Data_T >
template<class Data_T2 >
void ResizableField< Data_T >::copyFrom ( typename Field< Data_T2 >::Ptr  other)

Copies the data from another Field of another template class, also resizes.

Definition at line 986 of file Field.h.

987 {
988  // Set mapping
989  FieldRes::setMapping(other->mapping());
990  // Set size to match
991  setSize(other->extents(), other->dataWindow());
992  // Copy over the data
993  typename base::iterator i = base::begin();
994  typename base::iterator end = base::end();
995  typename Field<Data_T2>::const_iterator c = other->cbegin();
996  for (; i != end; ++i, ++c)
997  *i = *c;
998 }

References Field< Data_T >::cbegin(), FieldRes::dataWindow(), FieldRes::extents(), FieldRes::mapping(), and FieldRes::setMapping().

◆ matchDefinition()

template<class Data_T >
void ResizableField< Data_T >::matchDefinition ( FieldRes::Ptr  fieldToMatch)

Sets up this field so that resolution and mapping matches the other.

Definition at line 1003 of file Field.h.

1004 {
1005  setSize(fieldToMatch->extents(), fieldToMatch->dataWindow());
1006  FieldRes::setMapping(fieldToMatch->mapping());
1007 }

References FieldRes::setMapping().

Referenced by MACField< Data_T >::copyMAC().

◆ sizeChanged()

template<class Data_T >
virtual void ResizableField< Data_T >::sizeChanged ( )
inlineprotectedvirtual

Subclasses should re-implement this if they need to perform memory allocations, etc. every time the size of the storage changes.

Note
Make sure to call the base class version in subclasses!

Reimplemented in SparseField< Data_T >, MACField< Data_T >, and DenseField< Data_T >.

Definition at line 901 of file Field.h.

902  { base::m_mapping->setExtents(base::m_extents); }

References FieldRes::m_extents, and FieldRes::m_mapping.

Referenced by SparseField< Data_T >::sizeChanged().

Member Data Documentation

◆ DEFINE_FIELD_RTTI_ABSTRACT_CLASS

template<class Data_T >
ResizableField< Data_T >::DEFINE_FIELD_RTTI_ABSTRACT_CLASS

Definition at line 845 of file Field.h.

◆ ms_classType

template<class Data_T >
TemplatedFieldType<ResizableField<Data_T> > ResizableField< Data_T >::ms_classType
staticprotected

Definition at line 890 of file Field.h.


The documentation for this class was generated from the following file:
FieldRes::m_extents
Box3i m_extents
Defines the extents of the the storage. This may be larger or smaller than the data window,...
Definition: Field.h:307
ResizableField::setSize
void setSize(const V3i &size)
Resizes the object.
Definition: Field.h:913
FieldRes::dataWindow
const Box3i & dataWindow() const
Returns the data window. Any coordinate inside this window is safe to pass to value() in the Field su...
Definition: Field.h:253
V3i
Imath::V3i V3i
Definition: SpiMathLib.h:71
WritableField::end
iterator end()
Iterator pointing one element past the last valid one.
Definition: Field.h:802
Field::const_iterator
Definition: Field.h:492
FieldBase::name
std::string name
Optional name of the field.
Definition: Field.h:171
FieldRes::setMapping
void setMapping(FieldMapping::Ptr mapping)
Sets the field's mapping.
Definition: Field.h:347
WritableField::begin
iterator begin()
Iterator to first element.
Definition: Field.h:779
FieldRes::m_mapping
FieldMapping::Ptr m_mapping
Pointer to the field's mapping.
Definition: Field.h:312
FieldRes::extents
const Box3i & extents() const
Returns the extents of the data. This signifies the relevant area that the data exists over....
Definition: Field.h:249
ResizableField::sizeChanged
virtual void sizeChanged()
Subclasses should re-implement this if they need to perform memory allocations, etc....
Definition: Field.h:901
Box3i
Imath::Box3i Box3i
Definition: SpiMathLib.h:77
Field
Definition: Field.h:390
ResizableField
Definition: Field.h:835