G4THnToolsManager< DIM, HT > Class Template Reference

#include <G4THnToolsManager.hh>

Inheritance diagram for G4THnToolsManager< DIM, HT >:

Public Member Functions
	G4THnToolsManager (const G4AnalysisManagerState &state)
virtual	~G4THnToolsManager ()=default
	G4THnToolsManager (const G4THnToolsManager &rhs)=delete
G4THnToolsManager &	operator= (const G4THnToolsManager &rhs)=delete
G4int	Create (const G4String &name, const G4String &title, const std::array< G4HnDimension, DIM > &bins, const std::array< G4HnDimensionInformation, DIM > &hnInfo) override
G4bool	Set (G4int id, const std::array< G4HnDimension, DIM > &bins, const std::array< G4HnDimensionInformation, DIM > &hnInfo) override
virtual G4bool	Scale (G4int id, G4double factor) override
virtual G4int	GetNofHns (G4bool onlyIfExist) const override
virtual G4bool	Fill (G4int id, std::array< G4double, DIM > value, G4double weight=1.0) override
virtual G4int	GetId (const G4String &name, G4bool warn=true) const override
virtual G4int	GetNbins (unsigned int idim, G4int id) const override
virtual G4double	GetMinValue (unsigned int idim, G4int id) const override
virtual G4double	GetMaxValue (unsigned int idim, G4int id) const override
virtual G4double	GetWidth (unsigned int idim, G4int id) const override
virtual G4bool	SetTitle (G4int id, const G4String &title) override
virtual G4bool	SetAxisTitle (unsigned int idim, G4int id, const G4String &title) override
virtual G4String	GetTitle (G4int id) const override
virtual G4String	GetAxisTitle (unsigned int idim, G4int id) const override
virtual G4bool	WriteOnAscii (std::ofstream &output) override
virtual G4bool	List (std::ostream &output, G4bool onlyIfActive=true) override
virtual G4bool	Delete (G4int id, G4bool keepSetting) override
virtual std::shared_ptr< G4HnManager >	GetHnManager () override
virtual const std::shared_ptr< G4HnManager >	GetHnManager () const override
G4bool	WriteOnAscii (std::ofstream &output)
G4bool	WriteOnAscii (std::ofstream &output)
G4bool	WriteOnAscii (std::ofstream &output)
G4bool	WriteOnAscii (std::ofstream &output)
G4bool	WriteOnAscii (std::ofstream &output)
G4bool	WriteOnAscii (std::ofstream &output)
G4bool	WriteOnAscii (std::ofstream &output)
G4bool	WriteOnAscii (std::ofstream &output)
G4bool	WriteOnAscii (std::ofstream &output)
G4bool	WriteOnAscii (std::ofstream &output)
Public Member Functions inherited from G4VTBaseHnManager< DIM >
	G4VTBaseHnManager ()=default
virtual	~G4VTBaseHnManager ()=default
	G4VTBaseHnManager (const G4VTBaseHnManager &rhs)=delete
G4VTBaseHnManager &	operator= (const G4VTBaseHnManager &rhs)=delete
Public Member Functions inherited from G4THnManager< HT >
	G4THnManager (const G4AnalysisManagerState &state)
	G4THnManager ()=delete
virtual	~G4THnManager ()
G4int	RegisterT (const G4String &name, HT *ht, G4HnInformation *info=nullptr)
G4bool	Reset ()
void	ClearData ()
G4bool	DeleteT (G4int id, G4bool keepSetting)
G4bool	IsEmpty () const
void	AddTVector (const std::vector< HT * > &tVector)
void	Merge (G4Mutex &mergeMutex, G4THnManager< HT > *masterInstance)
HT *	GetT (G4int id, G4bool warn=true, G4bool onlyIfActive=true) const
std::vector< HT * > *	GetTVector ()
const std::vector< HT * > &	GetTVectorRef () const
std::vector< std::pair< HT *, G4HnInformation * > > *	GetTHnVector ()
const std::vector< std::pair< HT *, G4HnInformation * > > &	GetTHnVectorRef () const
G4int	GetNofHns (G4bool onlyIfExist) const
G4bool	List (std::ostream &output, G4bool onlyIfActive) const
std::vector< HT * >::iterator	BeginT ()
std::vector< HT * >::iterator	EndT ()
std::vector< HT * >::const_iterator	BeginConstT () const
std::vector< HT * >::const_iterator	EndConstT () const

Static Protected Attributes
static constexpr std::string_view	fkClass { "G4THnToolsManager" }
Static Protected Attributes inherited from G4THnManager< HT >
static constexpr std::string_view	fkClass { "G4THnManager<T>" }

Friends
class	G4VAnalysisManager
class	G4VAnalysisReader

Additional Inherited Members
Protected Member Functions inherited from G4THnManager< HT >
std::pair< HT *, G4HnInformation * >	GetTHnInFunction (G4int id, std::string_view functionName, G4bool warn=true, G4bool onlyIfActive=true) const
HT *	GetTInFunction (G4int id, std::string_view functionName, G4bool warn=true, G4bool onlyIfActive=true) const
G4int	GetTId (const G4String &name, G4bool warn=true) const
G4bool	IsVerbose (G4int verboseLevel) const
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
Protected Attributes inherited from G4THnManager< HT >
const G4AnalysisManagerState &	fState
std::vector< HT * >	fTVector
std::vector< std::pair< HT *, G4HnInformation * > >	fTHnVector
std::set< G4int >	fFreeIds
std::map< G4String, G4int >	fNameIdMap
std::shared_ptr< G4HnManager >	fHnManager { nullptr }

Detailed Description

template<unsigned int DIM, typename HT>
class G4THnToolsManager< DIM, HT >

Definition at line 48 of file G4THnToolsManager.hh.

Constructor & Destructor Documentation

G4THnToolsManager() [1/2]

template<unsigned int DIM, typename HT >

G4THnToolsManager< DIM, HT >::G4THnToolsManager

(

const G4AnalysisManagerState &

state

)

~G4THnToolsManager()

template<unsigned int DIM, typename HT >

virtual G4THnToolsManager< DIM, HT >::~G4THnToolsManager ( )

virtualdefault

G4THnToolsManager() [2/2]

template<unsigned int DIM, typename HT >

G4THnToolsManager< DIM, HT >::G4THnToolsManager ( const G4THnToolsManager< DIM, HT > & rhs )

delete

Member Function Documentation

Create()

template<unsigned int DIM, typename HT >

G4int G4THnToolsManager< DIM, HT >::Create ( const G4String & name, const G4String & title, const std::array< G4HnDimension, DIM > & bins, const std::array< G4HnDimensionInformation, DIM > & hnInfo )

overridevirtual

Implements G4VTBaseHnManager< DIM >.

Delete()

template<unsigned int DIM, typename HT >

virtual G4bool G4THnToolsManager< DIM, HT >::Delete ( G4int id, G4bool keepSetting )

overridevirtual

Implements G4VTBaseHnManager< DIM >.

Fill()

template<unsigned int DIM, typename HT >

virtual G4bool G4THnToolsManager< DIM, HT >::Fill ( G4int id, std::array< G4double, DIM > value, G4double weight = 1.0 )

overridevirtual

Implements G4VTBaseHnManager< DIM >.

GetAxisTitle()

template<unsigned int DIM, typename HT >

virtual G4String G4THnToolsManager< DIM, HT >::GetAxisTitle ( unsigned int idim, G4int id ) const

overridevirtual

Implements G4VTBaseHnManager< DIM >.

GetHnManager() [1/2]

template<unsigned int DIM, typename HT >

virtual const std::shared_ptr< G4HnManager > G4THnToolsManager< DIM, HT >::GetHnManager ( ) const

overridevirtual

Implements G4VTBaseHnManager< DIM >.

GetHnManager() [2/2]

template<unsigned int DIM, typename HT >

virtual std::shared_ptr< G4HnManager > G4THnToolsManager< DIM, HT >::GetHnManager ( )

overridevirtual

Implements G4VTBaseHnManager< DIM >.

GetId()

template<unsigned int DIM, typename HT >

virtual G4int G4THnToolsManager< DIM, HT >::GetId ( const G4String & name, G4bool warn = true ) const

overridevirtual

Implements G4VTBaseHnManager< DIM >.

GetMaxValue()

template<unsigned int DIM, typename HT >

virtual G4double G4THnToolsManager< DIM, HT >::GetMaxValue ( unsigned int idim, G4int id ) const

overridevirtual

Implements G4VTBaseHnManager< DIM >.

GetMinValue()

template<unsigned int DIM, typename HT >

virtual G4double G4THnToolsManager< DIM, HT >::GetMinValue ( unsigned int idim, G4int id ) const

overridevirtual

Implements G4VTBaseHnManager< DIM >.

GetNbins()

template<unsigned int DIM, typename HT >

virtual G4int G4THnToolsManager< DIM, HT >::GetNbins ( unsigned int idim, G4int id ) const

overridevirtual

Implements G4VTBaseHnManager< DIM >.

GetNofHns()

template<unsigned int DIM, typename HT >

virtual G4int G4THnToolsManager< DIM, HT >::GetNofHns ( G4bool onlyIfExist ) const

overridevirtual

Implements G4VTBaseHnManager< DIM >.

GetTitle()

template<unsigned int DIM, typename HT >

virtual G4String G4THnToolsManager< DIM, HT >::GetTitle ( G4int id ) const

overridevirtual

Implements G4VTBaseHnManager< DIM >.

GetWidth()

template<unsigned int DIM, typename HT >

virtual G4double G4THnToolsManager< DIM, HT >::GetWidth ( unsigned int idim, G4int id ) const

overridevirtual

Implements G4VTBaseHnManager< DIM >.

List()

template<unsigned int DIM, typename HT >

virtual G4bool G4THnToolsManager< DIM, HT >::List ( std::ostream & output, G4bool onlyIfActive = true )

overridevirtual

Implements G4VTBaseHnManager< DIM >.

operator=()

template<unsigned int DIM, typename HT >

G4THnToolsManager & G4THnToolsManager< DIM, HT >::operator= ( const G4THnToolsManager< DIM, HT > & rhs )

delete

Scale()

template<unsigned int DIM, typename HT >

virtual G4bool G4THnToolsManager< DIM, HT >::Scale ( G4int id, G4double factor )

overridevirtual

Implements G4VTBaseHnManager< DIM >.

Set()

template<unsigned int DIM, typename HT >

G4bool G4THnToolsManager< DIM, HT >::Set ( G4int id, const std::array< G4HnDimension, DIM > & bins, const std::array< G4HnDimensionInformation, DIM > & hnInfo )

overridevirtual

Implements G4VTBaseHnManager< DIM >.

SetAxisTitle()

template<unsigned int DIM, typename HT >

virtual G4bool G4THnToolsManager< DIM, HT >::SetAxisTitle ( unsigned int idim, G4int id, const G4String & title )

overridevirtual

Implements G4VTBaseHnManager< DIM >.

SetTitle()

template<unsigned int DIM, typename HT >

virtual G4bool G4THnToolsManager< DIM, HT >::SetTitle ( G4int id, const G4String & title )

overridevirtual

Implements G4VTBaseHnManager< DIM >.

WriteOnAscii() [1/11]

G4bool G4THnToolsManager< kDim1, tools::histo::h1d >::WriteOnAscii ( std::ofstream & output )

virtual

Implements G4VTBaseHnManager< DIM >.

WriteOnAscii() [2/11]

G4bool G4THnToolsManager< kDim2, tools::histo::h2d >::WriteOnAscii ( std::ofstream & output )

virtual

Implements G4VTBaseHnManager< DIM >.

WriteOnAscii() [3/11]

G4bool G4THnToolsManager< kDim3, tools::histo::h3d >::WriteOnAscii ( std::ofstream & output )

virtual

Implements G4VTBaseHnManager< DIM >.

WriteOnAscii() [4/11]

G4bool G4THnToolsManager< kDim2, tools::histo::p1d >::WriteOnAscii ( std::ofstream & output )

virtual

Implements G4VTBaseHnManager< DIM >.

WriteOnAscii() [5/11]

G4bool G4THnToolsManager< kDim3, tools::histo::p2d >::WriteOnAscii ( std::ofstream & output )

virtual

Implements G4VTBaseHnManager< DIM >.

WriteOnAscii() [6/11]

G4bool G4THnToolsManager< kDim1, tools::histo::h1d >::WriteOnAscii ( std::ofstream & output )

virtual

Implements G4VTBaseHnManager< DIM >.

Definition at line 96 of file G4TH1ToolsManager.cc.

{
// Write selected objects on ASCII file
// According to the implementation by Michel Maire, originally in
// extended examples.
 
  // Do nothing if no histograms are selected
  if ( ! GetHnManager()->IsAscii() ) return true;
 
  // Write h1 histograms
  auto id = GetHnManager()->GetFirstId();
  for (const auto& [h1, info] : *GetTHnVector()) {
 
    if ( (h1 == nullptr) || (! info->GetAscii()) ) {
      // skip writing
      // if h1 was deleted or writing ascii is not selected
      id++;
      continue;
    }
 
    Message(kVL3, "write on ascii", "h1d", info->GetName());
 
    output << "\n  1D histogram " << id++ << ": " << h1->title()
           << "\n \n \t     X \t\t Bin Height" << 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 output.good();
}

WriteOnAscii() [7/11]

G4bool G4THnToolsManager< kDim2, tools::histo::h2d >::WriteOnAscii ( std::ofstream & output )

virtual

Implements G4VTBaseHnManager< DIM >.

Definition at line 108 of file G4TH2ToolsManager.cc.

{
// Write selected objects on ASCII file
// According to the implementation by Michel Maire, originally in
// extended examples.
 
  // Do nothing if no histograms are selected
  if ( ! GetHnManager()->IsAscii() ) return true;
 
  // Write h2 histograms
  auto id = GetHnManager()->GetFirstId();
  for (const auto& [h2, info] : *GetTHnVector()) {
 
    if ( (h2 == nullptr) || (! info->GetAscii()) ) {
      // skip writing
      // if h2 was deleted or writing ascii is not selected
      id++;
      continue;
    }
 
    Message(kVL3, "write on ascii", "h2d", info->GetName());
 
    output << "\n  2D histogram " << id++ << ": " << h2->title()
           << "\n \n \t \t     X \t\t     Y \t\t Bin Height" << G4endl;
 
    for (G4int j=0; j< G4int(h2->axis_x().bins()); ++j) {
      for (G4int k=0; k< G4int(h2->axis_y().bins()); ++k) {
        output << "  " << j << "\t" << k << "\t"
               << h2->axis_x().bin_center(j) << "\t"
               << h2->axis_y().bin_center(k) << "\t"
               << h2->bin_height(j, k) << G4endl;
      }
    }
  }
 
  return output.good();
}

WriteOnAscii() [8/11]

G4bool G4THnToolsManager< kDim3, tools::histo::h3d >::WriteOnAscii ( std::ofstream & output )

virtual

Implements G4VTBaseHnManager< DIM >.

Definition at line 119 of file G4TH3ToolsManager.cc.

{
// Write selected objects on ASCII file
// According to the implementation by Michel Maire, originally in
// extended examples.
 
  // Do nothing if no histograms are selected
  if ( ! GetHnManager()->IsAscii() ) return true;
 
  // Write h3 histograms
  auto id = GetHnManager()->GetFirstId();
  for (const auto& [h3, info] : *GetTHnVector()) {
 
    if ( (h3 == nullptr) || (! info->GetAscii()) ) {
      // skip writing
      // if h3 was deleted or writing ascii is not selected
      id++;
      continue;
    }
 
    Message(kVL3, "write on ascii", "h3d", info->GetName());
 
    output << "\n  3D histogram " << id++ << ": " << h3->title()
           << "\n \n \t \t \t     X \t\t     Y \t\t     Z \t\t Bin Height" << G4endl;
 
    for (G4int j=0; j< G4int(h3->axis_x().bins()); ++j) {
      for (G4int k=0; k< G4int(h3->axis_y().bins()); ++k) {
        for (G4int l=0; l< G4int(h3->axis_y().bins()); ++l) {
          output << "  " << j << "\t" << k << "\t" << l << "\t"
                 << h3->axis_x().bin_center(j) << "\t"
                 << h3->axis_y().bin_center(k) << "\t"
                 << h3->axis_y().bin_center(l) << "\t"
                 << h3->bin_height(j, k, l) << G4endl;
        }
      }
    }
  }
 
  return output.good();
}

WriteOnAscii() [9/11]

G4bool G4THnToolsManager< kDim2, tools::histo::p1d >::WriteOnAscii ( std::ofstream & output )

virtual

Implements G4VTBaseHnManager< DIM >.

Definition at line 125 of file G4TP1ToolsManager.cc.

{
// Write selected objects on ASCII file
 
  // Do nothing if no histograms are selected
  if ( ! GetHnManager()->IsAscii() ) return true;
 
  // Write p1 histograms
  auto id = GetHnManager()->GetFirstId();
  for (const auto& [p1, info] : *GetTHnVector()) {
 
    if ( (p1 == nullptr) || (! info->GetAscii()) ) {
      // skip writing
      // if p1 was deleted or writing ascii is not selected
      id++;
      continue;
    }
 
    Message(kVL3, "write on ascii", "p1d", info->GetName());
 
    output << "\n  1D profile " << id++ << ": " << p1->title()
           << "\n \n \t \t     X \t\t MeanY" << G4endl;
 
    for (G4int j=0; j< G4int(p1->axis().bins()); ++j) {
       auto sw = p1->bin_Sw(j);
       auto svw = p1->bin_Svw(j);
       auto mean = ( sw != 0. ) ?  (svw / sw) : 0.;
       output << "  " << j << "\t"
              << p1->axis().bin_center(j) << "\t"
              << mean << G4endl;
    }
  }
 
  return output.good();
}

WriteOnAscii() [10/11]

G4bool G4THnToolsManager< kDim3, tools::histo::p2d >::WriteOnAscii ( std::ofstream & output )

virtual

Implements G4VTBaseHnManager< DIM >.

Definition at line 137 of file G4TP2ToolsManager.cc.

{
// Write selected objects on ASCII file
 
  // Do nothing if no histograms are selected
  if ( ! GetHnManager()->IsAscii() ) return true;
 
  // Write p2 histograms
  auto id = GetHnManager()->GetFirstId();
  for (const auto& [p2, info] : *GetTHnVector()) {
 
    if ( (p2 == nullptr) || (! info->GetAscii()) ) {
      // skip writing
      // if p2 was deleted or writing ascii is not selected
      id++;
      continue;
    }
 
    Message(kVL3, "write on ascii", "p2d", info->GetName());
 
    output << "\n  2D profile " << id++ << ": " << p2->title()
           << "\n \n \t \t     X \t\t     Y \t\t    MeanZ" << G4endl;
 
    for (G4int j=0; j< G4int(p2->axis_x().bins()); ++j) {
      for (G4int k=0; k< G4int(p2->axis_y().bins()); ++k) {
        auto sw = p2->bin_Sw(j, k);
        auto svw = p2->bin_Svw(j, k);
        auto mean = ( sw != 0. ) ?  (svw / sw) : 0.;
        output << "  " << j << "\t" << k << "\t"
               << p2->axis_x().bin_center(j) << "\t"
               << p2->axis_y().bin_center(k) << "\t"
               << mean << G4endl;
      }
    }
  }
 
  return output.good();
}

WriteOnAscii() [11/11]

template<unsigned int DIM, typename HT >

virtual G4bool G4THnToolsManager< DIM, HT >::WriteOnAscii ( std::ofstream & output )

overridevirtual

Implements G4VTBaseHnManager< DIM >.

Friends And Related Symbol Documentation

G4VAnalysisManager

template<unsigned int DIM, typename HT >

friend class G4VAnalysisManager

friend

Definition at line 53 of file G4THnToolsManager.hh.

G4VAnalysisReader

template<unsigned int DIM, typename HT >

friend class G4VAnalysisReader

friend

Definition at line 54 of file G4THnToolsManager.hh.

Member Data Documentation

fkClass

template<unsigned int DIM, typename HT >

std::string_view G4THnToolsManager< DIM, HT >::fkClass { "G4THnToolsManager" }

staticconstexprprotected

Definition at line 117 of file G4THnToolsManager.hh.

{ "G4THnToolsManager" };

---

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

• G4ToolsAnalysisManager.hh
• G4THnToolsManager.hh