Catalogs

class jdaviz.configs.imviz.plugins.catalogs.catalogs.Catalogs(*args, **kwargs)

Bases: PluginTemplateMixin, ViewerSelectMixin, HasFileImportSelect, TableMixin

See the Catalog Search Plugin Documentation for more details.

Only the following attributes and methods are available through the public plugin API:

• show()

• open_in_tray()

• close_in_tray()

• import_catalog()

• zoom_to_selected()

• search()

• max_sources

• catalog (SelectPluginComponent)

• table (Table): Table containing all search results.

• table_selected (Table): Table containing all selected search results.

Public constructor

Attributes Summary

catalog_items	An instance of a Python list.
catalog_selected	A trait for unicode strings.
headers
marks
max_sources	Mixin to handle empty integer field.
number_of_results	An int trait.
results_available	A boolean (True, False) trait.
table_selected_widget	A trait for unicode strings.
template_file
user_api
uses_active_status	A boolean (True, False) trait.

Methods Summary

import_catalog(catalog)	Import a catalog from a file path.
search([error_on_fail])	Search the catalog, display markers on the viewer, and return results if available.
vue_do_search(*args, **kwargs)
vue_zoom_in(*args, **kwargs)
zoom_to_selected([padding, return_bounding_box])	Zoom on the default viewer to a region containing the currently selected points in the catalog.

Attributes Documentation

catalog_items

An instance of a Python list.

catalog_selected

A trait for unicode strings.

headers = ['Right Ascension (degrees)', 'Declination (degrees)', 'Object ID', 'x_coord', 'y_coord']

marks

max_sources

Mixin to handle empty integer field.

number_of_results

An int trait.

results_available

A boolean (True, False) trait.

table_selected_widget

A trait for unicode strings.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/latest/lib/python3.11/site-packages/jdaviz/configs/imviz/plugins/catalogs/catalogs.py', 'catalogs.vue')

user_api

uses_active_status

A boolean (True, False) trait.

Methods Documentation

import_catalog(catalog)

Import a catalog from a file path.

Parameters:

catalogstr

Path to a file that can be parsed by astropy QTable

search(error_on_fail=False)

Search the catalog, display markers on the viewer, and return results if available.

Parameters:

error_on_failbool

Throw exception when query fails instead of a red snackbar message. This is useful for debugging.

Returns:

skycoordsSkyCoord or None

Sky coordinates (or None if no results available).

vue_do_search(*args, **kwargs)

vue_zoom_in(*args, **kwargs)

zoom_to_selected(padding=0.02, return_bounding_box=False)

Zoom on the default viewer to a region containing the currently selected points in the catalog.

Parameters:

paddingfloat, optional

A fractional value representing the padding around the bounding box of the selected points. It is applied as a proportion of the largest dimension of the current extent of loaded data. Defaults to 0.02.

return_bounding_boxbool, optional

If True, returns the bounding box of the zoomed region as ((x_min, x_max), (y_min, y_max)). Defaults to False.

Returns:

bblist of float or None

If there are activley selected rows, and return_bounding_box is True, returns a list containing the bounding box coordinates: [x_min, x_max, y_min, y_max]. Otherwise, returns None.