Commit 7b86617f834b40111e9ac4879bd69f4326cdada3
1 parent
c3ce2e0d
Update information about example scripts.
Showing
2 changed files
with
16 additions
and
5 deletions
examples/README
| 1 | This folder contains Python example scripts that illustrate the | 1 | This folder contains Python example scripts that illustrate the |
| 2 | usage of the ctools. | 2 | usage of the ctools. |
| 3 | 3 | ||
| 4 | +benchmark_cta_analysis.py | ||
| 5 | + Performs performance benchmarks of the various CTA analysis types. | ||
| 6 | + | ||
| 4 | pipeline_stacked_mem.py | 7 | pipeline_stacked_mem.py |
| 5 | Example pipeline for simulating events and performing a stacked | 8 | Example pipeline for simulating events and performing a stacked |
| 6 | analysis in memory. No files will be written to disk. | 9 | analysis in memory. No files will be written to disk. |
| @@ -35,10 +38,18 @@ make_unbinned_analysis.py | @@ -35,10 +38,18 @@ make_unbinned_analysis.py | ||
| 35 | and the observed offset angle distribution is displayed in | 38 | and the observed offset angle distribution is displayed in |
| 36 | counts space. | 39 | counts space. |
| 37 | 40 | ||
| 41 | +show_butterfly.py | ||
| 42 | + Displays a butterfly generated using the ctbutterfly tool. | ||
| 43 | + | ||
| 44 | +show_pha.py | ||
| 45 | + Displays a spectrum in PHA format. | ||
| 46 | + | ||
| 38 | show_pull_histogram.py | 47 | show_pull_histogram.py |
| 39 | - Displays pull histograms from pull data generated by the | ||
| 40 | - cspull script. | 48 | + Displays pull histograms generated by the cspull script. |
| 49 | + | ||
| 50 | +show_response.py | ||
| 51 | + Display one or several CTA response functions. | ||
| 41 | 52 | ||
| 42 | show_ts_distribution.py | 53 | show_ts_distribution.py |
| 43 | - Displays pull histograms from pull data generated by the | ||
| 44 | - cspull script. | 54 | + Displays Test Statistic histograms generated using the cstsdist |
| 55 | + script. |
examples/benchmark_cta_analysis.py
| 1 | #! /usr/bin/env python | 1 | #! /usr/bin/env python |
| 2 | # ========================================================================== | 2 | # ========================================================================== |
| 3 | -# This script peforms a benchmark of the various CTA analysis styles | 3 | +# This script peforms a benchmark of the various CTA analysis types |
| 4 | # (unbinned, binned, cube-style), and if matplotlib is installed, creates | 4 | # (unbinned, binned, cube-style), and if matplotlib is installed, creates |
| 5 | # a plot of the benchmark results. | 5 | # a plot of the benchmark results. |
| 6 | # | 6 | # |