Generated/html/segyuiscandata_8h_source.html

#pragma once


/*+

________________________________________________________________________


 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt

 Author:        Bert

 Date:          July 2015

 RCS:           $Id: $

________________________________________________________________________


-*/


#include "uisegycommon.h"

#include "ranges.h"

#include "bufstring.h"

#include "datachar.h"

#include "namedobj.h"

#include "survinfo.h"

#include "refcount.h"


class SeisTrcInfo;

class DataClipSampler;

class uiParent;

class TaskRunner;

namespace Coords  { class CoordSystem; }

namespace PosInfo { class Detector; }


namespace SEGY

{


class FilePars;

class TrcHeader;

class TrcHeaderDef;

class FileReadOpts;

class HdrEntryKeyData;

class OffsetCalculator;


mExpClass(uiSEGYTools) BasicFileInfo

{ mODTextTranslationClass(BasicFileInfo);

public:


                        BasicFileInfo()                 { init(); }

    void                init();


    int                 revision_;

    int                 binns_;         // nr samples binary header

    int                 binsr_;         // sample rate (us or mm)

    int                 ns_;            // nr samples trace header

    short               format_;

    SamplingData<float> sampling_;

    bool                hdrsswapped_;

    bool                dataswapped_;


    bool                isValid() const                 { return ns_ > 0; }

    bool                isRev0() const                  { return revision_ < 1;}

    int                 bytesPerSample() const;

    int                 traceDataBytes() const;

    DataCharacteristics getDataChar() const;

    StepInterval<float> getZRange() const

                        { return sampling_.interval(ns_); }


    TrcHeader*          getTrcHdr(od_istream&) const;

    int                 nrTracesIn(const od_istream&,od_stream_Pos p=-1) const;

    bool                goToTrace(od_istream&,od_stream_Pos,int) const;

    uiString            getFrom(od_istream&,bool& zinft,

                                const bool* knownhdrswap=0);


    virtual void        getFilePars(FilePars&) const;


protected:


    virtual const TrcHeaderDef& getHDef() const; // returns default


};


mExpClass(uiSEGYTools) LoadDef : public BasicFileInfo

{

public:


                        LoadDef();

                        ~LoadDef();

                        LoadDef(const LoadDef&);

    LoadDef&            operator =(const LoadDef&);

    void                reInit(bool alsohdef);


    float               coordscale_;

    FileReadOpts::ICvsXYType icvsxytype_;

    bool                havetrcnrs_;

    SamplingData<int>   trcnrdef_;

    FileReadOpts::PSDefType psoffssrc_;

    SamplingData<float> psoffsdef_;

    bool                usenrsampsinfile_;

    bool                usezsamplinginfile_;

    bool                useformatinfile_;


    TrcHeaderDef*       hdrdef_;


    LoadDef             getPrepared(od_istream&) const;

    bool                getData(od_istream&,char*,float* vals=0) const;

    TrcHeader*          getTrace(od_istream&,char*,float*) const;

    bool                skipData(od_istream&) const;

    void                getTrcInfo(TrcHeader&,SeisTrcInfo&,

                                   const OffsetCalculator&) const;


    virtual void        getFilePars(FilePars&) const;

    void                getFileReadOpts(FileReadOpts&) const;

    void                usePar(const IOPar&);

    void                setUserCoordSys(Coords::CoordSystem* crs)

                        { coordsys_ = crs; }

    ConstRefMan<Coords::CoordSystem>       getUserCoordSys()

                              { return coordsys_; }

    bool                needXY() const;


protected:


    virtual const TrcHeaderDef& getHDef() const { return *hdrdef_; }

    ConstRefMan<Coords::CoordSystem> coordsys_;


};


mExpClass(uiSEGYTools) ScanRangeInfo

{

public:

                        ScanRangeInfo()         { reInit(); }


    Interval<double>    xrg_;

    Interval<double>    yrg_;

    Interval<int>       inls_;

    Interval<int>       crls_;

    Interval<int>       trcnrs_;

    Interval<float>     refnrs_;

    Interval<float>     offs_;

    Interval<float>     azims_;


    void                reInit();

    void                use(const PosInfo::Detector&);

    void                merge(const ScanRangeInfo&);

};


mExpClass(uiSEGYTools) ScanInfo

{

public:


                        ScanInfo(const char* fnm,bool is2d);

                        ~ScanInfo();


    BasicFileInfo&      basicInfo()             { return basicinfo_; }


    void                getFromSEGYBody(od_istream&,const LoadDef&,bool surv,

                                    DataClipSampler&,TaskRunner* t=0);


    void                merge(const ScanInfo&);


    const char*         fileName() const        { return filenm_; }

    bool                is2D() const;

    bool                isEmpty() const         { return nrtrcs_ < 1; }

    int                 nrTraces() const        { return nrtrcs_; }

    bool                isFull() const          { return full_; }


    const HdrEntryKeyData&      keyData() const         { return keydata_; }

    const ScanRangeInfo&        ranges() const          { return rgs_; }

    const PosInfo::Detector&    piDetector() const      { return *pidetector_; }

    const BasicFileInfo&        basicInfo() const       { return basicinfo_; }


protected:


    BufferString        filenm_;

    PosInfo::Detector*  pidetector_;

    HdrEntryKeyData&    keydata_;

    BasicFileInfo       basicinfo_;

    ScanRangeInfo       rgs_;

    int                 nrtrcs_;

    int                 idxfirstlive_;

    bool                full_;


    od_stream_Pos       startpos_;


    void                reInit()                { init( is2D() ); }

    void                addTrace(TrcHeader&,const float*,const LoadDef&,

                                 DataClipSampler&,const OffsetCalculator&,

                                 int trcidx);

    void                addTraces(od_istream&,Interval<int>,char*,float*,

                                  const LoadDef&,DataClipSampler&,

                                  const OffsetCalculator&);

    bool                addNextTrace(od_istream&,char*,float*,

                                         const LoadDef&,DataClipSampler&,

                                         const OffsetCalculator&);

    void                ensureStepsFound(od_istream&,char*,float*,

                                         const LoadDef&,DataClipSampler&,

                                         const OffsetCalculator&);

    void                addValues(DataClipSampler&,const float*,int);


private:


    void                init(bool);

    void                finishGet(od_istream&);


    friend class        FullUIScanner;


};


mExpClass(uiSEGYTools) ScanInfoSet : public NamedObject

{

public:


                        ScanInfoSet(bool is2d,bool isps);

                        ~ScanInfoSet();


    void                setEmpty();

    ScanInfo&           add(const char* fnm);

    void                removeLast();

    void                setInFeet( bool yn )    { infeet_ = yn; }

    void                finish();


    bool                is2D() const            { return is2d_; }

    bool                isEmpty() const         { return size() < 1; }

    int                 nrTraces() const        { return nrtrcs_; }

    bool                inFeet() const          { return infeet_; }

    bool                isFull() const;

    const BasicFileInfo& basicInfo() const;

    const PosInfo::Detector& piDetector() const { return detector_; }

    const HdrEntryKeyData& keyData() const      { return keydata_; }

    const ScanRangeInfo& ranges() const         { return rgs_; }


    int                 size() const            { return sis_.size(); }

    const ScanInfo&     scanInfo( int i ) const { return *sis_[i]; }


protected:


    ObjectSet<ScanInfo> sis_;

    bool                is2d_;

    bool                isps_;

    bool                infeet_;

    int                 nrtrcs_;

    HdrEntryKeyData&    keydata_;

    ScanRangeInfo       rgs_;

    PosInfo::Detector&  detector_;


};


} // namespace SEGY