Source code: SPICE_DATA::get_one_image

Class: SPICE_DATA

Description

This routine returns the data of the specified window and exposure index. If 'noscale' keyword is set, the output data will not be scaled using the optional BSCALE and BZERO keywords in the FITS header. The exposure index is in the first dimension of the 4D cube in case the study type is 'Raster', and in the fourth dimension if study type is 'Sit-and-stare'. The array is also transposed, so that it can be directly plotted, i.e. array = [lambda, instrument-Y].

Syntax

image = spice_object->get_one_image( window, exposure_index, [, /noscale] [, /debin] [, /no_masking] [, /approximated_slit] )

Return Value

Returns a transposed 2D subset of the data from the specified window and exposure (array = [lambda, instrument-Y]).

Arguments

window

A scalar integer or string giving the index or name of the window to be returned.

exposure_index

The index of the desired exposure.

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.

debin

If set, the image will be expanded if binning is GT 1, and data values will be divided by the binning value.

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.

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.