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

syned/beamline/optical_elements/multilayers/__init__.py

@@ -1,46 +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.                                             #
-# ----------------------------------------------------------------------- #
+#!/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/beamline/optical_elements/multilayers/multilayer.py

@@ -1,45 +1,45 @@
-from syned.beamline.shape import SurfaceShape
-from syned.beamline.optical_element_with_surface_shape import OpticalElementsWithSurfaceShape
-
-class Multilayer(OpticalElementsWithSurfaceShape):
-    """
-    Constructor.
-
-    Parameters
-    ----------
-    name : str
-        The name of the optical element.
-    surface_shape : instance of SurfaceShape, optional
-        The geometry of the crystal surface. if None, it is initialized to SurfaceShape().
-    boundary_shape : instance of BoundaryShape, optional
-        The geometry of the slit aperture. if None, it is initialized to BoundaryShape().
-    structure : str, optional
-        The multilayer structure e.g. [B,W]x50+Si.
-    period : float, optional
-        The period of the repeated bilayer in A.
-    Gamma : float, optional
-        The gamma factor.
-    """
-    def __init__(self,
-                 name="Undefined",
-                 surface_shape=SurfaceShape(),
-                 boundary_shape=None,
-                 structure='[B/W]x50+Si',
-                 period=25.0,
-                 Gamma=0.5,
-                 ):
-
-        super().__init__(name, surface_shape, boundary_shape)
-        self._structure = structure
-        self._period = period
-        self._Gamma = Gamma
-        # support text containg name of variable, help text and unit. Will be stored in self._support_dictionary
-        self._set_support_text([
-                    ("name",                "Name" ,                                          "" ),
-                    ("surface_shape",       "Surface shape",                                  "" ),
-                    ("boundary_shape",      "Boundary shape",                                 "" ),
-                    ("structure",           "structure ([Odd,Even]xN+Substrate)",             "" ),
-                    ("period",              "period of the repeated structure",               "A"),
-                    ("Gamma",               "Gamma factor [thickness ratio Even)/(Odd+Even)", ""),
-            ] )
-
+from syned.beamline.shape import SurfaceShape
+from syned.beamline.optical_element_with_surface_shape import OpticalElementsWithSurfaceShape
+
+class Multilayer(OpticalElementsWithSurfaceShape):
+    """
+    Constructor.
+
+    Parameters
+    ----------
+    name : str
+        The name of the optical element.
+    surface_shape : instance of SurfaceShape, optional
+        The geometry of the crystal surface. if None, it is initialized to SurfaceShape().
+    boundary_shape : instance of BoundaryShape, optional
+        The geometry of the slit aperture. if None, it is initialized to BoundaryShape().
+    structure : str, optional
+        The multilayer structure e.g. [B,W]x50+Si.
+    period : float, optional
+        The period of the repeated bilayer in A.
+    Gamma : float, optional
+        The gamma factor.
+    """
+    def __init__(self,
+                 name="Undefined",
+                 surface_shape=SurfaceShape(),
+                 boundary_shape=None,
+                 structure='[B/W]x50+Si',
+                 period=25.0,
+                 Gamma=0.5,
+                 ):
+
+        super().__init__(name, surface_shape, boundary_shape)
+        self._structure = structure
+        self._period = period
+        self._Gamma = Gamma
+        # support text containg name of variable, help text and unit. Will be stored in self._support_dictionary
+        self._set_support_text([
+                    ("name",                "Name" ,                                          "" ),
+                    ("surface_shape",       "Surface shape",                                  "" ),
+                    ("boundary_shape",      "Boundary shape",                                 "" ),
+                    ("structure",           "structure ([Odd,Even]xN+Substrate)",             "" ),
+                    ("period",              "period of the repeated structure",               "A"),
+                    ("Gamma",               "Gamma factor [thickness ratio Even)/(Odd+Even)", ""),
+            ] )
+

syned/beamline/optical_elements/refractors/__init__.py

@@ -1 +1 @@
-
+

syned/beamline/optical_elements/refractors/crl.py

@@ -1,79 +1,79 @@
-from syned.beamline.optical_elements.refractors.lens import Lens
-
-class CRL(Lens):
-    """
-    Defines a Compound refractive lens (CRL). It is composed by a number (n_lens) of identical lenses.
-
-    Constructor.
-
-    Parameters
-    ----------
-    name : str, optional
-        The name of the optical element.
-    n_lens : int, optional
-        The number of (identical) lenses.
-    surface_shape1 : instance of SurfaceShape, optional
-        The geometry of the lens surface 1. if None, it is initialized to SurfaceShape().
-    surface_shape2 : instance of SurfaceShape, optional
-        The geometry of the lens surface 2. if None, it is initialized to SurfaceShape().
-    boundary_shape : instance of BoundaryShape, optional
-        The geometry of the slit aperture. if None, it is initialized to BoundaryShape().
-    material : str
-        A string defining the material within the two surfaces.
-    thickness : float
-        The distance between the two surfaces at the center of the lens in m.
-    piling_thickness : float, optional
-        The piling distance in m, or spatial periodicity in the stack. In other words, the distance from the
-        lens1-surface1 to the lens2-surface1.
-
-    """
-    def __init__(self,
-                 name="Undefined",
-                 n_lens=1,
-                 surface_shape1=None,
-                 surface_shape2=None,
-                 boundary_shape=None,
-                 material="",
-                 thickness=0.0,
-                 piling_thickness=0.0):
-        super().__init__(name=name,
-                         surface_shape1=surface_shape1,
-                         surface_shape2=surface_shape2,
-                         boundary_shape=boundary_shape,
-                         material=material,
-                         thickness=thickness)
-        self._n_lens           = n_lens
-        self._piling_thickness = piling_thickness
-
-        # support text contaning name of variable, help text and unit. Will be stored in self._support_dictionary
-        self._set_support_text([
-                    ("name",                "Name" ,                                "" ),
-                    ("n_lens",              "N Lens" ,                              "" ),
-                    ("surface_shapes",      "Surface shapes",                       "" ),
-                    ("boundary_shape",      "Boundary shape",                       "" ),
-                    ("material",            "Material (element, compound or name)", "" ),
-                    ("thickness",           "Thickness",                            "m"),
-                    ("piling_thickness",    "Piling Thickness",                     "m")
-            ] )
-
-    def get_n_lens(self):
-        """
-        Returns the number of lenses.
-
-        Returns
-        -------
-        int
-
-        """
-        return self._n_lens
-
-    def get_piling_thickness(self):
-        """
-        Returns the piling thickness.
-
-        Returns
-        -------
-        float
-
-        """
-        return self._piling_thickness
+from syned.beamline.optical_elements.refractors.lens import Lens
+
+class CRL(Lens):
+    """
+    Defines a Compound refractive lens (CRL). It is composed by a number (n_lens) of identical lenses.
+
+    Constructor.
+
+    Parameters
+    ----------
+    name : str, optional
+        The name of the optical element.
+    n_lens : int, optional
+        The number of (identical) lenses.
+    surface_shape1 : instance of SurfaceShape, optional
+        The geometry of the lens surface 1. if None, it is initialized to SurfaceShape().
+    surface_shape2 : instance of SurfaceShape, optional
+        The geometry of the lens surface 2. if None, it is initialized to SurfaceShape().
+    boundary_shape : instance of BoundaryShape, optional
+        The geometry of the slit aperture. if None, it is initialized to BoundaryShape().
+    material : str
+        A string defining the material within the two surfaces.
+    thickness : float
+        The distance between the two surfaces at the center of the lens in m.
+    piling_thickness : float, optional
+        The piling distance in m, or spatial periodicity in the stack. In other words, the distance from the
+        lens1-surface1 to the lens2-surface1.
+
+    """
+    def __init__(self,
+                 name="Undefined",
+                 n_lens=1,
+                 surface_shape1=None,
+                 surface_shape2=None,
+                 boundary_shape=None,
+                 material="",
+                 thickness=0.0,
+                 piling_thickness=0.0):
+        super().__init__(name=name,
+                         surface_shape1=surface_shape1,
+                         surface_shape2=surface_shape2,
+                         boundary_shape=boundary_shape,
+                         material=material,
+                         thickness=thickness)
+        self._n_lens           = n_lens
+        self._piling_thickness = piling_thickness
+
+        # support text contaning name of variable, help text and unit. Will be stored in self._support_dictionary
+        self._set_support_text([
+                    ("name",                "Name" ,                                "" ),
+                    ("n_lens",              "N Lens" ,                              "" ),
+                    ("surface_shapes",      "Surface shapes",                       "" ),
+                    ("boundary_shape",      "Boundary shape",                       "" ),
+                    ("material",            "Material (element, compound or name)", "" ),
+                    ("thickness",           "Thickness",                            "m"),
+                    ("piling_thickness",    "Piling Thickness",                     "m")
+            ] )
+
+    def get_n_lens(self):
+        """
+        Returns the number of lenses.
+
+        Returns
+        -------
+        int
+
+        """
+        return self._n_lens
+
+    def get_piling_thickness(self):
+        """
+        Returns the piling thickness.
+
+        Returns
+        -------
+        float
+
+        """
+        return self._piling_thickness

syned/beamline/optical_elements/refractors/interface.py

@@ -1,61 +1,61 @@
-from syned.beamline.shape import SurfaceShape
-from syned.beamline.optical_element_with_surface_shape import OpticalElementsWithSurfaceShape
-
-class Interface(OpticalElementsWithSurfaceShape):
-    def __init__(self,
-                 name="Undefined",
-                 surface_shape=SurfaceShape(),
-                 boundary_shape=None,
-                 material_object=None,
-                 material_image=None,):
-        """
-        Defines an interface (a surface with different materials in side 1 and side 2).
-
-        Parameters
-        ----------
-        name : str, optional
-            The name of the optical element.
-        surface_shape : instance of SurfaceShape, optional
-            The geometry of the crystal surface. if None, it is initialized to SurfaceShape().
-        boundary_shape : instance of BoundaryShape, optional
-            The geometry of the slit aperture. if None, it is initialized to BoundaryShape().
-        material_object : str, optional
-            The material in side 1 (object side).
-        material_image : str, optional
-            The material in side 2 (object image).
-
-        """
-
-        super().__init__(name, surface_shape, boundary_shape)
-        self._material_object = material_object
-        self._material_image = material_image
-        # support text containg name of variable, help text and unit. Will be stored in self._support_dictionary
-        self._set_support_text([
-                    ("name",                "Name" ,                               "" ),
-                    ("surface_shape",       "Surface shape",                       "" ),
-                    ("boundary_shape",      "Boundary shape",                      "" ),
-                    ("material_object",     "Material in object side (element, compound, name or refraction index)", "" ),
-                    ("material_image",      "Material in image side (element, compound, name or refraction index)", ""),
-           ] )
-
-    def get_material_object(self):
-        """
-        Returns the material of side 1 (object).
-
-        Returns
-        -------
-        str
-
-        """
-        return self._material_object
-
-    def get_material_image(self):
-        """
-        Returns the material of side 2 (image).
-
-        Returns
-        -------
-        str
-
-        """
+from syned.beamline.shape import SurfaceShape
+from syned.beamline.optical_element_with_surface_shape import OpticalElementsWithSurfaceShape
+
+class Interface(OpticalElementsWithSurfaceShape):
+    def __init__(self,
+                 name="Undefined",
+                 surface_shape=SurfaceShape(),
+                 boundary_shape=None,
+                 material_object=None,
+                 material_image=None,):
+        """
+        Defines an interface (a surface with different materials in side 1 and side 2).
+
+        Parameters
+        ----------
+        name : str, optional
+            The name of the optical element.
+        surface_shape : instance of SurfaceShape, optional
+            The geometry of the crystal surface. if None, it is initialized to SurfaceShape().
+        boundary_shape : instance of BoundaryShape, optional
+            The geometry of the slit aperture. if None, it is initialized to BoundaryShape().
+        material_object : str, optional
+            The material in side 1 (object side).
+        material_image : str, optional
+            The material in side 2 (object image).
+
+        """
+
+        super().__init__(name, surface_shape, boundary_shape)
+        self._material_object = material_object
+        self._material_image = material_image
+        # support text containg name of variable, help text and unit. Will be stored in self._support_dictionary
+        self._set_support_text([
+                    ("name",                "Name" ,                               "" ),
+                    ("surface_shape",       "Surface shape",                       "" ),
+                    ("boundary_shape",      "Boundary shape",                      "" ),
+                    ("material_object",     "Material in object side (element, compound, name or refraction index)", "" ),
+                    ("material_image",      "Material in image side (element, compound, name or refraction index)", ""),
+           ] )
+
+    def get_material_object(self):
+        """
+        Returns the material of side 1 (object).
+
+        Returns
+        -------
+        str
+
+        """
+        return self._material_object
+
+    def get_material_image(self):
+        """
+        Returns the material of side 2 (image).
+
+        Returns
+        -------
+        str
+
+        """
         return self._material_image