HDecimator< T > Class Template Reference

#include <hdecimator.h>

Inheritance diagram for HDecimator< T >:

Collaboration diagram for HDecimator< T >:

Public Member Functions
	HDecimator (HWriter< T > *writer, int factor, size_t blocksize, bool collect=true, int start=0, HProbe< T > *probe=nullptr)
	HDecimator (HWriterConsumer< T > *consumer, int factor, size_t blocksize, bool collect=true, int start=0, HProbe< T > *probe=nullptr)
	HDecimator (HReader< T > *reader, int factor, size_t blocksize, bool collect=true, int start=0, HProbe< T > *probe=nullptr)
void	SetWriter (HWriter< T > *writer)
	~HDecimator ()
int	Write (T *src, size_t blocksize)
int	Read (T *dest, size_t blocksize)
bool	Start ()
bool	Stop ()
bool	Command (HCommand *command)
void	SetFactor (int factor)
Public Member Functions inherited from HReader< T >
virtual	~HReader ()=default
HReader< T > *	Reader ()
Public Member Functions inherited from HObject
	HObject ()
Public Member Functions inherited from HWriter< T >
virtual	~HWriter ()=default
HWriter< T > *	Writer ()
Public Member Functions inherited from HWriterConsumer< T >
HWriterConsumer< T > *	Consumer ()

Detailed Description

template<class T>
class HDecimator< T >

Implements a decimator that can reduce the incomming samplerate by a given factor

Constructor & Destructor Documentation

HDecimator() [1/3]

template<class T >

HDecimator< T >::HDecimator	(	HWriter< T > *	writer,
		int	factor,
		size_t	blocksize,
		bool	collect = true,
		int	start = 0,
		HProbe< T > *	probe = nullptr
	)

Construct a new HDecimator that handle writers.

Parameters

writer	The downstream writer
factor	Decimation factor, 1 or larger
blocksize	The expected input and output blocksize
collect	Normally you want to use the same blocksize for alle writers in a chain, but if you are going to use a decimator in a parallel demultiplexed chain (processing IQ data), it is very important to write chunks from both branches alternating. In that case, set 'collect=false'. A write of 1024 samples will then immediately result in a write of 1024/factor samples to the next writer.
start	Begin decimating from this position in the buffer
probe	Probe

HDecimator() [2/3]

template<class T >

HDecimator< T >::HDecimator	(	HWriterConsumer< T > *	consumer,
		int	factor,
		size_t	blocksize,
		bool	collect = true,
		int	start = 0,
		HProbe< T > *	probe = nullptr
	)

Construct a new HDecimator that handle writer consumers.

Parameters

consumer	The upstream consumer to receive this as a writer
factor	Decimation factor, 1 or larger
blocksize	The expected input and output blocksize
collect	Normally you want to use the same blocksize for alle writers in a chain, but if you are going to use a decimator in a parallel demultiplexed chain (processing IQ data), it is very important to write chunks from both branches alternating. In that case, set 'collect=false'. A write of 1024 samples will then immediately result in a write of 1024/factor samples to the next writer.
start	Begin decimating from this position in the buffer
probe	Probe

HDecimator() [3/3]

template<class T >

HDecimator< T >::HDecimator	(	HReader< T > *	reader,
		int	factor,
		size_t	blocksize,
		bool	collect = true,
		int	start = 0,
		HProbe< T > *	probe = nullptr
	)

Construct a new HDecimator that handle readers.

Parameters

reader	The upstream reader
factor	Decimation factor, 1 or larger
blocksize	The expected input and output blocksize
collect	Normally you want to use the same blocksize for alle readers in a chain, but if you are going to use a decimator in a parallel demultiplexed chain (processing IQ data), it is very important to read chunks from both branches alternating. In that case, set 'collect=false'. Constructing with 'blocksize=1024' then a Read() with 'blocksize=256' will then be expected.
start	Begin decimating from this position in the buffer
probe	Probe

~HDecimator()

template<class T >

HDecimator< T >::~HDecimator

Default destructor

Member Function Documentation

Command()

template<class T >

bool HDecimator< T >::Command ( HCommand *  command )

inlinevirtual

Execute or carry through a command

Implements HReader< T >.

Read()

template<class T >

int HDecimator< T >::Read ( T *  dest, size_t  blocksize  )

virtual

Read a block of samples

Parameters

dest	Destination buffer
blocksize	Number of samples to read

Implements HReader< T >.

SetFactor()

template<class T >

void HDecimator< T >::SetFactor ( int  factor )

inline

Set the decimation factor. Warning: This will reset the buffer position and start collecting samples for a write from position 0 (zero)

Parameters

factor

Decimation factor

SetWriter()

template<class T >

void HDecimator< T >::SetWriter ( HWriter< T > *  writer )

inlinevirtual

Implements HWriterConsumer::SetWriter()

Parameters

writer

Downstream writer

Implements HWriterConsumer< T >.

Start()

template<class T >

bool HDecimator< T >::Start ( )

inlinevirtual

Returns

Call Start() on up- or downstream components

Reimplemented from HReader< T >.

Stop()

template<class T >

bool HDecimator< T >::Stop ( )

inlinevirtual

Returns

Call Stop() on up- or downstream components

Reimplemented from HReader< T >.

Write()

template<class T >

int HDecimator< T >::Write ( T *  src, size_t  blocksize  )

virtual

Write a block of samples

Parameters

src	Source buffer
blocksize	Number of samples to write

Implements HWriter< T >.

---

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

• /home/henrik/Git/Hardt/hardt/libhardt/include/hdecimator.h
• /home/henrik/Git/Hardt/hardt/libhardt/components/hdecimator.cpp