Skip to content

Commit 61fc9a7

Browse files
demianweffigies
authored andcommitted
Improved docstring of Cifti2BrainModel
1 parent fecd0f2 commit 61fc9a7

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

nibabel/cifti2/cifti2.py

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -650,14 +650,27 @@ def _to_xml_element(self):
650650

651651

652652
class Cifti2BrainModel(xml.XmlSerializable):
653+
'''
654+
BrainModel element representing a mapping of the dimension to vertex or voxels.
655+
Mapping to vertices of voxels must be specified.
653656
654-
# index_offset = int
655-
# index_count = int
656-
# model_type = str
657-
# brain_structure = str
658-
# surface_number_of_vertices = int
659-
# voxel_indices_ijk = np.array
660-
# vertex_indices = np.array
657+
Attributes
658+
----------
659+
index_offset : int
660+
Start of the mapping
661+
index_count : int
662+
Number of elements in the array to be mapped
663+
model_type : str
664+
One of CIFTI_MODEL_TYPES
665+
brain_structure : str
666+
One of CIFTI_BrainStructures
667+
surface_number_of_vertices : int
668+
Number of vertices in the surface. Use only for surface-type structure
669+
voxel_indices_ijk : Cifti2VoxelIndicesIJK, optional
670+
Indices on the image towards where the array indices are mapped
671+
vertex_indices : Cifti2VertexIndices, optional
672+
Indices of the vertices towards where the array indices are mapped
673+
'''
661674

662675
def __init__(self, index_offset=None, index_count=None, model_type=None,
663676
brain_structure=None, n_surface_vertices=None,

0 commit comments

Comments
 (0)