Navigation

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

class PolynomialModel( LinearModel )	Source

General polynomial model of arbitrary degree.

     f( x:p ) = ∑ p_k * x^k

where the sum is over k running from 0 to degree ( inclusive ).

It is a linear model. Examples

poly = PolynomialModel( 3 )            # 3rd degree polynomial
print( poly.getNumberOfParameters() )
4

• Author : Do Kester

Attributes

• degree : int
       degree of the polynomial

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

PolynomialModel( degree, copy=None, **kwargs )

Polynomial of a certain degree.

The number of parameters is ( degree + 1 )

Parameters

• degree : int
       the degree of the polynomial.
• copy : PolynomialModel
       model to copy
• 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.

The partials are the powers of x ( xdata ) from 0 to degree.

Parameters

• xdata : array_like
       values at which to calculate the partials
• params : array_like
       parameters for the model (ignored for LinearModels).
• parlist : array_like
       list of indices of active parameters

baseDerivative( xdata, params )

Return the derivative df/dx at each input (=x).

Parameters

• xdata : array_like
       values at which to calculate the partials
• params : array_like
       parameters for the model.

baseName( )

Returns a string representation of the model.

baseParameterName( k )

Return the name of the indicated parameter. Parameters

• k : int
       parameter number.

baseParameterUnit( k )

Return the unit of the indicated parameter.

Parameters

• k : int
       parameter number.

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 )