G4H1ToolsManager Class Reference

#include <G4H1ToolsManager.hh>

Inheritance diagram for G4H1ToolsManager:

Public Member Functions
	G4H1ToolsManager (const G4AnalysisManagerState &state)
virtual	~G4H1ToolsManager ()
G4int	AddH1 (const G4String &name, tools::histo::h1d *h1d)
void	AddH1Vector (const std::vector< tools::histo::h1d * > &h1Vector)
tools::histo::h1d *	GetH1 (G4int id, G4bool warn=true, G4bool onlyIfActive=true) const
std::vector< tools::histo::h1d * >::iterator	BeginH1 ()
std::vector< tools::histo::h1d * >::iterator	EndH1 ()
std::vector< tools::histo::h1d * >::const_iterator	BeginConstH1 () const
std::vector< tools::histo::h1d * >::const_iterator	EndConstH1 () const
const std::vector< tools::histo::h1d * > &	GetH1Vector () const
const std::vector< G4HnInformation * > &	GetHnVector () const
Public Member Functions inherited from G4VH1Manager
	G4VH1Manager ()
virtual	~G4VH1Manager ()
	G4VH1Manager (const G4VH1Manager &rhs)=delete
G4VH1Manager &	operator= (const G4VH1Manager &rhs)=delete
Public Member Functions inherited from G4THnManager< tools::histo::h1d >
	G4THnManager (const G4AnalysisManagerState &state, const G4String &hnType)
virtual	~G4THnManager ()
G4bool	Reset ()
G4bool	IsEmpty () const
void	AddTVector (const std::vector< tools::histo::h1d * > &tVector)
void	Merge (G4Mutex &mergeMutex, G4THnManager< tools::histo::h1d > *masterInstance)

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") final
virtual G4int	CreateH1 (const G4String &name, const G4String &title, const std::vector< G4double > &edges, const G4String &unitName="none", const G4String &fcnName="none") final
virtual G4bool	SetH1 (G4int id, G4int nbins, G4double xmin, G4double xmax, const G4String &unitName="none", const G4String &fcnName="none", const G4String &binSchemeName="linear") final
virtual G4bool	SetH1 (G4int id, const std::vector< G4double > &edges, const G4String &unitName="none", const G4String &fcnName="none") final
virtual G4bool	ScaleH1 (G4int id, G4double factor) final
virtual G4bool	FillH1 (G4int id, G4double value, G4double weight=1.0) final
virtual G4int	GetH1Id (const G4String &name, G4bool warn=true) const final
virtual G4int	GetH1Nbins (G4int id) const final
virtual G4double	GetH1Xmin (G4int id) const final
virtual G4double	GetH1Xmax (G4int id) const final
virtual G4double	GetH1Width (G4int id) const final
virtual G4bool	SetH1Title (G4int id, const G4String &title) final
virtual G4bool	SetH1XAxisTitle (G4int id, const G4String &title) final
virtual G4bool	SetH1YAxisTitle (G4int id, const G4String &title) final
virtual G4String	GetH1Title (G4int id) const final
virtual G4String	GetH1XAxisTitle (G4int id) const final
virtual G4String	GetH1YAxisTitle (G4int id) const final
virtual G4bool	WriteOnAscii (std::ofstream &output) final
virtual std::shared_ptr< G4HnManager >	GetHnManager () final
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 &binSchemeName="linear")=0
virtual G4int	CreateH1 (const G4String &name, const G4String &title, const std::vector< G4double > &edges, const G4String &unitName="none", const G4String &fcnName="none")=0
virtual G4bool	SetH1 (G4int id, G4int nbins, G4double xmin, G4double xmax, const G4String &unitName="none", const G4String &fcnName="none", const G4String &binSchemeName="linear")=0
virtual G4bool	SetH1 (G4int id, const std::vector< G4double > &edges, const G4String &unitName="none", const G4String &fcnName="none")=0
virtual G4bool	ScaleH1 (G4int id, G4double factor)=0
virtual G4bool	FillH1 (G4int id, G4double value, G4double weight=1.0)=0
virtual G4int	GetH1Id (const G4String &name, G4bool warn=true) const =0
virtual G4int	GetH1Nbins (G4int id) const =0
virtual G4double	GetH1Xmin (G4int id) const =0
virtual G4double	GetH1Xmax (G4int id) const =0
virtual G4double	GetH1Width (G4int id) const =0
virtual G4bool	SetH1Title (G4int id, const G4String &title)=0
virtual G4bool	SetH1XAxisTitle (G4int id, const G4String &title)=0
virtual G4bool	SetH1YAxisTitle (G4int id, const G4String &title)=0
virtual G4String	GetH1Title (G4int id) const =0
virtual G4String	GetH1XAxisTitle (G4int id) const =0
virtual G4String	GetH1YAxisTitle (G4int id) const =0
virtual G4bool	WriteOnAscii (std::ofstream &output)=0
virtual std::shared_ptr< G4HnManager >	GetHnManager ()=0
Protected Member Functions inherited from G4THnManager< tools::histo::h1d >
std::vector< tools::histo::h1d * >::iterator	BeginT ()
std::vector< tools::histo::h1d * >::iterator	EndT ()
std::vector< tools::histo::h1d * >::const_iterator	BeginConstT () const
std::vector< tools::histo::h1d * >::const_iterator	EndConstT () const
tools::histo::h1d *	GetTInFunction (G4int id, G4String functionName, G4bool warn=true, G4bool onlyIfActive=true) const
G4int	RegisterT (tools::histo::h1d *t, const G4String &name)
G4int	GetTId (const G4String &name, G4bool warn=true) const

Additional Inherited Members
Protected Attributes inherited from G4THnManager< tools::histo::h1d >
const G4AnalysisManagerState &	fState
std::vector< tools::histo::h1d * >	fTVector
std::map< G4String, G4int >	fNameIdMap
std::shared_ptr< G4HnManager >	fHnManager

Detailed Description

Definition at line 51 of file G4H1ToolsManager.hh.

Constructor & Destructor Documentation

G4H1ToolsManager()

G4H1ToolsManager::G4H1ToolsManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 48 of file G4H1ToolsManager.cc.

 : G4VH1Manager(),
   G4THnManager<tools::histo::h1d>(state, "H1")
{}

~G4H1ToolsManager()

G4H1ToolsManager::~G4H1ToolsManager ( )

virtual

Definition at line 54 of file G4H1ToolsManager.cc.

{}

Member Function Documentation

AddH1()

G4int G4H1ToolsManager::AddH1	(	const G4String &	name,
		tools::histo::h1d *	h1d
	)

Definition at line 492 of file G4H1ToolsManager.cc.

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("add", "H1", name);
#endif
    
  // Add annotation
  AddH1Annotation(h1d, "none", "none");        
  // Add information
  AddH1Information(name, "none", "none", G4BinScheme::kLinear);
    
  // Register histogram 
  auto id = RegisterT(h1d, name); 
  
#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) 
    fState.GetVerboseL2()->Message("add", "H1", name);
#endif
  return id;
}  

Referenced by G4CsvAnalysisReader::ReadH1Impl(), G4Hdf5AnalysisReader::ReadH1Impl(), G4RootAnalysisReader::ReadH1Impl(), and G4XmlAnalysisReader::ReadH1Impl().

AddH1Vector()

void G4H1ToolsManager::AddH1Vector

(

const std::vector< tools::histo::h1d * > &

h1Vector

)

Definition at line 516 of file G4H1ToolsManager.cc.

{
  AddTVector(h1Vector);
}  

BeginConstH1()

std::vector< tools::histo::h1d * >::const_iterator G4H1ToolsManager::BeginConstH1 ( ) const

inline

Definition at line 160 of file G4H1ToolsManager.hh.

{ return BeginConstT(); }

BeginH1()

std::vector< tools::histo::h1d * >::iterator G4H1ToolsManager::BeginH1 ( )

inline

Definition at line 153 of file G4H1ToolsManager.hh.

{ return BeginT(); }

CreateH1() [1/2]

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

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 231 of file G4H1ToolsManager.cc.

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

CreateH1() [2/2]

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"  )

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 199 of file G4H1ToolsManager.cc.

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

EndConstH1()

std::vector< tools::histo::h1d * >::const_iterator G4H1ToolsManager::EndConstH1 ( ) const

inline

Definition at line 164 of file G4H1ToolsManager.hh.

{ return EndConstT(); }

EndH1()

std::vector< tools::histo::h1d * >::iterator G4H1ToolsManager::EndH1 ( )

inline

Definition at line 156 of file G4H1ToolsManager.hh.

{ return EndT(); }

FillH1()

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

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 330 of file G4H1ToolsManager.cc.

{
  auto h1d = GetTInFunction(id, "FillH1", true, false);
  if ( ! h1d ) return false;
 
  if ( fState.GetIsActivation() && ( ! fHnManager->GetActivation(id) ) ) {
    //G4cout << "Skipping FillH1 for " << id << G4endl; 
    return false; 
  }  
 
  auto info 
    = fHnManager->GetHnDimensionInformation(id, kX, "FillH1");
  h1d->fill(info->fFcn(value/info->fUnit), weight);
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) {
    G4ExceptionDescription description;
    description << " id " << id << " value " << value 
                << " fcn(value/unit) " << info->fFcn(value/info->fUnit)  
                << " weight " << weight;
    fState.GetVerboseL4()->Message("fill", "H1", description);
  }  
#endif
  return true;
}

GetH1()

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

Definition at line 523 of file G4H1ToolsManager.cc.

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

GetH1Id()

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

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 356 of file G4H1ToolsManager.cc.

{
  return GetTId(name, warn);
}  

GetH1Nbins()

G4int G4H1ToolsManager::GetH1Nbins ( G4int  id ) const

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 362 of file G4H1ToolsManager.cc.

{
  auto h1d = GetTInFunction(id, "GetH1Nbins");
  if ( ! h1d ) return 0;
  
  return GetNbins(*h1d, kX);
}  

GetH1Title()

G4String G4H1ToolsManager::GetH1Title ( G4int  id ) const

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 427 of file G4H1ToolsManager.cc.

{
  auto h1d = GetTInFunction(id, "GetH1Title");
  if ( ! h1d ) return "";
  
  return GetTitle(*h1d);
}  

GetH1Vector()

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

inline

Definition at line 167 of file G4H1ToolsManager.hh.

{ return fTVector; }

Referenced by G4ToolsAnalysisManager::MergeImpl(), G4ToolsAnalysisManager::PlotImpl(), and G4GenericAnalysisManager::WriteImpl().

GetH1Width()

G4double G4H1ToolsManager::GetH1Width ( G4int  id ) const

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 391 of file G4H1ToolsManager.cc.

{
  auto h1d = GetTInFunction(id, "GetH1XWidth", true, false);
  if ( ! h1d ) return 0.;
  
  return GetWidth(*h1d, kX, fHnManager->GetHnType());
}  

GetH1XAxisTitle()

G4String G4H1ToolsManager::GetH1XAxisTitle ( G4int  id ) const

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 437 of file G4H1ToolsManager.cc.

{
  auto h1d = GetTInFunction(id, "GetH1XAxisTitle");
  if ( ! h1d ) return "";
  
  return GetAxisTitle(*h1d, kX, fHnManager->GetHnType());
}

GetH1Xmax()

G4double G4H1ToolsManager::GetH1Xmax ( G4int  id ) const

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 382 of file G4H1ToolsManager.cc.

{
  auto h1d = GetTInFunction(id, "GetH1Xmax");
  if ( ! h1d ) return 0.;
  
  return GetMax(*h1d, kX);
}  

GetH1Xmin()

G4double G4H1ToolsManager::GetH1Xmin ( G4int  id ) const

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 371 of file G4H1ToolsManager.cc.

{
// Returns xmin value with applied unit and histogram function
 
  auto h1d = GetTInFunction(id, "GetH1Xmin");
  if ( ! h1d ) return 0.;
  
  return GetMin(*h1d, kX);
}  

GetH1YAxisTitle()

G4String G4H1ToolsManager::GetH1YAxisTitle ( G4int  id ) const

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 446 of file G4H1ToolsManager.cc.

{
  auto h1d = GetTInFunction(id, "GetH1YAxisTitle");
  if ( ! h1d ) return "";
  
  return GetAxisTitle(*h1d, kY, fHnManager->GetHnType());
}  

GetHnManager()

std::shared_ptr< G4HnManager > G4H1ToolsManager::GetHnManager ( )

inlinefinalprotectedvirtual

Implements G4VH1Manager.

Definition at line 173 of file G4H1ToolsManager.hh.

{ return std::shared_ptr<G4HnManager>(fHnManager); }

GetHnVector()

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

inline

Definition at line 170 of file G4H1ToolsManager.hh.

{ return fHnManager->GetHnVector(); }

Referenced by G4ToolsAnalysisManager::MergeImpl(), G4ToolsAnalysisManager::PlotImpl(), and G4GenericAnalysisManager::WriteImpl().

ScaleH1()

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

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 321 of file G4H1ToolsManager.cc.

{
  auto h1d = GetTInFunction(id, "ScaleH1", false, false);
  if ( ! h1d ) return false;
 
  return h1d->scale(factor);
}  

SetH1() [1/2]

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

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 290 of file G4H1ToolsManager.cc.

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

SetH1() [2/2]

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

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 259 of file G4H1ToolsManager.cc.

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

SetH1Title()

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

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 400 of file G4H1ToolsManager.cc.

{
  auto h1d = GetTInFunction(id, "SetH1Title");
  if ( ! h1d ) return false;
  
  return SetTitle(*h1d, title);
}  

SetH1XAxisTitle()

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

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 409 of file G4H1ToolsManager.cc.

{
  auto h1d = GetTInFunction(id, "SetH1XAxisTitle");
  if ( ! h1d ) return false;
  
  return SetAxisTitle(*h1d, kX, title);
}  

SetH1YAxisTitle()

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

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 418 of file G4H1ToolsManager.cc.

{
  auto h1d = GetTInFunction(id, "SetH1YAxisTitle");
  if ( ! h1d ) return false;
  
  return SetAxisTitle(*h1d, kY, title);
}  

WriteOnAscii()

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

finalprotectedvirtual

Implements G4VH1Manager.

Definition at line 455 of file G4H1ToolsManager.cc.

{
// 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(fTVector.size()); ++i ) {
    auto id = i + fHnManager->GetFirstId();
    auto info = fHnManager->GetHnInformation(id,"WriteOnAscii"); 
    // skip writing if activation is enabled and H1 is inactivated
    if ( ! info->GetAscii() ) continue; 
    auto h1 = fTVector[i];
 
#ifdef G4VERBOSE
    if ( fState.GetVerboseL3() ) 
      fState.GetVerboseL3()->Message("write on ascii", "h1d", info->GetName());
#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:

• G4H1ToolsManager.hh
• G4H1ToolsManager.cc