Reference API¶

Command-line tools¶

usage: iact-estimator [-h] [--version] [--performance PERFORMANCE]
                      {config,run} ...

Positional Arguments¶

command: Possible choices: config, run

Named Arguments¶

--version

Default: False

--performance

Custom performance data.

Default: ''

Get the default config file¶

usage: iact-estimator config [-h] [--to TO]

Named Arguments¶

--to: Where to save the configuration file (default: current working directory).

Run the estimation process¶

usage: iact-estimator run [-h] --config CONFIG [--source-name SOURCE_NAME]
                          [--output-path OUTPUT_PATH]
                          [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
                          [--overwrite]

Named Arguments¶

--config

Path to configuration file.

--source-name

Name of the source to estimate.

Default: 'test_source'

--output-path

Path where output will be saved (defaults to current working directory)

--log-level

Possible choices: DEBUG, INFO, WARNING, ERROR, CRITICAL

Logging level.

Default: INFO

--overwrite

Overwrite any generated output.

Default: False

Package resources¶

The package comes shipped with a set of package resources which are available after installation.

Configuration File¶

A default configuration file config.yml can be obtained with the Get the default config file command.

Performance Data Tables¶

All performance data are stored as ~astropy.table.QTable objects and can be imported directly:

MAGIC-only Performance¶

from iact_estimator import (
    LOW_ZENITH_PERFORMANCE,      # 0-30° zenith
    MID_ZENITH_PERFORMANCE,      # 30-45° zenith
    HIGH_ZENITH_PERFORMANCE,     # ~60° zenith
)

MAGIC+LST1 Performance¶

from iact_estimator import (
    MAGIC_LST1_LOW_ZENITH_PERFORMANCE,   # 0-30° zenith
    MAGIC_LST1_MID_ZENITH_PERFORMANCE,   # 30-45° zenith
    MAGIC_LST1_HIGH_ZENITH_PERFORMANCE,  # ~60° zenith (MC-based)
)

Each table contains the following columns:

min_energy: Lower energy bin edge (GeV)
max_energy: Upper energy bin edge (GeV)
gamma_rate: Rate of gamma-ray events (1/min)
background_rate: Rate of background events (1/min)

Data Sources and References¶

Performance Data Provenance¶
Dataset	Zenith	Source
MAGIC Low/Mid	0-45°	Aleksić et al. 2016, Astroparticle Physics, 72, 76
MAGIC High	55-62°	Crab observations (2016-2018), 2.5 hours
MAGIC+LST1 Low	0-30°	Monte Carlo simulations, validated with data
MAGIC+LST1 Mid	30-45°	Abe et al. 2023, A&A, 670, A145
MAGIC+LST1 High	~59°	Monte Carlo simulations (conservative background)

Note

When using MAGIC+LST1 high zenith performance data, please note that it is based on Monte Carlo simulations. Background rates above 1 TeV have been increased by 40% to provide conservative estimates.

API description¶

This section contains auto-generated API reference documentation [1].