G4P1ToolsManager Class Reference

#include <G4P1ToolsManager.hh>

Inheritance diagram for G4P1ToolsManager:

Public Member Functions
	G4P1ToolsManager (const G4AnalysisManagerState &state)
virtual	~G4P1ToolsManager ()
G4int	AddP1 (const G4String &name, tools::histo::p1d *p1d)
void	AddP1Vector (const std::vector< tools::histo::p1d * > &p1Vector)
tools::histo::p1d *	GetP1 (G4int id, G4bool warn=true, G4bool onlyIfActive=true) const
std::vector< tools::histo::p1d * >::iterator	BeginP1 ()
std::vector< tools::histo::p1d * >::iterator	EndP1 ()
std::vector< tools::histo::p1d * >::const_iterator	BeginConstP1 () const
std::vector< tools::histo::p1d * >::const_iterator	EndConstP1 () const
const std::vector< tools::histo::p1d * > &	GetP1Vector () const
const std::vector< G4HnInformation * > &	GetHnVector () const
Public Member Functions inherited from G4VP1Manager
	G4VP1Manager ()
virtual	~G4VP1Manager ()
	G4VP1Manager (const G4VP1Manager &rhs)=delete
G4VP1Manager &	operator= (const G4VP1Manager &rhs)=delete
Public Member Functions inherited from G4THnManager< tools::histo::p1d >
	G4THnManager (const G4AnalysisManagerState &state, const G4String &hnType)
virtual	~G4THnManager ()
G4bool	Reset ()
G4bool	IsEmpty () const
void	AddTVector (const std::vector< tools::histo::p1d * > &tVector)
void	Merge (G4Mutex &mergeMutex, G4THnManager< tools::histo::p1d > *masterInstance)

Protected Member Functions
virtual G4int	CreateP1 (const G4String &name, const G4String &title, G4int nbins, G4double xmin, G4double xmax, G4double ymin=0, G4double ymax=0, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none", const G4String &xbinScheme="linear") final
virtual G4int	CreateP1 (const G4String &name, const G4String &title, const std::vector< G4double > &edges, G4double ymin=0, G4double ymax=0, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none") final
virtual G4bool	SetP1 (G4int id, G4int nbins, G4double xmin, G4double xmax, G4double ymin=0, G4double ymax=0, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none", const G4String &xbinScheme="linear") final
virtual G4bool	SetP1 (G4int id, const std::vector< G4double > &edges, G4double ymin=0, G4double ymax=0, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none") final
virtual G4bool	ScaleP1 (G4int id, G4double factor) final
virtual G4bool	FillP1 (G4int id, G4double xvalue, G4double yvalue, G4double weight=1.0) final
virtual G4int	GetP1Id (const G4String &name, G4bool warn=true) const final
virtual G4int	GetP1Nbins (G4int id) const final
virtual G4double	GetP1Xmin (G4int id) const final
virtual G4double	GetP1Xmax (G4int id) const final
virtual G4double	GetP1XWidth (G4int id) const final
virtual G4double	GetP1Ymin (G4int id) const final
virtual G4double	GetP1Ymax (G4int id) const final
virtual G4bool	SetP1Title (G4int id, const G4String &title) final
virtual G4bool	SetP1XAxisTitle (G4int id, const G4String &title) final
virtual G4bool	SetP1YAxisTitle (G4int id, const G4String &title) final
virtual G4String	GetP1Title (G4int id) const final
virtual G4String	GetP1XAxisTitle (G4int id) const final
virtual G4String	GetP1YAxisTitle (G4int id) const final
virtual std::shared_ptr< G4HnManager >	GetHnManager () final
virtual G4int	CreateP1 (const G4String &name, const G4String &title, G4int nbins, G4double xmin, G4double xmax, G4double ymin=0, G4double ymax=0, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none", const G4String &xbinScheme="linear")=0
virtual G4int	CreateP1 (const G4String &name, const G4String &title, const std::vector< G4double > &edges, G4double ymin=0, G4double ymax=0, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none")=0
virtual G4bool	SetP1 (G4int id, G4int nbins, G4double xmin, G4double xmax, G4double ymin=0, G4double ymax=0, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none", const G4String &xbinScheme="linear")=0
virtual G4bool	SetP1 (G4int id, const std::vector< G4double > &edges, G4double ymin=0, G4double ymax=0, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none")=0
virtual G4bool	ScaleP1 (G4int id, G4double factor)=0
virtual G4bool	FillP1 (G4int id, G4double xvalue, G4double yvalue, G4double weight=1.0)=0
virtual G4int	GetP1Id (const G4String &name, G4bool warn=true) const =0
virtual G4int	GetP1Nbins (G4int id) const =0
virtual G4double	GetP1Xmin (G4int id) const =0
virtual G4double	GetP1Xmax (G4int id) const =0
virtual G4double	GetP1XWidth (G4int id) const =0
virtual G4double	GetP1Ymin (G4int id) const =0
virtual G4double	GetP1Ymax (G4int id) const =0
virtual G4bool	SetP1Title (G4int id, const G4String &title)=0
virtual G4bool	SetP1XAxisTitle (G4int id, const G4String &title)=0
virtual G4bool	SetP1YAxisTitle (G4int id, const G4String &title)=0
virtual G4String	GetP1Title (G4int id) const =0
virtual G4String	GetP1XAxisTitle (G4int id) const =0
virtual G4String	GetP1YAxisTitle (G4int id) const =0
virtual std::shared_ptr< G4HnManager >	GetHnManager ()=0
Protected Member Functions inherited from G4THnManager< tools::histo::p1d >
std::vector< tools::histo::p1d * >::iterator	BeginT ()
std::vector< tools::histo::p1d * >::iterator	EndT ()
std::vector< tools::histo::p1d * >::const_iterator	BeginConstT () const
std::vector< tools::histo::p1d * >::const_iterator	EndConstT () const
tools::histo::p1d *	GetTInFunction (G4int id, G4String functionName, G4bool warn=true, G4bool onlyIfActive=true) const
G4int	RegisterT (tools::histo::p1d *t, const G4String &name)
G4int	GetTId (const G4String &name, G4bool warn=true) const

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

Detailed Description

Definition at line 52 of file G4P1ToolsManager.hh.

Constructor & Destructor Documentation

G4P1ToolsManager()

G4P1ToolsManager::G4P1ToolsManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 48 of file G4P1ToolsManager.cc.

 : G4VP1Manager(),
   G4THnManager<tools::histo::p1d>(state, "P1")
{}

~G4P1ToolsManager()

G4P1ToolsManager::~G4P1ToolsManager ( )

virtual

Definition at line 54 of file G4P1ToolsManager.cc.

{}

Member Function Documentation

AddP1()

G4int G4P1ToolsManager::AddP1	(	const G4String &	name,
		tools::histo::p1d *	p1d
	)

Definition at line 557 of file G4P1ToolsManager.cc.

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("add", "P1", name);
#endif
    
  // Add annotation
  AddP1Annotation(p1d, "none", "none", "none", "none");        
  // Add information
  AddP1Information(name, "none", "none", "none", "none", G4BinScheme::kLinear);
    
  // Register profile 
  auto id = RegisterT(p1d, name); 
  
#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) 
    fState.GetVerboseL2()->Message("add", "P1", name);
#endif
  return id;
}  

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

AddP1Vector()

void G4P1ToolsManager::AddP1Vector

(

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

p1Vector

)

Definition at line 580 of file G4P1ToolsManager.cc.

{
  AddTVector(p1Vector);
}  

BeginConstP1()

std::vector< tools::histo::p1d * >::const_iterator G4P1ToolsManager::BeginConstP1 ( ) const

inline

Definition at line 178 of file G4P1ToolsManager.hh.

{ return BeginConstT(); }

BeginP1()

std::vector< tools::histo::p1d * >::iterator G4P1ToolsManager::BeginP1 ( )

inline

Definition at line 171 of file G4P1ToolsManager.hh.

{ return BeginT(); }

CreateP1() [1/2]

G4int G4P1ToolsManager::CreateP1 ( const G4String &  name, const G4String &  title, const std::vector< G4double > &  edges, G4double  ymin = 0, G4double  ymax = 0, const G4String &  xunitName = "none", const G4String &  yunitName = "none", const G4String &  xfcnName = "none", const G4String &  yfcnName = "none"  )

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 288 of file G4P1ToolsManager.cc.

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("create", "P1", name);
#endif
  tools::histo::p1d* p1d 
    = CreateToolsP1(title, edges, ymin, ymax, 
                    xunitName, yunitName, xfcnName, yfcnName);
    
  // Add annotation
  AddP1Annotation(p1d, xunitName, yunitName, xfcnName, yfcnName);        
    
  // Save P1 information
  AddP1Information(
    name, xunitName, yunitName, xfcnName, yfcnName, G4BinScheme::kUser);
    
  // Register profile 
  G4int id = RegisterT(p1d, name); 
  
#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) 
    fState.GetVerboseL2()->Message("create", "P1", name);
#endif
  return id;
}                                         

CreateP1() [2/2]

G4int G4P1ToolsManager::CreateP1 ( const G4String &  name, const G4String &  title, G4int  nbins, G4double  xmin, G4double  xmax, G4double  ymin = 0, G4double  ymax = 0, const G4String &  xunitName = "none", const G4String &  yunitName = "none", const G4String &  xfcnName = "none", const G4String &  yfcnName = "none", const G4String &  xbinScheme = "linear"  )

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 253 of file G4P1ToolsManager.cc.

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("create", "P1", name);
#endif
  tools::histo::p1d* p1d
    = CreateToolsP1(title, nbins, xmin, xmax, ymin, ymax, 
                    xunitName, yunitName, xfcnName, yfcnName, 
                    xbinSchemeName);
    
  // Add annotation
  AddP1Annotation(p1d, xunitName, yunitName, xfcnName, yfcnName);        
    
  // Save P1 information
  auto xbinScheme = GetBinScheme(xbinSchemeName);
  AddP1Information(
    name, xunitName, yunitName, xfcnName, yfcnName, xbinScheme);
    
  // Register profile 
  G4int id = RegisterT(p1d, name); 
  
#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) 
    fState.GetVerboseL2()->Message("create", "P1", name);
#endif
  return id;
}                                         

EndConstP1()

std::vector< tools::histo::p1d * >::const_iterator G4P1ToolsManager::EndConstP1 ( ) const

inline

Definition at line 182 of file G4P1ToolsManager.hh.

{ return EndConstT(); }

EndP1()

std::vector< tools::histo::p1d * >::iterator G4P1ToolsManager::EndP1 ( )

inline

Definition at line 174 of file G4P1ToolsManager.hh.

{ return EndT(); }

FillP1()

G4bool G4P1ToolsManager::FillP1 ( G4int  id, G4double  xvalue, G4double  yvalue, G4double  weight = 1.0  )

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 399 of file G4P1ToolsManager.cc.

{
  auto p1d = GetTInFunction(id, "FillP1", true, false);
  if ( ! p1d ) return false;
 
  if ( fState.GetIsActivation() && ( ! fHnManager->GetActivation(id) ) ) {
    //G4cout << "Skipping FillP1 for " << id << G4endl; 
    return false; 
  }  
 
  auto xInfo 
    = fHnManager->GetHnDimensionInformation(id, kX, "FillP1");
  auto yInfo 
    = fHnManager->GetHnDimensionInformation(id, kY, "FillP1");
 
  p1d->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", "P1", description);
  }  
#endif
  return true;
}

GetHnManager()

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

inlinefinalprotectedvirtual

Implements G4VP1Manager.

Definition at line 191 of file G4P1ToolsManager.hh.

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

GetHnVector()

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

inline

Definition at line 188 of file G4P1ToolsManager.hh.

{ return fHnManager->GetHnVector(); }

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

GetP1()

tools::histo::p1d * G4P1ToolsManager::GetP1	(	G4int	id,
		G4bool	warn = true,
		G4bool	onlyIfActive = true
	)		const

Definition at line 587 of file G4P1ToolsManager.cc.

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

GetP1Id()

G4int G4P1ToolsManager::GetP1Id ( const G4String &  name, G4bool  warn = true  ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 434 of file G4P1ToolsManager.cc.

{
  return GetTId(name, warn);
}  

GetP1Nbins()

G4int G4P1ToolsManager::GetP1Nbins ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 440 of file G4P1ToolsManager.cc.

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

GetP1Title()

G4String G4P1ToolsManager::GetP1Title ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 525 of file G4P1ToolsManager.cc.

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

GetP1Vector()

const std::vector< tools::histo::p1d * > & G4P1ToolsManager::GetP1Vector ( ) const

inline

Definition at line 185 of file G4P1ToolsManager.hh.

{ return fTVector; }

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

GetP1XAxisTitle()

G4String G4P1ToolsManager::GetP1XAxisTitle ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 535 of file G4P1ToolsManager.cc.

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

GetP1Xmax()

G4double G4P1ToolsManager::GetP1Xmax ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 460 of file G4P1ToolsManager.cc.

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

GetP1Xmin()

G4double G4P1ToolsManager::GetP1Xmin ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 449 of file G4P1ToolsManager.cc.

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

GetP1XWidth()

G4double G4P1ToolsManager::GetP1XWidth ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 469 of file G4P1ToolsManager.cc.

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

GetP1YAxisTitle()

G4String G4P1ToolsManager::GetP1YAxisTitle ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 544 of file G4P1ToolsManager.cc.

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

GetP1Ymax()

G4double G4P1ToolsManager::GetP1Ymax ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 489 of file G4P1ToolsManager.cc.

{
  auto p1d = GetTInFunction(id, "GetP1Ymax");
  if ( ! p1d ) return 0.;
  
  return p1d->max_v();
}  

GetP1Ymin()

G4double G4P1ToolsManager::GetP1Ymin ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 478 of file G4P1ToolsManager.cc.

{
// Returns xmin value with applied unit and profile function
 
  auto p1d = GetTInFunction(id, "GetP1Ymin");
  if ( ! p1d ) return 0.;
  
  return p1d->min_v();
}  

ScaleP1()

G4bool G4P1ToolsManager::ScaleP1 ( G4int  id, G4double  factor  )

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 390 of file G4P1ToolsManager.cc.

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

SetP1() [1/2]

G4bool G4P1ToolsManager::SetP1 ( G4int  id, const std::vector< G4double > &  edges, G4double  ymin = 0, G4double  ymax = 0, const G4String &  xunitName = "none", const G4String &  yunitName = "none", const G4String &  xfcnName = "none", const G4String &  yfcnName = "none"  )

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 356 of file G4P1ToolsManager.cc.

{
  auto p1d = GetTInFunction(id, "SetP1", false, false);
  if ( ! p1d ) return false;
 
  auto info = fHnManager->GetHnInformation(id,"SetP1");
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("configure", "P1", info->GetName());
#endif
 
  // Configure tools p1
  ConfigureToolsP1(p1d, edges, ymin, ymax, 
                   xunitName, yunitName, xfcnName, yfcnName);
      
  // Add annotation
  AddP1Annotation(p1d, xunitName, yunitName, xfcnName, yfcnName);        
 
  // Update information 
  UpdateP1Information(
    info, xunitName, yunitName, xfcnName, yfcnName, G4BinScheme::kUser);
 
  // Set activation
  fHnManager->SetActivation(id, true); 
  
  return true;
}

SetP1() [2/2]

G4bool G4P1ToolsManager::SetP1 ( G4int  id, G4int  nbins, G4double  xmin, G4double  xmax, G4double  ymin = 0, G4double  ymax = 0, const G4String &  xunitName = "none", const G4String &  yunitName = "none", const G4String &  xfcnName = "none", const G4String &  yfcnName = "none", const G4String &  xbinScheme = "linear"  )

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 320 of file G4P1ToolsManager.cc.

{                                
  auto p1d = GetTInFunction(id, "SetP1", false, false);
  if ( ! p1d ) return false;
 
  auto info = fHnManager->GetHnInformation(id,"SetP1");
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("configure", "P1", info->GetName());
#endif
 
  // Configure tools p1
  ConfigureToolsP1(
    p1d, nbins, xmin, xmax, ymin, ymax, 
    xunitName, yunitName, xfcnName, yfcnName, xbinSchemeName);
 
  // Add annotation
  AddP1Annotation(p1d, xunitName, yunitName, xfcnName, yfcnName);        
    
  // Update information
  auto xbinScheme = GetBinScheme(xbinSchemeName);
  UpdateP1Information(
    info, xunitName, yunitName, xfcnName, yfcnName, xbinScheme);
 
  // Set activation
  fHnManager->SetActivation(id, true); 
  
  return true;
}

SetP1Title()

G4bool G4P1ToolsManager::SetP1Title ( G4int  id, const G4String &  title  )

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 498 of file G4P1ToolsManager.cc.

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

SetP1XAxisTitle()

G4bool G4P1ToolsManager::SetP1XAxisTitle ( G4int  id, const G4String &  title  )

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 507 of file G4P1ToolsManager.cc.

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

SetP1YAxisTitle()

G4bool G4P1ToolsManager::SetP1YAxisTitle ( G4int  id, const G4String &  title  )

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 516 of file G4P1ToolsManager.cc.

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

---

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

• G4P1ToolsManager.hh
• G4P1ToolsManager.cc