Catalogs

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

Bases: PluginTemplateMixin, ViewerSelectMixin, HasFileImportSelect

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

Public constructor

Attributes Summary

catalog_items	An instance of a Python list.
catalog_selected	A trait for unicode strings.
number_of_results	An int trait.
results_available	A boolean (True, False) trait.
template_file

Methods Summary

clear([hide_only])
import_catalog(catalog)	Import a catalog from a file path.
search(*args, **kwargs)
vue_do_clear(*args, **kwargs)
vue_do_search(*args, **kwargs)

Attributes Documentation

catalog_items

An instance of a Python list.

catalog_selected

A trait for unicode strings.

number_of_results

An int trait.

results_available

A boolean (True, False) trait.

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

Methods Documentation

clear(hide_only=True)

import_catalog(catalog)

Import a catalog from a file path.

Parameters:

catalogstr

Path to a file that can be parsed by astropy QTable

search(*args, **kwargs)

vue_do_clear(*args, **kwargs)

vue_do_search(*args, **kwargs)