This is a LibCorr3D extension of the GeoTessModel for use by LibCorr3D. More...
#include <LibCorr3DModel.h>
Public Member Functions | |
LibCorr3DModel (const string &filename, const string &relGridFilePath, vector< int > &attributeFilter, int handle) | |
Standard constructor. More... | |
LibCorr3DModel (const string &filename, const string &relGridFilePath="", int handle=-1) | |
Standard constructor. More... | |
virtual | ~LibCorr3DModel () |
Destructor. More... | |
virtual string | class_name () |
Returns the class name. More... | |
const string & | getBaseModel () const |
const string & | getBaseModelVersion () const |
const string & | getComments () const |
double | getDeasts () const |
double | getDnorth () const |
const string & | getFileName () const |
Return the file name string associated with this model. More... | |
int | getHandle () const |
Return the handle associated with this model. More... | |
virtual LONG_INT | getMemory () |
Return the amount of memory currently occupied by this LibCorr3DModel object NOT INCLUDING THE GRIDS. More... | |
const string & | getParameters () const |
const string & | getPhase () const |
const string & | getRefsta () const |
const string & | getStaName () const |
double | getStationDepth () const |
double | getStationElevation () const |
double | getStationEndTime () const |
double | getStationLatitude () const |
double | getStationLongitude () const |
const string & | getStationName () const |
const double * | getStationPosition () const |
double | getStationStartTime () const |
const string & | getStaType () const |
const string & | getSupportedPhaseList () const |
string | getVmodel () const |
double | interpolate2DModelUncertainty (const double *pos) |
Calculates the old 2D model uncertainty if this model was loaded as such. More... | |
bool | is3DModel () |
Returns true if this model is a LibCorr3D model derived off of GeoTessModel. More... | |
bool | operator!= (const GeoTessModel &other) const |
Return true if this and the input other model are not equal. More... | |
bool | operator== (const GeoTessModel &m) const |
Return true if this and the input other model are equal. More... | |
void | setBaseModel (const string &bm) |
void | setBaseModelVersion (const string &bmv) |
void | setComments (const string &com) |
void | setParameters (const string &par) |
void | setPhase (const string &ph) |
void | setStationInfo (const string &name, const double &ontime, const double &offtime, const double &lat, const double &lon, const double &depth, const string &staname, const string &statype, const string &refsta, const double &dnorth, const double &deast) |
Set station information. More... | |
void | setSupportedPhaseList (const string &ph) |
Set the list of supported phases, formatted like this: Pg, Pn, P. More... | |
virtual string | toString () |
This is a LibCorr3D extension of the GeoTessModel for use by LibCorr3D.
Specific capabilities, beyond those of the base class, include acting as a metadata container for various additional descriptive strings, and to provide a home for the overloaded functions GeoTessModel::loadModelBinary(...) and GeoTessModel::loadExtraData(...) binary read functions.
Additionally, this derived model provides backward compatibility functions to load older LibCorr 2D models. These models are actually converted to a new GeoTess 3D representation on the fly so that none of the older interpolation functionality is required.
geotess::LibCorr3DModel::LibCorr3DModel | ( | const string & | filename, |
const string & | relGridFilePath = "" , |
||
int | handle = -1 |
||
) |
Standard constructor.
filename | is the name of the file containing the model to be loaded which can be either a new LibCorr3D model (extended from GeoTessModel), or an older LibCorr2D model. |
relGridFilePath | the relative path from the directory where the model resides to the directory where the tessellation grid file resides. |
handle | integer index of this model. This value is not processed in any way by LibCorr3DModel. It is specified here, stored in internal private variable, and returned by getHandle() method. |
geotess::LibCorr3DModel::LibCorr3DModel | ( | const string & | filename, |
const string & | relGridFilePath, | ||
vector< int > & | attributeFilter, | ||
int | handle | ||
) |
Standard constructor.
filename | is the name of the file containing the model to be loaded which can be either a new LibCorr3D model (extended from GeoTessModel), or an older LibCorr2D model. |
relGridFilePath | the relative path from the directory where the model resides to the directory where the tessellation grid file resides. |
attributeFilter | the indexes of the attributes in the model file that should be loaded into memory. Used to load into memory only a subset of all the attributes available in the model file. By default, all attributes are loaded. |
handle | integer index of this model. This value is not processed in any way by LibCorr3DModel. It is specified here, stored in internal private variable, and returned by getHandle() method. |
|
virtual |
Destructor.
|
inlinevirtual |
Returns the class name.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Return the file name string associated with this model.
|
inline |
Return the handle associated with this model.
This value is not processed in any way by LibCorr3DModel. It is specified in the constructore, stored in an internal private variable, and returned by this method.
|
inlinevirtual |
Return the amount of memory currently occupied by this LibCorr3DModel object NOT INCLUDING THE GRIDS.
To retrieve the size of the LibCorr3DGrid call model.getGrid().getMemory(). Note that multiple LibCorr3DModels may reference the same LibCorr3DGrid object so if you are working with multiple models and they might be sharing references to the same grids then the best way to find the memory requirements of the set of LibCorr3DGrid objects currently in use is to call the static method GeoTessModel::getReuseGridMapMemory().
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
double geotess::LibCorr3DModel::interpolate2DModelUncertainty | ( | const double * | pos | ) |
Calculates the old 2D model uncertainty if this model was loaded as such.
This function is not called if is3DModel() is true.
pos | a 3-element array of doubles defining the unit vector that defines the geographic position where the uncertainty is to be evaluated. |
|
inline |
|
inline |
Return true if this and the input other model are not equal.
bool geotess::LibCorr3DModel::operator== | ( | const GeoTessModel & | m | ) | const |
Return true if this and the input other model are equal.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Set station information.
name | station name |
onTime | epoch time when station became active |
offTime | epoch time when station ceased to be active |
lat | latitude in degrees |
lon | longitude in degrees |
depth | depth of station below surface of ellipsoid in km (negative elevation) @paraam staname descriptive name of the station |
statype | single station (ss) or array (ar) |
refsta | reference station for arrays |
dnorth | northing from station to array beam point in km |
deast | easting from station to array beam point in km |
|
inline |
Set the list of supported phases, formatted like this: Pg, Pn, P.
|
virtual |