|
HarmonicModel = class HarmonicModel(LinearModel) |
| |
HarmonicModel(order, period=1.0, copy=None, **kwargs)
Harmonic oscillator Model.
f( x:p ) = SUM_j ( p_k * cos( 2*pi*j*x ) + p_k+1 * sin( 2*pi*j*x ) )
j = 1, N; k = 0, 2N-2.
The number of parameters is 2 * order.
The parameters are initialized at 1.0. It is a linear model.
Author: Do Kester
Examples
--------
>>> harm = HarmonicModel( 3 ) # period = 1
>>> print( harm.npbase
6
>>> harm = HarmonicModel( 4, 2.7 ) # period = 2.7
Attributes
----------
order : int
the order of the harmonic
period : float
the length of the period of the fundamental
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
|
| |
- Method resolution order:
- HarmonicModel
- LinearModel
- Model
- FixedModel
- BaseModel
- builtins.object
Constructor:
- HarmonicModel( order, period=1.0, copy=None, **kwargs )
- Harmonic oscillator model.
Number of parameters is 2 * order.
Parameters
----------
order : int (>0)
the number of overtones
period : float
length of the period of the fundamental. default 1.0
copy : HarmonicModel
model 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
Methods defined here:
- baseDerivative( xdata, params )
- Returns the partials at the input value.
Parameters
----------
xdata : array_like
value at which to calculate the partials
params : array_like
parameters of 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.
Always : YUnit.
Parameters
----------
k : int
parameter number.
- basePartial( xdata, params, parlist=None )
- Returns the partials at the input value.
Parameters
----------
xdata : array_like
x values at which to calculate the partials
params : array_like
parameters of the model. (ignored in LinearModels)
parlist : array_like
list of indices of active parameters
- copy()
- Copy method.
Methods inherited from LinearModel:
Methods inherited from Model:
Overloaded operators and aliases
Other methods
- addModel( model )
- appendModel( model, operation )
- assignDF1( partial, i, dpi )
- assignDF2( partial, i, dpi )
- chainLength()
- correctParameters( params )
- derivative( xdata, param, useNum=False )
- divideModel( model )
- domain2Unit( dvalue, kpar=None )
- getIntegralUnit()
- getLimits()
- getLinearIndex()
- getNumberOfParameters()
- getParameterName( k )
- getParameterUnit( k )
- getPrior( k )
- hasLimits( fitindex=None )
- hasPriors( isBound=True )
- isDynamic()
- isMixed()
- isNullModel()
- isolateModel( k )
- multiplyModel( model )
- nextPrior()
- numDerivative( xdata, param )
- numPartial( xdata, param )
- operate( res, pars, next )
- partial( xdata, param, useNum=False )
- partialDomain2Unit( dvalue )
- pipeModel( model )
- 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)
- result( xdata, param=None )
- selectPipe( ndim, ninter, ndout )
- setLimits( lowLimits=None, highLimits=None )
- setPrior( k, prior=None, **kwargs )
- shortName()
- strictNumericDerivative( xdata, param )
- strictNumericPartial( xdata, params, parlist=None )
- subtractModel( model )
- testPartial( xdata, params, silent=True )
- unit2Domain( uvalue, kpar=None )
Methods inherited from FixedModel:
Methods inherited from BaseModel:
|
|