Source code for sknano.core.math._points

# -*- coding: utf-8 -*-
Points class (:mod:`sknano.core.math._points`)

.. currentmodule:: sknano.core.math._points

from __future__ import absolute_import, division, print_function
from __future__ import unicode_literals
__docformat__ = 'restructuredtext en'

from operator import attrgetter

import numpy as np

from sknano.core import UserList
from ._transforms import transformation_matrix
#from sknano.core.geometric_regions import Cuboid  # , Rectangle

__all__ = ['Points']

[docs]class Points(UserList): """Container class for collection of `Point` objects. Parameters ---------- points : {None, sequence, `Points`}, optional if not `None`, then a list of `Point` instance objects or an existing `Points` instance object. """ def __init__(self, points=None): super().__init__(initlist=points) def __str__(self): return repr(self) def __repr__(self): """Return canonical string representation of `Points`.""" return "Points(points={!r})".format(
[docs] def sort(self, key=attrgetter('x', 'y', 'z'), reverse=False): super().sort(key=key, reverse=reverse)
@property def x(self): """Return :math:`x` coordinates of `Point` objects as array.""" return [point.x for point in self] @property def y(self): """Return :math:`y` coordinates of `Point` objects as array.""" return [point.y for point in self] @property def z(self): """Return :math:`z` coordinates of `Point` objects as array.""" return [point.z for point in self]
[docs] def filter(self, condition, invert=False): """Filter `Points` by `condition`. Parameters ---------- condition : array_like, bool Boolean index array having same shape as the initial dimensions of the list of `Points` being indexed. invert : bool, optional If `True`, the boolean array `condition` is inverted element-wise. Returns ------- filtered_points : `Points` If `invert` is `False`, return the elements where `condition` is `True`. If `invert` is `True`, return the elements where `~condition` (i.e., numpy.invert(condition)) is `True`. """ if invert: condition = ~condition return self.__class__(points=np.asarray(self)[condition].tolist())
[docs] def rezero(self, epsilon=1.0e-10): """Set really really small coordinates to zero. Set all coordinates with absolute value less than epsilon to zero. Parameters ---------- epsilon : float smallest allowed absolute value of any :math:`x,y,z` component. """ [point.rezero(epsilon=epsilon) for point in self]
[docs] def rotate(self, angle=None, axis=None, anchor_point=None, rot_point=None, from_vector=None, to_vector=None, degrees=False, transform_matrix=None, verbose=False, **kwargs): """Rotate `Point`\ s coordinates. Parameters ---------- angle : float axis : :class:`~sknano.core.math.Vector`, optional anchor_point : :class:`~sknano.core.math.Point`, optional rot_point : :class:`~sknano.core.math.Point`, optional from_vector, to_vector : :class:`~sknano.core.math.Vector`, optional degrees : bool, optional transform_matrix : :class:`~numpy:numpy.ndarray` """ if transform_matrix is None: transform_matrix = \ transformation_matrix(angle=angle, axis=axis, anchor_point=anchor_point, rot_point=rot_point, from_vector=from_vector, to_vector=to_vector, degrees=degrees, verbose=verbose, **kwargs) [point.rotate(transform_matrix=transform_matrix) for point in self]
[docs] def translate(self, t): """Translate `Point`\ s by :class:`Vector` `t`. Parameters ---------- v : :class:`Vector` """ [point.translate(t) for point in self]