Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Paper available at https://doi.org/10.1038/s43856-022-00186-5
TIA Toolbox 2.1.3 Documentation
TIA Toolbox 2.1.3 Documentation
  • Readme
  • Installation
  • Pre-trained Models
  • Usage Examples
    • Basic Functionalities
      • Read and Visualize a WSI
      • Stain Normalization
      • Masking tissue region in whole slide images
      • Patch extraction from Histology Images
      • Patch Prediction Models
      • Semantic Segmentation Models
      • Advanced Model Handling in TIAToolbox
      • Nucleus Instance Segmentation
      • Multi-Task Segmentation Models
      • Whole Slide Image Registration
      • Using Foundation Models in TIAToolbox
      • Nucleus Detection And Classification
    • Pipelines
      • Virtual Spatial Transcriptomics from H&E Images
      • Prediction of Molecular Pathways and Key Mutations
      • Slide Graph Pipeline
      • Slide Graph Full-pipeline Notebook
  • Algorithms
    • IDaRS Theory
  • Visualization
  • API Reference
    • read_registry_files
    • DuplicateFilter
    • annotation
      • dsl
        • json_contains
        • json_list_sum
        • py_is_none
        • py_is_not_none
        • py_regexp
        • sql_has_key
        • sql_is_none
        • sql_is_not_none
        • sql_list_sum
        • COMMON_GLOBALS_Type
        • SQLExpression
        • SQLJSONDictionary
        • SQLNone
        • SQLRegex
        • SQLTriplet
      • storage
        • Annotation
        • AnnotationStore
        • DictionaryStore
        • SQLiteMetadata
        • SQLiteStore
    • cli
      • version_msg
      • common
        • add_default_to_usage_help
        • cli_auto_get_mask
        • cli_base_path
        • cli_batch_size
        • cli_class_dict
        • cli_device
        • cli_file_type
        • cli_img_input
        • cli_input_resolutions
        • cli_masks
        • cli_memory_threshold
        • cli_method
        • cli_min_distance
        • cli_mode
        • cli_model
        • cli_name
        • cli_num_workers
        • cli_output_file
        • cli_output_path
        • cli_output_resolutions
        • cli_output_type
        • cli_overlays
        • cli_overwrite
        • cli_patch_input_shape
        • cli_patch_mode
        • cli_patch_output_shape
        • cli_port
        • cli_postproc_tile_shape
        • cli_region
        • cli_resolution
        • cli_return_predictions
        • cli_return_probabilities
        • cli_scale_factor
        • cli_slides
        • cli_stride_shape
        • cli_threshold_abs
        • cli_threshold_rel
        • cli_tile_format
        • cli_tile_objective
        • cli_tile_read_size
        • cli_units
        • cli_verbose
        • cli_weights
        • cli_yaml_config_path
        • no_input_message
        • parse_bool_list
        • prepare_file_dir_cli
        • prepare_ioconfig
        • prepare_model_cli
        • TIAToolboxCLI
      • deep_feature_extractor
      • multitask_segmentor
      • nucleus_detector
      • nucleus_instance_segment
      • patch_predictor
      • read_bounds
      • save_tiles
      • semantic_segmentor
      • show_wsi
      • slide_info
      • slide_thumbnail
      • stain_norm
      • tissue_mask
      • visualize
      • visualize_beta
    • data
      • small_svs
      • stain_norm_target
    • enums
      • GeometryType
    • models
      • architecture
        • fetch_pretrained_weights
        • get_pretrained_model
        • deepspotm
          • tiatoolbox.models.architecture.deepspotm.DEEPSPOTM_SOURCES
          • DeepSpotM
        • efficientunet_tissue_mask_model
          • Conv2dReLU
          • Conv2dStaticSamePadding
          • EfficientNetEncoder
          • EfficientUNetTissueMaskModel
          • MBConvBlock
          • UnetDecoder
          • UnetDecoderBlock
        • grandqc
          • CenterBlock
          • DecoderBlock
          • GrandQCModel
          • UnetPlusPlusDecoder
        • hovernet
          • DenseBlock
          • HoVerNet
          • ResidualBlock
          • TFSamepaddingLayer
        • hovernetplus
          • HoVerNetPlus
        • idars
          • IDaRS
        • kongnet
          • CenterBlock
          • DecoderBlock
          • KongNet
          • KongNetDecoder
          • SubPixelUpsample
          • TimmEncoderFixed
        • mapde
          • MapDe
        • micronet
          • group1_arch_branch
          • group1_forward_branch
          • group2_arch_branch
          • group2_forward_branch
          • group3_arch_branch
          • group3_forward_branch
          • group4_arch_branch
          • group4_forward_branch
          • out_arch_branch
          • MicroNet
        • nuclick
          • ConvBnRelu
          • MultiscaleConvBlock
          • NuClick
          • ResidualConv
        • sam
          • SAM
        • sccnn
          • SCCNN
        • segformer
          • Segformer
        • segformer_hf
          • is_smp_segformer_state_dict
          • remap_smp_segformer_state_dict
        • timm_efficientnet
          • get_efficientnet_kwargs
          • EfficientNetBaseEncoder
          • EfficientNetEncoder
        • unet
          • create_block
          • ResNetEncoder
          • UNetModel
          • UnetEncoder
        • utils
          • argmax_last_axis
          • centre_crop
          • centre_crop_to_shape
          • compile_model
          • is_torch_compile_compatible
          • nms_on_detection_maps
          • patch_first_conv
          • peak_detection_map_overlap
          • replace_strides_with_dilation
          • AttentionModule
          • Conv2dReLU
          • EncoderMixin
          • SCSEModule
          • SegmentationHead
          • UpSample2x
        • vanilla
          • CNNBackbone
          • CNNModel
          • TimmBackbone
          • TimmModel
      • dataset
        • classification
          • predefined_preproc_func
        • dataset_abc
          • PatchDataset
          • PatchDatasetABC
          • WSIPatchDataset
        • info
          • DatasetInfoABC
          • KatherPatchDataset
      • engine
        • deep_feature_extractor
          • save_to_cache
          • DeepFeatureExtractor
        • engine_abc
          • prepare_engines_save_dir
          • EngineABC
          • EngineABCRunParams
        • io_config
          • IOInstanceSegmentorConfig
          • IOPatchPredictorConfig
          • IOSegmentorConfig
          • ModelIOConfigABC
        • multi_task_segmentor
          • apply_coordinate_offset
          • dict_to_json_store
          • merge_multitask_horizontal
          • merge_multitask_vertical_chunkwise
          • prepare_multitask_full_batch
          • retrieve_sel_uids
          • save_multitask_to_cache
          • DaskDelayedJSONStore
          • MultiTaskSegmentor
          • MultiTaskSegmentorRunParams
        • nucleus_detector
          • save_detection_arrays_to_qupath_json
          • save_detection_arrays_to_store
          • NucleusDetector
          • NucleusDetectorRunParams
        • nucleus_instance_segmentor
          • NucleusInstanceSegmentor
        • patch_predictor
          • PatchPredictor
          • PredictorRunParams
        • prompt_segmentor
          • PromptSegmentor
        • semantic_segmentor
          • build_da_pad_width
          • clip_probabilities_to_shape
          • concatenate_none
          • get_full_output_locs_inside_mask
          • get_wsi_output_shape
          • merge_batch_to_canvas
          • merge_horizontal
          • merge_vertical_chunkwise
          • prepare_full_batch
          • save_to_cache
          • store_probabilities
          • SemanticSegmentor
          • SemanticSegmentorRunParams
      • models_abc
        • load_torch_model
        • model_to
        • ModelABC
    • tiatoolbox
    • tools
      • graph
        • affinity_to_edge_index
        • delaunay_adjacency
        • edge_index_to_triangles
        • triangle_signed_area
        • SlideGraphConstructor
      • patchextraction
        • get_patch_extractor
        • validate_shape
        • ExtractorParams
        • PatchExtractor
        • PatchExtractorABC
        • PointsPatchExtractor
        • PointsPatchExtractorParams
        • SlidingWindowPatchExtractor
        • SlidingWindowPatchExtractorParams
      • pyramid
        • AnnotationTileGenerator
        • TilePyramidGenerator
        • ZoomifyGenerator
      • registration
        • wsi_registration
          • apply_affine_transformation
          • apply_bspline_transform
          • compute_center_of_mass
          • estimate_bspline_transform
          • match_histograms
          • prealignment
          • AffineWSITransformer
          • DFBRFeatureExtractor
          • DFBRegister
      • stainaugment
        • StainAugmentor
      • stainextract
        • dl_output_for_h_and_e
        • h_and_e_in_right_order
        • vectors_in_correct_direction
        • CustomExtractor
        • MacenkoExtractor
        • RuifrokExtractor
        • VahadaneExtractor
      • stainnorm
        • get_normalizer
        • CustomNormalizer
        • MacenkoNormalizer
        • ReinhardNormalizer
        • RuifrokNormalizer
        • StainNormalizer
        • VahadaneNormalizer
      • tissuemask
        • MorphologicalMasker
        • OtsuTissueMasker
        • TissueMasker
    • type_hints
    • utils
      • env_detection
        • check_pixman_using_anaconda
        • check_pixman_using_brew
        • check_pixman_using_dpkg
        • check_pixman_using_macports
        • colab_has_gpu
        • has_gpu
        • has_network
        • in_conda_env
        • is_interactive
        • is_notebook
        • pixman_versions
        • pixman_warning
        • running_on_ci
        • running_on_circleci
        • running_on_colab
        • running_on_github
        • running_on_kaggle
        • running_on_travis
        • version_to_tuple
      • exceptions
        • tiatoolbox.utils.exceptions.DimensionMismatchError
        • tiatoolbox.utils.exceptions.FileNotSupportedError
        • tiatoolbox.utils.exceptions.MethodNotSupportedError
      • image
        • tiatoolbox.utils.image.PADDING_TO_BOUNDS
        • crop_and_pad_edges
        • find_overlap
        • find_padding
        • make_bounds_size_positive
        • normalize_padding_size
        • safe_padded_read
        • sub_pixel_read
      • magic
        • is_dcm
        • is_dir
        • is_sqlite3
        • is_zip
      • metrics
        • dice
        • f1_detection
        • pair_coordinates
      • misc
        • add_from_dat
        • anns_from_hoverdict
        • assert_dtype_int
        • cast_to_min_dtype
        • contrast_enhancer
        • create_smart_array
        • dict_to_store_patch_predictions
        • dict_to_store_semantic_segmentor
        • download_data
        • get_bounding_box
        • get_luminosity_tissue_mask
        • get_zarr_array
        • grab_files_from_dir
        • imread
        • imwrite
        • load_stain_matrix
        • make_default_dict
        • make_valid_poly
        • pad_contours
        • parse_cv2_interpolaton
        • patch_predictions_as_annotations
        • patch_predictions_as_qupath_json
        • ppu2mpp
        • process_contours
        • read_locations
        • remove_padded_values_in_contours
        • save_annotations
        • save_as_json
        • save_qupath_json
        • save_yaml
        • select_cv2_interpolation
        • select_device
        • split_path_name_ext
        • store_from_dat
        • string_to_tuple
        • tqdm_dask_progress_bar
        • unzip_data
        • update_tqdm_desc
        • write_probability_heatmap_as_ome_tiff
      • postproc_defs
        • MultichannelToRGB
      • tiff_to_fsspec
        • convert_metadata
        • main
        • replace_url
      • transforms
        • background_composite
        • bounds2locsize
        • bounds2slices
        • imresize
        • locsize2bounds
        • od2rgb
        • pad_bounds
        • rgb2od
      • visualization
        • colourise_image
        • overlay_prediction_contours
        • overlay_prediction_mask
        • overlay_probability_map
        • plot_graph
        • random_colors
        • AnnotationRenderer
        • ColorbarParamsDict
    • visualization
      • bokeh_app
        • app_hooks
          • on_session_destroyed
        • main
          • add_layer
          • bind_cb_obj
          • bind_cb_obj_tog
          • blur_spinner_cb
          • build_predicate
          • change_tiles
          • clear_overlay_cb
          • cmap_select_cb
          • color_input_cb
          • control_tabs_cb
          • control_tabs_remove_cb
          • cprop_input_cb
          • create_channel_color_ui
          • edge_size_cb
          • filter_input_cb
          • fixed_layer_select_cb
          • format_info
          • gather_ui_elements
          • get_channel_info
          • get_from_config
          • get_mapper_for_prop
          • get_view_bounds
          • handle_graph_layer
          • hex2rgb
          • initialise_overlay
          • initialise_slide
          • layer_drop_cb
          • layer_select_cb
          • layer_slider_cb
          • make_color_dict
          • make_color_seq_from_cmap
          • make_safe_name
          • make_ts
          • make_window
          • model_drop_cb
          • name2type
          • node_select_cb
          • opt_buttons_cb
          • overlay_alpha_cb
          • overlay_toggle_cb
          • populate_layer_list
          • populate_slide_list
          • populate_table
          • pt_size_cb
          • res_switch_cb
          • rgb2hex
          • sam_segment
          • save_cb
          • scale_spinner_cb
          • segment_on_box
          • set_alpha_glyph
          • set_channel_info
          • setup_config_ui_settings
          • slide_alpha_cb
          • slide_select_cb
          • slide_toggle_cb
          • tap_event_cb
          • to_float_rgb
          • to_int_rgb
          • to_model_cb
          • to_num
          • type_cmap_cb
          • update
          • update_mapper
          • update_renderer
          • update_ui_on_new_annotations
          • ColorCycler
          • DocConfig
          • DummyAttr
          • TileGroup
          • UIWrapper
          • ViewerState
      • tileserver
        • TileServer
      • ui_utils
        • get_level_by_extent
    • wsicore
      • metadata
        • ngff
          • Axis
          • Channel
          • CoordinateTransform
          • Creator
          • Dataset
          • Multiscales
          • Omero
          • RDefs
          • Window
          • Zattrs
      • wsimeta
        • WSIMeta
      • wsireader
        • annotation_store
          • AnnotationStoreReader
        • base
          • ArrayView
          • FsspecJsonWSIReader
          • OpenSlideWSIReader
          • TIFFWSIReader
          • TIFFWSIReaderDelegate
          • TransformedWSIReader
          • VirtualWSIReader
          • WSIReader
        • detection
          • is_dicom
          • is_ngff
          • is_tiled_tiff
          • is_url
          • is_valid_zarr_fsspec
          • is_zarr
        • dicom
          • DICOMWSIReader
        • factory
          • fix_mangled_url_by_pathlib
          • open_wsi
          • try_annotation_store
          • try_dicom
          • try_fsspec
          • try_ngff
          • try_ome_tiff
          • try_openslide
          • try_tiff
          • verify_supported_wsi
        • jp2
          • JP2WSIReader
        • ngff
          • NGFFWSIReader
        • types
          • WSIReaderExtraParams
          • WSIReaderParams
  • Contributing
  • Authors
  • History
Back to top

ngff¶

tiatoolbox . wsicore . wsireader . ngff

Reader for NGFF WSI files.

Classes

NGFFWSIReader

Reader for NGFF WSI zarr(s).
Next
NGFFWSIReader
Previous
JP2WSIReader
Copyright © 2026, TIA Lab
Made with Sphinx and @pradyunsg's Furo