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

syned/beamline/optical_elements/ideal_elements/ideal_fzp.py

@@ -1,183 +1,183 @@
-import numpy
-from syned.beamline.optical_elements.ideal_elements.ideal_element import IdealElement
-
-class IdealFZP(IdealElement):
-    """
-    Defines an ideal Fresnel Zone Plate.
-
-    Constructor.
-
-    Parameters
-    ----------
-    name : str, optional
-        The name of the optical element.
-    focusing_direction : int
-        0=None, 1=x (sagittal), 2=z (meridional), 3=2D focusing.
-    focal : float
-        The focal length in meters.
-    nominal_wavelength : float
-        The nominal wavelength in m for where the focal length is defined.
-    diameter : float
-        The FZP diameter in m.
-
-    """
-    def __init__(self,
-                 name="Undefined",
-                 focusing_direction=3,  # 0=None, 1=x (sagittal), 2=z (meridional), 3=2D focusing.
-                 focal=1.0,                 #  focal distance (m)
-                 nominal_wavelength=1e-10,  # nominal wavelength in m
-                 # r0=10.0e-6,                #  inner zone radius (m)
-                 diameter=0.001,            # FZP diameter in m
-                 ):
-        IdealElement.__init__(self, name=name)
-        self._focusing_direction = focusing_direction
-        self._focal = focal
-        self._nominal_wavelength = nominal_wavelength
-        self._diameter = diameter
-
-        # 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"    , ""                    , ""),
-                    ("focusing_direction", "Focusing direction: 0=None, 1=1D along X, 2=1D along Z, 3=2D", ""),
-                    ("focal"             , "Focal length"        , "m"),
-                    ("nominal_wavelength", "Nominal wavelength"  , "m"),
-                    ("diameter"          , "FZP diameter"        , "m"),
-            ] )
-
-    def focusing_direction(self):
-        """
-        Returns the focusing direction.
-
-        Returns
-        -------
-        int
-            0=None,
-            1=1D along X,
-            2=1D along Z,
-            3=2D.
-        """
-        return self._focusing_direction
-
-    def focal(self):
-        """
-        Returns the focal length.
-
-        Returns
-        -------
-        float
-
-        """
-        return self._focal
-
-    def nominal_wavelength(self):
-        """
-        Returns the nominal wavelength.
-
-        Returns
-        -------
-        float
-
-        """
-        return self._nominal_wavelength
-
-    def diameter(self):
-        """
-        Returns the FZP diameter.
-
-        Returns
-        -------
-        float
-
-        """
-        return self._diameter
-
-    #
-    # calculated. The exact expression is rn = sqrt( n lambda f + (n lambda / 2)**2 )
-    #
-    def rn(self):
-        return 0.5 * self.diameter()
-
-    def r0(self):
-        """
-        Returns the innermost radius (approximated calculation r0=sqrt(wavelength * focal)).
-
-        Returns
-        -------
-        float
-
-        """
-        return numpy.sqrt(self.nominal_wavelength() * self.focal())
-
-    def r0_exact(self):
-        """
-        Returns the innermost radius (exact calculation r0=sqrt(wavelength * focal + (wavelength/2)**2)).
-
-        Returns
-        -------
-        float
-
-        """
-        return numpy.sqrt(self.nominal_wavelength() * self.focal() + (0.5 * self.nominal_wavelength())**2)
-
-    def n_vs_r(self, r): # approximated if f >> diameter; eq 855 in Michette
-        """
-        Returns the zone number for a given distance r (approximated calculation).
-
-        Returns
-        -------
-        float
-
-        """
-        return (r ** 2 / self.nominal_wavelength() / self.focal())
-
-    def n_exact_vs_r(self, r): # Exact, solving n from rn = sqrt( n lambda f + (n lambda / 2)**2 )
-        """
-        Returns the zone number for a given distance r
-        (exact calculation solving n from rn = sqrt( n lambda f + (n lambda / 2)**2).
-
-        Returns
-        -------
-        float
-
-        """
-        nn = -2 * self.focal() + 2 * numpy.sqrt(self.focal()**2 + r**2)
-        return nn / self.nominal_wavelength()
-
-    def n(self):
-        """
-        Returns the zone number for a outermost zone (approximated calculation).
-
-        Returns
-        -------
-        float
-
-        """
-        return self.n_vs_r( self.rn() )
-
-    def n_exact(self):
-        """
-        Returns the zone number for a outermost zone (exact calculation using n_exact_vs_r() ).
-
-        Returns
-        -------
-        float
-
-        """
-        return self.n_exact_vs_r(self.rn())
-
-if __name__ == "__main__":
-    fzp = IdealFZP(
-        name = "Undefined",
-        focusing_direction = 3,  # 0=None, 1=x (sagittal), 2=z (meridional), 3=2D focusing.
-        focal = 1.0,  # focal distance (m)
-        nominal_wavelength = 1e-10,  # nominal wavelength in m
-        diameter = 0.001,  # FZP diameter in m
-    )
-
-    print(fzp.info())
-    print("r0, r0_exact: ", fzp.r0(), fzp.r0_exact())
-    print("rn: ", fzp.rn())
-    print("n, n_exact: ", fzp.n(), fzp.n_exact())
-
-
+import numpy
+from syned.beamline.optical_elements.ideal_elements.ideal_element import IdealElement
+
+class IdealFZP(IdealElement):
+    """
+    Defines an ideal Fresnel Zone Plate.
+
+    Constructor.
+
+    Parameters
+    ----------
+    name : str, optional
+        The name of the optical element.
+    focusing_direction : int
+        0=None, 1=x (sagittal), 2=z (meridional), 3=2D focusing.
+    focal : float
+        The focal length in meters.
+    nominal_wavelength : float
+        The nominal wavelength in m for where the focal length is defined.
+    diameter : float
+        The FZP diameter in m.
+
+    """
+    def __init__(self,
+                 name="Undefined",
+                 focusing_direction=3,  # 0=None, 1=x (sagittal), 2=z (meridional), 3=2D focusing.
+                 focal=1.0,                 #  focal distance (m)
+                 nominal_wavelength=1e-10,  # nominal wavelength in m
+                 # r0=10.0e-6,                #  inner zone radius (m)
+                 diameter=0.001,            # FZP diameter in m
+                 ):
+        IdealElement.__init__(self, name=name)
+        self._focusing_direction = focusing_direction
+        self._focal = focal
+        self._nominal_wavelength = nominal_wavelength
+        self._diameter = diameter
+
+        # 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"    , ""                    , ""),
+                    ("focusing_direction", "Focusing direction: 0=None, 1=1D along X, 2=1D along Z, 3=2D", ""),
+                    ("focal"             , "Focal length"        , "m"),
+                    ("nominal_wavelength", "Nominal wavelength"  , "m"),
+                    ("diameter"          , "FZP diameter"        , "m"),
+            ] )
+
+    def focusing_direction(self):
+        """
+        Returns the focusing direction.
+
+        Returns
+        -------
+        int
+            0=None,
+            1=1D along X,
+            2=1D along Z,
+            3=2D.
+        """
+        return self._focusing_direction
+
+    def focal(self):
+        """
+        Returns the focal length.
+
+        Returns
+        -------
+        float
+
+        """
+        return self._focal
+
+    def nominal_wavelength(self):
+        """
+        Returns the nominal wavelength.
+
+        Returns
+        -------
+        float
+
+        """
+        return self._nominal_wavelength
+
+    def diameter(self):
+        """
+        Returns the FZP diameter.
+
+        Returns
+        -------
+        float
+
+        """
+        return self._diameter
+
+    #
+    # calculated. The exact expression is rn = sqrt( n lambda f + (n lambda / 2)**2 )
+    #
+    def rn(self):
+        return 0.5 * self.diameter()
+
+    def r0(self):
+        """
+        Returns the innermost radius (approximated calculation r0=sqrt(wavelength * focal)).
+
+        Returns
+        -------
+        float
+
+        """
+        return numpy.sqrt(self.nominal_wavelength() * self.focal())
+
+    def r0_exact(self):
+        """
+        Returns the innermost radius (exact calculation r0=sqrt(wavelength * focal + (wavelength/2)**2)).
+
+        Returns
+        -------
+        float
+
+        """
+        return numpy.sqrt(self.nominal_wavelength() * self.focal() + (0.5 * self.nominal_wavelength())**2)
+
+    def n_vs_r(self, r): # approximated if f >> diameter; eq 855 in Michette
+        """
+        Returns the zone number for a given distance r (approximated calculation).
+
+        Returns
+        -------
+        float
+
+        """
+        return (r ** 2 / self.nominal_wavelength() / self.focal())
+
+    def n_exact_vs_r(self, r): # Exact, solving n from rn = sqrt( n lambda f + (n lambda / 2)**2 )
+        """
+        Returns the zone number for a given distance r
+        (exact calculation solving n from rn = sqrt( n lambda f + (n lambda / 2)**2).
+
+        Returns
+        -------
+        float
+
+        """
+        nn = -2 * self.focal() + 2 * numpy.sqrt(self.focal()**2 + r**2)
+        return nn / self.nominal_wavelength()
+
+    def n(self):
+        """
+        Returns the zone number for a outermost zone (approximated calculation).
+
+        Returns
+        -------
+        float
+
+        """
+        return self.n_vs_r( self.rn() )
+
+    def n_exact(self):
+        """
+        Returns the zone number for a outermost zone (exact calculation using n_exact_vs_r() ).
+
+        Returns
+        -------
+        float
+
+        """
+        return self.n_exact_vs_r(self.rn())
+
+if __name__ == "__main__":
+    fzp = IdealFZP(
+        name = "Undefined",
+        focusing_direction = 3,  # 0=None, 1=x (sagittal), 2=z (meridional), 3=2D focusing.
+        focal = 1.0,  # focal distance (m)
+        nominal_wavelength = 1e-10,  # nominal wavelength in m
+        diameter = 0.001,  # FZP diameter in m
+    )
+
+    print(fzp.info())
+    print("r0, r0_exact: ", fzp.r0(), fzp.r0_exact())
+    print("rn: ", fzp.rn())
+    print("n, n_exact: ", fzp.n(), fzp.n_exact())
+
+

syned/beamline/optical_elements/ideal_elements/ideal_lens.py

@@ -1,54 +1,54 @@
-from syned.beamline.optical_elements.ideal_elements.ideal_element import IdealElement
-
-class IdealLens(IdealElement):
-    """
-    Defines an ideal lens. It converts a plane wave into:
-    * an spherical converging wave (if focal_x=focal_y).
-    * a toroidal converging wave (if focal_x != focal_y).
-    * a cylindrical wave (if focal_x or focal_y is infinity).
-
-    Constructor.
-
-    Parameters
-    ----------
-    name : str, optional
-        The name of the optical element.
-    focal_x : float
-        The focal length in meters along the X direction.
-    focal_y : float
-        The focal length in meters along the Y direction.
-
-    """
-    def __init__(self, name="Undefined", focal_x=1.0, focal_y=1.0):
-        IdealElement.__init__(self, name=name)
-        self._focal_x = focal_x
-        self._focal_y = focal_y
-        # 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", ""                              , ""),
-                    ("focal_x"       , "Focal length in x [horizontal]", "m" ),
-                    ("focal_y"       , "Focal length in y [vertical]"  , "m" ),
-            ] )
-
-    def focal_x(self):
-        """
-        Returns the focal length in the X direction.
-
-        Returns
-        -------
-        float
-
-        """
-        return self._focal_x
-
-    def focal_y(self):
-        """
-        Returns the focal length in the Y direction.
-
-        Returns
-        -------
-        float
-
-        """
-        return self._focal_y
+from syned.beamline.optical_elements.ideal_elements.ideal_element import IdealElement
+
+class IdealLens(IdealElement):
+    """
+    Defines an ideal lens. It converts a plane wave into:
+    * an spherical converging wave (if focal_x=focal_y).
+    * a toroidal converging wave (if focal_x != focal_y).
+    * a cylindrical wave (if focal_x or focal_y is infinity).
+
+    Constructor.
+
+    Parameters
+    ----------
+    name : str, optional
+        The name of the optical element.
+    focal_x : float
+        The focal length in meters along the X direction.
+    focal_y : float
+        The focal length in meters along the Y direction.
+
+    """
+    def __init__(self, name="Undefined", focal_x=1.0, focal_y=1.0):
+        IdealElement.__init__(self, name=name)
+        self._focal_x = focal_x
+        self._focal_y = focal_y
+        # 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", ""                              , ""),
+                    ("focal_x"       , "Focal length in x [horizontal]", "m" ),
+                    ("focal_y"       , "Focal length in y [vertical]"  , "m" ),
+            ] )
+
+    def focal_x(self):
+        """
+        Returns the focal length in the X direction.
+
+        Returns
+        -------
+        float
+
+        """
+        return self._focal_x
+
+    def focal_y(self):
+        """
+        Returns the focal length in the Y direction.
+
+        Returns
+        -------
+        float
+
+        """
+        return self._focal_y

syned/beamline/optical_elements/ideal_elements/screen.py

@@ -1,16 +1,16 @@
-from syned.beamline.optical_elements.ideal_elements.ideal_element import IdealElement
-
-class Screen(IdealElement):
-    """
-    Defines an ideal screen (a plane perpendiculat to the optical axis).
-
-    Constructor.
-
-    Parameters
-    ----------
-    name : str, optional
-        The name of the optical element.
-
-    """
-    def __init__(self, name="Undefined"):
+from syned.beamline.optical_elements.ideal_elements.ideal_element import IdealElement
+
+class Screen(IdealElement):
+    """
+    Defines an ideal screen (a plane perpendiculat to the optical axis).
+
+    Constructor.
+
+    Parameters
+    ----------
+    name : str, optional
+        The name of the optical element.
+
+    """
+    def __init__(self, name="Undefined"):
         IdealElement.__init__(self, name=name)

syned/beamline/optical_elements/mirrors/__init__.py

@@ -1 +1 @@
-
+

syned/beamline/optical_elements/mirrors/mirror.py

@@ -1,39 +1,39 @@
-from syned.beamline.shape import SurfaceShape
-from syned.beamline.optical_element_with_surface_shape import OpticalElementsWithSurfaceShape
-
-class Mirror(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().
-    coating : str, optional
-        The grating coating material.
-    coating_thickness : float, optional
-        The grating coating thickness in m.
-    """
-    def __init__(self,
-                 name="Undefined",
-                 surface_shape=SurfaceShape(),
-                 boundary_shape=None,
-                 coating=None,
-                 coating_thickness=None):
-
-        super().__init__(name, surface_shape, boundary_shape)
-        self._coating = coating
-        self._coating_thickness = coating_thickness
-        # 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",                      "" ),
-                    ("coating",             "Coating (element, compound or name)", "" ),
-                    ("coating_thickness",   "Coating thickness",                   "m"),
-            ] )
-
+from syned.beamline.shape import SurfaceShape
+from syned.beamline.optical_element_with_surface_shape import OpticalElementsWithSurfaceShape
+
+class Mirror(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().
+    coating : str, optional
+        The grating coating material.
+    coating_thickness : float, optional
+        The grating coating thickness in m.
+    """
+    def __init__(self,
+                 name="Undefined",
+                 surface_shape=SurfaceShape(),
+                 boundary_shape=None,
+                 coating=None,
+                 coating_thickness=None):
+
+        super().__init__(name, surface_shape, boundary_shape)
+        self._coating = coating
+        self._coating_thickness = coating_thickness
+        # 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",                      "" ),
+                    ("coating",             "Coating (element, compound or name)", "" ),
+                    ("coating_thickness",   "Coating thickness",                   "m"),
+            ] )
+