augmenta

AugmentA: Patient-specific Augmented Atrial model Generation Tool

https://github.com/kit-ibt/augmenta

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

AugmentA: Patient-specific Augmented Atrial model Generation Tool

Basic Info
  • Host: GitHub
  • Owner: KIT-IBT
  • License: other
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 47.1 MB
Statistics
  • Stars: 10
  • Watchers: 5
  • Forks: 3
  • Open Issues: 2
  • Releases: 1
Created over 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

AugmentA: Patient-specific Augmented Atrial model Generation Tool

We propose a patient-specific Augmented Atrial model Generation Tool (AugmentA) as a highly automated framework which, starting from clinical geometrical data, provides ready-to-use atrial personalized computational models. AugmentA consists firstly of a pre-processing step applied to the input geometry. Secondly, the atrial orifices are identified and labelled using only one reference point per atrium. If the workflow includes fitting a statistical shape model (SSM) to the input geometry, this is first rigidly aligned with the given mean shape and finally a non-rigid fitting procedure is applied. AugmentA automatically generates the fiber orientation using a Laplace-Dirichlet-Rule-based-Method.

Pipeline

Files and Folders

  • main.py: AugmentA's main script
  • mesh/: contains the exemplary mesh and the statistical shape model
  • standalones/: standalone tools used in the pipeline
  • template/: template for non-rigid fitting process
  • Atrial_LDRBM/: Laplace-Dirichlet-Rule-based-Method to annotate anatomical regions and generate atrial fiber orientation in the atria

Setup

Create a python virtual environment to install AugmentA dependencies: python -m venv ~/myEnv source ~/myEnv/bin/activate pip install -r requirements.txt

Go to the carputils folder and re-install carputils' requirements (assuming that carputils was installed in the home folder): cd ~/carputils pip install -r requirements.txt

Usage

Remember to source to myEnv before using the pipeline: source ~/myEnv/bin/activate Show all options: python main.py --help Example using an MRI segmentation to produce a bilayer atrial model: python main.py --mesh mesh/LA_MRI.vtp --closed_surface 0 --use_curvature_to_open 1 --atrium LA --open_orifices 1 --MRI 1 Example opening the atrial orifices using the surface curvature to identify the veins of a closed geometry, it expects the valve region to be tagged on the atrial surface with a value > 0.5 (see the scalar "valve" in mesh/LAEAM.vtp): ``` python main.py --mesh mesh/LAEAM.vtp --openorifices 1 --MRI 0 Example manually opening the atrial orifices of a closed geometry: python main.py --mesh mesh/LAEAM.vtp --openorifices 1 --MRI 0 --usecurvaturetoopen 0 Example using a closed surface derived from a MRI segmentation to produce a volumetric atrial model: python main.py --mesh mesh/mwk05bi.vtp --closedsurface 1 --usecurvaturetoopen 0 --atrium LARA ```

Q&A

  • Selection of appendage apex: the selected point will be used as boundary condition for a Laplacian problem. Therefore, the point at the center of the appendage is the most suitable to identify the whole appendage body
  • FiberLA: LAA labeling (check LPVs identification functions distinguishPvs and optimizePVs in lagenerate_fiber.py)
  • FiberRA: PMs (check step in function Method.downsamplepath in rageneratefiber.py), bridges (boolean operations and normal directions of original mesh)

Citation

When using this work, please cite

AugmentA: Patient-specific Augmented Atrial model Generation Tool Computerized Medical Imaging and Graphics 2023;108:102265 Luca Azzolin, Martin Eichenlaub, Claudia Nagel, Deborah Nairn, Jorge Sánchez, Laura Unger, Olaf Dössel, Amir Jadidi, Axel Loewe doi:10.1016/j.compmedimag.2023.102265

License

All source code is subject to the terms of the Academic Public License. Copyright 2021 Luca Azzolin, Karlsruhe Institute of Technology.

Contact

Luca Azzolin
Institute of Biomedical Engineering
Karlsruhe Institute of Technology
www.ibt.kit.edu

Owner

  • Name: KIT-IBT
  • Login: KIT-IBT
  • Kind: organization
  • Email: publications@ibt.kit.edu

Institute of Biomedical Engineering (IBT) at Karlsruhe Institute of Technology (KIT)

Citation (CITATION.cff)

cff-version: 1.2.0
title: "AugmentA: Patient-specific Augmented Atrial model Generation Tool"
message: "Please cite this software using the metadata from 'preferred-citation'."
type: software
authors:
  - given-names: Luca
    family-names: Azzolin
    email: luca.azzolin@kit.edu
    affiliation: Karlsruhe Institute of Technology (KIT)
    orcid: https://orcid.org/0000-0002-2919-4617
  - given-names: Axel
    family-names: Loewe
    email: axel.loewe@kit.edu
    affiliation: Karlsruhe Institute of Technology (KIT)
    orcid: https://orcid.org/0000-0002-2487-4744
license: APL-1.0
identifiers:
  - description: "Description of AugmentA"
    type: doi
    value: 10.1101/2022.02.13.22270835
repository-code: https://github.com/KIT-IBT/AugmentA
preferred-citation:
  type: article
  title: "AugmentA: Patient-specific Augmented Atrial model Generation Tool" 
  authors:
    - family-names: Azzolin
      given-names: Luca
    - family-names: Eichenlaub
      given-names: Martin
    - family-names: Nagel
      given-names: Claudia
    - family-names: Nairn
      given-names: Deborah
    - family-names: Sánchez
      given-names: Jorge
    - family-names: Unger
      given-names: Laura
    - family-names: Dössel
      given-names: Olaf 
    - family-names: Jadidi
      given-names: Amir
    - family-names: Loewe
      given-names: Axel
  doi: 10.1016/j.compmedimag.2023.102265
  journal: "Computerized Medical Imaging and Graphics"
  year: 2023
  volume: 108
  start: 102265

GitHub Events

Total
  • Watch event: 5
  • Delete event: 2
  • Member event: 1
  • Push event: 6
  • Pull request event: 3
  • Create event: 3
Last Year
  • Watch event: 5
  • Delete event: 2
  • Member event: 1
  • Push event: 6
  • Pull request event: 3
  • Create event: 3

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 minutes
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • aashildte (1)
  • kubagrzelak (1)
Pull Request Authors
  • Pascal2000 (2)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

requirements.txt pypi
  • h5py ==3.7.0
  • meshio ==5.3.4
  • pandas ==1.5.2
  • pymeshfix ==0.16.1
  • pymeshlab ==2022.2.post2
  • transformations ==2022.9.26