Field3D
FieldRes Class Reference

#include <Field.h>

Inheritance diagram for FieldRes:
FieldBase RefBase Field

List of all members.

Public Types

typedef FieldRes class_type
typedef boost::intrusive_ptr
< FieldRes
Ptr
typedef std::vector< PtrVec

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 long long int memSize () const
 Returns the memory usage (in bytes)
void setMapping (FieldMapping::Ptr mapping)
 Sets the field's mapping.

Static Public Member Functions

static const char * classType ()
static const char * staticClassName ()

Public Attributes

 DEFINE_FIELD_RTTI_ABSTRACT_CLASS

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.


Member Typedef Documentation

typedef boost::intrusive_ptr<FieldRes> FieldRes::Ptr

Reimplemented from FieldBase.

Reimplemented in Field.

Definition at line 215 of file Field.h.

typedef std::vector<Ptr> FieldRes::Vec

Reimplemented in Field.

Definition at line 216 of file Field.h.

Reimplemented from FieldBase.

Reimplemented in Field.

Definition at line 220 of file Field.h.

Definition at line 288 of file Field.h.

typedef FieldBase FieldRes::base [private]

Convenience typedef for referring to base class.

Reimplemented in Field.

Definition at line 308 of file Field.h.


Constructor & Destructor Documentation

FieldRes::FieldRes ( ) [inline]

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

Definition at line 314 of file Field.h.

References m_extents, m_dataWindow, and m_mapping.

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 324 of file Field.h.

References m_mapping, and mapping().

  : FieldBase(src)
{
  // Call base class first
  // FieldBase(src);
  // Copy self
  *this = src;
  m_mapping = src.mapping()->clone();
}

Member Function Documentation

virtual std::string FieldRes::dataTypeString ( ) const [inline, virtual]

Reimplemented in Field.

Definition at line 223 of file Field.h.

    { return std::string("FieldRes"); }
static const char* FieldRes::staticClassName ( ) [inline, static]

Reimplemented from FieldBase.

Reimplemented in Field.

Definition at line 226 of file Field.h.

  {
    return "FieldRes";
  }
static const char* FieldRes::classType ( ) [inline, static]

Reimplemented from FieldBase.

Reimplemented in Field.

Definition at line 231 of file Field.h.

  {
    return staticClassName();
  }
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 251 of file Field.h.

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

  { return m_extents; }
const Box3i& FieldRes::dataWindow ( ) const [inline]

Returns the data window. Any coordinate inside this window is safe to pass to value() in the Field subclass.

Definition at line 255 of file Field.h.

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

  { return m_dataWindow; }
void FieldRes::setMapping ( FieldMapping::Ptr  mapping) [inline]

Sets the field's mapping.

Definition at line 336 of file Field.h.

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

Referenced by ResizableField< Data_T >::copyFrom(), and ResizableField< Data_T >::matchDefinition().

{ 
  if (mapping) {
    m_mapping = mapping->clone(); 
    m_mapping->setExtents(m_extents); 
  } else {
    Msg::print(Msg::SevWarning, 
               "Tried to call FieldRes::setMapping with null pointer");
  }
}
FieldMapping::Ptr FieldRes::mapping ( ) [inline]

Returns a pointer to the mapping.

Definition at line 265 of file Field.h.

Referenced by FieldRes(), ResizableField< Data_T >::copyFrom(), sameDefinition(), Field3DOutputFile::createNewPartition(), Field3DOutputFile::writeLayer(), and wsSample().

  { return m_mapping; }
const FieldMapping::Ptr FieldRes::mapping ( ) const [inline]

Returns a pointer to the mapping.

Definition at line 269 of file Field.h.

  { return m_mapping; }
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 349 of file Field.h.

References m_dataWindow.

{
  // Check bounds
  if (i < m_dataWindow.min.x || i > m_dataWindow.max.x ||
      j < m_dataWindow.min.y || j > m_dataWindow.max.y ||
      k < m_dataWindow.min.z || k > m_dataWindow.max.z) {
    return false;
  }

  return true;
}
virtual long long int FieldRes::memSize ( ) const [inline, 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.

Definition at line 281 of file Field.h.

  { return sizeof(*this); }

Member Data Documentation

Reimplemented in Field.

Definition at line 221 of file Field.h.

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 296 of file Field.h.

Referenced by FieldRes(), and setMapping().

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

Definition at line 299 of file Field.h.

Referenced by FieldRes(), isInBounds(), Field< Data_T >::cbegin(), and Field< Data_T >::cend().

Pointer to the field's mapping.

Definition at line 301 of file Field.h.

Referenced by FieldRes(), and setMapping().


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