OpendTect-6_4  6.4
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Attrib::Scaling Class Reference

Scaling Attribute Calculates the squared sum of the gate's samples divided by the number of samples in the gate. More...

Inheritance diagram for Attrib::Scaling:
[legend]

Classes

struct  Trend
 

Public Member Functions

 Scaling (Desc &)
 
- Public Member Functions inherited from Attrib::Provider
virtual bool isOK () const
 
bool is2D () const
 
const DescgetDesc () const
 
DescgetDesc ()
 
const DataHoldergetData (const BinID &relpos=BinID(0, 0), int idx=0)
 
const DataHoldergetDataDontCompute (const BinID &relpos) const
 
int nrOutputs () const
 
void enableOutput (int output, bool yn=true)
 
bool isOutputEnabled (int output) const
 
void setOutputInterestSize (bool preserve=false)
 
void enableAllOutputs (bool yn=true)
 
virtual void getCompNames (BufferStringSet &) const
 
virtual bool isSingleTrace () const
 
virtual bool usesTracePosition () const
 
virtual void setReqBufStepout (const BinID &, bool wait=false)
 
virtual void setDesBufStepout (const BinID &, bool wait=false)
 
const BinIDgetReqBufStepout () const
 
const BinIDgetDesBufStepout () const
 
void setDesiredVolume (const TrcKeyZSampling &)
 
const TrcKeyZSamplinggetDesiredVolume () const
 
void resetDesiredVolume ()
 
void setPossibleVolume (const TrcKeyZSampling &)
 
virtual bool getPossibleVolume (int outp, TrcKeyZSampling &)
 
const TrcKeyZSamplinggetPossibleVolume () const
 
int getTotalNrPos (bool)
 
void setCurLineName (const char *)
 
virtual void adjust2DLineStoredVolume ()
 
virtual Pos::GeomID getGeomID () const
 
virtual void setGeomID (Pos::GeomID)
 
virtual int moveToNextTrace (BinID startpos=BinID(-1,-1), bool firstcheck=false)
 
void computeNewStartPos (BinID &)
 
int alignInputs (ObjectSet< Provider > &)
 
int comparePosAndAlign (Provider *, bool, Provider *, bool, bool)
 
void resetMoved ()
 
void resetZIntervals ()
 
virtual const SeisTrcInfogetCurrentTrcInfo () const
 
BinID getCurrentPosition () const
 
virtual bool setCurrentPosition (const BinID &)
 
void updateCurrentInfo ()
 
virtual bool needStoredInput () const
 
void addLocalCompZIntervals (const TypeSet< Interval< int > > &)
 
const TypeSet< Interval< int > > & localCompZIntervals () const
 
void updateInputReqs (int input=-1)
 
virtual void updateStorageReqs (bool all=false)
 
void setUseSC ()
 
void setSelData (const Seis::SelData *)
 
void setExtraZ (const Interval< float > &)
 
void setNeedInterpol (bool)
 
void setExactZ (const TypeSet< float > &)
 
void computeRefStep ()
 
void setRefStep (float step)
 
float getRefStep () const
 
void computeRefZ0 ()
 
void setRefZ0 (float z0)
 
float getRefZ0 () const
 
virtual BinID getStepoutStep () const
 
ObjectSet< Provider > & getInputs ()
 
BinID getTrcInfoBid () const
 
uiString errMsg () const
 
virtual void initSteering ()
 
virtual void prepSteeringForStepout (const BinID &)
 
virtual bool prepPriorToOutputSetup ()
 
virtual void prepPriorToBoundsCalc ()
 
virtual void prepareForComputeData ()
 
virtual void fillDataPackWithTrc (RegularSeisDataPack *) const
 
virtual void setRdmPaths (TypeSet< BinID > *truepath, TypeSet< BinID > *snappedpath)
 For directional attributes. More...
 
virtual void updateCSIfNeeded (TrcKeyZSampling &) const
 
virtual bool compDistBetwTrcsStats (bool force=false)
 
float getApplicableCrlDist (bool) const
 
virtual float getDistBetwTrcs (bool, const char *linenm=0) const
 
BinID getElementStepout () const
 
void setDataUnavailableFlag (bool yn)
 
bool getDataUnavailableFlag () const
 

Static Public Member Functions

static void initClass ()
 
static const char * attribName ()
 
static const char * scalingTypeStr ()
 
static const char * powervalStr ()
 
static const char * gateStr ()
 
static const char * factorStr ()
 
static const char * widthStr ()
 
static const char * mutefractionStr ()
 
static const char * statsTypeStr ()
 
static const char * sqrangeStr ()
 
static const char * squntouchedStr ()
 
static const char * statsTypeNamesStr (int type)
 
static const char * scalingTypeNamesStr (int type)
 
- Static Public Member Functions inherited from Attrib::Provider
static Providercreate (Desc &, uiString &errmsg)
 
static uiString prepare (Desc &)
 

Protected Member Functions

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

Static Protected Member Functions

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

Protected Attributes

int scalingtype_
 
int statstype_
 
float powerval_
 
TypeSet< Interval< float > > gates_
 
TypeSet< float > factors_
 
const DataHolderinputdata_
 
int dataidx_
 
Interval< int > desgate_
 
Interval< float > sqrg_
 
Interval< float > squrg_
 
float width_
 
Interval< float > window_
 
float mutefraction_
 
TypeSet< Trendtrends_
 
- Protected Attributes inherited from Attrib::Provider
ObjectSet< Providerinputs_
 
ObjectSet< Providerparents_
 
Descdesc_
 
TypeSet< int > outputinterest_
 
BinID desbufferstepout_
 
BinID reqbufferstepout_
 
TrcKeyZSamplingdesiredvolume_
 
TrcKeyZSamplingpossiblevolume_
 
TypeSet< Interval< int > > localcomputezintervals_
 
ObjectSet< Providerallexistingprov_
 
TypeSet< float > exactz_
 
ProviderTask * providertask_
 
DataHolderLineBufferlinebuffer_
 
BinID currentbid_
 
int prevtrcnr_
 
Pos::GeomID geomid_
 
const Seis::SelDataseldata_
 
Interval< float > extraz_
 
const SeisTrcInfocurtrcinfo_
 
BinID trcinfobid_
 
bool useshortcuts_
 
float refz0_
 
float refstep_
 
bool alreadymoved_
 
bool isusedmulttimes_
 
bool needinterp_
 
uiString errmsg_
 
bool dataunavailableflag_
 

Detailed Description

Scaling Attribute Calculates the squared sum of the gate's samples divided by the number of samples in the gate.

  Scaling gate =
  Input:
  0               Data
  Outputs:
  0               The scaled trace

Constructor & Destructor Documentation

Attrib::Scaling::Scaling ( Desc )
Attrib::Scaling::~Scaling ( )
inlineprotected

Member Function Documentation

bool Attrib::Scaling::allowParallelComputation ( ) const
protectedvirtual

Reimplemented from Attrib::Provider.

static const char* Attrib::Scaling::attribName ( )
inlinestatic
bool Attrib::Scaling::computeData ( const DataHolder output,
const BinID relpos,
int  t0,
int  nrsamples,
int  threadidx 
) const
protectedvirtual

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
threadidthread identifier that may be handy when using multiple threads.

Implements Attrib::Provider.

static Provider* Attrib::Scaling::createInstance ( Desc )
staticprotected
const Interval<int>* Attrib::Scaling::desZSampMargin ( int  input,
int  output 
) const
protectedvirtual

The gate is specified in the trace samples, and is in addition to the gate specified in desZMargin. The system will try to supply the attribute with the desired gate, but will not take the desired gate into account when computing the volume that can be computed.

Returns
the extra gate desired on input if output is going to be computed, or NULL if no extra gate is desired.

Reimplemented from Attrib::Provider.

static const char* Attrib::Scaling::factorStr ( )
inlinestatic
static const char* Attrib::Scaling::gateStr ( )
inlinestatic
bool Attrib::Scaling::getInputData ( const BinID relpos,
int  idx 
)
protectedvirtual

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

Reimplemented from Attrib::Provider.

bool Attrib::Scaling::getInputOutput ( int  input,
TypeSet< int > &   
) const
protectedvirtual

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::Provider.

void Attrib::Scaling::getSampleGates ( const TypeSet< Interval< float > > &  oldtgs,
TypeSet< Interval< int > > &  newsampgates,
int  z0,
int  nrsamples 
) const
protected
void Attrib::Scaling::getScaleFactorsFromStats ( const TypeSet< Interval< int > > &  gates,
TypeSet< float > &  factors,
int   
) const
protected
void Attrib::Scaling::getTrendsFromStats ( const TypeSet< Interval< int > > &  gates,
int   
)
protected
static void Attrib::Scaling::initClass ( )
static
static const char* Attrib::Scaling::mutefractionStr ( )
inlinestatic
static const char* Attrib::Scaling::powervalStr ( )
inlinestatic
void Attrib::Scaling::scaleAGC ( const DataHolder ,
int  z0,
int  nrsamples 
) const
protected
void Attrib::Scaling::scaleGain ( const DataHolder ,
int  z0,
int  nrsamples 
) const
protected
void Attrib::Scaling::scaleSqueeze ( const DataHolder ,
int  ,
int   
) const
protected
void Attrib::Scaling::scaleZN ( const DataHolder ,
int  ,
int   
) const
protected
static const char* Attrib::Scaling::scalingTypeNamesStr ( int  type)
static
static const char* Attrib::Scaling::scalingTypeStr ( )
inlinestatic
static const char* Attrib::Scaling::sqrangeStr ( )
inlinestatic
static const char* Attrib::Scaling::squntouchedStr ( )
inlinestatic
static const char* Attrib::Scaling::statsTypeNamesStr ( int  type)
static
static const char* Attrib::Scaling::statsTypeStr ( )
inlinestatic
static void Attrib::Scaling::updateDesc ( Desc )
staticprotected
static const char* Attrib::Scaling::widthStr ( )
inlinestatic

Member Data Documentation

int Attrib::Scaling::dataidx_
protected
Interval<int> Attrib::Scaling::desgate_
protected
TypeSet<float> Attrib::Scaling::factors_
protected
TypeSet< Interval<float> > Attrib::Scaling::gates_
protected
const DataHolder* Attrib::Scaling::inputdata_
protected
float Attrib::Scaling::mutefraction_
protected
float Attrib::Scaling::powerval_
protected
int Attrib::Scaling::scalingtype_
protected
Interval<float> Attrib::Scaling::sqrg_
protected
Interval<float> Attrib::Scaling::squrg_
protected
int Attrib::Scaling::statstype_
protected
TypeSet<Trend> Attrib::Scaling::trends_
protected
float Attrib::Scaling::width_
protected
Interval<float> Attrib::Scaling::window_
protected

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