Skip to content

dvisionlab/Larvitar

Repository files navigation

Larvitar Logo

Larvitar

License type-coverage Last Commit GitHub stars

Larvitar is a modern, lightweight TypeScript library for medical imaging applications. Built on top of the Cornerstone ecosystem, Larvitar provides tools for rendering, analyzing, and interacting with medical images, including support for advanced modalities like multiframe images, NRRD, and ECG synchronization.

🛠 Current Version

Build Status GitHub release npm

Check out the releases page for more details.

🚀 Features

  • Advanced DICOM Image Rendering: Seamlessly handles single-frame, multiframe, and custom modalities.
  • ECG and Waveform Visualization: Built-in tools for synchronizing and rendering waveforms.
  • Custom Tools and Extensions: Easily extendable for specific imaging needs.
  • Integration Ready: Designed for use in advanced imaging workflows and applications.

📖 Documentation

Comprehensive documentation is available on the Larvitar Documentation Page.

Sections

  1. Core API: Learn how to parse, load, and render DICOM images.
  2. Modules: Explore the segmentation tools, color maps, and advanced rendering features.
  3. Examples: See working examples for ECG synchronization, NRRD image loading, segmentation tools, and more.
  4. Installation: Step-by-step guide to getting started with Larvitar in your project.

📦 Dependencies

Larvitar relies on the following libraries for its core functionality:

Make sure to have these dependencies installed when developing or using Larvitar.


🛠 Development

To start developing Larvitar or contribute to the project:

  1. Clone the repository:
    git clone https://github.com/dvisionlab/Larvitar.git
    cd Larvitar
  2. Install dependencies:
     yarn install
  3. Start the development server:
    yarn run dev
  4. Open the development environment:
    • Serve the examples folder using a static server (e.g., http-server or visual studio code live server).
    • Navigate to http://localhost:5500/docs/examples/<example_name>.html (or the port configured in your dev server).

📝 License

Larvitar is licensed under the MIT License. Feel free to use, modify, and distribute it in your projects.

🤝 Contributing

Contributions are welcome! If you’d like to report a bug, suggest a feature, or submit a pull request, please follow our contributing guidelines.

Larvitar has adopted a Code of Conduct that we expect project participants to adhere to.

👨‍💻 Main Developers

D/Vision Lab Logo