omnilab/vizier API reference

Omnilab\Vizier

Row class

final readonly class Row Row.php:13

One row of a VizieR table (outside the contract): its table, its separation from the point asked, and its values by column - each a Property whose key is the column's name, whose label is VizieR's description, and whose value is a Quantity when the column has a unit.

public string $table

public ?float $separation

public array $values

Row::__construct()

public function __construct(public string $table, public ?float $separation, public array $values)

Row::value()

public function value(string $column): mixed

A column's value: a Quantity, a number, a text; null when empty or absent.

VizierSource class

final class VizierSource extends HttpSource VizierSource.php:27

VizieR, the CDS's library of published astronomical catalogues (Strasbourg), through its TAP service: the tables whose description holds a text, as datasets (datasets(): a Product per table, its id the table's name, I/239/hip_main), and, outside the contract, the rows of a table around a point of the sky or an object (rows(), rowsOf()).

No key. VizieR's ADQL has no OFFSET, no ILIKE and no LOWER: a search is one page, and asks each word as written, lower case, capitalised and upper case.

const BASE_URI = 'https://tapvizier.cds.unistra.fr/TAPVizieR/tap/'

const MAX_LIMIT = 1000

The most tables a search gives, the most rows a cone.

VizierSource::__construct()

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

VizierSource::getName()

public function getName(): string

VizierSource::capabilities()

public function capabilities(): array

VizierSource::datasets()

public function datasets(Query $query): Page

The tables whose description holds every word of the text, the largest first (VizieR ranks nothing), one page: Page::$next is always null, and Page::$total known when fewer than the limit were found. Each a Product: its id the table's name (I/239/hip_main), its collection the catalogue's (I/239), its title and authors, its rows.

VizierSource::rows()

public function rows(string $table, float $ra, float $dec, float $radius = 5 / 3600, int $limit = 50): array

The rows of a table within a radius of a point of the sky, the nearest first, by the table's main position columns (its pos.eq.ra;meta.main and pos.eq.dec;meta.main: one call to read them, one for the rows). Outside the contract: the core's places are on the Earth, and a row is no entity of its own.

$table

VizieR's name: I/239/hip_main, I/355/gaiadr3

$ra

degrees (ICRS / J2000)

$dec

degrees

$radius

degrees (5 arcseconds by default)

VizierSource::rowsOf()

public function rowsOf(string $table, Entity $object, float $radius = 5 / 3600, int $limit = 50): array

The rows of a table around an entity that has a position on the sky - its "ra" and "dec" properties in degrees, as omnilab/simbad, omnilab/ned and omnilab/gaia give them.

VizierSourceFactory class

final class VizierSourceFactory extends SourceFactory VizierSourceFactory.php:20

VizieR, the CDS's library of published astronomical catalogues: its tables by text, and the rows of a table around a point of the sky - no key needed.

options: mailto: 'support@glitchr.io' # in the User-Agent throttle: 0 # seconds between two calls: the CDS publishes no rate for TAP base_uri: 'https://tapvizier.cds.unistra.fr/TAPVizieR/tap/'

Options