Field3D
|
#include <Field.h>
Public Types | |
typedef ResizableField< Data_T > | class_type |
typedef boost::intrusive_ptr< ResizableField > | Ptr |
![]() | |
typedef WritableField< Data_T > | class_type |
typedef boost::intrusive_ptr< WritableField > | Ptr |
![]() | |
typedef Field< Data_T > | class_type |
typedef boost::intrusive_ptr< Field > | Ptr |
typedef Data_T | value_type |
Allows us to reference the template class. | |
typedef std::vector< Ptr > | Vec |
This is a convenience typedef for the list that Field3DInputFile::readScalarLayers() and Field3DInputFile::readVectorLayers() will return its data in. | |
![]() | |
typedef FieldRes | class_type |
typedef boost::intrusive_ptr< FieldRes > | Ptr |
typedef std::vector< Ptr > | Vec |
![]() | |
typedef FieldBase | class_type |
typedef boost::intrusive_ptr< FieldBase > | Ptr |
![]() | |
typedef boost::intrusive_ptr< RefBase > | Ptr |
typedef boost::weak_ptr< RefBase > | WeakPtr |
Public Member Functions | |
void | copyFrom (typename Field< Data_T >::Ptr other) |
Copies the data from another Field, also resizes. | |
template<class Data_T2 > | |
void | copyFrom (typename Field< Data_T2 >::Ptr other) |
Copies the data from another Field of another template class, also resizes. | |
void | matchDefinition (FieldRes::Ptr fieldToMatch) |
Sets up this field so that resolution and mapping matches the other. | |
void | setSize (const Box3i &extents) |
Resizes the object. | |
void | setSize (const Box3i &extents, const Box3i &dataWindow) |
Resizes the object. | |
void | setSize (const V3i &size) |
Resizes the object. | |
void | setSize (const V3i &size, int padding) |
Resizes the object with padding. | |
![]() | |
iterator | begin () |
Iterator to first element. | |
iterator | begin (const Box3i &subset) |
Iterator to first element of specific subset. | |
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. | |
iterator | end () |
Iterator pointing one element past the last valid one. | |
iterator | end (const Box3i &subset) |
Iterator pointing one element past the last valid one (for a subset) | |
virtual Data_T & | lvalue (int i, int j, int k)=0 |
Write access to a voxel. The coordinates are global coordinates. | |
![]() | |
const_iterator | cbegin () const |
Const iterator to first element. "cbegin" matches the tr1 c++ standard. | |
const_iterator | cbegin (const Box3i &subset) const |
Const iterator to first element of specific subset. | |
const_iterator | cend () const |
Const iterator pointing one element past the last valid one. | |
const_iterator | cend (const Box3i &subset) const |
Const iterator pointing one element past the last valid one (for a subset) | |
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 . | |
virtual | ~Field () |
Dtor. | |
![]() | |
V3i const | dataResolution () const |
const Box3i & | dataWindow () const |
Returns the data window. Any coordinate inside this window is safe to pass to value() in the Field subclass. | |
const Box3i & | extents () 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. | |
FieldRes () | |
This constructor ensures that we have a valid mapping at all times. | |
FieldRes (const FieldRes &src) | |
Base class copy constructor. | |
bool | isInBounds (int i, int j, int k) const |
Returns true is the indicies are in bounds of the data window. | |
FieldMapping::Ptr | mapping () |
Returns a pointer to the mapping. | |
const FieldMapping::Ptr | mapping () const |
Returns a pointer to the mapping. | |
virtual void | mappingChanged () |
Tells the subclass that the mapping changed. | |
virtual long long int | memSize () const |
Returns the memory usage (in bytes) | |
void | setMapping (FieldMapping::Ptr mapping) |
Sets the field's mapping. | |
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. | |
![]() | |
FieldBase () | |
Constructor. | |
FieldBase (const FieldBase &) | |
Copy Constructor. | |
virtual | ~FieldBase () |
Destructor. | |
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. | |
virtual std::string | classType () const =0 |
Returns the full class type string. | |
virtual Ptr | clone () const =0 |
Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it. | |
FieldMetadata & | metadata () |
accessor to the m_metadata class | |
const FieldMetadata & | metadata () const |
Read only access to the m_metadata class. | |
void | copyMetadata (const FieldBase &field) |
Copies the metadata from a second field. | |
![]() | |
void | ref () const |
Used by boost::intrusive_pointer. | |
size_t | refcnt () |
Used by boost::intrusive_pointer. | |
void | unref () const |
Used by boost::intrusive_pointer. | |
WeakPtr | weakPtr () const |
RefBase () | |
RefBase (const RefBase &) | |
Copy constructor. | |
RefBase & | operator= (const RefBase &) |
Assignment operator. | |
virtual | ~RefBase () |
Destructor. | |
virtual bool | checkRTTI (const char *typenameStr)=0 |
This function is only implemented by concrete classes and triggers the actual RTTI check through matchRTTI();. | |
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. | |
![]() | |
virtual void | metadataHasChanged (const std::string &) |
Alerts the callback holder that the metadata has changed. | |
Static Public Member Functions | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassName () |
static const char * | staticClassType () |
![]() | |
static const char * | staticClassType () |
Public Attributes | |
DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
![]() | |
DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
![]() | |
DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
![]() | |
DEFINE_FIELD_RTTI_ABSTRACT_CLASS | |
![]() | |
std::string | attribute |
Optional name of the attribute the field represents. | |
std::string | name |
Optional name of the field. | |
Protected Types | |
typedef WritableField< Data_T > | base |
![]() | |
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. | |
Static Protected Attributes | |
static TemplatedFieldType< ResizableField< Data_T > > | ms_classType |
Additional Inherited Members | |
![]() | |
Box3i | m_dataWindow |
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval. | |
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. | |
FieldMapping::Ptr | m_mapping |
Pointer to the field's mapping. | |
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.
boost::intrusive_ptr<ResizableField> ResizableField< Data_T >::Ptr |
ResizableField<Data_T> ResizableField< Data_T >::class_type |
|
protected |
|
inlinestatic |
|
inlinestatic |
Definition at line 852 of file Field.h.
References FieldBase::name.
void ResizableField< Data_T >::setSize | ( | const V3i & | size | ) |
Resizes the object.
Definition at line 913 of file Field.h.
Referenced by convertCellCenteredToMAC(), Field3DInputFile::readProxyLayer(), and Field3DInputFileHDF5::readProxyLayer().
void ResizableField< Data_T >::setSize | ( | const Box3i & | extents | ) |
Resizes the object.
Definition at line 930 of file Field.h.
void ResizableField< Data_T >::setSize | ( | const Box3i & | extents, |
const Box3i & | dataWindow ) |
Resizes the object.
Definition at line 941 of file Field.h.
void ResizableField< Data_T >::setSize | ( | const V3i & | size, |
int | padding ) |
Resizes the object with padding.
Definition at line 953 of file Field.h.
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.
References Field< Data_T >::cbegin(), FieldRes::dataWindow(), FieldRes::extents(), FieldRes::mapping(), and FieldRes::setMapping().
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.
References Field< Data_T >::cbegin(), FieldRes::dataWindow(), FieldRes::extents(), FieldRes::mapping(), and FieldRes::setMapping().
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.
References FieldRes::setMapping().
Referenced by MACField< Data_T >::copyMAC().
|
inlineprotectedvirtual |
Subclasses should re-implement this if they need to perform memory allocations, etc. every time the size of the storage changes.
Reimplemented in DenseField< Data_T >, MACField< Data_T >, and SparseField< Data_T >.
Definition at line 901 of file Field.h.
References FieldRes::m_extents, and FieldRes::m_mapping.
Referenced by SparseField< Data_T >::sizeChanged().
ResizableField< Data_T >::DEFINE_FIELD_RTTI_ABSTRACT_CLASS |
|
staticprotected |