#include <G4H1ToolsManager.hh>

Inheritance diagram for G4H1ToolsManager:

Public Member Functions
	G4H1ToolsManager (const G4AnalysisManagerState &state)

virtual	~G4H1ToolsManager ()

void	AddH1Vector (const std::vector< tools::histo::h1d * > &h1Vector)

G4bool	Reset ()

G4bool	IsEmpty () const

tools::histo::h1d *	GetH1 (G4int id, G4bool warn=true, G4bool onlyIfActive=true) const

const std::vector < tools::histo::h1d * > &	GetH1Vector () const

const std::vector < G4HnInformation * > &	GetHnVector () const

Public Member Functions inherited from G4BaseAnalysisManager
	G4BaseAnalysisManager (const G4AnalysisManagerState &state)

virtual	~G4BaseAnalysisManager ()

G4bool	SetFirstId (G4int firstId)

Protected Member Functions
virtual G4int	CreateH1 (const G4String &name, const G4String &title, G4int nbins, G4double xmin, G4double xmax, const G4String &unitName="none", const G4String &fcnName="none", const G4String &binScheme="linear")

virtual G4int	CreateH1 (const G4String &name, const G4String &title, const std::vector< G4double > &edges, const G4String &unitName="none", const G4String &fcnName="none")

virtual G4bool	SetH1 (G4int id, G4int nbins, G4double xmin, G4double xmax, const G4String &unitName="none", const G4String &fcnName="none", const G4String &binSchemeName="linear")

virtual G4bool	SetH1 (G4int id, const std::vector< G4double > &edges, const G4String &unitName="none", const G4String &fcnName="none")

virtual G4bool	ScaleH1 (G4int id, G4double factor)

virtual G4bool	FillH1 (G4int id, G4double value, G4double weight=1.0)

virtual G4int	GetH1Id (const G4String &name, G4bool warn=true) const

virtual G4int	GetH1Nbins (G4int id) const

virtual G4double	GetH1Xmin (G4int id) const

virtual G4double	GetH1Xmax (G4int id) const

virtual G4double	GetH1Width (G4int id) const

virtual G4bool	SetH1Title (G4int id, const G4String &title)

virtual G4bool	SetH1XAxisTitle (G4int id, const G4String &title)

virtual G4bool	SetH1YAxisTitle (G4int id, const G4String &title)

virtual G4String	GetH1Title (G4int id) const

virtual G4String	GetH1XAxisTitle (G4int id) const

virtual G4String	GetH1YAxisTitle (G4int id) const

virtual G4bool	WriteOnAscii (std::ofstream &output)

Protected Member Functions inherited from G4VH1Manager
	G4VH1Manager (const G4AnalysisManagerState &state)

virtual	~G4VH1Manager ()

Protected Member Functions inherited from G4BaseAnalysisManager
void	ExceptionForHistograms (const G4String &functionName) const

Additional Inherited Members
Protected Attributes inherited from G4VH1Manager
G4HnManager *	fHnManager

Protected Attributes inherited from G4BaseAnalysisManager
const G4AnalysisManagerState &	fState

G4int	fFirstId

G4bool	fLockFirstId

Detailed Description

Definition at line 51 of file G4H1ToolsManager.hh.

Constructor & Destructor Documentation

G4H1ToolsManager::G4H1ToolsManager ( const G4AnalysisManagerState & state )

Definition at line 46 of file G4H1ToolsManager.cc.

  : G4VH1Manager(state),
    fH1Vector(),
    fH1NameIdMap()
 {
 }

G4H1ToolsManager::~G4H1ToolsManager ( )

virtual

Definition at line 54 of file G4H1ToolsManager.cc.

 {  
   std::vector<tools::histo::h1d*>::iterator it;
   for (it = fH1Vector.begin(); it != fH1Vector.end(); it++ ) {
     delete (*it);
   }  
 }

Member Function Documentation

void G4H1ToolsManager::AddH1Vector ( const std::vector< tools::histo::h1d * > & h1Vector )

Definition at line 577 of file G4H1ToolsManager.cc.

References G4BaseAnalysisManager::fState, G4AnalysisManagerState::GetVerboseL1(), G4AnalysisManagerState::GetVerboseL4(), and G4AnalysisVerbose::Message().

 {
 #ifdef G4VERBOSE
     if ( fState.GetVerboseL4() ) 
       fState.GetVerboseL4()->Message("merge", "all h1", "");
 #endif
   std::vector<tools::histo::h1d*>::const_iterator itw = h1Vector.begin();
   std::vector<tools::histo::h1d*>::iterator it;
   for (it = fH1Vector.begin(); it != fH1Vector.end(); it++ ) {
     (*it)->add(*(*itw++));
   }  
 #ifdef G4VERBOSE
     if ( fState.GetVerboseL1() ) 
       fState.GetVerboseL1()->Message("merge", "all h1", "");
 #endif
 }  

G4int G4H1ToolsManager::CreateH1	(	const G4String &	name,
		const G4String &	title,
		G4int	nbins,
		G4double	xmin,
		G4double	xmax,
		const G4String &	unitName = `"none"`,
		const G4String &	fcnName = `"none"`,
		const G4String &	binScheme = `"linear"`
	)

protectedvirtual

Implements G4VH1Manager.

Definition at line 244 of file G4H1ToolsManager.cc.

References G4BaseAnalysisManager::fState, G4Analysis::GetBinScheme(), G4AnalysisManagerState::GetVerboseL2(), G4AnalysisManagerState::GetVerboseL4(), and G4AnalysisVerbose::Message().

 {
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL4() ) 
     fState.GetVerboseL4()->Message("create", "H1", name);
 #endif
   tools::histo::h1d* h1d
     = CreateToolsH1(title, nbins, xmin, xmax, fcnName, binSchemeName);
     
   // Add annotation
   AddH1Annotation(h1d, unitName, fcnName);        
     
   // Save H1 information
   G4BinScheme binScheme = GetBinScheme(binSchemeName);
   AddH1Information(name, unitName, fcnName, binScheme);
     
   // Register histogram 
   G4int id = RegisterToolsH1(h1d, name); 
   
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL2() ) 
     fState.GetVerboseL2()->Message("create", "H1", name);
 #endif
   return id;
 }                                         

G4int G4H1ToolsManager::CreateH1	(	const G4String &	name,
		const G4String &	title,
		const std::vector< G4double > &	edges,
		const G4String &	unitName = `"none"`,
		const G4String &	fcnName = `"none"`
	)

protectedvirtual

Implements G4VH1Manager.

Definition at line 274 of file G4H1ToolsManager.cc.

References G4BaseAnalysisManager::fState, G4AnalysisManagerState::GetVerboseL2(), G4AnalysisManagerState::GetVerboseL4(), kUserBinScheme, and G4AnalysisVerbose::Message().

 {
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL4() ) 
     fState.GetVerboseL4()->Message("create", "H1", name);
 #endif
   tools::histo::h1d* h1d 
     = CreateToolsH1(title, edges, fcnName);
     
   // Add annotation
   AddH1Annotation(h1d, unitName, fcnName);        
     
   // Save H1 information
   AddH1Information(name, unitName, fcnName, kUserBinScheme);
     
   // Register histogram 
   G4int id = RegisterToolsH1(h1d, name); 
   
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL2() ) 
     fState.GetVerboseL2()->Message("create", "H1", name);
 #endif
   return id;
 }                                         

G4bool G4H1ToolsManager::FillH1	(	G4int	id,
		G4double	value,
		G4double	weight = `1.0`
	)

protectedvirtual

Implements G4VH1Manager.

Definition at line 373 of file G4H1ToolsManager.cc.

References G4VH1Manager::fHnManager, G4BaseAnalysisManager::fState, G4HnInformation::fXFcn, G4HnInformation::fXUnit, G4HnManager::GetActivation(), G4HnManager::GetHnInformation(), G4AnalysisManagerState::GetIsActivation(), G4AnalysisManagerState::GetVerboseL4(), and G4AnalysisVerbose::Message().

 {
   tools::histo::h1d* h1d = GetH1InFunction(id, "FillH1", true, false);
   if ( ! h1d ) return false;
 
   if ( fState.GetIsActivation() && ( ! fHnManager->GetActivation(id) ) ) {
     //G4cout << "Skipping FillH1 for " << id << G4endl; 
     return false; 
   }  
 
   G4HnInformation* info = fHnManager->GetHnInformation(id, "FillId");
   h1d->fill(info->fXFcn(value/info->fXUnit), weight);
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL4() ) {
     G4ExceptionDescription description;
     description << " id " << id << " value " << value;
     fState.GetVerboseL4()->Message("fill", "H1", description);
   }  
 #endif
   return true;
 }

tools::histo::h1d * G4H1ToolsManager::GetH1	(	G4int	id,
		G4bool	warn = `true`,
		G4bool	onlyIfActive = `true`
	)		const

Definition at line 618 of file G4H1ToolsManager.cc.

 {
   return GetH1InFunction(id, "GetH1", warn, onlyIfActive);
 }

G4int G4H1ToolsManager::GetH1Id	(	const G4String &	name,
		G4bool	warn = `true`
	)		const

protectedvirtual

Implements G4VH1Manager.

Definition at line 396 of file G4H1ToolsManager.cc.

References G4Exception(), and JustWarning.

 {
   std::map<G4String, G4int>::const_iterator it = fH1NameIdMap.find(name);
   if ( it ==  fH1NameIdMap.end() ) {  
     if ( warn) {
       G4String inFunction = "G4H1ToolsManager::GetH1Id";
       G4ExceptionDescription description;
       description << "      " << "histogram " << name << " does not exist.";
       G4Exception(inFunction, "Analysis_W007", JustWarning, description);
     }
     return -1;         
   }
   return it->second;
 }  

G4int G4H1ToolsManager::GetH1Nbins ( G4int id ) const

protectedvirtual

Implements G4VH1Manager.

Definition at line 412 of file G4H1ToolsManager.cc.

 {
   tools::histo::h1d* h1d = GetH1InFunction(id, "GetH1Nbins");
   if ( ! h1d ) return 0;
   
   return h1d->axis().bins();
 }  

G4String G4H1ToolsManager::GetH1Title ( G4int id ) const

protectedvirtual

Implements G4VH1Manager.

Definition at line 492 of file G4H1ToolsManager.cc.

 {
   tools::histo::h1d* h1d = GetH1InFunction(id, "GetH1Title");
   if ( ! h1d ) return "";
   
   return h1d->title();
 }  

const std::vector< tools::histo::h1d * > & G4H1ToolsManager::GetH1Vector ( ) const

inline

Definition at line 153 of file G4H1ToolsManager.hh.

154 { return fH1Vector; }

G4double G4H1ToolsManager::GetH1Width ( G4int id ) const

protectedvirtual

Implements G4VH1Manager.

Definition at line 443 of file G4H1ToolsManager.cc.

References G4VH1Manager::fHnManager, G4HnInformation::fXFcn, G4HnInformation::fXUnit, G4Exception(), G4HnManager::GetHnInformation(), and JustWarning.

 {
   tools::histo::h1d* h1d = GetH1InFunction(id, "GetH1XWidth", true, false);
   if ( ! h1d ) return 0;
   
   G4int nbins = h1d->axis().bins();
   if ( ! nbins ) {
     G4ExceptionDescription description;
     description << "    nbins = 0 (for h1 id = " << id << ").";
     G4Exception("G4H1ToolsManager::GetH1Width",
                 "Analysis_W014", JustWarning, description);
     return 0;
   }              
   
   G4HnInformation* info = fHnManager->GetHnInformation(id, "GetH1XWidth");
   return ( info->fXFcn(h1d->axis().upper_edge()) 
            - info->fXFcn(h1d->axis().lower_edge()))*info->fXUnit/nbins;
 }  

G4String G4H1ToolsManager::GetH1XAxisTitle ( G4int id ) const

protectedvirtual

Implements G4VH1Manager.

Definition at line 502 of file G4H1ToolsManager.cc.

References G4Exception(), JustWarning, and title().

 {
   tools::histo::h1d* h1d = GetH1InFunction(id, "GetH1XAxisTitle");
   if ( ! h1d ) return "";
   
   G4String title;
   G4bool result = h1d->annotation(tools::histo::key_axis_x_title(), title);
   if ( ! result ) {
     G4ExceptionDescription description;
     description << "    Failed to get x_axis title for h1 id = " << id << ").";
     G4Exception("G4H1ToolsManager::GetH1XAxisTitle",
                 "Analysis_W014", JustWarning, description);
     return "";
   }
   
   return title;              
 }  

G4double G4H1ToolsManager::GetH1Xmax ( G4int id ) const

protectedvirtual

Implements G4VH1Manager.

Definition at line 433 of file G4H1ToolsManager.cc.

References G4VH1Manager::fHnManager, G4HnInformation::fXFcn, G4HnInformation::fXUnit, and G4HnManager::GetHnInformation().

 {
   tools::histo::h1d* h1d = GetH1InFunction(id, "GetH1Xmax");
   if ( ! h1d ) return 0;
   
   G4HnInformation* info = fHnManager->GetHnInformation(id, "GetH1Xmax");
   return info->fXFcn(h1d->axis().upper_edge()*info->fXUnit);
 }  

G4double G4H1ToolsManager::GetH1Xmin ( G4int id ) const

protectedvirtual

Implements G4VH1Manager.

Definition at line 421 of file G4H1ToolsManager.cc.

References G4VH1Manager::fHnManager, G4HnInformation::fXFcn, G4HnInformation::fXUnit, and G4HnManager::GetHnInformation().

 {
 // Returns xmin value with applied unit and histogram function
 
   tools::histo::h1d* h1d = GetH1InFunction(id, "GetH1Xmin");
   if ( ! h1d ) return 0;
   
   G4HnInformation* info = fHnManager->GetHnInformation(id, "GetH1Xmin");
   return info->fXFcn(h1d->axis().lower_edge()*info->fXUnit);
 }  

G4String G4H1ToolsManager::GetH1YAxisTitle ( G4int id ) const

protectedvirtual

Implements G4VH1Manager.

Definition at line 521 of file G4H1ToolsManager.cc.

References G4Exception(), JustWarning, and title().

 {
   tools::histo::h1d* h1d = GetH1InFunction(id, "GetH1YAxisTitle");
   if ( ! h1d ) return "";
   
   G4String title;
   G4bool result = h1d->annotation(tools::histo::key_axis_y_title(), title);
   if ( ! result ) {
     G4ExceptionDescription description;
     description << "    Failed to get y_axis title for h1 id = " << id << ").";
     G4Exception("G4H1ToolsManager::GetH1YAxisTitle",
                 "Analysis_W014", JustWarning, description);
     return "";
   }
   
   return title;              
 }  

const std::vector< G4HnInformation * > & G4H1ToolsManager::GetHnVector ( ) const

inline

Definition at line 156 of file G4H1ToolsManager.hh.

References G4VH1Manager::fHnManager, and G4HnManager::GetHnVector().

157 { return fHnManager->GetHnVector(); }

G4VH1Manager::fHnManager

G4HnManager * fHnManager

Definition: G4VH1Manager.hh:101

G4HnManager::GetHnVector

const std::vector< G4HnInformation * > & GetHnVector() const

Definition: G4HnManager.hh:117

G4bool G4H1ToolsManager::IsEmpty ( ) const

Definition at line 612 of file G4H1ToolsManager.cc.

Referenced by G4XmlAnalysisManager::CloseFileImpl(), G4RootAnalysisManager::CloseFileImpl(), G4XmlAnalysisManager::WriteImpl(), and G4RootAnalysisManager::WriteImpl().

 {
   return ! fH1Vector.size();
 }  

G4bool G4H1ToolsManager::Reset ( )

Definition at line 596 of file G4H1ToolsManager.cc.

 {
 // Reset histograms and ntuple
 
   G4bool finalResult = true;
 
   std::vector<tools::histo::h1d*>::iterator it;
   for (it = fH1Vector.begin(); it != fH1Vector.end(); it++ ) {
     G4bool result = (*it)->reset();
     if ( ! result ) finalResult = false;
   }  
   
   return finalResult;
 }  

G4bool G4H1ToolsManager::ScaleH1	(	G4int	id,
		G4double	factor
	)

protectedvirtual

Implements G4VH1Manager.

Definition at line 364 of file G4H1ToolsManager.cc.

 {
   tools::histo::h1d* h1d = GetH1InFunction(id, "ScaleH1", false, false);
   if ( ! h1d ) return false;
 
   return h1d->scale(factor);
 }  

G4bool G4H1ToolsManager::SetH1	(	G4int	id,
		G4int	nbins,
		G4double	xmin,
		G4double	xmax,
		const G4String &	unitName = `"none"`,
		const G4String &	fcnName = `"none"`,
		const G4String &	binSchemeName = `"linear"`
	)

protectedvirtual

Implements G4VH1Manager.

Definition at line 302 of file G4H1ToolsManager.cc.

References G4VH1Manager::fHnManager, G4HnInformation::fName, G4BaseAnalysisManager::fState, G4Analysis::GetBinScheme(), G4HnManager::GetHnInformation(), G4AnalysisManagerState::GetVerboseL4(), G4AnalysisVerbose::Message(), and G4HnManager::SetActivation().

 {                                
   tools::histo::h1d* h1d = GetH1InFunction(id, "SetH1", false, false);
   if ( ! h1d ) return false;
 
   G4HnInformation* info = fHnManager->GetHnInformation(id,"SetH1");
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL4() ) 
     fState.GetVerboseL4()->Message("configure", "H1", info->fName);
 #endif
 
   // Configure tools h1
   ConfigureToolsH1(h1d, nbins, xmin, xmax, fcnName, binSchemeName);
 
   // Add annotation
   AddH1Annotation(h1d, unitName, fcnName);        
     
   // Update information
   G4BinScheme binScheme = GetBinScheme(binSchemeName);
   UpdateH1Information(info, unitName, fcnName, binScheme);
 
   // Set activation
   fHnManager->SetActivation(id, true); 
   
   return true;
 }

G4bool G4H1ToolsManager::SetH1	(	G4int	id,
		const std::vector< G4double > &	edges,
		const G4String &	unitName = `"none"`,
		const G4String &	fcnName = `"none"`
	)

protectedvirtual

Implements G4VH1Manager.

Definition at line 333 of file G4H1ToolsManager.cc.

References G4VH1Manager::fHnManager, G4HnInformation::fName, G4BaseAnalysisManager::fState, G4HnManager::GetHnInformation(), G4AnalysisManagerState::GetVerboseL4(), kUserBinScheme, G4AnalysisVerbose::Message(), and G4HnManager::SetActivation().

 {
   tools::histo::h1d* h1d = GetH1InFunction(id, "SetH1", false, false);
   if ( ! h1d ) return false;
 
   G4HnInformation* info = fHnManager->GetHnInformation(id,"SetH1");
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL4() ) 
     fState.GetVerboseL4()->Message("configure", "H1", info->fName);
 #endif
 
   // Configure tools h1
   ConfigureToolsH1(h1d, edges, fcnName);
       
   // Add annotation
   AddH1Annotation(h1d, unitName, fcnName);        
 
   // Update information 
   UpdateH1Information(info, unitName, fcnName, kUserBinScheme);
 
   // Set activation
   fHnManager->SetActivation(id, true); 
   
   return true;
 }

G4bool G4H1ToolsManager::SetH1Title	(	G4int	id,
		const G4String &	title
	)

protectedvirtual

Implements G4VH1Manager.

Definition at line 463 of file G4H1ToolsManager.cc.

 {
   tools::histo::h1d* h1d = GetH1InFunction(id, "SetH1Title");
   if ( ! h1d ) return false;
   
   return h1d->set_title(title);
 }  

G4bool G4H1ToolsManager::SetH1XAxisTitle	(	G4int	id,
		const G4String &	title
	)

protectedvirtual

Implements G4VH1Manager.

Definition at line 472 of file G4H1ToolsManager.cc.

 {
   tools::histo::h1d* h1d = GetH1InFunction(id, "SetH1XAxisTitle");
   if ( ! h1d ) return false;
   
   h1d->add_annotation(tools::histo::key_axis_x_title(), title);
   return true;
 }  

G4bool G4H1ToolsManager::SetH1YAxisTitle	(	G4int	id,
		const G4String &	title
	)

protectedvirtual

Implements G4VH1Manager.

Definition at line 482 of file G4H1ToolsManager.cc.

 {
   tools::histo::h1d* h1d = GetH1InFunction(id, "SetH1YAxisTitle");
   if ( ! h1d ) return false;
   
   h1d->add_annotation(tools::histo::key_axis_y_title(), title);
   return true;
 }  

G4bool G4H1ToolsManager::WriteOnAscii ( std::ofstream & output )

protectedvirtual

Implements G4VH1Manager.

Definition at line 540 of file G4H1ToolsManager.cc.

References G4HnInformation::fAscii, G4BaseAnalysisManager::fFirstId, G4VH1Manager::fHnManager, G4HnInformation::fName, G4BaseAnalysisManager::fState, G4endl, G4HnManager::GetHnInformation(), G4AnalysisManagerState::GetVerboseL3(), and G4AnalysisVerbose::Message().

 {
 // Write selected objects on ASCII file
 // According to the implementation by Michel Maire, originally in
 // extended examples.
 
   // h1 histograms
   for ( G4int i=0; i<G4int(fH1Vector.size()); ++i ) {
     G4int id = i + fFirstId;
     G4HnInformation* info = fHnManager->GetHnInformation(id,"WriteOnAscii"); 
     // skip writing if activation is enabled and H1 is inactivated
     if ( ! info->fAscii ) continue; 
     tools::histo::h1d* h1 = fH1Vector[i];
 
 #ifdef G4VERBOSE
     if ( fState.GetVerboseL3() ) 
       fState.GetVerboseL3()->Message("write on ascii", "h1d", info->fName);
 #endif
   
     output << "\n  1D histogram " << id << ": " << h1->title() 
            << "\n \n \t     X \t\t     Y" << G4endl;
     
     for (G4int j=0; j< G4int(h1->axis().bins()); ++j) {
        output << "  " << j << "\t" 
               << h1->axis().bin_center(j) << "\t"
               << h1->bin_height(j) << G4endl;
     } 
   }
   
   return true;
 }  

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation