OpendTect  7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Attrib::VolStats Class Reference

Volume Statistics Attribute. More...

Inheritance diagram for Attrib::VolStats:
[legend]

Public Member Functions

 VolStats (Desc &)
 
void prepPriorToBoundsCalc () override
 
void setRdmPaths (const TypeSet< BinID > &truepos, const TypeSet< BinID > &snappedpos) override
 For directional attributes. More...
 
- Public Member Functions inherited from Attrib::VolStatsBase
void initSteering () override
 
bool isSingleTrace () const override
 
- Public Member Functions inherited from Attrib::Provider
void addLocalCompZIntervals (const TypeSet< Interval< int > > &)
 
virtual void adjust2DLineStoredVolume ()
 
int alignInputs (ObjectSet< Provider > &)
 
int comparePosAndAlign (Provider *, bool, Provider *, bool, bool)
 
virtual bool compDistBetwTrcsStats (bool force=false)
 
void computeNewStartPos (BinID &)
 
void computeRefStep ()
 
void computeRefZ0 ()
 
void doParallel (bool yn)
 
void enableAllOutputs (bool yn=true)
 
void enableOutput (int output, bool yn=true)
 
uiString errMsg () const
 
virtual void fillDataPackWithTrc (RegularSeisDataPack *) const
 
float getApplicableCrlDist (bool) const
 
virtual void getCompNames (BufferStringSet &) const
 
virtual void getCompOutputIDs (TypeSet< int > &) const
 
Coord getCoord (const BinID &) const
 
Coord getCurrentCoord () const
 
BinID getCurrentPosition () const
 
virtual const SeisTrcInfogetCurrentTrcInfo () const
 
const DataHoldergetData (const BinID &relpos=BinID(0, 0), int idx=0)
 
const DataHoldergetDataDontCompute (const BinID &relpos) const
 
bool getDataUnavailableFlag () const
 
const BinIDgetDesBufStepout () const
 
DescgetDesc ()
 
const DescgetDesc () const
 
const TrcKeyZSamplinggetDesiredVolume () const
 
virtual float getDistBetwTrcs (bool, const char *linenm=0) const
 
BinID getElementStepout () const
 
virtual Pos::GeomID getGeomID () const
 
ObjectSet< Provider > & getInputs ()
 
const TrcKeyZSamplinggetPossibleVolume () const
 
virtual bool getPossibleVolume (int outp, TrcKeyZSampling &)
 
float getRefStep () const
 
float getRefZ0 () const
 
const BinIDgetReqBufStepout () const
 
virtual BinID getStepoutStep () const
 
int getTotalNrPos (bool)
 
BinID getTrcInfoBid () const
 
bool is2D () const
 
virtual bool isOK () const
 
bool isOutputEnabled (int output) const
 
const TypeSet< Interval< int > > & localCompZIntervals () const
 
virtual int moveToNextTrace (BinID startpos=BinID::udf(), bool firstcheck=false)
 
virtual bool needStoredInput () const
 
int nrOutputs () const
 
virtual void prepareForComputeData ()
 
virtual bool prepPriorToOutputSetup ()
 
virtual void prepSteeringForStepout (const BinID &)
 
void resetDesiredVolume ()
 
void resetMoved ()
 
void resetZIntervals ()
 
void setCurLineName (const char *)
 
virtual bool setCurrentPosition (const BinID &)
 
void setDataUnavailableFlag (bool yn)
 
virtual void setDesBufStepout (const BinID &, bool wait=false)
 
void setDesiredVolume (const TrcKeyZSampling &)
 
void setExactZ (const TypeSet< float > &)
 
void setExtraZ (const Interval< float > &)
 
virtual void setGeomID (Pos::GeomID)
 
void setNeedInterpol (bool)
 
void setOutputInterestSize (bool preserve=false)
 
void setPossibleVolume (const TrcKeyZSampling &)
 
void setRefStep (float step)
 
void setRefZ0 (float z0)
 
virtual void setReqBufStepout (const BinID &, bool wait=false)
 
void setSelData (const Seis::SelData *)
 
void setUseSC ()
 
virtual void updateCSIfNeeded (TrcKeyZSampling &) const
 
void updateCurrentInfo ()
 
void updateInputReqs (int input=-1)
 
virtual void updateStorageReqs (bool all=false)
 
virtual bool usesTracePosition () const
 
- Public Member Functions inherited from RefCount::Referenced
void addObserver (WeakPtrBase *obs)
 Not for normal use. May become private. More...
 
int nrRefs () const
 Only for expert use. More...
 
void ref () const
 
bool refIfReffed () const
 Don't use in production, for debugging. More...
 
void removeObserver (WeakPtrBase *obs)
 Not for normal use. May become private. More...
 
bool tryRef () const
 Not for normal use. May become private. More...
 
void unRef () const
 
void unRefNoDelete () const
 

Static Public Member Functions

static const char * allowEdgeEffStr ()
 
static const char * attribName ()
 
static void initClass ()
 
static const char * optstackdirStr ()
 
static const char * optStackDirTypeStr (int)
 
static const char * optstackstepStr ()
 
- Static Public Member Functions inherited from Attrib::VolStatsBase
static const char * absolutegateStr ()
 
static const char * gateStr ()
 
static void initDesc (Desc &)
 
static const char * nrtrcsStr ()
 
static const char * nrvolumesStr ()
 
static const char * shapeStr ()
 
static const char * shapeTypeStr (int)
 
static const char * steeringStr ()
 
static const char * stepoutStr ()
 
- Static Public Member Functions inherited from Attrib::Provider
static Providercreate (Desc &, uiString &errmsg)
 
static uiString prepare (Desc &)
 
- Static Public Member Functions inherited from RefCount::Referenced
static bool isSane (const Referenced *)
 

Protected Member Functions

 ~VolStats ()
 
bool computeData (const DataHolder &, const BinID &relpos, int z0, int nrsamples, int threadid) const override
 
void getIdealStackPos (const BinID &, const BinID &, const BinID &, TypeSet< Geom::Point2D< float > > &) const
 
bool getInputData (const BinID &, int zintv) override
 
bool getInputOutput (int, TypeSet< int > &res) const override
 
void getStackPositions (TypeSet< BinID > &) const
 
void reInitPosAndSteerIdxes ()
 
const Interval< float > * reqZMargin (int input, int output) const override
 
- Protected Member Functions inherited from Attrib::VolStatsBase
 VolStatsBase (Desc &)
 
 ~VolStatsBase ()
 
bool allowParallelComputation () const override
 
const BinIDdesStepout (int input, int output) const override
 
const Interval< float > * desZMargin (int inp, int) const override
 
void init ()
 
int * outputTypes () const
 
- Protected Member Functions inherited from Attrib::Provider
 Provider (Desc &)
 
virtual ~Provider ()
 
void addParent (Provider *prov)
 
virtual bool checkInpAndParsAtStart ()
 
void computeDesInputCube (int inp, int out, TrcKeyZSampling &, bool usestepout=true) const
 
float crlDist () const
 
virtual const Interval< int > * desZSampMargin (int input, int output) const
 
float dipFactor () const
 
virtual bool doNotReUseDH () const
 
void fillInputRangesArray (Array2DImpl< BasicInterval< int > > &, int, const BasicInterval< int > &)
 
virtual bool finalizeCalculation (bool scs)
 
DataHoldergetDataHolder (const BinID &relpos)
 
int getDataIndex (int input) const
 
float getExtraZFromSampInterval (int, int) const
 
float getExtraZFromSampPos (float) const
 
float getInputValue (const DataHolder &, int inputidx, int sampleidx, int z0) const
 
float getInterpolInputValue (const DataHolder &, int inputidx, float sample, int z0) const
 
float getInterpolInputValue (const DataHolder &, int inputidx, float zval) const
 
virtual SeisMSCProvidergetMSCProvider (bool &) const
 
virtual BinDataDesc getOutputFormat (int output) const
 
virtual bool getZ0StoredData (float &z0) const
 
float getZAtSample (int idx) const
 
virtual bool getZStepStoredData (float &step) const
 
float inlDist () const
 
bool isNew2DLine () const
 
bool isUsedMultTimes ()
 
float lineDist () const
 
float maxSecureDip () const
 
virtual int minTaskSize () const
 
virtual bool preProcCommonToAllThreads (const DataHolder &out, const BinID &relpos)
 
void removeDataHolder (const BinID &relpos)
 
virtual const BinIDreqStepout (int input, int output) const
 
virtual const Interval< int > * reqZSampMargin (int input, int output) const
 
void setInput (int input, Provider *)
 
virtual bool setNrThreads (int idx)
 
void setOutputValue (const DataHolder &output, int outputidx, int sampleidx, int z0, float val) const
 
void setUsedMultTimes ()
 
void stdPrepSteering (const BinID &)
 
float trcDist () const
 
virtual bool useInterTrcDist () const
 
float zFactor () const
 
bool zIsTime () const
 
- Protected Member Functions inherited from RefCount::Referenced
 Referenced ()
 
 Referenced (const Referenced &)
 
virtual ~Referenced ()
 
Referencedoperator= (const Referenced &)
 

Static Protected Member Functions

static ProvidercreateInstance (Desc &)
 
static void updateDesc (Desc &)
 
- Static Protected Member Functions inherited from Attrib::VolStatsBase
static void updateDefaults (Desc &)
 
- Static Protected Member Functions inherited from Attrib::Provider
static ProviderinternalCreate (Desc &, ObjectSet< Provider > &, bool &issame, uiString &)
 

Protected Attributes

bool allowedgeeffects_
 
bool dosteer_
 
TypeSet< BinIDlinepath_
 
TypeSet< BinIDlinetruepos_
 
int optstackdir_
 
int optstackstep_
 
TypeSet< int > steerindexes_
 
- Protected Attributes inherited from Attrib::VolStatsBase
int dataidx_
 
Interval< float > desgate_
 
Interval< float > gate_
 
ObjectSet< const DataHolderinputdata_
 
int minnrtrcs_
 
TypeSet< BinIDpositions_
 
int shape_
 
const DataHoldersteeringdata_
 
BinID stepout_
 
- Protected Attributes inherited from Attrib::Provider
ObjectSet< Providerallexistingprov_
 
bool alreadymoved_
 
BinID currentbid_
 
const SeisTrcInfocurtrcinfo_
 
bool dataunavailableflag_
 
BinID desbufferstepout_
 
Descdesc_
 
TrcKeyZSamplingdesiredvolume_
 
uiString errmsg_
 
TypeSet< float > exactz_
 
Interval< float > extraz_
 
Pos::GeomID geomid_
 
ObjectSet< Providerinputs_
 
bool isusedmulttimes_
 
DataHolderLineBufferlinebuffer_
 
TypeSet< Interval< int > > localcomputezintervals_
 
bool needinterp_
 
TypeSet< int > outputinterest_
 
bool parallel_ = true
 
ObjectSet< Providerparents_
 
TrcKeyZSamplingpossiblevolume_
 
int prevtrcnr_
 
ProviderTaskprovidertask_
 
float refstep_
 
float refz0_
 
BinID reqbufferstepout_
 
const Seis::SelDataseldata_
 
BinID trcinfobid_
 
bool useshortcuts_
 

Detailed Description

Volume Statistics Attribute.

VolumeStatistics collects all samples within the timegate from all traces within the stepout.

If steering is enabled, the timegate is taken relative to the steering.

If the OpticalStack shape is chosen, the positions used are defined by a step and a direction: the line direction or its normal.

  VolumeStatistics stepout=1,1 shape=Rectangle|Ellipse|OpticalStack gate=[0,0]
                   steering=
  Inputs:
  0-(nrvolumes-1)         The data
  nrvolumes  -            Steerings (only if steering is enabled)

  Outputs:
  0       Avg
  1       Med
  2       Variance
  3       Min
  4       Max
  5       Sum
  6       Normalized Variance
  7       Most Frequent
  8       RMS
  9       Extreme

<>

Constructor & Destructor Documentation

◆ VolStats()

Attrib::VolStats::VolStats ( Desc )

◆ ~VolStats()

Attrib::VolStats::~VolStats ( )
protected

Member Function Documentation

◆ allowEdgeEffStr()

static const char* Attrib::VolStats::allowEdgeEffStr ( )
inlinestatic

◆ attribName()

static const char* Attrib::VolStats::attribName ( )
inlinestatic

◆ computeData()

bool Attrib::VolStats::computeData ( const DataHolder output,
const BinID relpos,
int  t0,
int  nrsamples,
int  threadidx 
) const
overrideprotectedvirtual

The system will use the algorithm specified in this function to compute the attribute's outputs. The results will be stored as different series in the DataHolder output.

Parameters
output
relpos
t0
nrsamples
threadidxthread identifier that may be handy when using multiple threads.

Implements Attrib::VolStatsBase.

◆ createInstance()

static Provider* Attrib::VolStats::createInstance ( Desc )
staticprotected

◆ getIdealStackPos()

void Attrib::VolStats::getIdealStackPos ( const BinID ,
const BinID ,
const BinID ,
TypeSet< Geom::Point2D< float > > &   
) const
protected

◆ getInputData()

bool Attrib::VolStats::getInputData ( const BinID relpos,
int  idx 
)
overrideprotectedvirtual

Gets all imput data, including data for which a stepout is required

Reimplemented from Attrib::VolStatsBase.

◆ getInputOutput()

bool Attrib::VolStats::getInputOutput ( int  input,
TypeSet< int > &   
) const
overrideprotectedvirtual

Specifies the outputs needed for calculation among all those provided by the input data; very usefull when steering used as input data

Reimplemented from Attrib::VolStatsBase.

◆ getStackPositions()

void Attrib::VolStats::getStackPositions ( TypeSet< BinID > &  ) const
protected

◆ initClass()

static void Attrib::VolStats::initClass ( )
static

◆ optstackdirStr()

static const char* Attrib::VolStats::optstackdirStr ( )
inlinestatic

◆ optStackDirTypeStr()

static const char* Attrib::VolStats::optStackDirTypeStr ( int  )
static

◆ optstackstepStr()

static const char* Attrib::VolStats::optstackstepStr ( )
inlinestatic

◆ prepPriorToBoundsCalc()

void Attrib::VolStats::prepPriorToBoundsCalc ( )
overridevirtual

Z refstep is known now, this is meant to be used before possible- and desired- volumes are computed

Reimplemented from Attrib::VolStatsBase.

◆ reInitPosAndSteerIdxes()

void Attrib::VolStats::reInitPosAndSteerIdxes ( )
protected

◆ reqZMargin()

const Interval<float>* Attrib::VolStats::reqZMargin ( int  input,
int  output 
) const
overrideprotectedvirtual

Reimplemented from Attrib::VolStatsBase.

◆ setRdmPaths()

void Attrib::VolStats::setRdmPaths ( const TypeSet< BinID > &  truepath,
const TypeSet< BinID > &  snappedpath 
)
overridevirtual

For directional attributes.

Special case for attributes (like PreStack) which inputs are not treated as normal input cubes and thus not delivering adequate cs automaticly

Reimplemented from Attrib::Provider.

◆ updateDesc()

static void Attrib::VolStats::updateDesc ( Desc )
staticprotected

Member Data Documentation

◆ allowedgeeffects_

bool Attrib::VolStats::allowedgeeffects_
protected

◆ dosteer_

bool Attrib::VolStats::dosteer_
protected

◆ linepath_

TypeSet<BinID> Attrib::VolStats::linepath_
protected

◆ linetruepos_

TypeSet<BinID> Attrib::VolStats::linetruepos_
protected

◆ optstackdir_

int Attrib::VolStats::optstackdir_
protected

◆ optstackstep_

int Attrib::VolStats::optstackstep_
protected

◆ steerindexes_

TypeSet<int> Attrib::VolStats::steerindexes_
protected

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B.V. 1995-2024