API Reference

Importing from Katsu

Imports in katsu are done by calling the appropriate submodules. The code snippet below shows how to import the method to create a linear diattenuator

from katsu.mueller import linear_diattenuator

Methods or classes with an underscore “_” preceding the name indicates that this is not a public method or class, and therefore its direct use is not reccomended. For a complete listing of the methods available in Katsu, see the following API reference:

• katsu API Reference
  • Submodules
    • katsu.katsu_math module
      • BackendShim
      • RMS_calculator()
      • broadcast_kron()
      • broadcast_outer()
      • condition_number()
      • propagated_error()
      • set_backend_to_cupy()
      • set_backend_to_jax()
      • set_backend_to_numpy()
    • katsu.motion module
      • AgilisRotationStage
      • BaseRotationStage
    • katsu.mueller module
      • decompose_depolarizer()
      • decompose_diattenuator()
      • decompose_retarder()
      • depolarization_index()
      • depolarizer()
      • diattenuation_from_mueller()
      • diattenuation_parameters_from_mueller()
      • linear_diattenuator()
      • linear_polarizer()
      • linear_retarder()
      • mueller_rotation()
      • mueller_to_jones()
      • retardance_from_mueller()
      • retardance_parameters_from_mueller()
      • stokes_from_parameters()
      • wollaston()
    • katsu.polarimetry module
      • I_output_simulation_function()
      • drrp_data_reduction_matrix()
      • dual_channel_polarimeter()
      • dual_channel_sinusoid()
      • full_mueller_polarimetry()
      • full_stokes_polarimetry()
      • normalized_double_diff_sinusoid()
      • normalized_single_diff_sinusoid()
      • q_calibrated_full_mueller_polarimetry()
      • q_output_simulation_function()
      • q_ultimate_polarimetry()
      • single_output_simulation_function()
      • stokes_sinusoid()
      • unnormalized_double_diff_sinusoid()
      • unnormalized_single_diff_sinusoid()