core.py 85.2 KB
Newer Older
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
1
2
3
4
5
6
7
8
#!/usr/bin/env
# encoding: utf-8
"""
Author:     Daniel Boeckenhoff
Mail:       daniel.boeckenhoff@ipp.mpg.de

core of tfields library
contains numpy ndarray derived bases of the tfields package
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
9
10

Notes:
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
11
    It could be worthwhile concidering `np.li.mixins.NDArrayOperatorsMixin <https://docs.scipy.org/doc/numpy-1.15.1/reference/generated/numpy.lib.mixins.NDArrayOperatorsMixin.html>`_
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
12
13
14
15
16
17
18
19
20
21
22
"""
import warnings
import os
import pathlib
from six import string_types
from contextlib import contextmanager
from collections import Counter

import numpy as np
import sympy
import scipy as sp
23
import rna
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
24
import tfields.bases
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
25
from nltk.misc.chomsky import objects
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
np.seterr(all='warn', over='raise')


def rank(tensor):
    """
    Tensor rank
    """
    return len(tensor.shape) - 1


def dim(tensor):
    """
    Manifold dimension
    """
    if rank(tensor) == 0:
        return 1
    return tensor.shape[1]


class AbstractNdarray(np.ndarray):
    """
    All tensors and subclasses should derive from AbstractNdarray.
    AbstractNdarray implements all the inheritance specifics for np.ndarray
    Whene inheriting, three attributes are of interest:
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
50
51

    Attributes:
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
52
53
54
55
56
57
58
59
60
61
62
63
64
        __slots__ (list of str): If you want to add attributes to
            your AbstractNdarray subclass, add the attribute name to __slots__
        __slot_defaults__ (list): if __slot_defaults__ is None, the
            defaults for the attributes in __slots__ will be None
            other values will be treaded as defaults to the corresponding
            arg at the same position in the __slots__ list.
        __slotDtype__ (list of types): for the conversion of the
            args in __slots__ to numpy arrays. None values mean no
            conversion.

    Args:
        array (array-like): input array
        **kwargs: arguments corresponding to __slots__
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
65

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
66
67
    TODO:
        equality check
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
68

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
    """
    __slots__ = []
    __slot_defaults__ = []
    __slotDtypes__ = []
    __slot_setters__ = []

    def __new__(cls, array, **kwargs):  # pragma: no cover
        raise NotImplementedError("{clsType} type must implement '__new__'"
                                  .format(clsType=type(cls)))

    def __array_finalize__(self, obj):
        if obj is None:
            return
        for attr in self._iter_slots():
            setattr(self, attr, getattr(obj, attr, None))

    def __array_wrap__(self, out_arr, context=None):
        return np.ndarray.__array_wrap__(self, out_arr, context)

    @classmethod
    def _iter_slots(cls):
        return [att for att in cls.__slots__ if att != '_cache']

    @classmethod
    def _update_slot_kwargs(cls, kwargs):
        """
        set the defaults in kwargs according to __slot_defaults__
        and convert the kwargs according to __slotDtypes__
        """
        slotDefaults = cls.__slot_defaults__ + \
            [None] * (len(cls.__slots__) - len(cls.__slot_defaults__))
        slotDtypes = cls.__slotDtypes__ + \
            [None] * (len(cls.__slots__) - len(cls.__slotDtypes__))
        for attr, default, dtype in zip(cls.__slots__, slotDefaults, slotDtypes):
            if attr == '_cache':
                continue
            if attr not in kwargs:
                kwargs[attr] = default
            if dtype is not None:
                try:
                    kwargs[attr] = np.array(kwargs[attr], dtype=dtype)
                except Exception as err:
                    raise ValueError(str(attr) + str(dtype) + str(kwargs[attr]) + str(err))

    def __setattr__(self, name, value):
        if name in self.__slots__:
            index = self.__slots__.index(name)
            try:
                setter = self.__slot_setters__[index]
            except IndexError:
                setter = None
            if setter is not None:
                value = setter(value)
        super(AbstractNdarray, self).__setattr__(name, value)

    def __reduce__(self):
        """
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
126
127
        important for pickling (see `here <https://stackoverflow.com/questions/26598109/preserve-custom-attributes-when-pickling-subclass-of-numpy-array>`_)

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
128
129
130
131
132
133
        Examples:
            >>> from tempfile import NamedTemporaryFile
            >>> import pickle
            >>> import tfields

            Build a dummy scalar field
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
134

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
135
136
137
            >>> from tfields import Tensors, TensorFields
            >>> scalars = Tensors([0, 1, 2])
            >>> vectors = Tensors([[0, 0, 0], [0, 0, 1], [0, -1, 0]])
138
            >>> scalar_field = TensorFields(vectors, scalars, coord_sys='cylinder')
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
139
140

            Save it and restore it
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
141

142
            >>> out_file = NamedTemporaryFile(suffix='.pickle')
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
143

144
            >>> pickle.dump(scalar_field,
145
146
            ...             out_file)
            >>> _ = out_file.seek(0)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
147

148
            >>> sf = pickle.load(out_file)
149
            >>> sf.coord_sys == 'cylinder'
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
            True
            >>> sf.fields[0][2] == 2.
            True

        """
        # Get the parent's __reduce__ tuple
        pickled_state = super(AbstractNdarray, self).__reduce__()

        # Create our own tuple to pass to __setstate__
        new_state = pickled_state[2] + tuple([getattr(self, slot) for slot in
                                              self._iter_slots()])

        # Return a tuple that replaces the parent's __setstate__ tuple with our own
        return (pickled_state[0], pickled_state[1], new_state)

    def __setstate__(self, state):
        """
167
        Counterpart to __reduce__. Important for unpickling.
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
168
169
        """
        # Call the parent's __setstate__ with the other tuple elements.
170
171
        # numpy ndarray state has 5 entries
        super(AbstractNdarray, self).__setstate__(state[:5])
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
172
173

        # set the __slot__ attributes
174
175
176
177
178
179
180
181
182
183
184
        valid_slot_attrs = list(self._iter_slots())
        added_slot_attrs = ['name']  # attributes that have been added later
                                     # have not been pickled with the full
                                     # information and thus need to be
                                     # excluded from the __setstate__
                                     # need to be in the same order as they have
                                     # been added to __slots__
        n_old = len(valid_slot_attrs) - len(state[5:])
        if n_old > 0:
            for latest_index in range(n_old):
                new_slot = added_slot_attrs[-latest_index]
185
                warnings.warn("Slots with names '{new_slot}' appears to have been "
186
187
188
189
190
191
192
193
194
                              "added after the creation of the reduced state. "
                              "No corresponding state found in __setstate__."
                              .format(**locals()))
                valid_slot_attrs.pop(valid_slot_attrs.index(new_slot))
                setattr(self, new_slot, None)

        for slot_index, slot in enumerate(valid_slot_attrs):
            state_index = 5 + slot_index
            setattr(self, slot, state[state_index])
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
195

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
196
197
198
199
200
201
202
203
    @property
    def bulk(self):
        """
        The pure ndarray version of the actual state
            -> nothing attached
        """
        return np.array(self)

204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
    @classmethod
    @contextmanager
    def _bypass_setter(cls, slot, demand_existence=False):
        """
        Temporarily remove the setter in __slot_setters__ corresponding to slot
        position in __slot__. You should know what you do, when using this.
        """
        slot_index = cls.__slots__.index(slot) if slot in cls.__slots__ else None
        if slot_index is None:
            if demand_existence:
                raise ValueError("Slot {slot} not existing".format(**locals()))
            else:
                yield
                return
        setter = cls.__slot_setters__[slot_index]
        cls.__slot_setters__[slot_index] = None
        yield
        cls.__slot_setters__[slot_index] = setter

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
223
224
225
    def copy(self, *args, **kwargs):
        """
        The standard ndarray copy does not copy slots. Correct for this.
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
226

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
227
228
229
230
231
232
233
234
235
236
237
        Examples:
            >>> import tfields
            >>> m = tfields.TensorMaps([[1,2,3], [3,3,3], [0,0,0], [5,6,7]],
            ...                        maps=[tfields.TensorFields([[0, 1, 2], [1, 2, 3]],
            ...                                                   [1, 2])])
            >>> mc = m.copy()
            >>> mc is m
            False
            >>> mc.maps[0].fields[0] is m.maps[0].fields[0]
            False

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
238
239
        TODO:
            This function implementation could be more general or maybe redirect to deepcopy?
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
240
241
242
243
        """
        inst = super(AbstractNdarray, self).copy(*args, **kwargs)
        for attr in self._iter_slots():
            value = getattr(self, attr)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
244
            if hasattr(value, 'copy') and not isinstance(value, list):
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
                setattr(inst, attr, value.copy(*args, **kwargs))
            elif isinstance(value, list):
                list_copy = []
                for item in value:
                    if hasattr(item, 'copy'):
                        list_copy.append(item.copy(*args, **kwargs))
                    else:
                        list_copy.append(item)
                setattr(inst, attr, list_copy)

        return inst

    def save(self, path, *args, **kwargs):
        """
        Saving a tensors object by redirecting to the correct save method depending on path
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
260

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
261
262
263
264
265
266
267
268
269
        Args:
            path (str or buffer)
            *args:
                forwarded to extension specific method
            **kwargs:
                extension (str): only needed if path is buffer
                ... remaining:forwarded to extension specific method
        """
        # get the extension
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
270
        if isinstance(path, (string_types, pathlib.Path)):
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
271
            extension = pathlib.Path(path).suffix.lstrip('.')
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
272
273
274
        else:
            raise ValueError("Wrong path type {0}".format(type(path)))
        path = str(path)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
275
276
277
278
279
280
281
282
283

        # get the save method
        try:
            save_method = getattr(self,
                                  '_save_{extension}'.format(**locals()))
        except:
            raise NotImplementedError("Can not find save method for extension: "
                                      "{extension}.".format(**locals()))

284
        path = rna.path.resolve(path)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
285
286
287
288
289
290
        return save_method(path, **kwargs)

    @classmethod
    def load(cls, path, *args, **kwargs):
        """
        load a file as a tensors object.
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
291

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
292
293
294
295
296
297
298
299
        Args:
            path (str or buffer)
            *args:
                forwarded to extension specific method
            **kwargs:
                extension (str): only needed if path is buffer
                ... remaining:forwarded to extension specific method
        """
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
300
        if isinstance(path, (string_types, pathlib.Path)):
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
301
            extension = pathlib.Path(path).suffix.lstrip('.')
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
302
            path = str(path)
303
            path = rna.path.resolve(path)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
304
305
        else:
            extension = kwargs.pop('extension', 'npz')
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
306
307
308
309
310
311
312
313
314
315
316
317

        try:
            load_method = getattr(cls, '_load_{e}'.format(e=extension))
        except:
            raise NotImplementedError("Can not find load method for extension: "
                                      "{extension}.".format(**locals()))
        return load_method(path, *args, **kwargs)

    def _save_npz(self, path, **kwargs):
        """
        Args:
            path (open file or str/unicode): destination to save file to.
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
318

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
319
        Examples:
320
            Build some dummies:
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
321
322
            >>> import tfields
            >>> from tempfile import NamedTemporaryFile
323
            >>> out_file = NamedTemporaryFile(suffix='.npz')
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
324
325
326
            >>> p = tfields.Points3D([[1., 2., 3.], [4., 5., 6.], [1, 2, -6]],
            ...                      name='my_points')
            >>> scalars = tfields.Tensors([0, 1, 2], name=42)
327
328
329
330
331
332
333
334
            >>> vectors = tfields.Tensors([[0, 0, 0], [0, 0, 1], [0, -1, 0]])
            >>> maps = [tfields.TensorFields([[0, 1, 2], [0, 1, 2]], [42, 21]),
            ...         tfields.TensorFields([[1], [2]], [-42, -21])]
            >>> m = tfields.TensorMaps(vectors, scalars,
            ...                        maps=maps)

            Simply give the file name to save
            >>> p.save(out_file.name)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
335
            >>> _ = out_file.seek(0)  # this is only necessary in the test
336
            >>> p1 = tfields.Points3D.load(out_file.name)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
337
            >>> assert p.equal(p1)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
338
            >>> assert p.coord_sys == p1.coord_sys
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
339

340
341
342
343
344
345
            The fully nested structure of a TensorMaps object is reconstructed
            >>> out_file_maps = NamedTemporaryFile(suffix='.npz')
            >>> m.save(out_file_maps.name)
            >>> _ = out_file_maps.seek(0)
            >>> m1 = tfields.TensorMaps.load(out_file_maps.name)
            >>> assert m.equal(m1)
346
            >>> assert m.maps[0].dtype == m1.maps[0].dtype
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
347

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
348
349
350
351
352
            Names are preserved
            >>> assert p.name == 'my_points'
            >>> m.names
            [42]

353
        """
354
355
        content_dict = self._as_dict()
        np.savez(path, **content_dict)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
356
357
358
359
360
361
362
363

    @classmethod
    def _load_npz(cls, path, **load_kwargs):
        """
        Factory method
        Given a path to a npz file, construct the object
        """
        np_file = np.load(path, **load_kwargs)
364
365
366
367
368
369
370
        return cls._from_dict(**np_file)

    def _as_dict(self):
        """
        Recursively walk trough all __slots__ and describe all elements
        """
        d = {}
371
        d['bulk'] = self.bulk
372
373
374
375
376
377
378
379
380
381
382
        d['bulk_type'] = self.__class__.__name__
        for attr in self._iter_slots():
            value = getattr(self, attr)
            if isinstance(value, list):
                if len(value) == 0:
                    d[attr] = None
                if all([isinstance(part, AbstractNdarray) for part in value]):
                    for i, part in enumerate(value):
                        part_dict = part._as_dict()
                        for part_attr, part_value in part_dict.items():
                            d["{attr}::{i}::{part_attr}".format(**locals())] = part_value
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
383
                    continue
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
            if isinstance(value, AbstractNdarray):
                value = value._as_dict()
            d[attr] = value
        return d

    @classmethod
    def _from_dict(cls, **d):
        """
        Opposite of _as_dict
        """
        list_dict = {}
        kwargs = {}
        '''
        De-Flatten the first layer of lists
        '''
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
399
        for key in sorted(list(d)):
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
            if '::' in key:
                splits = key.split('::')
                attr, _, end = key.partition('::')
                if attr not in list_dict:
                    list_dict[attr] = {}

                index, _, end = end.partition('::')
                if not index.isdigit():
                    raise ValueError("None digit index given")
                index = int(index)
                if index not in list_dict[attr]:
                    list_dict[attr][index] = {}
                list_dict[attr][index][end] = d[key]
            else:
                kwargs[key] = d[key]

        '''
        Build the lists (recursively)
        '''
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
419
        for key in list(list_dict):
420
421
            sub_dict = list_dict[key]
            list_dict[key] = []
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
422
            for index in sorted(list(sub_dict)):
Priyanjana Sinha's avatar
Priyanjana Sinha committed
423
424
425
426
427
                bulk_type = sub_dict[index].get('bulk_type').tolist()
                if isinstance(bulk_type, bytes):
                    # asthonishingly, this is not necessary under linux. Found under nt. ???
                    bulk_type = bulk_type.decode('UTF-8')
                bulk_type = getattr(tfields, bulk_type)
428
429
                list_dict[key].append(bulk_type._from_dict(**sub_dict[index]))

430
431
432
433
434
435
436
437
438
439
440
441
442
        with cls._bypass_setter('fields'):
            '''
            Build the normal way
            '''
            bulk = kwargs.pop('bulk')
            bulk_type = kwargs.pop('bulk_type')
            obj = cls.__new__(cls, bulk, **kwargs)

            '''
            Set list attributes
            '''
            for attr, list_value in list_dict.items():
                setattr(obj, attr, list_value)
443
        return obj
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
444
445
446
447
448


class Tensors(AbstractNdarray):
    """
    Set of tensors with the same basis.
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
449

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
450
451
    TODO:
        all slot args should be protected -> _base
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
452

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
453
454
    Args:
        tensors: np.ndarray or AbstractNdarray subclass
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
455

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
456
457
    Examples:
        >>> import numpy as np
458
        >>> import tfields
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
459
460

        Initialize a scalar range
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
461

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
462
463
464
465
466
        >>> scalars = tfields.Tensors([0, 1, 2])
        >>> scalars.rank == 0
        True

        Initialize vectors
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
467

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
468
469
470
471
472
        >>> vectors = tfields.Tensors([[0, 0, 0], [0, 0, 1], [0, -1, 0]])
        >>> vectors.rank == 1
        True
        >>> vectors.dim == 3
        True
473
        >>> assert vectors.coord_sys == 'cartesian'
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
474
475

        Initialize the Levi-Zivita Tensor
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
476

477
478
479
480
        >>> matrices = tfields.Tensors(
        ...                     [[[0, 0, 0], [0, 0, 1], [0, -1, 0]],
        ...                      [[0, 0, -1], [0, 0, 0], [1, 0, 0]],
        ...                      [[0, 1, 0], [-1, 0, 0], [0, 0, 0]]])
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
481
482
483
484
485
486
487
488
        >>> matrices.shape == (3, 3, 3)
        True
        >>> matrices.rank == 2
        True
        >>> matrices.dim == 3
        True

        Initializing in different start coordinate system
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
489

490
491
        >>> cyl = tfields.Tensors([[5, np.arctan(4. / 3.), 42]], coord_sys='cylinder')
        >>> assert cyl.coord_sys == 'cylinder'
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
492
        >>> cyl.transform('cartesian')
493
        >>> assert cyl.coord_sys == 'cartesian'
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
494
495
496
497
498
499
        >>> cart = cyl
        >>> assert round(cart[0, 0], 10) == 3.
        >>> assert round(cart[0, 1], 10) == 4.
        >>> assert cart[0, 2] == 42

        Initialize with copy constructor keeps the coordinate system
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
500

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
501
502
        >>> with vectors.tmp_transform('cylinder'):
        ...     vect_cyl = tfields.Tensors(vectors)
503
504
        ...     assert vect_cyl.coord_sys == vectors.coord_sys
        >>> assert vect_cyl.coord_sys == 'cylinder'
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
505
506

        You can demand a special dimension.
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
507

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
508
509
510
511
512
513
514
515
        >>> _ = tfields.Tensors([[1, 2, 3]], dim=3)
        >>> _ = tfields.Tensors([[1, 2, 3]], dim=2)  # doctest: +ELLIPSIS
        Traceback (most recent call last):
            ...
        ValueError: Incorrect dimension: 3 given, 2 demanded.

        The dimension argument (dim) becomes necessary if you want to initialize
        an empty array
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
516

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
517
518
519
520
521
522
523
524
        >>> _ = tfields.Tensors([])  # doctest: +ELLIPSIS
        Traceback (most recent call last):
            ...
        ValueError: Empty tensors need dimension parameter 'dim'.
        >>> tfields.Tensors([], dim=7)
        Tensors([], shape=(0, 7), dtype=float64)

    """
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
525
    __slots__ = ['coord_sys', 'name']
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
526
527
528
529
530
531
532
533
534
535
536
537
    __slot_defaults__ = ['cartesian']
    __slot_setters__ = [tfields.bases.get_coord_system_name]

    def __new__(cls, tensors, **kwargs):
        dtype = kwargs.pop('dtype', None)
        order = kwargs.pop('order', None)
        dim = kwargs.pop('dim', None)

        ''' copy constructor extracts the kwargs from tensors'''
        if issubclass(type(tensors), Tensors):
            if dim is not None:
                dim = tensors.dim
538
            coord_sys = kwargs.pop('coord_sys', tensors.coord_sys)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
539
            tensors = tensors.copy()
540
541
            tensors.transform(coord_sys)
            kwargs['coord_sys'] = coord_sys
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
542
            kwargs['name'] = kwargs.pop('name', tensors.name)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
543
544
545
546
            if dtype is None:
                dtype = tensors.dtype
        else:
            if dtype is None:
547
548
549
550
                if hasattr(tensors, 'dtype'):
                    dtype = tensors.dtype
                else:
                    dtype = np.float64
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579

        ''' demand iterable structure '''
        try:
            len(tensors)
        except TypeError as err:
            raise TypeError("Iterable structure necessary."
                            " Got {tensors}"
                            .format(**locals()))

        ''' process empty inputs '''
        if len(tensors) == 0:
            if issubclass(type(tensors), tfields.Tensors):
                tensors = np.empty(tensors.shape, dtype=tensors.dtype)
            elif dim is not None:
                tensors = np.empty((0, dim))
            if issubclass(type(tensors), np.ndarray):
                # np.empty
                pass
            else:
                raise ValueError("Empty tensors need dimension "
                                 "parameter 'dim'.")

        tensors = np.asarray(tensors, dtype=dtype, order=order)
        obj = tensors.view(cls)

        ''' check dimension(s) '''
        for d in obj.shape[1:]:
            if not d == obj.dim:
                raise ValueError("Dimensions are inconstistent. "
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
580
                                 "Manifold dimension is {obj.dim}. "
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
                                 "Found dimensions {found} in {obj}."
                                 .format(found=obj.shape[1:], **locals()))
        if dim is not None:
            if dim != obj.dim:
                raise ValueError("Incorrect dimension: {obj.dim} given,"
                                 " {dim} demanded."
                                 .format(**locals()))

        ''' update kwargs with defaults from slots '''
        cls._update_slot_kwargs(kwargs)

        ''' set kwargs to slots attributes '''
        for attr in kwargs:
            if attr not in cls._iter_slots():
                raise AttributeError("Keyword argument {attr} not accepted "
                                     "for class {cls}".format(**locals()))
            setattr(obj, attr, kwargs[attr])

        return obj

601
602
603
604
    def __iter__(self):
        """
        Forwarding iterations to the bulk array. Otherwise __getitem__ would
        kick in and slow down imensely.
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
605

606
607
608
609
610
611
612
613
614
615
616
        Examples:
            >>> import tfields
            >>> vectors = tfields.Tensors([[0, 0, 0], [0, 0, 1], [0, -1, 0]])
            >>> scalar_field = tfields.TensorFields(vectors, [42, 21, 10.5], [1, 2, 3])
            >>> [(point.rank, point.dim) for point in scalar_field]
            [(0, 1), (0, 1), (0, 1)]

        """
        for index in range(len(self)):
            yield super(Tensors, self).__getitem__(index).view(Tensors)

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
617
618
619
620
621
622
623
624
625
626
627
628
    @classmethod
    def merged(cls, *objects, **kwargs):
        """
        Factory method
        Merges all tensor inputs to one tensor

        Examples:
            >>> import numpy as np
            >>> import tfields
            >>> import tfields.bases

            Use of most frequent coordinate system
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
629

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
630
            >>> vec_a = tfields.Tensors([[0, 0, 0], [0, 0, 1], [0, -1, 0]])
631
632
            >>> vec_b = tfields.Tensors([[5, 4, 1]], coord_sys=tfields.bases.cylinder)
            >>> vec_c = tfields.Tensors([[4, 2, 3]], coord_sys=tfields.bases.cylinder)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
633
            >>> merge = tfields.Tensors.merged(vec_a, vec_b, vec_c, [[2, 0, 1]])
634
            >>> assert merge.coord_sys == 'cylinder'
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
635
636
637
638
639
640
641
642
            >>> assert merge.equal([[0, 0, 0],
            ...                     [0, 0, 1],
            ...                     [1, -np.pi / 2, 0],
            ...                     [5, 4, 1],
            ...                     [4, 2, 3],
            ...                     [2, 0, 1]])

            Merge also shifts the maps to still refer to the same tensors
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
643

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
644
645
            >>> tm_a = tfields.TensorMaps(merge, maps=[[[0, 1, 2]]])
            >>> tm_b = tm_a.copy()
646
            >>> assert tm_a.coord_sys == 'cylinder'
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
647
            >>> tm_merge = tfields.TensorMaps.merged(tm_a, tm_b)
648
            >>> assert tm_merge.coord_sys == 'cylinder'
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
649
650
651
652
653
            >>> assert tm_merge.maps[0].equal([[0, 1, 2],
            ...                               list(range(len(merge),
            ...                                          len(merge) + 3,
            ...                                          1))])
            
654
            >>> obj_list = [tfields.Tensors([[1, 2, 3]], coord_sys=tfields.bases.CYLINDER),
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
655
656
            ...             tfields.Tensors([[3] * 3]),
            ...             tfields.Tensors([[5, 1, 3]])]
657
            >>> merge2 = tfields.Tensors.merged(*obj_list, coord_sys=tfields.bases.CARTESIAN)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
658
659
            >>> assert merge2.equal([[-0.41614684, 0.90929743, 3.],
            ...                      [3, 3, 3], [5, 1, 3]], atol=1e-8)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
660

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
661
662
        """

663
664
        ''' get most frequent coord_sys or predefined coord_sys '''
        coord_sys = kwargs.get('coord_sys', None)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
665
        dimension = kwargs.get('dim', None)
666
        if coord_sys is None:
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
667
668
669
            bases = []
            for t in objects:
                try:
670
                    bases.append(t.coord_sys)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
671
672
673
                except AttributeError:
                    pass
            if bases:
674
675
676
                # get most frequent coord_sys
                coord_sys = sorted(bases, key=Counter(bases).get, reverse=True)[0]
                kwargs['coord_sys'] = coord_sys
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
677
            else:
678
679
                default = cls.__slot_defaults__[cls.__slots__.index('coord_sys')]
                kwargs['coord_sys'] = default
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
680

681
        ''' transform all raw inputs to cls type with correct coord_sys. Also
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
682
683
        automatically make a copy of those instances that are of the correct
        type already.'''
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
684
        objects = [cls.__new__(cls, t, **kwargs) for t in objects]
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708

        ''' check rank and dimension equality '''
        if not len(set([t.rank for t in objects])) == 1:
            raise TypeError("Tensors must have the same rank for merging.")
        if not len(set([t.dim for t in objects])) == 1:
            raise TypeError("Tensors must have the same dimension for merging.")

        ''' merge all objects '''
        remainingObjects = objects[1:] or []
        tensors = objects[0]

        for i, obj in enumerate(remainingObjects):
            tensors = np.append(tensors, obj, axis=0)

        if len(tensors) == 0 and dimension is None:
            for obj in objects:
                kwargs['dim'] = dim(obj)

        return cls.__new__(cls, tensors, **kwargs)

    @classmethod
    def grid(cls, *base_vectors, **kwargs):
        """
        Args:
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
709
710
711
712
713
714
715
716
717
718
719
720
721
722
            *base_vectors (Iterable): base coordinates. The amount of base
                vectors defines the dimension

            **kwargs:
                iter_order (list): order in which the iteration will be done.
                    Frequency rises with position in list. default is [0, 1, 2]
                    iteration will be done like::
                          
                    for v0 in base_vectors[iter_order[0]]:
                        for v1 in base_vectors[iter_order[1]]:
                            for v2 in base_vectors[iter_order[2]]:
                                coords0.append(locals()['v%i' % iter_order[0]])
                                coords1.append(locals()['v%i' % iter_order[1]])
                                coords2.append(locals()['v%i' % iter_order[2]])
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
723
724
725

        Examples:
            Initilaize using the mgrid notation
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
726

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
727
728
729
730
731
732
733
734
735
736
737
            >>> import tfields
            >>> mgrid = tfields.Tensors.grid((0, 1, 2j), (3, 4, 2j), (6, 7, 2j))
            >>> mgrid.equal([[0, 3, 6],
            ...              [0, 3, 7],
            ...              [0, 4, 6],
            ...              [0, 4, 7],
            ...              [1, 3, 6],
            ...              [1, 3, 7],
            ...              [1, 4, 6],
            ...              [1, 4, 7]])
            True
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
738
739
740

            Lists or arrays are accepted also.
            Furthermore, the iteration order can be changed
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
741

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
            >>> lins = tfields.Tensors.grid(np.linspace(3, 4, 2), np.linspace(0, 1, 2),
            ...                             np.linspace(6, 7, 2), iter_order=[1, 0, 2])
            >>> lins.equal([[3, 0, 6],
            ...             [3, 0, 7],
            ...             [4, 0, 6],
            ...             [4, 0, 7],
            ...             [3, 1, 6],
            ...             [3, 1, 7],
            ...             [4, 1, 6],
            ...             [4, 1, 7]])
            True
            >>> lins2 = tfields.Tensors.grid(np.linspace(0, 1, 2),
            ...                              np.linspace(3, 4, 2),
            ...                              np.linspace(6, 7, 2),
            ...                              iter_order=[2, 0, 1])
            >>> lins2.equal([[0, 3, 6],
            ...              [0, 4, 6],
            ...              [1, 3, 6],
            ...              [1, 4, 6],
            ...              [0, 3, 7],
            ...              [0, 4, 7],
            ...              [1, 3, 7],
            ...              [1, 4, 7]])
            True

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
767
768
            When given the coord_sys argument, the grid is performed in the
            given coorinate system:
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
769

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
770
771
772
773
774
775
776
777
778
            >>> lins3 = tfields.Tensors.grid(np.linspace(4, 9, 2),
            ...                              np.linspace(np.pi/2, np.pi/2, 1),
            ...                              np.linspace(4, 4, 1),
            ...                              iter_order=[2, 0, 1],
            ...                              coord_sys=tfields.bases.CYLINDER)
            >>> assert lins3.coord_sys == 'cylinder'
            >>> lins3.transform('cartesian')
            >>> assert np.array_equal(lins3[:, 1], [4, 9])

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
779
        """
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
780
        cls_kwargs = {attr: kwargs.pop(attr) for attr in list(kwargs) if attr in cls.__slots__}
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
781
782
783
        inst = cls.__new__(cls,
                           tfields.lib.grid.igrid(*base_vectors, **kwargs),
                           **cls_kwargs)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
        return inst

    @property
    def rank(self):
        """
        Tensor rank
        """
        return rank(self)

    @property
    def dim(self):
        """
        Manifold dimension
        """
        return dim(self)

800
    def transform(self, coord_sys):
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
801
802
        """
        Args:
803
            coord_sys (str)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
804
805
806
807
808
809
810
811
812
813

        Examples:
            >>> import numpy as np
            >>> import tfields

            CARTESIAN to SPHERICAL
            >>> t = tfields.Tensors([[1, 2, 2], [1, 0, 0], [0, 0, -1], [0, 0, 1], [0, 0, 0]])
            >>> t.transform('spherical')

            r
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
814

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
815
816
817
            >>> assert t[0, 0] == 3

            phi
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
818

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
819
820
821
822
            >>> assert t[1, 1] == 0.
            >>> assert t[2, 1] == 0.

            theta is 0 at (0, 0, 1) and pi / 2 at (0, 0, -1)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
823

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
824
825
826
827
828
            >>> assert round(t[1, 2], 10) == round(0, 10)
            >>> assert t[2, 2] == -np.pi / 2
            >>> assert t[3, 2] == np.pi / 2

            theta is defined 0 for R == 0
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
829

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
830
831
832
833
834
            >>> assert t[4, 0] == 0.
            >>> assert t[4, 2] == 0.


            CARTESIAN to CYLINDER
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
835

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
836
837
838
            >>> tCart = tfields.Tensors([[3, 4, 42], [1, 0, 0], [0, 1, -1], [-1, 0, 1], [0, 0, 0]])
            >>> t_cyl = tCart.copy()
            >>> t_cyl.transform('cylinder')
839
            >>> assert t_cyl.coord_sys == 'cylinder'
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
840
841

            R
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
842

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
843
844
845
846
847
848
            >>> assert t_cyl[0, 0] == 5
            >>> assert t_cyl[1, 0] == 1
            >>> assert t_cyl[2, 0] == 1
            >>> assert t_cyl[4, 0] == 0

            Phi
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
849
            
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
850
851
852
853
854
855
            >>> assert round(t_cyl[0, 1], 10) == round(np.arctan(4. / 3), 10)
            >>> assert t_cyl[1, 1] == 0
            >>> assert round(t_cyl[2, 1], 10) == round(np.pi / 2, 10)
            >>> assert t_cyl[1, 1] == 0

            Z
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
856
            
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
857
858
859
860
            >>> assert t_cyl[0, 2] == 42
            >>> assert t_cyl[2, 2] == -1

            >>> t_cyl.transform('cartesian')
861
            >>> assert t_cyl.coord_sys == 'cartesian'
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
862
863
864
865
            >>> assert t_cyl[0, 0] == 3

        """
        #           scalars                 empty             already there
866
867
        if self.rank == 0 or self.shape[0] == 0 or self.coord_sys == coord_sys:
            self.coord_sys = coord_sys
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
868
869
            return

870
871
872
        tfields.bases.transform(self, self.coord_sys, coord_sys)
        # self[:] = tfields.bases.transform(self, self.coord_sys, coord_sys)
        self.coord_sys = coord_sys
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
873
874

    @contextmanager
875
    def tmp_transform(self, coord_sys):
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
876
        """
877
        Temporarily change the coord_sys to another coord_sys and change it back at exit
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
878
879
        This method is for cleaner code only.
        No speed improvements go with this.
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
880

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
881
882
        Args:
            see transform
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
883

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
884
885
        Examples:
            >>> import tfields
886
            >>> p = tfields.Tensors([[1,2,3]], coord_sys=tfields.bases.SPHERICAL)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
887
            >>> with p.tmp_transform(tfields.bases.CYLINDER):
888
889
            ...     assert p.coord_sys == tfields.bases.CYLINDER
            >>> assert p.coord_sys == tfields.bases.SPHERICAL
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
890
891

        """
892
893
        baseBefore = self.coord_sys
        if baseBefore == coord_sys:
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
894
895
            yield
        else:
896
            self.transform(coord_sys)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
897
898
899
900
901
902
903
904

            yield

            self.transform(baseBefore)

    def mirror(self, coordinate, condition=None):
        """
        Reflect/Mirror the entries meeting <condition> at <coordinate> = 0
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
905

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
906
907
        Args:
            coordinate (int): coordinate index
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
908

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
909
910
911
912
913
914
        Examples:
            >>> import tfields
            >>> p = tfields.Tensors([[1., 2., 3.], [4., 5., 6.], [1, 2, -6]])
            >>> p.mirror(1)
            >>> assert p.equal([[1, -2, 3], [4, -5,  6], [1, -2, -6]])

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
915
916
            multiple coordinates can be mirrored at the same time
            i.e. a point mirrorion would be
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
917

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
918
919
920
921
922
923
            >>> p = tfields.Tensors([[1., 2., 3.], [4., 5., 6.], [1, 2, -6]])
            >>> p.mirror([0,2])
            >>> assert p.equal([[-1, 2, -3], [-4, 5, -6], [-1, 2., 6.]])

            You can give a condition as mask or as str.
            The mirroring will only be applied to the points meeting the condition.
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
924

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
925
926
            >>> import sympy
            >>> x, y, z = sympy.symbols('x y z')
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
927
            >>> p.mirror([0, 2], y > 3)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
928
929
930
931
932
933
934
935
936
937
            >>> p.equal([[-1, 2, -3], [4, 5, 6], [-1, 2, 6]])
            True

        """
        if condition is None:
            condition = np.array([True for i in range(len(self))])
        elif isinstance(condition, sympy.Basic):
            condition = self.evalf(condition)
        if isinstance(coordinate, list) or isinstance(coordinate, tuple):
            for c in coordinate:
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
938
                self.mirror(c, condition=condition)
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
939
940
941
942
943
944
        elif isinstance(coordinate, int):
            self[:, coordinate][condition] *= -1
        else:
            raise TypeError()

    def to_segment(self, segment, num_segments, coordinate,
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
945
                   periodicity=2 * np.pi, offset=0.,
946
                   coord_sys=None):
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
947
948
949
950
951
        """
        For circular (close into themself after
        <periodicity>) coordinates at index <coordinate> assume
        <num_segments> segments and transform all values to
        segment number <segment>
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
952

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
953
954
955
956
957
958
        Args:
            segment (int): segment index (starting at 0)
            num_segments (int): number of segments
            coordinate (int): coordinate index
            periodicity (float): after what lenght, the coordiante repeats
            offset (float): offset in the mapping
959
            coord_sys (str or sympy.CoordinateSystem): in which coord sys the
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
960
                transformation should be done
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
961

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
962
963
964
965
966
        Examples:
            >>> import tfields
            >>> import numpy as np
            >>> pStart = tfields.Points3D([[6, 2 * np.pi, 1],
            ...                            [6, 2 * np.pi / 5 * 3, 1]],
967
            ...                           coord_sys='cylinder')
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
968
969
970
971
972
973
974
975
976
977
978
979
            >>> p = tfields.Points3D(pStart)
            >>> p.to_segment(0, 5, 1, offset=-2 * np.pi / 10)
            >>> assert np.array_equal(p[:, 1], [0, 0])

            >>> p2 = tfields.Points3D(pStart)
            >>> p2.to_segment(1, 5, 1, offset=-2 * np.pi / 10)
            >>> assert np.array_equal(np.round(p2[:, 1], 4), [1.2566] * 2)

        """
        if segment > num_segments - 1:
            raise ValueError("Segment {0} not existent.".format(segment))

980
981
982
        if coord_sys is None:
            coord_sys = self.coord_sys
        with self.tmp_transform(coord_sys):
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
983
984
985
986
987
988
989
990
991
992
            # map all values to first segment
            self[:, coordinate] = \
                (self[:, coordinate] - offset) % (periodicity / num_segments) + \
                offset + segment * periodicity / num_segments

    def equal(self, other,
              rtol=None, atol=None, equal_nan=False,
              return_bool=True):
        """
        Evaluate, whether the instance has the same content as other.
Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
993

Daniel Boeckenhoff's avatar
Daniel Boeckenhoff committed
994
995
996
997
998
999
1000
        Args:
            optional:
                rtol (float)
                atol (float)
                equal_nan (bool)
            see numpy.isclose
        """
For faster browsing, not all history is shown. View entire blame