lsst.pipe.tasks gcf790cdeb6+f6e4da7c1c
Loading...
Searching...
No Matches
lsst.pipe.tasks.ssp.moid.MOIDSolver Class Reference

Public Member Functions

 __init__ (self, mu=GM_sun, n_samples=128, refine_factor=5.0, tol_MOID_abs=1e-7 *u.AU, tol_MOID_rel=1e-6, max_refine=10)
 
 compute (self, el1, el2)
 

Public Attributes

 mu = mu.to_value(u.km**3 / u.s**2) if hasattr(mu, "unit") else float(mu)
 
 n_samples = int(n_samples)
 
 refine_factor = float(refine_factor)
 
 tol_MOID_abs = tol_MOID_abs.to_value(u.AU)
 
 tol_MOID_rel = float(tol_MOID_rel)
 
 max_refine = int(max_refine)
 

Protected Member Functions

 _make_orbit_params (cls, a_AU, e, inc, Om, om)
 
 _moid_grid_search (self, p1, e1, Q1, p2, e2, Q2)
 

Static Protected Member Functions

 _make_rotation_matrix (inc, Om, om)
 
 _orbit_positions (p_AU, e, Q, f)
 
 _rv_from_params (p_AU, e, Q, f, mu_km3_s2)
 

Detailed Description

MOID solver using an adaptive 2D grid in (f1, f2).

Units:
  - Semi-major axes a: AU
  - Distances / MOID: AU
  - Velocities: km/s
  - μ: astropy quantity (km^3/s^2) or float
  - Public angles: degrees
  - Internal angles: radians

Definition at line 111 of file moid.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.pipe.tasks.ssp.moid.MOIDSolver.__init__ ( self,
mu = GM_sun,
n_samples = 128,
refine_factor = 5.0,
tol_MOID_abs = 1e-7 * u.AU,
tol_MOID_rel = 1e-6,
max_refine = 10 )

Definition at line 124 of file moid.py.

Member Function Documentation

◆ _make_orbit_params()

lsst.pipe.tasks.ssp.moid.MOIDSolver._make_orbit_params ( cls,
a_AU,
e,
inc,
Om,
om )
protected
Return p in AU, rotation matrix Q.

Definition at line 188 of file moid.py.

◆ _make_rotation_matrix()

lsst.pipe.tasks.ssp.moid.MOIDSolver._make_rotation_matrix ( inc,
Om,
om )
staticprotected
Rz(Omega) * Rx(inc) * Rz(omega).

Definition at line 150 of file moid.py.

◆ _moid_grid_search()

lsst.pipe.tasks.ssp.moid.MOIDSolver._moid_grid_search ( self,
p1,
e1,
Q1,
p2,
e2,
Q2 )
protected
Adaptive search in AU.
Returns: (MOID_AU, f1_best, f2_best)

Definition at line 245 of file moid.py.

◆ _orbit_positions()

lsst.pipe.tasks.ssp.moid.MOIDSolver._orbit_positions ( p_AU,
e,
Q,
f )
staticprotected
Vectorized positions in AU.

Definition at line 195 of file moid.py.

◆ _rv_from_params()

lsst.pipe.tasks.ssp.moid.MOIDSolver._rv_from_params ( p_AU,
e,
Q,
f,
mu_km3_s2 )
staticprotected
Return (r in AU, v in km/s).

Definition at line 212 of file moid.py.

◆ compute()

lsst.pipe.tasks.ssp.moid.MOIDSolver.compute ( self,
el1,
el2 )
Compute MOID and related quantities.

el = (a_AU, e, inc_deg, Ω_deg, ω_deg)
Returns MOIDResult namedtuple.

Definition at line 312 of file moid.py.

Member Data Documentation

◆ max_refine

lsst.pipe.tasks.ssp.moid.MOIDSolver.max_refine = int(max_refine)

Definition at line 143 of file moid.py.

◆ mu

lsst.pipe.tasks.ssp.moid.MOIDSolver.mu = mu.to_value(u.km**3 / u.s**2) if hasattr(mu, "unit") else float(mu)

Definition at line 134 of file moid.py.

◆ n_samples

lsst.pipe.tasks.ssp.moid.MOIDSolver.n_samples = int(n_samples)

Definition at line 136 of file moid.py.

◆ refine_factor

lsst.pipe.tasks.ssp.moid.MOIDSolver.refine_factor = float(refine_factor)

Definition at line 137 of file moid.py.

◆ tol_MOID_abs

lsst.pipe.tasks.ssp.moid.MOIDSolver.tol_MOID_abs = tol_MOID_abs.to_value(u.AU)

Definition at line 140 of file moid.py.

◆ tol_MOID_rel

lsst.pipe.tasks.ssp.moid.MOIDSolver.tol_MOID_rel = float(tol_MOID_rel)

Definition at line 141 of file moid.py.


The documentation for this class was generated from the following file: