h5geo 0.4.0
C++17 and python API to work with geo-data (seismic, wells, maps, other in process) based on HDF5. Aimed at geoscientists and developers.
Loading...
Searching...
No Matches
H5Points3 Class Referenceabstract

Provides API to work with 3D points. More...

#include <h5points3.h>

Inheritance diagram for H5Points3:
H5BasePoints H5BaseObject H5Base H5BaseImpl< H5Points3 > H5BaseObjectImpl< H5Points3 > H5BasePointsImpl< H5Points3 > H5Points3Impl< TBase >

Public Member Functions

virtual bool writeData (h5geo::Point3Array &data, const std::string &lengthUnits="", const std::string &temporalUnits="", bool doCoordTransform=false)=0
 Write data to DataSet.
 
virtual h5geo::Point3Array getData (const std::string &lengthUnits="", const std::string &temporalUnits="", bool doCoordTransform=false)=0
 Read data from DataSet.
 
- Public Member Functions inherited from H5BasePoints
virtual bool setNPoints (size_t n)=0
 Resize HDF5 DataSet.
 
virtual bool setDomain (const h5geo::Domain &domain)=0
 Set domain for the points (TVD, TVDSS, TWT, OWT)
 
virtual H5BaseContaineropenContainer () const =0
 Open container where current points resides.
 
virtual size_t getNPoints ()=0
 Return number of points.
 
virtual h5geo::Domain getDomain ()=0
 Get domain (TVD, TVDSS, TWT, OWT)
 
virtual H5PointsParam getParam ()=0
 Get parameters that were used to create current points.
 
virtual std::optional< h5gt::DataSet > getPointsD () const =0
 Get current points DataSet.
 
- Public Member Functions inherited from H5BaseObject
virtual H5BasePointsopenPoints (const std::string &name)=0
 Open H5BasePoints derived points.
 
virtual H5BasePointsopenPoints (h5gt::Group group)=0
 Open H5BasePoints derived points.
 
virtual H5HorizonopenHorizon (const std::string &name)=0
 
virtual H5HorizonopenHorizon (h5gt::Group group)=0
 
virtual H5Points1createPoints1 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag)=0
 
virtual H5Points1createPoints1 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag)=0
 
virtual H5Points2createPoints2 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag)=0
 
virtual H5Points2createPoints2 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag)=0
 
virtual H5Points3createPoints3 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag)=0
 
virtual H5Points3createPoints3 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag)=0
 
virtual H5Points4createPoints4 (std::string &name, H5PointsParam &p, h5geo::CreationType createFlag)=0
 
virtual H5Points4createPoints4 (h5gt::Group group, H5PointsParam &p, h5geo::CreationType createFlag)=0
 
virtual H5HorizoncreateHorizon (std::string &name, H5HorizonParam &p, h5geo::CreationType createFlag)=0
 
virtual H5HorizoncreateHorizon (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 H5Baseclone ()=0
 
virtual void Delete ()=0
 

Detailed Description

Provides API to work with 3D points.

H5Points3 consists of X, Y, VAL and name.
Maximal length of name is defined by H5GEO_CHAR_ARRAY_SIZE macro passed to cmake as CACHE var.

Member Function Documentation

◆ getData()

virtual h5geo::Point3Array H5Points3::getData ( const std::string & lengthUnits = "",
const std::string & temporalUnits = "",
bool doCoordTransform = false )
pure virtual

Read data from DataSet.

Implemented in H5Points3Impl< TBase >.

◆ writeData()

virtual bool H5Points3::writeData ( h5geo::Point3Array & data,
const std::string & lengthUnits = "",
const std::string & temporalUnits = "",
bool doCoordTransform = false )
pure virtual

Write data to DataSet.

Implemented in H5Points3Impl< TBase >.


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