@header@
 
 
matplotlib.axes
index
/matplotlib/axes.py

 
Modules
       
MLab
math
matplotlib.mlab
sys

 
Classes
       
matplotlib.artist.Artist
Axes
Subplot

 
class Axes(matplotlib.artist.Artist)
    Emulate matlab's axes command, creating axes with
 
   Axes(position=[left, bottom, width, height])
 
where all the arguments are fractions in [0,1] which specify the
fraction of the total figure window.  
 
axisbg is the color of the axis background
 
  Methods defined here:
__init__(self, fig, position, axisbg='w')
add_line(self, line)
Add a line to the list of plot lines
add_patch(self, patch)
Add a line to the list of plot lines
add_table(self, tab)
Add a table instance to the list of axes tables
bar(self, left, height, width=0.80000000000000004, bottom=0, color='b', yerr=None, xerr=None, capsize=3)
BAR(left, height)
 
Make a bar plot with rectangles at
  left, left+width, 0, height
left and height are Numeric arrays
 
Return value is a list of Rectangle patch instances
 
BAR(left, height, width, bottom,
    color, yerr, xerr, capsize, yoff)
 
xerr and yerr, if not None, will be used to generate errorbars
on the bar chart
 
color specifies the color of the bar
 
capsize determines the length in points of the error bar caps
 
 
The optional arguments color, width and bottom can be either
scalars or len(x) sequences
 
This enables you to use bar as the basis for stacked bar
charts, or candlestick plots
cla(self)
Clear the current axes
clear(self)
cohere(self, x, y, NFFT=256, Fs=2, detrend=<function detrend_none>, window=<function window_hanning>, noverlap=0)
cohere the coherence between x and y.  Coherence is the normalized
cross spectral density
 
Cxy = |Pxy|^2/(Pxx*Pyy)
 
The return value is (Cxy, f), where f are the frequencies of the
coherence vector.  See the docs for psd and csd for information
about the function arguments NFFT, detrend, windowm noverlap, as
well as the methods used to compute Pxy, Pxx and Pyy.
 
Returns the tuple Cxy, freqs
 
Refs:
  Bendat & Piersol -- Random Data: Analysis and Measurement
    Procedures, John Wiley & Sons (1986)
csd(self, x, y, NFFT=256, Fs=2, detrend=<function detrend_none>, window=<function window_hanning>, noverlap=0)
The cross spectral density Pxy by Welches average periodogram
method.  The vectors x and y are divided into NFFT length
segments.  Each segment is detrended by function detrend and
windowed by function window.  noverlap gives the length of the
overlap between segments.  The product of the direct FFTs of x and
y are averaged over each segment to compute Pxy, with a scaling to
correct for power loss due to windowing.  Fs is the sampling
frequency.
 
NFFT must be a power of 2
 
detrend and window are functions, unlike in matlab where they are
vectors.  For detrending you can use detrend_none, detrend_mean,
detrend_linear or a custom function.  For windowing, you can use
window_none, window_hanning, or a custom function
 
Returns the tuple Pxy, freqs.  Pxy is the cross spectrum (complex
valued), and 10*log10(|Pxy|) is plotted
 
Refs:
  Bendat & Piersol -- Random Data: Analysis and Measurement
    Procedures, John Wiley & Sons (1986)
errorbar(self, x, y, yerr=None, xerr=None, fmt='b-', capsize=3)
Plot x versus y with error deltas in yerr and xerr.
Vertical errorbars are plotted if yerr is not None
Horizontal errorbars are plotted if xerr is not None
 
xerr and yerr may be any of:
    a rank-0, Nx1 Numpy array  - symmetric errorbars +/- value
    an N-element list or tuple - symmetric errorbars +/- value
    a rank-1, Nx2 Numpy array  - asymmetric errorbars -column1/+column2
 
fmt is the plot format symbol for y.  if fmt is None, just
plot the errorbars with no line symbols.  This can be useful
for creating a bar plot with errorbars
 
Return value is a length 2 tuple.  The first element is a list of
y symbol lines.  The second element is a list of error bar lines.
 
capsize is the size of the error bar caps in points
get_axis_bgcolor(self)
Return the axis background color
get_child_artists(self)
get_legend(self)
Return the Legend instance, or None if no legend is defined
get_lines(self)
get_xaxis(self)
Return the XAxis instance
get_xgridlines(self)
Get the x grid lines as a list of Line2D instances
get_xlim(self)
Get the x axis range [xmin, xmax]
get_xticklabels(self)
Get the xtick labels as a list of Text instances
get_xticklines(self)
Get the xtick lines as a list of Line2D instances
get_xticks(self)
Return the x ticks as a list of locations
get_yaxis(self)
Return the YAxis instance
get_ygridlines(self)
Get the y grid lines as a list of Line2D instances
get_ylim(self)
Get the y axis range [ymin, ymax]
get_yticklabels(self)
Get the ytick labels as a list of Text instances
get_yticklines(self)
Get the ytick lines as a list of Line2D instances
get_yticks(self)
Return the y ticks as a list of locations
grid(self, b)
Set the axes grids on or off; b is a boolean
hist(self, x, bins=10, normed=0)
Compute the histogram of x.  bins is either an integer number of
bins or a sequence giving the bins.  x are the data to be binned.
 
if noplot is True, just compute the histogram and return the
number of observations and the bins as an (n, bins) tuple.
 
If noplot is False, compute the histogram and plot it, returning
n, bins, patches
 
If normed is true, the first element of the return tuple will be the
counts normalized to form a probability distribtion, ie,
n/(len(x)*dbin)
hlines(self, y, xmin, xmax, fmt='k-')
plot horizontal lines at each y from xmin to xmax.  xmin or
xmax can be scalars or len(x) numpy arrays.  If they are
scalars, then the respective values are constant, else the
widths of the lines are determined by xmin and xmax
 
Returns a list of line instances that were added
in_axes(self, xwin, ywin)
legend(self, *args, **kwargs)
Place a legend on the current axes at location loc.  Labels are a
sequence of strings and loc can be a string or an integer
specifying the legend location
 
USAGE: 
 
  Make a legend with existing lines
  legend( LABELS )
  >>> legend( ('label1', 'label2', 'label3') ) 
 
  Make a legend for Line2D instances lines1, line2, line3
  legend( LINES, LABELS )
  >>> legend( (line1, line2, line3), ('label1', 'label2', 'label3') )
 
  Make a legend at LOC
  legend( LABELS, LOC )  or
  legend( LINES, LABELS, LOC )
  >>> legend( ('label1', 'label2', 'label3'), loc='upper left')
  >>> legend( (line1, line2, line3),
              ('label1', 'label2', 'label3'),
              loc=2)
 
The LOC location codes are
 
The location codes are
 
  'best' : 0,          (currently not supported, defaults to upper right)
  'upper right'  : 1,  (default)
  'upper left'   : 2,
  'lower left'   : 3,
  'lower right'  : 4,
  'right'        : 5,
  'center left'  : 6,
  'center right' : 7,
  'lower center' : 8,
  'upper center' : 9,
  'center'       : 10,
loglog(self, *args, **kwargs)
Make a loglog plot with log scaling on the a and y axis.  The args
to semilog x are the same as the args to plot.  See help plot for
more info
panx(self, numsteps)
Pan the x axis numsteps (plus pan right, minus pan left)
pany(self, numsteps)
Pan the x axis numsteps (plus pan up, minus pan down)
pcolor(self, *args, **kwargs)
pcolor(C) - make a pseudocolor plot of matrix C
 
pcolor(X, Y, C) - a pseudo color plot of C on the matrices X and Y  
 
Shading:
 
  The optional keyword arg shading ('flat' or 'faceted') will
  determine whether a black grid is drawn around each pcolor
  square.  Default 'faceteted'
     e.g.,   
     pcolor(C, shading='flat')  
     pcolor(X, Y, C, shading='faceted')
 
returns a list of patch objects
 
Note, the behavior of meshgrid in matlab is a bit
counterintuitive for x and y arrays.  For example,
 
  x = arange(7)
  y = arange(5)
  X, Y = meshgrid(x,y)
 
  Z = rand( len(x), len(y))
  pcolor(X, Y, Z)
 
will fail in matlab and matplotlib.  You will probably be
happy with
 
 pcolor(X, Y, transpose(Z))
 
Likewise, for nonsquare Z,
 
 pcolor(transpose(Z))
 
will make the x and y axes in the plot agree with the numrows
and numcols of Z
plot(self, *args)
Emulate matlab's plot command.  *args is a variable length
argument, allowing for multiple x,y pairs with an optional
format string.  For example, all of the following are legal,
assuming a is the Axis instance:
 
  a.plot(x,y)            # plot Numeric arrays y vs x
  a.plot(x,y, 'bo')      # plot Numeric arrays y vs x with blue circles
  a.plot(y)              # plot y using x = arange(len(y))
  a.plot(y, 'r+')        # ditto with red plusses
 
An arbitrary number of x, y, fmt groups can be specified, as in 
  a.plot(x1, y1, 'g^', x2, y2, 'l-')  
 
Returns a list of lines that were added
psd(self, x, NFFT=256, Fs=2, detrend=<function detrend_none>, window=<function window_hanning>, noverlap=0)
The power spectral density by Welches average periodogram method.
The vector x is divided into NFFT length segments.  Each segment
is detrended by function detrend and windowed by function window.
noperlap gives the length of the overlap between segments.  The
absolute(fft(segment))**2 of each segment are averaged to compute Pxx,
with a scaling to correct for power loss due to windowing.  Fs is
the sampling frequency.
 
-- NFFT must be a power of 2
 
-- detrend and window are functions, unlike in matlab where they
   are vectors.  For detrending you can use detrend_none,
   detrend_mean, detrend_linear or a custom function.  For
   windowing, you can use window_none, window_hanning, or a custom
   function
 
-- if length x < NFFT, it will be zero padded to NFFT
 
 
Returns the tuple Pxx, freqs
 
For plotting, the power is plotted as 10*log10(pxx)) for decibels,
though pxx itself is returned
 
Refs:
  Bendat & Piersol -- Random Data: Analysis and Measurement
    Procedures, John Wiley & Sons (1986)
resize(self)
scatter(self, x, y, s=None, c='b')
Make a scatter plot of x versus y.  s is a size (in data
coords) and can be either a scalar or an array of the same
length as x or y.  c is a color and can be a single color
format string or an length(x) array of intensities which will
be mapped by the colormap jet.        
 
If size is None a default size will be used
semilogx(self, *args, **kwargs)
Make a semilog plot with log scaling on the x axis.  The args to
semilog x are the same as the args to plot.  See help plot for
more info
semilogy(self, *args, **kwargs)
Make a semilog plot with log scaling on the y axis.  The args to
semilog x are the same as the args to plot.  See help plot for
more info
set_axis_bgcolor(self, color)
set_axis_off(self)
set_axis_on(self)
set_title(self, label, fontdict=None, **kwargs)
Set the title for the xaxis
 
See the text docstring for information of how override and the
optional args work
set_xlabel(self, xlabel, fontdict=None, **kwargs)
Set the label for the xaxis
 
See the text docstring for information of how override and the
optional args work
set_xlim(self, v)
Set the limits for the xaxis; v = [xmin, xmax]
set_xscale(self, value)
set_xticklabels(self, labels, fontdict=None, **kwargs)
Set the xtick labels with list of strings labels
Return a list of axis text instances
set_xticks(self, ticks)
Set the x ticks with list of ticks
set_ylabel(self, ylabel, fontdict=None, **kwargs)
Set the label for the yaxis
 
Defaults override is
 
    override = {
       'fontsize'            : 10,
       'verticalalignment'   : 'center',
       'horizontalalignment' : 'right',
       'rotation'='vertical' : }
 
See the text doctstring for information of how override and
the optional args work
set_ylim(self, v)
Set the limits for the xaxis; v = [ymin, ymax]
set_yscale(self, value)
set_yticklabels(self, labels, fontdict=None, **kwargs)
Set the ytick labels with list of strings labels.
Return a list of Text instances
set_yticks(self, ticks)
Set the y ticks with list of ticks
table(self, cellText=None, cellColours=None, cellLoc='right', colWidths=None, rowLabels=None, rowColours=None, rowLoc='left', colLabels=None, colColours=None, colLoc='center', loc='bottom', bbox=None)
Create a table and add it to the axes.  Returns a table
instance.  For finer grained control over tables, use the
Table class and add it to the axes with add_table.
 
Thanks to John Gill for providing the class and table.
text(self, x, y, text, fontdict=None, **kwargs)
Add text to axis at location x,y (data coords)
 
fontdict is a dictionary to override the default text properties.
If fontdict is None, the default is
 
If len(args) the override dictionary will be:
 
  'fontsize'            : 10,
  'verticalalignment'   : 'bottom',
  'horizontalalignment' : 'left'
 
 
**kwargs can in turn be used to override the override, as in
 
  a.text(x,y,label, fontsize=12)
 
will have verticalalignment=bottom and
horizontalalignment=left but will have a fontsize of 12
 
 
The Text defaults are
    'color'               : 'k',
    'fontname'            : 'Sans',
    'fontsize'            : 10,
    'fontweight'          : 'bold',
    'fontangle'           : 'normal',
    'horizontalalignment' : 'left'
    'rotation'            : 'horizontal',
    'verticalalignment'   : 'bottom',
    'transx'              : self.xaxis.transData,
    'transy'              : self.yaxis.transData,            
 
transx and transy specify that text is in data coords,
alternatively, you can specify text in axis coords (0,0 lower
left and 1,1 upper right).  The example below places text in
the center of the axes
 
ax = subplot(111)
text(0.5, 0.5,'matplotlib', 
     horizontalalignment='center',
     verticalalignment='center',
     transx = ax.xaxis.transAxis,
     transy = ax.yaxis.transAxis,
)
update_viewlim(self)
Update the view limits with all the data in self
vlines(self, x, ymin, ymax, color='k')
Plot vertical lines at each x from ymin to ymax.  ymin or ymax
can be scalars or len(x) numpy arrays.  If they are scalars,
then the respective values are constant, else the heights of
the lines are determined by ymin and ymax
 
Returns a list of lines that were added
zoomx(self, numsteps)
Zoom in on the x xaxis numsteps (plus for zoom in, minus for zoom out)
zoomy(self, numsteps)
Zoom in on the x xaxis numsteps (plus for zoom in, minus for zoom out)

Methods inherited from matplotlib.artist.Artist:
draw(self, renderer=None, *args, **kwargs)
Derived classes drawing method
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_dpi(self)
Get the DPI of the display
get_window_extent(self, renderer=None)
Return the window extent of the Artist as a Bound2D instance
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_clip_on(self, b)
Set whether artist is clipped to bbox
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'

 
class Subplot(Axes)
    Emulate matlab's subplot command, creating axes with
 
  Subplot(numRows, numCols, plotNum)
 
where plotNum=1 is the first plot number and increasing plotNums
fill rows first.  max(plotNum)==numRows*numCols
 
You can leave out the commas if numRows<=numCols<=plotNum<10, as
in
 
  Subplot(211)    # 2 rows, 1 column, first (upper) plot
 
 
Method resolution order:
Subplot
Axes
matplotlib.artist.Artist

Methods defined here:
__init__(self, fig, *args, **kwargs)
is_first_col(self)
is_first_row(self)
is_last_col(self)
is_last_row(self)

Methods inherited from Axes:
add_line(self, line)
Add a line to the list of plot lines
add_patch(self, patch)
Add a line to the list of plot lines
add_table(self, tab)
Add a table instance to the list of axes tables
bar(self, left, height, width=0.80000000000000004, bottom=0, color='b', yerr=None, xerr=None, capsize=3)
BAR(left, height)
 
Make a bar plot with rectangles at
  left, left+width, 0, height
left and height are Numeric arrays
 
Return value is a list of Rectangle patch instances
 
BAR(left, height, width, bottom,
    color, yerr, xerr, capsize, yoff)
 
xerr and yerr, if not None, will be used to generate errorbars
on the bar chart
 
color specifies the color of the bar
 
capsize determines the length in points of the error bar caps
 
 
The optional arguments color, width and bottom can be either
scalars or len(x) sequences
 
This enables you to use bar as the basis for stacked bar
charts, or candlestick plots
cla(self)
Clear the current axes
clear(self)
cohere(self, x, y, NFFT=256, Fs=2, detrend=<function detrend_none>, window=<function window_hanning>, noverlap=0)
cohere the coherence between x and y.  Coherence is the normalized
cross spectral density
 
Cxy = |Pxy|^2/(Pxx*Pyy)
 
The return value is (Cxy, f), where f are the frequencies of the
coherence vector.  See the docs for psd and csd for information
about the function arguments NFFT, detrend, windowm noverlap, as
well as the methods used to compute Pxy, Pxx and Pyy.
 
Returns the tuple Cxy, freqs
 
Refs:
  Bendat & Piersol -- Random Data: Analysis and Measurement
    Procedures, John Wiley & Sons (1986)
csd(self, x, y, NFFT=256, Fs=2, detrend=<function detrend_none>, window=<function window_hanning>, noverlap=0)
The cross spectral density Pxy by Welches average periodogram
method.  The vectors x and y are divided into NFFT length
segments.  Each segment is detrended by function detrend and
windowed by function window.  noverlap gives the length of the
overlap between segments.  The product of the direct FFTs of x and
y are averaged over each segment to compute Pxy, with a scaling to
correct for power loss due to windowing.  Fs is the sampling
frequency.
 
NFFT must be a power of 2
 
detrend and window are functions, unlike in matlab where they are
vectors.  For detrending you can use detrend_none, detrend_mean,
detrend_linear or a custom function.  For windowing, you can use
window_none, window_hanning, or a custom function
 
Returns the tuple Pxy, freqs.  Pxy is the cross spectrum (complex
valued), and 10*log10(|Pxy|) is plotted
 
Refs:
  Bendat & Piersol -- Random Data: Analysis and Measurement
    Procedures, John Wiley & Sons (1986)
errorbar(self, x, y, yerr=None, xerr=None, fmt='b-', capsize=3)
Plot x versus y with error deltas in yerr and xerr.
Vertical errorbars are plotted if yerr is not None
Horizontal errorbars are plotted if xerr is not None
 
xerr and yerr may be any of:
    a rank-0, Nx1 Numpy array  - symmetric errorbars +/- value
    an N-element list or tuple - symmetric errorbars +/- value
    a rank-1, Nx2 Numpy array  - asymmetric errorbars -column1/+column2
 
fmt is the plot format symbol for y.  if fmt is None, just
plot the errorbars with no line symbols.  This can be useful
for creating a bar plot with errorbars
 
Return value is a length 2 tuple.  The first element is a list of
y symbol lines.  The second element is a list of error bar lines.
 
capsize is the size of the error bar caps in points
get_axis_bgcolor(self)
Return the axis background color
get_child_artists(self)
get_legend(self)
Return the Legend instance, or None if no legend is defined
get_lines(self)
get_xaxis(self)
Return the XAxis instance
get_xgridlines(self)
Get the x grid lines as a list of Line2D instances
get_xlim(self)
Get the x axis range [xmin, xmax]
get_xticklabels(self)
Get the xtick labels as a list of Text instances
get_xticklines(self)
Get the xtick lines as a list of Line2D instances
get_xticks(self)
Return the x ticks as a list of locations
get_yaxis(self)
Return the YAxis instance
get_ygridlines(self)
Get the y grid lines as a list of Line2D instances
get_ylim(self)
Get the y axis range [ymin, ymax]
get_yticklabels(self)
Get the ytick labels as a list of Text instances
get_yticklines(self)
Get the ytick lines as a list of Line2D instances
get_yticks(self)
Return the y ticks as a list of locations
grid(self, b)
Set the axes grids on or off; b is a boolean
hist(self, x, bins=10, normed=0)
Compute the histogram of x.  bins is either an integer number of
bins or a sequence giving the bins.  x are the data to be binned.
 
if noplot is True, just compute the histogram and return the
number of observations and the bins as an (n, bins) tuple.
 
If noplot is False, compute the histogram and plot it, returning
n, bins, patches
 
If normed is true, the first element of the return tuple will be the
counts normalized to form a probability distribtion, ie,
n/(len(x)*dbin)
hlines(self, y, xmin, xmax, fmt='k-')
plot horizontal lines at each y from xmin to xmax.  xmin or
xmax can be scalars or len(x) numpy arrays.  If they are
scalars, then the respective values are constant, else the
widths of the lines are determined by xmin and xmax
 
Returns a list of line instances that were added
in_axes(self, xwin, ywin)
legend(self, *args, **kwargs)
Place a legend on the current axes at location loc.  Labels are a
sequence of strings and loc can be a string or an integer
specifying the legend location
 
USAGE: 
 
  Make a legend with existing lines
  legend( LABELS )
  >>> legend( ('label1', 'label2', 'label3') ) 
 
  Make a legend for Line2D instances lines1, line2, line3
  legend( LINES, LABELS )
  >>> legend( (line1, line2, line3), ('label1', 'label2', 'label3') )
 
  Make a legend at LOC
  legend( LABELS, LOC )  or
  legend( LINES, LABELS, LOC )
  >>> legend( ('label1', 'label2', 'label3'), loc='upper left')
  >>> legend( (line1, line2, line3),
              ('label1', 'label2', 'label3'),
              loc=2)
 
The LOC location codes are
 
The location codes are
 
  'best' : 0,          (currently not supported, defaults to upper right)
  'upper right'  : 1,  (default)
  'upper left'   : 2,
  'lower left'   : 3,
  'lower right'  : 4,
  'right'        : 5,
  'center left'  : 6,
  'center right' : 7,
  'lower center' : 8,
  'upper center' : 9,
  'center'       : 10,
loglog(self, *args, **kwargs)
Make a loglog plot with log scaling on the a and y axis.  The args
to semilog x are the same as the args to plot.  See help plot for
more info
panx(self, numsteps)
Pan the x axis numsteps (plus pan right, minus pan left)
pany(self, numsteps)
Pan the x axis numsteps (plus pan up, minus pan down)
pcolor(self, *args, **kwargs)
pcolor(C) - make a pseudocolor plot of matrix C
 
pcolor(X, Y, C) - a pseudo color plot of C on the matrices X and Y  
 
Shading:
 
  The optional keyword arg shading ('flat' or 'faceted') will
  determine whether a black grid is drawn around each pcolor
  square.  Default 'faceteted'
     e.g.,   
     pcolor(C, shading='flat')  
     pcolor(X, Y, C, shading='faceted')
 
returns a list of patch objects
 
Note, the behavior of meshgrid in matlab is a bit
counterintuitive for x and y arrays.  For example,
 
  x = arange(7)
  y = arange(5)
  X, Y = meshgrid(x,y)
 
  Z = rand( len(x), len(y))
  pcolor(X, Y, Z)
 
will fail in matlab and matplotlib.  You will probably be
happy with
 
 pcolor(X, Y, transpose(Z))
 
Likewise, for nonsquare Z,
 
 pcolor(transpose(Z))
 
will make the x and y axes in the plot agree with the numrows
and numcols of Z
plot(self, *args)
Emulate matlab's plot command.  *args is a variable length
argument, allowing for multiple x,y pairs with an optional
format string.  For example, all of the following are legal,
assuming a is the Axis instance:
 
  a.plot(x,y)            # plot Numeric arrays y vs x
  a.plot(x,y, 'bo')      # plot Numeric arrays y vs x with blue circles
  a.plot(y)              # plot y using x = arange(len(y))
  a.plot(y, 'r+')        # ditto with red plusses
 
An arbitrary number of x, y, fmt groups can be specified, as in 
  a.plot(x1, y1, 'g^', x2, y2, 'l-')  
 
Returns a list of lines that were added
psd(self, x, NFFT=256, Fs=2, detrend=<function detrend_none>, window=<function window_hanning>, noverlap=0)
The power spectral density by Welches average periodogram method.
The vector x is divided into NFFT length segments.  Each segment
is detrended by function detrend and windowed by function window.
noperlap gives the length of the overlap between segments.  The
absolute(fft(segment))**2 of each segment are averaged to compute Pxx,
with a scaling to correct for power loss due to windowing.  Fs is
the sampling frequency.
 
-- NFFT must be a power of 2
 
-- detrend and window are functions, unlike in matlab where they
   are vectors.  For detrending you can use detrend_none,
   detrend_mean, detrend_linear or a custom function.  For
   windowing, you can use window_none, window_hanning, or a custom
   function
 
-- if length x < NFFT, it will be zero padded to NFFT
 
 
Returns the tuple Pxx, freqs
 
For plotting, the power is plotted as 10*log10(pxx)) for decibels,
though pxx itself is returned
 
Refs:
  Bendat & Piersol -- Random Data: Analysis and Measurement
    Procedures, John Wiley & Sons (1986)
resize(self)
scatter(self, x, y, s=None, c='b')
Make a scatter plot of x versus y.  s is a size (in data
coords) and can be either a scalar or an array of the same
length as x or y.  c is a color and can be a single color
format string or an length(x) array of intensities which will
be mapped by the colormap jet.        
 
If size is None a default size will be used
semilogx(self, *args, **kwargs)
Make a semilog plot with log scaling on the x axis.  The args to
semilog x are the same as the args to plot.  See help plot for
more info
semilogy(self, *args, **kwargs)
Make a semilog plot with log scaling on the y axis.  The args to
semilog x are the same as the args to plot.  See help plot for
more info
set_axis_bgcolor(self, color)
set_axis_off(self)
set_axis_on(self)
set_title(self, label, fontdict=None, **kwargs)
Set the title for the xaxis
 
See the text docstring for information of how override and the
optional args work
set_xlabel(self, xlabel, fontdict=None, **kwargs)
Set the label for the xaxis
 
See the text docstring for information of how override and the
optional args work
set_xlim(self, v)
Set the limits for the xaxis; v = [xmin, xmax]
set_xscale(self, value)
set_xticklabels(self, labels, fontdict=None, **kwargs)
Set the xtick labels with list of strings labels
Return a list of axis text instances
set_xticks(self, ticks)
Set the x ticks with list of ticks
set_ylabel(self, ylabel, fontdict=None, **kwargs)
Set the label for the yaxis
 
Defaults override is
 
    override = {
       'fontsize'            : 10,
       'verticalalignment'   : 'center',
       'horizontalalignment' : 'right',
       'rotation'='vertical' : }
 
See the text doctstring for information of how override and
the optional args work
set_ylim(self, v)
Set the limits for the xaxis; v = [ymin, ymax]
set_yscale(self, value)
set_yticklabels(self, labels, fontdict=None, **kwargs)
Set the ytick labels with list of strings labels.
Return a list of Text instances
set_yticks(self, ticks)
Set the y ticks with list of ticks
table(self, cellText=None, cellColours=None, cellLoc='right', colWidths=None, rowLabels=None, rowColours=None, rowLoc='left', colLabels=None, colColours=None, colLoc='center', loc='bottom', bbox=None)
Create a table and add it to the axes.  Returns a table
instance.  For finer grained control over tables, use the
Table class and add it to the axes with add_table.
 
Thanks to John Gill for providing the class and table.
text(self, x, y, text, fontdict=None, **kwargs)
Add text to axis at location x,y (data coords)
 
fontdict is a dictionary to override the default text properties.
If fontdict is None, the default is
 
If len(args) the override dictionary will be:
 
  'fontsize'            : 10,
  'verticalalignment'   : 'bottom',
  'horizontalalignment' : 'left'
 
 
**kwargs can in turn be used to override the override, as in
 
  a.text(x,y,label, fontsize=12)
 
will have verticalalignment=bottom and
horizontalalignment=left but will have a fontsize of 12
 
 
The Text defaults are
    'color'               : 'k',
    'fontname'            : 'Sans',
    'fontsize'            : 10,
    'fontweight'          : 'bold',
    'fontangle'           : 'normal',
    'horizontalalignment' : 'left'
    'rotation'            : 'horizontal',
    'verticalalignment'   : 'bottom',
    'transx'              : self.xaxis.transData,
    'transy'              : self.yaxis.transData,            
 
transx and transy specify that text is in data coords,
alternatively, you can specify text in axis coords (0,0 lower
left and 1,1 upper right).  The example below places text in
the center of the axes
 
ax = subplot(111)
text(0.5, 0.5,'matplotlib', 
     horizontalalignment='center',
     verticalalignment='center',
     transx = ax.xaxis.transAxis,
     transy = ax.yaxis.transAxis,
)
update_viewlim(self)
Update the view limits with all the data in self
vlines(self, x, ymin, ymax, color='k')
Plot vertical lines at each x from ymin to ymax.  ymin or ymax
can be scalars or len(x) numpy arrays.  If they are scalars,
then the respective values are constant, else the heights of
the lines are determined by ymin and ymax
 
Returns a list of lines that were added
zoomx(self, numsteps)
Zoom in on the x xaxis numsteps (plus for zoom in, minus for zoom out)
zoomy(self, numsteps)
Zoom in on the x xaxis numsteps (plus for zoom in, minus for zoom out)

Methods inherited from matplotlib.artist.Artist:
draw(self, renderer=None, *args, **kwargs)
Derived classes drawing method
get_alpha(self)
Return the alpha value used for blending - not supported on
all backends
get_clip_on(self)
Return whether artist uses clipping
get_dpi(self)
Get the DPI of the display
get_window_extent(self, renderer=None)
Return the window extent of the Artist as a Bound2D instance
set_alpha(self, alpha)
Set the alpha value used for blending - not supported on
all backends
set_child_attr(self, attr, val)
Set attribute attr for self, and all child artists
set_clip_on(self, b)
Set whether artist is clipped to bbox
set_lod(self, on)
Set Level of Detail on or off.  If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly

Data and other attributes inherited from matplotlib.artist.Artist:
aname = 'Artist'

 
Functions
       
arange(...)
arange(start, stop=None, step=1, typecode=None)
 
 Just like range() except it returns an array whose type can be
specified by the keyword argument typecode.
array(...)
array(sequence, typecode=None, copy=1, savespace=0) will return a new array formed from the given (potentially nested) sequence with type given by typecode.  If no typecode is given, then the type will be determined as the minimum type required to hold the objects in sequence.  If copy is zero and sequence is already an array, a reference will be returned.  If savespace is nonzero, the new array will maintain its precision in operations.

 
Data
        False = False
Float = 'd'
True = True
absolute = <ufunc 'absolute'>
division = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
generators = _Feature((2, 2, 0, 'alpha', 1), (2, 3, 0, 'final', 0), 4096)
lineMarkers = {'+': 1, ',': 1, '.': 1, '<': 1, '>': 1, '^': 1, 'o': 1, 's': 1, 'v': 1, 'x': 1}
lineStyles = {'-': 1, '--': 1, '-.': 1, ':': 1}
log10 = <ufunc 'log10'>
@footer@