casacore
ZScoreCalculator.h
Go to the documentation of this file.
1 //# Copyright (C) 2000,2001
2 //# Associated Universities, Inc. Washington DC, USA.
3 //#
4 //# This library is free software; you can redistribute it and/or modify it
5 //# under the terms of the GNU Library General Public License as published by
6 //# the Free Software Foundation; either version 2 of the License, or (at your
7 //# option) any later version.
8 //#
9 //# This library is distributed in the hope that it will be useful, but WITHOUT
10 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12 //# License for more details.
13 //#
14 //# You should have received a copy of the GNU Library General Public License
15 //# along with this library; if not, write to the Free Software Foundation,
16 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
17 //#
18 //# Correspondence concerning AIPS++ should be addressed as follows:
19 //# Internet email: aips2-request@nrao.edu.
20 //# Postal address: AIPS++ Project Office
21 //# National Radio Astronomy Observatory
22 //# 520 Edgemont Road
23 //# Charlottesville, VA 22903-2475 USA
24 //#
25 //# $Id: HostInfoDarwin.h 21521 2014-12-10 08:06:42Z gervandiepen $
26 
27 #ifndef SCIMATH_ZSCORECALCULATOR_H
28 #define SCIMATH_ZSCORECALCULATOR_H
29 
30 #include <casacore/casa/aips.h>
31 
32 #include <cmath>
33 #include <map>
34 #include <mutex>
35 #include <set>
36 
37 namespace casacore {
38 
39 class Mutex;
40 
41 // This class contains static methods related to z-scores. A z-score is the
42 // number of standard deviations from the mean in a normal distribution.
43 
45 public:
46 
47  ZScoreCalculator() = delete;
48 
49  // compute the maximum expected zscore given the number of points
50  // in a sample.
51  static Double getMaxZScore(uInt64 npts);
52 
53  // Get the minimum number of points in a Gaussian distribution, such that
54  // the probability that the maximum of the distribution having the specified
55  // zscore is 0.5. <src>zscore</src> should be non-negative.
56  static inline uInt64 zscoreToNpts(Double zscore) {
57  return (uInt64)(0.5/erfc(zscore/sqrt(2)));
58  }
59 
60 private:
61  static std::map<uInt64, Double> _nptsToMaxZScore;
62  static std::mutex _mutex;
63 
64 };
65 
66 }
67 
68 #endif
This class contains static methods related to z-scores.
static uInt64 zscoreToNpts(Double zscore)
Get the minimum number of points in a Gaussian distribution, such that the probability that the maxim...
static std::map< uInt64, Double > _nptsToMaxZScore
static Double getMaxZScore(uInt64 npts)
compute the maximum expected zscore given the number of points in a sample.
this file contains all the compiler specific defines
Definition: mainpage.dox:28
LatticeExprNode sqrt(const LatticeExprNode &expr)
double Double
Definition: aipstype.h:55
unsigned long long uInt64
Definition: aipsxtype.h:39