Line data    Source code

       1             : //# SimACoh.h: Definition for Simulated additive errors
       2             : //# Copyright (C) 1996,1997,1999
       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 adressed 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             : //#
      27             : //# $Id$
      28             : 
      29             : #ifndef SYNTHESIS_SIMACOH_H
      30             : #define SYNTHESIS_SIMACOH_H
      31             : 
      32             : #include <casacore/casa/aips.h>
      33             : #include <casacore/casa/BasicMath/Random.h>
      34             : #include <synthesis/MeasurementComponents/ACoh.h>
      35             : 
      36             : namespace casa { //# NAMESPACE CASA - BEGIN
      37             : 
      38             : // <summary> 
      39             : // SimACoh: Model additive noise errors for the <linkto class="VisEquation">VisEquation</linkto>
      40             : // </summary>
      41             : 
      42             : // <use visibility=export>
      43             : 
      44             : // <reviewed reviewer="" date="" tests="" demos="">
      45             : 
      46             : // <prerequisite>
      47             : //   <li> <linkto module="MeasurementComponents">MeasurementComponents</linkto> module
      48             : //   <li> <linkto class="VisSet">VisSet</linkto> class
      49             : //   <li> <linkto class="VisEquation">VisEquation</linkto> class
      50             : // </prerequisite>
      51             : //
      52             : // <etymology>
      53             : // SimACoh describes random additive errors to be used in
      54             : // the <linkto class="VisEquation">VisEquation</linkto>. 
      55             : // </etymology>
      56             : //
      57             : // <synopsis> 
      58             : //
      59             : // See <linkto class="VisEquation">VisEquation</linkto> for definition of the
      60             : // Visibility Measurement Equation. See <linkto class="ACoh">ACoh</linkto>
      61             : // for how SimACoh is to be used.
      62             : // </synopsis> 
      63             : //
      64             : // <motivation>
      65             : // The properties of an additive component must be described
      66             : // for the <linkto class="VisEquation">VisEquation</linkto>.
      67             : // </motivation>
      68             : //
      69             : // <todo asof="97/10/01">
      70             : // </todo>
      71             : 
      72             : class SimACoh  : public ACoh
      73             : {
      74             : public:
      75             :     // Construct from VisSet, seed and rms of additive noise (normal dist.)
      76             :     SimACoh(casacore::Int seed=1, casacore::Double rms=0.1);
      77             :  
      78             :     // Apply additive error (Inverse is minus)
      79             :     // <group>
      80             :     virtual VisBuffer& apply(VisBuffer& vb);
      81             :     virtual VisBuffer& applyInv(VisBuffer& vb);
      82             :     // </group>
      83             : private:
      84           0 :     casacore::Bool solve(VisEquation& /*ve*/) {return true;}
      85             :     
      86             :     SimACoh();
      87             :     casacore::MLCG rndGen_p;
      88             :     casacore::Normal noiseDist_p;
      89             : };
      90             : 
      91             : 
      92             : } //# NAMESPACE CASA - END
      93             : 
      94             : #endif