dsp::InverseFilterbank::Engine Class Reference

Abstract base class for derived engines that operate on data in order to perform inverse (synthesis) filterbank operation. More...

Inheritance diagram for dsp::InverseFilterbank::Engine:

Public Member Functions
virtual void	setup (InverseFilterbank *)=0
	If kernel is not set, then the engine should set up for benchmark only.

virtual void	set_scratch (float *)=0
	provide some scratch space for the engine

virtual void	perform (const dsp::TimeSeries in, dsp::TimeSeries out, uint64_t npart, const uint64_t in_step, const uint64_t out_step)=0
	Perform the filterbank operation on the input data.

virtual void	perform (const dsp::TimeSeries in, dsp::TimeSeries out, dsp::TimeSeries *zero_DM_out, uint64_t npart, const uint64_t in_step, const uint64_t out_step)=0

virtual void	finish ()
	Finish up.

unsigned	get_total_scratch_needed () const
	get the amount of scratch space the engine has calculated that it needs

bool	get_report () const

void	set_report (bool _report)

Public Member Functions inherited from Reference::Able
	Able (const Able &)

Able &	operator= (const Able &)

unsigned	get_reference_count () const

Public Member Functions inherited from Reference::HeapTracked
	HeapTracked (const HeapTracked &)

HeapTracked &	operator= (const HeapTracked &)

bool	__is_on_heap () const

Protected Attributes
float *	scratch

float *	output

unsigned	output_span

unsigned	total_scratch_needed

bool	report
	Flag indicating whether to report intermediate data products.

Additional Inherited Members
Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()

Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)

static void	operator delete (void location, void ptr)

static void	operator delete (void *location)

static size_t	get_heap_queue_size ()

Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const

void	__dereference (bool auto_delete=true) const

Detailed Description

Abstract base class for derived engines that operate on data in order to perform inverse (synthesis) filterbank operation.

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