faultBandMetrics
Spectral metrics for the specified fault frequency bands of the power spectral density (PSD)
Syntax
Description
returns a set of spectral metrics spectralMetrics
= faultBandMetrics(psd
,freqGrid
,FB
)spectralMetrics
for the power
spectral density (PSD) data psd
defined at the frequencies specified in
freqGrid
for each fault frequency range in
FB
.
The output spectralMetrics
includes peak amplitude, peak frequency,
and band powers for each frequency range specified in FB
along with the
total band power across all frequency bands.
returns a set of spectral metrics spectralMetrics
= faultBandMetrics(X
,FB
)spectralMetrics
for the PSD and
frequency grid data specified in the cell array X
.
faultBandMetrics
assumes that the last column of data in each cell of
X
contains the frequency grid while the first column contains PSD
data. If the data is not in the same order, then use the 'SpectrumColumn
'
and 'FrequencyColumn
' name-value pair arguments to specify the column
numbers or names of the PSD data and the frequency grid, respectively. The output
spectralMetrics
has as many rows as the length of cell array
X
.
returns a set of spectral metrics spectralMetrics
= faultBandMetrics(T
,FB
)spectralMetrics
for the PSD and
frequency grid data specified in the data set T
.
T
can be a table/timetable or an ensemble, where a member variable
of matrices or tables should contain the PSD data corresponding to one experiment. The last
column of data in the member variable should contain the frequency grid and the first column
should contain the PSD data.
If T
is not in the same order, then use the
'SpectrumColumn
' and 'FrequencyColumn
' name-value
pair arguments to specify the column numbers or names of the PSD data and the frequency
grid, respectively. The output spectralMetrics
has as many rows as the
number of rows in data set T
.
allows you to specify additional parameters using one or more name-value pair
arguments.spectralMetrics
= faultBandMetrics(___,Name,Value)
[
also returns a structure spectralMetrics
,info
] = faultBandMetrics(___)info
with additional information about the
table or fileEnsembleDatastore
object variables used to compute
spectralMetrics
.
Examples
Input Arguments
Output Arguments
Extended Capabilities
Version History
Introduced in R2019b