ImagingPath.saveFigure

raytracing.ImagingPath.saveFigure(self, filePath, rays=None, raysList=None, removeBlocked=True, comments=None, onlyPrincipalAndAxialRays=None, limitObjectToFieldOfView=None)

The figure of the imaging path can be saved using this function.

Parameters:

• filePath (str or PathLike or file-like object) – A path, or a Python file-like object, or possibly some backend-dependent object. If filepath is not a path or has no extension, remember to specify format to ensure that the correct backend is used.
• rays (Rays instance) –
• raysList (list of Rays or list of list of Ray) –
• onlyPrincipalAndAxialRays (bool (Optional)) – If True, only the principal rays will appear on the plot (default=True)
• removeBlocked (bool (Optional)) – If True, the blocked rays are removed (default=False)
• comments (string) – If comments are included they will be displayed on a graph in the bottom half of the plot. (default=None)