ATLAS initialization file reference¶
Generated reference
This page was generated by ATLAS 1.2.0.rc4 from the parser schema, src/atlas_actris/templates/init_template_flavor.py, and the explicit selection in src/atlas_actris/templates/template_profiles.py.
The corresponding generated full INI template is call_atlas.ini.
Purpose¶
The initialization file tells ATLAS where the input data and metadata files are located, which QA tests, quicklooks, background plots, and VLDR plots should be produced, and which optional filtering, trimming, export, and radiosonde parsing settings should be applied for one processing run.
This page is generated automatically from the initialization parser schema and the user-facing template flavor text. Edit src/atlas_actris/templates/init_template_flavor.py to change descriptions, examples, or version notes. Edit src/atlas_actris/templates/template_profiles.py to change which parameters are included or their ordering. Edit src/atlas_actris/utils/parse_init_file.py only when the technical schema itself changes.
How values are interpreted¶
- Empty values mean that ATLAS will use the schema default or automatic selection when available.
- List values can be separated with commas or semicolons.
- Boolean values must be written as
TrueorFalse. - Relative explicit paths are resolved relative to the folder containing the initialization file.
- Measurement folder aliases in
explicit_foldersare resolved relative toparent_folder.
Sections¶
configuration: Controls how ATLAS obtains or uses the system configuration, including optional SCC HOI export behaviour. (3 parameters).explicit_paths: Defines the main input, configuration, settings, radiosonde, and output paths. Relative paths are interpreted with respect to the folder containing the initialization file. (6 parameters).general_options: Selects which QA tests, profile quicklooks, background plots, and VLDR plots are produced. When process is explicitly selected, empty process_qck/process_bgd values are derived from it, while process_dedicated_dark controls automatic drk_* companions. (14 parameters).filter_channels: Restricts the channels that are processed, either by selecting explicit ATLAS channel IDs or excluding groups of channels based on parts of the channel ID. (6 parameters).trimming_options: Controls signal trimming, overflow handling, temporal averaging options, and optional time slicing/exclusion of measurements. (10 parameters).explicit_folders: Overrides the default measurement folder names inside parent_folder. Leave these empty when the standard ATLAS folder structure is used. (10 parameters).parsing_options: Controls automatic telecover file distribution and custom radiosonde parsing metadata. (11 parameters).
Parameter reference¶
configuration¶
Controls how ATLAS obtains or uses the system configuration, including optional SCC HOI export behaviour.
| Parameter | Type | Default | Allowed / limits |
|---|---|---|---|
scc_compatible_format |
bool |
False |
|
export_hoi_cfg |
str |
0 |
Allowed values: 0, 1, 2 |
scc_configuration_id |
str |
empty parameter --> ignored or automatic selection |
scc_compatible_format
Set to True if the data are in scc format and export_hoi_cfg is 1 or 3 to generate the config file by automatically connecting the scc_channel_ids andthe recorder_channel_ids.
- Type:
bool - Category:
optional - Default:
False - Example:
True - Version history: New in ATLAS
1.0.0.
export_hoi_cfg
Controls exporting the config_file from the SCC HOI for the provided scc_configuration_id. Select among 0, 1, or 2 | 0: A local, manually created, configuration ini file will be used, 1: The config_file file will be automatically created from the SCC HOI overwritting any exported config_file for the same configuration, prepared file, 1: export from HOI and overwrite existing, 2: The config_file file will be automatically created from the SCC HOI if no file has already be exported for the same configuration.
- Type:
str - Category:
optional - Default:
0 - Limits / allowed values: Allowed values: 0, 1, 2
- Example:
0 - Version history: Unchanged from previous ATLAS versions.
scc_configuration_id
The SCC configuration ID. It is used only if export_hoi_cfg is set to 1 or 2 to connect with the SCC HOI.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
665 - Version history: Unchanged from previous ATLAS versions.
explicit_paths¶
Defines the main input, configuration, settings, radiosonde, and output paths. Relative paths are interpreted with respect to the folder containing the initialization file.
| Parameter | Type | Default | Allowed / limits |
|---|---|---|---|
parent_folder |
str |
empty parameter --> ignored or automatic selection |
|
atlas_configuration_file |
str |
empty parameter --> ignored or automatic selection |
|
atlas_settings_file |
str |
empty parameter --> ignored or automatic selection |
|
radiosonde_folder |
str |
empty parameter --> ignored or automatic selection |
|
radiosonde_file |
str |
empty parameter --> ignored or automatic selection |
|
output_folder |
str |
empty parameter --> ignored or automatic selection |
parent_folder
Absolute or relative path to the folder containing the input lidar data. If empty, defaults to the directory containing the initialization file. Measurement folder aliases are resolved relative to parent_folder. Relative paths are resolved from the directory containing the initialization file used to run ATLAS.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
. - Version history: Unchanged from previous ATLAS versions.
atlas_configuration_file
Absolute or relative path to the ATLAS configuration file containing system, channel, and channel-pair metadata. If empty and export_hoi_cfg is 0, uses config_file.ini beside the initialization file; this file must exist. For export_hoi_cfg 1 or 2, leave this entry empty: ATLAS prepares config_file_<scc_configuration_id>.ini in the initialization directory for SCC HOI export or download. Relative paths are resolved from the directory containing the initialization file used to run ATLAS.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
./config_file.ini - Version history: Unchanged from previous ATLAS versions.
atlas_settings_file
Absolute or relative path to the optional ATLAS settings file containing QA test and plotting settings. If empty, uses settings_file.ini beside the initialization file when present; otherwise uses the built-in settings defaults. An explicitly provided file must exist. Relative paths are resolved from the directory containing the initialization file used to run ATLAS.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
./settings_file.ini - Version history: Unchanged from previous ATLAS versions.
radiosonde_folder
Absolute or relative path to the folder containing radiosonde files. If empty, defaults to the radiosondes subfolder beside the initialization file, which is created if needed. Ignored when radiosonde_file is provided. Relative paths are resolved from the directory containing the initialization file used to run ATLAS.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
./radiosondes/ - Version history: Unchanged from previous ATLAS versions.
radiosonde_file
Absolute or relative path to a specific radiosonde file. If provided, takes precedence over radiosonde_folder. Relative paths are resolved from the directory containing the initialization file used to run ATLAS.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
./radiosondes/20231221_1527_ecmwf_bucharest.nc - Version history: New in ATLAS
1.0.0.
output_folder
Absolute or relative path for ATLAS outputs (plots, ASCII, cached data, and exported stages). If empty, outputs go to the analysis subfolder beside the initialization file. If explicitly provided, outputs go to a subfolder named after parent_folder inside the specified directory. Relative paths are resolved from the directory containing the initialization file used to run ATLAS.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
./results - Version history: New in ATLAS
1.0.0.
general_options¶
Selects which QA tests, profile quicklooks, background plots, and VLDR plots are produced. When process is explicitly selected, empty process_qck/process_bgd values are derived from it, while process_dedicated_dark controls automatic drk_* companions.
| Parameter | Type | Default | Allowed / limits |
|---|---|---|---|
process |
list[str] |
ray, pcb, tlc, tlc_rin, drk, trg, dtm, ray_pcb, pcb_aux, cam |
Allowed values: ray, pcb, tlc, tlc_rin, drk, trg, dtm, ray_pcb, pcb_aux, cam, off |
process_qck |
list[str] |
ray, pcb, tlc, tlc_rin, ray_pcb, pcb_aux |
Allowed values: ray, pcb, tlc, tlc_rin, ray_pcb, pcb_aux, trg, dtm, drk, drk_ray, drk_pcb, drk_tlc, drk_tlc_rin, drk_ray_pcb, drk_pcb_aux, drk_trg, drk_dtm, off |
process_bgd |
list[str] |
off |
Allowed values: ray, pcb, tlc, tlc_rin, ray_pcb, pcb_aux, trg, dtm, drk, drk_ray, drk_pcb, drk_tlc, drk_tlc_rin, drk_ray_pcb, drk_pcb_aux, drk_trg, drk_dtm, off |
process_vldr |
bool |
True |
|
process_dedicated_dark |
bool |
False |
|
vertical_scale |
str |
range |
Allowed values: range, height_agl, height_asl |
view_mean_signal_stages |
list[str] |
common_preprocessing_complete, preprocessing_complete, dark_preprocessing_complete |
Allowed values: init, ranges_and_heights, sliced, shots_screened, overflows_checked, dark_assigned, photon_units_converted, dead_time_corrected, averaged, averaged_low_res, averaged_high_res, mean_computed, dark_smoothed, dark_corrected, background_raw_calculated, background_calculated, background_corrected, range_corrected, vert_trimmed, molecular_calculated, mldr_generated, noise_calculated, dark_background_raw_calculated, dark_background_calculated, dark_background_corrected, gain_ratio_generated, calibration_factor_generated, calibrated_ratio_generated_mean, vldr_generated_mean, calibrated_ratio_generated, vldr_generated, screening_complete, common_preprocessing_complete, preprocessing_complete, dark_preprocessing_complete, pol_cal_complete, off |
view_signal_stages |
list[str] |
screening_complete |
Allowed values: init, ranges_and_heights, sliced, shots_screened, overflows_checked, dark_assigned, photon_units_converted, dead_time_corrected, averaged, averaged_low_res, averaged_high_res, mean_computed, dark_smoothed, dark_corrected, background_raw_calculated, background_calculated, background_corrected, range_corrected, vert_trimmed, molecular_calculated, mldr_generated, noise_calculated, dark_background_raw_calculated, dark_background_calculated, dark_background_corrected, gain_ratio_generated, calibration_factor_generated, calibrated_ratio_generated_mean, vldr_generated_mean, calibrated_ratio_generated, vldr_generated, screening_complete, common_preprocessing_complete, preprocessing_complete, dark_preprocessing_complete, pol_cal_complete, off |
dpi |
int |
150 |
|
color_reduction |
bool |
True |
|
overwrite_output |
bool |
False |
|
expert_analyst |
str |
empty parameter --> ignored or automatic selection |
|
export_stages |
list[str] |
pol_cal_complete |
Allowed values: init, ranges_and_heights, sliced, shots_screened, overflows_checked, dark_assigned, photon_units_converted, dead_time_corrected, averaged, averaged_low_res, averaged_high_res, mean_computed, dark_smoothed, dark_corrected, background_raw_calculated, background_calculated, background_corrected, range_corrected, vert_trimmed, molecular_calculated, mldr_generated, noise_calculated, dark_background_raw_calculated, dark_background_calculated, dark_background_corrected, gain_ratio_generated, calibration_factor_generated, calibrated_ratio_generated_mean, vldr_generated_mean, calibrated_ratio_generated, vldr_generated, screening_complete, common_preprocessing_complete, preprocessing_complete, dark_preprocessing_complete, pol_cal_complete, off |
export_all |
bool |
False |
process
The user can choose specific QA test(s) to process. Choose one or more of the allowed keys to process the corresponding QA tests. If left empty, ATLAS keeps the standard default behaviour. If one or more tests are provided, empty process_qck and process_bgd entries are derived automatically from this selection.
- Type:
list[str] - Category:
optional - Default:
ray, pcb, tlc, tlc_rin, drk, trg, dtm, ray_pcb, pcb_aux, cam - Limits / allowed values: Allowed values: ray, pcb, tlc, tlc_rin, drk, trg, dtm, ray_pcb, pcb_aux, cam, off
- Example:
ray, pcb, tlc - Version history: Unchanged from previous ATLAS versions.
process_qck
Generate profile quicklooks for specific QA tests. When process is explicitly selected and process_qck is left empty, this list is derived automatically from process. An explicit process_qck value overrides that derived list. VLDR quicklooks are controlled separately by process_vldr.
- Type:
list[str] - Category:
optional - Default:
ray, pcb, tlc, tlc_rin, ray_pcb, pcb_aux - Limits / allowed values: Allowed values: ray, pcb, tlc, tlc_rin, ray_pcb, pcb_aux, trg, dtm, drk, drk_ray, drk_pcb, drk_tlc, drk_tlc_rin, drk_ray_pcb, drk_pcb_aux, drk_trg, drk_dtm, off
- Example:
ray, drk - Version history: Unchanged from previous ATLAS versions.
process_bgd
Generate background time-series plots for specific QA tests. When process is explicitly selected and process_bgd is left empty, this list is derived automatically from process. An explicit process_bgd value overrides that derived list.
- Type:
list[str] - Category:
optional - Default:
off - Limits / allowed values: Allowed values: ray, pcb, tlc, tlc_rin, ray_pcb, pcb_aux, trg, dtm, drk, drk_ray, drk_pcb, drk_tlc, drk_tlc_rin, drk_ray_pcb, drk_pcb_aux, drk_trg, drk_dtm, off
- Example:
ray, drk - Version history: New in ATLAS
1.0.1.
process_vldr
Generate VLDR quicklook plots independently of process and process_qck. VLDR quicklooks are enabled by default and can be disabled explicitly with process_vldr = False.
- Type:
bool - Category:
optional - Default:
True - Example:
True - Version history: New in ATLAS
1.0.1.
process_dedicated_dark
Control automatic dedicated-dark companions for explicitly selected QA tests. If True, process = ray automatically adds drk_ray to derived quicklook/background selections, process = tlc adds drk_tlc, and so on. If False, those automatic drk_* companions are omitted. The standalone drk test is never removed by this option when drk is selected. If process is empty, the standard independent defaults are used.
- Type:
bool - Category:
optional - Default:
False - Example:
True - Version history: New in ATLAS
1.0.1.
vertical_scale
Select the vertical scale used for all QA tests. Select one of:range: Use range from the lidar in meters as the vertical scaleheight_agl: Use height above ground level in meters as the vertical scaleheight_asl: Use height above sea level in meters as the vertical scale
- Type:
str - Category:
optional - Default:
range - Limits / allowed values: Allowed values: range, height_agl, height_asl
- Example:
height_agl - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Previous name:use_range. Old name removed in ATLAS1.0.0.
view_mean_signal_stages
Option used only providing the init file to signal_viewer.The user can provide one or more stages for which time-averaged signals will be ploted for each channel and each QA test.If no time-averaged signals exist for a selected stage a warning will be raised and no plots will be created.
- Type:
list[str] - Category:
optional - Default:
common_preprocessing_complete, preprocessing_complete, dark_preprocessing_complete - Limits / allowed values: Allowed values: init, ranges_and_heights, sliced, shots_screened, overflows_checked, dark_assigned, photon_units_converted, dead_time_corrected, averaged, averaged_low_res, averaged_high_res, mean_computed, dark_smoothed, dark_corrected, background_raw_calculated, background_calculated, background_corrected, range_corrected, vert_trimmed, molecular_calculated, mldr_generated, noise_calculated, dark_background_raw_calculated, dark_background_calculated, dark_background_corrected, gain_ratio_generated, calibration_factor_generated, calibrated_ratio_generated_mean, vldr_generated_mean, calibrated_ratio_generated, vldr_generated, screening_complete, common_preprocessing_complete, preprocessing_complete, dark_preprocessing_complete, pol_cal_complete, off
- Example:
preprocessing_complete - Version history: New in ATLAS
1.0.0.
view_signal_stages
Option used only providing the init file to signal_viewer.The user can provide one or more stages for which time-resolved signals will be ploted for each channel and each QA test. Each signal is plotted with a separate line.
- Type:
list[str] - Category:
optional - Default:
screening_complete - Limits / allowed values: Allowed values: init, ranges_and_heights, sliced, shots_screened, overflows_checked, dark_assigned, photon_units_converted, dead_time_corrected, averaged, averaged_low_res, averaged_high_res, mean_computed, dark_smoothed, dark_corrected, background_raw_calculated, background_calculated, background_corrected, range_corrected, vert_trimmed, molecular_calculated, mldr_generated, noise_calculated, dark_background_raw_calculated, dark_background_calculated, dark_background_corrected, gain_ratio_generated, calibration_factor_generated, calibrated_ratio_generated_mean, vldr_generated_mean, calibrated_ratio_generated, vldr_generated, screening_complete, common_preprocessing_complete, preprocessing_complete, dark_preprocessing_complete, pol_cal_complete, off
- Example:
init, preprocessing_complete - this will plot all raw signals and all range-corrected signals - Version history: New in ATLAS
1.0.0.
dpi
Resolution of exported figures in dots per inch.
- Type:
int - Category:
optional - Default:
150 - Example:
300 - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Old names removed in ATLAS1.0.0.
color_reduction
If set to False, the plot colors are not reduced to decrease plot size.
- Type:
bool - Category:
optional - Default:
True - Example:
False - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Old names removed in ATLAS1.0.0. Built-in color reduction performed directly in python with PIL.Imagemagick is no longer used.
overwrite_output
If set to True, ATLAS writes outputs directly into the existing 'plots' and 'ascii' folders, overwriting files with the same names. If set to False, ATLAS creates new timestamped subfolders for each run ('plots_<timestamp>' and 'ascii_<timestamp>') and writes the new outputs there.
- Type:
bool - Category:
optional - Default:
False - Example:
False - Version history: New in ATLAS
1.0.0.
expert_analyst
Name or identifier of the analyst responsible for the processing. It is used in the filename of the generated QA reports
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
ns - Version history: Unchanged from previous ATLAS versions.
export_stages
At the end of ATLAS excecution, the useris asked to export all export_stages. A rough calculation of the size of the data to be exported is provided. Exporting can take a while, depending on the volume of data and number of stages.
- Type:
list[str] - Category:
optional - Default:
pol_cal_complete - Limits / allowed values: Allowed values: init, ranges_and_heights, sliced, shots_screened, overflows_checked, dark_assigned, photon_units_converted, dead_time_corrected, averaged, averaged_low_res, averaged_high_res, mean_computed, dark_smoothed, dark_corrected, background_raw_calculated, background_calculated, background_corrected, range_corrected, vert_trimmed, molecular_calculated, mldr_generated, noise_calculated, dark_background_raw_calculated, dark_background_calculated, dark_background_corrected, gain_ratio_generated, calibration_factor_generated, calibrated_ratio_generated_mean, vldr_generated_mean, calibrated_ratio_generated, vldr_generated, screening_complete, common_preprocessing_complete, preprocessing_complete, dark_preprocessing_complete, pol_cal_complete, off
- Example:
preprocessing_complete - Version history: New in ATLAS
1.0.0.
export_all
If set to True, all channels are exported in the QA reports (e.g analog channels for Rayleigh fit test and photon channels for the telecover test)
- Type:
bool - Category:
optional - Default:
False - Example:
True - Version history: Unchanged from previous ATLAS versions.
filter_channels¶
Restricts the channels that are processed, either by selecting explicit ATLAS channel IDs or excluding groups of channels based on parts of the channel ID.
| Parameter | Type | Default | Allowed / limits |
|---|---|---|---|
select_channels |
list[str] |
empty parameter --> ignored or automatic selection |
|
exclude_wavelength |
list[str] |
empty parameter --> ignored or automatic selection |
|
exclude_telescope_type |
list[str] |
empty parameter --> ignored or automatic selection |
Allowed values: n, f, x, m, g, y, l, h, z |
exclude_channel_type |
list[str] |
empty parameter --> ignored or automatic selection |
Allowed values: p, c, t, v, r, a, f |
exclude_acquisition_mode |
list[str] |
empty parameter --> ignored or automatic selection |
Allowed values: a, p, g |
exclude_channel_subtype |
list[str] |
empty parameter --> ignored or automatic selection |
Allowed values: r, t, n, o, w, c, h, l, a, m, b, s, x |
select_channels
Provide ATLAS channel IDs of the channels to be processed.All channels are processed by default. Excluding options are applied after selecting channels
- Type:
list[str] - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
0355xtax, 0355xtpx - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Previous name:channels. Old name removed in ATLAS1.0.0.
exclude_wavelength
Provide the wavelegth part of the ATLAS channel ID (first 4 characters) of the channels to be excluded before processing.All channels are processed by default.
- Type:
list[str] - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
0355, 1064 - Version history: New in ATLAS
1.0.0.
exclude_telescope_type
Provide the telescope type part of the ATLAS channel ID (5th character) of the channels to be excluded before processing.All channels are processed by default.
- Type:
list[str] - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Limits / allowed values: Allowed values: n, f, x, m, g, y, l, h, z
- Example:
n - near range telescope channels will be excluded - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Old names removed in ATLAS1.0.0.
exclude_channel_type
Provide the channel type part of the ATLAS channel ID (6th character) of the channels to be excluded before processing.All channels are processed by default.
- Type:
list[str] - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Limits / allowed values: Allowed values: p, c, t, v, r, a, f
- Example:
v, f - vibrational Raman and fluorescence channels will be excluded - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Old names removed in ATLAS1.0.0.
exclude_acquisition_mode
Provide the channel acquisition_mode part of the ATLAS channel ID (7th character) of the channels to be excluded before processing.All channels are processed by default.
- Type:
list[str] - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Limits / allowed values: Allowed values: a, p, g
- Example:
a - analogue channels will be excluded - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Old names removed in ATLAS1.0.0.
exclude_channel_subtype
Provide the channel subtype part of the ATLAS channel ID (8th character) of the channels to be excluded before processing.All channels are processed by default.
- Type:
list[str] - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Limits / allowed values: Allowed values: r, t, n, o, w, c, h, l, a, m, b, s, x
- Example:
a - analog channels will be excluded - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Old names removed in ATLAS1.0.0.
trimming_options¶
Controls signal trimming, overflow handling, temporal averaging options, and optional time slicing/exclusion of measurements.
| Parameter | Type | Default | Allowed / limits |
|---|---|---|---|
max_height_agl |
float |
40.0 |
|
low_shot_threshold |
float |
0.9 |
Range: 0.0 to 0.999 |
trim_overflows |
int |
0 |
Allowed values: 0, 1, 2, 3 |
low_res_averaging_period |
str |
1h |
|
low_res_averaging_threshold |
float |
0.5 |
Range: 0.0 to 1.0 |
high_res_averaging_period |
str |
10min |
|
high_res_averaging_threshold |
float |
0.5 |
Range: 0.0 to 1.0 |
max_adjacent_overflows |
int |
5 |
Minimum: 0 |
slice_measurement |
list[str] |
empty parameter --> ignored or automatic selection |
|
exclude_measurement |
list[str] |
empty parameter --> ignored or automatic selection |
max_height_agl
The maximum height in km agl above which signal will be trimmed after the signal trimming is applied.
- Type:
float - Category:
optional - Default:
40.0 - Example:
40 - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Previous name:vertical_trimming, vertical_limit. Old name removed in ATLAS1.0.0.
low_shot_threshold
The fraction of profile shots divided by the max number of shots. Profiles with shots less than low_shot_threshold times the max number of shots will be masked out by the screen low shots stage.
- Type:
float - Category:
optional - Default:
0.9 - Limits / allowed values: Range: 0.0 to 0.999
- Example:
40 - Version history: New in ATLAS
1.0.0.
trim_overflows
This options determines how overflow values in the raw input files will be treated if detected. Choose among: 0: the algorithm will stop and provide a diagnostic error, if overflows are found, 1: the files containing at least one overflow value will be screened out, 2: overflows will be interpolated from neighboring bins.3: overflows will not be masked out.
- Type:
int - Category:
optional - Default:
0 - Limits / allowed values: Allowed values: 0, 1, 2, 3
- Example:
2 - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Old names removed in ATLAS1.0.0.
low_res_averaging_period
Not applied yet for QA - Averaging period (low temporal resolution) for Rayleigh and dark measurements, specified in minutes or hours, for example 10min or 2h. If the measurement duration is shorter than the averaging period, the full dataset is averaged. Otherwise, data are averaged over equal time intervals. Averages are masked when the fraction of missing profiles within an interval exceeds low_res_averaging_threshold.
- Type:
str - Category:
optional - Default:
1h - Example:
1h - Version history: New in ATLAS
1.0.0.
low_res_averaging_threshold
Not applied for QA yet - Threshold for masking averages based on missing data within the averaging time interval. The interval is defined by low_res_averaging_period; averages are masked when the fraction of missing profiles relative to the expected number of profiles exceeds low_res_averaging_threshold.
- Type:
float - Category:
optional - Default:
0.5 - Limits / allowed values: Range: 0.0 to 1.0
- Example:
1h - Version history: New in ATLAS
1.0.0.
high_res_averaging_period
Not applied for QA yet - Averaging period (high temporal resolution) for Rayleigh and dark measurements, specified in minutes or hours, for example 10min or 2h. Decimal values are also accepted: e.g. 0.5min --> 30 seconds, 0.5h --> 30 minutesIf the measurement duration is shorter than the averaging period, the full dataset is averaged. Otherwise, data are averaged over equal time intervals. Averages are masked when the fraction of missing profiles within an interval exceeds high_res_averaging_threshold.
- Type:
str - Category:
optional - Default:
10min - Example:
0.5min - Version history: New in ATLAS
1.0.0.
high_res_averaging_threshold
Not applied for QA yet - Threshold for masking averages based on missing data within the averaging time interval. The interval is defined by high_res_averaging_threshold; averages are masked when the fraction of missing profiles relative to the expected number of profiles exceeds high_res_averaging_threshold.
- Type:
float - Category:
optional - Default:
0.5 - Limits / allowed values: Range: 0.0 to 1.0
- Example:
1h - Version history: New in ATLAS
1.0.0.
max_adjacent_overflows
Therehold applied when overflow interpolation is attempted: trim_overflows = 2 If the number of adjucent bins with overflow values in a measurement profiled exceeds max_adjacent_overflows, the whole profile is masked (similar to trim_overflows = 1)
- Type:
int - Category:
optional - Default:
5 - Limits / allowed values: Minimum: 0
- Example:
3 - Version history: New in ATLAS
1.0.0.
slice_measurement
Select temporal regions to process using repeating triplets:<test_folder_alias>, <start_time>, <stop_time> The same test folder alias can appear multiple times. Accepted time formats: HHMM, yyyymmdd, yyyymmdd_HH, yyyymmdd_HHMM, yyyymmdd_HHMMSS For HHMM only, intervals crossing midnight are handled automatically, e.g. 2300 to 0135 means next day. For absolute formats, write the next date explicitly. Available test folder aliases: ['drk', 'drk_dtm', 'drk_pcb', 'drk_pcb_aux', 'drk_ray', 'drk_ray_pcb', 'drk_tlc', 'drk_tlc_rin', 'drk_trg', 'dtm', 'pcb', 'pcb_aux', 'pcb_aux_m45', 'pcb_aux_p45', 'pcb_m45', 'pcb_p45', 'ray', 'ray_pcb', 'tlc', 'tlc_east', 'tlc_inner', 'tlc_north', 'tlc_outer', 'tlc_rin', 'tlc_south', 'tlc_west', 'trg']
- Type:
list[str] - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
slice_measurement = drk, 2300, 0135, ray, 20251204_2300, 20251205_0600, tlc, 20251205_071510, 20251205_071545, ray_pcb, 20251205_08, 20251205_09 - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Old names removed in ATLAS1.0.0.
exclude_measurement
Select temporal regions to exclude using repeating triplets:<test_folder_alias>, <start_time>, <stop_time> The same test folder alias can appear multiple times. Accepted time formats: HHMM, yyyymmdd, yyyymmdd_HH, yyyymmdd_HHMM, yyyymmdd_HHMMSS For HHMM only, intervals crossing midnight are handled automatically, e.g. 2300 to 0135 means next day. For absolute formats, write the next date explicitly. Available test folder aliases: ['drk', 'drk_dtm', 'drk_pcb', 'drk_pcb_aux', 'drk_ray', 'drk_ray_pcb', 'drk_tlc', 'drk_tlc_rin', 'drk_trg', 'dtm', 'pcb', 'pcb_aux', 'pcb_aux_m45', 'pcb_aux_p45', 'pcb_m45', 'pcb_p45', 'ray', 'ray_pcb', 'tlc', 'tlc_east', 'tlc_inner', 'tlc_north', 'tlc_outer', 'tlc_rin', 'tlc_south', 'tlc_west', 'trg']
- Type:
list[str] - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
exclude_measurement = drk, 2300, 0135, ray, 20251204_2300, 20251205_0600, tlc, 20251205_071510, 20251205_071545, ray_pcb, 20251205_08, 20251205_09 - Version history: New in ATLAS
1.0.0.
explicit_folders¶
Overrides the default measurement folder names inside parent_folder. Leave these empty when the standard ATLAS folder structure is used.
| Parameter | Type | Default | Allowed / limits |
|---|---|---|---|
ray |
str |
empty parameter --> ignored or automatic selection |
|
pcb |
str |
empty parameter --> ignored or automatic selection |
|
tlc |
str |
empty parameter --> ignored or automatic selection |
|
tlc_rin |
str |
empty parameter --> ignored or automatic selection |
|
drk |
str |
empty parameter --> ignored or automatic selection |
|
trg |
str |
empty parameter --> ignored or automatic selection |
|
dtm |
str |
empty parameter --> ignored or automatic selection |
|
ray_pcb |
str |
empty parameter --> ignored or automatic selection |
|
pcb_aux |
str |
empty parameter --> ignored or automatic selection |
|
cam |
str |
empty parameter --> ignored or automatic selection |
ray
Alias folder name for the ray folder.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
ray_02 - Version history: Unchanged from previous ATLAS versions. Since update 1.0.0 the ray suffix has replaced the nrm suffix for Rayleigh measurements. Any folders with the nrm suffix will be renamed using the ray suffix
pcb
Alias folder name for the pcb folder.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
pcb_filter_02 - Version history: Unchanged from previous ATLAS versions. Since update 1.0.0 the p45 and m45 folders have replaced the +45 and -45 folders for pol. cal measurements. Any folder named +45 (-45) will be automatically renamed to p45 (m45), respectively
tlc
Alias folder name for the tlc folder.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
tlc - Version history: Unchanged from previous ATLAS versions.
tlc_rin
Alias folder name for the tlc_rin folder.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
tlc_03 - Version history: Unchanged from previous ATLAS versions.
drk
Alias folder name for the drk folder.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
drk_01 - Version history: Unchanged from previous ATLAS versions.
trg
Alias folder name for the trg folder.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
trg_raman - Version history: New in ATLAS
1.0.0. trg (zero bin measuremnt) measurements can be provided to inspect signals
dtm
Alias folder name for the dtm folder.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
dtm_02 - Version history: New in ATLAS
1.0.0. dtm (deat time measuremnt measurements can be provided to inspect signals
ray_pcb
Alias folder name for the dtm folder.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
ray_pcb_01 - Version history: New in ATLAS
1.0.0. ray_pcb (Rayleigh measuremnt in pol. cal. mode) measurements can be provided to inspect signals
pcb_aux
Alias folder name for the pcb_aux folder.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
pcb_aux - Version history: New in ATLAS
1.0.0. pcb_aux (Pol. Cal. measuremnt for ND filter characterization) measurements can be provided to inspect signals
cam
Alias folder name for the cam folder.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
cam - Version history: New in ATLAS
1.0.0. cam (camera images) measurements can be provided to inspect signals
parsing_options¶
Controls automatic telecover file distribution and custom radiosonde parsing metadata.
| Parameter | Type | Default | Allowed / limits |
|---|---|---|---|
files_per_quadrant |
int |
empty parameter --> ignored or automatic selection |
Minimum: 0 |
files_per_ring |
int |
empty parameter --> ignored or automatic selection |
Minimum: 0 |
rsonde_skip_header |
int |
1 |
Minimum: 0 |
rsonde_skip_footer |
int |
0 |
Minimum: 0 |
rsonde_delimiter |
str |
S |
Allowed values: S, C |
rsonde_column_index |
list[int] |
2, 1, 3, 5 |
Minimum: 0; Allowed list sizes: 3, 4 |
rsonde_column_units |
list[str] |
m_asl, hPa, C, percent |
Allowed values: m_asl, m_agl, km_asl, km_agl, Pa, hPa, atm, K, C, Cx10, percent, fraction; Allowed list sizes: 3, 4 |
rsonde_station_altitude |
float |
empty parameter --> ignored or automatic selection |
Range: 0 to 5000 |
cloudnet_station_name |
str |
empty parameter --> ignored or automatic selection |
|
rsonde_station_name |
str |
empty parameter --> ignored or automatic selection |
|
rsonde_station_wmo_id |
int |
empty parameter --> ignored or automatic selection |
Minimum: 0 |
files_per_quadrant
Number of consecutive telecover files per quadrant sector when files must be automatically distributed. The files are distributed automatically in subfolders (north, east, south, west)and are read from there for any subsequent run, automatically.
- Type:
int - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Limits / allowed values: Minimum: 0
- Example:
4 - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Previous name:files_per_sector. Old name removed in ATLAS1.0.0. In older versions the files where not distributed into sector subfolders. This changed in version 1.0.0
files_per_ring
Number of consecutive telecover files per quadrant sector when files must be automatically distributed. The files are distributed automatically in subfolders (outer, inner)and are read from there for any subsequent run, automatically.
- Type:
int - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Limits / allowed values: Minimum: 0
- Example:
4 - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. In older versions the files where not distributed into sector subfolders. This changed in version 1.0.0
rsonde_skip_header
Number of header lines to skip when reading an ASCII radiosonde file with custom format.
- Type:
int - Category:
optional - Default:
1 - Limits / allowed values: Minimum: 0
- Example:
1 - Version history: Moved in ATLAS
<=0.5.0fromsettings_file.
rsonde_skip_footer
Number of footer lines to skip when reading an ASCII radiosonde file with custom format.
- Type:
int - Category:
optional - Default:
0 - Limits / allowed values: Minimum: 0
- Example:
0 - Version history: Moved in ATLAS
<=0.5.0fromsettings_file.
rsonde_delimiter
Delimiter type used when reading an ASCII radiosonde file with custom format.
- Type:
str - Category:
optional - Default:
S - Limits / allowed values: Allowed values: S, C
- Example:
S - space delimeter - Version history: Moved in ATLAS
<=0.5.0fromsettings_file.
rsonde_column_index
Column indices for height, pressure, temperature, and optionally humidity. Used when reading an ASCII radiosonde.file with custom format.
- Type:
list[int] - Category:
optional - Default:
2, 1, 3, 5 - Limits / allowed values: Minimum: 0; Allowed list sizes: 3, 4
- Example:
2, 1, 3, 5 - Version history: Moved in ATLAS
<=0.5.0fromsettings_file.
rsonde_column_units
Units corresponding to the radiosonde columns. Used when reading an ASCII radiosonde
- Type:
list[str] - Category:
optional - Default:
m_asl, hPa, C, percent - Limits / allowed values: Allowed values: m_asl, m_agl, km_asl, km_agl, Pa, hPa, atm, K, C, Cx10, percent, fraction; Allowed list sizes: 3, 4
- Example:
m_asl, hPa, C, percent - Version history: Moved in ATLAS
<=0.5.0fromsettings_file.
rsonde_station_altitude
Altitude of the radiosonde station. Used when reading an ASCII radiosonde and agl height units are used.
- Type:
float - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Limits / allowed values: Range: 0 to 5000
- Example:
60. - Version history: Moved in ATLAS
<=0.5.0fromsettings_file. Previous name:station_altitude.
cloudnet_station_name
Cloudnet station name used when Cloudnet. If provided, ATALS will attempt downloading ECMWF meteorological files from Cloudnet to extract the temperature, pressure, and relative humidity parameters. The name of the station must be provided exactly as define in the Cloudnet API. This is not necessary the same as the display name in the web interface.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
garmish - Version history: New in ATLAS
1.0.0.
rsonde_station_name
Radiosonde station name displayed in plots. If an ECMW file is used, the station name is used for displaying instead and this parameter is ignored.
- Type:
str - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Example:
Thessaloniki - Version history: Moved in ATLAS
<=0.5.0.
rsonde_station_wmo_id
WMO identifier of the radiosonde station. If provided, ATALS will attempt downloading Wyoming radiosonde filed to extract the temperature, pressure, and relative humidity.
- Type:
int - Category:
optional - Default:
empty parameter --> ignored or automatic selection - Limits / allowed values: Minimum: 0
- Example:
16622 - Version history: Moved in the current ATLAS version. Previous name:
rsonde_wmo_number. Before ATLAS 1.0.0 this parameter was used for display. Since ATLAS 1.0.0 it is used for automatic downloading of Wyoming radiosonde files.