SpectralPeakAmplitude

class of dascore.transform.spectral_descriptors inherits from: dascore.transform.spectral_descriptors._SharedFields, dascore.transform.spectral_descriptors._SpectralDescriptor, PatchProcessor, DascoreBaseModel, pydantic.main.BaseModel

source

SpectralPeakAmplitude(
    *args ,
    dim: Any = None,
    fmin: Any = None,
    fmax: Any = None,
    spectral_format: Any = auto,
    negative_frequencies: Any = auto,
)-> None

Compute the peak spectral amplitude of a Fourier-domain patch.

The input patch must already be transformed with Patch.dft or Patch.stft. The descriptor returns the largest linear spectral amplitude along the requested Fourier dimension within the selected frequency range. This is the global maximum, not a search for multiple local peaks.

Parameters

Parameter	Description
dim	Frequency dimension over which to compute the descriptor. This can be either the original dimension name, such as "time", or the Fourier dimension name, such as "ft_time". If omitted, a single Fourier dimension is inferred.
fmin	Optional lower frequency bound.
fmax	Optional upper frequency bound.
spectral_format	Representation of the spectral data. "auto" uses DASCore DFT/STFT metadata when available. Other options are "fft" for complex Fourier coefficients, "amplitude" for amplitude spectra, "power" for power spectra, and "density" for power spectral densities.
negative_frequencies	How to handle negative frequency bins. "auto" drops negative bins when power is symmetric and raises otherwise, folding a verified negative Nyquist bin to positive frequency without changing its power. "drop" always uses non-negative frequencies, "raise" rejects spectra with negative bins, and "keep" includes them in the calculation.

Returns

PatchType Patch containing the maximum spectral amplitude.

Methods

Name	Description
check	Refuse a patch which does not carry what the operation needs.
describe	Return the largest amplitude.
get_metadata	Return the reduced metadata, and the bins and format to read.
model_copy	Copy the model, dropping cached values the update invalidates.
new	Create new instance with some attributed updated.
numpy_kernel	Return the descriptor of the power in the bins kept.
spectral_peak_amplitude	Compute the peak spectral amplitude of a Fourier-domain patch.
reconcile	Return metadata or a patch holding the final data; default as is.
result_dtype	Return the power’s own dtype.
run	Run the operation: check, get_metadata, kernel, reconcile, record.
units	Return the amplitude’s units: a power’s square root.