"""
wiggle - Plot z=f(x,y) anomalies along tracks.
"""
import warnings
from pygmt.clib import Session
from pygmt.exceptions import GMTInvalidInput
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
@fmt_docstring
@use_alias(
B="frame",
D="position",
G="color",
J="projection",
R="region",
T="track",
V="verbose",
W="pen",
Z="scale",
b="binary",
c="panel",
d="nodata",
e="find",
f="coltypes",
g="gap",
h="header",
i="incols",
p="perspective",
t="transparency",
w="wrap",
)
@kwargs_to_strings(R="sequence", c="sequence_comma", i="sequence_comma", p="sequence")
def wiggle(
self,
data=None,
x=None,
y=None,
z=None,
fillpositive=None,
fillnegative=None,
**kwargs,
):
r"""
Plot z=f(x,y) anomalies along tracks.
Takes a matrix, (x, y, z) triplets, or a file name as input and plots z
as a function of distance along track.
Must provide either ``data`` or ``x``, ``y``, and ``z``.
Full option list at :gmt-docs:`wiggle.html`
{aliases}
Parameters
----------
x/y/z : 1-D arrays
The arrays of x and y coordinates and z data points.
data : str or {table-like}
Pass in either a file name to an ASCII data table, a 2-D
{table-classes}.
Use parameter ``incols`` to choose which columns are x, y, z,
respectively.
{projection}
{region}
scale : str or float
Give anomaly scale in data-units/distance-unit. Append **c**, **i**,
or **p** to indicate the distance unit (centimeters, inches, or
points); if no unit is given we use the default unit that is
controlled by :gmt-term:`PROJ_LENGTH_UNIT`.
{frame}
position : str
[**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\
**+w**\ *length*\ [**+j**\ *justify*]\ [**+al**\|\ **r**]\
[**+o**\ *dx*\ [/*dy*]][**+l**\ [*label*]].
Define the reference point on the map for the vertical scale bar.
fillpositive : str
Set color or pattern for filling positive wiggles
[Default is no fill].
fillnegative : str
Set color or pattern for filling negative wiggles
[Default is no fill].
track : str
Draw track [Default is no track]. Append pen attributes to use
[Default is ``"0.25p,black,solid"``].
{verbose}
pen : str
Specify outline pen attributes [Default is no outline].
{binary}
{panel}
{nodata}
{find}
{coltypes}
{gap}
{header}
{incols}
{perspective}
{transparency}
{wrap}
"""
kwargs = self._preprocess(**kwargs) # pylint: disable=protected-access
if (fillpositive or fillnegative) and kwargs.get("G") is not None:
raise GMTInvalidInput("Use either fillpositive/fillnegative or color.")
if kwargs.get("G") is not None:
msg = (
"The 'color' parameter has been deprecated since v0.8.0"
" and will be removed in v0.12.0. Use fillpositive/fillnegative"
" instead."
)
warnings.warn(msg, category=FutureWarning, stacklevel=2)
if fillpositive or fillnegative:
kwargs["G"] = []
if fillpositive:
kwargs["G"].append(fillpositive + "+p")
if fillnegative:
kwargs["G"].append(fillnegative + "+n")
with Session() as lib:
# Choose how data will be passed in to the module
file_context = lib.virtualfile_from_data(
check_kind="vector", data=data, x=x, y=y, z=z, required_z=True
)
with file_context as fname:
lib.call_module(
module="wiggle", args=build_arg_string(kwargs, infile=fname)
)