zospy.analyses.extendedscene.geometric_image_analysis.GeometricImageAnalysis

class zospy.analyses.extendedscene.geometric_image_analysis.GeometricImageAnalysis

Bases: BaseAnalysisWrapper[DataFrame | None, GeometricImageAnalysisSettings]

Geometric Image 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([minx, miny])	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 FFT Through Focus MTF 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__(*, wavelength: Literal['All'] | int = 'All', field: int = 1, surface: Literal['Image'] | int = 'Image', field_size: float = 0, image_size: float = 50, file: str = 'LETTERF.IMA', rotation: float = 0, rays_x_1000: int = 10, show_as: constants.Analysis.GiaShowAsTypes | str = 'Surface', source: constants.Analysis.Settings.SourceGia | str = 'Uniform', number_of_pixels: int = 100, row_column_number: Literal['Center'] | int = 'Center', na: float = 0, total_watts: float = 1, parity: constants.Analysis.Settings.Parity | str = 'Even', reference: constants.Analysis.Settings.ReferenceGia | str = 'ChiefRay', use_symbols: bool = False, use_polarization: bool = False, remove_vignetting_factors: bool = True, scatter_rays: bool = False, delete_vignetted: bool = False, use_pixel_interpolation: bool = False, save_as_bim_file: str = '', settings: GeometricImageAnalysisSettings | None = None)

Create a new Geometric Image Analysis.

See also

GeometricImageAnalysisSettings

Settings for the Geometric Image Analysis analysis.

get_data_grid(minx=None, miny=None) → DataFrame | None

Get the data grids from the analysis result.

Returns:

pd.DataFrame | None

The data grids from the analysis result, or None if there are no data grids.

run_analysis() → DataFrame | None

Run the FFT Through Focus MTF analysis.