Line data    Source code

       1             : //# RFAFlagCubeBase.h: this defines RFAFlagCubeBase
       2             : //# Copyright (C) 2000,2001
       3             : //# Associated Universities, Inc. Washington DC, USA.
       4             : //#
       5             : //# This library is free software; you can redistribute it and/or modify it
       6             : //# under the terms of the GNU Library General Public License as published by
       7             : //# the Free Software Foundation; either version 2 of the License, or (at your
       8             : //# option) any later version.
       9             : //#
      10             : //# This library is distributed in the hope that it will be useful, but WITHOUT
      11             : //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
      12             : //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
      13             : //# License for more details.
      14             : //#
      15             : //# You should have received a copy of the GNU Library General Public License
      16             : //# along with this library; if not, write to the Free Software Foundation,
      17             : //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
      18             : //#
      19             : //# Correspondence concerning AIPS++ should be addressed as follows:
      20             : //#        Internet email: aips2-request@nrao.edu.
      21             : //#        Postal address: AIPS++ Project Office
      22             : //#                        National Radio Astronomy Observatory
      23             : //#                        520 Edgemont Road
      24             : //#                        Charlottesville, VA 22903-2475 USA
      25             : //#
      26             : //# $Id$
      27             : #ifndef FLAGGING_RFAFLAGCUBEBASE_H
      28             : #define FLAGGING_RFAFLAGCUBEBASE_H
      29             : 
      30             : #include <casacore/casa/Containers/RecordInterface.h>
      31             : #include <flagging/Flagging/RFABase.h> 
      32             : #include <flagging/Flagging/RFFlagCube.h>
      33             : 
      34             : namespace casa { //# NAMESPACE CASA - BEGIN
      35             : 
      36             : // <summary>
      37             : // Abstract RedFlagger Agent class with a flag cube
      38             : // </summary>
      39             : 
      40             : // <use visibility=local>
      41             : 
      42             : // <reviewed reviewer="" date="" tests="" demos="">
      43             : // </reviewed>
      44             : 
      45             : // <prerequisite>
      46             : //   <li> RFFlagCube
      47             : // </prerequisite>
      48             : //
      49             : // <synopsis>
      50             : // RFAFlagCubeBase is derived from RFABase. It includes an RFFlagCube
      51             : // object, which is essentially an [NCHAN,NIFR,NTIME] lattice of flags.
      52             : // Approrpiate vritual methods for managing the cube are defined.
      53             : // </synopsis>
      54             : //
      55             : // <todo asof="2001/04/16">
      56             : //   <li> add this feature
      57             : //   <li> fix this bug
      58             : //   <li> start discussion of this possible extension
      59             : // </todo>
      60             : 
      61             : class RFAFlagCubeBase : public RFABase
      62             : {
      63             : public:
      64             :   RFAFlagCubeBase  ( RFChunkStats &ch,const casacore::RecordInterface &parm );
      65             :   virtual ~RFAFlagCubeBase ();
      66             :   
      67             :   virtual casacore::uInt estimateMemoryUse ();  
      68             :   virtual casacore::Bool newChunk ( casacore::Int &maxmem );
      69             :   virtual void endChunk ();
      70             :   virtual void startData (bool verbose);
      71             :   virtual void startDry (bool verbose);
      72             :   virtual void startFlag (bool verbose);
      73             :   virtual IterMode iterTime (casacore::uInt it);
      74             :   virtual IterMode iterDry  (casacore::uInt it);
      75             :   virtual void iterFlag     (casacore::uInt it);
      76             :   virtual IterMode endData  ();
      77             :   virtual IterMode endDry   ();
      78             : 
      79             :   virtual casacore::String getDesc ();
      80             :   virtual casacore::String getStats ();
      81             :   static const casacore::RecordInterface & getDefaults ();
      82             : 
      83           0 :   virtual casacore::String getID() {return casacore::String("");};
      84             :   
      85             : protected:
      86             : // mask of active correlations. Must be setup somewhere before calling
      87             : // newChunk()
      88             :   RFlagWord   corrmask; 
      89             : // flag cube lattice
      90             :   RFFlagCube  flag;   // flag cube lattice  
      91             : };
      92             : 
      93             : 
      94             : } //# NAMESPACE CASA - END
      95             : 
      96             : #endif