Navigation

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

class ArctanModel( NonLinearModel )	Source

Arctangus Model.

     f( x:p ) = p₀ * arctan( p₂ * ( x - p₁ ) )
         p₀ = amplitude

         p₁ = center
         p₂ = slope.

As always x = input.

The parameters are initialized at [2/pi, 0.0, 1.0]. It is a non-linear model.

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

Example

arct = ArctanModel( )
print( arct.getNumberOfParameters( ) )
3

• Author : Do Kester

ArctanModel( copy=None, **kwargs )

Arc-tangus model.

Number of parameters is 3.

Parameters

• copy : ArctanModel
       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.

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.

basePartial( xdata, params, parlist=None )

Returns the partials at the input value.

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)

baseDerivative( xdata, params )

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

Parameters

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

baseName( )

Returns a string representation of the model.

baseParameterUnit( k )

Return the unit of the indicated parameter.

Parameters

• k : int
       parameter number.

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 )