SpectralExtraction

class jdaviz.configs.specviz2d.plugins.spectral_extraction.spectral_extraction.SpectralExtraction(*args, **kwargs)

Bases: PluginTemplateMixin

Public constructor

Attributes Summary

active_step	A trait for unicode strings.
bg_add_to_viewer_items	An instance of a Python list.
bg_add_to_viewer_selected	A trait for unicode strings.
bg_dataset_items	An instance of a Python list.
bg_dataset_selected	A trait for unicode strings.
bg_results_label	A trait for unicode strings.
bg_results_label_auto	A boolean (True, False) trait.
bg_results_label_default	A trait for unicode strings.
bg_results_label_invalid_msg	A trait for unicode strings.
bg_results_label_overwrite	A boolean (True, False) trait.
bg_separation	Mixin to handle empty integer field.
bg_sub_add_to_viewer_items	An instance of a Python list.
bg_sub_add_to_viewer_selected	A trait for unicode strings.
bg_sub_results_label	A trait for unicode strings.
bg_sub_results_label_auto	A boolean (True, False) trait.
bg_sub_results_label_default	A trait for unicode strings.
bg_sub_results_label_invalid_msg	A trait for unicode strings.
bg_sub_results_label_overwrite	A boolean (True, False) trait.
bg_trace_pixel	Mixin to handle empty integer field.
bg_type_items	An instance of a Python list.
bg_type_selected	A trait for unicode strings.
bg_width	Mixin to handle empty integer field.
dialog	A boolean (True, False) trait.
ext_add_to_viewer_items	An instance of a Python list.
ext_add_to_viewer_selected	A trait for unicode strings.
ext_dataset_items	An instance of a Python list.
ext_dataset_selected	A trait for unicode strings.
ext_results_label	A trait for unicode strings.
ext_results_label_auto	A boolean (True, False) trait.
ext_results_label_default	A trait for unicode strings.
ext_results_label_invalid_msg	A trait for unicode strings.
ext_results_label_overwrite	A boolean (True, False) trait.
ext_specreduce_err	A trait for unicode strings.
ext_width	Mixin to handle empty integer field.
marks	Access the marks created by this plugin in both the spectrum-viewer and spectrum-2d-viewer.
setting_interactive_extract	A boolean (True, False) trait.
template_file
trace_bins	Mixin to handle empty integer field.
trace_dataset_items	An instance of a Python list.
trace_dataset_selected	A trait for unicode strings.
trace_peak_method_items	An instance of a Python list.
trace_peak_method_selected	A trait for unicode strings.
trace_pixel	Mixin to handle empty integer field.
trace_type_items	An instance of a Python list.
trace_type_selected	A trait for unicode strings.
trace_window	Mixin to handle empty integer field.

Methods Summary

clear_marks()	Manually clear the live-preview marks.
export_bg(**kwargs)	Create a specreduce Background object from the input parameters defined in the plugin.
export_bg_img([add_data])	Create a background 2D spectrum from the input parameters defined in the plugin.
export_bg_sub([add_data])	Create a background-subtracted 2D spectrum from the input parameters defined in the plugin.
export_extract(**kwargs)	Create a specreduce extraction object from the input parameters defined in the plugin.
export_extract_spectrum([add_data])	Create an extracted 1D spectrum from the input parameters defined in the plugin.
export_trace(**kwargs)	Create a specreduce Trace object from the input parameters defined in the plugin.
import_bg(bg)	Import the input parameters from an existing specreduce Background object into the plugin.
import_extract(ext)	Import the input parameters from an existing specreduce extract object into the plugin.
import_trace(trace)	Import the input parameters from an existing specreduce Trace object into the plugin.
update_marks([step])	Manually update the live-preview marks for a given step in spectral extraction.
vue_create_bg_img(*args)
vue_create_bg_sub(*args)
vue_extract_spectrum(*args)

Attributes Documentation

active_step

A trait for unicode strings.

bg_add_to_viewer_items

An instance of a Python list.

bg_add_to_viewer_selected

A trait for unicode strings.

bg_dataset_items

An instance of a Python list.

bg_dataset_selected

A trait for unicode strings.

bg_results_label

A trait for unicode strings.

bg_results_label_auto

A boolean (True, False) trait.

bg_results_label_default

A trait for unicode strings.

bg_results_label_invalid_msg

A trait for unicode strings.

bg_results_label_overwrite

A boolean (True, False) trait.

bg_separation

Mixin to handle empty integer field.

bg_sub_add_to_viewer_items

An instance of a Python list.

bg_sub_add_to_viewer_selected

A trait for unicode strings.

bg_sub_results_label

A trait for unicode strings.

bg_sub_results_label_auto

A boolean (True, False) trait.

bg_sub_results_label_default

A trait for unicode strings.

bg_sub_results_label_invalid_msg

A trait for unicode strings.

bg_sub_results_label_overwrite

A boolean (True, False) trait.

bg_trace_pixel

Mixin to handle empty integer field.

bg_type_items

An instance of a Python list.

bg_type_selected

A trait for unicode strings.

bg_width

Mixin to handle empty integer field.

dialog

A boolean (True, False) trait.

ext_add_to_viewer_items

An instance of a Python list.

ext_add_to_viewer_selected

A trait for unicode strings.

ext_dataset_items

An instance of a Python list.

ext_dataset_selected

A trait for unicode strings.

ext_results_label

A trait for unicode strings.

ext_results_label_auto

A boolean (True, False) trait.

ext_results_label_default

A trait for unicode strings.

ext_results_label_invalid_msg

A trait for unicode strings.

ext_results_label_overwrite

A boolean (True, False) trait.

ext_specreduce_err

A trait for unicode strings.

ext_width

Mixin to handle empty integer field.

marks

Access the marks created by this plugin in both the spectrum-viewer and spectrum-2d-viewer.

setting_interactive_extract

A boolean (True, False) trait.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/v2.10.0/lib/python3.9/site-packages/jdaviz/configs/specviz2d/plugins/spectral_extraction/spectral_extraction.py', 'spectral_extraction.vue')

trace_bins

Mixin to handle empty integer field.

trace_dataset_items

An instance of a Python list.

trace_dataset_selected

A trait for unicode strings.

trace_peak_method_items

An instance of a Python list.

trace_peak_method_selected

A trait for unicode strings.

trace_pixel

Mixin to handle empty integer field.

trace_type_items

An instance of a Python list.

trace_type_selected

A trait for unicode strings.

trace_window

Mixin to handle empty integer field.

Methods Documentation

clear_marks()

Manually clear the live-preview marks.

export_bg(**kwargs)

Create a specreduce Background object from the input parameters defined in the plugin.

Parameters

add_databool

Whether to add the resulting image to the application, according to the options defined in the plugin.

export_bg_img(add_data=False, **kwargs)

Create a background 2D spectrum from the input parameters defined in the plugin.

Parameters

add_databool

Whether to add the resulting image to the application, according to the options defined in the plugin.

export_bg_sub(add_data=False, **kwargs)

Create a background-subtracted 2D spectrum from the input parameters defined in the plugin.

Parameters

add_databool

Whether to add the resulting image to the application, according to the options defined in the plugin.

export_extract(**kwargs)

Create a specreduce extraction object from the input parameters defined in the plugin.

export_extract_spectrum(add_data=False, **kwargs)

Create an extracted 1D spectrum from the input parameters defined in the plugin.

Parameters

add_databool

Whether to add the resulting spectrum to the application, according to the options defined in the plugin.

export_trace(**kwargs)

Create a specreduce Trace object from the input parameters defined in the plugin.

import_bg(bg)

Import the input parameters from an existing specreduce Background object into the plugin.

Parameters

bgspecreduce.background.Background

Background object to import

import_extract(ext)

Import the input parameters from an existing specreduce extract object into the plugin.

Parameters

extspecreduce.extract.BoxcarExtract

Extract object to import

import_trace(trace)

Import the input parameters from an existing specreduce Trace object into the plugin.

Parameters

tracespecreduce.tracing.Trace

Trace object to import

update_marks(step=None)

Manually update the live-preview marks for a given step in spectral extraction. This API mimics opening the plugin and interacting with one of the steps.

Parameters

stepstr

Step in the extraction process to visualize. Must be one of: ‘trace’, ‘bg’, ‘ext’.

vue_create_bg_img(*args)

vue_create_bg_sub(*args)

vue_extract_spectrum(*args)