DP3 step reading from multiple MSs. More...
#include <MultiMsReader.h>
Public Member Functions | |
| MultiMsReader (const std::vector< std::string > &msNames, const common::ParameterSet &parset, const std::string &prefix) | |
| ~MultiMsReader () override | |
| void | finish () override |
| Finish the processing of this step and subsequent steps. More... | |
| std::string | msName () const override |
| Returns (only) the name of the first MS. More... | |
| bool | process (std::unique_ptr< base::DPBuffer > buffer) override |
| void | setFieldsToRead (const dp3::common::Fields &fields) override |
| Set which fields must be read. More... | |
| void | show (std::ostream &) const override |
| Show the step parameters. More... | |
| void | showCounts (std::ostream &) const override |
| If needed, show the flag counts. More... | |
| void | showTimings (std::ostream &, double duration) const override |
| Show the timings. More... | |
| const casacore::Table & | table () const override |
| Returns only the first MS table. More... | |
| void | updateInfo (const base::DPInfo &) override |
| Update the general info (by initializing it). More... | |
 Public Member Functions inherited from dp3::steps::InputStep | |
| ~InputStep () override | |
| const dp3::common::Fields & | getFieldsToRead () const |
| Get which fields must be read. More... | |
| common::Fields | getProvidedFields () const override |
| common::Fields | getRequiredFields () const override |
| Get the fields required by the current step. More... | |
| 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... | |
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::InputStep | |
| static std::unique_ptr< InputStep > | CreateReader (const common::ParameterSet &) |
| static bool | HasBda (const casacore::MeasurementSet &ms) |
| 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 reading from multiple MSs.
This class is an InputStep step reading the data from multiple MeasurementSets (MSs) which can be used when the total number of channels has been distributed over multiple MSs. It is therefore important that the shape of all data inside the MSs (visibilities, flags, weights, etc.) is identical except for the channel dimension.
Similar to the MsReader step, the object is constructed from the 'msin' keywords in the parset file. These keywords are identical to those in the MsReader because this class creates a vector of several MsReader steps, where each MsReader is responsible for reading one of the MSs. So, refer to the documentation of the MsReader for the definitions of the 'msin' keywords that can be used for this class. In addition to those keywords, the following can be given:
- msin.orderms: order the MSs on frequency? If yes, all MSs must exist, otherwise they cannot be ordered. If no, the MSs must be given in order of frequency [yes]
- msin.missingdata: allow a non-existing data column in an MS? [no]
Constructor & Destructor Documentation
◆ MultiMsReader()
| dp3::steps::MultiMsReader::MultiMsReader | ( | const std::vector< std::string > & | msNames, |
| const common::ParameterSet & | parset, | ||
| const std::string & | prefix | ||
| ) |
Construct the object for the given MS. Parameters are obtained from the parset using the given prefix.
◆ ~MultiMsReader()
|
override |
Member Function Documentation
◆ finish()
|
overridevirtual |
Finish the processing of this step and subsequent steps.
Implements dp3::steps::Step.
◆ msName()
|
inlineoverridevirtual |
Returns (only) the name of the first MS.
Reimplemented from dp3::steps::InputStep.
◆ process()
|
overridevirtual |
Process the next data chunk. It returns false when at the end.
Reimplemented from dp3::steps::Step.
◆ setFieldsToRead()
|
overridevirtual |
Set which fields must be read.
Reimplemented from dp3::steps::InputStep.
◆ show()
|
overridevirtual |
Show the step parameters.
Implements dp3::steps::Step.
◆ showCounts()
|
overridevirtual |
If needed, show the flag counts.
Reimplemented from dp3::steps::Step.
◆ showTimings()
|
overridevirtual |
Show the timings.
Reimplemented from dp3::steps::Step.
◆ table()
|
inlineoverridevirtual |
Returns only the first MS table.
Reimplemented from dp3::steps::InputStep.
◆ updateInfo()
|
overridevirtual |
Update the general info (by initializing it).
Reimplemented from dp3::steps::Step.
The documentation for this class was generated from the following file:
