ROES Server - DP2 Agent - Masks
DP2 Agent Mask Images Directory Behavior
Use this article to understand how the Masks Images Directory path and Err on missing Mask image checkbox affect mask handling in the DP2 Agent.
Overview
The Masks Images Directory path and the Err on missing Mask image checkbox determine whether mask images are included in the DP2 job file and whether missing masks generate an error.
Both settings are located in the Order Items section of the DP2 Agent.
If this image does not display, open it directly: Dp2Agent-OrderItems.png
Behavior Summary
| Scenario | Checkbox | Directory | Result |
|---|---|---|---|
| 1 | Checked | Defined | Mask is included if found. Missing mask generates an error. |
| 2 | Not checked | Defined | Mask is included if found. Missing mask is skipped and the job is still created. |
| 3 | Not checked | Not defined | maskimage values are not included in the job and no error is generated. |
Scenario 1: Checkbox Checked and Directory Defined
If this image does not display, open it directly: Scenario_1-A74.png
When Err on missing Mask image is checked and a Masks Images Directory is defined, DP2 Agent includes the mask in the job file if the called mask exists in the defined directory. If the mask does not exist, an error is generated.
Scenario 2: Checkbox Not Checked and Directory Defined
If this image does not display, open it directly: Scenario_2-A74.png
When Err on missing Mask image is not checked and a Masks Images Directory is defined, DP2 Agent includes the mask in the job file if it exists in the defined directory. If the mask does not exist, it is not included and the job is still created without presenting an error.
Scenario 3: Checkbox Not Checked and Directory Not Defined
If this image does not display, open it directly: Scenario_3-A74.png
When Err on missing Mask image is not checked and a Masks Images Directory is not defined, maskimage values are not included in the job and no error is generated.
This is the most common configuration for DP2 labs.
Explicit Mask Location
A maskimage location can be explicitly set using the rendermaskimage attribute.
The value uses a DP2 keyword followed by a path from the DP2 perspective to the mask file.
Expected Result
DP2 Agent should include mask information only when the configuration and mask availability allow it. Missing masks should generate an error only when Err on missing Mask image is checked and a directory is defined.
Escalation Notes
- Confirm whether Err on missing Mask image is checked.
- Confirm whether a Masks Images Directory is defined.
- If a directory is defined, confirm the referenced mask file exists in that location.
- If errors occur, verify whether the checkbox is intentionally enabled.
- If using rendermaskimage, confirm the path is valid from the DP2 perspective.