VAPoR  0.1
Public Member Functions | Protected Member Functions | List of all members
VAPoR::WaveletBlock3DRegionWriter Class Reference

A subregion write for VDC files. More...

#include <WaveletBlock3DRegionWriter.h>

Inheritance diagram for VAPoR::WaveletBlock3DRegionWriter:
VAPoR::WaveletBlockIOBase VAPoR::VDFIOBase VAPoR::MetadataVDC VAPoR::Metadata VetsUtil::MyBase VAPoR::ParsedXml

Public Member Functions

 WaveletBlock3DRegionWriter (const MetadataVDC &metadata)
 
 WaveletBlock3DRegionWriter (const string &metafile)
 
virtual ~WaveletBlock3DRegionWriter ()
 
virtual int OpenVariableWrite (size_t timestep, const char *varname, int reflevel=-1, int lod=-1)
 
virtual int OpenVariableRead (size_t timestep, const char *varname, int reflevel=0, int lod=0)
 
virtual int CloseVariable ()
 
int WriteRegion (const float *region, const size_t min[3], const size_t max[3])
 
int WriteRegion (const float *region)
 
int BlockWriteRegion (const float *region, const size_t bmin[3], const size_t bmax[3], int block=1)
 
- Public Member Functions inherited from VAPoR::WaveletBlockIOBase
 WaveletBlockIOBase (const MetadataVDC &metadata)
 
 WaveletBlockIOBase (const string &metafile)
 
virtual ~WaveletBlockIOBase ()
 
virtual int VariableExists (size_t ts, const char *varname, int reflevel=0, int lod=0) const
 
virtual int BlockWriteRegion (const float *region, const size_t bmin[3], const size_t bmax[3], bool block=true)
 
virtual int WriteSlice (const float *slice)
 
virtual int BlockReadRegion (const size_t bmin[3], const size_t bmax[3], float *region, bool unblock=true)
 
virtual int ReadRegion (const size_t min[3], const size_t max[3], float *region)
 
virtual int ReadRegion (float *region)
 
virtual int ReadSlice (float *slice)
 
int GetBlockMins (const float **mins, int reflevel)
 
int GetBlockMaxs (const float **maxs, int reflevel)
 
void Tile2NonTile (const float *blk, const size_t bcoord[2], const size_t min[2], const size_t max[2], VarType_T vtype, float *voxels) const
 
void Block2NonBlock (const float *blk, const size_t bcoord[3], const size_t min[3], const size_t max[3], float *voxels) const
 
virtual const float * GetDataRange () const
 
void GetValidRegion (size_t min[3], size_t max[3], int reflevel) const
 
virtual void GetDim (size_t dim[3], int reflevel=0) const
 
virtual void GetDimBlk (size_t bdim[3], int reflevel=0) const
 
- Public Member Functions inherited from VAPoR::VDFIOBase
 VDFIOBase (const MetadataVDC &metadata)
 
 VDFIOBase (const string &metafile)
 
virtual ~VDFIOBase ()
 
double GetReadTimer () const
 
double GetSeekTimer () const
 
void SeekTimerReset ()
 
void SeekTimerStart ()
 
void SeekTimerStop ()
 
double GetWriteTimer () const
 
double GetXFormTimer () const
 
- Public Member Functions inherited from VAPoR::MetadataVDC
 MetadataVDC (const size_t dim[3], size_t numTransforms, const size_t bs[3], int nFilterCoef=1, int nLiftingCoef=1, int msbFirst=1, int vdfVersion=VDF_VERSION)
 
 MetadataVDC (const size_t dim[3], const size_t bs[3], const vector< size_t > &cratios, string wname, string wmode)
 
 MetadataVDC (const string &metafile)
 
 MetadataVDC (const MetadataVDC &node)
 
virtual ~MetadataVDC ()
 
int Merge (const MetadataVDC &metadata, size_t ts=0)
 
int Merge (const string &path, size_t ts=0)
 
int MakeCurrent () const
 
const string & GetParentDir () const
 
const string & GetMetafileName () const
 
const string & GetDataDirName () const
 
int ConstructFullVBase (size_t ts, const string &var, string *path) const
 
int ConstructFullAuxBase (size_t ts, string *path) const
 
int Write (const string &path, int relative_path=1)
 
virtual const size_t * GetBlockSize () const
 
virtual void GetBlockSize (size_t bs[3], int) const
 
virtual void GetGridDim (size_t dim[3]) const
 
const size_t * GetDimension () const
 
int GetFilterCoef () const
 
int GetLiftingCoef () const
 
virtual int GetNumTransforms () const
 
int GetMSBFirst () const
 
int GetVDFVersion () const
 
string GetWaveName () const
 
string GetBoundaryMode () const
 
virtual vector< size_t > GetCRatios () const
 
int GetVDCType () const
 
int SetGridType (const string &value)
 
string GetGridType () const
 
int IsValidGridType (const string &value) const
 
int SetCoordSystemType (const string &value)
 
string GetCoordSystemType () const
 
int IsValidCoordSystemType (const string &value) const
 
int SetExtents (const vector< double > &value)
 
vector< double > GetExtents (size_t ts=0) const
 
int IsValidExtents (const vector< double > &value) const
 
int SetNumTimeSteps (long value)
 
long GetNumTimeSteps () const
 
int IsValidTimeStep (long value) const
 
int SetVariableNames (const vector< string > &value)
 
int SetVariables3D (const vector< string > &value)
 
vector< string > GetVariables3D () const
 
vector< string > GetCoordinateVariables () const
 
int SetCoordinateVariables (const vector< string > &value)
 
int SetVariables2DXY (const vector< string > &value)
 
int SetVariables2DXZ (const vector< string > &value)
 
int SetVariables2DYZ (const vector< string > &value)
 
vector< string > GetVariables2DXY () const
 
vector< string > GetVariables2DXZ () const
 
vector< string > GetVariables2DYZ () const
 
int SetComment (const string &value)
 
string GetComment () const
 
int SetPeriodicBoundary (const vector< long > &value)
 
vector< long > GetPeriodicBoundary () const
 
int SetGridPermutation (const vector< long > &value)
 
int SetMissingValue (double value)
 
int SetMissingValue ()
 
vector< double > GetMissingValue () const
 
vector< long > GetGridPermutation () const
 
int SetMapProjection (const string &value)
 
virtual string GetMapProjection () const
 
int SetTSUserTime (size_t ts, const vector< double > &value)
 
double GetTSUserTime (size_t ts) const
 
int SetTSUserTimeStamp (size_t ts, const string &s)
 
void GetTSUserTimeStamp (size_t ts, string &s) const
 
string GetTSAuxBasePath (size_t ts) const
 
int HasTSUserTime (size_t ts) const
 
int IsValidUserTime (const vector< double > &value) const
 
int SetTSXCoords (size_t ts, const vector< double > &value)
 
vector< double > GetTSXCoords (size_t ts) const
 
int SetTSYCoords (size_t ts, const vector< double > &value)
 
vector< double > GetTSYCoords (size_t ts) const
 
int SetTSZCoords (size_t ts, const vector< double > &value)
 
vector< double > GetTSZCoords (size_t ts) const
 
int SetTSComment (size_t ts, const string &value)
 Set a comment for the time step indicated by ts. More...
 
string GetTSComment (size_t ts) const
 Return the comment for the indicated time step, ts, if it exists. More...
 
int SetTSExtents (size_t ts, const vector< double > &value)
 
vector< double > GetTSExtents (size_t ts) const
 
int SetTSMissingValue (size_t ts, double v)
 
vector< double > GetTSMissingValue (size_t ts) const
 Returns the time-varying missing value, if any. More...
 
int SetVComment (size_t ts, const string &var, const string &value)
 
string GetVComment (size_t ts, const string &var) const
 
string GetVBasePath (size_t ts, const string &var) const
 
int SetVBasePath (size_t ts, const string &var, const string &value)
 
int SetVDataRange (size_t ts, const string &var, const vector< double > &value)
 
vector< double > GetVDataRange (size_t ts, const string &var) const
 
int IsValidVDataRange (const vector< double > &value) const
 
int SetVMissingValue (size_t ts, const string &var, double v)
 
vector< double > GetVMissingValue (size_t ts, const string &var) const
 
vector< string > GetUserDataLongTags () const
 
int SetUserDataLong (const string &tag, const vector< long > &value)
 
vector< long > GetUserDataLong (const string &tag) const
 
vector< string > GetUserDataDoubleTags () const
 
int SetUserDataDouble (const string &tag, const vector< double > &value)
 
vector< double > GetUserDataDouble (const string &tag) const
 
vector< string > GetUserDataStringTags () const
 
int SetUserDataString (const string &tag, const string &value)
 
string GetUserDataString (const string &tag) const
 
int SetUserDataStringVec (const string &tag, const vector< string > &value)
 
vector< string > GetUserDataStringVec (const string &tag) const
 
vector< string > GetTSUserDataLongTags () const
 
int SetTSUserDataLong (size_t ts, const string &tag, const vector< long > &value)
 
vector< long > GetTSUserDataLong (size_t ts, const string &tag) const
 
int SetTSUserDataDouble (size_t ts, const string &tag, const vector< double > &value)
 
vector< double > GetTSUserDataDouble (size_t ts, const string &tag) const
 
vector< string > GetTSUserDataDoubleTags () const
 
int SetTSUserDataString (size_t ts, const string &tag, const string &value)
 
string GetTSUserDataString (size_t ts, const string &tag) const
 
vector< string > GetTSUserDataStringTags () const
 
vector< string > GetVUserDataLongTags () const
 
int SetVUserDataLong (size_t ts, const string &var, const string &tag, const vector< long > &value)
 
vector< long > GetVUserDataLong (size_t ts, const string &var, const string &tag) const
 
vector< string > GetVUserDataDoubleTags () const
 
int SetVUserDataDouble (size_t ts, const string &var, const string &tag, const vector< double > &value)
 
vector< double > GetVUserDataDouble (size_t ts, const string &var, const string &tag) const
 
int SetVUserDataString (size_t ts, const string &var, const string &tag, const string &value)
 
string GetVUserDataString (size_t ts, const string &var, const string &tag) const
 
vector< string > GetVUserDataStringTags () const
 
- Public Member Functions inherited from VetsUtil::MyBase
 MyBase ()
 
const string & getClassName () const
 
- Public Member Functions inherited from VAPoR::ParsedXml
virtual ~ParsedXml ()
 
virtual bool charHandler (ExpatParseMgr *, const XML_Char *, int)
 

Protected Member Functions

void _GetDataRange (float range[2]) const
 
void _GetValidRegion (size_t minreg[3], size_t maxreg[3]) const
 
- Protected Member Functions inherited from VAPoR::WaveletBlockIOBase
int seekBlocks (unsigned int offset, int reflevel=0)
 
int seekLambdaBlocks (const size_t bcoord[3])
 
int seekGammaBlocks (const size_t bcoord[3], int reflevel)
 
int readBlocks (size_t n, float *blks, int reflevel)
 
int readLambdaBlocks (size_t n, float *blks)
 
int readGammaBlocks (size_t n, float *blks, int reflevel)
 
int writeBlocks (const float *blks, size_t n, int reflevel)
 
int writeLambdaBlocks (const float *blks, size_t n)
 
int writeGammaBlocks (const float *blks, size_t n, int reflevel)
 
- Protected Member Functions inherited from VAPoR::VDFIOBase
void _ReadTimerReset ()
 
void _ReadTimerStart ()
 
void _ReadTimerStop ()
 
void _WriteTimerReset ()
 
void _WriteTimerStart ()
 
void _WriteTimerStop ()
 
void _XFormTimerReset ()
 
void _XFormTimerStart ()
 
void _XFormTimerStop ()
 
int _MaskOpenWrite (size_t timestep, string varname, int reflevel)
 
int _MaskOpenRead (size_t timestep, string varname, int reflevel)
 
int _MaskClose ()
 
int _MaskWrite (const float *srcblk, const size_t bmin_p[3], const size_t bmax_p[3], bool block)
 
int _MaskRead (const size_t bmin_p[3], const size_t bmax_p[3])
 
void _MaskRemove (float *blk, bool &valid_data) const
 
void _MaskReplace (size_t bx, size_t by, size_t bz, float *blk) const
 
- Protected Member Functions inherited from VetsUtil::MyBase
void SetClassName (const string &name)
 

Additional Inherited Members

- Public Types inherited from VetsUtil::MyBase
typedef void(* ErrMsgCB_T )(const char *msg, int err_code)
 
typedef void(* DiagMsgCB_T )(const char *msg)
 
- Static Public Member Functions inherited from VetsUtil::MyBase
static void SetErrMsg (const char *format,...)
 Record a formatted error message. More...
 
static void SetErrMsg (int errcode, const char *format,...)
 Record a formatted error message and an error code. More...
 
static const char * GetErrMsg ()
 
static void SetErrCode (int err_code)
 Record an error code. More...
 
static int GetErrCode ()
 Retrieve the current error code. More...
 
static void SetErrMsgCB (ErrMsgCB_T cb)
 
static ErrMsgCB_T GetErrMsgCB ()
 
static void SetErrMsgFilePtr (FILE *fp)
 
static const FILE * SetErrMsgFilePtr ()
 
static void SetDiagMsg (const char *format,...)
 Record a formatted diagnostic message. More...
 
static const char * GetDiagMsg ()
 
static void SetDiagMsgCB (DiagMsgCB_T cb)
 
static DiagMsgCB_T GetDiagMsgCB ()
 
static void SetDiagMsgFilePtr (FILE *fp)
 
static bool EnableErrMsg (bool enable)
 
- Public Attributes inherited from VAPoR::ParsedXml
ParsedXmlpreviousClass
 
- Static Public Attributes inherited from VetsUtil::MyBase
static char * ErrMsg
 
static int ErrCode
 
static int ErrMsgSize
 
static FILE * ErrMsgFilePtr
 
static ErrMsgCB_T ErrMsgCB
 
static char * DiagMsg
 
static int DiagMsgSize
 
static FILE * DiagMsgFilePtr
 
static DiagMsgCB_T DiagMsgCB
 
static bool Enabled
 
- Static Protected Member Functions inherited from VAPoR::VDFIOBase
static void _UnpackCoord (VarType_T vtype, const size_t src[3], size_t dst[3], size_t fill)
 
static void _PackCoord (VarType_T vtype, const size_t src[3], size_t dst[3], size_t fill)
 
static void _FillPackedCoord (VarType_T vtype, const size_t src[3], size_t dst[3], size_t fill)
 
- Protected Attributes inherited from VAPoR::WaveletBlockIOBase
int _reflevel
 
size_t _timeStep
 
string _varName
 
float * _super_block
 
float * _super_tile
 
VarType_T _vtype
 
WaveletBlock2D_wb2dXY
 
WaveletBlock2D_wb2dXZ
 
WaveletBlock2D_wb2dYZ
 
WaveletBlock3D_wb3d
 
float * _mins3d [MAX_LEVELS]
 
float * _maxs3d [MAX_LEVELS]
 
float * _mins2d [MAX_LEVELS]
 
float * _maxs2d [MAX_LEVELS]
 
- Static Protected Attributes inherited from VAPoR::WaveletBlockIOBase
static const int MAX_LEVELS = 16
 
- Static Protected Attributes inherited from VAPoR::ParsedXml
static const string _stringType
 
static const string _longType
 
static const string _doubleType
 
static const string _typeAttr
 

Detailed Description

A subregion write for VDC files.

Author
John Clyne
Version
$Revision$
Date
$Date$

This class provides an API for writing volume sub-regions to a VDC

Definition at line 24 of file WaveletBlock3DRegionWriter.h.

Constructor & Destructor Documentation

VAPoR::WaveletBlock3DRegionWriter::WaveletBlock3DRegionWriter ( const MetadataVDC metadata)

Constructor for the WaveletBlock3DRegionWriter class.

Parameters
[in]metadataA pointer to a Metadata structure identifying the data set upon which all future operations will apply.
Note
The success or failure of this constructor can be checked with the GetErrCode() method.
See also
MetadataVDC, GetErrCode()
VAPoR::WaveletBlock3DRegionWriter::WaveletBlock3DRegionWriter ( const string &  metafile)

Constructor for the WaveletBlock3DRegionWriter class.

Parameters
[in]metafilePath to a metadata file for which all future class operations will apply
Note
The success or failure of this constructor can be checked with the GetErrCode() method.
See also
MetadataVDC, GetErrCode()
virtual VAPoR::WaveletBlock3DRegionWriter::~WaveletBlock3DRegionWriter ( )
virtual

Member Function Documentation

void VAPoR::WaveletBlock3DRegionWriter::_GetDataRange ( float  range[2]) const
protectedvirtual
void VAPoR::WaveletBlock3DRegionWriter::_GetValidRegion ( size_t  minreg[3],
size_t  maxreg[3] 
) const
protectedvirtual

Reimplemented from VAPoR::WaveletBlockIOBase.

int VAPoR::WaveletBlock3DRegionWriter::BlockWriteRegion ( const float *  region,
const size_t  bmin[3],
const size_t  bmax[3],
int  block = 1 
)

Write a volume subregion to the currently opened multiresolution data volume.

This method is identical to the WriteRegion() method with the exception that the region boundaries are defined in block, not voxel, coordinates. Secondly, unless the 'block' parameter is set, the internal blocking of the data will be preserved. I.e. the data are assumed to already be blocked.

Parameters
[in]bminMinimum region extents in block coordinates
[in]bmaxMaximum region extents in block coordinates
[in]regionThe volume subregion to write
[in]blockIf true, block the data before writing/transforming
Return values
statusReturns a non-negative value on success
See also
OpenVariableWrite(), Metadata::GetBlockSize(), MapVoxToBlk()
virtual int VAPoR::WaveletBlock3DRegionWriter::CloseVariable ( )
virtual

Close the data volume opened by the most recent call to OpenVariableWrite()

Return values
statusReturns a non-negative value on success
See also
OpenVariableWrite()

Reimplemented from VAPoR::WaveletBlockIOBase.

virtual int VAPoR::WaveletBlock3DRegionWriter::OpenVariableRead ( size_t  timestep,
const char *  varname,
int  reflevel = 0,
int  lod = 0 
)
inlinevirtual

Open the named variable for reading

This method prepares the multiresolution data volume, indicated by a variable name and time step pair, for subsequent read operations by methods of this class. Furthermore, the number of the refinement level parameter, reflevel indicates the resolution of the volume in the multiresolution hierarchy. The valid range of values for reflevel is [0..max_refinement], where max_refinement is the maximum finement level of the data set: Metadata::GetNumTransforms(). volume when the volume was created. A value of zero indicates the coarsest resolution data, a value of max_refinement indicates the finest resolution data.

An error occurs, indicated by a negative return value, if the volume identified by the {varname, timestep, reflevel} tripple is not present on disk. Note the presence of a volume can be tested for with the VariableExists() method.

Parameters
[in]timestepTime step of the variable to read
[in]varnameName of the variable to read
[in]reflevelRefinement level of the variable. A value of -1 indicates the maximum refinment level defined for the VDC
Return values
statusReturns a non-negative value on success
See also
Metadata::GetVariableNames(), Metadata::GetNumTransforms()

Reimplemented from VAPoR::WaveletBlockIOBase.

Definition at line 86 of file WaveletBlock3DRegionWriter.h.

virtual int VAPoR::WaveletBlock3DRegionWriter::OpenVariableWrite ( size_t  timestep,
const char *  varname,
int  reflevel = -1,
int  lod = -1 
)
virtual

Open the named variable for writing

This method prepares the multiresolution data volume, indicated by a variable name and time step pair, for subsequent write operations by methods of this class. The number of refinement levels actually saved to the data collection are determined by reflevels. If reflevels is zero, the default, only the coarsest approximation is saved. If reflevels is one, the coarsest and first refinement level is saved, and so on. A value of -1 indicates the maximum refinment level permitted by the VDF

An error occurs, indicated by a negative return value, if the volume identified by the {varname, timestep, reflevel} can not be written .

Parameters
[in]timestepTime step of the variable to write
[in]varnameName of the variable to write
[in]reflevelRefinement level of the variable. A value of -1 indicates the maximum refinment level defined for the VDC
Return values
statusReturns a non-negative value on success
See also
Metadata::GetVariableNames(), Metadata::GetNumTransforms()

Reimplemented from VAPoR::WaveletBlockIOBase.

int VAPoR::WaveletBlock3DRegionWriter::WriteRegion ( const float *  region,
const size_t  min[3],
const size_t  max[3] 
)
virtual

Write a subregion to the currently opened multiresolution data volume. The min and max vectors identify the minium and maximum extents, in voxel coordinates, of the subregion of interest. The minimum valid value of 'min' is (0,0,0), the maximum valid value of max is (nx-1,ny-1,nz-1), where nx, ny, and nz are the voxel dimensions of the volume at the native resolution (finest resolution). The volume subregion to be written is pointed to by region.

Parameters
[in]minMinimum region extents in voxel coordinates
[in]maxMaximum region extents in voxel coordinates
[in]regionThe volume subregion to write
Return values
statusReturns a non-negative value on success
See also
OpenVariableWrite()

Reimplemented from VAPoR::WaveletBlockIOBase.

int VAPoR::WaveletBlock3DRegionWriter::WriteRegion ( const float *  region)
virtual

Reimplemented from VAPoR::WaveletBlockIOBase.


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