syned 1.0.47__py3-none-any.whl

syned/beamline/optical_elements/absorbers/absorber.py

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

syned/beamline/optical_elements/absorbers/beam_stopper.py

@@ -0,0 +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)
+
+    #TODO: add set_ellipse (like in slit).

syned/beamline/optical_elements/absorbers/filter.py

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

syned/beamline/optical_elements/absorbers/holed_filter.py

@@ -0,0 +1,67 @@
+#
+# this is a filter with a hole (holed-filter)
+#                                  Slit     BeamStopper    Filter      HoledFilter
+#       beam pass at center         Yes     No             Yes         No
+#       apply attenuation           No      No             Yes         Yes
+#
+#
+from syned.beamline.optical_elements.absorbers.absorber import Absorber
+
+class HoledFilter(Absorber):
+    """
+    Filter or absorber or attenuator with a hole.
+
+    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
+        Defines the geometry of the hole. 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

syned/beamline/optical_elements/absorbers/slit.py

@@ -0,0 +1,81 @@
+
+from syned.beamline.shape import BoundaryShape
+from syned.beamline.shape import Rectangle, Ellipse, Circle
+
+from syned.beamline.optical_elements.absorbers.absorber import Absorber
+
+class Slit(Absorber):
+    """
+    Slit or aperture.
+
+    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,center_x=0.0,center_y=0.0):
+        """
+        Sets the aperture 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+center_x,0.5*width+center_x,-0.5*height+center_y,0.5*height+center_y)
+
+    def set_circle(self,radius=3e-3,center_x=0.0,center_y=0.0):
+        """
+        Sets the aperture 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=Circle(radius,center_x,center_y)
+
+    def set_ellipse(self,width=3e-3,height=4e-3,center_x=0.0,center_y=0.0):
+        """
+        Sets the aperture as an ellipse.
+
+        Parameters
+        ----------
+        width : float, optional
+            The ellipse width (2a).
+        height : float, optional
+            The ellipse height (2b).
+        center_x : float, optional
+            The ellipse center coordinate X.
+        center_y : float, optional
+            The ellipse center coordinate Y.
+
+        """
+        self._boundary_shape=Ellipse(-0.5*width+center_x,0.5*width+center_x,-0.5*height+center_y,0.5*height+center_y)

syned/beamline/optical_elements/crystals/__init__.py

@@ -0,0 +1 @@
+

syned/beamline/optical_elements/crystals/crystal.py

@@ -0,0 +1,70 @@
+from syned.beamline.shape import SurfaceShape
+from syned.beamline.optical_element_with_surface_shape import OpticalElementsWithSurfaceShape
+
+class DiffractionGeometry:
+    BRAGG = 0
+    LAUE = 1
+
+class Crystal(OpticalElementsWithSurfaceShape):
+    """
+    Constructor.
+
+    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 : str, optional
+        The material name.
+    diffraction_geometry : int (as defined in DiffractionGeometry, optional
+        BRAGG = 0, LAUE = 1.
+    miller_index_h : int, optional
+        The Miller index H.
+    miller_index_k : int, optional
+        The Miller index K.
+    miller_index_l : int, optional
+        The Miller index L.
+    asymmetry_angle : float, optional
+        The asymmetry angle in rad.
+    thickness : float, optional
+        The crystal thickness in m.
+
+    """
+    def __init__(self,
+                 name="Undefined",
+                 surface_shape=SurfaceShape(), # TODO: this should be None
+                 boundary_shape=None,
+                 material="Si",
+                 diffraction_geometry=DiffractionGeometry.BRAGG,
+                 miller_index_h=1,
+                 miller_index_k=1,
+                 miller_index_l=1,
+                 asymmetry_angle=0.0,
+                 thickness=0.0,
+                 ):
+        super().__init__(name, surface_shape, boundary_shape)
+        self._material = material
+        self._diffraction_geometry = diffraction_geometry
+        self._miller_index_h = miller_index_h
+        self._miller_index_k = miller_index_k
+        self._miller_index_l = miller_index_l
+        self._asymmetry_angle = asymmetry_angle
+        self._thickness = 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" ,        "" ),
+                    ("material",            "Material (name)" ,       "" ),
+                    ("diffraction_geometry","Diffraction Geometry",   "" ),
+                    ("miller_index_h",      "Miller index h",         "" ),
+                    ("miller_index_k",      "Miller index k",         "" ),
+                    ("miller_index_l",      "Miller index l",         "" ),
+                    ("asymmetry_angle",     "Asymmetry angle",        "rad"),
+                    ("thickness",           "Thickness",              "m"),
+            ] )
+

syned/beamline/optical_elements/gratings/__init__.py

@@ -0,0 +1 @@
+

syned/beamline/optical_elements/gratings/grating.py

@@ -0,0 +1,279 @@
+from syned.beamline.shape import SurfaceShape, BoundaryShape
+from syned.beamline.optical_element_with_surface_shape import OpticalElementsWithSurfaceShape
+
+class Grating(OpticalElementsWithSurfaceShape):
+    """
+    Constructor.
+
+    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().
+    ruling : float, optional
+        The grating ruling in lines/m.
+
+    """
+    def __init__(self,
+                 name="Undefined",
+                 surface_shape=SurfaceShape(),
+                 boundary_shape=BoundaryShape(),
+                 ruling=800e3,
+                 ):
+        super().__init__(name, surface_shape, boundary_shape)
+        self._ruling = ruling
+
+        # 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" ,        "" ),
+                    ("ruling",                 "Ruling at center" ,      "lines/m" ),
+            ] )
+
+
+class GratingVLS(Grating):
+    """
+    Constructor.
+
+    Parameters
+    ----------
+    name : str, optional
+        The name of the optical element.
+    surface_shape : instance of SurfaceShape, optional
+        The geometry of the optical element 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().
+    ruling : float, optional
+        The grating ruling polinomial coefficient of 0th order [lines/m].
+    ruling_coeff_linear : float, optional
+        The grating ruling polinomial coefficient of 1th order [lines/m^2].
+    ruling_coeff_quadratic : float, optional
+        The grating ruling polinomial coefficient of 2th order [lines/m^3].
+    ruling_coeff_cubic : float, optional
+        The grating ruling polinomial coefficient of 3th order [lines/m^4].
+    ruling_coeff_quartic : float, optional
+        The grating ruling polinomial coefficient of 4th order [lines/m^5].
+    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=BoundaryShape(),
+                 ruling=800e3,
+                 ruling_coeff_linear=0.0,
+                 ruling_coeff_quadratic=0.0,
+                 ruling_coeff_cubic=0.0,
+                 ruling_coeff_quartic=0.0,
+                 coating=None,
+                 coating_thickness=None,
+                 ):
+        super().__init__(name, surface_shape, boundary_shape)
+
+        self._ruling = ruling
+        self._ruling_coeff_linear = ruling_coeff_linear
+        self._ruling_coeff_quadratic = ruling_coeff_quadratic
+        self._ruling_coeff_cubic = ruling_coeff_cubic
+        self._ruling_coeff_quartic = ruling_coeff_quartic
+        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" ,        "" ),
+                    ("ruling",                 "Ruling at center" ,      "lines/m" ),
+                    ("ruling_coeff_linear",    "Ruling linear coeff",    "lines/m^2"),
+                    ("ruling_coeff_quadratic", "Ruling quadratic coeff", "lines/m^3"),
+                    ("ruling_coeff_cubic",     "Ruling cubic coeff",     "lines/m^4"),
+                    ("ruling_coeff_quartic",   "Ruling quartic coeff",    "lines/m^5"),
+                    ("coating",                "Coating (element, compound or name)", ""),
+                    ("coating_thickness",      "Coating thickness", "m"),
+            ] )
+
+
+class GratingBlaze(GratingVLS):
+    """
+    Constructor.
+
+    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().
+    ruling : float, optional
+        The grating ruling polinomial coefficient of 0th order [lines/m].
+    ruling_coeff_linear : float, optional
+        The grating ruling polinomial coefficient of 1th order [lines/m^2].
+    ruling_coeff_quadratic : float, optional
+        The grating ruling polinomial coefficient of 2th order [lines/m^3].
+    ruling_coeff_cubic : float, optional
+        The grating ruling polinomial coefficient of 3th order [lines/m^4].
+    ruling_coeff_quartic : float, optional
+        The grating ruling polinomial coefficient of 4th order [lines/m^5].
+    coating : str, optional
+        The grating coating material.
+    coating_thickness : float, optional
+        The grating coating thickness in m.
+    blaze_angle : float, optional
+        The blaze angle in rad.
+    antiblaze_angle : float, optional
+        The anti-blaze angle in rad.
+
+    """
+    def __init__(self,
+                 name="Undefined",
+                 surface_shape=SurfaceShape(),
+                 boundary_shape=BoundaryShape(),
+                 ruling=800e3,
+                 ruling_coeff_linear=0.0,
+                 ruling_coeff_quadratic=0.0,
+                 ruling_coeff_cubic=0.0,
+                 ruling_coeff_quartic=0.0,
+                 coating=None,
+                 coating_thickness=None,
+                 blaze_angle=0.0,
+                 antiblaze_angle=90.0,
+                 ):
+        super().__init__(name, surface_shape, boundary_shape,
+                         ruling=ruling,
+                         ruling_coeff_linear=ruling_coeff_linear,
+                         ruling_coeff_quadratic=ruling_coeff_quadratic,
+                         ruling_coeff_cubic=ruling_coeff_cubic,
+                         ruling_coeff_quartic=ruling_coeff_quartic,
+                         coating=coating,
+                         coating_thickness=coating_thickness,
+                         )
+        self._blaze_angle = blaze_angle
+        self._antiblaze_angle = antiblaze_angle
+
+
+        # 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", ""),
+                    ("ruling", "Ruling at center", "lines/m"),
+                    ("ruling_coeff_linear", "Ruling linear coeff", "lines/m^2"),
+                    ("ruling_coeff_quadratic", "Ruling quadratic coeff", "lines/m^3"),
+                    ("ruling_coeff_cubic", "Ruling cubic coeff", "lines/m^4"),
+                    ("ruling_coeff_quartic", "Ruling quartic coeff", "lines/m^5"),
+                    ("coating", "Coating (element, compound or name)", ""),
+                    ("coating_thickness", "Coating thickness", "m"),
+                    ("blaze_angle",      "Blaze angle",     "rad"),
+                    ("antiblaze_angle",  "Antiblaze angle", "rad"),
+            ] )
+
+    def get_apex_angle(self):
+        return 180 - self._blaze_angle - self._antiblaze_angle
+
+
+class GratingLamellar(GratingVLS):
+    """
+    Constructor.
+
+    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().
+    ruling : float, optional
+        The grating ruling polinomial coefficient of 0th order [lines/m].
+    ruling_coeff_linear : float, optional
+        The grating ruling polinomial coefficient of 1th order [lines/m^2].
+    ruling_coeff_quadratic : float, optional
+        The grating ruling polinomial coefficient of 2th order [lines/m^3].
+    ruling_coeff_cubic : float, optional
+        The grating ruling polinomial coefficient of 3th order [lines/m^4].
+    ruling_coeff_quartic : float, optional
+        The grating ruling polinomial coefficient of 4th order [lines/m^5].
+    coating : str, optional
+        The grating coating material.
+    coating_thickness : float, optional
+        The grating coating thickness in m.
+    height : str, optional
+        The height of the grating lamella in m.
+    ratio_valley_to_period : float, optional
+        The grating ration valley to period.
+
+    """
+
+    def __init__(self,
+                 name="Undefined",
+                 surface_shape=SurfaceShape(),
+                 boundary_shape=BoundaryShape(),
+                 ruling=800e3,
+                 ruling_coeff_linear=0.0,
+                 ruling_coeff_quadratic=0.0,
+                 ruling_coeff_cubic=0.0,
+                 coating=None,
+                 coating_thickness=None,
+                 height=1e-6,
+                 ratio_valley_to_period=0.5, # TODO: is better to define ratio valley to height?
+                 ):
+        super().__init__(name, surface_shape, boundary_shape,
+                         ruling=ruling,
+                         ruling_coeff_linear=ruling_coeff_linear,
+                         ruling_coeff_quadratic=ruling_coeff_quadratic,
+                         ruling_coeff_cubic=ruling_coeff_cubic,
+                         coating=coating,
+                         coating_thickness=coating_thickness,
+                         )
+        self._height = height
+        self._ratio_valley_to_period = ratio_valley_to_period
+
+
+        # 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", ""),
+                    ("ruling", "Ruling at center", "lines/m"),
+                    ("ruling_coeff_linear", "Ruling linear coeff", "lines/m^2"),
+                    ("ruling_coeff_quadratic", "Ruling quadratic coeff", "lines/m^3"),
+                    ("ruling_coeff_cubic", "Ruling cubic coeff", "lines/m^4"),
+                    ("ruling_coeff_quartic", "Ruling quartic coeff", "lines/m^5"),
+                    ("coating", "Coating (element, compound or name)", ""),
+                    ("coating_thickness", "Coating thickness", "m"),
+                    ("height",            "Height",     "m"),
+                    ("ratio_valley_to_period",  "Valley/period ratio", ""),
+            ] )
+
+
+if __name__ == "__main__":
+
+    grating1 = Grating(name="grating1")
+    # grating1.keys()
+    print(grating1.info())
+    # print(grating1.to_json())
+
+    grating1 = GratingVLS(name="grating1")
+    # grating1.keys()
+    print(grating1.info())
+    # print(grating1.to_json())
+
+    grating1 = GratingBlaze(name="grating1")
+    # grating1.keys()
+    print(grating1.info())
+    # print(grating1.to_json())
+
+    grating1 = GratingLamellar(name="grating1")
+    # grating1.keys()
+    print(grating1.info())
+    # print(grating1.to_json())
+
+

syned/beamline/optical_elements/ideal_elements/__init__.py

@@ -0,0 +1 @@
+

syned/beamline/optical_elements/ideal_elements/ideal_element.py

@@ -0,0 +1,16 @@
+from syned.beamline.optical_element import OpticalElement
+
+class IdealElement(OpticalElement):
+    def __init__(self, name="Undefined", boundary_shape=None):
+        """
+        Base for ideal optical elements (e.g., screen, ideal lenses).
+
+        Parameters
+        ----------
+        name : str, optional
+            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().
+
+        """
+        OpticalElement.__init__(self, name=name, boundary_shape=boundary_shape)