Field3D
FieldRes Class Reference

#include <Field.h>

Inheritance diagram for FieldRes:
FieldBase RefBase MetadataCallback Field< Field_T::value_type > Field< Data_T > MIPBase< Field_T::value_type > MIPBase< DenseField< Data_T >::value_type > MIPBase< SparseField< Data_T >::value_type > MIPBase< Data_T > ProceduralField< Data_T > WritableField< Data_T > MIPField< Field_T > MIPField< DenseField< Data_T > > MIPField< SparseField< Data_T > > ResizableField< Data_T > MIPDenseField< Data_T > MIPSparseField< Data_T > DenseField< Data_T > EmptyField< Data_T > MACField< Data_T > SparseField< Data_T >

Public Types

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

V3i const dataResolution () const
 
virtual std::string dataTypeString () const
 
const Box3idataWindow () const
 Returns the data window. Any coordinate inside this window is safe to pass to value() in the Field subclass.
 
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.
 
 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.
 
- Public Member Functions inherited from FieldBase
 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.
 
FieldMetadatametadata ()
 accessor to the m_metadata class
 
const FieldMetadatametadata () const
 Read only access to the m_metadata class.
 
void copyMetadata (const FieldBase &field)
 Copies the metadata from a second field.
 
- Public Member Functions inherited from RefBase
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.
 
RefBaseoperator= (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.
 
- Public Member Functions inherited from MetadataCallback
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 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 FieldBase
std::string attribute
 Optional name of the attribute the field represents.
 
std::string name
 Optional name of the field.
 

Protected Types

typedef MatrixFieldMapping default_mapping
 

Protected Attributes

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 Types

typedef FieldBase base
 Convenience typedef for referring to base class.
 

Detailed Description

This class serves to isolate the extents and data window from its templated subclasses. Thus, anything that needs to access the extents or data window don't need to know about what data type the subclass is templated on.

It also owns the field's mapping.

Why do we have both an extent and a data window? The extents are used to define which range of voxels define the [0..1] local coordinate system. The data window in turn defines the voxels that are legal to read/write from. Thus, for optimization we may have a large extents but a small data window, or a small extents and a larger data window which would let us apply large-kernel filters without having to deal with boundary conditions.

Definition at line 207 of file Field.h.

Member Typedef Documentation

◆ Ptr

boost::intrusive_ptr<FieldRes> FieldRes::Ptr

Definition at line 213 of file Field.h.

◆ Vec

std::vector<Ptr> FieldRes::Vec

Definition at line 214 of file Field.h.

◆ class_type

Definition at line 218 of file Field.h.

◆ default_mapping

Definition at line 299 of file Field.h.

◆ base

Convenience typedef for referring to base class.

Definition at line 319 of file Field.h.

Constructor & Destructor Documentation

◆ FieldRes() [1/2]

FieldRes::FieldRes ( )
inline

This constructor ensures that we have a valid mapping at all times.

Definition at line 325 of file Field.h.

327{
328 m_extents = Box3i(V3i(0), V3i(-1));
330 m_mapping->setExtents(m_extents);
331}
Imath::V3i V3i
Definition SpiMathLib.h:71
Imath::Box3i Box3i
Definition SpiMathLib.h:77
Box3i m_extents
Defines the extents of the the storage. This may be larger or smaller than the data window,...
Definition Field.h:307
Box3i m_dataWindow
Defines the area where data is allocated. This should be treated as a closed (i.e....
Definition Field.h:310
FieldMapping::Ptr m_mapping
Pointer to the field's mapping.
Definition Field.h:312
MatrixFieldMapping default_mapping
Definition Field.h:299

References m_dataWindow, m_extents, and m_mapping.

◆ FieldRes() [2/2]

FieldRes::FieldRes ( const FieldRes & src)
inline

Base class copy constructor.

Todo
OSS Go over the copy constructing - is it implemented right? 8hr

Definition at line 335 of file Field.h.

336 : FieldBase(src)
337{
338 // Call base class first
339 // FieldBase(src);
340 // Copy self
341 *this = src;
342 m_mapping = src.mapping()->clone();
343}
FieldBase()
Constructor.
Definition Field.cpp:54
FieldMapping::Ptr mapping()
Returns a pointer to the mapping.
Definition Field.h:263

References FieldBase::clone(), m_mapping, and mapping().

Member Function Documentation

◆ dataTypeString()

virtual std::string FieldRes::dataTypeString ( ) const
inlinevirtual

Reimplemented in Field< Data_T >, and Field< Field_T::value_type >.

Definition at line 221 of file Field.h.

222 { return std::string("FieldRes"); }

◆ staticClassName()

static const char * FieldRes::staticClassName ( )
inlinestatic

Definition at line 224 of file Field.h.

225 {
226 return "FieldRes";
227 }

Referenced by staticClassType().

◆ staticClassType()

static const char * FieldRes::staticClassType ( )
inlinestatic

Definition at line 229 of file Field.h.

230 {
231 return staticClassName();
232 }
static const char * staticClassName()
Definition Field.h:224

References staticClassName().

◆ extents()

const Box3i & FieldRes::extents ( ) const
inline

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.

Definition at line 249 of file Field.h.

250 { return m_extents; }

References m_extents.

Referenced by convertCellCenteredToMAC(), convertMACToCellCentered(), ResizableField< Data_T >::copyFrom(), ResizableField< Data_T >::copyFrom(), and sameDefinition().

◆ dataWindow()

◆ dataResolution()

◆ setMapping()

void FieldRes::setMapping ( FieldMapping::Ptr mapping)
inline

Sets the field's mapping.

Definition at line 347 of file Field.h.

348{
349 if (mapping) {
350 m_mapping = mapping->clone();
351 m_mapping->setExtents(m_extents);
352 } else {
354 "Tried to call FieldRes::setMapping with null pointer");
355 }
356 // Tell subclasses about the mapping change
358}
virtual void mappingChanged()
Tells the subclass that the mapping changed.
Definition Field.h:283
@ SevWarning
Definition Log.h:68
FIELD3D_API void print(Severity severity, const std::string &message)
Sends the string to the assigned output, prefixing the message with the severity.
Definition Log.cpp:70

References m_extents, m_mapping, mapping(), mappingChanged(), Msg::print(), and Msg::SevWarning.

Referenced by convertCellCenteredToMAC(), ResizableField< Data_T >::copyFrom(), ResizableField< Data_T >::copyFrom(), ResizableField< Data_T >::matchDefinition(), Field3DInputFile::readLayer(), Field3DInputFileHDF5::readLayer(), Field3DInputFile::readProxyLayer(), and Field3DInputFileHDF5::readProxyLayer().

◆ mapping() [1/2]

◆ mapping() [2/2]

const FieldMapping::Ptr FieldRes::mapping ( ) const
inline

Returns a pointer to the mapping.

Definition at line 267 of file Field.h.

268 { return m_mapping; }

References m_mapping.

◆ isInBounds()

bool FieldRes::isInBounds ( int i,
int j,
int k ) const
inline

Returns true is the indicies are in bounds of the data window.

Definition at line 362 of file Field.h.

363{
364 // Check bounds
365 if (i < m_dataWindow.min.x || i > m_dataWindow.max.x ||
366 j < m_dataWindow.min.y || j > m_dataWindow.max.y ||
367 k < m_dataWindow.min.z || k > m_dataWindow.max.z) {
368 return false;
369 }
370
371 return true;
372}

References m_dataWindow.

◆ memSize()

virtual long long int FieldRes::memSize ( ) const
inlinevirtual

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 in DenseField< Data_T >, EmptyField< Data_T >, MACField< Data_T >, MIPField< Field_T >, MIPField< DenseField< Data_T > >, MIPField< SparseField< Data_T > >, and SparseField< Data_T >.

Definition at line 279 of file Field.h.

280 { return sizeof(*this); }

◆ mappingChanged()

virtual void FieldRes::mappingChanged ( )
inlinevirtual

Tells the subclass that the mapping changed.

Reimplemented in MIPField< Field_T >, MIPField< DenseField< Data_T > >, and MIPField< SparseField< Data_T > >.

Definition at line 283 of file Field.h.

284 { /* Empty */ }

Referenced by setMapping().

◆ voxelCount()

virtual size_t FieldRes::voxelCount ( ) const
inlinevirtual

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 in MIPField< Field_T >, MIPField< DenseField< Data_T > >, MIPField< SparseField< Data_T > >, and SparseField< Data_T >.

Definition at line 289 of file Field.h.

290 {
291 V3i res = m_dataWindow.size() + V3i(1);
292 return res.x * res.y * res.z;
293 }

References m_dataWindow.

Member Data Documentation

◆ DEFINE_FIELD_RTTI_ABSTRACT_CLASS

FieldRes::DEFINE_FIELD_RTTI_ABSTRACT_CLASS

Definition at line 219 of file Field.h.

◆ m_extents

Box3i FieldRes::m_extents
protected

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.

Definition at line 307 of file Field.h.

Referenced by extents(), FieldRes(), setMapping(), and ResizableField< Data_T >::sizeChanged().

◆ m_dataWindow

Box3i FieldRes::m_dataWindow
protected

Defines the area where data is allocated. This should be treated as a closed (i.e. inclusive) interval.

Definition at line 310 of file Field.h.

Referenced by SparseField< Data_T >::applyDataWindowOffset(), dataResolution(), dataWindow(), FieldRes(), isInBounds(), and voxelCount().

◆ m_mapping

FieldMapping::Ptr FieldRes::m_mapping
protected

Pointer to the field's mapping.

Definition at line 312 of file Field.h.

Referenced by FieldRes(), FieldRes(), mapping(), mapping(), setMapping(), and ResizableField< Data_T >::sizeChanged().


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