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

RFRowClipper: flags rows based on their noise level. More...

#include <RFRowClipper.h>

Inheritance diagram for casa::RFRowClipper:
casa::FlaggerEnums

Public Member Functions

 RFRowClipper (RFChunkStats &chunk, RFFlagCube &flag, casacore::Float clip, casacore::uInt hw=6, casacore::uInt maxp=5)
 construct from a chunk accessor and flag cube. More...
 
 ~RFRowClipper ()
 destructor More...
 
void init (casacore::uInt ni, casacore::uInt nt)
 initialize for an [NI,NT] matrix More...
 
void cleanup ()
 deallocate matrices More...
 
void reset ()
 reset at start of pass More...
 
casacore::Float sigma0 (casacore::uInt ifr, casacore::uInt it)
 returns the current noise estimate More...
 
void setSigma (casacore::uInt ifr, casacore::uInt it, casacore::Float level)
 sets a new noise estimate More...
 
void markSigma (casacore::uInt ifr)
 marks a noise estimate as updated without changing it More...
 
casacore::Float updateSigma (casacore::uInt &ifrmax, casacore::uInt &itmax, casacore::Bool flagrows=true, bool clear_flags=true)
 recompute updated estimates and optionally do row flagging More...
 

Private Attributes

RFChunkStatschunk
 
RFFlagCubeflag
 
casacore::Float clip_level
 
casacore::uInt halfwin
 
casacore::uInt maxpass
 
casacore::uInt nifr
 
casacore::uInt ntime
 
casacore::Matrix< casacore::Floatsig
 
casacore::Matrix< casacore::Floatsig0
 
casacore::Vector< casacore::Boolsigupdated
 
casacore::LogIOos
 

Additional Inherited Members

- Public Types inherited from casa::FlaggerEnums
enum  StatEnums {
  POLZN,
  POL,
  CORR,
  CHAN,
  IFR,
  TIME,
  ROW,
  ANT,
  FEED,
  FEEDCORR,
  NONE,
  Num_StatEnums
}
 
enum  PreFlagPolicy {
  FL_HONOR,
  FL_IGNORE,
  FL_RESET
}
 

Detailed Description

RFRowClipper: flags rows based on their noise level.

Intended use:

Internal

Synopsis

RFRowClipper accumulates per-row noise estimates in an [NIFR,NTIME] matrix. After each pass it performs flagging of rows with excessive noise (w/respect to a sliding median per IFR, over time).

Motivation

Several flagging agents produce per-row noise estimates and can flag based on them. Hence, a commmon implementation was desired.

To Do

Definition at line 65 of file RFRowClipper.h.

Constructor & Destructor Documentation

casa::RFRowClipper::RFRowClipper ( RFChunkStats chunk,
RFFlagCube flag,
casacore::Float  clip,
casacore::uInt  hw = 6,
casacore::uInt  maxp = 5 
)

construct from a chunk accessor and flag cube.

Clip is the clipping level, HW is the sliding median window half-width, MAXP is maximum iterative passes.

casa::RFRowClipper::~RFRowClipper ( )
inline

destructor

Definition at line 73 of file RFRowClipper.h.

Member Function Documentation

void casa::RFRowClipper::cleanup ( )

deallocate matrices

void casa::RFRowClipper::init ( casacore::uInt  ni,
casacore::uInt  nt 
)

initialize for an [NI,NT] matrix

void casa::RFRowClipper::markSigma ( casacore::uInt  ifr)
inline

marks a noise estimate as updated without changing it

Definition at line 116 of file RFRowClipper.h.

References sigupdated.

void casa::RFRowClipper::reset ( )

reset at start of pass

void casa::RFRowClipper::setSigma ( casacore::uInt  ifr,
casacore::uInt  it,
casacore::Float  level 
)
inline

sets a new noise estimate

Definition at line 110 of file RFRowClipper.h.

References sig, and sigupdated.

casacore::Float casa::RFRowClipper::sigma0 ( casacore::uInt  ifr,
casacore::uInt  it 
)
inline

returns the current noise estimate

Definition at line 105 of file RFRowClipper.h.

References sig0.

casacore::Float casa::RFRowClipper::updateSigma ( casacore::uInt ifrmax,
casacore::uInt itmax,
casacore::Bool  flagrows = true,
bool  clear_flags = true 
)

recompute updated estimates and optionally do row flagging

Member Data Documentation

RFChunkStats& casa::RFRowClipper::chunk
private

Definition at line 93 of file RFRowClipper.h.

casacore::Float casa::RFRowClipper::clip_level
private

Definition at line 95 of file RFRowClipper.h.

RFFlagCube& casa::RFRowClipper::flag
private

Definition at line 94 of file RFRowClipper.h.

casacore::uInt casa::RFRowClipper::halfwin
private

Definition at line 96 of file RFRowClipper.h.

casacore::uInt casa::RFRowClipper::maxpass
private

Definition at line 96 of file RFRowClipper.h.

casacore::uInt casa::RFRowClipper::nifr
private

Definition at line 98 of file RFRowClipper.h.

casacore::uInt casa::RFRowClipper::ntime
private

Definition at line 98 of file RFRowClipper.h.

casacore::LogIO& casa::RFRowClipper::os
private

Definition at line 102 of file RFRowClipper.h.

casacore::Matrix<casacore::Float> casa::RFRowClipper::sig
private

Definition at line 99 of file RFRowClipper.h.

Referenced by setSigma().

casacore::Matrix<casacore::Float> casa::RFRowClipper::sig0
private

Definition at line 99 of file RFRowClipper.h.

Referenced by sigma0().

casacore::Vector<casacore::Bool> casa::RFRowClipper::sigupdated
private

Definition at line 100 of file RFRowClipper.h.

Referenced by markSigma(), and setSigma().


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