Source code for stride.problem.transducers

from collections import OrderedDict

from mosaic.utils import camel_case

from .base import ProblemBase
from ..problem import transducer_types

__all__ = ['Transducers']

[docs]class Transducers(ProblemBase): """ The Transducers stores a reference to all the transducer devices that are used in a problem. Transducers are identified through a numerical ID, which is >= 0. A transducer can be added through ``Transducers.add`` and accessed through ``Transducers.get``. Parameters ---------- name : str Alternative name to give to the Transducers. problem : Problem Problem to which the Transducers belongs. grid : Grid or any of Space or Time Grid on which the Transducers are defined """ def __init__(self, name='transducers', problem=None, **kwargs): super().__init__(name=name, problem=problem, **kwargs) self._transducers = OrderedDict()
[docs] def add(self, item): """ Add a new transducer to the Transducers. Parameters ---------- item : Transducer Transducer to be added to the Transducers. Returns ------- """ if in self._transducers.keys(): raise ValueError('Transducer with ID "%d" already exists in the Transducers' % self._transducers[] = item
[docs] def get(self, id): """ Get a transducer from the Transducers with a known id. Parameters ---------- id : int Identifier of the transducer. Returns ------- Transducer Found Transducer. """ if not isinstance(id, int) or id < 0: raise ValueError('Transducer IDs have to be positive integer numbers') return self._transducers[id]
[docs] def get_slice(self, start=None, end=None, step=None): """ Get a slice of the indices of the transducer using ``slice(start, stop, step)``. Parameters ---------- start : int, optional Start of the slice, defaults to the first id. end : int, optional End of the slice, defaults to the last id. step : int, optional Steps in between transducers, defaults to 1. Returns ------- list Found transducers in the slice. """ section = OrderedDict() if start is None: _range = range(end) elif step is None: _range = range(start, end) else: _range = range(start, end, step) for index in _range: section[list(self._transducers.keys())[index]] = list(self._transducers.values())[index] return section
[docs] def items(self): """ Access all transducers as iterable of (ID, transducer) pairs. """ return self._transducers.items()
@property def num_transducers(self): """ Get number of transducers in the Transducers. """ return len(self._transducers.keys()) @property def transducers(self): """ Get all transducers as a list. """ return list(self._transducers.values()) @property def transducer_ids(self): """ Get all transducer IDs in the Transducers. Returns ------- list IDs of the transducers. """ return list(self._transducers.keys())
[docs] def default(self): """ Fill the container with the default configuration. In this case, a single PointTransducer will be generated. Returns ------- """ transducer = transducer_types.PointTransducer(0, grid=self.grid) self.add(transducer)
[docs] def sub_problem(self, shot, sub_problem): """ Create a subset object for a certain shot. A SubProblem contains everything that is needed to fully determine how to run a particular shot. This method takes care of selecting the portions of the Transducers that are needed for a given shot. Parameters ---------- shot : Shot Shot for which the SubProblem is being generated. sub_problem : SubProblem Container for the sub-problem being generated. Returns ------- Transducers Newly created Transducers instance. """ sub_transducers = Transducers(, problem=sub_problem, grid=self.grid) source_ids = shot.source_ids receiver_ids = shot.receiver_ids location_ids = list(set(source_ids) | set(receiver_ids)) geometry = self.problem.geometry for location_id in location_ids: location = geometry.get(location_id) if in sub_transducers.transducer_ids: continue transducer = location.transducer.sub_problem(shot, sub_problem) sub_transducers.add(transducer) return sub_transducers
def __get_desc__(self, **kwargs): description = { 'num_transducers': self.num_transducers, 'transducers': [], } for transducer_id, transducer in self._transducers.items(): description['transducers'].append(transducer.__get_desc__()) return description def __set_desc__(self, description): for transducer_desc in description.transducers: transducer_type = getattr(transducer_types, camel_case(transducer_desc.type)) transducer = transducer_type(, grid=self.grid) transducer.__set_desc__(transducer_desc) self.add(transducer)