Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

rootAngleHist Class Reference

This class stores the the flux vs. incident angle information for creating a graph. More...

#include <rootAngleHist.h>

List of all members.

Public Methods

 rootAngleHist (int bins)
 Constructor takes number of bins for histogram. More...

 ~rootAngleHist (void)
 rootAngleHist (const rootAngleHist& oldHist)
void setTitle (std::string title)
 Sets the title for the graphs. More...

void setPhiXLabel (std::string label)
 Sets the x-axis label on the flux vs. azimuth angle graph. More...

void setPhiYLabel (std::string label)
 Sets the y-axis label on the flux vs. azimuth angle graph. More...

void setThetaXLabel (std::string label)
 Sets the x-axis label on the flux vs. zenith angle graph. More...

void setThetaYLabel (std::string label)
 Sets the y-axis label on the flux vs. zenith angle graph. More...

void setGraphType (const char *graph_type)
 Sets the y-axis scaling for the graphs Valid values are "linear" and "log". More...

void storeTheta (double theta_value)
 Increments the temporary bin corresponding to parameter theta. More...

void storePhi (double phi_value)
 Increments the temporary bin corresponding to parameter phi. More...

double retrievePhiCount (int binNumber)
 Retrieves the phi angle raw count from the specified bin. More...

double retrievePhiFlux (int binNumber)
 Retrieves the phi angle flux from the specified bin. More...

double retrievePhiFluxUncertainty (int binNumber)
 Retrieves the phi angle flux uncertainty from the specified bin. More...

double retrieveThetaCount (int binNumber)
 Retrieves the theta angle raw count from the specified bin. More...

double retrieveThetaFlux (int binNumber)
 Retrieves the theta angle flux from the specified bin. More...

double retrieveThetaFluxUncertainty (int binNumber)
 Retrieves the theta angle flux uncertainty from the specified bin. More...

double retrievePhiAngle (int binNumber)
 Retrieves the angle in degrees associated with the bin number. More...

double retrieveThetaAngle (int binNumber)
 Retrives the value of cos(theta) associated with the bin number. More...

void apply (double scale_factor)
 Applies the scaling factor to the raw counts to obtain the fluxes. More...

void reset (void)
 This function clears everything in the object except for the number of bins. More...

void draw (double scale_factor, std::string mode, int current_plot, int total_plots)
 Writes the contents of the flux and flux uncertainty histograms to a script file. More...

void writeFile (double scale_factor, std::ostream& out_file)
 Not yet implemented. More...


Private Types

enum  graphType { linear, log }

Private Attributes

rootHist* theta_hist
 histogram for zenith angle fluxes. More...

rootHist* theta_sigma_hist
 histogram to store zenith angle uncertainties. More...

rootHist* theta_raw_hist
 histogram to store zenith agnle raw counts. More...

rootHist* phi_hist
 histogram for azimuthal angle fluxes. More...

rootHist* phi_sigma_hist
 histogram to store azimuthal angle uncertainties. More...

rootHist* phi_raw_hist
 histogram to store azimuthal angle raw counts. More...

const int num_bins
 number of bins for the histogram. More...

std::string graphTitle
 title of graph. More...

std::string PhiXLabel
 phi graph x axis title. More...

std::string PhiYLabel
 phi graph y axis title. More...

std::string ThetaXLabel
 theta graph x axis title. More...

std::string ThetaYLabel
 theta graph y axis title. More...

enum rootAngleHist::graphType  currentType
 Determines whether the y-axis will be linear or logarithmic.

Detailed Description

This class stores the the flux vs. incident angle information for creating a graph.

Normal usage typically entails 1. calling the constructor 2. calling setTitle, setXLabel, setYLabel, etc. 3. storing energies in the object using store 4. calling apply to normalize the histogram 5. calling draw or writeFile to output the results

Author(s):
Theodore Hierath

Definition at line 25 of file rootAngleHist.h.

Member Enumeration Documentation

enum rootAngleHist::graphType [private]
 

Enumeration values:
linear  
log  

Definition at line 125 of file rootAngleHist.h.

Constructor & Destructor Documentation

rootAngleHist::rootAngleHist ( int bins )
 

Constructor takes number of bins for histogram.

Definition at line 16 of file rootAngleHist.cxx.

rootAngleHist::~rootAngleHist ( void )
 

Definition at line 32 of file rootAngleHist.cxx.

rootAngleHist::rootAngleHist ( const rootAngleHist & oldHist )
 

Definition at line 42 of file rootAngleHist.cxx.

Member Function Documentation

void rootAngleHist::apply ( double scale_factor )
 

Applies the scaling factor to the raw counts to obtain the fluxes.

This function clears the raw count histograms, stores the flux values in the flux histograms, and calculates the uncertainties. If there was a previous value in the flux and flux uncertainty histograms, this function does not overwrite the values, but adds them together. This function must be used before the draw member function.

Definition at line 172 of file rootAngleHist.cxx.

void rootAngleHist::draw ( double scale_factor,
std::string mode,
int current_plot,
int total_plots )
 

Writes the contents of the flux and flux uncertainty histograms to a script file.

This file is then interpreted by root.

Parameters:
scale_factor   This is a final scale factor applied to the graphs.
mode   This can be "normal", "begin", or "end". Normal means that the draw function for this object will be used alone. Begin means that this draw function is first called before the corresponding one for rootEnergyHist. End means that this draw function is first called after the draw function for rootEnergyHist.
current_plot   This is the number of times this function has been called. If it is the first time it is called, this number should be '0'. This is used by the function so that it knows if it is at the beginning, middle, or end of the script file.
total_plots   This is the total number of plots that will be graphed. This is used in conjunction with current_plot so that the function knows when the script file should end.

Definition at line 221 of file rootAngleHist.cxx.

void rootAngleHist::reset ( void )
 

This function clears everything in the object except for the number of bins.

Definition at line 202 of file rootAngleHist.cxx.

double rootAngleHist::retrievePhiAngle ( int binNumber )
 

Retrieves the angle in degrees associated with the bin number.

Definition at line 166 of file rootAngleHist.cxx.

double rootAngleHist::retrievePhiCount ( int binNumber )
 

Retrieves the phi angle raw count from the specified bin.

Definition at line 131 of file rootAngleHist.cxx.

double rootAngleHist::retrievePhiFlux ( int binNumber )
 

Retrieves the phi angle flux from the specified bin.

Definition at line 136 of file rootAngleHist.cxx.

Referenced by draw().

double rootAngleHist::retrievePhiFluxUncertainty ( int binNumber )
 

Retrieves the phi angle flux uncertainty from the specified bin.

Definition at line 141 of file rootAngleHist.cxx.

Referenced by draw().

double rootAngleHist::retrieveThetaAngle ( int binNumber )
 

Retrives the value of cos(theta) associated with the bin number.

Definition at line 161 of file rootAngleHist.cxx.

double rootAngleHist::retrieveThetaCount ( int binNumber )
 

Retrieves the theta angle raw count from the specified bin.

Definition at line 146 of file rootAngleHist.cxx.

double rootAngleHist::retrieveThetaFlux ( int binNumber )
 

Retrieves the theta angle flux from the specified bin.

Definition at line 151 of file rootAngleHist.cxx.

Referenced by draw().

double rootAngleHist::retrieveThetaFluxUncertainty ( int binNumber )
 

Retrieves the theta angle flux uncertainty from the specified bin.

Definition at line 156 of file rootAngleHist.cxx.

Referenced by draw().

void rootAngleHist::setGraphType ( const char * graph_type )
 

Sets the y-axis scaling for the graphs Valid values are "linear" and "log".

Definition at line 104 of file rootAngleHist.cxx.

void rootAngleHist::setPhiXLabel ( std::string label )
 

Sets the x-axis label on the flux vs. azimuth angle graph.

Definition at line 84 of file rootAngleHist.cxx.

void rootAngleHist::setPhiYLabel ( std::string label )
 

Sets the y-axis label on the flux vs. azimuth angle graph.

Definition at line 89 of file rootAngleHist.cxx.

void rootAngleHist::setThetaXLabel ( std::string label )
 

Sets the x-axis label on the flux vs. zenith angle graph.

Definition at line 94 of file rootAngleHist.cxx.

void rootAngleHist::setThetaYLabel ( std::string label )
 

Sets the y-axis label on the flux vs. zenith angle graph.

Definition at line 99 of file rootAngleHist.cxx.

void rootAngleHist::setTitle ( std::string title )
 

Sets the title for the graphs.

Definition at line 79 of file rootAngleHist.cxx.

void rootAngleHist::storePhi ( double phi_value )
 

Increments the temporary bin corresponding to parameter phi.

Definition at line 124 of file rootAngleHist.cxx.

void rootAngleHist::storeTheta ( double theta_value )
 

Increments the temporary bin corresponding to parameter theta.

Definition at line 114 of file rootAngleHist.cxx.

void rootAngleHist::writeFile ( double scale_factor,
std::ostream & out_file )
 

Not yet implemented.

Definition at line 482 of file rootAngleHist.cxx.

Member Data Documentation

std::string rootAngleHist::PhiXLabel [private]
 

phi graph x axis title.

Definition at line 121 of file rootAngleHist.h.

std::string rootAngleHist::PhiYLabel [private]
 

phi graph y axis title.

Definition at line 122 of file rootAngleHist.h.

std::string rootAngleHist::ThetaXLabel [private]
 

theta graph x axis title.

Definition at line 123 of file rootAngleHist.h.

std::string rootAngleHist::ThetaYLabel [private]
 

theta graph y axis title.

Definition at line 124 of file rootAngleHist.h.

enum rootAngleHist::graphType rootAngleHist::currentType [private]
 

Determines whether the y-axis will be linear or logarithmic.

std::string rootAngleHist::graphTitle [private]
 

title of graph.

Definition at line 120 of file rootAngleHist.h.

const int rootAngleHist::num_bins [private]
 

number of bins for the histogram.

Definition at line 119 of file rootAngleHist.h.

rootHist * rootAngleHist::phi_hist [private]
 

histogram for azimuthal angle fluxes.

Definition at line 116 of file rootAngleHist.h.

rootHist * rootAngleHist::phi_raw_hist [private]
 

histogram to store azimuthal angle raw counts.

Definition at line 118 of file rootAngleHist.h.

rootHist * rootAngleHist::phi_sigma_hist [private]
 

histogram to store azimuthal angle uncertainties.

Definition at line 117 of file rootAngleHist.h.

rootHist * rootAngleHist::theta_hist [private]
 

histogram for zenith angle fluxes.

Definition at line 113 of file rootAngleHist.h.

rootHist * rootAngleHist::theta_raw_hist [private]
 

histogram to store zenith agnle raw counts.

Definition at line 115 of file rootAngleHist.h.

rootHist * rootAngleHist::theta_sigma_hist [private]
 

histogram to store zenith angle uncertainties.

Definition at line 114 of file rootAngleHist.h.

The documentation for this class was generated from the following files:
Generated at Wed Nov 21 12:20:36 2001 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000