DOC: consistently use CIFTI-2 instead of CIfTI2 or CIFTI2

Author: MichielCottaar

nibabel/cifti2/__init__.py

@@ -6,7 +6,7 @@
 #   copyright and license terms.
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
-"""CIfTI2 format IO
+"""CIFTI-2 format IO
 
 .. currentmodule:: nibabel.cifti2
 

nibabel/cifti2/cifti2.py

@@ -6,13 +6,13 @@
 #   copyright and license terms.
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
-''' Read / write access to CIfTI2 image format
+''' Read / write access to CIFTI-2 image format
 
 Format of the NIFTI2 container format described here:
 
     http://www.nitrc.org/forum/message.php?msg_id=3738
 
-Definition of the CIFTI2 header format and file extensions can be found at:
+Definition of the CIFTI-2 header format and file extensions can be found at:
 
     http://www.nitrc.org/projects/cifti
 '''
@@ -39,7 +39,7 @@ def _float_01(val):
 
 
 class Cifti2HeaderError(Exception):
-    """ Error in CIFTI2 header
+    """ Error in CIFTI-2 header
     """
 
 
@@ -175,7 +175,7 @@ def _to_xml_element(self):
 
 
 class Cifti2LabelTable(xml.XmlSerializable, MutableMapping):
-    """ CIFTI2 label table: a sequence of ``Cifti2Label``s
+    """ CIFTI-2 label table: a sequence of ``Cifti2Label``s
 
     * Description - Used by NamedMap when IndicesMapToDataType is
       "CIFTI_INDEX_TYPE_LABELS" in order to associate names and display colors
@@ -233,7 +233,7 @@ def _to_xml_element(self):
 
 
 class Cifti2Label(xml.XmlSerializable):
-    """ CIFTI2 label: association of integer key with a name and RGBA values
+    """ CIFTI-2 label: association of integer key with a name and RGBA values
 
     For all color components, value is floating point with range 0.0 to 1.0.
 
@@ -311,7 +311,7 @@ def _to_xml_element(self):
 
 
 class Cifti2NamedMap(xml.XmlSerializable):
-    """CIFTI2 named map: association of name and optional data with a map index
+    """CIFTI-2 named map: association of name and optional data with a map index
 
     Associates a name, optional metadata, and possibly a LabelTable with an
     index in a map.
@@ -429,7 +429,7 @@ def _to_xml_element(self):
 
 
 class Cifti2VoxelIndicesIJK(xml.XmlSerializable, MutableSequence):
-    """CIFTI2 VoxelIndicesIJK: Set of voxel indices contained in a structure
+    """CIFTI-2 VoxelIndicesIJK: Set of voxel indices contained in a structure
 
     * Description - Identifies the voxels that model a brain structure, or
       participate in a parcel. Note that when this is a child of BrainModel,
@@ -511,7 +511,7 @@ def _to_xml_element(self):
 
 
 class Cifti2Vertices(xml.XmlSerializable, MutableSequence):
-    """CIFTI2 vertices - association of brain structure and a list of vertices
+    """CIFTI-2 vertices - association of brain structure and a list of vertices
 
     * Description - Contains a BrainStructure type and a list of vertex indices
       within a Parcel.
@@ -577,7 +577,7 @@ def _to_xml_element(self):
 
 
 class Cifti2Parcel(xml.XmlSerializable):
-    """CIFTI2 parcel: association of a name with vertices and/or voxels
+    """CIFTI-2 parcel: association of a name with vertices and/or voxels
 
     * Description - Associates a name, plus vertices and/or voxels, with an
       index.
@@ -692,7 +692,7 @@ def _to_xml_element(self):
 
 
 class Cifti2Volume(xml.XmlSerializable):
-    """CIFTI2 volume: information about a volume for mappings that use voxels
+    """CIFTI-2 volume: information about a volume for mappings that use voxels
 
     * Description - Provides information about the volume for any mappings that
       use voxels.
@@ -735,7 +735,7 @@ def _to_xml_element(self):
 
 
 class Cifti2VertexIndices(xml.XmlSerializable, MutableSequence):
-    """CIFTI2 vertex indices: vertex indices for an associated brain model
+    """CIFTI-2 vertex indices: vertex indices for an associated brain model
 
     The vertex indices (which are independent for each surface, and
     zero-based) that are used in this brain model[.] The parent
@@ -1078,7 +1078,7 @@ def _to_xml_element(self):
 
 
 class Cifti2Matrix(xml.XmlSerializable, MutableSequence):
-    """ CIFTI2 Matrix object
+    """ CIFTI-2 Matrix object
 
     This is a list-like container where the elements are instances of
     :class:`Cifti2MatrixIndicesMap`.
@@ -1210,7 +1210,7 @@ def _to_xml_element(self):
 
 
 class Cifti2Header(FileBasedHeader, xml.XmlSerializable):
-    ''' Class for CIFTI2 header extension '''
+    ''' Class for CIFTI-2 header extension '''
 
     def __init__(self, matrix=None, version="2.0"):
         FileBasedHeader.__init__(self)
@@ -1301,7 +1301,7 @@ def from_axes(cls, axes):
 
 
 class Cifti2Image(DataobjImage):
-    """ Class for single file CIFTI2 format image
+    """ Class for single file CIFTI-2 format image
     """
     header_class = Cifti2Header
     valid_exts = Nifti2Image.valid_exts
@@ -1329,7 +1329,7 @@ def __init__(self,
             returns an array from ``np.asanyarray``.  It should have a
             ``shape`` attribute or property.
         header : Cifti2Header instance or Sequence[cifti2_axes.Axis]
-            Header with data for / from XML part of CIFTI2 format.
+            Header with data for / from XML part of CIFTI-2 format.
             Alternatively a sequence of cifti2_axes.Axis objects can be provided
             describing each dimension of the array.
         nifti_header : None or mapping or NIfTI2 header instance, optional
@@ -1356,7 +1356,7 @@ def nifti_header(self):
 
     @classmethod
     def from_file_map(klass, file_map):
-        """ Load a CIFTI2 image from a file_map
+        """ Load a CIFTI-2 image from a file_map
 
         Parameters
         ----------
@@ -1376,7 +1376,7 @@ def from_file_map(klass, file_map):
                 cifti_header = item.get_content()
                 break
         else:
-            raise ValueError('NIfTI2 header does not contain a CIFTI2 '
+            raise ValueError('NIfTI2 header does not contain a CIFTI-2 '
                              'extension')
 
         # Construct cifti image.
@@ -1435,7 +1435,7 @@ def to_file_map(self, file_map=None):
         img.to_file_map(file_map or self.file_map)
 
     def update_headers(self):
-        ''' Harmonize CIFTI2 and NIfTI headers with image data
+        ''' Harmonize CIFTI-2 and NIfTI headers with image data
 
         >>> import numpy as np
         >>> data = np.zeros((2,3,4))