bundles / scipy 1.17.1 / scipy / signal / _short_time_fft / ShortTimeFFT / upper_border_begin
function
scipy.signal._short_time_fft:ShortTimeFFT.upper_border_begin
Signature
def upper_border_begin ( self , n : int ) → tuple[int, int] Summary
First signal index and first slice index affected by post-padding.
Extended Summary
Describes the point where the window does begin stick out to the right of the signal domain. A detailed example is given tutorial_stft_sliding_win section of the user_guide.
Parameters
n: intNumber of samples of input signal (must be ≥ half of the window length).
Returns
k_ub: intLowest signal index, where a touching time slice sticks out past the signal end.
p_ub: intLowest index of time slice of which the end sticks out past the signal end.
Notes
Note that the return values are cached together with the parameter n to avoid unnecessary recalculations.
See also
- ShortTimeFFT
Class this method belongs to.
- k_max
First sample index after signal end not touched by a time slice.
- k_min
The smallest possible signal index.
- lower_border_end
Where pre-padding effects end.
- p_max
Index of first non-overlapping upper time slice.
- p_min
The smallest possible slice index.
- p_num
Number of time slices, i.e.,
p_max-p_min.- p_range
Determine and validate slice index range.
Aliases
-
scipy.signal.ShortTimeFFT.upper_border_begin