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.

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

reduce bia-bob suggestions #348

Merged
merged 2 commits into from
Sep 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 18 additions & 23 deletions clic/include/tier1.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ namespace cle::tier1
* @param dst The output image where results are written into. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'filter', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_absolute
*/
auto
Expand Down Expand Up @@ -81,7 +81,7 @@ add_image_and_scalar_func(const Device::Pointer & device, const Array::Pointer &
* @param dst The output image where results are written into. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'combine', 'binary processing', 'in assistant', 'combine labels', 'label processing', 'bia-bob-suggestion'
* @note 'combine', 'binary processing', 'in assistant', 'combine labels', 'label processing'
* @see https://clij.github.io/clij2-docs/reference_binaryAnd
*/
auto
Expand Down Expand Up @@ -138,7 +138,7 @@ binary_not_func(const Device::Pointer & device, const Array::Pointer & src, Arra
* @param src1 The second binary input image to be processed. [const Array::Pointer &]
* @param dst The output image where results are written into. [Array::Pointer ( = None )]
* @return Array::Pointer
* @note 'combine', 'binary processing', 'in assistant', 'combine labels', 'label processing', 'bia-bob-suggestion'
* @note 'combine', 'binary processing', 'in assistant', 'combine labels', 'label processing'
*
* @see https://clij.github.io/clij2-docs/reference_binaryOr
*/
Expand All @@ -158,7 +158,7 @@ binary_or_func(const Device::Pointer & device,
* @param src1 The second binary input image to be subtracted from the first. [const Array::Pointer &]
* @param dst The output image where results are written into. [Array::Pointer ( = None )]
* @return Array::Pointer
* @note 'combine', 'binary processing', 'in assistant', 'combine labels', 'label processing', 'bia-bob-suggestion'
* @note 'combine', 'binary processing', 'in assistant', 'combine labels', 'label processing'
*
* @see https://clij.github.io/clij2-docs/reference_binarySubtract
*/
Expand All @@ -181,7 +181,7 @@ binary_subtract_func(const Device::Pointer & device,
* @param dst The output image where results are written into. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'combine', 'binary processing', 'in assistant', 'combine labels', 'label processing', 'bia-bob-suggestion'
* @note 'combine', 'binary processing', 'in assistant', 'combine labels', 'label processing'
* @see https://clij.github.io/clij2-docs/reference_binaryXOr
*/
auto
Expand Down Expand Up @@ -431,7 +431,7 @@ dilate_box_func(const Device::Pointer & device, const Array::Pointer & src, Arra
* @param dst Output result image. Output result image. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'binary processing', 'bia-bob-suggestion'
* @note 'binary processing'
* @see https://clij.github.io/clij2-docs/reference_dilateSphere
* @deprecated This function is deprecated. Consider using dilate() instead.
*/
Expand All @@ -452,7 +452,7 @@ dilate_sphere_func(const Device::Pointer & device, const Array::Pointer & src, A
* @param connectivity Element shape, "box" or "sphere". [std::string ( = "box" )]
* @return Array::Pointer
*
* @note 'binary processing', 'bia-bob-suggestion'
* @note 'binary processing'
* @see https://clij.github.io/clij2-docs/reference_dilateBox
* @see https://clij.github.io/clij2-docs/reference_dilateSphere
*/
Expand Down Expand Up @@ -567,7 +567,7 @@ erode_box_func(const Device::Pointer & device, const Array::Pointer & src, Array
* @param dst Output result image. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'binary processing', 'bia-bob-suggestion'
* @note 'binary processing'
* @see https://clij.github.io/clij2-docs/reference_erodeSphere
* @deprecated This function is deprecated. Consider using erode() instead.
*/
Expand All @@ -588,7 +588,7 @@ erode_sphere_func(const Device::Pointer & device, const Array::Pointer & src, Ar
* @param connectivity Element shape, "box" or "sphere". [std::string ( = "box" )]
* @return Array::Pointer
*
* @note 'binary processing', 'bia-bob-suggestion'
* @note 'binary processing'
* @see https://clij.github.io/clij2-docs/reference_erodeBox
* @see https://clij.github.io/clij2-docs/reference_erodeSphere
*/
Expand Down Expand Up @@ -678,7 +678,6 @@ gaussian_blur_func(const Device::Pointer & device,
* @param dst Output result image. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'bia-bob-suggestion'
* @see https://clij.github.io/clij2-docs/reference_generateDistanceMatrix
*/
auto
Expand Down Expand Up @@ -851,7 +850,7 @@ hessian_eigenvalues_func(const Device::Pointer & device,
* @param dst Output result image. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'filter', 'edge detection', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'edge detection', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_laplaceBox
* @deprecated This function is deprecated. Consider using laplace() instead.
*/
Expand All @@ -868,7 +867,7 @@ laplace_box_func(const Device::Pointer & device, const Array::Pointer & src, Arr
* @param dst Output result image. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'filter', 'edge detection', 'bia-bob-suggestion'
* @note 'filter', 'edge detection'
* @see https://clij.github.io/clij2-docs/reference_laplaceDiamond
* @deprecated This function is deprecated. Consider using laplace() instead.
*/
Expand All @@ -886,7 +885,7 @@ laplace_diamond_func(const Device::Pointer & device, const Array::Pointer & src,
* @param connectivity Filter neigborhood connectivity, "box" or "sphere" [std::string ( = "box" )]
* @return Array::Pointer
*
* @note 'filter', 'edge detection', 'bia-bob-suggestion'
* @note 'filter', 'edge detection'
* @see https://clij.github.io/clij2-docs/reference_laplaceDiamond
*/
auto
Expand Down Expand Up @@ -941,7 +940,6 @@ logarithm_func(const Device::Pointer & device, const Array::Pointer & src, Array
* @param dst Output result image. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'bia-bob-suggestion'
* @see https://clij.github.io/clij2-docs/reference_mask
*/
auto
Expand All @@ -963,7 +961,6 @@ mask_func(const Device::Pointer & device, const Array::Pointer & src, const Arra
* @param label Label value to use. [float ( = 1 )]
* @return Array::Pointer
*
* @note 'bia-bob-suggestion'
* @see https://clij.github.io/clij2-docs/reference_maskLabel
*/
auto
Expand All @@ -985,7 +982,7 @@ mask_label_func(const Device::Pointer & device,
* @param scalar Scalar value used in the comparison. [float ( = 0 )]
* @return Array::Pointer
*
* @note 'filter', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_maximumImageAndScalar
*/
auto
Expand All @@ -1006,7 +1003,7 @@ maximum_image_and_scalar_func(const Device::Pointer & device,
* @param dst Output result image. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'combine', 'in assistant', 'bia-bob-suggestion'
* @note 'combine', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_maximumImages
*/
auto
Expand Down Expand Up @@ -1188,7 +1185,7 @@ mean_sphere_func(const Device::Pointer & device,
* @param connectivity Filter neigborhood connectivity, "box" or "sphere" [std::string ( = "box" )]
* @return Array::Pointer
*
* @note 'filter', 'denoise', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'denoise', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_mean3DSphere
*/
auto
Expand Down Expand Up @@ -1560,7 +1557,7 @@ mode_sphere_func(const Device::Pointer & device,
* @param connectivity Filter neigborhood connectivity, "box" or "sphere" [std::string ( = "box" )]
* @return Array::Pointer
*
* @note 'label processing', 'in assistant', 'bia-bob-suggestion'
* @note 'label processing', 'in assistant'
*/
auto
mode_func(const Device::Pointer & device,
Expand All @@ -1581,7 +1578,7 @@ mode_func(const Device::Pointer & device,
* @param src1 Second input image to process. [const Array::Pointer &]
* @param dst Output result image. [Array::Pointer ( = None )]
* @return Array::Pointer
* @note 'combine', 'bia-bob-suggestion'
* @note 'combine'
*
*/
auto
Expand Down Expand Up @@ -2009,7 +2006,6 @@ range_func(const Device::Pointer & device,
* @param dst Output vector image of intensities. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'bia-bob-suggestion'
*/
auto
read_values_from_positions_func(const Device::Pointer & device,
Expand Down Expand Up @@ -2090,7 +2086,6 @@ replace_intensity_func(const Device::Pointer & device,
* @param dst Output result image. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'bia-bob-suggestion'
* @see https://clij.github.io/clij2-docs/reference_replaceIntensities
* @deprecated This function is deprecated. Consider using replace_values() instead.
*/
Expand Down Expand Up @@ -2707,7 +2702,7 @@ variance_box_func(const Device::Pointer & device,
* @param radius_z Radius size along z axis. [int ( = 1 )]
* @return Array::Pointer
*
* @note 'filter', 'edge detection', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'edge detection', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_varianceSphere
* @deprecated This function is deprecated. Consider using variance() instead.
*/
Expand Down
27 changes: 13 additions & 14 deletions clic/include/tier2.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace cle::tier2
* @param dst The output image where results are written into. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'combine', 'in assistant', 'bia-bob-suggestion'
* @note 'combine', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_absoluteDifference
*/
auto
Expand Down Expand Up @@ -87,7 +87,7 @@ bottom_hat_box_func(const Device::Pointer & device,
* @param radius_z Radius of the background determination region in Z. [float ( = 1 )]
* @return Array::Pointer
*
* @note 'filter', 'background removal', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'background removal', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_bottomHatSphere
* @deprecated This method is deprecated. Consider using bottom_hat() instead.
*/
Expand All @@ -112,7 +112,7 @@ bottom_hat_sphere_func(const Device::Pointer & device,
* @param connectivity Element shape, "box" or "sphere" [std::string ( = "box" )]
* @return Array::Pointer
*
* @note 'filter', 'background removal', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'background removal', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_bottomHatBox
* @see https://clij.github.io/clij2-docs/reference_bottomHatSphere
*/
Expand Down Expand Up @@ -208,7 +208,7 @@ closing_sphere_func(const Device::Pointer & device,
* @param radius_z Radius along the z axis. [int ( = 0 )]
* @param connectivity Element shape, "box" or "sphere" [std::string ( = "box" )]
* @return Array::Pointer
* @note 'filter', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'in assistant'
*/
auto
closing_func(const Device::Pointer & device,
Expand Down Expand Up @@ -288,7 +288,6 @@ concatenate_along_z_func(const Device::Pointer & device,
* @param ignore_background [bool ( = True )]
* @return Array::Pointer
*
* @note 'bia-bob-suggestion'
* @see https://clij.github.io/clij2-docs/reference_countTouchingNeighbors
*/
auto
Expand Down Expand Up @@ -327,7 +326,7 @@ crop_border_func(const Device::Pointer & device, const Array::Pointer & src, Arr
* @param sigma_z Gaussian sigma value along z. [float ( = 2 )]
* @return Array::Pointer
*
* @note 'filter', 'background removal', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'background removal', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_divideByGaussianBackground
*/
auto
Expand Down Expand Up @@ -501,7 +500,7 @@ difference_of_gaussian_func(const Device::Pointer & device,
* @param dst Output result image. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'label processing', 'in assistant', 'bia-bob-suggestion'
* @note 'label processing', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_extendLabelingViaVoronoi
*/
auto
Expand Down Expand Up @@ -537,7 +536,7 @@ invert_func(const Device::Pointer & device, const Array::Pointer & src, Array::P
* @param dst Output result image. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'label', 'in assistant', 'bia-bob-suggestion'
* @note 'label', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_labelSpots
*/
auto
Expand Down Expand Up @@ -648,7 +647,7 @@ opening_box_func(const Device::Pointer & device,
* @param radius_y Radius along the y axis. [float ( = 1 )]
* @param radius_z Radius along the z axis. [float ( = 0 )]
* @return Array::Pointer
* @note 'filter', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'in assistant'
* @deprecated This method is deprecated. Consider using opening() instead.
*/
auto
Expand All @@ -673,7 +672,7 @@ opening_sphere_func(const Device::Pointer & device,
* @param radius_z Radius along the z axis. [float ( = 0 )]
* @param connectivity Element shape, "box" or "sphere" [std::string ( = "box" )]
* @return Array::Pointer
* @note 'filter', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'in assistant'
*
*/
auto
Expand Down Expand Up @@ -764,7 +763,7 @@ square_func(const Device::Pointer & device, const Array::Pointer & src, Array::P
* @param dst Output result image. [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'combine', 'in assistant', 'bia-bob-suggestion'
* @note 'combine', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_squaredDifference
*/
auto
Expand Down Expand Up @@ -813,7 +812,7 @@ standard_deviation_box_func(const Device::Pointer & device,
* @param radius_z Radius along the z axis. [int ( = 1 )]
* @return Array::Pointer
*
* @note 'filter', 'edge detection', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'edge detection', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_standardDeviationSphere
* @deprecated This method is deprecated. Consider using standard_deviation() instead.
*/
Expand All @@ -839,7 +838,7 @@ standard_deviation_sphere_func(const Device::Pointer & device,
* @param connectivity Neigborhood shape, "box" or "sphere" [std::string ( = "box" )]
* @return Array::Pointer
*
* @note 'filter', 'edge detection', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'edge detection', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_standardDeviationBox
* @see https://clij.github.io/clij2-docs/reference_standardDeviationSphere
*/
Expand Down Expand Up @@ -1013,7 +1012,7 @@ top_hat_sphere_func(const Device::Pointer & device,
* @param connectivity Element shape, "box" or "sphere" [std::string ( = "box" )]
* @return Array::Pointer
*
* @note 'filter', 'background removal', 'in assistant', 'bia-bob-suggestion'
* @note 'filter', 'background removal', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_topHatBox
* @see https://clij.github.io/clij2-docs/reference_topHatSphere
*/
Expand Down
4 changes: 1 addition & 3 deletions clic/include/tier3.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ remove_labels_on_edges_func(const Device::Pointer & device,
* @param exclude_z Exclude labels along min and max z [bool ( = True )]
* @return Array::Pointer
*
* @note 'label processing', 'in assistant', 'bia-bob-suggestion'
* @note 'label processing', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_excludeLabelsOnEdges
*/
auto
Expand Down Expand Up @@ -205,7 +205,6 @@ generate_binary_overlap_matrix_func(const Device::Pointer & device,
* @param dst [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'bia-bob-suggestion'
* @see https://clij.github.io/clij2-docs/reference_generateTouchMatrix
*/
auto
Expand Down Expand Up @@ -286,7 +285,6 @@ jaccard_index_func(const Device::Pointer & device, const Array::Pointer & src0,
* @param dst [Array::Pointer ( = None )]
* @return Array::Pointer
*
* @note 'bia-bob-suggestion'
* @see https://clij.github.io/clij2-docs/reference_labelledSpotsToPointList
*/
auto
Expand Down
1 change: 0 additions & 1 deletion clic/include/tier4.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,6 @@ label_pixel_count_map_func(const Device::Pointer & device,
* @param withBG Determines if the background label should be included. [bool ( = False )]
* @return Array::Pointer
*
* @note 'bia-bob-suggestion'
* @see https://clij.github.io/clij2-docs/reference_centroidsOfLabels
*/
auto
Expand Down
2 changes: 1 addition & 1 deletion clic/include/tier5.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ combine_labels_func(const Device::Pointer & device,
* @param connectivity Defines pixel neighborhood relationship, "box" or "sphere". [const std::string & ( = 'box' )]
* @return Array::Pointer
*
* @note 'label', 'in assistant', 'bia-bob-suggestion'
* @note 'label', 'in assistant'
* @see https://clij.github.io/clij2-docs/reference_connectedComponentsLabelingBox
* @deprecated This method is deprecated. Consider using connected_component_labeling() instead.
*/
Expand Down
Loading
Loading