NANSEN - Neuro Analysis Software Ensemble
NANSEN - Neuro ANalysis Software ENsemble
A collection of apps and modules for processing, analysis and visualization of two-photon imaging data. Check out the introduction to Nansen on YouTube and/or see the Wiki for more details.
Contents
Disclaimer
The NANSEN toolbox is still under development, so don't be surprised if you find occasional bugs here and there! If you manage to break something, please report under the issues section! Also, suggestions for improvements and general feedback are very welcome!
Installation
- Clone the repository and add all subfolders to MATLAB's search path.
- Make sure the required MATLAB toolboxes (listed below) are installed.
- Run
nansen.setup
to install community toolboxes and configure your first project. Alternative: To use nansen apps without creating a project, install the required community toolboxes (listed below). View demo ofnansen.setup
on YouTube.
Required Matlab toolboxes
- Image Processing Toolbox
- Statistics and Machine Learning Toolbox
- Parallel Computing Toolbox
To check if these toolboxes are already installed, use the ver
command.
Typing ver
in matlab's command window will display all installed toolboxes.
If any of the above toolboxes are not installed, they can be installed by
navigating to MATLAB's Home tab and then selecting Add-Ons > Get Add-Ons
Required community toolboxes
- Widgets Toolbox** (Download toolbox installer | View toolbox site)
** The Widgets Toolbox can also be installed using MATLAB's addon manager,
but it is important to install a compatibility version (v1.3.330) of the
toolbox, so please use the download link above or install using nansen.setup
.
Apps
Imviewer
App for viewing and interacting with videos & image stacks
Fovmanager
App for registering cranial implants, injection spots and imaging field of views (and RoIs) on an atlas of the dorsal surface of the cortex.
<themed-picture data-catalyst-inline="true"><picture> <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/17237719/197357426-248bc6e4-cbe4-4f80-9fae-3d54382edcd9.png"> <source media="(prefers-color-scheme: light)" srcset="https://camo.githubusercontent.com/83a9451f955c21e7cc07e43b4fce99f91822dc93607ef3e864b22a2793ebcc70/68747470733a2f2f6568656e6e65737461642e6769746875622e696f2f696d616765732f666f766d616e616765722e706e67" data-canonical-src="https://ehennestad.github.io/images/fovmanager.png"> <img alt="Fovmanager." src="https://camo.githubusercontent.com/83a9451f955c21e7cc07e43b4fce99f91822dc93607ef3e864b22a2793ebcc70/68747470733a2f2f6568656e6e65737461642e6769746875622e696f2f696d616765732f666f766d616e616765722e706e67" width="500" data-canonical-src="https://ehennestad.github.io/images/fovmanager.png"> </picture></themed-picture>Plugins
Example of toolbox plugins that are included in NANSEN
MATLAB Release Compatibility
Platform Compatibility
Windows macOS LinuxCategories
Tags
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!Discover Live Editor
Create scripts with code, output, and formatted text in a single executable document.
+nansen
+nansen/+app
+nansen/+app/+setup
+nansen/+common/+constant
+nansen/+common/+exception
+nansen/+config
+nansen/+config/+abstract
+nansen/+config/+addons
+nansen/+config/+addons/@AddonManager
+nansen/+config/+addons/@AddonManagerApp
+nansen/+config/+addons/@AddonManagerUI
+nansen/+config/+dloc
+nansen/+config/+dloc/@DataLocationModel
+nansen/+config/+dloc/@DataLocationModelApp
+nansen/+config/+dloc/@DataLocationModelUI
+nansen/+config/+dloc/@FolderOrganizationUI
+nansen/+config/+dloc/@FolderPathViewer
+nansen/+config/+dloc/@MetadataInitializationUI
+nansen/+config/+mixin
+nansen/+config/+module
+nansen/+config/+module/@ModuleManager
+nansen/+config/+module/@ModuleManagerApp
+nansen/+config/+module/@ModuleManagerUI
+nansen/+config/+path
+nansen/+config/+project
+nansen/+config/+project/+event
+nansen/+config/+project/@Preferences
+nansen/+config/+project/@Project
+nansen/+config/+project/@ProjectManager
+nansen/+config/+project/@ProjectManagerApp
+nansen/+config/+project/@ProjectManagerUI
+nansen/+config/+varmodel
+nansen/+config/+varmodel/+event
+nansen/+config/+varmodel/+template/+twophoton
+nansen/+dataio
+nansen/+dataio/+dataconvert/+roi
+nansen/+dataio/+dataconverter/+roi
+nansen/+dataio/+dataconverter/+roi/+adapter/@Caiman
+nansen/+dataio/+dataconverter/+roi/+adapter/@Extract
+nansen/+dataio/+dataconverter/+roi/+adapter/@Nansen
+nansen/+dataio/+dataconverter/+roi/+adapter/@Suite2p
+nansen/+dataio/+dataset
+nansen/+dataio/+dialog
+nansen/+dataio/+fileadapter
+nansen/+dataio/+fileadapter/+imagestack
+nansen/+dataio/+fileadapter/+internal
+nansen/+dataio/+fileadapter/+roi
+nansen/+dataio/+fileadapter/+timeseries
+nansen/+dataio/+metadata
+nansen/+dataio/+session
+nansen/+dataio/+session/deprecated
+nansen/+dataio/@DataIoModel
+nansen/+dataio/@DataSet
+nansen/+datatype/+roi
+nansen/+enum
+nansen/+external/+fex/+datautil
+nansen/+external/+fex/+sysutil
+nansen/+internal
+nansen/+internal/+dataio/+fileadapter
+nansen/+internal/+refactor
+nansen/+internal/+setup
+nansen/+internal/+system
+nansen/+internal/+user
+nansen/+internal/+user/@NansenUserSession
+nansen/+internal/+utility
+nansen/+manage
+nansen/+manage/+options
+nansen/+metadata
+nansen/+metadata/+abstract
+nansen/+metadata/+abstract/@BaseSchema
+nansen/+metadata/+abstract/@TableVariable
+nansen/+metadata/+schema/+dummy
+nansen/+metadata/+schema/+generic
+nansen/+metadata/+tablevar
+nansen/+metadata/+tablevar/+mixin
+nansen/+metadata/+temp
+nansen/+metadata/+type
+nansen/+metadata/+type/+animal
+nansen/+metadata/+utility
+nansen/+metadata/@MetaTable
+nansen/+metadata/@MetaTableCatalog
+nansen/+mixin
+nansen/+module
+nansen/+module/resources/module_folder_template/+nansen/+module/+category/+name
+nansen/+notes
+nansen/+pipeline
+nansen/+pipeline/@PipelineAssignmentModelApp
+nansen/+pipeline/@PipelineAssignmentModelUI
+nansen/+processing
+nansen/+processing/+image
+nansen/+processing/+mixin
+nansen/+processing/+roi
+nansen/+processing/+util
+nansen/+processing/@MotionCorrection
+nansen/+processing/@MotionCorrectionPreview
+nansen/+processing/@RoiSegmentation
+nansen/+processing/@SignalExtractor
+nansen/+session
+nansen/+session/+methods
+nansen/+session/+methods/+template
+nansen/+tools/+image/+registration
+nansen/+tools/+image/+resize
+nansen/+tools/+image/+transform
+nansen/+twophoton/+autosegmentation
+nansen/+twophoton/+autosegmentation/+able
+nansen/+twophoton/+autosegmentation/+cnmf
+nansen/+twophoton/+autosegmentation/+extract
+nansen/+twophoton/+autosegmentation/+extract/@Options
+nansen/+twophoton/+autosegmentation/+suite2p
+nansen/+twophoton/+autosegmentation/+suite2p/@Options
+nansen/+twophoton/+autosegmentation/+template
+nansen/+twophoton/+roi
+nansen/+twophoton/+roi/+compute
+nansen/+twophoton/+roi/+stats
+nansen/+twophoton/+roimasks
+nansen/+twophoton/+roisignals
+nansen/+twophoton/+roisignals/+analyze
+nansen/+twophoton/+roisignals/+extract
+nansen/+twophoton/+roisignals/+process/+deconvolve
+nansen/+twophoton/+roisignals/+process/+dff
+nansen/+ui
+nansen/+ui/+data
+nansen/+ui/+dialog
+nansen/+util
algorithms
algorithms/+flufinder
algorithms/+flufinder/+binarize
algorithms/+flufinder/+convert
algorithms/+flufinder/+detect
algorithms/+flufinder/+filter
algorithms/+flufinder/+longitudinal
algorithms/+flufinder/+module
algorithms/+flufinder/+preprocess
algorithms/+flufinder/+signals
algorithms/+flufinder/+utility
algorithms/+ophys/+twophoton
algorithms/+ophys/+twophoton/+analysis
algorithms/+ophys/+twophoton/+data
algorithms/+ophys/+twophoton/+plotting
algorithms/+stack
algorithms/+stack/+downsample
algorithms/+stack/+process/+compute
algorithms/+stack/+process/+filter2
algorithms/+stack/+process/+filter3
algorithms/+stack/+process/+framebin
algorithms/+stack/+reshape
algorithms/+stack/+transform
algorithms/+stack/+zproject
apps
apps/+fovmanager
apps/+fovmanager/+fileio
apps/+fovmanager/+mapobject
apps/+fovmanager/+utility
apps/+fovmanager/+utility/+atlas
apps/+fovmanager/+view
apps/+fovmanager/+widget
apps/+fovmanager/@App
apps/+imviewer/+export
apps/+imviewer/+plot
apps/+imviewer/+plugin/@FlowRegistration
apps/+imviewer/+plugin/@NoRMCorre
apps/+imviewer/+plugin/@RoiClassifier
apps/+imviewer/+plugin/@RoiManager
apps/+imviewer/+plugin/@RoiSignalVideo
apps/+imviewer/+tool
apps/+imviewer/+utility
apps/+imviewer/+widget
apps/+imviewer/@App
apps/+imviewer/@ImviewerPlugin
apps/+mclassifier
apps/+nansen
apps/+nansen/@App
apps/+nansen/@FileViewer
apps/+nansen/@MetaTableViewer
apps/+nansen/@Preferences
apps/+nansen/@TaskProcessor
apps/+roiclassifier
apps/+roiclassifier/@App
apps/+roisignalviewer/@App
apps/+signalviewer
apps/+signalviewer/+event
apps/+signalviewer/+plot
apps/+signalviewer/+pointerTool
apps/+signalviewer/+utility
apps/+signalviewer/@App
apps/+structeditor
apps/+structeditor/+eventdata
dashboards
dashboards/+roimanager
datatypes
datatypes/+nansen/+roisignals
datatypes/+nansen/+stack
datatypes/+nansen/+stack/+data
datatypes/+nansen/+stack/+data/+abstract
datatypes/+nansen/+stack/+metadata
datatypes/+nansen/+stack/+processor
datatypes/+nansen/+stack/+utility
datatypes/+nansen/+stack/+virtual
datatypes/+nansen/+stack/@Deinterleaver
datatypes/+nansen/+stack/@HighResolutionImage
datatypes/+nansen/+stack/@ImageStack
external
external/fileexchange
external/fileexchange/colormaps
external/fileexchange/colormaps/cbrewer/cbrewer
external/fileexchange/colormaps/matplotlib/colormaps
external/fileexchange/other
external/fileexchange/other/GetGoogleSpreadsheet
general
general/+tools
general/+utility
general/+utility/+cell
general/+utility/+class
general/+utility/+data
general/+utility/+data/+mixin
general/+utility/+dir
general/+utility/+io
general/+utility/+path
general/+utility/+string
general/+utility/+struct
general/+utility/+system
graphics
graphics/+applify
graphics/+applify/+menu
graphics/+applify/+mixin
graphics/+applify/+utility
graphics/+applify/+utility/+abstract
graphics/+applify/@uicontrolSchemer
graphics/+nansen/+theme
graphics/+uics
graphics/+uim
graphics/+uim/+abstract
graphics/+uim/+control
graphics/+uim/+decorator
graphics/+uim/+dialog
graphics/+uim/+event
graphics/+uim/+graphics
graphics/+uim/+illustration
graphics/+uim/+interface
graphics/+uim/+interface/+pointerTool
graphics/+uim/+interface/+pointerTool/+mixin
graphics/+uim/+mixin
graphics/+uim/+shape
graphics/+uim/+style
graphics/+uim/+utility
graphics/+uim/+utility/+layout
graphics/+uim/+widget
graphics/+uiw/+abstract
graphics/+uiw/+utility
graphics/+uiw/+widget
modules
modules/+nansen/+module/+general/+core/+fileadapter
modules/+nansen/+module/+general/+core/+sessionmethod/+data
modules/+nansen/+module/+general/+core/+sessionmethod/+data/+organize
modules/+nansen/+module/+general/+core/+tablevariable/+session
modules/+nansen/+module/+general/+core/+tablevariable/+session/deprecated
modules/+nansen/+module/+ophys/+macroscope
modules/+nansen/+module/+ophys/+macroscope/+fileadapter
modules/+nansen/+module/+ophys/+twophoton/+fileadapter
modules/+nansen/+module/+ophys/+twophoton/+sessionmethod/+data/+open
modules/+nansen/+module/+ophys/+twophoton/+sessionmethod/+data/+view
modules/+nansen/+module/+ophys/+twophoton/+sessionmethod/+plot
modules/+nansen/+module/+ophys/+twophoton/+sessionmethod/+process/+autoSegmentation
modules/+nansen/+module/+ophys/+twophoton/+sessionmethod/+process/+deconvolution
modules/+nansen/+module/+ophys/+twophoton/+sessionmethod/+process/+imageProcessing
modules/+nansen/+module/+ophys/+twophoton/+sessionmethod/+process/+motionCorrection
modules/+nansen/+module/+ophys/+twophoton/+sessionmethod/+process/+roiCuration
modules/+nansen/+module/+ophys/+twophoton/+sessionmethod/+process/+roiRegistration
modules/+nansen/+module/+ophys/+twophoton/+sessionmethod/+process/+signalExtraction
modules/+nansen/+module/+ophys/+twophoton/+utility
modules/+nansen/+module/+ophys/+twophoton/+utility/+mscan
modules/+nansen/+module/+ophys/+twophoton/+utility/+prairieview
modules/+nansen/+module/+ophys/+twophoton/+utility/+scanimage
modules/+nansen/+module/+ophys/+twophoton/+utility/+sciscan
modules/+nansen/+module/+ophys/+twophoton/+utility/+thorlabs
shortcuts/+nansen
tools
tools/+roimanager
tools/+roimanager/+autosegment
tools/+roimanager/+binarize
tools/+roimanager/+enum
tools/+roimanager/+eventdata
tools/+roimanager/+fileio
tools/+roimanager/+imtools
tools/+roimanager/+pointerTool
tools/+roimanager/+roitools
tools/+roimanager/+utilities
tools/+roimanager/resources/icons
wrappers
wrappers/+nansen/+plugin/+imviewer
wrappers/+nansen/+plugin/+signalviewer
wrappers/+nansen/+toolbox
wrappers/+nansen/+wrapper/+abstract
wrappers/+nansen/+wrapper/+extract
wrappers/+nansen/+wrapper/+extract/+util
wrappers/+nansen/+wrapper/+extract/@Options
wrappers/+nansen/+wrapper/+extract/@Processor
wrappers/+nansen/+wrapper/+extract/@ProcessorT
wrappers/+nansen/+wrapper/+flowreg
wrappers/+nansen/+wrapper/+flowreg/+presets
wrappers/+nansen/+wrapper/+flowreg/+utility
wrappers/+nansen/+wrapper/+flowreg/@Options
wrappers/+nansen/+wrapper/+flowreg/@Processor
wrappers/+nansen/+wrapper/+normcorre/+presets
wrappers/+nansen/+wrapper/+normcorre/+utility
wrappers/+nansen/+wrapper/+normcorre/@Options
wrappers/+nansen/+wrapper/+normcorre/@Processor
wrappers/+nansen/+wrapper/+quicky/+presets
wrappers/+nansen/+wrapper/+quicky/+utility
wrappers/+nansen/+wrapper/+quicky/@Options
wrappers/+nansen/+wrapper/+quicky/@Processor
wrappers/+nansen/+wrapper/+suite2p
wrappers/+nansen/+wrapper/+suite2p/+utility
wrappers/+nansen/+wrapper/+suite2p/@Options
wrappers/+nansen/+wrapper/+suite2p/@Processor
Version | Published | Release Notes | |
---|---|---|---|
0.9.0.1 | See release notes for this release on GitHub: https://github.com/VervaekeLab/NANSEN/releases/tag/v0.9.0.1 |
|