|
RadialVelocityModel = class RadialVelocityModel(NonLinearModel) |
| |
RadialVelocityModel(copy=None, **kwargs)
Model for the radial velocity variations of a star caused by a orbiting planet.
p_0 : eccentricity of the elliptic orbit (0<e<1; 0 = circular orbit)
p_1 : amplitude of the velocity variation (>0)
p_2 : period of the velocity variation (>0)
p_3 : phase phase of periastron (0<p<2pi)
p_4 : periastron longitude of periastron (0<p<2pi)
This class uses Kepplers2ndLaw to find radius and true anomaly.
Note:
The velocity of the star system is not included in this model. See example.
The parameters are initialized at {0.0, 1.0, 1.0, 0.0, 0.0}.
It is a non-linear model.
Attributes
----------
keppler : Kepplers2ndLaw()
to calculate the radius and true anomaly
Examples
--------
>>> rv = RadialVelocityModel( )
>>> print( rv.npars )
5
>>> rv += PolynomialModel( 0 ) # add a constant system velocity
|
| |
- Method resolution order:
- RadialVelocityModel
- NonLinearModel
- Model
- FixedModel
- BaseModel
- builtins.object
Constructor:
- RadialVelocityModel( copy=None, **kwargs )
- Radial velocity model.
Number of parameters is 5:
Parameters
----------
copy : RadialVelocityModel
model to copy
fixed : dictionary of {int:float}
int list if parameters to fix permanently. Default None.
float list of values for the fixed parameters.
Attribute fixed can only be set in the constructor.
Methods defined here:
- baseDerivative( xdata, params )
- Returns the derivative of f to x (df/dx) at the input values.
dfdx = - p_1 * sin( v + p_4 ) * dvdx
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 a parameter.
Parameters
----------
k : int
the kth parameter.
- basePartial( xdata, params, parlist=None )
- Returns the partials at the input value.
f(x:p) = p_1 * ( cos( v + p_4 ) + p_0 * cos( p_4 ) )
df/dp_0 = p_1 * ( - sin( v + p_4 ) dv/dp_0 + cos( p_4 ) )
df/dp_1 = cos( v + p_4 ) + p_0 * cos( p_4 )
df/dp_2 = - p_1 * sin( v + p_4 ) dv/dp_2
df/dp_3 = - p_1 * sin( v + p_4 ) dv/dp_3
df/dp_4 = - p_1 * ( sin( v + p_4 ) + p_0 * sin( p_4 ) )
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)
- baseResult( xdata, params )
- Returns the result of the model function.
f(x:p) = p_1 * ( cos( v + p_4 ) + p_0 * cos( p_4 ) )
where v is the true anomaly
Parameters
----------
xdata : array_like
values at which to calculate the result
params : array_like
values for the parameters.
- copy()
- Copy method.
- getMsini( stellarmass )
- Return the mass of the exoplanet in Jupiter masses.
Parameters
----------
stellarmass : float
mass of the host star in solar masses.
Methods inherited from NonLinearModel:
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()
- isNullModel()
- isolateModel( k )
- multiplyModel( model )
- nextPrior()
- numDerivative( xdata, param )
- numPartial( xdata, param )
- operate( res, pars, next )
- 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:
|
|