jLM.JupyterDisplay Namespace Reference

Classes
class	_Report
class	FileJupyterMixin
class	JupyterDisplayMixin

Functions
	_maybeJupyter (fn)
	_num (x, scale=1, unit=None)
	_numFmt (fmt, *nums)
	_maxEntropySlice (siteLattice, axis)
	_siteTypeImg (siteLattice, siteColors, axis0, axis1, axis2, planeIndex)
	_renderId ()
	_downloadFile (data, filename)
	_showRegionStack (lattice, htmlNames, siteColors, plane='xz', scl=None, maxWidth=600, maxHeight=600)
	_showBinaryLattices (binLattices, manualColor=None, filterFunctions=None, mode="widget")
	showVolumeStack (vol, plane='xz', cmap='inferno', scl=None, maxWidth=600, maxHeight=600)

Variables
	report = _Report()

Detailed Description

SpatialModel mixins for rich display in Jupyter

Function Documentation

_downloadFile()

jLM.JupyterDisplay._downloadFile ( data, filename )

protected

_maxEntropySlice()

jLM.JupyterDisplay._maxEntropySlice ( siteLattice, axis )

protected

_maybeJupyter()

jLM.JupyterDisplay._maybeJupyter ( fn )

protected

_num()

jLM.JupyterDisplay._num ( x, scale = 1, unit = None )

protected

_numFmt()

jLM.JupyterDisplay._numFmt ( fmt, * nums )

protected

_renderId()

jLM.JupyterDisplay._renderId ( )

protected

_showBinaryLattices()

jLM.JupyterDisplay._showBinaryLattices ( binLattices, manualColor = None, filterFunctions = None, mode = "widget" )

protected

_showRegionStack()

jLM.JupyterDisplay._showRegionStack ( lattice, htmlNames, siteColors, plane = 'xz', scl = None, maxWidth = 600, maxHeight = 600 )

protected

_siteTypeImg()

jLM.JupyterDisplay._siteTypeImg ( siteLattice, siteColors, axis0, axis1, axis2, planeIndex )

protected

showVolumeStack()

jLM.JupyterDisplay.showVolumeStack	(		vol,
			plane = 'xz',
			cmap = 'inferno',
			scl = None,
			maxWidth = 600,
			maxHeight = 600 )

Display slices volumetric data interactively

Args:
    vol (:py:class:`numpy.ndarray`):
        3-D data

Keyword Args:
    cmap (str):
        Name of matplotlib colormap
    plane (str):
        Viewing plane, e.g. "xy"
    scl (int):
        Scale pixels by this amount
    maxWidth (int):
        Maximum width of image
    maxHeight (int):
        Maximum height of image

Variable Documentation

report

jLM.JupyterDisplay.report = _Report()