OpendTect
7.0
|
Holds survey general information. More...
Public Types | |
using | Pol2D3D = OD::Pol2D3D |
enum | Unit { Second , Meter , Feet } |
Public Types inherited from ObjectWithName | |
typedef OD::String | name_type |
Public Member Functions | |
SurveyInfo (const SurveyInfo &) | |
~SurveyInfo () | |
float | angleXCrl () const |
float | angleXInl () const |
const Pos::IdxPair2Coord & | binID2Coord () const |
void | checkCrlRange (Interval< int > &, bool work) const |
Makes sure range is inside. More... | |
void | checkInlRange (Interval< int > &, bool work) const |
Makes sure range is inside. More... | |
void | checkZRange (Interval< float > &, bool work) const |
Makes sure range is inside. More... | |
const char * | comment () const |
float | crlDistance () const |
StepInterval< int > | crlRange () const |
StepInterval< int > | crlRange (bool work) const |
int | crlStep () const |
bool | depthsInFeet () const |
ZDomain::DepthType | depthType () const |
const SurveyDiskLocation & | diskLocation () const |
void | gen3Pts () |
RefMan< Survey::Geometry3D > | get3DGeometry (bool work) const |
void | get3Pts (Coord c[3], BinID b[2], int &xline) const |
float | getArea (bool work) const |
returns m2 More... | |
float | getArea (const Interval< int > &inl, const Interval< int > &crl) const |
returns m2 More... | |
Pos::IdxPair2Coord & | getBinID2Coord () const |
RefMan< Coords::CoordSystem > | getCoordSystem () |
ConstRefMan< Coords::CoordSystem > | getCoordSystem () const |
BufferString | getDataDirName () const |
BufferString | getDirName () const |
LatLong2Coord & | getLatlong2Coord () const |
IOPar & | getLogPars () const |
IOPar & | getPars () const |
uiString | getUiXYUnitString (bool abbrviated=true, bool withparens=true) const |
const uiString | getUiZUnitString (bool withparens=true) const |
const char * | getXYUnitString (bool withparens=true) const |
const char * | getZUnitString (bool withparens=true) const |
bool | has2D () const |
bool | has3D () const |
bool | hasProjection () const |
bool | includes (const BinID &, const float, bool work) const |
Returns true when pos is inside survey-range. More... | |
float | inlDistance () const |
distance for one increment More... | |
StepInterval< int > | inlRange () const |
StepInterval< int > | inlRange (bool work) const |
int | inlStep () const |
bool | isClockWise () const |
Don't use. Will be removed. More... | |
bool | isInside (const BinID &, bool work) const |
bool | isReasonable (const BinID &) const |
Checks if in or near survey. More... | |
bool | isReasonable (const Coord &) const |
Checks if in or near survey. More... | |
bool | isRightHandSystem () const |
bool | isWorkRangeSet () const |
const LatLong2Coord & | latlong2Coord () const |
const IOPar & | logPars () const |
Return survey creation log. More... | |
Coord | maxCoord (bool work) const |
int | maxNrTraces (bool work) const |
Coord | minCoord (bool work) const |
int | nrXYDecimals () const |
int | nrZDecimals () const |
Coord3 | oneStepTranslation (const Coord3 &planenormal) const |
bool | operator!= (const SurveyInfo &) const |
SurveyInfo & | operator= (const SurveyInfo &) |
bool | operator== (const SurveyInfo &) const |
const IOPar & | pars () const |
Returns contents of .defs file. More... | |
void | putZDomain (IOPar &) const |
void | readSavedCoordSystem () const |
Useful after loading plugins. More... | |
Interval< int > | reasonableRange (bool inl) const |
const TrcKeyZSampling & | sampling (bool work) const |
void | saveJSON (const char *basedir, OD::JSON::Object *obj=nullptr) const |
Write to .defs file. More... | |
void | saveLog (const char *basedir=nullptr) const |
void | savePars (const char *basedir=nullptr) const |
float | seismicReferenceDatum () const |
const char * | set3Pts (const Coord c[3], const BinID b[2], int xline) |
uiString | set3PtsWithMsg (const Coord c[3], const BinID b[2], int xline) |
void | setComment (const char *s) |
bool | setCoordSystem (Coords::CoordSystem *) |
void | setDepthInFeet (bool yn=true) |
void | setRange (const TrcKeyZSampling &, bool) |
void | setSeismicReferenceDatum (float d) |
void | setSipName (BufferString sipnm) |
void | setSurvDataType (OD::Pol2D3D typ) |
void | setTr (double, double, double, bool isx) |
void | setWorkRange (const TrcKeyZSampling &) |
void | setXYInFeet (bool yn=true) |
void | setZUnit (bool istime, bool infeet=false) |
float | showZ2UserFactor () const |
BufferString | sipName () const |
void | snap (BinID &, const BinID &dir=BinID(0, 0)) const |
dir = 0 : auto; -1 round downward, 1 round upward More... | |
void | snapStep (BinID &, const BinID &dir=BinID(0, 0)) const |
see snap() for direction More... | |
void | snapZ (float &, int direction=0) const |
see snap() for direction More... | |
OD::Pol2D3D | survDataType () const |
Coord | transform (const BinID &b) const |
BinID | transform (const Coord &) const |
void | update3DGeometry () |
void | updateDirName () |
May be used after setName() More... | |
bool | write (const char *basedir=nullptr) const |
bool | writeJSON (const char *basedir=nullptr) const |
Write to .survey file. More... | |
bool | xyInFeet () const |
Unit | xyUnit () const |
const ZDomain::Def & | zDomain () const |
const ZDomain::Info & | zDomainInfo () const |
bool | zInFeet () const |
bool | zInMeter () const |
bool | zIsTime () const |
const StepInterval< float > & | zRange () const |
const StepInterval< float > & | zRange (bool work) const |
float | zScale () const |
float | zStep () const |
Unit | zUnit () const |
Public Member Functions inherited from NamedCallBacker | |
NamedCallBacker (const char *nm=0) | |
NamedCallBacker (const NamedCallBacker &) | |
virtual Notifier< NamedCallBacker > & | objectToBeDeleted () const |
bool | operator== (const NamedCallBacker &oth) const |
bool | operator== (const NamedObject &oth) const |
Public Member Functions inherited from CallBacker | |
CallBacker () | |
CallBacker (const CallBacker &) | |
virtual | ~CallBacker () |
bool | attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const |
bool | attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const |
void | detachAllNotifiers () const |
Call from the destructor of your inherited object. More... | |
void | detachCB (const NotifierAccess &, const CallBack &) const |
void | detachCB (const NotifierAccess *notif, const CallBack &cb) const |
virtual bool | isCapsule () const |
bool | isNotifierAttached (const NotifierAccess *) const |
Only for debugging purposes, don't use. More... | |
void | stopReceivingNotifications () const |
virtual CallBacker * | trueCaller () |
Public Member Functions inherited from NamedObject | |
NamedObject (const char *nm=nullptr) | |
NamedObject (const NamedObject &oth) | |
virtual | ~NamedObject () |
virtual BufferString | getName () const |
bool | getNameFromPar (const IOPar &) |
const name_type & | name () const override |
NamedObject & | operator= (const NamedObject &) |
bool | operator== (const NamedObject &oth) const |
virtual void | setName (const char *nm) |
Public Member Functions inherited from ObjectWithName | |
virtual | ~ObjectWithName () |
bool | hasName (const char *nm) const |
bool | hasName (const name_type &nm) const |
void | putNameInPar (IOPar &) const |
Static Public Member Functions | |
static const char * | curSurveyName () |
Survey directory name (not a full path) More... | |
static float | defaultXYtoZScale (Unit, Unit) |
static void | deleteInstance () |
static SurveyInfo & | empty () |
static Notifier< SurveyInfo > & | instanceCreated () |
static uiRetVal | isValidDataRoot (const char *) |
static uiRetVal | isValidSurveyDir (const char *) |
static SurveyInfo * | popSI () |
static void | pushSI (SurveyInfo *) |
static SurveyInfo * | read (const char *path, bool pathisfile) |
static SurveyInfo * | read (const char *survdir) |
static SurveyInfo * | readDirectory (const char *loc) |
static SurveyInfo * | readFile (const char *loc) |
static const char * | sKeyBasicSurveyName () |
static const char * | sKeyComments () |
static const char * | sKeyCrlRange () |
static const char * | sKeyCRS () |
static const char * | sKeyDef () |
static const char * | sKeyDomain () |
static const char * | sKeyDpthInFt () |
Not used by SI, just a UI default. More... | |
static const char * | sKeyIC () |
static const char * | sKeyInlRange () |
static const char * | sKeyProjVersion () |
static const char * | sKeySeismicRefDatum () |
static const char * | sKeySetPt () |
static const char * | sKeySetupFileName () |
static const char * | sKeySurvDataType () |
static const char * | sKeySurvDiskLoc () |
static const char * | sKeyTransformation () |
static const char * | sKeyXRange () |
static const char * | sKeyXY () |
static const char * | sKeyXYInFt () |
static const char * | sKeyYRange () |
static const char * | sKeyZAxis () |
static const char * | sKeyZRange () |
Static Public Member Functions inherited from CallBacker | |
static void | createReceiverForCurrentThread () |
static void | removeReceiverForCurrentThread () |
Public Attributes | |
Notifier< SurveyInfo > | workRangeChg |
Protected Member Functions | |
SurveyInfo () | |
void | handleLineRead (const BufferString &, const char *) |
void | putTr (const Pos::IdxPair2Coord::DirTransform &, ascostream &, const char *) const |
void | setTr (Pos::IdxPair2Coord::DirTransform &, const char *) |
bool | wrapUpRead () |
void | writeSpecLines (ascostream &) const |
void | writeSpecLines (ascostream *, OD::JSON::Object *obj=nullptr) const |
Protected Member Functions inherited from NamedCallBacker | |
void | sendDelNotif () const |
Static Protected Member Functions | |
static SurveyInfo * | readJSON (const OD::JSON::Object &, uiRetVal &) |
static SurveyInfo * | readStrm (od_istream &, uiRetVal &) |
Protected Attributes | |
Pos::IdxPair2Coord | b2c_ |
BufferString | comment_ |
RefMan< Coords::CoordSystem > | coordsystem_ |
bool | depthsinfeet_ |
SurveyDiskLocation | disklocation_ |
LatLong2Coord & | ll2c_ |
IOPar | logpars_ |
IOPar & | pars_ |
Threads::AtomicPointer< Survey::Geometry3D > | s3dgeom_ |
float | seisrefdatum_ |
BinID | set3binids_ [3] |
Coord | set3coords_ [3] |
BufferString | sipnm_ |
OD::Pol2D3D | survdatatype_ |
bool | survdatatypeknown_ |
TrcKeyZSampling & | tkzs_ |
TrcKeyZSampling & | wcs_ |
Threads::AtomicPointer< Survey::Geometry3D > | work_s3dgeom_ |
bool | xyinfeet_ |
ZDomain::Def & | zdef_ |
Protected Attributes inherited from NamedCallBacker | |
Threads::Atomic< bool > | delalreadytriggered_ |
Notifier< NamedCallBacker > | delnotif_ |
Protected Attributes inherited from NamedObject | |
BufferString | name_ |
Private Member Functions | |
bool | writeSurveyFile (const char *basedir, bool isjson) const |
Static Private Member Functions | |
static void | setSurveyName (const char *surveydirnm) |
static const char * | surveyFileName () |
Private Attributes | |
Pos::IdxPair2Coord::DirTransform | rdxtr_ |
Pos::IdxPair2Coord::DirTransform | rdytr_ |
Friends | |
class | EmptyTempSurvey |
class | IOMan |
const SurveyInfo & | SI () |
class | uiSurvey |
class | uiSurveyInfoEditor |
class | uiSurveyMap |
Holds survey general information.
The surveyinfo is the primary source for ranges and steps.It also provides the transformation between inline/xline <-> coordinates and lat/long estimates
Note: the Z range step is only a default. It should not be used further because different cubes/lines have different sample rates.
The ranges are defined for two cubes: the entire survey, and a 'working area'. Normally, you'll want to have the working area.
If you are an expert, and you feel you need more 'power', you may want to look at the bottom part of the class too for some more public functions.
<>
using SurveyInfo::Pol2D3D = OD::Pol2D3D |
enum SurveyInfo::Unit |
SurveyInfo::~SurveyInfo | ( | ) |
|
protected |
SurveyInfo::SurveyInfo | ( | const SurveyInfo & | ) |
float SurveyInfo::angleXCrl | ( | ) | const |
It's the angle between the X-axis (East) and a Crossline
float SurveyInfo::angleXInl | ( | ) | const |
It's the angle between the X-axis (East) and an Inline
|
inline |
void SurveyInfo::checkCrlRange | ( | Interval< int > & | , |
bool | work | ||
) | const |
Makes sure range is inside.
void SurveyInfo::checkInlRange | ( | Interval< int > & | , |
bool | work | ||
) | const |
Makes sure range is inside.
void SurveyInfo::checkZRange | ( | Interval< float > & | , |
bool | work | ||
) | const |
Makes sure range is inside.
|
inline |
float SurveyInfo::crlDistance | ( | ) | const |
|
inline |
StepInterval<int> SurveyInfo::crlRange | ( | bool | work | ) | const |
int SurveyInfo::crlStep | ( | ) | const |
|
static |
Survey directory name (not a full path)
Gives a ballpark figure of how to scale XY to make it comparable to Z.
|
inlinestatic |
|
inline |
ZDomain::DepthType SurveyInfo::depthType | ( | ) | const |
const SurveyDiskLocation& SurveyInfo::diskLocation | ( | ) | const |
|
static |
void SurveyInfo::gen3Pts | ( | ) |
RefMan<Survey::Geometry3D> SurveyInfo::get3DGeometry | ( | bool | work | ) | const |
float SurveyInfo::getArea | ( | bool | work | ) | const |
returns m2
returns m2
|
inline |
RefMan<Coords::CoordSystem> SurveyInfo::getCoordSystem | ( | ) |
ConstRefMan<Coords::CoordSystem> SurveyInfo::getCoordSystem | ( | ) | const |
BufferString SurveyInfo::getDataDirName | ( | ) | const |
BufferString SurveyInfo::getDirName | ( | ) | const |
|
inline |
|
inline |
|
inline |
uiString SurveyInfo::getUiXYUnitString | ( | bool | abbrviated = true , |
bool | withparens = true |
||
) | const |
|
inline |
const char* SurveyInfo::getXYUnitString | ( | bool | withparens = true | ) | const |
|
inline |
|
protected |
bool SurveyInfo::has2D | ( | ) | const |
bool SurveyInfo::has3D | ( | ) | const |
bool SurveyInfo::hasProjection | ( | ) | const |
bool SurveyInfo::includes | ( | const BinID & | , |
const float | , | ||
bool | work | ||
) | const |
Returns true when pos is inside survey-range.
float SurveyInfo::inlDistance | ( | ) | const |
distance for one increment
|
inline |
StepInterval<int> SurveyInfo::inlRange | ( | bool | work | ) | const |
int SurveyInfo::inlStep | ( | ) | const |
|
static |
|
inline |
Don't use. Will be removed.
bool SurveyInfo::isInside | ( | const BinID & | , |
bool | work | ||
) | const |
bool SurveyInfo::isReasonable | ( | const BinID & | ) | const |
Checks if in or near survey.
bool SurveyInfo::isReasonable | ( | const Coord & | ) | const |
Checks if in or near survey.
bool SurveyInfo::isRightHandSystem | ( | ) | const |
Orientation is determined by rotating the inline axis to the crossline axis.
|
static |
Full path to a writable directory Exclusively for usage in modules below General
|
static |
Full path to an OpendTect project directory Exclusively for usage in modules below General
bool SurveyInfo::isWorkRangeSet | ( | ) | const |
|
inline |
|
inline |
Return survey creation log.
Coord SurveyInfo::maxCoord | ( | bool | work | ) | const |
int SurveyInfo::maxNrTraces | ( | bool | work | ) | const |
Coord SurveyInfo::minCoord | ( | bool | work | ) | const |
int SurveyInfo::nrXYDecimals | ( | ) | const |
int SurveyInfo::nrZDecimals | ( | ) | const |
bool SurveyInfo::operator!= | ( | const SurveyInfo & | ) | const |
SurveyInfo& SurveyInfo::operator= | ( | const SurveyInfo & | ) |
bool SurveyInfo::operator== | ( | const SurveyInfo & | ) | const |
|
inline |
Returns contents of .defs file.
|
static |
|
static |
|
protected |
void SurveyInfo::putZDomain | ( | IOPar & | ) | const |
|
static |
|
static |
|
static |
|
static |
|
staticprotected |
void SurveyInfo::readSavedCoordSystem | ( | ) | const |
Useful after loading plugins.
|
staticprotected |
Interval<int> SurveyInfo::reasonableRange | ( | bool | inl | ) | const |
|
inline |
void SurveyInfo::saveJSON | ( | const char * | basedir, |
OD::JSON::Object * | obj = nullptr |
||
) | const |
Write to .defs file.
void SurveyInfo::saveLog | ( | const char * | basedir = nullptr | ) | const |
void SurveyInfo::savePars | ( | const char * | basedir = nullptr | ) | const |
|
inline |
In depth units (m or ft), positive upward from sea level. Always in meters for time surveys
|
inline |
bool SurveyInfo::setCoordSystem | ( | Coords::CoordSystem * | ) |
|
inline |
void SurveyInfo::setRange | ( | const TrcKeyZSampling & | , |
bool | |||
) |
|
inline |
|
inline |
|
inline |
|
staticprivate |
void SurveyInfo::setTr | ( | double | , |
double | , | ||
double | , | ||
bool | isx | ||
) |
|
protected |
void SurveyInfo::setWorkRange | ( | const TrcKeyZSampling & | ) |
|
inline |
void SurveyInfo::setZUnit | ( | bool | istime, |
bool | infeet = false |
||
) |
|
inline |
|
inline |
|
inlinestatic |
|
inlinestatic |
|
static |
|
inlinestatic |
|
inlinestatic |
|
inlinestatic |
|
static |
Not used by SI, just a UI default.
|
inlinestatic |
|
static |
|
inlinestatic |
|
static |
|
inlinestatic |
|
inlinestatic |
|
static |
|
inlinestatic |
|
inlinestatic |
|
static |
|
inlinestatic |
|
static |
|
static |
|
inlinestatic |
|
static |
dir = 0 : auto; -1 round downward, 1 round upward
see snap() for direction
void SurveyInfo::snapZ | ( | float & | , |
int | direction = 0 |
||
) | const |
see snap() for direction
|
inline |
|
staticprivate |
void SurveyInfo::update3DGeometry | ( | ) |
void SurveyInfo::updateDirName | ( | ) |
May be used after setName()
|
protected |
bool SurveyInfo::write | ( | const char * | basedir = nullptr | ) | const |
bool SurveyInfo::writeJSON | ( | const char * | basedir = nullptr | ) | const |
Write to .survey file.
|
protected |
|
protected |
|
private |
bool SurveyInfo::xyInFeet | ( | ) | const |
Unit SurveyInfo::xyUnit | ( | ) | const |
const ZDomain::Def& SurveyInfo::zDomain | ( | ) | const |
const ZDomain::Info& SurveyInfo::zDomainInfo | ( | ) | const |
|
inline |
|
inline |
bool SurveyInfo::zIsTime | ( | ) | const |
|
inline |
const StepInterval<float>& SurveyInfo::zRange | ( | bool | work | ) | const |
float SurveyInfo::zScale | ( | ) | const |
Gives a ballpark figure of how to scale Z to make it comparable to XY.
float SurveyInfo::zStep | ( | ) | const |
Unit SurveyInfo::zUnit | ( | ) | const |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
private |
|
private |
|
mutableprotected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
mutableprotected |
Notifier<SurveyInfo> SurveyInfo::workRangeChg |
|
protected |
|
protected |
Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B.V. 1995-2024