G4H2ToolsManager Class Reference

#include <G4H2ToolsManager.hh>

Inheritance diagram for G4H2ToolsManager:

Collaboration diagram for G4H2ToolsManager:

Public Member Functions
	G4H2ToolsManager (const G4AnalysisManagerState &state)
virtual	~G4H2ToolsManager ()
G4int	AddH2 (const G4String &name, tools::histo::h2d *h2d)
void	AddH2Vector (const std::vector< tools::histo::h2d * > &h2Vector)
tools::histo::h2d *	GetH2 (G4int id, G4bool warn=true, G4bool onlyIfActive=true) const
std::vector< tools::histo::h2d * > ::iterator	BeginH2 ()
std::vector< tools::histo::h2d * > ::iterator	EndH2 ()
std::vector< tools::histo::h2d * > ::const_iterator	BeginConstH2 () const
std::vector< tools::histo::h2d * > ::const_iterator	EndConstH2 () const
const std::vector < tools::histo::h2d * > &	GetH2Vector () const
const std::vector < G4HnInformation * > &	GetHnVector () const
Public Member Functions inherited from G4VH2Manager
	G4VH2Manager ()
virtual	~G4VH2Manager ()
	G4VH2Manager (const G4VH2Manager &rhs)=delete
G4VH2Manager &	operator= (const G4VH2Manager &rhs)=delete
Public Member Functions inherited from G4THnManager< tools::histo::h2d >
	G4THnManager (const G4AnalysisManagerState &state, const G4String &hnType)
virtual	~G4THnManager ()
G4bool	Reset ()
G4bool	IsEmpty () const

Protected Member Functions
virtual G4int	CreateH2 (const G4String &name, const G4String &title, G4int nxbins, G4double xmin, G4double xmax, G4int nybins, G4double ymin, G4double ymax, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none", const G4String &xbinScheme="linear", const G4String &ybinScheme="linear") final
virtual G4int	CreateH2 (const G4String &name, const G4String &title, const std::vector< G4double > &xedges, const std::vector< G4double > &yedges, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none") final
virtual G4bool	SetH2 (G4int id, G4int nxbins, G4double xmin, G4double xmax, G4int nybins, G4double ymin, G4double ymax, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none", const G4String &xbinScheme="linear", const G4String &ybinScheme="linear") final
virtual G4bool	SetH2 (G4int id, const std::vector< G4double > &xedges, const std::vector< G4double > &yedges, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none") final
virtual G4bool	ScaleH2 (G4int id, G4double factor) final
virtual G4bool	FillH2 (G4int id, G4double xvalue, G4double yvalue, G4double weight=1.0) final
virtual G4int	GetH2Id (const G4String &name, G4bool warn=true) const final
virtual G4int	GetH2Nxbins (G4int id) const final
virtual G4double	GetH2Xmin (G4int id) const final
virtual G4double	GetH2Xmax (G4int id) const final
virtual G4double	GetH2XWidth (G4int id) const final
virtual G4int	GetH2Nybins (G4int id) const final
virtual G4double	GetH2Ymin (G4int id) const final
virtual G4double	GetH2Ymax (G4int id) const final
virtual G4double	GetH2YWidth (G4int id) const final
virtual G4bool	SetH2Title (G4int id, const G4String &title) final
virtual G4bool	SetH2XAxisTitle (G4int id, const G4String &title) final
virtual G4bool	SetH2YAxisTitle (G4int id, const G4String &title) final
virtual G4bool	SetH2ZAxisTitle (G4int id, const G4String &title) final
virtual G4String	GetH2Title (G4int id) const final
virtual G4String	GetH2XAxisTitle (G4int id) const final
virtual G4String	GetH2YAxisTitle (G4int id) const final
virtual G4String	GetH2ZAxisTitle (G4int id) const final
virtual G4bool	WriteOnAscii (std::ofstream &output) final
virtual std::shared_ptr < G4HnManager >	GetHnManager () final
Protected Member Functions inherited from G4THnManager< tools::histo::h2d >
void	AddTVector (const std::vector< tools::histo::h2d * > &tVector)
std::vector< tools::histo::h2d * > ::iterator	BeginT ()
std::vector< tools::histo::h2d * > ::iterator	EndT ()
std::vector< tools::histo::h2d * > ::const_iterator	BeginConstT () const
std::vector< tools::histo::h2d * > ::const_iterator	EndConstT () const
tools::histo::h2d *	GetTInFunction (G4int id, G4String functionName, G4bool warn=true, G4bool onlyIfActive=true) const
G4int	RegisterT (tools::histo::h2d *t, const G4String &name)
G4int	GetTId (const G4String &name, G4bool warn=true) const

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

Detailed Description

Definition at line 52 of file G4H2ToolsManager.hh.

Constructor & Destructor Documentation

G4H2ToolsManager::G4H2ToolsManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 45 of file G4H2ToolsManager.cc.

 : G4VH2Manager(),
   G4THnManager<tools::histo::h2d>(state, "H2")
{}

G4H2ToolsManager::~G4H2ToolsManager ( )

virtual

Definition at line 51 of file G4H2ToolsManager.cc.

{}

Member Function Documentation

G4int G4H2ToolsManager::AddH2	(	const G4String &	name,
		tools::histo::h2d *	h2d
	)

Definition at line 605 of file G4H2ToolsManager.cc.

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("add", "H2", name);
#endif

  // Add annotation
  AddH2Annotation(h2d, "none", "none", "none", "none");        
  // Add information
  AddH2Information(name, "none", "none", "none", "none", 
                   G4BinScheme::kLinear, G4BinScheme::kLinear);
    
  // Register histogram 
  G4int id = RegisterT(h2d, name); 
  
#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) 
    fState.GetVerboseL2()->Message("add", "H2", name);
#endif
  return id;
}  

Here is the call graph for this function:

Here is the caller graph for this function:

void G4H2ToolsManager::AddH2Vector

(

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

h2Vector

)

Definition at line 629 of file G4H2ToolsManager.cc.

{
  AddTVector(h2Vector);
}  

Here is the call graph for this function:

std::vector< tools::histo::h2d * >::const_iterator G4H2ToolsManager::BeginConstH2 ( ) const

inline

Definition at line 185 of file G4H2ToolsManager.hh.

{ return BeginConstT(); }

Here is the call graph for this function:

std::vector< tools::histo::h2d * >::iterator G4H2ToolsManager::BeginH2 ( )

inline

Definition at line 178 of file G4H2ToolsManager.hh.

{ return BeginT(); }

Here is the call graph for this function:

G4int G4H2ToolsManager::CreateH2 ( const G4String &  name, const G4String &  title, G4int  nxbins, G4double  xmin, G4double  xmax, G4int  nybins, G4double  ymin, G4double  ymax, const G4String &  xunitName = "none", const G4String &  yunitName = "none", const G4String &  xfcnName = "none", const G4String &  yfcnName = "none", const G4String &  xbinScheme = "linear", const G4String &  ybinScheme = "linear"  )

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 250 of file G4H2ToolsManager.cc.

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("create", "H2", name);
#endif
  tools::histo::h2d* h2d
    = CreateToolsH2(title, nxbins, xmin, xmax, nybins, ymin, ymax, 
                    xunitName, yunitName, xfcnName, yfcnName, 
                    xbinSchemeName, ybinSchemeName);
    
  // Add annotation
  AddH2Annotation(h2d, xunitName, yunitName, xfcnName, yfcnName);        
    
  // Save H2 information
  auto xbinScheme = GetBinScheme(xbinSchemeName);
  auto ybinScheme = GetBinScheme(ybinSchemeName);
  AddH2Information(
    name, xunitName, yunitName, xfcnName, yfcnName, xbinScheme, ybinScheme);
    
  // Register histogram 
  G4int id = RegisterT(h2d, name); 

#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) 
    fState.GetVerboseL2()->Message("create", "H2", name);
#endif

  return id;
}                                         

Here is the call graph for this function:

G4int G4H2ToolsManager::CreateH2 ( const G4String &  name, const G4String &  title, const std::vector< G4double > &  xedges, const std::vector< G4double > &  yedges, const G4String &  xunitName = "none", const G4String &  yunitName = "none", const G4String &  xfcnName = "none", const G4String &  yfcnName = "none"  )

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 289 of file G4H2ToolsManager.cc.

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("create", "H2", name);
#endif
  tools::histo::h2d* h2d
    = CreateToolsH2(title, xedges, yedges, 
                    xunitName, yunitName, xfcnName, yfcnName); 
    
  // Add annotation
  AddH2Annotation(h2d, xunitName, yunitName, xfcnName, yfcnName);        
    
  // Save H2 information
  AddH2Information(
    name, xunitName, yunitName, xfcnName, yfcnName, G4BinScheme::kUser, G4BinScheme::kUser);
    
  // Register histogram 
  G4int id = RegisterT(h2d, name); 

#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) 
    fState.GetVerboseL2()->Message("create", "H2", name);
#endif

  return id;
}                                         

Here is the call graph for this function:

std::vector< tools::histo::h2d * >::const_iterator G4H2ToolsManager::EndConstH2 ( ) const

inline

Definition at line 189 of file G4H2ToolsManager.hh.

{ return EndConstT(); }

Here is the call graph for this function:

std::vector< tools::histo::h2d * >::iterator G4H2ToolsManager::EndH2 ( )

inline

Definition at line 181 of file G4H2ToolsManager.hh.

{ return EndT(); }

Here is the call graph for this function:

G4bool G4H2ToolsManager::FillH2 ( G4int  id, G4double  xvalue, G4double  yvalue, G4double  weight = 1.0  )

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 402 of file G4H2ToolsManager.cc.

{
  auto h2d = GetTInFunction(id, "FillH2", true, false);
  if ( ! h2d ) return false;

  if ( fState.GetIsActivation() && ( ! fHnManager->GetActivation(id) ) ) {
    return false; 
  }  

  G4HnDimensionInformation* xInfo 
    = fHnManager->GetHnDimensionInformation(id, kX, "FillH2");
  G4HnDimensionInformation* yInfo 
    = fHnManager->GetHnDimensionInformation(id, kY, "FillH2");

  h2d->fill(xInfo->fFcn(xvalue/xInfo->fUnit), 
            yInfo->fFcn(yvalue/yInfo->fUnit), weight);
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) {
    G4ExceptionDescription description;
    description << " id " << id 
                << " xvalue " << xvalue 
                << " xfcn(xvalue/xunit) " <<  xInfo->fFcn(xvalue/xInfo->fUnit) 
                << " yvalue " << yvalue
                << " yfcn(yvalue/yunit) " <<  yInfo->fFcn(yvalue/yInfo->fUnit) 
                << " weight " << weight;
    fState.GetVerboseL4()->Message("fill", "H2", description);
  }  
#endif
  return true;
}

Here is the call graph for this function:

tools::histo::h2d * G4H2ToolsManager::GetH2	(	G4int	id,
		G4bool	warn = true,
		G4bool	onlyIfActive = true
	)		const

Definition at line 635 of file G4H2ToolsManager.cc.

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

Here is the call graph for this function:

G4int G4H2ToolsManager::GetH2Id ( const G4String &  name, G4bool  warn = true  ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 436 of file G4H2ToolsManager.cc.

{
  return GetTId(name, warn);
}  

Here is the call graph for this function:

G4int G4H2ToolsManager::GetH2Nxbins ( G4int  id ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 442 of file G4H2ToolsManager.cc.

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

Here is the call graph for this function:

G4int G4H2ToolsManager::GetH2Nybins ( G4int  id ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 480 of file G4H2ToolsManager.cc.

{
  auto h2d = GetTInFunction(id, "GetH2NYbins");
  if ( ! h2d ) return 0;
  
  return GetNbins(*h2d, kY);
}  

Here is the call graph for this function:

G4String G4H2ToolsManager::GetH2Title ( G4int  id ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 554 of file G4H2ToolsManager.cc.

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

Here is the call graph for this function:

const std::vector< tools::histo::h2d * > & G4H2ToolsManager::GetH2Vector ( ) const

inline

Definition at line 192 of file G4H2ToolsManager.hh.

{ return fTVector; }

Here is the caller graph for this function:

G4String G4H2ToolsManager::GetH2XAxisTitle ( G4int  id ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 563 of file G4H2ToolsManager.cc.

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

Here is the call graph for this function:

G4double G4H2ToolsManager::GetH2Xmax ( G4int  id ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 462 of file G4H2ToolsManager.cc.

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

Here is the call graph for this function:

G4double G4H2ToolsManager::GetH2Xmin ( G4int  id ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 451 of file G4H2ToolsManager.cc.

{
// Returns xmin value with applied unit and histogram function

  auto h2d = GetTInFunction(id, "GetH2Xmin");
  if ( ! h2d ) return 0.;
  
  return GetMin(*h2d, kX);
}  

Here is the call graph for this function:

G4double G4H2ToolsManager::GetH2XWidth ( G4int  id ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 471 of file G4H2ToolsManager.cc.

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

Here is the call graph for this function:

G4String G4H2ToolsManager::GetH2YAxisTitle ( G4int  id ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 572 of file G4H2ToolsManager.cc.

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

Here is the call graph for this function:

G4double G4H2ToolsManager::GetH2Ymax ( G4int  id ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 500 of file G4H2ToolsManager.cc.

{
  auto h2d = GetTInFunction(id, "GetH2Ymax");
  if ( ! h2d ) return 0.;
  
  return GetMax(*h2d, kY);
}  

Here is the call graph for this function:

G4double G4H2ToolsManager::GetH2Ymin ( G4int  id ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 489 of file G4H2ToolsManager.cc.

{
// Returns xmin value with applied unit and histogram function

  auto h2d = GetTInFunction(id, "GetH2Ymin");
  if ( ! h2d ) return 0.;
  
  return GetMin(*h2d, kY);
}  

Here is the call graph for this function:

G4double G4H2ToolsManager::GetH2YWidth ( G4int  id ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 509 of file G4H2ToolsManager.cc.

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

Here is the call graph for this function:

G4String G4H2ToolsManager::GetH2ZAxisTitle ( G4int  id ) const

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 581 of file G4H2ToolsManager.cc.

{
  auto h2d = GetTInFunction(id, "GetH2ZAxisTitle");
  if ( ! h2d ) return "";
  
  return GetAxisTitle(*h2d, kZ, fHnManager->GetHnType());
}  

Here is the call graph for this function:

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

inlinefinalprotectedvirtual

Implements G4VH2Manager.

Definition at line 198 of file G4H2ToolsManager.hh.

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

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

inline

Definition at line 195 of file G4H2ToolsManager.hh.

{ return fHnManager->GetHnVector(); }

Here is the caller graph for this function:

G4bool G4H2ToolsManager::ScaleH2 ( G4int  id, G4double  factor  )

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 393 of file G4H2ToolsManager.cc.

{
  auto h2d = GetTInFunction(id, "ScaleH2", false, false);
  if ( ! h2d ) return false;

  return h2d->scale(factor);
}  

Here is the call graph for this function:

G4bool G4H2ToolsManager::SetH2 ( G4int  id, G4int  nxbins, G4double  xmin, G4double  xmax, G4int  nybins, G4double  ymin, G4double  ymax, const G4String &  xunitName = "none", const G4String &  yunitName = "none", const G4String &  xfcnName = "none", const G4String &  yfcnName = "none", const G4String &  xbinScheme = "linear", const G4String &  ybinScheme = "linear"  )

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 323 of file G4H2ToolsManager.cc.

{                                
  auto h2d = GetTInFunction(id, "SetH2", false, false);
  if ( ! h2d ) return false;

  auto info = fHnManager->GetHnInformation(id, "SetH2");
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("configure", "H2", info->GetName());
#endif

  // Configure tools h2
  ConfigureToolsH2(
    h2d, nxbins, xmin, xmax, nybins, ymin, ymax, 
    xunitName, yunitName, xfcnName, yfcnName, xbinSchemeName, ybinSchemeName);

  // Add annotation
  AddH2Annotation(h2d, xunitName, yunitName, xfcnName, yfcnName);        
    
  // Update information
  auto xbinScheme = GetBinScheme(xbinSchemeName);
  auto ybinScheme = GetBinScheme(ybinSchemeName);
  UpdateH2Information(
    info, xunitName, yunitName, xfcnName, yfcnName, xbinScheme, ybinScheme);

  // Set activation
  fHnManager->SetActivation(id, true); 
  
  return true;
}

Here is the call graph for this function:

G4bool G4H2ToolsManager::SetH2 ( G4int  id, const std::vector< G4double > &  xedges, const std::vector< G4double > &  yedges, const G4String &  xunitName = "none", const G4String &  yunitName = "none", const G4String &  xfcnName = "none", const G4String &  yfcnName = "none"  )

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 361 of file G4H2ToolsManager.cc.

{                                
  auto h2d = GetTInFunction(id, "SetH2", false, false);
  if ( ! h2d ) return false;

  auto info = fHnManager->GetHnInformation(id, "SetH2");
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("configure", "H2", info->GetName());
#endif

  // Configure tools h2
  ConfigureToolsH2(h2d, xedges, yedges, xunitName, yunitName, xfcnName, yfcnName);

  // Add annotation
  AddH2Annotation(h2d, xunitName, yunitName, xfcnName, yfcnName);        
    
  // Update information
  UpdateH2Information(
    info, xunitName, yunitName, xfcnName, yfcnName, G4BinScheme::kUser, G4BinScheme::kUser);

  // Set activation
  fHnManager->SetActivation(id, true); 
  
  return true;
}

Here is the call graph for this function:

G4bool G4H2ToolsManager::SetH2Title ( G4int  id, const G4String &  title  )

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 518 of file G4H2ToolsManager.cc.

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

Here is the call graph for this function:

G4bool G4H2ToolsManager::SetH2XAxisTitle ( G4int  id, const G4String &  title  )

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 527 of file G4H2ToolsManager.cc.

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

Here is the call graph for this function:

G4bool G4H2ToolsManager::SetH2YAxisTitle ( G4int  id, const G4String &  title  )

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 536 of file G4H2ToolsManager.cc.

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

Here is the call graph for this function:

G4bool G4H2ToolsManager::SetH2ZAxisTitle ( G4int  id, const G4String &  title  )

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 545 of file G4H2ToolsManager.cc.

{
  auto h2d = GetTInFunction(id, "SetH2ZAxisTitle");
  if ( ! h2d ) return false;
  
  return SetAxisTitle(*h2d, kZ, title);
}  

Here is the call graph for this function:

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

finalprotectedvirtual

Implements G4VH2Manager.

Definition at line 590 of file G4H2ToolsManager.cc.

{
// Write selected objects on ASCII file
// According to the implementation by Michel Maire, originally in
// extended examples.
// Not yet available for H2

  return ! fHnManager->IsAscii();
} 

---

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

• source/geant4.10.03.p03/source/analysis/hntools/include/G4H2ToolsManager.hh
• source/geant4.10.03.p03/source/analysis/hntools/src/G4H2ToolsManager.cc