Chemical Data Processing Library C++ API - Version 1.3.0
Namespaces | Classes | Typedefs | Functions
CDPL::Grid Namespace Reference

Contains classes and functions related to grid based data representation and processing. More...

Namespaces

 AttributedGridProperty
 Provides keys for built-in Grid::AttributedGrid properties.
 
 AttributedGridPropertyDefault
 Provides default values for built-in Grid::AttributedGrid properties.
 
 ControlParameter
 Provides keys for built-in control-parameters.
 
 ControlParameterDefault
 Provides default values for built-in control-parameters.
 
 DataFormat
 Provides preinitialized Base::DataFormat objects for all supported data formats.
 

Classes

class  RegularGrid
 RegularGrid. More...
 
class  RegularGridSet
 RegularGridSet. More...
 
class  AttributedGrid
 AttributedGrid. More...
 
class  CDFDRegularGridReader
 A reader for spatial regular grid data in the native I/O format of the CDPL. More...
 
class  CDFDRegularGridSetReader
 A reader for spatial regular grid set data in the native I/O format of the CDPL. More...
 
class  CDFDRegularGridSetWriter
 A writer for spatial regular grid set data in the native I/O format of the CDPL. More...
 
class  CDFDRegularGridWriter
 A writer for spatial regular grid data in the native I/O format of the CDPL. More...
 
class  SpatialGrid
 SpatialGrid. More...
 

Typedefs

typedef Util::DefaultDataInputHandler< CDFBZ2DRegularGridReader, DataFormat::CDF_BZ2 > CDFBZ2DRegularGridInputHandler
 A handler for the input of bzip2-compressed spatial regular grid data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataOutputHandler< CDFBZ2DRegularGridWriter, DataFormat::CDF_BZ2 > CDFBZ2DRegularGridOutputHandler
 A handler for the output of bzip2-compressed spatial regular grid data in the native I/O format of the CDPL. More...
 
typedef Util::CompressedDataReader< CDFDRegularGridReader, Util::BZip2IStream > CDFBZ2DRegularGridReader
 
typedef Util::DefaultDataInputHandler< CDFBZ2DRegularGridSetReader, DataFormat::CDF_BZ2 > CDFBZ2DRegularGridSetInputHandler
 A handler for the input of bzip2-compressed spatial regular grid set data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataOutputHandler< CDFBZ2DRegularGridSetWriter, DataFormat::CDF_BZ2 > CDFBZ2DRegularGridSetOutputHandler
 A handler for the output of bzip2-compressed spatial regular grid set data in the native I/O format of the CDPL. More...
 
typedef Util::CompressedDataReader< CDFDRegularGridSetReader, Util::BZip2IStream > CDFBZ2DRegularGridSetReader
 
typedef Util::CompressedDataWriter< CDFDRegularGridSetWriter, Util::BZip2OStream > CDFBZ2DRegularGridSetWriter
 
typedef Util::CompressedDataWriter< CDFDRegularGridWriter, Util::BZip2OStream > CDFBZ2DRegularGridWriter
 
typedef Util::DefaultDataInputHandler< CDFDRegularGridReader, DataFormat::CDF > CDFDRegularGridInputHandler
 A handler for the input of spatial regular grid data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataOutputHandler< CDFDRegularGridWriter, DataFormat::CDF > CDFDRegularGridOutputHandler
 A handler for the output of spatial regular grid data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataInputHandler< CDFDRegularGridSetReader, DataFormat::CDF > CDFDRegularGridSetInputHandler
 A handler for the input of spatial regular grid set data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataOutputHandler< CDFDRegularGridSetWriter, DataFormat::CDF > CDFDRegularGridSetOutputHandler
 A handler for the output of spatial regular grid set data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataInputHandler< CDFGZDRegularGridReader, DataFormat::CDF_GZ > CDFGZDRegularGridInputHandler
 A handler for the input of gzip-compressed spatial regular grid data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataOutputHandler< CDFGZDRegularGridWriter, DataFormat::CDF_GZ > CDFGZDRegularGridOutputHandler
 A handler for the output of gzip-compressed spatial regular grid data in the native I/O format of the CDPL. More...
 
typedef Util::CompressedDataReader< CDFDRegularGridReader, Util::GZipIStream > CDFGZDRegularGridReader
 
typedef Util::DefaultDataInputHandler< CDFGZDRegularGridSetReader, DataFormat::CDF_GZ > CDFGZDRegularGridSetInputHandler
 A handler for the input of gzip-compressed spatial regular grid set data in the native I/O format of the CDPL. More...
 
typedef Util::DefaultDataOutputHandler< CDFGZDRegularGridSetWriter, DataFormat::CDF_GZ > CDFGZDRegularGridSetOutputHandler
 A handler for the output of gzip-compressed spatial regular grid set data in the native I/O format of the CDPL. More...
 
typedef Util::CompressedDataReader< CDFDRegularGridSetReader, Util::GZipIStream > CDFGZDRegularGridSetReader
 
typedef Util::CompressedDataWriter< CDFDRegularGridSetWriter, Util::GZipOStream > CDFGZDRegularGridSetWriter
 
typedef Util::CompressedDataWriter< CDFDRegularGridWriter, Util::GZipOStream > CDFGZDRegularGridWriter
 
typedef RegularGrid< double > DRegularGrid
 
typedef Util::MultiFormatDataReader< DRegularGrid > DRegularGridReader
 Reader for grid data of type Grid::DRegularGrid in any supported format. More...
 
typedef RegularGridSet< double > DRegularGridSet
 
typedef Util::MultiFormatDataReader< DRegularGridSet > DRegularGridSetReader
 Reader for grid set data of type Grid::DRegularGridSet in any supported format. More...
 
typedef Util::MultiFormatDataWriter< DRegularGridSet > DRegularGridSetWriter
 Writer for grid set data of type Grid::DRegularGridSet in any supported format. More...
 
typedef Util::MultiFormatDataWriter< DRegularGrid > DRegularGridWriter
 Writer for grid data of type Grid::DRegularGrid in any supported format. More...
 
typedef RegularGrid< float > FRegularGrid
 
typedef RegularGridSet< float > FRegularGridSet
 
typedef SpatialGrid< float > FSpatialGrid
 
typedef SpatialGrid< double > DSpatialGrid
 

Functions

CDPL_GRID_API const std::string & getName (const AttributedGrid &grid)
 
CDPL_GRID_API void setName (AttributedGrid &grid, const std::string &name)
 
CDPL_GRID_API void clearName (AttributedGrid &grid)
 
CDPL_GRID_API bool hasName (const AttributedGrid &grid)
 
CDPL_GRID_API bool getStrictErrorCheckingParameter (const Base::ControlParameterContainer &cntnr)
 
CDPL_GRID_API void setStrictErrorCheckingParameter (Base::ControlParameterContainer &cntnr, bool strict)
 
CDPL_GRID_API bool hasStrictErrorCheckingParameter (const Base::ControlParameterContainer &cntnr)
 
CDPL_GRID_API void clearStrictErrorCheckingParameter (Base::ControlParameterContainer &cntnr)
 
CDPL_GRID_API bool getCDFOutputSinglePrecisionFloatsParameter (const Base::ControlParameterContainer &cntnr)
 
CDPL_GRID_API void setCDFOutputSinglePrecisionFloatsParameter (Base::ControlParameterContainer &cntnr, bool single_prec)
 
CDPL_GRID_API bool hasCDFOutputSinglePrecisionFloatsParameter (const Base::ControlParameterContainer &cntnr)
 
CDPL_GRID_API void clearCDFOutputSinglePrecisionFloatsParameter (Base::ControlParameterContainer &cntnr)
 

Detailed Description

Contains classes and functions related to grid based data representation and processing.

Typedef Documentation

◆ CDFBZ2DRegularGridInputHandler

A handler for the input of bzip2-compressed spatial regular grid data in the native I/O format of the CDPL.

◆ CDFBZ2DRegularGridOutputHandler

A handler for the output of bzip2-compressed spatial regular grid data in the native I/O format of the CDPL.

◆ CDFBZ2DRegularGridReader

◆ CDFBZ2DRegularGridSetInputHandler

A handler for the input of bzip2-compressed spatial regular grid set data in the native I/O format of the CDPL.

◆ CDFBZ2DRegularGridSetOutputHandler

A handler for the output of bzip2-compressed spatial regular grid set data in the native I/O format of the CDPL.

◆ CDFBZ2DRegularGridSetReader

◆ CDFBZ2DRegularGridSetWriter

◆ CDFBZ2DRegularGridWriter

◆ CDFDRegularGridInputHandler

A handler for the input of spatial regular grid data in the native I/O format of the CDPL.

◆ CDFDRegularGridOutputHandler

A handler for the output of spatial regular grid data in the native I/O format of the CDPL.

◆ CDFDRegularGridSetInputHandler

A handler for the input of spatial regular grid set data in the native I/O format of the CDPL.

◆ CDFDRegularGridSetOutputHandler

A handler for the output of spatial regular grid set data in the native I/O format of the CDPL.

◆ CDFGZDRegularGridInputHandler

A handler for the input of gzip-compressed spatial regular grid data in the native I/O format of the CDPL.

◆ CDFGZDRegularGridOutputHandler

A handler for the output of gzip-compressed spatial regular grid data in the native I/O format of the CDPL.

◆ CDFGZDRegularGridReader

◆ CDFGZDRegularGridSetInputHandler

A handler for the input of gzip-compressed spatial regular grid set data in the native I/O format of the CDPL.

◆ CDFGZDRegularGridSetOutputHandler

A handler for the output of gzip-compressed spatial regular grid set data in the native I/O format of the CDPL.

◆ CDFGZDRegularGridSetReader

◆ CDFGZDRegularGridSetWriter

◆ CDFGZDRegularGridWriter

◆ DRegularGrid

◆ DRegularGridReader

Reader for grid data of type Grid::DRegularGrid in any supported format.

◆ DRegularGridSet

◆ DRegularGridSetReader

Reader for grid set data of type Grid::DRegularGridSet in any supported format.

◆ DRegularGridSetWriter

Writer for grid set data of type Grid::DRegularGridSet in any supported format.

◆ DRegularGridWriter

Writer for grid data of type Grid::DRegularGrid in any supported format.

◆ FRegularGrid

◆ FRegularGridSet

◆ FSpatialGrid

◆ DSpatialGrid

Function Documentation

◆ getName()

CDPL_GRID_API const std::string& CDPL::Grid::getName ( const AttributedGrid &  grid)

◆ setName()

CDPL_GRID_API void CDPL::Grid::setName ( AttributedGrid &  grid,
const std::string &  name 
)

◆ clearName()

CDPL_GRID_API void CDPL::Grid::clearName ( AttributedGrid &  grid)

◆ hasName()

CDPL_GRID_API bool CDPL::Grid::hasName ( const AttributedGrid &  grid)

◆ getStrictErrorCheckingParameter()

CDPL_GRID_API bool CDPL::Grid::getStrictErrorCheckingParameter ( const Base::ControlParameterContainer &  cntnr)

◆ setStrictErrorCheckingParameter()

CDPL_GRID_API void CDPL::Grid::setStrictErrorCheckingParameter ( Base::ControlParameterContainer &  cntnr,
bool  strict 
)

◆ hasStrictErrorCheckingParameter()

CDPL_GRID_API bool CDPL::Grid::hasStrictErrorCheckingParameter ( const Base::ControlParameterContainer &  cntnr)

◆ clearStrictErrorCheckingParameter()

CDPL_GRID_API void CDPL::Grid::clearStrictErrorCheckingParameter ( Base::ControlParameterContainer &  cntnr)

◆ getCDFOutputSinglePrecisionFloatsParameter()

CDPL_GRID_API bool CDPL::Grid::getCDFOutputSinglePrecisionFloatsParameter ( const Base::ControlParameterContainer &  cntnr)
Since
1.2

◆ setCDFOutputSinglePrecisionFloatsParameter()

CDPL_GRID_API void CDPL::Grid::setCDFOutputSinglePrecisionFloatsParameter ( Base::ControlParameterContainer &  cntnr,
bool  single_prec 
)

◆ hasCDFOutputSinglePrecisionFloatsParameter()

CDPL_GRID_API bool CDPL::Grid::hasCDFOutputSinglePrecisionFloatsParameter ( const Base::ControlParameterContainer &  cntnr)

◆ clearCDFOutputSinglePrecisionFloatsParameter()

CDPL_GRID_API void CDPL::Grid::clearCDFOutputSinglePrecisionFloatsParameter ( Base::ControlParameterContainer &  cntnr)