Skip to content

Latest commit

 

History

History
209 lines (160 loc) · 10.7 KB

File metadata and controls

209 lines (160 loc) · 10.7 KB




class ArctanModel( NonLinearModel )[source]

Arctangus Model.

     f( x:p ) = p0 * arctan( p2 * ( x - p1 ) )
         p0 = amplitude

         p1 = center
         p2 = 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 ) [source]

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( ) [source]

Copy method.

baseResult( xdata, params ) [source]
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 ) [source]
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 ) [source]
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( ) [source]
Returns a string representation of the model.

baseParameterUnit( k ) [source]
Return the unit of the indicated parameter.

Parameters

  • k : int
         parameter number.
Methods inherited from NonLinearModel
Methods inherited from Model
Methods inherited from FixedModel
Methods inherited from BaseModel