RectilinearMesh2D_stitched

digraph inheritance9774ecb1cc { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "Mesh" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Abstract Base Class"]; "myObject" -> "Mesh" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RectilinearMesh2D" [URL="RectilinearMesh2D.html#geobipy.src.classes.mesh.RectilinearMesh2D.RectilinearMesh2D",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class defining a 2D rectilinear mesh with cell centres and edges."]; "Mesh" -> "RectilinearMesh2D" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RectilinearMesh2D_stitched" [URL="#geobipy.src.classes.mesh.RectilinearMesh2D_stitched.RectilinearMesh2D_stitched",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class defining stitched 1D rectilinear meshes."]; "RectilinearMesh2D" -> "RectilinearMesh2D_stitched" [arrowsize=0.5,style="setlinewidth(0.5)"]; "myObject" [URL="../core/myObject.html#geobipy.src.classes.core.myObject.myObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ABC" -> "myObject" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

@RectilinearMesh2D_Class Module describing a 2D Rectilinear Mesh class with x and y axes specified

class geobipy.src.classes.mesh.RectilinearMesh2D_stitched.RectilinearMesh2D_stitched(max_cells, x=None, relative_to=None, nCells=None, **kwargs)

Class defining stitched 1D rectilinear meshes.

createHdf(parent, name, withPosterior=True, add_axis=None, fillvalue=None, upcast=False): Create the hdf group metadata in file parent: HDF object to create a group inside myName: Name of the group

classmethod fromHdf(grp, index=None, skip_posterior=False): Reads in the object from a HDF file

property nCells

The number of cells in the mesh.

Returns:: out – Number of cells
Return type:: int

pcolor(values, **kwargs)

Create a pseudocolour plot of a 2D array using the mesh.

Parameters:

values (array_like or StatArray) – A 2D array of colour values.
xAxis (str) – If xAxis is ‘x’, the horizontal xAxis uses self.x If xAxis is ‘y’, the horizontal xAxis uses self.y If xAxis is ‘r’, the horizontal xAxis uses cumulative distance along the line
zAxis (str) – If zAxis is ‘absolute’ the vertical axis is the relative_to plus z. If zAxis is ‘relative’ the vertical axis is z.
alpha (scalar or array_like, optional) – If alpha is scalar, behaves like standard matplotlib alpha and opacity is applied to entire plot If array_like, each pixel is given an individual alpha value.
log ('e' or float, optional) – Take the log of the colour to a base. ‘e’ if log = ‘e’, and a number e.g. log = 10. Values in c that are <= 0 are masked.
equalize (bool, optional) – Equalize the histogram of the colourmap so that all colours have an equal amount.
nbins (int, optional) – Number of bins to use for histogram equalization.
xscale (str, optional) – Scale the x axis? e.g. xscale = ‘linear’ or ‘log’
yscale (str, optional) – Scale the y axis? e.g. yscale = ‘linear’ or ‘log’.
flipX (bool, optional) – Flip the X axis
flipY (bool, optional) – Flip the Y axis
grid (bool, optional) – Plot the grid
noColorbar (bool, optional) – Turn off the colour bar, useful if multiple plotting plotting routines are used on the same figure.
trim (bool, optional) – Set the x and y limits to the first and last non zero values along each axis.

Returns:

matplotlib .Axes

Return type:

ax