Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes

Attrib::Energy Class Reference

"Energy Attribute" More...

Inheritance diagram for Attrib::Energy:
Attrib::Provider

List of all members.

Public Member Functions

 Energy (Desc &)

Static Public Member Functions

static void initClass ()
static const char * attribName ()
static const char * gateStr ()
static const char * dogradStr ()

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

Static Protected Member Functions

static ProvidercreateInstance (Desc &)
static void updateDefaults (Desc &)

Protected Attributes

Interval< float > gate_
Interval< int > dessampgate_
bool dograd_
int dataidx_
const DataHolderinputdata_

Detailed Description

"Energy Attribute"

Energy gate= dograd=

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

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 (  )  [inline, protected]

Member Function Documentation

bool Attrib::Energy::allowParallelComputation (  )  const [protected, virtual]

Reimplemented from Attrib::Provider.

static const char* Attrib::Energy::attribName (  )  [inline, static]
bool Attrib::Energy::computeData ( const DataHolder ,
const BinID relpos,
int  t0,
int  nrsamples,
int  threadid 
) const [protected, virtual]

Reimplemented from Attrib::Provider.

static Provider* Attrib::Energy::createInstance ( Desc  )  [static, protected]
const Interval<int>* Attrib::Energy::desZSampMargin ( int  input,
int  output 
) const [inline, protected, virtual]

Reimplemented from Attrib::Provider.

static const char* Attrib::Energy::dogradStr (  )  [inline, static]
static const char* Attrib::Energy::gateStr (  )  [inline, static]
bool Attrib::Energy::getInputData ( const BinID ,
int  idx 
) [protected, virtual]

Reimplemented from Attrib::Provider.

bool Attrib::Energy::getInputOutput ( int  input,
TypeSet< int > &  res 
) const [protected, virtual]

Reimplemented from Attrib::Provider.

static void Attrib::Energy::initClass (  )  [static]
const Interval<float>* Attrib::Energy::reqZMargin ( int  input,
int  output 
) const [inline, protected, virtual]

Reimplemented from Attrib::Provider.

static void Attrib::Energy::updateDefaults ( Desc  )  [static, protected]

Member Data Documentation

int Attrib::Energy::dataidx_ [protected]
bool Attrib::Energy::dograd_ [protected]
Interval<float> Attrib::Energy::gate_ [protected]