zospy.analyses.systemviewers.cross_section.CrossSectionSettings

class zospy.analyses.systemviewers.cross_section.CrossSectionSettings

Bases: object

Settings for the cross section viewer.

Attributes:

start_surfaceint, optional

The starting surface index for the cross-section analysis. Defaults to 1.

end_surfaceint, optional

The ending surface index for the cross-section analysis. A value of -1 indicates the last surface. Defaults to -1.

number_of_raysint, optional

The number of rays to be used in the analysis. Defaults to 3.

y_stretchfloat, optional

The stretch factor in the Y-axis for the analysis visualization. Defaults to 1.0.

fletch_raysbool, optional

Flag indicating whether to fletch rays. Defaults to False.

wavelengthint | str, optional

The wavelength index to be used. Can be an integer or “all” for all wavelengths. Defaults to “all”.

fieldint | str, optional

The field index to be used. Can be an integer or “all” for all fields. Defaults to “all”.

color_rays_byconstants.Tools.Layouts.ColorRaysByCrossSectionOptions | str, optional

The criterion for coloring rays in the analysis. Defaults to “Fields”.

upper_pupilfloat, optional

The upper pupil limit for the analysis. Defaults to 1.

lower_pupilfloat, optional

The lower pupil limit for the analysis. Defaults to -1.

delete_vignettedbool, optional

Flag indicating whether to delete vignetted rays. Defaults to False.

marginal_and_chief_onlybool, optional

Flag indicating whether to include only marginal and chief rays in the analysis. Defaults to False.

image_sizetuple[int, int], optional

The size of the output image in pixels (width, height). Defaults to (800, 600).

rays_line_thicknessconstants.Tools.Layouts.LineThicknessOptions | str, optional

The thickness of the lines in the output visualization. Defaults to “Standard”.

surface_line_thicknessconstants.Tools.Layouts.LineThicknessOptions | str, optional

The thickness of the surface lines in the output visualization. Defaults to “Standard”.

__init__(*args: Any, **kwargs: Any) → None