---
alias: user-guide-apply-substrate-map-mask
tags:
- mapping
description: "Apply a Substrate Map Mask to units within a designated region, adjusting their values based on the mask’s specifications"
---

# Apply Substrate Map Mask

:lock: SubstrateMap.**ApplyMask**

:lock: SubstrateMapMask.**Apply**

## Overview

This operation is used to apply a **Substrate Map Mask**. When applying a **Substrate Map**, all the affected units in the designated region are changed to the Set Value as defined in the mask.

## Setup

No specific setup is required other than to meet the preconditions of the transaction.  

## Preconditions

* The **Substrate Map Mask** exists and is Active.
* All the **Substrate Maps** to which the **Substrate Map Mask** will be applied exist, are Active, and non-template.

## Sequence of Steps

A **Substrate Map Mask** can be applied either from the **Substrate Map** page or directly from the **Substrate Map Mask** page. Follow the steps below according to your preferred entry point.

### Apply Substrate Map Mask From a Substrate Map Page

#### Raw (no Bin Converter is set)

1. In the **Substrate Map**, go to the [[user-guide-substrate-map-page#content-view|Content View]], and select the Bin Code Map Overlay.
2. Select **Apply Mask** on the top ribbon:

    ![Screenshot showing a bin converter set in the Content View of the Substrate Map, with the Bin Code Map Overlay selected.](images/apply_submap_mask_01.png)

3. In the new window, select which Mask to apply:

    ![Screenshot showing a UI with "Apply Mask" selected and a dropdown list labeled "* Mask:" with "apply submap mask 02" as an option.](images/apply_submap_mask_02.png)

    !!! note
        The selected Mask must have the same Layout Specifier, Substrate Type, Dimension X, Dimension Y, Orientation, Origin Location, and Axis Direction of the currently selected Overlay.

4. Select **Apply** to preview the Mask:

    ![Screenshot showing a UI with a filename hint "apply submap mask 03" and an instruction to select "Apply".](images/apply_submap_mask_03.png)

5. In the preview of the Mask, you can Add Units or Remove Units.

    !!! info
        If you make changes to the Mask in the preview, the changes will apply to the Map and the Mask.

6. In the Save Substrate Map wizard, you can choose to:

    * **Synchronize Material** - enables synchronization of the **Substrate Map** with the **Material** quantity. For more information, see [[user-guide-set-material-substrate-map]] and [[user-guide-synchronize-material-substrate-map]].
    * **Copy Overlay Information** - if enabled, the Substrate Map Overlay Information from the original **Substrate Map** are copied into the newly created Overlay. For more information, see [[user-guide-manage-substrate-map-overlay-information]]. This option is only available if you choose to Create New Version or Create New Map Name.
    * **Set Overlay as Active** - if you choose to create a new version or a new map, you can designate the newly created Overlay as the active version.
    * **Create New Version** - creates a new version for the currently selected Map Name.
    * **Create New Map Name** - creates a new Map Name with version 1. When selecting this option, you must provide the following information:
        * **Facility** - optionally, associate a **Facility**.
        * **Step** - optionally, associate a **Step**.
        * **Resource** - optionally, associate a **Resource**.

    ![Apply submap mask 04](images/apply_submap_mask_04.png)

7. Once you have made your selections, choose **Cancel** to discard changes or **Save** to apply them.

#### Converted (a Bin Converter is set)

1. In the **Substrate Map**, go to the [[user-guide-substrate-map-page#content-view|Content View]], and select the Bin Code Map Overlay:

    ![Screenshot showing a bin converter set in the Content View of the Substrate Map, with the Bin Code Map Overlay selected.](images/apply_submap_mask_01.png)

2. If you select **Apply Bin Converter** on the right, a new window will open for you to select the Bin Converter:

    ![Screenshot showing the "Apply Bin Converter" button in the UI.](images/apply_submap_mask_05.png)

3. Select the Bin Converter followed by **Apply** to access the converted **Substrate Map**:

    ![Screenshot showing a Bin Converter selected in the interface, with a Substrate Map displayed.](images/apply_submap_mask_06.png)

4. Select **Apply Mask** on the top ribbon, and select which Mask to apply:

    ![Screenshot showing a bin converter with an "Apply Mask" option selected from the top ribbon.](images/apply_submap_mask_07.png)

5. Select **Apply** to preview the Mask with the selected Bin Converter:

    ![Screenshot showing a bin converter applied in the conversion process.](images/apply_submap_mask_08.png)

6. In the preview of the Mask, you can Add Units or Remove Units.

    !!! info
        If you make changes to the Mask in the preview, the changes will apply to the Map and the Mask.

7. In the Save Substrate Map wizard, you can choose to:

    * **Synchronize Material** - enables synchronization of the **Substrate Map** with the **Material** quantity. For more information, see [[user-guide-set-material-substrate-map]] and [[user-guide-synchronize-material-substrate-map]].
    * **Copy Overlay Information** - if enabled, the Substrate Map Overlay Information from the original **Substrate Map** are copied into the newly created Overlay. For more information, see [[user-guide-manage-substrate-map-overlay-information]]. This option is only available if you choose to Create New Version or Create New Map Name.
    * **Set Overlay as Active** - if you choose to create a new version or a new map, you can designate the newly created Overlay as the active version.
    * **Create New Version** - creates a new version for the currently selected Map Name.
    * **Create New Map Name** - creates a new Map Name with version 1. When selecting this option, you must provide the following information:
        * **Facility** - optionally, associate a **Facility**.
        * **Step** - optionally, associate a **Step**.
        * **Resource** - optionally, associate a **Resource**.

    ![Apply submap mask 04](images/apply_submap_mask_04.png)

8. Once you have made your selections, choose **Cancel** to discard changes or **Save** to apply them.

### Apply Substrate Map Mask From a Substrate Map Mask Page (Bulk)

In the chosen **Substrate Map Mask**, select **Apply Mask** on the top ribbon:

![Screenshot showing a UI with an applied mask, displaying a substrate map.](images/apply_submap_mask_10.png)

#### Step 1: General Data

1. Configure the optional settings:

      * **Synchronize Materials** - enables **Material** synchronization. For more information, see [[user-guide-set-material-substrate-map]] and [[user-guide-synchronize-material-substrate-map]].
      * **Create New Version** - creates a new version of the current Substrate Map Overlay.
      * **Create New Overlay** - creates a new Substrate Map Overlay.
      * **Process Valid Only** - if enabled, only valid Substrate Map Masks will be processed.
      * **Copy Overlay Information** - if enabled, the Substrate Map Overlay Information from the original Substrate Map is copied into the newly created Overlay. For more information, see [[user-guide-manage-substrate-map-overlay-information]]. This option is only available if you choose to Create New Version or Create New Overlay.

2. Enable the **Select Mode** option:

      * **Substrate Map** - select **Substrate Maps** directly (see [[user-guide-apply-substrate-map-mask#step-2-substrate-maps|Step 2: Substrate Maps]] below)
      * **Materials** - select **Substrate Maps** indirectly (see [[user-guide-apply-substrate-map-mask#step-2-materials|Step 2: Materials]] below)

    !!! note
        The Advanced Options for the Select Modes vary. If you select Materials, you can also choose to apply the Substrate Map Mask to Sub-Materials.

3. In the Apply To Values, you can select Raw or Converted (default).
4. You can also use the Map Name Filter to specify where the **Substrate Map Mask** should be applied.
5. Select **Next** to continue.

![Apply mask](images/apply_mask.png)

#### Step 2: Substrate Maps

1. Use :material-plus: to add as many **Substrate Maps** as needed:

    ![Screenshot showing a user interface with multiple Substrate Maps added.](images/apply_submap_mask_12.png)

2. Select **Apply** to complete the operation.

#### Step 2: Materials

1. Use :material-plus: to add as many **Materials** as needed:

    ![Screenshot showing a list of materials.](images/apply_submap_mask_13.png)

2. You can chose to filter the **Materials**:

    ![Screenshot showing a list of materials with filtering options.](images/apply_submap_mask_14.png)

3. Select **Apply** to complete the operation.