DP3
Public Member Functions | List of all members
dp3::steps::Transfer Class Referencefinal

DP3 step class to transfer visbility data and flags from a lower to a MS with higher time/freq resolution. More...

#include <Transfer.h>

Inheritance diagram for dp3::steps::Transfer:
dp3::steps::Step

Public Member Functions

 Transfer (const common::ParameterSet &parameter_set, const std::string &prefix)
 
void finish () final
 Finish the processing of this step and subsequent steps. More...
 
common::Fields getProvidedFields () const final
 
common::Fields getRequiredFields () const final
 Get the fields required by the current step. More...
 
bool process (std::unique_ptr< base::DPBuffer > buffer) final
 
void show (std::ostream &) const final
 Show the step parameters. More...
 
void showTimings (std::ostream &, double duration) const final
 
void updateInfo (const base::DPInfo &) final
 
- 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...
 
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 class to transfer visbility data and flags from a lower to a MS with higher time/freq resolution.

This class is a Step class for extrapolating visibilities and flags recorded at lower time and/or frequency resolution to a higher resolution MS. This is achieved by buffering the low-resolution data for a number of time slots and channels depending on the time interval and channel width of the source and target MS, and subsequently writing these to DPBuffer. Additionally, a Filter sub-step can be used to transfer data to a MS that, e.g., contains more baselines than the source MS.

Constructor & Destructor Documentation

◆ Transfer()

dp3::steps::Transfer::Transfer ( const common::ParameterSet parameter_set,
const std::string &  prefix 
)
explicit

Construct the object using parameter values from the parset, using the given prefix.

Member Function Documentation

◆ finish()

void dp3::steps::Transfer::finish ( )
finalvirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

◆ getProvidedFields()

common::Fields dp3::steps::Transfer::getProvidedFields ( ) const
inlinefinalvirtual

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::Transfer::getRequiredFields ( ) const
inlinefinalvirtual

Get the fields required by the current step.

Implements dp3::steps::Step.

◆ process()

bool dp3::steps::Transfer::process ( std::unique_ptr< base::DPBuffer buffer)
finalvirtual

Process the data. When processed, the step should invoke the process function of the next step with the same buffer as argument.

Returns
False at the end of the input. True if there is more input.

Reimplemented from dp3::steps::Step.

◆ show()

void dp3::steps::Transfer::show ( std::ostream &  ) const
finalvirtual

Show the step parameters.

Implements dp3::steps::Step.

◆ showTimings()

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

Show the timings. The default implementation does nothing.

Reimplemented from dp3::steps::Step.

◆ updateInfo()

void dp3::steps::Transfer::updateInfo ( const base::DPInfo )
finalvirtual

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: