Navigation

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

class HarmonicDynamicModel( HarmonicModel,Dynamic )	Source

Harmonic oscillator Model of adaptable order.

f( x:p ) = ∑_j ( p_k cos( 2 π j x ) + p_k+1 sin( 2 π j x ) )

j = 1, N; k = 0, 2N

The parameters are initialized at 1.0. It is a linear model.

Author Do Kester

Attributes

• minOrder : int
       minimum degree of polynomial (def=1)
       Can also be read as minComp
• maxOrder : None or int
       maximum degree of polynomial (def=None)
       Can also be read as maxComp

Attributes from Dynamic

     ncomp (= order), deltaNpar, minComp (= minOrder), maxComp (= maxComp), growPrior

Attributes from HarmonicModel

     order, period

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

Examples

harm = HarmonicDynamicModel( 3 )            # period = 1
print harm.getNumberOfParameters( )         # 6
harm = HarmonicModel( 4, period=2.7 )       # period = 2.7

Category mathematics/Fitting

HarmonicDynamicModel( order, minOrder=1, maxOrder=None, period=1.0, fixed=None, growPrior=None, copy=None, **kwargs )

Harmonic of a adaptable order.

The model starts as a HarmonicModel of order = 1 Growth of the model is governed by a prior.

Parameters

• order : int
       order to start with. It should be minOrder <= order <= maxOrder
• minOrder : int
       minimum degree of polynomial (def=1)
• maxOrder : None or int
       maximum degree of polynomial (def=None)
• period : float
       period of the oscilation
• fixed : None
       If fixed is not None an AttributeError is raised
• growPrior : None or Prior
       governing the birth and death.
       ExponentialPrior (scale=2) if maxOrder is None else UniformPrior
• copy : HarmonicDynamicModel
       model to copy

Raises

AttributeError when fixed parameters are requested ValueError when order is outside [min..max] range

copy( )

Copy method.

isDynamic( )

changeNComp( dn )

basePrior( k )

Return the prior for parameter k.

Parameters

• k : int
       the parameter to be selected.

baseName( )

Return a string representation of the model.

Methods inherited from HarmonicModel,

• basePartial( xdata, params, parlist=None )
• baseDerivative( xdata, params )
• baseParameterName( k )
• baseParameterUnit( k )

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

Methods inherited from Dynamic

• setGrowPrior( growPrior=None, min=1, max=None, name="Comp" )
• setDynamicAttribute( name, value )
• grow( offset=0, rng=None, **kwargs )
• shrink( offset=0, rng=None, **kwargs )
• alterParameterNames( dnp )
• alterParameterSize( dnp, offset, location=None, value=0 )
• alterParameters( param, location, dnp, offset, value=None )
• alterFitindex( findex, location, dnp, offset )
• shuffle( param, offset, np, rng )