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

© Copyright 2020-2024, Stephane Rigaud.

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