.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
.TH MINTPY-TIMESERIES2VELOCITY "1" "May 2022" "mintpy-timeseries2velocity v1.3.3" "User Commands"
.SH NAME
mintpy-timeseries2velocity \- Estimate velocity / time functions from time\-series.
.SH DESCRIPTION
usage: timeseries2velocity.py [\-h] [\-\-template TEMPLATE_FILE]
.TP
[\-\-ts\-cov\-file TS_COV_FILE] [\-o OUTFILE]
[\-\-update] [\-\-ref\-lalo LAT LON] [\-\-ref\-yx Y X]
[\-\-ref\-date DATE] [\-\-start\-date STARTDATE]
[\-\-end\-date ENDDATE]
[\-\-exclude EXCLUDEDATE [EXCLUDEDATE ...]]
[\-\-bootstrap] [\-\-bc BOOTSTRAPCOUNT]
[\-\-poly POLYNOMIAL]
[\-\-periodic PERIODIC [PERIODIC ...]]
[\-\-step STEP [STEP ...]] [\-\-exp EXP [EXP ...]]
[\-\-log LOG [LOG ...]] [\-\-save\-res]
[\-\-res\-file RES_FILE] [\-\-ram MAXMEMORY]
timeseries_file
.PP
Estimate velocity / time functions from time\-series.
.SS "positional arguments:"
.TP
timeseries_file
Time series file for velocity inversion.
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-template\fR TEMPLATE_FILE, \fB\-t\fR TEMPLATE_FILE
template file with options
.TP
\fB\-\-ts\-cov\-file\fR TS_COV_FILE
Time\-series (co)variance file for velocity STD calculation
.TP
\fB\-o\fR OUTFILE, \fB\-\-output\fR OUTFILE
output file name
.TP
\fB\-\-update\fR
Enable update mode, and skip estimation if:
1) output velocity file already exists, readable and newer than input file
2) all configuration parameters are the same.
.TP
\fB\-\-ref\-lalo\fR LAT LON
Change reference point LAT LON for estimation.
.TP
\fB\-\-ref\-yx\fR Y X
Change reference point Y X for estimation.
.TP
\fB\-\-ref\-date\fR DATE
Change reference date for estimation.
.TP
\fB\-\-ram\fR MAXMEMORY, \fB\-\-memory\fR MAXMEMORY
Max amount of memory in GB to use (default: 4.0).
Adjust according to your computer memory.
.SS "dates of interest:"
.TP
\fB\-\-start\-date\fR STARTDATE, \fB\-s\fR STARTDATE
start date for velocity estimation
.TP
\fB\-\-end\-date\fR ENDDATE, \fB\-e\fR ENDDATE
end date for velocity estimation
.TP
\fB\-\-exclude\fR EXCLUDEDATE [EXCLUDEDATE ...], \fB\-\-ex\fR EXCLUDEDATE [EXCLUDEDATE ...]
date(s) not included in velocity estimation, i.e.:
\fB\-\-exclude\fR 20040502 20060708 20090103
\fB\-\-exclude\fR exclude_date.txt
exclude_date.txt:
20040502
20060708
20090103
.SS "bootstrapping:"
.IP
estimating the mean / STD of the velocity estimator
.TP
\fB\-\-bootstrap\fR, \fB\-\-bootstrapping\fR
Enable bootstrapping to estimate the mean and STD of the velocity estimator.
.TP
\fB\-\-bc\fR BOOTSTRAPCOUNT, \fB\-\-bootstrap\-count\fR BOOTSTRAPCOUNT
number of iterations for bootstrapping (default: 400).
.SS "Deformation Model:"
.IP
A suite of time functions
.TP
\fB\-\-poly\fR POLYNOMIAL, \fB\-\-polynomial\fR POLYNOMIAL, \fB\-\-poly\-order\fR POLYNOMIAL
a polynomial function with the input degree (default: 1). E.g.:
\fB\-\-poly\fR 1                                  # linear
\fB\-\-poly\fR 2                                  # quadratic
\fB\-\-poly\fR 3                                  # cubic
.TP
\fB\-\-periodic\fR PERIODIC [PERIODIC ...], \fB\-\-period\fR PERIODIC [PERIODIC ...], \fB\-\-peri\fR PERIODIC [PERIODIC ...]
periodic function(s) with period in decimal years (default: []). E.g.:
\fB\-\-periodic\fR 1.0                            # an annual cycle
\fB\-\-periodic\fR 1.0 0.5                        # an annual cycle plus a semi\-annual cycle
.TP
\fB\-\-step\fR STEP [STEP ...]
step function(s) at YYYYMMDD (default: []). E.g.:
\fB\-\-step\fR 20061014                           # coseismic step  at 2006\-10\-14T00:00
\fB\-\-step\fR 20110311 20120928T1733             # coseismic steps at 2011\-03\-11T00:00 and 2012\-09\-28T17:33
.TP
\fB\-\-exp\fR EXP [EXP ...], \fB\-\-exponential\fR EXP [EXP ...]
exponential function(s) at YYYYMMDD with characteristic time(s) tau in decimal days (default: []). E.g.:
\fB\-\-exp\fR  20181026 60                        # exp onset at 2006\-10\-14T00:00 with tau=60 days
\fB\-\-exp\fR  20181026T1355 60 120               # exp onset at 2006\-10\-14T13:55 with tau=60 days overlayed by a tau=145 days
\fB\-\-exp\fR  20161231 80.5 \fB\-\-exp\fR 20190125 100   # 1st exp onset at 2011\-03\-11 with tau=80.5 days and
.TP
# 2nd exp onset at 2012\-09\-28 with tau=100
days
.TP
\fB\-\-log\fR LOG [LOG ...], \fB\-\-logarithmic\fR LOG [LOG ...]
logarithmic function(s) at YYYYMMDD with characteristic time(s) tau in decimal days (default: []). E.g.:
\fB\-\-log\fR  20181016 90.4                      # log onset at 2006\-10\-14T00:00 with tau=90.4 days
\fB\-\-log\fR  20181016T1733 90.4 240             # log onset at 2006\-10\-14T17:33 with tau=90.4 days overlayed by a tau=240 days
\fB\-\-log\fR  20161231 60 \fB\-\-log\fR 20190125 180.2   # 1st log onset at 2011\-03\-11 with tau=60 days and
.IP
# 2nd log onset at 2012\-09\-28 with tau=180.2 days
.SS "Residual file:"
.IP
Save residual displacement time\-series to HDF5 file.
.TP
\fB\-\-save\-res\fR, \fB\-\-save_residual\fR
Save the residual displacement time\-series to HDF5 file.
.TP
\fB\-\-res\-file\fR RES_FILE, \fB\-\-residual\-file\fR RES_FILE
Output file name for the residual time\-series file (default: timeseriesResidual.h5).
.SS "template options:"
.IP
## Estimate linear velocity and its standard deviation from time\-series
## and from tropospheric delay file if exists.
## reference: Fattahi and Amelung (2015, JGR)
mintpy.velocity.excludeDate    = auto   #[exclude_date.txt / 20080520,20090817 / no], auto for exclude_date.txt
mintpy.velocity.startDate      = auto   #[20070101 / no], auto for no
mintpy.velocity.endDate        = auto   #[20101230 / no], auto for no
.IP
## Bootstrapping
## reference: Efron and Tibshirani (1986, Stat. Sci.)
mintpy.velocity.bootstrap      = auto   #[yes / no], auto for no, use bootstrap
mintpy.velocity.bootstrapCount = auto   #[int>1], auto for 400, number of iterations for bootstrapping
.SS "references:"
.IP
Fattahi, H., and F. Amelung (2015), InSAR bias and uncertainty due to the systematic and stochastic
tropospheric delay, Journal of Geophysical Research: Solid Earth, 120(12), 8758\-8773, doi:10.1002/2015JB012419.
.IP
Efron, B., and R. Tibshirani (1986), Bootstrap methods for standard errors, confidence intervals,
and other measures of statistical accuracy, Statistical science, 54\-75, doi:10.1214/ss/1177013815.
.SS "example:"
.TP
timeseries2velocity.py
timeseries_ERA5_demErr.h5
.TP
timeseries2velocity.py
timeseries_ERA5_demErr_ramp.h5  \fB\-t\fR KyushuT73F2980_2990AlosD.template
.TP
timeseries2velocity.py
timeseries.h5  \fB\-\-start\-date\fR 20080201  \fB\-\-end\-date\fR 20100508
.TP
timeseries2velocity.py
timeseries.h5  \fB\-\-exclude\fR exclude_date.txt
.TP
timeseries2velocity.py
LS\-PARAMS.h5
.TP
timeseries2velocity.py
NSBAS\-PARAMS.h5
.TP
timeseries2velocity.py
TS\-PARAMS.h5
.IP
# bootstrapping for STD calculation
timeseries2velocity.py timeseries_ERA5_demErr.h5 \fB\-\-bootstrap\fR
.IP
# complex time functions
timeseries2velocity.py timeseries_ERA5_ramp_demErr.h5 \fB\-\-poly\fR 3 \fB\-\-period\fR 1 0.5 \fB\-\-step\fR 20170910
timeseries2velocity.py timeseries_ERA5_demErr.h5      \fB\-\-poly\fR 1 \fB\-\-exp\fR 20170910 90
timeseries2velocity.py timeseries_ERA5_demErr.h5      \fB\-\-poly\fR 1 \fB\-\-log\fR 20170910 60.4
timeseries2velocity.py timeseries_ERA5_demErr.h5      \fB\-\-poly\fR 1 \fB\-\-log\fR 20170910 60.4 200 \fB\-\-log\fR 20171026 200.7