On this page
matplotlib.axes.Axes.phase_spectrum
Axes.phase_spectrum(self, x, Fs=None, Fc=None, window=None, pad_to=None, sides=None, *, data=None, **kwargs)[source]-
Plot the phase spectrum.
Compute the phase spectrum (unwrapped angle spectrum) of x. Data is padded to a length of pad_to and the windowing function window is applied to the signal.
Parameters: -
x1-D array or sequence -
Array or sequence containing the data
-
Fsscalar -
The sampling frequency (samples per time unit). It is used to calculate the Fourier frequencies, freqs, in cycles per time unit. The default value is 2.
-
windowcallable or ndarray -
A function or a vector of length NFFT. To create window vectors see
window_hanning,window_none,numpy.blackman,numpy.hamming,numpy.bartlett,scipy.signal,scipy.signal.get_window, etc. The default iswindow_hanning. If a function is passed as the argument, it must take a data segment as an argument and return the windowed version of the segment. -
sides{'default', 'onesided', 'twosided'} -
Specifies which sides of the spectrum to return. Default gives the default behavior, which returns one-sided for real data and both for complex data. 'onesided' forces the return of a one-sided spectrum, while 'twosided' forces two-sided.
-
pad_toint -
The number of points to which the data segment is padded when performing the FFT. While not increasing the actual resolution of the spectrum (the minimum distance between resolvable peaks), this can give more points in the plot, allowing for more detail. This corresponds to the n parameter in the call to fft(). The default is None, which sets pad_to equal to the length of the input signal (i.e. no padding).
-
Fcint -
The center frequency of x (defaults to 0), which offsets the x extents of the plot to reflect the frequency range used when a signal is acquired and then filtered and downsampled to baseband.
Returns: -
spectrum1-D array -
The values for the phase spectrum in radians (real valued).
-
freqs1-D array -
The frequencies corresponding to the elements in spectrum.
-
lineLine2D -
The line created by this function.
Other Parameters: - **kwargs
-
Keyword arguments control the
Line2Dproperties:Property Description agg_filtera filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alphafloat or None animatedbool antialiasedor aabool clip_boxBboxclip_onbool clip_pathPatch or (Path, Transform) or None coloror ccolor containscallable dash_capstyle{'butt', 'round', 'projecting'} dash_joinstyle{'miter', 'round', 'bevel'} dashessequence of floats (on/off ink in points) or (None, None) data(2, N) array or two 1D arrays drawstyleor ds{'default', 'steps', 'steps-pre', 'steps-mid', 'steps-post'}, default: 'default' figureFigurefillstyle{'full', 'left', 'right', 'bottom', 'top', 'none'} gidstr in_layoutbool labelobject linestyleor ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidthor lwfloat markermarker style markeredgecoloror meccolor markeredgewidthor mewfloat markerfacecoloror mfccolor markerfacecoloraltor mfcaltcolor markersizeor msfloat markeveryNone or int or (int, int) or slice or List[int] or float or (float, float) path_effectsAbstractPathEffectpickerfloat or callable[[Artist, Event], Tuple[bool, dict]] pickradiusfloat rasterizedbool or None sketch_params(scale: float, length: float, randomness: float) snapbool or None solid_capstyle{'butt', 'round', 'projecting'} solid_joinstyle{'miter', 'round', 'bevel'} transformmatplotlib.transforms.Transformurlstr visiblebool xdata1D array ydata1D array zorderfloat
See also
magnitude_spectrum()magnitude_spectrum()plots the magnitudes of the corresponding frequencies.angle_spectrum()angle_spectrum()plots the wrapped version of this function.specgram()specgram()can plot the phase spectrum of segments within the signal in a colormap.
Notes
Note
In addition to the above described arguments, this function can take a data keyword argument. If such a data argument is given, the following arguments are replaced by data[<arg>]:
- All arguments with the following names: 'x'.
Objects passed as data must support item access (
data[<arg>]) and membership test (<arg> in data). -
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.2.2/api/_as_gen/matplotlib.axes.Axes.phase_spectrum.html