Ramp Extraction#

Plugin Availability

This plugin works with ramp data.

The plugin will be visible when at least one ramp data dataset is loaded.

Extract ramp profiles from detector data.

Description#

Warning

Ramp functionality is still under active development. Stay tuned for updates!

The Ramp Extraction plugin collapses spatial dimensions of ramp data to produce integration-level time series for pixels or regions.

Data products from infrared detectors flow through the official JWST or Roman mission pipelines in levels. Infrared detectors use an “up-the-ramp” readout pattern, which is summarized in the JWST documentation.

Note

For more information on the JWST and Roman stages/levels, see JWST pipeline stage documentation Roman data pipelines documentation.

The Ramp Extraction plugin is a quick-look tool; it does not yet support every feature of the mission pipelines. The mission pipelines produce rate images from ramp cubes by fitting the samples up the ramp while accounting for non-linearity, jumps detected during an integration, saturation, and detector defects. These data quality checks and corrections are not applied in the Ramp Extraction plugin. For details on how rate images are derived from ramps, see the JWST pipeline’s Ramp Fitting step or the Roman pipeline’s Ramp Fitting step.

Key Features:

Extract ramps from spatial regions
Multiple extraction functions
Integration visualization
Uncertainty propagation

UI Access#

Click the Ramp Extraction icon in the plugin toolbar to:

Select ramp dataset
Choose spatial region
Select extraction function
Extract ramp profile

API Access#

plg = rampviz.plugins['Ramp Extraction']
plg.aperture = 'Subset 1'
plg.extract()

API References#

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

show()
open_in_tray()
close_in_tray()
dataset (DatasetSelect): Dataset to use for ramp extraction.
function (SelectPluginComponent): Function to use for the extraction (Mean, Median, Min, Max, Sum).
aperture (ApertureSubsetSelect): Subset to use for the ramp extraction, or Entire Cube.
aperture_method (SelectPluginComponent): Method to use for extracting a ramp profile
add_results (AddResults)
extract()

For detailed API documentation, see RampExtraction.