Non-sequential Component Editor (NCE) Detector Functions

Non-sequential Component Editor (NCE) Detector Functions#

The functions within this category are related reading, formatting, saving and loading NCE detector data from ray traces.

skZemax.skZemax_subfunctions._NCE_detector_functions.NCE_GetDetectorComplete(self, in_Object: int | ZOSAPI_Editors_NCE_INCERow) → Dataset[source]#

This is the recommended and primariy function to get detector information of a Non-sequential ray trace.

Parameters:

in_Object (Union[int, ZOSAPI_Editors_NCE_INCERow]) – An NCE (detector) object specifed as either an index or an NCE object itself.

Returns:

An xarray of the detector infomraiton.

Return type:

xr.Dataset

skZemax.skZemax_subfunctions._NCE_detector_functions.NCE_GetDetectorLocations(self) → list[source]#

This function looks through each NCE object in the system and checks if it is a detector. If it is, it returns the object’s index in a list.

Returns:

A list of NCE object indicies indicating the indices of detectors.

Return type:

list

skZemax.skZemax_subfunctions._NCE_detector_functions.NCE_LoadDetectorInZemaxFormat(self, in_Object: int | ZOSAPI_Editors_NCE_INCERow, in_file_name: str, sum_to_current_data: bool = False) → None[source]#

Loads detector data in Zemax format (i.e. DDP or DDR).

Parameters:

  • in_Object (Union[int, ZOSAPI_Editors_NCE_INCERow]) – An NCE (detector) object specifed as either an index or an NCE object itself.

  • in_file_name (str) – File name of detector data to load.

  • sum_to_current_data (bool, optional) – If set to true then the data from the file is summed to the existing detector data, else the detector is cleared first, defaults to False

skZemax.skZemax_subfunctions._NCE_detector_functions.NCE_SaveDetectorInZemaxFormat(self, in_Object: int | ZOSAPI_Editors_NCE_INCERow, in_file_name: str) → None[source]#

Saves detector data in Zemax format (i.e. DDP or DDR).

Parameters:

  • in_Object (Union[int, ZOSAPI_Editors_NCE_INCERow]) – An NCE (detector) object specifed as either an index or an NCE object itself.

  • in_file_name (str) – File name of detector data to save.

Contents