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

DP3 step that expands BDA data in BdaBuffers to regular data in DPBuffers. More...

#include <BdaExpander.h>

Inheritance diagram for dp3::steps::BdaExpander:
dp3::steps::Step

Public Member Functions

 BdaExpander (const std::string &prefix)
 
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 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::Step
 Step ()
 
virtual ~Step ()
 
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::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< 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
virtual void addToMS (const std::string &msName)
 
base::DPInfoGetWritableInfoOut ()
 

Detailed Description

DP3 step that expands BDA data in BdaBuffers to regular data in DPBuffers.

This class expands bda averaged data to regular data. The averaged data is copied throughout all the timeslots which have been averaged originally. This step doesn't add information, it is just used for backward compatibility to ensure the correct workflow for processing steps which are not yet able to handle BDA data

Constructor & Destructor Documentation

◆ BdaExpander()

dp3::steps::BdaExpander::BdaExpander ( const std::string &  prefix)
explicit

Member Function Documentation

◆ accepts()

bool dp3::steps::BdaExpander::accepts ( MsType  dt) const
inlineoverridevirtual

Boolean if this step can process this type of data.

Reimplemented from dp3::steps::Step.

◆ finish()

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

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

◆ getProvidedFields()

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

Get the fields required by the current step.

Implements dp3::steps::Step.

◆ process()

bool dp3::steps::BdaExpander::process ( std::unique_ptr< base::BdaBuffer )
overridevirtual

Process the data. Reads the data from a BdaBuffer and fills an internal vector of DPBuffer. Gives regular buffer to the next step once all the baselines are available.

Reimplemented from dp3::steps::Step.

◆ show()

void dp3::steps::BdaExpander::show ( std::ostream &  ) const
overridevirtual

Show the step parameters.

Implements dp3::steps::Step.

◆ showTimings()

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

Show the timings. The default implementation does nothing.

Reimplemented from dp3::steps::Step.

◆ updateInfo()

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