Source code: SPICE_DATA::mk_analysis

Class: SPICE_DATA

Description

This procedure creates an ANA (analysis structure) with the data of a chosen window, so that it can be used in CFIT_BLOCK and XCFIT_BLOCK. Fit components are estimated and added to ANA. Calls SPICE_DATA::transform_data_for_ana.

Syntax

ana = spice_object->mk_analysis( window [, /no_masking] [, /approximated_slit] [, /init_all_cubes] [, /position] [, velocity=velocity] [, /no_line_list] [, /debug_plot] )

Return Value

This procedure returns an ANA structure, which can be used in CFIT_BLOCK and XCFIT_BLOCK.

Arguments

window

The index or name of the desired window.

Keywords

init_all_cubes

If set, then all cubes within the ANA will be initialised, otherwise, the cubes RESULT, RESIDUALS, INCLUDE and CONSTANT will be undefined.

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.

VELOCITY

Set this equal to the initial velocity if you want the line position represented by the velocity relative to a lab wavelength - the lab wavelength is taken from the supplied POSITION, i.e., INT_POS_FWHM(1), which is calculated/estimated within the procedure 'generate_adef'. This input is ignored if /POSITION is set. Default is zero.

position

If set, then the line position is NOT represented by the velocity relative to a lab wavelength, but as the wavelength.

no_line_list

If set, then no predefined line list will be used to define gaussian fit components. By default, the list returned by the function spice_line_list() will be used.

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.