Provides API to work with well logs. More...

#include <h5logcurve.h>

Inheritance diagram for H5LogCurve:

Public Member Functions
virtual bool	writeCurve (const h5geo::LogDataType &name, Eigen::Ref< Eigen::VectorXd > v, const std::string &units="")=0
	Write `MD` or `VAL` curve.

virtual bool	writeCurve (const std::string &name, Eigen::Ref< Eigen::VectorXd > v, const std::string &units="")=0
	Write `MD` or `VAL` curve.

virtual size_t	getNCurves ()=0
	Get number of curves.

virtual size_t	getNSamp ()=0
	Get number of samples.

virtual Eigen::VectorXd	getCurve (const h5geo::LogDataType &name, const std::string &units="")=0
	Get `MD` or `VAL` curve.

virtual Eigen::VectorXd	getCurve (const std::string &name, const std::string &units="")=0
	Get `MD` or `VAL` curve.

virtual std::string	getRelativeName ()=0
	Get current Log curve's name.

virtual H5LogCurveParam	getParam ()=0
	Get parameters that were used to create current log curve.

virtual H5WellContainer *	openWellContainer ()=0
	Open H5WellContainer where current log curve resides.

virtual H5Well *	openWell ()=0
	Open parent H5Well.

virtual std::optional< h5gt::DataSet >	getLogCurveD ()=0
	Get current Log curve's 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 well logs.

Log curve stores the following curves: MD, VAL.
Each log has its type and it is located in HDF5 container using following pattern: /well/LOG/log_type/relative_path_to_log_curve

Member Function Documentation

◆ getCurve() [1/2]

virtual Eigen::VectorXd H5LogCurve::getCurve	(	const h5geo::LogDataType &	name,
		const std::string &	units = "" )

pure virtual

Get MD or VAL curve.

Implemented in H5LogCurveImpl.

◆ getCurve() [2/2]

virtual Eigen::VectorXd H5LogCurve::getCurve	(	const std::string &	name,
		const std::string &	units = "" )

pure virtual

Get MD or VAL curve.

Implemented in H5LogCurveImpl.

◆ getLogCurveD()

virtual std::optional< h5gt::DataSet > H5LogCurve::getLogCurveD ( )

pure virtual

Get current Log curve's DataSet.

Implemented in H5LogCurveImpl.

◆ getNCurves()

virtual size_t H5LogCurve::getNCurves ( )

pure virtual

Get number of curves.

Implemented in H5LogCurveImpl.

◆ getNSamp()

virtual size_t H5LogCurve::getNSamp ( )

pure virtual

Get number of samples.

Implemented in H5LogCurveImpl.

◆ getParam()

virtual H5LogCurveParam H5LogCurve::getParam ( )

pure virtual

Get parameters that were used to create current log curve.

Implemented in H5LogCurveImpl.

◆ getRelativeName()

virtual std::string H5LogCurve::getRelativeName ( )

pure virtual

Get current Log curve's name.

Returned curve name is relative to LOG Group within H5Well. It is possible to use this name when H5Well::openLogCurve for example.

Implemented in H5LogCurveImpl.

◆ openWell()

virtual H5Well * H5LogCurve::openWell ( )

pure virtual

Open parent H5Well.

Implemented in H5LogCurveImpl.

◆ openWellContainer()

virtual H5WellContainer * H5LogCurve::openWellContainer ( )

pure virtual

Open H5WellContainer where current log curve resides.

Implemented in H5LogCurveImpl.

◆ writeCurve() [1/2]

virtual bool H5LogCurve::writeCurve	(	const h5geo::LogDataType &	name,
		Eigen::Ref< Eigen::VectorXd >	v,
		const std::string &	units = "" )

pure virtual

Write MD or VAL curve.

Implemented in H5LogCurveImpl.

◆ writeCurve() [2/2]

virtual bool H5LogCurve::writeCurve	(	const std::string &	name,
		Eigen::Ref< Eigen::VectorXd >	v,
		const std::string &	units = "" )

pure virtual

Write MD or VAL curve.

Implemented in H5LogCurveImpl.

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

/github/workspace/include/h5geo/h5logcurve.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ getCurve() [1/2]

◆ getCurve() [2/2]

◆ getLogCurveD()

◆ getNCurves()

◆ getNSamp()

◆ getParam()

◆ getRelativeName()

◆ openWell()

◆ openWellContainer()

◆ writeCurve() [1/2]

◆ writeCurve() [2/2]