Skip to main content

A tool to create 2D morphology collage plots based on matplotlib.

Project description

NeuroCollage

A tool to create 2D morphology collage plots based on matplotlib.

Installation

It is recommended to install NeuroCollage using pip:

pip install neurocollage

Usage

This package provides only one command that aims at building figures of morphologies in atlas planes (i.e. collage plots).

Inputs

The collage requires the following inputs:

  • the path to a standard CircuitConfig, or the path to a sonata circuit_config.json file of a SONATA circuit and the path to an Atlas directory that can be read by Voxcell.
  • [optional] a configuration file containing the default values used for the CLI arguments (all these values are overridden by the ones passed to the CLI). The config file is a INI file divided in sections. These sections correspond to the first part of the CLI parameter names. For example, the atlas-path parameter of the CLI corresponds to the path parameter of the atlas section in the configuration file.

Outputs

This package contains three main functions:

  • get_layer_annotation: can generate annotation of layers for plotting or other uses
  • create_planes: defines a set of planes to create collage plots, with various algorithms. Planes are sampled along a centerline, which can be straight aligned or not with world coordinates or curved using an algorithm from former atlas_analysis package. The first and last point of the centerline can be defined manually, or estimated internally to span the given region best.
  • plot_collage: make the collage plot, see API for possible arguments.

Command

This package provides a CLI whose parameters are described in the Command Line Interface page of this documentation. It is also possible to get help from the command:

neuro-collage --help

If all the arguments are provided in the configuration file, the command is just:

neuro-collage -c <config-file>

Any argument from the configuration file can be overridden through the CLI:

neuro-collage -c <config-file> --cells-sample 20 --collage-pdf-filename custom_collage_name.pdf

Note that the parameter names of the CLI use the section in the configuration file as prefix. In the previous example, the --cells-sample overrides the sample parameter of the cells section of the configuration file.

Examples

The examples folder contains a simple example on S1 region of SSCx with L5_TPC:A morphologies. It also provides examples of programmatic use of the NeuroCollage API with both types of circuit formats.

Funding & Acknowledgment

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government's ETH Board of the Swiss Federal Institutes of Technology.

Copyright (c) 2022-2024 Blue Brain Project/EPFL

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neurocollage-0.3.7.tar.gz (649.2 kB view details)

Uploaded Source

Built Distribution

neurocollage-0.3.7-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file neurocollage-0.3.7.tar.gz.

File metadata

  • Download URL: neurocollage-0.3.7.tar.gz
  • Upload date:
  • Size: 649.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for neurocollage-0.3.7.tar.gz
Algorithm Hash digest
SHA256 29f033fc595ed5fc17d412b6fb4022d4a8523a203ea40630b5b0dfe8f5196004
MD5 0f63a9218c03cd0051dbcf054b6d5102
BLAKE2b-256 476a49c0a38cf1c922fb522d2e91e8a389db2821e01db44bb99bb68fde9a4192

See more details on using hashes here.

File details

Details for the file neurocollage-0.3.7-py3-none-any.whl.

File metadata

  • Download URL: neurocollage-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 38.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for neurocollage-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 046b984743d87418abbf3f26cdd91df2008fe224ffd7eb120d8c2dac9605bb74
MD5 d2627d9557eea4aba3f1848040c06949
BLAKE2b-256 ecc2c6ec8a95b6df3033591bf547717dfcef0623808588f7bfe23df00a574e81

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page