Module iaf.plot.validation

Validation plotting functions.

Functions

def plot_background_subtraction_control(img: numpy.ndarray, background: numpy.ndarray, img_corr: Optional[numpy.ndarray] = None, horizontal_profile_pos: Optional[int] = None, vertical_profile_pos: Optional[int] = None, figure_size: tuple = (12, 8), dpi: int = 150, out_file_name: Union[ForwardRef(None), pathlib.Path, str] = None) ‑> None

Plot horizontal and vertical profiles across the image to display the result of background estimation.

Parameters

img : np.ndarray

Image before background subtraction.

background : np.ndarray

Image containing the background estimation.

img_corr : np.ndarray | None

Background-subtracted image. Omit to calculate from img and background.

horizontal_profile_pos : Optional[int] = None

Position of the horizontal profile to plot. Omit to default to the vertical center of the image.

vertical_profile_pos : Optional[int] = None

Position of the vertical profile to plot. Omit to default to the horizontal center of the image.

figure_size : tuple (Optional)

Size of the figure.

dpi : int (Optional)

Resolution of the figure (please notice, this is set whether the figure is saved or not).

out_file_name : Union[None, Path, str] (Optional)

Full file name to save the figure. The figure is only displayed if no file name is passed.