This module provides functions for plotting cartesian and polar plots. This class provides a basic plotting capability, with a minimum number of lines. These are all wrapper functions, based on existing functions in other Python classes. Provision is made for combinations of linear and log scales, as well as polar plots for two-dimensional graphs. The Plotter class can save files to disk in a number of formats.
See the __main__ function for examples of use.
This package was partly developed to provide additional material in support of students and readers of the book Electro-Optical System Analysis and Design: A Radiometry Perspective, Cornelius J. Willers, ISBN 9780819495693, SPIE Monograph Volume PM236, SPIE Press, 2013. http://spie.org/x648.html?product_id=2021423&origin_id=x646
Encapsulates a plotting environment, optimized for radiometry plots.
This class provides a wrapper around Matplotlib to provide a plotting environment specialised towards radiometry results. These functions were developed to provide well labelled plots by entering only one or two lines.
Provision is made for plots containing subplots (i.e. multiple plots on the same figure), linear scale and log scale plots, and cartesian and polar plots. Simple 3D line plots can also be made.
Set a sequence of default colour styles of appropriate length.
The constructor provides a sequence with length 14 pre-defined plot styles. The user can define a new sequence if required. This function modulus-folds either sequence, in case longer sequences are required.
Colours can be one of the basic colours: [‘b’, ‘g’, ‘r’, ‘c’, ‘m’, ‘y’, ‘k’] or it can be a gray shade float value between 0 and 1, such as ‘0.75’, or it can be in hex format ‘#eeefff’ or it can be one of the legal html colours. See http://html-color-codes.info/ and http://www.computerhope.com/htmcolor.htm.
- Args:
plotCol ([strings]): User-supplied listof plotting styles(can be empty []).n (int): Length of required sequence.- Returns:
A list with sequence of plot styles, of required length.- Raises:
No exception is raised.
Returns a handle to the current plot
Returns a handle to the subplot, as requested per subplot number. Subplot numbers range from 1 upwards.
- Args:
subplotNumer (int) : number of the subplot- Returns:
A handle to the requested subplot.- Raises:
No exception is raised.
Plot data on logarithmic scales for abscissa and ordinates.
Given an existing figure, this function plots in a specified subplot position. The function arguments are described below in some detail. Note that the y-values or ordinates can be more than one column, each column representing a different line in the plot. This is convenient if large arrays of data must be plotted. If more than one column is present, the label argument can contain the legend labels for each of the columns/lines. The pltaxis argument defines the min/max scale values for the x and y axes.
- Args:
plotnum (int): subplot numberx (np.array[N,] or [N,1]): abscissay (np.array[N,] or [N,M]): ordinates - could be M columnsptitle (string): plot title (optional)xlabel (string): x axis label (optional)ylabel (string): y axis label (optional)plotCol ([strings]): plot line style, list with M entries, use default if [] (optional)label ([strings]): legend label for ordinate, list with M entries (optional)legendAlpha (float): transparancy for legend (optional)pltaxis ([xmin, xmax, ymin,ymax]): scale for x,y axes. default if all zeros. (optional)maxNX (int): draw maxNX+1 tick labels on x axis (optional)maxNY (int): draw maxNY+1 tick labels on y axis (optional)linestyle (string): linestyle for this plotpowerLimits[float]: axis notation power limits [x-neg, x-pos, y-neg, y-pos] (optional)titlefsize (int): title font size, default 12pt (optional)xylabelfsize (int): x, y label font size, default 12pt (optional)xytickfsize (int): x, y tick font size, default 10pt (optional)labelfsize (int): label/legend font size, default 10pt (optional)xScientific (bool): use scientific notation on x-axisyScientific (bool): use scientific notation on x-axisdrawGrid (bool): draw the grid on the plotyInvert (bool): invert the y-axisxInvert (bool): invert the x-axisxIsDate (bool): convert the x-values to datesxTicks ({tick:label}): dict of ticks and associated labelsxtickRotation (float) ax tick rotation anglemarkers ([string]) markers to be used in lines- Returns:
Nothing- Raises:
No exception is raised.
XY colour mesh plot for (xvals, yvals, zvals) input sets.
Given an existing figure, this function plots in a specified subplot position.
Only one mesh is drawn at a time. Future meshes in the same subplot will cover any previous meshes.
The data in xvals, yvals, and zvals must have matching points, all in two-dimensional arrays.
Use cmap=None to obtain a wireframe plot.
Z-values can be plotted on a log scale, in which case the colourbar is adjusted to show true values, but on the nonlinear scale.
The xvals and yvals vectors may have non-constant grid-intervals, i.e., they do not have to be on regular intervals.
- Args:
plotnum (int): subplot numberxvals (np.array[N,] or [N,1]): vector of x valuesyvals (np.array[M,] or [M,1]): vector of y valueszvals (np.array[N,M]): values on a (x,y) gridptitle (string): plot title (optional)xlabel (string): x axis labelylabel (string): y axis labelzlabel (string): z axis labelrstride (int): row stridecstride (int): column stridelinewidth (float): line widthplotCol ([strings]): plot line style, list with M entries, use default if []pltaxis ([xmin, xmax, ymin,ymax]): scale for x,y axes. default if all zeros.maxNX (int): draw maxNX+1 tick labels on x axismaxNY (int): draw maxNY+1 tick labels on y axismaxNZ (int): draw maxNY+1 tick labels on z axisxScientific (bool): use scientific notation on x-axisyScientific (bool): use scientific notation on x-axiszScientific (bool): use scientific notation on z-axispowerLimits[float]: axis notation power limits [x-neg, x-pos, y-neg, y-pos, z-neg, z-pos]titlefsize (int): title font size, default 12pt (optional)xylabelfsize (int): x, y label font size, default 12pt (optional)xytickfsize (int): x, y tick font size, default 10pt (optional)wireframe (bool): If True, do a wireframe plotcmap (cm): color map for the mesh (optional)cbarshow (bool): if true, the show a color barcbarorientation (string): ‘vertical’ (right) or ‘horizontal’ (below)cbarcustomticks zip([tick locations/float],[tick labels/string]): locations in image grey levelscbarfontsize (int): font size for color bardrawGrid (bool): draw the grid on the plotinvertX (bool): invert the x-axisinvertY (bool): invert the y-axisinvertZ (bool): invert the z-axislogScale (bool): do Z values on log scale, recompute colourbar valselevation (float): view elevation in degreesazimuth (float): view azimuth in degreesalpha (float): surface transparency- Returns:
Nothing- Raises:
No exception is raised.
XY colour mesh countour plot for (xvals, yvals, zvals) input sets.
Given an existing figure, this function plots in a specified subplot position.
Only one mesh is drawn at a time. Future meshes in the same subplot will cover any previous meshes.
The data in zvals must be on a grid where the xvals vector correspond to the number of rows in zvals and the yvals vector corresponds to the number of columns in zvals.
Z-values can be plotted on a log scale, in which case the colourbar is adjusted to show true values, but on the nonlinear scale.
The xvals and yvals vectors may have non-constant grid-intervals, i.e., they do not have to be on regular intervals.
- Args:
plotnum (int): subplot numberxvals (np.array[N,] or [N,1]): vector of x valuesyvals (np.array[M,] or [M,1]): vector of y valueszvals (np.array[N,M]): values on a (x,y) gridnumLevels (int): values of contour levelsptitle (string): plot title (optional)xlabel (string): x axis labelylabel (string): y axis labelshading (string): ‘flat’ | ‘gouraud’ (optional)plotCol ([strings]): plot line style, list with M entries, use default if []pltaxis ([xmin, xmax, ymin,ymax]): scale for x,y axes. default if all zeros.maxNX (int): draw maxNX+1 tick labels on x axismaxNY (int): draw maxNY+1 tick labels on y axisxScientific (bool): use scientific notation on x-axisyScientific (bool): use scientific notation on x-axispowerLimits[float]: axis notation power limits [x-neg, x-pos, y-neg, y-pos]titlefsize (int): title font size, default 12pt (optional)xylabelfsize (int): x, y label font size, default 12pt (optional)xytickfsize (int): x, y tick font size, default 10pt (optional)meshCmap (cm): color map for the mesh (optional)cbarshow (bool): if true, the show a color barcbarorientation (string): ‘vertical’ (right) or ‘horizontal’ (below)cbarcustomticks zip([tick locations/float],[tick labels/string]): locations in image grey levelscbarfontsize (int): font size for color bardrawGrid (bool): draw the grid on the plotinvertY (bool): invert the y-axisinvertX (bool): invert the x-axiscontourFill (bool): fill contours with colourcontourLine (bool): draw a series of contour lineslogScale (bool): do Z values on log scale, recompute colourbar valsnegativeSolid (bool): draw negative contours in solid lines, dashed otherwisezeroContourLine (bool): draw the contour at zero- Returns:
Nothing- Raises:
No exception is raised.
Low level helper function to create a subplot and plot the data as required.
This function does the actual plotting, labelling etc. It uses the plotting function provided by its user functions.
lineStyles = { ‘’: ‘_draw_nothing’, ‘ ‘: ‘_draw_nothing’, ‘None’: ‘_draw_nothing’, ‘–’: ‘_draw_dashed’, ‘-.’: ‘_draw_dash_dot’, ‘-‘: ‘_draw_solid’, ‘:’: ‘_draw_dotted’}
- Args:
plotcommand: name of a MatplotLib plotting functionplotnum (int): subplot numberptitle (string): plot titlexlabel (string): x axis labelylabel (string): y axis labelx (np.array[N,] or [N,1]): abscissay (np.array[N,] or [N,M]): ordinates - could be M columnsplotCol ([strings]): plot line style, list with M entries, use default if []label ([strings]): legend label for ordinate, list with M entrieslegendAlpha (float): transparancy for legendpltaxis ([xmin, xmax, ymin,ymax]): scale for x,y axes. default if all zeros.maxNX (int): draw maxNX+1 tick labels on x axismaxNY (int): draw maxNY+1 tick labels on y axislinestyle (string): linestyle for this plotpowerLimits[float]: axis notation power limits [x-neg, x-pos, y-neg, y-pos]titlefsize (int): title font size, default 12pt (optional)xylabelfsize (int): x, y label font size, default 12pt (optional)xytickfsize (int): x, y tick font size, default 10pt (optional)labelfsize (int): label/legend font size, default 10pt (optional)drawGrid (bool): draw the grid on the plotxScientific (bool): use scientific notation on x-axisyScientific (bool): use scientific notation on x-axisyInvert (bool): invert the y-axisxInvert (bool): invert the x-axisxIsDate (bool): convert the x-values to datesxTicks ({tick:label}): dict of ticks and associated labelsxtickRotation (float) ax tick rotation anglemarkers ([string]) markers to be used in lines- Returns:
Nothing- Raises:
No exception is raised.
Returns the next entry in a sequence of default plot line colour styles in circular list. One day I want to do this with a generator....
- Args:
None- Returns:
The next plot colour in the sequence.- Raises:
No exception is raised.
Cartesian plot on linear scales for abscissa and ordinates.
Given an existing figure, this function plots in a specified subplot position. The function arguments are described below in some detail. Note that the y-values or ordinates can be more than one column, each column representing a different line in the plot. This is convenient if large arrays of data must be plotted. If more than one column is present, the label argument can contain the legend labels for each of the columns/lines. The pltaxis argument defines the min/max scale values for the x and y axes.
- Args:
plotnum (int): subplot numberx (np.array[N,] or [N,1]): abscissay (np.array[N,] or [N,M]): ordinates - could be M columnsptitle (string): plot title (optional)xlabel (string): x axis label (optional)ylabel (string): y axis label (optional)plotCol ([strings]): plot line style, list with M entries, use default if [] (optional)label ([strings]): legend label for ordinate, list with M entries (optional)legendAlpha (float): transparancy for legend (optional)pltaxis ([xmin, xmax, ymin,ymax]): scale for x,y axes. default if all zeros. (optional)maxNX (int): draw maxNX+1 tick labels on x axis (optional)maxNY (int): draw maxNY+1 tick labels on y axis (optional)linestyle (string): linestyle for this plotpowerLimits[float]: axis notation power limits [x-neg, x-pos, y-neg, y-pos]titlefsize (int): title font size, default 12pt (optional)xylabelfsize (int): x, y label font size, default 12pt (optional)xytickfsize (int): x, y tick font size, default 10pt (optional)labelfsize (int): label/legend font size, default 10pt (optional)xScientific (bool): use scientific notation on x-axisyScientific (bool): use scientific notation on x-axisdrawGrid (bool): draw the grid on the plotyInvert (bool): invert the y-axisxInvert (bool): invert the x-axisxIsDate (bool): convert the x-values to datesxTicks ({tick:label}): dict of ticks and associated labelsxtickRotation (float) ax tick rotation anglemarkers ([string]) markers to be used in lines- Returns:
Nothing- Raises:
No exception is raised.
3D plot on linear scales for x y z input sets.
Given an existing figure, this function plots in a specified subplot position. The function arguments are described below in some detail.
Note that multiple 3D data sets can be plotted simultaneously by adding additional columns to the input coordinates of vertices, each column representing a different function in the plot. This is convenient if large arrays of data must be plotted. If more than one column is present, the label argument can contain the legend labels for each of the columns/lines.
- Args:
plotnum (int): subplot numberx (np.array[N,] or [N,M]): x coordinates of verticesy (np.array[N,] or [N,M]): y coordinates of verticesz (np.array[N,] or [N,M]): z coordinates of verticesptitle (string): plot title (optional)xlabel (string): x axis label (optional)ylabel (string): y axis label (optional)zlabel (string): z axis label (optional)plotCol ([strings]): plot line style, list with M entries, use default if [] (optional)label ([strings]): legend label for ordinate, list with M entries (optional)legendAlpha (float): transparancy for legend (optional)titlefsize (int): title font size, default 12pt (optional)xylabelfsize (int): x, y, z label font size, default 12pt (optional)xInvert (bool): invert the x-axisyInvert (bool): invert the y-axiszInvert (bool): invert the z-axis- Returns:
Nothing- Raises:
No exception is raised.
Creates a plot from an input array.
Given an input array with m x n dimensions, this function creates a subplot for vectors [1-n]. Vector 0 serves as the x-axis for each subplot. The slice dimension can be in columns (0) or rows (1).
- Args:
plotnum (int): subplot numberinarray (array): np.arrayslicedim (int): slice along columns (0) or rows (1)subtitles (list): a list of strings as subtitles for each subplotxlabel (string): x axis label (optional)maxNX (int): draw maxNX+1 tick labels on x axis (optional)maxNY (int): draw maxNY+1 tick labels on y axis (optional)titlefsize (int): title font size, default 12pt (optional)xylabelfsize (int): x, y label font size, default 12pt (optional)xytickfsize (int): x, y tick font size, default 10pt (optional)- Returns:
Nothing- Raises:
No exception is raised.
Add markers to the subplot
Create a subplot and plot the data in polar coordinates (linear radial orginates only).
Given an existing figure, this function plots in a specified subplot position. The function arguments are described below in some detail. Note that the radial values or ordinates can be more than one column, each column representing a different line in the plot. This is convenient if large arrays of data must be plotted. If more than one column is present, the label argument can contain the legend labels for each of the columns/lines. The scale for the radial ordinates can be set with rscale. The number of radial grid circles can be set with rgrid - this provides a somewhat better control over the built-in radial grid in matplotlib. thetagrids defines the angular grid interval. The angular rotation direction can be set to be clockwise or counterclockwise. Likewise the rotation offset where the plot zero angle must be, is set with zerooffset.
For some obscure reason the current version 1.13 does not plot negative values on the polar plot. We therefore force the plot by making the values positive and then highlight it as negative.
- Args:
plotnum (int): subplot numbertheta (np.array[N,] or [N,1]): angular abscissar (np.array[N,] or [N,M]): radial ordinates - could be M columnsptitle (string): plot title (optional)plotCol ([strings]): plot line style, list with M entries, use default if [] (optional)label ([strings]): legend label, list with M entries (optional)labelLocation ([x,y]): where the legend should located (optional)highlightNegative (bool): indicate if negative data be highlighted (optional)highlightCol (string): highlighted colour string (optional)highlightWidth (int): highlighted line width(optional)legendAlpha (float): transparancy for legend (optional)rscale ([rmin, rmax]): plotting limits. default if all 0 (optional)rgrid ([rinc, rmax]): radial grid default if all 0. if rinc=0 then rmax is number of ntervals. (optional)thetagrids (float): theta grid interval [degrees] (optional)direction (string)= ‘counterclockwise’ or ‘clockwise’ (optional)zerooffset (float) = rotation offset where zero should be [rad] (optional)titlefsize (int): title font size, default 12pt (optional)- Returns:
Nothing- Raises:
No exception is raised.
3D polar surface/mesh plot for (r, theta, zvals) input sets.
Given an existing figure, this function plots in a specified subplot position.
Only one mesh is drawn at a time. Future meshes in the same subplot will cover any previous meshes.
The data in zvals must be on a grid where the theta vector correspond to the number of rows in zvals and the radial vector corresponds to the number of columns in zvals.
The r and p vectors may have non-constant grid-intervals, i.e., they do not have to be on regular intervals.
- Args:
plotnum (int): subplot numbertheta (np.array[N,] or [N,1]): vector of angular values (rad)radial (np.array[M,] or [M,1]): vector if radial valueszvals (np.array[N,M]): values on a (theta,radial) gridptitle (string): plot title (optional)xlabel (string): x axis label (optional)ylabel (string): y axis label (optional)zlabel (string): z axis label (optional)zscale ([float]): z axis [min, max] in the plot.titlefsize (int): title font size, default 12pt (optional)xylabelfsize (int): x, y, z label font size, default 12pt (optional)thetaStride (int): theta stride in input data (optional)radialstride (int): radial stride in input data (optional)meshCmap (cm): color map for the mesh (optional)linewidth (float): width of the mesh linesazim (float): camera azimuth angle viewing the graph [degrees]elev (float): camera evelation angle viewing the graph [degrees]- Returns:
Nothing- Raises:
No exception is raised.
Polar colour mesh plot for (r, theta, zvals) input sets.
Given an existing figure, this function plots in a specified subplot position.
Only one mesh is drawn at a time. Future meshes in the same subplot will cover any previous meshes.
The data in zvals must be on a grid where the theta vector correspond to the number of rows in zvals and the radial vector corresponds to the number of columns in zvals.
Z-values can be plotted on a log scale, in which case the colourbar is adjusted to show true values, but on the nonlinear scale.
The r and p vectors may have non-constant grid-intervals, i.e., they do not have to be on regular intervals.
- Args:
plotnum (int): subplot numbertheta (np.array[N,] or [N,1]): vector of angular values [0..2pi]radial (np.array[M,] or [M,1]): vector of radial valueszvals (np.array[N,M]): values on a (theta,radial) gridptitle (string): plot title (optional)shading (string): ‘flat’ | ‘gouraud’ (optional)radscale ([float]): inner and outer radial scale max in the plot.titlefsize (int): title font size, default 12pt (optional)meshCmap (cm): color map for the mesh (optional)cbarshow (bool): if true, the show a color barcbarorientation (string): ‘vertical’ (right) or ‘horizontal’ (below)cbarcustomticks zip([tick locations/float],[tick labels/string]): locations in image grey levelscbarfontsize (int): font size for color barrgrid ([float]): radial grid - None, [number], [inc,max]thetagrid ([float]): angular grid - None, [inc]drawGrid (bool): draw the grid on the plotthetagridfontsize (float): font size for the angular gridradialgridfontsize (float): font size for the radial griddirection (string)= ‘counterclockwise’ or ‘clockwise’ (optional)zerooffset (float) = rotation offset where zero should be [rad] (optional)logScale (bool): do Z values on log scale, recompute colourbar valsplotCol ([strings]): plot line style, list with M entries, use default if []numLevels (int): values of contour levelscontourLine (bool): draw a series of contour lineszeroContourLine (bool): draw the contour at zero- Returns:
Nothing- Raises:
No exception is raised.
Resets the plot colours to start at the beginning of the cycle.
- Args:
None
- Returns:
None.- Raises:
No exception is raised.
Save the plot to a disk file, using filename, dpi specification and bounding box limits.
One of matplotlib’s design choices is a bounding box strategy which may result in a bounding box that is smaller than the size of all the objects on the page. It took a while to figure this out, but the current default values for bbox_inches and pad_inches seem to create meaningful bounding boxes. These are however larger than the true bounding box. You still need a tool such as epstools or Adobe Acrobat to trim eps files to the true bounding box.
- Args:
filename (string): output filename to write plot, file extdpi (int): the resolution of the graph in dots per inchbbox_inches: see matplotlib docs for more detail.pad_inches: see matplotlib docs for more detail.useTrueType: if True, truetype fonts are used in eps/pdf files, otherwise Type3- Returns:
Nothing. Saves a file to disk.- Raises:
No exception is raised.
Plot data on logarithmic scales for abscissa and linear scale for ordinates.
Given an existing figure, this function plots in a specified subplot position. The function arguments are described below in some detail. Note that the y-values or ordinates can be more than one column, each column representing a different line in the plot. This is convenient if large arrays of data must be plotted. If more than one column is present, the label argument can contain the legend labels for each of the columns/lines. The pltaxis argument defines the min/max scale values for the x and y axes.
- Args:
plotnum (int): subplot numberx (np.array[N,] or [N,1]): abscissay (np.array[N,] or [N,M]): ordinates - could be M columnsptitle (string): plot title (optional)xlabel (string): x axis label (optional)ylabel (string): y axis label (optional)plotCol ([strings]): plot line style, list with M entries, use default if [] (optional)label ([strings]): legend label for ordinate, list with M entries (optional)legendAlpha (float): transparancy for legend (optional)pltaxis ([xmin, xmax, ymin,ymax]): scale for x,y axes. default if all zeros. (optional)maxNX (int): draw maxNX+1 tick labels on x axis (optional)maxNY (int): draw maxNY+1 tick labels on y axis (optional)linestyle (string): linestyle for this plotpowerLimits[float]: axis notation power limits [x-neg, x-pos, y-neg, y-pos] (optional)titlefsize (int): title font size, default 12pt (optional)xylabelfsize (int): x, y label font size, default 12pt (optional)xytickfsize (int): x, y tick font size, default 10pt (optional)labelfsize (int): label/legend font size, default 10pt (optional)xScientific (bool): use scientific notation on x-axisyScientific (bool): use scientific notation on x-axisdrawGrid (bool): draw the grid on the plotyInvert (bool): invert the y-axisxInvert (bool): invert the x-axisxIsDate (bool): convert the x-values to datesxTicks ({tick:label}): dict of ticks and associated labelsxtickRotation (float) ax tick rotation anglemarkers ([string]) markers to be used in lines- Returns:
Nothing- Raises:
No exception is raised.
Plot data on linear scales for abscissa and logarithmic scale for ordinates.
Given an existing figure, this function plots in a specified subplot position. The function arguments are described below in some detail. Note that the y-values or ordinates can be more than one column, each column representing a different line in the plot. This is convenient if large arrays of data must be plotted. If more than one column is present, the label argument can contain the legend labels for each of the columns/lines. The pltaxis argument defines the min/max scale values for the x and y axes.
- Args:
plotnum (int): subplot numberx (np.array[N,] or [N,1]): abscissay (np.array[N,] or [N,M]): ordinates - could be M columnsptitle (string): plot title (optional)xlabel (string): x axis label (optional)ylabel (string): y axis label (optional)plotCol ([strings]): plot line style, list with M entries, use default if [] (optional)label ([strings]): legend label for ordinate, list withM entries (optional)legendAlpha (float): transparancy for legend (optional)pltaxis ([xmin, xmax, ymin,ymax]): scale for x,y axes. default if all zeros. (optional)maxNX (int): draw maxNX+1 tick labels on x axis (optional)maxNY (int): draw maxNY+1 tick labels on y axis (optional)linestyle (string): linestyle for this plotpowerLimits[float]: axis notation power limits [x-neg, x-pos, y-neg, y-pos] (optional)titlefsize (int): title font size, default 12pt (optional)xylabelfsize (int): x, y label font size, default 12pt (optional)xytickfsize (int): x, y tick font size, default 10pt (optional)labelfsize (int): label/legend font size, default 10pt (optional)xScientific (bool): use scientific notation on x-axisyScientific (bool): use scientific notation on x-axisdrawGrid (bool): draw the grid on the plotyInvert (bool): invert the y-axisxInvert (bool): invert the x-axisxIsDate (bool): convert the x-values to datesxTicks ({tick:label}): dict of ticks and associated labelsxtickRotation (float) ax tick rotation anglemarkers ([string]) markers to be used in lines- Returns:
Nothing- Raises:
No exception is raised.
Creates a subplot and show the image using the colormap provided.
Filled marker user-settable values.
This class encapsulates a few variables describing a Filled marker. Default values are provided that can be overridden in user plots.
Collect maker location and types and mark subplot.
Build a list of markers at plot locations with the specified marker.
Add a marker to the list, overridding properties if necessary.
Specify location and any specific marker properties to be used. The location can be (xy,y) for cartesian plots or (theta,rad) for polars.
If no marker properties are specified, the current marker class properties will be used. If the current maker instance does not specify properties, the default marker properties will be used.
- Args:
x (float): the x/theta location for the markery (float): the y/radial location for the markermarkerfacecolor (colour): main colour for marker (optional)markerfacecoloralt (colour): alterive colour for marker (optional)markeredgecolor (colour): edge colour for marker (optional)marker (string): string to specify the marker (optional)markersize (int)): size of the marker (optional)fillstyle (string): string to define fill style (optional)- Returns:
Nothing. Creates the figure for subequent use.- Raises:
No exception is raised.
Plot the current list of markers on the given axes.
All the markers currently stored in the class will be drawn.
- Args:
ax (axes): an axes handle for the plot- Returns:
Nothing. Creates the figure for subequent use.- Raises:
No exception is raised.
This class provides a functions to assist in the optimal display of images.
Compress an image (and then inversely expand the color bar values), prior to histogram equalisation to ensure that the two keep in step, we store the function names as pairs, and below invoke the pair elements cases are as follows: linear, log. sqrt. Note that the image is histogram equalised in all cases.
Uses with statement to create a plot and save to file on exit.
Use as follows:
x=numpy.linspace(-3,3,20)
with savePlot(1,saveName=['testwith.png','testwith.eps']) as p:
p.plot(1,x,x*x)
where the savePlot parameters are exactly the same as Plotter, except that a new named parameter saveName is now present. If saveName is not None, the list of filenames is used to save files of the plot (any number of names/types)