PolySineAmpModel


 
PolySineAmpModel = class PolySineAmpModel(LinearModel)
    PolySineAmpModel(degree, frequency, copy=None, fixed=None, **kwargs)
 
Sine of fixed frequency with polynomials as amplitudes.
 
Find amplitudes/phases for sinusoidal of a given frequency.
 
    f( x,y:p ) = P(y) cos( 2 π ω x ) + Q(y) sin( 2 π ω x )
 
P(y), Q(y) are Polynomials of a certain order, n.
 
It is a linear model in 2 dimensions, with 2n+2 papameters.
 
Examples
--------
>>> sine = PolySineAmpModel( 2, 150.0 )        # fixed frequency of 150 Hz
 
Attributes
----------
degree : int
    degree of the polynomials
frequency : float
    frequency of the sine.
pm : PolynomialModel
    polynomial to be multiplied with the (co)sine
 
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:
PolySineAmpModel
LinearModel
Model
FixedModel
BaseModel
builtins.object

Constructor:
PolySineAmpModel( degree, frequency, copy=None, fixed=None, **kwargs )
Sine model of a fixed frequency and polynomials as coefficients.
 
Number of parameters is 2n+2.
 
Parameters
----------
degree : int
    degree of the polynomials
frequency : float
    the frequency, ω
copy : PolySineAmpModel
    model to be copied
fixed : dict
    If not None raise AttributeError.
 
Raises
------
AttributeError : When fixed is not None
Methods defined here:
baseDerivative( xdata, params )
Returns the derivative of f to (x,y) (df/dx,df/dy) at the input value.
 
Parameters
----------
xdata : array_like [2,ndata]
    values at which to calculate the partials
params : array_like
    parameters of the model
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 value.
 
Parameters
----------
xdata : array_like [2,ndata]
    values at which to calculate the partials
params : array_like
    parameters of the model (ignored in LinearModels)
parlist : array_like
    list of indices active parameters (or None for all)
copy()
Copy method.

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