Source code: SPICE_DATA::get_window_data

Class: SPICE_DATA

Description

This method returns the data of the specified window. Pixels below and above the slit are set to NaN in the returned array, except if 'no_masking' is set.

Syntax

data = spice_object->get_window_data( window [, /noscale] [, /no_masking] [, /approximated_slit] [, /debug_plot] [, max_saturation_fraction=max_saturation_fraction] )

Return Value

Returns the data of the window as an array.

Arguments

window

The index or name of the desired window.

Keywords

noscale

If present and non-zero, then the output data will not be scaled using the optional BSCALE and BZERO keywords in the FITS header. Default is to scale.

no_masking

If set, then SPICE_DATA::mask_regions_outside_slit will NOT be called on the data. This procedure masks any y regions in a narrow slit data cube that don't contain slit data, i.e. pixels with contributions from parts of the detector that lie above/below the dumbbells, in the gap between the slit ends and the dumbbells, and the dumbbell regions themselves. The masking procedure is not called for wide-slit observations or if window_index corresponds to a regular dumbbell extension or if NOLOAD has been set.

approximated_slit

If set, routine uses a fixed (conservative) value for the slit range, i.e. does not estimate the slit length based on the position of the dumbbells. The keyword is ignored if NO_MASKING is set.

max_saturation_fraction

Pixels with a contribution fraction from saturated L1 pixels above this limit are set to nan. Default is 0, i.e. all pixels influenced by saturated pixels are nan. Pixels with a saturation fraction below this limit are set to the value calculated by spice_prep when setting saturated L1 pixels to 0 before the geometrical correction, and then correcting for the filling factor by upscaling the L2 pixel value to value /= (1-fraction). The coordinates of pixels influenced by saturated and the corresponding upscaled values are stored in a pixel list binary table extension SATPIXLIST(...)

debug_plot

If set, make plots to illustrate which part of the window is being masked. This keyword is ignored if NO_MASKING is set.