Field3D
|
This Field subclass stores voxel data in block-allocated arrays. More...
#include <SparseField.h>
Classes | |
class | block_iterator |
class | const_iterator |
class | iterator |
Public Types | |
typedef SparseField< Data_T > | class_type |
typedef CubicGenericFieldInterp< SparseField< Data_T > > | CubicInterp |
typedef LinearSparseFieldInterp< Data_T > | LinearInterp |
typedef boost::intrusive_ptr< SparseField > | Ptr |
typedef std::vector< Ptr > | Vec |
![]() | |
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 | addReference (const std::string &filename, const std::string &layerPath, int valuesPerBlock, int numVoxels, int occupiedBlocks) |
Internal function to create a Reference for the current field, for use in dynamic reading. | |
Data_T * | blockData (int bi, int bj, int bk) const |
Returns a pointer to the data in a block, or null if the given block is unallocated. | |
Data_T & | fastLValue (int i, int j, int k) |
Write access to voxel. Notice that this is non-virtual. | |
Data_T | fastValue (int i, int j, int k) const |
Read access to voxel. Notice that this is non-virtual. | |
void | setupReferenceBlocks () |
Internal function to setup the Reference's block pointers, for use with dynamic reading. | |
Constructors & destructor | |
SparseField () | |
Constructs an empty buffer. | |
SparseField (const SparseField &o) | |
Copy constructor. | |
~SparseField () | |
Destructor. | |
SparseField & | operator= (const SparseField &o) |
Assignment operator. For cache-managed fields, it creates a new file reference, and for non-managed fields, it copies the data. | |
virtual void | clear (const Data_T &value) |
Clears all the voxels in the storage. | |
void | setBlockOrder (int order) |
Sets the block order (i.e. the power-of-2 to use as block size. | |
int | blockOrder () const |
Returns the block order. | |
int | blockSize () const |
Returns the block size. | |
bool | voxelIsInAllocatedBlock (int i, int j, int k) const |
Checks if a voxel is in an allocated block. | |
bool | blockIsAllocated (int bi, int bj, int bk) const |
Checks if a block is allocated. | |
const Data_T | getBlockEmptyValue (int bi, int bj, int bk) const |
Returns the constant value of an block, whether it's allocated already or not.. | |
void | setBlockEmptyValue (int bi, int bj, int bk, const Data_T &val) |
Sets the constant value of an block. If the block is already allocated, it gets deallocated. | |
bool | blockIndexIsValid (int bi, int bj, int bk) const |
Returns whether a block index is valid. | |
V3i | blockRes () const |
Returns the resolution of the block array. | |
template<typename Functor_T> | |
int | releaseBlocks (Functor_T func) |
Releases any blocks that are deemed empty. This can be used to clean up after algorithms that write "zero" values to the buffer, as well as after any narrow band levelset algorithms. | |
int | blockId (int blockI, int blockJ, int blockK) const |
Calculates the block number based on a block i,j,k index. | |
void | getBlockCoord (int i, int j, int k, int &bi, int &bj, int &bk) const |
Calculates the block coordinates that a given set of voxel coords are in. | |
void | getVoxelInBlock (int i, int j, int k, int &vi, int &vj, int &vk) const |
Calculates the coordinates in a block for the given voxel index. | |
void | applyDataWindowOffset (int &i, int &j, int &k) const |
Applies data window offset. | |
bool | isDynamicLoad () const |
Whether the field is dynamically loaded. | |
void | incBlockRef (const int blockId) const |
Increments the block ref count for the given block. | |
void | activateBlock (const int blockId) const |
Activates a given block. | |
void | decBlockRef (const int blockId) const |
Decrements the block ref count for the given block. | |
size_t | numGrains () const |
Number of 'grains' to use with threaded access. | |
bool | getGrainBounds (const size_t idx, Box3i &vsBounds) const |
Bounding box of the given 'grain'. | |
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 . | |
virtual long long int | memSize () const |
Returns the memory usage (in bytes) | |
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. | |
From WritableField | |
virtual Data_T & | lvalue (int i, int j, int k) |
Write access to a voxel. The coordinates are global coordinates. | |
Iterators | |
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) | |
iterator | begin () |
Iterator to first element. | |
iterator | begin (const Box3i &subset) |
Iterator to first element of specific subset. | |
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) | |
block_iterator | blockBegin () const |
block_iterator | blockEnd () const |
Const iterator pointing to element one past the last valid block. | |
![]() | |
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. | |
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) | |
![]() | |
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 | ~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. | |
void | setMapping (FieldMapping::Ptr mapping) |
Sets the field's mapping. | |
![]() | |
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. | |
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 * | staticClassName () |
static const char * | staticClassType () |
static const char * | staticClassType () |
Public Attributes | |
DEFINE_FIELD_RTTI_CONCRETE_CLASS | |
![]() | |
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 ResizableField< Data_T > | base |
typedef Sparse::SparseBlock< Data_T > | Block |
![]() | |
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. | |
Convenience methods | |
void | setupBlocks () |
Initializes the block structure. Will clear any existing data. | |
void | deallocBlock (Block &block, const Data_T &emptyValue) |
Deallocated the data of the given block and sets its empty value. | |
Protected Attributes | |
int | m_blockOrder |
Block order (size = 2^blockOrder) | |
V3i | m_blockRes |
Block array resolution. | |
Block * | m_blocks |
Array of blocks. Not using std::vector since SparseBlock is noncopyable. | |
int | m_blockXYSize |
Block array res.x * res.y. | |
Data_T | m_dummy |
Dummy value used when needing to return but indicating a failed call. | |
int | m_fileId |
File id. Used with m_fileManager if active. Otherwise -1. | |
SparseFileManager * | m_fileManager |
Pointer to SparseFileManager. Used when doing dynamic reading. NULL if not in use. | |
size_t | m_numBlocks |
Number of blocks in field. | |
![]() | |
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. | |
Private Member Functions | |
void | copyBlockStates (const SparseField< Data_T > &o) |
Internal function to copy empty values and allocated flags, without copying data, used when copying a dynamically read field. | |
void | copySparseField (const SparseField &o) |
Copies internal data, including blocks, from another SparseField, used by copy constructor and operator=. | |
Static Private Attributes | |
static TemplatedFieldType< SparseField< Data_T > > | ms_classType |
Friends | |
class | SparseFieldIO |
From FieldBase | |
FIELD3D_CLASSNAME_CLASSTYPE_IMPLEMENTATION | |
virtual FieldBase::Ptr | clone () const |
Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it. | |
Additional Inherited Members | |
![]() | |
static TemplatedFieldType< ResizableField< Data_T > > | ms_classType |
This Field subclass stores voxel data in block-allocated arrays.
Empty blocks aren't allocated. This effectively optimizes away memory use for "empty" voxels.
Refer to using_fields for examples of how to use this in your code.
Definition at line 350 of file SparseField.h.
typedef boost::intrusive_ptr<SparseField> SparseField< Data_T >::Ptr |
Definition at line 357 of file SparseField.h.
typedef std::vector<Ptr> SparseField< Data_T >::Vec |
Definition at line 358 of file SparseField.h.
typedef LinearSparseFieldInterp<Data_T> SparseField< Data_T >::LinearInterp |
Definition at line 360 of file SparseField.h.
typedef CubicGenericFieldInterp<SparseField<Data_T> > SparseField< Data_T >::CubicInterp |
Definition at line 361 of file SparseField.h.
typedef SparseField<Data_T> SparseField< Data_T >::class_type |
Definition at line 365 of file SparseField.h.
|
protected |
Definition at line 582 of file SparseField.h.
|
protected |
Definition at line 583 of file SparseField.h.
SparseField< Data_T >::SparseField | ( | ) |
Constructs an empty buffer.
Definition at line 1287 of file SparseField.h.
References BLOCK_ORDER, m_blockOrder, m_blocks, m_fileManager, and setupBlocks().
Referenced by SparseField< half >::clone(), copyBlockStates(), copySparseField(), operator=(), and SparseField().
SparseField< Data_T >::SparseField | ( | const SparseField< Data_T > & | o | ) |
Copy constructor.
Definition at line 1299 of file SparseField.h.
References copySparseField(), m_blockOrder, m_blocks, m_fileManager, and SparseField().
SparseField< Data_T >::~SparseField | ( | ) |
Destructor.
Definition at line 1311 of file SparseField.h.
References m_blocks, m_fileId, and m_fileManager.
|
inlinestatic |
Definition at line 368 of file SparseField.h.
|
inlinestatic |
Definition at line 373 of file SparseField.h.
SparseField< Data_T > & SparseField< Data_T >::operator= | ( | const SparseField< Data_T > & | o | ) |
Assignment operator. For cache-managed fields, it creates a new file reference, and for non-managed fields, it copies the data.
Definition at line 1328 of file SparseField.h.
References copySparseField(), RefBase::operator=(), and SparseField().
|
virtual |
Clears all the voxels in the storage.
Reimplemented from WritableField< Data_T >.
Definition at line 1452 of file SparseField.h.
References Sparse::SparseBlock< Data_T >::emptyValue, end(), m_blocks, m_numBlocks, setupBlocks(), and value().
void SparseField< Data_T >::setBlockOrder | ( | int | order | ) |
Sets the block order (i.e. the power-of-2 to use as block size.
Definition at line 1466 of file SparseField.h.
References m_blockOrder, and setupBlocks().
int SparseField< Data_T >::blockOrder | ( | ) | const |
Returns the block order.
Definition at line 1475 of file SparseField.h.
References m_blockOrder.
Referenced by LinearSparseFieldInterp< Data_T >::sample().
int SparseField< Data_T >::blockSize | ( | ) | const |
Returns the block size.
Definition at line 1483 of file SparseField.h.
References m_blockOrder.
Referenced by fastLValue(), memSize(), releaseBlocks(), detail::threadingBlockSize(), and voxelCount().
bool SparseField< Data_T >::voxelIsInAllocatedBlock | ( | int | i, |
int | j, | ||
int | k ) const |
Checks if a voxel is in an allocated block.
Definition at line 1491 of file SparseField.h.
References applyDataWindowOffset(), blockIsAllocated(), and getBlockCoord().
bool SparseField< Data_T >::blockIsAllocated | ( | int | bi, |
int | bj, | ||
int | bk ) const |
Checks if a block is allocated.
Definition at line 1502 of file SparseField.h.
References blockId(), Sparse::SparseBlock< Data_T >::isAllocated, and m_blocks.
Referenced by detail::checkInputEmpty(), LinearSparseFieldInterp< Data_T >::sample(), and voxelIsInAllocatedBlock().
const Data_T SparseField< Data_T >::getBlockEmptyValue | ( | int | bi, |
int | bj, | ||
int | bk ) const |
Returns the constant value of an block, whether it's allocated already or not..
Definition at line 1511 of file SparseField.h.
References blockId(), and m_blocks.
Referenced by detail::checkInputEmpty(), and LinearSparseFieldInterp< Data_T >::sample().
void SparseField< Data_T >::setBlockEmptyValue | ( | int | bi, |
int | bj, | ||
int | bk, | ||
const Data_T & | val ) |
Sets the constant value of an block. If the block is already allocated, it gets deallocated.
Definition at line 1519 of file SparseField.h.
References blockId(), deallocBlock(), Sparse::SparseBlock< Data_T >::emptyValue, Sparse::SparseBlock< Data_T >::isAllocated, and m_blocks.
bool SparseField< Data_T >::blockIndexIsValid | ( | int | bi, |
int | bj, | ||
int | bk ) const |
Returns whether a block index is valid.
Definition at line 1533 of file SparseField.h.
References m_blockRes.
V3i SparseField< Data_T >::blockRes | ( | ) | const |
Returns the resolution of the block array.
Definition at line 1542 of file SparseField.h.
References m_blockRes.
Referenced by setupBlocks().
int SparseField< Data_T >::releaseBlocks | ( | Functor_T | func | ) |
Releases any blocks that are deemed empty. This can be used to clean up after algorithms that write "zero" values to the buffer, as well as after any narrow band levelset algorithms.
func | A function object with the method "bool check(SparseBlock&)" |
Definition at line 1551 of file SparseField.h.
References blockSize(), FieldRes::dataResolution(), deallocBlock(), m_blockRes, m_blocks, and m_numBlocks.
int SparseField< Data_T >::blockId | ( | int | blockI, |
int | blockJ, | ||
int | blockK ) const |
Calculates the block number based on a block i,j,k index.
Definition at line 1881 of file SparseField.h.
References m_blockRes, and m_blockXYSize.
Referenced by activateBlock(), blockData(), blockIsAllocated(), decBlockRef(), fastLValue(), fastValue(), getBlockEmptyValue(), incBlockRef(), LinearSparseFieldInterp< Data_T >::sample(), and setBlockEmptyValue().
void SparseField< Data_T >::getBlockCoord | ( | int | i, |
int | j, | ||
int | k, | ||
int & | bi, | ||
int & | bj, | ||
int & | bk ) const |
Calculates the block coordinates that a given set of voxel coords are in.
Definition at line 1890 of file SparseField.h.
References m_blockOrder.
Referenced by blockCoords(), fastLValue(), fastValue(), LinearSparseFieldInterp< Data_T >::sample(), and voxelIsInAllocatedBlock().
void SparseField< Data_T >::getVoxelInBlock | ( | int | i, |
int | j, | ||
int | k, | ||
int & | vi, | ||
int & | vj, | ||
int & | vk ) const |
Calculates the coordinates in a block for the given voxel index.
Definition at line 1905 of file SparseField.h.
References m_blockOrder.
Referenced by fastLValue(), fastValue(), and LinearSparseFieldInterp< Data_T >::sample().
|
inline |
Applies data window offset.
Definition at line 455 of file SparseField.h.
Referenced by blockCoords(), fastLValue(), fastValue(), LinearSparseFieldInterp< Data_T >::sample(), and voxelIsInAllocatedBlock().
|
inline |
Whether the field is dynamically loaded.
Definition at line 463 of file SparseField.h.
Referenced by LinearSparseFieldInterp< Data_T >::sample().
void SparseField< Data_T >::incBlockRef | ( | const int | blockId | ) | const |
Increments the block ref count for the given block.
Definition at line 1919 of file SparseField.h.
References blockId(), m_fileId, and m_fileManager.
Referenced by LinearSparseFieldInterp< Data_T >::sample().
void SparseField< Data_T >::activateBlock | ( | const int | blockId | ) | const |
Activates a given block.
Definition at line 1927 of file SparseField.h.
References blockId(), m_fileId, and m_fileManager.
Referenced by LinearSparseFieldInterp< Data_T >::sample().
void SparseField< Data_T >::decBlockRef | ( | const int | blockId | ) | const |
Decrements the block ref count for the given block.
Definition at line 1935 of file SparseField.h.
References blockId(), m_fileId, and m_fileManager.
Referenced by LinearSparseFieldInterp< Data_T >::sample().
size_t SparseField< Data_T >::numGrains | ( | ) | const |
Number of 'grains' to use with threaded access.
Definition at line 1943 of file SparseField.h.
References m_numBlocks.
bool SparseField< Data_T >::getGrainBounds | ( | const size_t | idx, |
Box3i & | vsBounds ) const |
Bounding box of the given 'grain'.
Definition at line 1951 of file SparseField.h.
References clipBounds(), end(), indexToCoord(), m_blockOrder, m_blockRes, and FieldRes::m_dataWindow.
|
virtual |
Read access to a voxel. The coordinates are in integer voxel space .
Implements Field< Data_T >.
Definition at line 1598 of file SparseField.h.
References fastValue().
Referenced by clear().
|
virtual |
Returns the memory usage (in bytes)
Reimplemented from FieldRes.
Definition at line 1708 of file SparseField.h.
References blockSize(), m_blockOrder, m_blocks, and m_numBlocks.
|
virtual |
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.
Reimplemented from FieldRes.
Definition at line 1726 of file SparseField.h.
References blockSize(), m_blockOrder, m_blocks, and m_numBlocks.
|
virtual |
Write access to a voxel. The coordinates are global coordinates.
Implements WritableField< Data_T >.
Definition at line 1606 of file SparseField.h.
References fastLValue().
Data_T SparseField< Data_T >::fastValue | ( | int | i, |
int | j, | ||
int | k ) const |
Read access to voxel. Notice that this is non-virtual.
Definition at line 1614 of file SparseField.h.
References applyDataWindowOffset(), blockId(), Sparse::SparseBlock< Data_T >::emptyValue, getBlockCoord(), getVoxelInBlock(), Sparse::SparseBlock< Data_T >::isAllocated, m_blockOrder, m_blocks, FieldRes::m_dataWindow, m_fileId, m_fileManager, and Sparse::SparseBlock< Data_T >::value().
Referenced by LinearSparseFieldInterp< Data_T >::sample(), and value().
Data_T & SparseField< Data_T >::fastLValue | ( | int | i, |
int | j, | ||
int | k ) |
Write access to voxel. Notice that this is non-virtual.
Definition at line 1653 of file SparseField.h.
References applyDataWindowOffset(), blockId(), blockSize(), getBlockCoord(), getVoxelInBlock(), Sparse::SparseBlock< Data_T >::isAllocated, m_blockOrder, m_blocks, FieldRes::m_dataWindow, m_dummy, m_fileManager, Msg::print(), Sparse::SparseBlock< Data_T >::resize(), Msg::SevWarning, and Sparse::SparseBlock< Data_T >::value().
Referenced by lvalue().
Data_T * SparseField< Data_T >::blockData | ( | int | bi, |
int | bj, | ||
int | bk ) const |
Returns a pointer to the data in a block, or null if the given block is unallocated.
Definition at line 1694 of file SparseField.h.
References blockId(), Sparse::SparseBlock< Data_T >::data, Sparse::SparseBlock< Data_T >::isAllocated, and m_blocks.
Referenced by LinearSparseFieldInterp< Data_T >::sample().
|
inlinevirtual |
Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it.
Implements FieldBase.
Definition at line 517 of file SparseField.h.
SparseField< Data_T >::const_iterator SparseField< Data_T >::cbegin | ( | ) | const |
Const iterator to first element. "cbegin" matches the tr1 c++ standard.
Definition at line 1744 of file SparseField.h.
References cend(), FieldRes::dataResolution(), m_blockOrder, and FieldRes::m_dataWindow.
SparseField< Data_T >::const_iterator SparseField< Data_T >::cbegin | ( | const Box3i & | subset | ) | const |
Const iterator to first element of specific subset.
Definition at line 1756 of file SparseField.h.
References cend(), and m_blockOrder.
SparseField< Data_T >::const_iterator SparseField< Data_T >::cend | ( | ) | const |
Const iterator pointing one element past the last valid one.
Definition at line 1767 of file SparseField.h.
References m_blockOrder, and FieldRes::m_dataWindow.
SparseField< Data_T >::const_iterator SparseField< Data_T >::cend | ( | const Box3i & | subset | ) | const |
Const iterator pointing one element past the last valid one (for a subset)
Definition at line 1780 of file SparseField.h.
References m_blockOrder.
SparseField< Data_T >::iterator SparseField< Data_T >::begin | ( | ) |
Iterator to first element.
Definition at line 1792 of file SparseField.h.
References FieldRes::dataResolution(), end(), m_blockOrder, and FieldRes::m_dataWindow.
SparseField< Data_T >::iterator SparseField< Data_T >::begin | ( | const Box3i & | subset | ) |
Iterator to first element of specific subset.
Definition at line 1803 of file SparseField.h.
References end(), and m_blockOrder.
SparseField< Data_T >::iterator SparseField< Data_T >::end | ( | ) |
Iterator pointing one element past the last valid one.
Definition at line 1814 of file SparseField.h.
References m_blockOrder, and FieldRes::m_dataWindow.
Referenced by begin(), begin(), clear(), and getGrainBounds().
SparseField< Data_T >::iterator SparseField< Data_T >::end | ( | const Box3i & | subset | ) |
Iterator pointing one element past the last valid one (for a subset)
Definition at line 1826 of file SparseField.h.
References m_blockOrder.
SparseField< Data_T >::block_iterator SparseField< Data_T >::blockBegin | ( | ) | const |
Definition at line 1837 of file SparseField.h.
References blockEnd(), FieldRes::dataResolution(), and m_blockRes.
SparseField< Data_T >::block_iterator SparseField< Data_T >::blockEnd | ( | ) | const |
Const iterator pointing to element one past the last valid block.
Definition at line 1849 of file SparseField.h.
References m_blockRes.
Referenced by blockBegin().
void SparseField< Data_T >::addReference | ( | const std::string & | filename, |
const std::string & | layerPath, | ||
int | valuesPerBlock, | ||
int | numVoxels, | ||
int | occupiedBlocks ) |
Internal function to create a Reference for the current field, for use in dynamic reading.
Definition at line 1379 of file SparseField.h.
References m_fileId, m_fileManager, m_numBlocks, and SparseFileManager::singleton().
Referenced by copySparseField().
void SparseField< Data_T >::setupReferenceBlocks | ( | ) |
Internal function to setup the Reference's block pointers, for use with dynamic reading.
Definition at line 1413 of file SparseField.h.
References SparseFile::Reference< Data_T >::blocks, SparseFile::Reference< Data_T >::fileBlockIndices, m_blocks, m_fileId, m_fileManager, and m_numBlocks.
Referenced by copySparseField().
|
inlineprotectedvirtual |
Subclasses should re-implement this if they need to perform memory allocations, etc. every time the size of the storage changes.
Reimplemented from ResizableField< Data_T >.
Definition at line 587 of file SparseField.h.
|
protected |
Initializes the block structure. Will clear any existing data.
Definition at line 1858 of file SparseField.h.
References blockRes(), m_blockOrder, m_blockRes, m_blocks, m_blockXYSize, FieldRes::m_dataWindow, and m_numBlocks.
Referenced by clear(), copySparseField(), setBlockOrder(), SparseField< half >::sizeChanged(), and SparseField().
|
protected |
Deallocated the data of the given block and sets its empty value.
Block::clear() deallocates the data
Definition at line 1970 of file SparseField.h.
References Sparse::SparseBlock< Data_T >::clear(), Sparse::SparseBlock< Data_T >::emptyValue, and Sparse::SparseBlock< Data_T >::isAllocated.
Referenced by releaseBlocks(), and setBlockEmptyValue().
|
private |
Copies internal data, including blocks, from another SparseField, used by copy constructor and operator=.
Definition at line 1341 of file SparseField.h.
References addReference(), copyBlockStates(), Sparse::SparseBlock< Data_T >::emptyValue, SparseFile::Reference< Data_T >::filename, Sparse::SparseBlock< Data_T >::isAllocated, SparseFile::Reference< Data_T >::layerPath, m_blockOrder, m_blockRes, m_blocks, m_blockXYSize, m_fileId, m_fileManager, m_numBlocks, SparseFile::Reference< Data_T >::numVoxels, SparseFile::Reference< Data_T >::occupiedBlocks, setupBlocks(), setupReferenceBlocks(), SparseField(), and SparseFile::Reference< Data_T >::valuesPerBlock.
Referenced by operator=(), and SparseField().
|
private |
Internal function to copy empty values and allocated flags, without copying data, used when copying a dynamically read field.
Definition at line 1399 of file SparseField.h.
References Sparse::SparseBlock< Data_T >::emptyValue, Sparse::SparseBlock< Data_T >::isAllocated, m_blocks, m_numBlocks, and SparseField().
Referenced by copySparseField().
|
friend |
Definition at line 578 of file SparseField.h.
SparseField< Data_T >::DEFINE_FIELD_RTTI_CONCRETE_CLASS |
Definition at line 366 of file SparseField.h.
SparseField< Data_T >::FIELD3D_CLASSNAME_CLASSTYPE_IMPLEMENTATION |
Definition at line 515 of file SparseField.h.
|
protected |
Block order (size = 2^blockOrder)
Definition at line 610 of file SparseField.h.
Referenced by begin(), begin(), blockOrder(), blockSize(), cbegin(), cbegin(), cend(), cend(), copySparseField(), end(), end(), fastLValue(), fastValue(), getBlockCoord(), getGrainBounds(), getVoxelInBlock(), memSize(), setBlockOrder(), setupBlocks(), SparseField(), SparseField(), and voxelCount().
|
protected |
Block array resolution.
Definition at line 612 of file SparseField.h.
Referenced by blockBegin(), blockEnd(), blockId(), blockIndexIsValid(), blockRes(), copySparseField(), getGrainBounds(), releaseBlocks(), and setupBlocks().
|
protected |
Block array res.x * res.y.
Definition at line 614 of file SparseField.h.
Referenced by blockId(), copySparseField(), and setupBlocks().
|
protected |
Array of blocks. Not using std::vector since SparseBlock is noncopyable.
Definition at line 616 of file SparseField.h.
Referenced by blockData(), blockIsAllocated(), clear(), copyBlockStates(), copySparseField(), fastLValue(), fastValue(), getBlockEmptyValue(), memSize(), releaseBlocks(), setBlockEmptyValue(), setupBlocks(), setupReferenceBlocks(), SparseField(), SparseField(), voxelCount(), and ~SparseField().
|
protected |
Number of blocks in field.
Definition at line 618 of file SparseField.h.
Referenced by addReference(), clear(), copyBlockStates(), copySparseField(), memSize(), numGrains(), releaseBlocks(), setupBlocks(), setupReferenceBlocks(), and voxelCount().
|
protected |
Pointer to SparseFileManager. Used when doing dynamic reading. NULL if not in use.
Definition at line 622 of file SparseField.h.
Referenced by activateBlock(), addReference(), copySparseField(), decBlockRef(), fastLValue(), fastValue(), incBlockRef(), setupReferenceBlocks(), SparseField(), SparseField(), and ~SparseField().
|
protected |
File id. Used with m_fileManager if active. Otherwise -1.
Definition at line 624 of file SparseField.h.
Referenced by activateBlock(), addReference(), copySparseField(), decBlockRef(), fastValue(), incBlockRef(), setupReferenceBlocks(), and ~SparseField().
|
protected |
Dummy value used when needing to return but indicating a failed call.
Definition at line 627 of file SparseField.h.
Referenced by fastLValue().
|
staticprivate |
Definition at line 633 of file SparseField.h.
Referenced by SparseField< half >::staticClassType().