seisprovider.h

Go to the documentation of this file.

#pragma once

/*
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert
 Date:          Nov 2016
________________________________________________________________________

*/

#include "seistrc.h"
#include "trckeyzsampling.h"
#include "dbkey.h"
#include "atomic.h"
#include "threadlock.h"
#include "survgeom.h"

class SeisTrcBuf;
namespace PosInfo { class CubeData; class Line2DData; }


namespace Seis
{

class SelData;
class Fetcher;
class Fetcher2D;
class Fetcher3D;


mExpClass(Seis) Provider
{ mODTextTranslationClass(Seis::Provider);
public:

    static Provider*    create(Seis::GeomType);
    static Provider*    create(const DBKey&,uiRetVal* uirv=0);
    static Provider*    create(const IOPar&,uiRetVal* uirv=0);
    static DBKey        dbKey(const IOPar&);
    virtual             ~Provider();

    uiRetVal            setInput(const DBKey&);

    virtual GeomType    geomType() const                = 0;
    bool                is2D() const    { return Seis::is2D(geomType()); }
    bool                isPS() const    { return Seis::isPS(geomType()); }
    BufferString        name() const;
    Pos::GeomID         firstGeomID() const     { return curGeomID(); }
    DBKey               dbKey() const           { return dbky_; }
    ZSampling           getZRange() const       { return doGetZRange(); }
    uiRetVal            getComponentInfo(BufferStringSet&,
                                         TypeSet<Seis::DataType>* dts=0) const;
    int                 nrOffsets() const; 

    void                setSelData(SelData*); 
    void                setSampleInterval(float);
    void                selectComponent(int);
    void                selectComponents(const TypeSet<int>&);
    void                forceFPData(bool yn=true);
    void                setReadMode(ReadMode);
    uiRetVal            fillPar(IOPar&) const;
    uiRetVal            usePar(const IOPar&);

    bool                isPresent( const TrcKey& tk ) const
                        { return doGetIsPresent( tk ); }
    uiRetVal            getNext(SeisTrc&) const;
    uiRetVal            getNextGather(SeisTrcBuf&) const;
    uiRetVal            get(const TrcKey&,SeisTrc&) const;
    uiRetVal            getGather(const TrcKey&,SeisTrcBuf&) const;

    const TypeSet<int>& getSelectedComponents() const   { return selcomps_;}
    bool                haveSelComps() const;

    Pos::GeomID         curGeomID() const       { return doGetCurGeomID(); }
    od_int64            nrDone() const                  { return nrdone_; }
    od_int64            totalNr() const;

    static const char*  sKeyForceFPData()
                        { return "Force FPs"; }
    static const char*  sKeySelectedComponents()
                        { return "Selected Components"; }

    static void         putTraceInGather(const SeisTrc&,SeisTrcBuf&);
    static void         putGatherInTrace(const SeisTrcBuf&,SeisTrc&);

    uiRetVal            reset() const; 
    const SelData*      selData() const         { return seldata_; }

protected:

                        Provider();

    mutable Threads::Lock lock_;
    DBKey               dbky_;
    SelData*            seldata_;
    float               zstep_;
    TypeSet<int>        selcomps_;
    ReadMode            readmode_;
    bool                forcefpdata_;
    mutable od_int64    totalnr_;
    mutable int         nrcomps_;
    mutable bool        setupchgd_;

    mutable Threads::Atomic<od_int64> nrdone_;

    void                ensureRightDataRep(SeisTrc&) const;
    void                ensureRightZSampling(SeisTrc&) const;
    void                ensureRightComponents(SeisTrc&) const;
    bool                handleSetupChanges(uiRetVal&) const;
    void                handleTrace(SeisTrc&) const;
    void                handleTraces(SeisTrcBuf&) const;

    virtual od_int64    getTotalNrInInput() const                       = 0;
    virtual void        doReset(uiRetVal&) const                        = 0;
    virtual void        doFillPar(IOPar&,uiRetVal&) const;
    virtual void        doUsePar(const IOPar&,uiRetVal&)                = 0;

    virtual int         gtNrOffsets() const                     { return 1; }
    virtual uiRetVal    doGetComponentInfo(BufferStringSet&,
                                           TypeSet<Seis::DataType>&) const;
    virtual Pos::GeomID doGetCurGeomID() const                          = 0;
    virtual ZSampling   doGetZRange() const                             = 0;
    virtual bool        doGetIsPresent(const TrcKey&) const;

                            // define at least either SeisTrc or SeisTrcBuf fns
    virtual void        doGetNext(SeisTrc&,uiRetVal&) const;
    virtual void        doGet(const TrcKey&,SeisTrc&,uiRetVal&) const;
    virtual void        doGetNextGather(SeisTrcBuf&,uiRetVal&) const;
    virtual void        doGetGather(const TrcKey&,SeisTrcBuf&,uiRetVal&) const;

    friend class        Fetcher;
    friend class        Fetcher2D;
    friend class        Fetcher3D;

};


mExpClass(Seis) Provider3D : public Provider
{ mODTextTranslationClass(Seis::Provider3D);
public:

    virtual bool        getRanges(TrcKeyZSampling&) const               = 0;
    virtual void        getGeometryInfo(PosInfo::CubeData&) const       = 0;

protected:

                        Provider3D()                                    {}

    virtual od_int64    getTotalNrInInput() const;
    virtual void        doFillPar( IOPar& iop, uiRetVal& uirv ) const
                        { Provider::doFillPar( iop, uirv ); }
    virtual void        doUsePar( const IOPar& iop, uiRetVal& uirv )
                        { Provider::doUsePar( iop, uirv ); }
    virtual Pos::GeomID doGetCurGeomID() const
                        { return Survey::GM().default3DSurvID(); }
    virtual ZSampling   doGetZRange() const;

};


mExpClass(Seis) Provider2D : public Provider
{ mODTextTranslationClass(Seis::Provider2D);
public:


    virtual int         nrLines() const                                 = 0;
    virtual Pos::GeomID geomID(int) const                               = 0;
    virtual BufferString lineName(int) const                            = 0;
    virtual int         lineNr(Pos::GeomID) const                       = 0;
    virtual int         curLineIdx() const                              = 0;
    virtual bool        getRanges(int,StepInterval<int>&,ZSampling&) const = 0;
    virtual void        getGeometryInfo(int,PosInfo::Line2DData&) const = 0;

protected:

                        Provider2D()                                    {}

    virtual od_int64    getTotalNrInInput() const;
    virtual void        doFillPar( IOPar& iop, uiRetVal& uirv ) const
                        { Provider::doFillPar( iop, uirv ); }
    virtual void        doUsePar( const IOPar& iop, uiRetVal& uirv )
                        { Provider::doUsePar( iop, uirv ); }
    virtual Pos::GeomID doGetCurGeomID() const
                        { return geomID( curLineIdx() ); }
    virtual ZSampling   doGetZRange() const;

};



} // namespace Seis