Field3D
|
#include <MIPBase.h>
Public Types | |
typedef MIPBase< Data_T > | class_type |
typedef boost::intrusive_ptr< MIPBase > | 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 | |
virtual void | getVsMIPCoord (const V3f &vsP, const size_t level, V3f &outVsP) const =0 |
Given a voxel space coordinate in the 0-level field, computes the coordinate in another level. | |
virtual bool | levelLoaded (const size_t level) const =0 |
Whether a given MIP level is loaded. | |
size_t | lowestLevel () const |
Lowest MIP level to use. | |
MIPBase () | |
virtual Field< Data_T >::Ptr | mipLevel (const size_t level) const =0 |
Returns a MIP level field. | |
const V3i & | mipOffset () const |
Returns the base MIP offset. | |
virtual V3i | mipResolution (size_t level) const =0 |
Returns the resolution of a given MIP level. | |
virtual Data_T | mipValue (size_t level, int i, int j, int k) const =0 |
Read access to a voxel in a given MIP level. | |
size_t | numLevels () const |
Number of MIP levels. | |
void | setLowestLevel (size_t level) |
Sets the lowest MIP level to use. Defaults to zero, but can be set higher to prevent high resolution levels from being accessed. | |
void | setMIPOffset (const V3i &offset) |
Sets the base MIP offset. This is used to indicate where voxel space coordinate (0, 0, 0) really maps to. | |
![]() | |
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 * | staticClassType () |
Public Attributes | |
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 Field< Data_T > | base |
![]() | |
typedef MatrixFieldMapping | default_mapping |
Protected Attributes | |
size_t | m_lowestLevel |
The lowest MIP level to use. Defaults to 0, but can be set higher to prevent high resolution levels from being accessed. | |
V3i | m_mipOffset |
Base coordinate offset. This is used to indicate where voxel space coordinate (0, 0, 0) really maps to. | |
size_t | m_numLevels |
Number of MIP levels. The default is 1. | |
![]() | |
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. | |
Static Protected Attributes | |
static TemplatedFieldType< MIPBase< Data_T > > | ms_classType |
Some assumptions:
MIP fields are neither Resizable nor Writable. They are constructed from an existing field such as DenseField, SparseField, etc.
The highest resolution representation is level 0.
All MIPBase subclasses are delayed-read, so as not to touch high res data unless needed.
The base class provides mipValue() and mipLValue(). It is assumed that concrete subclasses provide fastMipValue() and fastMipLValue().
Definition at line 213 of file MIPBase.h.
Definition at line 135 of file MIPBase.h.
References FieldBase::name.
|
pure virtual |
Read access to a voxel in a given MIP level.
level | The MIP level to read from |
Implemented in MIPField< Field_T >, MIPField< DenseField< Data_T > >, and MIPField< SparseField< Data_T > >.
|
pure virtual |
Returns the resolution of a given MIP level.
Implemented in MIPField< Field_T >, MIPField< DenseField< Data_T > >, and MIPField< SparseField< Data_T > >.
|
pure virtual |
Whether a given MIP level is loaded.
Implemented in MIPField< Field_T >, MIPField< DenseField< Data_T > >, and MIPField< SparseField< Data_T > >.
|
pure virtual |
Given a voxel space coordinate in the 0-level field, computes the coordinate in another level.
Implemented in MIPField< Field_T >, MIPField< DenseField< Data_T > >, and MIPField< SparseField< Data_T > >.
|
pure virtual |
Returns a MIP level field.
Implemented in MIPField< Field_T >, MIPField< DenseField< Data_T > >, and MIPField< SparseField< Data_T > >.
Sets the lowest MIP level to use. Defaults to zero, but can be set higher to prevent high resolution levels from being accessed.
Definition at line 222 of file MIPBase.h.
References FIELD3D_MTX_T.
Lowest MIP level to use.
Definition at line 171 of file MIPBase.h.
References MIPBase< Data_T >::m_lowestLevel.
Number of MIP levels.
Definition at line 174 of file MIPBase.h.
References MIPBase< Data_T >::m_numLevels.
Sets the base MIP offset. This is used to indicate where voxel space coordinate (0, 0, 0) really maps to.
Definition at line 230 of file MIPBase.h.
References FIELD3D_MTX_T, and detail::k_mipOffsetStr.
Returns the base MIP offset.
Definition at line 180 of file MIPBase.h.
References MIPBase< Data_T >::m_mipOffset.
|
staticprotected |
Number of MIP levels. The default is 1.
Definition at line 196 of file MIPBase.h.
Referenced by MIPField< Field_T >::MIPField(), and MIPBase< Data_T >::numLevels().
The lowest MIP level to use. Defaults to 0, but can be set higher to prevent high resolution levels from being accessed.
Definition at line 199 of file MIPBase.h.
Referenced by MIPBase< Data_T >::lowestLevel().
Base coordinate offset. This is used to indicate where voxel space coordinate (0, 0, 0) really maps to.
Definition at line 204 of file MIPBase.h.
Referenced by MIPBase< Data_T >::mipOffset().