ATK.Models.DataTable#

class ATK.Models.DataTable[source]#

Bases: Container

Container for storing target-matched data from a subset of one or multiple Vizier catalogue.



Attributes

table

Target-matched subset of one or more Vizier catalogues, combined into a single Table.

Methods

from_dataframe(target, data, **kwargs)

Construct a DataTable from a DataFrame.

from_table(target, data, **kwargs)

Construct a DataTable 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

table: Table | None = None#

Target-matched subset of one or more Vizier catalogues, combined into a single Table.

Each row contains:

  • surveystr

    Alias to Vizier catalogue.

  • cataloguestr

    Identifier of the source catalogue providing the measurement, (e.g. 'I/355/gaiadr3' for Gaia DR3, 'II/349/ps1' for Pan-STARRS).

  • correction{‘full’, ‘partial’, ‘none’}

    Achieved level of proper motion correction.

  • parameterstr

    Vizier column name, (e.g. 'Gmag', 'BPmag', 'rmag').

  • valuefloat

    Value in column given by parameter.

  • unitstr

    Unit of value.

  • separationfloat

    Separation between position of the search and the returned Vizier row.


Method Descriptions

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

Construct a DataTable 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 DataTable. 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: None

Returns:
DataTable
classmethod from_table(target: Target | SkyCoord | int, data: Table, **kwargs) → Self[source]#

Construct a DataTable 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 DataTable. 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: None

Returns:
DataTable
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[source]#

Converts structure into a DataFrame.

to_hdu()[source]#

Converts structure into a FITS BinTableHDU.

Returns:
BinTableHDU
to_table() → Table[source]#

Converts structure into a Table.