Navigation

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

class PolySineAmpModel( LinearModel )	Source

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

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

copy( )

Copy method.

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)

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.

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 )