zospy.analyses.reports.cardinal_points.CardinalPoints

class zospy.analyses.reports.cardinal_points.CardinalPoints

Bases: BaseAnalysisWrapper[CardinalPointsResult, CardinalPointsSettings]

Cardinal points analysis.

Attributes:

MODE

analysis

The OpticStudio analysis object.

config_file

Path to the temporary configuration file.

oss

The OpticStudio system.

settings

Settings of the analysis.

text_output_file

Path to the temporary text output file.

Methods

__call__(oss, *args, **kwargs)	Run the analysis and return the results.
get_data_grid([cell_origin])	Get the data grids from the analysis result.
get_data_series()	Get the data series from the analysis result.
get_text_output()	Get the text output of the analysis.
parse_output(grammar, transformer[, result_type])	Parse the text output of the analysis.
run(oss[, config_file, text_output_file, ...])	Run the analysis and return the results.
run_analysis()	Run the Cardinal Points analysis.
update_settings(*[, settings, settings_kws])	Update the settings of the analysis using a settings object or keyword arguments.
with_settings(settings)	Create a new analysis with the specified settings.

__init__(*, surface_1: int = 1, surface_2: int | Literal['Image'] = 'Image', wavelength: int = 1, orientation: Literal['Y-Z', 'X-Z'] = 'Y-Z')

Create a new Cardinal Points analysis.

See also

CardinalPointsSettings

Settings for the Cardinal Points analysis.

run_analysis() → CardinalPointsResult

Run the Cardinal Points analysis.