cast_axis_to_tuple.py 1.18 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# D2O
# Copyright (C) 2016  Theo Steininger
#
# Author: Theo Steininger
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
theos's avatar
theos committed
18
19
20
21

import numpy as np


22
def cast_axis_to_tuple(axis, length):
theos's avatar
theos committed
23
24
25
    if axis is None:
        return None
    try:
26
        axis = tuple(int(item) for item in axis)
theos's avatar
theos committed
27
28
29
30
    except(TypeError):
        if np.isscalar(axis):
            axis = (int(axis), )
        else:
theos's avatar
theos committed
31
32
            raise TypeError(
                "ERROR: Could not convert axis-input to tuple of ints")
33
34
35

    # shift negative indices to positive ones
    axis = tuple(item if (item >= 0) else (item + length) for item in axis)
theos's avatar
theos committed
36
    return axis