G4P1ToolsManager Class Reference

#include <G4P1ToolsManager.hh>

Inheritance diagram for G4P1ToolsManager:

Collaboration 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

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
Protected Member Functions inherited from G4THnManager< tools::histo::p1d >
void	AddTVector (const std::vector< tools::histo::p1d * > &tVector)
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

Private Member Functions
void	AddP1Information (const G4String &name, const G4String &xunitName, const G4String &yunitName, const G4String &xfcnName, const G4String &yfcnName, G4BinScheme xbinScheme) const

Static Private Attributes
static const G4int	kDimension = 1

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 53 of file G4P1ToolsManager.hh.

Constructor & Destructor Documentation

G4P1ToolsManager()

G4P1ToolsManager::G4P1ToolsManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 49 of file G4P1ToolsManager.cc.

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

~G4P1ToolsManager()

G4P1ToolsManager::~G4P1ToolsManager ( )

virtual

Definition at line 55 of file G4P1ToolsManager.cc.

{}

Here is the call graph for this function:

Member Function Documentation

AddP1()

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

Definition at line 536 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;
}  

Here is the call graph for this function:

Here is the caller graph for this function:

AddP1Information()

void G4P1ToolsManager::AddP1Information ( const G4String &  name, const G4String &  xunitName, const G4String &  yunitName, const G4String &  xfcnName, const G4String &  yfcnName, G4BinScheme  xbinScheme  ) const

private

Definition at line 215 of file G4P1ToolsManager.cc.

{
  auto hnInformation = fHnManager->AddHnInformation(name, 2);
  hnInformation->AddDimension(xunitName, xfcnName, xbinScheme);
  hnInformation->AddDimension(yunitName, yfcnName, G4BinScheme::kLinear);
}  

Here is the caller graph for this function:

AddP1Vector()

void G4P1ToolsManager::AddP1Vector

(

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

p1Vector

)

Definition at line 559 of file G4P1ToolsManager.cc.

{
  AddTVector(p1Vector);
}  

Here is the call graph for this function:

Here is the caller graph for this function:

BeginConstP1()

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

inline

Definition at line 179 of file G4P1ToolsManager.hh.

{ return BeginConstT(); }

BeginP1()

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

inline

Definition at line 172 of file G4P1ToolsManager.hh.

{ return BeginT(); }

CreateP1() [1/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 232 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;
}                                         

Here is the call graph for this function:

CreateP1() [2/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 267 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;
}                                         

Here is the call graph for this function:

EndConstP1()

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

inline

Definition at line 183 of file G4P1ToolsManager.hh.

{ return EndConstT(); }

EndP1()

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

inline

Definition at line 175 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 378 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;
}

Here is the call graph for this function:

GetHnManager()

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

inlinefinalprotectedvirtual

Implements G4VP1Manager.

Definition at line 192 of file G4P1ToolsManager.hh.

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

GetHnVector()

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

inline

Definition at line 189 of file G4P1ToolsManager.hh.

{ return fHnManager->GetHnVector(); }

Here is the caller graph for this function:

GetP1()

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

Definition at line 566 of file G4P1ToolsManager.cc.

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

Here is the call graph for this function:

GetP1Id()

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

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 413 of file G4P1ToolsManager.cc.

{
  return GetTId(name, warn);
}  

Here is the call graph for this function:

GetP1Nbins()

G4int G4P1ToolsManager::GetP1Nbins ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 419 of file G4P1ToolsManager.cc.

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

Here is the call graph for this function:

GetP1Title()

G4String G4P1ToolsManager::GetP1Title ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 504 of file G4P1ToolsManager.cc.

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

Here is the call graph for this function:

GetP1Vector()

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

inline

Definition at line 186 of file G4P1ToolsManager.hh.

{ return fTVector; }

Here is the caller graph for this function:

GetP1XAxisTitle()

G4String G4P1ToolsManager::GetP1XAxisTitle ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 514 of file G4P1ToolsManager.cc.

{
  auto p1d = GetTInFunction(id, "GetP1XAxisTitle");
  if ( ! p1d ) return "";

  return GetAxisTitle(*p1d, kX, fHnManager->GetHnType());
}  

Here is the call graph for this function:

GetP1Xmax()

G4double G4P1ToolsManager::GetP1Xmax ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 439 of file G4P1ToolsManager.cc.

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

Here is the call graph for this function:

GetP1Xmin()

G4double G4P1ToolsManager::GetP1Xmin ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 428 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);
}  

Here is the call graph for this function:

GetP1XWidth()

G4double G4P1ToolsManager::GetP1XWidth ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 448 of file G4P1ToolsManager.cc.

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

Here is the call graph for this function:

GetP1YAxisTitle()

G4String G4P1ToolsManager::GetP1YAxisTitle ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 523 of file G4P1ToolsManager.cc.

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

Here is the call graph for this function:

GetP1Ymax()

G4double G4P1ToolsManager::GetP1Ymax ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 468 of file G4P1ToolsManager.cc.

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

Here is the call graph for this function:

GetP1Ymin()

G4double G4P1ToolsManager::GetP1Ymin ( G4int  id ) const

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 457 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();
}  

Here is the call graph for this function:

ScaleP1()

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

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 369 of file G4P1ToolsManager.cc.

{
  auto p1d = GetTInFunction(id, "ScaleP1", false, false);
  if ( ! p1d ) return false;

  return p1d->scale(factor);
}  

Here is the call graph for this function:

SetP1() [1/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 299 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;
}

Here is the call graph for this function:

SetP1() [2/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 335 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;
}

Here is the call graph for this function:

SetP1Title()

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

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 477 of file G4P1ToolsManager.cc.

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

Here is the call graph for this function:

SetP1XAxisTitle()

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

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 486 of file G4P1ToolsManager.cc.

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

Here is the call graph for this function:

SetP1YAxisTitle()

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

finalprotectedvirtual

Implements G4VP1Manager.

Definition at line 495 of file G4P1ToolsManager.cc.

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

Here is the call graph for this function:

Member Data Documentation

kDimension

const G4int G4P1ToolsManager::kDimension = 1

staticprivate

Definition at line 167 of file G4P1ToolsManager.hh.

---

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

• G4P1ToolsManager.hh
• G4P1ToolsManager.cc