Skip to content

Latest commit

 

History

History
119 lines (80 loc) · 2.85 KB

README.md

File metadata and controls

119 lines (80 loc) · 2.85 KB
Raw

3D NIfTI Image Viewer

This project is a single-page React application that loads and visualizes 3D NIfTI images using the NIfTI-Reader-JS library.

Check it out Live

https://rednet09.github.io/3dslider/

Features

  • Upload a NIfTI file from your local machine.
  • Display the Axial Image of the 3D NIfTI file.
  • Navigate through the slices of the 3D image using a slider.

Requirements

  • Node.js
  • npm (Node package manager)

Getting Started

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/3dslider
cd 3dslider

  2. Install the necessary packages:

    npm install

  3. Install and configure Tailwind CSS:

    npm install -D tailwindcss postcss autoprefixer
npx tailwindcss init -p

  4. Configure tailwind.config.js:

    /** @type {import('tailwindcss').Config} */
module.exports = {
  content: ["./src/**/*.{js,jsx,ts,tsx}"],
  theme: {
    extend: {},
  },
  plugins: [],
};

  5. Add Tailwind CSS directives to src/index.css:

    @tailwind base;
@tailwind components;
@tailwind utilities;

  6. Import index.css in src/index.js:

    import "./index.css";

Running the Application

  1. Start the development server:

    npm run dev

  2. Open your web browser and go to http://localhost:5173.

Usage

  1. Click on the file upload button to select a NIfTI file from your local machine.
  2. Use the slider to navigate through the slices of the 3D image.
  3. The selected slice will be displayed on the canvas.

File Structure

  1. src/
  2. components/
  3. FileUpload.js # Component for handling file uploads
  4. ImageSlider.js # Component for the slider navigation
  5. ImageViewer.js # Component for displaying the NIfTI image slices
  6. App.js # Main component that manages state and handles file uploads
  7. index.js # Entry point of the React application
  8. index.css # Tailwind CSS configuration

Libraries Used

  • React - A JavaScript library for building user interfaces
  • NIfTI-Reader-JS - Library for reading NIfTI files
  • Tailwind CSS - Utility-first CSS framework for rapid UI development

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

  • This project utilizes the NIfTI-Reader-JS library for handling NIfTI files.
  • Thanks to the developers of React and Tailwind CSS for providing great tools for building this application.

Example NIfTI File

You can download an example NIfTI file to test the application from this link.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.