dp3::steps::OneApplyCal Class Reference

DP3 step class to apply a calibration correction to the data. More...

#include <OneApplyCal.h>

Inheritance diagram for dp3::steps::OneApplyCal:

Public Member Functions
	OneApplyCal (const common::ParameterSet &, const std::string &prefix, const std::string &defaultPrefix, bool substep=false, std::string predictDirection="")
	~OneApplyCal () override
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...
bool	invert ()
bool	process (std::unique_ptr< base::DPBuffer > buffer) 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 ()
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...

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

DP3 step class to apply a calibration correction to the data.

This class is a Step class applying calibration parameters to the data. It only applies one correction.

Constructor & Destructor Documentation

OneApplyCal()

dp3::steps::OneApplyCal::OneApplyCal	(	const common::ParameterSet &	,
		const std::string &	prefix,
		const std::string &	defaultPrefix,
		bool	substep = false,
		std::string	predictDirection = ""
	)

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

~OneApplyCal()

dp3::steps::OneApplyCal::~OneApplyCal ( )

override

Member Function Documentation

finish()

void dp3::steps::OneApplyCal::finish ( )

overridevirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

getProvidedFields()

common::Fields dp3::steps::OneApplyCal::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::OneApplyCal::getRequiredFields ( ) const

inlineoverridevirtual

Get the fields required by the current step.

Implements dp3::steps::Step.

invert()

bool dp3::steps::OneApplyCal::invert ( )

inline

process()

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

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::OneApplyCal::show ( std::ostream &  ) const

overridevirtual

Show the step parameters.

Implements dp3::steps::Step.

showTimings()

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

overridevirtual

Show the timings.

Reimplemented from dp3::steps::Step.

updateInfo()

void dp3::steps::OneApplyCal::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:

• OneApplyCal.h