EtalonDriftModel

 
EtalonDriftModel = class EtalonDriftModel(NonLinearModel)
    EtalonDriftModel(copy=None, **kwargs)
 
Sinusoidal Model with drifting frequency.
 
    f( x,y:p ) = p_0 / ( 1.0 + p_1^2 * sin^2( π ( p_2 x + p_3 + p_4 y ) ) )
 
where p_0 = amplitude
      p_1 = finesse
      p_2 = periods per wavenumber
      p_3 = phase
      p_4 = phase drift
As always (x,y) = input; it is in (wavenumbers,alpha)
 
The parameters are initialized at {1.0, 1.0, 1.0, 0.0, 0.0}. It is a non-linear model.
 
This model is specificly made for the MIRI instrumnet aboard JWST.
Its usefullness elsewhere is doubtfull.
 
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

 
Examples
--------
>>> fpm = EtalonDriftModel( )
>>> print( fpm.npchain )
5
>>> pars = [1.0, 30.0, 1.0, 0.0, 0.0]
>>> fpm.parameters = pars
 
 
Method resolution order:
EtalonDriftModel
NonLinearModel
Model
FixedModel
BaseModel
builtins.object

Constructor:
EtalonDriftModel( copy=None, **kwargs )
Etalon model.
 
Number of parameters is 5.
 
Parameters
----------
copy : EtalonModel
    to be copied
fixed : None or dictionary of {int:float|Model}
    int         index of parameter to fix permanently.
    float|Model values for the fixed parameters.
    Attribute fixed can only be set in the constructor.
    See: FixedModel
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: