autofig.call.Mesh.init (function)

def __init__(self, x=None, y=None, z=None, fc=None, ec=None, i=None, xerror=None, xunit=None, xlabel=None, xnormals=None, yerror=None, yunit=None, ylabel=None, ynormals=None, zerror=None, zunit=None, zlabel=None, znormals=None, fcunit=None, fclabel=None, fcmap=None, ecunit=None, eclabel=None, ecmap=None, iunit=None, itol=0.0, axorder=None, axpos=None, title=None, label=None, linestyle=None, consider_for_limits=True, uncover=True, trail=0, exclude_back=False, **kwargs)

Create a autofig.call.Mesh object which defines a single call to matplotlib.

See also:

• autofig.call.Plot

Arguments

• x (list/array, optional, default=None): array of values for the x-axes. Access via autofig.call.Mesh.x.
• y (list/array, optional, default=None): array of values for the y-axes. Access via autofig.call.Mesh.y.
• z (list/array, optional, default=None): array of values for the z-axes. Access via autofig.call.Mesh.z
• fc or facecolor (list/array, optional, default=None): array of values for the facecolor-direction. Access via autofig.call.Mesh.fc. Note: facecolor takes precedence over fc if both are provided.
• ec or edgecolor (list/array, optional, default=None): array of values for the edgecolor-direction. Access via autofig.call.Mesh.ec. Note: edgecolor takes precedence over ec if both are provided.
• i (list/array or string, optional, default=None): array of values for the independent-variable. If a string, can be one of: 'x', 'y', 'z', 'fc', 'ec' to reference an existing array. Access via autofig.call.Mesh.i.
• xerror (float or list/array, optional, default=None): errors for x. See autofig.call.Mesh.x and autofig.call.CallDimensionX.error.
• xunit (string or astropy unit, optional, default=None): units for x. See autofig.call.Mesh.x and autofig.call.CallDimensionX.unit.
• xlabel (strong, optional, default=None): label for x. See autofig.call.Mesh.x and autofig.call.CallDimensionX.label.
• xnormals (list/array, optional, default=None): normals for x. Currently ignored. See autofig.call.Mesh.x and autofig.call.CallDimensionX.normals.
• yerror (float or list/array, optional, default=None): errors for y. See autofig.call.Mesh.y and autofig.call.CallDimensionY.error.
• yunit (string or astropy unit, optional, default=None): units for y. See autofig.call.Mesh.y and autofig.call.CallDimensionY.unit.
• ylabel (strong, optional, default=None): label for y. See autofig.call.Mesh.y and autofig.call.CallDimensionY.label.
• ynormals (list/array, optional, default=None): normals for y. Currently ignored. See autofig.call.Mesh.y and autofig.call.CallDimensionY.normals.
• zerror (float or list/array, optional, default=None): errors for z. See autofig.call.Mesh.z and autofig.call.CallDimensionZ.error.
• zunit (string or astropy unit, optional, default=None): units for z. See autofig.call.Mesh.z and autofig.call.CallDimensionZ.unit.
• zlabel (strong, optional, default=None): label for x. See autofig.call.Mesh.z and autofig.call.CallDimensionZ.label.
• znormals (list/array, optional, default=None): normals for z. If provided then the back of the mesh can be ignored by setting exclude_back=True. See autofig.call.Mesh.z and autofig.call.CallDimensionZ.normals.
• fcerror (float or list/array, optional, default=None): errors for fc. See autofig.call.Mesh.fc and autofig.call.CallDimensionC.error.
• fcunit (string or astropy unit, optional, default=None): units for fc. See autofig.call.Mesh.fc and autofig.call.CallDimensionC.unit.
• fclabel (strong, optional, default=None): label for fc. See autofig.call.Mesh.fc and autofig.call.CallDimensionC.label.
• ecerror (float or list/array, optional, default=None): errors for ec. See autofig.call.Mesh.ec and autofig.call.CallDimensionC.error.
• ecunit (string or astropy unit, optional, default=None): units for ec. See autofig.call.Mesh.ec and autofig.call.CallDimensionC.unit.
• eclabel (strong, optional, default=None): label for ec. See autofig.call.Mesh.ec and autofig.call.CallDimensionC.label.
• iunit (string or astropy unit, optional, default=None): units for i. See autofig.call.Mesh.i and autofig.call.CallDimensionI.unit.
• itol (float, optional, default=0.0): see autofig.call.DimensionI.tol.
• axorder (int, optional, default=None): see autofig.call.Mesh.axorder.
• axpos (tuple, optional, default=None): see autofig.call.Mesh.axpos.
• title (string, optional, default=None): see autofig.call.Mesh.title.
• label (string, optional, default=None): see autofig.call.Mesh.label.
• linestyle or ls (string, optional, default='solid'): see autofig.call.Mesh.linestyle. Note: linestyle takes precedence over ls if both are provided. So technically ls defaults to 'solid' and linestyle defaults to None.
• consider_for_limits (bool, optional, default=True): see autofig.call.Call.consider_for_limits.
• exclude_back (bool, optional, default=False): whether to exclude any elements pointing away from the screen. This will be ignored for 3d projections or if znormals is not provided. Setting this to True can save significant time in drawing the mesh in matplotlib, and is especially useful for closed surfaces if fc is not 'none'.
• **kwargs: additional keyword arguments are stored and passed on when attaching to a parent axes. See autofig.axes.Axes.add_call.

Returns

• the instantiated autofig.call.Mesh object.