Reference
The Earth-orbit catalogue: orbit class, object kind, colours, fleets and the packed file format (no data)
import { … } from "@johnmorrisdotca/chikyu-earth/catalogue";Exports
| Name | Kind | What it is |
|---|---|---|
CatalogueRead | type | What readCatalogueRecords found: the records that can be used, and how many were left out (a number missing or not a number, or an orbit that is not an ellipse). |
CatalogueRecord | type | One object of the catalogue: its element set (the OMM numbers every source serves), what kind of object it is, and what the catalogue says of its owner and launch. |
CLASS_COLOURS | constant | The colour of each class on a dark background: green, yellow, red, violet and grey. |
CLASS_LABELS | constant | The words for each class, in English and Japanese, with the rule that makes it (heights above the mean Earth radius). |
CLASS_LIMITS | constant | The numbers behind the classes: the highest point a low orbit may have (2,000 km), the eccentricity from which an orbit is highly elliptical (0.25), and how far from 35,786 km the lowest and highest points of a geostationary orbit may be (1,500 km). |
classOfElements | function | The class of an orbit straight from the two numbers every element set has, its mean motion (revolutions a day) and its eccentricity; null when they are not an orbit. |
countFleets | function | How many of each fleet a list of objects holds, and how many objects there are in all: what a filter shows as "N of M". |
Fleet | type | A fleet: a group of satellites that belong together, found by the pattern its members' names follow. |
fleetOf | function | The fleet an object belongs to, from its name and kind, or undefined. |
FLEETS | constant | The fleets, in the order a filter lists them. |
GEO_ALTITUDE_KM | constant | The height of the geostationary orbit above the equator, in kilometres: the radius of a circular orbit that goes round once a sidereal day (42,164 km) less the equatorial radius (6,378 km). |
gzipBytes | function | Gzip bytes, with the web's own CompressionStream: the form a site hosts a packed file in. |
KIND_COLOURS | constant | The colour of each kind on a dark background: cyan payloads, orange rocket bodies, grey debris and pale unknowns. |
KIND_LABELS | constant | The words for each kind, in English and Japanese. |
legend | function | The legend for colouring by class or by kind, in the page's language. |
LegendEntry | type | One line of a legend: what it is called, in the page's language, and its colour. |
MAX_PACKED | constant | The most records one packed file holds: the data door's own limit, 200,000. |
MAX_PACKED_BYTES | constant | The most bytes a packed file may unpack to (64 MB): a file that claims more is refused before it is read. |
OBJECT_KINDS | constant | The four kinds, in the order a legend lists them. |
ObjectKind | type | What a catalogued object is: PAY a payload (a satellite or probe), RB a rocket body, DEB debris, UNK unknown. |
ORBIT_CLASSES | constant | The five classes, in the order a legend lists them. |
orbitClass | function | The class an orbit falls in. |
OrbitClass | type | The class of an orbit: low (leo), medium (meo), geostationary (geo), highly elliptical (heo), or other for what fits none of them. |
orbitShape | function | The shape of an orbit from the two numbers every element set has: its mean motion (revolutions a day) by Kepler's third law, and its eccentricity. |
OrbitShape | type | The size and shape of an orbit. |
OWNER_COUNTRIES | constant | Every owner code of the satellite catalogue with its country as an ISO 3166-1 alpha-2 code, or null where the owner is not one country: an organisation (ESA, ISS, ITSO, SES, GLOB, ...), several countries (FGER, France and Germany; PRES, China and ESA), not known (UNK, TBD), or not one country (CIS, the former Soviet registration). |
ownerCountry | function | The country of a satellite's owner code as an ISO 3166-1 alpha-2 code (PRC is CN, PAKI is PK, US is US), or undefined for an organisation, several countries, an ambiguous owner or a code that is not in the list. |
packCatalogue | function | Pack catalogue records into one file: a small header (the format, how many records, and meta, a few words of text such as where the data is from and when it was retrieved), a column for each number and, last, the names. |
PackedCatalogue | type | A packed file, read: the columns as typed arrays (nothing is copied into objects until you ask) and the names. |
PackError | class | A packed file that cannot be read: it is not a packed file, it is cut short, it holds more than MAX_PACKED records, or it unpacks to more than MAX_PACKED_BYTES. |
RadarSize | type | The radar size class Space-Track gives an object: small (under 0.1 square metres), medium or large (over 1). |
readCatalogueRecords | function | Read catalogue records from OMM text, as JSON (a list of objects) or CSV (a header row, then a row for each object). |
readKind | function | The kind a source's object type means: Space-Track says PAYLOAD, ROCKET BODY, DEBRIS or TBA, other lists say PAY, R/B, DEB or UNK; any other word, or none, is UNK. |
unpackAny | function | Read a packed file whether or not it is gzipped (gzip is found from its first two bytes). |
unpackCatalogue | function | Read a packed file (not gzipped: see unpackAny). |