casacore
UnaryParam.h
Go to the documentation of this file.
1//# UnaryParam.h: Parameter handling for one dimensional unary function
2//# Copyright (C) 2002,2005
3//# Associated Universities, Inc. Washington DC, USA.
4//#
5//# This library is free software; you can redistribute it and/or modify it
6//# under the terms of the GNU Library General Public License as published by
7//# the Free Software Foundation; either version 2 of the License, or (at your
8//# option) any later version.
9//#
10//# This library 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 Library General Public
13//# License for more details.
14//#
15//# You should have received a copy of the GNU Library General Public License
16//# along with this library; if not, write to the Free Software Foundation,
17//# Inc., 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$
27
28#ifndef SCIMATH_UNARYPARAM_H
29#define SCIMATH_UNARYPARAM_H
30
31//# Includes
32#include <casacore/casa/aips.h>
33#include <casacore/scimath/Functionals/Function.h>
34#include <casacore/casa/BasicSL/String.h>
35
36namespace casacore { //# NAMESPACE CASACORE - BEGIN
37
38//# Forward declarations
39
40// <summary> Parameter handling for one dimensional unary function
41// </summary>
42
43// <use visibility=local>
44
45// <reviewed reviewer="" date="" tests="tFunctionHolder"
46// demos="">
47// </reviewed>
48
49// <prerequisite>
50// <li> <linkto class="FunctionParam">FunctionParam</linkto> class
51// <li> <linkto class="Function">Function</linkto> class
52// </prerequisite>
53
54// <etymology>
55// A 1-dimensional unary hat.
56// </etymology>
57
58// <synopsis>
59// A <src>Unary</src> is described by a height, a center and a width
60// (halfwidth). The value is:
61// <srcblock>
62// height (|x-center| < width)
63// 0.5height (|x-center| == width)
64// 0 (|x-center| > width)
65// </srcblock>
66// The parameters are enumerated by HEIGHT, CENTER and WIDTH. They have
67// default values of (1, 0, 1).
68// </synopsis>
69//
70// <example>
71// <srcblock>
72// UnaryFunction<Double> sf(5.0, 25.0, 7);
73// sf(25); // = 5.0
74// </srcblock>
75// </example>
76
77// <templating arg=T>
78// <li> T should have standard numerical operators
79// </templating>
80
81// <thrown>
82// <li> AipsError if incorrect parameter number specified.
83// </thrown>
84
85template<class T> class UnaryParam : public Function<T>
86{
87public:
88 //# Enumerations
89 // Parameter numbers
90 enum { HEIGHT=0, CENTER, WIDTH };
91
92 //# Constructors
93 // Constructs the Unary, Defaults:
94 // height=1, center=0, width=1.
95 // <note role=warning> Could not use default arguments
96 // that worked both with gcc and IRIX </note>
97 // <group>
99 explicit UnaryParam(const T &height);
100 UnaryParam(const T &height, const T &center);
101 UnaryParam(const T &height, const T &center, const T &width);
102 // </group>
103
104 // Copy constructor (deep copy)
105 // <group>
107 template <class W>
108 UnaryParam(const UnaryParam<W> &other) :
109 Function<T>(other) {}
110 // </group>
111
112 // Copy assignment (deep copy)
114
115 // Destructor
116 virtual ~UnaryParam();
117
118 //# Operators
119 virtual uInt ndim() const { return 1; }
120
121 //# Member functions
122 // Give name of function
123 virtual const String &name() const { static String x("unary");
124 return x; }
125
126 //# Make members of parent classes known.
127protected:
128 using Function<T>::param_p;
129public:
130 using Function<T>::nparameters;
131};
132
133
134} //# NAMESPACE CASACORE - END
135
136#ifndef CASACORE_NO_AUTO_TEMPLATES
137#include <casacore/scimath/Functionals/UnaryParam.tcc>
138#endif //# CASACORE_NO_AUTO_TEMPLATES
139#endif
FunctionParam< T > param_p
The parameters and masks.
Definition: Function.h:332
uInt nparameters() const
Returns the number of parameters.
Definition: Function.h:230
String: the storage and methods of handling collections of characters.
Definition: String.h:225
UnaryParam(const T &height, const T &center)
UnaryParam(const UnaryParam< W > &other)
Definition: UnaryParam.h:108
UnaryParam< T > & operator=(const UnaryParam< T > &other)
Copy assignment (deep copy)
UnaryParam(const T &height)
virtual uInt ndim() const
Returns the number of dimensions of function.
Definition: UnaryParam.h:119
virtual const String & name() const
Give name of function.
Definition: UnaryParam.h:123
UnaryParam(const UnaryParam< T > &other)
Copy constructor (deep copy)
virtual ~UnaryParam()
Destructor.
UnaryParam()
Constructs the Unary, Defaults: height=1, center=0, width=1.
UnaryParam(const T &height, const T &center, const T &width)
this file contains all the compiler specific defines
Definition: mainpage.dox:28
unsigned int uInt
Definition: aipstype.h:51