casacore
Public Types | Public Member Functions | List of all members
casacore::UnaryParam< T > Class Template Reference

Parameter handling for one dimensional unary function. More...

#include <UnaryParam.h>

Public Types

enum  {
  HEIGHT,
  CENTER,
  WIDTH
}
 Parameter numbers. More...
 
- Public Types inherited from casacore::Function< T >
typedef FunctionTraits< T >::ArgType ArgType
 

Public Member Functions

 UnaryParam ()
 Constructs the Unary, Defaults: height=1, center=0, width=1. More...
 
 UnaryParam (const T &height)
 
 UnaryParam (const T &height, const T &center)
 
 UnaryParam (const T &height, const T &center, const T &width)
 
 UnaryParam (const UnaryParam< T > &other)
 Copy constructor (deep copy) More...
 
template<class W >
 UnaryParam (const UnaryParam< W > &other)
 
UnaryParam< T > & operator= (const UnaryParam< T > &other)
 Copy assignment (deep copy) More...
 
virtual ~UnaryParam ()
 Destructor. More...
 
virtual uInt ndim () const
 
virtual const Stringname () const
 Give name of function. More...
 
- Public Member Functions inherited from casacore::Function< T >
 Function ()
 Constructors. More...
 
 Function (const uInt n)
 
 Function (const Vector< T > &in)
 
 Function (const FunctionParam< T > &other)
 
 Function (const Function< W, X > &other)
 
 Function (const Function< T, T > &other)
 
virtual ~Function ()
 Destructor. More...
 
virtual uInt ndim () const=0
 Returns the number of dimensions of function. More...
 
uInt nparameters () const
 Returns the number of parameters. More...
 
virtual T eval (FunctionArg x) const=0
 Evaluate the function object. More...
 
T & operator[] (const uInt n)
 Manipulate the nth parameter (0-based) with no index check. More...
 
const T & operator[] (const uInt n) const
 
virtual T operator() () const
 Evaluate this function object at xor at x, y. More...
 
virtual T operator() (const ArgType &x) const
 
virtual T operator() (const Vector< ArgType > &x) const
 
virtual T operator() (FunctionArg x) const
 
virtual T operator() (const ArgType &x, const ArgType &y) const
 
virtual T operator() (const ArgType &x, const ArgType &y, const ArgType &z) const
 
virtual const Stringname () const
 Specify the name associated with the function (default will be unknown) More...
 
Boolmask (const uInt n)
 Manipulate the mask associated with the nth parameter (e.g. More...
 
const Boolmask (const uInt n) const
 
const FunctionParam< T > & parameters () const
 Return the parameter interface. More...
 
FunctionParam< T > & parameters ()
 
const Vector< ArgType > & argp () const
 Get arg_p and parset_p. More...
 
Bool parsetp () const
 
void lockParam ()
 Compiler cannot always find the correct 'const' version of parameter access. More...
 
void unlockParam ()
 
virtual void setMode (const RecordInterface &mode)
 get/set the function mode. More...
 
virtual void getMode (RecordInterface &mode) const
 
virtual Bool hasMode () const
 return True if the implementing function supports a mode. More...
 
ostream & print (ostream &os) const
 Print the function (i.e. More...
 
virtual Function< T, T > * clone () const=0
 Return a copy of this object from the heap. More...
 
virtual Function< typename FunctionTraits< T >::DiffType > * cloneAD () const
 
virtual Function< typename FunctionTraits< T >::BaseType > * cloneNonAD () const
 

Additional Inherited Members

- Public Attributes inherited from casacore::Function< T >
const typedef ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Function< T >
FunctionParam< T > param_p
 The parameters and masks. More...
 
Vector< ArgTypearg_p
 Aid for non-contiguous argument storage. More...
 
Bool parset_p
 Indicate parameter written. More...
 
Bool locked_p
 Indicate that parameters are expected to be locked from changing. More...
 

Detailed Description

template<class T>
class casacore::UnaryParam< T >

Parameter handling for one dimensional unary function.

Intended use:

Internal

Review Status

Test programs:
tFunctionHolder

Prerequisite

Etymology

A 1-dimensional unary hat.

Synopsis

A Unary is described by a height, a center and a width (halfwidth). The value is:

height (|x-center| < width)
0.5height (|x-center| == width)
0 (|x-center| > width)

The parameters are enumerated by HEIGHT, CENTER and WIDTH. They have default values of (1, 0, 1).

Example

UnaryFunction<Double> sf(5.0, 25.0, 7);
sf(25); // = 5.0

Template Type Argument Requirements (T)

Thrown Exceptions

Definition at line 85 of file UnaryParam.h.

Member Enumeration Documentation

◆ anonymous enum

template<class T >
anonymous enum

Parameter numbers.

Enumerator
HEIGHT 
CENTER 
WIDTH 

Definition at line 90 of file UnaryParam.h.

Constructor & Destructor Documentation

◆ UnaryParam() [1/6]

template<class T >
casacore::UnaryParam< T >::UnaryParam ( )

Constructs the Unary, Defaults: height=1, center=0, width=1.


Warning: Could not use default arguments that worked both with gcc and IRIX

◆ UnaryParam() [2/6]

template<class T >
casacore::UnaryParam< T >::UnaryParam ( const T &  height)
explicit

◆ UnaryParam() [3/6]

template<class T >
casacore::UnaryParam< T >::UnaryParam ( const T &  height,
const T &  center 
)

◆ UnaryParam() [4/6]

template<class T >
casacore::UnaryParam< T >::UnaryParam ( const T &  height,
const T &  center,
const T &  width 
)

◆ UnaryParam() [5/6]

template<class T >
casacore::UnaryParam< T >::UnaryParam ( const UnaryParam< T > &  other)

Copy constructor (deep copy)

◆ UnaryParam() [6/6]

template<class T >
template<class W >
casacore::UnaryParam< T >::UnaryParam ( const UnaryParam< W > &  other)
inline

Definition at line 108 of file UnaryParam.h.

◆ ~UnaryParam()

template<class T >
virtual casacore::UnaryParam< T >::~UnaryParam ( )
virtual

Destructor.

Member Function Documentation

◆ name()

template<class T >
virtual const String& casacore::UnaryParam< T >::name ( ) const
inlinevirtual

Give name of function.

Definition at line 123 of file UnaryParam.h.

◆ ndim()

template<class T >
virtual uInt casacore::UnaryParam< T >::ndim ( ) const
inlinevirtual

Definition at line 119 of file UnaryParam.h.

◆ operator=()

template<class T >
UnaryParam<T>& casacore::UnaryParam< T >::operator= ( const UnaryParam< T > &  other)

Copy assignment (deep copy)

Referenced by casacore::UnaryFunction< T >::operator=().


The documentation for this class was generated from the following file: