Field3D
MIPSparseField< Data_T > Class Template Reference

#include <MIPField.h>

Inheritance diagram for MIPSparseField< Data_T >:
MIPField< SparseField< Data_T > > MIPBase< SparseField< Data_T >::value_type > Field< SparseField< Data_T >::value_type > FieldRes FieldBase RefBase

Additional Inherited Members

- Public Types inherited from MIPField< SparseField< Data_T > >
typedef MIPField< SparseField< Data_T > > class_type
 
typedef CubicMIPFieldInterp< Data_TCubicInterp
 
typedef SparseField< Data_T >::value_type Data_T
 
typedef SparseField< Data_T >::Ptr FieldPtr
 
typedef std::vector< FieldPtrFieldVec
 
typedef MIPLinearInterp< MIPField< SparseField< Data_T > > > LinearInterp
 
typedef SparseField< Data_TNestedType
 
typedef EmptyField< Data_TProxyField
 
typedef ProxyField::Ptr ProxyPtr
 
typedef std::vector< ProxyPtrProxyVec
 
typedef boost::intrusive_ptr< MIPFieldPtr
 
typedef Data_T value_type
 
typedef std::vector< PtrVec
 
- Public Types inherited from MIPBase< SparseField< Data_T >::value_type >
typedef MIPBase< SparseField< Data_T >::value_typeclass_type
 
typedef boost::intrusive_ptr< MIPBasePtr
 
- Public Types inherited from Field< SparseField< Data_T >::value_type >
typedef Field< SparseField< Data_T >::value_typeclass_type
 
typedef boost::intrusive_ptr< FieldPtr
 
typedef SparseField< Data_T >::value_type 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 inherited from MIPField< SparseField< Data_T > >
void clear ()
 Clears all the levels of the MIP field. More...
 
SparseField< Data_T >::Ptr concreteMipLevel (const size_t level) const
 Returns a concretely typed pointer to a MIP level. More...
 
Data_T fastMipValue (size_t level, int i, int j, int k) const
 Read access to voxel at a given MIP level. More...
 
virtual void getVsMIPCoord (const V3f &vsP, const size_t level, V3f &outVsP) const
 Given a voxel space coordinate in the 0-level field, computes the coordinate in another level. More...
 
virtual bool levelLoaded (const size_t level) const
 Whether a given MIP level is loaded. More...
 
virtual Field< Data_T >::Ptr mipLevel (const size_t level) const
 Returns a MIP level field. More...
 
virtual V3i mipResolution (size_t level) const
 Returns the resolution of a given MIP level. More...
 
virtual Data_T mipValue (size_t level, int i, int j, int k) const
 Read access to a voxel in a given MIP level. More...
 
const SparseField< Data_T > * rawMipLevel (const size_t level) const
 Returns a raw pointer to a MIP level. More...
 
void setup (const FieldVec &fields)
 Sets up the MIP field given a set of non-MIP fields This call performs sanity checking to ensure that MIP properties are satisfied for each level. In this case, all MIP levels are available in memory. More...
 
void setupLazyLoad (const ProxyVec &proxies, const typename LazyLoadAction< SparseField< Data_T > >::Vec &actions)
 Sets up the MIP field in lazy-load mode. More...
 
 MIPField ()
 Constructs an empty MIP field. More...
 
 MIPField (const MIPField &other)
 Copy constructor. We need this because a) we own a mutex and b) we own shared pointers and shallow copies are not good enough. More...
 
const MIPFieldoperator= (const MIPField &rhs)
 Assignment operator. More...
 
virtual long long int memSize () const
 Returns the memory usage (in bytes) More...
 
virtual void mappingChanged ()
 We need to know if the mapping changed so that we may update the MIP levels' mappings. More...
 
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 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...
 
virtual FieldBase::Ptr clone () const
 Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it. More...
 
- Public Member Functions inherited from MIPBase< SparseField< Data_T >::value_type >
size_t lowestLevel () const
 Lowest MIP level to use. More...
 
 MIPBase ()
 
size_t numLevels () const
 Number of MIP levels. More...
 
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. More...
 
- Public Member Functions inherited from Field< SparseField< Data_T >::value_type >
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...
 
void setMapping (FieldMapping::Ptr mapping)
 Sets the field's mapping. 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 inherited from MIPField< SparseField< Data_T > >
static DEFINE_FIELD_RTTI_CONCRETE_CLASS const char * staticClassName ()
 
static const char * staticClassType ()
 
- Static Public Member Functions inherited from MIPBase< SparseField< Data_T >::value_type >
static const char * staticClassName ()
 
static const char * staticClassType ()
 
- Static Public Member Functions inherited from Field< SparseField< Data_T >::value_type >
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 ()
 
- Public Attributes inherited from MIPField< SparseField< Data_T > >
 FIELD3D_CLASSNAME_CLASSTYPE_IMPLEMENTATION
 
- Public Attributes inherited from MIPBase< SparseField< Data_T >::value_type >
 DEFINE_FIELD_RTTI_ABSTRACT_CLASS
 
- Public Attributes inherited from Field< SparseField< Data_T >::value_type >
 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 MIPField< SparseField< Data_T > >
typedef MIPBase< Data_Tbase
 
- Protected Types inherited from MIPBase< SparseField< Data_T >::value_type >
typedef Field< SparseField< Data_T >::value_typebase
 
- Protected Types inherited from FieldRes
typedef MatrixFieldMapping default_mapping
 
- Protected Member Functions inherited from MIPField< SparseField< Data_T > >
const MIPFieldinit (const MIPField &rhs)
 Copies from a second MIPField. More...
 
void loadLevelFromDisk (size_t level) const
 Loads the given level from disk. More...
 
void sanityChecks (const T &fields)
 Sanity checks to ensure that the provided Fields are a MIP representation. More...
 
void updateAuxMembers () const
 Updates the dependent data members based on m_field. More...
 
void updateMapping (FieldRes::Ptr field)
 Updates the mapping, extents and data window to match the given field. Used so that the MIPField will appear to have the same mapping in space as the level-0 field. More...
 
- Protected Attributes inherited from MIPField< SparseField< Data_T > >
std::vector< FieldPtrm_fields
 Storage of all MIP levels. Some or all of the pointers may be NULL. This is mutable because it needs updating during lazy loading of data. More...
 
boost::shared_ptr< boost::mutex > m_ioMutex
 Mutex lock around IO. Used to make sure only one thread reads MIP level data at a time. When a field is cloned, the two new fields will share the mutex, since they point to the same file. More...
 
LazyLoadAction< SparseField< Data_T > >::Vec m_loadActions
 Lazy load actions. Only used if setupLazyLoad() has been called. More...
 
std::vector< V3im_mipRes
 Resolution of each MIP level. More...
 
std::vector< SparseField< Data_T > * > m_rawFields
 Raw pointers to MIP levels. More...
 
std::vector< V3fm_relativeResolution
 Relative resolution of each MIP level. Pre-computed to avoid int-to-float conversions. More...
 
- Protected Attributes inherited from MIPBase< SparseField< Data_T >::value_type >
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. More...
 
size_t m_numLevels
 Number of MIP levels. The default is 1. 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...
 
- Static Protected Attributes inherited from MIPField< SparseField< Data_T > >
static NestedFieldType< MIPField< SparseField< Data_T > > > ms_classType
 
- Static Protected Attributes inherited from MIPBase< SparseField< Data_T >::value_type >
static TemplatedFieldType< MIPBase< SparseField< Data_T >::value_type > > ms_classType
 

Detailed Description

template<typename Data_T>
class MIPSparseField< Data_T >

Definition at line 296 of file MIPField.h.


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