dp3::steps::DynSpec Class Reference

DP3 step class that creates visibility averaged dynamic spectra. TODO: (1) Output the weights for each pixel in the spectrum. (2) Select polarizations to output, e.g., only I or instrumental polarizations. More...

#include <DynSpec.h>

Inheritance diagram for dp3::steps::DynSpec:

Public Types
using	DynamicSpectrumTensor = xt::xtensor< float, 4, xt::layout_type::column_major >
Public Types inherited from dp3::steps::Step
enum class	MsType { kRegular , kBda }
	To check compatibility between steps before running. More...
typedef std::shared_ptr< Step >	ShPtr

Public Member Functions
	DynSpec (const common::ParameterSet &, const std::string &prefix)
void	finish () final
	Finish the processing of this step and subsequent steps. More...
common::Fields	getProvidedFields () const final
common::Fields	getRequiredFields () const final
	Get the fields required by the current step. More...
bool	process (std::unique_ptr< base::DPBuffer > buffer) final
void	show (std::ostream &) const final
	Show the step parameters. More...
void	showTimings (std::ostream &, double duration) const final
void	updateInfo (const base::DPInfo &) final
Public Member Functions inherited from dp3::steps::Step
	Step ()
virtual	~Step ()
virtual bool	accepts (MsType dt) const
	Boolean if this step can process this type of data. More...
const base::DPInfo &	getInfoIn () const
	Get access to the info of the input. More...
const base::DPInfo &	getInfoOut () const
	Get access to the info of the output. More...
const Step::ShPtr &	getNextStep () const
	Get the next step. More...
Step *	getPrevStep () const
	Get the previous step. More...
virtual MsType	outputs () const
	Return which datatype this step outputs. More...
virtual bool	process (std::unique_ptr< base::BdaBuffer >)
void	setInfo (const base::DPInfo &)
virtual void	setNextStep (Step::ShPtr nextStep)
	Set the next step. More...
void	setPrevStep (Step *prevStep)
	Set the previous step. More...
virtual void	showCounts (std::ostream &) const

Additional Inherited Members
Static Public Member Functions inherited from dp3::steps::Step
static void	SetThreadingIsInitialized ()
Static Public Attributes inherited from dp3::steps::Step
static constexpr dp3::common::Fields	kDataField
static constexpr dp3::common::Fields	kFlagsField
static constexpr dp3::common::Fields	kUvwField
static constexpr dp3::common::Fields	kWeightsField
Protected Member Functions inherited from dp3::steps::Step
virtual void	addToMS (const std::string &msName)
base::DPInfo &	GetWritableInfoOut ()

Detailed Description

DP3 step class that creates visibility averaged dynamic spectra. TODO: (1) Output the weights for each pixel in the spectrum. (2) Select polarizations to output, e.g., only I or instrumental polarizations.

Member Typedef Documentation

DynamicSpectrumTensor

using dp3::steps::DynSpec::DynamicSpectrumTensor = xt::xtensor<float, 4, xt::layout_type::column_major>

Type for the dynamic spectra, with axes time x frequency x (4) Stokes parameters x direction. The FITS format enforces a column-major layout, hence, we adopt it here as well.

Constructor & Destructor Documentation

DynSpec()

dp3::steps::DynSpec::DynSpec	(	const common::ParameterSet &	,
		const std::string &	prefix
	)

Member Function Documentation

finish()

void dp3::steps::DynSpec::finish ( )

finalvirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

getProvidedFields()

common::Fields dp3::steps::DynSpec::getProvidedFields ( ) const

inlinefinalvirtual

Get the fields provided (modified and/or created) by the current step. The returned fields thus should not include (required) fields that are forwarded without modifications.

Implements dp3::steps::Step.

getRequiredFields()

common::Fields dp3::steps::DynSpec::getRequiredFields ( ) const

inlinefinalvirtual

Get the fields required by the current step.

Implements dp3::steps::Step.

process()

bool dp3::steps::DynSpec::process ( std::unique_ptr< base::DPBuffer >  buffer )

finalvirtual

Process the data. When processed, the step should invoke the process function of the next step with the same buffer as argument.

Returns

False at the end of the input. True if there is more input.

Reimplemented from dp3::steps::Step.

show()

void dp3::steps::DynSpec::show ( std::ostream &  ) const

finalvirtual

Show the step parameters.

Implements dp3::steps::Step.

showTimings()

void dp3::steps::DynSpec::showTimings ( std::ostream &  , double  duration  ) const

finalvirtual

Show the timings. The default implementation does nothing.

Reimplemented from dp3::steps::Step.

updateInfo()

void dp3::steps::DynSpec::updateInfo ( const base::DPInfo &  )

finalvirtual

Update the general info (called by setInfo). The default implementation copies the info.

Reimplemented from dp3::steps::Step.

---

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

• DynSpec.h