NaviNIBS.Navigator.Model.Targets module

class NaviNIBS.Navigator.Model.Targets.Target(key, targetCoord=None, entryCoord=None, angle=None, depthOffset=None, coilToMRITransf=None, isVisible=True, isHistorical=False, mayBeADependency=False, isSelected=False, color='#0000FF', session=None)

Bases: GenericCollectionDictItem[str]

Can specify (targetCoord, entryCoord, angle, [depthOffset]) to autogenerate coilToMRITransf, or (coilToMRITransf, [targetCoord]) to use transform directly.

Parameters:

• _key

• _targetCoord

• _entryCoord

• _angle – Typical coil handle angle, defined relative to “midline”

• _depthOffset – Offset beyond entryCoord, e.g. due to EEG electrode thickness, coil foam

• _coilToMRITransf – Uses convention where -y axis is along handle of typical coil and -z axis is pointing down into the head; origin is bottom face center of coil

• _isVisible – Whether currently visible in views that render subsets of targets

• _isHistorical – If True, will be hidden in almost all views, but may be referenced by samples (e.g. used when a target with associated samples is edited with a new orientation, but the associated samples should still be connected to the old version of the target)

• _mayBeADependency – Can be used to mark (e.g. when an associated sample is created) that this target is a dependency for other data elements, and a copy should be created and stored in history if this is edited

• _isSelected

• _color

• _session – Used to access head model for determining angle from coilToMRITransf and vice versa

_targetCoord: tp.Optional[np.ndarray]

_entryCoord: tp.Optional[np.ndarray]

_angle: tp.Optional[float]

Typical coil handle angle, defined relative to “midline”

_depthOffset: tp.Optional[float]

Offset beyond entryCoord, e.g. due to EEG electrode thickness, coil foam

_coilToMRITransf: tp.Optional[np.ndarray]

Uses convention where -y axis is along handle of typical coil and -z axis is pointing down into the head; origin is bottom face center of coil

_isVisible: bool

Whether currently visible in views that render subsets of targets

_isHistorical: bool

If True, will be hidden in almost all views, but may be referenced by samples (e.g. used when a target with associated samples is edited with a new orientation, but the associated samples should still be connected to the old version of the target)

_mayBeADependency: bool

Can be used to mark (e.g. when an associated sample is created) that this target is a dependency for other data elements, and a copy should be created and stored in history if this is edited

_isSelected: bool

_color: str

property targetCoord

property entryCoord

property angle

Angle from midline, in degrees.

Can be manually specified. If not specified, will be autocalculated based on coilToMRITransf (if available)

property calculatedAngle: float

Angle from midline (in degrees), calculated from coilToMRITransf (if available)

Return type:

float

property depthOffset: float

Return type:

float

property entryCoordPlusDepthOffset: ndarray | None

Return type:

Optional[ndarray]

property coilToMRITransf

property isVisible

property isHistorical

property mayBeADependency

property isSelected

property color

property session

autosetEntryCoord()

Note: this assumes the target coordinate is far inside the scalp (e.g. on cortical surface, not on the scalp itself)

asDict()

Return type:

Dict[str, Any]

classmethod fromDict(d, session=None)

class NaviNIBS.Navigator.Model.Targets.Targets(items=NOTHING, session=None)

Bases: GenericCollection[str, Target]

Parameters:

• _items

• _session – Used to access head model for determining angle from coilToMRITransf and vice versa

_session: Session | None

Used to access head model for determining angle from coilToMRITransf and vice versa

setWhichTargetsVisible(visibleKeys)

setWhichTargetsSelected(selectedKeys)

property session

classmethod fromList(itemList, session=None)

Return type:

Targets