wrapperutils.py 23.8 KB
Newer Older
1
2
#!/usr/bin/env python
#
Paul McCarthy's avatar
Paul McCarthy committed
3
4
# wrapperutils.py - Functions and decorators used by the FSL wrapper
# functions.
5
6
7
#
# Author: Paul McCarthy <pauldmccarthy@gmail.com>
#
Paul McCarthy's avatar
Paul McCarthy committed
8
9
10
11
"""This module contains functions and decorators used by the FSL wrapper
functions.


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
The :func:`cmdwrapper` and :func:`fslwrapper` functions are conenience
decorators which allow you to write your wrapper function such that it simply
generates the command-line needed to respectively run a standard shell
command or a FSL command. For example::


    @fslwrapper
    def fslreorient2std(input, output):
        return ['fslreorient2std', input, output]


When this ``fslreorient2std`` function is called, the ``fslwrapper`` decorator
will take care of invoking the command in a standardised way.


Paul McCarthy's avatar
Paul McCarthy committed
27
The :func:`applyArgStyle` function can be used to automatically convert
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
keyword arguments into command-line arguments, based on a set of standard
patterns. For example::


    @fslwrapper
    def flirt(src, ref, **kwargs):
        cmd  = ['flirt', '-in', src, '-ref', ref]
        return cmd + applyArgStyle('-=', **kwargs)


The :func:`fileOrImage` and :func:`fileOrArray` functions can be used to
decorate a wrapper function such that in-memory ``nibabel`` images or Numpy
arrays can be passed in as arguments - they will be automatically saved out to
files, and then the file names passed into the wrapper function. For exmaple::


    @fileOrImage('src', 'ref')
    @fslwrapper
    def flirt(src, ref, **kwargs):
        cmd  = ['flirt', '-in', src, '-ref', ref]
        return cmd + applyArgStyle('-=', **kwargs)


Now this ``flirt`` function can be called either with file names, or
``nibabel`` images.


55
56
57
58
59
60
61
.. note:: Because the :func:`fileOrImage` and :func:`fileOrArray` decorators
          manipulate the return value of the decorated function, they should
          be applied *after* any other decorators. Furthermore, if you need to
          apply both a ``fileOrImage`` and ``fileOrArray`` decorator to a
          function, they should be grouped together, e.g.::

              @fileOrImage('a', 'b')
Paul McCarthy's avatar
Paul McCarthy committed
62
              @fileOrArray('c', 'd')
63
64
65
66
67
              @fslwrapper
              def func(**kwargs):
                  ...


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
Command outputs can also be loaded back into memory by using the special
:data:`LOAD` value when calling a wrapper function. For example::


    @fileOrImage('src', 'ref', 'out')
    @fslwrapper
    def flirt(src, ref, **kwargs):
        cmd  = ['flirt', '-in', src, '-ref', ref]
        return cmd + applyArgStyle('-=', **kwargs)


If we set the ``out`` argument to ``LOAD``, the output image will be loaded
and returned::

    src     = nib.load('src.nii')
    ref     = nib.load('ref.nii')
    aligned = flirt(src, ref, out=LOAD)['out']
Paul McCarthy's avatar
Paul McCarthy committed
85
"""
86
87
88
89


import os.path as op
import            os
Paul McCarthy's avatar
Paul McCarthy committed
90
import            sys
91
92
93
94
95
96
97
98
import            inspect
import            tempfile
import            warnings
import            functools
import            collections

import            six
import nibabel as nib
Paul McCarthy's avatar
Paul McCarthy committed
99
import numpy   as np
100
101

import fsl.utils.tempdir as tempdir
102
import fsl.utils.run     as run
103
104
105
import fsl.data.image    as fslimage


Paul McCarthy's avatar
Paul McCarthy committed
106
107
108
109
110
def _update_wrapper(wrapper, wrapped, *args, **kwargs):
    """Replacement for the built-in ``functools.update_wrapper``. This
    implementation ensures that the wrapper function has an attribute
    called ``__wrapped__``, which refers to the ``wrapped`` function.

111
    This custom function is only needed in Python versions < 3.4.
Paul McCarthy's avatar
Paul McCarthy committed
112
113
114
115
116
    """

    wrapper = functools.update_wrapper(wrapper, wrapped, *args, **kwargs)

    # Python >= 3.4 does things right
Paul McCarthy's avatar
Paul McCarthy committed
117
    if (sys.version_info[0] * 10 + sys.version_info[1]) < 34:
Paul McCarthy's avatar
Paul McCarthy committed
118
119
        wrapper.__wrapped__ = wrapped
    return wrapper
120
121


Paul McCarthy's avatar
Paul McCarthy committed
122
123
124
125
126
127
def _unwrap(func):
    """Replacement for the built-in ``inspect.unwrap`` function, which
    is not present in Python versions prior to 3.4.
    """

    # Python >= 3.4 has an inspect.unwrap function
Paul McCarthy's avatar
Paul McCarthy committed
128
    if (sys.version_info[0] * 10 + sys.version_info[1]) >= 34:
Paul McCarthy's avatar
Paul McCarthy committed
129
130
131
132
133
134
135
136
137
        return inspect.unwrap(func)

    # Otherwise we follow the __wrapped__ chain ourselves
    if hasattr(func, '__wrapped__'):
        return _unwrap(func.__wrapped__)

    return func


138
139
140
141
142
143
def cmdwrapper(func):
    """This decorator can be used on functions which generate a command line.
    It will pass the return value of the function to the
    :func:`fsl.utils.run.run` function in a standardised manner.
    """
    def wrapper(*args, **kwargs):
144
        submit = kwargs.pop('submit', None)
145
146
147
148
        stderr = kwargs.pop('stderr', True)
        log    = kwargs.pop('log',    {'tee' : True})
        cmd    = func(*args, **kwargs)
        return run.run(cmd, stderr=stderr, log=log, submit=submit)
149
150
151
152
153
154
155
156
157
    return _update_wrapper(wrapper, func)


def fslwrapper(func):
    """This decorator can be used on functions which generate a FSL command
    line. It will pass the return value of the function to the
    :func:`fsl.utils.run.runfsl` function in a standardised manner.
    """
    def wrapper(*args, **kwargs):
158
        submit = kwargs.pop('submit', None)
159
160
161
162
        stderr = kwargs.pop('stderr', True)
        log    = kwargs.pop('log',    {'tee' : True})
        cmd    = func(*args, **kwargs)
        return run.runfsl(cmd, stderr=stderr, log=log, submit=submit)
163
164
165
    return _update_wrapper(wrapper, func)


Paul McCarthy's avatar
Paul McCarthy committed
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
SHOW_IF_TRUE = object()
"""Constant to be used in the ``valmap`` passed to the :func:`applyArgStyle`
function.

When a ``SHOW_IF_TRUE`` argument is ``True``, it is added to the generated
command line arguments.
"""


HIDE_IF_TRUE = object()
"""Constant to be used in the ``valmap`` passed to the :func:`applyArgStyle`
function.

When a ``HIDE_IF_TRUE`` argument is ``True``, it is suppressed from the
generated command line arguments.
"""
182
183


184
def applyArgStyle(style, valsep=None, argmap=None, valmap=None, **kwargs):
Paul McCarthy's avatar
Paul McCarthy committed
185
186
187
188
    """Turns the given ``kwargs`` into command line options. This function
    is intended to be used to automatically generate command line options
    from arguments passed into a Python function.

189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
    The ``style`` and ``valsep`` arguments control how key-value pairs
    are converted into command-line options:


    =========  ==========  ===========================
    ``style``  ``valsep``  Result
    =========  ==========  ===========================
    ``'-'``    ' '         ``-name val1 val2 val3``
    ``'-'``    '"'         ``-name "val1 val2 val3"``
    ``'-'``    ','         ``-name val1,val2,val3``
    ``'--'``   ' '         ``--name val1 val2 val3``
    ``'--'``   '"'         ``--name "val1 val2 val3"``
    ``'--'``   ','         ``--name val1,val2,val3``
    ``'-='``   ' '         Not supported
    ``'-='``   '"'         ``-name="val1 val2 val3"``
    ``'-='``   ','         ``-name=val1,val2,val3``
    ``'--='``  ' '         Not supported
    ``'--='``  '"'         ``--name="val1 val2 val3"``
    ``'--='``  ','         ``--name=val1,val2,val3``
    =========  ==========  ===========================


Paul McCarthy's avatar
Paul McCarthy committed
211
    :arg style:  Controls how the ``kwargs`` are converted into command-line
212
213
214
215
216
                 options - must be one of ``'-'``, ``'--'``, ``'-='``, or
                 ``'--='``.

    :arg valsep: Controls how the values passed to command-line options
                 which expect multiple arguments are delimited - must be
217
218
                 one of ``' '``, ``','`` or ``'"'``. Defaults to ``' '``
                 if ``'=' not in style``, ``','`` otherwise.
Paul McCarthy's avatar
Paul McCarthy committed
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

    :arg argmap: Dictionary of ``{kwarg-name : cli-name}`` mappings. This can
                 be used if you want to use different argument names in your
                 Python function for the command-line options.

    :arg valmap: Dictionary of ``{cli-name : value}`` mappings. This can be
                 used to define specific semantics for some command-line
                 options. Acceptable values for ``value`` are as follows

                  - :data:`SHOW_IF_TRUE` - if the argument is present, and
                    ``True`` in ``kwargs``, the command line option
                    will be added (without any arguments).

                  - :data:`HIDE_IF_TRUE` - if the argument is present, and
                    ``False`` in ``kwargs``, the command line option
                    will be added (without any arguments).

                  - Any other constant value. If the argument is present
                    in ``kwargs``, its command-line option will be
                    added, with the constant value as its argument.

                 The argument for any options not specified in the ``valmap``
                 will be converted into strings.
242

Paul McCarthy's avatar
Paul McCarthy committed
243
244
245
246
247
    :arg kwargs: Arguments to be converted into command-line options.

    :returns:    A list containing the generated command-line options.
    """

248
249
250
251
    if valsep is None:
        if '=' in style: valsep = ','
        else:            valsep = ' '

Paul McCarthy's avatar
Paul McCarthy committed
252
253
    if style not in ('-', '--', '-=', '--='):
        raise ValueError('Invalid style: {}'.format(style))
254
255
256
257
258
259
260
261
262
    if valsep not in (' ', ',', '"'):
        raise ValueError('Invalid valsep: {}'.format(valsep))

    # we don't handle the case where '=' in
    # style, and valsep == ' ', because no
    # sane CLI app would do this. Right?
    if '=' in style and valsep == ' ':
        raise ValueError('Incompatible style and valsep: s={} v={}'.format(
            style, valsep))
Paul McCarthy's avatar
Paul McCarthy committed
263
264
265
266
267

    if argmap is None: argmap = {}
    if valmap is None: valmap = {}

    def fmtarg(arg):
268
269
270
271
        if   style in ('-',  '-='):  arg =  '-{}'.format(arg)
        elif style in ('--', '--='): arg = '--{}'.format(arg)
        return arg

272
    # always returns a sequence
Paul McCarthy's avatar
Paul McCarthy committed
273
    def fmtval(val):
274
275
        if     isinstance(val, collections.Sequence) and \
           not isinstance(val, six.string_types):
276
277
278
279
280

            val = [str(v) for v in val]
            if   valsep == ' ': return val
            elif valsep == '"': return [' '   .join(val)]
            else:               return [valsep.join(val)]
281
        else:
282
283
284
285
286
287
288
289
            return [str(val)]

    # val is assumed to be a sequence
    def fmtargval(arg, val):
        # if '=' in style, val will
        # always be a single string
        if '=' in style: return ['{}={}'.format(arg, val[0])]
        else:            return [arg] + val
290
291
292
293
294
295

    args = []

    for k, v in kwargs.items():

        k    = argmap.get(k, k)
Paul McCarthy's avatar
Paul McCarthy committed
296
297
298
        mapv = valmap.get(k, fmtval(v))
        k    = fmtarg(k)

299

300
301
302
303
        if mapv in (SHOW_IF_TRUE, HIDE_IF_TRUE):
            if (mapv is SHOW_IF_TRUE and     v) or \
               (mapv is HIDE_IF_TRUE and not v):
                args.append(k)
304
        else:
305
            args.extend(fmtargval(k, mapv))
306
307
308
309

    return args


310
def namedPositionals(func, args):
311
    """Given a function, and a sequence of positional arguments destined
312
    for that function, identifies the name for each positional argument.
313
    Variable positional arguments are given an automatic name.
314

315
316
    :arg func: Function which will accept ``args`` as positionals.
    :arg args: Tuple of positional arguments to be passed to ``func``.
317
    """
Paul McCarthy's avatar
Paul McCarthy committed
318

319
320
321
322
323
324
325
326
327
328
    # Current implementation will
    # result in naming collisions
    # for something like this:
    #
    # def func(args0, *args):
    #     ...
    # because of automatic vararg
    # naming. But who would write
    # a function like that anyway?

329
330
    # Remove any decorators
    # from the function
Paul McCarthy's avatar
Paul McCarthy committed
331
332
    func = _unwrap(func)

333
334
335
    # getargspec is the only way to
    # get the names of positional
    # arguments in Python 2.x.
Paul McCarthy's avatar
Paul McCarthy committed
336
    if sys.version_info[0] < 3:
337
338
339
        spec     = inspect.getargspec(func)
        argnames = spec.args
        varargs  = spec.varargs
Paul McCarthy's avatar
Paul McCarthy committed
340

341
342
    # But getargspec is deprecated
    # in python 3.x
Paul McCarthy's avatar
Paul McCarthy committed
343
344
345
346
347
348
    else:

        # getfullargspec is deprecated in
        # python 3.5, but not in python 3.6.
        with warnings.catch_warnings():
            warnings.filterwarnings('ignore', category=DeprecationWarning)
349
350
351
            spec     = inspect.getfullargspec(func)
            argnames = spec.args
            varargs  = spec.varargs
352

353
354
355
    # we only care about the arguments
    # that are being passed in
    argnames = argnames[:len(args)]
356

357
358
359
360
    # make up names for varargs
    nvarargs = len(args) - len(argnames)
    if varargs is not None and nvarargs > 0:
        argnames += ['{}{}'.format(varargs, i) for i in range(nvarargs)]
361

362
    return argnames
363
364


Paul McCarthy's avatar
Paul McCarthy committed
365
LOAD = object()
Paul McCarthy's avatar
Paul McCarthy committed
366
367
"""Constant used by the :class:`_FileOrThing` class to indicate that an output
file should be loaded into memory and returned as a Python object.
368
369
370
"""


Paul McCarthy's avatar
Paul McCarthy committed
371
372
373
374
375
376
377
378
379
380
class _FileOrThing(object):
    """Decorator which ensures that certain arguments which are passed into the
    decorated function are always passed as file names. Both positional and
    keyword arguments can be specified.


    The ``_FileOrThing`` class is not intended to be used directly - see the
    :func:`fileOrImage` and :func:`fileOrArray` decorator functions for more
    details.

381

Paul McCarthy's avatar
Paul McCarthy committed
382
383
384
385
386
387
388
389
390
391
392
393
    These decorators are intended for functions which wrap a command-line tool,
    i.e. where some inputs/outputs need to be specified as file names.


    **Inputs**


    Any arguments which are not of type ``Thing`` are passed through to the
    decorated function unmodified.  Arguments which are of type ``Thing`` are
    saved to a temporary file, and the name of that file is passed to the
    function.

394

Paul McCarthy's avatar
Paul McCarthy committed
395
    **Outputs**
396
397


Paul McCarthy's avatar
Paul McCarthy committed
398
    If an argument is given the special :data:`LOAD` value, it is assumed
Paul McCarthy's avatar
Paul McCarthy committed
399
400
401
    to be an output argument. In this case, it is replaced with a temporary
    file name then, after the function has completed, that file is loaded
    into memory, and the value returned (along with the function's output,
Paul McCarthy's avatar
Paul McCarthy committed
402
    and any other arguments with a value of ``LOAD``).
Paul McCarthy's avatar
Paul McCarthy committed
403
404
405
406
407
408


    **Return value**


    Functions decorated with a ``_FileOrThing`` decorator will always return a
409
410
411
412
413
    ``dict``-like object, where the function's actual return value is
    accessible via an attribute called `output`. All output arguments with a
    value of ``LOAD`` will be present as dictionary entries, with the keyword
    argument names used as keys. Any ``LOAD``ed output arguments which were not
    generated by the function will not be present in the dictionary.
Paul McCarthy's avatar
Paul McCarthy committed
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437


    **Example**


    As an example of using the ``fileOrArray`` decorator on a function
    which concatenates two files containing affine transformations, and
    saves the output to a file::

        # if atob, btoc, or output are passed
        # in as arrays, they are converted to
        # file names.
        @fileOrArray('atob', 'btoc', 'output')
        def concat(atob, btoc, output=None):

            # inputs are guaranteed to be files
            atob = np.loadtxt(atob)
            btoc = np.loadtxt(atoc)

            atoc = np.dot(btoc, atob)

            if output is not None:
                np.savetxt(output, atoc)

438
439
            return 'Done'

Paul McCarthy's avatar
Paul McCarthy committed
440
441
442
443

    Because we have decorated the ``concat`` function with :func:`fileToArray`,
    it can be called with either file names, or Numpy arrays::

444

Paul McCarthy's avatar
Paul McCarthy committed
445
446
        # All arguments are passed through
        # unmodified - the output will be
447
        # saved to a file called atoc.mat.
Paul McCarthy's avatar
Paul McCarthy committed
448
449
        concat('atob.txt', 'btoc.txt', 'atoc.mat')

450
451
452
453
454
455
456
457
458
        # The function's return value
        # is accessed via an attribute called
        # "output" on the dict
        assert concat('atob.txt', 'btoc.txt', 'atoc.mat').output == 'Done'

        # Outputs to be loaded into memory
        # are returned in a dictionary,
        # with argument names as keys.
        atoc = concat('atob.txt', 'btoc.txt', LOAD)['atoc']
Paul McCarthy's avatar
Paul McCarthy committed
459

460
461
462
463
464
465
466
467
468
        # In-memory inputs are saved to
        # temporary files, and those file
        # names are passed to the concat
        # function.
        atoc = concat(np.diag([2, 2, 2, 0]),
                      np.diag([3, 3, 3, 3]), LOAD)['atoc']


    **Using with other decorators**
Paul McCarthy's avatar
Paul McCarthy committed
469
470
471
472
473
474
475
476
477


    ``_FileOrThing`` decorators can be chained with other ``_FileOrThing``
    decorators, and other decorators.  When multiple ``_FileOrThing``
    decorators are used on a single function, the outputs from each decorator
    are merged together into a single dict-like object.


    ``_FileOrThing`` decorators can be used with any other decorators
478
    **as long as** they do not manipulate the return value.
479
480
481
    """


482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
    class _Results(dict):
        """A custom ``dict`` type used to return outputs from a function
        decorated with ``_FileOrThing``. All outputs are stored as dictionary
        items, with the argument name as key, and the output object (the
        "thing") as value.

        The decorated function's actual return value is accessible via the
        :meth:`output` property.
        """
        def __init__(self, output):
            self.__output = output

        @property
        def output(self):
            """Access the return value of the decorated function. """
            return self.__output


500
    def __init__(self, func, prepIn, prepOut, load, *things):
Paul McCarthy's avatar
Paul McCarthy committed
501
502
        """Initialise a ``_FileOrThing`` decorator.

503
504
        :arg func:    The function to be decorated.

505
506
        :arg prepIn:  Function which returns a file name to be used in
                      place of an input argument.
Paul McCarthy's avatar
Paul McCarthy committed
507

508
509
        :arg prepOut: Function which generates a file name to use for
                      arguments that were set to :data:`LOAD`.
510

511
512
513
        :arg load:    Function which is called to load items for arguments
                      that were set to :data:`LOAD`. Must accept a file path
                      as its sole argument.
514

515
        :arg things:  Names of all arguments which will be handled by
516
517
518
                      this ``_FileOrThing`` decorator. If not provided,
                      *all* arguments passed to the function will be
                      handled.
519
520
521
522
523
524

        The ``prepIn`` and ``prepOut`` functions must accept the following
        positional arguments:

          - A directory in which all temporary input/output files should be
            stored
Paul McCarthy's avatar
Paul McCarthy committed
525

526
527
528
529
          - The name of the keyword argument to be processed

          - The argument value that was passed in
        """
530
        self.__func    = func
531
532
533
534
        self.__prepIn  = prepIn
        self.__prepOut = prepOut
        self.__load    = load
        self.__things  = things
Paul McCarthy's avatar
Paul McCarthy committed
535
536


537
    def __call__(self, *args, **kwargs):
538
        """Function which calls ``func``, ensuring that any arguments of
Paul McCarthy's avatar
Paul McCarthy committed
539
        type ``Thing`` are saved to temporary files, and any arguments
Paul McCarthy's avatar
Paul McCarthy committed
540
        with the value :data:`LOAD` are loaded and returned.
541

542
        All other arguments are passed through to ``func``.
543
        """
Paul McCarthy's avatar
Paul McCarthy committed
544

545
546
        func     = self.__func
        argnames = namedPositionals(func, args)
547
548

        # Create a tempdir to store any temporary
Paul McCarthy's avatar
Paul McCarthy committed
549
        # input/output things, but don't change
550
551
552
553
        # into it, as file paths passed to the
        # function may be relative.
        with tempdir.tempdir(changeto=False) as td:

554
555
            # Replace any things with file names.
            # Also get a list of LOAD outputs
556
557
            args, kwargs, outfiles = self.__prepareArgs(
                td, argnames, args, kwargs)
558
559

            # Call the function
560
            result = func(*args, **kwargs)
561

562
563
564
565
566
567
568
            # make a _Reults object to store
            # the output. If we are decorating
            # another _FileOrThing, the
            # results will get merged together
            # into a single _Results dict.
            if not isinstance(result, _FileOrThing._Results):
                result = _FileOrThing._Results(result)
569

570
571
            # Load the LOADed outputs
            for oname, ofile in outfiles.items():
572

573
574
                if not op.exists(ofile): oval = None
                else:                    oval = self.__load(ofile)
575

576
                result[oname] = oval
577

578
            return result
579
580


581
    def __prepareArgs(self, workdir, argnames, args, kwargs):
582
583
584
585
586
587
588
        """Prepares all input and output arguments to be passed to the
        decorated function. Any arguments with a value of :data:`LOAD` are
        passed to the ``prepOut`` function specified at :meth:`__init__`.
        All other arguments are passed through the ``prepIn`` function.

        :arg workdir: Directory in which all temporary files should be stored.

589
590
591
        :arg args:    Positional arguments to be passed to the decorated
                      function.

592
593
594
595
        :arg kwargs:  Keyword arguments to be passed to the decorated function.

        :returns:     A tuple containing:

596
597
598
                        - An updated copy of ``args``.

                        - An updated copy of ``kwargs``.
599
600
601

                        - A dictionary of ``{ name : filename }`` mappings,
                          for all arguments with a value of ``LOAD``.
602
603
        """

604
        outfiles = dict()
605

606
607
608
        allargs  = {k : v for k, v in zip(argnames, args)}
        allargs.update(kwargs)

609
610
        if len(self.__things) > 0: things = self.__things
        else:                      things = allargs.keys()
611

612
613
614
        for name in things:

            val = allargs.get(name, None)
615

616
            if val is None:
617
618
                continue

619
            if val is LOAD:
620
621
622
623

                outfile = self.__prepOut(workdir, name, val)

                if outfile is not None:
624
                    allargs[ name] = outfile
625
626
                    outfiles[name] = outfile
            else:
Paul McCarthy's avatar
Paul McCarthy committed
627

628
                infile = self.__prepIn(workdir, name, val)
Paul McCarthy's avatar
Paul McCarthy committed
629

630
                if infile is not None:
631
632
633
634
                    allargs[name] = infile

        args   = [allargs.pop(k) for k in argnames]
        kwargs = allargs
635

636
        return args, kwargs, outfiles
637
638


Paul McCarthy's avatar
Paul McCarthy committed
639
640
641
def fileOrImage(*imgargs):
    """Decorator which can be used to ensure that any NIfTI images are saved
    to file, and output images can be loaded and returned as ``nibabel``
642
    image objects or :class:`.Image` objects.
Paul McCarthy's avatar
Paul McCarthy committed
643
644
    """

645
646
647
648
649
650
    # keep track of the input argument
    # types on each call, so we know
    # whether to return a fsl.Image or
    # a nibabel image
    intypes = []

651
    def prepIn(workdir, name, val):
Paul McCarthy's avatar
Paul McCarthy committed
652

653
        infile = None
Paul McCarthy's avatar
Paul McCarthy committed
654

655
656
657
658
659
660
        if isinstance(val, (fslimage.Image, nib.nifti1.Nifti1Image)):
            intypes.append(type(val))

        if isinstance(val, fslimage.Image):
            val = val.nibImage

Paul McCarthy's avatar
Paul McCarthy committed
661
        if isinstance(val, nib.nifti1.Nifti1Image):
662
            infile = val.get_filename()
Paul McCarthy's avatar
Paul McCarthy committed
663
664
665

            # in-memory image - we have
            # to save it out to a file
666
667
            if infile is None:
                hd, infile = tempfile.mkstemp(fslimage.defaultExt())
Paul McCarthy's avatar
Paul McCarthy committed
668
                os.close(hd)
669
                val.to_filename(infile)
Paul McCarthy's avatar
Paul McCarthy committed
670

671
        return infile
Paul McCarthy's avatar
Paul McCarthy committed
672

673
674
    def prepOut(workdir, name, val):
        return op.join(workdir, '{}.nii.gz'.format(name))
Paul McCarthy's avatar
Paul McCarthy committed
675

676
    def load(path):
Paul McCarthy's avatar
Paul McCarthy committed
677
678
679
        # create an independent in-memory
        # copy of the image file
        img = nib.load(path)
680
681
682
683
684
685
686
687
688
689
690
691
692
693

        # if any arguments were fsl images,
        # that takes precedence.
        if fslimage.Image in intypes:
            return fslimage.Image(img.get_data(), header=img.header)
        # but if all inputs were file names,
        # nibabel takes precedence
        elif nib.nifti1.Nifti1Image in intypes or len(intypes) == 0:
            return nib.nifti1.Nifti1Image(img.get_data(), None, img.header)

        # this function should not be called
        # under any other circumstances
        else:
            raise RuntimeError('Cannot handle type: {}'.format(intypes))
Paul McCarthy's avatar
Paul McCarthy committed
694

695
696
697
698
    def decorator(func):
        fot = _FileOrThing(func, prepIn, prepOut, load, *imgargs)

        def wrapper(*args, **kwargs):
699
700
701
            result = fot(*args, **kwargs)
            intypes[:] = []
            return result
702
703
704
705

        return _update_wrapper(wrapper, func)

    return decorator
Paul McCarthy's avatar
Paul McCarthy committed
706
707
708
709
710
711
712


def fileOrArray(*arrargs):
    """Decorator which can be used to ensure that any Numpy arrays are saved
    to text files, and output files can be loaded and returned as Numpy arrays.
    """

713
    def prepIn(workdir, name, val):
Paul McCarthy's avatar
Paul McCarthy committed
714

715
        infile = None
Paul McCarthy's avatar
Paul McCarthy committed
716
717

        if isinstance(val, np.ndarray):
718
            hd, infile = tempfile.mkstemp('.txt')
Paul McCarthy's avatar
Paul McCarthy committed
719
            os.close(hd)
720
            np.savetxt(infile, val, fmt='%0.18f')
Paul McCarthy's avatar
Paul McCarthy committed
721

722
        return infile
Paul McCarthy's avatar
Paul McCarthy committed
723

724
725
    def prepOut(workdir, name, val):
        return op.join(workdir, '{}.txt'.format(name))
Paul McCarthy's avatar
Paul McCarthy committed
726

727
    load = np.loadtxt
Paul McCarthy's avatar
Paul McCarthy committed
728

729
730
731
732
733
734
735
736
737
    def decorator(func):
        fot = _FileOrThing(func, prepIn, prepOut, load, *arrargs)

        def wrapper(*args, **kwargs):
            return fot(*args, **kwargs)

        return _update_wrapper(wrapper, func)

    return decorator