Tool: functional Functionals handling
Method: functional Construct functional tool
host string valid host name string for the host on which to run tool
forceneweserver bool force the use of a new server
Method: is_functional Check if functional
v string value to be tested
Method: names Show the known functional names
Method: mkfunctional Create the named functional
name string name of functional to create
order int integer value giving the order if appropriate
params doubleArray parameters, the value of the parameters depends on the functional.
Method: f Calculate the value of the functional
x doubleArray real argument values
Method: cf Calculate the value of the complex functional
x complexArray argument values
Method: fdf Calculate the value and derivatives of the functional
x doubleArray real argument values
Method: cfdf Calculate the value and derivatives of the complex functional
x complexArray argument values
Method: type Show the type name
Method: npar Show the number of parameters
Method: ndim Show the number of dimensions
Method: order Show the order or similar information
Method: state Show complete state of the functional
Method: parameters Show the functional parameters
Method: setparameters Set the functional parameters
par doubleArray parameters to be set
Method: par Show a single parameter
n int parameter index, default index is 1
Method: setpar Set a single parameter
n int parameter index, default index is 1
v double parameter values to be set
Method: masks Show the functional masks
Method: setmasks Set the functional masks
mask boolArray masks to be set
Method: mask Show a single mask value
n int parameter index
Method: setmask Set a single mask
n int parameter index
v bool parameter mask to be set
Method: done Free resources of the functional
Method: gaussian1d Create a 1D Gaussian function
height any amplitude of Gaussian, or 3 numeric values
center double center of Gaussian
width double HPBW width of Gaussian
Method: gaussian2d Create a 2D Gaussian function
params doubleArray amplitude, centers, major width, ratio, angle of Gaussian default value should be 1,0,0,1,1,0
Method: poly Create a 1D polynomial function
order int polynomial degree
params doubleArray factors of terms
Method: oddpoly Create an odd 1D polynomial function
order int polynomial degree (integer value)
params doubleArray factors of terms
Method: evenpoly Create an even 1D polynomial function
order int polynomial degree (integer value)
params doubleArray factors of terms
Method: chebyshev Create a 1D Chebyshev polynomial function
order int order of the polynomial
params doubleArray the Chebyshev coefficients
xmin double the minimum value of the interval of interest
xmax double the maximum value of the interval of interest
ooimode string the ``out-of-interval'' mode. This controlswhat gets returned when an input value to the function is outside theinterval of interest.It is a minimum match to the following values: 'constant' -- the value of the def argument; 'zeroth' -- the value of the zero-th order coefficient; 'extrapolate' -- the function evaluated explicitly at the input value; 'cyclic' -- the function evaluated at the input value after ''folding'' it into the interval of interest; 'edge' -- the function evaluated at the nearest edge of the interval of interest
|def|double|the default value to return for input values outside of the interval of interest when ooimode='constant'|
Method: butterworth Create an approximation of butterworth bandpass
minorder int An integer value for the order of the minimum (high-pass) cutoff of the curve
maxorder int An integer value for the order of the maximum (low-pass) cutoff of the curve
mincut double the characteristic cutoff value of the minimum (high-pass) portion of the curve.
maxcut double the characteristic cutoff value of the maximum (low-pass) portion of the curve.
center double the location of the peak of the bandpass curve
peak double the maximum value of the bandpass curve
Method: combi Create a combination function
Method: compound Create a compound function
Method: compiled Create your own function
code string programmable expression string
params doubleArray optionally parameters to be set
Method: id identification of tool
Method: tool_type type of tool
Method: name type of tool
Method: tool_done free resources used by tool
kill bool force killing of the default tool

-- WesYoung - 17 Jul 2006
Topic revision: r1 - 2006-07-17, WesYoung
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding NRAO Public Wiki? Send feedback