|banner|
Overview
=========
This project contains the commands which create direction vectors for several brain regions including the cerebellum, the isocortex, and the thalamus of the AIBS P56 mouse brain.
Direction vectors are 3D unit vectors associated to voxels of a brain region.
They represent the directions of the fiber tracts and their streamlines are assumed to cross transversely layers in laminar brain regions.
Direction vectors are used in placement-algorithm to set cells orientations.
Direction vectors are also used to compute placement hints and split layer 2/3 of the AIBS mouse isocortex.
After installation, you can display the available command lines with the following ``bash`` command:
.. code-block:: bash
atlas-direction-vectors --help
Installation
============
.. code-block:: bash
pip install atlas-direction-vectors
Examples
========
Direction Vectors
-----------------
Get the required input files:
.. code-block:: bash
mkdir -p data/ccfv3
# hierarchy file:
curl -o data/1.json http://api.brain-map.org/api/v2/structure_graph_download/1.json
# CCFv3 annotation volume:
curl -o data/ccfv3/annotation_25.nrrd http://download.alleninstitute.org/informatics-archive/current-release/mouse_ccf/annotation/ccf_2017/annotation_25.nrrd
Run the code (note, depending on the resolution of the volume, this may require significant amounts of available RAM):
.. code-block:: bash
atlas-direction-vectors direction-vectors \
isocortex \
--hierarchy-path data/1.json \
--annotation-path data/ccfv3/annotation_25.nrrd \
--algorithm shading-blur-gradient \
--output-path data/ccfv3/direction_vectors.nrrd
For the placeholder orientations, one can compute the vectors for a particular
region with:
.. code-block:: bash
atlas-direction-vectors direction-vectors \
from-center \
--region SSp \
--hierarchy-path data/1.json \
--annotation-path data/ccfv3/annotation_25.nrrd \
--output-path placeholder-direction_vectors.nrrd
Instructions for developers
===========================
Run the following commands before submitting your code for review:
.. code-block:: bash
cd atlas-direction-vectors
isort -l 100 --profile black atlas_direction_vectors tests setup.py
black -l 100 atlas_direction_vectors tests setup.py
These formatting operations will help you pass the linting check `testenv:lint` defined in `tox.ini`.
Citation
========
When you use this software, we kindly ask you to cite the following DOI:
.. image:: https://zenodo.org/badge/451806460.svg
:target: https://zenodo.org/badge/latestdoi/451806460
Acknowledgements
================
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.
For license and authors, see LICENSE.txt and AUTHORS.txt respectively.
Copyright © 2022-2024 Blue Brain Project/EPFL
.. substitutions
.. |banner| image:: doc/source/static/atlas-direction-vectors.jpg
Raw data
{
"_id": null,
"home_page": "https://github.com/BlueBrain/atlas-direction-vectors",
"name": "atlas-direction-vectors",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.0",
"maintainer_email": "",
"keywords": "",
"author": "Blue Brain Project, EPFL",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/76/47/dad2308563b879f157af8c5a6904f6662cd08314daed132f869403d695e1/atlas-direction-vectors-0.1.5.tar.gz",
"platform": null,
"description": "|banner|\n\nOverview\n=========\n\nThis project contains the commands which create direction vectors for several brain regions including the cerebellum, the isocortex, and the thalamus of the AIBS P56 mouse brain.\n\nDirection vectors are 3D unit vectors associated to voxels of a brain region.\nThey represent the directions of the fiber tracts and their streamlines are assumed to cross transversely layers in laminar brain regions.\n\nDirection vectors are used in placement-algorithm to set cells orientations.\n\nDirection vectors are also used to compute placement hints and split layer 2/3 of the AIBS mouse isocortex.\n\nAfter installation, you can display the available command lines with the following ``bash`` command:\n\n.. code-block:: bash\n\n atlas-direction-vectors --help\n\nInstallation\n============\n\n.. code-block:: bash\n\n pip install atlas-direction-vectors\n\nExamples\n========\n\nDirection Vectors\n-----------------\n\nGet the required input files:\n\n.. code-block:: bash\n\n mkdir -p data/ccfv3\n\n # hierarchy file:\n curl -o data/1.json http://api.brain-map.org/api/v2/structure_graph_download/1.json\n\n # CCFv3 annotation volume:\n curl -o data/ccfv3/annotation_25.nrrd http://download.alleninstitute.org/informatics-archive/current-release/mouse_ccf/annotation/ccf_2017/annotation_25.nrrd\n\nRun the code (note, depending on the resolution of the volume, this may require significant amounts of available RAM):\n\n.. code-block:: bash\n\n atlas-direction-vectors direction-vectors \\\n isocortex \\\n --hierarchy-path data/1.json \\\n --annotation-path data/ccfv3/annotation_25.nrrd \\\n --algorithm shading-blur-gradient \\\n --output-path data/ccfv3/direction_vectors.nrrd\n\nFor the placeholder orientations, one can compute the vectors for a particular\nregion with:\n\n.. code-block:: bash\n\n atlas-direction-vectors direction-vectors \\\n from-center \\\n --region SSp \\\n --hierarchy-path data/1.json \\\n --annotation-path data/ccfv3/annotation_25.nrrd \\\n --output-path placeholder-direction_vectors.nrrd\n\nInstructions for developers\n===========================\n\nRun the following commands before submitting your code for review:\n\n.. code-block:: bash\n\n cd atlas-direction-vectors\n isort -l 100 --profile black atlas_direction_vectors tests setup.py\n black -l 100 atlas_direction_vectors tests setup.py\n\nThese formatting operations will help you pass the linting check `testenv:lint` defined in `tox.ini`.\n\nCitation\n========\n\nWhen you use this software, we kindly ask you to cite the following DOI:\n\n.. image:: https://zenodo.org/badge/451806460.svg\n :target: https://zenodo.org/badge/latestdoi/451806460\n\nAcknowledgements\n================\n\nThe development of this software was supported by funding to the Blue Brain Project, a research center of the \u00c9cole polytechnique f\u00e9d\u00e9rale de Lausanne (EPFL), from the Swiss government\u2019s ETH Board of the Swiss Federal Institutes of Technology.\n\nFor license and authors, see LICENSE.txt and AUTHORS.txt respectively.\n\nCopyright \u00a9 2022-2024 Blue Brain Project/EPFL\n\n.. substitutions\n\n.. |banner| image:: doc/source/static/atlas-direction-vectors.jpg",
"bugtrack_url": null,
"license": "Apache-2",
"summary": "Commands to compute direction vectors in volumetric brain regions. Direction vectors are 3D unit vectors associated to voxels of a brain region. They represent the directions of the fiber tracts.",
"version": "0.1.5",
"project_urls": {
"Download": "https://github.com/BlueBrain/atlas-direction-vectors",
"Homepage": "https://github.com/BlueBrain/atlas-direction-vectors"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7647dad2308563b879f157af8c5a6904f6662cd08314daed132f869403d695e1",
"md5": "a8a74b338f747c62bf95079f8541ad59",
"sha256": "2235fac2ea425539931cb17ccc4d454a5001d5cdd9101388ed35a0f7175b95eb"
},
"downloads": -1,
"filename": "atlas-direction-vectors-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "a8a74b338f747c62bf95079f8541ad59",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0",
"size": 146630,
"upload_time": "2024-01-16T14:50:34",
"upload_time_iso_8601": "2024-01-16T14:50:34.884248Z",
"url": "https://files.pythonhosted.org/packages/76/47/dad2308563b879f157af8c5a6904f6662cd08314daed132f869403d695e1/atlas-direction-vectors-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-16 14:50:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BlueBrain",
"github_project": "atlas-direction-vectors",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "atlas-direction-vectors"
}
JSON
