0ea17d8ff4
* Operation Interface Enhancement + Clarification - added set notation to all the geometry operations - added a warning to say sample_surface=True doesn't work * minor fix docs * fix operation_interface.py doc --------- Co-authored-by: Dario Coscia <dariocoscia@Dario-Coscia.local> Co-authored-by: Dario Coscia <93731561+dario-coscia@users.noreply.github.com>
61 lines
1.8 KiB
Python
61 lines
1.8 KiB
Python
import torch
|
|
from .location import Location
|
|
from ..utils import check_consistency
|
|
from ..label_tensor import LabelTensor
|
|
from abc import ABCMeta, abstractmethod
|
|
import random
|
|
|
|
|
|
class OperationInterface(Location, metaclass=ABCMeta):
|
|
"""PINA Operation Interface"""
|
|
|
|
def __init__(self, geometries):
|
|
"""
|
|
Abstract Operation class.
|
|
Any geometry operation entity must inherit from this class.
|
|
|
|
.. warning::
|
|
The ``sample_surface=True`` option is not implemented yet
|
|
for Difference, Intersection, and Exclusion. The usage will
|
|
result in unwanted behaviour.
|
|
|
|
:param list geometries: A list of geometries from 'pina.geometry'
|
|
such as 'EllipsoidDomain' or 'CartesianDomain'.
|
|
"""
|
|
# check consistency geometries
|
|
check_consistency(geometries, Location)
|
|
|
|
# check we are passing always different
|
|
# geometries with the same labels.
|
|
self._check_dimensions(geometries)
|
|
|
|
# assign geometries
|
|
self._geometries = geometries
|
|
|
|
@property
|
|
def geometries(self):
|
|
"""
|
|
The geometries."""
|
|
return self._geometries
|
|
|
|
@property
|
|
def variables(self):
|
|
"""
|
|
Spatial variables.
|
|
|
|
:return: All the variables defined in ``__init__`` in order.
|
|
:rtype: list[str]
|
|
"""
|
|
return self.geometries[0].variables
|
|
|
|
def _check_dimensions(self, geometries):
|
|
"""Check if the dimensions of the geometries are consistent.
|
|
|
|
:param geometries: Geometries to be checked.
|
|
:type geometries: list[Location]
|
|
"""
|
|
for geometry in geometries:
|
|
if geometry.variables != geometries[0].variables:
|
|
raise NotImplementedError(
|
|
f'The geometries need to have same dimensions and labels.')
|