Create Mask Dialog

The raster operation create mask dialog window allows the user to null out pixels that are inside the area of one or more geometries.

The dialog controls are:

  • Please Select The Source File Path

    A textbox that contains the file path of a geospatial image that the user wants to apply one or more mask geometries.
  • Source File Path - Browse

    When this button is clicked a file select dialog is displayed for the user to select a geospatial image file path.
  • Please Select The Output File Format

    A dropdown list control that displays the supported output file formats.
  • Please Specify The Output File Path

    The file path where the new, masked image file should be created.
  • Output File Path - Browse

    When clicked a file select dialog window is displayed allowing the user to select the output file path.
  • The Layer To Use For The Mask

    A drop down list box that contains a list of polygon vector layers in the Map View window that can be used as a mask source for the operation.
  • The Features To Use For The Mask

    A drop down list box that specifies what features from the selected mask layer to use for processing. Select "Use All The Features" option to use all the geometries in the layer for the mask. Select "Use Only The Selected Features" option to only use the features that are selected in the layer for the mask. Select "Use Only The Visible Features" option to only use the features that are visible in the layer for the mask.
  • Use The Extent Of The Features

    Select this option to use the extent of the feature geometries as the mask geometry.
  • Mask Type

    A drop down list box that specifies how the mask is applied to the image. Select "Set Area Transparent" option to set pixels that intersect the mask geometry as transparent. Select "Set Area To Solid Color" option to set pixels that intersect the mask geometry to the color specified in the "Mask Color" control.
  • Invert Mask

    Select this option to set all pixels that do not intersect the mask geometry to transparent or a solid color. This option essentially reverses the operation to mask out pixels that are located outside the interior of the mask geometries which is very similar to the Create Cutline Dialog operation. If this option is not selected then the pixels that are located inside the mask geometry will be set to transparent or a solid color.
  • Mask Color

    A color picker drop down list control that presents a color palette to choose a color from. This option is enabled when the "Mask Type" is set to "Set Area To Solid Color". The color specified in this control will be the color that is applied to the output image file as the mask.
  • Include All Pixels That Touch The Mask Edge

    Select this option to include all pixels in the output image that intersect or are completely within the interior of the mask geometry. Pixels that do not intersect the mask geometry will remain unchanged. If this option is not selected then only the pixels that are completely contained within the mask geometry will be nulled out.
  • Replace Existing

    Select this option to replace the output file path if the file already exists.
  • Advanced

    When clicked the Advanced Raster Options Dialog window is displayed allowing the user to specify additional options for the operation.
  • OK

    When this button is clicked the dialog queues the Create Mask task with the Parallel Processing Server and closes the dialog. Use the Task Pane window to monitor the task progress. A popup balloon window and the Task Pane will alert the user when the task is complete.
  • Cancel

    Closes the dialog window.

Documentation is published by LCIC with the Axis release and imported here in full. Screenshots and wording are the vendor's own.