DetectionCount#

DetectionCount(target=0, excess_only=False)[source]#

Count of detection, possibly in excess or deviation of a target count.

Parameters:
targetint, default=0

Target number of detections. If 0, the count is the absolute number of detections. If positive, the count reported is, by default, the absolute difference between the number of detections and the target. If the excess_only parameter is set to True, the count is the number of detections in excess of the target if larger, otherwise zero.

excess_onlybool, default=False

If False, the count is the absolute difference between the target and the number of detections. If True, the count is the number of detections in excess of the target if larger, otherwise zero.