pipeline — Pipeline#

This module wraps all the high-level simulation and analysis tasks of the package, providing functions with the same name as those in the tasks module, but driven entirely by keyword arguments.

These functions are meant to be used by the command-line interface, while programmatic pipelines should always use the functions in the tasks module, which come with a precise, documented signature.

Module documentation#

Pipeline facilities.

hexsample.pipeline.simulate(**kwargs) str[source]#

Run a simulation.

hexsample.pipeline.reconstruct(**kwargs) str[source]#

Run a reconstruction.

hexsample.pipeline.calibspec(**kwargs) str[source]#

Create a probability density function from a reconstructed spectrum to use in the gain calibration.

hexsample.pipeline.calibrate_position(**kwargs) str[source]#

Calibrate the position reconstruction algorithms.

hexsample.pipeline.calibrate_noise(**kwargs) str[source]#

Calibrate the noise of the chip.

hexsample.pipeline.calibrate_dark(**kwargs) Tuple[str, str][source]#

Calibrate the dark of the chip.

hexsample.pipeline.calibrate_enc(**kwargs) str[source]#

Calibrate the ENC of the chip.

hexsample.pipeline.calibrate_equalization(**kwargs) str[source]#

Calibrate the equalization of the chip.

hexsample.pipeline.calibrate_gain(**kwargs) str[source]#

Calibrate the gain of the chip.

hexsample.pipeline.synthesize_calibration_file(**kwargs) str[source]#

Generate a calibration file of a given type.

hexsample.pipeline.display(**kwargs) None[source]#

Display events from a digi or recon file.

hexsample.pipeline.quicklook(**kwargs) None[source]#

Quicklook at events from a recon file.

hexsample.pipeline.mdat3_to_digi(**kwargs) None[source]#

Convert a .mdat3 file to a HDF5 digi file.

hexsample.pipeline.calibview(**kwargs) None[source]#

Inspect a calibration matrix.