jamie@141: /*
jamie@141:  * Copyright (C) 2012 Jamie Bullock
jamie@107:  *
jamie@141:  * Permission is hereby granted, free of charge, to any person obtaining a copy
jamie@141:  * of this software and associated documentation files (the "Software"), to
jamie@141:  * deal in the Software without restriction, including without limitation the
jamie@141:  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
jamie@141:  * sell copies of the Software, and to permit persons to whom the Software is
jamie@141:  * furnished to do so, subject to the following conditions:
jamie@107:  *
jamie@141:  * The above copyright notice and this permission notice shall be included in
jamie@141:  * all copies or substantial portions of the Software.
jamie@107:  *
jamie@141:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
jamie@141:  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
jamie@141:  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
jamie@141:  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
jamie@141:  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
jamie@141:  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
jamie@141:  * IN THE SOFTWARE.
jamie@141:  *
jamie@107:  */
jamie@107: 
jamie@107: /* xtract_window_private.h: declares window generation functions */
jamie@107: 
jamie@107: #define PI 3.1415926535897931
jamie@107: 
jamie@107: /** \brief generate a Gaussian window
jamie@107:  *
jamie@107:  * \param *window a pointer to an array to contain the window data
jamie@107:  * \param N the number of elements in the array pointed to by *window
jamie@107:  * \param sd the standard deviation of the "distribution" represented by the Gaussian curve. The higher the value of sd, the wider the curve. Generally sd <= 0.5
jamie@107:  *
jamie@107:  */
jamie@146: void gauss(double *window, const int N, const double sd);
jamie@107: 
jamie@107: /** \brief generate a Hamming window
jamie@107:  *
jamie@107:  * \param *window a pointer to an array to contain the window data
jamie@107:  * \param N the number of elements in the array pointed to by *window
jamie@107:  *
jamie@107:  */
jamie@146: void hamming(double *window, const int N);
jamie@107: 
jamie@107: /** \brief generate a Hann window
jamie@107:  *
jamie@107:  * \param *window a pointer to an array to contain the window data
jamie@107:  * \param N the number of elements in the array pointed to by *window
jamie@107:  *
jamie@107:  */
jamie@146: void hann(double *window, const int N);
jamie@107: 
jamie@107: /** \brief generate a Bartlett window
jamie@107:  *
jamie@107:  * \param *window a pointer to an array to contain the window data
jamie@107:  * \param N the number of elements in the array pointed to by *window
jamie@107:  *
jamie@107:  */
jamie@146: void bartlett(double *window, const int N);
jamie@107: 
jamie@107: /** \brief generate a Triangular window
jamie@107:  *
jamie@107:  * \param *window a pointer to an array to contain the window data
jamie@107:  * \param N the number of elements in the array pointed to by *window
jamie@107:  *
jamie@107:  */
jamie@146: void triangular(double *window, const int N);
jamie@107: 
jamie@107: /** \brief generate a Bartlett-Hann  window
jamie@107:  *
jamie@107:  * \param *window a pointer to an array to contain the window data
jamie@107:  * \param N the number of elements in the array pointed to by *window
jamie@107:  *
jamie@107:  */
jamie@146: void bartlett_hann(double *window, const int N);
jamie@107: 
jamie@107: /** \brief generate a Blackman window
jamie@107:  *
jamie@107:  * \param *window a pointer to an array to contain the window data
jamie@107:  * \param N the number of elements in the array pointed to by *window
jamie@107:  *
jamie@107:  */
jamie@146: void blackman(double *window, const int N);
jamie@107: 
jamie@107: /** \brief generate a Kaiser window
jamie@107:  *
jamie@107:  * \param *window a pointer to an array to contain the window data
jamie@107:  * \param N the number of elements in the array pointed to by *window
jamie@107:  * \param alpha The larger the value of |alpha|, the narrower the window becomes
jamie@107:  *
jamie@107:  */
jamie@146: void kaiser(double *window, const int N, const double alpha);
jamie@107: 
jamie@107: /** \brief generate a Blackman-Harris window
jamie@107:  *
jamie@107:  * \param *window a pointer to an array to contain the window data
jamie@107:  * \param N the number of elements in the array pointed to by *window
jamie@107:  *
jamie@107:  */
jamie@146: void blackman_harris(double *window, const int N);
jamie@107: