/* ----------------------------------------------------------------------
 * Project:      CMSIS DSP Library
 * Title:        arm_welch_f64.c
 * Description:  Floating-point (f64) Welch window
 *
 * $Date:        14 December 2022
 * $Revision:    v1.15.0
 *
 * Target Processor: Cortex-M and Cortex-A cores
 * -------------------------------------------------------------------- */
/*
 * Copyright (C) 2010-2022 ARM Limited or its affiliates. All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the License); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "dsp/window_functions.h"

/**
  @ingroup groupWindow
 */

/**
  @defgroup WindowNormal Regular window functions

  Regular window functions that can be used for
  detecting tones or estimating the noise.
  If you need to estimate the amplitude of a tones,
  prefer a flat top window.

 */



/**
  @addtogroup WindowNormal
  @{
 */


/**
  @ingroup WindowWELCH
 */

/**
  @brief         Welch window generating function (f64).
  @param[out]    pDst       points to the output generated window
  @param[in]     blockSize  number of samples in the window
 
  @par Parameters of the window
  
  | Parameter                             | Value              |
  | ------------------------------------: | -----------------: |
  | Peak sidelobe level                   |           21.3 dB  |
  | Normalized equivalent noise bandwidth |          1.2 bins  |
  | 3 dB bandwidth                        |       1.1535 bins  |
  | Flatness                              |        -2.2248 dB  |
  | Recommended overlap                   |            29.3 %  |

 */



ARM_DSP_ATTRIBUTE void arm_welch_f64(
        float64_t * pDst,
        uint32_t blockSize)
{
   float64_t k = 2.0 / ((float64_t) blockSize);
   float64_t w;

   for(uint32_t i=0;i<blockSize;i++)
   {
     w = i * k - 1.0;
     w = 1.0 - w * w;
     pDst[i] = w;
   }
}

/**
  @} end of WindowNormal group
 */

