ATK.Models.Image

class ATK.Models.Image

Bases: Container

Container for storing image data. This object stores both data and relevant metadata.

Units

The following attributes are automatically converted to Quantity with a default unit unless one is explictly provided:

• size - arcsec

Plotting Arguments

The following keyword arguments are accepted when plotting via plot() or open().

cmap{‘viridis’, ‘grey’, ‘false_colour’}, optional

Sets the image colour map.

false_colour maps the wavelength of the image filter into a single RGB colour.

Default is 'viridis'.

relative_axesbool, optional

Sets the format of the coordinate axes.

True: coordinate axes display distance from the image centre.

False: coordinate axes display positions on the sky.

Default is True.

Attributes

band	Photometric band of stored data.
correction	Achieved degree of proper motion correction.
epoch	Epoch of stored image.
hdu	Raw image data and header.
overlay	Photometric overlay data.
search_pos	Position of search at time of execution (i.e. post-correction).
size	Size of stored image.
survey	Survey from which the stored data originates.
wcs	World coordinate system of stored image.

Methods

show([show_types, show_all])	Prints structure to stdout in a human-readable format.
to_hdu()	Converts structure into a FITS ImageHDU.

Attribute Descriptions

band: str | None = None

Photometric band of stored data.

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.

epoch: Time | None = None

Epoch of stored image.

hdu: ImageHDU | None = None

Raw image data and header.

overlay: DataFrame | None = None

Photometric overlay data.

Each row corresponds to a single detection, and contains:

• surveystr

  Survey name (e.g. 'gaia').

• rafloat

  Right ascension (deg).

• decfloat

  Declination (deg).

• pm_ra_cosdecfloat

  Proper motion in RA direction (mas/yr).

• pm_decfloat

  Proper motion in Dec direction (mas/yr).

• distfloat

  Distance to source, as derived from parallax (pc).

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

  Achieved level of proper motion correction.

• mag_namestr

  Name of magnitude band.

• magfloat

  Apparent magnitude.

• err_namestr

  Name of magnitude uncertainty field.

• errfloat

  Magnitude uncertainty.

• simbad_idstr or None

  Primary name in SIMBAD (None if no match was found).

search_pos: SkyCoord | None = None

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

size: Quantity | None = None

Size of stored image.

survey: str | None = None

Survey from which the stored data originates.

wcs: WCS | None = None

World coordinate system of stored image.

Method Descriptions

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_hdu() → ImageHDU

Converts structure into a FITS ImageHDU.

Returns:

ImageHDU