moirestrain documentation

Version:

0.1.1

moirestrain is a NumPy-first package for sampling moire analysis of periodic grating images. It targets full-field micro-displacement and micro-strain measurement from reference and deformed images.

The package focuses on the grid/phase-based metrology workflow: generating phase-shifted moire images, estimating wrapped phase, unwrapping phase, calculating displacement fields, and deriving strain fields.

Content

• Project scope
  • Primary goals
  • Relationship to other tools
• Installation
  • Development install
  • Dependencies
• Tutorials
  • 01. Square-Grid Analysis
  • 02. Partial-Grid Detection
  • 03. Four-Corner Rectification
• Tutorial
  • Basic displacement analysis
  • Synthetic example
  • Synthetic experimental data
  • Front-facing square-marker microstrain target
  • Command line analysis
  • Strain distribution example
  • Perspective rectification and partial grating ROI
  • Partial-grid detection and oblique-grid rectification
  • Choosing the axis
• Theory notes
  • Sampling moire phase
  • Square-marker grid targets
  • Displacement from phase difference
  • Strain field direction
  • Perspective rectification
• Citation
  • Method reference
• API reference
  • AnalysisResult
  • GratingROI
  • GridAnalysisResult
  • PerspectiveCalibration
  • StrainResult
  • SyntheticExperiment
  • SyntheticSquareGridExperiment
  • SyntheticStrainExperiment
  • analyze()
  • analyze_grid()
  • apply_homography()
  • apply_valid_mask()
  • crop_grating_roi()
  • crop_roi()
  • crop_to_mask()
  • detect_grating_roi()
  • displacement()
  • grating_energy()
  • homography_from_points()
  • inner_valid_mask()
  • load_grayscale_image()
  • make_microstrain_experiment()
  • make_microstrain_square_grid()
  • make_strain_distribution_experiment()
  • mask_bounds()
  • phase_shifted_sampling_moire()
  • phase_shifted_stack()
  • pixel_spacing_from_world_points()
  • recommended_strain_smoothing_window()
  • rectangle_points()
  • rectify_image()
  • rectify_image_pair()
  • resample_oblique_grid()
  • robust_limits()
  • sample_bilinear()
  • save_analysis_npz()
  • save_experiment_npz()
  • save_grayscale_image()
  • save_grid_analysis_figure()
  • save_grid_truth_comparison_figure()
  • save_square_grid_experiment_npz()
  • save_strain_experiment_npz()
  • separate_grid_components()
  • smooth_axis()
  • strain_field()
  • unwrap_phase()
  • warp_perspective()
  • wrapped_phase()
  • Core module
  • Synthetic data
  • Geometry
  • ROI detection
  • Masking and display helpers