| class SineSplineModel( LinearModel ) | Source |
|---|
Sine of fixed frequency with splineslike amplitudes/phases.
f( x:p ) = SM0 cos( 2 π ω x ) + SM1 sin( 2 π ω x )
Where SM0 and SM1 are splines models with defined knots and order.
It is a linear model with 2 * ( len(knots) + order - 1 ) papameters.
Examples
knots = [3.0*k for k in range( 11 )]
sine = SineSplineModel( 150, knots ) # fixed frequency of 150 Hz
print( sine.npbase ) # number of parameters
26
Attributes
- frequency : float
(fixed) frequency of the sine - knots : array_like
positions of the spline knots - order : int
order of the spline. default: 3 - cm : SplinesModel
amplitude of the cosine - sm : SplinesModel
amplitude of the 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
Alternate
The model
model = SineSplineModel( frequency, knots )
-
is equivalent to :
cm = SplinesModel( knots ) sm = SplinesModel( knots ) fxd = {0:cm, 1:sm} model = SineAmpModel( frequency, fixed=fxd )
| SineSplineModel( frequency, knots, order=3, copy=None, fixed=None, **kwargs ) |
|---|
Sine model of a fixed frequency with a splineslike changing amplitude/phase.
Number of parameters is 2 * ( len(knots) + order - 1 ).
Parameters
- frequency : float
the frequency - copy : SineSplineModel
model to be copied - fixed : dict
If not None raise AttributeError.
Raises
AttributeError
when fixed is not None
| copy( ) |
|---|
| basePartial( xdata, params, parlist=None ) |
|---|
Parameters
- xdata : array_like
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)
| baseDerivative( xdata, params ) |
|---|
Parameters
- xdata : array_like
values at which to calculate the partials - params : array_like
parameters of the model
| getAmplitudes( xdata, params ) |
|---|
Parameters
- xdata : array_like
values at which to calculate the partials - params : array_like
parameters of the model
| baseName( ) |
|---|
| baseParameterUnit( k ) |
|---|
- k : int
the kth parameter.
| Methods inherited from LinearModel |
|---|
| Methods inherited from Model |
|---|
- chainLength( )
- isNullModel( )
- isolateModel( k )
- addModel( model )
- subtractModel( model )
- multiplyModel( model )
- divideModel( model )
- pipeModel( model )
- appendModel( model, operation )
- correctParameters( params )
- result( xdata, param=None )
- operate( res, pars, next )
- derivative( xdata, param, useNum=False )
- partial( xdata, param, useNum=False )
- selectPipe( ndim, ninter, ndout )
- pipe_0( dGd, dHdG )
- pipe_1( dGd, dHdG )
- pipe_2( dGd, dHdG )
- pipe_3( dGd, dHdG )
- pipe_4( dGdx, dHdG )
- pipe_5( dGdx, dHdG )
- pipe_6( dGdx, dHdG )
- pipe_7( dGdx, dHdG )
- pipe_8( dGdx, dHdG )
- pipe_9( dGdx, dHdG )
- shortName( )
- getNumberOfParameters( )
- numDerivative( xdata, param )
- numPartial( xdata, param )
- isDynamic( )
- hasPriors( isBound=True )
- getPrior( kpar )
- setPrior( kpar, prior=None, **kwargs )
- getParameterName( kpar )
- getParameterUnit( kpar )
- getIntegralUnit( )
- setLimits( lowLimits=None, highLimits=None )
- getLimits( )
- hasLimits( fitindex=None )
- unit2Domain( uvalue, kpar=None )
- domain2Unit( dvalue, kpar=None )
- partialDomain2Unit( dvalue )
- nextPrior( )
- isMixed( )
- getLinearIndex( )
- testPartial( xdata, params, silent=True )
- strictNumericPartial( xdata, params, parlist=None )
- assignDF1( partial, i, dpi )
- assignDF2( partial, i, dpi )
- strictNumericDerivative( xdata, param )
| Methods inherited from FixedModel |
|---|
| Methods inherited from BaseModel |
|---|