aspen.processings.extract_envelope

Extract envelope

Functions

extract_envelope(x[, method, lpf_freq, …])

Extract the envelope from a signal

Classes

ExtractEnvelope([extract_envelope_method, …])

Extract the envelope from a signal

class aspen.processings.extract_envelope.ExtractEnvelope(extract_envelope_method='rect', extract_envelope_lpf_freq=16.0, extract_envelope_lpf_impulse_response='fir', extract_envelope_lpf_filter_order=512, extract_envelope_lpf_fir_window='hann', samp_freq=16000)[source]

Bases: aspen.interfaces.abs_common_interface.AbsCommonInterface, aspen.interfaces.abs_processing_interface.AbsProcessingInterface

Extract the envelope from a signal

Parameters
  • extract_envelope_method (str) – Extracting method of envelope. Defaults to “rect”.

  • extract_envelope_lpf_freq (float) – Frequency of low-pass filter. Defaults to 16.0.

  • extract_envelope_lpf_impulse_response (str) – Impulse response for low-pass filter. Defaults to “fir”.

  • extract_envelope_lpf_filter_order (int) – Filter order of low-pass filter. Defaults to 512.

  • extract_envelope_lpf_fir_window (str) – Window function for low-pass filter. Use only when lpf-impulse-response=fir. Defaults to “hann”.

  • samp_freq (int) – Sampling frequency. Defaults to 16000.

__call__(x)[source]

Apply envelope extracting

Parameters

x (ndarray) – Input signal

Return type

ndarray

Returns

Output signal

static add_arguments(parser)[source]

add arguments

classmethod load_class_kwargs(args)

Return the kwargs dict for class __init__ from parsed arguments

Parameters

args (Namespace) – (config)argparse arguments

Return type

dict

Returns

kwargs for class __init__

aspen.processings.extract_envelope.extract_envelope(x, method='rect', lpf_freq=16, lpf_impulse_response='fir', lpf_filter_order=512, lpf_fir_window='hann', samp_freq=16000)[source]

Extract the envelope from a signal

Parameters
  • x (ndarray) – Input signal

  • method (str) – Extracting method of envelope. Defaults to “rect”.

  • lpf_freq (float) – Frequency of low-pass filter. Defaults to 16.0.

  • lpf_impulse_response (str) – Impulse response for low-pass filter. Defaults to “fir”.

  • lpf_filter_order (int) – Filter order of low-pass filter. Defaults to 512.

  • lpf_fir_window (str) – Window function for low-pass filter. Use only when lpf-impulse-response=fir. Defaults to “hann”.

  • samp_freq (int) – Sampling frequency. Defaults to 16000.

Return type

ndarray

Returns

Output signal