DumpInstrumentTool

class ctapipe.tools.dump_instrument.DumpInstrumentTool(**kwargs: Any)

Bases: Tool

Attributes Summary

aliases
classes
description	A trait for unicode strings.
format	Format of output file
name
outdir	Output directory.

Methods Summary

finish()	Finish up.
setup()	Set up the tool.
start()	Main function of the tool.
write_camera_definitions()	writes out camgeom and camreadout files for each camera
write_optics_descriptions()	writes out optics files for each telescope type
write_subarray_description()

Attributes Documentation

aliases: StrDict = {('f', 'format'): 'DumpInstrumentTool.format', ('i', 'input'): 'EventSource.input_url', ('o', 'outdir'): 'DumpInstrumentTool.outdir'}

classes: ClassesType = [<class 'ctapipe.io.eventsource.EventSource'>]

description: str | Unicode[str, str | bytes]

A trait for unicode strings.

format

Format of output file

name: str | Unicode[str, str | bytes] = 'ctapipe-dump-instrument'

outdir

Output directory. If not given, the current working directory will be used.

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.

write_camera_definitions()

writes out camgeom and camreadout files for each camera

write_optics_descriptions()

writes out optics files for each telescope type

write_subarray_description()