PixelStatisticsCalculatorTool

class ctapipe.tools.calculate_pixel_stats.PixelStatisticsCalculatorTool(**kwargs: Any)

Bases: Tool

Perform statistics calculation for pixel-wise image data

Attributes Summary

DL1_COLUMN_NAMES
aliases
allowed_tels	List of allowed tel_ids, others will be ignored.
classes
description
examples
flags
input_column_name	Column name of the pixel-wise image data to calculate statistics
name
output_path	Output filename
output_table_name	Table name of the output statistics
overwrite	Overwrite output file if it exists

Methods Summary

finish()	Finish up.
setup()	Set up the tool.
start()	Main function of the tool.

Attributes Documentation

DL1_COLUMN_NAMES = ['image', 'peak_time']

aliases: StrDict = {('i', 'input_url'): 'TableLoader.input_url', ('o', 'output_path'): 'PixelStatisticsCalculatorTool.output_path'}

allowed_tels

List of allowed tel_ids, others will be ignored. If None, all telescopes in the input stream will be included.

classes: ClassesType = [<class 'ctapipe.io.tableloader.TableLoader'>, <class 'ctapipe.monitoring.calculator.PixelStatisticsCalculator'>]

description: str | Unicode[str, str | bytes] = 'Perform statistics calculation for pixel-wise image data'

examples: str | Unicode[str, str | bytes] = '\n    To calculate statistics of pixel-wise image data files:\n\n    > ctapipe-calculate-pixel-statistics --TableLoader.input_url input.dl1.h5 --output_path /path/monitoring.h5 --overwrite\n\n    '

flags: StrDict = {'overwrite': ({'PixelStatisticsCalculatorTool': {'overwrite': True}}, 'Overwrite existing files')}

input_column_name

Column name of the pixel-wise image data to calculate statistics

name: str | Unicode[str, str | bytes] = 'ctapipe-calculate-pixel-statistics'

output_path

Output filename

output_table_name

Table name of the output statistics

overwrite

Overwrite output file if it exists

Methods Documentation

finish()

Finish up.

This is called automatically after start when run is called.

setup()

Set up the tool.

This method runs after the configuration and command line options have been parsed.

Here the tool should construct all Components, open files, etc.

start()

Main function of the tool.

This is automatically called after initialize when run is called.