syned 1.0.40__tar.gz → 1.0.42__tar.gz

{syned-1.0.40 → syned-1.0.42}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: syned
-Version: 1.0.40
+Version: 1.0.42
 Summary: SYNED (SYNchrotron Elements Dictionary) kernel library
 Home-page: https://github.com/oasys-kit/syned
 Download-URL: https://github.com/oasys-kit/syned

{syned-1.0.40 → syned-1.0.42}/setup.py

@@ -9,7 +9,7 @@ except AttributeError:
 
 NAME = 'syned'
 
-VERSION = '1.0.40'
+VERSION = '1.0.42'
 ISRELEASED = True
 
 DESCRIPTION = 'SYNED (SYNchrotron Elements Dictionary) kernel library'

syned-1.0.42/syned/beamline/optical_elements/__init__.py

@@ -0,0 +1 @@
+

syned-1.0.42/syned/beamline/optical_elements/crystals/__init__.py

@@ -0,0 +1 @@
+

syned-1.0.42/syned/beamline/optical_elements/gratings/__init__.py

@@ -0,0 +1 @@
+

syned-1.0.42/syned/beamline/optical_elements/ideal_elements/__init__.py

@@ -0,0 +1 @@
+

syned-1.0.42/syned/beamline/optical_elements/ideal_elements/ideal_fzp.py

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

syned-1.0.42/syned/beamline/optical_elements/mirrors/__init__.py

@@ -0,0 +1 @@
+

syned-1.0.42/syned/beamline/optical_elements/refractors/__init__.py

@@ -0,0 +1 @@
+

syned-1.0.42/syned/storage_ring/__init__.py

@@ -0,0 +1 @@
+

syned-1.0.42/syned/storage_ring/magnetic_structures/__init__.py

@@ -0,0 +1 @@
+

{syned-1.0.40 → syned-1.0.42}/syned/version.py

@@ -1,9 +1,9 @@
 
 # THIS FILE IS GENERATED FROM syned SETUP.PY
-short_version = '1.0.36'
-version = '1.0.36'
-full_version = '1.0.36'
-git_revision = '357978d095b652b7164ba28368dc272a962652c1'
+short_version = '1.0.38'
+version = '1.0.38'
+full_version = '1.0.38'
+git_revision = ''
 release = True
 
 if not release:

{syned-1.0.40 → syned-1.0.42}/syned/widget/widget_decorator.py

@@ -8,7 +8,7 @@ class WidgetDecorator(object):
     """
 
     @classmethod
-    def syned_input_data(cls):
+    def syned_input_data(cls, multi_input=False):
         """
         A string to help defining SYNED data in OASYS.
 
@@ -18,7 +18,25 @@ class WidgetDecorator(object):
             [("SynedData", Beamline, "receive_syned_data")]
 
         """
-        return [("SynedData", Beamline, "receive_syned_data")]
+        try: # OASYS2
+            import oasys2
+
+            if not multi_input:
+                from orangewidget.widget import Input
+
+                return Input(name="SynedData",
+                             type=Beamline,
+                             id="SynedData",
+                             default=True, auto_summary=False)
+            else:
+                from orangewidget.widget import MultiInput
+
+                return MultiInput(name="SynedData",
+                                  type=Beamline,
+                                  id="SynedData",
+                                  default=True, auto_summary=False)
+        except:
+            return [("SynedData", Beamline, "receive_syned_data")]
 
     @classmethod
     def append_syned_input_data(cls, inputs):

{syned-1.0.40 → syned-1.0.42}/syned.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: syned
-Version: 1.0.40
+Version: 1.0.42
 Summary: SYNED (SYNchrotron Elements Dictionary) kernel library
 Home-page: https://github.com/oasys-kit/syned
 Download-URL: https://github.com/oasys-kit/syned

syned-1.0.42/syned.egg-info/SOURCES.txt

@@ -0,0 +1,60 @@
+LICENSE
+MANIFEST.in
+README.rst
+setup.py
+examples/__init__.py
+examples/example_beamline.py
+examples/example_double_slit.py
+examples/example_json_input_output.py
+syned/__init__.py
+syned/syned_object.py
+syned/version.py
+syned.egg-info/PKG-INFO
+syned.egg-info/SOURCES.txt
+syned.egg-info/dependency_links.txt
+syned.egg-info/not-zip-safe
+syned.egg-info/requires.txt
+syned.egg-info/top_level.txt
+syned/beamline/__init__.py
+syned/beamline/beamline.py
+syned/beamline/beamline_element.py
+syned/beamline/element_coordinates.py
+syned/beamline/optical_element.py
+syned/beamline/optical_element_with_surface_shape.py
+syned/beamline/shape.py
+syned/beamline/optical_elements/__init__.py
+syned/beamline/optical_elements/absorbers/__init__.py
+syned/beamline/optical_elements/absorbers/absorber.py
+syned/beamline/optical_elements/absorbers/beam_stopper.py
+syned/beamline/optical_elements/absorbers/filter.py
+syned/beamline/optical_elements/absorbers/holed_filter.py
+syned/beamline/optical_elements/absorbers/slit.py
+syned/beamline/optical_elements/crystals/__init__.py
+syned/beamline/optical_elements/crystals/crystal.py
+syned/beamline/optical_elements/gratings/__init__.py
+syned/beamline/optical_elements/gratings/grating.py
+syned/beamline/optical_elements/ideal_elements/__init__.py
+syned/beamline/optical_elements/ideal_elements/ideal_element.py
+syned/beamline/optical_elements/ideal_elements/ideal_fzp.py
+syned/beamline/optical_elements/ideal_elements/ideal_lens.py
+syned/beamline/optical_elements/ideal_elements/screen.py
+syned/beamline/optical_elements/mirrors/__init__.py
+syned/beamline/optical_elements/mirrors/mirror.py
+syned/beamline/optical_elements/refractors/__init__.py
+syned/beamline/optical_elements/refractors/crl.py
+syned/beamline/optical_elements/refractors/interface.py
+syned/beamline/optical_elements/refractors/lens.py
+syned/storage_ring/__init__.py
+syned/storage_ring/electron_beam.py
+syned/storage_ring/empty_light_source.py
+syned/storage_ring/light_source.py
+syned/storage_ring/magnetic_structure.py
+syned/storage_ring/magnetic_structures/__init__.py
+syned/storage_ring/magnetic_structures/bending_magnet.py
+syned/storage_ring/magnetic_structures/insertion_device.py
+syned/storage_ring/magnetic_structures/undulator.py
+syned/storage_ring/magnetic_structures/wiggler.py
+syned/util/__init__.py
+syned/util/json_tools.py
+syned/widget/__init__.py
+syned/widget/widget_decorator.py

syned-1.0.40/examples/example_get_source.py

@@ -1,48 +0,0 @@
-
-
-from syned.storage_ring.magnetic_structures.undulator import Undulator
-from syned.storage_ring.magnetic_structures.wiggler import Wiggler
-from syned.storage_ring.magnetic_structures.bending_magnet import BendingMagnet
-from syned.storage_ring.light_source import LightSource
-from syned.storage_ring.electron_beam import ElectronBeam
-
-from syned.beamline.beamline import Beamline
-
-if __name__ == "__main__":
-
-
-
-    src1 = ElectronBeam.initialize_as_pencil_beam(energy_in_GeV=6.0,current=0.2)
-    src2 = Undulator()
-    src = LightSource("test",src1,src2)
-    magnetic_structure = src.get_magnetic_structure()
-
-    print(magnetic_structure)
-    if isinstance(magnetic_structure, Undulator):
-        print(" I am undulator")
-    elif isinstance(magnetic_structure, Wiggler):
-        print("I am wiggler")
-    elif isinstance(magnetic_structure, BendingMagnet):
-        print("I am a Bending Magnet")
-    else:
-        print("I do not know what I am...")
-
-
-    #
-    #
-    #
-
-    a = Beamline()
-    magnetic_structure = a.get_light_source().get_magnetic_structure()
-
-    print(magnetic_structure)
-    if isinstance(magnetic_structure, Undulator):
-        print(" I am undulator")
-    elif isinstance(magnetic_structure, Wiggler):
-        print("I am wiggler")
-    elif isinstance(magnetic_structure, BendingMagnet):
-        print("I am a Bending Magnet")
-    else:
-        print("I do not know what I am...")
-
-

syned-1.0.40/shadow4/examples/optical_elements/examples_crystal.py

@@ -1,134 +0,0 @@
-
-import numpy
-
-from shadow4.sources.source_geometrical.source_geometrical import SourceGeometrical
-from shadow4.beamline.optical_elements.crystals.s4_plane_crystal import S4PlaneCrystal, S4PlaneCrystalElement
-
-
-from shadow4.tools.graphics import plotxy
-
-from syned.beamline.element_coordinates import ElementCoordinates
-
-from syned.beamline.optical_elements.crystals.crystal import Crystal, DiffractionGeometry
-
-
-def get_sigmas_radiation(photon_energy,undulator_length):
-    import scipy.constants as codata
-    lambdan = 1e-10 * codata.h*codata.c/codata.e*1e10 / photon_energy # in m
-    print("wavelength in m",lambdan)
-    return 1e6*2.740/4/numpy.pi*numpy.sqrt(lambdan*undulator_length),1e6*0.69*numpy.sqrt(lambdan/undulator_length)
-
-
-def crystal_diffraction_with_collimated_beam(do_plot=True):
-
-    #
-    # collimated source
-    #
-
-    if True:
-        src = SourceGeometrical()
-        src.set_energy_distribution_singleline(value=8000, unit='eV')
-        src.set_spatial_type_rectangle(width=1e-3, height=1e-3)
-        src.set_angular_distribution_uniform(0,0,-100e-6,100e-6)
-        src.set_polarization(polarization_degree= 0.5, phase_diff=numpy.pi/4, coherent_beam=True)
-        beam = src.get_beam()
-
-        print(beam.info())
-        SX, SZ = (1e6*beam.get_standard_deviation(1),1e6*beam.get_standard_deviation(3))
-
-
-    #
-    # crystal definition
-    #
-
-
-    if False:
-        crystal1 = S4PlaneCrystalElement(
-                                optical_element=S4PlaneCrystal(
-                                    name="Plane crystal",
-                                    boundary_shape=None,
-                                    material="Si",
-                                    diffraction_geometry=DiffractionGeometry.BRAGG,  # ?? not supposed to be in syned...
-                                    miller_index_h=1,
-                                    miller_index_k=1,
-                                    miller_index_l=1,
-                                    asymmetry_angle=0.0,
-                                    thickness=0.010, # this is thick crystal approximation
-                                    f_central=True,
-                                    f_phot_cent=0,
-                                    phot_cent=8000.0,
-                                    file_refl="",
-                                    f_bragg_a=False,
-                                    # a_bragg=0.0,
-                                    f_johansson=False,
-                                    r_johansson=1.0,
-                                    f_mosaic=False,
-                                    spread_mos=0.4 * numpy.pi / 180,
-                                    f_ext=0,                                    ),
-                                coordinates=ElementCoordinates(p=0.0, q=5000.0e-3,
-                                            angle_radial=0.0, angle_azimuthal=0.0, angle_radial_out=0.0),
-                                input_beam=beam)
-    else:
-        crystal1 = S4PlaneCrystalElement()
-        optical_element =             S4PlaneCrystal(
-                name="Plane crystal",
-                boundary_shape=None,
-                material="Si",
-                diffraction_geometry=DiffractionGeometry.BRAGG,  # ?? not supposed to be in syned...
-                miller_index_h=1,
-                miller_index_k=1,
-                miller_index_l=1,
-                asymmetry_angle=0.0,
-                thickness=0.010,  # this is thick crystal approximation
-                f_central=True,
-                f_phot_cent=0,
-                phot_cent=8000.0,
-                file_refl="",
-                f_bragg_a=False,
-                # a_bragg=0.0,
-                f_johansson=False,
-                r_johansson=1.0,
-                f_mosaic=False,
-                spread_mos=0.4 * numpy.pi / 180,
-                f_ext=0, )
-
-        crystal1.set_optical_element(optical_element)
-        crystal1.set_coordinates(
-            ElementCoordinates(p=0.0, q=5000.0e-3,
-                                           angle_radial=0.0, angle_azimuthal=0.0, angle_radial_out=0.0))
-        crystal1.set_input_beam(beam)
-
-
-    # print(crystal1.info())
-    # print(crystal1.get_optical_element().get_surface_shape().get_conic_coefficients())
-    #
-    # trace
-    #
-
-    beam2, mirr2 = crystal1.trace_beam()
-
-    if do_plot:
-        plotxy(beam2, 6, 23, nbins=100, title="INTENSITY VS Z'")
-
-    #
-    # #
-    # if do_plot:
-    #     plotxy(beam2, 1, 3, nbins=100, title="FOCAL PLANE")
-    #     plotxy(mirr2, 1, 3, nbins=100, title="LENS HEIGHT")
-    #     # plotxy(mirr2, 4, 5, nbins=100, title="FOOT DIV")
-    #
-    # FX, FZ = (1e6*beam2.get_standard_deviation(1),1e6*beam2.get_standard_deviation(3))
-    # print("Source dimensions: %f %f um"%(SX,SZ))
-    # print("Focal dimensions: %f %f um"%(FX,FZ))
-    # print("Demagnification: %g %g"%(SX/FX,SX/FZ))
-
-
-
-
-if __name__ == "__main__":
-    from srxraylib.plot.gol import set_qt
-    set_qt()
-
-    crystal_diffraction_with_collimated_beam(do_plot=True)
-
-

syned-1.0.40/shadow4/examples/optical_elements/examples_crystal_asymmetric.py

@@ -1,134 +0,0 @@
-
-import numpy
-
-from shadow4.sources.source_geometrical.source_geometrical import SourceGeometrical
-from shadow4.beamline.optical_elements.crystals.s4_plane_crystal import S4PlaneCrystal, S4PlaneCrystalElement
-
-
-from shadow4.tools.graphics import plotxy
-
-from syned.beamline.element_coordinates import ElementCoordinates
-
-from syned.beamline.optical_elements.crystals.crystal import Crystal, DiffractionGeometry
-
-
-def get_sigmas_radiation(photon_energy,undulator_length):
-    import scipy.constants as codata
-    lambdan = 1e-10 * codata.h*codata.c/codata.e*1e10 / photon_energy # in m
-    print("wavelength in m",lambdan)
-    return 1e6*2.740/4/numpy.pi*numpy.sqrt(lambdan*undulator_length),1e6*0.69*numpy.sqrt(lambdan/undulator_length)
-
-
-def crystal_diffraction_with_collimated_beam(do_plot=True):
-
-    #
-    # collimated source
-    #
-
-    if True:
-        src = SourceGeometrical(nrays=300)
-        src.set_energy_distribution_singleline(value=8000, unit='eV')
-        src.set_spatial_type_rectangle(width=1e-3, height=1e-3)
-        src.set_angular_distribution_uniform(0,0,-100e-6,100e-6)
-        src.set_polarization(polarization_degree= 0.5, phase_diff=numpy.pi/4, coherent_beam=True)
-        beam = src.get_beam()
-
-        print(beam.info())
-        SX, SZ = (1e6*beam.get_standard_deviation(1),1e6*beam.get_standard_deviation(3))
-
-
-    #
-    # crystal definition
-    #
-
-
-    if False:
-        crystal1 = S4PlaneCrystalElement(
-                                optical_element=S4PlaneCrystal(
-                                    name="Plane crystal",
-                                    boundary_shape=None,
-                                    material="Si",
-                                    diffraction_geometry=DiffractionGeometry.BRAGG,  # ?? not supposed to be in syned...
-                                    miller_index_h=1,
-                                    miller_index_k=1,
-                                    miller_index_l=1,
-                                    asymmetry_angle=0.0,
-                                    thickness=0.010, # this is thick crystal approximation
-                                    f_central=True,
-                                    f_phot_cent=0,
-                                    phot_cent=8000.0,
-                                    file_refl="",
-                                    f_bragg_a=False,
-                                    # a_bragg=0.0,
-                                    f_johansson=False,
-                                    r_johansson=1.0,
-                                    f_mosaic=False,
-                                    spread_mos=0.4 * numpy.pi / 180,
-                                    f_ext=0,                                    ),
-                                coordinates=ElementCoordinates(p=0.0, q=5000.0e-3,
-                                            angle_radial=0.0, angle_azimuthal=0.0, angle_radial_out=0.0),
-                                input_beam=beam)
-    else:
-        crystal1 = S4PlaneCrystalElement()
-        optical_element =             S4PlaneCrystal(
-                name="Plane crystal",
-                boundary_shape=None,
-                material="Si",
-                diffraction_geometry=DiffractionGeometry.BRAGG,  # ?? not supposed to be in syned...
-                miller_index_h=1,
-                miller_index_k=1,
-                miller_index_l=1,
-                asymmetry_angle=numpy.radians(10.0),
-                thickness=0.010,  # this is thick crystal approximation
-                f_central=True,
-                f_phot_cent=0,
-                phot_cent=8000.0,
-                file_refl="",
-                f_bragg_a=False,
-                # a_bragg=0.0,
-                f_johansson=False,
-                r_johansson=1.0,
-                f_mosaic=False,
-                spread_mos=0.4 * numpy.pi / 180,
-                f_ext=0, )
-
-        crystal1.set_optical_element(optical_element)
-        crystal1.set_coordinates(
-            ElementCoordinates(p=0.0, q=5000.0e-3,
-                                           angle_radial=0.0, angle_azimuthal=0.0, angle_radial_out=0.0))
-        crystal1.set_input_beam(beam)
-
-
-    # print(crystal1.info())
-    # print(crystal1.get_optical_element().get_surface_shape().get_conic_coefficients())
-    #
-    # trace
-    #
-
-    beam2, mirr2 = crystal1.trace_beam()
-
-    if do_plot:
-        plotxy(beam2, 6, 23, nbins=100, title="INTENSITY VS Z'")
-
-    #
-    # #
-    # if do_plot:
-    #     plotxy(beam2, 1, 3, nbins=100, title="FOCAL PLANE")
-    #     plotxy(mirr2, 1, 3, nbins=100, title="LENS HEIGHT")
-    #     # plotxy(mirr2, 4, 5, nbins=100, title="FOOT DIV")
-    #
-    # FX, FZ = (1e6*beam2.get_standard_deviation(1),1e6*beam2.get_standard_deviation(3))
-    # print("Source dimensions: %f %f um"%(SX,SZ))
-    # print("Focal dimensions: %f %f um"%(FX,FZ))
-    # print("Demagnification: %g %g"%(SX/FX,SX/FZ))
-
-
-
-
-if __name__ == "__main__":
-    from srxraylib.plot.gol import set_qt
-    set_qt()
-
-    crystal_diffraction_with_collimated_beam(do_plot=True)
-
-