essentia icon indicating copy to clipboard operation
essentia copied to clipboard

Parameter description does not match parameter choice for `normalize` in MelBands, TriangularBands & MFCC

Open Bomme opened this issue 4 years ago • 0 comments

The documentation for the algorithms MelBands, TriangularBands & MFCC contains this parameter:

normalize (string ∈ {unit_sum, unit_tri, unit_max}, default = unit_sum) :
    spectrum bin weights to use for each mel band: 
    'unit_max' to make each mel band vertex equal to 1,
    'unit_sum' to make each mel band area equal to 1 summing the actual weights of spectrum bins,
    'unit_area' to make each triangle mel band area equal to 1 normalizing the weights of each triangle by its bandwidth

'unit_area' appears in the text but is not in the set {unit_sum, unit_tri, unit_max} and I did not find it in the code. I guess it should be replaced with unit_tri? Maybe you can confirm.

Bomme avatar Oct 26 '21 17:10 Bomme