Skip to content

Commit

Permalink
fixed docstrings and type hint according to Fabians comments
Browse files Browse the repository at this point in the history
  • Loading branch information
JuliaKukulies authored Aug 14, 2024
1 parent 3a18cfb commit 5551fb7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions tobac/feature_detection.py
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ def feature_detection_threshold(
] = "center",
sigma_threshold: float = 0.5,
n_erosion_threshold: int = 0,
n_min_threshold: Union[int, dict, list] = 0,
n_min_threshold: Union[int, dict[float, int], list[int]] = 0,
min_distance: float = 0,
idx_start: int = 0,
PBC_flag: Literal["none", "hdim_1", "hdim_2", "both"] = "none",
Expand Down Expand Up @@ -428,7 +428,7 @@ def feature_detection_threshold(
Number of pixels by which to erode the identified features.
Default is 0.
n_min_threshold : int, dict or list, optional
n_min_threshold : int, dict of float to int, or list of int, optional
Minimum number of identified contiguous pixels for a feature to be detected. Default is 0.
If given as a list, the number of elements must match number of thresholds.
If given as a dict, the keys need to match the thresholds and the values are the minimum number of identified contiguous pixels for a feature using that specific threshold.
Expand Down Expand Up @@ -899,7 +899,7 @@ def feature_detection_multithreshold_timestep(
] = "center",
sigma_threshold: float = 0.5,
n_erosion_threshold: int = 0,
n_min_threshold: Union[int, dict, list] = 0,
n_min_threshold: Union[int, dict[float, int], list[int]] = 0,
min_distance: float = 0,
feature_number_start: int = 1,
PBC_flag: Literal["none", "hdim_1", "hdim_2", "both"] = "none",
Expand Down Expand Up @@ -946,7 +946,7 @@ def feature_detection_multithreshold_timestep(
Number of pixels by which to erode the identified features.
Default is 0.
n_min_threshold : int, dict or list, optional
n_min_threshold : int, dict of float to int, or list of int, optional
Minimum number of identified contiguous pixels for a feature to be detected. Default is 0.
If given as a list, the number of elements must match number of thresholds.
If given as a dict, the keys need to match the thresholds and the values are the minimum number of identified contiguous pixels for a feature using that specific threshold.
Expand Down Expand Up @@ -1143,7 +1143,7 @@ def feature_detection_multithreshold(
] = "center",
sigma_threshold: float = 0.5,
n_erosion_threshold: int = 0,
n_min_threshold: Union[int, dict, list] = 0,
n_min_threshold: Union[int, dict[float, int], list[int]] = 0,
min_distance: float = 0,
feature_number_start: int = 1,
PBC_flag: Literal["none", "hdim_1", "hdim_2", "both"] = "none",
Expand Down Expand Up @@ -1188,7 +1188,7 @@ def feature_detection_multithreshold(
Number of pixels by which to erode the identified features.
Default is 0.
n_min_threshold : int, dict or list, optional
n_min_threshold : int, dict of float to int, or list of int, optional
Minimum number of identified contiguous pixels for a feature to be detected. Default is 0.
If given as a list, the number of elements must match number of thresholds.
If given as a dict, the keys need to match the thresholds and the values are the minimum number of identified contiguous pixels for a feature using that specific threshold.
Expand Down

0 comments on commit 5551fb7

Please sign in to comment.