DP3
Public Member Functions | List of all members
dp3::base::BaselineSelection Class Reference

Class containing a few static functions to parse a baseline selection string. More...

#include <BaselineSelection.h>

Public Member Functions

 BaselineSelection ()
 Default constructor has no selection. More...
 
 BaselineSelection (const common::ParameterSet &, const std::string &prefix, bool minmax=false, const std::string &defaultCorrType=std::string(), const std::string &defaultBaseline=std::string())
 
casacore::Matrix< bool > apply (const DPInfo &info) const
 
casacore::Vector< bool > applyVec (const DPInfo &info) const
 
bool hasSelection () const
 Is there any selection? More...
 
void show (std::ostream &os, const std::string &blanks=std::string()) const
 

Detailed Description

Class containing a few static functions to parse a baseline selection string.

Constructor & Destructor Documentation

◆ BaselineSelection() [1/2]

dp3::base::BaselineSelection::BaselineSelection ( )

Default constructor has no selection.

◆ BaselineSelection() [2/2]

dp3::base::BaselineSelection::BaselineSelection ( const common::ParameterSet ,
const std::string &  prefix,
bool  minmax = false,
const std::string &  defaultCorrType = std::string(),
const std::string &  defaultBaseline = std::string() 
)

Construct from the parset using the given prefix. The keys used are:

  • baseline: for a baseline selection (e.g. CS*&)
  • corrtype: for correlation selection (auto, cross, or empty)
  • blrange: ranges of baseline lengths (in m)
  • minbl: minimum baseline length (in m); only if minmax=true
  • maxbl: maximum baseline length (in m); only if minmax=true

Member Function Documentation

◆ apply()

casacore::Matrix<bool> dp3::base::BaselineSelection::apply ( const DPInfo info) const

Form the selection matrix telling for each baseline if it is selected. If no selection is made, all values in the matrix are true.

◆ applyVec()

casacore::Vector<bool> dp3::base::BaselineSelection::applyVec ( const DPInfo info) const

Form the selection vector telling if a baseline in the DPInfo object is selected.

◆ hasSelection()

bool dp3::base::BaselineSelection::hasSelection ( ) const

Is there any selection?

◆ show()

void dp3::base::BaselineSelection::show ( std::ostream &  os,
const std::string &  blanks = std::string() 
) const

Show the parameters. Optional extra blanks can be put before the value.


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