Aller au contenu

omnilab/gaia Référence de l’API

Étage
Fournisseur · Omnilab
Version
1.x
Suite de conformité
non branchée
Vérifié en réel
Son README ne le dit pas
Licence
MIT
composer require omnilab/gaia:1.x-dev

Lue dans les fichiers PHP du paquet au commit 4411c907ea11 : ses espaces de noms, classes, interfaces et énumérations, leurs constantes, propriétés et méthodes publiques avec leur PHPDoc, et les options que prennent ses fabriques. Rien n’en est exécuté.

Omnilab\Gaia

  • GaiaSource class

    Gaia DR3, the third data release of ESA's Gaia mission (1.8 billion sources), through the ESA Gaia Archive's TAP service in ADQL: a source by its source_id or its designation ("Gaia DR3 4472832130942575872") - its astrometry (position at epoch J2016.0, parallax, proper motion, RUWE), its photometry (G, BP, RP, G_RVS), its radial velocity and line broadening, its astrophysical parameters when DR3 has them (GSP-Phot's temperature, gravity, metallicity, distance, extinction; FLAME's radius, mass, luminosity and age; Apsis's spectral type), the probabilities that it is a star, a quasar or a galaxy, and its Hipparcos number; cone() gives the sources around a point of the sky (outside the contract: the core's places are on the Earth).

    6 methods · 2 constants

  • GaiaSourceFactory class

    Gaia DR3 from the ESA Gaia Archive: a source's astrometry, photometry, radial velocity and astrophysical parameters by its source_id, and the sources of a cone on the sky - no key needed.

    2 options

Omnilab\Gaia

GaiaSource class

final class GaiaSource extends HttpSource GaiaSource.php:42

Gaia DR3, the third data release of ESA's Gaia mission (1.8 billion sources), through the ESA Gaia Archive's TAP service in ADQL: a source by its source_id or its designation ("Gaia DR3 4472832130942575872") - its astrometry (position at epoch J2016.0, parallax, proper motion, RUWE), its photometry (G, BP, RP, G_RVS), its radial velocity and line broadening, its astrophysical parameters when DR3 has them (GSP-Phot's temperature, gravity, metallicity, distance, extinction; FLAME's radius, mass, luminosity and age; Apsis's spectral type), the probabilities that it is a star, a quasar or a galaxy, and its Hipparcos number; cone() gives the sources around a point of the sky (outside the contract: the core's places are on the Earth).

The core has no scheme for Gaia: a source is named in the simbad scheme by its designation, "Gaia DR3 <source_id>", the name SIMBAD resolves for the sources it lists - see docs/index.md.

No key, no account. An anonymous synchronous query has 10 s on the archive's side (an answer takes 7 to 13 s from asking to reading): beyond, the archive answers 408, an UnavailableException here. One call an entity, one a cone's page.

const BASE_URI = 'https://gea.esac.esa.int/tap-server/tap/'
const MAX_LIMIT = 2000

The most sources a cone's page holds (an anonymous query returns 50,000 rows at most).

GaiaSource::__construct()

public function __construct(HttpClientInterface $http, string $baseUri = self::BASE_URI, array $headers = [], float $throttle = 0.0)

GaiaSource::getName()

public function getName(): string

GaiaSource::capabilities()

public function capabilities(): array

GaiaSource::entity()

public function entity(Identifier|string $id): ?Entity

A source by its source_id ("4472832130942575872") or its designation ("Gaia DR3 4472832130942575872", "simbad:Gaia DR3 ...", an Identifier of the simbad scheme); another name - a star's ("* alf Ori", "HIP 87937"), Gaia DR2's - is refused before any call (the archive resolves no name). Null when DR3 has no such source.

GaiaSource::cone()

public function cone(float $ra, float $dec, float $radius, int $limit = 50, ?float $maxMagnitude = null, ?string $cursor = null): Page

The sources within a radius of a point of the sky, the nearest first, one page at a time (outside the contract: the core's Point and BBox are places on the Earth, and occurrences() asks each answer for a time and a place there - a cone on the sky is neither). Each entity has what gaia_source holds (no FLAME parameters, no Hipparcos number: entity() reads them) and its separation from the point.

$gaia->cone(266.4168, -29.0078, 0.02, limit: 10); // around Sgr A*

$ra

right ascension, degrees (ICRS)

$dec

declination, degrees (ICRS)

$radius

degrees

$maxMagnitude

only the sources at least this bright in G

$cursor

the Page::$next of the page before

GaiaSource::sourceId()

public static function sourceId(Identifier|string $id): ?string

The source_id an identifier gives: digits, "Gaia DR3 " and digits, an Identifier of the gaia scheme, or its designation in the simbad scheme (as SIMBAD names it).

GaiaSourceFactory class

final class GaiaSourceFactory extends SourceFactory GaiaSourceFactory.php:20

Gaia DR3 from the ESA Gaia Archive: a source's astrometry, photometry, radial velocity and astrophysical parameters by its source_id, and the sources of a cone on the sky - no key needed.

options: mailto: 'support@glitchr.io' # in the User-Agent: whom the archive writes to before it blocks a caller throttle: 0 # seconds between two calls: the archive limits active queries, not their rate base_uri: 'https://gea.esac.esa.int/tap-server/tap/'

Options

OptionDefault
throttle0.0
base_uriGaiaSource::BASE_URI