Skip to content

Commit

Permalink
enh: type hinting for bright.py
Browse files Browse the repository at this point in the history
  • Loading branch information
Eoghan O'Connell committed Nov 26, 2024
1 parent c2fbfbd commit 525faa2
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion dclab/features/bright.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,13 @@
RT-DC event image mask.
"""
import numpy as np
import numpy.typing as npt


def get_bright(mask, image, ret_data="avg,sd"):
def get_bright(
mask: npt.NDArray[np.bool] | list[npt.NDArray[np.bool]],
image: npt.NDArray | list[npt.NDArray],
ret_data: str = "avg,sd"):
"""Compute avg and/or std of the event brightness
The event brightness is defined by the gray-scale values of the
Expand Down

0 comments on commit 525faa2

Please sign in to comment.