Skip to content

Commit 33ed37a

Browse files
demianweffigies
authored andcommitted
Improved docstring of Cifti2MatrixIndicesMap
1 parent 61fc9a7 commit 33ed37a

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

nibabel/cifti2/cifti2.py

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -720,14 +720,24 @@ class Cifti2MatrixIndicesMap(xml.XmlSerializable, collections.MutableSequence):
720720
"""Class for Matrix Indices Map
721721
722722
Provides a mapping between matrix indices and their interpretation.
723+
724+
Attribute
725+
---------
726+
applies_to_matrix_dimension : list of ints
727+
Dimensions of this matrix that follow this mapping
728+
indices_map_to_data_type : str one of CIFTI_MAP_TYPES
729+
Type of mapping to the matrix indices
730+
number_of_series_points : int, optional
731+
If it is a series, number of points in the series
732+
series_exponent : int, optional
733+
If it is a series the exponent of the increment
734+
series_start : float, optional
735+
If it is a series, starting time
736+
series_step : float, optional
737+
If it is a series, step per element
738+
series_unit : str, optional
739+
If it is a series, units
723740
"""
724-
# applies_to_matrix_dimension = list
725-
# indices_map_to_data_type = str
726-
# number_of_series_points = int
727-
# series_exponent = int
728-
# series_start = float
729-
# series_step = float
730-
# series_unit = str
731741
_valid_type_mappings_ = {
732742
Cifti2BrainModel: ('CIFTI_INDEX_TYPE_BRAIN_MODELS',),
733743
Cifti2Parcel: ('CIFTI_INDEX_TYPE_PARCELS',),

0 commit comments

Comments
 (0)