API reference#

Information on specific functions, classes, and methods.

Modules

brainrender.cameras

Pre-defined camera parameter dictionaries for brainrender scenes.

brainrender.camera

Camera utilities for brainrender scenes.

brainrender.video

VideoMaker and Animation classes for rendering brainrender scenes to video.

brainrender.actor

Actor class and label utilities for brainrender scenes.

brainrender.render

Scene rendering backend for brainrender.

brainrender.atlas

Atlas subclass adding region and plane Actor support for scenes.

brainrender.scene

Scene class for adding, removing, and slicing actors and brain regions in brainrender.

brainrender.settings

brainrender.actors.streamlines

Create actors for rendering axonal projection streamlines.

brainrender.actors.points

Point and point-cloud actors for brainrender scenes.

brainrender.actors.ruler

Create a ruler showing the distance between two points.

brainrender.actors.line

Line actor for brainrender scenes.

brainrender.actors.neurons

Neuron morphology actors for brainrender scenes.

brainrender.actors.volume

Volume actor for rendering 3D numpy arrays as surfaces or volumes.

brainrender.actors.cylinder

Cylinder actor for brainrender scenes.

brainrender.atlas_specific.allen_brain_atlas.streamlines

Utilities for downloading and processing streamlines aligned to the Allen Mouse Brain Atlas.

brainrender.atlas_specific.allen_brain_atlas.gene_expression.api

API client for downloading Allen Brain Atlas gene expression data.

brainrender.atlas_specific.allen_brain_atlas.gene_expression.ge_utils

Utilities for caching and loading Allen Brain Atlas gene expression data.