syned 1.0.47__py3-none-any.whl → 1.0.49__py3-none-any.whl

syned/beamline/optical_element_with_surface_shape.py

@@ -1,126 +1,126 @@
-"""
-Base classes for optical elements with shape(s).
-
-   * OpticalElementsWithSurfaceShape (e.g. an elliptical mirror).
-   * OpticalElementsWithMultipleShapes (e.g. a lens that has two surfaces).
-"""
-from syned.beamline.optical_element import OpticalElement
-from syned.beamline.shape import SurfaceShape
-
-class OpticalElementsWithMultipleShapes(OpticalElement):
-    """
-    Constructor.
-
-    Parameters
-    ----------
-    name : str
-        The optical elemnt name.
-    surface_shapes : list
-        List with surface shapes (instances of SurfaceShape)
-    boundary_shape : instance of BoundaryShape, optional
-        The element shape. The default=None means no shape associated to the optical element.
-
-    """
-
-    def __init__(self, name="",
-                 surface_shapes=None,
-                 boundary_shape=None):
-        super().__init__(name, boundary_shape)
-        if surface_shapes is None: surface_shapes = [SurfaceShape()]
-        if not isinstance(surface_shapes, list): raise ValueError("surface_shapes must of type 'list'")
-        self._surface_shapes = surface_shapes
-
-    def get_surface_shape(self, index):
-        """
-        Gets the surface shape.
-
-        Parameters
-        ----------
-        index : int
-            The index of the requested surface shape in the list.
-
-        Returns
-        -------
-        instance of SurfaceShape
-            The requested surface shape.
-
-        """
-        try: return self._surface_shapes[index]
-        except: raise Exception("only " + str(len(self._surface_shapes)) + " shapes in OpticalElementsWithMultipleShapes")
-
-    def set_surface_shape(self, index, surface_shape=None):
-        """
-        Sets a surface shape.
-
-        Parameters
-        ----------
-        index : int
-            The index of the surface shape to be set in the list.
-        surface_shape : instances of SurfaceShape, optional
-            The surface shape to be set (If None, initialize to SurfaceShape())
-
-        """
-        if surface_shape is None: surface_shape = SurfaceShape()
-        try: self._surface_shapes[index] = surface_shape
-        except: raise Exception("only " + str(len(self._surface_shapes)) + " shapes in OpticalElementsWithMultipleShapes")
-
-class OpticalElementsWithSurfaceShape(OpticalElementsWithMultipleShapes):
-    """
-    Constructor.
-
-    Parameters
-    ----------
-    name : str
-        The optical elemnt name.
-    surface_shape : instances of SurfaceShape
-        The surface shape.
-    boundary_shape : instance of BoundaryShape, optional
-        The element shape. The default=None means no shape associated to the optical element.
-    """
-    def __init__(self, name, surface_shape=None, boundary_shape=None):
-        super(OpticalElementsWithSurfaceShape, self).__init__(name=name,
-                                                              boundary_shape=boundary_shape,
-                                                              surface_shapes=[surface_shape])
-
-    # these definitions are necessary to define self._surface_shape which is needed to
-    # build the object instance from json files.
-    @property
-    def _surface_shape(self):
-        return self.get_surface_shape()
-
-    @_surface_shape.setter
-    def _surface_shape(self, value):
-        self.set_surface_shape(value)
-
-    def get_surface_shape(self):
-        """
-        Gets the surface shape.
-
-        Returns
-        -------
-        instance of SurfaceShape
-            The requested surface shape.
-
-        """
-        return super(OpticalElementsWithSurfaceShape, self).get_surface_shape(index=0)
-
-    def set_surface_shape(self, surface_shape=None):
-        """
-        Sets a surface shape.
-
-        Parameters
-        ----------
-        surface_shape : instances of SurfaceShape, optional
-            The surface shape to be set (If None, initialize to SurfaceShape())
-
-        """
-        super(OpticalElementsWithSurfaceShape, self).set_surface_shape(index=0, surface_shape=surface_shape)
-
-
-if __name__=="__main__":
-    from syned.beamline.shape import Cylinder, EllipticalCylinder
-
-    oe = OpticalElementsWithSurfaceShape(name="TEST", surface_shape=Cylinder())
-    print(oe.get_surface_shape())
-    oe.set_surface_shape(surface_shape=EllipticalCylinder())
-    print(oe.get_surface_shape())
+"""
+Base classes for optical elements with shape(s).
+
+   * OpticalElementsWithSurfaceShape (e.g. an elliptical mirror).
+   * OpticalElementsWithMultipleShapes (e.g. a lens that has two surfaces).
+"""
+from syned.beamline.optical_element import OpticalElement
+from syned.beamline.shape import SurfaceShape
+
+class OpticalElementsWithMultipleShapes(OpticalElement):
+    """
+    Constructor.
+
+    Parameters
+    ----------
+    name : str
+        The optical elemnt name.
+    surface_shapes : list
+        List with surface shapes (instances of SurfaceShape)
+    boundary_shape : instance of BoundaryShape, optional
+        The element shape. The default=None means no shape associated to the optical element.
+
+    """
+
+    def __init__(self, name="",
+                 surface_shapes=None,
+                 boundary_shape=None):
+        super().__init__(name, boundary_shape)
+        if surface_shapes is None: surface_shapes = [SurfaceShape()]
+        if not isinstance(surface_shapes, list): raise ValueError("surface_shapes must of type 'list'")
+        self._surface_shapes = surface_shapes
+
+    def get_surface_shape(self, index):
+        """
+        Gets the surface shape.
+
+        Parameters
+        ----------
+        index : int
+            The index of the requested surface shape in the list.
+
+        Returns
+        -------
+        instance of SurfaceShape
+            The requested surface shape.
+
+        """
+        try: return self._surface_shapes[index]
+        except: raise Exception("only " + str(len(self._surface_shapes)) + " shapes in OpticalElementsWithMultipleShapes")
+
+    def set_surface_shape(self, index, surface_shape=None):
+        """
+        Sets a surface shape.
+
+        Parameters
+        ----------
+        index : int
+            The index of the surface shape to be set in the list.
+        surface_shape : instances of SurfaceShape, optional
+            The surface shape to be set (If None, initialize to SurfaceShape())
+
+        """
+        if surface_shape is None: surface_shape = SurfaceShape()
+        try: self._surface_shapes[index] = surface_shape
+        except: raise Exception("only " + str(len(self._surface_shapes)) + " shapes in OpticalElementsWithMultipleShapes")
+
+class OpticalElementsWithSurfaceShape(OpticalElementsWithMultipleShapes):
+    """
+    Constructor.
+
+    Parameters
+    ----------
+    name : str
+        The optical elemnt name.
+    surface_shape : instances of SurfaceShape
+        The surface shape.
+    boundary_shape : instance of BoundaryShape, optional
+        The element shape. The default=None means no shape associated to the optical element.
+    """
+    def __init__(self, name, surface_shape=None, boundary_shape=None):
+        super(OpticalElementsWithSurfaceShape, self).__init__(name=name,
+                                                              boundary_shape=boundary_shape,
+                                                              surface_shapes=[surface_shape])
+
+    # these definitions are necessary to define self._surface_shape which is needed to
+    # build the object instance from json files.
+    @property
+    def _surface_shape(self):
+        return self.get_surface_shape()
+
+    @_surface_shape.setter
+    def _surface_shape(self, value):
+        self.set_surface_shape(value)
+
+    def get_surface_shape(self):
+        """
+        Gets the surface shape.
+
+        Returns
+        -------
+        instance of SurfaceShape
+            The requested surface shape.
+
+        """
+        return super(OpticalElementsWithSurfaceShape, self).get_surface_shape(index=0)
+
+    def set_surface_shape(self, surface_shape=None):
+        """
+        Sets a surface shape.
+
+        Parameters
+        ----------
+        surface_shape : instances of SurfaceShape, optional
+            The surface shape to be set (If None, initialize to SurfaceShape())
+
+        """
+        super(OpticalElementsWithSurfaceShape, self).set_surface_shape(index=0, surface_shape=surface_shape)
+
+
+if __name__=="__main__":
+    from syned.beamline.shape import Cylinder, EllipticalCylinder
+
+    oe = OpticalElementsWithSurfaceShape(name="TEST", surface_shape=Cylinder())
+    print(oe.get_surface_shape())
+    oe.set_surface_shape(surface_shape=EllipticalCylinder())
+    print(oe.get_surface_shape())

syned/beamline/optical_elements/__init__.py

@@ -1 +1 @@
-
+

syned/beamline/optical_elements/absorbers/absorber.py

@@ -1,21 +1,21 @@
-
-from syned.beamline.optical_element import OpticalElement
-from syned.beamline.shape import BoundaryShape
-
-class Absorber(OpticalElement):
-    """
-    Base class for optical element category "absorbers" (filters, slits, etc.)
-
-    Constructor.
-
-    Parameters
-    ----------
-    name : str
-        The name of the optical element.
-    boundary_shape : instance of BoundaryShape, optional
-        if None, it is initialized to BoundaryShape().
-
-    """
-    def __init__(self, name="Undefined", boundary_shape=None):
-        if boundary_shape is None: boundary_shape = BoundaryShape()
-        OpticalElement.__init__(self, name=name, boundary_shape=boundary_shape)
+
+from syned.beamline.optical_element import OpticalElement
+from syned.beamline.shape import BoundaryShape
+
+class Absorber(OpticalElement):
+    """
+    Base class for optical element category "absorbers" (filters, slits, etc.)
+
+    Constructor.
+
+    Parameters
+    ----------
+    name : str
+        The name of the optical element.
+    boundary_shape : instance of BoundaryShape, optional
+        if None, it is initialized to BoundaryShape().
+
+    """
+    def __init__(self, name="Undefined", boundary_shape=None):
+        if boundary_shape is None: boundary_shape = BoundaryShape()
+        OpticalElement.__init__(self, name=name, boundary_shape=boundary_shape)

syned/beamline/optical_elements/absorbers/beam_stopper.py

@@ -1,64 +1,64 @@
-
-from syned.beamline.shape import BoundaryShape
-from syned.beamline.shape import Rectangle, Ellipse
-
-from syned.beamline.optical_elements.absorbers.absorber import Absorber
-
-class BeamStopper(Absorber):
-    """
-    Beam-stopper or obstruction.
-
-    Constructor.
-
-    Note that:
-                                   Slit     BeamStopper    Filter      HoledFilter
-        beam pass at center         Yes     No             Yes         No
-        apply attenuation           No      No             Yes         Yes
-
-    Parameters
-    ----------
-    name : str
-        The name of the optical element.
-    boundary_shape : instance of BoundaryShape, optional
-        The geometry of the slit aperture. if None, it is initialized to BoundaryShape().
-
-    """
-    def __init__(self, name="Undefined", boundary_shape=None):
-        if boundary_shape is None: boundary_shape = BoundaryShape()
-        Absorber.__init__(self, name=name, boundary_shape=boundary_shape)
-
-    def set_rectangle(self,width=3e-3,height=4e-3):
-        """
-        Sets the stopper as a rectangle.
-
-        Parameters
-        ----------
-        width : float, optional
-            The rectangle width.
-        length : float, optional
-            The rectangle length.
-        center_x : float, optional
-            The center coordinate X.
-        center_y : float, optional
-            The center coordinate Y.
-
-        """
-        self._boundary_shape=Rectangle(-0.5*width,0.5*width,-0.5*height,0.5*height)
-
-    def set_circle(self,radius=3e-3):
-        """
-        Sets the stopper as a circle.
-
-        Parameters
-        ----------
-        radius : float
-            The radius of the circle.
-        center_x : float
-            The x coordinate of the center of the circle.
-        center_y   : float
-            The y coordinate of the center of the circle.
-
-        """
-        self._boundary_shape=Ellipse(-0.5*radius,0.5*radius,-0.5*radius,0.5*radius)
-
+
+from syned.beamline.shape import BoundaryShape
+from syned.beamline.shape import Rectangle, Ellipse
+
+from syned.beamline.optical_elements.absorbers.absorber import Absorber
+
+class BeamStopper(Absorber):
+    """
+    Beam-stopper or obstruction.
+
+    Constructor.
+
+    Note that:
+                                   Slit     BeamStopper    Filter      HoledFilter
+        beam pass at center         Yes     No             Yes         No
+        apply attenuation           No      No             Yes         Yes
+
+    Parameters
+    ----------
+    name : str
+        The name of the optical element.
+    boundary_shape : instance of BoundaryShape, optional
+        The geometry of the slit aperture. if None, it is initialized to BoundaryShape().
+
+    """
+    def __init__(self, name="Undefined", boundary_shape=None):
+        if boundary_shape is None: boundary_shape = BoundaryShape()
+        Absorber.__init__(self, name=name, boundary_shape=boundary_shape)
+
+    def set_rectangle(self,width=3e-3,height=4e-3):
+        """
+        Sets the stopper as a rectangle.
+
+        Parameters
+        ----------
+        width : float, optional
+            The rectangle width.
+        length : float, optional
+            The rectangle length.
+        center_x : float, optional
+            The center coordinate X.
+        center_y : float, optional
+            The center coordinate Y.
+
+        """
+        self._boundary_shape=Rectangle(-0.5*width,0.5*width,-0.5*height,0.5*height)
+
+    def set_circle(self,radius=3e-3):
+        """
+        Sets the stopper as a circle.
+
+        Parameters
+        ----------
+        radius : float
+            The radius of the circle.
+        center_x : float
+            The x coordinate of the center of the circle.
+        center_y   : float
+            The y coordinate of the center of the circle.
+
+        """
+        self._boundary_shape=Ellipse(-0.5*radius,0.5*radius,-0.5*radius,0.5*radius)
+
     #TODO: add set_ellipse (like in slit).

syned/beamline/optical_elements/absorbers/filter.py

@@ -1,61 +1,61 @@
-
-from syned.beamline.optical_elements.absorbers.absorber import Absorber
-
-class Filter(Absorber):
-    """
-    Filter or absorber or attenuator.
-
-    Note that:
-                                   Slit     BeamStopper    Filter      HoledFilter
-        beam pass at center         Yes     No             Yes         No
-        apply attenuation           No      No             Yes         Yes
-
-    Constructor.
-
-    Parameters
-    ----------
-    name : str
-        The name of the optical element.
-    material : str
-        A string defining the material.
-    thickness : float
-        The filter thickness in m.
-    boundary_shape : instance of BoundaryShape, optional
-        if None, it is initialized to BoundaryShape().
-    """
-    def __init__(self,
-                 name="Undefined",
-                 material="Be",
-                 thickness=1e-3,
-                 boundary_shape=None):
-        Absorber.__init__(self, name=name, boundary_shape=boundary_shape)
-        self._material = material
-        self._thickness = thickness
-
-        # support text containg name of variable, help text and unit. Will be stored in self._support_dictionary
-        self._set_support_text([
-                    ("material"      , "Material (symbol, formula or name)",    "" ),
-                    ("thickness"     , "Thickness ",                            "m" ),
-            ])
-
-    def get_material(self):
-        """
-        Returns the material name.
-
-        Returns
-        -------
-        str
-
-        """
-        return self._material
-
-    def get_thickness(self):
-        """
-        Retuirns the filter thickness in m.
-
-        Returns
-        -------
-        float
-
-        """
-        return self._thickness
+
+from syned.beamline.optical_elements.absorbers.absorber import Absorber
+
+class Filter(Absorber):
+    """
+    Filter or absorber or attenuator.
+
+    Note that:
+                                   Slit     BeamStopper    Filter      HoledFilter
+        beam pass at center         Yes     No             Yes         No
+        apply attenuation           No      No             Yes         Yes
+
+    Constructor.
+
+    Parameters
+    ----------
+    name : str
+        The name of the optical element.
+    material : str
+        A string defining the material.
+    thickness : float
+        The filter thickness in m.
+    boundary_shape : instance of BoundaryShape, optional
+        if None, it is initialized to BoundaryShape().
+    """
+    def __init__(self,
+                 name="Undefined",
+                 material="Be",
+                 thickness=1e-3,
+                 boundary_shape=None):
+        Absorber.__init__(self, name=name, boundary_shape=boundary_shape)
+        self._material = material
+        self._thickness = thickness
+
+        # support text containg name of variable, help text and unit. Will be stored in self._support_dictionary
+        self._set_support_text([
+                    ("material"      , "Material (symbol, formula or name)",    "" ),
+                    ("thickness"     , "Thickness ",                            "m" ),
+            ])
+
+    def get_material(self):
+        """
+        Returns the material name.
+
+        Returns
+        -------
+        str
+
+        """
+        return self._material
+
+    def get_thickness(self):
+        """
+        Retuirns the filter thickness in m.
+
+        Returns
+        -------
+        float
+
+        """
+        return self._thickness