NSBImageCleaner#

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

Bases: TailcutsImageCleaner

Clean images based on lstchains image cleaning technique described in [LST23]. See ctapipe.image.nsb_image_cleaning.

Attributes Summary

bright_cleaning_fraction

Fraction parameter for bright_cleaning.

bright_cleaning_n_pixels

Consider this number of the brightest pixels for calculating the mean charge.

bright_cleaning_threshold

Threshold parameter for bright_cleaning.

largest_island_only

Set to true to get only largest island.

pedestal_factor

Factor for interleaved pedestal cleaning.

time_limit

Time limit for the apply_time_delta_cleaning.

time_num_neighbors

Used for apply_time_delta_cleaning.

Methods Summary

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

Apply NSB image cleaning used by lstchain.

Attributes Documentation

bright_cleaning_fraction#

Fraction parameter for bright_cleaning. Pixels below fraction * (mean charge in the bright_cleaning_n_pixels brightest pixels) will be removed from the cleaned image. Set bright_cleaning_threshold to None if no bright_cleaning should be applied.

bright_cleaning_n_pixels#

Consider this number of the brightest pixels for calculating the mean charge. Pixels below fraction * (mean charge in the bright_cleaning_n_pixels brightest pixels) will be removed from the cleaned image. Set bright_cleaning_threshold to None if no bright_cleaning should be applied.

bright_cleaning_threshold#

Threshold parameter for bright_cleaning. Minimum mean charge in the bright_cleaning_n_pixels brightest pixels to apply the cleaning. Set to None if no bright_cleaning should be applied.

largest_island_only#

Set to true to get only largest island.

pedestal_factor#

Factor for interleaved pedestal cleaning. It is multiplied by the pedestal standard deviation for each pixel to calculate pixelwise upper limit picture thresholds and clip them with picture_thresh_pe of TailcutsImageCleaner for tailcuts_clean considering the current background. If no pedestal standard deviation is given, interleaved pedestal cleaning is not applied and picture_thresh_pe of TailcutsImageCleaner is used alone instead.

time_limit#

Time limit for the apply_time_delta_cleaning. Set to None if no apply_time_delta_cleaning should be applied.

time_num_neighbors#

Used for apply_time_delta_cleaning. A selected pixel needs at least this number of (already selected) neighbors that arrived within a given time_limit to itself to survive this cleaning.

Methods Documentation

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

Apply NSB image cleaning used by lstchain. See ImageCleaner.__call__()