SETSYSTEMPROPERTY, SYSP
Sets properties of the system, such as system aperture, field, wavelength, and other data.
Syntax:
SETSYSTEMPROPERTY code, value1, value2 SYSP code, value1, value2
Discussion:
This keyword requires a numeric expression that evaluates to an integer code which specifies what property is being modified. The second and third arguments are the new values for the specified property, and they may be either text in quotes, a string variable, or a numeric expression, depending upon the code. For most codes, the property value being modified is defined by the value1 argument. A few operands require both a value1 and a value2, as described in the table below.
If the property being modified is under control of the Multi-Configuration Editor, then the multi-configuration data for the current configuration only will also be modified to reflect the changed property.
SYSP is a shorthand for SETSYSTEMPROPERTY and is functionally identical.
| Code | Property |
| 4 | Adjust Index Data To Environment. Use 0 for off, 1 for on. See "Adjust Index Data To Environment". |
| 10 | Aperture Type code. See "Aperture Type" for code values and discussion. |
| 11 | Aperture Value. See "Aperture Value". |
| 12 | Apodization Type code. Use 0 for uniform, 1 for Gaussian, 2 for cosine cubed. See "Apodization Type". |
| 13 | Apodization Factor. See "Apodization Factor". |
| 14 | Telecentric Object Space. Use 0 for off, 1 for on. See "Telecentric Object Space". |
| 15 | Iterate Solves When Updating. Use 0 for off, 1 for on. See "Iterate Solves When Updating". |
| 16 | Lens Title. See "Lens Title". |
| 17 | Lens Notes. See "Notes". |
| 18 | Afocal Image Space. Use 0 for off, 1 for on. See "Afocal Image Space". |
| 21 | Global coordinate reference surface. See "Global Coordinate Reference Surface". |
| 23 | Glass catalog list. Use a string or string variable with the glass catalog name, such as "SCHOTT". To specify multiple catalogs use a single string or string variable containing names separated by spaces, such as "SCHOTT HOYA OHARA". |
| 24 | System Temperature in degrees Celsius. See "Temperature in degrees C". |
| 25 | System Pressure in atmospheres. See "Pressure in ATM". |
| 26 | Reference OPD method. Use 0 for absolute, 1 for infinity, 2 for exit pupil, and 3 for absolute 2. See "Reference OPD". |
| 30 | Lens Units code. Use 0 for mm, 1 for cm, 2 for inches, or 3 for Meters. Changing lens units does not scale or convert the lens data in any way, it only changes how the lens prescription data is interpreted. See "Lens Units". |
| 31 |
Source Units Prefix. Use 0 for Femto, 1 for Pico, 2 for Nano, 3 for Micro, 4 for Milli, 5 for None, 6 for Kilo, 7 for Mega, 8 for Giga, and 9 for Tera. See "Source Units". |
| 32 | Source Units. Use 0 for Watts, 1 for Lumens, and 2 for Joules. See "Source Units". |
| 33 |
Analysis Units Prefix. Use 0 for Femto, 1 for Pico, 2 for Nano, 3 for Micro, 4 for Milli, 5 for None, 6 for Kilo, 7 for Mega, 8 for Giga, and 9 for Tera. See "Analysis Units". |
| 34 | Analysis Units "per" Area. Use 0 for square mm, 1 for square cm, 2 for square inches, 3 for square Meters, and 4 for square feet. |
| 35 | MTF Units code. Use 0 for cycles per millimeter, or 1 for cycles per milliradian. See "MTF Units". |
| 40 | Coating File name. See "Coating File". |
| 41 | Scatter Profile name. See "Scatter Profile". |
| 42 | ABg Data File name. See "ABg Data File". |
| 43 | GRADIUM Profile name. See "GRADIUM Profile". |
| 50 | NSC Maximum Intersections Per Ray. See "Maximum Intersections Per Ray" . |
| 51 | NSC Maximum Segments Per Ray. See "Maximum Segments Per Ray". |
| 52 | NSC Maximum Nested/Touching Objects. See "Maximum Nested/Touching Objects". |
| 53 | NSC Minimum Relative Ray Intensity. See "Minimum Relative Ray Intensity". |
| 54 | NSC Minimum Absolute Ray Intensity. See "Minimum Absolute Ray Intensity". |
| 55 | NSC Glue Distance In Lens Units. See "Glue Distance In Lens Units". |
| 56 | NSC Missed Ray Draw Distance In Lens Units. See "Missed Ray Draw Distance in Lens Units". |
| 57 | NSC Retrace Source Rays Upon File Open. Use 0 for no, 1 for yes. See "Retrace Source Rays Upon File Open". |
| 58 | NSC Maximum Source File Rays In Memory. See "Maximum Source File Rays In Memory". |
| 59 | Simple Ray Splitting. Use 0 for no, 1 for yes. See "Simple Ray Splitting". |
| 60 | Polarization Jx. See "Jx, Jy, X-Phase, Y-Phase". |
| 61 | Polarization Jy. See "Jx, Jy, X-Phase, Y-Phase". |
| 62 | Polarization X-Phase. See "Jx, Jy, X-Phase, Y-Phase". |
| 63 | Polarization Y-Phase. See "Jx, Jy, X-Phase, Y-Phase". |
| 64 | Convert thin film phase to ray equivalent. Use 0 for no, 1 for yes. See "Convert thin film phase to ray equivalent". |
| 65 | Unpolarized. Use 0 for no, 1 for yes. See "Unpolarized". |
| 66 | Method. Use 0 for X-axis, 1 for Y-axis, and 2 for Z-axis. See "Method". |
| 70 | Ray Aiming. Use 0 for off, 1 for on, 2 for aberrated. See "Ray Aiming". |
| 71, 72, 73 | Ray aiming pupil shift x, y, and z. See "Pupil Shift, Pupil Compress". |
| 74 | Use Ray Aiming Cache. Use 0 for no, 1 for yes. See "Use Ray Aiming Cache". |
| 75 | Robust Ray Aiming. Use 0 for no, 1 for yes. See "Robust Ray Aiming (slow)". |
| 76 | Scale Pupil Shift Factors By Field. Use 0 for no, 1 for yes. See "Pupil Shift, Pupil Compress". |
| 77, 78 | Ray aiming pupil compress x, y. See "Pupil Shift, Pupil Compress". |
| 100 | Field type code. See "Field Type". |
| 101 | Number of fields. |
| 102, 103 | The field number is value1, value2 is the field x, y coordinate. |
| 104 | The field number is value1, value2 is the field weight. |
| 105, 106 | The field number is value1, value2 is the field vignetting decenter x, decenter y |
| 107, 108 | The field number is value1, value2 is the field tangential compression x, compression y |
| 109 | The field number is value1, value2 is the field tangential angle. |
| 110 | The field normalization method, value 1 is 0 for radial and 1 for rectangular. |
| 200 | Primary wavelength number. See "Wavelengths". |
| 201 | Number of wavelengths |
| 202 | The wavelength number is value1, value 2 is the wavelength in micrometers. |
| 203 | The wavelength number is value1, value 2 is the wavelength weight |
| 901 | The number of CPU's to use in multi-threaded computations, such as optimization. If the passed value is zero, the number of CPU's will be set to the default value. When testing this value using the function SYPR, this returns the total number of CPU's available as reported by the operating system. |
Usually, changes to system properties do not become effective until after the UPDATE keyword is executed.
Example:
! Set the number of wavelengths to 3 SETSYSTEMPROPERTY 201, 3 ! Set the number of fields to 4 SYSP 101, 4
Related Functions:
SYPR
Related Keywords:
SETSURFACEPROPERTY, UPDATE
Next: