dp3::steps::UVWFlagger Class Reference

DP3 step class to flag data on UVW coordinates. More...

#include <UVWFlagger.h>

Inheritance diagram for dp3::steps::UVWFlagger:

Public Member Functions
	UVWFlagger (const common::ParameterSet &, const std::string &prefix, MsType inputType)
	~UVWFlagger () 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...
bool	isDegenerate () const
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	showCounts (std::ostream &) const override
	Show the flag counts. More...
void	showTimings (std::ostream &, double duration) const override
	Show the timings. More...
void	updateInfo (const base::DPInfo &) 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...
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 flag data on UVW coordinates.

This class is a Step class flagging data points based on data selections given in the parset file. The following selections can be given:

• minimum and/or maximum UV distance
• minimum or maximum value for U, V, and/or W
• both can be used with a different phase center which can be be given as a position or as a moving source like SUN or JUPITER.

The UVW values can be given in meters or in wavelengths.

Constructor & Destructor Documentation

UVWFlagger()

dp3::steps::UVWFlagger::UVWFlagger	(	const common::ParameterSet &	,
		const std::string &	prefix,
		MsType	inputType
	)

Construct the object. Parameters are obtained from the parset using the given prefix. The antenna names are used to find antenna numbers. The channel frequencies as they are in the input step must be given starting at the start-channel.

~UVWFlagger()

dp3::steps::UVWFlagger::~UVWFlagger ( )

override

Member Function Documentation

accepts()

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

inlineoverridevirtual

Boolean if this step can process this type of data.

Reimplemented from dp3::steps::Step.

finish()

void dp3::steps::UVWFlagger::finish ( )

overridevirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

getProvidedFields()

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

inlineoverridevirtual

Get the fields required by the current step.

Implements dp3::steps::Step.

isDegenerate()

bool dp3::steps::UVWFlagger::isDegenerate ( ) const

inline

outputs()

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

inlineoverridevirtual

Return which datatype this step outputs.

Reimplemented from dp3::steps::Step.

process() [1/2]

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

overridevirtual

Process the BDA data. When processed, it invokes the process function of the next step. It should return False at the end.

Reimplemented from dp3::steps::Step.

process() [2/2]

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

overridevirtual

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

Reimplemented from dp3::steps::Step.

show()

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

overridevirtual

Show the step parameters.

Implements dp3::steps::Step.

showCounts()

void dp3::steps::UVWFlagger::showCounts ( std::ostream &  ) const

overridevirtual

Show the flag counts.

Reimplemented from dp3::steps::Step.

showTimings()

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

overridevirtual

Show the timings.

Reimplemented from dp3::steps::Step.

updateInfo()

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

overridevirtual

Update the general info. It is used to adjust the parms if needed.

Reimplemented from dp3::steps::Step.

---

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

• UVWFlagger.h