wrapperutils.py 24 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, singlechar_args=False, **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

243
244
245
    :arg singlechar_args: If True, single character arguments always take a single
                          hyphen prefix (e.g. -h) regardless of the style

Paul McCarthy's avatar
Paul McCarthy committed
246
247
248
249
250
    :arg kwargs: Arguments to be converted into command-line options.

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

251
252
253
254
    if valsep is None:
        if '=' in style: valsep = ','
        else:            valsep = ' '

Paul McCarthy's avatar
Paul McCarthy committed
255
256
    if style not in ('-', '--', '-=', '--='):
        raise ValueError('Invalid style: {}'.format(style))
257
258
259
260
261
262
263
264
265
    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
266
267
268
269
270

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

    def fmtarg(arg):
271
        if   style in ('-',  '-=') or (singlechar_args and len(arg) == 1):  arg =  '-{}'.format(arg)
272
273
274
        elif style in ('--', '--='): arg = '--{}'.format(arg)
        return arg

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

            val = [str(v) for v in val]
            if   valsep == ' ': return val
            elif valsep == '"': return [' '   .join(val)]
            else:               return [valsep.join(val)]
284
        else:
285
286
287
288
289
290
291
292
            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
293
294
295
296
297
298

    args = []

    for k, v in kwargs.items():

        k    = argmap.get(k, k)
Paul McCarthy's avatar
Paul McCarthy committed
299
300
301
        mapv = valmap.get(k, fmtval(v))
        k    = fmtarg(k)

302

303
304
305
306
        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)
307
        else:
308
            args.extend(fmtargval(k, mapv))
309
310
311
312

    return args


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

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

322
323
324
325
326
327
328
329
330
331
    # 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?

332
333
    # Remove any decorators
    # from the function
Paul McCarthy's avatar
Paul McCarthy committed
334
335
    func = _unwrap(func)

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

344
345
    # But getargspec is deprecated
    # in python 3.x
Paul McCarthy's avatar
Paul McCarthy committed
346
347
348
349
350
351
    else:

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

356
357
358
    # we only care about the arguments
    # that are being passed in
    argnames = argnames[:len(args)]
359

360
361
362
363
    # 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)]
364

365
    return argnames
366
367


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


Paul McCarthy's avatar
Paul McCarthy committed
374
375
376
377
378
379
380
381
382
383
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.

384

Paul McCarthy's avatar
Paul McCarthy committed
385
386
387
388
389
390
391
392
393
394
395
396
    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.

397

Paul McCarthy's avatar
Paul McCarthy committed
398
    **Outputs**
399
400


Paul McCarthy's avatar
Paul McCarthy committed
401
    If an argument is given the special :data:`LOAD` value, it is assumed
Paul McCarthy's avatar
Paul McCarthy committed
402
403
404
    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
405
    and any other arguments with a value of ``LOAD``).
Paul McCarthy's avatar
Paul McCarthy committed
406
407
408
409
410
411


    **Return value**


    Functions decorated with a ``_FileOrThing`` decorator will always return a
412
413
414
415
416
    ``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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440


    **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)

441
442
            return 'Done'

Paul McCarthy's avatar
Paul McCarthy committed
443
444
445
446

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

447

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

453
454
455
456
457
458
459
460
461
        # 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
462

463
464
465
466
467
468
469
470
471
        # 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
472
473
474
475
476
477
478
479
480


    ``_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
481
    **as long as** they do not manipulate the return value.
482
483
484
    """


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
    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


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

506
507
        :arg func:    The function to be decorated.

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

511
512
        :arg prepOut: Function which generates a file name to use for
                      arguments that were set to :data:`LOAD`.
513

514
515
516
        :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.
517

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

        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
528

529
530
531
532
          - The name of the keyword argument to be processed

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


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

545
        All other arguments are passed through to ``func``.
546
        """
Paul McCarthy's avatar
Paul McCarthy committed
547

548
549
        func     = self.__func
        argnames = namedPositionals(func, args)
550
551

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

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

            # Call the function
563
            result = func(*args, **kwargs)
564

565
566
567
568
569
570
571
            # 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)
572

573
574
            # Load the LOADed outputs
            for oname, ofile in outfiles.items():
575

576
577
                if not op.exists(ofile): oval = None
                else:                    oval = self.__load(ofile)
578

579
                result[oname] = oval
580

581
            return result
582
583


584
    def __prepareArgs(self, workdir, argnames, args, kwargs):
585
586
587
588
589
590
591
        """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.

592
593
594
        :arg args:    Positional arguments to be passed to the decorated
                      function.

595
596
597
598
        :arg kwargs:  Keyword arguments to be passed to the decorated function.

        :returns:     A tuple containing:

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

                        - An updated copy of ``kwargs``.
602
603
604

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

607
        outfiles = dict()
608

609
610
611
        allargs  = {k : v for k, v in zip(argnames, args)}
        allargs.update(kwargs)

612
613
        if len(self.__things) > 0: things = self.__things
        else:                      things = allargs.keys()
614

615
616
617
        for name in things:

            val = allargs.get(name, None)
618

619
            if val is None:
620
621
                continue

622
            if val is LOAD:
623
624
625
626

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

                if outfile is not None:
627
                    allargs[ name] = outfile
628
629
                    outfiles[name] = outfile
            else:
Paul McCarthy's avatar
Paul McCarthy committed
630

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

633
                if infile is not None:
634
635
636
637
                    allargs[name] = infile

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

639
        return args, kwargs, outfiles
640
641


Paul McCarthy's avatar
Paul McCarthy committed
642
643
644
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``
645
    image objects or :class:`.Image` objects.
Paul McCarthy's avatar
Paul McCarthy committed
646
647
    """

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

654
    def prepIn(workdir, name, val):
Paul McCarthy's avatar
Paul McCarthy committed
655

656
        infile = None
Paul McCarthy's avatar
Paul McCarthy committed
657

658
659
660
661
662
663
        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
664
        if isinstance(val, nib.nifti1.Nifti1Image):
665
            infile = val.get_filename()
Paul McCarthy's avatar
Paul McCarthy committed
666
667
668

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

674
        return infile
Paul McCarthy's avatar
Paul McCarthy committed
675

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

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

        # 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
697

698
699
700
701
    def decorator(func):
        fot = _FileOrThing(func, prepIn, prepOut, load, *imgargs)

        def wrapper(*args, **kwargs):
702
703
704
            result = fot(*args, **kwargs)
            intypes[:] = []
            return result
705
706
707
708

        return _update_wrapper(wrapper, func)

    return decorator
Paul McCarthy's avatar
Paul McCarthy committed
709
710
711
712
713
714
715


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.
    """

716
    def prepIn(workdir, name, val):
Paul McCarthy's avatar
Paul McCarthy committed
717

718
        infile = None
Paul McCarthy's avatar
Paul McCarthy committed
719
720

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

725
        return infile
Paul McCarthy's avatar
Paul McCarthy committed
726

727
728
    def prepOut(workdir, name, val):
        return op.join(workdir, '{}.txt'.format(name))
Paul McCarthy's avatar
Paul McCarthy committed
729

730
    load = np.loadtxt
Paul McCarthy's avatar
Paul McCarthy committed
731

732
733
734
735
736
737
738
739
740
    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