/usr/include/root/Fit/BinData.h is in libroot-math-mathcore-dev 5.34.19+dfsg-1.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 | // @(#)root/mathcore:$Id$
// Author: L. Moneta Wed Aug 30 11:15:23 2006
/**********************************************************************
* *
* Copyright (c) 2006 LCG ROOT Math Team, CERN/PH-SFT *
* *
* *
**********************************************************************/
// Header file for class BinData
#ifndef ROOT_Fit_BinData
#define ROOT_Fit_BinData
#ifndef ROOT_Fit_DataVector
#include "Fit/DataVector.h"
#endif
#ifdef USE_BINPOINT_CLASS
#ifndef ROOT_Fit_BinPoint
#include "Fit/BinPoint.h"
#endif
#endif
namespace ROOT {
namespace Fit {
//___________________________________________________________________________________
/**
Class describing the binned data sets :
vectors of x coordinates, y values and optionally error on y values and error on coordinates
The dimension of the coordinate is free
There are 4 different options:
- only coordinates and values (for binned likelihood fits) : kNoError
- coordinate, values and error on values (for normal least square fits) : kValueError
- coordinate, values, error on values and coordinates (for effective least square fits) : kCoordError
- corrdinate, values, error on coordinates and asymmettric error on valyes : kAsymError
In addition there is the option to construct Bindata copying the data in (using the DataVector class)
or using pointer to external data (DataWrapper) class.
In general is found to be more efficient to copy the data.
In case of really large data sets for limiting memory consumption then the other option can be used
Specialized constructor exists for data up to 3 dimensions.
When the data are copying in the number of points can be set later (or re-set) using Initialize and
the data are inserted one by one using the Add method.
It is mandatory to set the size before using the Add method.
@ingroup FitData
*/
class BinData : public FitData {
public :
enum ErrorType { kNoError, kValueError, kCoordError, kAsymError };
static unsigned int GetPointSize(ErrorType err, unsigned int dim) {
if (dim == 0 || dim > MaxSize() ) return 0;
if (err == kNoError) return dim + 1; // no errors
if (err == kValueError) return dim + 2; // error only on the value
if (err == kCoordError) return 2 * dim + 2 ; // error on value and coordinate
return 2 * dim + 3; // error on value (low and high) and error on coordinate
}
ErrorType GetErrorType() const {
if (fPointSize == fDim + 1) return kNoError;
if (fPointSize == fDim + 2) return kValueError;
if (fPointSize == 2 * fDim + 2) return kCoordError;
assert( fPointSize == 2 * fDim + 3 ) ;
return kAsymError;
}
/**
constructor from dimension of point and max number of points (to pre-allocate vector)
Give a zero value and then use Initialize later one if the size is not known
*/
explicit BinData(unsigned int maxpoints = 0, unsigned int dim = 1, ErrorType err = kValueError);
/**
constructor from option and default range
*/
explicit BinData (const DataOptions & opt, unsigned int maxpoints = 0, unsigned int dim = 1, ErrorType err = kValueError);
/**
constructor from options and range
efault is 1D and value errors
*/
BinData (const DataOptions & opt, const DataRange & range, unsigned int maxpoints = 0, unsigned int dim = 1, ErrorType err = kValueError );
/** constructurs using external data */
/**
constructor from external data for 1D with errors on coordinate and value
*/
BinData(unsigned int n, const double * dataX, const double * val, const double * ex , const double * eval );
/**
constructor from external data for 2D with errors on coordinate and value
*/
BinData(unsigned int n, const double * dataX, const double * dataY, const double * val, const double * ex , const double * ey, const double * eval );
/**
constructor from external data for 3D with errors on coordinate and value
*/
BinData(unsigned int n, const double * dataX, const double * dataY, const double * dataZ, const double * val, const double * ex , const double * ey , const double * ez , const double * eval );
/**
copy constructors
*/
BinData(const BinData &);
/**
assignment operator
*/
BinData & operator= (const BinData &);
/**
destructor
*/
virtual ~BinData();
/**
preallocate a data set with given size , dimension and error type (to get the full point size)
If the data set already exists and it is having the compatible point size space for the new points
is created in the data sets, while if not compatible the old data are erased and new space of
new size is allocated.
(i.e if exists initialize is equivalent to a resize( NPoints() + maxpoints)
*/
void Initialize(unsigned int maxpoints, unsigned int dim = 1, ErrorType err = kValueError );
/**
return the size of a fit point (is the coordinate dimension + 1 for the value and eventually
the number of all errors
*/
unsigned int PointSize() const {
return fPointSize;
}
/**
return the size of internal data (number of fit points)
if data are not copied in but used externally the size is 0
*/
unsigned int DataSize() const {
if (fDataVector) return fDataVector->Size();
return 0;
}
/**
flag to control if data provides error on the coordinates
*/
bool HaveCoordErrors() const {
if (fPointSize > fDim +2) return true;
return false;
}
/**
flag to control if data provides asymmetric errors on the value
*/
bool HaveAsymErrors() const {
if (fPointSize > 2 * fDim +2) return true;
return false;
}
/**
add one dim data with only coordinate and values
*/
void Add(double x, double y );
/**
add one dim data with no error in the coordinate (x)
in this case store the inverse of the error in the value (y)
*/
void Add(double x, double y, double ey);
/**
add one dim data with error in the coordinate (x)
in this case store the value (y) error and not the inverse
*/
void Add(double x, double y, double ex, double ey);
/**
add one dim data with error in the coordinate (x) and asymmetric errors in the value (y)
in this case store the y errors and not the inverse
*/
void Add(double x, double y, double ex, double eyl , double eyh);
/**
add multi-dim coordinate data with only value (no errors)
*/
void Add(const double *x, double val);
/**
add multi-dim coordinate data with only error in value
*/
void Add(const double *x, double val, double eval);
/**
add multi-dim coordinate data with both error in coordinates and value
*/
void Add(const double *x, double val, const double * ex, double eval);
/**
add multi-dim coordinate data with both error in coordinates and value
*/
void Add(const double *x, double val, const double * ex, double elval, double ehval);
/**
return a pointer to the coordinates data for the given fit point
*/
const double * Coords(unsigned int ipoint) const {
if (fDataVector)
return &((fDataVector->Data())[ ipoint*fPointSize ] );
return fDataWrapper->Coords(ipoint);
}
/**
return the value for the given fit point
*/
double Value(unsigned int ipoint) const {
if (fDataVector)
return (fDataVector->Data())[ ipoint*fPointSize + fDim ];
return fDataWrapper->Value(ipoint);
}
/**
return error on the value for the given fit point
Safe (but slower) method returning correctly the error on the value
in case of asymm errors return the average 0.5(eu + el)
*/
double Error(unsigned int ipoint) const {
if (fDataVector) {
ErrorType type = GetErrorType();
if (type == kNoError ) return 1;
// error on the value is the last element in the point structure
double eval = (fDataVector->Data())[ (ipoint+1)*fPointSize - 1];
if (type == kValueError ) // need to invert (inverror is stored)
return eval != 0 ? 1.0/eval : 0;
else if (type == kAsymError) { // return 1/2(el + eh)
double el = (fDataVector->Data())[ (ipoint+1)*fPointSize - 2];
return 0.5 * (el+eval);
}
return eval; // case of coord errors
}
return fDataWrapper->Error(ipoint);
}
/**
Return the inverse of error on the value for the given fit point
useful when error in the coordinates are not stored and then this is used directly this as the weight in
the least square function
*/
double InvError(unsigned int ipoint) const {
if (fDataVector) {
// error on the value is the last element in the point structure
double eval = (fDataVector->Data())[ (ipoint+1)*fPointSize - 1];
return eval;
// if (!fWithCoordError) return eval;
// // when error in the coordinate is stored, need to invert it
// return eval != 0 ? 1.0/eval : 0;
}
//case data wrapper
double eval = fDataWrapper->Error(ipoint);
return eval != 0 ? 1.0/eval : 0;
}
/**
Return a pointer to the errors in the coordinates for the given fit point
*/
const double * CoordErrors(unsigned int ipoint) const {
if (fDataVector) {
// error on the value is the last element in the point structure
return &(fDataVector->Data())[ (ipoint)*fPointSize + fDim + 1];
}
return fDataWrapper->CoordErrors(ipoint);
}
/**
retrieve at the same time a pointer to the coordinate data and the fit value
More efficient than calling Coords(i) and Value(i)
*/
const double * GetPoint(unsigned int ipoint, double & value) const {
if (fDataVector) {
unsigned int j = ipoint*fPointSize;
const std::vector<double> & v = (fDataVector->Data());
const double * x = &v[j];
value = v[j+fDim];
return x;
}
value = fDataWrapper->Value(ipoint);
return fDataWrapper->Coords(ipoint);
}
/**
retrieve in a single call a pointer to the coordinate data, value and inverse error for
the given fit point.
To be used only when type is kValueError or kNoError. In the last case the value 1 is returned
for the error.
*/
const double * GetPoint(unsigned int ipoint, double & value, double & invError) const {
if (fDataVector) {
const std::vector<double> & v = (fDataVector->Data());
unsigned int j = ipoint*fPointSize;
const double * x = &v[j];
j += fDim;
value = v[j];
if (fPointSize == fDim +1) // value error (type=kNoError)
invError = 1;
else if (fPointSize == fDim +2) // value error (type=kNoError)
invError = v[j+1];
else
assert(0); // cannot be here
return x;
}
value = fDataWrapper->Value(ipoint);
double e = fDataWrapper->Error(ipoint);
invError = ( e > 0 ) ? 1.0/e : 1.0;
return fDataWrapper->Coords(ipoint);
}
/**
Retrieve the errors on the point (coordinate and value) for the given fit point
It must be called only when the coordinate errors are stored otherwise it will produce an
assert.
*/
const double * GetPointError(unsigned int ipoint, double & errvalue) const {
if (fDataVector) {
assert(fPointSize > fDim + 2);
unsigned int j = ipoint*fPointSize;
const std::vector<double> & v = (fDataVector->Data());
const double * ex = &v[j+fDim+1];
errvalue = v[j + 2*fDim +1];
return ex;
}
errvalue = fDataWrapper->Error(ipoint);
return fDataWrapper->CoordErrors(ipoint);
}
/**
Get errors on the point (coordinate errors and asymmetric value errors) for the
given fit point.
It must be called only when the coordinate errors and asymmetric errors are stored
otherwise it will produce an assert.
*/
const double * GetPointError(unsigned int ipoint, double & errlow, double & errhigh) const {
// external data is not supported for asymmetric errors
assert(fDataVector);
assert(fPointSize > 2 * fDim + 2);
unsigned int j = ipoint*fPointSize;
const std::vector<double> & v = (fDataVector->Data());
const double * ex = &v[j+fDim+1];
errlow = v[j + 2*fDim +1];
errhigh = v[j + 2*fDim +2];
return ex;
}
#ifdef USE_BINPOINT_CLASS
const BinPoint & GetPoint(unsigned int ipoint) const {
if (fDataVector) {
unsigned int j = ipoint*fPointSize;
const std::vector<double> & v = (fDataVector->Data());
const double * x = &v[j];
double value = v[j+fDim];
if (fPointSize > fDim + 2) {
const double * ex = &v[j+fDim+1];
double err = v[j + 2*fDim +1];
fPoint.Set(x,value,ex,err);
}
else {
double invError = v[j+fDim+1];
fPoint.Set(x,value,invError);
}
}
else {
double value = fDataWrapper->Value(ipoint);
double e = fDataWrapper->Error(ipoint);
if (fPointSize > fDim + 2) {
fPoint.Set(fDataWrapper->Coords(ipoint), value, fDataWrapper->CoordErrors(ipoint), e);
} else {
double invError = ( e != 0 ) ? 1.0/e : 0;
fPoint.Set(fDataWrapper->Coords(ipoint), value, invError);
}
}
return fPoint;
}
const BinPoint & GetPointError(unsigned int ipoint) const {
if (fDataVector) {
unsigned int j = ipoint*fPointSize;
const std::vector<double> & v = (fDataVector->Data());
const double * x = &v[j];
double value = v[j+fDim];
double invError = v[j+fDim+1];
fPoint.Set(x,value,invError);
}
else {
double value = fDataWrapper->Value(ipoint);
double e = fDataWrapper->Error(ipoint);
double invError = ( e != 0 ) ? 1.0/e : 0;
fPoint.Set(fDataWrapper->Coords(ipoint), value, invError);
}
return fPoint;
}
#endif
/**
resize the vector to the new given npoints
if vector does not exists is created using existing point size
*/
void Resize (unsigned int npoints);
/**
return number of fit points
*/
unsigned int NPoints() const { return fNPoints; }
/**
return number of fit points
*/
unsigned int Size() const { return fNPoints; }
/**
return coordinate data dimension
*/
unsigned int NDim() const { return fDim; }
/**
apply a Log transformation of the data values
can be used for example when fitting an exponential or gaussian
Transform the data in place need to copy if want to preserve original data
The data sets must not contain negative values. IN case it does,
an empty data set is returned
*/
BinData & LogTransform();
/**
return an array containing the upper edge of the bin for coordinate i
In case of empty bin they could be merged in a single larger bin
Return a NULL pointer if the bin width is not stored
*/
const double * BinUpEdge(unsigned int icoord) const {
if (fBinEdge.size() == 0 || icoord*fDim > fBinEdge.size() ) return 0;
return &fBinEdge[ icoord * fDim];
}
/**
query if the data store the bin edges instead of the center
*/
bool HasBinEdges() const {
return fBinEdge.size() > 0 && fBinEdge.size() == fDim*fNPoints;
}
/**
add the bin width data, a pointer to an array with the bin upper edge information.
This is needed when fitting with integral options
The information is added for the previously inserted point.
BinData::Add must be called before
*/
void AddBinUpEdge(const double * xup);
/**
retrieve the reference volume used to normalize the data when the option bin volume is set
*/
double RefVolume() const { return fRefVolume; }
/**
set the reference volume used to normalize the data when the option bin volume is set
*/
void SetRefVolume(double value) { fRefVolume = value; }
/**
compute the total sum of the data content
(sum of weights in cse of weighted data set)
*/
double SumOfContent() const { return fSumContent; }
/**
compute the total sum of the error square
(sum of weight square in case of a weighted data set)
*/
double SumOfError2() const { return fSumError2;}
protected:
void SetNPoints(unsigned int n) { fNPoints = n; }
private:
unsigned int fDim; // coordinate dimension
unsigned int fPointSize; // total point size including value and errors (= fDim + 2 for error in only Y )
unsigned int fNPoints; // number of contained points in the data set (can be different than size of vector)
double fSumContent; // total sum of the bin data content
double fSumError2; // total sum square of the errors
double fRefVolume; // reference bin volume - used to normalize the bins in case of variable bins data
DataVector * fDataVector; // pointer to the copied in data vector
DataWrapper * fDataWrapper; // pointer to the external data wrapper structure
std::vector<double> fBinEdge; // vector containing the bin upper edge (coordinate will contain low edge)
#ifdef USE_BINPOINT_CLASS
mutable BinPoint fPoint;
#endif
};
} // end namespace Fit
} // end namespace ROOT
#endif /* ROOT_Fit_BinData */
|