TODO: Tier 1 kernel implementations

[StRigaud]

List of kernel to be implemented in CLIc, based from the pyclesperanto-prototype list.

If the link return a 404 error, it means that the kernel is not yet available for the clespernanto-kernel branch. See this issue for more info.

Please create a branch or a PR draft for the development of new kernel so that we can see those which are under development.

Kernels with a :question: next to them, means we do not know yet how relevant it is to keep them. Kernels with a :exclamation: next to them, means we need to update their .cl code before implementation.

Tiers 1

• [X] absolute
• [X] add_image_and_scalar
• [X] add_images_weighted
• [ ] average_distance_of_n_far_off_distances :question:
• [ ] average_distance_of_n_nearest_distances :question:
• [ ] average_distance_of_n_shortest_distances :question:
• [ ] average_distance_of_touching_neighbors :question:
• [X] binary_and
• [x] binary_edge_detection
• [X] binary_not
• [X] binary_or
• [X] binary_subtract
• [X] binary_xor
• [x] convolve
• [X] copy
• [x] copy_horizontal_slice
• [x] copy_slice
• [x] copy_vertical_slice
• [x] count_touching_neighbors
• [x] crop
• [x] cubic_root
• [x] detect_label_edges
• [X] detect_maxima
• [x] detect_minima
• [x] dilate_box
• [ ] dilate_box_slice_by_slice
• [X] dilate_sphere
• [ ] dilate_sphere_slice_by_slice :question:
• [X] divide_images
• [x] #158
• [ ] downsample_slice_by_slice_half_median :question:
• [ ] draw_box :question:
• [ ] draw_line :question:
• [ ] draw_sphere :question:
• [X] equal
• [x] equal_constant
• [x] erode_box
• [ ] erode_box_slice_by_slice :question:
• [X] erode_sphere
• [ ] erode_sphere_slice_by_slice
• [X] execute_separable_kernel
• [x] exponential
• [x] flip
• [X] gaussian_blur
• [ ] generate_angle_matrix :question:
• [x] generate_binary_overlap_matrix
• [x] generate_distance_matrix
• [x] generate_touch_matrix
• [X] gradient_x
• [X] gradient_y
• [X] gradient_z
• [X] greater
• [X] greater_constant
• [X] greater_or_equal
• [X] greater_or_equal_constant
• [x] hessian_eigenvalues
• [x] laplace_box
• [x] laplace_diamond
• [x] logarithm
• [X] mask
• [x] mask_label
• [X] maximum_box
• [ ] maximum_distance_of_n_shortest_distances :question:
• [ ] maximum_distance_of_touching_neighbors :question:
• [x] maximum_image_and_scalar
• [x] maximum_images
• [x] maximum_sphere
• [X] maximum_x_projection
• [X] maximum_y_projection
• [X] maximum_z_projection
• [X] mean_box
• [X] mean_sphere
• [X] mean_x_projection
• [X] mean_y_projection
• [X] mean_z_projection
• [x] median_box
• [x] median_sphere
• [X] minimum_box
• [ ] minimum_distance_of_touching_neighbors :question:
• [x] minimum_image_and_scalar
• [x] minimum_images
• [x] minimum_sphere
• [X] minimum_x_projection
• [X] minimum_y_projection
• [X] minimum_z_projection
• [x] modulo_images
• [x] multiply_image_and_coordinate
• [x] multiply_image_and_scalar
• [X] multiply_images
• [x] multiply_matrix
• [ ] n_closest_points :question:
• [x] nan_to_num
• [x] nonzero_maximum_box
• [x] nonzero_maximum_diamond
• [X] nonzero_minimum_box
• [x] nonzero_minimum_diamond
• [X] not_equal
• [X] not_equal_constant
• [X] onlyzero_overwrite_maximum_box
• [X] onlyzero_overwrite_maximum_diamond
• [x] paste
• [ ] point_index_list_to_mesh :question:
• [ ] point_index_list_to_touch_matrix :question:
• [x] power
• [x] power_images
• [x] range
• [ ] read_intensities_from_map :question:
• [x] read_intensities_from_positions
• [x] reciprocal
• [X] replace_intensities
• [X] replace_intensity
• [ ] resample :exclamation:
• [X] set
• [X] set_column
• [x] set_image_borders
• [X] set_non_zero_pixels_to_pixel_index
• [x] set_plane
• [x] set_ramp_x
• [x] set_ramp_y
• [x] set_ramp_z
• [x] set_row
• [x] set_where_x_equals_y
• [x] set_where_x_greater_than_y
• [x] set_where_x_smaller_than_y
• [x] sign
• [X] smaller
• [X] smaller_constant
• [X] smaller_or_equal
• [X] smaller_or_equal_constant
• [X] sobel
• [x] square_root
• [x] standard_deviation_z_projection
• [X] subtract_image_from_scalar
• [X] sum_x_projection
• [X] sum_y_projection
• [X] sum_z_projection
• [x] touch_matrix_to_mesh
• [x] transpose_xy
• [x] transpose_xz
• [x] transpose_yz
• [x] undefined_to_zero
• [x] variance_box
• [x] variance_sphere

[StRigaud]

For good example for Tier 1 contributions, see the following PRs:

• 118

• 117

• 113

I will try to build up a documentation from these later on.

[StRigaud]

I have started a documentation on how to create new kernels to CLIc

• doc: add_new_kernel

[StRigaud]

Update of T1 implemented kernel list

WARNING: some kernel have not been tested and/or are missing their test function

[StRigaud]

@haesleinhuepf can you have a look a the kernel not yet implemented in the list and tell me which one we still should implement and those we should not because out of scope?

Thanks :smiley:

[haesleinhuepf]

I think those would be useful:

• [ ] count_touching_neighbors
• [ ] generate_binary_overlap_matrix
• [ ] generate_distance_matrix
• [ ] generate_touch_matrix
• [ ] standard_deviation_z_projection

[StRigaud]

All 5 filters have been pushed (with tests), as well as the hessian eigenvalues filter.

[StRigaud]

closing for now