OpendTect  6.6
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
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 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
 
virtual void initSteering ()
 
bool is2D () const
 
virtual bool isOK () const
 
bool isOutputEnabled (int output) const
 
virtual bool isSingleTrace () const
 
const TypeSet< Interval< int > > & localCompZIntervals () const
 
virtual int moveToNextTrace (BinID startpos=BinID(-1,-1), bool firstcheck=false)
 
virtual bool needStoredInput () const
 
int nrOutputs () const
 
virtual void prepareForComputeData ()
 
virtual void prepPriorToBoundsCalc ()
 
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 &)
 
virtual void setRdmPaths (TypeSet< BinID > *truepath, TypeSet< BinID > *snappedpath)
 For directional attributes. More...
 
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
 

Static Public Member Functions

static const char * attribName ()
 
static const char * factorStr ()
 
static const char * gateStr ()
 
static void initClass ()
 
static const char * mutefractionStr ()
 
static const char * powervalStr ()
 
static const char * scalingTypeNamesStr (int type)
 
static const char * scalingTypeStr ()
 
static const char * sqrangeStr ()
 
static const char * squntouchedStr ()
 
static const char * statsTypeNamesStr (int type)
 
static const char * statsTypeStr ()
 
static const char * widthStr ()
 
- 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 computeData (const DataHolder &, const BinID &relpos, int z0, int nrsamples, int threadid) const
 
const Interval< int > * desZSampMargin (int inp, int) const
 
bool getInputData (const BinID &, int zintv)
 
bool getInputOutput (int input, TypeSet< int > &res) const
 
void getSampleGates (const TypeSet< Interval< float > > &oldtgs, TypeSet< Interval< int > > &newsampgates, 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)
 
void scaleAGC (const DataHolder &, int z0, int nrsamples) const
 
void scaleGain (const DataHolder &, int z0, int nrsamples) const
 
void scaleSqueeze (const DataHolder &, int, int) const
 
void scaleZN (const DataHolder &, int, int) const
 
- Protected Member Functions inherited from Attrib::Provider
 Provider (Desc &)
 
void addParent (Provider *prov)
 
virtual bool checkInpAndParsAtStart ()
 
void computeDesInputCube (int inp, int out, TrcKeyZSampling &, bool usestepout=true) const
 
float crlDist () const
 
virtual const BinIDdesStepout (int input, int output) const
 
virtual const Interval< float > * desZMargin (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< float > * reqZMargin (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
 

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 dataidx_
 
Interval< int > desgate_
 
TypeSet< float > factors_
 
TypeSet< Interval< float > > gates_
 
const DataHolderinputdata_
 
float mutefraction_
 
float powerval_
 
int scalingtype_
 
Interval< float > sqrg_
 
Interval< float > squrg_
 
int statstype_
 
TypeSet< Trendtrends_
 
float width_
 
Interval< float > window_
 
- 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_
 
ObjectSet< Providerparents_
 
TrcKeyZSamplingpossiblevolume_
 
int prevtrcnr_
 
ProviderTaskprovidertask_
 
float refstep_
 
float refz0_
 
BinID reqbufferstepout_
 
const Seis::SelDataseldata_
 
BinID trcinfobid_
 
bool useshortcuts_
 

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

◆ Scaling()

Attrib::Scaling::Scaling ( Desc )

◆ ~Scaling()

Attrib::Scaling::~Scaling ( )
inlineprotected

Member Function Documentation

◆ allowParallelComputation()

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

Reimplemented from Attrib::Provider.

◆ attribName()

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

◆ computeData()

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
output
relpos
t0
nrsamples
threadidxthread identifier that may be handy when using multiple threads.

Implements Attrib::Provider.

◆ createInstance()

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

◆ desZSampMargin()

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.

◆ factorStr()

static const char* Attrib::Scaling::factorStr ( )
inlinestatic

◆ gateStr()

static const char* Attrib::Scaling::gateStr ( )
inlinestatic

◆ getInputData()

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.

◆ getInputOutput()

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.

◆ getSampleGates()

void Attrib::Scaling::getSampleGates ( const TypeSet< Interval< float > > &  oldtgs,
TypeSet< Interval< int > > &  newsampgates,
int  z0,
int  nrsamples 
) const
protected

◆ getScaleFactorsFromStats()

void Attrib::Scaling::getScaleFactorsFromStats ( const TypeSet< Interval< int > > &  gates,
TypeSet< float > &  factors,
int   
) const
protected

◆ getTrendsFromStats()

void Attrib::Scaling::getTrendsFromStats ( const TypeSet< Interval< int > > &  gates,
int   
)
protected

◆ initClass()

static void Attrib::Scaling::initClass ( )
static

◆ mutefractionStr()

static const char* Attrib::Scaling::mutefractionStr ( )
inlinestatic

◆ powervalStr()

static const char* Attrib::Scaling::powervalStr ( )
inlinestatic

◆ scaleAGC()

void Attrib::Scaling::scaleAGC ( const DataHolder ,
int  z0,
int  nrsamples 
) const
protected

◆ scaleGain()

void Attrib::Scaling::scaleGain ( const DataHolder ,
int  z0,
int  nrsamples 
) const
protected

◆ scaleSqueeze()

void Attrib::Scaling::scaleSqueeze ( const DataHolder ,
int  ,
int   
) const
protected

◆ scaleZN()

void Attrib::Scaling::scaleZN ( const DataHolder ,
int  ,
int   
) const
protected

◆ scalingTypeNamesStr()

static const char* Attrib::Scaling::scalingTypeNamesStr ( int  type)
static

◆ scalingTypeStr()

static const char* Attrib::Scaling::scalingTypeStr ( )
inlinestatic

◆ sqrangeStr()

static const char* Attrib::Scaling::sqrangeStr ( )
inlinestatic

◆ squntouchedStr()

static const char* Attrib::Scaling::squntouchedStr ( )
inlinestatic

◆ statsTypeNamesStr()

static const char* Attrib::Scaling::statsTypeNamesStr ( int  type)
static

◆ statsTypeStr()

static const char* Attrib::Scaling::statsTypeStr ( )
inlinestatic

◆ updateDesc()

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

◆ widthStr()

static const char* Attrib::Scaling::widthStr ( )
inlinestatic

Member Data Documentation

◆ dataidx_

int Attrib::Scaling::dataidx_
protected

◆ desgate_

Interval<int> Attrib::Scaling::desgate_
protected

◆ factors_

TypeSet<float> Attrib::Scaling::factors_
protected

◆ gates_

TypeSet< Interval<float> > Attrib::Scaling::gates_
protected

◆ inputdata_

const DataHolder* Attrib::Scaling::inputdata_
protected

◆ mutefraction_

float Attrib::Scaling::mutefraction_
protected

◆ powerval_

float Attrib::Scaling::powerval_
protected

◆ scalingtype_

int Attrib::Scaling::scalingtype_
protected

◆ sqrg_

Interval<float> Attrib::Scaling::sqrg_
protected

◆ squrg_

Interval<float> Attrib::Scaling::squrg_
protected

◆ statstype_

int Attrib::Scaling::statstype_
protected

◆ trends_

TypeSet<Trend> Attrib::Scaling::trends_
protected

◆ width_

float Attrib::Scaling::width_
protected

◆ window_

Interval<float> Attrib::Scaling::window_
protected

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