syned 1.0.47__py3-none-any.whl

syned/__test/__init__.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# ----------------------------------------------------------------------- #
+# Copyright (c) 2025, UChicago Argonne, LLC. All rights reserved.         #
+#                                                                         #
+# Copyright 2025. UChicago Argonne, LLC. This software was produced       #
+# under U.S. Government contract DE-AC02-06CH11357 for Argonne National   #
+# Laboratory (ANL), which is operated by UChicago Argonne, LLC for the    #
+# U.S. Department of Energy. The U.S. Government has rights to use,       #
+# reproduce, and distribute this software.  NEITHER THE GOVERNMENT NOR    #
+# UChicago Argonne, LLC MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR        #
+# ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE.  If software is     #
+# modified to produce derivative works, such modified software should     #
+# be clearly marked, so as not to confuse it with the version available   #
+# from ANL.                                                               #
+#                                                                         #
+# Additionally, redistribution and use in source and binary forms, with   #
+# or without modification, are permitted provided that the following      #
+# conditions are met:                                                     #
+#                                                                         #
+#     * Redistributions of source code must retain the above copyright    #
+#       notice, this list of conditions and the following disclaimer.     #
+#                                                                         #
+#     * Redistributions in binary form must reproduce the above copyright #
+#       notice, this list of conditions and the following disclaimer in   #
+#       the documentation and/or other materials provided with the        #
+#       distribution.                                                     #
+#                                                                         #
+#     * Neither the name of UChicago Argonne, LLC, Argonne National       #
+#       Laboratory, ANL, the U.S. Government, nor the names of its        #
+#       contributors may be used to endorse or promote products derived   #
+#       from this software without specific prior written permission.     #
+#                                                                         #
+# THIS SOFTWARE IS PROVIDED BY UChicago Argonne, LLC AND CONTRIBUTORS     #
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT       #
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS       #
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL UChicago     #
+# Argonne, LLC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,        #
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,    #
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;        #
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER        #
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT      #
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN       #
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE         #
+# POSSIBILITY OF SUCH DAMAGE.                                             #
+# ----------------------------------------------------------------------- #

syned/__test/test.py

@@ -0,0 +1,28 @@
+import traceback
+import warnings
+warnings.simplefilter("always")
+
+from syned.storage_ring.electron_beam import ElectronBeam
+
+try:
+    a = ElectronBeam.initialize_as_pencil_beam(energy_in_GeV=6.0,
+                                               current=0.2,
+                                               energy_spread=0.00095,
+                                               moment_xx =1.0,
+                                               moment_xxp =1.0,
+                                               moment_xpxp =1.0,
+                                               moment_yy =1.0,
+                                               moment_yyp =1.0,
+                                               moment_ypyp =1.0,
+                                               dispersion_x =1.0,
+                                               dispersion_y =1.0,
+                                               dispersionp_x=1.0,
+                                               dispersionp_y=1.0)
+    a.set_twiss_horizontal  (0, 0, 0)
+    a.set_twiss_vertical    (0, 1, 1, eta_y=2.0, etap_y=3.0)
+
+    print(a.info())
+
+    print(a.get_twiss_no_dispersion_all())
+except:
+    traceback.print_exc()

syned/beamline/__init__.py

@@ -0,0 +1 @@
+

syned/beamline/beamline.py

@@ -0,0 +1,155 @@
+"""
+Represents a beamline. The beamline is composed by a light source ans a list of beamline elements.
+"""
+
+from syned.syned_object import SynedObject
+from syned.storage_ring.light_source import LightSource
+from syned.storage_ring.empty_light_source import EmptyLightSource
+from syned.beamline.beamline_element import BeamlineElement
+
+from collections import OrderedDict
+
+class Beamline(SynedObject):
+    """
+    Constructor.
+
+    Parameters
+    ----------
+    light_source : instance of LightSource
+        The light source
+    beamline_elements_list : list
+        The beamline elements (each one an instance of BeamlineElement).
+    """
+    def __init__(self, light_source=LightSource(), beamline_elements_list=None):
+        self._light_source = light_source
+        if beamline_elements_list is None:
+            self._beamline_elements_list = []
+        else:
+            self._beamline_elements_list = beamline_elements_list
+
+        # support text containg name of variable, help text and unit. Will be stored in self._support_dictionary
+        self._set_support_text([
+                    ("light_source",       "Light Source",      ""),
+                    ("beamline_elements_list",  "Beamline Elements", ""),
+            ] )
+
+
+    # overwrites the SynedObject method for dealing with list
+    def to_dictionary(self):
+        """
+        Returns a dictionary with the object fields.
+
+        Returns
+        -------
+        dict
+            A dictionary with the data.
+
+        """
+        dict_to_save = OrderedDict()
+        dict_to_save.update({"CLASS_NAME":self.__class__.__name__})
+
+        dict_to_save["light_source"] = self._light_source.to_dictionary()
+        dict_to_save["beamline_elements_list"] = [el.to_dictionary() for el in self._beamline_elements_list]
+
+        return dict_to_save
+
+
+
+    def get_light_source(self):
+        """
+        Returns the light source
+
+        Returns
+        -------
+        instance of LightSource
+
+        """
+        return self._light_source
+
+    def get_beamline_elements(self):
+        """
+        returns the beamline elements.
+
+        Returns
+        -------
+        list
+
+        """
+        return self._beamline_elements_list
+
+    def set_light_source(self, light_source=LightSource()):
+        """
+        Sets a light source.
+
+        Parameters
+        ----------
+        light_source : instance of LightSource
+
+        """
+        if not (isinstance(light_source,LightSource) or isinstance(light_source,EmptyLightSource)):
+            raise Exception("Input class must be of type: "+LightSource.__name__+" or "+EmptyLightSource.__name__)
+        else:
+            self._light_source = light_source
+
+    def append_beamline_element(self, beamline_element=BeamlineElement()):
+        """
+        Appends a beamline element.
+
+        Parameters
+        ----------
+        beamline_element : instance of BeamlineElement.
+
+        """
+        if not isinstance(beamline_element,BeamlineElement):
+            raise Exception("Input class must be of type: "+BeamlineElement.__name__)
+        else:
+            self._beamline_elements_list.append(beamline_element)
+
+    def get_beamline_elements_number(self):
+        """
+        Gets the number of beamline elements stored.
+
+        Returns
+        -------
+        int
+
+        """
+        return len(self._beamline_elements_list)
+
+    def get_beamline_element_at(self, index):
+        """
+        gets an individual beamline element.
+
+        Parameters
+        ----------
+        index : int
+            The index of the beamline element to be retrieved.
+
+        Returns
+        -------
+        instance of BeamlineElement
+            The wanted beamline element (referenced, not copied).
+
+        """
+        if index >= len(self._beamline_elements_list):
+            raise IndexError("Index " + str(index) + " out of bounds")
+
+        return self._beamline_elements_list[index]
+
+    # TODO: remove: probably this is not needed, as the deepcopy in SynedObject makes the work.
+    def duplicate(self):
+        """
+        Returns a copy of the beamline element instance.
+
+        Returns
+        -------
+        BeamlineElement  instance
+            A copy of the object instance.
+
+        """
+        beamline_elements_list = []
+        for beamline_element in self._beamline_elements_list:
+            beamline_elements_list.append(beamline_element)
+
+        return Beamline(light_source=self._light_source,
+                        beamline_elements_list = beamline_elements_list)

syned/beamline/beamline_element.py

@@ -0,0 +1,76 @@
+"""
+Base class for all beamline elements. A beamline element is composed by an optical element (instance of OpticalElement)
+and its position in th ebeamline (an instance of ElementCoordinates).
+"""
+
+from syned.syned_object import SynedObject
+from syned.beamline.optical_element import OpticalElement
+from syned.beamline.element_coordinates import ElementCoordinates
+
+class BeamlineElement(SynedObject):
+    """
+    Constructor
+
+    Parameters
+    ----------
+    optical_element : instance of OpticalElement
+    coordinates : instance of ElementCoordinates
+    """
+    def __init__(self, optical_element=OpticalElement(), coordinates=ElementCoordinates()):
+        self._optical_element = optical_element
+        self._coordinates = coordinates
+        # support text containg name of variable, help text and unit. Will be stored in self._support_dictionary
+        self._set_support_text([
+                    ("optical_element",       "Optical Element",      ""),
+                    ("coordinates",           "Element coordinates",  ""),
+            ] )
+
+    def get_optical_element(self):
+        """
+        Returns the optical element.
+
+        Returns
+        -------
+        instance of OpticalElement
+
+        """
+        return self._optical_element
+
+    def get_coordinates(self):
+        """
+        Returns the element coordinates.
+
+        Returns
+        -------
+        instance of ElementCoordinates
+
+        """
+        return self._coordinates
+
+    def set_optical_element(self, value):
+        """
+        Sets the optical element.
+
+        Parameters
+        ----------
+        value : instance of OpticalElement
+
+        """
+        if isinstance(value, OpticalElement):
+            self._optical_element = value
+        else:
+            raise Exception("entry is not an instance of OpticalElement")
+
+    def set_coordinates(self, value):
+        """
+        Sets the coordinates.
+
+        Parameters
+        ----------
+        value : instance of ElementCoordinates.
+
+        """
+        if isinstance(value, ElementCoordinates):
+            self._coordinates = value
+        else:
+            raise Exception("entry is not an instance of ElementCoordinates")

syned/beamline/element_coordinates.py

@@ -0,0 +1,199 @@
+"""
+Position coordinates of a beamline component.
+"""
+
+from syned.syned_object import SynedObject
+
+class ElementCoordinates(SynedObject):
+    """
+
+    """
+    def __init__(self, p = 0.0, q = 0.0, angle_radial=0.0, angle_azimuthal=0.0, angle_radial_out=None):
+        """
+
+        Parameters
+        ----------
+        p : float, optional
+            distance from previous element in m.
+        q : float, optional
+            distance to next element in m.
+        angle_radial : float, optional
+            Radial inclination angle in rads.
+        angle_azimuthal : float, optional
+            Azimuthal inclination angle in rads.
+        angle_radial_out : float, optional
+            The radial angle in rads in the output direction (default=None, the same as angle_radial).
+
+        """
+        self._p               = p
+        self._q               = q
+        self._angle_radial    = angle_radial
+        self._angle_azimuthal = angle_azimuthal
+        self._angle_radial_out = angle_radial_out
+
+        # support text containg name of variable, help text and unit. Will be stored in self._support_dictionary
+        self._set_support_text([
+                    ("p",                "distance from previous continuation plane", "m"    ),
+                    ("q",                "distance to next continuation plane",       "m"    ),
+                    ("angle_radial",     "incident angle [to normal]",                "rad"  ),
+                    ("angle_radial_out", "output angle [to normal]",                  "rad"),
+                    ("angle_azimuthal",  "rotation along beam axis",                  "rad"  ),
+                ])
+
+    def p(self):
+        """
+        Returns the distance from previous element.
+
+        Returns
+        -------
+        float
+
+        """
+        return self._p
+
+    def q(self):
+        """
+        Returns the distance to next element.
+
+        Returns
+        -------
+        float
+
+        """
+        return self._q
+
+    def angle_radial(self):
+        """
+        Returns the radial angle.
+
+        Returns
+        -------
+        float
+
+        """
+        return self._angle_radial
+
+    def angle_radial_out(self):
+        """
+        Returns the radial angle in the output direction.
+
+        Returns
+        -------
+        float
+
+        """
+        if self._angle_radial_out is None:
+            return self.angle_radial()
+        else:
+            return self._angle_radial_out
+
+    def angle_azimuthal(self):
+        """
+        Returns the azimuthal angle.
+
+        Returns
+        -------
+        float
+
+        """
+        return self._angle_azimuthal
+
+    def set_positions(self, p=0.0, q=0.0, angle_radial=0.0, angle_radial_out=None, angle_azimuthal=0.0):
+        """
+        Sets the coordinates.
+
+        Parameters
+        ----------
+        p : float, optional
+            distance from previous element in m.
+        q : float, optional
+            distance to next element in m.
+        angle_radial : float, optional
+            Radial inclination angle in rads.
+        angle_azimuthal : float, optional
+            Azimuthal inclination angle in rads.
+        angle_radial_out : float, optional
+            The radial angle in rads in the output direction (default=None, the same as angle_radial).
+
+        """
+        self._p = p
+        self._q = q
+        self._angle_radial = angle_radial
+        self._angle_radial_out = angle_radial_out
+        self._angle_azimuthal = angle_azimuthal
+
+    def get_positions(self):
+        """
+        Gets the coordinates.
+
+        Returns
+        -------
+        tuple
+            (p, q, angle_radial, angle_radial_out, angle_azimuthal)
+
+        """
+        return self.p(), \
+            self.q(), \
+            self.angle_radial(), \
+            self.angle_radial_out(), \
+            self.angle_azimuthal()
+
+    def set_p_and_q(self, p=0.0, q=0.0):
+        """
+        Set the distances p and q.
+
+        Parameters
+        ----------
+        p : float, optional
+            distance from previous element in m.
+        q : float, optional
+            distance to next element in m.
+
+        """
+        self._p = p
+        self._q = q
+
+    def get_p_and_q(self):
+        """
+        Gets p and q.
+
+        Returns
+        -------
+        tuple
+            (p,q).
+
+        """
+        return self.p(), self.q()
+
+    def set_angles(self, angle_radial=0.0, angle_radial_out=None, angle_azimuthal=0.0):
+        """
+        Sets the angles.
+
+        Parameters
+        ----------
+        angle_radial : float, optional
+            Radial inclination angle in rads.
+        angle_azimuthal : float, optional
+            Azimuthal inclination angle in rads.
+        angle_radial_out : float, optional
+            The radial angle in rads in the output direction (default=None, the same as angle_radial).
+
+        Returns
+        -------
+
+        """
+        self._angle_radial = angle_radial
+        self._angle_radial_out = angle_radial_out
+        self._angle_azimuthal = angle_azimuthal
+
+    def get_angles(self):
+        """
+        Get the angles.
+
+        Returns
+        -------
+        tuple
+            (angle_radial, angle_radial_out, angle_azimuthal)
+
+        """
+        return self.angle_radial(), self.angle_radial_out(), self.angle_azimuthal()

syned/beamline/optical_element.py

@@ -0,0 +1,47 @@
+"""
+Base class for an optical element.
+"""
+from syned.syned_object import SynedObject
+
+class OpticalElement(SynedObject):
+    """
+    Constructor.
+
+    Parameters
+    ----------
+    name : str
+        The element name.
+    boundary_shape : instance of BoundaryShape, optional
+        The element shape. The default=None means no shape associated to the optical element.
+    """
+    def __init__(self, name="Undefined", boundary_shape=None):
+        self._name = name
+        self._boundary_shape = boundary_shape
+
+        # support text containg name of variable, help text and unit. Will be stored in self._support_dictionary
+        self._set_support_text([
+                    ("name", "Name", ""),
+                    ("boundary_shape"      , "", "" ),
+            ] )
+
+    def get_name(self):
+        """
+        returns the optical element name.
+
+        Returns
+        -------
+        str
+
+        """
+        return self._name
+
+    def get_boundary_shape(self):
+        """
+        Returns the boundary shape.
+
+        Returns
+        -------
+        None or instance of BoundaryShape
+
+        """
+        return self._boundary_shape

syned/beamline/optical_element_with_surface_shape.py

@@ -0,0 +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())

syned/beamline/optical_elements/__init__.py

@@ -0,0 +1 @@
+