Skip to content

Latest commit

 

History

History
123 lines (95 loc) · 11.1 KB

README.md

File metadata and controls

123 lines (95 loc) · 11.1 KB
Raw

BRAVEHEART: Open-Source Software for Automated Electrocardiographic and Vectorcardiographic Analysis

badge badge badge
badge badge badge badge badge badge
badge badge

Hans Fredrich Stabenau, MD, PhD & Jonathan W. Waks, MD
Harvard-Thorndike Electrophysiology Institute, Department of Cardiovascular Medicine,
Beth Israel Deaconess Medical Center, Harvard Medical School, Boston, MA, USA
[email protected]

What is BRAVEHEART?

BRAVEHEART (Beth Israel Analysis of Vectors of the Heart) is a modular, customizable, open-source software package for processing electrocardiograms (ECGs) and vectorcardiograms (VCGs) for research purposes.
BRAVEHEART was built using MATLAB and requires a version after R2022a (http://www.mathworks.com) as well as the following toolboxes to run via source code:

  • Wavelet toolbox
  • Signal processing toolbox
  • Deep learning toolbox
  • Parallel computing toolbox (optional)

For users without access to MATLAB or all required toolboxes, we have also provided executables for Windows and Mac operating systems that can be run without needing MATLAB installed.

The most up to date version of the software can be found on GitHub at http://www.github.com/BIVectors/BRAVEHEART, where the software, source code, and executables for Windows and Mac are available under version 3 of the General Public License (GPL) (http://www.gnu.org/licenses/gpl-3.0.en.html).

License

badge
Copyright 2016-2024 Jonathan W. Waks and Hans F. Stabenau
All rights reserved.
This program 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 3 of the License, or (at your option) any later version. This program 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 this program. If not, see https://www.gnu.org/licenses/ or the LICENSE file included in this repository.

Installation & User Guide/Software Methods

badge
A detailed user guide that covers installation and use of the software, including a quick start guide and examples of ECG/VCG processing, is available in the file braveheart_userguide.pdf.

badge
A manuscript describing the software methods in detail is available in the file braveheart_methods.pdf and as a manuscript in Computer Methods and Programs in Biomedicine (DOI: https://doi.org/10.1016/j.cmpb.2023.107798).

Frequently Encountered Issue - GUI Not Displaying Correctly

If the GUI is not displaying completely first check that your monitor resolution is at least 1920 x 1080. If your monitor resolution is adequate but the GUI is still not fully displaying, your computer display settings likely have some form of scaling turned on; this setting increases the size of text to improve readability, but also effectively reduces the screen resolution. Instructions for how to disable this setting can be found below or in the user guide section 29.1:

To disable screen scaling:

  • Windows 10: Open the Ease of Access settings with Windows key + U. Under Make everything bigger on the Display tab, change to 100%.
  • Windows 11: Open Settings and then Display. Under Scale & layout, expand the Scale menu and change to 100%.
  • Mac OS: Open System Preferences and then Display. Choose Scaled Resolution and then More Space

Supported ECG Formats:

BRAVEHEART can read a wide variety of 12-lead ECG formats including:

  1. GE MUSE XML
  2. Philips XML
  3. HL7 XML
  4. DICOM
  5. ISHNE
  6. GE Marquette ASCII
  7. Cardiosoft XML
  8. Schiller XML
  9. SCP-ECG
  10. EDF
  11. Physionet .dat
  12. Physionet .csv
  13. GE Prucka
  14. Abbott Workmate Claris ASCII
  15. Unformatted .txt and .csv

If you need BRAVEHEART to read another ECG format let us know and we will help add it.

How to Cite Use of BRAVEHEART

Please include the link to this GitHub repository and cite our manuscript in Computer Methods and Programs in Biomedicine. The upper right section of this repository has a CITATION file that will provide the appropriate references which are also reproduced here:

Citation:
Hans F. Stabenau and Jonathan W. Waks. BRAVEHEART: Open-source software for automated electrocardiographic and vectorcardiographic analysis. Computer Methods and Programs in Biomedicine. Volume 242, Dec 2023, 107798. DOI: https://doi.org/10.1016/j.cmpb.2023.107798

Stabenau, HF and Waks, JW. BRAVEHEART: Open-source software for automated electrocardiographic and vectorcardiographic analysis. Comput Methods Programs Biomed. Volume 242, Dec 2023, 107798. DOI: https://doi.org/10.1016/j.cmpb.2023.107798

Bibtex:

@Article{BRAVEHEART,
   Author="Stabenau, H. F.  and Waks, J. W. ",
   Title="{{B}{R}{A}{V}{E}{H}{E}{A}{R}{T}: {O}pen-source software for automated electrocardiographic and vectorcardiographic analysis}",
   Journal="Comput Methods Programs Biomed",
   Year="2023",
   Volume="242",
   Pages="107798",
   Month="Dec",
   doi = {https://doi.org/10.1016/j.cmpb.2023.107798}
}

Publications

The software has been used for ECG/VCG analysis in the following publications:

  1. HF Stabenau, C Shen, LG Tereshchenko, and JW. Waks. Changes in global electrical heterogeneity associated with dofetilide, quinidine, ranolazine, and verapamil. Heart Rhythm, 2020 Mar;17(3):460-467.

  2. HF Stabenau, C Shen, P Zimetbaum, AE Buxton, LG Tereshchenko, and JW Waks. Global electrical heterogeneity associated with drug-induced torsades de pointes. Heart Rhythm, 2021 Jan;18(1):57-62.

  3. HF Stabenau, CP Bridge, and JW Waks. ECGAug: A novel method of generating augmented annotated electrocardiogram QRST complexes and rhythm strips. Comput Biol Med, 2021 Jul;134:104408.

  4. HF Stabenau, M Marcus, JD Matos, I McCormick, D Litmanovich, WJ Manning, BJ Carroll, and JW Waks. The spatial ventricular gradient is associated with adverse outcomes in acute pulmonary embolism. Ann Noninvasive Electrocardiol, 2023, Jan 24;e13041.

  5. AN Rosas Diaz, HF Stabenau, GP Hurtado, S Warack, JW Waks, and A Asnani. The spatial ventricular gradient is an independent predictor of anthracycline-associated cardiotoxicity. JACC: Adv, 2(2):100269, 2023.

  6. HF Stabenau, A Sau, DB Kramer, NS Peters, FS Ng, and JW Waks. Limits of the Spatial Ventricular Gradient and QRST Angles in Patients with Normal Electrocardiograms and No Known Cardiovascular Disease Stratified by Age, Sex, and Race. J Cardiovasc Electrophysiol, 2023 Nov;34(11):2305-2315.

  7. N Isaza, HF Stabenau, DB Kramer, A Sau, P Tung, TR Maher, AH Locke, P Zimetbaum, A d’Avila, NS Peters, LG Tereshchenko, FS Ng, AE Buxton, and JW Waks. The Spatial Ventricular Gradient is Associated with Inducibility of Ventricular Arrhythmias During Electrophysiology Study. Heart Rhythm, 2024 In Press.

  8. L Pastika, A Sau, K Patlatzoglou, E Sieliwonczyk, AH Ribeiro, KA McGurk, S Khan, D Mandic, WR Scott, JS Ware, NS Peters, ALP Ribeiro, DB Kramer, JW Waks, and FS Ng. Deep Neural Network-derived Electrocardiographic Body Mass Index as a Predictor of Cardiometabolic Disease. NPJ Digit. Med. 2024 Jun 25;7(1):167.

  9. A Sau, L Pastika, E Sieliwonczyk, K Patlatzoglou, AH Ribeiro, KA McGurk, B Zeidaabadi, H Zhang, K Macierzanka, D Mandic, E Sabino, L Giatti, SM Barreto, L do Valle Camelo, I Tzoulaki, DP O’Regan, NS Peters, JS Ware, ALP Ribeiro, DB Kramer, JW Waks, and FS Ng. Artificial Intelligence–Enabled Electrocardiogram for Mortality and Cardiovascular Risk Estimation: An Actionable, Explainable and Biologically Plausible Platform. Lancet Digit Health. 2024. In Press

  10. A Sau, AH Ribeiro, KA McGurk, L Pastika, N Bajaj, M Gurnani, E Sieliwonczyk, K Patlatzoglou, M Ardissino, JY Chen, H Wu, X Shi, K Hnatkova, S Zheng, A Britton, M Shipley, I Andršová, T Novotný, E Sabino, L Giatti, SM Barreto, JW Waks, DB Kramer, D Mandic, NS Peters, DP O’Regan, M Malik, JS Ware, ALP Ribeiro, and FS Ng. Neural Network-Derived Electrocardiographic Features have Prognostic Significance and Important Phenotypic and Genotypic Associations. Circ Cardiovasc Qual Outcomes. 2024. In Press

If you have used BRAVEHEART for your research project we would be happy to include a reference to your manuscript!

Contributing

Please contact the authors by email at [email protected] if you are interested in contributing to the project.