Generating calibration files for Fenix

Radiometric, wavelength and miscellaneous other calibration of the Fenix is undertaken at ARSF-Ops at least annually since 2014. This page describes how to use the calibration software written by ARSF-DAN to create the necessary calibration files from the raw calibration data. All progress should be recorded on a trac ticket (​https://arsf-dan.nerc.ac.uk/trac/newticket) and added to the list below.

2015: ​https://arsf-dan.nerc.ac.uk/trac/ticket/594
2016: ​https://arsf-dan.nerc.ac.uk/trac/ticket/613

Setup

Relevant scripts are held in the arsf git repository under tools/libarsfcal.

Note that the various calibration scripts written in Python expect to import a package called "libarsfcal". This means that you must have the directory above the libarsfcal directory in your PYTHONPATH environment variable for the scripts to run. This will be added by default but if you are making changes to the scripts you need to prepend the development version to your PYTHONPATH:

1. export GITCHECKOUT=~/scratch_network/git/internal-code
2. export PYTHONPATH=$GITCHECKOUT/tools:$PYTHONPATH

You can check the location of the library you are using with:

python -c "import libarsfcal;print(libarsfcal.__file__)"

Config file

The master calibration scripts require a config file to supply a lot of their options. An example config file can be found under libarsfcal/supplementary. Keys must be in the format key=value, one per line. The file must contain a [DEFAULT] heading holding default values, an [eagle] heading holding keys for the Eagle calibration, a [hawk] heading holding keys for the Hawk calibration and a [fenix] heading holding keys for the Hawk calibration.

Keys required under [DEFAULT]:

• aplcal=<path to aplcal>
• fast_bil_median=<path to fast_bil_median>
• fityk=<path to cfityk>
• linefile=<path to CSV file containing spectral lines>
• lamp_index_file=<path to CSV file matching data file names to spectral lamps>

Keys required under [eagle], [hawk] and [fenix]:

• number_of_pixels=<number of spectral pixels on sensor>
• rawdir=<Directory containing raw data files>
• splitdir=<Directory in which to place split light/dark files>
• darkdir=<Directory in which to place dark corrected files>
• averagedir=<Directory in which to place averaged files>
• outdir=<Directory in which to place output files>
• sample_hdr_file=<Path to header file containing old wavelength scale>
• lampfile=<Path to CSV file containing integrating sphere response for this sensor>
• raw_radcal_file=<Path to raw file to start from to create radiometric calibration file>

Extra keys required for [fenix]:

• lampfile_with_filter=<Path to CSV file containing integrating sphere response through blue filter for this sensor>
• filter_radcal_file=<Path to blue filtered raw file to start from to create radiometric calibration file>
• spectrum_break_band=<last pixel in VNIR>

Example files for linefile, lamp_index_file and lampfile are all under libarsfcal/supplementary.

Wavelength calibration

This must be run first, since the radiometric calibration requires a wavelength calibration to tie the lamp data into. Note for Eagle and Fenix you may need to re-run gen_bandsets.py (see "Other scripts", below) with different settings in order to obtain bandset files for different spectral binning settings.

Master script: cal_spectral.py

Basic usage of this requires only the name of the config file as an argument. You may also want to use the following arguments:

• -v: Verbose. Will print a lot more stuff but makes it easier to see if it's going wrong.
• -s: Specify sensor. Default is Eagle.
• -x: Comma-separated regex list. Files matching these regexes will not be processed. This may be useful if there are a lot of data files in the specified raw directory (or later stages) that are not relevant to the wavelength calibration.
• -t: Specify a calibration stage to start from. Useful to skip the long-running early stages if you don't need to (for example) split the raw files again when re-running.
• -p: Pauses calibration between stages so output can be easily checked.
• --hwhm: Generates fityk scripts using hwhm rather than fwhm.
• --offset2: Specifies a starting offset for Fenix's SWIR. Useful if the wavelength offset is large (>1nm).

Other scripts

The master script calls the following scripts. If the master script is failing you may need to bug-fix one of these, or they can be run individually - this gives more control and flexibility at several stages, but is more complicated.

• common.py: Contains functions that are common to more than one calibration stage
• data_handler.py: Contains functions for handling BIL files
• split_autodark.py: Splits Eagle or Hawk data files containing autodark lines into a light file and a dark file.
• spatial_average.py: Calculates the average of each line for each band
• findbaseline.py: Finds the baseline data value to remove prior to peak fitting
• gen_fityk_script.py: Generates fityk scripts to do peak fitting
• lookup_lamp.py: Looks up which type of spectral lamp was used for a given data file
• checkpeaks.py: Checks spectral peaks found by fityk against known spectral lines and works out corrected pixel numbers
• combine_anchors.py: Combines multiple spectral anchor files into one
• minimise_error.py: Minimises the RMS error of a list of calibration anchor points against known spectral lines
• wavelength_scale.py: Generates a wavelength scale for a given spectral dataset with wavelength anchor points.
• gen_bandsets.py: Generates new bandset (.prn, .bnd and .wls) files from the results of wavelength calibration

Wavelength scale checking

The generated wavelength scale may be checked against the lamp lines to determine the error in each matching band and it's FWHM. The output of this test is recorded in the data analysis report. Any unrealistic FWHMs and any failing bands should be removed from the calibration and the wavelength scale regenerated.

Master script: calc_peak_diffs.py

Basic usage of this requires the following arguments:

• -a: Final anchor file produced during wavelength calibration.
• -l: Spectral lines file.

When you have created the final wavelength scale that passes the lamp line test, record the parameters on the ticket, especially the data set (day), sample_hdr_file and linefile from the config file and any optional parameters used with cal_spectral.py. Also record the final anchors and check that the VNIR and SWIR starting wavelengths are realistic. These may not match up with the anchors, depending on which sample header is used, as the previous calibration wavelengths are not currently set in the raw data files.

Radiometric calibration

This can either be run after the wavelength calibration in order to obtain a cal using an up-to-date wavelength calibration, or it can be run using an old wavelength calibration.

Master script: cal_radiometric.py

Basic usage of this requires only the name of the config file as an argument. You may also want to use the following arguments:

• -v: Verbose. Will print a lot more stuff but makes it easier to see if it's going wrong.
• -s: Specify whether Eagle or Hawk. Required to run Hawk calibration.
• -t: Specify a calibration stage to start from. Useful to skip the long-running early stages if you don't need to (for example) split the raw files again when re-running.
• -p: Pauses calibration between stages so output can be easily checked.
• -w: Specifies a wavelength scale file to use (ie output from wavelength calibration). You shouldn't need to use this if you've just run the wavelength cal, but you might need to if there are multiple wavelength cal files in the output directory or if you are running from an old cal.

Other scripts

The master script calls the following scripts. If the master script is failing you may need to bug-fix one of these, or they can be run individually - this gives more control and flexibility at several stages, but is more complicated.

• common.py: Contains functions that are common to more than one calibration stage
• data_handler.py: Contains functions for handling BIL files
• split_autodark.py: Splits Eagle or Hawk data files containing autodark lines into a light file and a dark file.
• spatial_average.py: Calculates the average of each line for each band
• replace_wavscale.py: Replaces wavelength scale in a given Eagle/Hawk header file with a new wavelength scale
• gen_radcal.py: Generates calibration multipliers given an appropriate BIL input file.

Analysis

There are scripts to generate analysis graphs and files under libarsfcal/analysis. These should be run on the calibration output, please add to them if you think of more tests.

Data quality report

The data quality report must be updated for each calibration using the outputs produced by calc_peak_diffs.py and comparison.py.

If not already saved, generate a text file with the spectral offsets, using the output option to save to file:

calc_peak_diffs.py -a <anchor file> -l <spectral line file> -o results/fenix_spectral_offsets_sept.txt

Then create the comparison plots, e.g.:

comparison.py processed_sept_dac/d3-1/fenix/output/fenix_201509.cal ~/calibration/2014/fenix/fenix_201405.cal -s fenix --notitle

Finally, update the text and figures in arsfhome/documents/data_quality_reports, submit to code review and generate a new report.