Kontrol API

Subpackages

• kontrol.complementary_filter
  • Primary modules
    • kontrol.complementary_filter.complementary_filter
      • ComplementaryFilter
        • ComplementaryFilter.h2synthesis()
        • ComplementaryFilter.hinfsynthesis()
        • ComplementaryFilter.f
        • ComplementaryFilter.filter1
        • ComplementaryFilter.filter2
        • ComplementaryFilter.h2synthesis()
        • ComplementaryFilter.hinfsynthesis()
        • ComplementaryFilter.noise1
        • ComplementaryFilter.noise2
        • ComplementaryFilter.noise_super()
  • Secondary modules
    • kontrol.complementary_filter.predefined
      • generalized_sekiguchi()
      • lucia()
      • modified_sekiguchi()
      • sekiguchi()
    • kontrol.complementary_filter.synthesis
      • generalized_plant()
      • h2complementary()
      • hinfcomplementary()
• kontrol.core
  • kontrol.core.controlutils module
    • check_tf_equal()
    • clean_tf()
    • clean_tf2()
    • clean_tf3()
    • complex2wq()
    • convert_unstable_tf()
    • generic_tf()
    • outlier_exists()
    • outliers()
    • sos()
    • tf_order_split()
    • tfmatrix2tf()
    • zpk()
  • kontrol.core.math module
    • log_mse()
    • mse()
    • polyval()
    • quad_sum()
  • kontrol.core.spectral module
    • asd2rms()
    • asd2ts()
    • pad_above_maxima()
    • pad_above_minima()
    • pad_below_maxima()
    • pad_below_minima()
    • three_channel_correlation()
    • two_channel_correlation()
  • kontrol.core.foton module
    • foton2tf()
    • get_zpk2tf()
    • notch()
    • rpoly2tf()
    • tf2foton()
    • tf2rpoly()
    • tf2zpk()
    • zpk2tf()
• kontrol.curvefit
  • Primary modules
    • kontrol.curvefit.curvefit
      • CurveFit
        • CurveFit.cost
        • CurveFit.fit()
        • CurveFit.model
        • CurveFit.model_kwargs
        • CurveFit.optimize_result
        • CurveFit.optimized_args
        • CurveFit.optimizer
        • CurveFit.optimizer_kwargs
        • CurveFit.prefit()
        • CurveFit.xdata
        • CurveFit.ydata
        • CurveFit.yfit
    • kontrol.curvefit.transfer_function_fit
      • TransferFunctionFit
        • TransferFunctionFit.options
        • TransferFunctionFit.weight
        • TransferFunctionFit.x0
  • Secondary modules
    • kontrol.curvefit.cost
      • Cost
        • Cost.error_func
        • Cost.error_func_kwargs
    • kontrol.curvefit.error_func
      • log_mse()
      • mse()
      • noise_error()
      • spectrum_error()
      • tf_error()
  • Subpackages
    • kontrol.curve.model
      • Model
        • Model.args
        • Model.nargs
      • ComplexZPK
        • ComplexZPK.fn_zero
        • ComplexZPK.fn_pole
        • ComplexZPK.q_zero
        • ComplexZPK.q_pole
        • ComplexZPK.args
        • ComplexZPK.fn_pole
        • ComplexZPK.fn_zero
        • ComplexZPK.gain
        • ComplexZPK.npole_pairs
        • ComplexZPK.nzero_pairs
        • ComplexZPK.q_pole
        • ComplexZPK.q_zero
        • ComplexZPK.tf
      • CoupledOscillator
      • DampedOscillator
        • DampedOscillator.args
        • DampedOscillator.damped_oscillator_args
        • DampedOscillator.fn
        • DampedOscillator.gain
        • DampedOscillator.q
      • SimpleZPK
        • SimpleZPK.zero
        • SimpleZPK.pole
        • SimpleZPK.gain
        • SimpleZPK.tf
        • SimpleZPK.args
        • SimpleZPK.gain
        • SimpleZPK.npole
        • SimpleZPK.nzero
        • SimpleZPK.pole
        • SimpleZPK.tf
        • SimpleZPK.zero
      • TransferFunctionModel
        • TransferFunctionModel.tf
        • TransferFunctionModel.den
        • TransferFunctionModel.npole
        • TransferFunctionModel.num
        • TransferFunctionModel.nzero
        • TransferFunctionModel.tf
      • Erf
        • Erf.amplitude
        • Erf.slope
        • Erf.x_offset
        • Erf.y_offset
      • StraightLine
        • StraightLine.slope
        • StraightLine.intercept
        • StraightLine.intercept
        • StraightLine.slope
• kontrol.dmd
  • Primary modules
    • kontrol.dmd.dmd
      • DMD
        • DMD.snapshot_1
        • DMD.snapshot_2
        • DMD.truncation_value
        • DMD.dt
        • DMD.u
        • DMD.vh
        • DMD.sigma
        • DMD.u_truncated
        • DMD.vh_truncated
        • DMD.sigma_truncated
        • DMD.A_reduced
        • DMD.w_reduced
        • DMD.v_reduced
        • DMD.dmd_modes
        • DMD.complex_frequencies
        • DMD.v_constant
        • DMD.time_dynamics
        • DMD.prediction
        • DMD.A_reduced
        • DMD.complex_frequencies
        • DMD.compute_complex_frequencies()
        • DMD.compute_dmd_modes()
        • DMD.compute_reduced_model()
        • DMD.dt
        • DMD.eig_reduced_model()
        • DMD.low_rank_approximation()
        • DMD.predict()
        • DMD.prediction
        • DMD.run()
        • DMD.sigma
        • DMD.sigma_truncated
        • DMD.snapshot_1
        • DMD.snapshot_2
        • DMD.svd()
        • DMD.time_dynamics
        • DMD.truncation_value
        • DMD.u
        • DMD.u_truncated
        • DMD.v_constant
        • DMD.vh
        • DMD.vh_truncated
    • kontrol.dmd.forecast
      • dmd_forecast()
  • Secondary modules
    • kontrol.dmd.utils
      • auto_truncate()
      • hankel()
• kontrol.regulator
  • Primary modules
    • kontrol.regulator.feedback
      • add_integral_control()
      • add_proportional_control()
      • critical_damp_calculated()
      • critical_damp_optimize()
      • critical_damping()
      • mode_composition()
      • mode_decomposition()
    • kontrol.regulator.oscillator
      • pid()
    • kontrol.regulator.post_filter
      • post_low_pass()
      • post_notch()
  • Secondary modules
    • kontrol.regulator.predefined
      • low_pass()
      • notch()
      • pid()
      • proportional_integral_derivative()
• kontrol.sensact
  • Primary modules
    • kontrol.sensact.matrix
      • Matrix
      • SensingMatrix
        • SensingMatrix.diagonalize()
    • kontrol.sensact.optical_lever
      • HorizontalOpticalLeverSensingMatrix
        • HorizontalOpticalLeverSensingMatrix.delta_d
        • HorizontalOpticalLeverSensingMatrix.f
        • HorizontalOpticalLeverSensingMatrix.r
        • HorizontalOpticalLeverSensingMatrix.r_lens
      • OpticalLeverSensingMatrix
        • OpticalLeverSensingMatrix.alpha_h
        • OpticalLeverSensingMatrix.alpha_v
        • OpticalLeverSensingMatrix.d_h
        • OpticalLeverSensingMatrix.d_v
        • OpticalLeverSensingMatrix.delta_x
        • OpticalLeverSensingMatrix.delta_y
        • OpticalLeverSensingMatrix.f_h
        • OpticalLeverSensingMatrix.f_v
        • OpticalLeverSensingMatrix.format
        • OpticalLeverSensingMatrix.phi_len
        • OpticalLeverSensingMatrix.phi_tilt
        • OpticalLeverSensingMatrix.r_h
        • OpticalLeverSensingMatrix.r_lens_h
        • OpticalLeverSensingMatrix.r_lens_v
        • OpticalLeverSensingMatrix.r_v
        • OpticalLeverSensingMatrix.update_matrices_decorator()
      • VerticalOpticalLeverSensingMatrix
        • VerticalOpticalLeverSensingMatrix.delta_d
        • VerticalOpticalLeverSensingMatrix.f
        • VerticalOpticalLeverSensingMatrix.r
        • VerticalOpticalLeverSensingMatrix.r_lens
      • c_align()
      • c_miscenter()
      • c_rotation()
    • kontrol.sensact.calibration
      • calibrate()
      • calibrate_erf()
      • calibrate_linear()
• kontrol.transfer_function
  • Primary modules
    • kontrol.transfer_function.transfer_function
      • TransferFunction
        • TransferFunction.clean()
        • TransferFunction.foton()
        • TransferFunction.lstrip()
        • TransferFunction.rstrip()
        • TransferFunction.save()
        • TransferFunction.stabilize()
      • load_transfer_function()
    • kontrol.transfer_function.notch
      • Notch
        • Notch.depth
        • Notch.foton()
        • Notch.frequency
        • Notch.q

Submodules

• kontrol.ezca