Welcome to cuCIM’s documentation!

cuCIM (Compute Unified Device Architecture Clara IMage) is an open-source, accelerated computer vision and image processing software library for multidimensional images used in biomedical, geospatial, material and life science, and remote sensing use cases.

cuCIM provides GPU-accelearted I/O, computer vision and image processing primitives for N-Dimensional images including:

• color conversion

• exposure

• feature extraction

• filters

• measure

• metrics

• morphology

• registration

• restoration

• segmentation

• transforms

cuCIM supports the following formats:

• Aperio ScanScope Virtual Slide (SVS)

• Philips TIFF

• Generic Tiled, Multi-resolution RGB TIFF files with the following compression schemes:

  • No Compression

  • JPEG

  • JPEG2000

  • Lempel-Ziv-Welch (LZW)

  • Deflate

Our API mirrors scikit-image for image manipulation and OpenSlide for image loading.

cuCIM is interoperable with the following workflows:

• Albumentations

• cuPY

• Data Loading Library (DALI)

• JFX

• MONAI

• Numba

• NumPy

• PyTorch

• Tensorflow

• Triton

cuCIM is fully open sourced under the Apache-2.0 license, and the Clara and RAPIDS teams welcomes new and seasoned contributors, users and hobbyists! You may download cuCIM via Anaconda Conda or PyPI Thank you for your wonderful support! Below, we provide some resources to help get you started.

Blogs

• Accelerating Scikit-Image API with cuCIM: n-Dimensional Image Processing and IO on GPUs

• Accelerating Digital Pathology Pipelines with NVIDIA Clara™ Deploy

Webinars

• cuCIM: a GPU Image IO and Processing Library

Contents

• cuCIM API Reference
  • Clara Submodules
    • CuImage
      • CuImage.associated_image()
      • CuImage.associated_images
      • CuImage.cache()
      • CuImage.channel_names
      • CuImage.close()
      • CuImage.coord_sys
      • CuImage.device
      • CuImage.dims
      • CuImage.direction
      • CuImage.dtype
      • CuImage.is_loaded
      • CuImage.is_trace_enabled
      • CuImage.metadata
      • CuImage.ndim
      • CuImage.origin
      • CuImage.path
      • CuImage.profiler()
      • CuImage.raw_metadata
      • CuImage.read_region()
      • CuImage.resolutions
      • CuImage.save()
      • CuImage.shape
      • CuImage.size()
      • CuImage.spacing()
      • CuImage.spacing_units()
      • CuImage.typestr
    • DLDataType
      • DLDataType.bits
      • DLDataType.code
      • DLDataType.lanes
    • DLDataTypeCode
      • DLDataTypeCode.DLBfloat
      • DLDataTypeCode.DLFloat
      • DLDataTypeCode.DLInt
      • DLDataTypeCode.DLUInt
      • DLDataTypeCode.name
      • DLDataTypeCode.value
    • cache
      • CacheType
      • ImageCache
      • preferred_memory_capacity()
    • filesystem
      • CuFileDriver
      • close()
      • discard_page_cache()
      • open()
      • pread()
      • pwrite()
    • io
      • Device
      • DeviceType
  • core Submodules
    • color
      • color_jitter()
      • image_to_absorbance()
      • normalize_colors_pca()
      • stain_extraction_pca()
    • expose
    • intensity
      • normalize_data()
      • rand_zoom()
      • scale_intensity_range()
      • zoom()
    • morphology
      • distance_transform_edt()
    • spatial
      • image_flip()
      • image_rotate_90()
      • rand_image_flip()
      • rand_image_rotate_90()
  • skimage Submodules
    • color
      • combine_stains()
      • convert_colorspace()
      • deltaE_cie76()
      • deltaE_ciede2000()
      • deltaE_ciede94()
      • deltaE_cmc()
      • gray2rgb()
      • gray2rgba()
      • hed2rgb()
      • hsv2rgb()
      • lab2lch()
      • lab2rgb()
      • lab2xyz()
      • label2rgb()
      • lch2lab()
      • luv2rgb()
      • luv2xyz()
      • rgb2gray()
      • rgb2hed()
      • rgb2hsv()
      • rgb2lab()
      • rgb2luv()
      • rgb2rgbcie()
      • rgb2xyz()
      • rgb2ycbcr()
      • rgb2ydbdr()
      • rgb2yiq()
      • rgb2ypbpr()
      • rgb2yuv()
      • rgba2rgb()
      • rgbcie2rgb()
      • separate_stains()
      • xyz2lab()
      • xyz2luv()
      • xyz2rgb()
      • xyz_tristimulus_values()
      • ycbcr2rgb()
      • ydbdr2rgb()
      • yiq2rgb()
      • ypbpr2rgb()
      • yuv2rgb()
    • data
      • binary_blobs()
    • exposure
      • adjust_gamma()
      • adjust_log()
      • adjust_sigmoid()
      • cumulative_distribution()
      • equalize_adapthist()
      • equalize_hist()
      • histogram()
      • is_low_contrast()
      • match_histograms()
      • rescale_intensity()
    • feature
      • blob_dog()
      • blob_doh()
      • blob_log()
      • canny()
      • corner_foerstner()
      • corner_harris()
      • corner_kitchen_rosenfeld()
      • corner_peaks()
      • corner_shi_tomasi()
      • daisy()
      • hessian_matrix()
      • hessian_matrix_det()
      • hessian_matrix_eigvals()
      • match_descriptors()
      • match_template()
      • multiscale_basic_features()
      • peak_local_max()
      • shape_index()
      • structure_tensor()
      • structure_tensor_eigenvalues()
    • filters
      • LPIFilter2D
      • apply_hysteresis_threshold()
      • butterworth()
      • correlate_sparse()
      • difference_of_gaussians()
      • farid()
      • farid_h()
      • farid_v()
      • filter_forward()
      • filter_inverse()
      • frangi()
      • gabor()
      • gabor_kernel()
      • gaussian()
      • hessian()
      • laplace()
      • median()
      • meijering()
      • prewitt()
      • prewitt_h()
      • prewitt_v()
      • rank_order()
      • roberts()
      • roberts_neg_diag()
      • roberts_pos_diag()
      • sato()
      • scharr()
      • scharr_h()
      • scharr_v()
      • sobel()
      • sobel_h()
      • sobel_v()
      • threshold_isodata()
      • threshold_li()
      • threshold_local()
      • threshold_mean()
      • threshold_minimum()
      • threshold_multiotsu()
      • threshold_niblack()
      • threshold_otsu()
      • threshold_sauvola()
      • threshold_triangle()
      • threshold_yen()
      • try_all_threshold()
      • unsharp_mask()
      • wiener()
      • window()
    • measure
      • approximate_polygon()
      • block_reduce()
      • blur_effect()
      • centroid()
      • euler_number()
      • inertia_tensor()
      • inertia_tensor_eigvals()
      • intersection_coeff()
      • label()
      • manders_coloc_coeff()
      • manders_overlap_coeff()
      • moments()
      • moments_central()
      • moments_coords()
      • moments_coords_central()
      • moments_hu()
      • moments_normalized()
      • pearson_corr_coeff()
      • perimeter()
      • perimeter_crofton()
      • profile_line()
      • regionprops()
      • regionprops_table()
      • shannon_entropy()
      • subdivide_polygon()
    • metrics
      • adapted_rand_error()
      • contingency_table()
      • mean_squared_error()
      • normalized_mutual_information()
      • normalized_root_mse()
      • peak_signal_noise_ratio()
      • structural_similarity()
      • variation_of_information()
    • morphology
      • ball()
      • binary_closing()
      • binary_dilation()
      • binary_erosion()
      • binary_opening()
      • black_tophat()
      • closing()
      • convex_hull_image()
      • convex_hull_object()
      • diamond()
      • dilation()
      • disk()
      • erosion()
      • footprint_from_sequence()
      • footprint_rectangle()
      • isotropic_closing()
      • isotropic_dilation()
      • isotropic_erosion()
      • isotropic_opening()
      • medial_axis()
      • octagon()
      • octahedron()
      • opening()
      • reconstruction()
      • remove_small_holes()
      • remove_small_objects()
      • star()
      • thin()
      • white_tophat()
    • registration
      • optical_flow_ilk()
      • optical_flow_tvl1()
      • phase_cross_correlation()
    • restoration
      • calibrate_denoiser()
      • denoise_invariant()
      • denoise_tv_chambolle()
      • richardson_lucy()
      • unsupervised_wiener()
      • wiener()
    • segmentation
      • chan_vese()
      • checkerboard_level_set()
      • clear_border()
      • disk_level_set()
      • expand_labels()
      • find_boundaries()
      • inverse_gaussian_gradient()
      • join_segmentations()
      • mark_boundaries()
      • morphological_chan_vese()
      • morphological_geodesic_active_contour()
      • random_walker()
      • relabel_sequential()
    • transform
      • AffineTransform
      • EssentialMatrixTransform
      • EuclideanTransform
      • FundamentalMatrixTransform
      • PiecewiseAffineTransform
      • PolynomialTransform
      • ProjectiveTransform
      • SimilarityTransform
      • downscale_local_mean()
      • estimate_transform()
      • integral_image()
      • integrate()
      • matrix_transform()
      • pyramid_expand()
      • pyramid_gaussian()
      • pyramid_laplacian()
      • pyramid_reduce()
      • rescale()
      • resize()
      • resize_local_mean()
      • rotate()
      • swirl()
      • warp()
      • warp_coords()
      • warp_polar()
    • util
      • compare_images()
      • crop()
      • dtype_limits()
      • img_as_bool()
      • img_as_float()
      • img_as_float32()
      • img_as_float64()
      • img_as_int()
      • img_as_ubyte()
      • img_as_uint()
      • invert()
      • map_array()
      • montage()
      • random_noise()
      • view_as_blocks()
      • view_as_windows()
  • Submodule Contents
    • skimage
      • Subpackages
      • Utility Functions

Indices and tables

• Index

• Module Index

• Search Page