SuPyMode 2.4.3__cp313-cp313-win_amd64.whl

SuPyMode/representation/adiabatic.py

@@ -0,0 +1,111 @@
+# #!/usr/bin/env python
+# # -*- coding: utf-8 -*-
+import numpy
+import matplotlib.pyplot as plt
+import matplotlib.ticker as ticker
+from MPSPlots.helper import post_mpl_plot
+
+from SuPyMode.supermode import SUPERMODE
+
+
+class Adiabatic:
+    """
+    Represents the adiabatic criterion between modes of different supermodes in optical fiber simulations.
+
+    This class extends from `InheritFromSuperMode` for accessing supermode-related data and provides plotting functionalities
+    tailored to visualize adiabatic transition measurements.
+
+    Attributes
+    ----------
+    supermode : SUPERMODE
+        The parent supermode object that provides the base mode data.
+
+    """
+
+    def __init__(self, supermode: SUPERMODE):
+        """
+        Initialize an Adiabatic object with a reference to a parent supermode.
+
+        Parameters
+        ----------
+        supermode : SUPERMODE
+            The parent supermode object that provides the base mode data.
+        """
+        self.supermode = supermode
+
+    def get_values(self, other_supermode: SUPERMODE) -> numpy.ndarray:
+        """
+        Calculate the adiabatic transition measure between the parent supermode and another specified supermode.
+
+        Parameters
+        ----------
+        other_supermode : SUPERMODE
+            The supermode with which to compare the parent supermode.
+
+        Returns
+        -------
+        numpy.ndarray
+            An array of adiabatic transition measures calculated between the two supermodes, adjusted as needed for
+            computational compatibility.
+        """
+        output = self.supermode.get_adiabatic_with_mode(other_supermode)
+
+        if not self.supermode.is_computation_compatible(other_supermode):
+            output *= numpy.inf
+
+        return abs(output)
+
+    @post_mpl_plot
+    def plot(self, other_supermode: SUPERMODE, ax: plt.Axes = None) -> plt.Figure:
+        """
+        Plot the adiabatic criterion between the parent supermode and another specified supermode.
+        This method generates a plot of the adiabatic criterion as a function of the inverse taper ratio (ITR),
+        formatted according to the predefined plot style.
+
+        Parameters
+        ----------
+        other_supermode : SUPERMODE
+            The supermode to compare against.
+        ax : matplotlib.axes.Axes, optional
+            The axis on which to plot. If `None`, a new axis is created (default is `None`).
+
+        Returns
+        -------
+        matplotlib.figure.Figure
+            The figure object containing the generated plot.
+        """
+        if ax is None:
+            figure, ax = plt.subplots(nrows=1, ncols=1)
+        else:
+            figure = ax.figure
+
+        ax.set(
+            yscale="log",
+            xlabel="Inverse taper ratio",
+            ylabel=r"Adiabatic criterion [$\mu$m$^{-1}$]",
+            ylim=[1e-5 * 1e6, 1 * 1e6],
+        )
+
+        def log_scale_yaxis(value, tick_position):
+            return f"{value / 1e6:.0e}"
+
+        # Apply the custom formatter for log scale
+        ax.yaxis.set_major_formatter(ticker.FuncFormatter(log_scale_yaxis))
+
+        if not self.supermode.is_computation_compatible(other_supermode):
+            return
+
+        y = self.get_values(other_supermode=other_supermode)
+
+        label = f"{self.supermode.stylized_label} - {other_supermode.stylized_label}"
+
+        ax.plot(
+            self.supermode.model_parameters.itr_list, abs(y), label=label, linewidth=2
+        )
+
+        ax.legend()
+
+        return figure
+
+
+# -

SuPyMode/representation/beating_length.py

@@ -0,0 +1,95 @@
+# #!/usr/bin/env python
+# # -*- coding: utf-8 -*-
+
+import numpy
+import matplotlib.pyplot as plt
+from MPSPlots.helper import post_mpl_plot
+
+from SuPyMode.supermode import SUPERMODE
+
+
+class BeatingLength:
+    """
+    Represents the beating lengths between modes of different supermodes in optical fiber simulations.
+
+    This class extends from `InheritFromSuperMode` to utilize supermode-related data and provides plotting functionalities
+    tailored to visualize beating length comparisons.
+
+    Attributes
+    ----------
+    supermode : SUPERMODE
+        The parent supermode object that provides the base mode data.
+    """
+
+    def __init__(self, supermode: SUPERMODE):
+        """
+        Initialize a BeatingLength object with a reference to a parent supermode.
+
+        Parameters
+        ----------
+        supermode : SUPERMODE
+            The parent supermode object that provides the base mode data.
+        """
+        self.supermode = supermode
+
+    def get_values(self, other_supermode: SUPERMODE) -> numpy.ndarray:
+        """
+        Calculate the beating length between the parent supermode and another specified supermode.
+
+        Parameters
+        ----------
+        other_supermode : SUPERMODE
+            The supermode with which to compare the parent supermode.
+
+        Returns
+        -------
+        numpy.ndarray
+            An array of beating lengths calculated between the two supermodes.
+        """
+        return self.supermode.get_beating_length_with_mode(other_supermode)
+
+    @post_mpl_plot
+    def plot(self, other_supermode: SUPERMODE, ax: plt.Axes = None) -> plt.Figure:
+        """
+        Plot the beating length between the parent supermode and another specified supermode.
+
+        This method generates a plot of the beating length as a function of the inverse taper ratio (ITR),
+        formatted according to the predefined plot style.
+
+        Parameters
+        ----------
+        other_supermode : SUPERMODE
+            The supermode to compare against.
+        ax : matplotlib.axes.Axes, optional
+            The axis on which to plot. If `None`, a new axis is created (default is `None`).
+
+        Returns
+        -------
+        matplotlib.figure.Figure
+            The figure object containing the generated plot.
+        """
+        if ax is None:
+            figure, ax = plt.subplots(nrows=1, ncols=1)
+        else:
+            figure = ax.figure
+
+        ax.set_xlabel("Inverse taper ratio")
+        ax.set_ylabel("Beating length [m]")
+
+        if not self.supermode.is_computation_compatible(other_supermode):
+            return
+
+        y = self.get_values(other_supermode=other_supermode)
+
+        label = f"{self.supermode.stylized_label} - {other_supermode.stylized_label}"
+
+        ax.plot(
+            self.supermode.model_parameters.itr_list, abs(y), label=label, linewidth=2
+        )
+
+        ax.legend()
+
+        return figure
+
+
+# -

SuPyMode/representation/beta.py

@@ -0,0 +1,78 @@
+# #!/usr/bin/env python
+# # -*- coding: utf-8 -*-
+
+import matplotlib.pyplot as plt
+from MPSPlots.helper import post_mpl_plot
+
+from SuPyMode.supermode import SUPERMODE
+
+
+class Beta:
+    """
+    Represents the propagation constants (beta values) of a mode derived from a supermode in optical simulations.
+
+    This class utilizes inheritance from `InheritFromSuperMode` for accessing supermode-related data and
+    `BaseSingleModePlot` for plotting functionalities tailored to propagation constant visualization.
+
+    Attributes
+    ----------
+    supermode : SUPERMODE
+        A reference to the parent supermode object from which beta data is sourced.
+    data : numpy.ndarray
+        The propagation constant (beta) data retrieved from the parent supermode binding.
+    """
+
+    def __init__(self, supermode: SUPERMODE):
+        """
+        Initialize a Beta object with a reference to a parent supermode.
+
+        Parameters
+        ----------
+        supermode : SUPERMODE
+            The parent supermode object that provides the base beta data.
+        """
+        self.supermode = supermode
+        self.data = self.supermode.get_betas()
+
+    @post_mpl_plot
+    def plot(self, ax: plt.Axes = None, show: bool = True) -> plt.Figure:
+        """
+        Plot the propagation constant for a single mode.
+
+        This method generates a plot of the propagation constants as a function of the inverse taper ratio (ITR),
+        formatted according to the predefined plot style.
+
+        Parameters
+        ----------
+        ax : matplotlib.axes.Axes, optional
+            The axis on which to plot. If `None`, a new axis is created (default is `None`).
+        show : bool, optional
+            Whether to display the plot immediately (default is `True`).
+
+        Returns
+        -------
+        matplotlib.figure.Figure
+            The figure object containing the generated plot.
+
+        """
+        if ax is None:
+            figure, ax = plt.subplots(1, 1)
+        else:
+            figure = ax.figure
+
+        ax.plot(
+            self.supermode.model_parameters.itr_list,
+            self.data,
+            label=f"{self.supermode.stylized_label}",
+            linewidth=2,
+        )
+
+        ax.legend()
+
+        ax.set_xlabel("Inverse taper ratio")
+        ax.set_ylabel("Propagation constant [rad/M]")
+
+        return figure
+
+
+# -

SuPyMode/representation/eigen_value.py

@@ -0,0 +1,79 @@
+# #!/usr/bin/env python
+# # -*- coding: utf-8 -*-
+import matplotlib.pyplot as plt
+from MPSPlots.helper import post_mpl_plot
+
+from SuPyMode.supermode import SUPERMODE
+
+
+class EigenValue:
+    """
+    Represents the eigenvalues of a mode derived from a supermode in a waveguide or optical fiber simulation.
+
+    This class extends from `InheritFromSuperMode` to access supermode-related data and from `BaseSingleModePlot`
+    to provide plotting capabilities tailored to eigenvalue visualization.
+
+    Attributes
+    ----------
+    supermode : SUPERMODE
+        The parent supermode object from which eigenvalue data is derived.
+    data : numpy.ndarray
+        The eigenvalue data retrieved from the parent supermode binding.
+    """
+
+    def __init__(self, supermode: SUPERMODE):
+        """
+        Initialize an EigenValue object with a parent supermode reference.
+
+        Parameters
+        ----------
+        supermode : SUPERMODE
+            A reference to the parent supermode object that provides the base eigenvalue data.
+        """
+        self.supermode = supermode
+        self.data = self.supermode.get_eigen_value()
+
+    @post_mpl_plot
+    def plot(self, ax: plt.Axes = None, show: bool = True) -> plt.Figure:
+        """
+        Plot the propagation constant for a single mode.
+
+        This method generates a plot of the propagation constants as a function of the inverse taper ratio (ITR),
+        formatted according to the predefined plot style.
+
+        Parameters
+        ----------
+        ax : matplotlib.axes.Axes, optional
+            The axis on which to plot. If `None`, a new axis is created (default is `None`).
+        show : bool, optional
+            Whether to display the plot immediately (default is `True`).
+
+        Returns
+        -------
+        matplotlib.figure.Figure
+            The figure object containing the generated plot.
+
+        """
+        if ax is None:
+            figure, ax = plt.subplots(1, 1)
+        else:
+            figure = ax.figure
+
+        ax.plot(
+            self.supermode.model_parameters.itr_list,
+            self.data,
+            label=f"{self.supermode.stylized_label}",
+            linewidth=2,
+        )
+
+        ax.legend()
+
+        ax.set(
+            xlabel="Inverse taper ratio",
+            ylabel="Eigenvalue",
+        )
+
+        return figure
+
+
+# -