AGC< T > Class Template Reference

Computes an AGC over a ValueSeries. More...

Inheritance diagram for AGC< T >:

Public Member Functions
	AGC ()
	~AGC ()
void	setInput (const ValueSeries< T > &, int sz)
void	setOutput (ValueSeries< T > &)
	Output can be the same as input. More...
void	setSampleGate (const Interval< int > &)
const Interval< int > &	getSampleGate () const
void	setMuteFraction (float lvmf)
	The lowest fraction will be muted. More...
float	getMuteFraction () const
bool	doPrepare (int nrthreads)
Public Member Functions inherited from ParallelTask
virtual	~ParallelTask ()
bool	execute ()
virtual bool	executeParallel (bool parallel)
void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
int64_t	nrDone () const
	May be -1, i.e. class does not report nrdone. More...
int64_t	totalNr () const
Public Member Functions inherited from Task
virtual	~Task ()
virtual uiString	uiMessage () const
	will be message() again in 7.x More...
virtual uiString	uiNrDoneText () const
	will be nrDoneText() in 7.x More...
virtual void	enableWorkControl (bool=true)
	Must be called before execute() More...
bool	workControlEnabled () const
virtual void	controlWork (Control)
virtual Control	getState () const
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject *linkedto)
	NamedObject (const NamedObject &)
virtual	~NamedObject ()
void	setLinkedTo (NamedObject *)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual const OD::String &	annotName () const
virtual void	setName (const char *)
void	setCleanName (const char *)
	cleans string first More...
void	deleteNotify (const CallBack &)
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (NotifierAccess &, const CallBack &, bool onlyifnew=false)
bool	attachCB (NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false)
void	detachCB (NotifierAccess &, const CallBack &)
void	detachCB (NotifierAccess *notif, const CallBack &cb)
bool	isNotifierAttached (NotifierAccess *) const
	Only for debugging purposes, don't use. More...

Protected Member Functions
void	computeEnergyMute ()
bool	doWork (od_int64, od_int64, int)
int	minThreadSize () const
od_int64	nrIterations () const
Protected Member Functions inherited from ParallelTask
virtual int	maxNrThreads () const
virtual bool	stopAllOnFailure () const
	ParallelTask (const char *nm=0)
	ParallelTask (const ParallelTask &)
int64_t	calculateThreadSize (int64_t totalnr, int nrthreads, int thread) const
void	addToNrDone (int64_t increment)
void	quickAddToNrDone (int64_t loopidx)
void	resetNrDone ()
Protected Member Functions inherited from Task
	Task (const char *nm=0)
virtual bool	shouldContinue ()
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers ()
	Call from the destructor of your inherited object. More...

Protected Attributes
const ValueSeries< T > *	input_
od_int64	size_
ValueSeries< T > *	output_
Interval< int >	samplerg_
float	mutefraction_
TypeSet< T >	energies_
T	energymute_
int	threadsinenergycalc_
Threads::ConditionVar *	lock_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedObject
BufferString *	name_
NamedObject *	linkedto_
CallBackSet *	delnotify_

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run, Pause, Stop }
Static Public Member Functions inherited from ParallelTask
static uiString	sPosFinished ()
static uiString	sTrcFinished ()
Static Public Member Functions inherited from Task
static uiString	stdNrDoneText ()
static uiString	uiStdNrDoneText ()

Detailed Description

template<class T>
class AGC< T >

Computes an AGC over a ValueSeries.

Constructor & Destructor Documentation

template<class T >

AGC< T >::AGC ( )

inline

template<class T >

AGC< T >::~AGC ( )

inline

Member Function Documentation

template<class T >

void AGC< T >::computeEnergyMute ( )

inlineprotected

template<class T >

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

inlinevirtual

Called once, before any doWork is called.

Reimplemented from ParallelTask.

template<class T >

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

inlineprotected

template<class T >

float AGC< T >::getMuteFraction ( ) const

inline

template<class T >

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

inline

template<class T >

int AGC< T >::minThreadSize ( ) const

inlineprotectedvirtual

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.

template<class T >

od_int64 AGC< T >::nrIterations ( ) const

inlineprotectedvirtual

Returns

the number of times the process should be run.

Implements ParallelTask.

template<class T >

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

inline

template<class T >

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

inline

The lowest fraction will be muted.

template<class T >

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

inline

Output can be the same as input.

template<class T >

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

inline

Member Data Documentation

template<class T >

TypeSet<T> AGC< T >::energies_

protected

template<class T >

T AGC< T >::energymute_

protected

template<class T >

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

protected

template<class T >

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

protected

template<class T >

float AGC< T >::mutefraction_

protected

template<class T >

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

protected

template<class T >

Interval<int> AGC< T >::samplerg_

protected

template<class T >

od_int64 AGC< T >::size_

protected

template<class T >

int AGC< T >::threadsinenergycalc_

protected