LoadImageCount

class caqtus.analysis.loading.LoadImageCount(
camera_name: str,
picture_name: ImageLabel,
background_name: ImageLabel | None = attr_dict['background_name'].default,
roi: ROI | None = attr_dict['roi'].default,
column_name: str | None = attr_dict['column_name'].default,
)

Bases: CombinableLoader

Loads the count values of an image.

This loader computes the sum of the pixel values of an image.

Parameters:

  • camera_name – The name of the camera.

  • picture_name – The name of the picture.

  • background_name – The name of the background picture to subtract before computing the sum. If None, no background is subtracted.

  • roi – The region of interest to reduce the sum to. If None, the whole picture is used.

  • column_name – The name of the column to store the computed sum in. If not provided, the column is named ‘{picture_name} count’.

load(
shot: Shot,
) → DataFrame

Load data from a shot and return it as a DataFrame.

This method must be implemented by subclasses. It must return a dataframe containing the data loaded from the shot.