Commit 2dd54dbe authored by thomas.forbriger's avatar thomas.forbriger

libpsdxx [FIX][API]: replace coherency -> coherence

parent 6785f1f0
......@@ -74,7 +74,7 @@ $(call CHECKVARS,TF_BROWSER TF_WWWBASEDIR)
LIBHEADERS=debug.h error.h function_template_log_sampling.h psd.h helper.h
LIBCCSRC= \
dpsdcomputer_mscoherency.cc \
dpsdcomputer_mscoherence.cc \
dpsdcomputer_normalized_cpsd.cc \
dpsdcomputer_cross_psd.cc \
dpsdcomputer_parameters.cc \
......
......@@ -11,7 +11,7 @@ Description
-----------
This library (libpsdxx) provides a C++ class to compute the cross power
spectral density of two time series, the power spectral density of a single
time series and the coherency of two time series.
time series and the coherence of two time series.
Documentation
=============
......
......@@ -56,7 +56,7 @@ Compute cross power spectral density and power spectral density.
\par Description
This library (libpsdxx) provides a C++ class to compute the cross power
spectral density of two time series, the power spectral density of a single
time series and the coherency of two time series.
time series and the coherence of two time series.
\date 01.01.2019
*/
......
/*! \file dpsdcomputer_mscoherency.cc
* \brief compute magnitude squared coherency (implementation)
/*! \file dpsdcomputer_mscoherence.cc
* \brief compute magnitude squared coherence (implementation)
*
* ----------------------------------------------------------------------------
*
* \author Thomas Forbriger
* \date 03/01/2019
*
* compute magnitude squared coherency (implementation)
* compute magnitude squared coherence (implementation)
*
* Copyright (c) 2019 by Thomas Forbriger (BFO Schiltach)
*
......@@ -30,8 +30,8 @@
*
* ============================================================================
*/
#define PSDXX_DPSDCOMPUTER_MSCOHERENCY_CC_VERSION \
"PSDXX_DPSDCOMPUTER_MSCOHERENCY_CC V1.0"
#define PSDXX_DPSDCOMPUTER_MScoherence_CC_VERSION \
"PSDXX_DPSDCOMPUTER_MScoherence_CC V1.0"
#include <psdxx/psd.h>
#include <aff/iterator.h>
......@@ -39,7 +39,7 @@
namespace psd {
/*! compute magnitude squared coherency
/*! compute magnitude squared coherence
*
* Compute
* \f[
......@@ -52,7 +52,7 @@ namespace psd {
*
* The function returns are series of real values.
*/
TDISeries DPSDComputer::mscoherency(const TDISeries::Tcoc& s1,
TDISeries DPSDComputer::mscoherence(const TDISeries::Tcoc& s1,
const TDISeries::Tcoc& s2) const
{
SpectralValues sv=this->processor(s1, s2, true, true);
......@@ -71,8 +71,8 @@ namespace psd {
++S; ++P1; ++P2;
}
return(retval);
} // TDISeries DPSDComputer::mscoherency(...) const
} // TDISeries DPSDComputer::mscoherence(...) const
} // namespace psd
/* ----- END OF dpsdcomputer_mscoherency.cc ----- */
/* ----- END OF dpsdcomputer_mscoherence.cc ----- */
......@@ -59,7 +59,7 @@ namespace psd {
/*! general processor (internal use only)
*
* The function is used by member functions psd, coherency, and cross_psd to
* The function is used by member functions psd, coherence, and cross_psd to
* do the actual computation.
*
* \param s1 first input time series
......@@ -87,7 +87,7 @@ namespace psd {
* - \c psd2 is empty
* - \c cpsd contains cross power spectral density of \p s1 and \p s2
*
* \par Compute coherency of two input series
* \par Compute coherence of two input series
* Provide \p s1 and \p s2, the series for which the cross PSD will be
* computed and pass \p cpsd_flag=true and \p psd_flag=true.
* Member fields of the return value are:
......@@ -95,7 +95,7 @@ namespace psd {
* - \c psd2 contains PSD of \p s2
* - \c cpsd contains cross power spectral density of \p s1 and \p s2
* .
* The calling program has to compute actual coherency from the series in
* The calling program has to compute actual coherence from the series in
* the return value.
*
*
......
......@@ -46,7 +46,7 @@
* DPSDComputer is used to compute a spectral representation of
* - power spectral density
* - cross power spectral density
* - coherency
* - coherence
*
* on a uniformly spaced frequency axis. The class provides zero padding,
* segmentation of time series with overlap and averaging
......@@ -122,7 +122,7 @@ namespace psd {
/* ====================================================================== */
// containers for equally spaced data providing sampling information
//! time series and real spectral values (PSD and coherency)
//! time series and real spectral values (PSD and coherence)
typedef IntervalSeries<double> TDISeries;
//! complex coefficients
typedef IntervalSeries<std::complex<double> > TDCISeries;
......@@ -187,7 +187,7 @@ namespace psd {
* This class computes
* - power spectral density of a single time series
* - cross power spectral density of two time series
* - coherency of two time series
* - coherence of two time series
*
* The actual computation is provided through function operators.
*
......@@ -234,8 +234,8 @@ namespace psd {
//! compute normalized cross-power spectral density
TDCISeries normalized_cpsd(const TDISeries::Tcoc& s1,
const TDISeries::Tcoc& s2) const;
//! compute magnitude squared coherency
TDISeries mscoherency(const TDISeries::Tcoc& s1,
//! compute magnitude squared coherence
TDISeries mscoherence(const TDISeries::Tcoc& s1,
const TDISeries::Tcoc& s2) const;
//!@}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment