G4Analysis Namespace Reference

Functions
G4bool	CheckNbins (G4int nbins)
G4bool	CheckMinMax (G4double xmin, G4double xmax, const G4String &binSchemeName)
G4bool	CheckEdges (const std::vector< G4double > &edges)
G4double	GetUnitValue (const G4String &unit)
void	UpdateTitle (G4String &title, const G4String &unitName, const G4String &fcnName)
G4BinScheme	GetBinScheme (const G4String &binSchemeName)
void	ComputeEdges (G4int nbins, G4double xmin, G4double xmax, G4Fcn fcn, G4BinScheme, std::vector< G4double > &edges)
void	ComputeEdges (const std::vector< G4double > &edges, G4Fcn fcn, std::vector< G4double > &newEdges)
G4Fcn	GetFunction (const G4String &fcnName)

Variables
const G4int	kInvalidId = -1

Function Documentation

G4bool G4Analysis::CheckEdges

(

const std::vector< G4double > &

edges

)

Definition at line 82 of file G4AnalysisUtilities.cc.

References G4endl, G4Exception(), and JustWarning.

Referenced by G4VAnalysisManager::CreateH1(), G4VAnalysisManager::CreateH2(), G4VAnalysisManager::SetH1(), and G4VAnalysisManager::SetH2().

{
  if ( edges.size() <= 1 ) {
    G4ExceptionDescription description;
    description 
      << "    Illegal edges vector (size <= 1)" << G4endl;
      G4Exception("G4VAnalysisManager::CheckEdges",
                  "Analysis_W013", JustWarning, description);
    return false;
  }
  else
    return true;                   

}

G4bool G4Analysis::CheckMinMax	(	G4double	xmin,
		G4double	xmax,
		const G4String &	binSchemeName
	)

Definition at line 54 of file G4AnalysisUtilities.cc.

References G4endl, G4Exception(), GetBinScheme(), JustWarning, and kLogBinScheme.

Referenced by G4VAnalysisManager::CreateH1(), G4VAnalysisManager::CreateH2(), G4VAnalysisManager::SetH1(), and G4VAnalysisManager::SetH2().

{
  G4bool result = true;
  
  if ( xmax <= xmin ) {
    G4ExceptionDescription description;
    description 
      << "    Illegal values of (xmin >= xmax)" << G4endl;
      G4Exception("G4VAnalysisManager::CheckMinMax",
                  "Analysis_W013", JustWarning, description);
                  
    result = false;
  }
  
  if ( ( GetBinScheme(binSchemeName) == kLogBinScheme ) && ( xmin == 0 ) ) {
    G4ExceptionDescription description;
    description 
      << "    Illegal value of (xmin = 0) with logarithmic binning" << G4endl;
      G4Exception("G4VAnalysisManager::CheckMinMax",
                  "Analysis_W013", JustWarning, description);
                  
    result = false;
  }
  
  return result;
}  

G4bool G4Analysis::CheckNbins

(

G4int

nbins

)

Definition at line 38 of file G4AnalysisUtilities.cc.

References G4endl, G4Exception(), and JustWarning.

Referenced by G4VAnalysisManager::CreateH1(), G4VAnalysisManager::CreateH2(), G4VAnalysisManager::SetH1(), and G4VAnalysisManager::SetH2().

{
  if ( nbins <= 0 ) {
    G4ExceptionDescription description;
    description 
      << "    Illegal value of number of bins: nbins <= 0" << G4endl;
      G4Exception("G4VAnalysisManager::CheckNbins",
                  "Analysis_W013", JustWarning, description);
    return false;
  }
  else
    return true;                   
}  

void G4Analysis::ComputeEdges	(	G4int	nbins,
		G4double	xmin,
		G4double	xmax,
		G4Fcn	fcn,
		G4BinScheme	binScheme,
		std::vector< G4double > &	edges
	)

Definition at line 56 of file G4BinScheme.cc.

References G4endl, G4Exception(), JustWarning, kLinearBinScheme, kLogBinScheme, and kUserBinScheme.

{
// Compute edges from parameters

  if ( binScheme == kLinearBinScheme ) {
    G4double dx = (xmax - xmin ) / nbins;
    G4double binValue = xmin;
    while ( G4int(edges.size()) <= nbins ) {
      edges.push_back(binValue);
      binValue += dx;
    }
  }  
  else if ( binScheme == kLogBinScheme ) {
    G4double dlog 
      = (std::log10(fcn(xmax)) - std::log10(fcn(xmin)))/ nbins;
    G4double dx = std::pow(10, dlog);
    G4double binValue = fcn(xmin);
    while ( G4int(edges.size()) <= nbins ) {
      edges.push_back(binValue);
      binValue *= dx;
    }
  }
  else if ( binScheme == kUserBinScheme ) {  
    // This should never happen, but let's make sure about it
    // by issuing a warning
    G4ExceptionDescription description;
    description 
      << "    User binning scheme setting was ignored." << G4endl
      << "    Linear binning will be applied with given (nbins, xmin, xmax) values";
    G4Exception("G4Analysis::ComputeEdges",
              "Analysis_W013", JustWarning, description);
  }              
}                                          

void G4Analysis::ComputeEdges	(	const std::vector< G4double > &	edges,
		G4Fcn	fcn,
		std::vector< G4double > &	newEdges
	)

Definition at line 93 of file G4BinScheme.cc.

{
// Apply function to defined edges
  std::vector<G4double>::const_iterator it;
  for (it = edges.begin(); it != edges.end(); it++ ) {
    newBins.push_back(fcn(*it));
  }
}

G4BinScheme G4Analysis::GetBinScheme

(

const G4String &

binSchemeName

)

Definition at line 36 of file G4BinScheme.cc.

References G4endl, G4Exception(), JustWarning, kLinearBinScheme, and kLogBinScheme.

Referenced by CheckMinMax(), G4H1ToolsManager::CreateH1(), G4H2ToolsManager::CreateH2(), G4H1ToolsManager::SetH1(), and G4H2ToolsManager::SetH2().

{
  G4BinScheme binScheme = kLinearBinScheme;
  if ( binSchemeName != "linear" ) {
    if  ( binSchemeName == "log" )  
      binScheme = kLogBinScheme;
    else {
      // There is no name associated with kUserBinScheme
      G4ExceptionDescription description;
      description 
        << "    \"" << binScheme << "\" binning scheme is not supported." << G4endl
        << "    " << "Linear binning will be applied.";
      G4Exception("G4Analysis::GetBinScheme",
                "Analysis_W013", JustWarning, description);
    }              
  }
  return binScheme;            
}

G4Fcn G4Analysis::GetFunction

(

const G4String &

fcnName

)

Definition at line 36 of file G4Fcn.cc.

References G4endl, G4Exception(), G4FcnIdentity(), and JustWarning.

{
  G4Fcn fcn = G4FcnIdentity;
   if ( fcnName != "none" ) {
    if      ( fcnName == "log" )  fcn = std::log;
    else if ( fcnName == "log10") fcn = std::log10;
    else if ( fcnName == "exp" )  fcn = std::exp;
    else {
      G4ExceptionDescription description;
      description 
        << "    \"" << fcnName << "\" function is not supported." << G4endl
        << "    " << "No function will be applied to histogram values.";
      G4Exception("G4Analysis::GetFunction",
                "Analysis_W013", JustWarning, description);
    }              
  }
  return fcn;            
}

G4double G4Analysis::GetUnitValue

(

const G4String &

unit

)

Definition at line 98 of file G4AnalysisUtilities.cc.

References G4UnitDefinition::GetValueOf().

{
   G4double value = 1.;
   if ( unit != "none" ) {
     value = G4UnitDefinition::GetValueOf(unit);
     if ( value == 0. ) value = 1.; 
   }  
   return value;
}   

void G4Analysis::UpdateTitle	(	G4String &	title,
		const G4String &	unitName,
		const G4String &	fcnName
	)

Definition at line 109 of file G4AnalysisUtilities.cc.

{
  if ( fcnName != "none" )  { title += " "; title += fcnName; title += "("; }
  if ( unitName != "none" ) { title += " ["; title += unitName; title += "]";}
  if ( fcnName != "none" )  { title += ")"; }
}                                                            

Variable Documentation

const G4int G4Analysis::kInvalidId = -1

Definition at line 41 of file G4AnalysisUtilities.hh.

Referenced by G4VAnalysisManager::CreateH1(), G4VAnalysisManager::CreateH2(), G4VAnalysisManager::SetH1(), and G4VAnalysisManager::SetH2().