Navigation

Global	Documentation
Home	Manual
Readme	Glossary
Notes	Design
Examples	Classes
	Trouble
	Style

class SineDriftModel( NonLinearModel )	Source

Sinusoidal Model with drifting frequency.

     f( x:p ) = p₁ * cos( φ ) + p₂ * sin( φ )
        φ = 2 * π * x * ( p₀ + x * p₃ )

where p₀ = frequency, p₃ = is the drift in frequency,
       p₁ = amplitude cosine and p₂ = 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 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

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.

copy( )

Copy method.

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.

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.

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)

baseName( )

Returns a string representation of the model.

baseParameterUnit( k )

Return the name of a parameter.

Parameters

• k : int
       the kth parameter.

Methods inherited from NonLinearModel

• setMixedModel( lindex )
• isMixed( )
• getNonLinearIndex( )
• partial( xdata, param=None, useNum=False )

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 )
• 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( )
• 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

• select( params )
• selectNames( names )
• expand( xdata, param )

Methods inherited from BaseModel

• checkParameter( param )
• checkPositive( param )
• checkZeroParameter( param )
• isModifiable( )
• basePrior( kpar )
• baseParameterName( kpar )