Navigation

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

class SineAmpModel( LinearModel )	Source

Sine with fixed frequency.

Find amplitudes/phases for sinusoidal of a given frequency.

     f( x:p ) = p₀ cos( 2 π ω x ) + p₁ sin( 2 π ω x )

where
     p₀ = amplitude of cosine
     p₁ = amplitude of sine
     P₃ = ω is the fixed frequency of the model.

It is a linear model with 2 parameters.

Examples

sine = SineAmpModel( 150 )        # fixed frequency of 150 Hz

Attributes

• frequency : float
       the (fixed) frequency of the sinusoidal.

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

This model is equivalent to
     SineModel( fixed={0:frequency} )

SineAmpModel( frequency, copy=None, **kwargs )

Sine model of a fixed frequency.

Number of parameters is 2.

Parameters

• frequency : float
       the frequency
• copy : SineAmpModel
       model 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

copy( )

Copy method.

basePartial( xdata, params, parlist=None )

Returns the partials at the input value.

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 of active parameters

baseDerivative( xdata, params )

Returns the derivative of f to x (df/dx) at the input value.

Parameters

• xdata : array_like
       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.

Methods inherited from LinearModel

• baseResult( xdata, params )

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

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

Methods inherited from BaseModel

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