pygmt.Figure.velo
- Figure.velo(data=None, *, vector=None, frame=None, cmap=None, rescale=None, uncertaintyfill=None, fill=None, scale=None, shading=None, projection=None, line=None, no_clip=None, region=None, spec=None, verbose=None, pen=None, zvalue=None, panel=None, nodata=None, find=None, header=None, incols=None, perspective=None, transparency=None, **kwargs)
Plot velocity vectors, crosses, anisotropy bars, and wedges.
Reads data values from files,
numpy.ndarrayorpandas.DataFrameand plots the selected geodesy symbol on a map. You may choose from velocity vectors and their uncertainties, rotational wedges and their uncertainties, anisotropy bars, or strain crosses. Symbol fills or their outlines may be colored based on constant parameters or via color lookup tables.Must provide
dataandspec.Full option list at https://docs.generic-mapping-tools.org/6.5/supplements/geodesy/velo.html
Aliases:
A = vector
B = frame
C = cmap
D = rescale
E = uncertaintyfill
G = fill
H = scale
I = shading
J = projection
L = line
N = no_clip
R = region
S = spec
V = verbose
W = pen
Z = zvalue
c = panel
d = nodata
e = find
h = header
i = incols
p = perspective
t = transparency
- Parameters:
data (str, numpy.ndarray, pandas.DataFrame, xarray.Dataset, or geopandas.GeoDataFrame) – Pass in either a file name to an ASCII data table, a 2-D
numpy.ndarray, apandas.DataFrame, anxarray.Datasetmade up of 1-Dxarray.DataArraydata variables, or ageopandas.GeoDataFramecontaining the tabular data. Note that text columns are only supported with file orpandas.DataFrameinputs.spec (str) –
Select the meaning of the columns in the data file and the figure to be plotted. In all cases, the scales are in data units per length unit and sizes are in length units (default length unit is controlled by PROJ_LENGTH_UNIT unless c, i, or p is appended).
e[velscale/]confidence[+ffont]
Velocity ellipses in (N,E) convention. The velscale sets the scaling of the velocity arrows. If velscale is not given then we read it from the data file as an extra column. The confidence sets the 2-dimensional confidence limit for the ellipse, e.g. 0.95 for 95% confidence ellipse. Use +f to set the font and size of the text [Default is 9p,Helvetica,black]; give +f0 to deactivate labeling. The arrow will be drawn with the pen attributes specified by the
penparameter and the arrow-head can be colored viafill. The ellipse will be filled with the color or pattern specified by theuncertaintyfillparameter [Default is transparent], and its outline will be drawn iflineis selected using the pen selected (bypenif not given byline). Parameters are expected to be in the following columns:1,2: longitude, latitude of station
3,4: eastward, northward velocity
5,6: uncertainty of eastward, northward velocities (1-sigma)
7: correlation between eastward and northward components
Trailing text: name of station (optional)
n[barscale]
Anisotropy bars. barscale sets the scaling of the bars. If barscale is not given then we read it from the data file as an extra column. Parameters are expected to be in the following columns:
1,2: longitude, latitude of station
3,4: eastward, northward components of anisotropy vector
r[velscale/]confidence[+ffont]
Velocity ellipses in rotated convention. The velscale sets the scaling of the velocity arrows. If velscale is not given then we read it from the data file as an extra column. The confidence sets the 2-dimensional confidence limit for the ellipse, e.g. 0.95 for 95% confidence ellipse. Use +f to set the font and size of the text [Default is 9p,Helvetica,black]; give +f0 to deactivate labeling. The arrow will be drawn with the pen attributes specified by the
penparameter and the arrow-head can be colored viafill. The ellipse will be filled with the color or pattern specified by theuncertaintyfillparameter [Default is transparent], and its outline will be drawn iflineis selected using the pen selected (bypenif not given byline). Parameters are expected to be in the following columns:1,2: longitude, latitude of station
3,4: eastward, northward velocity
5,6: semi-major, semi-minor axes
7: counter-clockwise angle, in degrees, from horizontal axis to major axis of ellipse.
Trailing text: name of station (optional)
w[wedgescale/]wedgemag
Rotational wedges. The wedgescale sets the size of the wedges. If wedgescale is not given then we read it from the data file as an extra column. Rotation values are multiplied by wedgemag before plotting. For example, setting wedgemag to 1.e7 works well for rotations of the order of 100 nanoradians/yr. Use
fillto set the fill color or pattern for the wedge, anduncertaintyfillto set the color or pattern for the uncertainty. Parameters are expected to be in the following columns:1,2: longitude, latitude of station
3: rotation in radians
4: rotation uncertainty in radians
x[cross_scale]
Strain crosses. The cross_scale sets the size of the cross. If cross_scale is not given then we read it from the data file as an extra column. Parameters are expected to be in the following columns:
1,2: longitude, latitude of station
3: eps1, the most extensional eigenvalue of strain tensor, with extension taken positive.
4: eps2, the most compressional eigenvalue of strain tensor, with extension taken positive.
5: azimuth of eps2 in degrees CW from North.
projection (str) – projcode[projparams/]width|scale. Select map projection.
region (str or list) – xmin/xmax/ymin/ymax[+r][+uunit]. Specify the region of interest.
vector (bool or str) – Modify vector parameters. For vector heads, append vector head size [Default is 9p]. See https://docs.generic-mapping-tools.org/6.5/supplements/geodesy/velo.html#vector-attributes for specifying additional attributes.
frame (bool, str, or list) – Set map boundary frame and axes attributes.
cmap (str) – File name of a CPT file or a series of comma-separated colors (e.g., color1,color2,color3) to build a linear continuous CPT from those colors automatically.
rescale (str) – Can be used to rescale the uncertainties of velocities (
spec="e"andspec="r") and rotations (spec="w"). Can be combined with theconfidencevariable.uncertaintyfill (str) – Set color or pattern for filling uncertainty wedges (
spec="w") or velocity error ellipses (spec="e"orspec="r"). Ifuncertaintyfillis not specified, the uncertainty regions will be transparent. Note: Usingcmapandzvalue="+e"will update the uncertainty fill color based on the selected measure inzvalue[Default is magnitude error]. More details at https://docs.generic-mapping-tools.org/6.5/reference/features.html#gfill-attrib.fill (str) – Set color or pattern for filling symbols [Default is no fill]. Note: Using
cmap(and optionallyzvalue) will update the symbol fill color based on the selected measure inzvalue[Default is magnitude]. More details at https://docs.generic-mapping-tools.org/6.5/reference/features.html#gfill-attrib.scale (float or bool) – [scale]. Scale symbol sizes and pen widths on a per-record basis using the scale read from the data set, given as the first column after the (optional) z and size columns [Default is no scaling]. The symbol size is either provided by
specor via the input size column. Alternatively, append a constant scale that should be used instead of reading a scale column.shading (float or bool) – intens. Use the supplied intens value (nominally in the -1 to +1 range) to modulate the symbol fill color by simulating illumination [Default is none]. If intens is not provided we will instead read the intensity from an extra data column after the required input columns determined by
spec.line (str) – [pen[+c[f|l]]]. Draw lines. Ellipses and rotational wedges will have their outlines drawn using the current pen (see
pen). Alternatively, append a separate pen to use for the error outlines. If the modifier +cl is appended then the color of the pen is updated from the CPT (seecmap). If instead modifier +cf is appended then the color from the cpt file is applied to error fill only [Default]. Use just +c to set both pen and fill color.no_clip (bool) – Do not skip symbols that fall outside the frame boundaries [Default is
False, i.e., plot symbols inside the frame boundaries only].Select verbosity level [Default is w], which modulates the messages written to stderr. Choose among 7 levels of verbosity:
q - Quiet, not even fatal error messages are produced
e - Error messages only
w - Warnings [Default]
t - Timings (report runtimes for time-intensive algorithms)
i - Informational messages (same as
verbose=True)c - Compatibility warnings
d - Debugging messages
pen (str) – [pen][+c[f|l]]. Set pen attributes for velocity arrows, ellipse circumference and fault plane edges [Default is
"0.25p,black,solid"]. If the modifier +cl is appended then the color of the pen is updated from the CPT (seecmap). If instead modifier +cf is appended then the color from the cpt file is applied to symbol fill only [Default]. Use just +c to set both pen and fill color.zvalue (str) – [m|e|n|u][+e]. Select the quantity that will be used with the CPT given via
cmapto set the fill color. Choose from magnitude (vector magnitude or rotation magnitude), east-west velocity, north-south velocity, or user-supplied data column (supplied after the required columns). To instead use the corresponding error estimates (i.e., vector or rotation uncertainty) to lookup the color and paint the error ellipse or wedge instead, append +e.panel (bool, int, or list) – [row,col|index]. Select a specific subplot panel. Only allowed when in subplot mode. Use
panel=Trueto advance to the next panel in the selected order. Instead of row,col you may also give a scalar value index which depends on the order you set viaautolabelwhen the subplot was defined. Note: row, col, and index all start at 0.nodata (str) – i|onodata. Substitute specific values with NaN (for tabular data). For example,
nodata="-9999"will replace all values equal to -9999 with NaN during input and all NaN values with -9999 during output. Prepend i to the nodata value for input columns only. Prepend o to the nodata value for output columns only.find (str) – [~]“pattern” | [~]/regexp/[i]. Only pass records that match the given pattern or regular expressions [Default processes all records]. Prepend ~ to the pattern or regexp to instead only pass data expressions that do not match the pattern. Append i for case insensitive matching. This does not apply to headers or segment headers.
header (str) –
[i|o][n][+c][+d][+msegheader][+rremark][+ttitle]. Specify that input and/or output file(s) have n header records [Default is 0]. Prepend i if only the primary input should have header records. Prepend o to control the writing of header records, with the following modifiers supported:
+d to remove existing header records.
+c to add a header comment with column names to the output [Default is no column names].
+m to add a segment header segheader to the output after the header block [Default is no segment header].
+r to add a remark comment to the output [Default is no comment]. The remark string may contain \n to indicate line-breaks.
+t to add a title comment to the output [Default is no title]. The title string may contain \n to indicate line-breaks.
Blank lines and lines starting with # are always skipped.
incols (str or 1-D array) –
Specify data columns for primary input in arbitrary order. Columns can be repeated and columns not listed will be skipped [Default reads all columns in order, starting with the first (i.e., column 0)].
For 1-D array: specify individual columns in input order (e.g.,
incols=[1,0]for the 2nd column followed by the 1st column).For
str: specify individual columns or column ranges in the format start[:inc]:stop, where inc defaults to 1 if not specified, with columns and/or column ranges separated by commas (e.g.,incols="0:2,4+l"to input the first three columns followed by the log-transformed 5th column). To read from a given column until the end of the record, leave off stop when specifying the column range. To read trailing text, add the column t. Append the word number to t to ingest only a single word from the trailing text. Instead of specifying columns, useincols="n"to simply read numerical input and skip trailing text. Optionally, append one of the following modifiers to any column or column range to transform the input columns:+l to take the log10 of the input values.
+d to divide the input values by the factor divisor [Default is 1].
+s to multiple the input values by the factor scale [Default is 1].
+o to add the given offset to the input values [Default is 0].
perspective (list or str) – [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]. Select perspective view and set the azimuth and elevation angle of the viewpoint [Default is
[180, 90]]. Full documentation is at https://docs.generic-mapping-tools.org/6.5/gmt.html#perspective-full.transparency (float) – Set transparency level, in [0-100] percent range [Default is
0, i.e., opaque]. Only visible when PDF or raster format output is selected. Only the PNG format selection adds a transparency layer in the image (for further processing).
