empyrean.PlanResult

class PlanResult(orbit_id, metrics, candidates, ephemeris, active_width)[source]

Bases: object

The result of evaluating an observation plan.

Three tables describe the run, plus the two scalars that label it:

plan = evaluate_plan(orbit, planned)
plan.metrics.posterior().position_sigma_km[0].as_py()
plan.candidates.best_by_information_gain(3).obs_code.to_pylist()

Mirrors empyrean::PlanResult.

Methods

__init__(orbit_id, metrics, candidates, ...)

Attributes

orbit_id

Orbit identifier the plan was evaluated for.

metrics

Two rows — the covariance before any of the candidates and after every candidate submitted, observable or not.

candidates

Per-candidate information gain, in ascending epoch order rather than the order the candidates were supplied in.

ephemeris

Predicted sky position for each optical candidate.

active_width

Width of the solve-for set.

Parameters:
  • orbit_id (str)

  • metrics (PlanMetrics)

  • candidates (PlanCandidates)

  • ephemeris (PlanEphemeris)

  • active_width (int)

orbit_id: str

Orbit identifier the plan was evaluated for.

metrics: PlanMetrics

Two rows — the covariance before any of the candidates and after every candidate submitted, observable or not.

candidates: PlanCandidates

Per-candidate information gain, in ascending epoch order rather than the order the candidates were supplied in.

ephemeris: PlanEphemeris

Predicted sky position for each optical candidate.

active_width: int

Width of the solve-for set. Always 6 (state-only) on this entry point; see the Notes on empyrean.evaluate_plan().