Analysis Plotting Functions#
These functions are for plotting/displaying the results of invoking code of Analysis Functions.
- skZemax.skZemax_subfunctions._analyses_plotting_functions.AnalysisPlotting_Footprint(self, in_footprint_xarray: Dataset, ax: Axes = None, color_by_idx: int = 0) None[source]#
This function reproduces a footprint plot using the output of
Analyses_Footprint()Note that this footprint information does not capture any footprint descriptions beyond plotting an ellipse. Any more realistic ray-tracing is lost through the ZOS-API and needs to be examined directly in Zemax.
- Parameters:
in_footprint_xarray (xr.Dataset) – Output of
Analyses_Footprint().ax (plt.Axes, optional) – axis to put the footprint plot on, defaults to None (makes a new plot)
color_by_idx (int, optional) – How to color the footprint plot. 0=configuration, 1=wavelength, 2=field, defaults to 0
- skZemax.skZemax_subfunctions._analyses_plotting_functions.get_colormap(num_lines: int, should_reverse: bool = False, cmap_type='viridis') ndarray[source]#
Gets an array of color values for plotting based on a colormap.
- Parameters:
num_lines – number of lines you plan to plot
should_reverse – If true will return the color map in inverse order
- Returns:
colormap array