Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Pyvale: The Python Validation Engine
Light Logo Dark Logo
Pyvale: The Python Validation Engine
  • Installation
    • Ubuntu Linux
    • MacOS
    • Windows 11
  • Examples
    • Basic Sensor Simulation
      • Quickstart sensor sim
      • Scalar field sensor sim
      • Vector and tensor field sensors
      • Multi-physics experiment simulation
    • DIC
      • Selecting a Region of Interest (ROI)
      • 2D Plate with a Hole
      • Strain and Deformation Gradient Calculations
      • Render a known displacement and recover it with DIC
      • Comparison to the 2.0 2D DIC Challenge
      • HRDIC
      • 2D Incremental DIC
      • Stereo Calibration + DIC
      • Stereo DIC rigid body motion of a plate
      • Stereo DIC and strain calculation of a plate with a hole
      • Stereo Reconstruction from the DIC Challenge 1.0
    • Render 3D
      • Riley: Rendering Quickstart
      • Riley: Speckle sphere
      • Riley: Multi Shader, Multi Element Rabbits
      • Riley: Digital Image Correlation UQ
      • Riley: DIC UQ from Exodus
      • Riley: Stereo Calibration Target
      • Riley: Point spread functions
      • Riley: Feature Zoo
      • Blender: Scene for 2D DIC
      • Blender: 2D Deformation
      • Blender: Stereo Scene
      • Blender: Stereo Camera Calibration & Parameters
      • Blender: Stereo Image Deformation
      • Blender: Calibration Target Render
    • Render UVs
      • Render UVs: Intro and planar projection
      • Render UVs: Texture aspect and fit modes
      • Render UVs: Compare texture boundary modes
      • Render UVs: Projection onto an arbitrary plane
      • Render UVs: Translate, rotate, and scale a mapping
    • Extended Sensor Simulation
      • Bring your own simulation data
      • Mesh-free virtual sensors
      • Scalar field sensors in 2D
      • Scalar field sensors in 3D
      • Vector field sensors in 2D
      • Vector field sensors in 3D
      • Tensor field sensors in 2D
      • Tensor field sensors in 3D
      • Errors: basics
      • Errors: field-based
      • Errors: field-based with angles
      • Errors: field-based position/angle locking
      • Errors: field-based chaining
      • Errors: calibration
      • Errors: spatial averaging
      • Experiment simulation in 2D
      • Experiment simulation in 3D
    • Mooseherder
      • Creating a configuration file
      • Modifying moose input files
      • Modifying gmsh input files
      • Running MOOSE once
      • Running Gmsh once
      • Run Gmsh then MOOSE once
      • Running a parameter sweep of a MOOSE simulation
      • Running a parameter sweep of a Gmsh and MOOSE simulation
      • Using multiple calls to run parallel sweeps
      • Reading exodus output from a MOOSE simulation
      • Reading exodus output from a parameter sweep
      • Read parameter sweep results for a MOOSE simulation
      • Read parameter sweep results for a Gmsh and MOOSE simulation
      • Using read config to extract specific variables from a sweep
      • Reading results from a pre-run parameter sweep
  • User Guide
    • Sensor Simulation User Guide
    • DIC User Guide
    • Blender User Guide
    • Strain Calculation
  • Theory Guide
    • DIC
    • Stereo DIC
  • Developer Guide
    • Design Specification
    • Custom Sensors
    • Python Coding Guide
  • Detailed Python API
    • pyvale.sensorsim
      • pyvale.sensorsim.camera module
      • pyvale.sensorsim.camerasensor module
      • pyvale.sensorsim.cameratools module
      • pyvale.sensorsim.enums module
      • pyvale.sensorsim.errordriftcalc module
      • pyvale.sensorsim.errorintegrator module
      • pyvale.sensorsim.errorrand module
      • pyvale.sensorsim.errorsimulator module
      • pyvale.sensorsim.errorsyscalib module
      • pyvale.sensorsim.errorsysdep module
      • pyvale.sensorsim.errorsysfield module
      • pyvale.sensorsim.errorsysindep module
      • pyvale.sensorsim.exceptions module
      • pyvale.sensorsim.experimentsimio module
      • pyvale.sensorsim.experimentsimulator module
      • pyvale.sensorsim.experimentstats module
      • pyvale.sensorsim.field module
      • pyvale.sensorsim.fieldconverter module
      • pyvale.sensorsim.fieldinterp module
      • pyvale.sensorsim.fieldinterpmesh module
      • pyvale.sensorsim.fieldinterppoints module
      • pyvale.sensorsim.fieldsampler module
      • pyvale.sensorsim.fieldscalar module
      • pyvale.sensorsim.fieldtensor module
      • pyvale.sensorsim.fieldtransform module
      • pyvale.sensorsim.fieldvector module
      • pyvale.sensorsim.generatorsrandom module
      • pyvale.sensorsim.imagetools module
      • pyvale.sensorsim.integratorfactory module
      • pyvale.sensorsim.integratorquadrature module
      • pyvale.sensorsim.integratorrectangle module
      • pyvale.sensorsim.integratorspatial module
      • pyvale.sensorsim.integratortype module
      • pyvale.sensorsim.logger module
      • pyvale.sensorsim.plotting_logs module
      • pyvale.sensorsim.sensorarray module
      • pyvale.sensorsim.sensordata module
      • pyvale.sensorsim.sensordescriptor module
      • pyvale.sensorsim.sensorfactory module
      • pyvale.sensorsim.sensorspoint module
      • pyvale.sensorsim.sensortools module
      • pyvale.sensorsim.simtools module
      • pyvale.sensorsim.visualexpplotter module
      • pyvale.sensorsim.visualimagedef module
      • pyvale.sensorsim.visualimages module
      • pyvale.sensorsim.visualopts module
      • pyvale.sensorsim.visualsimanimator module
      • pyvale.sensorsim.visualsimplotter module
      • pyvale.sensorsim.visualsimsensors module
      • pyvale.sensorsim.visualtools module
      • pyvale.sensorsim.visualtraceanimator module
      • pyvale.sensorsim.visualtraceplotter module
    • pyvale.render
      • pyvale.render.blender package
        • pyvale.render.blender.adapter module
        • pyvale.render.blender.blendertools module
        • pyvale.render.blender.calibration module
        • pyvale.render.blender.config module
        • pyvale.render.blender.shader module
      • pyvale.render.camera module
      • pyvale.render.cameratools module
      • pyvale.render.capabilities module
      • pyvale.render.errors module
      • pyvale.render.feebee module
      • pyvale.render.imagetools module
      • pyvale.render.light module
      • pyvale.render.mesh module
      • pyvale.render.meshtools module
      • pyvale.render.rasterops module
      • pyvale.render.renderer3d module
      • pyvale.render.result module
      • pyvale.render.riley module
      • pyvale.render.scene module
      • pyvale.render.scenetools module
      • pyvale.render.uvtools module
      • pyvale.render.verifyinput module
    • pyvale.calib package
      • pyvale.calib.calibdataclass module
      • pyvale.calib.calibdotdetect module
      • pyvale.calib.calibstereo module
    • pyvale.dic
      • pyvale.dic.dic2d module
      • pyvale.dic.dic3d module
      • pyvale.dic.dicenum module
      • pyvale.dic.dicimport2d module
      • pyvale.dic.dicimport3d module
      • pyvale.dic.dicregionofinterest module
      • pyvale.dic.dicresults module
    • pyvale.strain
      • pyvale.strain.strain2d module
      • pyvale.strain.strain3d module
      • pyvale.strain.strainchecks module
      • pyvale.strain.strainimport module
      • pyvale.strain.strainresults module
    • pyvale.mooseherder
      • pyvale.mooseherder.availability module
      • pyvale.mooseherder.directorymanager module
      • pyvale.mooseherder.exodusloader module
      • pyvale.mooseherder.gmshrunner module
      • pyvale.mooseherder.inputmodifier module
      • pyvale.mooseherder.mooseconfig module
      • pyvale.mooseherder.mooseherd module
      • pyvale.mooseherder.mooserunner module
      • pyvale.mooseherder.outputloader module
      • pyvale.mooseherder.simloadtools module
      • pyvale.mooseherder.simrunner module
      • pyvale.mooseherder.sweeploader module
      • pyvale.mooseherder.sweeptools module
    • pyvale.verif
      • pyvale.verif.analyticmeshgen module
      • pyvale.verif.analyticsimdatafactory module
      • pyvale.verif.analyticsimdatagenerator module
      • pyvale.verif.matchsimdata module
      • pyvale.verif.pointsens module
      • pyvale.verif.pointsensconst module
      • pyvale.verif.pointsensmech module
      • pyvale.verif.pointsensmultiphys module
      • pyvale.verif.pointsensscalar module
      • pyvale.verif.pointsenstensor module
      • pyvale.verif.pointsensvector module
      • pyvale.verif.renderconformance module
      • pyvale.verif.renderverif module
    • pyvale.data
      • pyvale.data.valid package
      • pyvale.data.dataset module
  • Detailed C++ API
    • dic
      • diccoarsefine.hpp
      • diccoursefine.hpp
      • dicfourier.hpp
      • dicinterp.hpp
      • dicinterpBspline.hpp
      • dicinterpHermite.hpp
      • dicinterpfactory.hpp
      • dicmain.hpp
      • dicmultiwindow_only.hpp
      • dicmultiwindow_rg.hpp
      • dicmultiwindow_util.hpp
      • dicoptimizer.hpp
      • dicrasterscan.hpp
      • dicresults.hpp
      • dicrg.hpp
      • dicroiupdate.hpp
      • dicshapefunc.hpp
      • dicsinglewindow_rg.hpp
      • dicsubset.hpp
      • dicutil.hpp
      • stereomatching.hpp
      • stereoutil.hpp
    • strain
      • smooth.hpp
      • strain.hpp
  • Citing PyVale
Back to top
View this page
Edit this page

Detailed Python APIΒΆ

Modules

  • pyvale.sensorsim
  • pyvale.render
  • pyvale.calib package
  • pyvale.dic
  • pyvale.strain
  • pyvale.mooseherder
  • pyvale.verif
  • pyvale.data
Next
pyvale.sensorsim
Previous
Python Coding Guide
Copyright © 2025, The CAV Team
Made with Sphinx and @pradyunsg's Furo