NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.ViewLayers.SampleMetadataOrientationsLayer module

class NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.ViewLayers.SampleMetadataOrientationsLayer.SampleMetadataOrientationsLayer(*, key, coordinator, plotter, plotInSpace='MRI', opacity=0.5, lineWidth=3.0, style='lines', metadataKey, colorbarLabel=None, metadataScaleFactor=1.0, colorDepthIndicator=None, colorHandleIndicator=None, colorDepthIndicatorSelected=None, colorHandleIndicatorSelected=None)

Bases: SampleOrientationsLayer

Parameters:

• _key

• _coordinator

• _plotter

• _plotInSpace

• _opacity

• _lineWidth

• _style

• _metadataKey – Which value in sample metadata to plot

• _colorbarLabel

• _metadataScaleFactor

• _colorDepthIndicator

• _colorHandleIndicator

• _colorDepthIndicatorSelected

• _colorHandleIndicatorSelected

_metadataKey: str

Which value in sample metadata to plot

_colorbarLabel: str | None

_metadataScaleFactor: float

class NaviNIBS.Navigator.GUI.ViewPanels.NavigatePanel.ViewLayers.SampleMetadataOrientationsLayer.SampleMetadataInterpolatedSurfaceLayer(*, key, coordinator, plotter, plotInSpace='MRI', color='#d9a5b2', surfKey='gmSimpleSurf', opacity=1.0, metadataKey, colorbarLabel=None, scalarAnnotations=None, relevantSampleDepth='target', kernelSharpness=0.5, kernelRadius=5.0, scalarsKey='SampleMetadataInterpolated', scalarsOpacityKey=None, meshOpacityOutsideInterpolatedRegion=1.0, reinterpolationRateLimit=10)

Bases: HeadMeshSurfaceLayer

Parameters:

• _key

• _coordinator

• _plotter

• _plotInSpace

• _color

• _surfKey

• _opacity

• _metadataKey – Which value in sample metadata to plot

• _colorbarLabel

• _scalarAnnotations – In form accepted by pyvista.mapper.set_scalars(…, annotations=…). E.g. {50e-6: ‘50 uV’, 1e-3: ‘1 mV’}

• _relevantSampleDepth – Which depth along sample entry vector to use for interpolation on surface. If interpolating onto cortical surface, probably want to use skin depth. If interpolating onto skin surface, probably want to use entry or coil depth. Or for any smooth-ish surface, can use “intersection” to autoset depth based on intersection with plotted surface.

• _kernelSharpness

• _kernelRadius

• _scalarsKey – Where to save interpolated values within internal mesh object

• _scalarsOpacityKey

• _meshOpacityOutsideInterpolatedRegion

• _reinterpolationRateLimit

_metadataKey: str

Which value in sample metadata to plot

_colorbarLabel: str | None

_scalarAnnotations: dict[float, str] | None

In form accepted by pyvista.mapper.set_scalars(…, annotations=…). E.g.

{50e-6: ‘50 uV’, 1e-3: ‘1 mV’}

_relevantSampleDepth: str

Which depth along sample entry vector to use for interpolation on surface. If interpolating onto cortical surface, probably want to use skin depth. If interpolating onto skin surface, probably want to use entry or coil depth. Or for any smooth-ish surface, can use “intersection” to autoset depth based on intersection with plotted surface.

_kernelSharpness: float

_kernelRadius: float