Skip to content

plot_emittance

Classes¤

PlotEmittance ¤

PlotEmittance(
    run_number,
    working_dir="",
    distribution_file="generator.in",
    run_file="photo_track.in",
    log_dir="log",
    log_file_name="plots_log.log",
    console_log=True,
    plots_dir="plots",
)

Bases: PlotPhaseSpace

Source code in plot_analysis/plot_emittance.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def __init__(self, run_number:int, working_dir="", distribution_file="generator.in", run_file="photo_track.in", log_dir="log", log_file_name="plots_log.log", console_log=True, plots_dir="plots") -> None:
    super().__init__(run_number, "end", working_dir, distribution_file, run_file, log_dir, log_file_name, console_log, plots_dir)

    # create directory for emittance plots
    self.plots_dir = self.plots_dir.parents[0].joinpath(f"RUN_{run_number}_emittance")
    self.plots_dir.mkdir(exist_ok=True, parents=True)
    self.logger.info(f"Plot will be saved to: \n{self.plots_dir}")

    # get list of z points, where bunch properties are logged
    self.zpos_list = [int(f.name.split(".")[1]) for f in self.working_dir.iterdir() if f.is_file(
    ) and re.match(fr".*{self.run_file.stem}\.[0-9][0-9][0-9][0-9]\.{str(self.run_number).zfill(3)}", str(f))]

    # collect data at all z position
    self.data = self.collect_zpos_data()

Functions¤

collect_zpos_data ¤
collect_zpos_data()

Collects data from all z positions in self.zpos_list and returns a combined dataframe.

Returns:

Type Description
DataFrame

pd.DataFrame: dataframe containing the data from all z positions
Source code in plot_analysis/plot_emittance.py 
27
28
29
30
31
32
33
34
35
36
def collect_zpos_data(self) -> pd.DataFrame:
    """Collects data from all z positions in self.zpos_list and returns a combined dataframe.

    Returns:
        pd.DataFrame: dataframe containing the data from all z positions
    """
    data = pd.DataFrame([])    
    for zpos in self.zpos_list:
        data = pd.concat([data, self.prepare_data(self.run_number, zpos)], ignore_index=True)
    return data
plot ¤
plot()

Plots the emittance for every z position in the directory and plots the development of rms emittance along the trajectory (z).

Source code in plot_analysis/plot_emittance.py 
76
77
78
79
80
def plot(self):
    """Plots the emittance for every z position in the directory and plots the development of rms emittance along the trajectory (z).
    """
    self.plot_emittance()
    self.plot_emittance_development()
plot_emittance ¤
plot_emittance()

Iterates over all z positions in the directory and plots the emittance for each of them.

Source code in plot_analysis/plot_emittance.py 
51
52
53
54
55
56
57
def plot_emittance(self) -> None:
    """Iterates over all z positions in the directory and plots the emittance for each of them.
    """
    for zpos in self.zpos_list:
        self.logger.info(f"Plotting emittance at zpos={zpos}")
        self.plot_emittance_at_zpos(zpos)
    self.logger.info("Emittence plots done.")
plot_emittance_at_zpos ¤
plot_emittance_at_zpos(zpos)

Plots the emittance at given z position

Parameters:

Name Type Description Default
zpos int

z position to be plotted

 required
Source code in plot_analysis/plot_emittance.py 
38
39
40
41
42
43
44
45
46
47
48
49
def plot_emittance_at_zpos(self, zpos:int) -> None:
    """Plots the emittance at given z position

    Args:
        zpos (int): z position to be plotted
    """
    # get the figure from parent class
    fig = self._relative_momentum_plot("x", zpos)
    # save with settings of this class
    fig_name = self.plots_dir.joinpath(f"emittance_zpos_{zpos}.png")
    fig.savefig(fig_name, dpi=300, bbox_inches="tight")
    plt.close()
plot_emittance_development ¤
plot_emittance_development()

Plots the development of the rms emittance along the trajectory (z).

Source code in plot_analysis/plot_emittance.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def plot_emittance_development(self):
    """Plots the development of the rms emittance along the trajectory (z).
    """
    # get the data
    df = self.get_Xemit(self.run_number)

    fig, ax = plt.subplots(figsize=(6,5))

    plt.plot(df["z"], df["epsilon"])

    plt.xlabel(f"$z$ [m]")
    plt.ylabel("Emittance (x rms) [mm mrad]")

    fig_name = self.plots_dir.joinpath(f"emittance_development.png")
    fig.savefig(fig_name, dpi=300, bbox_inches="tight")
    plt.close()
Last update: October 31, 2023
Created: October 31, 2023