SofastFixed unit tests and test data

contrib/test_data_generation/sofast_fixed/generate_downsampled_calibration_data.py

@@ -1,10 +1,8 @@
-"""Generates downsampled dataset used for calibrating the 3d locations of fixed
-pattern dots.
+"""Generates downsampled dataset for dot_location_calibration
 """
 
 from glob import glob
-from os.path import join, basename
-import shutil
+from os.path import join, basename, abspath
 import sys
 
 import imageio.v3 as imageio
@@ -19,17 +17,14 @@
 def generate_data():
     """Downsamples and saves files"""
     # Define file locations
-    dir_sample_data = join(
-        opencsp_code_dir(), '../../sample_data/deflectometry/calibration_dot_locations/data_measurement'
+    dir_cal_data = join(
+        opencsp_code_dir(), '../../sample_data/deflectometry/sandia_lab/dot_locations_calibration/data_measurement'
     )
 
-    files_images = glob(join(dir_sample_data, 'images/*.JPG'))
-    file_camera_cal = join(dir_sample_data, 'camera_image_calibration.h5')
-    file_point_locs = join(dir_sample_data, 'point_locations.csv')
-    file_camera_def = join(dir_sample_data, 'camera_deflectometry.h5')
-    file_image_def = join(dir_sample_data, 'image_deflectometry_camera.png')
+    files_images = glob(abspath(join(dir_cal_data, 'images/*.JPG')))
+    file_camera_cal = abspath(join(dir_cal_data, 'camera_calibration.h5'))
 
-    dir_save = join(opencsp_code_dir(), 'test/data/measurements_sofast_fixed/dot_location_calibration/measurements')
+    dir_save = join(opencsp_code_dir(), 'test/data/dot_location_calibration')
 
     # Downsample marker/dot images
     n_downsample = 4
@@ -41,19 +36,13 @@ def generate_data():
         im_ds = ddg.downsample_images(im, n_downsample)
         # Save
         file_save = join(dir_save, 'images', basename(file))
-        imageio.imwrite(file_save, im_ds, quality=70)
+        imageio.imwrite(file_save, im_ds, quality=80)
 
     # Downsample cal camera
     print('Downsampling calibration camera...')
     cam_cal = ddg.downsample_camera(file_camera_cal, n_downsample)
     cam_cal.save_to_hdf(join(dir_save, basename(file_camera_cal)))
 
-    # Save other files
-    shutil.copy(file_point_locs, join(dir_save, basename(file_point_locs)))
-    shutil.copy(file_camera_def, join(dir_save, basename(file_camera_def)))
-    shutil.copy(file_image_def, join(dir_save, basename(file_image_def)))
-
 
 if __name__ == '__main__':
     generate_data()
-    print('Done')

example/sofast_fringe/example_calibration_screen_shape.py → example/sofast_calibration/example_calibration_screen_shape.py

@@ -13,30 +13,52 @@
 import opencsp.common.lib.tool.log_tools as lt
 
 
-def run_screen_shape_calibration(save_dir):
-    """Runs screen shape calibration. Saves a DisplayShape HDF5 file
-    to ./data/output/screen_shape/display_shape.h5
+def example_screen_shape_calibration():
+    """Example Sofast calibration script
+
+    Calibrates the 3d shape of a screen:
+    1. Load measured calibration data
+    2. Perform screen shpae calibration
+    3. Save 3d shape data as DisplayShape object
+    4. Save calculation figures
     """
-    # Load output data from Scene Reconstruction (Aruco marker xyz points)
-    file_pts_data = join(
-        opencsp_code_dir(), 'common/lib/deflectometry/test/data/data_measurement', 'point_locations.csv'
+    # General setup
+    # =============
+
+    # Define save directory
+    dir_save = join(dirname(__file__), 'data/output/screen_shape')
+    ft.create_directories_if_necessary(dir_save)
+
+    # Set up logger
+    lt.logger(join(dir_save, 'log.txt'), lt.log.INFO)
+
+    # Define input files
+    file_pts_data = join(opencsp_code_dir(), 'test/data/sofast_common/aruco_corner_locations.csv')
+    file_screen_cal_point_pairs = join(
+        opencsp_code_dir(), 'test/data/display_shape_calibration/data_measurement/screen_calibration_point_pairs.csv'
+    )
+    file_camera_distortion = join(
+        opencsp_code_dir(), 'test/data/display_shape_calibration/data_measurement/camera_screen_shape.h5'
+    )
+    file_image_projection = join(opencsp_code_dir(), 'test/data/sofast_common/image_projection.h5')
+    files_screen_shape_measurement = glob(
+        join(
+            opencsp_code_dir(),
+            'test/data/display_shape_calibration/data_measurement/screen_shape_sofast_measurements/pose_*.h5',
+        )
     )
+
+    # 1. Load measured calibration data
+    # =================================
+
+    # Load output data from Scene Reconstruction (Aruco marker xyz points)
     pts_marker_data = np.loadtxt(file_pts_data, delimiter=',', skiprows=1)
     pts_xyz_marker = Vxyz(pts_marker_data[:, 2:].T)
     corner_ids = pts_marker_data[:, 1]
 
     # Define desired resolution of screen sample grid
     resolution_xy = [100, 100]
 
-    # Define directory where screen shape calibration data is saved
-    base_dir_sofast_cal = join(opencsp_code_dir(), 'app/sofast/test/data/data_measurement')
-
-    # Define input files
-    file_screen_cal_point_pairs = join(base_dir_sofast_cal, 'screen_calibration_point_pairs.csv')
-    file_camera_distortion = join(base_dir_sofast_cal, 'camera_screen_shape.h5')
-    file_image_projection = join(base_dir_sofast_cal, 'image_projection.h5')
-    files_screen_shape_measurement = glob(join(base_dir_sofast_cal, 'screen_shape_sofast_measurements/pose_*.h5'))
-
     # Load input data
     camera = Camera.load_from_hdf(file_camera_distortion)
     image_projection_data = ImageProjection.load_from_hdf(file_image_projection)
@@ -53,36 +75,30 @@ def run_screen_shape_calibration(save_dir):
         [MeasurementSofastFringe.load_from_hdf(f) for f in files_screen_shape_measurement],
     )
 
-    # Perform screen shape calibration
+    # 2. Perform screen shape calibration
+    # ====================================
     cal = CalibrateDisplayShape(data_input)
     cal.make_figures = True
     cal.run_calibration()
 
+    # 3. Save 3d shape data as DisplayShape object
+    # ============================================
+
     # Get screen shape data
     display_shape = cal.as_DisplayShape('Example display shape')
 
     # Save DisplayShape file
-    file = join(save_dir, 'display_shape.h5')
+    file = join(dir_save, 'display_shape.h5')
     display_shape.save_to_hdf(file)
     lt.info(f'Saved DisplayShape file to {file:s}')
 
-    # Save calibration figures
+    # 4. Save calculation figures
+    # ===========================
     for fig in cal.figures:
-        file = join(save_dir, fig.get_label() + '.png')
+        file = join(dir_save, fig.get_label() + '.png')
         lt.info(f'Saving figure to: {file:s}')
         fig.savefig(file)
 
 
-def example_driver():
-    # Define save directory
-    save_path = join(dirname(__file__), 'data/output/screen_shape')
-    ft.create_directories_if_necessary(save_path)
-
-    # Set up logger
-    lt.logger(join(save_path, 'log.txt'), lt.log.INFO)
-
-    run_screen_shape_calibration(save_path)
-
-
 if __name__ == '__main__':
-    example_driver()
+    example_screen_shape_calibration()

example/sofast_fringe/example_calibration_spatial_orientation.py → example/sofast_calibration/example_calibration_spatial_orientation.py

@@ -13,18 +13,34 @@
 import opencsp.common.lib.tool.log_tools as lt
 
 
-def run_camera_position_calibration(save_dir):
-    """Calibrates the position of the Sofast camera. Saves the rvec/tvec that
-    define the relative pose of the camera/screen in a SpatialOrientation file
-    at ./data/output/spatial_orientation.h5
+def example_camera_position_calibration():
+    """Example Sofast calibration script
+
+    Calibrates the position of the Sofast camera:
+    1. Load measured calibration data
+    2. Perform camera position calibration
+    3. Save orientation as SpatialOrientation object
+    4. Save calculation figures
     """
-    # Define directory where screen shape calibration data is saved
-    base_dir_sofast_cal = join(opencsp_code_dir(), 'common/lib/deflectometry/test/data/data_measurement')
+    # General setup
+    # =============
+
+    # Define save dir
+    dir_save = join(dirname(__file__), 'data/output/camera_pose')
+    ft.create_directories_if_necessary(dir_save)
+
+    # Set up logger
+    lt.logger(join(dir_save, 'log.txt'), lt.log.INFO)
 
     # Define inputs
-    file_camera_sofast = join(base_dir_sofast_cal, 'camera_sofast.h5')
-    file_cal_image = join(base_dir_sofast_cal, 'image_sofast_camera.png')
-    file_pts_data = join(base_dir_sofast_cal, 'point_locations.csv')
+    file_camera_sofast = join(opencsp_code_dir(), 'test/data/sofast_common/camera_sofast.h5')
+    file_cal_image = join(
+        opencsp_code_dir(), 'test/data/camera_position_calibration/data_measurement/image_sofast_camera.png'
+    )
+    file_pts_data = join(opencsp_code_dir(), 'test/data/sofast_common/aruco_corner_locations.csv')
+
+    # 1. Load measured calibration data
+    # =================================
 
     # Load input data
     camera = Camera.load_from_hdf(file_camera_sofast)
@@ -35,11 +51,15 @@ def run_camera_position_calibration(save_dir):
     pts_xyz_marker = Vxyz(pts_marker_data[:, 2:].T)
     corner_ids = pts_marker_data[:, 1]
 
-    # Perform camera position calibraiton
+    # 2. Perform camera position calibration
+    # ======================================
     cal = CalibrationCameraPosition(camera, pts_xyz_marker, corner_ids, image)
     cal.make_figures = True
     cal.run_calibration()
 
+    # 3. Save orientation as SpatialOrientation object
+    # ================================================
+
     # Get orientation
     r_screen_cam, v_cam_screen_screen = cal.get_data()
     r_screen_cam = Rotation.from_rotvec(r_screen_cam)
@@ -52,25 +72,15 @@ def run_camera_position_calibration(save_dir):
     orientation = SpatialOrientation(r_cam_screen, v_cam_screen_cam)
 
     # Save data
-    orientation.save_to_hdf(join(save_dir, 'spatial_orientation.h5'))
+    orientation.save_to_hdf(join(dir_save, 'spatial_orientation.h5'))
 
-    # Save figures
+    # 4. Save calculation figures
+    # ===========================
     for fig in cal.figures:
-        file = join(save_dir, fig.get_label() + '.png')
+        file = join(dir_save, fig.get_label() + '.png')
         lt.info(f'Saving figure to: {file:s}')
         fig.savefig(file)
 
 
-def example_driver():
-    # Define save dir
-    save_path = join(dirname(__file__), 'data/output/camera_pose')
-    ft.create_directories_if_necessary(save_path)
-
-    # Set up logger
-    lt.logger(join(save_path, 'log.txt'))
-
-    run_camera_position_calibration(save_path)
-
-
 if __name__ == '__main__':
-    example_driver()
+    example_camera_position_calibration()

example/sofast_fringe/example_process_facet_ensemble.py

@@ -19,36 +19,52 @@
 import opencsp.common.lib.tool.log_tools as lt
 
 
-def example(dir_save: str):
-    """Example SOFAST script
-
-    Performs processing of previously collected Sofast data of multi facet mirror ensemble.
-        1. Loads saved "multi-facet" SOFAST collection data
-        2. Processes data with SOFAST (without using facet file)
-        3. Logs best-fit parabolic focal lengths
-        4. Plots slope magnitude, physical setup
+def example_process_facet_ensemble():
+    """Example Sofast script
+
+    Performs processing of previously collected Sofast data of multi facet mirror ensemble:
+    1. Load saved facet ensemble Sofast collection data
+    2. Processes data with Sofast
+    3. Log best-fit parabolic focal lengths
+    4. Plot slope magnitude
+    5. Plot 3d representation of facet ensemble
+    6. Save slope data as HDF5 file
     """
+    # General setup
+    # =============
+
+    # Define save dir
+    dir_save = join(dirname(__file__), 'data/output/facet_ensemble')
+    ft.create_directories_if_necessary(dir_save)
+
+    # Set up logger
+    lt.logger(join(dir_save, 'log.txt'), lt.log.INFO)
 
     # Define sample data directory
-    sample_data_dir = join(opencsp_code_dir(), 'test/data/measurements_sofast_fringe/')
+    dir_data_sofast = join(opencsp_code_dir(), 'test/data/sofast_fringe')
+    dir_data_common = join(opencsp_code_dir(), 'test/data/sofast_common')
 
     # Directory setup
-    file_measurement = join(sample_data_dir, 'measurement_ensemble.h5')
-    file_camera = join(sample_data_dir, 'camera.h5')
-    file_display = join(sample_data_dir, 'display_distorted_2d.h5')
-    file_orientation = join(sample_data_dir, 'spatial_orientation.h5')
-    file_calibration = join(sample_data_dir, 'image_calibration.h5')
-    file_facet = join(sample_data_dir, 'Facet_lab_6x4.json')
-    file_ensemble = join(sample_data_dir, 'Ensemble_lab_6x4.json')
-
-    # Load data
+    file_measurement = join(dir_data_sofast, 'data_measurement/measurement_ensemble.h5')
+    file_camera = join(dir_data_common, 'camera_sofast_downsampled.h5')
+    file_display = join(dir_data_common, 'display_distorted_2d.h5')
+    file_orientation = join(dir_data_common, 'spatial_orientation.h5')
+    file_calibration = join(dir_data_sofast, 'data_measurement/image_calibration.h5')
+    file_facet = join(dir_data_common, 'Facet_lab_6x4.json')
+    file_ensemble = join(dir_data_common, 'Ensemble_lab_6x4.json')
+
+    # 1. Load saved single facet Sofast collection data
+    # =================================================
     camera = Camera.load_from_hdf(file_camera)
     display = Display.load_from_hdf(file_display)
     orientation = SpatialOrientation.load_from_hdf(file_orientation)
     measurement = MeasurementSofastFringe.load_from_hdf(file_measurement)
     calibration = ImageCalibrationScaling.load_from_hdf(file_calibration)
     ensemble_data = DefinitionEnsemble.load_from_json(file_ensemble)
 
+    # 2. Process data with Sofast
+    # ===========================
+
     # Define facet data
     facet_data = [DefinitionFacet.load_from_json(file_facet)] * ensemble_data.num_facets
 
@@ -73,12 +89,16 @@ def example(dir_save: str):
     # Process
     sofast.process_optic_multifacet(facet_data, ensemble_data, surface_data)
 
-    # Calculate focal length from parabolic fit
+    # 3. Log best-fit parabolic focal lengths
+    # =======================================
     for idx in range(sofast.num_facets):
         surf_coefs = sofast.data_characterization_facet[idx].surf_coefs_facet
         focal_lengths_xy = [1 / 4 / surf_coefs[2], 1 / 4 / surf_coefs[5]]
         lt.info(f'Facet {idx:d} xy focal lengths (meters): {focal_lengths_xy[0]:.3f}, {focal_lengths_xy[1]:.3f}')
 
+    # 4. Plot slope magnitude
+    # =======================
+
     # Get optic representation
     ensemble: FacetEnsemble = sofast.get_optic()
 
@@ -87,31 +107,22 @@ def example(dir_save: str):
     mirror_control = rcm.RenderControlMirror(centroid=True, surface_normals=True, norm_res=1)
     axis_control_m = rca.meters()
 
-    # Plot scenario
-    fig_record = fm.setup_figure_for_3d_data(figure_control, axis_control_m, title='Facet Ensemble')
-    ensemble.draw(fig_record.view, mirror_control)
-    fig_record.axis.axis('equal')
-    fig_record.save(dir_save, 'facet_ensemble', 'png')
-
     # Plot slope map
     fig_record = fm.setup_figure(figure_control, axis_control_m, title='')
     ensemble.plot_orthorectified_slope(res=0.002, clim=7, axis=fig_record.axis)
     fig_record.save(dir_save, 'slope_magnitude', 'png')
 
-    # Save data (optionally)
-    sofast.save_to_hdf(f'{dir_save}/data_multifacet.h5')
-
-
-def example_driver():
-    # Define save dir
-    save_path = join(dirname(__file__), 'data/output/facet_ensemble')
-    ft.create_directories_if_necessary(save_path)
-
-    # Set up logger
-    lt.logger(join(save_path, 'log.txt'), lt.log.INFO)
+    # 5. Plot 3d representation of facet ensemble
+    # ===========================================
+    fig_record = fm.setup_figure_for_3d_data(figure_control, axis_control_m, title='Facet Ensemble')
+    ensemble.draw(fig_record.view, mirror_control)
+    fig_record.axis.axis('equal')
+    fig_record.save(dir_save, 'facet_ensemble', 'png')
 
-    example(save_path)
+    # 6. Save slope data as HDF5 file
+    # ===============================
+    sofast.save_to_hdf(f'{dir_save}/data_multifacet.h5')
 
 
 if __name__ == '__main__':
-    example_driver()
+    example_process_facet_ensemble()