Sofast examples modifications #166

braden6521 · 2024-08-29T22:44:00Z

Modified the Sofast Fringe examples to output directories with

Projected images
Captured images
Processed data files
Processed image visualizations

Updated the sofast facet ensemble unit test data that the multifacet example uses. (And the associated unit test itself)

NOTE:

Depends on #163

e10harvey

Partial review.

e10harvey · 2024-10-09T22:59:28Z

example/sofast_fringe/example_process_facet_ensemble.py

+This script performs the following steps:
+1. Load saved facet ensemble SOFAST collection data from an HDF5 file.
+2. Save projected sinusoidal fringe images to PNG format.
+3. Save captured sinusoidal fringe images and mask images to PNG format.
+4. Process data with SOFAST and save processed data to HDF5.
+5. Generate a suite of plots and save image files.
+
+Examples
+--------
+To run the script, simply execute it as a standalone program:
+
+>>> python example_process_facet_ensemble.py
+
+This will perform the processing steps and save the results to the data/output/single_facet directory
+with the following subfolders:
+1_images_fringes_projected - The patterns sent to the display during the SOFAST measurement of the optic.
+2_images_captured - The captured images of the displayed patterns as seen by the SOFAST camera
+3_processed_data - The processed data from SOFAST.
+4_processed_output_figures - The output figure suite from a SOFAST characterization.
+
+Notes
+-----
+- The script assumes that the input data files are located in the specified directories.
+- Chat GPT 40 assisted with the generation of some docstrings in this file."""


Suggested change

This script performs the following steps:

1. Load saved facet ensemble SOFAST collection data from an HDF5 file.

2. Save projected sinusoidal fringe images to PNG format.

3. Save captured sinusoidal fringe images and mask images to PNG format.

4. Process data with SOFAST and save processed data to HDF5.

5. Generate a suite of plots and save image files.

Examples

--------

To run the script, simply execute it as a standalone program:

>>> python example_process_facet_ensemble.py

This will perform the processing steps and save the results to the data/output/single_facet directory

with the following subfolders:

1_images_fringes_projected - The patterns sent to the display during the SOFAST measurement of the optic.

2_images_captured - The captured images of the displayed patterns as seen by the SOFAST camera

3_processed_data - The processed data from SOFAST.

4_processed_output_figures - The output figure suite from a SOFAST characterization.

Notes

-----

- The script assumes that the input data files are located in the specified directories.

- Chat GPT 40 assisted with the generation of some docstrings in this file."""

This script performs the following steps:

1. Load saved facet ensemble SOFAST collection data from an HDF5 file.

2. Save projected sinusoidal fringe images to PNG format.

3. Save captured sinusoidal fringe images and mask images to PNG format.

4. Process data with SOFAST and save processed data to HDF5.

5. Generate a suite of plots and save image files.

Examples

--------

To run the script, simply execute it as a standalone program:

>>> python example_process_facet_ensemble.py

This will perform the processing steps and save the results to the data/output/single_facet directory

with the following subfolders:

1_images_fringes_projected - The patterns sent to the display during the SOFAST measurement of the optic.

2_images_captured - The captured images of the displayed patterns as seen by the SOFAST camera

3_processed_data - The processed data from SOFAST.

4_processed_output_figures - The output figure suite from a SOFAST characterization.

Notes

-----

- The script assumes that the input data files are located in the specified directories.

- Chat GPT 40 assisted with the generation of some docstrings in this file."""

bbean23

I have just a few comments. Please address them and make changes as necessary.

bbean23 · 2024-10-11T17:27:16Z

opencsp/common/lib/csp/FacetEnsemble.py

-        The function for setting the positions of the facets relative to one another.
-
+        """Sets the positions of the facets relative to the ensemble.
+        NOTE: Will remove previously set facet canting rotations


if set_facet_positions() removes the canting, and set_facet_canting() removes the position, then how does both the position and canting get set at the same time?

That is done by set_facet_transform_list
Not very intuitive. Maybe the focus of a future PR?

That's a reasonable answer. Added a new issue #188

bbean23 · 2024-10-11T17:28:13Z

opencsp/common/lib/csp/FacetEnsemble.py

@@ -219,6 +205,9 @@ def set_facet_positions(self, positions: Pxyz):
            facet._self_to_parent_transform = TransformXYZ.from_V(pos)

    def set_facet_canting(self, canting_rotations: list[Rotation]):
+        """Sets facet canting relative to ensemble.


Does this apply to a single facet or multiple facets? In other words, should this be changed to "set_facet_cantings"?

bbean23 · 2024-10-11T17:29:17Z

opencsp/common/lib/csp/OpticOrientationAbstract.py



-class OpticOrientationAbstract(ABC):


Why remove the ABC (Abstract Base Class) inheritance? I'd have thought we would want that inheritance for any abstract class.

Fixed in another PR it looks like

bbean23 · 2024-10-11T17:29:33Z

opencsp/common/lib/csp/OpticOrientationAbstract.py

@@ -104,14 +101,13 @@ def add_child(self, new_child: 'OpticOrientationAbstract', new_child_to_self_tra

    @property
    def parent(self) -> 'OpticOrientationAbstract':
-        """..."""
+        """The parent of the current Optic"""


e10harvey · 2024-11-11T16:13:15Z

@braden6521: Please address existing feedback and resolve conflicts

braden6521 · 2024-11-11T19:33:13Z

@e10harvey, @bbean23: Thanks for the reviews both. Changes have been made.

…gure suite.

bbean23

Thanks for addressing all the feedback. Approved!

braden6521 added the enhancement New feature or request label Aug 29, 2024

braden6521 self-assigned this Aug 29, 2024

braden6521 marked this pull request as ready for review August 29, 2024 23:06

braden6521 requested review from bbean23 and e10harvey August 29, 2024 23:06

e10harvey reviewed Oct 9, 2024

View reviewed changes

bbean23 requested changes Oct 11, 2024

View reviewed changes

braden6521 force-pushed the sofast_ex_mods branch from d69b406 to 216ec49 Compare November 11, 2024 18:43

braden6521 added 18 commits November 19, 2024 10:46

Modified example_process_single_facet to save images and processed fi…

0cecf38

…gure suite.

Added default to load_from_hdf prefix input

d1ef964

Modernized test_integration_multi_facet. Added 2 tests.

632f771

Removed generate test data multi facet from contrib.

6c3448c

Updated multifacet test HDF5 file.

5893602

Updated doc in example psf

3716371

Fixed bug in multi facet integration test

8922090

Updated ex process ensemble

2b251de

Docs in example psf

e6b8c90

Fixed how SofastFringe parameter object loads

c454953

Added plotting and filenames to ex pfe

a439231

Updated example undefined shape sofast facet

3ae2705

Reworked documentation in the sofast_fringe directory files

59c017e

Added chat gpt note.

b993827

Added high resolution option to ex psf

82155f5

Updated test-image-processing reference to changed multi facet data.

c72fc04

Updated docs

52195c8

Changed set_facet_canting to set_facet_cantings

350131e

bbean23 force-pushed the sofast_ex_mods branch from 216ec49 to 350131e Compare November 19, 2024 17:46

bbean23 mentioned this pull request Nov 19, 2024

[Code Feature]: clarify how to set canting and position #188

Open

1 task

bbean23 approved these changes Nov 19, 2024

View reviewed changes

e10harvey merged commit 9834362 into sandialabs:develop Nov 19, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sofast examples modifications #166

Sofast examples modifications #166

braden6521 commented Aug 29, 2024 •

edited

Loading

e10harvey left a comment

e10harvey Oct 9, 2024

braden6521 Nov 11, 2024

bbean23 left a comment

bbean23 Oct 11, 2024

braden6521 Nov 11, 2024

bbean23 Nov 19, 2024

bbean23 Oct 11, 2024

braden6521 Nov 11, 2024

bbean23 Oct 11, 2024

braden6521 Nov 11, 2024

bbean23 Oct 11, 2024

e10harvey commented Nov 11, 2024

braden6521 commented Nov 11, 2024

bbean23 left a comment



		class OpticOrientationAbstract(ABC):

Sofast examples modifications #166

Sofast examples modifications #166

Conversation

braden6521 commented Aug 29, 2024 • edited Loading

NOTE:

e10harvey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bbean23 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

e10harvey commented Nov 11, 2024

braden6521 commented Nov 11, 2024

bbean23 left a comment

Choose a reason for hiding this comment

braden6521 commented Aug 29, 2024 •

edited

Loading