casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Private Attributes | List of all members
casa::vi::AveragingOptions Class Reference

AveragingOptions. More...

#include <AveragingVi2Factory.h>

Public Types

enum  Options {
  Nothing,
  AverageObserved,
  AverageModel,
  AverageCorrected,
  AverageFloat,
  ObservedPlainAvg,
  ObservedFlagAvg,
  ObservedWeightAvgFromSIGMA,
  ObservedFlagWeightAvgFromSIGMA,
  ModelPlainAvg,
  ModelFlagAvg,
  ModelWeightAvgFromWEIGHT,
  ModelWeightAvgFromSIGMA,
  ModelFlagWeightAvgFromWEIGHT,
  ModelFlagWeightAvgFromSIGMA,
  CorrectedPlainAvg,
  CorrectedFlagAvg,
  CorrectedWeightAvgFromWEIGHT,
  CorrectedFlagWeightAvgFromWEIGHT,
  BaselineDependentAveraging,
  phaseShifting,
  MarksLast
}
 

Public Member Functions

 AveragingOptions ()
 
 AveragingOptions (casacore::Int options)
 
 AveragingOptions (Options o)
 
AveragingOptions operator& (const AveragingOptions &other) const
 
AveragingOptions operator| (const AveragingOptions &other) const
 
AveragingOptionsoperator|= (const AveragingOptions &other)
 
AveragingOptionsoperator|= (Options options)
 
AveragingOptions operator~ () const
 
casacore::Bool contains (Options o) const
 
casacore::Int nSet (casacore::Int o) const
 

Private Attributes

Options options_p
 

Detailed Description

AveragingOptions.

A container for the options that can be specified when creating an AveragingTvi2 based VI. The user can specify which of the data cubes (observed, model and corrected) are to be averaged. The source of the weights applied to each cube can also be specified. See enum Options below for the symbols to use; the symbols are usually combined using bitwise-and ("|") in the constructor.

Definition at line 28 of file AveragingVi2Factory.h.

Member Enumeration Documentation

Enumerator
Nothing 
AverageObserved 
AverageModel 
AverageCorrected 
AverageFloat 
ObservedPlainAvg 
ObservedFlagAvg 
ObservedWeightAvgFromSIGMA 
ObservedFlagWeightAvgFromSIGMA 
ModelPlainAvg 
ModelFlagAvg 
ModelWeightAvgFromWEIGHT 
ModelWeightAvgFromSIGMA 
ModelFlagWeightAvgFromWEIGHT 
ModelFlagWeightAvgFromSIGMA 
CorrectedPlainAvg 
CorrectedFlagAvg 
CorrectedWeightAvgFromWEIGHT 
CorrectedFlagWeightAvgFromWEIGHT 
BaselineDependentAveraging 
phaseShifting 

Requires specifying a max uvw distance parameter.

MarksLast 

Definition at line 32 of file AveragingVi2Factory.h.

Constructor & Destructor Documentation

casa::vi::AveragingOptions::AveragingOptions ( )
inline

Definition at line 57 of file AveragingVi2Factory.h.

Referenced by operator&(), operator|(), operator|=(), and operator~().

casa::vi::AveragingOptions::AveragingOptions ( casacore::Int  options)
inline

Definition at line 58 of file AveragingVi2Factory.h.

casa::vi::AveragingOptions::AveragingOptions ( Options  o)
inlineexplicit

Definition at line 59 of file AveragingVi2Factory.h.

Member Function Documentation

casacore::Bool casa::vi::AveragingOptions::contains ( Options  o) const
inline

Definition at line 90 of file AveragingVi2Factory.h.

References options_p.

casacore::Int casa::vi::AveragingOptions::nSet ( casacore::Int  o) const
inline

Definition at line 93 of file AveragingVi2Factory.h.

References MarksLast, casacore::mask(), and options_p.

AveragingOptions casa::vi::AveragingOptions::operator& ( const AveragingOptions other) const
inline

Definition at line 61 of file AveragingVi2Factory.h.

References AveragingOptions(), and options_p.

AveragingOptions casa::vi::AveragingOptions::operator| ( const AveragingOptions other) const
inline

Definition at line 66 of file AveragingVi2Factory.h.

References AveragingOptions(), and options_p.

AveragingOptions& casa::vi::AveragingOptions::operator|= ( const AveragingOptions other)
inline

Definition at line 71 of file AveragingVi2Factory.h.

References AveragingOptions(), and options_p.

AveragingOptions& casa::vi::AveragingOptions::operator|= ( Options  options)
inline

Definition at line 78 of file AveragingVi2Factory.h.

References AveragingOptions(), and options_p.

AveragingOptions casa::vi::AveragingOptions::operator~ ( ) const
inline

Definition at line 85 of file AveragingVi2Factory.h.

References AveragingOptions(), and options_p.

Member Data Documentation

Options casa::vi::AveragingOptions::options_p
private

Definition at line 110 of file AveragingVi2Factory.h.

Referenced by contains(), nSet(), operator&(), operator|(), operator|=(), and operator~().


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