StellarOrbitModel

 
StellarOrbitModel = class StellarOrbitModel(NonLinearModel)
    StellarOrbitModel(copy=None, spherical=True, **kwargs)
 
    Model for the radial velocity variations of a star caused by a orbiting planet.
.
    The algorithm was taken from
        Cory Boule etal. (2017) J. of Double Star Observations Vol 13 p.189.
        http://www.jdso.org/volume13/number2/Harfenist_189-199.pdf
 
    p_0 : e     eccentricity of the elliptic orbit (0<e<1; 0 = circular orbit)
    p_1 : a     semi major axis (>0)
    p_2 : P     period of the orbit (>0)
    p_3 : T     phase since periastron passage (0<p_3<2pi)
    p_4 : i     inclination of the orbit wrt sky (0<i<pi; 0 = pi = in sky plane)
    p_5 : Omega position angle from North to the line of nodes (0<Omega<pi; 0 = north )
    p_6 : omega longitude from the node (in p_5) to the periastron (0<omega<2pi; 0 = periastron in node )
 
    Due to the fact that the orbit can be mirrored in the sky plane, one of p_5 or p_6
    has to be limited to [0,pi] and the other to [0,2pi].
 
    The parameters are initialized at [0.0, 1.0, 1.0, 0.0, 0.0,
         0.0, 0.0].

    It is a non-linear model.
 
    This class uses Kepplers2ndLaw to find the radius and anomaly.
 
    Attributes
    ----------
    keppler : Kepplers2ndLaw()
        to calculate the radius and true anomaly
    ndout : int
        The number of outputs is 2. Use MultipleOutputProblem.
    spherical : bool
        if True return the results in spherical coordinates.
    cyclic : { 1 : 2*pi }
        Only if spherical, indicating that result[:,1] is cyclic.
 
    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

 
    Examples
    --------
    >>> sm = StellarOrbitModel( )
    >>> print( sm.npars )
    7
 
 
Method resolution order:
StellarOrbitModel
NonLinearModel
Model
FixedModel
BaseModel
builtins.object

Constructor:
StellarOrbitModel( copy=None, spherical=True, **kwargs )
Radial velocity model.
 
Number of parameters is 5:
 
Parameters
----------
copy : StellarOrbitModel
    model to copy
spherical : bool (True)
    produce output in sperical coordinates (rho,phi)
    otherwise in rectilinear coordinates (x,y)
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 (df/dx) of the model function.
 
Parameters
----------
xdata : array_like
    values at which to calculate the result
params : array_like
    values for the parameters.
 
p_0 : e     eccentricity of the elliptic orbit (0<e<1; 0 = circular orbit)
p_1 : a     semi major axis (>0)
p_2 : P     period of the orbit (>0)
p_3 : p     phase since periastron passage (0<p<2pi)
p_4 : i     inclination of the orbit wrt sky (0<i<pi; 0 = orbit in sky plane)
p_5 : O(mega) position angle of the line of nodes (0<Omega<pi)
p_6 : o(mega) longitude of periastron (0<omega<2pi)
baseName()
Returns a string representation of the model.
baseParameterUnit( k )
Return the unit of a parameter. (TBC)
 
Parameters
----------
k : int
    the kth parameter.
basePartial( xdata, params, parlist=None )
Returns the partials at the xdata value.
<br>
The partials are x ( xdata ) to degree-th power.
 
Parameters
----------
xdata : array_like
    values at which to calculate the result
params : array_like
    values for the parameters. (not used for linear models)
parlist : array_like
    list of indices active parameters (or None for all)
 
p_0 : e     eccentricity of the elliptic orbit (0<e<1; 0 = circular orbit)
p_1 : a     semi major axis
p_2 : P     period of the orbit (>0)
p_3 : p     phase since periastron passage (0<p<2pi)
p_4 : i     inclination of the orbit wrt sky (0<i<pi; 0 = orbit in sky plane)
p_5 : O     position angle of the line of nodes
p_6 : o     longitude of periastron
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.
 
p_0 : e     eccentricity of the elliptic orbit (0<e<1; 0 = circular orbit)
p_1 : a     semi major axis (>0)
p_2 : P     period of the orbit (>0)
p_3 : p     phase since periastron passage (0<p<2pi)
p_4 : i     inclination of the orbit wrt sky (0<i<pi; 0 = orbit in sky plane)
p_5 : Omega position angle of the line of nodes
p_6 : omega longitude of periastron from lines of nodes
copy()
Copy method.
derivative( xdata, params )
Return the derivatives (df/dx) of the model at the inputs
 
Parameters
----------
xdata : array_like
    an input vector or array
param : array_like
    parameters for the model
useNum : bool
    if true, numeric derivatives are used.
partial( xdata, params, parlist=None )
Return the partial derivatives for the model.
 
Parameters
----------
xdata : array_like
    the value at which to calculate the partials
param : array_like
    the parameters of the model. Default the self.parameters
useNum : boolean
    if True use numeric partial derivatives. Default False
toRect( rp )
Return (x,y) coordinates from (rho,phi)
 
Parameters
----------
rp : array
    rp[:,0] : separation of the stars
    rp[:,1] : angle from north (down) CCW to east (right)
toSpher( xy )
Return (rho,phi) coordinates from (x,y)
 
Parameters
----------
xy : array
    xy[:,0] : x position
    xy[:,1] : y position

Methods inherited from NonLinearModel:
Methods inherited from Model:
Overloaded operators and aliases Other methods Methods inherited from FixedModel:
Methods inherited from BaseModel: