ElementSetCatalog

class huira.ElementSetCatalog

Satellites’ element sets read from a catalog of TLEs or OMMs, with a report of the entries left out of it and why. Make one with read() or parse().

__init__(*args, **kwargs)
static detect_format(text: str) → huira._huira.ElementSetFormat

The ElementSetFormat a catalog’s text is in, from how it starts

property element_sets

The element sets kept (SatRec)

static parse(text: str, format: huira._huira.ElementSetFormat, *, mode: huira._huira.Sgp4Mode = <Sgp4Mode.AFSPC: 0>, include: list[int] = [], exclude: list[int] = [], reference_time: Optional[huira._huira.Time] = None, max_age: object = None, strict: bool = False) → huira._huira.ElementSetCatalog

Read a catalog of element sets from its text, in the ElementSetFormat given.

mode: the Sgp4Mode to propagate them in; leave it AFSPC unless you have a reason not to. include: keep only the satellites with these catalog numbers, or every one if it is empty. exclude: leave out the satellites with these catalog numbers. reference_time: when the element sets are to be used. Of a satellite’s element sets, the one whose epoch is nearest it is kept, or with none, the newest. max_age: leave out element sets whose epoch is further than this from reference_time, as a duration such as huira.units.Day(14). strict: raise on the first entry that isn’t an element set SGP4 can propagate, rather than skip it.

static read(path: os.PathLike, *, format: Optional[huira._huira.ElementSetFormat] = None, mode: huira._huira.Sgp4Mode = <Sgp4Mode.AFSPC: 0>, include: list[int] = [], exclude: list[int] = [], reference_time: Optional[huira._huira.Time] = None, max_age: object = None, strict: bool = False) → huira._huira.ElementSetCatalog

Read a catalog of element sets from a file.

format: an ElementSetFormat, or None to work it out from the text. mode: the Sgp4Mode to propagate them in; leave it AFSPC unless you have a reason not to. include: keep only the satellites with these catalog numbers, or every one if it is empty. exclude: leave out the satellites with these catalog numbers. reference_time: when the element sets are to be used. Of a satellite’s element sets, the one whose epoch is nearest it is kept, or with none, the newest. max_age: leave out element sets whose epoch is further than this from reference_time, as a duration such as huira.units.Day(14). strict: raise on the first entry that isn’t an element set SGP4 can propagate, rather than skip it.

Raises RuntimeError if the file can’t be read or split into entries, or, with strict, at the first bad entry.

property skipped

The entries left out, and why (SkippedElementSet), in the catalog’s order

property sources

Where each element set kept came from (ElementSetSource), in the same order

class huira.ElementSetSource

Where in a catalog an element set kept from it came from

__init__(*args, **kwargs)
property entry

Which entry of the catalog it was, counted from 0

property line

The line its entry starts on, counted from 1, or 0 in a JSON catalog

class huira.SkippedElementSet

An entry of a catalog left out of it

__init__(*args, **kwargs)
property catalog_number

Its satellite’s NORAD catalog number, or 0 if it couldn’t be read

property entry

Which entry of the catalog it was, counted from 0

property line

The line its entry starts on, counted from 1, or 0 in a JSON catalog

property message

Why, in words

property name

Its satellite’s name, or ‘’

property reason

Why, as a SkipReason

class huira.ElementSetFormat

The formats a catalog of element sets is read from

Members:

TLE : TLEs, each with a name line before it or not

OMM_KVN : OMMs in CCSDS keyword = value notation

OMM_CSV : OMMs as CSV, under a header of keywords

OMM_JSON : OMMs as JSON: an array of objects

OMM_CSV = <ElementSetFormat.OMM_CSV: 2>
OMM_JSON = <ElementSetFormat.OMM_JSON: 3>
OMM_KVN = <ElementSetFormat.OMM_KVN: 1>
TLE = <ElementSetFormat.TLE: 0>
__init__(self: huira._huira.ElementSetFormat, value: int) → None
property name
property value
class huira.SkipReason

Why an entry of a catalog was left out of it

Members:

INVALID : It isn’t an element set SGP4 can propagate, or isn’t one at all

NOT_INCLUDED : Its satellite isn’t one of include

EXCLUDED : Its satellite is one of exclude

TOO_OLD : Its epoch is further than max_age from the reference time

SUPERSEDED : Another element set for its satellite was kept

CLAIMED : Its satellite places a node, or is in another constellation

CLAIMED = <SkipReason.CLAIMED: 5>
EXCLUDED = <SkipReason.EXCLUDED: 2>
INVALID = <SkipReason.INVALID: 0>
NOT_INCLUDED = <SkipReason.NOT_INCLUDED: 1>
SUPERSEDED = <SkipReason.SUPERSEDED: 4>
TOO_OLD = <SkipReason.TOO_OLD: 3>
__init__(self: huira._huira.SkipReason, value: int) → None
property name
property value
class huira.ConstellationReport

What adding satellites did

__init__(*args, **kwargs)
property added

The satellites added

property replaced

The satellites it held already, whose element sets were replaced

property skipped

by the catalog’s read, or as something else places their satellites (SkipReason.CLAIMED)

Type:

The element sets left out, and why (SkippedElementSet)

class huira.SkippedSatellite

A satellite of a constellation a scene view left out, as SGP4 can’t place it during the exposure

__init__(*args, **kwargs)
property catalog_number

Its NORAD catalog number

property constellation_id

Its constellation’s id

property message

Why, in words

property name

Its name, or ‘’