Skip to content

SPICE_DATA::create_l3_file

Martin Wiesmann edited this page Nov 24, 2022 · 32 revisions

This routine creates a level 3 FITS file for the chosen window(s). The data is arranged so that cfit_block can read it. The routine estimates the positions of the main peaks and fits those to the data by calling cfit_block. This may take a while. After that, the xcfit_block routine is called with the data and the fit, where one can view the result and make adjustments to the fit. After exiting xcfit_block by using the 'Exit' button, the routine saves the fits into a level 3 FITS file and moves this file into the $SPICE_DATA directory. The data cube will be saved in its original untransformed configuration.

Syntax

l3_filename = spice_object->create_l3_file( [window_index] [, /no_masking] [, /approximated_slit] [, /no_fitting] [, /no_widget] [, /no_xcfit_block] [, /position] [, velocity=velocity] [, /no_line_list] [, /official_l3dir] [, top_dir=top_dir] [path_index=path_index] [, /save_not] [, all_ana=all_ana] [, all_result_headers=all_result_headers] )

Return Value

The path and name of the Level 3 FITS file. And a level 3 FITS file, saved to directory $SPICE_DATA/level3/ .

Optional inputs

top_dir

A path to a directory in which the file should be saved. The necessary subdirectories will be created (e.g. level2/2020/03/26).

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.

TOP_DIR

A path to a directory in which the file should be saved. The necessary subdirectories will be created (e.g. level2/2020/06/21).

PATH_INDEX

If $SPICE_DATA contains multiple paths, then this keyword allows you to specify to which path you send the file. Default is 0.

Arguments

window_index

A scalar integer or an array of integers, giving the index/indices of the window(s) to be analysed. Default is all windows.

Keywords

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.

no_fitting

If set, fitting won't be computed. This can still be done manually in xcfit_block.

no_widget

If set, xcfit_block and small window to stopp fitting will not be called.

no_xcfit_block

If set, xcfit_block will not be called, but small window to stopp fitting will appear.

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.

official_l3dir

If set, the file will be moved to the directory $SPICE_DATA/level3, the directory for the official level 3 files.

save_not

If set, then the FITS file will not be saved. The output is the path and name of the level 3 FITS file, if it would have been saved.

OPTIONAL OUTPUTS:

all_ana

Array of ana structure, number of elements is the same as number of windows in the FITS file.

all_result_headers

A pointer array, containing the headers of the results extensions as string arrays.

Clone this wiki locally