Skip to content

Registration of animal MR brain data to a standard (published) atlas. The pipeline works with invivo or exvivo (skull-stripped) MR-data for the following species: mouse, rat, Etruscan shrew and cat. *OS: Windows, MAC, Linux. *Matlab: R2016a or later.

License

Notifications You must be signed in to change notification settings

retune-commons/antx2

 
 

Repository files navigation

ANTx2

ANTx2 stands for A tlas N ormalization T oolbox using elasti x. It is a MATLAB toolbox for image registration of mouse magnetic resonance imaging data developed for research laboratories/departments.

____________________________________________________________________________________________
⇒ Respository: GitHub:github.com/ChariteExpMri/antx2 
⇒ Tutorials: https://chariteexpmri.github.io/antxdoc/ 
⇒ Templates  : googleDrive:animal templates 
____________________________________________________________________________________________

Requirements

  • Windows (tested: Windows 10)
  • Linux (tested: Ubuntu 16.04.6 LTS, (MINT17/Linuxfx))
  • MAC (tested: OS X El Capitan/Catalina)
  • MATLAB, all functions were tested for R2015b/16a. Versions above 2018b should work (otherwise please send a mail)

♦ Inspect last changes/updates.

Tutorials

Tutorials can be found here: https://chariteexpmri.github.io/antxdoc

Installation

[OPTION-A] Installation via GITHUB using GIT

ADVANTAGE: updates can be made via toolbox

  • download & install GIT client --> https://git-scm.com/downloads just follow instructions and keep the default properties
  • browse to LINK: https://github.com/ChariteExpMri/antx2
  • select "installfromgithub.m" and click [RAW]-button or go to here: https://raw.githubusercontent.com/ChariteExpMri/antx2/master/installfromgithub.m
  • select "save as" (cmd+s or ctrl+s) and save file as "installfromgithub.m"
  • copy "installfromgithub.m" to the location where antx toolbox should be installed. ..please don't create a folder with name "antx2", this folder will be created later on
  • set MATLAB's current working dir to the location of "installfromgithub.m"
  • type installfromgithub to open the installer/check updates window
  • select [FRESH INSTALL] ...next, select the hyperlink "install" Matlab's in ..wait..and hit [close] to close the window

[OPTION-B] just download via clone-button (GITHUB)

ADVANTAGE : more simple installation
DISADVANTAGE: no update feature (or you have to install the GIT client post hoc)

  • select [Clone & download button]
  • select [Download ZIP]
  • unzip folder & copy entire "antx2"-folder to desired location

Start Ant Gui

- set MATLAB's current working dir to "antx2" directory 
- type antlink to link paths 
  Alternatively, you can create a hyperlink that occurs each time Matlab is started.. (see "__startup.m" file
  in the antx2-directory for more information) 
- type "ant" to open ant-gui 

Check For Updates

  • To check for updates select EXTRAS/"CHECK FOR UPATES (GITHUB)" from the ant main gui
  • Or type updateantx(2) in Matlab's CMD-window

Download Templates

Templates are not included in this repository. The templates can be downloaded via the ANT interface (Menu: Extras/get templates from googledrive)
or manually from google-drive.


♦ For C57BL/6 mice we suggest to use the latest Atlas from the Allen Institute (Atlas-2017,CCFv3), in googledrive prepared as "mouse_Allen2017HikishimaLR".

  • the Atlas (70µm isotropic resolution) includes gray matter regions, fiber tracts and the ventricular system
      For more information see http://help.brain-map.org/display/mouseconnectivity/API
      Please visit also the online interactive atlas: http://atlas.brain-map.org/atlas#atlas=1

  • unzip the downloaded template(s) file
  • create a folder "anttemplates" located at the same hierarchical level as the antx2-folder (This is easier to obtain the respective template.)
  • copy/move unzipped template folder(s) to the "anttemplates" folder. If unzipping creates a nested folder within the unzipped folder, than copy/move this folder.
  • The "anttemplates"-folder should now contain a folder (such as "mouse_Allen2017HikishimaLR") with templates.
  Examplary tree if "mouse_Allen2017HikishimaLR" template is used:
           mydir (directory of your choice)
             |---antx2
             |---anttemplates
                      |---mouse_Allen2017HikishimaLR  
                                   |---AVGT.nii (file)  
                                   |---ANO.nii (file)  
                                   |      ...
                                   |---readme.txt (file)  
 

Users

Antx/Antx2 was created and is used in the Department of Experimental Neurology at the Charite© - University Medicine Berlin, Germany since 2015. If you use it and find it useful please give us a note.

Included software

This toolbox uses and included the following packages SPM, Elastix, MRIcron, PCNN3D, nii, findjobj cbrewer, screen capture, windowapi.

Note that the templates are not included in this repository and must be downloaded from google-drive. Please consult the respective 'readme.txt' file in each templated folder regarding data origin and citation policiy.

Please respect the licenses and copyright of these software packages.

ANTx2 also includes the pvmatlab package of Bruker BioSpin GmbH, which is intended for Bruker users only. Please respect the legal issues in the manual within the pvtools_bruker directory and request permission to use the package by Bruker's preclinical MRI software customer support before using ANTx2. Otherwise please delete the directory pvtools_bruker.

Citation policy

  • When using ANTx2 in publications please use the following citation:
          Koch et al. "Atlas registration for edema-corrected MRI lesion volume in mouse stroke models ", JCBFM, 2017.
  • When using the Allen mouse brain atlas please cite:
          Hübner et al. "The connectomics of brain demyelination: Functional and structural patterns in the cuprizone mouse model", NeuroImage, 2017, Volume 146, Pages 1-18.
          Lein et al. " Genome-wide atlas of gene expression in the adult mouse brain
    ", Nature, 2006, Volume 445, pages 168-176.

License

Copyright (C) 2019 Stefan Koch < [email protected]> and Philipp Boehm-Sturm < [email protected]> ANTx2 is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version. ANTx2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with ANTx2. For more information see http://www.gnu.org/licenses/old-licenses/gpl-2.0.

About

Registration of animal MR brain data to a standard (published) atlas. The pipeline works with invivo or exvivo (skull-stripped) MR-data for the following species: mouse, rat, Etruscan shrew and cat. *OS: Windows, MAC, Linux. *Matlab: R2016a or later.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • MATLAB 88.4%
  • C 5.8%
  • TeX 4.8%
  • HTML 0.5%
  • Roff 0.2%
  • M 0.1%
  • Other 0.2%