NaviNIBS.Navigator.Model.HeadModel module¶

class NaviNIBS.Navigator.Model.HeadModel.HeadModel(filepath=None, skinSurfFilepath=None, gmSurfFilepath=None, meshToMRITransform=None)[source]¶

Bases: object

Parameters:

_filepath – Path to .msh file in simnibs folder. (note that .msh file and other nested files in same parent dir will be used)
_skinSurfFilepath – Path to skin surface mesh file, if not provided will be loaded from simnibs results folder.
_gmSurfFilepath – Path to gray matter surface mesh file, if not provided will be loaded from simnibs results folder.
_meshToMRITransform – “ Optional 4x4 transform matrix to convert mesh coordinates to MRI coordinates. Applied to all meshes when loading. Should not be needed in typical use cases.

_filepath: typing.Optional[str]¶: Path to .msh file in simnibs folder. (note that .msh file and other nested files in same parent dir will be used)

_skinSurfFilepath: typing.Optional[str]¶: Path to skin surface mesh file, if not provided will be loaded from simnibs results folder.

_gmSurfFilepath: typing.Optional[str]¶: Path to gray matter surface mesh file, if not provided will be loaded from simnibs results folder.

_meshToMRITransform: typing.Optional[numpy.ndarray]¶: ” Optional 4x4 transform matrix to convert mesh coordinates to MRI coordinates. Applied to all meshes when loading. Should not be needed in typical use cases.

sigFilepathChanged: NaviNIBS.util.Signaler.Signal¶: Emitted when main .msh or manually specified skin or gray matter surface mesh filepaths change.

sigDataChanged: NaviNIBS.util.Signaler.Signal¶: emits key which indicating what changed, e.g. which=’gmSurf’; if None all should be assumed to have changed

sigTransformChanged: NaviNIBS.util.Signaler.Signal¶

property skinSurfPath¶

property csfSurfPath¶

property gmSurfPath¶

property meshToMRITransform: ndarray | None¶

Return type:: Optional[ndarray]

loadCache(which)[source]¶

clearCache(which)[source]¶

property filepath¶

property skinSurfFilepath: str | None¶

Different than skinSurfPath, this is only not None if explicitly set.

Return type:: Optional[str]

property gmSurfFilepath: str | None¶

Different than gmSurfPath, this is only not None if explicitly set.

Return type:: Optional[str]

property isSet¶

property skinSurfIsSet¶

property gmSurfIsSet¶

property surfKeys¶

property gmSurf¶

property gmSimpleSurf¶: Simplified version of gmSurf mesh, for faster plotting.

property csfSurf¶

property skinSurf¶

property skinSimpleSurf¶: Simplified version of skinSurf mesh, for faster plotting.

property eegPositions¶

asDict(filepathRelTo)[source]¶

Return type:: Dict[str, Any]

classmethod fromDict(d, filepathRelTo)[source]¶

Return type:: HeadModel

classmethod validateFilepath(filepath, strict=False)[source]¶

Return type:: None