User Guide#
- Features
- Command Line Programs
- Python API
- Query
- Model creation
- Classes
- Applications
- Core
- Data Sources
- Input/Output
- Utilities
- Examples
- Classes
- C++ API
- Serial C++ API
- Classes
- Query
- Enumerated types
- Methods
- Query()
- getErrorHandler()
- initialize(const std::vector<std::string>& modelFilenames, const std::vector<std::string>& valueNames, const std::string& inputCRSString)
- setSquashMinElev(const double value)
- setSquashing(const SquashingEnum value)
- double queryTopElevation(const double x, const double y)
- double queryTopoBathyElevation(const double x, const double y)
- query(const double* values, const double x, const double y, const double z)
- finalize()
- Model
- Enums
- Methods
- Model()
- setInputCRS(const std::string& value)
- open(const char* filename, ModelMode mode)
- close()
- loadMetadata()
- initialize()
- const std::vector<std::string>& getValueNames()
- const std::vector<std::string>& getValueUnits()
- DataLayout getDataLayout()
- const double* getDims()
- const double* getOrigin()
- double getYAzimuth()
- const std::string& getCRSString()
- const geomodelgrids::serial::ModelInfo& getInfo()
- const geomodelgrids::serial::Surface& getTopSurface()
- const geomodelgrids::serial::Surface& getTopoBathy()
- const std::vector<geomodelgrids::serial::Block*>& getBlocks()
- bool contains(const double x, const double y, const double z)
- double queryTopElevation(const double x, const double y)
- double queryTopoBathyElevation(const double x, const double y)
- const double* query(const double x, const double y, const double z)
- ModelInfo
- Methods
- ModelInfo()
- const std::string& getTitle()
- const std::string& getId()
- const std::string& getDescription()
- const std::vector<std::string>& getKeywords()
- const std::string& getHistory()
- const std::string& getComment()
- const std::string& getCreatorName()
- const std::string& getCreatorInstitution()
- const std::string& getCreatorEmail()
- const std::string& getAcknowledgement()
- const std::vector<std::string>& getAuthors()
- const std::vector<std::string>& getReferences()
- const std::string& getRepositoryName()
- const std::string& getRepositoryURL()
- const std::string& getRepositoryDOI()
- const std::string& getVersion()
- const std::string& getLicense()
- const std::string& getAuxiliary()
- load(geomodelgrids::serial::HDF5* const h5)
- Methods
- Surface
- Methods
- Surface(const char* const name)
- loadMetadata(geomodelgrids::serial::HDF5* const h5)
- double getResolutionX()
- double getResolutionY()
- double* getCoordinatesX(void)
- double* getCoordinatesY(void)
- const size_t* getDims()
- setHyperslabDims(const size_t dims[], const size_t ndims)
- openQuery(geomodelgrids::serial::HDF5* const h5)
- closeQuery()
- double query(const double x, const double y)
- Methods
- Block
- Methods
- Block(const char* name)
- loadMetadata(geomodelgrids::serial::HDF5* const h5)
- const std::string& getName()
- double getResolutionX()
- double getResolutionY()
- double getResolutionZ()
- double getZTop()
- double getZBottom()
- double* getCoordinatesX(void)
- double* getCoordinatesY(void)
- double* getCoordinatesZ(void)
- const size_t getDims()
- size_t getNumValues()
- setHyperslabDims(const size_t dims[], const size_t ndims)
- openQuery(geomodelgrids::serial::HDF5* const h5)
- const double* query(const double x, const double y, const double z)
- closeQuery()
- bool compare(const Block* a, const Block* b)
- Methods
- Hyperslab
- HDF5
- Methods
- HDF5()
- setCache(const size_t cacheSize, const size_t nslots, const double preemption)
- open(const char* filename, hid_t mode)
- close()
- bool isOpen()
- bool hasGroup(const char* name)
- bool hasDataset(const char* name)
- getDatasetDims(hsize_t** dims, int* ndims, const char* path)
- getGroupDatasets(std::vector<std::string>* names, const char* parent)
- readAttribute(const char* path, const char* name, hid_t datatype, void* value)
- readAttribute(const char* path, const char* name, hid_t datatype, void** value, size_t* valuesSize)
- std::string readAttribute(const char* path, const char* name)
- readAttribute(const char* path, const char* name, std::vector<std::string>* values)
- readDatasetHyperslab(void* values, const char* path, const hsize_t* const origin, const hsize_t* const dims, int ndims, hid_t datatype)
- Methods
- Query
- Examples
- Classes
- Parallel C++ API
- Utilities C++ API
- Classes
- CRSTransformer
- Methods
- CRSTransformer()
- setSrc(const char* value)
- setDest(const char* value)
- initialize()
- transform(double* destX, double* destY, const double* destZ, const double srcX, const double srcY, const double srcZ)
- inverse_transform(ouble* srcX, double* srcY, double* srcZ, const double destX, const double destY, const double destZ)
- CRSTransformer* createGeoToXYAxisOrder(const char* crsString)
- Methods
- Indexing
- ErrorHandler
- CRSTransformer
- Classes
- Serial C++ API
- C API
- Serial C API
- Functions
- Serial Query functions
- Preprocessor macros
- Functions
- void* geomodelgrids_squery_create()
- geomodelgrids_squery_destroy(void** handle)
- void* geomodelgrids_squery_getErrorHandler()
- int geomodelgrids_squery_initialize(void* handle, const char* const modelFilenames[], const int modelFilenamesSize, const char* const valueNames[], const int valueNamesSize, const char* const inputCRSString)
- int geomodelgrids_squery_setSquashMinElev(const double value)
- int geomodelgrids_squery_setSquashing(const int value)
- double geomodelgrids_squery_queryTopElevation(const double x, const double y)
- double geomodelgrids_squery_queryTopoBathyElevation(const double x, const double y)
- int geomodelgrids_squery_query(const double* values, const double x, const double y, const double z)
- geomodelgrids_squery_finalize()
- Serial Query functions
- Examples
- Functions
- Parallel C API
- Utilities C API
- Functions
- Error Handler
- Enums
- Functions
- geomodelgrids_cerrorhandler_setLogFilename(void* handle, const char* filename)
- const char* const geomodelgrids_cerrorhandler_getLogFilename(void* handle) const
- geomodelgrids_cerrorhandler_setLoggingOn(void* handle, const int value)
- geomodelgrids_cerrorhandler_resetStatus(void* handle)
- GeomodelgridsStatusEnum geomodelgrids_cerrorhandler_getStatus(void* handle) const
- const char* geomodelgrids_cerrorhandler_getMessage(void* handle) const
- Error Handler
- Functions
- Serial C API