G4PlotManager Class Reference

#include <G4PlotManager.hh>

Collaboration diagram for G4PlotManager:

Public Member Functions
	G4PlotManager (const G4AnalysisManagerState &state)
	~G4PlotManager ()
	G4PlotManager (const G4PlotManager &rhs)=delete
G4PlotManager &	operator= (const G4PlotManager &rhs)=delete
G4bool	OpenFile (const G4String &fileName)
template<typename T >
G4bool	PlotAndWrite (const std::vector< T *> &htVector, const std::vector< G4HnInformation *> &hnVector)
G4bool	CloseFile ()

Private Member Functions
G4int	GetNofPlotsPerPage () const
G4bool	WritePage ()

Private Attributes
const G4AnalysisManagerState &	fState
std::unique_ptr< tools::viewplot >	fViewer
G4String	fFileName

Static Private Attributes
static G4PlotParameters	fgPlotParameters

Detailed Description

Definition at line 45 of file G4PlotManager.hh.

Constructor & Destructor Documentation

G4PlotManager() [1/2]

G4PlotManager::G4PlotManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 156 of file G4PlotManager.cc.

 : fState(state),
   fViewer(nullptr),
   fFileName()
{
#if defined(TOOLS_USE_FREETYPE)
#ifdef G4VERBOSE
  if ( fState.GetVerboseL1() ) 
    G4cout << "... using high resolution with Freetype fonts" << G4endl;
#endif
  //Have vertical A4 :
  // unsigned int ww = 2000; //to have better antialising on freetype fonts.
  // float A4 = 29.7f/21.0f;
  // unsigned int wh = (unsigned int)(float(ww)*A4*0.80);
  static tools::sg::text_freetype ttf;
  fViewer.reset(new tools::viewplot(G4cout, ttf,
                                    fgPlotParameters.GetColumns(),
                                    fgPlotParameters.GetRows(), 
                                    fgPlotParameters.GetWidth(), 
                                    fgPlotParameters.GetHeight()));
  fViewer->plots().view_border = false;
  load_embeded_styles(fViewer->styles());
  fViewer->styles().add_colormap("default",tools::sg::style_default_colormap());
  fViewer->styles().add_colormap("ROOT",tools::sg::style_ROOT_colormap());
#else
  // cretae a viewer with default parameters
#ifdef G4VERBOSE
  if ( fState.GetVerboseL1() ) 
    G4cout << "... using low resolution with Hershey fonts" << G4endl;
#endif
  fViewer.reset(new tools::viewplot(G4cout, 
                                    fgPlotParameters.GetColumns(), 
                                    fgPlotParameters.GetRows(), 
                                    fgPlotParameters.GetWidth(), 
                                    fgPlotParameters.GetHeight()));
  fViewer->plots().view_border = false;
#endif
}

Here is the call graph for this function:

~G4PlotManager()

G4PlotManager::~G4PlotManager

(

)

Definition at line 199 of file G4PlotManager.cc.

{}

G4PlotManager() [2/2]

G4PlotManager::G4PlotManager ( const G4PlotManager &  rhs )

delete

Member Function Documentation

CloseFile()

G4bool G4PlotManager::CloseFile

(

)

Definition at line 271 of file G4PlotManager.cc.

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("close", "plot file", fFileName);
#endif

  G4bool result = fViewer->close_file();
  if ( ! result ) {
    G4ExceptionDescription description;
    description << "      " << "Cannot close the plot file.";
    G4Exception("G4PlotManager::CloseFile()",
                "Analysis_W021", JustWarning, description);
  }

#ifdef G4VERBOSE
  if ( fState.GetVerboseL1() ) 
    fState.GetVerboseL1()->Message("close", "plot file", fFileName);
#endif

  return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetNofPlotsPerPage()

G4int G4PlotManager::GetNofPlotsPerPage ( ) const

inlineprivate

Definition at line 80 of file G4PlotManager.hh.

{ return fgPlotParameters.GetColumns()*fgPlotParameters.GetRows(); }

Here is the call graph for this function:

Here is the caller graph for this function:

OpenFile()

G4bool G4PlotManager::OpenFile

(

const G4String &

fileName

)

Definition at line 244 of file G4PlotManager.cc.

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("open", "plot file", fileName);
#endif

  // Keep filename for logging
  fFileName = fileName;

  G4bool result = fViewer->open_file(fileName);
  if ( ! result ) {
    G4ExceptionDescription description;
    description << "      " << "Cannot open plot file " << fileName;
    G4Exception("G4PlotManager::OpenFile()",
                "Analysis_W001", JustWarning, description);
  }

#ifdef G4VERBOSE
  if ( fState.GetVerboseL1() ) 
    fState.GetVerboseL1()->Message("open", "plot file", fileName);
#endif

  return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

G4PlotManager& G4PlotManager::operator= ( const G4PlotManager &  rhs )

delete

PlotAndWrite()

template<typename T >

G4bool G4PlotManager::PlotAndWrite ( const std::vector< T *> &  htVector, const std::vector< G4HnInformation *> &  hnVector  )

inline

Definition at line 86 of file G4PlotManager.hh.

{
  if ( ! htVector.size() ) return true;

  fViewer->plots().init_sg(); 
    //it will recreate the sg::plotters and then reset the styles on new ones.
  fViewer->set_cols_rows(fgPlotParameters.GetColumns(), fgPlotParameters.GetRows());
  fViewer->plots().set_current_plotter(0);

  G4bool finalResult = true;
  G4bool isWriteNeeded = false;

  for ( G4int i=0; i<G4int(htVector.size()); ++i ) {
    G4HnInformation* info = hnVector[i];
    G4bool plotting = info->GetPlotting();
    G4bool activation = info->GetActivation();
    G4String name = info->GetName();
    // skip plotting if not selected for plotting or
    // if activation is enabled and HT is inactivated
    if ( ( ! plotting ) ||
         ( fState.GetIsActivation() && ( ! activation ) ) ) continue;

    T* ht = htVector[i];

    // plot this object
    fViewer->plot(*ht);
    fViewer->set_current_plotter_style(fgPlotParameters.GetStyle());

    // set color (only blue for the time being)
    tools::sg::plotter& plotter = fViewer->plots().current_plotter();
    // set plot properties (use info object to get these)
    plotter.bins_style(0).color = tools::colorf::blue();
    
    isWriteNeeded = true;

#ifdef G4VERBOSE
    if ( fState.GetVerboseL3() ) 
      fState.GetVerboseL3()->Message("plotting", "hd|pd", name);
#endif

    // write a page if number of plots per page is achieved
    if ( G4int(fViewer->plots().current_index()) == (GetNofPlotsPerPage() - 1) ) { 
      G4bool result = WritePage();
      finalResult = result && finalResult;
      isWriteNeeded = false;
    }

    // Prepare for the next plot
    fViewer->plots().next(); 
  }

  // write a page if loop is finished and there are plots to be written
  if ( isWriteNeeded ) {
    G4bool result = WritePage();
    finalResult = result && finalResult;
  }

  // add test of result
  return finalResult;
}

Here is the call graph for this function:

Here is the caller graph for this function:

WritePage()

G4bool G4PlotManager::WritePage ( )

private

Definition at line 207 of file G4PlotManager.cc.

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("write a page in", "plot file", fFileName);
#endif

#if defined(TOOLS_USE_FREETYPE)
  HD_style(fViewer->plots(), 5);
  regions_style(fViewer->plots(), fgPlotParameters.GetScale());
#endif

  G4bool result = fViewer->write_page();
  if ( ! result ) {
    G4ExceptionDescription description;
    description << "      " << "Cannot write a page in the plot file " << fFileName;
    G4Exception("G4PlotManager::WritePage()",
                "Analysis_W022", JustWarning, description);
  }

  // clear viewers plots
  fViewer->plots().init_sg(); 
    //it will recreate the sg::plotters and then reset the styles on new ones.

#ifdef G4VERBOSE
  if ( fState.GetVerboseL3() ) 
    fState.GetVerboseL3()->Message("write a page in", "plot file", fFileName);
#endif

  return result;
}  

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

fFileName

G4String G4PlotManager::fFileName

private

Definition at line 74 of file G4PlotManager.hh.

fgPlotParameters

G4PlotParameters G4PlotManager::fgPlotParameters

staticprivate

Definition at line 69 of file G4PlotManager.hh.

fState

const G4AnalysisManagerState& G4PlotManager::fState

private

Definition at line 72 of file G4PlotManager.hh.

fViewer

std::unique_ptr<tools::viewplot> G4PlotManager::fViewer

private

Definition at line 73 of file G4PlotManager.hh.

---

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

• G4PlotManager.hh
• G4PlotManager.cc