API
Configurations
jdaviz.configs.cubeviz.helper Module
Classes
|
Cubeviz Helper class |
|
This class is pending deprecation. |
jdaviz.configs.imviz.helper Module
Functions
|
(Re)link loaded data in Imviz with the desired link type. |
Classes
|
Imviz Helper class. |
jdaviz.configs.mosviz.helper Module
Classes
|
Mosviz Helper class |
|
This class is pending deprecation. |
jdaviz.configs.specviz.helper Module
Classes
|
Specviz Helper class. |
|
This class is pending deprecation. |
jdaviz.configs.specviz2d.helper Module
Classes
|
Specviz2D Helper class |
Viewers
jdaviz.configs.default.plugins.viewers Module
Classes
|
jdaviz.configs.cubeviz.plugins.viewers Module
Classes
|
|
|
jdaviz.configs.imviz.plugins.viewers Module
Classes
|
jdaviz.configs.mosviz.plugins.viewers Module
Classes
|
|
|
|
|
|
|
jdaviz.configs.specviz.plugins.viewers Module
Classes
|
Parsers
jdaviz.configs.cubeviz.plugins.parsers Module
Functions
|
Attempts to parse a data file and auto-populate available viewers in cubeviz. |
jdaviz.configs.imviz.plugins.parsers Module
Functions
|
Parse a data file into Imviz. |
jdaviz.configs.mosviz.plugins.parsers Module
Functions
|
Attempts to parse a 1D spectrum object. |
|
Attempts to parse a 2D spectrum object. |
|
Attempts to parse an image-like object or list of images. |
jdaviz.configs.specviz.plugins.parsers Module
Functions
|
Loads a data file or |
jdaviz.configs.specviz2d.plugins.parsers Module
Functions
|
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
|
See the Collapse Plugin Documentation for more details. |
jdaviz.configs.default.plugins.data_tools.data_tools Module
Classes
|
Public constructor |
jdaviz.configs.default.plugins.export_plot.export_plot Module
Classes
|
See the Export Plot Plugin Documentation for more details. |
jdaviz.configs.default.plugins.gaussian_smooth.gaussian_smooth Module
Classes
|
See the Gaussian Smooth Plugin Documentation for more details. |
jdaviz.configs.default.plugins.line_lists.line_lists Module
Classes
|
Public constructor |
jdaviz.configs.default.plugins.metadata_viewer.metadata_viewer Module
Classes
|
See the Metadata Viewer Plugin Documentation for more details. |
jdaviz.configs.default.plugins.model_fitting.model_fitting Module
Classes
|
See the Model Fitting Plugin Documentation for more details. |
jdaviz.configs.default.plugins.plot_options.plot_options Module
Classes
|
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
|
Public constructor |
jdaviz.configs.default.plugins.subset_tools.subset_tools Module
Classes
|
Public constructor |
jdaviz.configs.default.plugins.viewer_creator.viewer_creator Module
Classes
|
Public constructor |
jdaviz.configs.cubeviz.plugins.moment_maps.moment_maps Module
Classes
|
See the Moment Maps Plugin Documentation for more details. |
jdaviz.configs.cubeviz.plugins.slice.slice Module
Classes
|
See the Slice Plugin Documentation for more details. |
jdaviz.configs.imviz.plugins.aper_phot_simple.aper_phot_simple Module
Classes
|
Public constructor |
jdaviz.configs.imviz.plugins.catalogs.catalogs Module
Classes
|
See the Catalog Search Plugin Documentation for more details. |
jdaviz.configs.imviz.plugins.compass.compass Module
Classes
|
See the Compass Plugin Documentation for more details. |
jdaviz.configs.imviz.plugins.coords_info.coords_info Module
Classes
|
Public constructor |
jdaviz.configs.imviz.plugins.image_viewer_creator.image_viewer_creator Module
Classes
|
Public constructor |
jdaviz.configs.imviz.plugins.line_profile_xy.line_profile_xy Module
Classes
|
Public constructor |
jdaviz.configs.imviz.plugins.links_control.links_control Module
Classes
|
See the Links Control Plugin Documentation for more details. |
jdaviz.configs.mosviz.plugins.row_lock.row_lock Module
Classes
|
Public constructor |
jdaviz.configs.mosviz.plugins.slit_overlay.slit_overlay Module
Functions
|
Classes
|
Public constructor |
jdaviz.configs.specviz.plugins.line_analysis.line_analysis Module
Classes
|
The Line Analysis plugin returns specutils analysis for a single spectral line. |
jdaviz.configs.specviz.plugins.unit_conversion.unit_conversion Module
Classes
|
Public constructor |
jdaviz.configs.specviz2d.plugins.spectral_extraction.spectral_extraction Module
Classes
|
The Spectral Extraction plugin exposes specreduce methods for tracing, background subtraction, and spectral extraction from 2D spectra. |
Nuts and Bolts
jdaviz.app Module
Classes
|
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 class. |
jdaviz.configs.default.plugins.line_lists.line_list_mixin Module
Classes
Line list-related methods and properties for use in the configuration helper classes. |
jdaviz.configs.default.plugins.model_fitting.fitting_backend Module
Functions
|
Fits a |
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 given model. |
|
jdaviz.configs.imviz.wcs_utils Module
This module handles calculations based on world coordinate system (WCS).
Functions
|
Calculate WCS compass parameters. |
|
Visualize the compass using Matplotlib. |
jdaviz.core.astrowidgets_api Module
Classes
This class implements |
jdaviz.core.config Module
This file contains helper function related to configuration handling.
Functions
|
Loads a configuration from a YAML file. |
|
Retrieve a copy of a specified configuration. |
Get a list of pre-built configurations. |
jdaviz.core.custom_traitlets Module
Classes
|
Mixin to handle empty field. |
|
Mixin to handle empty integer field. |
|
Mixin to handle empty floating point field. |
jdaviz.core.data_formats Module
Functions
|
Guess the dimensionality of a file. |
|
Identify a best match Jdaviz configuration from a filename. |
|
Identify the data format and application configuration from a filename. |
jdaviz.core.events Module
Classes
|
Message to trigger viewer creation in the application. |
|
Unlike |
|
Message emitted after a viewer is destroyed by the application. |
|
Create a new message |
|
Create a new message |
|
Create a new message |
|
Create a new message |
|
Create a new message |
|
Create a new message |
|
Message generated by the cubeviz helper and processed by the slice plugin to sync slice selection across all viewers |
|
Message generated by the select slice plot plugin when activated/deactivated |
|
Message generated by Mosviz table to zoom to object on image |
|
Message generated when the WCS/pixel linking is changed |
|
Message generated when exiting the outermost batch_load context manager |
jdaviz.core.freezable_state Module
Classes
|
|
|
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
|
The Base Helper Class. |
|
|
jdaviz.core.linelists Module
Functions
Return metadata for line lists. |
|
Return all available line lists. |
|
|
Return one of the preset line lists, loaded into |
jdaviz.core.marks Module
Classes
|
|
|
Public constructor |
|
Subclass on bqplot Lines, mostly so that we can erase spectral lines by eliminating any SpectralLines objects from a figures marks list. |
|
Subclass on bqplot Lines to handle slice/wavelength indicator. |
Mixin class to propagate traits from one mark object to another. |
|
|
Create a white shadow line around another line to help make it standout on top of other lines. |
|
Label whose position shadows that of a parent |
|
Public constructor |
|
Public constructor |
|
Public constructor |
|
Public constructor |
|
Public constructor |
|
Public constructor |
|
Public constructor |
|
Public constructor |
jdaviz.core.region_translators Module
The region_translators
module houses translations of
Region Shapes to Aperture Photometry (photutils.aperture) apertures.
Functions
|
Convert a given |
|
Convert a given |
|
Convert a given |
jdaviz.core.registries Module
Functions
|
Converts camel-case strings to snake-case. |
Classes
Base registry class that handles hashmap-like associations between a string representation of a plugin and the class to be instantiated. |
|
Registry containing references to custom viewers. |
|
Registry containing references to plugins that will be added to the sidebar tray tabs. |
|
Registry containing references to plugins which will populate the application-level toolbar. |
|
Registry containing references to plugins that will populate the application-level menu bar. |
|
Registry containing parsing functions for attempting to auto-populate the application-defined initial viewers. |
jdaviz.core.template_mixin Module
Functions
|
Classes
|
Public constructor |
|
This base class can be inherited by all sidebar/tray plugins to expose common functionality. |
|
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. |
|
Plugin select, with support for single or multi-selection. |
|
Plugin select for subsets, with support for single or multi-selection. |
|
Applies the SubsetSelect component as a mixin in the base plugin. |
|
Applies the SubsetSelect component as a mixin in the base plugin. |
|
Plugin select for viewers, with support for single or multi-selection. |
|
Applies the ViewerSelect component as a mixin in the base plugin. |
|
Plugin select for layers, with support for single or multi-selection. |
|
Applies the LayerSelect component as a mixin in the base plugin. |
|
Plugin select for data entries, with support for single or multi-selection. |
|
Applies the DatasetSelect component as a mixin in the base plugin. |
|
Label component with the ability to synchronize to a plugin-provided default value or override with a custom value. |
|
Applies the AutoTextField component as a mixin in the base plugin. |
|
Plugin component for providing a data-label and selecting a viewer to add the results from the plugin. |
|
Applies the AddResults component as a mixin in the base plugin. |
|
Plugin component for syncing with glue state objects. |
jdaviz.core.validunits Module
Functions
|
Convert equivalencies into readable versions of the units. |
|
Get all possible conversions from current spectral_axis_unit. |
|
Get all possible conversions for flux from current flux units. |
jdaviz.models.physical_models Module
Models that have physical origins.
Classes
|
Blackbody model using the Planck function. |
Class Inheritance Diagram
jdaviz.utils Module
Functions
Use |
|
|
Clears a given |
|
Standardize given metadata so it can be viewed in Metadata Viewer plugin. |
|
Converts an index to label (A-Z, AA-ZZ). |
Classes
Class that performs the role of VSnackbarQueue, which is not implemented in ipyvuetify. |
|
|
Cycles through matplotlib's default color palette after first using the Glue default data color. |