Skip to content
/ neu3d Public
forked from fruitflybrain/neu3d

A javascript 3D visualization engine for neural data in SWC format

Notifications You must be signed in to change notification settings

vivvyk/neu3d

 
 

Repository files navigation

Neu3D SWC visualization for fruitfly

Installation

npm install
npm run build

Test

Serve a HTML site from root of folder.

If using python3, in project root

python -m http.server

Usage

The module can be imported according to ES6 syntax as follows:

import { Neu3D } from 'neu3d';

Instantiate the visualization object by passing a HTMLDivElement with class vis-3d to it along with other optional configurations:

var ffbomesh = new Neu3D(
    parentDiv,  // parent div object with class `vis-3d`
    undefined,  // optionally add initalization JSON data
    { "globalCenter": { 'x': 0, 'y': -250, 'z': 0 } },  // optional metadata
    false);  // display stats panel on top left

window.ffbomesh = ffbomesh; // exposing to global namespace if desired

$.getJSON("./data/data.json", (json) => {
    ffbomesh.addJson({
        ffbo_json: json,
        showAfterLoadAll: true
    });
});

Consumption Example

  1. Global The class Neu3D is available if script is loaded as script tag. See index.html.
  2. ES6 See Usage section.
  3. TypeScript import Neu3D = require('neu3d');

Authors

This library is developed and maintained by:

Acknowledgements

A part of this library is inspired by the Sharkviewer project, developed at the Janelia Research Campus.

About

A javascript 3D visualization engine for neural data in SWC format

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 96.8%
  • CSS 2.1%
  • HTML 1.1%