API

Core

jdaviz.core.events Module

Classes

NewViewerMessage(cls, data[, x_attr])	Message to trigger viewer creation in the application.
ViewerAddedMessage(viewer_id, *args, **kwargs)	Unlike NewViewerMessage, this should be emitted after a viewer is created.
ViewerRemovedMessage(viewer_id, *args, **kwargs)	Message emitted after a viewer is destroyed by the application.
LoadDataMessage(path, *args, **kwargs)	Create a new message
AddDataMessage(data, viewer[, viewer_id])	Create a new message
SnackbarMessage(text[, color, timeout, loading])	Create a new message
RemoveDataMessage(data, viewer[, viewer_id])	Create a new message
AddLineListMessage(table, *args, **kwargs)	Create a new message
RowLockMessage(is_locked, *args, **kwargs)	Create a new message
SliceSelectWavelengthMessage([wavelength])	Message generated by the select slice plot plugin which is processed by the cubeviz helper
SliceSelectSliceMessage([slice])	Message generated by the cubeviz helper and processed by the slice plugin to sync slice selection across all viewers
SliceToolStateMessage(change, *args, **kwargs)	Message generated by the select slice plot plugin when activated/deactivated
TableClickMessage(selected_index[, shared_image])	Message generated by Mosviz table to zoom to object on image

jdaviz.core.helpers Module

Helper classes are meant to provide a convenient user API for specific configurations. They allow a separation of “viztool-specific” API and the glue application objects.

See also https://github.com/spacetelescope/jdaviz/issues/104 for more details on the motivation behind this concept.

Classes

ConfigHelper([app, verbosity])

The Base Helper Class.

jdaviz.core.registries Module

Classes

ViewerRegistry()	Registry containing references to custom viewers.
TrayRegistry()	Registry containing references to plugins that will be added to the sidebar tray tabs.
ToolRegistry()	Registry containing references to plugins which will populate the application-level toolbar.
MenuRegistry()	Registry containing references to plugins that will populate the application-level menu bar.
DataParserRegistry()	Registry containing parsing functions for attempting to auto-populate the application-defined initial viewers.
UniqueDictRegistry()	Base registry class that handles hashmap-like associations between a string representation of a plugin and the class to be instantiated.

jdaviz.core.template_mixin Module

Classes

TemplateMixin(*args, **kwargs)	Public constructor
PluginTemplateMixin(*args, **kwargs)	This base class can be inherited by all sidebar plugins to expose common functionality.
BasePluginComponent(plugin, **kwargs)	This base class handles attaching traitlets from the plugin itself to logic handled within the component, support for caching and clearing caches on properties, and common properties for accessing the app, etc.
BaseSelectPluginComponent(**kwargs)	This base class extends BasePluginComponent for common functionality for a select/dropdown component.
SubsetSelect(**kwargs)	Traitlets (in the object, custom traitlets in the plugin):
SpatialSubsetSelectMixin(**kwargs)	Applies the SubsetSelect component as a mixin in the base plugin.
SpectralSubsetSelectMixin(**kwargs)	Applies the SubsetSelect component as a mixin in the base plugin.
ViewerSelect(**kwargs)	Traitlets (in the object, custom traitlets in the plugin):
ViewerSelectMixin(**kwargs)	Applies the ViewerSelect component as a mixin in the base plugin.
DatasetSelect(**kwargs)	Traitlets (in the object, custom traitlets in the plugin):
DatasetSelectMixin(**kwargs)	Applies the DatasetSelect component as a mixin in the base plugin.
AutoLabel(plugin, value, default, auto, ...)	Traitlets (in the object, custom traitlets in the plugin):
AutoLabelMixin(**kwargs)	Applies the AutoLabel component as a mixin in the base plugin.
AddResults(plugin, label, label_default, ...)	Traitlets (in the object, custom traitlets in the plugin):
AddResultsMixin(**kwargs)	Applies the AddResults component as a mixin in the base plugin.

jdaviz.core.astrowidgets_api Module

Classes

AstrowidgetsImageViewerMixin()

This class implements astrowidgets API for Jdaviz image viewer.

jdaviz.core.region_translators Module

The region_translators module houses translations of Region Shapes to Aperture Photometry (photutils.aperture) apertures.

Functions

regions2aperture(region_shape)	Convert a given regions shape to photutils aperture.
aperture2regions(aperture)	Convert a given photutils aperture to regions shape.

Application

jdaviz.app Module

Classes

Application(**kwargs)

The main application object containing implementing the ipyvue/vuetify template instructions for composing the interface.

Configurations

jdaviz.configs.default Package

Classes

Collapse(*args, **kwargs)	Public constructor
DataTools(*args, **kwargs)	Public constructor
ExportViewer(*args, **kwargs)	Public constructor
GaussianSmooth(*args, **kwargs)	Public constructor
JdavizViewerMixin(*args, **kwargs)
LineListTool(*args, **kwargs)	Public constructor
MetadataViewer(*args, **kwargs)	Public constructor
ModelFitting(*args, **kwargs)	Public constructor
PlotOptions(*args, **kwargs)	Public constructor
SubsetTools(*args, **kwargs)	Public constructor
ViewerCreator(*args, **kwargs)	Public constructor

jdaviz.configs.default.plugins.line_lists.line_list_mixin Module

Classes

LineListMixin()

Line list-related methods and properties for use in the configuration helper classes.

jdaviz.configs.cubeviz Package

Functions

parse_data(app, file_obj[, data_type, ...])

Attempts to parse a data file and auto-populate available viewers in cubeviz.

Classes

CubeViz(*args, **kwargs)	This class is pending deprecation.
Cubeviz(*args, **kwargs)	Cubeviz Helper class
CubevizImageView(*args, **kwargs)
CubevizProfileView(*args, **kwargs)
MomentMap(*args, **kwargs)	Public constructor
SelectSlice(viewer, **kwargs)
Slice(*args, **kwargs)	Public constructor

jdaviz.configs.imviz.helper Module

Functions

link_image_data(app[, link_type, ...])

(Re)link loaded data in Imviz with the desired link type.

Classes

Imviz(*args, **kwargs)

Imviz Helper class.

jdaviz.configs.imviz.plugins Package

Functions

parse_data(app, file_obj[, ext, data_label])

Parse a data file into Imviz.

Classes

Compass(*args, **kwargs)	Public constructor
CoordsInfo(*args, **kwargs)	Public constructor
ImageViewerCreator(*args, **kwargs)	Public constructor
ImvizImageView(*args, **kwargs)
LineProfileXY(*args, **kwargs)	Public constructor
LinksControl(*args, **kwargs)	Public constructor
SimpleAperturePhotometry(*args, **kwargs)	Public constructor

jdaviz.configs.mosviz Package

Functions

jwst_header_to_skyregion(header)
mos_image_parser(app, data_obj[, ...])	Attempts to parse an image-like object or list of images.
mos_spec1d_parser(app, data_obj[, data_labels])	Attempts to parse a 1D spectrum object.
mos_spec2d_parser(app, data_obj[, ...])	Attempts to parse a 2D spectrum object.

Classes

MosViz(*args, **kwargs)	This class is pending deprecation.
Mosviz(*args, **kwargs)	Mosviz Helper class
MosvizImageView(*args, **kwargs)
MosvizProfile2DView(*args, **kwargs)
MosvizProfileView(*args, **kwargs)
MosvizTableViewer(session, *args, **kwargs)
RowLock(*args, **kwargs)	Public constructor
SlitOverlay(*args, **kwargs)	Public constructor

jdaviz.configs.specviz Package

Functions

specviz_spectrum1d_parser(app, data[, ...])

Loads a data file or Spectrum1D object into Specviz.

Classes

LineAnalysis(*args, **kwargs)	Public constructor
SpecViz(*args, **kwargs)	This class is pending deprecation.
Specviz(*args, **kwargs)	Specviz Helper class.
SpecvizProfileView(*args, **kwargs)
UnitConversion(*args, **kwargs)	Public constructor

jdaviz.configs.specviz2d Package

Functions

spec2d_1d_parser(app, data_obj[, ...])

Generate a quicklook 1D spectrum from an input 2D spectrum by summing over the cross-dispersion axis.

Classes

Specviz2d(*args, **kwargs)

Specviz2D Helper class