NaviNIBS.Navigator.TargetingCoordinator module

class NaviNIBS.Navigator.TargetingCoordinator.ProjectionSpecification(toOrientation, toDepth, toShape)

Bases: object

Specifiers to describe projection of an orientation down the depth axis to a target plane (or sphere)

Parameters:

• _toOrientation

• _toDepth

• _toShape

_toOrientation: str

_toDepth: str

_toShape: str

class NaviNIBS.Navigator.TargetingCoordinator.TargetingCoordinator(session, currentTargetKey=None, currentSampleKey=None, positionsClient=NOTHING, isOnTargetWhenDistErrorUnder=1, isOnTargetWhenZAngleErrorUnder=2.0, isOnTargetWhenHorizAngleErrorUnder=4.0, isOnTargetWhenZDistErrorBetween=(-8, 4.0), isOnTargetMinTime=0.5, isOffTargetWhenDistErrorExceeds=2.0, isOffTargetWhenZAngleErrorExceeds=4.0, isOffTargetWhenHorizAngleErrorExceeds=8.0, isOffTargetWhenZDistErrorExceeds=8.0, isOffTargetMinTime=0.1, doMonitorOnTarget=False, monitorOnTargetRate=5.0, onTargetMaybeChangedAtTime=None)

Bases: object

Parameters:

• _session

• _currentTargetKey

• _currentSampleKey

• _positionsClient

• _isOnTargetWhenDistErrorUnder

• _isOnTargetWhenZAngleErrorUnder

• _isOnTargetWhenHorizAngleErrorUnder

• _isOnTargetWhenZDistErrorBetween – in mm. Uses span to allow greater error in negative region (i.e. coil closer to head than planned).

• _isOnTargetMinTime

• _isOffTargetWhenDistErrorExceeds

• _isOffTargetWhenZAngleErrorExceeds

• _isOffTargetWhenHorizAngleErrorExceeds

• _isOffTargetWhenZDistErrorExceeds

• _isOffTargetMinTime

• _doMonitorOnTarget

• _monitorOnTargetRate

• _onTargetMaybeChangedAtTime

_session: Session

_currentTargetKey: str | None

_currentSampleKey: str | None

_positionsClient: ToolPositionsClient

sigIsOnTargetChanged: Signal

sigActiveCoilKeyChanged: Signal

sigCurrentTargetChanged: Signal

Emitted when a different target becomes current AND when an attribute of the current target changes.

sigCurrentSampleChanged: Signal

sigCurrentCoilPositionChanged: Signal

sigCurrentSubjectPositionChanged: Signal

property session

property positionsClient

property currentTargetKey

property currentTarget: Target | None

Return type:

Optional[Target]

property currentSampleKey

property currentSample: Sample | None

Return type:

Optional[Sample]

property currentPoseMetrics: PoseMetricCalculator

Return type:

PoseMetricCalculator

property currentSamplePoseMetrics: PoseMetricCalculator

Return type:

PoseMetricCalculator

property activeCoilTool

property activeCoilKey: str | None

Return type:

Optional[str]

property currentCoilToMRITransform: ndarray | None

Return type:

Optional[ndarray]

property doMonitorOnTarget

property isOnTarget

createTargetFromCurrentSample(doAddToSession=True)

Return type:

Target

createTargetFromCurrentPose(doAddToSession=True)

Return type:

Target

getTargetingCoord(orientation, depth)

Convenience function for getting a specific coordinate related to targeting orientations.

Abstracts some of the math needed for things like projecting the current coil orientation down the depth axis to plane of target.

May return None if we are currently missing pose information for a tracker, etc.

Return type:

Optional[ndarray]

classmethod getSingleton(session)

Get the singleton instance of the TargetingCoordinator for the given session.

Return type:

TargetingCoordinator