![]() |
OpendTect
6.3
|
Holds survey general information. More...
Public Types | |
| enum | Pol2D { No2D =0, Both2DAnd3D =1, Only2D =2 } |
| enum | Unit { Second, Meter, Feet } |
Public Types inherited from Monitorable | |
| typedef int | ChangeType |
| typedef int64_t | IDType |
| typedef int64_t | DirtyCountType |
| typedef CNotifier< Monitorable, ChangeData > | ChangeDataNotifier |
Public Member Functions | |
| bool | has2D () const |
| bool | has3D () const |
| StepInterval< int > | inlRange (bool work) const |
| StepInterval< int > | crlRange (bool work) const |
| StepInterval< float > | zRange (bool work) const |
| TrcKeyZSampling | sampling (bool work) const |
| int | inlStep () const |
| int | crlStep () const |
| float | zStep () const |
| float | inlDistance () const |
| distance for one increment More... | |
| float | crlDistance () const |
| Coord | transform (const BinID &) const |
| BinID | transform (const Coord &) const |
| bool | xyInFeet () const |
| uiString | xyUnitString (bool abbrviated=true, bool withparens=true) const |
| const char * | fileXYUnitString (bool withparens=true) const |
| const ZDomain::Def & | zDomain () const |
| float | showZ2UserFactor () const |
| uiString | zUnitString (bool withparens=true) const |
| const char * | fileZUnitString (bool withparens=true) const |
| bool | depthsInFeet () const |
| void | setDepthsInFeet (const bool &_set_to_) |
| bool | zIsTime () const |
| bool | zInMeter () const |
| bool | zInFeet () const |
| Coord | minCoord (bool work) const |
| Coord | maxCoord (bool work) const |
| 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... | |
| Interval< int > | reasonableRange (bool inl) const |
| int | maxNrTraces (bool work) const |
| bool | isRightHandSystem () const |
| float | angleXInl () const |
| void | checkInlRange (Interval< int > &, bool work) const |
| void | checkCrlRange (Interval< int > &, bool work) const |
| void | checkZRange (Interval< float > &, bool work) const |
| bool | includes (const BinID &, const float, bool work) 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... | |
| float | seismicReferenceDatum () const |
| void | setSeismicReferenceDatum (const float &_set_to_) |
| IOPar | getDefaultPars () const |
| void | setDefaultPar (const char *ky, const char *val, bool save2storage) const |
| void | setDefaultPars (const IOPar &, bool save2storage) const |
| void | removeKeyFromDefaultPars (const char *ky, bool save2storage) const |
| void | putZDomain (IOPar &) const |
| void | setWorkRange (const TrcKeyZSampling &) const |
| void | getCreationData (IOPar &) const |
| std creation entries and some SIP stuff More... | |
| RefMan< Survey::Geometry3D > | get3DGeometry (bool work) const |
| RefMan< Coords::PositionSystem > | getCoordSystem () |
| ConstRefMan< Coords::PositionSystem > | getCoordSystem () const |
| float | getArea (Interval< int > inl, Interval< int > crl) const |
| returns square meters More... | |
| float | getArea (bool work) const |
| returns square meters More... | |
| Coord3 | oneStepTranslation (const Coord3 &planenormal) const |
| SurveyInfo () | |
| ~SurveyInfo () | |
| SurveyInfo (const SurveyInfo &) | |
| SurveyInfo & | operator= (const SurveyInfo &) |
| bool | operator== (const SurveyInfo &) const |
| bool | operator!= (const SurveyInfo &oth) const |
| virtual SurveyInfo * | clone () const |
| ChangeType | compareWith (const Monitorable &) const |
| virtual SurveyInfo * | getClone () const |
| Pos::IdxPair2Coord | binID2Coord () const |
| void | get3Pts (Coord c[3], BinID b[2], int &xline) const |
| bool | isClockWise () const |
| void | setZUnit (bool istime, bool infeet=false) |
| BufferString | getDirName () const |
| void | setDirName (const BufferString &_set_to_) |
| BufferString | getBasePath () const |
| void | setBasePath (const BufferString &_set_to_) |
| BufferString | getFullDirPath () const |
| Pol2D | survDataType () const |
| void | setSurvDataType (Pol2D) const |
| uiString | sipName () const |
| void | setSipName (const uiString &) |
| bool | write (const char *basedir=0) const |
| Write to .survey file and .defs file. More... | |
| void | saveDefaultPars (const char *basedir=0) const |
| Write to .defs file. More... | |
| void | saveComments (const char *basedir=0) const |
| Write to .comments file. More... | |
| void | setRange (const TrcKeyZSampling &) |
| const char * | set3Pts (const Coord c[3], const BinID b[2], int xline) |
| const uiString | set3PtsUiMsg (const Coord c[3], const BinID b[2], int) |
| void | gen3Pts () |
| bool | setCoordSystem (Coords::PositionSystem *) |
| void | update3DGeometry () |
| bool | usePar (const IOPar &) |
| void | fillPar (IOPar &) const |
| bool | isFresh () const |
| void | setNotFresh () const |
| void | setFreshSetupData (const IOPar &) const |
| void | getFreshSetupData (IOPar &) const |
| IOPar & | defaultPars () |
| const IOPar & | pars () const |
| void | savePars (const char *basedir=0) const |
| IOPar & | getPars () const |
| BufferString | getDataDirName () const |
| void | setRange (const TrcKeyZSampling &cs, bool work) |
| const char * | getZUnitString (bool wp=true) const |
| uiString | getUiZUnitString (bool wp=true) const |
| const char * | getXYUnitString (bool wp=true) const |
| uiString | getUiXYUnitString (bool a=true, bool p=true) const |
| Unit | xyUnit () const |
| Unit | zUnit () const |
| float | zScale () const |
Public Member Functions inherited from NamedMonitorable | |
| NamedMonitorable (const char *nm=0) | |
| NamedMonitorable (const NamedObject &) | |
| virtual | ~NamedMonitorable () |
| NamedMonitorable (const NamedMonitorable &) | |
| NamedMonitorable & | operator= (const NamedMonitorable &) |
| bool | operator== (const NamedMonitorable &) const |
| bool | operator!= (const NamedMonitorable &oth) const |
| virtual BufferString | getName () const |
| virtual void | setName (const char *) |
Public Member Functions inherited from Monitorable | |
| Monitorable (const Monitorable &) | |
| virtual | ~Monitorable () |
| Monitorable & | operator= (const Monitorable &) |
| bool | operator== (const Monitorable &) const |
| virtual ChangeDataNotifier & | objectChanged () const |
| virtual Notifier< Monitorable > & | objectToBeDeleted () const |
| virtual void | touch () const |
| virtual DirtyCountType | dirtyCount () const |
| void | sendChangeNotification (const ChangeData &) const |
| void | sendEntireObjectChangeNotification () const |
| void | transferNotifsTo (const Monitorable &, const CallBacker *onlyfor=0) 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 | detachCB (const NotifierAccess &, const CallBack &) const |
| void | detachCB (const NotifierAccess *notif, const CallBack &cb) const |
| bool | isNotifierAttached (const NotifierAccess *) const |
| Only for debugging purposes, don't use. More... | |
| virtual bool | isCapsule () const |
| void | stopReceivingNotifications () const |
Public Member Functions inherited from NamedObject | |
| NamedObject (const char *nm=0) | |
| NamedObject (const NamedObject &oth) | |
| virtual | ~NamedObject () |
| NamedObject & | operator= (const NamedObject &) |
| bool | operator== (const NamedObject &oth) const |
| virtual const OD::String & | name () const |
| bool | getNameFromPar (const IOPar &) |
| void | putNameInPar (IOPar &) const |
Static Public Member Functions | |
| static const EnumDefImpl< Pol2D > & | Pol2DDef () |
| static const char ** | Pol2DNames () |
| static bool | parseEnumPol2D (const char *, Pol2D &) |
| static bool | parseEnum (const char *, Pol2D &) |
| static bool | parseEnum (const IOPar &, const char *, Pol2D &) |
| static Pol2D | parseEnumPol2D (const char *) |
| static const char * | toString (Pol2D) |
| static uiString | toUiString (Pol2D) |
| static const char * | getPol2DString (Pol2D) |
| static ChangeType | cSetupChange () |
| static ChangeType | cRangeChange () |
| static ChangeType | cWorkRangeChange () |
| static ChangeType | cParsChange () |
| static ChangeType | cPol2DChange () |
| static ChangeType | cAuxDataChange () |
| static ChangeType | cCommentChange () |
| static bool | isMinorChange (ChangeType ct) |
| static bool | isSetupChange (ChangeType ct) |
| static const char * | sKeyInlRange () |
| static const char * | sKeyCrlRange () |
| static const char * | sKeyXRange () |
| static const char * | sKeyYRange () |
| static const char * | sKeyZRange () |
| static const char * | sKeyXYInFt () |
| static const char * | sKeyDpthInFt () |
| Not used by SI, just a UI default. More... | |
| static const char * | sKeySurvDataType () |
| static const char * | sKeySeismicRefDatum () |
| static const char * | sSetupFileName () |
| static const char * | sBasicSurveyName () |
| static BufferString | dirNameForName (const char *) |
| static SurveyInfo * | read (const char *, uiRetVal &) |
| static uiRetVal | isValidDataRoot (const char *) |
| static uiRetVal | isValidSurveyDir (const char *) |
| static float | defaultXYtoZScale (Unit, Unit) |
Static Public Member Functions inherited from NamedMonitorable | |
| static Notifier< NamedMonitorable > & | instanceCreated () |
| static ChangeType | cNameChange () |
Static Public Member Functions inherited from Monitorable | |
| static Notifier< Monitorable > & | instanceCreated () |
| defines static instanceCreated() More... | |
| static ChangeType | cEntireObjectChange () |
| static ChangeType | cNoChange () |
| static IDType | cUnspecChgID () |
| static IDType | cEntireObjectChgID () |
| static ChangeType | changeNotificationTypeOf (CallBacker *) |
Static Public Member Functions inherited from CallBacker | |
| static void | createReceiverForCurrentThread () |
| static void | removeReceiverForCurrentThread () |
Protected Member Functions | |
| bool | wrapUpRead () |
| BufferString | comments () const |
| void | setComments (const BufferString &_set_to_) |
| TrcKeyZSampling & | gtSampling (bool work) const |
| void | copyAll (const SurveyInfo &) |
Protected Member Functions inherited from NamedMonitorable | |
| void | copyAll (const NamedMonitorable &) |
Protected Member Functions inherited from Monitorable | |
| Monitorable () | |
| void | copyAll (const Monitorable &) |
| void | sendChgNotif (AccessLocker &, const ChangeData &) const |
| calls objectChanged with released lock More... | |
| void | sendChgNotif (AccessLocker &, ChangeType, IDType) const |
| calls objectChanged with released lock More... | |
| void | sendDelNotif () const |
| void | stopChangeNotifications () const |
| void | resumeChangeNotifications () const |
| template<class T > | |
| T | getMemberSimple (const T &) const |
| the get function used by mImplSimpleMonitoredGet More... | |
| template<class TMember , class TSetTo > | |
| void | setMemberSimple (TMember &, TSetTo, ChangeType, IDType) |
| the set function used by mImplSimpleMonitoredSet More... | |
Protected Member Functions inherited from CallBacker | |
| void | detachAllNotifiers () const |
| Call from the destructor of your inherited object. More... | |
Protected Attributes | |
| const BufferString | uniqueid_ |
| BufferString | basepath_ |
| The 'data root'. More... | |
| BufferString | dirname_ |
| The subdirectory name. More... | |
| ZDomain::Def & | zdef_ |
| bool | depthsinfeet_ |
| TrcKeyZSampling & | fullcs_ |
| TrcKeyZSampling & | workcs_ |
| float | seisrefdatum_ |
| IOPar | defpars_ |
| RefMan< Coords::PositionSystem > | coordsystem_ |
| Survey::Geometry3D * | s3dgeom_ |
| Survey::Geometry3D * | work_s3dgeom_ |
| Pos::IdxPair2Coord | b2c_ |
| BinID | set3binids_ [3] |
| Coord | set3coords_ [3] |
| Pol2D | pol2d_ |
| bool | pol2dknown_ |
| BufferString | comments_ |
| uiString | sipnm_ |
Protected Attributes inherited from Monitorable | |
| Threads::Lock | accesslock_ |
Protected Attributes inherited from NamedObject | |
| BufferString | name_ |
Private Member Functions | |
| void | copyClassData (const SurveyInfo &) |
| ChangeType | compareClassData (const SurveyInfo &) const |
Static Private Member Functions | |
| static uiString | tr (const char *text, const char *disambiguation=0, int pluralnr=-1) |
| static uiString | legacyTr (const char *text, const char *disambiguation=0, int pluralnr=-1) |
| static EnumDefImpl< Pol2D > * | Pol2DCreateDef () |
| static uiRetVal | setSurveyLocation (const char *, const char *, bool) |
Private Attributes | |
| Pos::IdxPair2Coord | rdb2c_ |
Static Private Attributes | |
| static const char * | Pol2DKeys_ [] |
| static ConstPtrMan< EnumDefImpl< Pol2D > > | Pol2DDefinition_ |
Friends | |
| class | DBMan |
| class | uiSurveyManager |
| class | uiSurveyInfoEditor |
| const SurveyInfo & | SI () |
Additional Inherited Members | |
Protected Types inherited from Monitorable | |
| typedef Threads::Atomic< DirtyCountType > | DirtyCounter |
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.
To keep things safe we have made the non-const stuff inaccessible for casual use. On non-shared objects, you can do as you like wth all the non-const functions. The SI(), that is shared by all objects, is a const reference. If you have to edit something in your own local copy, cast the const away.
The 'major' changes are thus done only via assignment, for SI() preferably by specialist classes.
This does not need to be done for the 'minor' changes like work sampling, defaultPars() and comment(). These can be changed at any time and the regular 'change-and-notify' will apply - even while the functions are 'const' functions.
| enum SurveyInfo::Pol2D |
| enum SurveyInfo::Unit |
| SurveyInfo::SurveyInfo | ( | ) |
| SurveyInfo::~SurveyInfo | ( | ) |
| SurveyInfo::SurveyInfo | ( | const SurveyInfo & | ) |
| float SurveyInfo::angleXInl | ( | ) | const |
angle between the X-axis (East) and an Inline
| Pos::IdxPair2Coord SurveyInfo::binID2Coord | ( | ) | const |
|
inlinestatic |
|
inlinestatic |
| void SurveyInfo::checkCrlRange | ( | Interval< int > & | , |
| bool | work | ||
| ) | const |
| void SurveyInfo::checkInlRange | ( | Interval< int > & | , |
| bool | work | ||
| ) | const |
| void SurveyInfo::checkZRange | ( | Interval< float > & | , |
| bool | work | ||
| ) | const |
|
inlinevirtual |
Reimplemented from NamedMonitorable.
|
inlineprotected |
|
private |
|
virtual |
Reimplemented from NamedMonitorable.
|
protected |
|
private |
|
inlinestatic |
|
inlinestatic |
|
inlinestatic |
| float SurveyInfo::crlDistance | ( | ) | const |
| StepInterval<int> SurveyInfo::crlRange | ( | bool | work | ) | const |
| int SurveyInfo::crlStep | ( | ) | const |
|
inlinestatic |
|
inlinestatic |
|
inline |
Gives a ballpark figure of how to scale XY to make it comparable to Z.
|
inline |
|
static |
| const char* SurveyInfo::fileXYUnitString | ( | bool | withparens = true | ) | const |
| const char* SurveyInfo::fileZUnitString | ( | bool | withparens = true | ) | const |
| void SurveyInfo::fillPar | ( | IOPar & | ) | const |
| void SurveyInfo::gen3Pts | ( | ) |
| RefMan<Survey::Geometry3D> SurveyInfo::get3DGeometry | ( | bool | work | ) | const |
| float SurveyInfo::getArea | ( | bool | work | ) | const |
returns square meters
|
inline |
|
inlinevirtual |
Reimplemented from NamedMonitorable.
| RefMan<Coords::PositionSystem> SurveyInfo::getCoordSystem | ( | ) |
| ConstRefMan<Coords::PositionSystem> SurveyInfo::getCoordSystem | ( | ) | const |
| void SurveyInfo::getCreationData | ( | IOPar & | ) | const |
std creation entries and some SIP stuff
|
inline |
| IOPar SurveyInfo::getDefaultPars | ( | ) | const |
is in depth units (m or ft), positive upward from sea level. Always in meters for time surveys
|
inline |
| void SurveyInfo::getFreshSetupData | ( | IOPar & | ) | const |
| BufferString SurveyInfo::getFullDirPath | ( | ) | const |
|
inline |
|
static |
|
inline |
|
inline |
|
inline |
|
inline |
|
inlineprotected |
| bool SurveyInfo::has2D | ( | ) | const |
| bool SurveyInfo::has3D | ( | ) | const |
| bool SurveyInfo::includes | ( | const BinID & | , |
| const float | , | ||
| bool | work | ||
| ) | const |
| float SurveyInfo::inlDistance | ( | ) | const |
distance for one increment
| StepInterval<int> SurveyInfo::inlRange | ( | bool | work | ) | const |
| int SurveyInfo::inlStep | ( | ) | const |
|
inline |
| bool SurveyInfo::isFresh | ( | ) | const |
| bool SurveyInfo::isInside | ( | const BinID & | , |
| bool | work | ||
| ) | const |
|
inlinestatic |
| 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 |
rotating the inline axis to the crossline axis.
|
inlinestatic |
|
static |
|
static |
|
inlinestaticprivate |
| Coord SurveyInfo::maxCoord | ( | bool | work | ) | const |
| int SurveyInfo::maxNrTraces | ( | bool | work | ) | const |
| Coord SurveyInfo::minCoord | ( | bool | work | ) | const |
|
inline |
| SurveyInfo& SurveyInfo::operator= | ( | const SurveyInfo & | ) |
| bool SurveyInfo::operator== | ( | const SurveyInfo & | ) | const |
|
inline |
|
static |
|
static |
|
static |
|
staticprivate |
|
static |
|
static |
| void SurveyInfo::putZDomain | ( | IOPar & | ) | const |
|
static |
| Interval<int> SurveyInfo::reasonableRange | ( | bool | inl | ) | const |
| void SurveyInfo::removeKeyFromDefaultPars | ( | const char * | ky, |
| bool | save2storage | ||
| ) | const |
| TrcKeyZSampling SurveyInfo::sampling | ( | bool | work | ) | const |
| void SurveyInfo::saveComments | ( | const char * | basedir = 0 | ) | const |
Write to .comments file.
| void SurveyInfo::saveDefaultPars | ( | const char * | basedir = 0 | ) | const |
Write to .defs file.
|
inline |
|
inlinestatic |
|
inline |
|
inline |
|
inlineprotected |
| bool SurveyInfo::setCoordSystem | ( | Coords::PositionSystem * | ) |
| void SurveyInfo::setDefaultPar | ( | const char * | ky, |
| const char * | val, | ||
| bool | save2storage | ||
| ) | const |
| void SurveyInfo::setDefaultPars | ( | const IOPar & | , |
| bool | save2storage | ||
| ) | const |
|
inline |
|
inline |
| void SurveyInfo::setFreshSetupData | ( | const IOPar & | ) | const |
| void SurveyInfo::setNotFresh | ( | ) | const |
| void SurveyInfo::setRange | ( | const TrcKeyZSampling & | ) |
|
inline |
|
inline |
| void SurveyInfo::setSipName | ( | const uiString & | ) |
| void SurveyInfo::setSurvDataType | ( | Pol2D | ) | const |
|
staticprivate |
| void SurveyInfo::setWorkRange | ( | const TrcKeyZSampling & | ) | const |
| void SurveyInfo::setZUnit | ( | bool | istime, |
| bool | infeet = false |
||
| ) |
| float SurveyInfo::showZ2UserFactor | ( | ) | const |
|
inline |
|
static |
|
static |
Not used by SI, just a UI default.
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
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
|
inlinestatic |
| Pol2D SurveyInfo::survDataType | ( | ) | const |
|
static |
|
inlinestaticprivate |
| void SurveyInfo::update3DGeometry | ( | ) |
| bool SurveyInfo::usePar | ( | const IOPar & | ) |
|
protected |
| bool SurveyInfo::write | ( | const char * | basedir = 0 | ) | const |
Write to .survey file and .defs file.
| bool SurveyInfo::xyInFeet | ( | ) | const |
| Unit SurveyInfo::xyUnit | ( | ) | const |
| uiString SurveyInfo::xyUnitString | ( | bool | abbrviated = true, |
| bool | withparens = true |
||
| ) | const |
| const ZDomain::Def& SurveyInfo::zDomain | ( | ) | const |
| bool SurveyInfo::zInFeet | ( | ) | const |
| bool SurveyInfo::zInMeter | ( | ) | const |
| bool SurveyInfo::zIsTime | ( | ) | 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 |
| uiString SurveyInfo::zUnitString | ( | bool | withparens = true | ) | const |
|
friend |
|
friend |
|
friend |
|
friend |
|
protected |
|
protected |
The 'data root'.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
The subdirectory name.
|
protected |
|
protected |
|
staticprivate |
|
staticprivate |
|
protected |
|
private |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B. V. 2017