API Reference

This section provides detailed documentation for all modules, classes, and functions in the photoelastimetry package.

Core Modules

• disk - Elastic disk solution and photoelastic simulation
• image - Image processing and Mueller matrix operations
• io - Input/output operations for images and data
• main - Command-line interface entry points
• plotting - Visualization utilities and colormaps

Optimiser Modules

The optimiser subpackage provides three complementary approaches for stress field recovery:

• optimiser - Main optimiser module with high-level API
• optimiser.stokes - Stokes-based pixel-wise inversion
• optimiser.intensity - Intensity-based pixel-wise inversion
• optimiser.equilibrium - Global equilibrium-based inversion

Quick Links

Most Common Functions

Stress Analysis: - solver.recover_stress_map_stokes() - Primary method for stress recovery - solver.compute_stokes_components() - Compute Stokes parameters - solver.compute_normalized_stokes() - Normalize Stokes components

Image Processing: - image.compute_retardance() - Calculate optical retardance - image.compute_principal_angle() - Calculate principal stress angle - image.mueller_matrix() - Generate Mueller matrices

Simulation: - disk.simulate_four_step_polarimetry() - Simulate photoelastic response

See individual module pages for complete documentation.