Warning, /include/Geant4/tools/histo/p1 is written in an unsupported language. File is not indexed.
0001 // Copyright (C) 2010, Guy Barrand. All rights reserved.
0002 // See the file tools.license for terms.
0003
0004 #ifndef tools_histo_p1
0005 #define tools_histo_p1
0006
0007 #include "b1"
0008 #include "profile_data"
0009
0010 namespace tools {
0011 namespace histo {
0012
0013 //TC is for a coordinate.
0014 //TO is for an offset/index to identify/find a bind.
0015 //TN is for a number of entries.
0016 //TW is for a weight.
0017 //TH is for a height. Should be the same as TV.
0018 //TV is for a value (in general same as TC).
0019
0020 template <class TC,class TO,class TN,class TW,class TH,class TV>
0021 class p1 : public b1<TC,TO,TN,TW,TH> {
0022 typedef b1<TC,TO,TN,TW,TH> parent;
0023 public:
0024 typedef profile_data<TC,TO,TN,TW,TV> pd_t;
0025 typedef typename parent::bn_t bn_t;
0026 typedef typename parent::axis_t axis_t;
0027 typedef std::vector<TV> vs_t;
0028 protected:
0029 virtual TH get_bin_height(TO a_offset) const {
0030 return (parent::m_bin_Sw[a_offset] ? (m_bin_Svw[a_offset]/parent::m_bin_Sw[a_offset]):0);
0031 }
0032 public:
0033 bool equals(const p1& a_from,const TW& a_prec,TW(*a_fabs)(TW)) const {
0034 if(!parent::equals(a_from,a_prec,a_fabs)) return false;
0035 if(m_cut_v!=a_from.m_cut_v) return false;
0036 if(!numbers_are_equal(m_min_v,a_from.m_min_v,a_prec,a_fabs)) return false;
0037 if(!numbers_are_equal(m_max_v,a_from.m_max_v,a_prec,a_fabs)) return false;
0038 if(!vectors_are_equal(m_bin_Svw,a_from.m_bin_Svw,a_prec,a_fabs)) return false;
0039 if(!vectors_are_equal(m_bin_Sv2w,a_from.m_bin_Sv2w,a_prec,a_fabs)) return false;
0040 return true;
0041 }
0042 bool equals_TH(const p1& a_from,const TW& a_prec,TW(*a_fabs)(TW)) const {
0043 if(!parent::equals_TH(a_from,a_prec,a_fabs,false)) return false;
0044 if(m_cut_v!=a_from.m_cut_v) return false;
0045 if(!numbers_are_equal(m_min_v,a_from.m_min_v,a_prec,a_fabs)) return false;
0046 if(!numbers_are_equal(m_max_v,a_from.m_max_v,a_prec,a_fabs)) return false;
0047 if(!vectors_are_equal(m_bin_Svw,a_from.m_bin_Svw,a_prec,a_fabs)) return false;
0048 if(!vectors_are_equal(m_bin_Sv2w,a_from.m_bin_Sv2w,a_prec,a_fabs)) return false;
0049 return true;
0050 }
0051
0052 virtual TH bin_error(int aI) const { //TH should be the same as TV
0053 TO offset;
0054 if(!parent::_find_offset(aI,offset)) return 0;
0055
0056 //FIXME Is it correct ?
0057 // TProfile::GetBinError with kERRORMEAN mode does :
0058 // Stat_t cont = fArray[bin]; //Svw (see TProfile::Fill)
0059 // Stat_t sum = parent::m_bin_entries.fArray[bin]; //Sw
0060 // Stat_t err2 = fSumw2.fArray[bin]; //Sv2w
0061 // if (sum == 0) return 0;
0062 // Stat_t eprim;
0063 // Stat_t contsum = cont/sum;
0064 // Stat_t eprim2 = TMath::Abs(err2/sum - contsum*contsum);
0065 // eprim = TMath::Sqrt(eprim2);
0066 // ... ???
0067 // if (fErrorMode == kERRORMEAN) return eprim/TMath::Sqrt(sum);
0068
0069 TW sw = parent::m_bin_Sw[offset]; //ROOT sum
0070 if(sw==0) return 0;
0071 TV svw = m_bin_Svw[offset]; //ROOT cont
0072 TV sv2w = m_bin_Sv2w[offset]; //ROOT err2
0073 TV _mean = (svw / sw); //ROOT contsum
0074 TV _rms = ::sqrt(::fabs((sv2w/sw) - _mean * _mean)); //ROOT eprim
0075 return _rms/::sqrt(sw); //ROOT kERRORMEAN mode returned value
0076 }
0077
0078 public:
0079 bool multiply(TW a_factor){
0080 if(!parent::base_multiply(a_factor)) return false;
0081 for(bn_t ibin=0;ibin<parent::m_bin_number;ibin++) {
0082 m_bin_Svw[ibin] *= a_factor;
0083 }
0084 return true;
0085 }
0086 bool scale(TW a_factor) {return multiply(a_factor);}
0087
0088 TV bin_Svw(int aI) const {
0089 TO offset;
0090 if(!parent::_find_offset(aI,offset)) return 0;
0091 return m_bin_Svw[offset];
0092 }
0093 TV bin_Sv2w(int aI) const {
0094 TO offset;
0095 if(!parent::_find_offset(aI,offset)) return 0;
0096 return m_bin_Sv2w[offset];
0097 }
0098
0099 bool reset() {
0100 parent::base_reset();
0101 for(bn_t ibin=0;ibin<parent::m_bin_number;ibin++) {
0102 m_bin_Svw[ibin] = 0;
0103 m_bin_Sv2w[ibin] = 0;
0104 }
0105 return true;
0106 }
0107
0108 void copy_from_data(const pd_t& a_from) {
0109 parent::base_from_data(a_from);
0110 m_bin_Svw = a_from.m_bin_Svw;
0111 m_bin_Sv2w = a_from.m_bin_Sv2w;
0112 m_cut_v = a_from.m_cut_v;
0113 m_min_v = a_from.m_min_v;
0114 m_max_v = a_from.m_max_v;
0115 }
0116 pd_t get_histo_data() const {
0117 pd_t hd(parent::dac());
0118 hd.m_is_profile = true;
0119 hd.m_bin_Svw = m_bin_Svw;
0120 hd.m_bin_Sv2w = m_bin_Sv2w;
0121 hd.m_cut_v = m_cut_v;
0122 hd.m_min_v = m_min_v;
0123 hd.m_max_v = m_max_v;
0124 return hd;
0125 }
0126
0127 bool fill(TC aX,TV aV,TW aWeight = 1) {
0128 if(parent::m_dimension!=1) return false;
0129
0130 if(m_cut_v) {
0131 if( (aV<m_min_v) || (aV>=m_max_v) ) {
0132 return true;
0133 }
0134 }
0135
0136 bn_t ibin;
0137 if(!parent::m_axes[0].coord_to_absolute_index(aX,ibin)) return false;
0138 TO offset = ibin;
0139
0140 parent::m_bin_entries[offset]++;
0141 parent::m_bin_Sw[offset] += aWeight;
0142 parent::m_bin_Sw2[offset] += aWeight * aWeight;
0143
0144 TC xw = aX * aWeight;
0145 TC x2w = aX * xw;
0146 parent::m_bin_Sxw[offset][0] += xw;
0147 parent::m_bin_Sx2w[offset][0] += x2w;
0148
0149 bool inRange = true;
0150 if(ibin==0) inRange = false;
0151 else if(ibin==(parent::m_axes[0].m_number_of_bins+1)) inRange = false;
0152
0153 parent::m_all_entries++;
0154 if(inRange) {
0155 // fast getters :
0156 parent::m_in_range_entries++;
0157 parent::m_in_range_Sw += aWeight;
0158 parent::m_in_range_Sw2 += aWeight*aWeight;
0159
0160 parent::m_in_range_Sxw[0] += xw;
0161 parent::m_in_range_Sx2w[0] += x2w;
0162 }
0163
0164 // Profile part :
0165 TV vw = aV * aWeight;
0166 m_bin_Svw[offset] += vw;
0167 m_bin_Sv2w[offset] += aV * vw;
0168
0169 return true;
0170 }
0171
0172 bool set_bin_content(bn_t a_ibin,TN a_entries,TW a_Sw,TW a_Sw2,TC a_Sxw,TC a_Sx2w,TC a_Svw,TC a_Sv2w) {
0173 if(parent::m_dimension!=1) return false;
0174 if(a_ibin>(parent::m_axes[0].m_number_of_bins+1)) return false;
0175
0176 bool inRange = true;
0177 if(a_ibin==0) inRange = false;
0178 else if(a_ibin==(parent::m_axes[0].m_number_of_bins+1)) inRange = false;
0179
0180 TO offset = a_ibin;
0181
0182 parent::m_all_entries -= parent::m_bin_entries[offset];
0183 if(inRange) {
0184 parent::m_in_range_entries -= parent::m_bin_entries[offset];
0185 parent::m_in_range_Sw -= parent::m_bin_Sw[offset];
0186 parent::m_in_range_Sw2 -= parent::m_bin_Sw2[offset];
0187 parent::m_in_range_Sxw[0] -= parent::m_bin_Sxw[offset][0];
0188 parent::m_in_range_Sx2w[0] -= parent::m_bin_Sx2w[offset][0];
0189 }
0190
0191 parent::m_bin_entries[offset] = a_entries;
0192 parent::m_bin_Sw[offset] = a_Sw;
0193 parent::m_bin_Sw2[offset] = a_Sw2;
0194
0195 parent::m_bin_Sxw[offset][0] = a_Sxw;
0196 parent::m_bin_Sx2w[offset][0] = a_Sx2w;
0197
0198 parent::m_all_entries += a_entries;
0199 if(inRange) {
0200 parent::m_in_range_entries += a_entries;
0201 parent::m_in_range_Sw += a_Sw;
0202 parent::m_in_range_Sw2 += a_Sw2;
0203
0204 parent::m_in_range_Sxw[0] += a_Sxw;
0205 parent::m_in_range_Sx2w[0] += a_Sx2w;
0206 }
0207
0208 // Profile part :
0209 m_bin_Svw[offset] = a_Svw;
0210 m_bin_Sv2w[offset] = a_Sv2w;
0211
0212 return true;
0213 }
0214
0215 bool get_bin_content(bn_t a_ibin,TN& a_entries,TW& a_Sw,TW& a_Sw2,TC& a_Sxw,TC& a_Sx2w,TC& a_Svw,TC& a_Sv2w) {
0216 if(parent::m_dimension!=1) {
0217 a_entries = 0;a_Sw = 0;a_Sw2 = 0;a_Sxw = 0;a_Sx2w = 0;
0218 return false;
0219 }
0220 if(a_ibin>(parent::m_axes[0].m_number_of_bins+1)) {
0221 a_entries = 0;a_Sw = 0;a_Sw2 = 0;a_Sxw = 0;a_Sx2w = 0;
0222 return false;
0223 }
0224
0225 TO offset = a_ibin;
0226
0227 a_entries = parent::m_bin_entries[offset];
0228 a_Sw = parent::m_bin_Sw[offset];
0229 a_Sw2 = parent::m_bin_Sw2[offset];
0230
0231 a_Sxw = parent::m_bin_Sxw[offset][0];
0232 a_Sx2w = parent::m_bin_Sx2w[offset][0];
0233
0234 // Profile part :
0235 a_Svw = m_bin_Svw[offset];
0236 a_Sv2w = m_bin_Sv2w[offset];
0237
0238 return true;
0239 }
0240
0241 TV bin_rms_value(int aI) const {
0242 TO offset;
0243 if(!parent::_find_offset(aI,offset)) return 0;
0244 TW sw = parent::m_bin_Sw[offset];
0245 if(sw==0) return 0;
0246 TV svw = m_bin_Svw[offset];
0247 TV sv2w = m_bin_Sv2w[offset];
0248 TV _mean = (svw / sw);
0249 return ::sqrt(::fabs((sv2w / sw) - _mean * _mean));
0250 }
0251
0252 bool add(const p1& a_histo){
0253 parent::base_add(a_histo);
0254 for(bn_t ibin=0;ibin<parent::m_bin_number;ibin++) {
0255 m_bin_Svw[ibin] += a_histo.m_bin_Svw[ibin];
0256 m_bin_Sv2w[ibin] += a_histo.m_bin_Sv2w[ibin];
0257 }
0258 return true;
0259 }
0260 bool subtract(const p1& a_histo){
0261 parent::base_subtract(a_histo);
0262 for(bn_t ibin=0;ibin<parent::m_bin_number;ibin++) {
0263 m_bin_Svw[ibin] -= a_histo.m_bin_Svw[ibin];
0264 m_bin_Sv2w[ibin] -= a_histo.m_bin_Sv2w[ibin];
0265 }
0266 return true;
0267 }
0268
0269 bool gather_bins(unsigned int a_factor) { //for exa 2,3.
0270 if(!a_factor) return false;
0271
0272 // actual bin number must be a multiple of a_factor.
0273
0274 const axis_t& _axis = parent::axis();
0275
0276 bn_t n = _axis.bins();
0277 if(!n) return false;
0278
0279 bn_t new_n = n/a_factor;
0280 if(a_factor*new_n!=n) return false;
0281
0282 p1* new_h = 0;
0283 if(_axis.is_fixed_binning()) {
0284 new_h = new p1(parent::m_title,new_n,_axis.lower_edge(),_axis.upper_edge());
0285 } else {
0286 const std::vector<TC>& _edges = _axis.edges();
0287 std::vector<TC> new_edges(new_n+1);
0288 for(bn_t ibin=0;ibin<new_n;ibin++) {
0289 new_edges[ibin] = _edges[ibin*a_factor];
0290 }
0291 new_edges[new_n] = _edges[n]; //upper edge.
0292 new_h = new p1(parent::m_title,new_edges);
0293 }
0294 if(!new_h) return false;
0295
0296 new_h->m_cut_v = m_cut_v;
0297 new_h->m_min_v = m_min_v;
0298 new_h->m_max_v = m_max_v;
0299
0300 bn_t offset,new_offset,offac;
0301 for(bn_t ibin=0;ibin<new_n;ibin++) {
0302 new_offset = ibin+1;
0303 offset = a_factor*ibin+1;
0304 for(unsigned int ifac=0;ifac<a_factor;ifac++) {
0305 offac = offset+ifac;
0306 new_h->m_bin_entries[new_offset] += parent::m_bin_entries[offac];
0307 new_h->m_bin_Sw[new_offset] += parent::m_bin_Sw[offac];
0308 new_h->m_bin_Sw2[new_offset] += parent::m_bin_Sw2[offac];
0309 new_h->m_bin_Sxw[new_offset][0] += parent::m_bin_Sxw[offac][0];
0310 new_h->m_bin_Sx2w[new_offset][0] += parent::m_bin_Sx2w[offac][0];
0311
0312 new_h->m_bin_Svw[new_offset] += m_bin_Svw[offac];
0313 new_h->m_bin_Sv2w[new_offset] += m_bin_Sv2w[offac];
0314 }
0315 }
0316
0317 //underflow :
0318 new_offset = 0;
0319 offac = 0;
0320 new_h->m_bin_entries[new_offset] = parent::m_bin_entries[offac];
0321 new_h->m_bin_Sw[new_offset] = parent::m_bin_Sw[offac];
0322 new_h->m_bin_Sw2[new_offset] = parent::m_bin_Sw2[offac];
0323 new_h->m_bin_Sxw[new_offset][0] = parent::m_bin_Sxw[offac][0];
0324 new_h->m_bin_Sx2w[new_offset][0] = parent::m_bin_Sx2w[offac][0];
0325 new_h->m_bin_Svw[new_offset] = m_bin_Svw[offac];
0326 new_h->m_bin_Sv2w[new_offset] = m_bin_Sv2w[offac];
0327
0328 //overflow :
0329 new_offset = new_n+1;
0330 offac = n+1;
0331 new_h->m_bin_entries[new_offset] = parent::m_bin_entries[offac];
0332 new_h->m_bin_Sw[new_offset] = parent::m_bin_Sw[offac];
0333 new_h->m_bin_Sw2[new_offset] = parent::m_bin_Sw2[offac];
0334 new_h->m_bin_Sxw[new_offset][0] = parent::m_bin_Sxw[offac][0];
0335 new_h->m_bin_Sx2w[new_offset][0] = parent::m_bin_Sx2w[offac][0];
0336 new_h->m_bin_Svw[new_offset] = m_bin_Svw[offac];
0337 new_h->m_bin_Sv2w[new_offset] = m_bin_Sv2w[offac];
0338
0339 *this = *new_h;
0340 return true;
0341 }
0342
0343 bool cut_v() const {return m_cut_v;}
0344 TV min_v() const {return m_min_v;}
0345 TV max_v() const {return m_max_v;}
0346
0347 public:
0348 p1(const std::string& a_title,bn_t aXnumber,TC aXmin,TC aXmax)
0349 :parent(a_title,aXnumber,aXmin,aXmax)
0350 ,m_cut_v(false)
0351 ,m_min_v(0)
0352 ,m_max_v(0)
0353 {
0354 m_bin_Svw.resize(parent::m_bin_number,0);
0355 m_bin_Sv2w.resize(parent::m_bin_number,0);
0356 }
0357
0358 p1(const std::string& a_title,bn_t aXnumber,TC aXmin,TC aXmax,TV aVmin,TV aVmax)
0359 :parent(a_title,aXnumber,aXmin,aXmax)
0360 ,m_cut_v(true)
0361 ,m_min_v(aVmin)
0362 ,m_max_v(aVmax)
0363 {
0364 m_bin_Svw.resize(parent::m_bin_number,0);
0365 m_bin_Sv2w.resize(parent::m_bin_number,0);
0366 }
0367
0368 p1(const std::string& a_title,const std::vector<TC>& a_edges)
0369 :parent(a_title,a_edges)
0370 ,m_cut_v(false)
0371 ,m_min_v(0)
0372 ,m_max_v(0)
0373 {
0374 m_bin_Svw.resize(parent::m_bin_number,0);
0375 m_bin_Sv2w.resize(parent::m_bin_number,0);
0376 }
0377
0378 p1(const std::string& a_title,const std::vector<TC>& a_edges,TV aVmin,TV aVmax)
0379 :parent(a_title,a_edges)
0380 ,m_cut_v(true)
0381 ,m_min_v(aVmin)
0382 ,m_max_v(aVmax)
0383 {
0384 m_bin_Svw.resize(parent::m_bin_number,0);
0385 m_bin_Sv2w.resize(parent::m_bin_number,0);
0386 }
0387
0388 virtual ~p1(){}
0389 public:
0390 p1(const p1& a_from)
0391 :parent(a_from)
0392 ,m_cut_v(a_from.m_cut_v)
0393 ,m_min_v(a_from.m_min_v)
0394 ,m_max_v(a_from.m_max_v)
0395 ,m_bin_Svw(a_from.m_bin_Svw)
0396 ,m_bin_Sv2w(a_from.m_bin_Sv2w)
0397 {}
0398 p1& operator=(const p1& a_from){
0399 parent::operator=(a_from);
0400 m_cut_v = a_from.m_cut_v;
0401 m_min_v = a_from.m_min_v;
0402 m_max_v = a_from.m_max_v;
0403 m_bin_Svw = a_from.m_bin_Svw;
0404 m_bin_Sv2w = a_from.m_bin_Sv2w;
0405 return *this;
0406 }
0407 public:
0408 bool configure(bn_t aXnumber,TC aXmin,TC aXmax){
0409 if(!parent::configure(aXnumber,aXmin,aXmax)) return false;
0410 m_bin_Svw.clear();
0411 m_bin_Sv2w.clear();
0412 m_bin_Svw.resize(parent::m_bin_number,0);
0413 m_bin_Sv2w.resize(parent::m_bin_number,0);
0414 m_cut_v = false;
0415 m_min_v = 0;
0416 m_max_v = 0;
0417 return true;
0418 }
0419 bool configure(const std::vector<TC>& a_edges) {
0420 if(!parent::configure(a_edges)) return false;
0421 m_bin_Svw.clear();
0422 m_bin_Sv2w.clear();
0423 m_bin_Svw.resize(parent::m_bin_number,0);
0424 m_bin_Sv2w.resize(parent::m_bin_number,0);
0425 m_cut_v = false;
0426 m_min_v = 0;
0427 m_max_v = 0;
0428 return true;
0429 }
0430 bool configure(bn_t aXnumber,TC aXmin,TC aXmax,TV aVmin,TV aVmax){
0431 if(!parent::configure(aXnumber,aXmin,aXmax)) return false;
0432 m_bin_Svw.clear();
0433 m_bin_Sv2w.clear();
0434 m_bin_Svw.resize(parent::m_bin_number,0);
0435 m_bin_Sv2w.resize(parent::m_bin_number,0);
0436 m_cut_v = true;
0437 m_min_v = aVmin;
0438 m_max_v = aVmax;
0439 return true;
0440 }
0441 bool configure(const std::vector<TC>& a_edges,TV aVmin,TV aVmax) {
0442 if(!parent::configure(a_edges)) return false;
0443 m_bin_Svw.clear();
0444 m_bin_Sv2w.clear();
0445 m_bin_Svw.resize(parent::m_bin_number,0);
0446 m_bin_Sv2w.resize(parent::m_bin_number,0);
0447 m_cut_v = true;
0448 m_min_v = aVmin;
0449 m_max_v = aVmax;
0450 return true;
0451 }
0452 public:
0453 const vs_t& bins_sum_vw() const {return m_bin_Svw;}
0454 const vs_t& bins_sum_v2w() const {return m_bin_Sv2w;}
0455
0456 TW get_Svw() const {
0457 TW sw = 0;
0458 for(TO ibin=0;ibin<parent::m_bin_number;ibin++) {
0459 if(!histo::is_out(parent::m_axes,ibin)) {
0460 sw += m_bin_Svw[ibin];
0461 }
0462 }
0463 return sw;
0464 }
0465 TW get_Sv2w() const {
0466 TW sw = 0;
0467 for(TO ibin=0;ibin<parent::m_bin_number;ibin++) {
0468 if(!histo::is_out(parent::m_axes,ibin)) {
0469 sw += m_bin_Sv2w[ibin];
0470 }
0471 }
0472 return sw;
0473 }
0474 protected:
0475 bool m_cut_v;
0476 TV m_min_v;
0477 TV m_max_v;
0478 vs_t m_bin_Svw;
0479 vs_t m_bin_Sv2w;
0480 };
0481
0482 }}
0483
0484 #endif
0485
