packages/mcni/python/mcni/Instrument.py

#!/usr/bin/env python
#
#


# this is the original, minimal implementation of the Instrument data object
# it just contains a list of components
class Instrument0(object):

    '''Instrument is a container of neutron components'''

    def __init__(self, components = None ):
        self.components = components or []
        return


    def append(self, component):
        self.components.append(component)
        return


    def insert(self, index, component):
        self.components.insert(index, component)
        return

    pass # Instrument


# This class provides some syntatic sugar to simplify the
# procedure for users to create an instrument.
# It contains the geometer also.
class Instrument(Instrument0):

    '''Instrument is a container of neutron components, with a geometer'''

    def __init__(self, components = None, geometer = None):
        super(Instrument, self).__init__(components)
        self.geometer = geometer or self._createGeometer()
        return

    def __str__(self):
        g = self.geometer
        def s(c):
            if hasattr(c, '_factory_kwds'):
                kwds = c._factory_kwds
                return ', '.join(f'{k}={v!r}' for k, v in kwds.items())
            return str(c)
        return "Instrument:\n  " + '\n  '.join([
            f"{c.name}:{c.__class__.__name__}"
            f" at {g.position(c)} rotated {g.orientation(c)}"
            f"\n  * {s(c)}"
            for c in self.components
        ])

    def simulate(self, N, **kwds):
        """simulate N neutrons. **kwds are used to update simulation context

simulation context is an instance of SimulationContext
"""
        # convenient method to run simulation
        from . import simulate, neutron_buffer
        neutrons = neutron_buffer(N)
        simulate(self, self.geometer, neutrons, **kwds)
        return neutrons

    def append(self, component, position=None, orientation=None, relativeTo=None):
        super(Instrument, self).append(component)
        if position is None and orientation is None: return
        self._register(component, position, orientation, relativeTo)
        return

    def insert(self, index, component, position=None, orientation=None, relativeTo=None):
        super(Instrument, self).insert(index, component)
        if position is None and orientation is None: return
        self._register(component, position, orientation, relativeTo)
        return

    def _register(self, component, position, orientation, relativeTo=None):
        from .Geometer2 import AbsoluteCoord as abs, RelativeCoord as rel
        if position is None: position = (0,0,0)
        if orientation is None: orientation = (0,0,0)
        if relativeTo:
            position = rel(position, relativeTo)
            orientation = rel(orientation, relativeTo)
        else:
            position = abs(position)
            orientation = abs(orientation)
        self.geometer.register(component, position, orientation)
        component.abs_position = self.geometer.position(component)
        component.abs_orientation = self.geometer.orientation(component)
        return

    def _createGeometer(self):
        from .Geometer2 import Geometer
        return Geometer()

    pass # Instrument


# End of file 