survinfo.h

Go to the documentation of this file.

#pragma once
 
/*+
________________________________________________________________________
 
 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H.Bril
 Date:          9-4-1996
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
#include "basicmod.h"
#include "namedobj.h"
#include "ranges.h"
#include "enums.h"
#include "zdomain.h"
#include "atomic.h"
#include "survgeom3d.h"
 
class ascostream;
class LatLong2Coord;
class SurveyDiskLocation;
namespace Coords { class CoordSystem; }
 
 
mExpClass(Basic) SurveyInfo : public NamedCallBacker
{ mODTextTranslationClass(SurveyInfo);
 
    mGlobal(Basic) friend const SurveyInfo&     SI();
 
 
public:
                        ~SurveyInfo();
    bool                has2D() const;
    bool                has3D() const;
 
    StepInterval<int>   inlRange(bool work) const;
    StepInterval<int>   crlRange(bool work) const;
    const StepInterval<float>& zRange( bool work ) const;
    StepInterval<int>   inlRange() const        { return inlRange(false); }
    StepInterval<int>   crlRange() const        { return crlRange(false); }
    const StepInterval<float>& zRange() const   { return zRange(false); }
 
    int                 inlStep() const;
    int                 crlStep() const;
    float               zStep() const;
    int                 nrZDecimals() const;
    int                 nrXYDecimals() const;
    float               inlDistance() const; 
    float               crlDistance() const;
    float               getArea(const Interval<int>& inl,
                             const Interval<int>& crl) const;   
    float               getArea(bool work) const ;              
 
    Coord3              oneStepTranslation(const Coord3& planenormal) const;
 
    const TrcKeyZSampling&      sampling( bool work ) const
                        { return work ? wcs_ : tkzs_; }
 
    Coord               transform( const BinID& b ) const;
    BinID               transform(const Coord&) const;
    bool                xyInFeet() const;
    const char*         getXYUnitString(bool withparens=true) const;
    uiString            getUiXYUnitString(bool abbrviated=true,
                                                    bool withparens=true) const;
    const ZDomain::Def& zDomain() const;
    bool                depthsInFeet() const    { return depthsinfeet_; }
    inline float        showZ2UserFactor() const
                        { return float(zDomain().userFactor()); }
 
    bool                zIsTime() const;
    inline bool         zInMeter() const
                        { return zDomain().isDepth() && !depthsinfeet_;}
    inline bool         zInFeet() const
                        { return zDomain().isDepth() && depthsinfeet_;}
    const char*         getZUnitString(bool withparens=true) const
                        { return zDomain().unitStr( withparens ); }
    const uiString      getUiZUnitString(bool withparens=true) const
                        { return zDomain().uiUnitStr( withparens ); }
    enum Unit           { Second, Meter, Feet };
    Unit                xyUnit() const;
    Unit                zUnit() const;
 
    Coord               minCoord(bool work) const;
    Coord               maxCoord(bool work) const;
    bool                isInside(const BinID&,bool work) const;
    bool                isReasonable(const BinID&) const;
    bool                isReasonable(const Coord&) const;
    Interval<int>       reasonableRange(bool inl) const;
    int                 maxNrTraces(bool work) 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;
    void                snapStep(BinID&,const BinID& dir=BinID(0,0))const;
    void                snapZ(float&,int direction=0) const;
 
    float               seismicReferenceDatum() const    {return seisrefdatum_;}
    void                setSeismicReferenceDatum( float d ) { seisrefdatum_=d; }
 
    const IOPar&        pars() const                    { return pars_; }
    const IOPar&        logPars() const                 { return logpars_; }
    void                putZDomain(IOPar&) const;
 
    RefMan<Survey::Geometry3D> get3DGeometry(bool work) const;
    RefMan<Coords::CoordSystem> getCoordSystem();
    ConstRefMan<Coords::CoordSystem> getCoordSystem() const;
    bool                hasProjection() const;
 
    const SurveyDiskLocation&   diskLocation() const;
 
    enum Pol2D  { No2D=0, Both2DAnd3D=1, Only2D=2 };
 
    // Some public fns moved to bottom because they are rarely used; some fns
    // that have 'no user servicable parts inside' are at the very bottom
 
protected:
 
                        SurveyInfo();
 
    BufferString        datadir_;
    BufferString        dirname_;
 
    ZDomain::Def&       zdef_;
    bool                xyinfeet_;
    bool                depthsinfeet_;
    TrcKeyZSampling&    tkzs_;
    TrcKeyZSampling&    wcs_;
    float               seisrefdatum_;
    IOPar&              pars_;
    IOPar               logpars_;
    RefMan<Coords::CoordSystem> coordsystem_;
 
    mutable Threads::AtomicPointer<Survey::Geometry3D>  s3dgeom_;
    mutable Threads::AtomicPointer<Survey::Geometry3D>  work_s3dgeom_;
 
    Pos::IdxPair2Coord  b2c_;
    LatLong2Coord&      ll2c_;
    BinID               set3binids_[3];
    Coord               set3coords_[3];
 
    Pol2D               survdatatype_;
    bool                survdatatypeknown_;
 
    BufferString        comment_;
    BufferString        sipnm_;
 
    void                handleLineRead(const BufferString&,const char*);
    bool                wrapUpRead();
    void                writeSpecLines(ascostream&) const;
 
    void                setTr(Pos::IdxPair2Coord::DirTransform&,const char*);
    void                putTr(const Pos::IdxPair2Coord::DirTransform&,
                                ascostream&,const char*) const;
 
private:
 
    // ugly, but hard to avoid:
    friend class                IOMan;
    friend class                uiSurvey;
    friend class                uiSurveyMap;
    friend class                uiSurveyInfoEditor;
 
    Pos::IdxPair2Coord::DirTransform rdxtr_;
    Pos::IdxPair2Coord::DirTransform rdytr_;
 
                                // For IOMan only
    static void                 setSurveyName(const char*);
                                // friends only
    static const char*          surveyFileName();
 
public:
 
        // These fns are rarely used by non-specialist classes.
                        mDeclInstanceCreatedNotifierAccess(SurveyInfo);
 
    bool                isWorkRangeSet() const;
    void                setWorkRange(const TrcKeyZSampling&);
    Notifier<SurveyInfo> workRangeChg;
 
    const Pos::IdxPair2Coord&   binID2Coord() const     { return b2c_; }
    void                get3Pts(Coord c[3],BinID b[2],int& xline) const;
    const LatLong2Coord& latlong2Coord() const  { return ll2c_; }
    bool                isClockWise() const { return isRightHandSystem(); }
    bool                isRightHandSystem() const;
    float               angleXInl() const;
    float               angleXCrl() const;
    void                setXYInFeet( bool yn=true ) { xyinfeet_ = yn; }
    void                setDepthInFeet( bool yn=true ) { depthsinfeet_ = yn; }
    void                setZUnit(bool istime,bool infeet=false);
    static float        defaultXYtoZScale(Unit,Unit);
    float               zScale() const;
    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(); 
    static const char*  sKeySurvDataType();
    static const char*  sKeySeismicRefDatum();
    static const char*  sKeySetupFileName()             { return ".survey"; }
    static const char*  sKeyBasicSurveyName()           { return "BasicSurvey";}
 
    BufferString        getDirName() const      { return dirname_; }
    BufferString        getDataDirName() const  { return datadir_; }
    void                updateDirName(); 
 
                        mDeclareEnumUtils(Pol2D)
    Pol2D               survDataType() const    { return survdatatype_; }
    void                setSurvDataType( Pol2D typ )
                        { survdatatype_ = typ; survdatatypeknown_ = true; }
 
                        // Auxiliary info
    const char*         comment() const         { return comment_.buf(); }
    BufferString        sipName() const         { return sipnm_; }
    void                setSipName( BufferString sipnm )     { sipnm_ = sipnm; }
    void                setComment( const char* s )     { comment_ = s; }
 
        // Following fns are used by specialist classes. Don't use casually.
 
                        SurveyInfo(const SurveyInfo&);
    SurveyInfo&         operator =(const SurveyInfo&);
    static SurveyInfo&  empty();
 
    Pos::IdxPair2Coord& getBinID2Coord() const
                        { return const_cast<SurveyInfo*>(this)->b2c_; }
    LatLong2Coord&      getLatlong2Coord() const
                        { return const_cast<SurveyInfo*>(this)->ll2c_; }
    IOPar&              getPars() const
                        { return const_cast<SurveyInfo*>(this)->pars_; }
    IOPar&              getLogPars() const
                        { return const_cast<SurveyInfo*>(this)->logpars_; }
 
    bool                write(const char* basedir=nullptr) const;
    void                savePars(const char* basedir=nullptr) const;
    void                saveLog(const char* basedir=nullptr) const;
    static SurveyInfo*  read(const char* survdir);
    static SurveyInfo*  read(const char* path,bool pathisfile);
    void                setRange(const TrcKeyZSampling&,bool);
    uiString            set3PtsWithMsg(const Coord c[3],const BinID b[2],
                                       int xline);
    mDeprecated         ("Use set3PtsWithMsg")
    const char*         set3Pts(const Coord c[3],const BinID b[2],int xline);
    void                gen3Pts();
    bool                setCoordSystem(Coords::CoordSystem*);
    void                readSavedCoordSystem() const;
 
    void                update3DGeometry();
 
    static uiRetVal     isValidDataRoot(const char*);
    static uiRetVal     isValidSurveyDir(const char*);
 
    static const char*  curSurveyName();
 
                        // No, you really don't need these!
    static void         pushSI(SurveyInfo*);
    static SurveyInfo*  popSI();
    static void         deleteInstance()                { delete popSI(); }
 
};
 
 
mGlobal(Basic) const SurveyInfo& SI();
mGlobal(Basic) inline SurveyInfo& eSI()
                        { return const_cast<SurveyInfo&>(SI()); }
 
mExternC( Basic ) const char* GetSurveyName(void);
 
 
namespace Survey {
 
mGlobal(Basic) void getDirectoryNames(BufferStringSet&,bool fullpath,
                                      const char* dataroot=nullptr,
                                      const char* excludenm=nullptr);
 
} // namespace Survey