SepImageConvolverTask.h

Go to the documentation of this file.
00001 //# Copyright (C) 1996,1997,1998,1999,2000,2001,2002,2003
00002 //# Associated Universities, Inc. Washington DC, USA.
00003 //#
00004 //# This library is free software; you can redistribute it and/or modify it
00005 //# under the terms of the GNU Library General Public License as published by
00006 //# the Free Software Foundation; either version 2 of the License, or (at your
00007 //# option) any later version.
00008 //#
00009 //# This library is distributed in the hope that it will be useful, but WITHOUT
00010 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00011 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00012 //# License for more details.
00013 //#
00014 //# You should have received a copy of the GNU Library General Public License
00015 //# along with this library; if not, write to the Free Software Foundation,
00016 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00017 //#
00018 //# Correspondence concerning AIPS++ should be addressed as follows:
00019 //#        Internet email: aips2-request@nrao.edu.
00020 //#        Postal address: AIPS++ Project Office
00021 //#                        National Radio Astronomy Observatory
00022 //#                        520 Edgemont Road
00023 //#                        Charlottesville, VA 22903-2475 USA
00024 //#
00025 
00026 #ifndef IMAGES_SEPIMAGECONVOLVERTASK_H
00027 #define IMAGES_SEPIMAGECONVOLVERTASK_H
00028 
00029 #include <imageanalysis/ImageAnalysis/ImageTask.h>
00030 
00031 #include <casa/aips.h>
00032 
00033 namespace casa {
00034 
00035 // <summary>
00036 // This class is the high level interface to image convolving
00037 // </summary>
00038 
00039 // <use visibility=export>
00040 
00041 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
00042 // </reviewed>
00043 
00044 // <prerequisite>
00045 //   <li> <linkto class="ImageInterface">ImageInterface</linkto>
00046 //   <li> <linkto class="Convolver">Convolver</linkto>
00047 // </prerequisite>
00048 
00049 // <etymology>
00050 // This class is the high level interface to image convolving
00051 // </etymology>
00052 
00053 // <synopsis>
00054 // This class is the high level interface to image convolving
00055 // </synopsis>
00056 
00057 // <example>
00058 // <srcBlock>
00059 // </srcBlock>
00060 // </example>
00061 
00062 // <motivation>
00063 // Convolution is a standard image processing requirement.
00064 // </motivation>
00065 
00066 // <todo asof="2001/08/28">
00067 //   <li> 
00068 // </todo>
00069 
00070 template <class T> class SepImageConvolverTask : public ImageTask<T> {
00071 public:
00072 
00073         const static String CLASS_NAME;
00074 
00075         SepImageConvolverTask() = delete;
00076 
00077         SepImageConvolverTask(
00078                 const SPCIIT image, const Record *const &regionPtr,
00079             const String& mask, const String& outname, const Bool overwrite
00080         );
00081         
00082     SepImageConvolverTask(const SepImageConvolverTask<T> &other) = delete;
00083 
00084         ~SepImageConvolverTask() {}
00085 
00086         SepImageConvolverTask &operator=(const SepImageConvolverTask<T> &other) = delete;
00087 
00088         SPIIT convolve();
00089 
00090         void setKernels(const Vector<String>& kernels) { _kernels.assign(kernels); }
00091 
00092         void setKernelWidths(const Vector<Quantity>& kernelwidths) { _kernelWidths.assign(kernelwidths); }
00093 
00094         void setScale(Double d) { _scale = d; }
00095 
00096         void setSmoothAxes(const Vector<Int>& axes) { _axes.assign(axes); }
00097 
00098         String getClass() const { return CLASS_NAME; }
00099 
00100 protected:
00101 
00102         CasacRegionManager::StokesControl _getStokesControl() const {
00103                 return CasacRegionManager::USE_ALL_STOKES;
00104         }
00105 
00106     vector<Coordinate::Type> _getNecessaryCoordinates() const {
00107         return vector<Coordinate::Type>();
00108     }
00109 
00110     inline Bool _supportsMultipleRegions() const {return True;}
00111 
00112 private:
00113     Vector<String> _kernels;
00114     Vector<Quantity> _kernelWidths;
00115     Double _scale = 0;
00116     Vector<Int> _axes;
00117 
00118 };
00119 
00120 }
00121 
00122 #ifndef CASACORE_NO_AUTO_TEMPLATES
00123 #include <imageanalysis/ImageAnalysis/SepImageConvolverTask.tcc>
00124 #endif //# CASACORE_NO_AUTO_TEMPLATES
00125 #endif
00126 
00127 
00128 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1