DP3
Public Member Functions | List of all members
dp3::steps::AOFlaggerStep Class Reference

DPPP step class to flag using aoflagger's functionality. More...

#include <AOFlaggerStep.h>

Inheritance diagram for dp3::steps::AOFlaggerStep:
dp3::steps::Step

Public Member Functions

 AOFlaggerStep (const common::ParameterSet &, const std::string &prefix)
 
 ~AOFlaggerStep () override
 
void addToMS (const std::string &msName) override
 Write the statistics into the MS. 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 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 flagger 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::DPInfogetInfoIn () const
 Get access to the info of the input. More...
 
const base::DPInfogetInfoOut () const
 Get access to the info of the output. More...
 
const Step::ShPtrgetNextStep () const
 Get the next step. More...
 
StepgetPrevStep () 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< StepShPtr
 
- 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
base::DPInfoGetWritableInfoOut ()
 

Detailed Description

DPPP step class to flag using aoflagger's functionality.

This class is a Step class flagging data points based on the aoflagger library written by Andre Offringa. See the following papers for background information:

When a correlation is flagged, all correlations for that data point are flagged. It is possible to specify which correlations have to be taken into account when flagging. Using, say, only XX may boost performance with a factor 4, but miss points to be flagged. It is also possible to specify the order in which the correlations have to be tested.

It is possible to flag specific baselines only using a selection on baseline length.
Furthermore it is possible to only flag the autocorrelations and apply the resulting flags to the crosscorrelations, possibly selected on baseline length.

Constructor & Destructor Documentation

◆ AOFlaggerStep()

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

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

◆ ~AOFlaggerStep()

dp3::steps::AOFlaggerStep::~AOFlaggerStep ( )
override

Member Function Documentation

◆ addToMS()

void dp3::steps::AOFlaggerStep::addToMS ( const std::string &  msName)
overridevirtual

Write the statistics into the MS.

Reimplemented from dp3::steps::Step.

◆ finish()

void dp3::steps::AOFlaggerStep::finish ( )
overridevirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

◆ getProvidedFields()

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

Get the fields required by the current step.

Implements dp3::steps::Step.

◆ process()

bool dp3::steps::AOFlaggerStep::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::AOFlaggerStep::show ( std::ostream &  ) const
overridevirtual

Show the step parameters.

Implements dp3::steps::Step.

◆ showCounts()

void dp3::steps::AOFlaggerStep::showCounts ( std::ostream &  ) const
overridevirtual

Show the flagger counts.

Reimplemented from dp3::steps::Step.

◆ showTimings()

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

Show the timings.

Reimplemented from dp3::steps::Step.

◆ updateInfo()

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