Computes an AGC over a ValueSeries. More...

#include <agc.h>

Inheritance diagram for AGC< T >:

Public Member Functions
	AGC ()

	~AGC ()

bool	doPrepare (int nrthreads) override

float	getMuteFraction () const

const Interval< int > &	getSampleGate () const

void	setInput (const ValueSeries< T > &, int sz)

void	setMuteFraction (float lvmf)
	The lowest fraction will be muted.

void	setOutput (ValueSeries< T > &)
	Output can be the same as input.

void	setSampleGate (const Interval< int > &)

Public Member Functions inherited from ParallelTask
virtual	~ParallelTask ()

void	doParallel (bool yn)

bool	execute () override

virtual bool	executeParallel (bool parallel)

od_int64	nrDone () const override
	May be -1, i.e. class does not report nrdone.

od_int64	totalNr () const override

Public Member Functions inherited from ReportingTask
	ReportingTask (const ReportingTask &)=delete

virtual	~ReportingTask ()

void	getProgress (const ReportingTask &)

ReportingTask &	operator= (const ReportingTask &)=delete

void	setSimpleMeter (bool yn, int repperc)

int	simpleMeterStep () const

bool	useSimpleMeter () const

Public Member Functions inherited from Task
	Task (const Task &)=delete

virtual	~Task ()

virtual void	controlWork (Control)

virtual void	enableWorkControl (bool=true)
	Must be called before execute()

virtual uiRetVal	errorWithDetails () const

virtual Control	getState () const

Task &	operator= (const Task &)=delete

virtual uiString	uiMessage () const

virtual uiString	uiNrDoneText () const

bool	workControlEnabled () const

Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=nullptr)

	NamedCallBacker (const NamedCallBacker &)=delete

	~NamedCallBacker ()

virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const

NamedCallBacker &	operator= (const NamedCallBacker &)=delete

bool	operator== (const NamedCallBacker &oth) const

bool	operator== (const NamedObject &oth) const

Public Member Functions inherited from CallBacker
	CallBacker ()

	CallBacker (const CallBacker &)

virtual	~CallBacker ()

bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const

bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const

void	detachAllNotifiers () const
	Call from the destructor of your inherited object.

void	detachCB (const NotifierAccess &, const CallBack &) const

void	detachCB (const NotifierAccess *notif, const CallBack &cb) const

virtual bool	isCapsule () const

bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use.

CallBacker &	operator= (const CallBacker &)=delete

void	stopReceivingNotifications () const

virtual CallBacker *	trueCaller ()

Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)

	NamedObject (const NamedObject &oth)

virtual	~NamedObject ()

virtual BufferString	getName () const

bool	getNameFromPar (const IOPar &)

const name_type &	name () const override

NamedObject &	operator= (const NamedObject &)

bool	operator== (const NamedObject &oth) const

virtual void	setName (const char *nm)

Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()

bool	hasName (const char *nm) const

bool	hasName (const name_type &nm) const

void	putNameInPar (IOPar &) const

Protected Member Functions
void	computeEnergyMute ()

bool	doWork (od_int64, od_int64, int) override

int	minThreadSize () const override

od_int64	nrIterations () const override

Protected Member Functions inherited from ParallelTask
	ParallelTask (const char *nm=0)

void	addToNrDone (od_int64 increment)

od_int64	calculateThreadSize (od_int64 totalnr, int nrthreads, int thread) const

virtual int	maxNrThreads () const

void	quickAddToNrDone (od_int64 loopidx)

void	resetNrDone ()

virtual bool	stopAllOnFailure () const

Protected Member Functions inherited from ReportingTask
	ReportingTask (const char *nm=nullptr)

void	incrementProgress ()

ProgressMeter *	progressMeter () const

void	reportProgressFinished ()

void	reportProgressStarted ()

void	resetProgress ()

void	setProgressMeter (ProgressMeter *) override
	Must be called before execute()

void	updateProgressMeter (bool forced=false, od_int64 *totalnr=0)

void	updateReportedName ()

Protected Member Functions inherited from Task
	Task (const char *nm=nullptr)

virtual bool	shouldContinue ()

Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Protected Attributes
TypeSet< T >	energies_

T	energymute_

const ValueSeries< T > *	input_

Threads::ConditionVar *	lock_

float	mutefraction_

ValueSeries< T > *	output_

Interval< int >	samplerg_

od_int64	size_

int	threadsinenergycalc_

Protected Attributes inherited from Task
Control	control_ = Task::Run

Threads::ConditionVar *	workcontrolcondvar_ = nullptr

Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_

Notifier< NamedCallBacker >	delnotif_

Protected Attributes inherited from NamedObject
BufferString	name_

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run , Pause , Stop }

Public Types inherited from ObjectWithName
typedef OD::String	name_type

Static Public Member Functions inherited from ParallelTask
static uiString	sPosFinished ()

static uiString	sTrcFinished ()

Static Public Member Functions inherited from ReportingTask
static PtrMan< ProgressMeter >	getTextProgressMeter (od_ostream &, const IOPar *iop=nullptr)

static bool	needSimpleLogging (const IOPar &)

static const char *	sKeySimpleLogging ()

static const char *	sKeySimpleLoggingStep ()

Static Public Member Functions inherited from Task
static uiString	uiStdNrDoneText ()

Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()

static void	removeReceiverForCurrentThread ()

Public Attributes inherited from ReportingTask
Notifier< ReportingTask >	progressUpdated

Detailed Description

template<class T>
class AGC< T >

Computes an AGC over a ValueSeries.

<>

Constructor & Destructor Documentation

◆ AGC()

template<class T >

AGC< T >::AGC ( )

inline

◆ ~AGC()

template<class T >

AGC< T >::~AGC ( )

inline

Member Function Documentation

◆ computeEnergyMute()

template<class T >

void AGC< T >::computeEnergyMute ( )

inlineprotected

◆ doPrepare()

template<class T >

bool AGC< T >::doPrepare ( int nrthreads )

inlineoverridevirtual

Called once, before any doWork is called.

Reimplemented from ParallelTask.

◆ doWork()

template<class T >

bool AGC< T >::doWork	(	od_int64	start,
		od_int64	stop,
		int	threadidx )

inlineoverrideprotectedvirtual

The functions that does the job. The function will be called with all intervals from 0 to ParallelTask::nrIterations()-1. The function must be designed to be able to run in parallel.

Parameters

start	first index
stop	last index
threadidx	gives an identifier (between 0 and nr of threads -1) that is unique to each call to doWork.

Implements ParallelTask.

◆ getMuteFraction()

template<class T >

float AGC< T >::getMuteFraction ( ) const

inline

◆ getSampleGate()

template<class T >

const Interval< int > & AGC< T >::getSampleGate ( ) const

inline

◆ minThreadSize()

template<class T >

int AGC< T >::minThreadSize ( ) const

inlineoverrideprotectedvirtual

Returns: the minimum number of computations that effectively can be run in a separate thread. A small number will give a large overhead for when each step is quick and nrIterations is not big.

Reimplemented from ParallelTask.

◆ nrIterations()

template<class T >

od_int64 AGC< T >::nrIterations ( ) const

inlineoverrideprotectedvirtual

Returns: the number of times the process should be run.

Implements ParallelTask.

◆ setInput()

template<class T >

void AGC< T >::setInput	(	const ValueSeries< T > &	nvs,
		int	sz )

inline

◆ setMuteFraction()

template<class T >

void AGC< T >::setMuteFraction ( float lvmf )

inline

The lowest fraction will be muted.

◆ setOutput()

template<class T >

void AGC< T >::setOutput ( ValueSeries< T > & nvs )

inline

Output can be the same as input.

◆ setSampleGate()

template<class T >

void AGC< T >::setSampleGate ( const Interval< int > & nrg )

inline

Member Data Documentation

◆ energies_

template<class T >

TypeSet<T> AGC< T >::energies_

protected

◆ energymute_

template<class T >

T AGC< T >::energymute_

protected

◆ input_

template<class T >

const ValueSeries<T>* AGC< T >::input_

protected

◆ lock_

template<class T >

Threads::ConditionVar* AGC< T >::lock_

protected

◆ mutefraction_

template<class T >

float AGC< T >::mutefraction_

protected

◆ output_

template<class T >

ValueSeries<T>* AGC< T >::output_

protected

◆ samplerg_

template<class T >

Interval<int> AGC< T >::samplerg_

protected

◆ size_

template<class T >

od_int64 AGC< T >::size_

protected

◆ threadsinenergycalc_

template<class T >

int AGC< T >::threadsinenergycalc_

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AGC()

◆ ~AGC()

Member Function Documentation

◆ computeEnergyMute()

◆ doPrepare()

◆ doWork()

◆ getMuteFraction()

◆ getSampleGate()

◆ minThreadSize()

◆ nrIterations()

◆ setInput()

◆ setMuteFraction()

◆ setOutput()

◆ setSampleGate()

Member Data Documentation

◆ energies_

◆ energymute_

◆ input_

◆ lock_

◆ mutefraction_

◆ output_

◆ samplerg_

◆ size_

◆ threadsinenergycalc_