---
name: "pkgetmask"
section: "1"
platform: "linux"
package: "pktools"
version: "2.6.7.6+ds-6+b3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/pkgetmask"
---

# pkgetmask(1)

program to create mask image based on values in input raster image

## NAME

pkgetmask - program to create mask image based on values in input raster image

## SYNOPSIS

FC**pkgetmask**F\[0\]  FC**-i**F\[0\] *input* FC**-o**F\[0\] *output* \[*options*\] \[*advanced options*\]

## DESCRIPTION

**pkgetmask** creates a mask raster dataset from an input raster dataset. Values smaller than the minimum value (FC**-min**F\[0\]) or larger than the maximum value (FC**-max**F\[0\]) will result in a FC**-nodata**F\[0\] value in the mask.

## OPTIONS

- FC**-i**F\[0\] *filename*, FC**--input**F\[0\] *filename*

  input image file

- FC**-o**F\[0\] *filename*, FC**--output**F\[0\] *filename*

  Output mask file

- FC**-min**F\[0\] *value*, FC**--min**F\[0\] *value*

  Values smaller than min threshold(s) are masked as invalid. Use one threshold for each band

- FC**-max**F\[0\] *value*, FC**--max**F\[0\] *value*

  Values greater than max threshold(s) are masked as invalid. Use one threshold for each band

- FC**-data**F\[0\] *value*, FC**--data**F\[0\] *value*

  value(s) for valid pixels: between min and max

- FC**-nodata**F\[0\] *value*, FC**--nodata**F\[0\] *value*

  value(s) for invalid pixels: not between min and max

- FC**-v**F\[0\] *level*, FC**--verbose**F\[0\] *level*

  verbose

Advanced options

- FC**-b**F\[0\] *band*, FC**--band**F\[0\] *band*

  band(s) used for mask

- FC**-p**F\[0\] *AND\|OR*, FC**--operator**F\[0\] *AND\|OR*

  Operator: \[AND,OR\].

- FC**-ot**F\[0\] *type*, FC**--otype**F\[0\] *type*

  Data type for output image ({Byte / Int16 / UInt16 / UInt32 / Int32 / Float32 / Float64 / CInt16 / CInt32 / CFloat32 / CFloat64}). Empty string: inherit type from input image

- FC**-of**F\[0\] *format*, FC**--oformat**F\[0\] *format*

  Output image format (see also [**gdal\_translate**(1)](/gdal_translate/1.md)).

- FC**-co**F\[0\] *option*, FC**--co**F\[0\] *option*

  Creation option for output file. Multiple options can be specified.

- FC**-ct**F\[0\] *colortable*, FC**--ct**F\[0\] *colortable*

  color table (file with 5 columns: id R G B ALFA (0: transparent, 255: solid)).

## EXAMPLE

create mask, setting all negative values to 0 (rest to 1)

```
FC
pkgetmask -i input.tif -o output.tif -min 0 -nodata 0 -data 1
      F[0]
```

create mask. Mask is set to 0 (default value for FC**-nodata**F\[0\]) if either band 0 is not between 0 and 10 OR (default operator) band 1 is not between 0 and 250. Else mask is set to 1 (default value for FC**-data**F\[0\])

```
FC
pkgetmask -i input.tif -o output.tif -min 0 -max 10 -max 0 -max 250 -b 0 -b 1
      F[0]
```