velocitypicks.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        K. Tingdahl
 Date:          April 2005
________________________________________________________________________


-*/

#include "velocitymod.h"
#include "multidimstorage.h"
#include "notify.h"
#include "color.h"
#include "emposid.h"
#include "enums.h"
#include "dbkey.h"
#include "ranges.h"
#include "rowcol.h"

class Undo;
class IOObj;
template <class T> class Smoother1D;
class BinIDValueSet;
class IOObjContext;

namespace EM { class Horizon3D; }

namespace Vel
{

class PicksMgr;

mExpClass(Velocity) Pick
{
public:
                        Pick(float depth=mUdf(float),
                             float vel=mUdf(float),
                             float offset=mUdf(float),EM::ObjectID=-1);
    bool                operator==(const Pick& b) const;

    float               depth_;
    float               offset_;
    float               vel_;
    EM::ObjectID        emobjid_;
};


mExpClass(Velocity) Picks : public RefCount::Referenced
                          , public CallBacker
{
public:
                        Picks();
                        Picks(bool zit);

    enum PickType       { RMO, RMS, Delta, Epsilon, Eta };
                        mDeclareEnumUtils(PickType)
    PickType            pickType() const;
    void                setPickType( PickType, bool resetcolor );
    const char*         zDomain() const;

    bool                setColor(const Color&,bool savedefault);
    const Color&        getColor() const { return color_; }
    bool                getDefaultColor(Color&) const;


    Undo&               undo();

    void                removeAll(bool undo=true,bool interactionend=true);
    bool                isEmpty() const;


    void                        setSnappingInterval(const StepInterval<float>&);
    const StepInterval<float>&  getSnappingInterval() const { return snapper_; }
    RowCol                      find(const BinID&,const Pick&) const;
    RowCol                      set(const BinID&, const Pick&,
                                    bool undo=true,bool interactionend=true);
    void                        set(const RowCol&,
                                    const Pick&,bool undo=true,
                                    bool interactionend=true);
    int                         get(const BinID&, TypeSet<float>* depths,
                                    TypeSet<float>* vals,
                                    TypeSet<RowCol>*,
                                    TypeSet<EM::ObjectID>*,
                                    bool interpolatehors ) const;
    void                        get(const BinID&, TypeSet<Pick>&,
                                    bool interpolatehors,
                                    bool normalizerefoffset ) const;
    bool                        get(const RowCol&, BinID&, Pick& );
    void                        get(const EM::ObjectID&,TypeSet<RowCol>&) const;
    void                        remove(const RowCol&,
                                       bool undo=true,bool interactionend=true);

    const MultiDimStorage<Pick>& getAll() const { return picks_; }

    CNotifier<Picks,const BinID&> change;
    CNotifier<Picks,const BinID&> changelate;
    bool                        isChanged() const;
    void                        resetChangedFlag() { changed_ = false; }

    bool                        store(const IOObj*);
    const DBKey&                storageID() const;
    bool                        zIsTime() const         { return zit_; }

    Smoother1D<float>*          getSmoother()           { return smoother_; }
    const Smoother1D<float>*    getSmoother() const     { return smoother_; }
    void                        setSmoother(Smoother1D<float>*);

    const uiString              errMsg() const;
    static const char*          sKeyIsTime();

    void                        setAll(float vel,bool undo=true);

    static const IOObjContext&  getStorageContext();
    static void                 setContextPickType(IOObjContext&,PickType);

    float                       refOffset() const       { return refoffset_; }
    void                        setReferenceOffset(float n);

    const DBKey&                gatherID() const;
    void                        setGatherID(const DBKey&);


    void                        addHorizon(const DBKey&,
                                           bool addzeroonfail=false);
    void                        addHorizon(EM::Horizon3D*);
    int                         nrHorizons() const;

    EM::ObjectID                getHorizonID(int) const;
    void                        removeHorizon(EM::ObjectID);
    EM::Horizon3D*              getHorizon(EM::ObjectID);
    const EM::Horizon3D*        getHorizon(EM::ObjectID) const;
    bool                        interpolateVelocity(EM::ObjectID,
                                    float searchradius,BinIDValueSet&) const;
    char                        getHorizonStatus(const BinID&) const;
    static const char*          sKeyVelocityPicks();
    static const char*          sKeyRefOffset();
    static const char*          sKeyGatherID();
    static const char*          sKeyNrHorizons();
    static const char*          sKeyHorizonPrefix();
    static const char*          sKeyPickType();

protected:
                                ~Picks();
    void                        getColorKey(BufferString&) const;
    void                        removeHorizons();
    friend                      class PicksMgr;
    void                        fillIOObjPar(IOPar&) const;
    bool                        useIOObjPar(const IOPar&);
    float                       normalizeRMO(float depth,float rmo,
                                             float offset) const;
    void                        fillPar(IOPar&) const;
    bool                        usePar(const IOPar&);

    void                        horizonChangeCB(CallBacker*);

    float                       refoffset_;
    DBKey                       gatherid_;
    bool                        load(const IOObj*);
    StepInterval<float>         snapper_;
    DBKey                       storageid_;
    MultiDimStorage<Pick>       picks_;

    Undo*                       undo_;

    uiString                    errmsg_;
    Smoother1D<float>*          smoother_;
    ObjectSet<EM::Horizon3D>    horizons_;

    PickType                    picktype_;
    Color                       color_;

    bool                        changed_;
    bool                        zit_;

};


mExpClass(Velocity) PicksMgr : public CallBacker
{
public:
                                PicksMgr();
                                ~PicksMgr();

    Picks*                      get(const DBKey&,bool gathermid,
                                    bool create, bool forcefromstorage );

    const uiString              errMsg() const;
protected:
    friend                      class Picks;

    void                        surveyChange(CallBacker*);

    uiString                    errmsg_;
    ObjectSet<Picks>            velpicks_;
};


mGlobal(Velocity) PicksMgr& VPM();

} // namespace Vel