ClearMap Documentation#

Date: Aug 02, 2024 Version: 2.1.0

Useful links: Source Repository | Issues & Ideas | License


ClearMap is an open source, GPL-licensed program and set of libraries providing high-performance, easy-to-use tools to analyse TB scale volumetric image datasets using the Python programming language.

ClearMap has been written for mapping immediate early genes [Renier2016] as well as vasculature networks of whole mouse brains [Kirst2020]

Getting started

The getting started guides provide an overview of the ClearMap software and how to use it. It is recommended to start here if you are new to ClearMap.

GUI

The GUI documentation provides an overview of the graphical user interface. If you want to perform analysis without writing scripts, this is the place to start.

Advanced usage

The user guide provides a detailed description of the ClearMap software and how to use it. This is meant for more advanced users who want to understand the software in more detail or want to write their own scripts.

API reference

The API reference provides a detailed description of the ClearMap modules and functions. This will be your go-to place if you want to write your own scripts or understand the underlying algorithms.