simpeg.utils.plot2Ddata#

simpeg.utils.plot2Ddata(xyz, data, vec=False, nx=100, ny=100, ax=None, mask=None, level=False, figname=None, ncontour=10, dataloc=False, contourOpts=None, levelOpts=None, streamplotOpts=None, scale='linear', clim=None, method='linear', shade=False, shade_ncontour=100, shade_azimuth=-45.0, shade_angle_altitude=45.0, shadeOpts=None)[source]#

Interpolate and plot unstructured 2D data.

General plotting for scalar and vector quantities as a function of their x and y locations. plot2Ddata uses interpolates the unstructured data to a specified set of gridded locations before plotting with matplotlib.pyplot.contourf(). For vectors, matplotlib.pyplot.streamplot() is used to add a stream plot. As this function produces a plot for 2D data, the vertical position and vertical vector component (in the case of a vector) is ignored.

Parameters:

xyznumpy.ndarray: Data locations [x,y(,z)]. If the data locations are defined in 3D, the z-column is ignored.
datanumpy.ndarray: Data values. For scalar quantities, the data are stored in a 1D numpy.ndarray. For vector quantities, data are stored in a numpy array of shape (N, dim).
vecbool: If True, the data values represent a vector quantity and the function creates a stream plot illustrating the x and y components of the vector.
nxint: Number of grid locations along x-direction
nyint: Number of grid locations along y-direction
axmatplotlib.axes: An axes object on which to plot. If None, the function creates an axes object
masknumpy.ndarray of bool: Locations in the unstructured grid whose data are masked.
levelbool: If True, adds contours according to matplotlib.pyplot.contour()
fignamestr: Figure name
ncontourint: number of contours in the contour plot
datalocbool: If True, plot the data locations
contourOptsdict: Dictionary defining keyword arguments when matplotlib.pyplot.contourf() is called
levelOptsdict: Dictionary defining keyword arguments when matplotlib.pyplot.contourf() is called. This is only necessary when level = True.
clim(2) numpy.ndarray: Colorbar limits
methodstr: Interpolation method used to approximate at gridded locations. Must be ‘linear’ or ‘nearest’
shadebool: If True, add shading to the plot
shade_ncontourint: Number of matplotlib.pyplot.contourf() contours for the shading
shade_azimuthfloat: Azimuthal angle for the light source if shading
shade_angle_altitudefloat: Altitude angle for the light source if shading

Returns:

contmatplotlib.contour.ContourSet: The filled contour plot
axmatplotlib.axes: The axes object for the plot.
CSmatplotlib.contour.ContourSet: If the input parameter levels is True, the function outputs the level set for the contours