Skip to content

SPICE_DATA::xcfit_block

Martin Wiesmann edited this page Aug 29, 2024 · 5 revisions

Source code: SPICE_DATA:: xcfit_block

Class: SPICE_DATA

Description

This routine calls xcfit_block with the data of the chosen window. The data is arranged so that xcfit_block can read it. The routine also estimates the positions of the main peaks and adds fit components to the analysis structure. After exiting xcfit_block by using the 'Exit' button, the routine returns the analysis structure.

Syntax

ana = spice_object->xcfit_block( window [velocity=velocity] [, /position] [, /no_masking] [, /approximated_slit] )

Return Value

An analysis structure, which contains handles to the different data cubes, see also documentation of cfit, xcfit, cfit_block and xcfit_block.

Arguments

window

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

Keywords

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_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. The keyword is ignored if NO_MASKING is set.

Clone this wiki locally