RampExtraction#

class jdaviz.configs.rampviz.plugins.ramp_extraction.ramp_extraction.RampExtraction(*args, **kwargs)[source]#

Bases: PluginTemplateMixin, ApertureSubsetSelectMixin, DatasetSelectMixin, AddResultsMixin

See the Ramp Extraction Plugin Documentation for more details.

Only the following attributes and methods are available through the public plugin API:

Public constructor

Attributes Summary

active_step

A trait for unicode strings.

aperture_method_items

An instance of a Python list.

aperture_method_selected

A trait for unicode strings.

aperture_weight_mask

conflicting_aperture_and_function

A boolean (True, False) trait.

conflicting_aperture_error_message

A trait for unicode strings.

cube

do_auto_extraction

export_enabled

A boolean (True, False) trait.

extraction_available

A boolean (True, False) trait.

filename

A trait for unicode strings.

function_items

An instance of a Python list.

function_selected

A trait for unicode strings.

integration_viewer

live_update_subscriptions

marks

overwrite_warn

A boolean (True, False) trait.

resulting_product_name

A trait for unicode strings.

show_live_preview

A boolean (True, False) trait.

show_subset_preview

A boolean (True, False) trait.

slice_display_unit

slice_display_unit_name

slice_group_value

A float trait.

slice_indicator_viewers

slice_plugin

spatial_axes

subset_preview_limit

An int trait.

subset_preview_warning

A boolean (True, False) trait.

template_file

user_api

uses_active_status

A boolean (True, False) trait.

Methods Summary

__call__([add_data])

Call self as a function.

extract([add_data])

Extract the ramp profile from the data cube according to the plugin inputs.

vue_ramp_extraction(*args, **kwargs)

Attributes Documentation

active_step#

A trait for unicode strings.

aperture_method_items#

An instance of a Python list.

aperture_method_selected#

A trait for unicode strings.

aperture_weight_mask#
conflicting_aperture_and_function#

A boolean (True, False) trait.

conflicting_aperture_error_message#

A trait for unicode strings.

cube#
do_auto_extraction = True#
export_enabled#

A boolean (True, False) trait.

extraction_available#

A boolean (True, False) trait.

filename#

A trait for unicode strings.

function_items#

An instance of a Python list.

function_selected#

A trait for unicode strings.

integration_viewer#
live_update_subscriptions#
marks#
overwrite_warn#

A boolean (True, False) trait.

resulting_product_name#

A trait for unicode strings.

show_live_preview#

A boolean (True, False) trait.

show_subset_preview#

A boolean (True, False) trait.

slice_display_unit#
slice_display_unit_name#
slice_group_value#

A float trait.

slice_indicator_viewers#
slice_plugin#
spatial_axes#
subset_preview_limit#

An int trait.

subset_preview_warning#

A boolean (True, False) trait.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/latest/lib/python3.11/site-packages/jdaviz/configs/rampviz/plugins/ramp_extraction/ramp_extraction.py', 'ramp_extraction.vue')#
user_api#
uses_active_status#

A boolean (True, False) trait.

Methods Documentation

__call__(add_data=True)[source]#

Call self as a function.

extract(add_data=True, **kwargs)[source]#

Extract the ramp profile from the data cube according to the plugin inputs.

Parameters:
add_databool, optional

Whether to load the resulting data back into the application according to add_results.

kwargsdict

Additional keyword arguments passed to the NDDataArray collapse operation. Examples include propagate_uncertainties and operation_ignores_mask.

vue_ramp_extraction(*args, **kwargs)[source]#