/usr/include/casacore/scimath/Mathematics/VectorKernel.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | //# VectorKernel.h: generate Vector kernels
//# Copyright (C) 1996,1997,1998,1999,2000,2001
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//# $Id$
#ifndef SCIMATH_VECTORKERNEL_H
#define SCIMATH_VECTORKERNEL_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/Vector.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class Regex;
class String;
// <summary>
// Make a Vector smoothing kernel from a kernel specification
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class="Vector">Vector</linkto>
// </prerequisite>
// <etymology>
// Returns a vector from a smoothing kernel specification.
// </etymology>
// <synopsis>
// This class takes a smoothing kernel type and a width, and
// generates a Vector holding that kernel. It can be used
// in conjunction with the separable image convolver,
// SepImageConvolver
//
// The kernels can be normalized so that the peak of the
// kernel is 1, or 1/area under the kernel. The latter ensures
// conservation of integrated pixel value (the usual jargon
// is conservation of flux for images) and is the default.
// </synopsis>
// <example>
// <srcBlock>
// </srcBlock>
// </example>
// <motivation>
// </motivation>
// <todo asof="1990/03/31">
// <li>
// </todo>
class VectorKernel
{
public:
enum KernelTypes {
// Box-car smoothing kernel
BOXCAR,
// Gaussian smoothing kernel
GAUSSIAN,
// Hanning smoothing kernel
HANNING,
NKERNELS};
// Create kernel vector for width in pixels. For Gaussian, width is FWHM,
// for Boxcar, width is full width. For Hanning width is ignored.
// If useShapeExactly is True, the provided shape is used exactly.
// If useShapeExactly is False,
// the kernel length will be the max of the provided shape and an
// autoestimate (e.g. from +/- 5sigma limits for a Gaussian).
// <group>
static Vector<Double> make(KernelTypes kernelType, Double width,
uInt shape, Bool useShapeExactly, Bool peakIsUnity=False);
static Vector<Float> make(KernelTypes kernelType, Float width,
uInt shape, Bool useShapeExactly, Bool peakIsUnity=False);
// </group>
// Helper function to convert a string containing a list of desired smoothed kernel types
// to the correct <src>Vector<Int></src> required for the <src>setSmooth</src> function.
// This may be usful if your user interface involves strings rather than integers.
// A new value is added to the output vector (which is resized appropriately) if any of the
// substrings "boxcar", "gaussian" or "hanning" (actually "box", "gauss", and "hann"
// will do) is present.
static Vector<Int> toKernelTypes (const String& kernels,
const Regex& delimiter);
static Vector<Int> toKernelTypes (const Vector<String>& kernels);
static VectorKernel::KernelTypes toKernelType (const String& kernel);
static String fromKernelType (KernelTypes kernelType);
};
} //# NAMESPACE CASACORE - END
#endif
|