API

Configurations

jdaviz.configs.cubeviz.helper Module

Classes

Cubeviz(*args, **kwargs)

Cubeviz Helper class

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.mosviz.helper Module

Classes

Mosviz(*args, **kwargs)

Mosviz Helper class

jdaviz.configs.specviz.helper Module

Classes

Specviz(*args, **kwargs)

Specviz Helper class.

jdaviz.configs.specviz2d.helper Module

Classes

Specviz2d(*args, **kwargs)

Specviz2D Helper class

Viewers

jdaviz.configs.default.plugins.viewers Module

Classes

JdavizViewerMixin(*args, **kwargs)

jdaviz.configs.cubeviz.plugins.viewers Module

Classes

`CubevizImageView`(args, *kwargs)
`CubevizProfileView`(args, *kwargs)

jdaviz.configs.imviz.plugins.viewers Module

Classes

ImvizImageView(*args, **kwargs)

jdaviz.configs.mosviz.plugins.viewers Module

Classes

`MosvizImageView`(args, *kwargs)
`MosvizProfile2DView`(args, *kwargs)
`MosvizTableViewer`(session, args, *kwargs)

jdaviz.configs.specviz.plugins.viewers Module

Classes

SpecvizProfileView(*args, **kwargs)

Parsers

jdaviz.configs.cubeviz.plugins.parsers Module

Functions

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

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

jdaviz.configs.imviz.plugins.parsers Module

Functions

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

Parse a data file into Imviz.

jdaviz.configs.mosviz.plugins.parsers Module

Functions

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

jdaviz.configs.specviz.plugins.parsers Module

Functions

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

Loads a data file or Spectrum1D object into Specviz.

jdaviz.configs.specviz2d.plugins.parsers Module

Functions

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

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

Plugins

jdaviz.configs.default.plugins.collapse.collapse Module

Classes

Collapse(*args, **kwargs)

See the Collapse Plugin Documentation for more details.

jdaviz.configs.default.plugins.data_tools.data_tools Module

Classes

DataTools(*args, **kwargs)

Public constructor

jdaviz.configs.default.plugins.export_plot.export_plot Module

Classes

ExportViewer(*args, **kwargs)

See the Export Plot Plugin Documentation for more details.

jdaviz.configs.default.plugins.gaussian_smooth.gaussian_smooth Module

Classes

GaussianSmooth(*args, **kwargs)

See the Gaussian Smooth Plugin Documentation for more details.

jdaviz.configs.default.plugins.line_lists.line_lists Module

Classes

LineListTool(*args, **kwargs)

Public constructor

jdaviz.configs.default.plugins.metadata_viewer.metadata_viewer Module

Classes

MetadataViewer(*args, **kwargs)

See the Metadata Viewer Plugin Documentation for more details.

jdaviz.configs.default.plugins.model_fitting.model_fitting Module

Classes

ModelFitting(*args, **kwargs)

See the Model Fitting Plugin Documentation for more details.

jdaviz.configs.default.plugins.plot_options.plot_options Module

Classes

PlotOptions(*args, **kwargs)

The Plot Options Plugin gives access to per-viewer and per-layer options and enables setting across multiple viewers/layers simultaneously.

jdaviz.configs.default.plugins.subset_plugin.subset_plugin Module

Classes

SubsetPlugin(*args, **kwargs)

Public constructor

jdaviz.configs.default.plugins.subset_tools.subset_tools Module

Classes

SubsetTools(*args, **kwargs)

Public constructor

jdaviz.configs.default.plugins.viewer_creator.viewer_creator Module

Classes

ViewerCreator(*args, **kwargs)

Public constructor

jdaviz.configs.cubeviz.plugins.moment_maps.moment_maps Module

Classes

MomentMap(*args, **kwargs)

See the Moment Maps Plugin Documentation for more details.

jdaviz.configs.cubeviz.plugins.slice.slice Module

Classes

Slice(*args, **kwargs)

See the Slice Plugin Documentation for more details.

jdaviz.configs.imviz.plugins.aper_phot_simple.aper_phot_simple Module

Classes

SimpleAperturePhotometry(*args, **kwargs)

Public constructor

jdaviz.configs.imviz.plugins.catalogs.catalogs Module

Classes

Catalogs(*args, **kwargs)

See the Catalog Search Plugin Documentation for more details.

jdaviz.configs.imviz.plugins.compass.compass Module

Classes

Compass(*args, **kwargs)

See the Compass Plugin Documentation for more details.

jdaviz.configs.imviz.plugins.coords_info.coords_info Module

Classes

CoordsInfo(*args, **kwargs)

Public constructor

jdaviz.configs.imviz.plugins.image_viewer_creator.image_viewer_creator Module

Classes

ImageViewerCreator(*args, **kwargs)

Public constructor

jdaviz.configs.imviz.plugins.line_profile_xy.line_profile_xy Module

Classes

LineProfileXY(*args, **kwargs)

Public constructor

jdaviz.configs.imviz.plugins.links_control.links_control Module

Classes

LinksControl(*args, **kwargs)

See the Links Control Plugin Documentation for more details.

jdaviz.configs.mosviz.plugins.row_lock.row_lock Module

Classes

RowLock(*args, **kwargs)

Public constructor

jdaviz.configs.mosviz.plugins.slit_overlay.slit_overlay Module

Functions

jwst_header_to_skyregion(header)

Classes

SlitOverlay(*args, **kwargs)

Public constructor

jdaviz.configs.specviz.plugins.line_analysis.line_analysis Module

Classes

LineAnalysis(*args, **kwargs)

The Line Analysis plugin returns specutils analysis for a single spectral line.

jdaviz.configs.specviz.plugins.unit_conversion.unit_conversion Module

Classes

UnitConversion(*args, **kwargs)

Public constructor

jdaviz.configs.specviz2d.plugins.spectral_extraction.spectral_extraction Module

Classes

SpectralExtraction(*args, **kwargs)

The Spectral Extraction plugin exposes specreduce methods for tracing, background subtraction, and spectral extraction from 2D spectra.

Nuts and Bolts

jdaviz.app Module

Classes

Application(**kwargs)

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

jdaviz.configs.default.plugins.data_tools.file_chooser Module

Classes

FileChooser(**kwargs)

FileChooser class.

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.default.plugins.model_fitting.fitting_backend Module

Functions

fit_model_to_spectrum(spectrum, ...[, ...])

Fits a CompoundModel to a Spectrum1D instance.

jdaviz.configs.default.plugins.model_fitting.initializers Module

This module is used to initialize spectral models to the data at hand.

This is used by model-fitting code that has to create spectral model instances with sensible parameter values such that they can be used as first guesses by the fitting algorithms.

Functions

`initialize`(instance, x, y)	Initialize given model.
`get_model_parameters`(model_cls[, model_kwargs])

jdaviz.configs.imviz.wcs_utils Module

This module handles calculations based on world coordinate system (WCS).

Functions

`get_compass_info`(image_wcs, image_shape[, r_fac])	Calculate WCS compass parameters.
`draw_compass_mpl`(image[, orig_shape, wcs, ...])	Visualize the compass using Matplotlib.

jdaviz.core.astrowidgets_api Module

Classes

AstrowidgetsImageViewerMixin()

This class implements astrowidgets API for Jdaviz image viewer.

jdaviz.core.config Module

This file contains helper function related to configuration handling.

Functions

`read_configuration`([path])	Loads a configuration from a YAML file.
`get_configuration`([path, section, config])	Retrieve a copy of a specified configuration.
`list_configurations`()	Get a list of pre-built configurations.

jdaviz.core.custom_traitlets Module

Classes

`HandleEmptyMixin`(args, *kwargs)	Mixin to handle empty field.
`IntHandleEmpty`(args, *kwargs)	Mixin to handle empty integer field.
`FloatHandleEmpty`(args, *kwargs)	Mixin to handle empty floating point field.

jdaviz.core.data_formats Module

Functions

`guess_dimensionality`(filename)	Guess the dimensionality of a file.
`get_valid_format`(filename)	Identify a best match Jdaviz configuration from a filename.
`identify_data`(filename[, current])	Identify the data format and application configuration from a filename.

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
`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
`LinkUpdatedMessage`(link_type, ...)	Message generated when the WCS/pixel linking is changed
`ExitBatchLoadMessage`(args, *kwargs)	Message generated when exiting the outermost batch_load context manager
`MarkersChangedMessage`(has_markers, *args, ...)	Message generated when markers are added/removed from an image viewer

jdaviz.core.freezable_state Module

Classes

`FreezableState`()
`FreezableProfileViewerState`(**kwargs)
`FreezableBqplotImageViewerState`(args, *kwargs)

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, history_verbosity])	The Base Helper Class.
`ImageConfigHelper`(args, *kwargs)	`ConfigHelper` that uses an image viewer as its primary viewer.

jdaviz.core.linelists Module

Functions

`get_linelist_metadata`()	Return metadata for line lists.
`get_available_linelists`()	Return all available line lists.
`load_preset_linelist`(name)	Return one of the preset line lists, loaded into `QTable`.

jdaviz.core.marks Module

Classes

`OffscreenLinesMarks`(viewer)
`BaseSpectrumVerticalLine`(**kwargs)	Public constructor
`SpectralLine`(**kwargs)	Subclass on bqplot Lines, mostly so that we can erase spectral lines by eliminating any SpectralLines objects from a figures marks list.
`SliceIndicatorMarks`(**kwargs)	Subclass on bqplot Lines to handle slice/wavelength indicator.
`ShadowMixin`()	Mixin class to propagate traits from one mark object to another.
`ShadowLine`(**kwargs)	Create a white shadow line around another line to help make it standout on top of other lines.
`ShadowLabelFixedY`(**kwargs)	Label whose position shadows that of a parent `shadowing` line and will flip alignment based on whether it is left or right of the center of the viewer.
`PluginMark`()
`PluginLine`(**kwargs)	Public constructor
`PluginScatter`(**kwargs)	Public constructor
`LineAnalysisContinuum`(**kwargs)	Public constructor
`LineAnalysisContinuumCenter`(**kwargs)	Public constructor
`LineAnalysisContinuumLeft`(**kwargs)	Public constructor
`LineAnalysisContinuumRight`(**kwargs)	Public constructor
`LineUncertainties`(**kwargs)	Public constructor
`ScatterMask`(**kwargs)	Public constructor
`SelectedSpaxel`(**kwargs)	Public constructor

jdaviz.core.region_translators Module

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

Functions

`regions2roi`(region_shape[, wcs])	Convert a given `regions` shape to `glue` ROI.
`regions2aperture`(region_shape)	Convert a given `regions` shape to `photutils` aperture.
`aperture2regions`(aperture)	Convert a given `photutils` aperture to `regions` shape.

jdaviz.core.registries Module

Functions

convert(name)

Converts camel-case strings to snake-case.

Classes

`UniqueDictRegistry`()	Base registry class that handles hashmap-like associations between a string representation of a plugin and the class to be instantiated.
`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.

jdaviz.core.template_mixin Module

Functions

show_widget(widget, loc, title)

Classes

`TemplateMixin`(args, *kwargs)	Public constructor
`PluginTemplateMixin`(args, *kwargs)	This base class can be inherited by all sidebar/tray 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.
`SelectPluginComponent`(**kwargs)	Plugin select, with support for single or multi-selection.
`SubsetSelect`(**kwargs)	Plugin select for subsets, with support for single or multi-selection.
`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.
`DatasetSpectralSubsetValidMixin`(**kwargs)	Adds a traitlet tracking whether self.dataset and self.spectral_subset overlap in the spectral axis.
`ViewerSelect`(**kwargs)	Plugin select for viewers, with support for single or multi-selection.
`ViewerSelectMixin`(**kwargs)	Applies the ViewerSelect component as a mixin in the base plugin.
`LayerSelect`(**kwargs)	Plugin select for layers, with support for single or multi-selection.
`LayerSelectMixin`(**kwargs)	Applies the LayerSelect component as a mixin in the base plugin.
`DatasetSelect`(**kwargs)	Plugin select for data entries, with support for single or multi-selection.
`DatasetSelectMixin`(**kwargs)	Applies the DatasetSelect component as a mixin in the base plugin.
`AutoTextField`(plugin, value, default, auto, ...)	Label component with the ability to synchronize to a plugin-provided default value or override with a custom value.
`AutoTextFieldMixin`(**kwargs)	Applies the AutoTextField component as a mixin in the base plugin.
`AddResults`(plugin, label, label_default, ...)	Plugin component for providing a data-label and selecting a viewer to add the results from the plugin.
`AddResultsMixin`(**kwargs)	Applies the AddResults component as a mixin in the base plugin.
`PlotOptionsSyncState`(plugin, viewer_select, ...)	Plugin component for syncing with glue state objects.

jdaviz.core.validunits Module

Functions

`units_to_strings`(unit_list)	Convert equivalencies into readable versions of the units.
`create_spectral_equivalencies_list`(spectrum)	Get all possible conversions from current spectral_axis_unit.
`create_flux_equivalencies_list`(spectrum)	Get all possible conversions for flux from current flux units.

jdaviz.models.physical_models Module

Models that have physical origins.

Classes

BlackBody(*args, **kwargs)

Blackbody model using the Planck function.

Class Inheritance Diagram

jdaviz.utils Module

Functions

`enable_hot_reloading`()	Use `watchdog` to perform hot reloading.
`bqplot_clear_figure`(fig)	Clears a given `bqplot.Figure` to mimic matplotlib `clf()`.
`standardize_metadata`(metadata)	Standardize given metadata so it can be viewed in Metadata Viewer plugin.
`alpha_index`(index)	Converts an index to label (A-Z, AA-ZZ).

Classes

`SnackbarQueue`()	Class that performs the role of VSnackbarQueue, which is not implemented in ipyvuetify.
`ColorCycler`([counter])	Cycles through matplotlib's default color palette after first using the Glue default data color.