Field3D
DenseField< Data_T > Class Template Reference

This subclass of Field stores data in a contiguous std::vector. More...

#include <DenseField.h>

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

Classes

class  const_iterator
 
class  iterator
 

Public Types

typedef ResizableField< Data_T > base
 
typedef DenseField< Data_T > class_type
 
typedef CubicGenericFieldInterp< DenseField< Data_T > > CubicInterp
 
typedef LinearGenericFieldInterp< DenseField< Data_T > > LinearInterp
 
typedef boost::intrusive_ptr< DenseFieldPtr
 
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
 
typedef boost::weak_ptr< RefBaseWeakPtr
 

Public Member Functions

virtual void clear (const Data_T &value)
 Clears all the voxels in the storage. More...
 
Data_T & fastLValue (int i, int j, int k)
 Write access to voxel. Notice that this is non-virtual. More...
 
const Data_T & fastValue (int i, int j, int k) const
 Read access to voxel. Notice that this is non-virtual. More...
 
bool getGrainBounds (const size_t idx, Box3i &vsBounds) const
 Bounding box of the given 'grain'. More...
 
const FIELD3D_VEC3_T< size_t > & internalMemSize () const
 Returns the internal memory size in each dimension. This is used for example in LinearInterpolator, where it optimizes random access to voxels. More...
 
size_t numGrains () const
 Number of 'grains' to use with threaded access. More...
 
Constructors & destructor
 DenseField ()
 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...
 
Iterators
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...
 
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 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...
 
virtual void mappingChanged ()
 Tells the subclass that the mapping changed. 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...
 
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...
 
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...
 

Static Public Member Functions

static DEFINE_FIELD_RTTI_CONCRETE_CLASS const char * staticClassName ()
 
static const char * staticClassType ()
 
- Static Public Member Functions inherited from ResizableField< Data_T >
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 ()
 

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

Protected Attributes

std::vector< Data_T > m_data
 Field storage. More...
 
FIELD3D_VEC3_T< size_t > m_memSize
 Memory allocation size in each dimension. More...
 
size_t m_memSizeXY
 X scanline * Y scanline size. 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 Member Functions

Data_T * ptr (int i, int j, int k)
 Returns a pointer to a given element. Used by the iterators mainly. More...
 
const Data_T * ptr (int i, int j, int k) const
 Returns a pointer to a given element. Used by the iterators mainly. More...
 

Static Private Attributes

static TemplatedFieldType< DenseField< Data_T > > ms_classType
 

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

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
 
- Static Protected Attributes inherited from ResizableField< Data_T >
static TemplatedFieldType< ResizableField< Data_T > > ms_classType
 

Detailed Description

template<class Data_T>
class DenseField< Data_T >

This subclass of Field stores data in a contiguous std::vector.

Regarding threading granularity - DenseField considers each scanline (i.e. continuous X coords) to be one grain. Thus, numGrains is res.y * res.z.

Refer to using_fields for examples of how to use this in your code.

Definition at line 85 of file DenseField.h.

Member Typedef Documentation

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

Definition at line 92 of file DenseField.h.

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

Definition at line 93 of file DenseField.h.

template<class Data_T>
typedef LinearGenericFieldInterp<DenseField<Data_T> > DenseField< Data_T >::LinearInterp

Definition at line 95 of file DenseField.h.

template<class Data_T>
typedef CubicGenericFieldInterp<DenseField<Data_T> > DenseField< Data_T >::CubicInterp

Definition at line 96 of file DenseField.h.

template<class Data_T>
typedef ResizableField<Data_T> DenseField< Data_T >::base

Definition at line 98 of file DenseField.h.

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

Definition at line 132 of file DenseField.h.

Constructor & Destructor Documentation

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

Constructs an empty buffer.

Definition at line 446 of file DenseField.h.

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

447  : base(),
448  m_memSize(0), m_memSizeXY(0)
449 {
450  // Empty
451 }
FIELD3D_VEC3_T< size_t > m_memSize
Memory allocation size in each dimension.
Definition: DenseField.h:220
size_t m_memSizeXY
X scanline * Y scanline size.
Definition: DenseField.h:222
ResizableField< Data_T > base
Definition: DenseField.h:98

Member Function Documentation

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

Clears all the voxels in the storage.

Reimplemented from WritableField< Data_T >.

Definition at line 456 of file DenseField.h.

References DenseField< Data_T >::m_data, and DenseField< Data_T >::value().

457 {
458  std::fill(m_data.begin(), m_data.end(), value);
459 }
std::vector< Data_T > m_data
Field storage.
Definition: DenseField.h:224
virtual Data_T value(int i, int j, int k) const
Read access to a voxel. The coordinates are in integer voxel space .
Definition: DenseField.h:493
template<class Data_T >
size_t DenseField< Data_T >::numGrains ( ) const

Number of 'grains' to use with threaded access.

Definition at line 464 of file DenseField.h.

References FieldRes::m_dataWindow.

465 {
466  // Grain resolution
467  const V3i res = base::m_dataWindow.size() + V3i(1);
468  // Num grains is Y * Z
469  return res.y * res.z;
470 }
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:315
Imath::V3i V3i
Definition: SpiMathLib.h:71
template<class Data_T >
bool DenseField< Data_T >::getGrainBounds ( const size_t  idx,
Box3i vsBounds 
) const

Bounding box of the given 'grain'.

Definition at line 475 of file DenseField.h.

References clipBounds(), DenseField< Data_T >::end(), and FieldRes::m_dataWindow.

476 {
477  // Grain resolution
478  const V3i res = base::m_dataWindow.size() + V3i(1);
479  // Compute coordinate
480  const int y = idx % res.y;
481  const int z = idx / res.y;
482  // Build bbox
483  const V3i start = base::m_dataWindow.min + V3i(0, y, z);
484  const V3i end = base::m_dataWindow.min + V3i(res.x, y, z);
485  bounds = Field3D::clipBounds(Box3i(start, end), base::m_dataWindow);
486  // Done
487  return true;
488 }
Box3i clipBounds(const Box3i &bbox, const Box3i &bounds)
Definition: Field.h:1144
Imath::Box3i Box3i
Definition: SpiMathLib.h:77
iterator end()
Iterator pointing one element past the last valid one.
Definition: DenseField.h:623
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:315
Imath::V3i V3i
Definition: SpiMathLib.h:71
template<class Data_T >
Data_T DenseField< 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 493 of file DenseField.h.

References DenseField< Data_T >::fastValue().

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

494 {
495  return fastValue(i, j, k);
496 }
const Data_T & fastValue(int i, int j, int k) const
Read access to voxel. Notice that this is non-virtual.
Definition: DenseField.h:519
template<class Data_T >
long long int DenseField< 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 501 of file DenseField.h.

References DenseField< Data_T >::m_data, and FieldRes::memSize().

502 {
503  long long int superClassMemSize = base::memSize();
504  long long int vectorMemSize = m_data.capacity() * sizeof(Data_T);
505  return sizeof(*this) + vectorMemSize + superClassMemSize;
506 }
std::vector< Data_T > m_data
Field storage.
Definition: DenseField.h:224
virtual long long int memSize() const
Returns the memory usage (in bytes)
Definition: Field.h:284
template<class Data_T>
static DEFINE_FIELD_RTTI_CONCRETE_CLASS const char* DenseField< Data_T >::staticClassName ( )
inlinestatic

Definition at line 135 of file DenseField.h.

136  {
137  return "DenseField";
138  }
template<class Data_T>
static const char* DenseField< Data_T >::staticClassType ( )
inlinestatic

Definition at line 140 of file DenseField.h.

References DenseField< Data_T >::begin(), DenseField< Data_T >::cbegin(), DenseField< Data_T >::cend(), DenseField< Data_T >::end(), DenseField< Data_T >::fastLValue(), DenseField< Data_T >::fastValue(), DenseField< Data_T >::lvalue(), and FieldBase::name.

141  {
143  }
This subclass of Field stores data in a contiguous std::vector.
Definition: DenseField.h:85
std::string name
Optional name of the field.
Definition: Field.h:176
template<class Data_T >
Data_T & DenseField< 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 511 of file DenseField.h.

References DenseField< Data_T >::fastLValue().

Referenced by DenseField< Data_T >::staticClassType().

512 {
513  return fastLValue(i, j, k);
514 }
Data_T & fastLValue(int i, int j, int k)
Write access to voxel. Notice that this is non-virtual.
Definition: DenseField.h:538
template<class Data_T >
const Data_T & DenseField< Data_T >::fastValue ( int  i,
int  j,
int  k 
) const

Read access to voxel. Notice that this is non-virtual.

Definition at line 519 of file DenseField.h.

References DenseField< Data_T >::m_data, FieldRes::m_dataWindow, DenseField< Data_T >::m_memSize, and DenseField< Data_T >::m_memSizeXY.

Referenced by DenseField< Data_T >::staticClassType(), and DenseField< Data_T >::value().

520 {
521  assert (i >= base::m_dataWindow.min.x);
522  assert (i <= base::m_dataWindow.max.x);
523  assert (j >= base::m_dataWindow.min.y);
524  assert (j <= base::m_dataWindow.max.y);
525  assert (k >= base::m_dataWindow.min.z);
526  assert (k <= base::m_dataWindow.max.z);
527  // Add crop window offset
528  i -= base::m_dataWindow.min.x;
529  j -= base::m_dataWindow.min.y;
530  k -= base::m_dataWindow.min.z;
531  // Access data
532  return m_data[i + j * m_memSize.x + k * m_memSizeXY];
533 }
FIELD3D_VEC3_T< size_t > m_memSize
Memory allocation size in each dimension.
Definition: DenseField.h:220
std::vector< Data_T > m_data
Field storage.
Definition: DenseField.h:224
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:315
size_t m_memSizeXY
X scanline * Y scanline size.
Definition: DenseField.h:222
template<class Data_T >
Data_T & DenseField< Data_T >::fastLValue ( int  i,
int  j,
int  k 
)

Write access to voxel. Notice that this is non-virtual.

Definition at line 538 of file DenseField.h.

References DenseField< Data_T >::m_data, FieldRes::m_dataWindow, DenseField< Data_T >::m_memSize, and DenseField< Data_T >::m_memSizeXY.

Referenced by DenseField< Data_T >::lvalue(), and DenseField< Data_T >::staticClassType().

539 {
540  assert (i >= base::m_dataWindow.min.x);
541  assert (i <= base::m_dataWindow.max.x);
542  assert (j >= base::m_dataWindow.min.y);
543  assert (j <= base::m_dataWindow.max.y);
544  assert (k >= base::m_dataWindow.min.z);
545  assert (k <= base::m_dataWindow.max.z);
546  // Add crop window offset
547  i -= base::m_dataWindow.min.x;
548  j -= base::m_dataWindow.min.y;
549  k -= base::m_dataWindow.min.z;
550  // Access data
551  return m_data[i + j * m_memSize.x + k * m_memSizeXY];
552 }
FIELD3D_VEC3_T< size_t > m_memSize
Memory allocation size in each dimension.
Definition: DenseField.h:220
std::vector< Data_T > m_data
Field storage.
Definition: DenseField.h:224
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:315
size_t m_memSizeXY
X scanline * Y scanline size.
Definition: DenseField.h:222
template<class Data_T >
DenseField< Data_T >::const_iterator DenseField< Data_T >::cbegin ( ) const

Const iterator to first element. "cbegin" matches the tr1 c++ standard.

Definition at line 558 of file DenseField.h.

References DenseField< Data_T >::cend(), FieldRes::dataResolution(), and FieldRes::m_dataWindow.

Referenced by DenseField< Data_T >::staticClassType().

559 {
560  if (FieldRes::dataResolution() == V3i(0))
561  return cend();
562  return const_iterator(*this, base::m_dataWindow, base::m_dataWindow.min);
563 }
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:315
Imath::V3i V3i
Definition: SpiMathLib.h:71
V3i const dataResolution() const
Definition: Field.h:261
const_iterator cend() const
Const iterator pointing one element past the last valid one.
Definition: DenseField.h:580
template<class Data_T >
DenseField< Data_T >::const_iterator DenseField< Data_T >::cbegin ( const Box3i subset) const

Const iterator to first element of specific subset.

Definition at line 569 of file DenseField.h.

References DenseField< Data_T >::cend().

570 {
571  if (subset.isEmpty())
572  return cend(subset);
573  return const_iterator(*this, subset, subset.min);
574 }
const_iterator cend() const
Const iterator pointing one element past the last valid one.
Definition: DenseField.h:580
template<class Data_T >
DenseField< Data_T >::const_iterator DenseField< Data_T >::cend ( ) const

Const iterator pointing one element past the last valid one.

Definition at line 580 of file DenseField.h.

References FieldRes::m_dataWindow.

Referenced by DenseField< Data_T >::cbegin(), and DenseField< Data_T >::staticClassType().

581 {
582  return const_iterator(*this, base::m_dataWindow,
583  V3i(base::m_dataWindow.min.x,
584  base::m_dataWindow.min.y,
585  base::m_dataWindow.max.z + 1));
586 }
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:315
Imath::V3i V3i
Definition: SpiMathLib.h:71
template<class Data_T >
DenseField< Data_T >::const_iterator DenseField< Data_T >::cend ( const Box3i subset) const

Const iterator pointing one element past the last valid one (for a subset)

Definition at line 592 of file DenseField.h.

593 {
594  return const_iterator(*this, subset,
595  V3i(subset.min.x, subset.min.y, subset.max.z + 1));
596 }
Imath::V3i V3i
Definition: SpiMathLib.h:71
template<class Data_T >
DenseField< Data_T >::iterator DenseField< Data_T >::begin ( )

Iterator to first element.

Definition at line 602 of file DenseField.h.

References FieldRes::dataResolution(), DenseField< Data_T >::end(), and FieldRes::m_dataWindow.

Referenced by DenseFieldIO::readData(), DenseField< Data_T >::staticClassType(), and DenseFieldIO::writeData().

603 {
604  if (FieldRes::dataResolution() == V3i(0))
605  return end();
606  return iterator(*this, base::m_dataWindow, base::m_dataWindow.min); }
iterator end()
Iterator pointing one element past the last valid one.
Definition: DenseField.h:623
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:315
Imath::V3i V3i
Definition: SpiMathLib.h:71
V3i const dataResolution() const
Definition: Field.h:261
template<class Data_T >
DenseField< Data_T >::iterator DenseField< Data_T >::begin ( const Box3i subset)

Iterator to first element of specific subset.

Definition at line 612 of file DenseField.h.

References DenseField< Data_T >::end().

613 {
614  if (subset.isEmpty())
615  return end(subset);
616  return iterator(*this, subset, subset.min);
617 }
iterator end()
Iterator pointing one element past the last valid one.
Definition: DenseField.h:623
template<class Data_T >
DenseField< Data_T >::iterator DenseField< Data_T >::end ( )

Iterator pointing one element past the last valid one.

Definition at line 623 of file DenseField.h.

References FieldRes::m_dataWindow.

Referenced by DenseField< Data_T >::begin(), DenseField< Data_T >::getGrainBounds(), and DenseField< Data_T >::staticClassType().

624 {
625  return iterator(*this, base::m_dataWindow,
626  V3i(base::m_dataWindow.min.x,
627  base::m_dataWindow.min.y,
628  base::m_dataWindow.max.z + 1));
629 }
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:315
Imath::V3i V3i
Definition: SpiMathLib.h:71
template<class Data_T >
DenseField< Data_T >::iterator DenseField< Data_T >::end ( const Box3i subset)

Iterator pointing one element past the last valid one (for a subset)

Definition at line 635 of file DenseField.h.

636 {
637  return iterator(*this, subset,
638  V3i(subset.min.x, subset.min.y, subset.max.z + 1));
639 }
Imath::V3i V3i
Definition: SpiMathLib.h:71
template<class Data_T>
const FIELD3D_VEC3_T<size_t>& DenseField< Data_T >::internalMemSize ( ) const
inline

Returns the internal memory size in each dimension. This is used for example in LinearInterpolator, where it optimizes random access to voxels.

Definition at line 196 of file DenseField.h.

References DenseField< Data_T >::m_memSize.

Referenced by DenseFieldIO::writeInternal().

197  { return m_memSize; }
FIELD3D_VEC3_T< size_t > m_memSize
Memory allocation size in each dimension.
Definition: DenseField.h:220
template<class Data_T>
virtual FieldBase::Ptr DenseField< 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 206 of file DenseField.h.

References DenseField< Data_T >::DenseField(), and DenseField< Data_T >::sizeChanged().

207  { return Ptr(new DenseField(*this)); }
DenseField()
Constructs an empty buffer.
Definition: DenseField.h:446
boost::intrusive_ptr< DenseField > Ptr
Definition: DenseField.h:92
template<class Data_T >
void DenseField< Data_T >::sizeChanged ( )
protectedvirtual

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 from ResizableField< Data_T >.

Definition at line 644 of file DenseField.h.

References DenseField< Data_T >::m_data, FieldRes::m_dataWindow, DenseField< Data_T >::m_memSize, DenseField< Data_T >::m_memSizeXY, and ResizableField< Data_T >::sizeChanged().

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

645 {
646  // Call base class
648 
649  // Calculate offsets
652 
653  // Check that mem size is >= 0 in all dimensions
654  if (base::m_dataWindow.max.x < base::m_dataWindow.min.x ||
655  base::m_dataWindow.max.y < base::m_dataWindow.min.y ||
657  throw Exc::ResizeException("Attempt to resize ResizableField object "
658  "using negative size. Data window was: " +
659  boost::lexical_cast<std::string>(
660  base::m_dataWindow.min) + " - " +
661  boost::lexical_cast<std::string>(
662  base::m_dataWindow.max));
663 
664  // Allocate memory
665  try {
666  std::vector<Data_T>().swap(m_data);
667  m_data.resize(m_memSize.x * m_memSize.y * m_memSize.z);
668  }
669  catch (std::bad_alloc &) {
670  throw Exc::MemoryException("Couldn't allocate DenseField of size " +
671  boost::lexical_cast<std::string>(m_memSize));
672  }
673 }
FIELD3D_VEC3_T< size_t > m_memSize
Memory allocation size in each dimension.
Definition: DenseField.h:220
std::vector< Data_T > m_data
Field storage.
Definition: DenseField.h:224
virtual void sizeChanged()
Subclasses should re-implement this if they need to perform memory allocations, etc. every time the size of the storage changes.
Definition: Field.h:906
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:315
size_t m_memSizeXY
X scanline * Y scanline size.
Definition: DenseField.h:222
Imath::V3i V3i
Definition: SpiMathLib.h:71
template<class Data_T >
Data_T * DenseField< Data_T >::ptr ( int  i,
int  j,
int  k 
)
inlineprivate

Returns a pointer to a given element. Used by the iterators mainly.

Definition at line 678 of file DenseField.h.

References DenseField< Data_T >::m_data, FieldRes::m_dataWindow, DenseField< Data_T >::m_memSize, and DenseField< Data_T >::m_memSizeXY.

679 {
680  // Add crop window offset
681  i -= base::m_dataWindow.min.x;
682  j -= base::m_dataWindow.min.y;
683  k -= base::m_dataWindow.min.z;
684  // Access data
685  return &m_data[i + j * m_memSize.x + k * m_memSizeXY];
686 }
FIELD3D_VEC3_T< size_t > m_memSize
Memory allocation size in each dimension.
Definition: DenseField.h:220
std::vector< Data_T > m_data
Field storage.
Definition: DenseField.h:224
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:315
size_t m_memSizeXY
X scanline * Y scanline size.
Definition: DenseField.h:222
template<class Data_T >
const Data_T * DenseField< Data_T >::ptr ( int  i,
int  j,
int  k 
) const
inlineprivate

Returns a pointer to a given element. Used by the iterators mainly.

Definition at line 691 of file DenseField.h.

References FIELD3D_CLASSTYPE_TEMPL_INSTANTIATION(), FIELD3D_NAMESPACE_HEADER_CLOSE, DenseField< Data_T >::m_data, FieldRes::m_dataWindow, DenseField< Data_T >::m_memSize, and DenseField< Data_T >::m_memSizeXY.

692 {
693  // Add crop window offset
694  i -= base::m_dataWindow.min.x;
695  j -= base::m_dataWindow.min.y;
696  k -= base::m_dataWindow.min.z;
697  // Access data
698  return &m_data[i + j * m_memSize.x + k * m_memSizeXY];
699 }
FIELD3D_VEC3_T< size_t > m_memSize
Memory allocation size in each dimension.
Definition: DenseField.h:220
std::vector< Data_T > m_data
Field storage.
Definition: DenseField.h:224
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.
Definition: Field.h:315
size_t m_memSizeXY
X scanline * Y scanline size.
Definition: DenseField.h:222

Member Data Documentation

template<class Data_T>
DenseField< Data_T >::FIELD3D_CLASSNAME_CLASSTYPE_IMPLEMENTATION

Definition at line 204 of file DenseField.h.

template<class Data_T>
FIELD3D_VEC3_T<size_t> DenseField< Data_T >::m_memSize
protected
template<class Data_T>
size_t DenseField< Data_T >::m_memSizeXY
protected
template<class Data_T>
TemplatedFieldType<DenseField<Data_T> > DenseField< Data_T >::ms_classType
staticprivate

Definition at line 230 of file DenseField.h.


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