Parameter file in xml

Main explaination

The parameter file is the core of the program; it is from this file that the program will carry out the processing. This file contains the input lidar file(s) and the auxiliary files to be considered (radiosonde data, climatological models, etc.), as well as all the parameters for each processing step (saturation, sky background, filtering, etc.).

The file is in XML format. This language allows for the easy creation of a complete configuration with various attributes. It is a tag-based language with cascading tags.

Exemple of xml file

<balise_1>
   <balise_2 attribut="attribut_name">
          value
   </balise_2>
</balise_1>

Other attributes can be added in function of the parameter.

Example 1: application for the variable desaturation In this case, we apply a parameter of desaturation called tau, with a float value of 290 ns.

Exemple of desaturation variable

<desaturation>
   <tau units="ns" type="float">
          290
   </tau>
</desaturation>

List of attributes names

For each variable, multiple attributes are available:

• unit: unity of the value (default: no unity)

• type: type of the variable : file, value, string, bool (default: string)

• relativepath: is a full filename or just a relative path (if type=file): True or False (default: True)

• separator: separator, if tabulation of values (default: ,)

• apply_all: apply at all the channels (True or False) (default: False)

Attributes names	Description	Possibility
type	type of the variable	string, int, float, bool, path, relativepath
unit	Unit of the variable	pint format (exemple: m, km**2, K**-1)
separator	Lettre which separate the variables	String (exemple: “,”)
relativepath	Relative path	Boolean (True or False)
apply_all	Apply this parameter to all data	Boolean (True or False)
options	options enables for the value	String separate by “,”
multiple_option	Multiple values possible	Boolean (True or False)

Read parameters

For the element <Read>, there is several sub-elements:

• <Lidar_files>: This element contains all the parameters related to the reading of one or multiple raw lidar files. The sub-elements are as follows:

  • <filenames>: filename(s) to read

  • <format> : format of the file(s) (Teslas, Licel)

  • <Signal_Type> : type of the signal (More documentation)

  • <unit_photocounting> : [optionnel] : unity for photocounting channels

  • <Remove_channel>: signal type to remove of the reading file

• <ForceResolution>: [optionnal] force channel resolution. Necessary when channels have different resolutions.

• <ForceNumberOfPoint>: [optionnel] force the number of point for each channel (force le nombre de point de la voie (There can be only one altitude vector. If the resolution and the number of points are different, use this parameter.)

• <Atmosphere_file>: atmospheric auxialiry files.

  • <modele_X>: sub element of the model (x depend of the numero of the model)

    • <filenames>: filename(s) to read

    • <format>: format of the files (example: radiosounding_nimes_v02, ncep, etc)

    • <order>: order for the gluing (order=0 main file, as radiosounding)

    • <fill_value>: fill value (default: nan)

    • <station_name>: [in case of Arletty format] name of the station

  • <format> : format of the file (example: Arletty)

• <Cross_section_file>: parameters for ozone cross section

  • <filenames>: filename(s) to read

  • <format> : format of the file (example: Bass And Paur Files)

• <Climatology_ozone_file>: parameters for ozone climatology

  • <filenames>: filename(s) to read

  • <format> : format of the file (example: netcdf)

• <electronic_delay>: electronique delay (defaut : 0 ns)