Provides API to work with horizons. More...

#include <h5horizon.h>

Inheritance diagram for H5Horizon:

Public Member Functions
virtual bool	writeData (Eigen::Ref< Eigen::MatrixXd > M, const std::string &unitsFrom="", const std::string &unitsTo="")=0
	Write data to DataSet.

virtual Eigen::MatrixXd	getData (const std::string &unitsFrom="", const std::string &unitsTo="")=0
	Read data from DataSet.

virtual bool	writeComponent (const std::string &componentName, Eigen::Ref< Eigen::VectorXd > v, const std::string &unitsFrom="", const std::string &unitsTo="")=0
	Write single component to DataSet.

virtual Eigen::VectorXd	getComponent (const std::string &componentName, const std::string &unitsFrom="", const std::string &unitsTo="")=0
	Read single component from DataSet.

virtual bool	setNPoints (size_t n)=0
	Resize rows of HDF5 DataSet.

virtual bool	setNComponents (size_t n)=0
	Resize columns of HDF5 DataSet.

virtual bool	setComponents (const std::map< std::string, size_t > &components)=0
	Set components.

virtual bool	setDomain (const h5geo::Domain &domain)=0
	Set domain for the points (`TVD`, `TVDSS`, `TWT`, `OWT`)

virtual H5BaseContainer *	openContainer () const =0
	Open container where current points resides.

virtual size_t	getNPoints ()=0
	Return number of points for the horizon.

virtual size_t	getNComponents ()=0
	Return number of dimension for the horizon.

virtual std::map< std::string, size_t >	getComponents ()=0
	Return component names and corresponding HDF5 rows.

virtual h5geo::Domain	getDomain ()=0
	Get domain (`TVD`, `TVDSS`, `TWT`, `OWT`)

virtual H5HorizonParam	getParam ()=0
	Get parameters that were used to create current points.

virtual std::optional< h5gt::DataSet >	getHorizonD () const =0
	Get current points DataSet.

Public Member Functions inherited from H5BaseObject
virtual H5BasePoints *	openPoints (const std::string &name)=0
	Open H5BasePoints derived points.

virtual H5BasePoints *	openPoints (h5gt::Group group)=0
	Open H5BasePoints derived points.

virtual H5Horizon *	openHorizon (const std::string &name)=0

virtual H5Horizon *	openHorizon (h5gt::Group group)=0

virtual H5Points1 *	createPoints1 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points1 *	createPoints1 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points2 *	createPoints2 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points2 *	createPoints2 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points3 *	createPoints3 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points3 *	createPoints3 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points4 *	createPoints4 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Points4 *	createPoints4 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag)=0

virtual H5Horizon *	createHorizon (std::string &name, H5HorizonParam &p, h5geo::CreationType createFlag)=0

virtual H5Horizon *	createHorizon (h5gt::Group group, H5HorizonParam &p, h5geo::CreationType createFlag)=0

virtual bool	setSpatialReference (const std::string &str)=0
	Set spatial reference for current geo-object using `authName:code` form.

virtual bool	setSpatialReference (const std::string &authName, const std::string &code)=0
	Set spatial reference for current geo-object.

virtual bool	setLengthUnits (const std::string &str)=0
	Set length units for the current geo-object.

virtual bool	setTemporalUnits (const std::string &str)=0
	Set temporal units for the current geo-object.

virtual bool	setAngularUnits (const std::string &str)=0
	Set angular units for the current geo-object.

virtual bool	setDataUnits (const std::string &str)=0
	Set data units for the current geo-object.

virtual bool	setNullValue (double val)=0
	Set NULL value for the current geo-object.

virtual std::string	getSpatialReference ()=0
	Get spatial reference for current geo-object.

virtual std::string	getLengthUnits ()=0
	Get length units for the current geo-object.

virtual std::string	getTemporalUnits ()=0
	Get temporal units for the current geo-object.

virtual std::string	getAngularUnits ()=0
	Get angular units for the current geo-object.

virtual std::string	getDataUnits ()=0
	Get data units for the current geo-object.

virtual double	getNullValue ()=0
	Get NULL value for the current geo-object.

virtual h5gt::File	getH5File () const =0
	Get HDF5 file.

virtual h5gt::Group	getObjG () const =0
	Get HDF5 Group.

virtual std::string	getName () const =0
	Get geo-object's name without path.

virtual std::string	getFullName () const =0
	Get geo-object's name with full path to that object.

virtual std::vector< h5gt::Group >	getObjGroupList (const h5geo::ObjectType &objType, bool recursive)=0
	Find all geo-objects of specified type within current geo-object and return them as vector of Groups.

virtual std::vector< std::string >	getObjNameList (const h5geo::ObjectType &objType, bool recursive)=0
	Find all geo-objects of specified type within current geo-object and return them as vector of names.

virtual size_t	getObjCount (const h5geo::ObjectType &objType, bool recursive)=0
	Get number of geo-objects of specified type within current geo-object.

virtual bool	isEqual (H5BaseObject *other) const =0
	Check if geo-objects are the same.

virtual bool	operator== (const H5BaseObject &other) const =0
	Check if geo-objects are the same (compares HDF5 Groups)

virtual bool	operator!= (const H5BaseObject &other) const =0
	Check if geo-objects are not the same (compares HDF5 Groups)

Public Member Functions inherited from H5Base
virtual H5Base *	clone ()=0

virtual void	Delete ()=0

Detailed Description

Provides API to work with horizons.

Horizon is an object represented by a dataset with named rows within. Thus it can be XYZ and VAL - 4 component data. A single X0 Y0 Z0 VAL0 would be called point.

Member Function Documentation

◆ getComponent()

virtual Eigen::VectorXd H5Horizon::getComponent	(	const std::string &	componentName,
		const std::string &	unitsFrom = "",
		const std::string &	unitsTo = "" )

pure virtual

Read single component from DataSet.

Implemented in H5HorizonImpl.

◆ getComponents()

virtual std::map< std::string, size_t > H5Horizon::getComponents ( )

pure virtual

Return component names and corresponding HDF5 rows.

Implemented in H5HorizonImpl.

◆ getData()

virtual Eigen::MatrixXd H5Horizon::getData	(	const std::string &	unitsFrom = "",
		const std::string &	unitsTo = "" )

pure virtual

Read data from DataSet.

Implemented in H5HorizonImpl.

◆ getDomain()

virtual h5geo::Domain H5Horizon::getDomain ( )

pure virtual

Get domain (TVD, TVDSS, TWT, OWT)

Implemented in H5HorizonImpl.

◆ getHorizonD()

virtual std::optional< h5gt::DataSet > H5Horizon::getHorizonD ( ) const

pure virtual

Get current points DataSet.

Implemented in H5HorizonImpl.

◆ getNComponents()

virtual size_t H5Horizon::getNComponents ( )

pure virtual

Return number of dimension for the horizon.

Implemented in H5HorizonImpl.

◆ getNPoints()

virtual size_t H5Horizon::getNPoints ( )

pure virtual

Return number of points for the horizon.

Implemented in H5HorizonImpl.

◆ getParam()

virtual H5HorizonParam H5Horizon::getParam ( )

pure virtual

Get parameters that were used to create current points.

Implemented in H5HorizonImpl.

◆ openContainer()

virtual H5BaseContainer * H5Horizon::openContainer ( ) const

pure virtual

Open container where current points resides.

Implemented in H5HorizonImpl.

◆ setComponents()

virtual bool H5Horizon::setComponents ( const std::map< std::string, size_t > & components )

pure virtual

Set components.

Delete all attributes from horizon DataSet and create new

Implemented in H5HorizonImpl.

◆ setDomain()

virtual bool H5Horizon::setDomain ( const h5geo::Domain & domain )

pure virtual

Set domain for the points (TVD, TVDSS, TWT, OWT)

Implemented in H5HorizonImpl.

◆ setNComponents()

virtual bool H5Horizon::setNComponents ( size_t n )

pure virtual

Resize columns of HDF5 DataSet.

Implemented in H5HorizonImpl.

◆ setNPoints()

virtual bool H5Horizon::setNPoints ( size_t n )

pure virtual

Resize rows of HDF5 DataSet.

Implemented in H5HorizonImpl.

◆ writeComponent()

virtual bool H5Horizon::writeComponent	(	const std::string &	componentName,
		Eigen::Ref< Eigen::VectorXd >	v,
		const std::string &	unitsFrom = "",
		const std::string &	unitsTo = "" )

pure virtual

Write single component to DataSet.

Implemented in H5HorizonImpl.

◆ writeData()

virtual bool H5Horizon::writeData	(	Eigen::Ref< Eigen::MatrixXd >	M,
		const std::string &	unitsFrom = "",
		const std::string &	unitsTo = "" )

pure virtual

Write data to DataSet.

Implemented in H5HorizonImpl.

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

/github/workspace/include/h5geo/h5horizon.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ getComponent()

◆ getComponents()

◆ getData()

◆ getDomain()

◆ getHorizonD()

◆ getNComponents()

◆ getNPoints()

◆ getParam()

◆ openContainer()

◆ setComponents()

◆ setDomain()

◆ setNComponents()

◆ setNPoints()

◆ writeComponent()

◆ writeData()