1 | // ----------------------------------------------------------------------- |
---|
2 | // GaussSmooth2D.hh: Definition of GaussSmooth2D class, used to smooth a |
---|
3 | // 2D image with a Gaussian kernel. |
---|
4 | // ----------------------------------------------------------------------- |
---|
5 | // Copyright (C) 2006, Matthew Whiting, ATNF |
---|
6 | // |
---|
7 | // This program is free software; you can redistribute it and/or modify it |
---|
8 | // under the terms of the GNU General Public License as published by the |
---|
9 | // Free Software Foundation; either version 2 of the License, or (at your |
---|
10 | // option) any later version. |
---|
11 | // |
---|
12 | // Duchamp is distributed in the hope that it will be useful, but WITHOUT |
---|
13 | // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
---|
14 | // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
---|
15 | // for more details. |
---|
16 | // |
---|
17 | // You should have received a copy of the GNU General Public License |
---|
18 | // along with Duchamp; if not, write to the Free Software Foundation, |
---|
19 | // Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA |
---|
20 | // |
---|
21 | // Correspondence concerning Duchamp may be directed to: |
---|
22 | // Internet email: Matthew.Whiting [at] atnf.csiro.au |
---|
23 | // Postal address: Dr. Matthew Whiting |
---|
24 | // Australia Telescope National Facility, CSIRO |
---|
25 | // PO Box 76 |
---|
26 | // Epping NSW 1710 |
---|
27 | // AUSTRALIA |
---|
28 | // ----------------------------------------------------------------------- |
---|
29 | #ifndef GAUSSSMOOTH2D_H |
---|
30 | #define GAUSSSMOOTH2D_H |
---|
31 | |
---|
32 | /// @brief How the edges of the array are dealt with |
---|
33 | enum EDGES { EQUALTOEDGE, ///< All pixels are used and treated equally |
---|
34 | SCALEBYCOVERAGE, ///< All pixels are used, but edge pixels are weighted down by the kernel coverage |
---|
35 | TRUNCATE ///< Pixels at edge are set to Blank. |
---|
36 | }; |
---|
37 | |
---|
38 | /// @brief |
---|
39 | /// Define a Gaussian to smooth a 2D array. |
---|
40 | /// @details |
---|
41 | /// A simple class to define a Gaussian kernel that can be used to |
---|
42 | /// smooth a two-dimensional array. |
---|
43 | |
---|
44 | template <class Type> |
---|
45 | class GaussSmooth2D |
---|
46 | { |
---|
47 | public: |
---|
48 | GaussSmooth2D(); ///< Basic constructor: no kernel defined. |
---|
49 | virtual ~GaussSmooth2D(); ///< Destructor |
---|
50 | GaussSmooth2D(const GaussSmooth2D& g); |
---|
51 | GaussSmooth2D& operator=(const GaussSmooth2D& g); |
---|
52 | |
---|
53 | void defaults(); |
---|
54 | |
---|
55 | /// @brief Specific constructor that sets up kernel. |
---|
56 | GaussSmooth2D(float maj, float min, float pa); |
---|
57 | /// @brief Specific constructor that sets up kernel: assuming circular gaussian. |
---|
58 | GaussSmooth2D(float maj); |
---|
59 | |
---|
60 | /// @brief Define the size and the array of coefficients. |
---|
61 | void define(float maj, float min, float pa); |
---|
62 | |
---|
63 | /// @brief Set the size of the kernel |
---|
64 | void setKernelWidth(float width){kernWidth = width;}; |
---|
65 | |
---|
66 | /// @brief Smooth an array with the Gaussian kernel |
---|
67 | Type *smooth(Type *input, int xdim, int ydim, EDGES edgeTreatment=EQUALTOEDGE); |
---|
68 | /// @brief Smooth an array with the Gaussian kernel, using a mask to define blank pixels |
---|
69 | Type *smooth(Type *input, int xdim, int ydim, bool *mask, EDGES edgeTreatment=EQUALTOEDGE); |
---|
70 | |
---|
71 | void setKernMaj(float f){kernMaj=f;}; |
---|
72 | void setKernMin(float f){kernMin=f;}; |
---|
73 | void setKernPA(float f){kernPA=f;}; |
---|
74 | |
---|
75 | Type getKernelPt(int i){return kernel[i];}; |
---|
76 | Type *getKernel(){return kernel;}; |
---|
77 | |
---|
78 | int getKernelWidth(){return kernWidth;}; |
---|
79 | float getStddevScale(){return stddevScale;}; |
---|
80 | |
---|
81 | void setBlankVal(Type b){blankVal = b;}; |
---|
82 | Type getBlankVal(){return blankVal;}; |
---|
83 | |
---|
84 | private: |
---|
85 | float kernMaj; ///< The FWHM of the major axis of the elliptical Gaussian. |
---|
86 | float kernMin; ///< The FWHM of the minor axis of the elliptical Gaussian. |
---|
87 | float kernPA; ///< The position angle of the elliptical Gaussian. |
---|
88 | int kernWidth; ///< The width of the kernel (in pixels). |
---|
89 | float stddevScale; ///< The factor by which the rms of the input array gets scaled by (assuming iid normally) |
---|
90 | Type *kernel; ///< The coefficients of the smoothing kernel |
---|
91 | bool allocated; ///< Have the coefficients been allocated in memory? |
---|
92 | Type blankVal; ///< What value to set blanks (when doing TRUNCATE mode) |
---|
93 | |
---|
94 | }; |
---|
95 | |
---|
96 | #include <duchamp/Utils/GaussSmooth2D.tcc> |
---|
97 | |
---|
98 | #endif // GAUSSSMOOTH2D_H |
---|