ATK.Models.SED

class ATK.Models.SED

Bases: Container, DataFrameIOMixin, TableIOMixin, FITSIOMixin

Container for storing spectral energy distribution 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:

• flux - mJy

• flux_err - mJy

• separation - arcsec

• wavelength - Å

Data Methods

The following Data Methods are supported by SED - either individually or through DataSet.apply():

• crop()

Plotting Arguments

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

overlaySpectrum, optional

Overlays a spectrum.

By default, no spectrum is overlayed.

Attributes

band	Photometric bands.
correction	Achieved degree of proper motion correction.
flux	Flux values.
flux_err	Flux error values.
id	Per-survey object IDs.
separation	Separation between position of the search and the returned photometric detections.
survey	Survey from which the stored data originates.
wavelength	Wavelength values.

Methods

crop([cmin, cmax, inplace])	Bins all array-like attributes into a number of bins or a bin size in x (i.e. wavelength).
from_dataframe(target, data, **kwargs)	Construct a SED from a DataFrame.
from_table(target, data, **kwargs)	Construct a SED from a Table.
show([show_types, show_all])	Prints structure to stdout in a human-readable format.
to_dataframe()	Combines all array-like attributes of a structure into a DataFrame.
to_hdu()	Converts structure into a FITS BinTableHDU.
to_table()	Combines all array-like attributes of a structure into a Table, preserving units.

Attribute Descriptions

band: ndarray | None = None

Photometric bands.

correction: ndarray | None = None

Achieved degree of proper motion correction.

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

• 'partial' = 2-dimensional plane projection.

• 'none' = no correction.

flux: Quantity | None = None

Flux values.

flux_err: Quantity | None = None

Flux error values.

id: ndarray | None = None

Per-survey object IDs.

separation: Quantity | None = None

Separation between position of the search and the returned photometric detections.

survey: ndarray | None = None

Survey from which the stored data originates.

wavelength: Quantity | None = None

Wavelength values.

Method Descriptions

crop(cmin: float | None = None, cmax: float | None = None, inplace=True)

Bins all array-like attributes into a number of bins or a bin size in x (i.e. wavelength).

Exactly one of bin or size must be provided.

Parameters:

binsint, optional

Number of bins in which to bin data.

sizefloat or Quantity, optional

Size of each bin in which to bin data. If a Unit is not provided, size is assumed to be in the same unit as x.

inplacebool, optional

If True, modify the current SED inplace. If False, operate on and return a copy - leaving the original unchanged.

Returns:

Self

The binned SED. Returns self if inplace=True, otherwise returns a new instance.

classmethod from_dataframe(target, data, **kwargs)

Construct a SED 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 SED. 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: survey

Returns:

SED

classmethod from_table(target, data, **kwargs)

Construct a SED 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 SED. 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: survey

Returns:

SED

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()

Combines all array-like attributes of a structure into a DataFrame.

Units are not preserved.

Returns:

DataFrame

to_hdu() → BinTableHDU

Converts structure into a FITS BinTableHDU.

Returns:

BinTableHDU

to_table()

Combines all array-like attributes of a structure into a Table, preserving units.

Returns:

Table