Interface ZOSAPI::Tools::Sequences::IViaZRDOrPAFGenerationSettings
Last update: 13.03.2026
Definition:
Sequence generation settings interface for the Via ZRD or PAF File mode.
Inherits from:
Members
Properties
Property RayDatabaseFile
Definition:
string ZOSAPI.Tools.Sequences.IViaZRDOrPAFGenerationSettings.RayDatabaseFile
The name (with extension, but not including path) of the ray file to process. Can be either a ZRD or PAF file which is present in the same directory as the lens file.
If a ZRD / PAF file exists with the same name as the lens file, in the same directory, then this will be set as the default for this property when creating this settings interface via ISequenceSelector.SelectViaZRDOrPAFGeneration.
Return type: string
Property FilterString
Definition:
string ZOSAPI.Tools.Sequences.IViaZRDOrPAFGenerationSettings.FilterString
Optional filter string to apply when reading the ray file. Only applicable when the RayDatabaseFile is a ZRD file. Defaults to an empty string (no filter).
Return type: string
Property SortBy
Definition:
Analysis.RayTracing.PathAnalysisSortType ZOSAPI.Tools.Sequences.IViaZRDOrPAFGenerationSettings.SortBy
Metric by which to sort the resulting generated paths.
The default value, when creating this settings interface, will be Analysis.RayTracing.PathAnalysisSortType.TotalEndingFlux.
Return type: Analysis.RayTracing.PathAnalysisSortType
Property RelativeMinimumFlux
Definition:
double ZOSAPI.Tools.Sequences.IViaZRDOrPAFGenerationSettings.RelativeMinimumFlux
Optional minimum flux value, as a fraction of the initial ray flux, which paths must satisfy in order for sequences to be generated. Defaults to 0.
Return type: double
