Skip to content

← source_localization package

ProjectOntoMesh

Projects each position on the space axis onto its nearest vertex on the mesh for the given headmodel.

Note that the headmodel mesh is coregistered into native Neuropype space before projecting. Version 0.9.0

Ports/Properties

data

Data to process.

verbose name
Data
default value
None
port type
DataPort
value type
Packet (can be None)
data direction
INOUT

headmodel

Head model file to use (.h m or .mshs). If omitted, the node checks if the data has a current head model associated with it, e.g., because a previous node has annotated it, and then uses that head model. If a relative path is given, the file is searched in the resources/headmodels folder of the cpe.

verbose name
Head Model File
default value
port type
StringPort
value type
str (can be None)

mesh_sequence

Meshes in the headmodel onto which the positions (and positions_source) will be projected. The positions are projected onto each mesh in the list in sequence.

verbose name
List Of Meshes
default value
['Scalp']
port type
ListPort
value type
list (can be None)

use_data_lms

The headmodel will always be coregistered to a common space before projection. Set this True to do the alignment using available landmarks provided by the data (SpaceAxis properties or chunk properties). Otherwise use the landmarks in the default montage.

verbose name
Use Landmarks In Data
default value
True
port type
BoolPort
value type
bool (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

verbose name
Set Breakpoint (Debug Only)
default value
False
port type
BoolPort
value type
bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

verbose name
Metadata
default value
{}
port type
DictPort
value type
dict (can be None)