gifti.py 9.72 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
#!/usr/bin/env python
#
# gifti.py - GIFTI file support.
#
# Author: Paul McCarthy  <pauldmccarthy@gmail.com>
#         Michiel Cottar <michiel.cottaar@ndcn.ox.ac.uk>
#
"""This class provides classes and functions for working with GIFTI files.

The GIFTI file format specification can be found at
http://www.nitrc.org/projects/gifti/

Support is currently very basic - only the following classes/functions
are available:

  .. autosummary::
     :nosignatures:

19
20
21
     GiftiMesh
     loadGiftiMesh
     loadGiftiVertexData
22
     prepareGiftiVertexData
23
     relatedFiles
24
25
26
"""


27
import            glob
28
29
import os.path as op

30
import numpy   as np
31
32
import nibabel as nib

33
34
35
import fsl.utils.path     as fslpath
import fsl.data.constants as constants
import fsl.data.mesh      as fslmesh
36
37


38
ALLOWED_EXTENSIONS = ['.gii']
39
40
41
42
43
"""List of file extensions that a file containing Gifti surface data
is expected to have.
"""


44
EXTENSION_DESCRIPTIONS = ['GIFTI file']
45
46
47
48
"""A description for each of the :data:`ALLOWED_EXTENSIONS`. """


class GiftiMesh(fslmesh.Mesh):
49
50
51
    """Class which represents a GIFTI surface image. This is essentially
    just a 3D model made of triangles.

52
53
54
    For each GIFTI surface file that is loaded, the
    ``nibabel.gifti.GiftiImage`` instance is stored in the :class:`.Meta`
    store, with the absolute path to the surface file as the key.
55
56
57
    """


58
    def __init__(self, infile, fixWinding=False, loadAll=False):
59
        """Load the given GIFTI file using ``nibabel``, and extracts surface
60
        data using the  :func:`loadGiftiMesh` function.
61

62
63
        :arg infile:     A GIFTI file (``*..gii``) which contains a surface
                         definition.
64
65
66
67
68
69
70

        :arg fixWinding: Passed through to the :meth:`addVertices` method
                         for the first vertex set.

        :arg loadAll:    If ``True``, the ``infile`` directory is scanned
                         for other surface files which are then loaded
                         as additional vertex sets.
71
72
73

        .. todo:: Allow loading from a ``.topo.gii`` and ``.coord.gii`` file?
                  Maybe.
74
75
        """

76
77
78
        name   = fslpath.removeExt(op.basename(infile), ALLOWED_EXTENSIONS)
        infile = op.abspath(infile)

79
        surfimg, indices, vertices, vdata = loadGiftiMesh(infile)
80

81
82
83
84
        fslmesh.Mesh.__init__(self,
                              indices,
                              name=name,
                              dataSource=infile)
85

86
87
        for v in vertices:
            self.addVertices(v, infile, fixWinding=fixWinding)
88
        self.setMeta(infile, surfimg)
89

90
91
92
        if vdata is not None:
            self.addVertexData(infile, vdata)

93
94
95
96
        # Find and load all other
        # surfaces in the same directory
        # as the specfiied one.
        if loadAll:
97

98
            nvertices = vertices.shape[0]
99
            surfFiles = relatedFiles(infile, ALLOWED_EXTENSIONS)
100

101
102
            for sfile in surfFiles:

103
                surfimg, vertices, _ = loadGiftiMesh(sfile)
104
105
106
107
108
109
110
111

                if vertices.shape[0] != nvertices:
                    continue

                self.addVertices(vertices, sfile, select=False)
                self.setMeta(    sfile, surfimg)


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
    def loadVertices(self, infile, key=None, *args, **kwargs):
        """Overrides the :meth:`.Mesh.loadVertices` method.

        Attempts to load vertices for this ``GiftiMesh`` from the given
        ``infile``, which may be a GIFTI file or a plain text file containing
        vertices.
        """

        if not infile.endswith('.gii'):
            return fslmesh.Mesh.loadVertices(
                self, infile, key, *args, **kwargs)

        infile = op.abspath(infile)

        if key is None:
            key = infile

        surfimg, vertices, _ = loadGiftiMesh(infile)

131
132
133
        vertices = self.addVertices(vertices, key, *args, **kwargs)

        self.setMeta(infile, surfimg)
134
135
136
137

        return vertices


138
    def loadVertexData(self, infile, key=None):
139
        """Overrides the :meth:`.Mesh.loadVertexData` method.
140
141

        Attempts to load data associated with each vertex of this
142
143
        ``GiftiMesh`` from the given ``infile``, which may be a GIFTI file or
        a plain text file which contains vertex data.
144
145
        """

146
147
148
        if not infile.endswith('.gii'):
            return fslmesh.Mesh.loadVertexData(self, infile)

149
        infile = op.abspath(infile)
150

151
152
        if key is None:
            key = infile
153

154
155
        vdata = loadGiftiVertexData(infile)[1]
        return self.addVertexData(key, vdata)
156
157


158
def loadGiftiMesh(filename):
159
160
161
162
163
164
    """Extracts surface data from the given ``nibabel.gifti.GiftiImage``.

    The image is expected to contain the following``<DataArray>`` elements:

      - one comprising ``NIFTI_INTENT_TRIANGLE`` data (vertex indices
        defining the triangles).
165
166
      - one or more comprising ``NIFTI_INTENT_POINTSET`` data (the surface
        vertices)
167
168
169

    A ``ValueError`` will be raised if this is not the case.

170
    :arg filename: Name of a GIFTI file containing surface data.
171
172
173

    :returns:     A tuple containing these values:

174
175
                   - The loaded ``nibabel.gifti.GiftiImage`` instance

176
                   - A ``(M, 3)`` array containing the vertex indices for
177
                     ``M`` triangles.
178

179
180
                   - A list of at least one ``(N, 3)`` arrays containing ``N``
                     vertices.
181

182
183
184
185
                   - A ``(M, N)`` numpy array containing ``N`` data points for
                     ``M`` vertices, or ``None`` if the file does not contain
                     any vertex data.
    """
186

187
    gimg = nib.load(filename)
188

189
190
    pscode  = constants.NIFTI_INTENT_POINTSET
    tricode = constants.NIFTI_INTENT_TRIANGLE
191

192
193
194
    pointsets = [d for d in gimg.darrays if d.intent == pscode]
    triangles = [d for d in gimg.darrays if d.intent == tricode]
    vdata     = [d for d in gimg.darrays if d.intent not in (pscode, tricode)]
195

196
    if len(triangles) != 1:
197
198
        raise ValueError('{}: GIFTI surface files must contain '
                         'exactly one triangle array'.format(filename))
199

200
201
202
203
204
    if len(pointsets) == 0:
        raise ValueError('{}: GIFTI surface files must contain '
                         'at least one pointset array'.format(filename))

    vertices = [ps.data for ps in pointsets]
205
206
    indices  = triangles[0].data

207
208
209
210
    if len(vdata) == 0: vdata = None
    else:               vdata = prepareGiftiVertexData(vdata, filename)

    return gimg, indices, vertices, vdata
211
212
213
214
215


def loadGiftiVertexData(filename):
    """Loads vertex data from the given GIFTI file.

216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
    See :func:`prepareGiftiVertexData`.

    Returns a tuple containing:

      - The loaded ``nibabel.gifti.GiftiImage`` object

      - A ``(M, N)`` numpy array containing ``N`` data points for ``M``
        vertices
    """
    gimg = nib.load(filename)
    return gimg, prepareGiftiVertexData(gimg.darrays, filename)


def prepareGiftiVertexData(darrays, filename=None):
    """Prepares vertex data from the given list of GIFTI data arrays.

232
233
234
    It is assumed that the given file does not contain any
    ``NIFTI_INTENT_POINTSET`` or ``NIFTI_INTENT_TRIANGLE`` data arrays, and
    which contains either:
235

236
237
238
239
240
241
      - One ``(M, N)`` data array containing ``N`` data points for ``M``
        vertices

      - One or more ``(M, 1)`` data arrays each containing a single data point
        for ``M`` vertices, and all with the same intent code

242
243
    Returns a ``(M, N)`` numpy array containing ``N`` data points for ``M``
    vertices.
244
245
    """

246
    intents = set([d.intent for d in darrays])
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261

    if len(intents) != 1:
        raise ValueError('{} contains multiple (or no) intents'
                         ': {}'.format(filename, intents))

    intent = intents.pop()

    if intent in (constants.NIFTI_INTENT_POINTSET,
                  constants.NIFTI_INTENT_TRIANGLE):
        raise ValueError('{} contains surface data'.format(filename))

    # Just a single array - return it as-is.
    # n.b. Storing (M, N) data in a single
    # DataArray goes against the GIFTI spec,
    # but hey, it happens.
262
263
264
    if len(darrays) == 1:
        vdata = darrays[0].data
        return vdata.reshape(vdata.shape[0], -1)
265
266
267

    # Otherwise extract and concatenate
    # multiple 1-dimensional arrays
268
    vdata = [d.data for d in darrays]
269
270
271
272

    if any([len(d.shape) != 1 for d in vdata]):
        raise ValueError('{} contains one or more non-vector '
                         'darrays'.format(filename))
273

274
275
276
    vdata = np.vstack(vdata).T
    vdata = vdata.reshape(vdata.shape[0], -1)

277
    return vdata
278
279


280
def relatedFiles(fname, ftypes=None):
281
282
283
    """Given a GIFTI file, returns a list of other GIFTI files in the same
    directory which appear to be related with the given one.  Files which
    share the same prefix are assumed to be related to the given file.
284
285
286

    :arg fname: Name of the file to search for related files for

287
288
    :arg ftype: If provided, only files with suffixes in this list are
                searched for. Defaults to files which contain vertex data.
289
290
    """

291
292
293
    if ftypes is None:
        ftypes = ['.func.gii', '.shape.gii', '.label.gii', '.time.gii']

Paul McCarthy's avatar
Paul McCarthy committed
294
295
296
    # We want to return all files in the same
    # directory which have the following name:

297
    #
298
    # [subj].[hemi].[type].*.[ftype]
Paul McCarthy's avatar
Paul McCarthy committed
299
    #
300

Paul McCarthy's avatar
Paul McCarthy committed
301
    #   where
302
    #     - [subj] is the subject ID, and matches fname
Paul McCarthy's avatar
Paul McCarthy committed
303
    #
304
    #     - [hemi] is the hemisphere, and matches fname
Paul McCarthy's avatar
Paul McCarthy committed
305
    #
306
    #     - [type] defines the file contents
307
    #
308
    #     - suffix is func, shape, label, time, or `ftype`
Paul McCarthy's avatar
Paul McCarthy committed
309

310
311
    path            = op.abspath(fname)
    dirname, fname  = op.split(path)
Paul McCarthy's avatar
Paul McCarthy committed
312

313
314
315
316
317
    # get the [subj].[hemi] prefix
    try:
        subj, hemi, _ = fname.split('.', 2)
        prefix        = '.'.join((subj, hemi))
    except Exception:
318
        return []
Paul McCarthy's avatar
Paul McCarthy committed
319

320
321
322
    related = []

    for ftype in ftypes:
323
324
        related.extend(
            glob.glob(op.join(dirname, '{}*{}'.format(prefix, ftype))))
325

326
    return [r for r in related if r != path]