:py:mod:`pygsti.algorithms.robust_phase_estimation`
===================================================

.. py:module:: pygsti.algorithms.robust_phase_estimation

.. autoapi-nested-parse::

   Robust Phase Estimation platform agnostic portion






Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   pygsti.algorithms.robust_phase_estimation.RobustPhaseEstimation




.. py:class:: RobustPhaseEstimation(q)


   Bases: :py:obj:`object`

   Runs the non-adaptive RPE algorithm.

   Runs the non-adaptive RPE algorithm using a dictionary of measurement results,
   `Q.raw_angles`, containing the angles calculated from the probabilities:

   `P^{γ'γ}_{Nₖs} = |<γ' y| U^Nₖ |γ x>|² = |<γ' x| U^Nₖ |-γ y>|² = (1 ± sin(θ))/2`
   `P^{γ'γ}_{Nₖc} = |<γ' x| U^Nₖ |γ x>|² = |<γ' y| U^Nₖ | γ y>|² = (1 ± cos(θ))/2`

   Expect `measured[Nₖ] = θ`.

   Overview:

   At each generation, use the previous estimated angle to select the `2π/L` window
   (of which the measurements cannot distinguish).

   Returns an result object. theta is the estimated angle, angle_estimates are
   the estimates from each generation.

   Parameters
   ----------
   q : <TODO typ>
       <TODO description>

   .. py:attribute:: Q

      

   .. py:method:: theta_n(n)

      Returns the equivalence class of the measurement Θ.

      By definition, Θ is equivalent when any integer multiple of 2π/N is added to it.

      Parameters
      ----------
      n : int
          The RPE 'N' parameter, used to determine the equivalence class.

      Returns
      -------
      float