~ubuntu-branches/ubuntu/saucy/openturns/saucy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
\name{estimateTruncatedNormalParameters}
\alias{estimateTruncatedNormalParameters}
\title{Estimates the underlying truncated normal distribution parameters from a sample.}
\description{
This ROT function, called from a TruncatedNormalFactory C++ object, is given a sample
and returns the estimated parameters of the underlying TruncatedNormal distribution,   
as well as the corresponding confidence intervals of required level.                          
}
\usage{
estimateTruncatedNormalParameters(numericalSample, testLevel = 0.975)
}
\arguments{
  \item{numericalSample}{A vector containing the sample.}
  \item{testLevel}{the test level. (scalar in [0:1])}
}
\value{
A list is returned, containing :
  \item{distribution}{The distribution name.}
  \item{mu}{The estimated mu parameter.}
  \item{sigma}{The sigma parameter.}
  \item{a}{The aParameter parameter.}
  \item{b}{The bParameter parameter.}
  \item{confidenceIntervalmu}{CI for the mu parameter (vector).}
  \item{confidenceIntervalsigma}{CI for the sigma parameter (vector).}
  \item{logLikelihood}{The model loglikelihood.}
}
\author{Pierre-Matthieu Pair, RĂ©gis Lebrun.}
\examples{
# Standard TruncatedNormal distribution example.
numericalSample <- rnorm(1000, 3, 1.5)
numericalSample <- numericalSample[numericalSample > 0.0 &&
numericalSample < 5.0]
print(estimateTruncatedNormalParameters(numericalSample))
}
\keyword{distribution}