volprocsurfacelimitedfiller.h

Go to the documentation of this file.

#ifndef volprocsurfacelimitedfiller_h
#define volprocsurfacelimitedfiller_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Y.C. Liu
 Date:          April 2010
 RCS:           $Id$
________________________________________________________________________

-*/

#include "volumeprocessingmod.h"
#include "volprocstep.h"
#include "multiid.h"

namespace Geometry { class FaultStickSurface; }
namespace EM { class Fault; class Horizon; class Horizon3D; }

namespace VolProc
{

mExpClass(VolumeProcessing) SurfaceLimitedFiller : public Step
{ mODTextTranslationClass(SurfaceLimitedFiller);
public:
                mDefaultFactoryCreatorImpl( Step, SurfaceLimitedFiller );
                mDefaultFactoryInstanciationBase( "SurfaceLimitedFiller",
                                tr("Horizon-based painter - Advanced") );

                        ~SurfaceLimitedFiller();
                        SurfaceLimitedFiller();

    bool                isOK() const;

    bool                needsInput() const              { return false; }
    bool                isInputPrevStep() const         { return true; }

    bool                setSurfaces(const TypeSet<MultiID>&,
                                    const TypeSet<char>& fillside);
                        /*Assume going down increases z.
                          For horizons, side = 1 if go below, -1 if go above.*/

    int                 nrOfSurfaces() const             {return side_.size();}
    char                getSurfaceFillSide(int idx) const{ return side_[idx]; }
    const MultiID*      getSurfaceID(int idx) const;

                        //Start value/grid stuff
    bool                usesStartValue() const      { return usestartval_; }
    void                useStartValue(bool yn)      { usestartval_ = yn; }

    float               getStartValue() const       { return fixedstartval_; }
    void                setStartValue(float vel)    { fixedstartval_ = vel; }

    bool                setStartValueHorizon(const MultiID*);
    const MultiID*      getStartValueHorizonID() const;
    int                 getStartAuxdataIdx() const {return startauxdataselidx_;}
    void                setStartAuxdataIdx(int i)  { startauxdataselidx_ = i; }

                        //Gradient value/grid stuff
    bool                usesGradientValue() const   { return usegradient_; }
    void                useGradientValue(bool yn)   { usegradient_ = yn; }

    bool                isGradientVertical() const  { return gradvertical_; }
    void                setGradientVertical(bool yn){ gradvertical_ = yn; }

    float               getGradient() const     { return fixedgradient_; }
    void                setGradient(float grd)  { fixedgradient_ = grd; }

    bool                setGradientHorizon(const MultiID*);
    const MultiID*      getGradientHorizonID() const;
    int                 getGradAuxdataIdx()     { return gradauxdataselidx_; }
    void                setGradAuxdataIdx(int i){ gradauxdataselidx_ = i; }

                        //Reference horizon/z stuff
    bool                usesRefZValue() const           { return userefz_; }
    void                useRefZValue(bool yn)           { userefz_ = yn; }

    void                setRefZValue(float zv)          { refz_ = zv; }
    float               getRefZValue() const            { return refz_; }

    bool                setRefHorizon(const MultiID*);
    const MultiID*      getRefHorizonID() const;

    void                fillPar(IOPar&) const;
    bool                usePar(const IOPar&);
    bool                useHorInterFillerPar(const IOPar&);
    virtual uiString    errMsg() const                  { return errmsg_; }

    void                releaseData();
    bool                canInputAndOutputBeSame() const { return true; }
    bool                needsFullVolume() const         { return false; }
    bool                canHandle2D() const             { return false; }

    /* mDeprecated (this function will be protected virtual after 6.0) */
    od_int64            extraMemoryUsage(OutputSlotID,const TrcKeySampling&,
                                         const StepInterval<int>&) const;

    virtual bool        areSamplesIndependent() const   { return true; }

protected:

    bool                prepareComp(int);
    bool                computeBinID(const BinID&, int);
    EM::Horizon*        loadHorizon(const MultiID&) const;
    int                 setDataHorizon(const MultiID&,EM::Horizon3D*&,
                                       int auxdataidx) const;
    bool                prefersBinIDWise() const        { return true; }

    static const char*  sKeySurfaceID()         { return "Surface MID"; }
    static const char*  sKeySurfaceFillSide()   { return "Surface fill side"; }
    static const char*  sKeyNrSurfaces()        { return "Nr of surfaces"; }

    static const char*  sKeyUseStartValue() { return "Use start value"; }
    static const char*  sKeyStartValue()    { return "Start value"; }
    static const char*  sKeyStartValHorID() { return "Start value horizon"; }
    static const char*  sKeyStartAuxDataID(){ return "Start auxdata id"; }

    static const char*  sKeyUseGradValue()  { return "Use gradient value"; }
    static const char*  sKeyGradValue()     { return "Gradient value"; }
    static const char*  sKeyGradHorID()     { return "Gradient horizon"; }
    static const char*  sKeyGradAuxDataID() { return "Gradient auxdata id"; }
    static const char*  sKeyGradType()      { return "Gradient type"; }

    static const char*  sKeyRefHorID()      { return "Reference horizon"; }
    static const char*  sKeyRefZ()          { return "Reference z"; }
    static const char*  sKeyUseRefZ()       { return "Use reference z"; }

    MultiID             gradhormid_;
    EM::Horizon3D*      gradhorizon_;
    int                 gradauxdataselidx_;
    int                 gradauxidx_;
    float               fixedgradient_;
    bool                usegradient_;
    bool                gradvertical_;

    MultiID             starthormid_;
    EM::Horizon3D*      starthorizon_;
    int                 startauxdataselidx_;
    int                 startauxidx_;
    float               fixedstartval_;
    bool                usestartval_;

    MultiID             refhormid_;
    EM::Horizon*        refhorizon_;
    float               refz_;
    bool                userefz_;

                        /*The following four have the same size, for any idx,
                          faults_[idx] or hors_[idx] is 0. */
    TypeSet<char>       side_;
    TypeSet<MultiID>    surfacelist_;
    ObjectSet<EM::Horizon>                      hors_;
    ObjectSet<Geometry::FaultStickSurface>      faults_;

    bool                usebottomval_;
    double              valrange_;
};

} // namespace VolProc

#endif