threeBrain1.2.0 package

Your Advanced 3D Brain Visualization

AbstractGeom

R6 Class - Abstract Class of Geometries

BlankGeom

A geometry that renders nothing

brain_proxy

Shiny Proxy for Viewer

brain_setup

Setup Package, Install Environment

calculate_rotation

Calculate rotation matrix from non-zero vectors

check_freesurfer_path

Function to check whether FreeSurfer folder has everything we need

conform_volume

Conform imaging data in 'FreeSurfer' way

create_group

Create a geometry group containing multiple geometries

cross_prod

Calculate cross-product of two vectors in '3D'

DataCubeGeom

R6 Class - Generate Data Cube Geometry

DataCubeGeom2

R6 Class - Generate Data Cube Geometry via 3D Volume Texture

default_template_directory

Default Directory to Store Template Brain

FreeGeom

R6 Class - Generate Geometry from Vertices and Face Indices

freesurfer_brain

Read FreeSurfer surface and volume files

freesurfer_lut

Query the 'FreeSurfer' labels

generate_smooth_envelope

Generate smooth envelope around surface

generate_subcortical_surface

Approximate 'sub-cortical' surfaces from 'parcellation'

geom_freemesh

Creates any mesh geometry given vertices and face indices

geom_sphere

Create sphere geometry

GeomGroup

R6 Class - Generate Group of Geometries

get_digest_header

Function to read digest header

get_ijk2ras

Get 'voxel' to world matrix

import_from_freesurfer

Import from FreeSurfer and create JSON cache for 3D viewer

import-fs-suma

Import 'FreeSurfer' or 'SUMA' files into the viewer structure

LineSegmentsGeom

R6 Class - Generate Line Segments

list_electrode_prototypes

List or load all electrode prototypes

localization_module

Launch a 'shiny' application to localize electrodes

merge_brain

Create Multi-subject Template

new_electrode_prototype

Create or load new electrode prototype from existing configurations

plot_slices

Plot slices of volume

read_fs_asc

Read FreeSurfer ascii file

read_fs_labels

Read FreeSurfer Annotations

read_fs_m3z

Read FreeSurfer m3z file

read_fs_mgh_mgz

Read FreeSurfer mgz/mgh file

read_gii2

Function to load surface data from Gifti files

read_mgz

Function to load FreeSurfer mgz/mgh file

read_volume

Read volume file in 'MGH' or 'Nifti' formats

reexports

Objects exported from other packages

renderBrain

Shiny Renderer for threeBrain Widgets

reorient_volume

Function to reshape data to RAS order

save_brain

Save threeBrain widgets to local file system

seeg_prototype

Create 'sEEG' shaft geometry prototype

SphereGeom

R6 Class - Generate Sphere Geometry

SpriteGeom

R6 Class - Generate Sphere Geometry

template_subject

Download and Manage Template Subjects

threeBrain

Create a brain object

threejs_brain

Create a Threejs Brain and View it in Browsers

threejsBrainOutput

Shiny Output for threeBrain Widgets

TubeGeom

R6 Class - Generate Tube Geometry

video_content

Add video content to the viewer

volume_to_surf

Generate surface file from 'nii' or 'mgz' volume files

voxel_colormap

Color maps for volume or surface data

voxel_cube

Generate volume data from 'MNI' coordinates

A fast, interactive cross-platform, and easy to share 'WebGL'-based 3D brain viewer that visualizes 'FreeSurfer' and/or 'AFNI/SUMA' surfaces. The viewer widget can be either standalone or embedded into 'R-shiny' applications. The standalone version only require a web browser with 'WebGL2' support (for example, 'Chrome', 'Firefox', 'Safari'), and can be inserted into any websites. The 'R-shiny' support allows the 3D viewer to be dynamically generated from reactive user inputs. Please check the publication by Wang, Magnotti, Zhang, and Beauchamp (2023, <doi:10.1523/ENEURO.0328-23.2023>) for electrode localization. This viewer has been fully adopted by 'RAVE' <https://openwetware.org/wiki/RAVE>, an interactive toolbox to analyze 'iEEG' data by Magnotti, Wang, and Beauchamp (2020, <doi:10.1016/j.neuroimage.2020.117341>). Please check 'citation("threeBrain")' for details.

  • Maintainer: Zhengjia Wang
  • License: MPL-2.0
  • Last published: 2024-11-07