iblviewer.launcher

Functions

main

str2bool

Classes

IBLViewer

str2bool(v)[source]
class IBLViewer[source]

Bases: object

parse_args(parser=None)[source]

Standard argument parser for iblviewer. Make sure you do not use the below argument shortcuts: -s, -t, -ui, -r, -m, -d, -atlas, -dwi, -cm, -nc, -na

Parameters

parser – An existing ArgumentParser that will be updated with standard arguments. If None, a new one is created (default).

Returns

ArgumentParser

launch(callable=None, stats_callable=None, args=None, jupyter=False, neuroscience=True, **kwargs)[source]

Start the 3D viewer according to parameters given in the console

Parameters
  • callable – Function that will be called when the 3D viewer is initialized

  • stats_callable – Function that will be called when statistics are updated, when a selection or sub selection changes in the 3D viewer. Available when you use the Qt UI only.

  • args – Any existing ArgumentParser. If None, a new IBL standard one is created.

  • jupyter – Whether you launch the viewer within a jupyter notebook or lab

  • neuroscience – Whether the viewer in jupyter is started in neuroscience mode or not

  • kwargs – All further keyword arguments set to viewer.initialize() method (for jupyter mode)

Returns

Either a qt_application.ViewerApp (if Qt) or a viewer instance (mouse_brain.MouseBrainViewer or application.)

main(auto_close_viewer=True)[source]