dp3::steps::BdaGroupPredict Class Reference

DP3 step class to predict BDA visibilities from a source model. More...

#include <BdaGroupPredict.h>

Inheritance diagram for dp3::steps::BdaGroupPredict:

Public Member Functions
	BdaGroupPredict (const common::ParameterSet &, const std::string &prefix)
	BdaGroupPredict (const common::ParameterSet &, const std::string &prefix, const std::vector< std::string > &source_patterns)
	~BdaGroupPredict () 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...
base::Direction	GetFirstDirection () 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
void	show (std::ostream &) const override
	Show the step parameters. More...
void	showTimings (std::ostream &, double duration) const override
void	updateInfo (const base::DPInfo &) override
Public Member Functions inherited from dp3::steps::ModelDataStep
common::Fields	getProvidedFields () const override
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...
virtual bool	process (std::unique_ptr< base::DPBuffer > buffer)
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

DP3 step class to predict BDA visibilities from a source model.

Author

Sebastiaan van der Tol

Constructor & Destructor Documentation

BdaGroupPredict() [1/2]

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

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

BdaGroupPredict() [2/2]

dp3::steps::BdaGroupPredict::BdaGroupPredict	(	const common::ParameterSet &	,
		const std::string &	prefix,
		const std::vector< std::string > &	source_patterns
	)

Constructs the object with explicit source patterns.

Parameters

input_step	Input step, for reading extra data.
parset	Parameter set with settings for the step.
prefix	Prefix for reading settings from 'parset'.
source_patterns	Source patterns.

~BdaGroupPredict()

dp3::steps::BdaGroupPredict::~BdaGroupPredict ( )

override

Member Function Documentation

accepts()

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

inlineoverridevirtual

Boolean if this step can process this type of data.

Reimplemented from dp3::steps::Step.

finish()

void dp3::steps::BdaGroupPredict::finish ( )

overridevirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

GetFirstDirection()

base::Direction dp3::steps::BdaGroupPredict::GetFirstDirection ( ) const

overridevirtual

Returns

The direction of the first patch.

Implements dp3::steps::ModelDataStep.

getRequiredFields()

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

overridevirtual

Get the fields required by the current step.

Implements dp3::steps::Step.

outputs()

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

inlineoverridevirtual

Return which datatype this step outputs.

Reimplemented from dp3::steps::Step.

process()

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

overridevirtual

Processes the data. Buffers incoming BdaBuffers in a queue and sends them to the the next step when all baseline groups are complete. This is necessary because baseline groups may overlap multiple BdaBuffers, while the predict is done by calls to the Predict step, which needs complete baseline groups.

Reimplemented from dp3::steps::Step.

show()

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

overridevirtual

Show the step parameters.

Implements dp3::steps::Step.

showTimings()

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

overridevirtual

Show the timings. The default implementation does nothing.

Reimplemented from dp3::steps::Step.

updateInfo()

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

overridevirtual

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:

• BdaGroupPredict.h