'\" -*- coding: UTF-8 -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH pkgetmask 1 "06 December 2020" "" ""
.SH NAME
pkgetmask \- program to create mask image based on values in input raster image
.SH SYNOPSIS
'nh
.fi
.ad l
\fBpkgetmask\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
\fB-i\fR \fIinput\fR \fB-o\fR \fIoutput\fR [\fIoptions\fR] [\fIadvanced options\fR]
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
\fBpkgetmask\fR creates a mask raster dataset from an input
raster dataset.
Values smaller than the minimum value (\*(T<\fB\-min\fR\*(T>) or larger
than the maximum value (\*(T<\fB\-max\fR\*(T>) will result in a
\*(T<\fB\-nodata\fR\*(T> value in the mask.
.SH OPTIONS
.TP 
\*(T<\fB\-i\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-input\fR\*(T> \fIfilename\fR
input image file
.TP 
\*(T<\fB\-o\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-output\fR\*(T> \fIfilename\fR
Output mask file
.TP 
\*(T<\fB\-min\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-min\fR\*(T> \fIvalue\fR
Values smaller than min threshold(s) are masked as invalid.
Use one threshold for each band
.TP 
\*(T<\fB\-max\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-max\fR\*(T> \fIvalue\fR
Values greater than max threshold(s) are masked as invalid.
Use one threshold for each band
.TP 
\*(T<\fB\-data\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-data\fR\*(T> \fIvalue\fR
value(s) for valid pixels: between min and max
.TP 
\*(T<\fB\-nodata\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-nodata\fR\*(T> \fIvalue\fR
value(s) for invalid pixels: not between min and max
.TP 
\*(T<\fB\-v\fR\*(T> \fIlevel\fR, \*(T<\fB\-\-verbose\fR\*(T> \fIlevel\fR
verbose
.PP
Advanced options
.TP 
\*(T<\fB\-b\fR\*(T> \fIband\fR, \*(T<\fB\-\-band\fR\*(T> \fIband\fR
band(s) used for mask
.TP 
\*(T<\fB\-p\fR\*(T> \fIAND|OR\fR, \*(T<\fB\-\-operator\fR\*(T> \fIAND|OR\fR
Operator: [AND,OR].
.TP 
\*(T<\fB\-ot\fR\*(T> \fItype\fR, \*(T<\fB\-\-otype\fR\*(T> \fItype\fR
Data type for output image
({Byte / Int16 / UInt16 / UInt32 / Int32 / Float32 / Float64 / CInt16 / CInt32 / CFloat32 / CFloat64}).
Empty string: inherit type from input image 
.TP 
\*(T<\fB\-of\fR\*(T> \fIformat\fR, \*(T<\fB\-\-oformat\fR\*(T> \fIformat\fR
Output image format (see also
\fBgdal_translate\fR(1)).
.TP 
\*(T<\fB\-co\fR\*(T> \fIoption\fR, \*(T<\fB\-\-co\fR\*(T> \fIoption\fR
Creation option for output file.
Multiple options can be specified.
.TP 
\*(T<\fB\-ct\fR\*(T> \fIcolortable\fR, \*(T<\fB\-\-ct\fR\*(T> \fIcolortable\fR
color table (file with 5 columns:
id R G B ALFA (0: transparent, 255: solid)).
.SH EXAMPLE
create mask, setting all negative values to 0 (rest to 1)
.PP
.nf
\*(T<
\fBpkgetmask\fR \fB\-i\fR \fIinput.tif\fR \fB\-o\fR \fIoutput.tif\fR \fB\-min\fR \fI0\fR \fB\-nodata\fR \fI0\fR \fB\-data\fR \fI1\fR
      \*(T>
.fi
.PP
create mask.
Mask is set to 0 (default value for \*(T<\fB\-nodata\fR\*(T>) 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 \*(T<\fB\-data\fR\*(T>)
.PP
.nf
\*(T<
\fBpkgetmask\fR \fB\-i\fR \fIinput.tif\fR \fB\-o\fR \fIoutput.tif\fR \fB\-min\fR \fI0\fR \fB\-max\fR \fI10\fR \fB\-max\fR \fI0\fR \fB\-max\fR \fI250\fR \fB\-b\fR \fI0\fR \fB\-b\fR \fI1\fR
      \*(T>
.fi