civet.xfm

 1"""
 2Types related to xfm transformations
 3(`param2xfm`, `transform_objects`, `transform_volume`).
 4"""
 5import abc
 6from os import PathLike
 7from typing import Sequence, TypeVar, Literal
 8from civet.abstract_data import AbstractDataCommand
 9from civet.bases import DataSource, DataFile
10from enum import Enum
11from dataclasses import dataclass
12
13
14class Transformations(Enum):
15    CENTER = '-center'
16    TRANSLATION = '-translation'
17    ROTATIONS = '-rotations'
18    SCALES = '-scales'
19    SHEARS = '-shears'
20
21
22@dataclass(frozen=True)
23class Xfm(DataSource):
24    """
25    Represents a `.xfm` file created by `param2xfm`.
26
27    `Xfm` can only represent a single `param2xfm` option.
28    Would be nice to support multiple transformations in go, but it's not implemented.
29    """
30
31    transformation: Transformations
32    x: float
33    y: float
34    z: float
35    preferred_suffix = '.xfm'
36
37    def command(self, output: str | PathLike) -> Sequence[str | PathLike | AbstractDataCommand]:
38        return 'param2xfm', self.transformation.value, str(self.x), str(self.y), str(self.z), output
39
40
41TransformProgram = Literal['transform_objects', 'transform_volume']
42_T = TypeVar('_T', bound='TransformableMixin')
43
44
45@dataclass(frozen=True)
46class TransformableMixin(DataFile[_T], abc.ABC):
47    @property
48    @abc.abstractmethod
49    def transform_program(self) -> TransformProgram:
50        """
51        Specifies which program is used to transform objects of this type.
52        """
53        ...
54
55    def append_xfm(self, xfm: Xfm) -> _T:
56        def command(output: str | PathLike) -> Sequence[str | PathLike | AbstractDataCommand]:
57            return self.transform_program, self, xfm, output
58        return self.create_command(command)
59
60    def flip_x(self) -> _T:
61        """
62        Flip this surface along the *x*-axis.
63        """
64        return self.append_xfm(Xfm(Transformations.SCALES, -1, 1, 1))
65
66    def translate_x(self, x: float) -> _T:
67        """
68        Translate this surface along the *x*-axis.
69        """
70        return self.append_xfm(Xfm(Transformations.TRANSLATION, x, 0, 0))
71
72    def slide_left(self) -> _T:
73        """
74        Translate this surface 25 units to the left.
75        """
76        return self.translate_x(-25)
77
78    def slide_right(self) -> _T:
79        """
80        Translate this surface 25 units to the right.
81        """
82        return self.translate_x(25)