dp3::steps::OnePredict Class Reference

Step class that predicts visibilities with optionally beam. The Predict class uses one or more instances of this class for predicting data with different regular shapes. More...

#include <OnePredict.h>

Inheritance diagram for dp3::steps::OnePredict:

Public Member Functions
	OnePredict (const common::ParameterSet &, const std::string &prefix, const std::vector< std::string > &source_patterns)
	~OnePredict () override
void	finish () override
	Finish the processing of this step and subsequent steps. More...
base::Direction	GetFirstDirection () const override
	Return the direction of the first patch. More...
common::Fields	getProvidedFields () const override
common::Fields	getRequiredFields () const override
	Get the fields required by the current step. More...
bool	process (std::unique_ptr< base::DPBuffer >) override
void	SetApplyCal (const common::ParameterSet &, const std::string &prefix)
	Set the ApplyCal substep and connect it to a ResultStep. More...
void	SetOperation (const std::string &type)
	Set the operation type. More...
void	setSources (const std::vector< std::string > &sourcePatterns)
	Prepare the sources. More...
void	SetThreadData (std::mutex *measures_mutex)
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::ModelDataStep
common::Fields	getProvidedFields () const override
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
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

Step class that predicts visibilities with optionally beam. The Predict class uses one or more instances of this class for predicting data with different regular shapes.

Constructor & Destructor Documentation

OnePredict()

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

Constructs the object.

Parameters

parset	Parameter set with settings for the step.
prefix	Prefix for reading settings from 'parset'.
sourceList	Direction names. If empty, obtain sources from the parset

~OnePredict()

dp3::steps::OnePredict::~OnePredict ( )

override

Member Function Documentation

finish()

void dp3::steps::OnePredict::finish ( )

overridevirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

GetFirstDirection()

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

overridevirtual

Return the direction of the first patch.

Implements dp3::steps::ModelDataStep.

getProvidedFields()

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

inlineoverridevirtual

Get the fields required by the current step.

Implements dp3::steps::Step.

process()

bool dp3::steps::OnePredict::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.

SetApplyCal()

void dp3::steps::OnePredict::SetApplyCal	(	const common::ParameterSet &	,
		const std::string &	prefix
	)

Set the ApplyCal substep and connect it to a ResultStep.

SetOperation()

void dp3::steps::OnePredict::SetOperation

(

const std::string &

type

)

Set the operation type.

setSources()

void dp3::steps::OnePredict::setSources

(

const std::vector< std::string > &

sourcePatterns

)

Prepare the sources.

SetThreadData()

void dp3::steps::OnePredict::SetThreadData ( std::mutex *  measures_mutex )

inline

When multiple OnePredict steps are running in parallel from multiple threads, they require synchronisation. This is done with this mutex. When multiple Predicts steps run serially (like currently in H5ParmPredict), this function should not be called, as otherwise they will synchronize needlessly.

show()

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

overridevirtual

Show the step parameters.

Implements dp3::steps::Step.

showTimings()

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

overridevirtual

Show the timings.

Reimplemented from dp3::steps::Step.

updateInfo()

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

• OnePredict.h