positional arguments:¶

file

time-series file to display i.e.: timeseries_ERA5_ramp_demErr.h5 (MintPy)

LS-PARAMS.h5 (GIAnT)

S1_IW12_128_0593_0597_20141213_20180619.he5 (HDF-EOS5)

options:¶

-h, --help

show this help message and exit

--label [FILE_LABEL ...]

labels to display for multiple input files

--ylim YMIN YMAX

Y limits for point plotting.

--tick-right

set tick and tick label to the right

-l LOOKUP_FILE, --lookup LOOKUP_FILE

lookup table file

-n NUM

Epoch/slice number for initial display.

--error ERROR_FILE

txt file with error for each date.

--start-date START_DATE

start date of displacement to display

--end-date END_DATE

end date of displacement to display

--exclude [EX_DATE_LIST ...], --ex [EX_DATE_LIST ...]

Exclude date shown as gray.

--zf, --zero-first

Set displacement at first acquisition to zero.

--off OFFSET, --offset OFFSET

Offset for each timeseries file.

--noverbose

Disable the verbose message printing.

--nomodel, --nofit

Do not plot the prediction of the time function (deformation model) fitting.

--plot-model-conf-int, --plot-fit-conf-int

Plot the time function prediction confidence intervals. [!-- Preliminary feature alert! --!] [!-- This feature is NOT throughly checked. Read the code before use. Interpret at your own risk! --!]

--ram MAXMEMORY, --memory MAXMEMORY

Max amount of memory in GB to use (default: 4.0). Adjust according to your computer memory.

Deformation Model:¶

A suite of time functions

--poly POLYNOMIAL, --polynomial POLYNOMIAL, --poly-order POLYNOMIAL

a polynomial function with the input degree (default: 1). E.g.: --poly 1 # linear --poly 2 # quadratic --poly 3 # cubic

--periodic PERIODIC [PERIODIC ...], --period PERIODIC [PERIODIC ...], --peri PERIODIC [PERIODIC ...]

periodic function(s) with period in decimal years (default: []). E.g.: --periodic 1.0 # an annual cycle --periodic 1.0 0.5 # an annual cycle plus a semi-annual cycle

--step STEP [STEP ...]

step function(s) at YYYYMMDD (default: []). E.g.: --step 20061014 # coseismic step at 2006-10-14T00:00 --step 20110311 20120928T1733 # coseismic steps at 2011-03-11T00:00 and 2012-09-28T17:33

--exp EXP [EXP ...], --exponential EXP [EXP ...]

exponential function(s) at YYYYMMDD with characteristic time(s) tau in decimal days (default: []). E.g.: --exp 20181026 60 # exp onset at 2006-10-14T00:00 with tau=60 days --exp 20181026T1355 60 120 # exp onset at 2006-10-14T13:55 with tau=60 days overlayed by a tau=145 days --exp 20161231 80.5 --exp 20190125 100 # 1st exp onset at 2011-03-11 with tau=80.5 days and

# 2nd exp onset at 2012-09-28 with tau=100

days

--log LOG [LOG ...], --logarithmic LOG [LOG ...]

logarithmic function(s) at YYYYMMDD with characteristic time(s) tau in decimal days (default: []). E.g.: --log 20181016 90.4 # log onset at 2006-10-14T00:00 with tau=90.4 days --log 20181016T1733 90.4 240 # log onset at 2006-10-14T17:33 with tau=90.4 days overlayed by a tau=240 days --log 20161231 60 --log 20190125 180.2 # 1st log onset at 2011-03-11 with tau=60 days and

# 2nd log onset at 2012-09-28 with tau=180.2 days

Pixel Input:¶

--yx Y X

initial pixel to plot in Y/X coord

--lalo LAT LON

initial pixel to plot in lat/lon coord

--marker MARKER

marker style (default: o).

--ms MARKER_SIZE, --markersize MARKER_SIZE

marker size (default: 6.0).

--lw LINEWIDTH, --linewidth LINEWIDTH

line width (default: 0).

--ew EDGE_WIDTH, --edgewidth EDGE_WIDTH

Edge width for the error bar (default: 1.0)

Data Display Options:¶

Options to adjust the dataset display

-v VMIN VMAX, --vlim VMIN VMAX

Display limits for matrix plotting.

-u UNIT, --unit UNIT

unit for display. Its priority > wrap

--nd NO_DATA_VALUE, --no-data-val NO_DATA_VALUE, --no-data-value NO_DATA_VALUE

Specify the no-data-value to be ignored and masked.

--wrap

re-wrap data to display data in fringes.

--wrap-range MIN MAX

range of one cycle after wrapping (default: [-3.141592653589793, 3.141592653589793]).

--flip-lr

flip left-right

--flip-ud

flip up-down

--noflip

turn off auto flip for radar coordinate file

--nmli NUM, --num-multilook NUM, --multilook-num NUM

multilook data in X and Y direction with a factor for display (default: 1).

--nomultilook, --no-multilook

do not multilook, for high quality display. If multilook is True and multilook_num=1, multilook_num will be estimated automatically. Useful when displaying big datasets.

--alpha TRANSPARENCY

Data transparency. 0.0 - fully transparent, 1.0 - no transparency.

DEM:¶

display topography in the background

-d DEM_FILE, --dem DEM_FILE

DEM file to show topography as background

--mask-dem

Mask out DEM pixels not coincident with valid data pixels

--dem-noshade

do not show DEM shaded relief

--dem-nocontour

do not show DEM contour lines

--contour-smooth DEM_CONTOUR_SMOOTH

Background topography contour smooth factor - sigma of Gaussian filter. Set to 0.0 for no smoothing; (default: 3.0).

--contour-step NUM

Background topography contour step in meters (default: 200.0).

--contour-linewidth NUM

Background topography contour linewidth (default: 0.5).

--shade-az DEG

The azimuth (0-360, degrees clockwise from North) of the light source (default: 315.0).

--shade-alt DEG

The altitude (0-90, degrees up from horizontal) of the light source (default: 45.0).

--shade-min MIN

The min height in m of colormap of shaded relief topography (default: -4000.0).

--shade-max MAX

The max height of colormap of shaded relief topography (default: max(DEM)+2000).

--shade-exag SHADE_EXAG

Vertical exaggeration ratio (default: 0.5).

Figure:¶

Figure settings for display

--fontsize FONT_SIZE

font size

--fontcolor FONT_COLOR

font color (default: k).

--nowhitespace

do not display white space

--noaxis

do not display axis

--notick

do not display tick in x/y axis

-c COLORMAP, --colormap COLORMAP

colormap used for display, i.e. jet, cmy, RdBu, hsv, jet_r, temperature, viridis, etc. More at https://mintpy.readthedocs.io/en/latest/api/colormaps/

--cm-lut NUM, --cmap-lut NUM

number of increment of colormap lookup table (default: 256).

--cm-vlist CMAP_VLIST CMAP_VLIST CMAP_VLIST, --cmap-vlist CMAP_VLIST CMAP_VLIST CMAP_VLIST

list of 3 float numbers, for truncated colormap only (default: [0.0, 0.7, 1.0]).

--nocbar, --nocolorbar

do not display colorbar

--cbar-nbins NUM

number of bins for colorbar.

--cbar-ext {None,both,neither,max,min}

Extend setting of colorbar; based on data stat by default.

--cbar-label CBAR_LABEL

colorbar label

--cbar-loc CBAR_LOC

colorbar location for single plot (default: right).

--cbar-size CBAR_SIZE

colorbar size and pad (default: 2%).

--notitle

do not display title

--title-in

draw title in/out of axes

--figtitle FIG_TITLE

Title shown in the figure.

--title4sen, --title4sentinel1

display Sentinel-1 A/B and IPF info in title.

--figsize WID LEN

figure size in inches - width and length

--dpi DPI

DPI - dot per inch - for display/write (default: 300).

--figext {.emf,.eps,.pdf,.png,.ps,.raw,.rgba,.svg,.svgz}

File extension for figure output file (default: .png).

--fignum NUM

number of figure windows

--nrows NUM

subplot number in row

--ncols NUM

subplot number in column

--wspace FIG_WID_SPACE

width space between subplots in inches

--hspace FIG_HEI_SPACE

height space between subplots in inches

--no-tight-layout

disable automatic tight layout for multiple subplots

--coord {radar,geo}

Display in radar/geo coordination system (for geocoded file only; default: geo).

--animation

enable animation mode

GPS:¶

GPS data to display

--show-gps

Show UNR GPS location within the coverage.

--mask-gps

Mask out GPS stations not coincident with valid data pixels

--gps-label

Show GPS site name

--gps-ms GPS_MARKER_SIZE

Plot GPS value as scatter in size of ms**2 (default: 6).

--gps-comp {up2los,vert,enu2los,hz2los,horz}

Plot GPS in color indicating deformation velocity direction

--gps-redo

Re-calculate GPS observations in LOS direction, instead of read from existing CSV file.

--ref-gps REF_GPS_SITE

Reference GPS site

--ex-gps [EX_GPS_SITES ...]

Exclude GPS sites, require --gps-comp.

--gps-start-date YYYYMMDD

start date of GPS data, default is date of the 1st SAR acquisition

--gps-end-date YYYYMMDD

start date of GPS data, default is date of the last SAR acquisition

--horz-az HORZ_AZ_ANGLE, --hz-az HORZ_AZ_ANGLE

Azimuth angle (anti-clockwise from the north) of the horizontal movement in degrees E.g.: -90. for east direction [default]

0.

for north direction

Set to the azimuth angle of the strike-slip fault to show the fault-parallel displacement.

Mask:¶

Mask file/options

-m FILE, --mask FILE

mask file for display. "no" to turn OFF masking.

--mask-vmin MASK_VMIN

hide pixels with mask value < vmin (default: None).

--mask-vmax MASK_VMAX

hide pixels with mask value > vmax (default: None).

--zm, --zero-mask

mask pixels with zero value.

Map:¶

for one subplot in geo-coordinates only

--coastline {10m,110m,50m}

Draw coastline with specified resolution (default: None). This will enable --lalo-label option. Link: https://scitools.org.uk/cartopy/docs/latest/matplotlib/geoaxes.html#cartopy.mpl.geoaxes.GeoAxes.coastlines

--lalo-label

Show N, S, E, W tick label for plot in geo-coordinate. Useful for final figure output.

--lalo-step DEG

Lat/lon step for lalo-label option.

--lalo-max-num NUM

Maximum number of lalo tick label (default: 3).

--lalo-loc left right top bottom

Draw lalo label in [left, right, top, bottom] (default: [1, 0, 0, 1]).

--scalebar LEN X Y

scale bar distance and location in ratio (default: [0.2, 0.2, 0.1]). distance in ratio of total width location in X/Y in ratio with respect to the lower left corner

--scalebar 0.2 0.2 0.1

#for lower left corner

--scalebar 0.2 0.2 0.8

#for upper left corner

--scalebar 0.2 0.8 0.1

#for lower right corner

--scalebar 0.2 0.8 0.8

#for upper right corner

--noscalebar, --nosbar

do not display scale bar.

--scalebar-pad SCALEBAR_PAD, --sbar-pad SCALEBAR_PAD

scale bar label pad in ratio of scalebar width (default: 0.05).

Reference:¶

Show / Modify reference in time and space for display

--ref-date DATE

Change reference date for display

--ref-lalo LAT LON

Change reference point LAT LON for display

--ref-yx Y X

Change reference point Y X for display

--noreference

do not show reference point

--ref-marker REF_MARKER

marker of reference pixel (default: ks).

--ref-size NUM

marker size of reference point (default: 6).

Save/Output:¶

Save figure and write to file(s)

-o [OUTFILE ...], --outfile [OUTFILE ...]

save the figure with assigned filename. By default, it's calculated based on the input file name.

--save

save the figure

--nodisplay

save and do not display the figure

--update

enable update mode for save figure: skip running if 1) output file already exists AND 2) output file is newer than input file.

Subset:¶

Display dataset in subset range

--sub-x XMIN XMAX, --subx XMIN XMAX, --subset-x XMIN XMAX

subset display in x/cross-track/range direction

--sub-y YMIN YMAX, --suby YMIN YMAX, --subset-y YMIN YMAX

subset display in y/along-track/azimuth direction

--sub-lat LATMIN LATMAX, --sublat LATMIN LATMAX, --subset-lat LATMIN LATMAX

subset display in latitude

--sub-lon LONMIN LONMAX, --sublon LONMIN LONMAX, --subset-lon LONMIN LONMAX

subset display in longitude

example:¶

tsview.py timeseries.h5 tsview.py timeseries.h5 --wrap tsview.py timeseries.h5 --yx 300 400 --zero-first --nodisplay tsview.py geo_timeseries.h5 --lalo 33.250 131.665 --nodisplay tsview.py slcStack.h5 -u dB -v 20 60 -c gray

# press left / right key to slide images

# multiple time-series files tsview.py timeseries_ERA5_ramp_demErr.h5 timeseries_ERA5_ramp.h5 timeseries_ERA5.h5 timeseries.h5 --off 5 tsview.py timeseries_ERA5_ramp_demErr.h5 ../GIANT/Stack/LS-PARAMS.h5 --off 5 --label mintpy giant