ImageCleaner#

class ctapipe.image.cleaning.ImageCleaner(**kwargs: Any)[source]#

Bases: TelescopeComponent

Abstract class for all configurable Image Cleaning algorithms. Use ImageCleaner.from_name() to construct an instance of a particular algorithm

Methods Summary

__call__(tel_id, image[, arrival_times, ...])

Identify pixels with signal, and reject those with pure noise.

Methods Documentation

abstract __call__(tel_id: int, image: ndarray, arrival_times: ndarray | None = None, *, monitoring: MonitoringCameraContainer | None = None) ndarray[source]#

Identify pixels with signal, and reject those with pure noise.

Parameters:
tel_id: int

which telescope id in the subarray is being used (determines which cut is used)

imagenp.ndarray

image pixel data corresponding to the camera geometry

arrival_times: np.ndarray

image of arrival time (not used in this method)

monitoring: `ctapipe.containers.MonitoringCameraContainer`

MonitoringCameraContainer to make use of additional parameters from monitoring data e.g. pedestal std.

Returns:
np.ndarray

boolean mask of pixels passing cleaning