Energy Attribute More...

Inheritance diagram for Attrib::Energy:

Public Member Functions
	Energy (Desc &)

Public Member Functions inherited from Attrib::Provider
virtual bool	isOK () const

bool	is2D () const

const Desc &	getDesc () const

Desc &	getDesc ()

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

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

const BinID &	getDesBufStepout () const

void	setDesiredVolume (const TrcKeyZSampling &)

const TrcKeyZSampling *	getDesiredVolume () const

void	resetDesiredVolume ()

void	setPossibleVolume (const TrcKeyZSampling &)

virtual bool	getPossibleVolume (int outp, TrcKeyZSampling &)

const TrcKeyZSampling *	getPossibleVolume () 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 SeisTrcInfo *	getCurrentTrcInfo () 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 *	gateStr ()

static const char *	dogradStr ()

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	getInputOutput (int input, TypeSet< int > &res) const

bool	getInputData (const BinID &, int idx)

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

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

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

Protected Member Functions inherited from Attrib::Provider
	Provider (Desc &)

virtual bool	checkInpAndParsAtStart ()

virtual SeisMSCProvider *	getMSCProvider (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)

DataHolder *	getDataHolder (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 BinID *	desStepout (int input, int output) const

virtual const BinID *	reqStepout (int input, int output) const

virtual const Interval< float > *	desZMargin (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 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
Interval< float >	gate_

Interval< int >	dessampgate_

bool	dograd_

int	dataidx_

const DataHolder *	inputdata_

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

ObjectSet< Provider >	parents_

Desc &	desc_

TypeSet< int >	outputinterest_

BinID	desbufferstepout_

BinID	reqbufferstepout_

TrcKeyZSampling *	desiredvolume_

TrcKeyZSampling *	possiblevolume_

TypeSet< Interval< int > >	localcomputezintervals_

ObjectSet< Provider >	allexistingprov_

TypeSet< float >	exactz_

ProviderTask *	providertask_

DataHolderLineBuffer *	linebuffer_

BinID	currentbid_

int	prevtrcnr_

Pos::GeomID	geomid_

const Seis::SelData *	seldata_

Interval< float >	extraz_

const SeisTrcInfo *	curtrcinfo_

BinID	trcinfobid_

bool	useshortcuts_

float	refz0_

float	refstep_

bool	alreadymoved_

bool	isusedmulttimes_

bool	needinterp_

uiString	errmsg_

bool	dataunavailableflag_

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

Attrib::Energy::Energy ( Desc & )

Attrib::Energy::~Energy ( )

inlineprotected

Member Function Documentation

bool Attrib::Energy::allowParallelComputation ( ) const

protectedvirtual

Reimplemented from Attrib::Provider.

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

inlinestatic

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

threadid thread identifier that may be handy when using multiple threads.

Implements Attrib::Provider.

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

staticprotected

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.

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

inlinestatic

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

inlinestatic

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.

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.

static void Attrib::Energy::initClass ( )

static

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

inlineprotectedvirtual

Reimplemented from Attrib::Provider.

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

staticprotected

Member Data Documentation

int Attrib::Energy::dataidx_

protected

Interval<int> Attrib::Energy::dessampgate_

protected

bool Attrib::Energy::dograd_

protected

Interval<float> Attrib::Energy::gate_

protected

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

Member Function Documentation

Member Data Documentation