Welcome to Python polarization’s documentation!

Contents:

• 1. Python polarization
  • 1.1. Features
  • 1.2. Examples
    • 1.2.1. Jones formalism
    • 1.2.2. Stokes-Mueller formalism
    • 1.2.3. Drawings
  • 1.3. Conventions
  • 1.4. Authors
  • 1.5. Citing
  • 1.6. References
  • 1.7. Acknowlegments
  • 1.8. Credits
• 2. Installation
  • 2.1. Stable release
  • 2.2. From sources
• Examples
  • 1. Introductory
    • 1.1. Example 1: Malus law
      • 1.1.1. Jones formalism
        • 1.1.1.1. Perfect polarizers
        • 1.1.1.2. Imperfect polarizers
      • 1.1.2. Mueller-Stokes formalism
        • 1.1.2.1. Perfect polarizers
        • 1.1.2.2. Imperfect polarizers
    • 1.2. Example 2: Classic Zeno effect
      • 1.2.1. Jones formalism
        • 1.2.1.1. Perfect polarizers
        • 1.2.1.2. Imperfect polarizers
      • 1.2.2. Mueller-Stokes formalism
        • 1.2.2.1. Perfect polarizers
        • 1.2.2.2. Imperfect polarizers
  • 2. Advanced
    • 2.1. Example 3: Analysis
      • 2.1.1. Analysis of light waves
        • 2.1.1.1. Theory of Jones vectors
        • 2.1.1.2. Example of analysis of Jones vectors
        • 2.1.1.3. Theory of Stokes vectors
        • 2.1.1.4. Example of analysis of Stokes vectors
        • 2.1.1.5. Error filtering
      • 2.1.2. Analysis of optical elements
        • 2.1.2.1. Theory of Jones matrix objects
        • 2.1.2.2. Examples of characterization of Jones matrices
        • 2.1.2.3. Decomposition of Jones matrices
        • 2.1.2.4. Theory of Mueller objects
        • 2.1.2.5. Examples of characterization of Mueller matrices
        • 2.1.2.6. Decomposition of Mueller matrices
        • 2.1.2.7. Error filtering
        • 2.1.2.8. Purification of Mueller matrices
    • 2.2. Example 4: Light polarimetry
      • 2.2.1. Jones formalism
      • 2.2.2. Mueller-Stokes formalism
    • 2.3. Example 5: Optical elements polarimetry
      • 2.3.1. Jones formalism
      • 2.3.2. Mueller-Stokes formalism
    • 2.4. Example 6: Liquid crystal
      • 2.4.1. Layer model
        • 2.4.1.1. Number of layers
        • 2.4.1.2. Voltages
    • 2.5. Coy model
    • 2.6. Marquez model
• Tutorials
  • 1. Jones_vector class
    • 1.1. Creating an instance
    • 1.2. Jones_vector class fields
    • 1.3. Generating polarization states
      • 1.3.1. Features of creation methods
    • 1.4. Basic operations
      • 1.4.1. Addition of two Jones vectors
      • 1.4.2. Multiply by a constant
      • 1.4.3. Equality
      • 1.4.4. Operations and multidimensionality
    • 1.5. Jones vector manipulation
      • 1.5.1. Picking and setting
      • 1.5.2. Iterating
    • 1.6. Parameters of Jones_vector
    • 1.7. Checks of Jones_vector
  • 2. Jones_matrix class
    • 2.1. Creating an instance
    • 2.2. Jones_matrix class fields
    • 2.3. Generating of optical elements
      • 2.3.1. Features of creation methods
    • 2.4. Basic operations
      • 2.4.1. Multiplication of a Jones matrix by a Jones vector
      • 2.4.2. Multiplication of 2 Jones matrices
      • 2.4.3. Multiplication by a constant
      • 2.4.4. Addition of two Jones matrices
      • 2.4.5. Equality
      • 2.4.6. Operations and multidimensionality
    • 2.5. Jones matrix manipulation
      • 2.5.1. Picking and setting
      • 2.5.2. Iterating
    • 2.6. Parameters of Jones_matrix
    • 2.7. Checks of Jones_matrix
    • 2.8. Analysis of Jones_matrix
  • 3. Stokes class
    • 3.1. Creating an instance
    • 3.2. Stokes class fields
    • 3.3. Generating polarization states
      • 3.3.1. Features of creation methods
    • 3.4. Basic operations
      • 3.4.1. Addition of two Stokes vectors
      • 3.4.2. Multiply by a constant
      • 3.4.3. Equality
      • 3.4.4. Operations and multidimensionality
    • 3.5. Stokes vectors manipulation
      • 3.5.1. Picking and setting
      • 3.5.2. Iterating
    • 3.6. Parameters of Stokes vector
    • 3.7. Checks of Stokes vectors
    • 3.8. Analysis of Stokes vectors
  • 4. Mueller class
    • 4.1. Creating an instance
    • 4.2. Mueller class fields
    • 4.3. Generating polarization devices
      • 4.3.1. Features of creation methods
    • 4.4. Basic operations
      • 4.4.1. Addition of two Mueller matrices
      • 4.4.2. Multiply by a constant
      • 4.4.3. Multiplication of a Stokes vector by a Mueller matrix
      • 4.4.4. Multiplication of Mueller matrices
      • 4.4.5. Equality
      • 4.4.6. Operations and multidimensionality
    • 4.5. Mueller matrix manipulation
      • 4.5.1. Picking and setting
      • 4.5.2. Iterating
    • 4.6. Parameters of Mueller matrices
    • 4.7. Checks on Mueller Matrices
    • 4.8. Analysis of Mueller matrices
  • 5. Draw
    • 5.1. Polarization ellipse
      • 5.1.1. Pure states
      • 5.1.2. Plot multiple ellipses in a single plot
      • 5.1.3. Plot several ellipses in multiple plots
      • 5.1.4. Plot partially polarized states
      • 5.1.5. Save the figure as an image file
    • 5.2. Poincaré sphere
      • 5.2.1. Plotting multiple states
      • 5.2.2. Plotting parameters
• 3. py_pol
  • 3.1. py_pol package
    • 3.1.1. py_pol.py_pol module
      • get_options()
      • set_option()
      • Py_pol
        • Py_pol.name
        • Py_pol.type
        • Py_pol.M
        • Py_pol.size
        • Py_pol.shape
        • Py_pol.ndim
        • Py_pol.get_list()
        • Py_pol.from_list()
        • Py_pol.concatenate()
        • Py_pol.flip()
        • Py_pol.stretch()
        • Py_pol.copy()
        • Py_pol.reshape()
        • Py_pol.shape_like()
        • Py_pol.flatten()
        • Py_pol.draw()
        • Py_pol.clear()
      • Py_pol_Iterator
    • 3.1.2. py_pol.jones_vector module
      • create_Jones_vectors()
      • set_printoptions()
      • Jones_vector
        • Jones_vector.self.parameters
        • Jones_vector.self.checks
        • Jones_vector.rotate()
        • Jones_vector.reciprocal()
        • Jones_vector.orthogonal()
        • Jones_vector.sum()
        • Jones_vector.normalize()
        • Jones_vector.rotate_to_azimuth()
        • Jones_vector.remove_global_phase()
        • Jones_vector.add_global_phase()
        • Jones_vector.set_global_phase()
        • Jones_vector.add_delay()
        • Jones_vector.draw_ellipse()
        • Jones_vector.draw_poincare()
        • Jones_vector.from_components()
        • Jones_vector.from_matrix()
        • Jones_vector.from_distribution()
        • Jones_vector.from_Stokes()
        • Jones_vector.linear_light()
        • Jones_vector.circular_light()
        • Jones_vector.elliptical_light()
        • Jones_vector.general()
        • Jones_vector.general_azimuth_ellipticity()
        • Jones_vector.general_charac_angles()
      • Parameters_Jones_Vector
        • Parameters_Jones_Vector.self.parent
        • Parameters_Jones_Vector.get_all()
        • Parameters_Jones_Vector.matrix()
        • Parameters_Jones_Vector.components()
        • Parameters_Jones_Vector.amplitudes()
        • Parameters_Jones_Vector.norm()
        • Parameters_Jones_Vector.intensity()
        • Parameters_Jones_Vector.irradiance()
        • Parameters_Jones_Vector.alpha()
        • Parameters_Jones_Vector.delay()
        • Parameters_Jones_Vector.delta()
        • Parameters_Jones_Vector.charac_angles()
        • Parameters_Jones_Vector.azimuth()
        • Parameters_Jones_Vector.ellipticity_angle()
        • Parameters_Jones_Vector.azimuth_ellipticity()
        • Parameters_Jones_Vector.global_phase()
        • Parameters_Jones_Vector.ellipse_axes()
        • Parameters_Jones_Vector.ellipticity_param()
        • Parameters_Jones_Vector.eccentricity()
        • Parameters_Jones_Vector.degree_circular_polarization()
        • Parameters_Jones_Vector.degree_linear_polarization()
      • Checks_Jones_Vector
        • Checks_Jones_Vector.self.parent
        • Checks_Jones_Vector.get_all()
        • Checks_Jones_Vector.is_linear()
        • Checks_Jones_Vector.is_circular()
        • Checks_Jones_Vector.is_right_handed()
        • Checks_Jones_Vector.is_left_handed()
    • 3.1.3. py_pol.jones_matrix module
      • create_Jones_matrices()
        • self.parameters
        • self.checks
      • set_printoptions()
      • Jones_matrix
        • Jones_matrix.self.parameters
        • Jones_matrix.self.checks
        • Jones_matrix.self.analysis
        • Jones_matrix.rotate()
        • Jones_matrix.reciprocal()
        • Jones_matrix.transpose()
        • Jones_matrix.hermitian()
        • Jones_matrix.inverse()
        • Jones_matrix.sum()
        • Jones_matrix.prod()
        • Jones_matrix.remove_global_phase()
        • Jones_matrix.add_global_phase()
        • Jones_matrix.set_global_phase()
        • Jones_matrix.from_components()
        • Jones_matrix.from_matrix()
        • Jones_matrix.from_Mueller()
        • Jones_matrix.vacuum()
        • Jones_matrix.filter_amplifier()
        • Jones_matrix.mirror()
        • Jones_matrix.diattenuator_perfect()
        • Jones_matrix.diattenuator_linear()
        • Jones_matrix.diattenuator_circular()
        • Jones_matrix.diattenuator_general()
        • Jones_matrix.diattenuator_azimuth_ellipticity()
        • Jones_matrix.diattenuator_charac_angles()
        • Jones_matrix.quarter_waveplate()
        • Jones_matrix.half_waveplate()
        • Jones_matrix.retarder_linear()
        • Jones_matrix.retarder_circular()
        • Jones_matrix.retarder_general()
        • Jones_matrix.retarder_azimuth_ellipticity()
        • Jones_matrix.retarder_charac_angles()
        • Jones_matrix.diattenuator_retarder_linear()
        • Jones_matrix.diattenuator_retarder_general()
        • Jones_matrix.diattenuator_retarder_azimuth_ellipticity()
        • Jones_matrix.diattenuator_retarder_charac_angles()
        • Jones_matrix.biaxial_material()
        • Jones_matrix.general_eigenstates()
      • Parameters_Jones_Matrix
        • Parameters_Jones_Matrix.get_all()
        • Parameters_Jones_Matrix.matrix()
        • Parameters_Jones_Matrix.components()
        • Parameters_Jones_Matrix.inhomogeneity()
        • Parameters_Jones_Matrix.diattenuation()
        • Parameters_Jones_Matrix.polarizance()
        • Parameters_Jones_Matrix.retardance()
        • Parameters_Jones_Matrix.global_phase()
        • Parameters_Jones_Matrix.transmissions()
        • Parameters_Jones_Matrix.mean_transmission()
        • Parameters_Jones_Matrix.eig()
        • Parameters_Jones_Matrix.eigenvectors()
        • Parameters_Jones_Matrix.eigenstates()
        • Parameters_Jones_Matrix.eigenvalues()
        • Parameters_Jones_Matrix.det()
        • Parameters_Jones_Matrix.trace()
        • Parameters_Jones_Matrix.norm()
      • Checks_Jones_Matrix
        • Checks_Jones_Matrix.get_all()
        • Checks_Jones_Matrix.is_physical()
        • Checks_Jones_Matrix.is_homogeneous()
        • Checks_Jones_Matrix.is_retarder()
        • Checks_Jones_Matrix.is_diattenuator()
        • Checks_Jones_Matrix.is_polarizer()
        • Checks_Jones_Matrix.is_symmetric()
        • Checks_Jones_Matrix.is_conjugate_symmetric()
        • Checks_Jones_Matrix.is_eigenstate()
      • Analysis_Jones_Matrix
        • Analysis_Jones_Matrix.decompose_pure()
        • Analysis_Jones_Matrix.diattenuator()
        • Analysis_Jones_Matrix.polarizer()
        • Analysis_Jones_Matrix.retarder()
    • 3.1.4. py_pol.stokes module
      • create_Stokes()
      • set_printoptions()
      • Stokes
        • Stokes.self.parameters
        • Stokes.self.checks
        • Stokes.self.analysis
        • Stokes.global_phase
        • Stokes.sum()
        • Stokes.rotate()
        • Stokes.set_depolarization()
        • Stokes.add_depolarization()
        • Stokes.normalize()
        • Stokes.add_global_phase()
        • Stokes.set_global_phase()
        • Stokes.remove_global_phase()
        • Stokes.rotate_to_azimuth()
        • Stokes.rotate_Poincare()
        • Stokes.rotate_Poincare_orig()
        • Stokes.from_components()
        • Stokes.from_matrix()
        • Stokes.from_distribution()
        • Stokes.from_Jones()
        • Stokes.linear_light()
        • Stokes.circular_light()
        • Stokes.elliptical_light()
        • Stokes.general()
        • Stokes.general_azimuth_ellipticity()
        • Stokes.general_charac_angles()
        • Stokes.draw_poincare()
        • Stokes.draw_ellipse()
      • Parameters_Stokes_vector
        • Parameters_Stokes_vector.self.parent
        • Parameters_Stokes_vector.get_all()
        • Parameters_Stokes_vector.matrix()
        • Parameters_Stokes_vector.global_phase()
        • Parameters_Stokes_vector.components()
        • Parameters_Stokes_vector.intensity()
        • Parameters_Stokes_vector.irradiance()
        • Parameters_Stokes_vector.degree_polarization()
        • Parameters_Stokes_vector.degree_depolarization()
        • Parameters_Stokes_vector.degree_linear_polarization()
        • Parameters_Stokes_vector.degree_circular_polarization()
        • Parameters_Stokes_vector.alpha()
        • Parameters_Stokes_vector.delay()
        • Parameters_Stokes_vector.delta()
        • Parameters_Stokes_vector.charac_angles()
        • Parameters_Stokes_vector.ellipticity_param()
        • Parameters_Stokes_vector.ellipticity_angle()
        • Parameters_Stokes_vector.azimuth()
        • Parameters_Stokes_vector.azimuth_ellipticity()
        • Parameters_Stokes_vector.eccentricity()
        • Parameters_Stokes_vector.ellipse_axes()
        • Parameters_Stokes_vector.polarized_unpolarized()
        • Parameters_Stokes_vector.amplitudes()
        • Parameters_Stokes_vector.norm()
        • Parameters_Stokes_vector.density()
      • Analysis_Stokes
        • Analysis_Stokes.self.parent
        • Analysis_Stokes.filter_physical_conditions()
        • Analysis_Stokes.density()
        • Analysis_Stokes.existence()
      • Check_Stokes
        • Check_Stokes.self.parent
        • Check_Stokes.get_all()
        • Check_Stokes.is_physical()
        • Check_Stokes.is_linear()
        • Check_Stokes.is_circular()
        • Check_Stokes.is_right_handed()
        • Check_Stokes.is_left_handed()
        • Check_Stokes.is_polarized()
        • Check_Stokes.is_totally_polarized()
        • Check_Stokes.is_depolarized()
        • Check_Stokes.is_totally_depolarized()
    • 3.1.5. py_pol.mueller module
      • create_Mueller()
        • self.parameters
        • self.checks
      • set_printoptions()
      • Mueller
        • Mueller.M
        • Mueller.m00
        • Mueller.D
        • Mueller.P
        • Mueller.m
        • Mueller.global_phase
        • Mueller.name
        • Mueller.shape
        • Mueller.size
        • Mueller.ndim
        • Mueller.no_rotation
        • Mueller.type
        • Mueller.self.parameters
        • Mueller.self.checks
        • Mueller.self.analysis
        • Mueller.global_phase
        • Mueller.add_global_phase()
        • Mueller.set_global_phase()
        • Mueller.remove_global_phase()
        • Mueller.rotate()
        • Mueller.covariance_matrix()
        • Mueller.inverse()
        • Mueller.reciprocal()
        • Mueller.transpose()
        • Mueller.sum()
        • Mueller.prod()
        • Mueller.from_components()
        • Mueller.from_matrix()
        • Mueller.from_normalized()
        • Mueller.from_blocks()
        • Mueller.from_Jones()
        • Mueller.from_covariance()
        • Mueller.vacuum()
        • Mueller.filter_amplifier()
        • Mueller.mirror()
        • Mueller.depolarizer_perfect()
        • Mueller.depolarizer_diagonal()
        • Mueller.depolarizer_states()
        • Mueller.diattenuator_perfect()
        • Mueller.diattenuator_linear()
        • Mueller.diattenuator_circular()
        • Mueller.diattenuator_general()
        • Mueller.diattenuator_azimuth_ellipticity()
        • Mueller.diattenuator_charac_angles()
        • Mueller.diattenuator_vector()
        • Mueller.quarter_waveplate()
        • Mueller.half_waveplate()
        • Mueller.retarder_general()
        • Mueller.retarder_azimuth_ellipticity()
        • Mueller.retarder_linear()
        • Mueller.retarder_circular()
        • Mueller.retarder_charac_angles()
        • Mueller.retarder_vector()
        • Mueller.diattenuator_retarder_linear()
        • Mueller.diattenuator_retarder_general()
        • Mueller.diattenuator_retarder_azimuth_ellipticity()
        • Mueller.diattenuator_retarder_charac_angles()
        • Mueller.biaxial_material()
        • Mueller.general_eigenstates()
      • Parameters_Mueller
        • Parameters_Mueller.get_all()
        • Parameters_Mueller.matrix()
        • Parameters_Mueller.components()
        • Parameters_Mueller.mean_transmission()
        • Parameters_Mueller.diattenuation_vector()
        • Parameters_Mueller.polarizance_vector()
        • Parameters_Mueller.small_matrix()
        • Parameters_Mueller.blocks()
        • Parameters_Mueller.global_phase()
        • Parameters_Mueller.inhomogeneity()
        • Parameters_Mueller.diattenuation()
        • Parameters_Mueller.diattenuation_linear()
        • Parameters_Mueller.diattenuation_circular()
        • Parameters_Mueller.polarizance()
        • Parameters_Mueller.polarizance_linear()
        • Parameters_Mueller.polarizance_circular()
        • Parameters_Mueller.degree_polarizance()
        • Parameters_Mueller.spheric_purity()
        • Parameters_Mueller.retardance()
        • Parameters_Mueller.polarimetric_purity()
        • Parameters_Mueller.depolarization_index()
        • Parameters_Mueller.polarimetric_purity_indices()
        • Parameters_Mueller.transmissions()
        • Parameters_Mueller.retardance_vector()
        • Parameters_Mueller.eig()
        • Parameters_Mueller.eigenvectors()
        • Parameters_Mueller.eigenstates()
        • Parameters_Mueller.eigenvalues()
        • Parameters_Mueller.det()
        • Parameters_Mueller.trace()
        • Parameters_Mueller.norm()
      • Analysis_Mueller
        • Analysis_Mueller.self.marent
        • Analysis_Mueller.depolarizer()
        • Analysis_Mueller.diattenuator()
        • Analysis_Mueller.polarizer()
        • Analysis_Mueller.retarder()
        • Analysis_Mueller.filter_purify_number()
        • Analysis_Mueller.filter_purify_threshold()
        • Analysis_Mueller.filter_physical_conditions()
        • Analysis_Mueller.decompose_pure()
        • Analysis_Mueller.decompose_polar()
      • Check_Mueller
        • Check_Mueller.self.parent
        • Check_Mueller.get_all()
        • Check_Mueller.is_physical()
        • Check_Mueller.is_non_depolarizing()
        • Check_Mueller.is_pure()
        • Check_Mueller.is_homogeneous()
        • Check_Mueller.is_retarder()
        • Check_Mueller.is_diattenuator()
        • Check_Mueller.is_polarizer()
        • Check_Mueller.is_depolarizer()
        • Check_Mueller.is_singular()
        • Check_Mueller.is_symmetric()
        • Check_Mueller.is_eigenstate()
    • 3.1.6. py_pol.drawings module
      • draw_ellipse()
      • draw_poincare()
    • 3.1.7. py_pol.utils module
      • prepare_variables()
      • expand_objects()
      • reshape()
      • select_shape()
      • multitake()
      • merge_indices()
      • combine_indices()
      • PrintParam()
      • take_shape()
      • kron_axis()
      • prepare_variables_blocks()
      • NumberOfSubplots()
      • PrintMatrices()
      • rotation_matrix_Jones()
      • rotation_matrix_Mueller()
      • azimuth_elipt_2_charac_angles()
      • charac_angles_2_azimuth_elipt()
      • extract_azimuth_elipt()
      • extract_charac_angles()
      • which_quad()
      • put_in_limits()
      • execute_multiprocessing()
      • divide_in_blocks()
      • list_of_objects_depercated()
      • inv_pypol()
      • obj_error()
      • matmul_pypol()
      • list_of_objects()
      • iscolumn()
      • isrow()
      • delta_kron()
      • order_eig()
      • check_eig()
      • distance()
      • nearest()
      • nearest2()
      • repair_name()
      • comparison()
      • params_to_list()
      • fit_distribution()
      • fit_cos()
      • fit_sine()
      • obj_2_xyz()
      • azel_2_xyz()
• 4. Contributing
  • 4.1. Types of Contributions
    • 4.1.1. Report Bugs
    • 4.1.2. Fix Bugs
    • 4.1.3. Implement Features
    • 4.1.4. Write Documentation
    • 4.1.5. Submit Feedback
  • 4.2. Get Started!
  • 4.3. Pull Request Guidelines
  • 4.4. Tips
  • 4.5. Deploying
• 5. History
  • 5.1. 1.3.0
  • 5.2. 1.2.0
  • 5.3. 1.1.4
  • 5.4. 1.1.3
  • 5.5. 1.1.2
  • 5.6. 1.1.1
  • 5.7. 1.1.0 (2022-3-31)
  • 5.8. 1.0.4 (2022-02-07)
  • 5.9. 1.0.4 (2021-07-19)
  • 5.10. 1.0.3 (2021-01-22)
  • 5.11. 1.0.2 (2020-07-04)
  • 5.12. 1.0.0 (2020-06-04)
  • 5.13. 0.2.2 (2019-09-04)
  • 5.14. 0.2.1 (2019-09-04)
  • 5.15. 0.2.0 (2019-05-25)
  • 5.16. 0.1.5 (2019-02-25)
  • 5.17. 0.1.4 (2019-02-03)
  • 5.18. 0.1.3 (2019-01-22)
  • 5.19. 0.1.1 (2018-12-22)
  • 5.20. 0.0.0 (2018-11-22)
• 6. Credits
  • 6.1. Development Lead
  • 6.2. Contributors

Indices and tables

• Index

• Module Index

• Search Page