G4ConvergenceTester Class Reference

#include <G4ConvergenceTester.hh>

Public Member Functions
	G4ConvergenceTester (G4String theName="NONAME")
	~G4ConvergenceTester ()
	G4ConvergenceTester (G4double)
void	AddScore (G4double)
void	ShowHistory (std::ostream &out=G4cout)
void	ShowResult (std::ostream &out=G4cout)
G4double	GetValueOfMinimizingFunction (std::vector< G4double > x)
void	ComputeStatistics ()
G4double	GetMean ()
G4double	GetStandardDeviation ()
G4double	GetVariance ()
G4double	GetR ()
G4double	GetEfficiency ()
G4double	GetR2eff ()
G4double	GetR2int ()
G4double	GetShift ()
G4double	GetVOV ()
G4double	GetFOM ()

Detailed Description

Definition at line 58 of file G4ConvergenceTester.hh.

Constructor & Destructor Documentation

G4ConvergenceTester::G4ConvergenceTester

(

G4String

theName = "NONAME"

)

Definition at line 46 of file G4ConvergenceTester.cc.

References G4Timer::Start().

 : name(theName), n(0), sum(0.), mean(0.), var(0.), sd(0.), r(0.), efficiency(0.),
   r2eff(0.), r2int(0.), shift(0.), vov(0.), fom(0.), largest(0.),
   largest_score_happened(0), mean_1(0.), var_1(0.), sd_1(0.), r_1(0.),
   shift_1(0.), vov_1(0.), fom_1(0.), noBinOfHistory(16), slope(0.),
   noBinOfPDF(10), minimizer(0), noPass(0), noTotal(8), statsAreUpdated(true)
   , showHistory(true) , calcSLOPE(true)
{
   nonzero_histories.clear();
   largest_scores.clear();
   largest_scores.push_back( 0.0 );

   history_grid.resize( noBinOfHistory , 0 );
   mean_history.resize( noBinOfHistory , 0.0 );
   var_history.resize( noBinOfHistory , 0.0 );
   sd_history.resize( noBinOfHistory , 0.0 );
   r_history.resize( noBinOfHistory , 0.0 );
   vov_history.resize( noBinOfHistory , 0.0 );
   fom_history.resize( noBinOfHistory , 0.0 );
   shift_history.resize( noBinOfHistory , 0.0 );
   e_history.resize( noBinOfHistory , 0.0 );
   r2eff_history.resize( noBinOfHistory , 0.0 );
   r2int_history.resize( noBinOfHistory , 0.0 );

   timer = new G4Timer();
   timer->Start();
   cpu_time.clear();
   cpu_time.push_back( 0.0 );
}

G4ConvergenceTester::~G4ConvergenceTester

(

)

Definition at line 78 of file G4ConvergenceTester.cc.

{
   delete timer;
}

G4ConvergenceTester::G4ConvergenceTester

(

G4double

)

Member Function Documentation

void G4ConvergenceTester::AddScore

(

G4double

x

)

Definition at line 85 of file G4ConvergenceTester.cc.

References G4cout, G4endl, G4Timer::GetSystemElapsed(), G4Timer::GetUserElapsed(), G4Timer::Stop(), and test::x.

Referenced by B1ConRunAction::EndOfRunAction().

{ 

   //G4cout << x << G4endl;

   timer->Stop();
   cpu_time.push_back( timer->GetSystemElapsed() + timer->GetUserElapsed() );

   if ( x < 0.0 ) {
      G4cout << "Warning: G4convergenceTester expects zero or positive number as inputs, but received a negative number." << G4endl;
   }

   if ( x == 0.0 ) 
   { 
   }
   else
   {
       nonzero_histories.insert( std::pair< G4int , G4double > ( n , x ) );
       if ( x > largest_scores.back() )  
       { 
//        Following serch should become faster if begin from bottom.
          std::vector< G4double >::iterator it; 
          for ( it = largest_scores.begin() ; it != largest_scores.end() ; it++ )
          { 
             if ( x > *it ) 
             { 
                largest_scores.insert( it , x );
                break;
             }
          }

          if ( largest_scores.size() > 201 )
          {
             largest_scores.pop_back();
          } 
          //G4cout << largest_scores.size() << " " << largest_scores.front() << " " << largest_scores.back() << G4endl;
       }
       sum += x; 
   }

    // Data has been added so statistics have not been updated to new values
   statsAreUpdated = false;
   n++;
   return; 
}

void G4ConvergenceTester::ComputeStatistics ( )

inline

Definition at line 88 of file G4ConvergenceTester.hh.

{ calStat(); }

G4double G4ConvergenceTester::GetEfficiency ( )

inline

Definition at line 95 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return efficiency; }

G4double G4ConvergenceTester::GetFOM ( )

inline

Definition at line 100 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return fom; }

G4double G4ConvergenceTester::GetMean ( )

inline

Definition at line 91 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return mean; }

G4double G4ConvergenceTester::GetR ( )

inline

Definition at line 94 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return r; }

G4double G4ConvergenceTester::GetR2eff ( )

inline

Definition at line 96 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return r2eff; }

G4double G4ConvergenceTester::GetR2int ( )

inline

Definition at line 97 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return r2int; }

G4double G4ConvergenceTester::GetShift ( )

inline

Definition at line 98 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return shift; }

G4double G4ConvergenceTester::GetStandardDeviation ( )

inline

Definition at line 92 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return sd; }

G4double G4ConvergenceTester::GetValueOfMinimizingFunction ( std::vector< G4double >  x )

inline

Definition at line 74 of file G4ConvergenceTester.hh.

             { return slope_fitting_function( x ); }

G4double G4ConvergenceTester::GetVariance ( )

inline

Definition at line 93 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return var; }

G4double G4ConvergenceTester::GetVOV ( )

inline

Definition at line 99 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return vov; }

void G4ConvergenceTester::ShowHistory

(

std::ostream &

out = G4cout

)

Definition at line 439 of file G4ConvergenceTester.cc.

References G4endl.

Referenced by B1ConRunAction::EndOfRunAction().

{

   if ( !showHistory ) {
      out << "Number of events of this run is too small to show history." << G4endl;
      return;
   }
   
   out << std::setprecision( 6 );

   out << G4endl;
   out << "G4ConvergenceTester Output History of " << name << G4endl;
   out << "i/" << noBinOfHistory << " till_ith      mean" 
       << std::setw(13) << "var" 
       << std::setw(13) << "sd" 
       << std::setw(13) << "r" 
       << std::setw(13) << "vov" 
       << std::setw(13) << "fom" 
       << std::setw(13) << "shift" 
       << std::setw(13) << "e"
       << std::setw(13) << "r2eff"
       << std::setw(13) << "r2int" 
       << G4endl;
   for ( G4int i = 1 ; i <=  noBinOfHistory  ; i++ )
   {
      out << std::setw( 4) << i << " " 
          << std::setw( 5) << history_grid [ i-1 ] 
          << std::setw(13) << mean_history [ i-1 ] 
          << std::setw(13) << var_history [ i-1 ] 
          << std::setw(13) << sd_history [ i-1 ] 
          << std::setw(13) << r_history [ i-1 ] 
          << std::setw(13) << vov_history [ i-1 ] 
          << std::setw(13) << fom_history [ i-1 ] 
          << std::setw(13) << shift_history [ i-1 ] 
          << std::setw(13) << e_history [ i-1 ] 
          << std::setw(13) << r2eff_history [ i-1 ] 
          << std::setw(13) << r2int_history [ i-1 ]
          << G4endl;
   }
}

void G4ConvergenceTester::ShowResult

(

std::ostream &

out = G4cout

)

Definition at line 366 of file G4ConvergenceTester.cc.

References G4endl.

Referenced by B1ConRunAction::EndOfRunAction().

{
    // if data has been added since the last computation of the statistical values (not statsAreUpdated)
    // call calStat to recompute the statistical values
   if(!statsAreUpdated) { calStat(); }

   out << std::setprecision( 6 );

   out << G4endl;
   out << "G4ConvergenceTester Output Result of " << name << G4endl;
   out << std::setw(20) << "EFFICIENCY = " << std::setw(13)  << efficiency << G4endl;
   out << std::setw(20) << "MEAN = " << std::setw(13) << mean << G4endl;
   out << std::setw(20) << "VAR = " << std::setw(13) << var << G4endl;
   out << std::setw(20) << "SD = " << std::setw(13) << sd << G4endl;
   out << std::setw(20) << "R = " << std::setw(13) << r << G4endl;
   out << std::setw(20) << "SHIFT = "<< std::setw(13) << shift << G4endl;
   out << std::setw(20) << "VOV = "<< std::setw(13) << vov << G4endl;
   out << std::setw(20) << "FOM = "<< std::setw(13) << fom << G4endl;

   out << std::setw(20) << "THE LARGEST SCORE = " << std::setw(13) << largest << " and it happend at " << largest_score_happened << "th event" << G4endl;
   if ( mean!=0 ) {
      out << std::setw(20) << "Affected Mean = " << std::setw(13) << mean_1 << " and its ratio to orignal is " << mean_1/mean << G4endl;
   } else {
      out << std::setw(20) << "Affected Mean = " << std::setw(13) << mean_1 << G4endl;
   }
   if ( var!=0 ) {
      out << std::setw(20) << "Affected VAR = " << std::setw(13) << var_1 << " and its ratio to orignal is " << var_1/var << G4endl;
   } else {
      out << std::setw(20) << "Affected VAR = " << std::setw(13) << var_1 << G4endl;
   }
   if ( r!=0 ) {
      out << std::setw(20) << "Affected R = " << std::setw(13) << r_1 << " and its ratio to orignal is " << r_1/r << G4endl;
   } else {
      out << std::setw(20) << "Affected R = " << std::setw(13) << r_1 << G4endl;
   }
   if ( shift!=0 ) {
      out << std::setw(20) << "Affected SHIFT = " << std::setw(13) << shift_1 << " and its ratio to orignal is " << shift_1/shift << G4endl;
   } else {
      out << std::setw(20) << "Affected SHIFT = " << std::setw(13) << shift_1 << G4endl;
   }
   if ( fom!=0 ) {
      out << std::setw(20) << "Affected FOM = " << std::setw(13) << fom_1 << " and its ratio to orignal is " << fom_1/fom << G4endl;
   } else {
      out << std::setw(20) << "Affected FOM = " << std::setw(13) << fom_1 << G4endl;
   }

   if ( !showHistory ) {
      out << "Number of events of this run is too small to do convergence tests." << G4endl;
      return;
   }

   check_stat_history(out);

// check SLOPE and output result
   if ( calcSLOPE ) {
      if ( slope >= 3 )
      {    
         noPass++;
         out << "SLOPE is large enough" << G4endl; 
      }
      else
      {
         out << "SLOPE is not large enough" << G4endl; 
      }
   } else { 
      out << "Number of non zero history too small to calculate SLOPE" << G4endl;
   }

   out << "This result passes " << noPass << " / "<< noTotal << " Convergence Test." << G4endl; 
   out << G4endl;

}

---

The documentation for this class was generated from the following files:

• G4ConvergenceTester.hh
• G4ConvergenceTester.cc