Ejemplo n.º 1
0
def propagate_wavefront(wavefront, beamline, output_file=None):
    """
    Propagate wavefront and store it in output file.

    :param wavefront: wpg.Wavefront object or path to HDF5 file
    :param beamline: SRWLOptC container of beamline
    :param output_file: if parameter present - store propagaed wavefront to file
    :return: propagated wavefront object
    """

    if not isinstance(beamline, Beamline):
        bl = Beamline(beamline)
    else:
        bl = beamline
    print(bl)

    if isinstance(wavefront, Wavefront):
        wfr = Wavefront(srwl_wavefront=wavefront._srwl_wf)
    else:
        print('*****reading wavefront from h5 file...')
        wfr = Wavefront()
        wfr.load_hdf5(wavefront)

    print_mesh(wfr)
    print('*****propagating wavefront (with resizing)...')
    bl.propagate(wfr)

    if output_file is not None:
        print('save hdf5:', output_file)
        wfr.store_hdf5(output_file)
    print('done')
    return wfr
Ejemplo n.º 2
0
def propagate_wavefront(wavefront, beamline, output_file=None):
    """
    Propagate wavefront and store it in output file.

    :param wavefront: Wavefront object or path to HDF5 file
    :param beamline: SRWLOptC container of beamline
    :param output_file: if parameter present - store propagaed wavefront to file
    :return: propagated wavefront object:
    """

    if not isinstance(beamline, Beamline):
        bl = Beamline(beamline)
    else:
        bl = beamline
    print(bl)

    if isinstance(wavefront, Wavefront):
        wfr = Wavefront(srwl_wavefront=wavefront._srwl_wf)
    else:
        print("*****reading wavefront from h5 file...")
        wfr = Wavefront()
        wfr.load_hdf5(wavefront)

    print_mesh(wfr)
    print("*****propagating wavefront (with resizing)...")
    bl.propagate(wfr)

    if output_file is not None:
        print("save hdf5:", output_file)
        wfr.store_hdf5(output_file)
    print("done")
    return wfr
Ejemplo n.º 3
0
def main():
    d2waist = 270.
    # beam parameters:
    qnC = 0.1  # [nC] e-bunch charge
    thetaOM = 3.6e-3
    ekev = 5.0

    # calculate angular divergence:
    theta_fwhm = (17.2 - 6.4 * np.sqrt(qnC)) * 1e-6 / ekev ** 0.85
    theta_rms = theta_fwhm / 2.35
    sigX = 12.4e-10 / (ekev * 4 * np.pi * theta_rms)

    # define limits
    xmax = theta_rms * d2waist * 3.5
    xmin = - xmax
    ymin = xmin
    ymax = xmax
    nx = 600
    ny = nx
    nz = 5
    tau = 0.12e-15

    srw_wf = build_gauss_wavefront(
        nx, ny, nz, ekev, xmin, xmax, ymin, ymax, tau, sigX, sigX, d2waist)
    wf = wpg.Wavefront(srw_wf)  
    b = Beamline()
    b.append(Drift(5), Use_PP())
    b.propagate(wf)
    # srwl.ResizeElecField(srw_wf, 'c', [0, 0.25, 1, 0.25, 1])

    if not os.path.exists('tests_data'):
        os.mkdir('tests_data')

    wf_hdf5_out_file_path = os.path.join('tests_data', 'my_gauss.h5')
    wf.store_hdf5(wf_hdf5_out_file_path)

    wf_out = wpg.Wavefront()
    wf_out.load_hdf5(wf_hdf5_out_file_path)
    return wf
Ejemplo n.º 4
0
    def do_wpg_calculation(self):
        rMinCRL = 2 * self.delta * self.input_data.get_distance_to_previous(
        ) / self.nCRL  #CRL radius at the tip of parabola [m]

        opCRL = create_CRL_from_file(self.working_directory, self.file_name, 3,
                                     self.delta, self.attenLen, 1,
                                     self.diamCRL, self.diamCRL, rMinCRL,
                                     self.nCRL, self.wallThickCRL, 0, 0, None)

        wavefront = self.input_data.get_wavefront()

        beamline_for_propagation = Beamline()
        beamline_for_propagation.append(opCRL, Use_PP())
        beamline_for_propagation.append(Drift(self.distance),
                                        Use_PP(semi_analytical_treatment=1))

        beamline_for_propagation.propagate(wavefront)

        return wavefront
Ejemplo n.º 5
0
    def do_wpg_calculation(self):
        aperture = Aperture(shape='r',
                            ap_or_ob='a',
                            Dx=self.horApM1,
                            Dy=self.range_xy)

        wavefront = self.input_data.get_wavefront()

        beamline_for_propagation = Beamline()
        beamline_for_propagation.append(aperture, Use_PP())
        beamline_for_propagation.propagate(wavefront)

        return wavefront
Ejemplo n.º 6
0
def main():
    d2waist = 270.
    # beam parameters:
    qnC = 0.1  # [nC] e-bunch charge
    thetaOM = 3.6e-3
    ekev = 5.0

    # calculate angular divergence:
    theta_fwhm = (17.2 - 6.4 * np.sqrt(qnC)) * 1e-6 / ekev**0.85
    theta_rms = theta_fwhm / 2.35
    sigX = 12.4e-10 / (ekev * 4 * np.pi * theta_rms)

    # define limits
    xmax = theta_rms * d2waist * 3.5
    xmin = -xmax
    ymin = xmin
    ymax = xmax
    nx = 600
    ny = nx
    nz = 5
    tau = 0.12e-15

    srw_wf = build_gauss_wavefront(nx, ny, nz, ekev, xmin, xmax, ymin, ymax,
                                   tau, sigX, sigX, d2waist)
    wf = wpg.Wavefront(srw_wf)
    b = Beamline()
    b.append(Drift(5), Use_PP())
    b.propagate(wf)
    # srwl.ResizeElecField(srw_wf, 'c', [0, 0.25, 1, 0.25, 1])

    if not os.path.exists('tests_data'):
        os.mkdir('tests_data')

    wf_hdf5_out_file_path = os.path.join('tests_data', 'my_gauss.h5')
    wf.store_hdf5(wf_hdf5_out_file_path)

    wf_out = wpg.Wavefront()
    wf_out.load_hdf5(wf_hdf5_out_file_path)
    return wf
Ejemplo n.º 7
0
    def scale(self, wfr, iscx=1024, iscy=1024, ifov=800e-06):
        """
        DEPR.
        narrow functionality for scaling a wavefront (ie the number of pixels)
        in the source plane
        
        :param wfr: wpg wfr strucutre
        :param isc: ideal scale
        :param ifov: ideal field of view
        
        :returns wfr: scaled wpg wfr structure
        """

        nx, ny = wfr.params.Mesh.nx, wfr.params.Mesh.ny
        dx, dy = wfr.params.Mesh.xMax - wfr.params.Mesh.xMin, wfr.params.Mesh.yMax - wfr.params.Mesh.yMin

        scbl = Beamline()
        scbl.append(
            Aperture('r', 'a', 800e-06, 800e-06),
            propagation_parameters(dx / ifov, iscx / nx, dy / ifov, iscy / ny))
        scbl.propagate(wfr)

        return wfr
Ejemplo n.º 8
0
ekev = 25
wav = ekev2wav(25)
k = np.pi * 2 / wav
delta = 4e-07
d2waist = (wav) / (np.arctan(.27 / 8) * np.pi)

r = 75e-03

wfr = Wavefront(
    construct_gaussian(1024, 1024, 25, -15e-02, 15e-02, -15e-02, 15e-02, 3e-2,
                       3e-02, d2waist))

### PLOT 1
plot_intensity_map(wfr)

bl = Beamline()

bl.append(Drift(1), propagation_parameters(1, 1, 1, 1))
bl.propagate(wfr)

x = np.linspace(wfr.params.Mesh.xMin, wfr.params.Mesh.xMax, wfr.params.Mesh.nx)
y = np.ones([wfr.params.Mesh.nx, wfr.params.Mesh.ny])

thickness = norm(cylinder_thickness(x, r, offset=0), lim=(0, 255))

sdir = "../../data/samples/cylinder_thickness.png"

im = Image.fromarray(thickness * y)
im = im.convert("L")
im.save(sdir)
Ejemplo n.º 9
0
    def build_beamline(self, focus="nano", screens="false"):
        """
        Construct the beamline object
        
        :param focus: what beamline configuration (micron or nano)
        """

        self.bl = Beamline()

        if focus == "micron":

            self.bl.append(
                self.d1, propagation_parameters(1, 1, 1, 1, mode="fraunhofer"))

            self.bl.append(self.HOM1,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d2, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.HOM2,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d3, propagation_parameters(1, 1, 1, 1, mode='fraunhofer'))

            self.bl.append(
                self.MKB_pslit,
                propagation_parameters(1 / 5, 1, 1 / 5, 1, mode='fresnel'))
            self.bl.append(
                self.d4, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.MHP,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d5, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.MHE,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(self.MHE_error,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d6, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.MVE,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(self.MVE_error,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d8, propagation_parameters(1, 1, 1, 1, mode='quadratic'))

            self.bl.append(self.MVP,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(self.df,
                           propagation_parameters(5, 1, 5, 1, mode='converge'))

        elif focus == "nano":

            self.bl.append(
                self.d1, propagation_parameters(1, 1, 1, 1, mode="fraunhofer"))

            self.bl.append(self.HOM1,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d2, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.HOM2,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d3, propagation_parameters(1, 1, 1, 1, mode='fraunhofer'))

            self.bl.append(
                self.NKB_pslit,
                propagation_parameters(1 / 10, 1, 1 / 10, 1, mode='fresnel'))
            self.bl.append(
                self.d4, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.NHE_error,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(self.NHE,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))

            self.bl.append(
                self.d5, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.NVE_error,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(self.NVE,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))

            self.bl.append(self.df,
                           propagation_parameters(1, 1, 1, 1, mode='converge'))

        self.bl.params = self.params
Ejemplo n.º 10
0
class BeamlineModel:
    """
    A container for loading and modifying beamline data
    """
    def __init__(self, VERBOSE=True):

        self.VERBOSE = VERBOSE

        if VERBOSE:
            print("Initialising Single Particle Beamline")

        self.load_params()
        self.fpath = felpy_path()  ### felpy path (for dev. purposes)

        add_path()

    def load_params(self, fromFile=False):
        """
        load beamline parameters from /data/spb/
        """

        if fromFile:
            with open("../../data/params/exfel_spb.json", "r") as read_file:
                self.params = json.load(read_file)
        else:
            self.params = get_params()

    def export_params(self, sdir=None):
        """
        save the current set of beamline parameters in json format
        
        :param sdir: save directory
        """
        if sdir is None:
            with open('../../data/spb/parameters.json', 'w') as f:
                json.dump(self.params, f)
        else:
            with open(sdir + 'parameters.json', 'w') as f:
                json.dump(self.params, f)

    def adjust_mirror(self, mirror_name, ekev, new_ang, mirror_refl=None):

        if mirror_refl == None:
            if ekev <= 7.5:
                material = "B4C"
            else:
                material = "Ru"

            refl = get_refl(load_refl(material), ekev, new_ang)

        else:
            refl = mirror_refl

        new_ang = new_ang + np.tan(
            self.params[mirror_name]["xc"] /
            self.params[self.params[mirror_name]['next_drift']]['distance'])
        self.params[mirror_name]["incidence angle"] = new_ang
        self.params[mirror_name]['reflectivity'] = refl

    def define_mirror_profiles(self,
                               overwrite=False,
                               surface='flat',
                               plot=False,
                               aperture=True):
        """
        Define the plane mirror profiles by loading from /data/. 
        If mirror profiles not defined (unlikely), generate profiles via genMirrorSurface
        
        :param overwrite: bool to overwrite current file.
        :param surface: surface type (flat, random or real)
        """

        if surface == 'real':

            mm = 'random'  ### fix for no 'real' surface MHE, MVE, MVP surfaces etc.

            if overwrite == True:

                if aperture == True:
                    genMirrorSurface(
                        500,
                        500,
                        [self.params["MHP"]['dx'], self.params["MHP"]['dy']],
                        "../../data/spb/mirror_surface/mhp_",
                        mode=mm,
                        plot=plot,
                        mirrorName="MHP")
                    genMirrorSurface(
                        500,
                        500,
                        [self.params["MVP"]['dx'], self.params["MVP"]['dy']],
                        "../../data/spb/mirror_surface/mvp_",
                        mode=mm,
                        plot=plot,
                        mirrorName="MVP")
                    genMirrorSurface(
                        500,
                        500,
                        [self.params["MHE"]['dx'], self.params["MHE"]['dy']],
                        "../../data/spb/mirror_surface/mhe_",
                        mode=mm,
                        plot=plot,
                        mirrorName="MHE")
                    genMirrorSurface(
                        500,
                        500,
                        [self.params["MVE"]['dx'], self.params["MVE"]['dy']],
                        "../../data/spb/mirror_surface/mve_",
                        mode=mm,
                        plot=plot,
                        mirrorName="MVE")
                    genMirrorSurface(
                        500,
                        500,
                        [self.params["NHE"]['dx'], self.params["NHE"]['dy']],
                        "../../data/spb/mirror_surface/nhe_",
                        mode=surface,
                        plot=plot,
                        mirrorName="NHE")
                    genMirrorSurface(
                        500,
                        500,
                        [self.params["NVE"]['dx'], self.params["NVE"]['dy']],
                        "../../data/spb/mirror_surface/nve_",
                        mode=surface,
                        plot=plot,
                        mirrorName="NVE")

                elif aperture == False:
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "data/spb/mirror_surface/hom1_",
                                     mode=mm,
                                     plot=plot,
                                     mirrorName="HOM1")
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "data/spb/mirror_surface/hom2_",
                                     mode=mm,
                                     plot=plot,
                                     mirrorName="HOM2")
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "data/spb/mirror_surface/mhp_",
                                     mode=mm,
                                     plot=plot,
                                     mirrorName="MHP")
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "data/spb/mirror_surface/mvp_",
                                     mode=mm,
                                     plot=plot,
                                     mirrorName="MVP")
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "data/spb/mirror_surface/mhe_",
                                     mode=mm,
                                     plot=plot,
                                     mirrorName="MHE")
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "../../data/spb/mirror_surface/mve_",
                                     mode=mm,
                                     plot=plot,
                                     mirrorName="MVE")
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "../../data/spb/mirror_surface/nhe_",
                                     mode=mm,
                                     plot=plot,
                                     mirrorName="NHE")
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "../../data/spb/mirror_surface/nve_",
                                     mode=mm,
                                     plot=plot,
                                     mirrorName="NVE")

        elif surface == 'flat':

            mm = 'flat'

            if overwrite == True:

                if aperture == True:
                    genMirrorSurface(
                        500,
                        500,
                        [self.params["MHP"]['dx'], self.params["MHP"]['dy']],
                        "../../data/spb/mirror_surface/mhp_",
                        mode=surface,
                        plot=plot,
                        mirrorName="MHP")
                    genMirrorSurface(
                        500,
                        500,
                        [self.params["MVP"]['dx'], self.params["MVP"]['dy']],
                        "../../data/spb/mirror_surface/mvp_",
                        mode=surface,
                        plot=plot,
                        mirrorName="MVP")
                    genMirrorSurface(
                        500,
                        500,
                        [self.params["MHE"]['dx'], self.params["MHE"]['dy']],
                        "../../data/spb/mirror_surface/mhe_",
                        mode=surface,
                        plot=plot,
                        mirrorName="MHE")
                    genMirrorSurface(
                        500,
                        500,
                        [self.params["MVE"]['dx'], self.params["MVE"]['dy']],
                        "../../data/spb/mirror_surface/mve_",
                        mode=surface,
                        plot=plot,
                        mirrorName="MVE")
                    genMirrorSurface(
                        500,
                        500,
                        [self.params["NHE"]['dx'], self.params["NHE"]['dy']],
                        "../../data/spb/mirror_surface/nhe_",
                        mode=surface,
                        plot=plot,
                        mirrorName="NHE")
                    genMirrorSurface(
                        500,
                        500,
                        [self.params["NVE"]['dx'], self.params["NVE"]['dy']],
                        "../../data/spb/mirror_surface/nve_",
                        mode=surface,
                        plot=plot,
                        mirrorName="NVE")

                if aperture == False:
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "../../data/spb/mirror_surface/hom1_",
                                     mode=surface,
                                     plot=plot,
                                     mirrorName="HOM1")
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "../../data/spb/mirror_surface/hom2_",
                                     mode=surface,
                                     plot=plot,
                                     mirrorName="HOM2")
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "../../data/spb/mirror_surface/mhp_",
                                     mode=surface,
                                     plot=plot,
                                     mirrorName="MHP")
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "../../data/spb/mirror_surface/mvp_",
                                     mode=surface,
                                     plot=plot,
                                     mirrorName="MVP")
                    genMirrorSurface(500,
                                     500, [1000, 1000],
                                     "../../data/spb/mirror_surface/mhe_",
                                     mode=surface,
                                     plot=plot,
                                     mirrorName="MHE")
                    genMirrorSurface(500,
                                     500, [1000, 1000],
                                     "../../data/spb/mirror_surface/mve_",
                                     mode=surface,
                                     plot=plot,
                                     mirrorName="MVE")
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "../../data/spb/mirror_surface/nhe_",
                                     mode=surface,
                                     plot=plot,
                                     mirrorName="NHE")
                    genMirrorSurface(500,
                                     500, [100, 100],
                                     "../../data/spb/mirror_surface/nve_",
                                     mode=surface,
                                     plot=plot,
                                     mirrorName="NVE")

        if aperture == True:
            self.params['HOM1'][
                'mirror profile'] = "../../data/spb/mirror_surface/hom1_mir_{}.dat".format(
                    surface)
            self.params['HOM2'][
                'mirror profile'] = "../../data/spb/mirror_surface/hom2_mir_{}.dat".format(
                    surface)
        else:
            self.params['HOM1'][
                'mirror profile'] = "../../data/spb/mirror_surface/hom1_mir_{}.dat".format(
                    mm)
            self.params['HOM2'][
                'mirror profile'] = "../../data/spb/mirror_surface/hom2_mir_{}.dat".format(
                    mm)
            self.params['MHE']["length"] = 10
            self.params['MVE']["length"] = 10

        self.params['MHP'][
            'mirror profile'] = "../../data/spb/mirror_surface/mhp_mir_{}.dat".format(
                mm)
        self.params['MVP'][
            'mirror profile'] = "../../data/spb/mirror_surface/mvp_mir_{}.dat".format(
                mm)
        self.params['MHE_error'][
            'mirror profile'] = "../../data/spb/mirror_surface/mhe_mir_{}.dat".format(
                mm)
        self.params['MVE_error'][
            'mirror profile'] = "../../data/spb/mirror_surface/mve_mir_{}.dat".format(
                mm)
        self.params['NHE_error'][
            'mirror profile'] = "../../data/spb/mirror_surface/nhe_mir_{}.dat".format(
                mm)
        self.params['NVE_error'][
            'mirror profile'] = "../../data/spb/mirror_surface/nve_mir_{}.dat".format(
                mm)

    def build_elements(self, focus="nano"):

        self.d1 = Drift(self.params["HOM1"]['distance from source'])
        self.d1.name = self.params["d1"]['name']

        self.HOM1 = MirPl(np.loadtxt(
            self.fpath +
            self.params['HOM1']['mirror profile'].replace("../../", "")),
                          _dim=self.params['HOM1']['orientation'],
                          _ang=self.params['HOM1']['incidence angle'],
                          _amp_coef=1,
                          _x=self.params['HOM1']['xc'],
                          _y=self.params['HOM1']['yc'],
                          _refl=self.params['HOM1']['transmission'])

        self.HOM1.name = self.params['HOM1']['name']

        self.d2 = Drift(self.params["HOM2"]['distance from source'] -
                        self.params["HOM1"]['distance from source'])
        self.d2.name = self.params["d2"]['name']

        self.HOM2 = MirPl(np.loadtxt(
            self.fpath +
            self.params['HOM2']['mirror profile'].replace("../../", "")),
                          _dim=self.params['HOM2']['orientation'],
                          _ang=self.params['HOM2']['incidence angle'],
                          _amp_coef=1,
                          _x=self.params['HOM2']['xc'],
                          _y=self.params['HOM2']['yc'],
                          _refl=self.params['HOM2']['transmission'])

        self.HOM2.name = self.params['HOM2']['name']

        if focus == "micron":
            self.d3 = Drift(self.params["d3"]['distance'])
            self.d3.name = self.params["d3"]['name']

            self.MKB_pslit = Aperture(
                _shape=self.params["MKB_pslit"]['shape'],
                _ap_or_ob=self.params["MKB_pslit"]['type'],
                _Dx=self.params["MKB_pslit"]['dx'],
                _Dy=self.params["MKB_pslit"]['dy'],
                _x=self.params["MKB_pslit"]['xc'],
                _y=self.params["MKB_pslit"]['yc'])
            self.MKB_pslit.name = self.params["MKB_pslit"]['name']

            self.d4 = Drift(self.params["d4"]['distance'])
            self.d4.name = self.params["d4"]['name']

            self.MHP = MirPl(np.loadtxt(self.fpath +
                                        self.params['MHP']['mirror profile']),
                             _dim=self.params['MHP']['orientation'],
                             _ang=self.params['MHP']['incidence angle'],
                             _refl=self.params['MHP']['transmission'],
                             _x=self.params['MHP']['xc'],
                             _y=self.params['MHP']['yc'])
            self.MHP.name = self.params['MHP']['name']

            self.d5 = Drift(self.params["d5"]['distance'])
            self.d5.name = self.params["d5"]['name']

            self.MHE_error = MirPl(
                np.loadtxt(self.fpath +
                           self.params['MHE_error']['mirror profile']),
                _dim=self.params['MHE_error']['orientation'],
                _ang=self.params['MHE_error']['incidence angle'],
                _refl=self.params['MHE_error']['transmission'],
                _x=self.params['MHE_error']['xc'],
                _y=self.params['MHE_error']['yc'])

            self.MHE_error.name = self.params['MHE_error']['name']

            self.MVE_error = MirPl(
                np.loadtxt(self.fpath +
                           self.params['MVE_error']['mirror profile']),
                _dim=self.params['MVE_error']['orientation'],
                _ang=self.params['MVE_error']['incidence angle'],
                _refl=self.params['MVE_error']['transmission'],
                _x=self.params['MVE_error']['xc'],
                _y=self.params['MVE_error']['yc'])

            self.MVE_error.name = self.params['MVE_error']['name']

            self.MHE = MirEl(orient=self.params['MHE']["orientation"],
                             p=self.params['MHE']["distance from source"],
                             q=self.params['MHE']["distance to focus"],
                             thetaE=self.params['MHE']["design angle"],
                             theta0=self.params['MHE']["incidence angle"],
                             _x=self.params["MHE"]["xc"],
                             _y=self.params["MHE"]["yc"],
                             length=self.params['MHE']["length"],
                             roll=self.params['MHE']["roll"],
                             yaw=self.params['MHE']["yaw"],
                             _refl=self.params['MHE']["reflectivity"],
                             _ext_in=self.params['MHE']["_ext_in"],
                             _ext_out=self.params['MHE']["_ext_out"])

            self.MHE.name = self.params['MHE']['name']

            self.d6 = Drift(self.params["d7"]['distance'])
            self.d6.name = self.params["d7"]['name']

            self.MVE = MirEl(orient=self.params['MVE']["orientation"],
                             p=self.params['MVE']["distance from source"],
                             q=self.params['MVE']["distance to focus"],
                             thetaE=self.params['MVE']["design angle"],
                             theta0=self.params['MVE']["incidence angle"],
                             _x=self.params["MVE"]["xc"],
                             _y=self.params["MVE"]["yc"],
                             length=self.params['MVE']["length"],
                             roll=self.params['MVE']["roll"],
                             yaw=self.params['MVE']["yaw"],
                             _refl=self.params['MVE']["reflectivity"],
                             _ext_in=self.params['MVE']["_ext_in"],
                             _ext_out=self.params['MVE']["_ext_out"])

            self.MVE.name = self.params['MVE']['name']

            self.d8 = Drift(self.params["d8"]['distance'])
            self.d8.name = self.params["d8"]['name']

            self.MVP = MirPl(np.loadtxt(self.fpath +
                                        self.params['MVP']['mirror profile']),
                             _dim=self.params['MVP']['orientation'],
                             _ang=self.params['MVP']['incidence angle'],
                             _refl=self.params['MVP']['transmission'],
                             _x=self.params['MVP']['xc'],
                             _y=self.params['MVP']['yc'])
            self.MVP.name = self.params['MVP']['name']

            self.df = Drift(self.params["df"]['distance'])
            self.df.name = self.params["df"]['name']

        elif focus == "nano":

            self.NKB_pslit = Aperture(
                _shape=self.params["NKB_pslit"]['shape'],
                _ap_or_ob=self.params["NKB_pslit"]['type'],
                _Dx=self.params["NKB_pslit"]['dx'],
                _Dy=self.params["NKB_pslit"]['dy'],
                _x=self.params["NKB_pslit"]['xc'],
                _y=self.params["NKB_pslit"]['yc'])
            self.NKB_pslit.name = self.params["NKB_pslit"]['name']

            self.NHE = MirEl(orient=self.params['NHE']["orientation"],
                             p=self.params['NHE']["distance from source"],
                             q=self.params['NHE']["distance to focus"],
                             thetaE=self.params['NHE']["design angle"],
                             theta0=self.params['NHE']["incidence angle"],
                             _x=self.params["NHE"]["xc"],
                             _y=self.params["NHE"]["yc"],
                             length=self.params['NHE']["length"],
                             roll=self.params['NHE']["roll"],
                             yaw=self.params['NHE']["yaw"],
                             _refl=self.params['NHE']["reflectivity"],
                             _ext_in=self.params['NHE']["_ext_in"],
                             _ext_out=self.params['NHE']["_ext_out"])

            self.NHE.name = self.params["NHE"]["name"]

            self.NVE = MirEl(orient=self.params['NVE']["orientation"],
                             p=self.params['NVE']["distance from source"],
                             q=self.params['NVE']["distance to focus"],
                             thetaE=self.params['NVE']["design angle"],
                             theta0=self.params['NVE']["incidence angle"],
                             _x=self.params["NVE"]["xc"],
                             _y=self.params["NVE"]["yc"],
                             length=self.params['NVE']["length"],
                             roll=self.params['NVE']["roll"],
                             yaw=self.params['NVE']["yaw"],
                             _refl=self.params['NVE']["reflectivity"],
                             _ext_in=self.params['NVE']["_ext_in"],
                             _ext_out=self.params['NVE']["_ext_out"])

            self.NVE.name = self.params["NVE"]["name"]

            self.NVE_error = MirPl(
                np.loadtxt(self.fpath + self.params['NVE_error']
                           ['mirror profile'].replace("../../", "")),
                _dim=self.params['NVE_error']['orientation'],
                _ang=self.params['NVE_error']['incidence angle'] +
                self.params['NVE']['incidence angle'],
                _refl=self.params['NVE_error']['transmission'],
                _x=self.params['NVE_error']['xc'],
                _y=self.params['NVE_error']['yc'])

            self.NVE_error.name = self.params['NVE_error']['name']

            self.NHE_error = MirPl(
                np.loadtxt(self.fpath + self.params['NHE_error']
                           ['mirror profile'].replace("../../", "")),
                _dim=self.params['NHE_error']['orientation'],
                _ang=self.params['NHE_error']['incidence angle'] +
                self.params['NHE']['incidence angle'],
                _refl=self.params['NHE_error']['transmission'],
                _x=self.params['NHE_error']['xc'],
                _y=self.params['NHE_error']['yc'])

            self.NHE_error.name = self.params['NHE_error']['name']

            self.params["d3"]["distance"] = 656.424
            self.params["d4"]["distance"] = 1.20
            self.params["d5"]["distance"] = 1.00
            self.params["df"]["distance"] = 2.2

            self.d3 = Drift(self.params["d3"]['distance'])
            self.d3.name = self.params["d3"]['name']

            self.d4 = Drift(self.params["d4"]['distance'])
            self.d4.name = self.params["d4"]['name']

            self.d5 = Drift(self.params["d5"]['distance'])
            self.d5.name = self.params["d5"]['name']

            self.df = Drift(self.params["df"]['distance'])
            self.df.name = self.params["df"]['name']

    def build_beamline(self, focus="nano", screens="false"):
        """
        Construct the beamline object
        
        :param focus: what beamline configuration (micron or nano)
        """

        self.bl = Beamline()

        if focus == "micron":

            self.bl.append(
                self.d1, propagation_parameters(1, 1, 1, 1, mode="fraunhofer"))

            self.bl.append(self.HOM1,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d2, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.HOM2,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d3, propagation_parameters(1, 1, 1, 1, mode='fraunhofer'))

            self.bl.append(
                self.MKB_pslit,
                propagation_parameters(1 / 5, 1, 1 / 5, 1, mode='fresnel'))
            self.bl.append(
                self.d4, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.MHP,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d5, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.MHE,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(self.MHE_error,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d6, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.MVE,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(self.MVE_error,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d8, propagation_parameters(1, 1, 1, 1, mode='quadratic'))

            self.bl.append(self.MVP,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(self.df,
                           propagation_parameters(5, 1, 5, 1, mode='converge'))

        elif focus == "nano":

            self.bl.append(
                self.d1, propagation_parameters(1, 1, 1, 1, mode="fraunhofer"))

            self.bl.append(self.HOM1,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d2, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.HOM2,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(
                self.d3, propagation_parameters(1, 1, 1, 1, mode='fraunhofer'))

            self.bl.append(
                self.NKB_pslit,
                propagation_parameters(1 / 10, 1, 1 / 10, 1, mode='fresnel'))
            self.bl.append(
                self.d4, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.NHE_error,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(self.NHE,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))

            self.bl.append(
                self.d5, propagation_parameters(1, 1, 1, 1, mode='quadratic'))
            self.bl.append(self.NVE_error,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))
            self.bl.append(self.NVE,
                           propagation_parameters(1, 1, 1, 1, mode='fresnel'))

            self.bl.append(self.df,
                           propagation_parameters(1, 1, 1, 1, mode='converge'))

        self.bl.params = self.params

    def get_beamline(self):
        return self.bl

    def cropBeamline(self, element1=None, element2=None):
        """
        crop the beamline to some position as defined by the name of the optical element
        
        :param bl: beamline object
        :param position: position to be cropped to
        """

        if element1 is not None:
            names = [
                el.name
                for el in self.bl.propagation_options[0]['optical_elements']
            ]
            idx1 = names.index(element1)

        if element2 is not None:
            names = [
                el.name
                for el in self.bl.propagation_options[0]['optical_elements']
            ]
            idx2 = names.index(element2)

        if element1 not in names:
            pass
        elif element2 is not None:
            self.bl.propagation_options[0][
                'optical_elements'] = self.bl.propagation_options[0][
                    'optical_elements'][idx1:idx2 + 1]
            self.bl.propagation_options[0][
                'propagation_parameters'] = self.bl.propagation_options[0][
                    'propagation_parameters'][idx1:idx2 + 1]
        else:
            self.bl.propagation_options[0][
                'optical_elements'] = self.bl.propagation_options[0][
                    'optical_elements'][:idx1 + 1]
            self.bl.propagation_options[0][
                'propagation_parameters'] = self.bl.propagation_options[0][
                    'propagation_parameters'][:idx1 + 1]

    def addScreen(self, position, distance, screenName=None):
        """
        add a screening plane at drift beyond some element posiFalsetion
        
        :param position: last optical element before screen
        :param distance: position from last optical element to screen
        :param screenName: name of the screen element (ie., MKB-scr etc) [str]
        """
        self.cropBeamline(element1=position)

        drift2screen = Drift(distance)
        if screenName is not None:
            drift2screen.name = "screen"
        else:
            drift2screen.name = screenName
        self.bl.append(Drift(distance),
                       propagation_parameters(1, 1, 1, 1, m='quadratic'))

    def mirror_profiles(self, toggle="on", aperture=True, overwrite=False):
        """
        toggle for mirror surfaces
        """
        if toggle == "on":
            self.define_mirror_profiles(overwrite=overwrite,
                                        aperture=aperture,
                                        surface='real')
        if toggle == "off":
            self.define_mirror_profiles(overwrite=overwrite,
                                        aperture=aperture,
                                        surface='flat')

    def plot_mirror_profiles(self, mirror_name, sdir=None):

        sns.set()

        surface = np.loadtxt(self.params[mirror_name]['mirror profile'])

        x = surface[1:, 0]
        y = surface[0, 1:]

        surface = surface[1:, 1:]

        extent = [
            x.min() * 1e03,
            x.max() * 1e03,
            y.min() * 1e03,
            y.max() * 1e03
        ]

        fig = plt.figure()
        ax = fig.add_subplot(111)

        ax.set_title(mirror_name + " Surface")

        img = ax.imshow(surface * 1e9, extent=extent, aspect='auto')

        ax.set_xlabel("x (mm)")
        ax.set_ylabel("y (mm)")
        ax.grid(False)
        cb = plt.colorbar(img, ax=ax)
        cb.ax.get_yaxis().labelpad = 15
        cb.ax.set_ylabel("Height Error (nm)", rotation=270)

        if sdir is not None:
            fig.savefig(sdir + mirror_name + "_surface.eps")
        else:
            plt.show()

    def scale(self, wfr, iscx=1024, iscy=1024, ifov=800e-06):
        """
        DEPR.
        narrow functionality for scaling a wavefront (ie the number of pixels)
        in the source plane
        
        :param wfr: wpg wfr strucutre
        :param isc: ideal scale
        :param ifov: ideal field of view
        
        :returns wfr: scaled wpg wfr structure
        """

        nx, ny = wfr.params.Mesh.nx, wfr.params.Mesh.ny
        dx, dy = wfr.params.Mesh.xMax - wfr.params.Mesh.xMin, wfr.params.Mesh.yMax - wfr.params.Mesh.yMin

        scbl = Beamline()
        scbl.append(
            Aperture('r', 'a', 800e-06, 800e-06),
            propagation_parameters(dx / ifov, iscx / nx, dy / ifov, iscy / ny))
        scbl.propagate(wfr)

        return wfr