"""plot3d - Plot in three dimensions."""frompygmt.clibimportSessionfrompygmt.exceptionsimportGMTInvalidInputfrompygmt.helpersimport(build_arg_string,data_kind,deprecate_parameter,fmt_docstring,is_nonstr_iter,kwargs_to_strings,use_alias,)frompygmt.src.whichimportwhich@fmt_docstring@deprecate_parameter("columns","incols","v0.4.0",remove_version="v0.6.0")@deprecate_parameter("sizes","size","v0.4.0",remove_version="v0.6.0")@use_alias(A="straight_line",B="frame",C="cmap",D="offset",G="color",I="intensity",J="projection",Jz="zscale",JZ="zsize",L="close",N="no_clip",Q="no_sort",R="region",S="style",V="verbose",W="pen",X="xshift",Y="yshift",Z="zvalue",a="aspatial",b="binary",c="panel",d="nodata",e="find",f="coltypes",g="gap",h="header",i="incols",l="label",p="perspective",t="transparency",w="wrap",)@kwargs_to_strings(R="sequence",c="sequence_comma",i="sequence_comma",p="sequence")defplot3d(self,x=None,y=None,z=None,data=None,size=None,direction=None,**kwargs):r""" Plot lines, polygons, and symbols in 3-D. Takes a matrix, (x,y,z) triplets, or a file name as input and plots lines, polygons, or symbols at those locations in 3-D. Must provide either ``data`` or ``x``/``y``/``z``. If providing data through ``x/y/z``, ``color`` can be a 1d array that will be mapped to a colormap. If a symbol is selected and no symbol size given, then plot3d will interpret the fourth column of the input data as symbol size. Symbols whose size is <= 0 are skipped. If no symbols are specified then the symbol code (see ``style`` below) must be present as last column in the input. If ``style`` is not used, a line connecting the data points will be drawn instead. To explicitly close polygons, use ``close``. Select a fill with ``color``. If ``color`` is set, ``pen`` will control whether the polygon outline is drawn or not. If a symbol is selected, ``color`` and ``pen`` determines the fill and outline/no outline, respectively. Full parameter list at :gmt-docs:`plot3d.html` {aliases} Parameters ---------- x/y/z : float or 1d arrays The x, y, and z coordinates, or arrays of x, y and z coordinates of the data points data : str or {table-like} Either a data file name, a 2d {table-classes}. Optionally, use parameter ``incols`` to specify which columns are x, y, z, color, and size, respectively. size : 1d array The size of the data points in units specified in ``style``. Only valid if using ``x``/``y``/``z``. direction : list of two 1d arrays If plotting vectors (using ``style='V'`` or ``style='v'``), then should be a list of two 1d arrays with the vector directions. These can be angle and length, azimuth and length, or x and y components, depending on the style options chosen. {J} zscale/zsize : float or str Set z-axis scaling or z-axis size. {R} straight_line : bool or str [**m**\|\ **p**\|\ **x**\|\ **y**]. By default, geographic line segments are drawn as great circle arcs. To draw them as straight lines, use ``straight_line``. Alternatively, add **m** to draw the line by first following a meridian, then a parallel. Or append **p** to start following a parallel, then a meridian. (This can be practical to draw a line along parallels, for example). For Cartesian data, points are simply connected, unless you append **x** or **y** to draw stair-case curves that whose first move is along *x* or *y*, respectively. **Note**: The ``straight_line`` parameter requires constant *z*-coordinates. {B} {CPT} offset : str *dx*/*dy*\ [/*dz*]. Offset the plot symbol or line locations by the given amounts *dx*/*dy*\ [/*dz*] [Default is no offset]. {G} *color* can be a 1d array, but it is only valid if using ``x``/``y`` and ``cmap=True`` is also required. intensity : float or bool or 1d array Provide an *intensity* value (nominally in the -1 to +1 range) to modulate the fill color by simulating illumination. If using ``intensity=True``, we will instead read *intensity* from the first data column after the symbol parameters (if given). *intensity* can also be a 1d array to set varying intensity for symbols, but it is only valid for ``x``/``y``/``z``. close : str [**+b**\|\ **d**\|\ **D**][**+xl**\|\ **r**\|\ *x0*]\ [**+yl**\|\ **r**\|\ *y0*][**+p**\ *pen*]. Force closed polygons. Full documentation is at :gmt-docs:`plot3d.html#l`. no_clip : bool or str [**c**\|\ **r**]. Do NOT clip symbols that fall outside map border [Default plots points whose coordinates are strictly inside the map border only]. This parameter does not apply to lines and polygons which are always clipped to the map region. For periodic (360-longitude) maps we must plot all symbols twice in case they are clipped by the repeating boundary. ``no_clip=True`` will turn off clipping and not plot repeating symbols. Use ``no_clip="r"`` to turn off clipping but retain the plotting of such repeating symbols, or use ``no_clip="c"`` to retain clipping but turn off plotting of repeating symbols. no_sort : bool Turn off the automatic sorting of items based on their distance from the viewer. The default is to sort the items so that items in the foreground are plotted after items in the background. style : str Plot symbols. Full documentation is at :gmt-docs:`plot3d.html#s`. {U} {V} {W} {XY} zvalue : str *value*\|\ *file*. Instead of specifying a symbol or polygon fill and outline color via ``color`` and ``pen``, give both a *value* via **zvalue** and a color lookup table via ``cmap``. Alternatively, give the name of a *file* with one z-value (read from the last column) for each polygon in the input data. To apply it to the fill color, use ``color='+z'``. To apply it to the pen color, append **+z** to ``pen``. {a} {b} {c} {d} {e} {f} {g} {h} {i} {l} {p} {t} *transparency* can also be a 1d array to set varying transparency for symbols, but this option is only valid if using x/y/z. {w} """# pylint: disable=too-many-localskwargs=self._preprocess(**kwargs)# pylint: disable=protected-accesskind=data_kind(data,x,y,z)extra_arrays=[]if"S"inkwargsandkwargs["S"][0]in"vV"anddirectionisnotNone:extra_arrays.extend(direction)elif("S"notinkwargsandkind=="geojson"anddata.geom_type.isin(["Point","MultiPoint"]).all()):# checking if the geometry of a geoDataFrame is Point or MultiPointkwargs["S"]="u0.2c"elif("S"notinkwargsandkind=="file"):# checking that the data is a file path to set default styletry:withopen(which(data),mode="r",encoding="utf8")asfile:line=file.readline()if("@GMULTIPOINT"inlineor"@GPOINT"inline):# if the file is gmt style and geometry is set to Pointkwargs["S"]="u0.2c"exceptFileNotFoundError:passif"G"inkwargsandnotisinstance(kwargs["G"],str):ifkind!="vectors":raiseGMTInvalidInput("Can't use arrays for color if data is matrix or file.")extra_arrays.append(kwargs["G"])delkwargs["G"]ifsizeisnotNone:ifkind!="vectors":raiseGMTInvalidInput("Can't use arrays for 'size' if data is a matrix or a file.")extra_arrays.append(size)forflagin["I","t"]:ifflaginkwargsandis_nonstr_iter(kwargs[flag]):ifkind!="vectors":raiseGMTInvalidInput(f"Can't use arrays for {plot3d.aliases[flag]} if data is matrix or file.")extra_arrays.append(kwargs[flag])kwargs[flag]=""withSession()aslib:# Choose how data will be passed in to the modulefile_context=lib.virtualfile_from_data(check_kind="vector",data=data,x=x,y=y,z=z,extra_arrays=extra_arrays,required_z=True,)withfile_contextasfname:arg_str=" ".join([fname,build_arg_string(kwargs)])lib.call_module("plot3d",arg_str)