NaviNIBS.util.CoilOrientations module

class NaviNIBS.util.CoilOrientations.MetricSpecification(getter, units, label, doShowByDefault=True)

Bases: object

Parameters:

• getter (Callable[[], float])

• units (str)

• label (str)

• doShowByDefault (bool)

getter: Callable[[], float]

units: str

label: str

doShowByDefault: bool

class NaviNIBS.util.CoilOrientations.PoseMetricCalculator(session, sample)

Bases: object

Parameters:

• _session

• _sample

_session: <module 'NaviNIBS.Navigator.Model.Session' from 'C:\\Users\\chris\\OneDrive - Stanford\\RTNaBS\\NaviNIBS\\Navigator\\Model\\Session.py'>

_sample: Sample | None

sigCacheReset: Signal

Emitted whenever previously cached values are cleared, e.g. due to change in sample orientation, sample, or target.

getValueForMetric(label)

property supportedMetrics

property session

property sample

getTargetCoilToScalpDist(doUseCache=True)

Return type:

float

getTargetCoilToCortexDist(doUseCache=True)

Return type:

float

getSampleCoilToScalpDist(doUseCache=True)

Return type:

float

getSampleCoilToCortexDist(doUseCache=True)

Return type:

float

getTargetErrorInBrain(doUseCache=True)

Distance from target in brain to sample after projecting down to plane of cortical target.

Note: this determines depth of the target in the brain by finding closest point to the gm surf, so that we don’t need to assume that target.targetCoord is already at the cortical surface.

Return type:

float

getTargetErrorAtCoil(doUseCache=True)

Return type:

float

getTargetXErrorAtCoil(doUseCache=True)

Return type:

float

getTargetYErrorAtCoil(doUseCache=True)

Return type:

float

getDepthOffsetError(doUseCache=True)

Return type:

float

getDepthAngleError(doUseCache=True)

Return type:

float

getDepthTargetXAngleError(doUseCache=True)

Return type:

float

getDepthTargetYAngleError(doUseCache=True)

Return type:

float

getDepthCoilXAngleError(doUseCache=True)

Return type:

float

getDepthCoilYAngleError(doUseCache=True)

Return type:

float

getHorizAngleError(doUseCache=True)

Return type:

float

getAngleFromMidline(doUseCache=True)

Return type:

float

getAngleFromNormal(doUseCache=True)

Return type:

float

getCoilPosX(doUseCache=True)

Return type:

float

getCoilPosY(doUseCache=True)

Return type:

float

getCoilPosZ(doUseCache=True)

Return type:

float

getClosestPointToCoilOnSkin(doUseCache=True)

Return type:

Optional[ndarray]

getClosestPointToCoilOnGM(doUseCache=True)

Return type:

Optional[ndarray]

getClosestPointToSampleCortexDepthOnSkin(doUseCache=True)

Return type:

Optional[ndarray]

getNormalCoilXAngleError(doUseCache=True)

Return type:

float

getNormalCoilYAngleError(doUseCache=True)

Return type:

float