pyclEsperanto

📘 Documentation

  • Installation
    • From Package Manager (Recommended)
    • From Source
    • Troubleshooting
  • Usage
    • Memory transfer
      • Create
      • Push
      • Pull
      • Free memory
    • Apply operations on images
    • Pipeline of operations
  • Frequently Asked Questions
  • API Documentation
    • Core functions
      • default_initialisation()
      • get_device()
      • info()
      • list_available_backends()
      • list_available_devices()
      • select_backend()
      • select_device()
      • wait_for_kernel_to_finish()
    • Memory operations
      • create()
      • create_like()
      • pull()
      • push()
    • Array class
      • T()
      • empty()
      • empty_like()
      • from_array()
      • get()
      • is_image()
      • reshape()
      • set()
      • to_device()
      • zeros()
      • zeros_like()
    • Functionalities
      • execute()
      • imshow()
      • native_execute()
      • operation()
      • operations()
      • search_operation_names()
    • Filters
      • absolute()
      • add_image_and_scalar()
      • add_images_weighted()
      • binary_and()
      • binary_dilate()
      • binary_edge_detection()
      • binary_erode()
      • binary_infsup()
      • binary_not()
      • binary_or()
      • binary_subtract()
      • binary_supinf()
      • binary_xor()
      • block_enumerate()
      • circular_shift()
      • convolve()
      • copy()
      • copy_horizontal_slice()
      • copy_slice()
      • copy_vertical_slice()
      • crop()
      • cubic_root()
      • detect_label_edges()
      • dilate_box()
      • dilate_sphere()
      • dilation()
      • divide_images()
      • divide_scalar_by_image()
      • equal()
      • equal_constant()
      • erode_box()
      • erode_sphere()
      • erosion()
      • exponential()
      • flip()
      • gaussian_blur()
      • gaussian_derivative()
      • generate_distance_matrix()
      • gradient_x()
      • gradient_y()
      • gradient_z()
      • grayscale_dilate()
      • grayscale_erode()
      • greater()
      • greater_constant()
      • greater_or_equal()
      • greater_or_equal_constant()
      • hessian_eigenvalues()
      • laplace()
      • laplace_box()
      • laplace_diamond()
      • local_cross_correlation()
      • logarithm()
      • mask()
      • mask_label()
      • maximum_box()
      • maximum_filter()
      • maximum_image_and_scalar()
      • maximum_images()
      • maximum_sphere()
      • maximum_x_projection()
      • maximum_y_projection()
      • maximum_z_projection()
      • mean_box()
      • mean_filter()
      • mean_sphere()
      • mean_x_projection()
      • mean_y_projection()
      • mean_z_projection()
      • median()
      • median_box()
      • median_sphere()
      • minimum_box()
      • minimum_filter()
      • minimum_image_and_scalar()
      • minimum_images()
      • minimum_sphere()
      • minimum_x_projection()
      • minimum_y_projection()
      • minimum_z_projection()
      • mode()
      • mode_box()
      • mode_sphere()
      • modulo_images()
      • multiply_image_and_position()
      • multiply_image_and_scalar()
      • multiply_images()
      • multiply_matrix()
      • nan_to_num()
      • nonzero_maximum()
      • nonzero_maximum_box()
      • nonzero_maximum_diamond()
      • nonzero_minimum()
      • nonzero_minimum_box()
      • nonzero_minimum_diamond()
      • not_equal()
      • not_equal_constant()
      • onlyzero_overwrite_maximum()
      • onlyzero_overwrite_maximum_box()
      • onlyzero_overwrite_maximum_diamond()
      • pad()
      • paste()
      • power()
      • power_images()
      • range()
      • read_values_from_positions()
      • reciprocal()
      • replace_intensities()
      • replace_intensity()
      • replace_value()
      • replace_values()
      • set()
      • set_column()
      • set_image_borders()
      • set_nonzero_pixels_to_pixelindex()
      • set_plane()
      • set_ramp_x()
      • set_ramp_y()
      • set_ramp_z()
      • set_row()
      • set_where_x_equals_y()
      • set_where_x_greater_than_y()
      • set_where_x_smaller_than_y()
      • sign()
      • smaller()
      • smaller_constant()
      • smaller_or_equal()
      • smaller_or_equal_constant()
      • sobel()
      • square_root()
      • std_z_projection()
      • subtract_image_from_scalar()
      • sum_reduction_x()
      • sum_x_projection()
      • sum_y_projection()
      • sum_z_projection()
      • transpose_xy()
      • transpose_xz()
      • transpose_yz()
      • undefined_to_zero()
      • unpad()
      • variance_box()
      • variance_filter()
      • variance_sphere()
      • write_values_to_positions()
      • x_position_of_maximum_x_projection()
      • x_position_of_minimum_x_projection()
      • y_position_of_maximum_y_projection()
      • y_position_of_minimum_y_projection()
      • z_position_of_maximum_z_projection()
      • z_position_of_minimum_z_projection()
      • z_position_projection()
      • absolute_difference()
      • add_images()
      • binary_closing()
      • binary_opening()
      • bottom_hat()
      • bottom_hat_box()
      • bottom_hat_sphere()
      • clip()
      • closing()
      • closing_box()
      • closing_sphere()
      • concatenate_along_x()
      • concatenate_along_y()
      • concatenate_along_z()
      • count_touching_neighbors()
      • crop_border()
      • degrees_to_radians()
      • detect_maxima()
      • detect_maxima_box()
      • detect_minima()
      • detect_minima_box()
      • difference_of_gaussian()
      • divide_by_gaussian_background()
      • extend_labeling_via_voronoi()
      • extended_depth_of_focus_sobel_projection()
      • extended_depth_of_focus_variance_projection()
      • grayscale_closing()
      • grayscale_opening()
      • hessian_gaussian_eigenvalues()
      • invert()
      • label_spots()
      • large_hessian_eigenvalue()
      • maximum_of_all_pixels()
      • minimum_of_all_pixels()
      • minimum_of_masked_pixels()
      • opening()
      • opening_box()
      • opening_sphere()
      • radians_to_degrees()
      • reduce_labels_to_label_edges()
      • reduce_stack()
      • small_hessian_eigenvalue()
      • square()
      • squared_difference()
      • standard_deviation()
      • standard_deviation_box()
      • standard_deviation_sphere()
      • sub_stack()
      • subtract_gaussian_background()
      • subtract_images()
      • sum_of_all_pixels()
      • top_hat()
      • top_hat_box()
      • top_hat_sphere()
      • bounding_box()
      • center_of_mass()
      • clahe()
      • exclude_labels()
      • exclude_labels_on_edges()
      • flag_existing_labels()
      • gamma_correction()
      • generate_binary_overlap_matrix()
      • generate_touch_matrix()
      • histogram()
      • jaccard_index()
      • labelled_spots_to_pointlist()
      • maximum_position()
      • mean_of_all_pixels()
      • minimum_position()
      • morphological_chan_vese()
      • remove_labels()
      • remove_labels_on_edges()
      • sato_filter()
      • statistics_of_background_and_labelled_pixels()
      • statistics_of_labelled_pixels()
      • centroids_of_labels()
      • exclude_labels_with_map_values_out_of_range()
      • exclude_labels_with_map_values_within_range()
      • extension_ratio_map()
      • label_bounding_box()
      • label_pixel_count_map()
      • maximum_extension_map()
      • maximum_intensity_map()
      • mean_extension_map()
      • mean_intensity_map()
      • mean_squared_error()
      • minimum_intensity_map()
      • percentile()
      • pixel_count_map()
      • relabel_sequential()
      • remove_labels_with_map_values_out_of_range()
      • remove_labels_with_map_values_within_range()
      • spots_to_pointlist()
      • standard_deviation_intensity_map()
      • threshold_otsu()
      • array_equal()
      • combine_labels()
      • connected_component_labeling()
      • connected_components_labeling()
      • exclude_labels_outside_size_range()
      • filter_label_by_size()
      • merge_touching_labels()
      • reduce_labels_to_centroids()
      • dilate_labels()
      • erode_labels()
      • exclude_large_labels()
      • exclude_small_labels()
      • gauss_otsu_labeling()
      • masked_voronoi_labeling()
      • remove_large_labels()
      • remove_small_labels()
      • voronoi_labeling()
      • affine_transform()
      • closing_labels()
      • erode_connected_labels()
      • eroded_otsu_labeling()
      • opening_labels()
      • rigid_transform()
      • rotate()
      • scale()
      • translate()
      • voronoi_otsu_labeling()
  • Index

🚀 Prototype Migration

  • Prototype migration
    • Library import
    • imread & imwrite
    • erode_labels
    • Filter connectivity management
    • Affine transform
    • Morphological operations
    • Histogram
  • API pyClesperanto V.S. Prototype
    • Core functions
    • Tiers functions

🛠️ Developper Guide

  • Contributing
    • Environment setup
    • Contributing to the python bindings
    • New OpenCL operations (WIP)
    • Versioning
    • Code quality and formating
pyclEsperanto
  • Search


© Copyright 2024, Stephane Rigaud.

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