Utilities API#
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. |
|
Guess the appropriate viz helper for a data file. |
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 slice plugin when the selected slice is updated |
|
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 |
Message generated when markers are added/removed from an image viewer via astrowidgets API |
|
|
Message when the length of the markers plugin table changes |
|
Message generated by canvas rotation plugin |
|
Message generated when the global app-wide display unit is changed |
|
Create a new message |
|
Message generated when a plugin table is initialized |
|
Message generated when the items in a plugin table are changed |
|
Message generated when a plugin plot is initialized |
|
Message generated when the items in a plugin plot are changed |
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 spacetelescope/jdaviz#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 |
|
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#
|
|
|
decorator on a plugin method to set a traitlet to True at the beginning and False either on failure or successful completion. |
|
decorator on a plugin method to track the amount of time the wrapped method takes, and disable live plugin-previews if it takes longer than |
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. |
|
Public constructor |
|
Plugin select, with support for single or multi-selection. |
|
This extends BasePluginComponent for common functionality for a select/dropdown component. |
|
Plugin select with support for renaming, adding, and deleting items (by the user). |
|
Public constructor |
|
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. |
|
Applies the SubsetSelect component as a mixin in the base plugin. |
|
Plugin select for aperture subsets, with support for single or multi-selection, as well as live-preview rendered in the viewers. |
|
Applies the ApertureSubsetSelect component as a mixin in the base plugin. |
|
Adds a traitlet tracking whether self.dataset and self.spectral_subset overlap in the spectral axis. |
|
Plugin select to choose options for a linear spectral continuum. |
|
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 plugin table entries, with support for single or multi-selection. |
|
Public constructor |
|
Plugin select for plugin plot entries, with support for single or multi-selection. |
|
Public constructor |
|
Adds a traitlet that identifies if there are any finite data values that correspond to a non-finite uncertainty at that index. |
|
Plugin select for data entries, with support for single or multi-selection. |
|
Applies the DatasetSelect component as a mixin in the base plugin. |
|
Applies the DatasetSelect component as a mixin in the base plugin with togglable multiselect. |
|
IMPORTANT: Always accompany with HasFileImportSelect IMPORTANT: currently assumed only one instance per-plugin |
|
Public constructor |
|
Table subcomponent. |
|
Table subcomponent mixin. |
|
Plot subcomponent. |
|
Plot subcomponent mixin. |
|
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). |
|
Determine the subset type of a subset or layer |
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. |