Line data    Source code

       1             : //# tSubImage.cc: Test program for class SubImage
       2             : //# Copyright (C) 1998,1999,2000,2001,2003
       3             : //# Associated Universities, Inc. Washington DC, USA.
       4             : //#
       5             : //# This program is free software; you can redistribute it and/or modify it
       6             : //# under the terms of the GNU General Public License as published by the Free
       7             : //# Software Foundation; either version 2 of the License, or (at your option)
       8             : //# any later version.
       9             : //#
      10             : //# This program 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 General Public License for
      13             : //# more details.
      14             : //#
      15             : //# You should have received a copy of the GNU General Public License along
      16             : //# with this program; if not, write to the Free Software Foundation, Inc.,
      17             : //# 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: tSubImage.cc 20567 2009-04-09 23:12:39Z gervandiepen $
      27             : 
      28             : #ifndef IMAGEANALYSIS_PROFILEFITRESULTS_H
      29             : #define IMAGEANALYSIS_PROFILEFITRESULTS_H
      30             : 
      31             : #include <imageanalysis/ImageAnalysis/ImageFit1D.h>
      32             : 
      33             : #include <casacore/casa/namespace.h>
      34             : 
      35             : namespace casa {
      36             : 
      37             : class ProfileFitResults {
      38             :         // <summary>
      39             :         // Class to store results from a ImageFit1D object that ImageProfileFitter needs
      40             :         // </summary>
      41             : 
      42             :         // <reviewed reviewer="" date="" tests="" demos="">
      43             :         // </reviewed>
      44             : 
      45             :         // <prerequisite>
      46             :         // </prerequisite>
      47             : 
      48             :         // <etymology>
      49             :         // Results of a profile fit.
      50             :         // </etymology>
      51             : 
      52             :         // <synopsis>
      53             :         // Class to store results from a ImageFit1D object that ImageProfileFitter needs
      54             :         // </synopsis>
      55             : 
      56             :         // <example>
      57             :         // </example>
      58             : 
      59             : public:
      60             : 
      61             :         ProfileFitResults(const ImageFit1D<casacore::Float>& fitter);
      62             : 
      63       16755 :         ~ProfileFitResults() {};
      64             : 
      65       70397 :         const SpectralList getList() const {return _spectralList; }
      66             : 
      67       44852 :         casacore::Bool converged() const {return _converged; }
      68             : 
      69       24026 :         casacore::uInt getNumberIterations() const { return _iterations; }
      70             : 
      71       34777 :         casacore::Bool isValid() const { return _isValid; }
      72             : 
      73       16755 :     casacore::Bool succeeded() const { return _succeeded; }
      74             : private:
      75             :         SpectralList _spectralList;
      76             :         casacore::Bool _converged, _isValid, _succeeded;
      77             :         casacore::uInt _iterations;
      78             : 
      79             : };
      80             : 
      81             : }
      82             : 
      83             : #endif