The Messages Window in Ansys Zemax OpticStudio contains details of errors, warnings, and other information message that inform the user about the status of their optical design. This tool removes the need for users to repeatedly click away pop-up messages, while providing more information about the source of errors than was previously available.
Authored By Chris Normanshire
How the Messages Window Works
The Messages Window will automatically open at the bottom of the screen to alert you to an error state or warning relating to the system setup. You can then identify the source of the error and take action to resolve it uninterrupted. Alternatively, you can continue with modifications the system and then return to correct the error when convenient. This replaces the previous behaviour where each error generated an individual pop-up message that need to be clicked away before work could continue.
The utility of the Messages Window is best shown with an example.
In the video above, an initial modification results in an error that prevents system updates. The Messages Window opens at the bottom of the screen and gives details of the error. The red dot indicates the serious nature of the error. The thickness of surface 0 is modified to correct the error, but this leads to another issue. When this second issue is addressed, by correcting the problematic mechanical semi diameter, a green dot in the Messages Window indicates the system is now error free.
The Messages Window can be closed at any time and the contents will be retained. The window will reopen the next time a new message is issued. While the default location is docked at the bottom of the screen, the Messages Window can also be docked on the left (in the same panel as the System Explorer) or right side of the screen, or be set as floating.
Messages in the window will only persist during the current session. This means that if a new lens files is opened, or if OpticStudio is closed, the content of the Messages Window is cleared. There are options the saved the Messages Window contents to a file, or copy to the clipboard, in order to retain the information for future reference or share with colleagues.
There is a search option in the toolbar for locating specific messages or keywords. As the message list can become quite long this can be used to find a particular error that occurred earlier in the session.
Additional Information
In addition to the Messages Window providing information in a less obtrusive way than pop-up messages it can also provide more usable information to identify and fix the source of and error. For example, previously if the ray aiming algorithm could not trace rays from a specific field point the pop-up message would read:
- "Cannot determine object coordinates"
Now the entry in the Messages Window details the source of the error along with suggestions on how to resolve:
- "Cannot determine object coordinates for Field 3. Use Field Data Editor to adjust the value or set the field to Ignore in Field Properties."
System Check
It is also possible to route information from the System Check tool from to the Messages Window, by clicking the traffic light icon on the Messages toolbar. This provides all important information about the status of your system in one convenient location.
Note that the System Check warnings do not dynamically update in the Messages Window, they must be refreshed via the traffic light button.
Supported Messages
Currently, not all pop-up messages are routed to the Messages Window. Core system messages, generated from Lens Data and Non-Sequential Component Editors are supported and include:
- "Cannot determine object coordinates"
- "Can’t find glass *XXXX* in catalog!"
- "Invalid asphere surface sag"
- "Invalid mechanical semi-diameter value XXXX on surface Y!"
Support for messages from other editors and tools will be added in future. If there is a specific error message you would like to see added to the Messages Window please contact Ansys technical support or your Channel Partner representatives.
Conclusion
The Messages Window provides a convenient location to view important system status messages and, by reducing the number of pop-up messages, enables a smoother workflow with fewer interruptions.