Skip to content

Commit

Permalink
add misc_utils
Browse files Browse the repository at this point in the history
  • Loading branch information
@takenori-y
takenori-y committed Nov 25, 2020
1 parent fe57795 commit 09f59ea
Show file tree
Hide file tree
Showing 6 changed files with 462 additions and 165 deletions.
141 changes: 141 additions & 0 deletions include/SPTK/utils/misc_utils.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
// ----------------------------------------------------------------- //
// The Speech Signal Processing Toolkit (SPTK) //
// developed by SPTK Working Group //
// http://sp-tk.sourceforge.net/ //
// ----------------------------------------------------------------- //
// //
// Copyright (c) 1984-2007 Tokyo Institute of Technology //
// Interdisciplinary Graduate School of //
// Science and Engineering //
// //
// 1996-2020 Nagoya Institute of Technology //
// Department of Computer Science //
// //
// All rights reserved. //
// //
// Redistribution and use in source and binary forms, with or //
// without modification, are permitted provided that the following //
// conditions are met: //
// //
// - Redistributions of source code must retain the above copyright //
// notice, this list of conditions and the following disclaimer. //
// - Redistributions in binary form must reproduce the above //
// copyright notice, this list of conditions and the following //
// disclaimer in the documentation and/or other materials provided //
// with the distribution. //
// - Neither the name of the SPTK working group nor the names of its //
// contributors may be used to endorse or promote products derived //
// from this software without specific prior written permission. //
// //
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND //
// CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, //
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF //
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE //
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS //
// BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, //
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED //
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, //
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON //
// ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, //
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY //
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE //
// POSSIBILITY OF SUCH DAMAGE. //
// ----------------------------------------------------------------- //

#ifndef SPTK_UTILS_MISC_UTILS_H_
#define SPTK_UTILS_MISC_UTILS_H_

#include <vector> // std::vector

namespace sptk {

/**
* Compute the percentage point of the standard normal distribution using the
* formula for the approximation by Toda and Ono.
*
* [1] H. Toda and H. Ono, &quot;The minimax approximation for percentage points
* of the standard normal distribution,&quot; Japanese journal of applied
* statistics, vol. 22, no. 1, pp. 13-21, 1993.
*
* @param[in] probability Probability.
* @param[out] percentage_point Percentage point.
* @return True on success, false on failure.
*/
bool ComputePercentagePointOfStandardNormalDistribution(
double probability, double* percentage_point);

/**
* Compute the probablity of the t-distribution.
*
* @param[in] percentage_point Percentage point.
* @param[in] degrees_of_freedom Degrees of freedom.
* @param[out] probability Probability.
* @return True on success, false on failure.
*/
bool ComputeProbabilityOfTDistribution(double percentage_point,
int degrees_of_freedom,
double* probability);

/**
* Compute the percentage point of the t-distribution using the Cornish-Fisher
* expansion in the percentage point of the standard normal distribution.
*
* [1] R. A. Fisher and E. A. Cornish, &quot;The percentile points of
* distributions having known cumulants,&quot; Technometrics, vol. 2, no. 2,
* pp. 209-225, 1960.
*
* @param[in] probability Probability.
* @param[in] degrees_of_freedom Degrees of freedom.
* @param[out] percentage_point Percentage point.
* @return True on success, false on failure.
*/
bool ComputePercentagePointOfTDistribution(double probability,
int degrees_of_freedom,
double* percentage_point);

/**
* Make pseudo quadrature mirror filter banks under given condition.
*
* [1] T. Q. Nguyen, &quot;Near-perfect-reconstruction pseudo-QMF banks,&quot;
* IEEE Transactions on Signal Processing, vol. 42, no. 1, pp. 65-76, 1994.
*
* [2] Y.-P. Lin and P. P. Vaidyanathan, &quot;A Kaiser window approach for the
* design of prototype filters of cosine modulated filterbanks,&quot; IEEE
* Signal Processing Letters, vol. 5, no. 6, pp. 132-134, 1998.
*
* [3] F. Cruz-Roldan, P. Amo-Lopez, S. Maldonado-Bascon, and S. S. Lawson,
* &quot;An efficient and simple method for designing prototype filters for
* cosine-modulated pseudo-QMF banks,&quot; IEEE Signal Processing Letters,
* vol. 9, no. 1, pp. 29-31, 2002.
*
* @param[in] inverse If true, filter banks for synthesis is calculated.
* @param[in] num_subband Number of subbands.
* @param[in] num_order Order of filter.
* @param[in] attenuation Stopband attenuation.
* @param[in] num_iteration Number of iterations.
* @param[in] convergence_threshold Convergence threshold.
* @param[in] initial_step_size Initial step size.
* @param[out] filter_banks Filter banks.
* @param[out] is_converged True if convergence is reached (optional).
* @return True on success, false on failure.
*/
bool MakePseudoQuadratureMirrorFilterBanks(
bool inverse, int num_subband, int num_order, double attenuation,
int num_iteration, double convergence_threshold, double initial_step_size,
std::vector<std::vector<double> >* filter_banks, bool* is_converged);

/**
* Perform 1D convolution.
*
* @param[in] f First input signal.
* @param[in] g Second Input signal.
* @param[out] result Output signal.
* @return True on success, false on failure.
*/
bool Perform1DConvolution(const std::vector<double>& f,
const std::vector<double>& g,
std::vector<double>* result);

} // namespace sptk

#endif // SPTK_UTILS_MISC_UTILS_H_
12 changes: 1 addition & 11 deletions include/SPTK/utils/sptk_utils.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,22 +97,12 @@ bool IsInRange(double num, double min, double max);
bool IsPowerOfTwo(int num);
bool IsValidAlpha(double alpha);
bool IsValidGamma(double gamma);
int NextPow(int num);
int ExtractSign(double x);
double FloorLog(double x);
double FloorLog2(double x);
double FloorLog10(double x);
double AddInLogSpace(double log_x, double log_y);
bool ComputePercentagePointOfStandardNormalDistribution(
double probability, double* percentage_point);
bool ComputeProbabilityOfTDistribution(double percentage_point,
int degrees_of_freedom,
double* probability);
bool ComputePercentagePointOfTDistribution(double probability,
int degrees_of_freedom,
double* percentage_point);
bool Perform1DConvolution(const std::vector<double>& f,
const std::vector<double>& g,
std::vector<double>* result);
void PrintDataType(const std::string& symbol, std::ostream* stream);
void PrintErrorMessage(const std::string& program_name,
const std::ostringstream& message);
Expand Down
2 changes: 2 additions & 0 deletions src/conversion/filter_coefficients_to_group_delay.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@
#include <cmath> // std::pow
#include <cstddef> // std::size_t

#include "SPTK/utils/misc_utils.h"

namespace sptk {

FilterCoefficientsToGroupDelay::FilterCoefficientsToGroupDelay(
Expand Down
1 change: 1 addition & 0 deletions src/main/vstat.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@

#include "SPTK/math/statistics_accumulator.h"
#include "SPTK/math/symmetric_matrix.h"
#include "SPTK/utils/misc_utils.h"
#include "SPTK/utils/sptk_utils.h"

namespace {
Expand Down
Loading

0 comments on commit 09f59ea

Please sign in to comment.