simtools-plot-tabular-data#

Plot tabular data read from a file or from the model parameter repository.

Data file mode (--plot_config) applies a plotting configuration to a data file. Model parameter mode (--parameter) plots a model parameter using the plotting configurations defined in its schema file.

Plots tabular data in one of two modes.

Data file mode (--plot_config): uses a plotting configuration file to define the data to be plotted and all plotting details.
Model parameter mode (--parameter): uses the plotting configurations defined in the model parameter schema files. Use --plot_type all to plot all types defined in the schema.

Command line arguments

plot_config (str, required in data file mode): Plotting configuration file name.
parameter (str, required in model parameter mode): Model parameter to plot (e.g., ‘atmospheric_profile’).
output_file (str, required in data file mode): Output file name (without suffix).
parameter_version (str, required in model parameter mode): Version of the model parameter to plot (e.g., ‘1.0.0’).
site (str, required in model parameter mode): Site for which the model parameter is defined (e.g., ‘North’).
telescope (str, optional): Telescope for which the model parameter is defined (e.g., ‘LSTN-01’).
plot_type (str, required in model parameter mode): Type of plot as defined in the schema file.

Example

Plot tabular data using a configuration file.

simtools-plot-tabular-data --plot_config config_file_name --output_file output_file_name

Plot tabular data for a specific type defined in the schema file:

simtools-plot-tabular-data \\
    --parameter atmospheric_profile \\
    --parameter_version 1.0.0 \\
    --site North \\
    --plot_type refractive_index_vs_altitude

Plot tabular data for all types defined in the schema file:

simtools-plot-tabular-data \\
    --parameter fadc_pulse_shape \\
    --parameter_version 1.0.0 \\
    --site North \\
    --telescope LSTN-01 \\
    --plot_type all

Command line arguments#

options#

–help: show this help message and exit
–plot_config: Plotting configuration file name (data file mode).
–parameter: Model parameter name to plot (model parameter mode, e.g., ‘atmospheric_profile’).
–output_file: Output file name (without suffix; required in data file mode).
–plot_type: Plot type as defined in the schema file (required in model parameter mode; use ‘all’ to plot all types).

simulation model#

–parameter_version: model parameter version
–overwrite_model_parameters: JSON string with model parameters to overwrite
–site: Observatory site (e.g., North, South). Use –show_options site.
–telescope: telescope model name (e.g., LSTN-01, SSTS-design, …)

model repository#

–simulation_models_path: Path containing the simulation-model repository to read.
–simulation_models_git_path: Path to a local normal, bare, or mirror Git repository containing simulation models.
–simulation_models_git_revision: Git tag, ref, or commit to read from the simulation-model repository.

application#

–show_options: Print available values for a supported option and exit.

Examples#

Plot a single-photoelectron spectrum from ECSV#

Apply a plotting configuration to ECSV camera-response data and write PDF and PNG figures.

Application: simtools-plot-tabular-data

Integration test: plot_tabular_data_for_single_pe_from_ecsv_file.yml

Command

simtools-plot-tabular-data --config tests/integration_tests/config/plot_tabular_data_for_single_pe_from_ecsv_file.yml

Configuration

figure_format:
- pdf
- png
output_file: single_pe_data
output_path: simtools-output
plot_config: ${static:plot_single_pe_config_from_ecsv_file.yml}

Plot a legacy single-photoelectron spectrum#

Read legacy CSV camera-response data through a plotting configuration and write PDF and PNG figures.

Application: simtools-plot-tabular-data

Integration test: plot_tabular_data_for_single_pe_legacy_data.yml

Command

simtools-plot-tabular-data --config tests/integration_tests/config/plot_tabular_data_for_single_pe_legacy_data.yml

Configuration

figure_format:
- pdf
- png
output_file: single_pe_data
output_path: simtools-output
plot_config: ${static:plot_single_pe_config_data_from_legacy_csv.yml}
data_search_path: tests/resources/downloaded

Plot all atmospheric-profile quantities#

Plot density, thickness, refractive index, and related quantities from the North atmospheric model.

Application: simtools-plot-tabular-data

Integration test: plot_tabular_data_for_model_parameter_atmospheric_density_all.yml

Command

simtools-plot-tabular-data --config tests/integration_tests/config/plot_tabular_data_for_model_parameter_atmospheric_density_all.yml

Configuration

figure_format:
- pdf
- png
output_path: simtools-output
parameter: atmospheric_profile
parameter_version: 1.0.0
plot_type: all
site: North

Plot atmospheric refractive index#

Plot refractive index versus altitude from the North-site atmospheric-profile model parameter.

Application: simtools-plot-tabular-data

Integration test: plot_tabular_data_for_model_parameter_atmospheric_density_one_type.yml

Command

simtools-plot-tabular-data --config tests/integration_tests/config/plot_tabular_data_for_model_parameter_atmospheric_density_one_type.yml

Configuration

figure_format:
- pdf
- png
output_path: simtools-output
parameter: atmospheric_profile
parameter_version: 1.0.0
plot_type: refractive_index_vs_altitude
site: North

Plot an LST camera pulse shape#

Retrieve the LST camera FADC pulse-shape parameter and plot its sampled waveform.

Application: simtools-plot-tabular-data

Integration test: plot_tabular_data_for_model_parameter_fadc_pulse_shape.yml

Command

simtools-plot-tabular-data --config tests/integration_tests/config/plot_tabular_data_for_model_parameter_fadc_pulse_shape.yml

Configuration

figure_format: pdf
output_path: simtools-output
parameter: fadc_pulse_shape
parameter_version: 1.0.0
plot_type: all
site: North
telescope: LSTN-design