SincModel


 
SincModel = class SincModel(KernelModel)
    SincModel(copy=None, **kwargs)
 
Sinc Model.
Also known as Cardinal Sine.
 
    f( x:p ) = p_0 * sin( ( x - p_1 ) / p_2 ) / ( ( x - p_1 ) / p_2 )
 
where
    p_0 = amplitude
    p_1 = offset
    p_2 = width ( =Distance between first zero-crossings divided by 2 Pi. )
As always x = input.
 
The parameters are initialized at {1.0, 0.0, 1.0}.
Parameter 2 ( width ) is always kept positive ( >=0 ).
 
SincModel() is syntactic sugar for
    KernelModel( kernel=Sinc() )
See KernelModel
 
Examples
--------
>>> sinc = SincModel( )
>>> print sinc.npchain
3
>>> print( sinc( numpy.arange( 15, dtype=float )-7 ) )        # sinc function between [-7,+7]
 
 
Attributes
----------
none 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:
SincModel
KernelModel
NonLinearModel
Model
FixedModel
BaseModel
builtins.object

Constructor:
SincModel( copy=None, **kwargs )
Sinc model.
 
Number of parameters is 3.
 
Parameters
----------
copy : ArctanModel
    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:
copy()
Copy method.

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