watex.utils.plot_tensors#

watex.utils.plot_tensors(z_or_edis_obj_list, /, station='S00', zplot=False, **kwargs)[source]#

Plot resistivity and phase tensors or the real and imaginary impedance.

Plots the real and imaginary impedance and induction vector if present.

Parameters:

z_or_edis_obj_list (list of watex.edi.Edi or watex.externals.z.Z) – A collection of EDI- or Impedances tensors objects.
station (int, default='S00') – Station to visualize the resistivity, phases or impendances tensors. Default is the first station. Note that station counting start from index equal to 0.
zplot (bool, default=False,) – Visualize the impedance tensors values Z.

kwargs: Additional keywords arguments

To get further details about the way to control the plot, refer to the following attributes.

Attributes	Description
color_mode	[ ‘color’ \| ‘bw’ ] color or black and white plots
cted	color for data Z_XX and Z_XY mode
ctem	color for model Z_XX and Z_XY mode
ctmd	color for data Z_YX and Z_YY mode
ctmm	color for model Z_YX and Z_YY mode
data_fn	full path to data file
data_object	WSResponse instance
e_capsize	cap size of error bars in points (default is .5)
e_capthick	cap thickness of error bars in points (default is 1)
fig_dpi	resolution of figure in dots-per-inch (300)
fig_list	list of matplotlib.figure instances for plots
fig_size	size of figure in inches (default is [6, 6])
font_size	size of font for tick labels, axes labels are font_size+2 (default is 7)
legend_border_axes_pad	padding between legend box and axes
legend_border_pad	padding between border of legend and symbols
legend_handle_text_pad	padding between text labels and symbols of legend
legend_label_spacing	padding between labels
legend_loc	location of legend
legend_marker_scale	scale of symbols in legend
lw	line width data curves (default is .5)
ms	size of markers (default is 1.5)
lw_r	line width response curves (default is .5)
ms_r	size of markers response curves (default is 1.5)
mted	marker for data Z_XX and Z_XY mode
mtem	marker for model Z_XX and Z_XY mode
mtmd	marker for data Z_YX and Z_YY mode
mtmm	marker for model Z_YX and Z_YY mode
phase_limits	limits of phase
plot_component	[ 2 \| 4 ] 2 for TE and TM or 4 for all components
plot_style	[ 1 \| 2 ] 1 to plot each mode in a seperate subplot and 2 to plot xx, xy and yx, yy in same plots
plot_type	[ ‘1’ \| list of station name ] ‘1’ to plot all stations in data file or input a list of station names to plot if station_fn is input, otherwise input a list of integers associated with the index with in the data file, ie 2 for 2nd station
plot_z	[ True \| False ] default is True to plot impedance, False for plotting resistivity and phase
plot_yn	[ ‘n’ \| ‘y’ ] to plot on instantiation
res_limits	limits of resistivity in linear scale
resp_fn	full path to response file
resp_object	WSResponse object for resp_fn, or list of WSResponse objects if resp_fn is a list of response files
station_fn	full path to station file written by WSStation
subplot_bottom	space between axes and bottom of figure
subplot_hspace	space between subplots in vertical direction
subplot_left	space between axes and left of figure
subplot_right	space between axes and right of figure
subplot_top	space between axes and top of figure
subplot_wspace	space between subplots in horizontal direction

Examples

>>> import watex as wx
>>> edi_data = wx.fetch_data ('edis', samples= 17 , return_data =True )
>>> wx.utils.plotutils.plot_tensors ( edi_data, station =4 )