clabtoolkit Logo

Getting started

  • Installation
    • Requirements and optional dependencies
  • Quick Start
    • Filter a parcellation by region name
    • Sample an image along the streamlines of a tractogram
    • Plot a surface with a scalar map
    • Next steps
  • What can you do with CLABTOOLKIT?
    • Colors and color tables
    • BIDS datasets and derivatives
    • Parcellations
    • Surfaces and FreeSurfer
    • Tractograms
    • Connectomes and networks
    • Diffusion MRI and images
    • Morphometry
    • Visualization
    • Quality control and everyday utilities
  • Examples
    • General overview
    • Representative workflows
    • Examples by module

Reference

  • API Reference
    • bidstools module
      • Key Features
      • API reference
        • str2entity()
        • entity2str()
        • delete_entity()
        • replace_entity_value()
        • replace_entity_key()
        • insert_entity()
        • recursively_replace_entity_value()
        • recursively_replace_entity_key()
        • recursively_delete_entity()
        • recursively_insert_entity()
        • get_all_entities()
        • entities4table()
        • entities_to_table()
        • get_subjects()
        • copy_bids_folder()
        • get_bids_database_table()
        • get_derivatives_folders()
        • is_bids_filename()
        • get_individual_files_and_folders()
        • generate_bids_tree()
        • generate_bids_tree_with_stats()
        • validate_bids_structure()
        • load_bids_json()
      • Main Functions
        • Entities in a filename
        • Entities in a dataset
        • Dataset management
      • Common Usage Examples
    • colorstools module
      • Key Features
      • API reference
        • bcolors
        • is_color_like()
        • detect_rgb_range()
        • is_valid_rgb_255()
        • is_valid_rgb_01()
        • normalize_rgb()
        • rgb2hex()
        • multi_rgb2hex()
        • is_valid_hex_color()
        • hex2rgb()
        • multi_hex2rgb()
        • invert_colors()
        • harmonize_colors()
        • readjust_colors()
        • create_random_colors()
        • get_colormaps_names()
        • create_lut_dictionary()
        • create_distinguishable_colors()
        • get_predefined_distinguishable_colors()
        • colortable_visualization()
        • get_colors_from_colortable()
        • values2colors()
        • colors_to_table()
        • visualize_colors()
        • generate_colortable()
        • ColorTableLoader
      • Main Classes
        • ColorTableLoader
        • bcolors
      • Main Functions
        • Format Conversion
        • Validation
        • Palette Generation
        • Colour Tables
        • Visualization
      • Common Usage Examples
    • connectivitytools module
      • Key Features
      • API reference
        • Connectome
      • Main Class
        • Connectome
      • Common Usage Examples
    • dicomtools module
      • Key Features
      • Session and series names
      • API reference
        • progress_indicator()
        • org_conv_dicoms()
        • organize_dicom_files()
        • org_dicom_folder()
        • copy_dicom_file()
        • create_session_series_names()
        • uncompress_dicom_session()
        • compress_dicom_session()
        • get_dicom_info()
      • Main Functions
        • DICOM Organization
        • Sessions
        • Auxiliary
      • Common Usage Examples
    • dwitools module
      • Key Features
      • API reference
        • delete_dwi_volumes()
        • get_b0s()
        • maps_from_tensor_eigenvalues()
        • DiffusionScheme
      • Main Classes
        • DiffusionScheme
      • Main Functions
        • Volume Management
        • Tensor Maps
      • Common Usage Examples
    • freesurfertools module
      • Key Features
      • API reference
        • AnnotParcellation
        • FreeSurferSubject
        • create_subject_stats_table()
        • process_subject()
        • create_cohort_stats_table()
        • create_fsaverage_links()
        • remove_fsaverage_links()
        • region_to_vertexwise()
        • create_vertex_colors()
        • colors2colortable()
        • resolve_colortable_duplicates()
        • find_unique_color()
        • verify_packed_rgb_values()
        • detect_hemi()
        • parse_freesurfer_lta()
        • get_cras_coordinates()
        • load_lobes_json()
        • get_version()
      • Main Classes
        • AnnotParcellation
        • FreeSurferSubject
      • Main Functions
        • Table Generation
        • Transforms and Coordinates
        • Colours and Labels
        • Utilities
      • Common Usage Examples
    • imagetools module
      • Key Features
      • API reference
        • MorphologicalOperations
        • quick_morphology()
        • get_voxel_size()
        • get_voxel_volume()
        • get_center()
        • get_rotation_matrix()
        • get_vox_neighbors()
        • crop_image_from_mask()
        • cropped_to_native()
        • apply_multi_transf()
        • vox2mm()
        • mm2vox()
        • merge_to_4d()
        • create_spams()
        • spams2maxprob()
        • simulate_image()
        • delete_volumes_from_4D_images()
        • extract_mesh_from_volume()
        • extract_centroid_from_volume()
        • create_spams_from_volume()
        • spams2maxprob_from_volume()
        • compute_statistics_at_nonzero_voxels()
        • interpolate()
        • region_growing()
        • simulate_array()
        • delete_volumes_from_4D_array()
        • dilate_mm()
      • Main Classes
        • MorphologicalOperations
      • Main Functions
        • Morphology
        • Affine Utilities
        • Image Manipulation
        • Probabilistic Maps
        • Mesh and Statistics
        • Simulation
      • Common Usage Examples
    • misctools module
      • Key Features
      • API reference
        • ExplorerDict
        • build_indices()
        • get_indices_by_condition()
        • get_values_by_condition()
        • build_indices_with_conditions()
        • build_values_with_conditions()
        • parse_condition()
        • is_numeric()
        • analyze_condition()
        • remove_duplicates()
        • select_ids_from_file()
        • get_indexes_by_substring()
        • filter_by_substring()
        • remove_substrings()
        • replace_substrings()
        • to_list()
        • list_intercept()
        • ismember()
        • find_closest_date()
        • get_leaf_directories()
        • remove_trailing_separators()
        • get_all_files()
        • rename_folders()
        • remove_empty_folders()
        • create_temporary_filename()
        • remove_consecutive_duplicates()
        • create_names_from_indices()
        • correct_names()
        • get_real_basename()
        • load_json()
        • remove_empty_keys_or_values()
        • save_dictionary_to_json()
        • compare_dicts()
        • read_file_with_separator_detection()
        • smart_read_table()
        • drop_empty_columns()
        • extract_string_values()
        • update_dict()
        • expand_and_concatenate()
        • generate_container_command()
        • is_notebook()
        • format_signature()
        • show_module_contents()
        • show_object_content()
        • h5explorer()
        • h5explorer_simple()
        • search_methods()
        • printprogressbar()
        • SmartFormatter
        • list_sample_data()
        • fetch_sample_data()
        • get_sample_data_dir()
      • Main Functions
        • Indices and conditions
        • Lists and strings
        • Files, folders and tables
        • Exploration and display
      • Common Usage Examples
    • morphometrytools module
      • Key Features
      • API reference
        • compute_reg_val_fromannot()
        • compute_reg_area_fromsurf()
        • compute_reg_nvertices_fromsurf()
        • compute_euler_fromsurf()
        • area_from_mesh()
        • euler_from_mesh()
        • compute_reg_val_fromparcellation()
        • compute_reg_volume_fromparcellation()
        • parse_freesurfer_global_fromaseg()
        • parse_freesurfer_stats_fromaseg()
        • parse_freesurfer_cortex_stats()
        • get_stats_dictionary()
        • network_metrics_to_table()
        • stats_from_vector()
        • get_units()
        • convert_from_mm()
      • Main Functions
        • Surface-based Analysis
        • Volume-based Analysis
        • FreeSurfer Analysis
        • Utility Functions
      • Common Usage Examples
    • networktools module
      • Key Features
      • API reference
        • adjacency_matrix_to_csr()
        • triangulated_mesh_to_csr()
        • edges_to_csr()
        • edges_to_components()
        • connected_components()
      • Main Functions
        • Graph Conversion
        • Connected Components
      • Common Usage Examples
    • parcellationtools module
      • Key Features
      • API reference
        • Parcellation
        • RegionTimeSeries
      • Main Classes
        • Parcellation
        • RegionTimeSeries
      • Common Usage Examples
    • pipelinetools module
      • Key Features
      • API reference
        • get_fullids2process()
        • create_processing_status_table()
        • process_file()
        • process_freesurfer_subject()
        • scan_derivatives()
        • build_inventory()
        • build_derivatives_inventory()
        • get_processing_status_details_json()
        • get_processing_status_details_sqlite3()
        • query_processing_status_db()
        • export_db_to_json()
      • Main Functions
        • Subjects
        • Status tables and inventories
        • Processing status details
      • Common Usage Examples
    • plottools module
      • Key Features
      • API reference
        • get_screen_size()
        • get_current_monitor_size()
        • estimate_monitor_dpi()
        • calculate_optimal_subplots_grid()
        • calculate_subplot_layout()
        • create_proportional_subplots()
        • calculate_font_sizes()
        • get_pyvista_fonts()
        • generate_spherical_coords()
      • Main Functions
        • Screen
        • Layout
        • Fonts
        • Utilities
      • Common Usage Examples
    • pointstools module
      • Key Features
      • API reference
        • PointsCloud
        • merge_pointsclouds()
        • smooth_curve_coordinates()
      • Main Classes
        • PointsCloud
      • Main Functions
      • Common Usage Examples
    • qcqatools module
      • Key Features
      • API reference
        • get_valid_slices()
        • generate_slices()
        • recursively_generate_slices()
        • generate_image_selection_webpage()
        • create_png_webpage_from_generated_slices()
      • Main Functions
      • Common Usage Examples
    • segmentationtools module
      • Key Features
      • API reference
        • abased_parcellation()
        • tissue_seg_table()
      • Main Functions
      • Common Usage Examples
    • surfacetools module
      • Key Features
      • API reference
        • Surface
        • merge_surfaces()
        • create_surface_colortable()
      • Main Classes
        • Surface
      • Main Functions
      • Common Usage Examples
    • tracttools module
      • Key Features
      • API reference
        • Tractogram
        • resample_streamlines()
        • interpolate_streamline_values()
        • merge_tractograms()
        • trk2tck()
        • tck2trk()
        • simulate_tractogram()
      • Main Classes
        • Tractogram
      • Main Functions
        • Format Conversion
        • Streamline Utilities
      • Common Usage Examples
    • visualizationtools module
      • Key Features
      • API reference
        • BrainPlotter
        • create_carpet_plot()
      • Main Classes
        • BrainPlotter
      • Main Functions
      • Common Usage Examples
    • Data and formats
    • Surfaces and parcellations
    • Tractography and connectivity
    • Visualization and quality control

Project

  • Contributing
    • Types of Contributions
      • Report Bugs
      • Fix Bugs
      • Implement Features
      • Write Documentation
      • Submit Feedback
    • Get Started!
    • Coding Standards
    • Building the Documentation
    • Pull Request Guidelines
    • Tips
    • Releases
  • History
    • 0.6.1 (2026-10-29)
    • 0.6.0 (2026-10-25)
    • 0.5.3 (2026-10-22)
    • 0.5.2 (2026-10-22)
    • 0.5.1 (2026-10-21)
    • 0.5.0 (2026-10-21)
    • 0.4.5 (2026-08-28)
    • 0.4.4 (2026-07-17)
    • 0.4.3 (2026-06-10)
    • 0.4.1 (2026-02-19)
    • 0.3.4 (2025-01-09)
    • 0.3.1 (2025-05-22)
clabtoolkit
  • Connectomics Lab Toolkit Documentation
  • View page source

Connectomics Lab Toolkit Documentation

clabtoolkit logo

A comprehensive Python toolkit for neuroimaging data processing and analysis, specifically designed for working with brain connectivity data, BIDS datasets, and various neuroimaging formats.

  • Free software: Apache Software License 2.0

  • Source code: https://github.com/connectomicslab/clabtoolkit

  • Python versions: 3.11+

clabtoolkit ecosystem

Getting started

  • Installation
    • Requirements and optional dependencies
  • Quick Start
    • Filter a parcellation by region name
    • Sample an image along the streamlines of a tractogram
    • Plot a surface with a scalar map
    • Next steps
  • What can you do with CLABTOOLKIT?
    • Colors and color tables
    • BIDS datasets and derivatives
    • Parcellations
    • Surfaces and FreeSurfer
    • Tractograms
    • Connectomes and networks
    • Diffusion MRI and images
    • Morphometry
    • Visualization
    • Quality control and everyday utilities
  • Examples
    • General overview
    • Representative workflows
    • Examples by module

Reference

  • API Reference
    • Data and formats
    • Surfaces and parcellations
    • Tractography and connectivity
    • Visualization and quality control

Project

  • Contributing
  • History

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2024-2026, Yasser Alemán-Gómez.

Built with Sphinx using a theme provided by Read the Docs.