Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

T_Histo3D Class Reference

#include <T_Histograms_3D.h>

Inheritance diagram for T_Histo3D:

T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition > T_I_Histo_3D T_I_Histo List of all members.

Detailed Description

Values stored in the bins are doubles.

Definition at line 37 of file T_Histograms_3D.h.

Public Types

typedef T_Histo3D Like_Current
 Convenience typedef to current type.


Public Methods

 H_IID_IMPLEMENT (T_Histo3D)
 Very simple RTTI feature.

typedef H_T_REF (Like_Current) Ref_Like_Current
 Convenience typedef to reference to current type.

 T_Histo3D (const char *a_title, Size n1, double x1, double x2,Size n2, double y1, double y2,Size n3, double z1, double z2, End_Point_Convention epc1=RIGHT_OPEN, End_Point_Convention epc2=RIGHT_OPEN, End_Point_Convention epc3=RIGHT_OPEN)
 Create a transient 3D histo with Weighted_Bin and fixed partition.

 T_Histo3D (I_Histo &a_histo, int copy_data=1)
 Copy constructor.

 T_Histo3D (const I_Histo &a_histo, int copy_data=1)
 Copy constructor taking const reference.

virtual ~T_Histo3D ()
 Destructor.

void fill (double x, double y, double z, double w=1.0)
 Fill histo with datapoint ( x , y , z) and weight w.

double bin_center (Index i, Index j, Index k, Index p=0)
 Center of the bin indexed by ( i , j , k ) projected on axis p.

double mean (Index p=0)
 Return histogram mean projected on axis p.

double rms (Index p=0)
 Return histogram RMS (Root Mean Square) projected on axis p.

Ref_Like_Current clone (int copy_data=1)
 Clone the histogram.

Ref_Like_Current clone (H_T_CLUSTER1(a_place), int copy_data=1)
 Clone the histogram.

Ref_Like_Current add (const Ref_Like_Current &other)
 Add another histogram of the same type to this one.

void add (const I_Histo &other)
 Add another histogram to this one using the abstract interface.

Ref_Like_Current sub (const Ref_Like_Current &other)
 Subtract another histogram of the same type from this one.

void sub (const I_Histo &other)
 Subtract another histogram from this one using the abstract interface.

Ref_Like_Current mul (const Ref_Like_Current &other)
 Multiply another histogram of the same type to this one.

void mul (const I_Histo &other)
 Multiply another histogram to this one using the abstract interface.

Ref_Like_Current div (const Ref_Like_Current &other)
 Divide this histogram by another of the same type.

void div (const I_Histo &other)
 Divide this histogram by another one using the abstract interface.

void add (double x)
 Add a scalar to this histogram.

void sub (double x)
 Subtract a scalar from this histogram.

void mul (double x)
 Multiply by a scalar this histogram.

void div (double x)
 Divide by scalar this histogram.


Protected Methods

virtual T_REF_I_Histo clone_ (int copy_data=1)
virtual T_REF_I_Histo clone_ (H_T_CLUSTER1(a_place), int copy_data=1)


Member Typedef Documentation

typedef T_Histo3D T_Histo3D::Like_Current
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 43 of file T_Histograms_3D.h.

Referenced by clone().


Constructor & Destructor Documentation

T_Histo3D::T_Histo3D const char *    a_title,
Size    n1,
double    x1,
double    x2,
Size    n2,
double    y1,
double    y2,
Size    n3,
double    z1,
double    z2,
End_Point_Convention    epc1 = RIGHT_OPEN,
End_Point_Convention    epc2 = RIGHT_OPEN,
End_Point_Convention    epc3 = RIGHT_OPEN
[inline]
 

Parameters:
a_title:  title of the histo
n1:  number of (in range) bins on axis X
x1  and x2: (x1,x2) is the interval of in range bins
epc1:  global endpoint convention (RIGHT_OPEN or LEFT_OPEN) on X axis
n2:  number of (in range) bins on Y axis
y1  and y2: (y1,y2) is the interval of in range bins
epc2:  global endpoint convention (RIGHT_OPEN or LEFT_OPEN) on Y axis
n3:  number of (in range) bins on Z axis
z1  and z2: (z1,z2) is the interval of in range bins
epc3:  global endpoint convention (RIGHT_OPEN or LEFT_OPEN) on Z axis

Definition at line 59 of file T_Histograms_3D.h.

References End_Point_Convention, H_H3D_E_EP, RIGHT_OPEN, and Size.

T_Histo3D::T_Histo3D I_Histo   a_histo,
int    copy_data = 1
[inline]
 

If copy_data == 1 the content of the histogram is copied as well, otherwise the copy is empty.

Definition at line 72 of file T_Histograms_3D.h.

T_Histo3D::T_Histo3D const I_Histo   a_histo,
int    copy_data = 1
[inline]
 

If copy_data == 1 the content of the histogram is copied as well, otherwise the copy is empty.

Definition at line 78 of file T_Histograms_3D.h.

virtual T_Histo3D::~T_Histo3D   [inline, virtual]
 

Definition at line 82 of file T_Histograms_3D.h.


Member Function Documentation

void T_Histo3D::add double    x [inline]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 208 of file T_Histograms_3D.h.

References T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::add_().

void T_Histo3D::add const I_Histo   other [inline]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 152 of file T_Histograms_3D.h.

References T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::add_().

Ref_Like_Current T_Histo3D::add const Ref_Like_Current &    other [inline]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 137 of file T_Histograms_3D.h.

References T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::bin_count(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::bins_, T_I_Histo_3D::extra_bin_count(), H_T_THIS, HTL_ERR, Index, I_Partition::is_compatible_with(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::partition_X(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::partition_Y(), and T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::partition_Z().

double T_Histo3D::bin_center Index    i,
Index    j,
Index    k,
Index    p = 0
[inline]
 

Definition at line 104 of file T_Histograms_3D.h.

References H_Bin_Helper::bin_center(), I_Histo::I_Bin_Location, and Index.

Ref_Like_Current T_Histo3D::clone H_T_CLUSTER1(a_place)   ,
int    copy_data = 1
[inline]
 

The first parameter is a clustering hint. If copy_data is zero the clone is empty.

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 126 of file T_Histograms_3D.h.

References H_T_NEW_CLUSTER1, and Like_Current.

Ref_Like_Current T_Histo3D::clone int    copy_data = 1 [inline]
 

If copy_data is zero the clone is empty.

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 117 of file T_Histograms_3D.h.

References H_T_NEW_CLUSTER0, and Like_Current.

Referenced by clone_().

virtual T_REF_I_Histo T_Histo3D::clone_ H_T_CLUSTER1(a_place)   ,
int    copy_data = 1
[inline, protected, virtual]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 132 of file T_Histograms_3D.h.

References clone().

virtual T_REF_I_Histo T_Histo3D::clone_ int    copy_data = 1 [inline, protected, virtual]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 130 of file T_Histograms_3D.h.

References clone().

void T_Histo3D::div double    x [inline]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 214 of file T_Histograms_3D.h.

References T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::div_().

void T_Histo3D::div const I_Histo   other [inline]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 206 of file T_Histograms_3D.h.

References T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::div_().

Ref_Like_Current T_Histo3D::div const Ref_Like_Current &    other [inline]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 190 of file T_Histograms_3D.h.

References T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::bin_count(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::bins_, T_I_Histo_3D::extra_bin_count(), H_T_THIS, HTL_ERR, Index, I_Partition::is_compatible_with(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::partition_X(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::partition_Y(), and T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::partition_Z().

void T_Histo3D::fill double    x,
double    y,
double    z,
double    w = 1.0
[inline]
 

Definition at line 86 of file T_Histograms_3D.h.

References HTLlimits::classify(), HTLlimits::isFinite(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::mapped_bin(), and Weighted_Bin::put().

T_Histo3D::H_IID_IMPLEMENT T_Histo3D   
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

typedef T_Histo3D::H_T_REF Like_Current   
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

double T_Histo3D::mean Index    p = 0 [inline]
 

Definition at line 109 of file T_Histograms_3D.h.

References Index, and H_Statistics::mean().

Referenced by rms().

void T_Histo3D::mul double    x [inline]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 212 of file T_Histograms_3D.h.

References T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::mul_().

void T_Histo3D::mul const I_Histo   other [inline]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 188 of file T_Histograms_3D.h.

References T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::mul_().

Ref_Like_Current T_Histo3D::mul const Ref_Like_Current &    other [inline]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 172 of file T_Histograms_3D.h.

References T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::bin_count(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::bins_, T_I_Histo_3D::extra_bin_count(), H_T_THIS, HTL_ERR, Index, I_Partition::is_compatible_with(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::partition_X(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::partition_Y(), and T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::partition_Z().

double T_Histo3D::rms Index    p = 0 [inline]
 

Definition at line 111 of file T_Histograms_3D.h.

References Index, mean(), and H_Statistics::rms().

void T_Histo3D::sub double    x [inline]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 210 of file T_Histograms_3D.h.

References T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::sub_().

void T_Histo3D::sub const I_Histo   other [inline]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 170 of file T_Histograms_3D.h.

References T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::sub_().

Ref_Like_Current T_Histo3D::sub const Ref_Like_Current &    other [inline]
 

Reimplemented from T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >.

Definition at line 154 of file T_Histograms_3D.h.

References T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::bin_count(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::bins_, T_I_Histo_3D::extra_bin_count(), H_T_THIS, HTL_ERR, Index, I_Partition::is_compatible_with(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::partition_X(), T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::partition_Y(), and T_Histo_3D< T_Lifetime< Weighted_Bin >, Weighted_Bin, double, Even_Partition, double, Even_Partition, double, Even_Partition >::partition_Z().


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

Anaphe documentation generated by Doxygen (www.doxygen.org)