Detects phase-coherent TimeSeries data. More...

#include <Detection.h>

Inheritance diagram for dsp::Detection:

Public Member Functions
	Detection ()
	Constructor.

void	prepare ()
	Prepare the output TimeSeries attributes.

void	set_output_state (Signal::State _state)
	Set the state of the output data. More...

Signal::State	get_output_state () const
	Get the state of the output data.

void	set_output_ndim (int _ndim)
	Set the dimension of the output data.

bool	get_output_ndim () const
	Get the dimension of the output data.

bool	get_order_supported (TimeSeries::Order) const
	Return true if the specified input data order can be supported.

void	set_engine (Engine *)

Public Member Functions inherited from dsp::Transformation< TimeSeries, 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 TimeSeries *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< TimeSeries >
virtual	~HasInput ()
	Destructor.

const TimeSeries *	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.

Protected Member Functions
virtual void	transformation ()
	Detect the input data.

void	get_result_pointers (unsigned ichan, bool inplace, float *r[4])
	Called by polarimetry to return pointers to the result channels.

void	square_law ()
	Perform simple square-law detection.

void	polarimetry ()
	Polarization detection (Stokes parameters or Coherency products)

void	resize_output ()
	Set the state of the output TimeSeries.

void	checks ()
	Throws an Error if something is wrong.

void	onepol_detect ()
	Quick and dirty method for detecting to PP or QQ.

Protected Member Functions inherited from dsp::Transformation< TimeSeries, 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

Protected Attributes
Signal::State	state
	Signal::State of the output data.

int	ndim
	Dimension of the output data.

Reference::To< Engine >	engine
	Interface to alternate processing engine (e.g. GPU)

Protected Attributes inherited from dsp::Transformation< TimeSeries, 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< TimeSeries >
Reference::To< const TimeSeries >	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 Types inherited from dsp::Operation
enum	Function { Producer, Procedural, Structural }
	The function of the operator. More...

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 ()

Public Attributes inherited from dsp::Transformation< TimeSeries, 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

Detects phase-coherent TimeSeries data.

The Detection class may be used to perform simple square law detection or calculation of the Stokes parameters or the coherency matrix. In the case of Stokes/Coherency formation, the components may be stored in polarization-major order or time-major order, or a mixture of the two by calling set_output_ndim() with an argument of 4, 1, or 2, respectively. The three methods require different amounts of RAM and therefore result in performance benefits that are largely cache-dependent.

It is recommended that both set_output_ndim and set_output_state are called.

Member Function Documentation

◆ set_output_state()

void dsp::Detection::set_output_state ( Signal::State _state )

Set the state of the output data.

Set the state of output data.

References Signal::Coherence, Signal::Intensity, Signal::NthPower, Signal::PP_State, Signal::PPQQ, Signal::QQ_State, and Signal::Stokes.

Referenced by dsp::LoadToFITS::construct(), and dsp::LoadToFil::construct().

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

Detection.h
Detection.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ set_output_state()