opihiexarata.photometry.panstarrs module

Photometric database access using PANSTARRS data. There are a few ways and they are implemented here.

class opihiexarata.photometry.panstarrs.PanstarrsMastWebAPIEngine(verify_ssl: bool = True)[source]

Bases: PhotometryEngine

This is a photometric data extractor using PanSTARRS data obtained from their catalogs via the MAST API.

See https://catalogs.mast.stsci.edu/docs/panstarrs.html for more information.

__init__(verify_ssl: bool = True) → None[source]

Create the instance of the API.

Parameters:: verify_ssl (boolean, default = True) – Connecting to the MAST API usually uses SSL verification via HTTPS, set to False to allow bypassing this.
Return type:: None

_mask_table_data(data_table: Table) → Table[source]

This masks the raw data derived from PanSTARRS, implementing the masking/null value specifics of the PanSTARRS system.

The point of this is to make masked or invalid data more typical to the user by abstracting the idiosyncrasies of PanSTARRS.

Parameters:: data_table (Astropy Table) – The data table to be cleaned up.
Returns:: masked_data_table – The masked table.
Return type:: Astropy Table

cone_search(ra: float, dec: float, radius: float, detections: int = 3, color_detections: int = 1, columns: list[str] = None, max_rows: int = 1000, data_release: int = 2) → Table[source]

Search the PanSTARRS database for targets within a cone region specified.

The table data returned from this function is not processed and is raw from the fetching of the results.

Parameters:

ra (float) – The right ascension of the center point of the cone search, in degrees.
dec (float) – The declination of the center point of the cone search, in degrees.
radius (float) – The radius from the center point of the cone search in which to search, in degrees.
detections (int, default = 3) – The minimum number of detections each object needs to have to be included.
color_detections (int, default = 1) – The minimum number of detections for the g, r, i, z filters of the Sloan filters of PanSTARRS. As this is a photometric engine for OpihiExarata, the filters should be the ones pertinent to the telescope.
columns (list) – The columns that are desired to be pulled. The purpose of this is to lighten the data download load. If None, then it defaults to all columns.
max_rows (int, default = 1000) – The maximum entries that will be pulled from the server.
data_release (int, default = 2) – The PanSTARRS data release version from which to take the data from.

Returns:

catalog_results – The result of the cone search, pulled from the PanSTARRS catalog.

Return type:

Astropy Table

masked_cone_search(*args, **kwargs) → Table[source]

The same as cone_search, but it also masks the data based on the masking idiosyncrasies of PanSTARRS.

Parameters:: cone_search) ((see) –
Returns:: masked_catalog_results – The data from the cone search with the entries masked where appropriate.
Return type:: Astropy Table