casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
CEMemImageSkyModel.h
Go to the documentation of this file.
00001 //# CEMemImageSkyModel.h: Definition for CEMemImageSkyModel
00002 //# Copyright (C) 1996,1997,1998,1999,2000
00003 //# Associated Universities, Inc. Washington DC, USA.
00004 //#
00005 //# This library is free software; you can redistribute it and/or modify it
00006 //# under the terms of the GNU Library General Public License as published by
00007 //# the Free Software Foundation; either version 2 of the License, or (at your
00008 //# option) any later version.
00009 //#
00010 //# This library is distributed in the hope that it will be useful, but WITHOUT
00011 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00012 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00013 //# License for more details.
00014 //#
00015 //# You should have received a copy of the GNU Library General Public License
00016 //# along with this library; if not, write to the Free Software Foundation,
00017 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00018 //#
00019 //# Correspondence concerning AIPS++ should be adressed as follows:
00020 //#        Internet email: aips2-request@nrao.edu.
00021 //#        Postal address: AIPS++ Project Office
00022 //#                        National Radio Astronomy Observatory
00023 //#                        520 Edgemont Road
00024 //#                        Charlottesville, VA 22903-2475 USA
00025 //#
00026 //#
00027 //# $Id$
00028 
00029 #ifndef SYNTHESIS_CEMEMIMAGESKYMODEL_H
00030 #define SYNTHESIS_CEMEMIMAGESKYMODEL_H
00031 
00032 #include <synthesis/MeasurementComponents/CleanImageSkyModel.h>
00033 namespace casa { //# NAMESPACE CASA - BEGIN
00034 
00035 //forward
00036 class SkyEquation;
00037 class CEMemProgress;
00038 
00039 // <summary> Image Sky Model for the Cornwell-Evens maximum entropy algorithm </summary>
00040 
00041 // <use visibility=export>
00042 
00043 // <reviewed reviewer="" date="" tests="" demos="">
00044 
00045 // <prerequisite>
00046 //   <li> <linkto class=ImageSkyModel>ImageSkyModel</linkto> class
00047 //   <li> <linkto class=CEMemLatModel>CEMemModel</linkto> class
00048 // </prerequisite>
00049 //
00050 // <etymology>
00051 // CEMemImageSkyModel implements the Cornwell-Evens MEM algorithm.
00052 // It is derived from <linkto class=CleanImageSkyModel>CleanImageSkyModel</linkto>.
00053 // </etymology>
00054 //
00055 // <synopsis> 
00056 // We need to add more stuff here.
00057 //
00058 //
00059 //
00060 // Masking is optionally performed using a mask image: only points
00061 // where the mask is non-zero are cleaned. If no mask is specified
00062 // all points in the inner quarter of the image are cleaned.
00063 // </synopsis> 
00064 //
00065 // <example>
00066 // See the example for <linkto class=CleanImageSkyModel>CleanImageSkyModel</linkto>.
00067 // </example>
00068 //
00069 // <motivation>
00070 // </motivation>
00071 //
00072 // <todo asof="99/11/01">
00073 // <ul> Some of the "CleanImageSkyModel" functionality should be moved to "ImageSkyModel"
00074 // <ul> Create another virtual base class, "MemImageSkyModel", derived from "ImageSkyModel"
00075 // <ul> THEN: derive CEMemImageSkyModel from "MemImageSkyModel"
00076 // <ul> However, now we are just doing what works quickly: deriving from CleanImageSkyModel
00077 // </todo>
00078 
00079 class CEMemImageSkyModel : public CleanImageSkyModel {
00080 public:
00081 
00082   // constructor
00083   CEMemImageSkyModel(Float sigma, 
00084                      Float targetFlux,
00085                      Bool constrainFlux,
00086                      const Vector<String>& priors,
00087                      const String& entropy);
00088 
00089   // destructor
00090   ~CEMemImageSkyModel();
00091 
00092   // Solve for this SkyModel
00093   virtual Bool solve (SkyEquation& me);
00094 
00095   // Set control parameters which are different from Clean:
00096   //<group>
00097   void setSigma(const Float targetSigma) {itsSigma = targetSigma; }
00098   void setTargetFlux(const Float targetFlux) {itsTargetFlux = targetFlux; }
00099   void setConstrainTargetFlux(const Bool constrainFlux) { itsConstrainFlux = constrainFlux; }
00100   void setPrior(const Vector<String>& prior) { itsPrior = prior; }
00101   void setEntropy(const String& ent) { itsEntropy = ent; }
00102   //</group>
00103 
00104   // Get the various control parameters which are different from Clean:
00105   //<group>
00106   Float sigma() { return itsSigma; }
00107   Float targetFlux() { return itsTargetFlux; }
00108   Bool constrainFlux() { return itsConstrainFlux; }
00109   Vector<String> prior() { return itsPrior; }
00110   String entropy() { return itsEntropy; }
00111   //</group>
00112 
00113 protected:
00114 
00115   Bool initializeModel() { return itsInitializeModel; }
00116   
00117   Float itsSigma;
00118   Float itsTargetFlux;
00119   Bool itsConstrainFlux;
00120   Vector<String> itsPrior;
00121   String itsEntropy;
00122   Bool itsInitializeModel;
00123 
00124   CEMemProgress *itsProgress;
00125 
00126 };
00127 
00128 
00129 } //# NAMESPACE CASA - END
00130 
00131 #endif
00132 
00133