ATK.Models.DataPages#

class ATK.Models.DataPages[source]#

Bases: object



Attributes

targets

Targets for which datapages have been generated.

figures

Stored datapages.

Methods

open(target[, fname])

Matches a datapage from figures to a specific target before opening it in the default browser.

save(target, fname)

Matches a datapage from figures to a specific target before saving it to local files.

show([show_types, show_all])

Prints structure to stdout in a human-readable format.


Attribute Descriptions

targets: list[Target]#

Targets for which datapages have been generated.

figures: list[GridBox]#

Stored datapages.


Method Descriptions

open(target: Target | int, fname: Path | str | None = None) → Self[source]#

Matches a datapage from figures to a specific target before opening it in the default browser.

Optionally, the datapage can also be saved to local files.

Parameters:
targetTarget or int

Target to which a datapage should be matched.

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

fnamePath | str, optional

Path to which the matched datapage should be saved.

If not provided, matched datapages are saved to the ~/.AstroToolkit/cached_figures directory.

save(target: Target | int, fname: Path | str) → Self[source]#

Matches a datapage from figures to a specific target before saving it to local files.

Parameters:
targetTarget or int

Target to which a datapage should be matched.

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

fnamePath | str

Path to which the matched datapage should be saved.

show(show_types=False, show_all=False)[source]#

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