piel.visual.plot.signals.frequency
==================================

.. py:module:: piel.visual.plot.signals.frequency


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/piel/visual/plot/signals/frequency/two_port/index


Functions
---------

.. autoapisummary::

   piel.visual.plot.signals.frequency.plot_s21_gain_per_input_power_dBm
   piel.visual.plot.signals.frequency.plot_s11_s21_magnitude_per_input_frequency
   piel.visual.plot.signals.frequency.plot_s11_magnitude_per_input_frequency
   piel.visual.plot.signals.frequency.plot_s21_magnitude_per_input_frequency


Package Contents
----------------

.. py:function:: plot_s21_gain_per_input_power_dBm(network_transmission: piel.types.NetworkTransmission, fig: Optional[matplotlib.figure.Figure] = None, axs: Optional[matplotlib.axes.Axes] = None, label: Optional[str] = None, xlabel: str = None, ylabel: str = None, **kwargs) -> tuple[matplotlib.figure.Figure, matplotlib.axes.Axes]

   Plots input power (p_in_dbm) vs S21 gain (s_21_db) from a NetworkTransmission object.

   Parameters:
   -----------
   frequency_array_state : NetworkTransmission
       The NetworkTransmission object containing the measurement data.

   fig : matplotlib.figure.Figure, optional
       The figure object to plot on. If None, a new figure is created.

   axs : matplotlib.axes.Axes, optional
       The axes object to plot on. If None, a new set of axes is created.

   label : str, optional
       The label for the plot. If None, a default label is used.

   Returns:
   --------
   :
   tuple
       A tuple containing the matplotlib Figure and Axes objects.


.. py:function:: plot_s11_s21_magnitude_per_input_frequency(network_transmission: piel.types.NetworkTransmission, fig: Optional[matplotlib.figure.Figure] = None, axs: Optional[matplotlib.axes.Axes] = None, labels: Optional[Tuple[str, str]] = None, xlabel: Optional[str] = None, ylabel: Optional[str] = None, **kwargs) -> Tuple[matplotlib.figure.Figure, matplotlib.axes.Axes]

   Plots S21 and S11 magnitudes vs input power (P_in_dBm) from a NetworkTransmission object on the same axes.

   Parameters:
   -----------
   network_transmission : NetworkTransmission
       The NetworkTransmission object containing the measurement data.

   fig : matplotlib.figure.Figure, optional
       The figure object to plot on. If None, a new figure is created.

   axs : matplotlib.axes.Axes, optional
       The axes object to plot on. If None, a new set of axes is created.

   labels : tuple of str, optional
       A tuple containing labels for S21 and S11 plots. If None, defaults to ("S21 Gain", "S11 Magnitude").

   xlabel : str, optional
       The label for the x-axis. If None, defaults to "P_in dBm".

   ylabel : str, optional
       The label for the y-axis. If None, defaults to "Magnitude (dB)".

   **kwargs :
       Additional keyword arguments passed to the plot function.

   Returns:
   --------
   :
   tuple
       A tuple containing the matplotlib Figure and Axes objects.


.. py:function:: plot_s11_magnitude_per_input_frequency(network_transmission: piel.types.NetworkTransmission, fig: Optional[matplotlib.figure.Figure] = None, axs: Optional[matplotlib.axes.Axes] = None, label: str = None, xlabel: Optional[str] = None, ylabel: Optional[str] = None, **kwargs) -> Tuple[matplotlib.figure.Figure, matplotlib.axes.Axes]

   Plots S11 magnitudes vs input power (P_in_dBm) from a NetworkTransmission object on the same axes.

   Parameters:
   -----------
   network_transmission : NetworkTransmission
       The NetworkTransmission object containing the measurement data.

   fig : matplotlib.figure.Figure, optional
       The figure object to plot on. If None, a new figure is created.

   axs : matplotlib.axes.Axes, optional
       The axes object to plot on. If None, a new set of axes is created.

   labels : tuple of str, optional
       A tuple containing labels for S21 and S11 plots. If None, defaults to ("S21 Gain", "S11 Magnitude").

   xlabel : str, optional
       The label for the x-axis. If None, defaults to "P_in dBm".

   ylabel : str, optional
       The label for the y-axis. If None, defaults to "Magnitude (dB)".

   **kwargs :
       Additional keyword arguments passed to the plot function.

   Returns:
   --------
   :
   tuple
       A tuple containing the matplotlib Figure and Axes objects.


.. py:function:: plot_s21_magnitude_per_input_frequency(network_transmission: piel.types.NetworkTransmission, fig: Optional[matplotlib.figure.Figure] = None, axs: Optional[matplotlib.axes.Axes] = None, label: Optional[Tuple[str, str]] = None, xlabel: Optional[str] = None, ylabel: Optional[str] = None, **kwargs) -> Tuple[matplotlib.figure.Figure, matplotlib.axes.Axes]

   Plots S21 and S11 magnitudes vs input power (P_in_dBm) from a NetworkTransmission object on the same axes.

   Parameters:
   -----------
   network_transmission : NetworkTransmission
       The NetworkTransmission object containing the measurement data.

   fig : matplotlib.figure.Figure, optional
       The figure object to plot on. If None, a new figure is created.

   axs : matplotlib.axes.Axes, optional
       The axes object to plot on. If None, a new set of axes is created.

   labels : tuple of str, optional
       A tuple containing labels for S21 and S11 plots. If None, defaults to ("S21 Gain", "S11 Magnitude").

   xlabel : str, optional
       The label for the x-axis. If None, defaults to "P_in dBm".

   ylabel : str, optional
       The label for the y-axis. If None, defaults to "Magnitude (dB)".

   **kwargs :
       Additional keyword arguments passed to the plot function.

   Returns:
   --------
   :
   tuple
       A tuple containing the matplotlib Figure and Axes objects.