Abstract base class of Transformations that convert n-bit to float. More...

#include <Unpacker.h>

Inheritance diagram for dsp::Unpacker:

Classes
class	Iterator
	Interface to Unpacker iterator implementations. More...

Public Types
typedef Registry::List< Unpacker >	Register
	typedef used to simplify template syntax in Unpacker_registry.C

Public Types inherited from dsp::Operation
enum	Function { Producer, Procedural, Structural }
	The function of the operator. More...

Public Member Functions
	Unpacker (const char *name="Unpacker")
	Constructor.

virtual Unpacker *	clone () const
	Clone operator.

virtual bool	get_order_supported (TimeSeries::Order) const
	Return true if the unpacker supports the specified output order. More...

virtual void	set_output_order (TimeSeries::Order)
	Set the order of the dimensions in the output TimeSeries.

virtual bool	get_device_supported (Memory *) const
	Return true if the unpacker can operate on the specified device.

virtual void	set_device (Memory *)
	Set the device on which the unpacker will operate.

virtual bool	matches (const Observation *observation)=0
	Return true if the derived class can convert the Observation. More...

virtual void	match_resolution (Input *)
	Match the unpacker to the resolution of the Input.

virtual unsigned	get_resolution () const
	Return the smallest number of time samples that can be unpacked.

void	prepare ()
	Copy the input attributes to the output.

void	reserve ()
	Reserve the maximum amount of space required in the output.

Iterator	get_iterator (unsigned idig)
	Return the iterator for the specified digitizer.

Public Member Functions inherited from dsp::Transformation< BitSeries, TimeSeries >
	Transformation (const char *_name, Behaviour _type)
	All sub-classes must specify name and capacity for inplace operation.

virtual	~Transformation ()
	Destructor.

void	reserve ()
	Set the size of the output to that of the input by default.

void	set_input (const BitSeries *input)
	Set the container from which input data will be read.

void	set_output (TimeSeries *output)
	Set the container into which output data will be written.

Behaviour	get_type () const
	Return the Transformation type.

virtual void	set_buffering_policy (BufferingPolicy *policy)
	Set the policy for buffering input and/or output data.

bool	has_buffering_policy () const
	Returns true if buffering_policy is set.

BufferingPolicy *	get_buffering_policy () const

void	reset_min_samps ()
	Reset minimum_samps_can_process.

std::string	name (const std::string &function) const
	String preceding output in verbose mode.

virtual void	set_cerr (std::ostream &os) const
	Set verbosity ostream.

Public Member Functions inherited from dsp::Operation
	Operation (const char *name)
	All sub-classes must specify a unique name. More...

	Operation (const Operation &)
	Copy constructor.

virtual	~Operation ()
	Virtual destructor.

virtual bool	operate ()
	Call this method to operate on data Returns false on failure. More...

virtual void	add_extensions (Extensions *)
	Add any extensions.

virtual void	combine (const Operation *)
	Combine accumulated results with another operation. More...

virtual void	report () const
	Report operation statistics.

virtual void	reset ()
	Reset accumulated results to intial values. More...

std::string	get_name () const
	Return the unique name of this operation.

double	get_total_time () const
	Return the total time spent on this Operation in seconds.

double	get_elapsed_time () const
	Get the time spent in the last invocation of operate()

virtual uint64_t	get_total_weights () const
	Return the total number of timesample weights encountered. More...

virtual uint64_t	get_discarded_weights () const
	Return the number of invalid timesample weights encountered.

int	get_id ()
	Inquire the unique instantiation id.

virtual Function	get_function () const
	Get the function classification of this operation.

virtual double	get_delay_time () const
	Get the time delay of this operation, if any, in seconds.

virtual void	set_scratch (Scratch *)
	Set the scratch space.

bool	scratch_was_set () const

virtual uint64_t	bytes_storage () const
	The number of bytes of additional storage used by the operation.

virtual uint64_t	bytes_scratch () const
	The number of bytes of scratch space used by the operation. More...

Public Member Functions inherited from OwnStream
	OwnStream (const OwnStream &)

const OwnStream &	operator= (const OwnStream &)

virtual void	set_cout (std::ostream &) const

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

Public Member Functions inherited from dsp::HasInput< BitSeries >
virtual	~HasInput ()
	Destructor.

const BitSeries *	get_input () const
	Return pointer to the container from which input data will be read.

bool	has_input () const
	Returns true if input is set.

Public Member Functions inherited from dsp::HasOutput< TimeSeries >
virtual	~HasOutput ()
	Destructor.

virtual TimeSeries *	get_output () const
	Return pointer to the container into which output data will be written.

bool	has_output () const
	Returns true if output is set.

Static Public Member Functions
static Unpacker *	create (const Observation *observation)
	Return a pointer to a new instance of the appropriate sub-class.

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
virtual void	transformation ()
	The operation unpacks n-bit into floating point TimeSeries. More...

virtual void	unpack ()=0
	The unpacking routine. More...

virtual void	match (const Observation *observation)
	Specialize the Unpacker for the Observation. More...

template<class T >
const T *	get_Input ()
	Provide BitSeries::input attribute access to derived classes.

Protected Member Functions inherited from dsp::Transformation< BitSeries, TimeSeries >
virtual bool	can_operate ()
	Return false if the input doesn't have enough data to proceed.

virtual void	operation ()
	Define the Operation pure virtual method.

virtual void	vchecks ()
	Makes sure input & output are okay before calling transformation()

Protected Member Functions inherited from dsp::Operation
virtual void	set_name (const std::string &_name)
	Set the name!

int	timers_index (const std::string &op_name)
	Returns the index in the 'timers' array of a particular timer.

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

void	__dereference (bool auto_delete=true) const

Static Protected Member Functions
static Register &	get_register ()
	Return the list of registered sub-classes.

Protected Attributes
TimeSeries::Order	output_order
	The order of the dimensions in the output TimeSeries.

Protected Attributes inherited from dsp::Transformation< BitSeries, TimeSeries >
Reference::To< BufferingPolicy >	buffering_policy
	The buffering policy in place (if any)

int64_t	minimum_samps_can_process
	If input doesn't have this many samples, operate() returns false.

Protected Attributes inherited from dsp::Operation
Scratch *	scratch
	Shared scratch space, if needed.

bool	set_scratch_called

std::string	name
	Operation name.

uint64_t	discarded_weights
	Number of time sample weights encountered that are flagged invalid.

uint64_t	total_weights
	Total number of time sample weights encountered.

RealTimer	optime
	Stop watch records the amount of time spent performing this operation.

int	id
	Unique instantiation id.

bool	prepared
	Set true when preparation optimizations are completed.

Protected Attributes inherited from dsp::HasInput< BitSeries >
Reference::To< const BitSeries >	input
	Container from which input data will be read.

Protected Attributes inherited from dsp::HasOutput< TimeSeries >
Reference::To< TimeSeries >	output
	Container into which output data will be written.

Additional Inherited Members
Public Attributes inherited from dsp::Transformation< BitSeries, TimeSeries >
Callback< Transformation * >	pre_transformation
	Functions called before the transformation takes place.

Callback< Transformation * >	post_transformation
	Functions called after the transformation takes place.

Static Public Attributes inherited from dsp::Operation
static bool	record_time = false
	Global flag enables stopwatch to record the time spent operating. More...

static bool	report_time = true
	Global flag enables report of time spent in operation on descruction. More...

static bool	verbose = false
	Global verbosity flag.

static int	operation_status = 0
	Operations can set this to non-zero in operation() if they fail.

static bool	check_state = true
	Operations should perform internal consistency checks.

static int	instantiation_count = 0
	Counts how many Operation instantiations there have been Used for setting the unique instantiation ID. More...

Detailed Description

Abstract base class of Transformations that convert n-bit to float.

This class is used in conjunction with the File class in order to add new file formats to the baseband/dsp library. Inherit either dsp::Unpacker or one of its derived classes and implement the two pure virtual methods:

bool matches(const Observation* observation)
void unpack()

then register the new class in Unpacker_registry.C.

Member Function Documentation

◆ get_order_supported()

bool dsp::Unpacker::get_order_supported ( TimeSeries::Order order ) const

virtual

Return true if the unpacker supports the specified output order.

Return true if the unpacker support the specified output order.

Reimplemented in dsp::BPSRCrossUnpacker, dsp::LuMPUnpacker, dsp::FloatUnpacker, dsp::BPSRUnpacker, dsp::GMRTFilterbank16, dsp::LOFAR_DALUnpacker, and dsp::SigProcUnpacker.

◆ match()

void dsp::Unpacker::match ( const Observation * observation )

protectedvirtual

Specialize the Unpacker for the Observation.

Specialize the unpacker to the Observation.

Reimplemented in dsp::FadcTwoBitCorrection, dsp::FadcUnpacker, and dsp::S2TwoBitCorrection.

◆ matches()

virtual bool dsp::Unpacker::matches ( const Observation * observation )

pure virtual

Return true if the derived class can convert the Observation.

Derived classes must define the conditions under which they can be used to parse the given data.

◆ transformation()

void dsp::Unpacker::transformation ( )

protectedvirtual

The operation unpacks n-bit into floating point TimeSeries.

Initialize and resize the output before calling unpack.

Implements dsp::Transformation< BitSeries, TimeSeries >.

Reimplemented in dsp::OneBitCorrection.

◆ unpack()

virtual void dsp::Unpacker::unpack ( )

protectedpure virtual

The unpacking routine.

This method must unpack the data from the BitSeries Input into the TimeSeries output.

Implemented in dsp::ExcisionUnpacker, dsp::OneBitCorrection, dsp::BitUnpacker, dsp::GenericEightBitUnpacker, dsp::GenericSixteenBitUnpacker, dsp::MaximUnpacker, dsp::GUPPIFITSUnpacker, dsp::BPSRCrossUnpacker, dsp::LuMPUnpacker, dsp::BPSRUnpacker, dsp::GMRTFilterbank16, dsp::SigProcUnpacker, dsp::VDIFnByteUnpacker, dsp::LWAUnpacker, dsp::Mark5Unpacker, dsp::Mark5bUnpacker, dsp::SixteenBitUnpacker, dsp::ASPUnpacker, dsp::WAPPUnpacker, dsp::FloatUnpacker, dsp::FadcUnpacker, dsp::LOFAR_DALUnpacker, dsp::EDAFourBit, dsp::GUPPIUnpacker, dsp::VDIFTwoBitCorrectionMulti, and dsp::S2TwoBitCorrection.

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

Unpacker.h
Unpacker.C
Unpacker_create.C
Unpacker_registry.C

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes