UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Attributes | List of all members
ZqbGainControl Class Reference

#include <zqb_gain_control.hpp>

Public Member Functions

 ZqbGainControl ()
 
void init (const ZqbAbstrTrace &atrace, const ZqbSVOptions &svo)
 
void prepare (const ZqbRealTrace &trace)
 
float * apply (const ZqbRealTrace &trace, float mm[2]=NULL)
 
 ZqbGainControl ()
 
void init (const ZqbAbstrTrace &atrace, const ZqbSVOptions &svo)
 
void prepare (const ZqbRealTrace &trace)
 
float * apply (const ZqbRealTrace &trace, float mm[2]=NULL)
 

Protected Attributes

ZqbSVOptions m_Options
 
ZqbRealTrace m_GainOp
 
ZqbRealTrace m_Result
 

Detailed Description

Class for gain control operations.

Constructor & Destructor Documentation

ZqbGainControl::ZqbGainControl ( )

Create object for gain control.

ZqbGainControl::ZqbGainControl ( )

Create object for gain control.

Member Function Documentation

float* ZqbGainControl::apply ( const ZqbRealTrace trace,
float  mm[2] = NULL 
)

Apply precalculated gain to the given trace. Returns pointer to internal buffer of samples after gain application. Returns min and max sample value after application if it's needed (mm is not NULL).

float* ZqbGainControl::apply ( const ZqbRealTrace trace,
float  mm[2] = NULL 
)

Apply precalculated gain to the given trace. Returns pointer to internal buffer of samples after gain application. Returns min and max sample value after application if it's needed (mm is not NULL).

void ZqbGainControl::init ( const ZqbAbstrTrace atrace,
const ZqbSVOptions svo 
)

Tune the object for gain control over given abstract trace and with given parameters. Should preceed all other operations.

void ZqbGainControl::init ( const ZqbAbstrTrace atrace,
const ZqbSVOptions svo 
)

Tune the object for gain control over given abstract trace and with given parameters. Should preceed all other operations.

void ZqbGainControl::prepare ( const ZqbRealTrace trace)

Calculate gain control operator for given trace. Computes gain function which can be applied by apply() method to many traces.

void ZqbGainControl::prepare ( const ZqbRealTrace trace)

Calculate gain control operator for given trace. Computes gain function which can be applied by apply() method to many traces.

Member Data Documentation

ZqbRealTrace ZqbGainControl::m_GainOp
protected

Buffer for precalculated gain for each sample.

ZqbSVOptions ZqbGainControl::m_Options
protected

Gain control options.

ZqbRealTrace ZqbGainControl::m_Result
protected

Internal buffer for result of gain application. It's reused by numerous calls to apply().


The documentation for this class was generated from the following files: