OEGrid

template<class GridType>
class OEGrid : public OEFixedGrid<GridType>

This class represents OEGrid.

The following methods are publicly inherited from OEFixedGrid:

operator() GetDataType SetValues
operator[] GetValues  
CreateCopy IsDataType  

The following methods are publicly inherited from OEGridBase:

Clear GetXMid GetZMin
CreateCopy GetXMin GridIdxToElement
ElementToGridIdx GetY GridIdxToSpatialCoord
ElementToSpatialCoord GetYDim IsDataType
GetDataType GetYIdx IsInGrid
GetDim GetYInc IsSpacingSet
GetMid GetYMax IsTitleSet
GetSize GetYMid IsXMidSet
GetSpacing GetYMin IsYMidSet
GetTitle GetZ IsZMidSet
GetX GetZDim SetTitle
GetXDim GetZIdx SpatialCoordToElement
GetXIdx GetZInc SpatialCoordToGridIdx
GetXInc GetZMax  
GetXMax GetZMid  

The following methods are publicly inherited from OEGridAbstractBase:

Clear GetTitle GetZMid
GetDataType GetXDim IsDataType
GetDim GetXMid IsSpacingSet
GetMid GetYDim SetTitle
GetSize GetYMid  
GetSpacing GetZDim  

The following methods are publicly inherited from OEBase:

operator= GetData IsDataType
operator+= GetDataIter SetBaseData
AddBaseData GetDataType SetBoolData
AddData GetDoubleData SetData
Clear GetFloatData SetDoubleData
CreateCopy GetIntData SetFloatData
DeleteData GetStringData SetIntData
GetBoolData HasData SetStringData
The following classes derive from this class:

Constructors

OEGrid()

Creates a one point OEScalarGrid grid object.

OEGrid(const OEGrid<GridType> &rhs)
OEGrid(const OEFixedGrid<GridType> &rhs)

Creates a OEGrid object and copies the entire contents of the ‘rhs’ grid.

OEGrid(const float minmax[6], float spacing, const char *title="")
OEGrid(const double minmax[6], double spacing, const char *title="")

Creates a OEGrid object from a minimum bounding box (‘minmax’). The size of each length between grid points is determined by the ‘spacing’ parameter. The ‘title’ parameter is provided as a convenience for setting the title upon construction. It can later be retrieved with the OEGridBase.GetTitle method.

OEGrid(int xdim, int ydim, int zdim, float midx, float midy, float midz,
       float spacing, std::string title="", GridType *dataptr=0)

Creates and initializes a OEGrid object. The grid data can be copied from the optional parameter ‘dataptr’. The pointer should be an array of size xdim*ydim*zdim*sizeof(float).

operator=

OEGrid<GridType> &operator=(const OEGrid<GridType> &rhs)
OEGrid<GridType> &operator=(const OEFixedGrid<GridType> &rhs)

Copies the contents of ‘rhs’ grid.

Clear

void Clear()

Reallocates memory for the grid, effectively clearing all the grid values. Calls through to OEBase.Clear.

CreateCopy

OEBase *CreateCopy() const

GetDataType

const void *GetDataType() const

IsDataType

bool IsDataType(const void *type) const

SetAll

bool SetAll(int xdim, int ydim, int zdim, float midx, float midy, float midz,
            float spacing, std::string title, GridType *dataptr)

Convenience method for setting all the properties of this grid at once.

SetDim

bool SetDim(unsigned int ixdim, unsigned int iydim, unsigned int izdim)

Sets the number of grid points for each dimension.

SetMid

bool SetMid(float x, float y, float z)

Sets the mid-point (center) of the grid.

SetSpacing

bool SetSpacing(float spacing)

Sets the length between grid points.

SetXDim

bool SetXDim(unsigned int ixdim)

Sets the number of grid points in the x-dimension.

SetXMid

bool SetXMid(float x)

Sets the mid-point (center) in the x-dimension.

SetYDim

bool SetYDim(unsigned int iydim)

Sets the number of grid points in the y-dimension.

SetYMid

bool SetYMid(float y)

Sets the mid-point (center) in the y-dimension.

SetZDim

bool SetZDim(unsigned int izdim)

Sets the number of grid points in the z-dimension.

SetZMid

bool SetZMid(float z)

Sets the mid-point (center) in the z-dimension.