DP3 step class to flag data on channel, baseline, or time. More...

#include <PreFlagger.h>

Inheritance diagram for dp3::steps::PreFlagger:

Public Types
enum class	Mode { kSetFlag , kClearFlag , kSetComp , kClearComp }

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

Public Member Functions
	PreFlagger (const common::ParameterSet &, const std::string &prefix)

	~PreFlagger () 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	process (std::unique_ptr< base::DPBuffer > buffer) 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 ()

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...

Friends
class	TestPSet
	Make this Test class a friend, so it can access private code. More...

Additional Inherited Members
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 channel, baseline, or time.

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 (projected baseline length)
minimum and/or maximum baseline length (intrinsic)
autocorrelations or crosscorrelations
baselines using names for antenna 1 and 2
antennae using antenna names
minimum and/or maximum amplitude/phase/real/imag per correlation
channel numbers
frequency ranges
sequence nr or time ranges
LST
azimuth/elevation

The antenna names can contain shell-style wildcards (* ? [] {}).

All selections are ANDed, thus only the data points matching all selections are flagged. It is however, possible to specify a logical expression of selections by means of the internal PSet class. A PSet objects contains a set of ANDed selections. The PSets can be logically combined by the user using the normal logical operators.

Member Enumeration Documentation

◆ Mode

enum dp3::steps::PreFlagger::Mode

strong

Enumerator
kSetFlag
kClearFlag
kSetComp
kClearComp

Constructor & Destructor Documentation

◆ PreFlagger()

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

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

◆ ~PreFlagger()

dp3::steps::PreFlagger::~PreFlagger ( )

override

Member Function Documentation

◆ finish()

void dp3::steps::PreFlagger::finish ( )

overridevirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

◆ getProvidedFields()

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

inlineoverridevirtual

Get the fields required by the current step.

Implements dp3::steps::Step.

◆ process()

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

overridevirtual

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

Reimplemented from dp3::steps::Step.

◆ show()

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

overridevirtual

Show the step parameters.

Implements dp3::steps::Step.

◆ showCounts()

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

overridevirtual

Show the flag counts.

Reimplemented from dp3::steps::Step.

◆ showTimings()

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

overridevirtual

Show the timings.

Reimplemented from dp3::steps::Step.

◆ updateInfo()

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

overridevirtual

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

Reimplemented from dp3::steps::Step.

Friends And Related Function Documentation

◆ TestPSet

friend class TestPSet

friend

Make this Test class a friend, so it can access private code.

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

PreFlagger.h

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Mode

Constructor & Destructor Documentation

◆ PreFlagger()

◆ ~PreFlagger()

Member Function Documentation

◆ finish()

◆ getProvidedFields()

◆ getRequiredFields()

◆ process()

◆ show()

◆ showCounts()

◆ showTimings()

◆ updateInfo()

Friends And Related Function Documentation

◆ TestPSet