ATK.Models.Record

class ATK.Models.Record

Bases: Container

Container for storing rows of a Vizier catalogue. This object stores metadata describing the origin of the data along with the associated data table.

Attributes

catalogue	Vizier catalogue ID.
correction	Achieved degree of proper motion correction.
search_pos	Position of search at time of execution (i.e. post-correction).
survey	Alias to Vizier catalogue.
table	Returned Vizier table.

Methods

from_dataframe(target, data, **kwargs)	Construct a Record from a DataFrame.
from_table(target, data, **kwargs)	Construct a Record from a Table.
show([show_types, show_all])	Prints structure to stdout in a human-readable format.
to_dataframe()	Converts structure into a DataFrame.
to_hdu()	Converts structure into a FITS BinTableHDU.
to_table()	Converts structure into a Table.

Attribute Descriptions

catalogue: str | None = None

Vizier catalogue ID.

correction: str | None = None

Achieved degree of proper motion correction.

• 'full' = complete 3-dimensional projection on the sky.

• 'partial' = 2-dimensional plane projection.

• 'none' = no correction.

search_pos: SkyCoord | None = None

Position of search at time of execution (i.e. post-correction).

survey: str | None = None

Alias to Vizier catalogue.

table: Table | None = None

Returned Vizier table.

Method Descriptions

classmethod from_dataframe(target: Target | SkyCoord | int, data: DataFrame, **kwargs) → Self

Construct a Record from a DataFrame.

Parameters:

targetTarget, int, or SkyCoord

Astronomical target with which to associate input data.

Can be a Target, a Gaia Source ID (int), or a SkyCoord.

dataDataFrame

Tabular data containing the relevant fields (i.e. array-like attributes) required to construct a Record. Units are assumed to be as listed above.

**kwargs

Additional keyword arguments to be forwarded to the internal parser.

The following keyword arguments are required: catalogue

Returns:

Record

classmethod from_table(target: Target | SkyCoord | int, data: Table, **kwargs) → Self

Construct a Record from a Table.

Parameters:

targetTarget, int, or SkyCoord

Astronomical target with which to associate input data.

Can be a Target, a Gaia Source ID (int), or a SkyCoord.

dataTable

Tabular data containing the relevant fields (i.e. array-like attributes) required to construct a Record. Units are taken from the table where available, with missing units assumed to be those listed above.

**kwargs

Additional keyword arguments to be forwarded to the internal parser.

The following keyword arguments are required: catalogue

Returns:

Record

show(show_types=False, show_all=False)

Prints structure to stdout in a human-readable format.

Parameters:

show_typesbool, optional

If True, print data types of structure attributes.

Default is False

show_allbool, optional

If True, do not truncate printing of large iterables.

Default is False.

Returns:

self

to_dataframe() → DataFrame

Converts structure into a DataFrame.

to_hdu() → BinTableHDU

Converts structure into a FITS BinTableHDU.

Returns:

BinTableHDU

to_table() → Table

Converts structure into a Table.