'\" -*- coding: us-ascii -*-
.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 pkkalman 1 "14 June 2016" "" ""
.SH NAME
pkkalman \- kalman raster images: median, min/max, morphological, kalmaning
.SH SYNOPSIS
'nh
.fi
.ad l
\fBpkkalman\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
[\fIoptions\fR]
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
\fBpkkalman\fR will complement a time series of observations
(option \*(T<\fB\-obs\fR\*(T>) at fine spatial resolution.
A data assimilation technique based on a Kalman filter is hereby used.
The data at fine spatial resolution are assimilated with coarse spatial
resolution time series at a finer temporal resolution, referred to as a
model (option \*(T<\fB\-mod\fR\*(T>).
The time series for both observation and model can either be provided as
multi-band raster datasets or as multiple single band datasets.
Missing data in the observations are predicted by the algorithm.
The model must cover at least the spatial coverage of the observation.
The missing data must be provided either as nodata values in the input
(using option \*(T<\fB\-obsnodata\fR\*(T>) or as an external mask (using
option \*(T<\fB\-obsmask\fR\*(T>).
The time sequence for the model and observation should be provided via
the options \*(T<\fB\-tmod\fR\*(T> and \*(T<\fB\-tobs\fR\*(T>.
Tuning parameters for the algorithm are process noise (option
\*(T<\fB\-q\fR\*(T>) and the weights for uncertainty of valid
observations (\*(T<\fB\-uo\fR\*(T>) and the model (\*(T<\fB\-um\fR\*(T>).
.SH OPTIONS
.TP 
\*(T<\fB\-dir\fR\*(T> \fIforward|backward|smooth\fR, \*(T<\fB\-\-direction\fR\*(T> \fIforward|backward|smooth\fR
direction to run model (forward|backward|smooth)
.TP 
\*(T<\fB\-mod\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-model\fR\*(T> \fIfilename\fR
coarse spatial resolution input datasets(s) used as model.
Use either multi-band input (\*(T<\fB\-model\fR\*(T>
\fImultiband_model.tif\fR) or multiple
single-band inputs
(\*(T<\fB\-mod\fR\*(T> \fImodel1\fR
\*(T<\fB\-mod\fR\*(T> \fImodel2\fR etc.)
.TP 
\*(T<\fB\-modmask\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-modmask\fR\*(T> \fIfilename\fR
model mask datasets(s).
Must have same dimension as model input.
Use either multi-band input or multiple single-band inputs
.TP 
\*(T<\fB\-obs\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-observation\fR\*(T> \fIfilename\fR
fine spatial resolution input dataset(s) used as observation.
Use either multi-band input (\*(T<\fB\-obs\fR\*(T>
\fImultiband_obs.tif\fR) or multiple
single-band inputs (\*(T<\fB\-obs\fR\*(T>
\fIobs1\fR \*(T<\fB\-obs\fR\*(T>
\fIobs2\fR etc.)
.TP 
\*(T<\fB\-obsmask\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-obsmask\fR\*(T> \fIfilename\fR
observation mask dataset(s).
Must have same dimension as observation input
(use multi-band input or multiple single-band inputs)
.TP 
\*(T<\fB\-tmod\fR\*(T> \fInumber\fR, \*(T<\fB\-\-tmodel\fR\*(T> \fInumber\fR
time sequence of model input.
Sequence must have exact same length as model input.
Leave empty to have default sequence 0,1,2,etc.
.TP 
\*(T<\fB\-tobs\fR\*(T> \fInumber\fR, \*(T<\fB\-\-tobservation\fR\*(T> \fInumber\fR
time sequence of observation input.
Sequence must have exact same length as observation input
.TP 
\*(T<\fB\-a_srs\fR\*(T> \fIEPSG:number\fR, \*(T<\fB\-\-a_srs\fR\*(T> \fIEPSG:number\fR
Override the projection for the output file
(leave blank to copy from input file, use epsg:3035 to use
European projection and force to European grid)
.TP 
\*(T<\fB\-ofw\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-outputfw\fR\*(T> \fIfilename\fR
Output raster dataset for forward model
.TP 
\*(T<\fB\-u_ofw\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-u_outputfw\fR\*(T> \fIfilename\fR
Uncertainty output raster dataset for forward model
.TP 
\*(T<\fB\-obw\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-outputbw\fR\*(T> \fIfilename\fR
Output raster dataset for backward model
.TP 
\*(T<\fB\-u_obw\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-u_outputbw\fR\*(T> \fIfilename\fR
Uncertainty output raster dataset for backward model
.TP 
\*(T<\fB\-ofb\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-outputfb\fR\*(T> \fIfilename\fR
Output raster dataset for smooth model
.TP 
\*(T<\fB\-u_ofb\fR\*(T> \fIfilename\fR, \*(T<\fB\-\-u_outputfb\fR\*(T> \fIfilename\fR
Uncertainty output raster dataset for smooth model
.TP 
\*(T<\fB\-modnodata\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-modnodata\fR\*(T> \fIvalue\fR
invalid value for model input
.TP 
\*(T<\fB\-obsnodata\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-obsnodata\fR\*(T> \fIvalue\fR
invalid value for observation input
.TP 
\*(T<\fB\-msknodata\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-msknodata\fR\*(T> \fIvalue\fR
Mask value not to consider
.TP 
\*(T<\fB\-mskband\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-mskband\fR\*(T> \fIvalue\fR
Mask band to read (0 indexed)
.TP 
\*(T<\fB\-obsmin\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-obsmin\fR\*(T> \fIvalue\fR
Minimum value for observation data
.TP 
\*(T<\fB\-obsmax\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-obsmax\fR\*(T> \fIvalue\fR
Maximum value for observation data
.TP 
\*(T<\fB\-eps\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-eps\fR\*(T> \fIvalue\fR
epsilon for non zero division.
Default: 0.00001
.TP 
\*(T<\fB\-um\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-uncertmodel\fR\*(T> \fIvalue\fR
Uncertainty of the model
.TP 
\*(T<\fB\-uo\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-uncertobs\fR\*(T> \fIvalue\fR
Uncertainty of valid observations
.TP 
\*(T<\fB\-unodata\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-uncertnodata\fR\*(T> \fIvalue\fR
Uncertainty in case of no-data values in observation.
.TP 
\*(T<\fB\-q\fR\*(T> \fIvalue\fR, \*(T<\fB\-\-q\fR\*(T> \fIvalue\fR
Process noise: expresses instability (variance) of proportions of
fine res pixels within a moderate resolution pixel
.TP 
\*(T<\fB\-down\fR\*(T> \fInumber\fR, \*(T<\fB\-\-down\fR\*(T> \fInumber\fR
Downsampling factor for reading model data to calculate regression
(default is ratio between coarse (model) and fine (obs) resolution
raster datasets)
.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> \fIGDALformat\fR, \*(T<\fB\-\-oformat\fR\*(T> \fIGDALformat\fR
Output image format (see also
\fBgdal_translate\fR(1)).
Empty string: inherit from input image
.TP 
\*(T<\fB\-co\fR\*(T> \fINAME=VALUE\fR, \*(T<\fB\-\-co\fR\*(T> \fINAME=VALUE\fR
Creation option for output file.
Multiple options can be specified.
.TP 
\*(T<\fB\-v\fR\*(T> \fIlevel\fR, \*(T<\fB\-\-verbose\fR\*(T> \fIlevel\fR
verbose mode when positive