5.1.4.0 sd.fitter.set_sinusoid_parameters

NRAO Home > CASA > CASA Toolkit Reference Manual

sd.fitter.set_sinusoid_parameters - Function

5.1.4 Set the parameters of Sinusoidal component
Description

Set the Parameters of a ’Sinusoidal’ component, set with set_function.

Three arguments, ampl, period, and x0, are mandatory to be set. They specifies an initial model of Sinusoidal component.

The amplfixed, periodfixed, and x0fixed are optional parameters to indicate if the paramters should be held fixed during the fitting process. The default is to keep all parameters flexible. If you want to fix one of those parameters, you can do it by setting corresponding arguments (amplfixed, periodfixed, and x0fixed) to 1.

The component argument is only effective for multi-component Sinusoidal fitting. It specifies the number of the component to set the specified parameters.

Arguments


Inputs
ampl	The sinusoidal parameters (amplitude)
	allowed:	float
	Default:
period	The sinusoidal parameters (period)
	allowed:	float
	Default:
x0	The sinusoidal parameters (phase offset)
	allowed:	float
	Default:
amplfixed	Optional parameters to indicate if ampl should be held fixed during the fitting process
	allowed:	integer
	Default:	0 (flexible)
periodfixed	Optional parameters to indicate if period should be held fixed during the fitting process
	allowed:	integer
	Default:	0 (flexible)
x0fixed	Optional parameters to indicate if x0 should be held fixed during the fitting process
	allowed:	integer
	Default:	0 (flexible)
component
	allowed:	integer
	Default:	0

Returns

Example

[next] [prev] [prev-tail] [front] [up]

More information about CASA may be found at the CASA web page

This code is available under the terms of the GNU General Public Lincense