pyvale package¶
Subpackages¶
- pyvale.blender
- blendercalibrationdata.py
- blenderexceptions.py
- blenderlightdata.py
- blendermaterialdata.py
- blenderrenderdata.py
- blenderscene.py
- blendertools.py
ToolsTools.save_blender_file()Tools.move_blender_obj()Tools.rotate_blender_obj()Tools.set_new_frame()Tools.deform_single_timestep()Tools.clear_material_nodes()Tools.uv_unwrap_part()Tools.add_image_texture()Tools.save_render_as_array()Tools.number_calibration_images()Tools.render_calibration_images()Tools.check_for_GPU()
- pyvale.dataset
- dataset.py
SIM_CASE_COUNTEElemTestDataSetErrorsim_case_input_file_path()sim_case_gmsh_file_path()dic_pattern_5mpx_path()thermal_2d_path()thermal_3d_path()mechanical_2d_path()thermomechanical_2d_path()thermomechanical_3d_path()thermomechanical_2d_experiment_paths()render_mechanical_3d_path()render_simple_block_path()element_case_input_path()element_case_output_path()dic_plate_with_hole_ref()dic_plate_with_hole_def()dic_plate_rigid_ref()dic_plate_rigid_def()dic_challenge_ref()dic_challenge_def()cal_target()
- dataset.py
- pyvale.dic
- dic2d.py
- dic2dconv.py
- dicchecks.py
- dicdataimport.py
- dicregionofinterest.py
RegionOfInterestRegionOfInterest.__init__()RegionOfInterest.interactive_selection()RegionOfInterest.reset_mask()RegionOfInterest.rect_boundary()RegionOfInterest.rect_region()RegionOfInterest.save_image()RegionOfInterest.save_array()RegionOfInterest.read_array()RegionOfInterest.save_yaml()RegionOfInterest.read_yaml()RegionOfInterest.show_image()
CustomMainWindow
- dicresults.py
- dicspecklegenerator.py
- dicspecklequality.py
DICSpeckleQualityDICSpeckleQuality.__init__()DICSpeckleQuality.mean_intensity_gradient()DICSpeckleQuality.shannon_entropy()DICSpeckleQuality.gray_level_histogram()DICSpeckleQuality.speckle_size()DICSpeckleQuality.speckle_size_plot()DICSpeckleQuality.balance_subset()DICSpeckleQuality.balance_image()DICSpeckleQuality.balance_subset_avg()DICSpeckleQuality.balance_subset_plot()
extract_subset()
- dicstrain.py
- dicstrainresults.py
- pyvale.examples package
- pyvale.mooseherder
- directorymanager.py
DirectoryManagerDirectoryManager.__init__()DirectoryManager.set_sub_dir_name()DirectoryManager.set_base_dir()DirectoryManager.get_output_key_tag()DirectoryManager.get_sweep_var_tag()DirectoryManager.create_dirs()DirectoryManager.clear_dirs()DirectoryManager.reset_dirs()DirectoryManager.get_all_run_dirs()DirectoryManager.get_run_dir()DirectoryManager.set_output_paths()DirectoryManager.get_output_paths()DirectoryManager.get_output_key_file()DirectoryManager.write_output_key()DirectoryManager.get_sweep_var_file()DirectoryManager.write_sweep_vars()
output_paths_to_str()output_str_to_paths()
- exodusreader.py
ExodusReaderExodusReader.__init__()ExodusReader.get_names()ExodusReader.get_var()ExodusReader.get_key()ExodusReader.get_connectivity_names()ExodusReader.get_connectivity()ExodusReader.get_sideset_names()ExodusReader.get_sidesets()ExodusReader.get_all_sidesets()ExodusReader.get_node_var_names()ExodusReader.get_node_vars()ExodusReader.get_all_node_vars()ExodusReader.get_elem_var_names()ExodusReader.get_num_elem_blocks()ExodusReader.get_elem_var_names_and_blocks()ExodusReader.get_elem_vars()ExodusReader.get_all_elem_vars()ExodusReader.get_glob_var_names()ExodusReader.get_glob_vars()ExodusReader.get_all_glob_vars()ExodusReader.get_coords()ExodusReader.get_time()ExodusReader.print_vars()ExodusReader.get_read_config()ExodusReader.read_sim_data()ExodusReader.read_all_sim_data()
- gmshrunner.py
- inputmodifier.py
- mooseconfig.py
- mooseherd.py
MooseHerdErrorMooseHerdMooseHerd.__init__()MooseHerd.set_input_copy_names()MooseHerd.set_keep_flag()MooseHerd.set_num_para_sims()MooseHerd.get_sim_iter()MooseHerd.get_sweep_iter()MooseHerd.reset_iter_counts()MooseHerd.run_once()MooseHerd.run_sequential()MooseHerd.run_para()MooseHerd.get_sweep_time()MooseHerd.get_iter_time()
- mooserunner.py
MooseRunnerMooseRunner.__init__()MooseRunner.set_env_vars()MooseRunner.set_threads()MooseRunner.set_tasks()MooseRunner.set_stdout()MooseRunner.set_run_opts()MooseRunner.get_input_file()MooseRunner.set_input_file()MooseRunner.get_input_dir()MooseRunner.get_input_tag()MooseRunner.get_output_path()MooseRunner.get_arg_list()MooseRunner.assemble_arg_list()MooseRunner.run()
- outputreader.py
- simdata.py
- simrunner.py
- sweepreader.py
- sweeptools.py
- directorymanager.py
- pyvale.sensorsim
- camera.py
CameraBasic2DCameraBasic2D.__init__()CameraBasic2D.get_sample_times()CameraBasic2D.get_measurement_shape()CameraBasic2D.get_image_measurements_shape()CameraBasic2D.get_field()CameraBasic2D.get_descriptor()CameraBasic2D.calc_truth_values()CameraBasic2D.get_truth()CameraBasic2D.set_error_integrator()CameraBasic2D.get_errors_systematic()CameraBasic2D.get_errors_random()CameraBasic2D.get_errors_total()CameraBasic2D.calc_measurements()CameraBasic2D.get_measurements()CameraBasic2D.calc_measurement_images()CameraBasic2D.get_measurement_images()
- cameradata.py
CameraDataCameraData.pixels_numCameraData.pixels_sizeCameraData.pos_worldCameraData.rot_worldCameraData.roi_cent_worldCameraData.focal_lengthCameraData.sub_sampCameraData.bitsCameraData.back_face_removalCameraData.k1CameraData.k2CameraData.k3CameraData.p1CameraData.p2CameraData.c0CameraData.c1CameraData.fstopCameraData.sensor_sizeCameraData.image_dimsCameraData.image_distCameraData.cam_to_world_matCameraData.world_to_cam_matCameraData.__init__()
- cameradata2d.py
CameraData2DCameraData2D.pixels_countCameraData2D.leng_per_pxCameraData2D.bitsCameraData2D.roi_cent_worldCameraData2D.backgroundCameraData2D.sample_timesCameraData2D.angleCameraData2D.subsampleCameraData2D.field_of_viewCameraData2D.dynamic_rangeCameraData2D.world_to_camCameraData2D.cam_to_worldCameraData2D.__init__()
- camerasensor.py
- camerastereo.py
- cameratools.py
CameraToolsCameraTools.pixel_vec_px()CameraTools.pixel_grid_px()CameraTools.vectorise_pixel_grid_px()CameraTools.subpixel_vec_px()CameraTools.subpixel_grid_px()CameraTools.vectorise_subpixel_grid_px()CameraTools.pixel_vec_leng()CameraTools.pixel_grid_leng()CameraTools.vectorise_pixel_grid_leng()CameraTools.subpixel_vec_leng()CameraTools.subpixel_grid_leng()CameraTools.vectorise_subpixel_grid_leng()CameraTools.calc_resolution_from_sim_2d()CameraTools.calc_roi_cent_from_sim_2d()CameraTools.crop_image_rectangle()CameraTools.average_subpixel_image()CameraTools.build_sensor_data_from_camera_2d()CameraTools.fov_from_cam_rot_3d()CameraTools.image_dist_from_fov_3d()CameraTools.pos_fill_frame()CameraTools.pos_fill_frame_all()CameraTools.calculate_FOV()CameraTools.blender_FOV()CameraTools.calculate_mm_px_resolution()CameraTools.focal_length_from_resolution()CameraTools.blender_camera_from_resolution()CameraTools.symmetric_stereo_cameras()CameraTools.faceon_stereo_cameras()
- errorcalculator.py
- errordriftcalc.py
- errorintegrator.py
ErrIntOptsErrIntegratorErrIntegrator.__init__()ErrIntegrator.set_error_chain()ErrIntegrator.calc_errors_from_chain()ErrIntegrator.get_errs_by_chain()ErrIntegrator.get_sens_data_by_chain()ErrIntegrator.get_sens_data_accumulated()ErrIntegrator.get_errs_systematic()ErrIntegrator.get_errs_random()ErrIntegrator.get_errs_total()
- errorrand.py
- errorsyscalib.py
- errorsysdep.py
- errorsysfield.py
ErrFieldDataErrFieldData.pos_offset_xyzErrFieldData.ang_offset_zyxErrFieldData.time_offsetErrFieldData.pos_rand_xyzErrFieldData.ang_rand_zyxErrFieldData.time_randErrFieldData.spatial_averagerErrFieldData.spatial_dimsErrFieldData.pos_lock_xyzErrFieldData.ang_lock_zyxErrFieldData.time_driftErrFieldData.__init__()
ErrSysField
- errorsysindep.py
- exceptions.py
- experimentsimulator.py
- field.py
- fieldconverter.py
- fieldinterp.py
- fieldinterpmesh.py
- fieldinterppoints.py
- fieldsampler.py
- fieldscalar.py
- fieldtensor.py
- fieldtransform.py
- fieldvector.py
- generatorsrandom.py
- imagedef2d.py
ImageDefOptsImageDefOpts.save_pathImageDefOpts.save_tagImageDefOpts.mask_input_imageImageDefOpts.crop_onImageDefOpts.crop_pxImageDefOpts.calc_res_from_feImageDefOpts.calc_res_border_pxImageDefOpts.add_static_refImageDefOpts.fe_interpImageDefOpts.fe_rescaleImageDefOpts.fe_extrap_outside_fovImageDefOpts.image_def_orderImageDefOpts.image_def_extrapImageDefOpts.image_def_extvalImageDefOpts.def_complex_geomImageDefOpts.__init__()
ImageDef2D
- imagetools.py
- integratorfactory.py
- integratorquadrature.py
- integratorrectangle.py
- integratorspatial.py
- integratortype.py
- output.py
- raster.py
- rastercy.py
- rasternp.py
RasterNumpyRasterNPRasterNP.world_to_raster_coords()RasterNP.back_face_removal_mask()RasterNP.crop_and_bound_by_connect()RasterNP.elem_bound_box_low()RasterNP.elem_bound_box_high()RasterNP.average_buffers()RasterNP.setup_frame()RasterNP.raster_elem()RasterNP.raster_one_mesh()RasterNP.raster_frame()RasterNP.raster_scene()
edge_function()edge_function_slice()
- rasteropts.py
- renderer.py
- rendermesh.py
RenderMeshRenderMesh.__init__()RenderMesh.coordsRenderMesh.connectivityRenderMesh.fields_renderRenderMesh.fields_dispRenderMesh.node_countRenderMesh.elem_countRenderMesh.nodes_per_elemRenderMesh.pos_worldRenderMesh.rot_worldRenderMesh.mesh_to_world_matRenderMesh.world_to_mesh_matRenderMesh.set_pos()RenderMesh.set_rot()
create_render_mesh()
- renderscene.py
- sensorarray.py
- sensorarrayfactory.py
- sensorarraypoint.py
SensorArrayPointSensorArrayPoint.__init__()SensorArrayPoint.get_sample_times()SensorArrayPoint.get_measurement_shape()SensorArrayPoint.get_field()SensorArrayPoint.calc_truth_values()SensorArrayPoint.get_truth()SensorArrayPoint.set_error_integrator()SensorArrayPoint.get_sensor_data_perturbed()SensorArrayPoint.get_errors_systematic()SensorArrayPoint.get_errors_random()SensorArrayPoint.get_errors_total()SensorArrayPoint.calc_measurements()SensorArrayPoint.get_measurements()
- sensordata.py
- sensordescriptor.py
- sensortools.py
- simtools.py
- visualexpplotter.py
- visualimagedef.py
- visualimages.py
- visualopts.py
PlotOptsGeneralPlotOptsGeneral.aspect_ratioPlotOptsGeneral.single_fig_scalePlotOptsGeneral.resolutionPlotOptsGeneral.font_def_weightPlotOptsGeneral.font_def_sizePlotOptsGeneral.font_tick_sizePlotOptsGeneral.font_head_sizePlotOptsGeneral.font_ax_sizePlotOptsGeneral.font_leg_sizePlotOptsGeneral.msPlotOptsGeneral.lwPlotOptsGeneral.cmap_seqPlotOptsGeneral.cmap_divPlotOptsGeneral.colorsPlotOptsGeneral.a4_widthPlotOptsGeneral.a4_heightPlotOptsGeneral.a4_margin_widthPlotOptsGeneral.a4_margin_heightPlotOptsGeneral.font_namePlotOptsGeneral.a4_print_widthPlotOptsGeneral.a4_print_heightPlotOptsGeneral.single_fig_size_squarePlotOptsGeneral.single_fig_size_portraitPlotOptsGeneral.single_fig_size_landscapePlotOptsGeneral.colors_numPlotOptsGeneral.__init__()
TraceOptsSensorEExpVisCentreEExpVisBoundsTraceOptsExperimentTraceOptsExperiment.legend_locTraceOptsExperiment.x_labelTraceOptsExperiment.y_labelTraceOptsExperiment.z_labelTraceOptsExperiment.__init__()TraceOptsExperiment.time_labelTraceOptsExperiment.truth_lineTraceOptsExperiment.sim_lineTraceOptsExperiment.exp_centre_lineTraceOptsExperiment.exp_marker_lineTraceOptsExperiment.sensors_to_plotTraceOptsExperiment.time_min_maxTraceOptsExperiment.centreTraceOptsExperiment.fill_betweenTraceOptsExperiment.fill_scaleTraceOptsExperiment.plot_all_exp_points
VisOptsSimSensorsVisOptsSimSensors.__init__()VisOptsSimSensors.window_size_pxVisOptsSimSensors.camera_positionVisOptsSimSensors.show_edgesVisOptsSimSensors.interactiveVisOptsSimSensors.font_colourVisOptsSimSensors.background_colourVisOptsSimSensors.time_label_posVisOptsSimSensors.time_label_font_sizeVisOptsSimSensors.colour_bar_showVisOptsSimSensors.colour_bar_font_sizeVisOptsSimSensors.colour_bar_limsVisOptsSimSensors.colour_bar_verticalVisOptsSimSensors.show_perturbed_posVisOptsSimSensors.sens_colour_nomVisOptsSimSensors.sens_colour_pertVisOptsSimSensors.sens_point_sizeVisOptsSimSensors.sens_label_font_sizeVisOptsSimSensors.sens_label_colour
EImageTypeVisOptsImageSaveEAnimationTypeVisOptsAnimation
- visualsimanimator.py
- visualsimplotter.py
- visualsimsensors.py
- visualtools.py
- visualtraceplotter.py
- camera.py
- pyvale.verif
- analyticmeshgen.py
- analyticsimdatafactory.py
- analyticsimdatagenerator.py
AnalyticData2DAnalyticData2D.length_xAnalyticData2D.length_yAnalyticData2D.num_elem_xAnalyticData2D.num_elem_yAnalyticData2D.time_stepsAnalyticData2D.field_keysAnalyticData2D.funcs_xAnalyticData2D.funcs_yAnalyticData2D.funcs_tAnalyticData2D.symbolsAnalyticData2D.offsets_spaceAnalyticData2D.offsets_timeAnalyticData2D.nodes_per_elemAnalyticData2D.__init__()
AnalyticSimDataGenAnalyticSimDataGen.__init__()AnalyticSimDataGen.case_dataAnalyticSimDataGen.coordsAnalyticSimDataGen.connectAnalyticSimDataGen.field_sym_funcsAnalyticSimDataGen.field_lam_funcsAnalyticSimDataGen.field_evalAnalyticSimDataGen.evaluate_field_truth()AnalyticSimDataGen.evaluate_all_fields_truth()AnalyticSimDataGen.evaluate_field_at_nodes()AnalyticSimDataGen.evaluate_all_fields_at_nodes()AnalyticSimDataGen.generate_sim_data()AnalyticSimDataGen.get_visualisation_grid()
- psens.py
- psensconst.py
- psensmech.py
- psensmultiphys.py
- psensscalar.py
simdata_2d()simdata_3d()sens_pos_2d()sens_pos_3d()sens_pos_2d_lock()sens_pos_3d_lock()sens_data_2d_dict()sens_data_3d_dict()err_chain_sfield()err_chain_sfield_dep()calib_assumed()calib_truth()err_chain_calib()err_chain_2d_dict()err_chain_3d_dict()sens_noerrs()gen_sens_dict_2d()gen_sens_dict_3d()sens_2d_dict()sens_3d_dict()
- psenstensor.py
- psensvector.py
Module contents¶
The python validation engine (pyvale) is your virtual engineering laboratory: An all-in-one package for sensor simulation, sensor uncertainty quantification, sensor placement optimisation and simulation calibration/validation. Used to simulate experimental data from an input multi-physics simulation by explicitly modelling sensors with realistic uncertainties. Useful for experimental design, sensor placement optimisation, testing simulation validation metrics and virtually testing digital shadows/twins.