Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More type hinting for the codebase #265

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

More type hinting for the codebase #265

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
525faa2
enh: type hinting for bright.py
Nov 26, 2024
fb0ed0b
test, docs: ensure get_bright returns expected types
Nov 26, 2024
1c4d9c1
test, docs: ensure get_bright_perc returns expected types
Nov 26, 2024
821b4b3
docs: add futures annotations import for older py versions
Nov 26, 2024
6f92494
docs: add type hints for contour
Nov 26, 2024
63cdca8
docs type hints for fl_crosstalk
Nov 26, 2024
a2862a3
docs: type hints for volume and inert_ratio
Nov 26, 2024
c695331
docs: add type hints to emodulus load
Nov 26, 2024
ea1ad64
docs: type hints for emod pxcorr
Nov 26, 2024
392b57c
docs: add type hints for emod __init__ functions
Nov 27, 2024
35bdbd8
docs: add type hints for emod scale_linear
Nov 27, 2024
63905bf
docs: add type hints for emod viscosity
Nov 27, 2024
e49eba0
ref: docstrings - remove duplicate info but keep array shape info
Nov 27, 2024
4d48eab
updated CHANGELOG
Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion dclab/features/bright.py
View file
Open in desktop
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]],
PinkShnack marked this conversation as resolved.
Show resolved Hide resolved
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
Loading