Skip to content

Commit 0f0e1f7

Browse files
DOC: added list of concrete classes to Axis object
1 parent cefb8c6 commit 0f0e1f7

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

nibabel/cifti2/cifti2_axes.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,14 @@ class Axis(object):
172172
Abstract class for any object describing the rows or columns of a CIFTI-2 vector/matrix
173173
174174
Mainly used for type checking.
175+
176+
Base class for the following concrete CIFTI-2 axes:
177+
178+
* :class:`BrainModelAxis`: each row/column is a voxel or vertex
179+
* :class:`ParcelsAxis`: each row/column is a group of voxels and/or vertices
180+
* :class:`ScalarAxis`: each row/column has a unique name (with optional meta-data)
181+
* :class:`LabelAxis`: each row/column has a unique name and label table (with optional meta-data)
182+
* :class:`SeriesAxis`: each row/column is a timepoint, which increases monotonically
175183
"""
176184

177185
@property

0 commit comments

Comments
 (0)