g4tools  5.4.0
Public Member Functions | Static Public Member Functions | List of all members
tools::histo::h3df Class Reference
Inheritance diagram for tools::histo::h3df:
Inheritance graph
[legend]
Collaboration diagram for tools::histo::h3df:
Collaboration graph
[legend]

Public Member Functions

const std::string & s_cls () const
 
 h3df ()
 
 h3df (const std::string &a_title, unsigned int aXnumber, float aXmin, float aXmax, unsigned int aYnumber, float aYmin, float aYmax, unsigned int aZnumber, float aZmin, float aZmax)
 
 h3df (const std::string &a_title, const std::vector< double > &a_edges_x, const std::vector< double > &a_edges_y, const std::vector< double > &a_edges_z)
 
virtual ~h3df ()
 
 h3df (const h3df &a_from)
 
h3dfoperator= (const h3df &a_from)
 
- Public Member Functions inherited from tools::histo::h3< double, unsigned int, unsigned int, float, float >
virtual float bin_error (int aI, int aJ, int aK) const
 
bool multiply (float a_factor)
 
bool multiply (const h3 &a_histo)
 
bool scale (float a_factor)
 
void copy_from_data (const hd_t &a_from)
 
hd_t get_histo_data () const
 
bool reset ()
 
bool fill (double aX, double aY, double aZ, float aWeight=1)
 
bool set_bin_content (bn_t a_ibin, bn_t a_jbin, bn_t a_kbin, unsigned int a_entries, float a_Sw, float a_Sw2, double a_Sxw, double a_Sx2w, double a_Syw, double a_Sy2w, double a_Szw, double a_Sz2w)
 
bool get_bin_content (bn_t a_ibin, bn_t a_jbin, bn_t a_kbin, unsigned int &a_entries, float &a_Sw, float &a_Sw2, double &a_Sxw, double &a_Sx2w, double &a_Syw, double &a_Sy2w, double &a_Szw, double &a_Sz2w)
 
bool add (const h3 &a_histo)
 
bool subtract (const h3 &a_histo)
 
bool divide (const h3 &a_histo)
 
bool equals_TH (const h3 &a_from, const float &a_prec, float(*a_fabs)(float)) const
 
void not_a_profile () const
 
bool Fill (double aX, double aY, double aZ, float aWeight=1)
 
 h3 (const std::string &a_title, bn_t aXnumber, double aXmin, double aXmax, bn_t aYnumber, double aYmin, double aYmax, bn_t aZnumber, double aZmin, double aZmax)
 
 h3 (const std::string &a_title, const std::vector< double > &a_edges_x, const std::vector< double > &a_edges_y, const std::vector< double > &a_edges_z)
 
 h3 (const h3 &a_from)
 
virtual ~h3 ()
 
h3operator= (const h3 &a_from)
 
- Public Member Functions inherited from tools::histo::b3< double, unsigned int, unsigned int, float, float >
int coord_to_index_x (double aCoord) const
 
int coord_to_index_y (double aCoord) const
 
int coord_to_index_z (double aCoord) const
 
double mean_x () const
 
double mean_y () const
 
double mean_z () const
 
double rms_x () const
 
double rms_y () const
 
double rms_z () const
 
unsigned int bin_entries (int aI, int aJ, int aK) const
 
float bin_height (int aI, int aJ, int aK) const
 
double bin_center_x (int aI) const
 
double bin_center_y (int aJ) const
 
double bin_center_z (int aK) const
 
double bin_mean_x (int aI, int aJ, int aK) const
 
double bin_mean_y (int aI, int aJ, int aK) const
 
double bin_mean_z (int aI, int aJ, int aK) const
 
double bin_rms_x (int aI, int aJ, int aK) const
 
double bin_rms_y (int aI, int aJ, int aK) const
 
double bin_rms_z (int aI, int aJ, int aK) const
 
const axis_taxis_x () const
 
axis_taxis_x ()
 
const axis_taxis_y () const
 
axis_taxis_y ()
 
const axis_taxis_z () const
 
axis_taxis_z ()
 
unsigned int bin_entries_x (int aI) const
 
unsigned int bin_entries_y (int aJ) const
 
unsigned int bin_entries_z (int aK) const
 
float bin_height_x (int aI) const
 
float bin_height_y (int aJ) const
 
float bin_height_z (int aK) const
 
double Sxyw () const
 
double Syzw () const
 
double Szxw () const
 
void hprint (std::ostream &a_out)
 
 b3 (const std::string &a_title, bn_t aXnumber, double aXmin, double aXmax, bn_t aYnumber, double aYmin, double aYmax, bn_t aZnumber, double aZmin, double aZmax)
 
 b3 (const std::string &a_title, const std::vector< double > &a_edges_x, const std::vector< double > &a_edges_y, const std::vector< double > &a_edges_z)
 
virtual ~b3 ()
 
bool configure (bn_t aXnumber, double aXmin, double aXmax, bn_t aYnumber, double aYmin, double aYmax, bn_t aZnumber, double aZmin, double aZmax)
 
bool configure (const std::vector< double > &a_edges_x, const std::vector< double > &a_edges_y, const std::vector< double > &a_edges_z)
 
- Public Member Functions inherited from tools::histo::base_histo< double, unsigned int, unsigned int, float, float >
const hd_tdac () const
 
bool equals (const base_histo &a_from, const float &a_prec, float(*a_fabs)(float)) const
 
const std::string & title () const
 
bool set_title (const std::string &a_title)
 
dim_t dimension () const
 
dim_t number_of_planes () const
 
unsigned int entries () const
 
unsigned int all_entries () const
 
unsigned int extra_entries () const
 
float equivalent_bin_entries () const
 
float sum_bin_heights () const
 
float sum_all_bin_heights () const
 
float sum_extra_bin_heights () const
 
float min_bin_height () const
 
float max_bin_height () const
 
bool min_bin_height_with_entries (float &a_value) const
 
bool max_bin_height_with_entries (float &a_value) const
 
bool has_entries_per_bin () const
 
bool get_ith_axis_Sxw (dim_t a_axis, double &a_value) const
 
bool get_ith_axis_Sx2w (dim_t a_axis, double &a_value) const
 
float get_in_range_Sw () const
 
float get_in_range_Sw2 () const
 
void get_Sw_Sw2 (float &a_sw, float &a_sw2) const
 
void get_all_Sw_Sw2 (float &a_sw, float &a_sw2) const
 
const std::vector< unsigned int > & bins_entries () const
 
const std::vector< float > & bins_sum_w () const
 
const std::vector< float > & bins_sum_w2 () const
 
const std::vector< std::vector< double > > & bins_sum_xw () const
 
const std::vector< std::vector< double > > & bins_sum_x2w () const
 
const std::vector< double > & in_range_planes_xyw () const
 
const axis_tget_axis (int a_index) const
 
offset_t get_bins () const
 
const std::string & get_title () const
 
dim_t get_dimension () const
 
bool is_valid () const
 
const annotations_tannotations () const
 
annotations_t annotations ()
 
void add_annotation (const std::string &a_key, const std::string &a_value)
 
bool annotation (const std::string &a_key, std::string &a_value) const
 
void set_annotations (const annotations_t &a_annotations)
 
void hprint_annotations (std::ostream &a_out)
 

Static Public Member Functions

static const std::string & s_class ()
 

Additional Inherited Members

- Public Types inherited from tools::histo::h3< double, unsigned int, unsigned int, float, float >
typedef histo_data< double, unsigned int, unsigned int, float > hd_t
 
typedef parent::bn_t bn_t
 
- Public Types inherited from tools::histo::b3< double, unsigned int, unsigned int, float, float >
typedef base_histo< double, unsigned int, unsigned int, float, float > base_histo_t
 
typedef parent::axis_t axis_t
 
typedef parent::bn_t bn_t
 
- Public Types inherited from tools::histo::base_histo< double, unsigned int, unsigned int, float, float >
typedef histo_data< double, unsigned int, unsigned int, float > hd_t
 
typedef axis< double, unsigned int > axis_t
 
typedef axis_t::bn_t bn_t
 
typedef unsigned int dim_t
 
typedef double coordinate_t
 
typedef unsigned int offset_t
 
typedef unsigned int num_entries_t
 
typedef float weight_t
 
typedef float height_t
 
typedef std::map< std::string, std::string > annotations_t
 
- Protected Types inherited from tools::histo::b3< double, unsigned int, unsigned int, float, float >
enum  
 
- Protected Types inherited from tools::histo::base_histo< double, unsigned int, unsigned int, float, float >
enum  
 
- Protected Types inherited from tools::histo::histo_data< double, unsigned int, unsigned int, float >
typedef axis< double, unsigned int > axis_t
 
typedef unsigned int dim_t
 
typedef std::map< std::string, std::string > annotations_t
 
- Protected Member Functions inherited from tools::histo::h3< double, unsigned int, unsigned int, float, float >
virtual float get_bin_height (unsigned int a_offset) const
 
- Protected Member Functions inherited from tools::histo::b3< double, unsigned int, unsigned int, float, float >
 b3 (const b3 &a_from)
 
b3operator= (const b3 &a_from)
 
bool _find_offset (int aI, int aJ, int aK, unsigned int &a_offset) const
 
- Protected Member Functions inherited from tools::histo::base_histo< double, unsigned int, unsigned int, float, float >
void base_from_data (const hd_t &a_from)
 
hd_t base_get_data () const
 
 base_histo ()
 
 base_histo (const base_histo &a_from)
 
virtual ~base_histo ()
 
base_histooperator= (const base_histo &a_from)
 
bool configure (dim_t a_dim, const std::vector< bn_t > &aNumbers, const std::vector< double > &aMins, const std::vector< double > &aMaxs)
 
bool configure (dim_t a_dim, const std::vector< std::vector< double > > &a_edges)
 
void base_reset ()
 
void base_allocate ()
 
bool is_compatible (const base_histo &a_histo)
 
void base_add (const base_histo &a_histo)
 
void base_subtract (const base_histo &a_histo)
 
bool base_multiply (const base_histo &a_histo)
 
bool base_multiply (float a_factor)
 
bool base_divide (const base_histo &a_histo)
 
bool get_ith_axis_mean (dim_t a_axis, double &a_value) const
 
bool get_ith_axis_rms (dim_t a_axis, double &a_value) const
 
unsigned int get_bin_entries (const std::vector< int > &aIs) const
 
- Protected Member Functions inherited from tools::histo::histo_data< double, unsigned int, unsigned int, float >
void reset_fast_getters ()
 
 histo_data ()
 
 histo_data (const histo_data &a_from)
 
histo_dataoperator= (const histo_data &a_from)
 
virtual ~histo_data ()
 
void update_fast_getters ()
 
bool equals (const histo_data &a_from, const float &a_prec, float(*a_fabs)(float)) const
 
bool equals_TH (const histo_data &a_from, const float &a_prec, float(*a_fabs)(float), bool a_cmp_bin_Sw2) const
 
- Protected Attributes inherited from tools::histo::histo_data< double, unsigned int, unsigned int, float >
std::string m_title
 
dim_t m_dimension
 
unsigned int m_bin_number
 
std::vector< unsigned int > m_bin_entries
 
std::vector< float > m_bin_Sw
 
std::vector< float > m_bin_Sw2
 
std::vector< std::vector< double > > m_bin_Sxw
 
std::vector< std::vector< double > > m_bin_Sx2w
 
std::vector< axis_tm_axes
 
std::vector< double > m_in_range_plane_Sxyw
 
std::map< std::string, std::string > m_annotations
 
unsigned int m_all_entries
 
unsigned int m_in_range_entries
 
float m_in_range_Sw
 
float m_in_range_Sw2
 
std::vector< double > m_in_range_Sxw
 
std::vector< double > m_in_range_Sx2w
 

Detailed Description

Definition at line 15 of file h3df.

Constructor & Destructor Documentation

◆ h3df() [1/4]

tools::histo::h3df::h3df ( )
inline

Definition at line 24 of file h3df.

24 :parent("",10,0,1,10,0,1,10,0,1){} //for I/O when reading.

◆ h3df() [2/4]

tools::histo::h3df::h3df ( const std::string &  a_title,
unsigned int  aXnumber,
float  aXmin,
float  aXmax,
unsigned int  aYnumber,
float  aYmin,
float  aYmax,
unsigned int  aZnumber,
float  aZmin,
float  aZmax 
)
inline

Definition at line 26 of file h3df.

30  :parent(a_title,aXnumber,aXmin,aXmax,
31  aYnumber,aYmin,aYmax,
32  aZnumber,aZmin,aZmax)
33  {}

◆ h3df() [3/4]

tools::histo::h3df::h3df ( const std::string &  a_title,
const std::vector< double > &  a_edges_x,
const std::vector< double > &  a_edges_y,
const std::vector< double > &  a_edges_z 
)
inline

Definition at line 35 of file h3df.

39  :parent(a_title,a_edges_x,a_edges_y,a_edges_z)
40  {}

◆ ~h3df()

virtual tools::histo::h3df::~h3df ( )
inlinevirtual

Definition at line 42 of file h3df.

42 {}

◆ h3df() [4/4]

tools::histo::h3df::h3df ( const h3df a_from)
inline

Definition at line 44 of file h3df.

44 :parent(a_from){}

Member Function Documentation

◆ operator=()

h3df& tools::histo::h3df::operator= ( const h3df a_from)
inline

Definition at line 45 of file h3df.

45  {
46  parent::operator=(a_from);
47  return *this;
48  }

◆ s_class()

static const std::string& tools::histo::h3df::s_class ( )
inlinestatic

Definition at line 18 of file h3df.

18  {
19  static const std::string s_v("tools::histo::h3df");
20  return s_v;
21  }

◆ s_cls()

const std::string& tools::histo::h3df::s_cls ( ) const
inline

Definition at line 22 of file h3df.

22 {return s_class();}

The documentation for this class was generated from the following file:
tools::histo::h3< double, unsigned int, unsigned int, float, float >::operator=
h3 & operator=(const h3 &a_from)
Definition: h3:269
tools::histo::h3df::s_class
static const std::string & s_class()
Definition: h3df:18