From 1ac87c0258cc92b578924fe82660ab0e246dcc8d Mon Sep 17 00:00:00 2001 From: Robert Haase Date: Thu, 17 Oct 2024 10:18:46 +0200 Subject: [PATCH] rename parameters in centroids_of_labels and exclude_labels_with_values... --- clic/include/tier4.hpp | 20 ++++++++++---------- clic/src/tier4/centroids_of_labels.cpp | 4 ++-- clic/src/tier4/filter_label_by_values.cpp | 12 ++++++------ 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/clic/include/tier4.hpp b/clic/include/tier4.hpp index 99312747..ad6992da 100644 --- a/clic/include/tier4.hpp +++ b/clic/include/tier4.hpp @@ -146,13 +146,13 @@ label_pixel_count_map_func(const Device::Pointer & device, const Array::Pointer * @param device Device to perform the operation on. [const Device::Pointer &] * @param src Label image where the centroids will be determined from. [const Array::Pointer &] * @param dst Output image where the centroids will be written to. [Array::Pointer ( = None )] - * @param withBG Determines if the background label should be included. [bool ( = False )] + * @param include_background Determines if the background label should be included. [bool ( = False )] * @return Array::Pointer * * @see https://clij.github.io/clij2-docs/reference_centroidsOfLabels */ auto -centroids_of_labels_func(const Device::Pointer & device, const Array::Pointer & src, Array::Pointer dst, bool withBG) +centroids_of_labels_func(const Device::Pointer & device, const Array::Pointer & src, Array::Pointer dst, bool include_background) -> Array::Pointer; @@ -213,8 +213,8 @@ remove_labels_with_map_values_within_range_func(const Device::Pointer & device, * @param src Input image where labels will be filtered. [const Array::Pointer &] * @param values Vector of values associated with the labels. [const Array::Pointer &] * @param dst Output image where labels will be written to. [Array::Pointer ( = None )] - * @param min_value_range Minimum value to keep. [float ( = 0 )] - * @param max_value_range Maximum value to keep. [float ( = 100 )] + * @param minimum_value_range Minimum value to keep. [float ( = 0 )] + * @param maximum_value_range Maximum value to keep. [float ( = 100 )] * @return Array::Pointer * * @note 'label processing', 'combine' @@ -226,8 +226,8 @@ exclude_labels_with_map_values_out_of_range_func(const Device::Pointer & device, const Array::Pointer & src, const Array::Pointer & values, Array::Pointer dst, - float min_value_range, - float max_value_range) -> Array::Pointer; + float minimum_value_range, + float maximum_value_range) -> Array::Pointer; /** * @name exclude_labels_with_map_values_within_range @@ -238,8 +238,8 @@ exclude_labels_with_map_values_out_of_range_func(const Device::Pointer & device, * @param src Input image where labels will be filtered. [const Array::Pointer &] * @param values Vector of values associated with the labels. [const Array::Pointer &] * @param dst Output image where labels will be written to. [Array::Pointer ( = None )] - * @param min_value_range Minimum value to keep. [float ( = 0 )] - * @param max_value_range Maximum value to keep. [float ( = 100 )] + * @param minimum_value_range Minimum value to keep. [float ( = 0 )] + * @param maximum_value_range Maximum value to keep. [float ( = 100 )] * @return Array::Pointer * * @note 'label processing', 'combine' @@ -251,8 +251,8 @@ exclude_labels_with_map_values_within_range_func(const Device::Pointer & device, const Array::Pointer & src, const Array::Pointer & values, Array::Pointer dst, - float min_value_range, - float max_value_range) -> Array::Pointer; + float minimum_value_range, + float maximum_value_range) -> Array::Pointer; /** * @name extension_ratio_map diff --git a/clic/src/tier4/centroids_of_labels.cpp b/clic/src/tier4/centroids_of_labels.cpp index 92532d40..471bc9e3 100644 --- a/clic/src/tier4/centroids_of_labels.cpp +++ b/clic/src/tier4/centroids_of_labels.cpp @@ -12,11 +12,11 @@ namespace cle::tier4 { auto -centroids_of_labels_func(const Device::Pointer & device, const Array::Pointer & src, Array::Pointer dst, bool withBG) +centroids_of_labels_func(const Device::Pointer & device, const Array::Pointer & src, Array::Pointer dst, bool include_background) -> Array::Pointer { cle::StatisticsMap props; - if (withBG) + if (include_background) { props = tier3::statistics_of_background_and_labelled_pixels_func(device, src, nullptr); } diff --git a/clic/src/tier4/filter_label_by_values.cpp b/clic/src/tier4/filter_label_by_values.cpp index 830d3519..b4d657f7 100644 --- a/clic/src/tier4/filter_label_by_values.cpp +++ b/clic/src/tier4/filter_label_by_values.cpp @@ -50,10 +50,10 @@ exclude_labels_with_map_values_out_of_range_func(const Device::Pointer & device, const Array::Pointer & src, const Array::Pointer & values, Array::Pointer dst, - float min_value_range, - float max_value_range) -> Array::Pointer + float minimum_value_range, + float maximum_value_range) -> Array::Pointer { - return remove_labels_with_map_values_out_of_range_func(device, src, values, dst, min_value_range, max_value_range); + return remove_labels_with_map_values_out_of_range_func(device, src, values, dst, minimum_value_range, maximum_value_range); } @@ -62,10 +62,10 @@ exclude_labels_with_map_values_within_range_func(const Device::Pointer & device, const Array::Pointer & src, const Array::Pointer & values, Array::Pointer dst, - float min_value_range, - float max_value_range) -> Array::Pointer + float minimum_value_range, + float maximum_value_range) -> Array::Pointer { - return remove_labels_with_map_values_within_range_func(device, src, values, dst, min_value_range, max_value_range); + return remove_labels_with_map_values_within_range_func(device, src, values, dst, minimum_value_range, maximum_value_range); } } // namespace cle::tier4