Skip to content

Commit

Permalink
Added documentation to SlopeSolverDataDebug parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
braden6521 committed Dec 17, 2024
1 parent f0b69db commit 39f978a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions opencsp/common/lib/deflectometry/SlopeSolverDataDebug.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,22 @@ class SlopeSolverDataDebug:

def __init__(self):
self.debug_active: bool = False
"""To activate slope solver debugging. Default False"""
self.optic_data: Any = None
"""Representation of optic (Facet/Mirror) being solved for.
The geometry data in this object is used to create visualization plots.
This information is updated automatically during SOFAST execution and will
overwrite any previously user-given values. Default None"""
self.slope_solver_figures: list = []
"""List to hold figure objects once created."""
self.slope_solver_camera_rays_length: float = 0.0
"""The length (meters) of camera rays to draw when plotting the 3d slope solving scenario plot. Default 0.0"""
self.slope_solver_plot_camera_screen_points: bool = False
"""To include scatter plot of xyz screen point locations seen by camera in slope solving scenario plot. Default False"""
self.slope_solver_point_downsample: int = 50
"""The downsample factor (to save computing resources) to apply to screen points
Only applicable if plotting screen points is enabled with the
`SlopeSolverDataDebug.slope_solver_plot_camera_screen_points` flag). Default 50"""
self.slope_solver_single_plot: bool = False
"""Flag to plot all iterations of the slope solving algorithm on one plot (True) or create a separate
plot for each iteration (False). Default False (new plot for each iteration)"""

0 comments on commit 39f978a

Please sign in to comment.