SineModel


 
SineModel = class SineModel(NonLinearModel)
    SineModel(copy=None, phase=False, **kwargs)
 
Sinusoidal Model.
 
Two variants are implemented.
 
1. By default it is the weighted sum of sine and cosine of the same frequency:
 
    f( x:p ) = p_1 * cos( 2 * π * p_0 * x ) + p_2 * sin( 2 * π * p_0 * x )
 
where
    p_0 = frequency
    p_1 = amplitude cosine and
    p_2 = amplitude sine.
As always x = input.
 
The parameters are initialized at [1.0, 1.0, 1.0]. It is a non-linear model.
 
2. If phase == True, the sinusoidal model has an explicit phase:
 
    f( x:p ) = p_0 * sin( 2 * π * p_1 * x + p_2 )
 
where
    p_0 = amplitude
    p_1 = frequency
    p_2 = phase.
 
The parameters are initialized as [1.0, 1.0, 0.0].
 
 
Examples
--------
>>> sine = SineModel( )
>>> print( sine.npchain )
3
>>> pars = [0.1, 0.0, 1.0]
>>> sine.parameters = pars
>>> print( sine( numpy.arange( 11, dtype=float ) ) )    # One sine period
>>> pars = [0.1, 1.0, 0.0]
>>> sine.parameters = pars
>>> print( sine( numpy.arange( 11, dtype=float ) ) )     # One cosine period
 
Attributes
----------
phase : bool (False)
    False : original 2 amplitudes model
    True  : phase model
 
Attributes from Model
---------------------
    npchain, parameters, stdevs, xUnit, yUnit
 
Attributes from FixedModel
--------------------------
    npmax, fixed, parlist, mlist
 
Attributes from BaseModel
--------------------------
    npbase, ndim, priors, posIndex, nonZero,
         tiny, deltaP, parNames
 
 
Method resolution order:
SineModel
NonLinearModel
Model
FixedModel
BaseModel
builtins.object
Constructor:
SineModel( copy=None, phase=False, **kwargs )
Sinusiodal model.
 
Number of parameters is 3.
 
Parameters
----------
phase : bool
    if True, construct phase variant.
copy : SineModel
    model to copy
fixed : dictionary of {int:float}
    int     list if parameters to fix permanently. Default None.
    float   list of values for the fixed parameters.
    Attribute fixed can only be set in the constructor.
Methods defined here:
baseDerivative( xdata, params )
Returns the derivative of f to x (df/dx) at the input values.
 
Parameters
----------
xdata : array_like
    values at which to calculate the result
params : array_like
    values for the parameters.
baseName()
Returns a string representation of the model.
baseParameterUnit( k )
Return the unit of a parameter.
 
Parameters
----------
k : int
    the kth parameter.
basePartial( xdata, params, parlist=None )
Returns the partials at the input value.
 
Parameters
----------
xdata : array_like
    values at which to calculate the result
params : array_like
    values for the parameters.
parlist : array_like
    list of indices active parameters (or None for all)
baseResult( xdata, params )
Returns the result of the model function.
 
Parameters
----------
xdata : array_like
    values at which to calculate the result
params : array_like
    values for the parameters.
copy()
Copy method.
phaseDerivative( xdata, params )
Returns the derivative of f to x (df/dx) at the input values.
 
Parameters
----------
xdata : array_like
    values at which to calculate the result
params : array_like
    values for the parameters.
phaseName()
Returns a string representation of the model.
phaseParameterUnit( k )
Return the unit of a parameter.
 
Parameters
----------
k : int
    the kth parameter.
phasePartial( xdata, params, parlist=None )
Returns the partials at the input value.
 
Parameters
----------
xdata : array_like
    values at which to calculate the result
params : array_like
    values for the parameters.
parlist : array_like
    list of indices active parameters (or None for all)
phaseResult( xdata, params )
Returns the result of the model function.
 
Parameters
----------
xdata : array_like
    values at which to calculate the result
params : array_like
    values for the parameters.
Methods inherited from NonLinearModel:
Methods inherited from Model:
Overloaded operators and aliases Other methods Methods inherited from FixedModel:
Methods inherited from BaseModel: