casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ImageTotalPolarization.h
Go to the documentation of this file.
1 //# Copyright (C) 1996,1997,1998,1999,2000,2001,2002
2 //# Associated Universities, Inc. Washington DC, USA.
3 //#
4 //# This library is free software; you can redistribute it and/or modify it
5 //# under the terms of the GNU Library General Public License as published by
6 //# the Free Software Foundation; either version 2 of the License, or (at your
7 //# option) any later version.
8 //#
9 //# This library is distributed in the hope that it will be useful, but WITHOUT
10 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12 //# License for more details.
13 //#
14 //# You should have received a copy of the GNU Library General Public License
15 //# along with this library; if not, write to the Free Software Foundation,
16 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
17 //#
18 //# Correspondence concerning AIPS++ should be addressed as follows:
19 //# Internet email: aips2-request@nrao.edu.
20 //# Postal address: AIPS++ Project Office
21 //# National Radio Astronomy Observatory
22 //# 520 Edgemont Road
23 //# Charlottesville, VA 22903-2475 USA
24 //#
25 
26 #ifndef IMAGEANALYSIS_IMAGETOTALPOLARIZATION_H
27 #define IMAGEANALYSIS_IMAGETOTALPOLARIZATION_H
28 
30 
31 namespace casa {
32 
33 // <summary>
34 // Compute total polarization intensity
35 // </summary>
36 
37 // <use visibility=export>
38 
39 // <prerequisite>
40 // <li> <linkto class=casacore::ImageExpr>ImageExpr</linkto>
41 // <li> <linkto class=casacore::ImageInterface>ImageInterface</linkto>
42 // </prerequisite>
43 
44 // <etymology>
45 // Polarimetric analysis of Images
46 // </etymology>
47 
48 // <synopsis>
49 
50 // </synopsis>
51 //
52 // <motivation>
53 // Basic image analysis capability
54 // </motivation>
55 
56 // <todo asof="1999/11/01">
57 // </todo>
58 
60 public:
61 
62  ImageTotalPolarization() = delete;
63 
65  const SPCIIF image, const casacore::String& outname,
66  casacore::Bool overwrite
67  );
68 
69  virtual ~ImageTotalPolarization();
70 
71  String getClass() const;
72 
73  void setClip(casacore::Float clip);
74 
75  void setDebias(casacore::Bool debias);
76 
77  void setSigma(casacore::Float sigma);
78 
79  SPIIF compute();
80 
81 private:
85 
86  const static String CLASS_NAME;
87 
89 
90 };
91 
92 }
93 
94 #endif
void setClip(casacore::Float clip)
Hold mathematical expressions involving ImageInterface objects.
Definition: WCLELMask.h:46
void setSigma(casacore::Float sigma)
std::shared_ptr< const casacore::ImageInterface< casacore::Float > > SPCIIF
Definition: ImageTypedefs.h:50
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42
float Float
Definition: aipstype.h:54
const Bool False
Definition: aipstype.h:44
std::shared_ptr< casacore::ImageInterface< casacore::Float > > SPIIF
Definition: ImageTypedefs.h:51
String: the storage and methods of handling collections of characters.
Definition: String.h:223
casacore::ImageExpr< Float > _totPolInt()
void setDebias(casacore::Bool debias)
Begin moving polarization tasks to ImageTask framework.
Definition: ImagePolTask.h:83
Compute total polarization intensity.