dp3::steps::ScaleData Class Reference

DPPP step class for freq-dependent scaling of the data. More...

#include <ScaleData.h>

Inheritance diagram for dp3::steps::ScaleData:

Public Member Functions
	ScaleData (const common::ParameterSet &, const std::string &prefix, MsType input_type)
	~ScaleData () override
bool	accepts (MsType dt) const override
	Boolean if this step can process this type of data. More...
void	finish () override
	Finish the processing of this step and subsequent steps. More...
common::Fields	getProvidedFields () const override
common::Fields	getRequiredFields () const override
	Get the fields required by the current step. More...
MsType	outputs () const override
	Return which datatype this step outputs. More...
bool	process (std::unique_ptr< base::BdaBuffer >) override
bool	process (std::unique_ptr< base::DPBuffer >) override
void	show (std::ostream &) const override
	Show the step parameters. More...
void	showTimings (std::ostream &, double duration) const override
	Show the timings. More...
void	updateInfo (const base::DPInfo &) override
	Update the general info. More...
Public Member Functions inherited from dp3::steps::Step
	Step ()
virtual	~Step ()
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...
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
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
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

DPPP step class for freq-dependent scaling of the data.

This class is a Step class scaling the data using a polynomial in frequency (in MHz) for LBA and HBA. The coefficients can be given as ParSet parameters having a default determined by Adam Deller.

The polynomial coefficients can depend on station by giving them per station name regular expression. The default coefficients are used for the station not matching any regular expression.

The data are multiplied with a factor sqrt(scale[ant1] * scale[ant2]). An extra scale factor can be applied to compensate for the different number of dipoles or tiles or for missing ones. By default that extra scale factor is only applied to stations using the default coefficients, because it is assumed that coefficients are scaled well when specifying them explicitly for stations.

Constructor & Destructor Documentation

ScaleData()

dp3::steps::ScaleData::ScaleData	(	const common::ParameterSet &	,
		const std::string &	prefix,
		MsType	input_type
	)

Construct the object. Parameters are obtained from the parset using the given prefix.

~ScaleData()

dp3::steps::ScaleData::~ScaleData ( )

override

Member Function Documentation

accepts()

bool dp3::steps::ScaleData::accepts ( MsType  dt ) const

inlineoverridevirtual

Boolean if this step can process this type of data.

Reimplemented from dp3::steps::Step.

finish()

void dp3::steps::ScaleData::finish ( )

overridevirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

getProvidedFields()

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

inlineoverridevirtual

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::ScaleData::getRequiredFields ( ) const

inlineoverridevirtual

Get the fields required by the current step.

Implements dp3::steps::Step.

outputs()

MsType dp3::steps::ScaleData::outputs ( ) const

inlineoverridevirtual

Return which datatype this step outputs.

Reimplemented from dp3::steps::Step.

process() [1/2]

bool dp3::steps::ScaleData::process ( std::unique_ptr< base::BdaBuffer >  )

overridevirtual

Process the DBA data. It keeps the data. When processed, it invokes the process function of the next step.

Reimplemented from dp3::steps::Step.

process() [2/2]

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

overridevirtual

Process the data. It keeps the data. When processed, it invokes the process function of the next step.

Reimplemented from dp3::steps::Step.

show()

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

overridevirtual

Show the step parameters.

Implements dp3::steps::Step.

showTimings()

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

overridevirtual

Show the timings.

Reimplemented from dp3::steps::Step.

updateInfo()

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

overridevirtual

Update the general info.

Reimplemented from dp3::steps::Step.

---

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

• ScaleData.h