Query-engine that maps center voxels (indexed by feature ids) to indices of features (voxels) that are near each center voxel.
In a typical use case such an instance is generated using the function ‘disc_surface_queryengine’ with the output_space=’voxels’ argument.
For a mapping from center nodes (on a surface) to voxels, consider SurfaceVerticesQueryEngine.
Methods
feature_id2linear_voxel_ids(feature_id) | |
feature_id2nearest_vertex_id(feature_id[, ...]) | Compute the index of the vertex nearest to a given voxel. |
get_masked_nifti_image([center_ids]) | Returns a nifti image indicating which voxels are included in one or more searchlights. |
linear_voxel_id2feature_id(linear_voxel_id) | |
query(**kwargs) | |
query_byid(feature_id) | Query the engine using a feature id |
train(ds) | Train the query engine on a dataset |
untrain() | |
vertex_id2nearest_feature_id(vertex_id) | Compute the index of the voxel nearest to a given vertex. |
Makes a new SurfaceVoxelsQueryEngine
Parameters: | voxsel: volume_mask_dict.VolumeMaskDictionary :
space: str (default: ‘voxel_indices’) :
add_fa: list of str :
fallback_euclidean_distance: bool (default: True) :
|
---|
Methods
feature_id2linear_voxel_ids(feature_id) | |
feature_id2nearest_vertex_id(feature_id[, ...]) | Compute the index of the vertex nearest to a given voxel. |
get_masked_nifti_image([center_ids]) | Returns a nifti image indicating which voxels are included in one or more searchlights. |
linear_voxel_id2feature_id(linear_voxel_id) | |
query(**kwargs) | |
query_byid(feature_id) | Query the engine using a feature id |
train(ds) | Train the query engine on a dataset |
untrain() | |
vertex_id2nearest_feature_id(vertex_id) | Compute the index of the voxel nearest to a given vertex. |
Returns a nifti image indicating which voxels are included in one or more searchlights.
Parameters: | center_ids: list or None :
|
---|---|
Returns: | img: nibabel.Nifti1Image :
|
Notes
When using surface-based searchlights, a use case of this function is to get the voxels that were associated with the searchlights in a subset of all nodes on a cortical surface.
Query the engine using a feature id
Train the query engine on a dataset