G4Analysis Namespace Reference

Typedefs
using	G4ToolsBaseHisto = tools::histo::base_histo< double, unsigned int, unsigned int, double, double >

Functions
G4ToolsAnalysisManager *	ManagerInstance (const G4String &outputType)
G4int	GetNbins (const G4ToolsBaseHisto &baseHisto, G4int dimension)
G4double	GetMin (const G4ToolsBaseHisto &baseHisto, G4int dimension)
G4double	GetMax (const G4ToolsBaseHisto &baseHisto, G4int dimension)
G4double	GetWidth (const G4ToolsBaseHisto &baseHisto, G4int dimension, const G4String &hnType)
G4bool	SetTitle (G4ToolsBaseHisto &baseHisto, const G4String &title)
G4bool	SetAxisTitle (G4ToolsBaseHisto &baseHisto, G4int dimension, const G4String &title)
G4String	GetTitle (const G4ToolsBaseHisto &baseHisto)
G4String	GetAxisTitle (const G4ToolsBaseHisto &baseHisto, G4int dimension, const G4String &hnType)
G4bool	CheckNbins (G4int nbins)
G4bool	CheckMinMax (G4double xmin, G4double xmax, const G4String &fcnName="none", const G4String &binSchemeName="linear")
G4bool	CheckEdges (const std::vector< G4double > &edges)
G4bool	CheckName (const G4String &name, const G4String &objectType)
G4double	GetUnitValue (const G4String &unit)
void	UpdateTitle (G4String &title, const G4String &unitName, const G4String &fcnName)
void	Tokenize (const G4String &line, std::vector< G4String > &tokens)
template<typename T , typename... Args>
std::unique_ptr< T >	make_unique (Args &&... args)
G4AnalysisOutput	GetOutput (const G4String &outputName, G4bool warn=true)
size_t	GetOutputId (const G4String &outputName, G4bool warn=true)
G4String	GetOutputName (G4AnalysisOutput outputType)
template<typename HT >
G4String	GetHnType ()
G4String	GetBaseName (const G4String &fileName)
G4String	GetExtension (const G4String &fileName, const G4String &defaultExtension="")
G4String	GetHnFileName (const G4String &fileName, const G4String &fileType, const G4String &hnType, const G4String &hnName)
G4String	GetNtupleFileName (const G4String &fileName, const G4String &fileType, const G4String &ntupleName)
G4String	GetNtupleFileName (const G4String &fileName, const G4String &fileType, G4int ntupleFileNumber)
G4String	GetTnFileName (const G4String &fileName, const G4String &fileType)
G4String	GetPlotFileName (const G4String &fileName)
G4BinScheme	GetBinScheme (const G4String &binSchemeName)
void	ComputeEdges (G4int nbins, G4double xmin, G4double xmax, G4double unit, G4Fcn fcn, G4BinScheme, std::vector< G4double > &edges)
void	ComputeEdges (const std::vector< G4double > &edges, G4double unit, G4Fcn fcn, std::vector< G4double > &newEdges)
G4Fcn	GetFunction (const G4String &fcnName)

Variables
const G4int	kX = 0
const G4int	kY = 1
const G4int	kZ = 2
const G4int	kInvalidId = -1

Typedef Documentation

G4ToolsBaseHisto

using G4Analysis::G4ToolsBaseHisto = typedef tools::histo::base_histo<double, unsigned int, unsigned int, double, double>

Definition at line 41 of file G4BaseHistoUtilities.hh.

Function Documentation

CheckEdges()

G4bool G4Analysis::CheckEdges

(

const std::vector< G4double > &

edges

)

Definition at line 120 of file G4AnalysisUtilities.cc.

{
  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;                   
 
}

Referenced by G4VAnalysisManager::CreateH1(), G4VAnalysisManager::CreateH2(), G4VAnalysisManager::CreateH3(), G4VAnalysisManager::CreateP1(), G4VAnalysisManager::CreateP2(), G4VAnalysisManager::SetH1(), G4VAnalysisManager::SetH2(), G4VAnalysisManager::SetH3(), G4VAnalysisManager::SetP1(), and G4VAnalysisManager::SetP2().

CheckMinMax()

G4bool G4Analysis::CheckMinMax	(	G4double	xmin,
		G4double	xmax,
		const G4String &	fcnName = "none",
		const G4String &	binSchemeName = "linear"
	)

Definition at line 78 of file G4AnalysisUtilities.cc.

{
  auto result = true;
  
  if ( xmax <= xmin ) {
    G4ExceptionDescription description;
    description 
      << "    Illegal values of (xmin >= xmax)" << G4endl;
      G4Exception("G4VAnalysisManager::CheckMinMax",
                  "Analysis_W013", JustWarning, description);
                  
    result = false;
  }
  
  if ( ( fcnName != "none" ) && ( binSchemeName != "linear" ) ) {
    G4ExceptionDescription description;
    description 
      << "    Combining Function and Binning scheme is not supported." 
      << G4endl;
      G4Exception("G4VAnalysisManager::CheckMinMax",
                  "Analysis_W013", JustWarning, description);
                  
    result = false;
  }
  
  if ( ( GetBinScheme(binSchemeName) == G4BinScheme::kLog ||
         fcnName == "log" || fcnName == "log10" ) && ( xmin == 0 ) ) {
    G4ExceptionDescription description;
    description 
      << "    Illegal value of (xmin = 0) with logarithmic function or binning" 
      << G4endl;
      G4Exception("G4VAnalysisManager::CheckMinMax",
                  "Analysis_W013", JustWarning, description);
                  
    result = false;
  }
  
  return result;
}  

Referenced by G4VAnalysisManager::CreateH1(), G4VAnalysisManager::CreateH2(), G4VAnalysisManager::CreateH3(), G4VAnalysisManager::CreateP1(), G4VAnalysisManager::CreateP2(), G4VAnalysisManager::SetH1(), G4VAnalysisManager::SetH2(), G4VAnalysisManager::SetH3(), G4VAnalysisManager::SetP1(), and G4VAnalysisManager::SetP2().

CheckName()

G4bool G4Analysis::CheckName	(	const G4String &	name,
		const G4String &	objectType
	)

Definition at line 136 of file G4AnalysisUtilities.cc.

{
  if ( ! name.size() ) {
    G4ExceptionDescription description;
    description 
      << "    Empty " << objectType << " name is not allowed." << G4endl
      << "    " << objectType << " was not created." << G4endl;
      G4Exception("G4VAnalysisManager::CheckName",
                  "Analysis_W013", JustWarning, description);
    return false;
  }
  else
    return true;                   
}

Referenced by G4VAnalysisManager::CreateH1(), G4VAnalysisManager::CreateH2(), G4VAnalysisManager::CreateH3(), G4VAnalysisManager::CreateNtuple(), G4VAnalysisManager::CreateNtupleDColumn(), G4VAnalysisManager::CreateNtupleFColumn(), G4VAnalysisManager::CreateNtupleIColumn(), G4VAnalysisManager::CreateNtupleSColumn(), G4VAnalysisManager::CreateP1(), and G4VAnalysisManager::CreateP2().

CheckNbins()

G4bool G4Analysis::CheckNbins

(

G4int

nbins

)

Definition at line 62 of file G4AnalysisUtilities.cc.

{
  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;                   
}  

Referenced by G4VAnalysisManager::CreateH1(), G4VAnalysisManager::CreateH2(), G4VAnalysisManager::CreateH3(), G4VAnalysisManager::CreateP1(), G4VAnalysisManager::CreateP2(), G4VAnalysisManager::SetH1(), G4VAnalysisManager::SetH2(), G4VAnalysisManager::SetH3(), G4VAnalysisManager::SetP1(), and G4VAnalysisManager::SetP2().

ComputeEdges() [1/2]

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

Definition at line 97 of file G4BinScheme.cc.

{
// Apply function to defined edges
 
  for (auto element : edges) {
    newBins.push_back(fcn(element/unit));
  }
}

ComputeEdges() [2/2]

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

Definition at line 55 of file G4BinScheme.cc.

{
// Compute edges from parameters
 
  // Apply units
  auto xumin = xmin/unit;
  auto xumax = xmax/unit;
 
  if ( binScheme == G4BinScheme::kLinear ) {
    auto dx = (fcn(xumax) - fcn(xumin) ) / nbins;
    auto binValue = fcn(xumin);
    while ( G4int(edges.size()) <= nbins ) {  // Loop checking, 23.06.2015, I. Hrivnacova
      edges.push_back(binValue);
      binValue += dx;
    }
  }  
  else if ( binScheme == G4BinScheme::kLog ) {
    // do not apply fcn 
    auto dlog 
      = (std::log10(xumax) - std::log10(xumin))/ nbins;
    auto dx = std::pow(10, dlog);
    auto binValue = xumin;
    while ( G4int(edges.size()) <= nbins ) { // Loop checking, 23.06.2015, I. Hrivnacova
      edges.push_back(binValue);
      binValue *= dx;
    }
  }
  else if ( binScheme == G4BinScheme::kUser ) {  
    // 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);
  }              
}                                          

GetAxisTitle()

G4String G4Analysis::GetAxisTitle	(	const G4ToolsBaseHisto &	baseHisto,
		G4int	dimension,
		const G4String &	hnType
	)

Definition at line 109 of file G4BaseHistoUtilities.cc.

{
  G4String title;
  G4bool result = false;
  if ( dimension == kX ) {
    result = baseHisto.annotation(tools::histo::key_axis_x_title(), title);
  }  
  else if ( dimension == kY ) {  
    result = baseHisto.annotation(tools::histo::key_axis_y_title(), title);
  }
  else if ( dimension == kZ ) {  
    result = baseHisto.annotation(tools::histo::key_axis_z_title(), title);
  }
 
  if ( ! result ) {
    G4String axes("xyz");
    G4String axis = axes(dimension, 1);
    G4String functionName = "Get";
    functionName += hnType;
    functionName += axis;
    functionName += "Title";
    G4ExceptionDescription description;
    description << "    Failed to get " << axis << " axis " << hnType << " title.";
    G4Exception(functionName, "Analysis_W014", JustWarning, description);
    return "";
  }
  
  return title;              
} 

Referenced by G4H1ToolsManager::GetH1XAxisTitle(), G4H1ToolsManager::GetH1YAxisTitle(), G4H2ToolsManager::GetH2XAxisTitle(), G4H2ToolsManager::GetH2YAxisTitle(), G4H2ToolsManager::GetH2ZAxisTitle(), G4H3ToolsManager::GetH3XAxisTitle(), G4H3ToolsManager::GetH3YAxisTitle(), G4H3ToolsManager::GetH3ZAxisTitle(), G4P1ToolsManager::GetP1XAxisTitle(), G4P1ToolsManager::GetP1YAxisTitle(), G4P2ToolsManager::GetP2XAxisTitle(), G4P2ToolsManager::GetP2YAxisTitle(), and G4P2ToolsManager::GetP2ZAxisTitle().

GetBaseName()

G4String G4Analysis::GetBaseName

(

const G4String &

fileName

)

Definition at line 240 of file G4AnalysisUtilities.cc.

{
// Get file base name (without dot)
 
  G4String name = fileName;
  if ( name.rfind(".") != std::string::npos ) { 
    name = name.substr(0, name.rfind("."));
  }
  return name;
}    

Referenced by G4CsvFileManager::CreateNtupleFile(), G4XmlFileManager::CreateNtupleFile(), GetHnFileName(), GetNtupleFileName(), GetPlotFileName(), GetTnFileName(), G4VFileManager::SetFileName(), and G4NtupleBookingManager::SetFileType().

GetBinScheme()

G4BinScheme G4Analysis::GetBinScheme

(

const G4String &

binSchemeName

)

Definition at line 35 of file G4BinScheme.cc.

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

Referenced by CheckMinMax(), G4H1ToolsManager::CreateH1(), G4H2ToolsManager::CreateH2(), G4H3ToolsManager::CreateH3(), G4P1ToolsManager::CreateP1(), G4P2ToolsManager::CreateP2(), G4H1ToolsManager::SetH1(), G4H2ToolsManager::SetH2(), G4H3ToolsManager::SetH3(), G4P1ToolsManager::SetP1(), and G4P2ToolsManager::SetP2().

GetExtension()

G4String G4Analysis::GetExtension	(	const G4String &	fileName,
		const G4String &	defaultExtension = ""
	)

Definition at line 252 of file G4AnalysisUtilities.cc.

{
// Get file base extension (without dot)
// If fileName is provided without extension, return defaultExtension
 
  G4String extension;
  if ( fileName.rfind(".") != std::string::npos ) { 
    extension = fileName.substr(fileName.rfind(".") + 1);
  }
  if ( ! extension.size() ) {
    extension = defaultExtension;
  }
  return extension;
}

Referenced by G4CsvFileManager::CreateNtupleFile(), G4XmlFileManager::CreateNtupleFile(), GetHnFileName(), GetNtupleFileName(), GetTnFileName(), G4GenericAnalysisManager::OpenFileImpl(), G4VFileManager::SetFileName(), G4NtupleBookingManager::SetFileName(), and G4NtupleBookingManager::SetFileType().

GetFunction()

G4Fcn G4Analysis::GetFunction

(

const G4String &

fcnName

)

Definition at line 35 of file G4Fcn.cc.

{
  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;            
}

Referenced by G4HnInformation::AddDimension(), and G4HnInformation::SetDimension().

GetHnFileName()

G4String G4Analysis::GetHnFileName	(	const G4String &	fileName,
		const G4String &	fileType,
		const G4String &	hnType,
		const G4String &	hnName
	)

Definition at line 269 of file G4AnalysisUtilities.cc.

{
// Compose and return the histogram or profile specific file name:
// - add _hn_hnName suffix to the file base name
// - add file extension if not present
 
  auto name = GetBaseName(fileName);
 
  // Add _hnType_hnName
  name.append("_");
  name.append(hnType);
  name.append("_");
  name.append(hnName);
 
  // Add file extension
  auto extension = GetExtension(fileName, fileType);
  if ( extension.size() ) {
    name.append(".");
    name.append(extension);
  }
 
  return name;
}

Referenced by G4BaseFileManager::GetHnFileName().

GetHnType()

template<typename HT >

G4String G4Analysis::GetHnType

(

)

Definition at line 96 of file G4AnalysisUtilities.hh.

{
  // tools::histo::h1d etc.
  G4String hnTypeLong = HT::s_class();
 
  // tools::histo::h1d -> h1 etc.
  return hnTypeLong.substr(14, 2);
}

GetMax()

G4double G4Analysis::GetMax	(	const G4ToolsBaseHisto &	baseHisto,
		G4int	dimension
	)

Definition at line 52 of file G4BaseHistoUtilities.cc.

{
// Returns max data value
 
  return baseHisto.get_axis(dimension).upper_edge();
}  

Referenced by G4H1ToolsManager::GetH1Xmax(), G4H2ToolsManager::GetH2Xmax(), G4H2ToolsManager::GetH2Ymax(), G4H3ToolsManager::GetH3Xmax(), G4H3ToolsManager::GetH3Ymax(), G4H3ToolsManager::GetH3Zmax(), G4P1ToolsManager::GetP1Xmax(), G4P2ToolsManager::GetP2Xmax(), G4P2ToolsManager::GetP2Ymax(), and G4P2ToolsManager::GetP2Zmax().

GetMin()

G4double G4Analysis::GetMin	(	const G4ToolsBaseHisto &	baseHisto,
		G4int	dimension
	)

Definition at line 44 of file G4BaseHistoUtilities.cc.

{
// Returns min data value
 
  return baseHisto.get_axis(dimension).lower_edge();
}  

Referenced by G4H1ToolsManager::GetH1Xmin(), G4H2ToolsManager::GetH2Xmin(), G4H2ToolsManager::GetH2Ymin(), G4H3ToolsManager::GetH3Xmin(), G4H3ToolsManager::GetH3Ymin(), G4H3ToolsManager::GetH3Zmin(), G4P1ToolsManager::GetP1Xmin(), G4P2ToolsManager::GetP2Xmin(), G4P2ToolsManager::GetP2Ymin(), and G4P2ToolsManager::GetP2Zmin().

GetNbins()

G4int G4Analysis::GetNbins	(	const G4ToolsBaseHisto &	baseHisto,
		G4int	dimension
	)

Definition at line 38 of file G4BaseHistoUtilities.cc.

{
  return baseHisto.get_axis(dimension).bins();
}  

Referenced by G4H1ToolsManager::GetH1Nbins(), G4H2ToolsManager::GetH2Nxbins(), G4H2ToolsManager::GetH2Nybins(), G4H3ToolsManager::GetH3Nxbins(), G4H3ToolsManager::GetH3Nybins(), G4H3ToolsManager::GetH3Nzbins(), G4P1ToolsManager::GetP1Nbins(), G4P2ToolsManager::GetP2Nxbins(), and G4P2ToolsManager::GetP2Nybins().

GetNtupleFileName() [1/2]

G4String G4Analysis::GetNtupleFileName	(	const G4String &	fileName,
		const G4String &	fileType,
		const G4String &	ntupleName
	)

Definition at line 298 of file G4AnalysisUtilities.cc.

{
// Compose and return the ntuple specific file name:
// - add _nt_ntupleName suffix to the file base name
// - add _tN suffix if called on thread worker
// - add file extension if not present
 
  auto name = GetBaseName(fileName);
    
  // Add ntupleName
  name.append("_nt_");
  name.append(ntupleName);
 
  // Add thread Id to a file name if MT processing
  if ( ! G4Threading::IsMasterThread() ) {
    std::ostringstream os;
    os << G4Threading::G4GetThreadId();
    name.append("_t");
    name.append(os.str());
  }  
 
  // Add file extension
  auto extension = GetExtension(fileName, fileType);
  if ( extension.size() ) {
    name.append(".");
    name.append(extension);
  }
  
  return name;
}

Referenced by G4BaseFileManager::GetNtupleFileName().

GetNtupleFileName() [2/2]

G4String G4Analysis::GetNtupleFileName	(	const G4String &	fileName,
		const G4String &	fileType,
		G4int	ntupleFileNumber
	)

Definition at line 333 of file G4AnalysisUtilities.cc.

{
// Compose and return the ntuple specific file name:
// - add _mFN suffix to the file base name where FN = ntupleFileNumber
// - add file extension if not present
 
  auto name = GetBaseName(fileName);
    
  // Add _M followed by ntupleFileNumber
  std::ostringstream os;
  os << ntupleFileNumber;
  name.append("_m");
  name.append(os.str());
 
  // Add file extension
  auto extension = GetExtension(fileName, fileType);
  if ( extension.size() ) {
    name.append(".");
    name.append(extension);
  }
  
  return name;
}

GetOutput()

G4AnalysisOutput G4Analysis::GetOutput	(	const G4String &	outputName,
		G4bool	warn = true
	)

Definition at line 192 of file G4AnalysisUtilities.cc.

                                                                    {
  if      ( outputName == "csv"  )  { return G4AnalysisOutput::kCsv;  }
  else if ( outputName == "hdf5" )  { return G4AnalysisOutput::kHdf5; }
  else if ( outputName == "root" )  { return G4AnalysisOutput::kRoot; }
  else if ( outputName == "xml"  )  { return G4AnalysisOutput::kXml;  }
  else if ( outputName == "none" )  { return G4AnalysisOutput::kNone; }
  else {
    if (warn) {
      G4ExceptionDescription description;
      description 
        << "    \"" << outputName << "\" output type is not supported." << G4endl;
      G4Exception("G4Analysis::GetOutputType",
                  "Analysis_W051", JustWarning, description);
    }
    return G4AnalysisOutput::kNone; 
  }
}

Referenced by ManagerInstance(), G4GenericFileManager::SetDefaultFileType(), and G4NtupleBookingManager::SetFileName().

GetOutputId()

size_t G4Analysis::GetOutputId	(	const G4String &	outputName,
		G4bool	warn = true
	)

GetOutputName()

G4String G4Analysis::GetOutputName

(

G4AnalysisOutput

outputType

)

Definition at line 211 of file G4AnalysisUtilities.cc.

                                                {
  switch ( output ) {
    case G4AnalysisOutput::kCsv:
      return "csv";
      break;
    case G4AnalysisOutput::kHdf5: 
      return "hdf5";
      break;
    case G4AnalysisOutput::kRoot: 
      return "root";
      break;
    case G4AnalysisOutput::kXml:
      return "xml";
      break;
    case G4AnalysisOutput::kNone:
      return "none";
      break;
  }
  // should never reach this line
  G4ExceptionDescription description;
  description
    << "    \"" << static_cast<int>(output) << "\" is not handled." << G4endl
    << "    " << "none type will be used.";
  G4Exception("G4Analysis::GetOutputName",
              "Analysis_W051", JustWarning, description);
  return "none";
}

Referenced by G4GenericFileManager::CreateNtupleFileManager().

GetPlotFileName()

G4String G4Analysis::GetPlotFileName

(

const G4String &

fileName

)

Definition at line 390 of file G4AnalysisUtilities.cc.

{
// Generate plot file name for an output file name
 
  auto name = GetBaseName(fileName);
 
  // Add .ps extension
  name.append(".ps");
 
  return name;
}

Referenced by G4BaseFileManager::GetPlotFileName().

GetTitle()

G4String G4Analysis::GetTitle

(

const G4ToolsBaseHisto &

baseHisto

)

Definition at line 102 of file G4BaseHistoUtilities.cc.

{
  return baseHisto.title();
}  

Referenced by G4H1ToolsManager::GetH1Title(), G4H2ToolsManager::GetH2Title(), G4H3ToolsManager::GetH3Title(), G4P1ToolsManager::GetP1Title(), and G4P2ToolsManager::GetP2Title().

GetTnFileName()

G4String G4Analysis::GetTnFileName	(	const G4String &	fileName,
		const G4String &	fileType
	)

Definition at line 361 of file G4AnalysisUtilities.cc.

{
// Update file base name with the thread suffix:
// - add _tN suffix if called on thread worker
// - add file extension if not present
 
  auto name = GetBaseName(fileName);
 
  // Add thread Id to a file name if MT processing
  if ( !  G4Threading::IsMasterThread() ) {
    std::ostringstream os;
    os << G4Threading::G4GetThreadId();
    name.append("_t");
    name.append(os.str());
  }
 
  // Add file extension
  auto extension = GetExtension(fileName, fileType);
  if ( extension.size() ) {
    name.append(".");
    name.append(extension);
  }
 
  return name;
}

GetUnitValue()

G4double G4Analysis::GetUnitValue

(

const G4String &

unit

)

Definition at line 152 of file G4AnalysisUtilities.cc.

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

Referenced by G4HnInformation::AddDimension(), G4HnInformation::SetDimension(), G4H1Messenger::SetNewValue(), G4H2Messenger::SetNewValue(), G4H3Messenger::SetNewValue(), G4P1Messenger::SetNewValue(), and G4P2Messenger::SetNewValue().

GetWidth()

G4double G4Analysis::GetWidth	(	const G4ToolsBaseHisto &	baseHisto,
		G4int	dimension,
		const G4String &	hnType
	)

Definition at line 60 of file G4BaseHistoUtilities.cc.

{
  auto nbins = baseHisto.get_axis(dimension).bins();
  if ( ! nbins ) {
    G4String functionName = "Get";
    functionName += hnType;
    functionName += "Width";
    G4ExceptionDescription description;
    description << "    nbins = 0 (for " << hnType << ").";
    G4Exception(functionName, "Analysis_W014", JustWarning, description);
    return 0.;
  }              
  
  return ( baseHisto.get_axis(dimension).upper_edge() 
           - baseHisto.get_axis(dimension).lower_edge() )/nbins;
}  

Referenced by G4H1ToolsManager::GetH1Width(), G4H2ToolsManager::GetH2XWidth(), G4H2ToolsManager::GetH2YWidth(), G4H3ToolsManager::GetH3XWidth(), G4H3ToolsManager::GetH3YWidth(), G4H3ToolsManager::GetH3ZWidth(), G4P1ToolsManager::GetP1XWidth(), G4P2ToolsManager::GetP2XWidth(), and G4P2ToolsManager::GetP2YWidth().

make_unique()

template<typename T , typename... Args>

std::unique_ptr< T > G4Analysis::make_unique

(

Args &&...

args

)

Definition at line 84 of file G4AnalysisUtilities.hh.

{
    return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
}

ManagerInstance()

G4ToolsAnalysisManager * G4Analysis::ManagerInstance

(

const G4String &

outputType

)

Definition at line 56 of file g4analysis.cc.

{
  // Get output type
  G4AnalysisOutput outputType = GetOutput(outputName, false);
  if ( outputType == G4AnalysisOutput::kNone ) {
    DoFatalException(outputName);
    return nullptr;
  }
 
  // Create the analysis manager of a selected type
  switch ( outputType ) {
    case G4AnalysisOutput::kCsv:
      return G4CsvAnalysisManager::Instance();
      break;
#ifdef TOOLS_USE_HDF5
    case G4AnalysisOutput::kHdf5: 
      return G4Hdf5AnalysisManager::Instance();
      break;
#endif
    case G4AnalysisOutput::kRoot: 
      return G4RootAnalysisManager::Instance();
      break;
    case G4AnalysisOutput::kXml:
      return G4XmlAnalysisManager::Instance();
      break;
    case G4AnalysisOutput::kNone:
    default:
      break;
  }
  
  // should never reach this line
  DoFatalException(outputName);
  return nullptr;
}

SetAxisTitle()

G4bool G4Analysis::SetAxisTitle	(	G4ToolsBaseHisto &	baseHisto,
		G4int	dimension,
		const G4String &	title
	)

Definition at line 85 of file G4BaseHistoUtilities.cc.

{
  if ( dimension == kX ) {
    baseHisto.add_annotation(tools::histo::key_axis_x_title(), title);
  }
  else if ( dimension == kY ) {  
    baseHisto.add_annotation(tools::histo::key_axis_y_title(), title);
  }
  else if ( dimension == kZ ) {  
    baseHisto.add_annotation(tools::histo::key_axis_z_title(), title);
  }
  
  return true;
}  

Referenced by G4H1ToolsManager::SetH1XAxisTitle(), G4H1ToolsManager::SetH1YAxisTitle(), G4H2ToolsManager::SetH2XAxisTitle(), G4H2ToolsManager::SetH2YAxisTitle(), G4H2ToolsManager::SetH2ZAxisTitle(), G4H3ToolsManager::SetH3XAxisTitle(), G4H3ToolsManager::SetH3YAxisTitle(), G4H3ToolsManager::SetH3ZAxisTitle(), G4P1ToolsManager::SetP1XAxisTitle(), G4P1ToolsManager::SetP1YAxisTitle(), G4P2ToolsManager::SetP2XAxisTitle(), G4P2ToolsManager::SetP2YAxisTitle(), and G4P2ToolsManager::SetP2ZAxisTitle().

SetTitle()

G4bool G4Analysis::SetTitle	(	G4ToolsBaseHisto &	baseHisto,
		const G4String &	title
	)

Definition at line 79 of file G4BaseHistoUtilities.cc.

{
  return baseHisto.set_title(title);
}  

Referenced by G4H1ToolsManager::SetH1Title(), G4H2ToolsManager::SetH2Title(), G4H3ToolsManager::SetH3Title(), G4P1ToolsManager::SetP1Title(), and G4P2ToolsManager::SetP2Title().

Tokenize()

void G4Analysis::Tokenize	(	const G4String &	line,
		std::vector< G4String > &	tokens
	)

Definition at line 173 of file G4AnalysisUtilities.cc.

{
  // Define start values
  std::string::size_type begIdx = 0;
  std::string::size_type endIdx = 0; 
  G4String token;
  
  do {
    if ( GetToken(line, token, begIdx, endIdx) ) {
      //G4cout << "got token: '" << token << "'" << G4endl;
      //G4cout << "beg, end: " << begIdx << ", " << endIdx << G4endl;
      tokens.push_back(token);
    }  
    begIdx = endIdx + 1;
  }
  while ( endIdx < line.length() ); // Loop checking, 23.06.2015, I. Hrivnacova
}

Referenced by G4H1Messenger::SetNewValue(), G4H2Messenger::SetNewValue(), G4H3Messenger::SetNewValue(), G4HnMessenger::SetNewValue(), G4NtupleMessenger::SetNewValue(), G4P1Messenger::SetNewValue(), G4P2Messenger::SetNewValue(), and G4PlotMessenger::SetNewValue().

UpdateTitle()

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

Definition at line 163 of file G4AnalysisUtilities.cc.

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

Variable Documentation

kInvalidId

const G4int G4Analysis::kInvalidId = -1

Definition at line 62 of file G4AnalysisUtilities.hh.

Referenced by G4VAnalysisManager::CreateH1(), G4VAnalysisManager::CreateH2(), G4VAnalysisManager::CreateH3(), G4VAnalysisManager::CreateNtuple(), G4VAnalysisManager::CreateNtupleDColumn(), G4VAnalysisManager::CreateNtupleFColumn(), G4VAnalysisManager::CreateNtupleIColumn(), G4VAnalysisManager::CreateNtupleSColumn(), G4VAnalysisManager::CreateP1(), G4VAnalysisManager::CreateP2(), G4Hdf5FileManager::GetHistoDirectory(), G4VAnalysisReader::GetNtuple(), G4Hdf5FileManager::GetNtupleDirectory(), G4Hdf5RFileManager::GetRFile(), G4VAnalysisReader::ReadH1(), G4CsvAnalysisReader::ReadH1Impl(), G4Hdf5AnalysisReader::ReadH1Impl(), G4RootAnalysisReader::ReadH1Impl(), G4XmlAnalysisReader::ReadH1Impl(), G4VAnalysisReader::ReadH2(), G4XmlAnalysisReader::ReadH2Impl(), G4CsvAnalysisReader::ReadH2Impl(), G4Hdf5AnalysisReader::ReadH2Impl(), G4RootAnalysisReader::ReadH2Impl(), G4VAnalysisReader::ReadH3(), G4XmlAnalysisReader::ReadH3Impl(), G4CsvAnalysisReader::ReadH3Impl(), G4Hdf5AnalysisReader::ReadH3Impl(), G4RootAnalysisReader::ReadH3Impl(), G4CsvAnalysisReader::ReadNtupleImpl(), G4Hdf5AnalysisReader::ReadNtupleImpl(), G4RootAnalysisReader::ReadNtupleImpl(), G4XmlAnalysisReader::ReadNtupleImpl(), G4VAnalysisReader::ReadP1(), G4XmlAnalysisReader::ReadP1Impl(), G4CsvAnalysisReader::ReadP1Impl(), G4Hdf5AnalysisReader::ReadP1Impl(), G4RootAnalysisReader::ReadP1Impl(), G4VAnalysisReader::ReadP2(), G4XmlAnalysisReader::ReadP2Impl(), G4CsvAnalysisReader::ReadP2Impl(), G4Hdf5AnalysisReader::ReadP2Impl(), G4RootAnalysisReader::ReadP2Impl(), G4VAnalysisManager::SetH1(), G4VAnalysisManager::SetH2(), G4VAnalysisManager::SetH3(), G4VAnalysisManager::SetP1(), and G4VAnalysisManager::SetP2().

kX

const G4int G4Analysis::kX = 0

Definition at line 55 of file G4AnalysisUtilities.hh.

Referenced by G4H1ToolsManager::FillH1(), G4H2ToolsManager::FillH2(), G4H3ToolsManager::FillH3(), G4P1ToolsManager::FillP1(), G4P2ToolsManager::FillP2(), GetAxisTitle(), G4H1ToolsManager::GetH1Nbins(), G4H1ToolsManager::GetH1Width(), G4H1ToolsManager::GetH1XAxisTitle(), G4H1ToolsManager::GetH1Xmax(), G4H1ToolsManager::GetH1Xmin(), G4H2ToolsManager::GetH2Nxbins(), G4H2ToolsManager::GetH2XAxisTitle(), G4H2ToolsManager::GetH2Xmax(), G4H2ToolsManager::GetH2Xmin(), G4H2ToolsManager::GetH2XWidth(), G4H3ToolsManager::GetH3Nxbins(), G4H3ToolsManager::GetH3XAxisTitle(), G4H3ToolsManager::GetH3Xmax(), G4H3ToolsManager::GetH3Xmin(), G4H3ToolsManager::GetH3XWidth(), G4P1ToolsManager::GetP1Nbins(), G4P1ToolsManager::GetP1XAxisTitle(), G4P1ToolsManager::GetP1Xmax(), G4P1ToolsManager::GetP1Xmin(), G4P1ToolsManager::GetP1XWidth(), G4P2ToolsManager::GetP2Nxbins(), G4P2ToolsManager::GetP2XAxisTitle(), G4P2ToolsManager::GetP2Xmax(), G4P2ToolsManager::GetP2Xmin(), G4P2ToolsManager::GetP2XWidth(), G4HnManager::GetXAxisIsLog(), G4HnManager::GetXUnit(), G4PlotManager::PlotAndWrite(), SetAxisTitle(), G4H1ToolsManager::SetH1XAxisTitle(), G4H2ToolsManager::SetH2XAxisTitle(), G4H3ToolsManager::SetH3XAxisTitle(), G4P1ToolsManager::SetP1XAxisTitle(), G4P2ToolsManager::SetP2XAxisTitle(), and G4HnManager::SetXAxisIsLog().

kY

const G4int G4Analysis::kY = 1

Definition at line 56 of file G4AnalysisUtilities.hh.

Referenced by G4H2ToolsManager::FillH2(), G4H3ToolsManager::FillH3(), G4P1ToolsManager::FillP1(), G4P2ToolsManager::FillP2(), GetAxisTitle(), G4H1ToolsManager::GetH1YAxisTitle(), G4H2ToolsManager::GetH2Nybins(), G4H2ToolsManager::GetH2YAxisTitle(), G4H2ToolsManager::GetH2Ymax(), G4H2ToolsManager::GetH2Ymin(), G4H2ToolsManager::GetH2YWidth(), G4H3ToolsManager::GetH3Nybins(), G4H3ToolsManager::GetH3YAxisTitle(), G4H3ToolsManager::GetH3Ymax(), G4H3ToolsManager::GetH3Ymin(), G4H3ToolsManager::GetH3YWidth(), G4P1ToolsManager::GetP1YAxisTitle(), G4P2ToolsManager::GetP2Nybins(), G4P2ToolsManager::GetP2YAxisTitle(), G4P2ToolsManager::GetP2Ymax(), G4P2ToolsManager::GetP2Ymin(), G4P2ToolsManager::GetP2YWidth(), G4HnManager::GetYAxisIsLog(), G4HnManager::GetYUnit(), G4PlotManager::PlotAndWrite(), SetAxisTitle(), G4H1ToolsManager::SetH1YAxisTitle(), G4H2ToolsManager::SetH2YAxisTitle(), G4H3ToolsManager::SetH3YAxisTitle(), G4P1ToolsManager::SetP1YAxisTitle(), G4P2ToolsManager::SetP2YAxisTitle(), and G4HnManager::SetYAxisIsLog().

kZ

const G4int G4Analysis::kZ = 2

Definition at line 57 of file G4AnalysisUtilities.hh.

Referenced by G4H3ToolsManager::FillH3(), G4P2ToolsManager::FillP2(), GetAxisTitle(), G4H2ToolsManager::GetH2ZAxisTitle(), G4H3ToolsManager::GetH3Nzbins(), G4H3ToolsManager::GetH3ZAxisTitle(), G4H3ToolsManager::GetH3Zmax(), G4H3ToolsManager::GetH3Zmin(), G4H3ToolsManager::GetH3ZWidth(), G4P2ToolsManager::GetP2ZAxisTitle(), G4P2ToolsManager::GetP2Zmax(), G4P2ToolsManager::GetP2Zmin(), G4HnManager::GetZAxisIsLog(), G4HnManager::GetZUnit(), G4PlotManager::PlotAndWrite(), SetAxisTitle(), G4H2ToolsManager::SetH2ZAxisTitle(), G4H3ToolsManager::SetH3ZAxisTitle(), G4P2ToolsManager::SetP2ZAxisTitle(), and G4HnManager::SetZAxisIsLog().