ExG4HbookBaseHnManager Class Reference

#include <ExG4HbookBaseHnManager.hh>

Collaboration diagram for ExG4HbookBaseHnManager:

Public Member Functions
	ExG4HbookBaseHnManager (const G4String &hnType)
virtual	~ExG4HbookBaseHnManager ()

Protected Types
typedef tools::hbook::base_histo	G4HbookBaseHisto

Protected Member Functions
G4int	GetNbins (const tools::hbook::axis &axis) const
G4double	GetMin (const tools::hbook::axis &axis) const
G4double	GetMax (const tools::hbook::axis &axis) const
G4double	GetWidth (const tools::hbook::axis &axis) const
G4bool	SetAxisTitle (G4HbookBaseHisto &baseHisto, G4int dimension, const G4String &title)
G4String	GetAxisTitle (const G4HbookBaseHisto &baseHisto, G4int dimension) const

Static Protected Attributes
static const G4int	kX = 0
static const G4int	kY = 1
static const G4int	kZ = 2

Private Attributes
G4String	fHnType

Friends
class	ExG4HbookH1Manager
class	ExG4HbookH2Manager
class	ExG4HbookP1Manager

Detailed Description

Manager class for tools::hbook::base_histo functions.

It implements functions common to all hbook histograms and profiles.

Definition at line 45 of file ExG4HbookBaseHnManager.hh.

Member Typedef Documentation

G4HbookBaseHisto

typedef tools::hbook::base_histo ExG4HbookBaseHnManager::G4HbookBaseHisto

protected

Definition at line 56 of file ExG4HbookBaseHnManager.hh.

Constructor & Destructor Documentation

ExG4HbookBaseHnManager()

ExG4HbookBaseHnManager::ExG4HbookBaseHnManager

(

const G4String &

hnType

)

Definition at line 46 of file ExG4HbookBaseHnManager.cc.

 : fHnType(hnType)
{
}

~ExG4HbookBaseHnManager()

ExG4HbookBaseHnManager::~ExG4HbookBaseHnManager ( )

virtual

Definition at line 52 of file ExG4HbookBaseHnManager.cc.

{  
}

Member Function Documentation

GetAxisTitle()

G4String ExG4HbookBaseHnManager::GetAxisTitle ( const G4HbookBaseHisto &  baseHisto, G4int  dimension  ) const

protected

Definition at line 130 of file ExG4HbookBaseHnManager.cc.

{
  G4String title;
  G4bool result = false;
  if ( dimension == 0 ) {
    result = baseHisto.annotation(tools::hbook::key_axis_x_title(), title);
  }  
  else if ( dimension == 1 ) {  
    result = baseHisto.annotation(tools::hbook::key_axis_y_title(), title);
  }
  else if ( dimension == 2 ) {  
    result = baseHisto.annotation(tools::hbook::key_axis_z_title(), title);
  }

  if ( ! result ) {
    G4String axes("xyz");
    G4String axis = axes(dimension, 1);
    G4String functionName = "ExG4HbookBaseHnManager::Get";
    functionName += fHnType;
    functionName += axis;
    functionName += "Title";
    G4ExceptionDescription description;
    description << "    Failed to get " << axis << " axis " << fHnType << " title.";
    G4Exception(functionName, "Analysis_W014", JustWarning, description);
    return "";
  }
  
  return title;              
}  

Here is the call graph for this function:

GetMax()

G4double ExG4HbookBaseHnManager::GetMax ( const tools::hbook::axis &  axis ) const

protected

Definition at line 71 of file ExG4HbookBaseHnManager.cc.

{
// Returns max data value

  return axis.upper_edge();
}  

GetMin()

G4double ExG4HbookBaseHnManager::GetMin ( const tools::hbook::axis &  axis ) const

protected

Definition at line 63 of file ExG4HbookBaseHnManager.cc.

{
// Returns min data value

  return axis.lower_edge();
}  

GetNbins()

G4int ExG4HbookBaseHnManager::GetNbins ( const tools::hbook::axis &  axis ) const

protected

Definition at line 57 of file ExG4HbookBaseHnManager.cc.

{
  return axis.bins();
}  

GetWidth()

G4double ExG4HbookBaseHnManager::GetWidth ( const tools::hbook::axis &  axis ) const

protected

Definition at line 79 of file ExG4HbookBaseHnManager.cc.

{
  G4int nbins = axis.bins();
  if ( ! nbins ) {
    G4String functionName = "ExG4HbookBaseHnManager::Get";
    functionName += fHnType;
    functionName += "Width";
    G4ExceptionDescription description;
    description << "    nbins = 0 (for " << fHnType << ").";
    G4Exception(functionName, "Analysis_W014", JustWarning, description);
    return 0;
  }              
  
  return ( axis.upper_edge() - axis.lower_edge() )/nbins;
}  

Here is the call graph for this function:

SetAxisTitle()

G4bool ExG4HbookBaseHnManager::SetAxisTitle ( G4HbookBaseHisto &  baseHisto, G4int  dimension, const G4String &  title  )

protected

Definition at line 104 of file ExG4HbookBaseHnManager.cc.

{
  if ( title == "" ) return false;

  if ( dimension == 0 ) {
    baseHisto.add_annotation(tools::hbook::key_axis_x_title(), title);
  }
  else if ( dimension == 1 ) {  
    baseHisto.add_annotation(tools::hbook::key_axis_y_title(), title);
  }
  else if ( dimension == 2 ) {  
    baseHisto.add_annotation(tools::hbook::key_axis_z_title(), title);
  }
  
  return true;
}  

Friends And Related Function Documentation

ExG4HbookH1Manager

friend class ExG4HbookH1Manager

friend

Definition at line 51 of file ExG4HbookBaseHnManager.hh.

ExG4HbookH2Manager

friend class ExG4HbookH2Manager

friend

Definition at line 52 of file ExG4HbookBaseHnManager.hh.

ExG4HbookP1Manager

friend class ExG4HbookP1Manager

friend

Definition at line 53 of file ExG4HbookBaseHnManager.hh.

Member Data Documentation

fHnType

G4String ExG4HbookBaseHnManager::fHnType

private

Definition at line 82 of file ExG4HbookBaseHnManager.hh.

kX

const G4int ExG4HbookBaseHnManager::kX = 0

staticprotected

Definition at line 76 of file ExG4HbookBaseHnManager.hh.

kY

const G4int ExG4HbookBaseHnManager::kY = 1

staticprotected

Definition at line 77 of file ExG4HbookBaseHnManager.hh.

kZ

const G4int ExG4HbookBaseHnManager::kZ = 2

staticprotected

Definition at line 78 of file ExG4HbookBaseHnManager.hh.

---

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

• ExG4HbookBaseHnManager.hh
• ExG4HbookBaseHnManager.cc