CLIc

🛠️ Developer Documentation

  • Requirements & Compilation
    • Requirements
    • Compilation
      • Using terminal CLI
      • Using CMake GUI
      • Using VSCode
      • Configuration options
  • Running tests
  • How to use the library
    • Initialization
    • Get a device
    • Create, Write, and Read an Array
    • Execute an Operation
  • Adding new functions
    • Create a new function
      • Function definition
      • Function instantiation
      • Call lower-tier functions
    • Call an OpenCL kernel file
    • Add Function Tests
  • Contributing
    • Versioning

📘 API Doxygen

  • Backends
    • Backend Manager
      • cle::BackendManager
        • setBackend()
        • getBackend()
        • ~BackendManager()
        • BackendManager()
        • operator=()
        • getInstance()
        • getBackendsList()
        • cudaEnabled()
        • openCLEnabled()
        • operator<<
    • Backend Class
      • cle::Backend
        • Backend()
        • Backend()
        • Backend()
        • ~Backend()
        • operator=()
        • operator=()
        • getType()
        • getDevicesList()
        • getDevices()
        • getDevice()
        • getDeviceFromIndex()
        • getPreamble()
        • allocateMemory()
        • freeMemory()
        • writeMemory()
        • readMemory()
        • copyMemoryBufferToBuffer()
        • copyMemoryImageToBuffer()
        • copyMemoryBufferToImage()
        • copyMemoryImageToImage()
        • setMemory()
        • buildKernel()
        • executeKernel()
        • operator<<
        • operator<<
      • OpenCL Backend
        • cle::OpenCLBackend
          • getDevices()
          • getDevice()
          • getDeviceFromIndex()
          • getDevicesList()
          • getType()
          • allocateMemory()
          • freeMemory()
          • writeMemory()
          • readMemory()
          • copyMemoryBufferToBuffer()
          • copyMemoryImageToBuffer()
          • copyMemoryBufferToImage()
          • copyMemoryImageToImage()
          • setMemory()
          • buildKernel()
          • executeKernel()
          • getPreamble()
      • CUDA Backend
        • cle::CUDABackend
          • getDevices()
          • getDevice()
          • getDeviceFromIndex()
          • getDevicesList()
          • getType()
          • allocateMemory()
          • freeMemory()
          • writeMemory()
          • readMemory()
          • copyMemoryBufferToBuffer()
          • copyMemoryImageToBuffer()
          • copyMemoryBufferToImage()
          • copyMemoryImageToImage()
          • setMemory()
          • buildKernel()
          • executeKernel()
          • getPreamble()
  • Device Class
    • cle::Device
      • Type
        • CUDA
        • OPENCL
      • Device()
      • ~Device()
      • initialize()
      • finalize()
      • finish()
      • setWaitToFinish()
      • isInitialized()
      • getName()
      • getInfo()
      • getInfoExtended()
      • getType()
      • getDeviceType()
      • getDeviceIndex()
      • getPlatform()
      • supportImage()
      • getNbDevicesFromContext()
      • operator<<
      • operator<<
  • Array Class
    • cle::Array
      • allocate()
      • writeFrom()
      • writeFrom()
      • writeFrom()
      • readTo()
      • readTo()
      • readTo()
      • copyTo()
      • copyTo()
      • fill()
      • size()
      • width()
      • height()
      • depth()
      • itemSize()
      • dtype()
      • mtype()
      • device()
      • dim()
      • dimension()
      • initialized()
      • get()
      • c_get()
      • ~Array()
      • Array()
      • New()
      • create()
      • create()
      • create()
      • check_ptr()
      • operator<<
      • print
  • Operation tier list
    • tier1
      • cle::tier1
        • absolute_func()
        • add_images_weighted_func()
        • add_image_and_scalar_func()
        • binary_and_func()
        • binary_edge_detection_func()
        • binary_not_func()
        • binary_or_func()
        • binary_subtract_func()
        • binary_xor_func()
        • binary_supinf_func()
        • binary_infsup_func()
        • block_enumerate_func()
        • convolve_func()
        • copy_func()
        • copy_slice_func()
        • copy_horizontal_slice_func()
        • copy_vertical_slice_func()
        • crop_func()
        • cubic_root_func()
        • detect_label_edges_func()
        • dilation_func()
        • dilate_box_func()
        • dilate_sphere_func()
        • binary_dilate_func()
        • divide_images_func()
        • divide_scalar_by_image_func()
        • equal_func()
        • equal_constant_func()
        • erosion_func()
        • erode_box_func()
        • erode_sphere_func()
        • binary_erode_func()
        • exponential_func()
        • flip_func()
        • gaussian_blur_func()
        • generate_distance_matrix_func()
        • gradient_x_func()
        • gradient_y_func()
        • gradient_z_func()
        • greater_func()
        • greater_constant_func()
        • greater_or_equal_func()
        • greater_or_equal_constant_func()
        • hessian_eigenvalues_func()
        • laplace_box_func()
        • laplace_diamond_func()
        • laplace_func()
        • local_cross_correlation_func()
        • logarithm_func()
        • mask_func()
        • mask_label_func()
        • maximum_image_and_scalar_func()
        • maximum_images_func()
        • maximum_box_func()
        • maximum_filter_func()
        • grayscale_dilate_func()
        • maximum_x_projection_func()
        • maximum_y_projection_func()
        • maximum_z_projection_func()
        • mean_box_func()
        • mean_sphere_func()
        • mean_filter_func()
        • mean_x_projection_func()
        • mean_y_projection_func()
        • mean_z_projection_func()
        • median_box_func()
        • median_sphere_func()
        • median_func()
        • minimum_box_func()
        • minimum_filter_func()
        • grayscale_erode_func()
        • minimum_image_and_scalar_func()
        • minimum_images_func()
        • minimum_x_projection_func()
        • minimum_y_projection_func()
        • minimum_z_projection_func()
        • minimum_of_masked_pixels_reduction_func()
        • mode_box_func()
        • mode_sphere_func()
        • mode_func()
        • modulo_images_func()
        • multiply_image_and_position_func()
        • multiply_image_and_scalar_func()
        • multiply_images_func()
        • nan_to_num_func()
        • nonzero_maximum_box_func()
        • nonzero_maximum_diamond_func()
        • nonzero_maximum_func()
        • nonzero_minimum_box_func()
        • nonzero_minimum_diamond_func()
        • nonzero_minimum_func()
        • not_equal_func()
        • not_equal_constant_func()
        • paste_func()
        • onlyzero_overwrite_maximum_box_func()
        • onlyzero_overwrite_maximum_diamond_func()
        • onlyzero_overwrite_maximum_func()
        • power_func()
        • power_images_func()
        • range_func()
        • read_values_from_positions_func()
        • replace_values_func()
        • replace_value_func()
        • replace_intensity_func()
        • replace_intensities_func()
        • maximum_sphere_func()
        • minimum_sphere_func()
        • multiply_matrix_func()
        • reciprocal_func()
        • set_func()
        • set_column_func()
        • set_image_borders_func()
        • set_plane_func()
        • set_ramp_x_func()
        • set_ramp_y_func()
        • set_ramp_z_func()
        • set_row_func()
        • set_nonzero_pixels_to_pixelindex_func()
        • set_where_x_equals_y_func()
        • set_where_x_greater_than_y_func()
        • set_where_x_smaller_than_y_func()
        • sign_func()
        • smaller_func()
        • smaller_constant_func()
        • smaller_or_equal_func()
        • smaller_or_equal_constant_func()
        • sobel_func()
        • square_root_func()
        • std_z_projection_func()
        • subtract_image_from_scalar_func()
        • sum_reduction_x_func()
        • sum_x_projection_func()
        • sum_y_projection_func()
        • sum_z_projection_func()
        • transpose_xy_func()
        • transpose_xz_func()
        • transpose_yz_func()
        • undefined_to_zero_func()
        • variance_box_func()
        • variance_sphere_func()
        • variance_filter_func()
        • write_values_to_positions_func()
        • x_position_of_maximum_x_projection_func()
        • x_position_of_minimum_x_projection_func()
        • y_position_of_maximum_y_projection_func()
        • y_position_of_minimum_y_projection_func()
        • z_position_of_maximum_z_projection_func()
        • z_position_of_minimum_z_projection_func()
    • tier2
      • cle::tier2
        • absolute_difference_func()
        • add_images_func()
        • bottom_hat_box_func()
        • bottom_hat_sphere_func()
        • bottom_hat_func()
        • clip_func()
        • closing_box_func()
        • closing_sphere_func()
        • grayscale_closing_func()
        • closing_func()
        • binary_closing_func()
        • concatenate_along_x_func()
        • concatenate_along_y_func()
        • concatenate_along_z_func()
        • count_touching_neighbors_func()
        • crop_border_func()
        • divide_by_gaussian_background_func()
        • degrees_to_radians_func()
        • detect_maxima_box_func()
        • detect_maxima_func()
        • detect_minima_box_func()
        • detect_minima_func()
        • difference_of_gaussian_func()
        • extend_labeling_via_voronoi_func()
        • invert_func()
        • label_spots_func()
        • large_hessian_eigenvalue_func()
        • maximum_of_all_pixels_func()
        • minimum_of_all_pixels_func()
        • minimum_of_masked_pixels_func()
        • opening_box_func()
        • opening_sphere_func()
        • grayscale_opening_func()
        • opening_func()
        • binary_opening_func()
        • radians_to_degrees_func()
        • reduce_labels_to_label_edges_func()
        • small_hessian_eigenvalue_func()
        • square_func()
        • squared_difference_func()
        • standard_deviation_box_func()
        • standard_deviation_sphere_func()
        • standard_deviation_func()
        • subtract_gaussian_background_func()
        • subtract_images_func()
        • sub_stack_func()
        • reduce_stack_func()
        • sum_of_all_pixels_func()
        • top_hat_box_func()
        • top_hat_sphere_func()
        • top_hat_func()
    • tier3
      • cle::tier3
        • bounding_box_func()
        • center_of_mass_func()
        • remove_labels_func()
        • exclude_labels_func()
        • remove_labels_on_edges_func()
        • exclude_labels_on_edges_func()
        • flag_existing_labels_func()
        • gamma_correction_func()
        • generate_binary_overlap_matrix_func()
        • generate_touch_matrix_func()
        • histogram_func()
        • jaccard_index_func()
        • labelled_spots_to_pointlist_func()
        • maximum_position_func()
        • mean_of_all_pixels_func()
        • minimum_position_func()
        • morphological_chan_vese_func()
        • statistics_of_labelled_pixels_func()
        • statistics_of_background_and_labelled_pixels_func()
    • tier4
      • cle::tier4
        • label_bounding_box_func()
        • mean_squared_error_func()
        • spots_to_pointlist_func()
        • relabel_sequential_func()
        • threshold_otsu_func()
        • mean_intensity_map_func()
        • pixel_count_map_func()
        • label_pixel_count_map_func()
        • centroids_of_labels_func()
        • remove_labels_with_map_values_out_of_range_func()
        • remove_labels_with_map_values_within_range_func()
        • exclude_labels_with_map_values_out_of_range_func()
        • exclude_labels_with_map_values_within_range_func()
        • extension_ratio_map_func()
    • tier5
      • cle::tier5
        • array_equal_func()
        • combine_labels_func()
        • connected_components_labeling_func()
        • connected_component_labeling_func()
        • reduce_labels_to_centroids_func()
        • filter_label_by_size_func()
        • exclude_labels_outside_size_range_func()
    • tier6
      • cle::tier6
        • dilate_labels_func()
        • erode_labels_func()
        • gauss_otsu_labeling_func()
        • masked_voronoi_labeling_func()
        • voronoi_labeling_func()
        • remove_small_labels_func()
        • exclude_small_labels_func()
        • remove_large_labels_func()
        • exclude_large_labels_func()
    • tier7
      • cle::tier7
        • affine_transform_func()
        • eroded_otsu_labeling_func()
        • rigid_transform_func()
        • rotate_func()
        • scale_func()
        • translate_func()
        • closing_labels_func()
        • erode_connected_labels_func()
        • opening_labels_func()
        • voronoi_otsu_labeling_func()
    • tier8
      • cle::tier8
        • smooth_labels_func()
        • smooth_connected_labels_func()
  • Index
CLIc
  • Search

© Copyright 2020-2025, Stephane Rigaud.

Built with Sphinx using a theme provided by Read the Docs.
Version: 0.16.0
Versions
master
0.16.0
0.15.1
Languages
en