Energy Attribute More...

Inheritance diagram for Attrib::Energy:

Public Member Functions
	Energy (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 SeisTrcInfo *	getCurrentTrcInfo () const

const DataHolder *	getData (const BinID &relpos=BinID(0, 0), int idx=0)

const DataHolder *	getDataDontCompute (const BinID &relpos) const

bool	getDataUnavailableFlag () const

const BinID &	getDesBufStepout () const

Desc &	getDesc ()

const Desc &	getDesc () const

const TrcKeyZSampling *	getDesiredVolume () const

virtual float	getDistBetwTrcs (bool, const char *linenm=0) const

BinID	getElementStepout () const

virtual Pos::GeomID	getGeomID () const

ObjectSet< Provider > &	getInputs ()

const TrcKeyZSampling *	getPossibleVolume () const

virtual bool	getPossibleVolume (int outp, TrcKeyZSampling &)

float	getRefStep () const

float	getRefZ0 () const

const BinID &	getReqBufStepout () 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 *	dogradStr ()

static const char *	gateStr ()

static void	initClass ()

Static Public Member Functions inherited from Attrib::Provider
static Provider *	create (Desc &, uiString &errmsg)

static uiString	prepare (Desc &)

Protected Member Functions
	~Energy ()

bool	allowParallelComputation () const

bool	computeData (const DataHolder &, const BinID &relpos, int t0, int nrsamples, int threadid) const

const Interval< int > *	desZSampMargin (int input, int output) const

bool	getInputData (const BinID &, int idx)

bool	getInputOutput (int input, TypeSet< int > &res) const

const Interval< float > *	reqZMargin (int input, int output) 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 BinID *	desStepout (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)

DataHolder *	getDataHolder (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 SeisMSCProvider *	getMSCProvider (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 BinID *	reqStepout (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 Provider *	createInstance (Desc &)

static void	updateDefaults (Desc &)

Static Protected Member Functions inherited from Attrib::Provider
static Provider *	internalCreate (Desc &, ObjectSet< Provider > &, bool &issame, uiString &)

Protected Attributes
int	dataidx_

Interval< int >	dessampgate_

bool	dograd_

Interval< float >	gate_

const DataHolder *	inputdata_

Protected Attributes inherited from Attrib::Provider
ObjectSet< Provider >	allexistingprov_

bool	alreadymoved_

BinID	currentbid_

const SeisTrcInfo *	curtrcinfo_

bool	dataunavailableflag_

BinID	desbufferstepout_

Desc &	desc_

TrcKeyZSampling *	desiredvolume_

uiString	errmsg_

TypeSet< float >	exactz_

Interval< float >	extraz_

Pos::GeomID	geomid_

ObjectSet< Provider >	inputs_

bool	isusedmulttimes_

DataHolderLineBuffer *	linebuffer_

TypeSet< Interval< int > >	localcomputezintervals_

bool	needinterp_

TypeSet< int >	outputinterest_

ObjectSet< Provider >	parents_

TrcKeyZSampling *	possiblevolume_

int	prevtrcnr_

ProviderTask *	providertask_

float	refstep_

float	refz0_

BinID	reqbufferstepout_

const Seis::SelData *	seldata_

BinID	trcinfobid_

bool	useshortcuts_

Detailed Description

Energy Attribute

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

Energy gate= dograd=

Input:
0               Data

Outputs:        
0               The energy
1               Square root of the energy
2               Ln of the energy

if Gradient is selected outputs will be : grad(Energy), grad(SQRT(Energy)), ...

<>

Constructor & Destructor Documentation

◆ Energy()

Attrib::Energy::Energy ( Desc & )

◆ ~Energy()

Attrib::Energy::~Energy ( )

inlineprotected

Member Function Documentation

◆ allowParallelComputation()

bool Attrib::Energy::allowParallelComputation ( ) const

protectedvirtual

Reimplemented from Attrib::Provider.

◆ attribName()

static const char* Attrib::Energy::attribName ( )

inlinestatic

◆ computeData()

bool Attrib::Energy::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
threadidx	thread identifier that may be handy when using multiple threads.

Implements Attrib::Provider.

◆ createInstance()

static Provider* Attrib::Energy::createInstance ( Desc & )

staticprotected

◆ desZSampMargin()

const Interval<int>* Attrib::Energy::desZSampMargin	(	int	input,
		int	output
	)		const

inlineprotectedvirtual

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.

◆ dogradStr()

static const char* Attrib::Energy::dogradStr ( )

inlinestatic

◆ gateStr()

static const char* Attrib::Energy::gateStr ( )

inlinestatic

◆ getInputData()

bool Attrib::Energy::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::Energy::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.

◆ initClass()

static void Attrib::Energy::initClass ( )

static

◆ reqZMargin()

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

inlineprotectedvirtual

Reimplemented from Attrib::Provider.

◆ updateDefaults()

static void Attrib::Energy::updateDefaults ( Desc & )

staticprotected

Member Data Documentation

◆ dataidx_

int Attrib::Energy::dataidx_

protected

◆ dessampgate_

Interval<int> Attrib::Energy::dessampgate_

protected

◆ dograd_

bool Attrib::Energy::dograd_

protected

◆ gate_

Interval<float> Attrib::Energy::gate_

protected

◆ inputdata_

const DataHolder* Attrib::Energy::inputdata_

protected

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Energy()

◆ ~Energy()

Member Function Documentation

◆ allowParallelComputation()

◆ attribName()

◆ computeData()

◆ createInstance()

◆ desZSampMargin()

◆ dogradStr()

◆ gateStr()

◆ getInputData()

◆ getInputOutput()

◆ initClass()

◆ reqZMargin()

◆ updateDefaults()

Member Data Documentation

◆ dataidx_

◆ dessampgate_

◆ dograd_

◆ gate_

◆ inputdata_