|
SineAmpModel = class SineAmpModel(LinearModel) |
| |
SineAmpModel(frequency, copy=None, **kwargs)
Sine with fixed frequency.
Find amplitudes/phases for sinusoidal of a given frequency.
f( x:p ) = p_0 cos( 2 π ω x ) + p_1 sin( 2 π ω x )
where
p_0 = amplitude of cosine
p_1 = amplitude of sine
ω is the fixed frequency of the model.
It is a linear model with 2 parameters.
Examples
--------
>>> sine = SineAmpModel( 150 ) # fixed frequency of 150 Hz
Attributes
----------
frequency : float
the (fixed) frequency of the sinusoidal.
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
Alternate
---------
This model is equivalent to
SineModel( fixed={0:frequency} )
|
| |
- Method resolution order:
- SineAmpModel
- LinearModel
- Model
- FixedModel
- BaseModel
- builtins.object
Constructor:
- SineAmpModel( frequency, copy=None, **kwargs )
- Sine model of a fixed frequency.
Number of parameters is 2.
Parameters
----------
frequency : float
the frequency
copy : SineAmpModel
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 derivative of f to x (df/dx) at the input value.
Parameters
----------
xdata : array_like
values at which to calculate the partials
params : array_like
parameters of the model
- baseName()
- Returns a string representation of the model.
- baseParameterUnit( k )
- Return the name of a parameter.
Parameters
----------
k : int
the kth parameter.
- basePartial( xdata, params, parlist=None )
- Returns the partials at the input value.
Parameters
----------
xdata : array_like
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:
|
|