SineDriftModel


 
SineDriftModel = class SineDriftModel(NonLinearModel)
    SineDriftModel(copy=None, **kwargs)
 
Sinusoidal Model with drifting frequency.
.. math::
    f( x:p ) = p_1 * \cos( \phi ) + p_2 * sin( \phi )
    \phi = 2 * \pi * x * ( p_0 + x * p_3 )
 
where :math:`p_0` = frequency, :math:`p_3` = is the drift in frequency,
:math:`p_1` = amplitude cosine and :math:`p_2` = amplitude sine.
As always x = input.
 
The parameters are initialized at {1.0, 1.0, 1.0, 0.0}. It is a non-linear model.
 
Examples
--------
>>> sine = SineDriftModel( )
>>> print( sine.npchain )
>>> pars = [0.1,0,1,0.0]
>>> sine.parameters = pars
>>> print( sine( numpy.arange( 101, dtype=float ) ) )     # 10 sine periods, no drift
>>> pars = [0.1,0,1,0.001]
>>> sine.parameters = pars
>>> print( sine( numpy.arange( 101, dtype=float ) ) )     # 10 sine periods, drifting
 
 
Attributes
----------
    No attributes of its own.
 
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:
SineDriftModel
NonLinearModel
Model
FixedModel
BaseModel
builtins.object

Constructor:
SineDriftModel( copy=None, **kwargs )
Sinusiodal model with drifting frequency.
 
Number of parameters is 4.
 
Parameters
----------
copy : SineDriftModel
    to be copied
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 name of a parameter.
 
Parameters
----------
k : int
    the kth parameter.
basePartial( xdata, params, parlist=None )
Returns the partials at the input values.
 
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.

Methods inherited from NonLinearModel:
Methods inherited from Model:
Overloaded operators and aliases Other methods Methods inherited from FixedModel:
Methods inherited from BaseModel: