NaviNIBS.util package

NaviNIBS.util.exceptionToStr(e)

Return type:

str

NaviNIBS.util.makeStrUnique(baseStr, existingStrs, delimiter='_')

Return type:

str

class NaviNIBS.util.classproperty(fget)

Bases: object

Adapted from https://stackoverflow.com/a/13624858

Subpackages

• NaviNIBS.util.GUI package
  • Submodules
    • NaviNIBS.util.GUI.Dock module
      • LabelScrollArea
      • AltTContainer
      • StackedWidget
      • TContainer
      • HContainer
      • VContainer
      • DockLabel
      • DockDrop
      • Dock
      • DockArea
    • NaviNIBS.util.GUI.ErrorDialog module
      • raiseErrorDialog()
      • asyncTryAndRaiseDialogOnError()
    • NaviNIBS.util.GUI.IconWidget module
      • IconWidget
    • NaviNIBS.util.GUI.Icons module
      • getIcon()
      • DynamicColorIconicFont
      • DynamicColorCharIconPainter
    • NaviNIBS.util.GUI.QAppWithAsyncioLoop module
      • RunnableAsApp
      • TestGUI
    • NaviNIBS.util.GUI.QCollapsibleSection module
      • QCollapsibleSection
    • NaviNIBS.util.GUI.QDial module
      • AngleDial
    • NaviNIBS.util.GUI.QFileSelectWidget module
      • QFileSelectWidget
    • NaviNIBS.util.GUI.QFlowLayout module
      • QFlowLayout
    • NaviNIBS.util.GUI.QLineEdit module
      • QLineEditWithValidationFeedback
    • NaviNIBS.util.GUI.QMouseWheelAdjustmentGuard module
      • preventAnnoyingScrollBehaviour()
    • NaviNIBS.util.GUI.QScrollContainer module
      • VerticalScrollArea
      • QScrollContainer
    • NaviNIBS.util.GUI.QTableWidgetDragRows module
      • QTableWidgetDragRows
    • NaviNIBS.util.GUI.QValidators module
      • TransformValidator
      • OptionalTransformValidator
    • NaviNIBS.util.GUI.QWidgetWithCloseSignal module
      • QWidgetWithCloseSignal
      • QMainWindowWithCloseSignal
    • NaviNIBS.util.GUI.QueuedRedrawMixin module
      • QueuedRedrawMixin
    • NaviNIBS.util.GUI.StyleSheets module
      • setStyleSheetForInstanceOnly()
• NaviNIBS.util.lsl package
  • getDTypeFromStreamInfo()
  • getKeyForStreamInfo()
  • getEquivalentKeysForStreamInfo()
  • inferStreamKey()
  • Submodules
    • NaviNIBS.util.lsl.LSLStreamResolver module
      • LSLStreamResolver
      • ThreadedLSLStreamResolver
    • NaviNIBS.util.lsl.LSLStreamSelector module
      • LSLStreamSelector
• NaviNIBS.util.pyvista package
  • setActorUserTransform()
  • getActorUserTransform()
  • concatenateLineSegments()
  • Subpackages
    • NaviNIBS.util.pyvista.RemotePlotting package
      • ActorRef
      • Submodules
  • Submodules
    • NaviNIBS.util.pyvista.PlotInteraction module
      • set_mouse_event_for_picking()
      • pickActor()
      • interactivelyMoveActor()
    • NaviNIBS.util.pyvista.dataset module
      • find_closest_point()
    • NaviNIBS.util.pyvista.plotting module
      • PlotterImprovementsMixin
      • BackgroundPlotter
      • SecondaryLayeredPlotter
      • CustomRenderWindowInteractor
      • PrimaryLayeredPlotter
    • NaviNIBS.util.pyvista.ticks module
      • getNiceTicksForRange()

Submodules

• NaviNIBS.util.AsyncRunner module
  • asyncioRunAndHandleExceptions()
• NaviNIBS.util.Asyncio module
  • asyncWait()
  • asyncWaitWithCancel()
  • asyncTryAndLogExceptionOnError()
  • asyncAtomicCancellable()
  • asyncNonCancellable()
• NaviNIBS.util.CoilOrientations module
  • MetricSpecification
    • MetricSpecification.getter
    • MetricSpecification.units
    • MetricSpecification.label
    • MetricSpecification.doShowByDefault
  • PoseMetricCalculator
    • PoseMetricCalculator._session
    • PoseMetricCalculator._sample
    • PoseMetricCalculator.sigCacheReset
    • PoseMetricCalculator.getValueForMetric()
    • PoseMetricCalculator.supportedMetrics
    • PoseMetricCalculator.session
    • PoseMetricCalculator.sample
    • PoseMetricCalculator.getTargetCoilToScalpDist()
    • PoseMetricCalculator.getTargetCoilToCortexDist()
    • PoseMetricCalculator.getSampleCoilToScalpDist()
    • PoseMetricCalculator.getSampleCoilToCortexDist()
    • PoseMetricCalculator.getTargetErrorInBrain()
    • PoseMetricCalculator.getTargetErrorAtCoil()
    • PoseMetricCalculator.getTargetXErrorAtCoil()
    • PoseMetricCalculator.getTargetYErrorAtCoil()
    • PoseMetricCalculator.getDepthOffsetError()
    • PoseMetricCalculator.getDepthAngleError()
    • PoseMetricCalculator.getDepthTargetXAngleError()
    • PoseMetricCalculator.getDepthTargetYAngleError()
    • PoseMetricCalculator.getDepthCoilXAngleError()
    • PoseMetricCalculator.getDepthCoilYAngleError()
    • PoseMetricCalculator.getHorizAngleError()
    • PoseMetricCalculator.getAngleFromMidline()
    • PoseMetricCalculator.getAngleFromNormal()
    • PoseMetricCalculator.getCoilPosX()
    • PoseMetricCalculator.getCoilPosY()
    • PoseMetricCalculator.getCoilPosZ()
    • PoseMetricCalculator.getClosestPointToCoilOnSkin()
    • PoseMetricCalculator.getClosestPointToCoilOnGM()
    • PoseMetricCalculator.getClosestPointToSampleCortexDepthOnSkin()
    • PoseMetricCalculator.getNormalCoilXAngleError()
    • PoseMetricCalculator.getNormalCoilYAngleError()
• NaviNIBS.util.Transforms module
  • composeTransform()
  • decomposeTransform()
  • applyTransform()
  • applyDirectionTransform()
  • concatenateTransforms()
  • invertTransform()
  • transformToString()
  • stringToTransform()
  • calculateRotationMatrixFromTwoVectors()
  • calculateRotationMatrixFromVectorToVector()
  • estimateAligningTransform()
• NaviNIBS.util.ZMQAsyncioFix module
• NaviNIBS.util.ZMQConnector module
  • InvalidMessageError
  • ZMQConnectorServer
    • ZMQConnectorServer.close()
    • ZMQConnectorServer.publish()
  • RemoteError
  • ZMQConnectorClient
    • ZMQConnectorClient.onMessagePublished
    • ZMQConnectorClient.connAddr
    • ZMQConnectorClient.close()
    • ZMQConnectorClient.send_async()
    • ZMQConnectorClient.send()
    • ZMQConnectorClient.get_async()
    • ZMQConnectorClient.get()
    • ZMQConnectorClient.set_async()
    • ZMQConnectorClient.set()
    • ZMQConnectorClient.call_async()
    • ZMQConnectorClient.call()
    • ZMQConnectorClient.callAsync_async()
    • ZMQConnectorClient.callAsync()
    • ZMQConnectorClient.ping_async()
    • ZMQConnectorClient.ping()
  • checkIfPortAvailable()
  • getNewPort()
  • Test_ZMQConnector
    • Test_ZMQConnector.state
      • Test_ZMQConnector.state.a
      • Test_ZMQConnector.state.b
      • Test_ZMQConnector.state.c
      • Test_ZMQConnector.state.respondAfterDelay()
    • Test_ZMQConnector.test_large_async()
    • Test_ZMQConnector.test_large_sync()
    • Test_ZMQConnector.test_basic_async()
    • Test_ZMQConnector.test_basic_sync()
    • Test_ZMQConnector.test_overlapping_async()
• NaviNIBS.util.attrs module
  • attrsAsDict()
• NaviNIBS.util.json module
  • beautifyJSON()
  • jsonPrettyDumps()
• NaviNIBS.util.logging module
  • getLogFilepath()
  • createLogFileHandler()
• NaviNIBS.util.numpy module
  • array_equalish()
  • attrsOptionalNDArrayField()
  • attrsWithNumpyAsDict()
  • attrsWithNumpyFromDict()
• NaviNIBS.util.test_attrs module
  • ExampleClass
    • ExampleClass.aStr
    • ExampleClass.anOptionalStr
    • ExampleClass.anOptionalArray
    • ExampleClass._aPrivateOptionalArray
    • ExampleClass._aPrivateInt
  • objA()
  • objB()
  • test_equality()
  • test_asdict()