Frequency Attribute More...

Inheritance diagram for Attrib::Frequency:

Classes
class	FreqFunc

Public Member Functions
	Frequency (Desc &)

void	prepPriorToBoundsCalc () 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 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::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 &)

virtual void	setRdmPaths (const TypeSet< BinID > &truepath, const 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

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 *	attribName ()

static const char *	dumptofileStr ()

static const char *	gateStr ()

static void	initClass ()

static const char *	normalizeStr ()

static const char *	paramvalStr ()

static const char *	smoothspectrumStr ()

static const char *	windowStr ()

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

static uiString	prepare (Desc &)

Static Public Member Functions inherited from RefCount::Referenced
static bool	isSane (const Referenced *)

Protected Member Functions
	~Frequency ()

bool	allowParallelComputation () const override

bool	checkInpAndParsAtStart () override

bool	computeData (const DataHolder &, const BinID &rel, int z0, int nrsamples, int threadid) const override

bool	getInputData (const BinID &, int idx) override

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

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

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

virtual	~Provider ()

void	addParent (Provider *prov)

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

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)

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

Protected Member Functions inherited from RefCount::Referenced
	Referenced ()

	Referenced (const Referenced &)

virtual	~Referenced ()

Referenced &	operator= (const Referenced &)

Static Protected Member Functions
static Provider *	createInstance (Desc &)

static void	updateDefaults (Desc &)

static void	updateDesc (Desc &)

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

Protected Attributes
float	df_

BufferStringSet	dumpset_

bool	dumptofile_

Fourier::CC *	fft_

bool	fftisinit_

int	fftsz_

Array1DImpl< float_complex > *	freqdomain_

Interval< float >	gate_

int	imagidx_

const DataHolder *	imdata_

bool	normalize_

int	realidx_

const DataHolder *	redata_

Interval< int >	samplegate_

Array1DImpl< float_complex > *	signal_

bool	smoothspectrum_

Array1DImpl< float_complex > *	timedomain_

float	variable_

ArrayNDWindow *	window_

BufferString	windowtype_

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_

bool	parallel_ = true

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

Frequency Attribute

Calculates a number of attributes (see below) from the frequency domain in a gate. The gate can be windowed with the window specified in the window parameter prior to the Fourier Transform. If normalize is enabled, the frequency spectra is normalized with regard to its area. This will make it possible to attribare the attribs from areas with high and low energy.

Dumptofile dumps the spectrogram at all locations to a file. This feature is only for experimental dGB use - don't present it in any manuals. If used wrong (i.e. with volume output) you will end up with a file of several Gb. The file is stored as /tmp/frequency.dump

  Frequency gate=[-4,4] [normalize=No] [window=CosTaper5] [dumptofile=No]

  Input:
  0       Real data
  1       Imag data

  Output:
  0       Dominant frequency (DFQ)
  1       Average frequency  (AFQ)
  2       Median frequency (MFQ)
  3       Average frequency Squared (AFS)
  4       Maximum spectral amplitude (MSA)
  5       Spectral Area beyond dominant frequency (SADF)
  6       Frequency Slope Fall (FSF)
  7       Absorption Quality Factor (AQF)

<>

Constructor & Destructor Documentation

◆ Frequency()

Attrib::Frequency::Frequency ( Desc & )

◆ ~Frequency()

Attrib::Frequency::~Frequency ( )

protected

Member Function Documentation

◆ allowParallelComputation()

bool Attrib::Frequency::allowParallelComputation ( ) const

inlineoverrideprotectedvirtual

Reimplemented from Attrib::Provider.

◆ attribName()

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

inlinestatic

◆ checkInpAndParsAtStart()

bool Attrib::Frequency::checkInpAndParsAtStart ( )

overrideprotectedvirtual

Should be used for check after inputs are set, for extra checks at other time use isOK()

Reimplemented from Attrib::Provider.

◆ computeData()

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

Implements Attrib::Provider.

◆ createInstance()

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

staticprotected

◆ dumptofileStr()

static const char* Attrib::Frequency::dumptofileStr ( )

inlinestatic

◆ gateStr()

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

inlinestatic

◆ getInputData()

bool Attrib::Frequency::getInputData	(	const BinID &	relpos,
		int	idx
	)

overrideprotectedvirtual

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

Reimplemented from Attrib::Provider.

◆ getInputOutput()

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

◆ initClass()

static void Attrib::Frequency::initClass ( )

static

◆ normalizeStr()

static const char* Attrib::Frequency::normalizeStr ( )

inlinestatic

◆ paramvalStr()

static const char* Attrib::Frequency::paramvalStr ( )

inlinestatic

◆ prepPriorToBoundsCalc()

void Attrib::Frequency::prepPriorToBoundsCalc ( )

overridevirtual

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

Reimplemented from Attrib::Provider.

◆ reqZMargin()

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

overrideprotectedvirtual

Reimplemented from Attrib::Provider.

◆ smoothspectrumStr()

static const char* Attrib::Frequency::smoothspectrumStr ( )

inlinestatic

◆ updateDefaults()

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

staticprotected

◆ updateDesc()

static void Attrib::Frequency::updateDesc ( Desc & )

staticprotected

◆ windowStr()

static const char* Attrib::Frequency::windowStr ( )

inlinestatic

Member Data Documentation

◆ df_

float Attrib::Frequency::df_

protected

◆ dumpset_

BufferStringSet Attrib::Frequency::dumpset_

protected

◆ dumptofile_

bool Attrib::Frequency::dumptofile_

protected

◆ fft_

Fourier::CC* Attrib::Frequency::fft_

protected

◆ fftisinit_

bool Attrib::Frequency::fftisinit_

protected

◆ fftsz_

int Attrib::Frequency::fftsz_

protected

◆ freqdomain_

Array1DImpl<float_complex>* Attrib::Frequency::freqdomain_

protected

◆ gate_

Interval<float> Attrib::Frequency::gate_

protected

◆ imagidx_

int Attrib::Frequency::imagidx_

protected

◆ imdata_

const DataHolder* Attrib::Frequency::imdata_

protected

◆ normalize_

bool Attrib::Frequency::normalize_

protected

◆ realidx_

int Attrib::Frequency::realidx_

protected

◆ redata_

const DataHolder* Attrib::Frequency::redata_

protected

◆ samplegate_

Interval<int> Attrib::Frequency::samplegate_

protected

◆ signal_

Array1DImpl<float_complex>* Attrib::Frequency::signal_

protected

◆ smoothspectrum_

bool Attrib::Frequency::smoothspectrum_

protected

◆ timedomain_

Array1DImpl<float_complex>* Attrib::Frequency::timedomain_

protected

◆ variable_

float Attrib::Frequency::variable_

protected

◆ window_

ArrayNDWindow* Attrib::Frequency::window_

protected

◆ windowtype_

BufferString Attrib::Frequency::windowtype_

protected

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Frequency()

◆ ~Frequency()

Member Function Documentation

◆ allowParallelComputation()

◆ attribName()

◆ checkInpAndParsAtStart()

◆ computeData()

◆ createInstance()

◆ dumptofileStr()

◆ gateStr()

◆ getInputData()

◆ getInputOutput()

◆ initClass()

◆ normalizeStr()

◆ paramvalStr()

◆ prepPriorToBoundsCalc()

◆ reqZMargin()

◆ smoothspectrumStr()

◆ updateDefaults()

◆ updateDesc()

◆ windowStr()

Member Data Documentation

◆ df_

◆ dumpset_

◆ dumptofile_

◆ fft_

◆ fftisinit_

◆ fftsz_

◆ freqdomain_

◆ gate_

◆ imagidx_

◆ imdata_

◆ normalize_

◆ realidx_

◆ redata_

◆ samplegate_

◆ signal_

◆ smoothspectrum_

◆ timedomain_

◆ variable_

◆ window_

◆ windowtype_