JAANET::JVolume Struct Reference

Auxiliary class for histogramming of effective volume. More...

#include <JVolume.hh>

Public Member Functions
	JVolume (const Head &head, const bool Elog10=false)
	Constructor.
double	getAlpha () const
	Get spectral index of energy distribution.
double	getWall () const
	Get generation dependent weight.
Double_t	getXmin () const
	Get minimal abscissa value.
Double_t	getXmax () const
	Get maximal abscissa value.
Double_t	getX (const Double_t E, double constrain=false) const
	Get abscissa value.
Double_t	getE (const Double_t x, double constrain=false) const
	Get energy.
Double_t	getW (TAxis *axis, const Double_t E) const
	Get bin width corrected energy spectrum dependent weight.
double	getW (const double E) const
	Get generation dependent integral value of given energy.
JVolume &	mul (const double factor)
	Multiply weight.
JVolume &	div (const double factor)
	Divide weight.

Protected Attributes
bool	elog
	histogram option
JTOOLS::JRange< double >	E
	Energy range [GeV].
double	alpha
	spectral index
double	Wall
	generation volume

Detailed Description

Auxiliary class for histogramming of effective volume.

In this, it is assumed that events are generated according . The weight is expressed in .

Definition at line 29 of file JVolume.hh.

Constructor & Destructor Documentation

JVolume()

JAANET::JVolume::JVolume ( const Head & head, const bool Elog10 = false )

inline

Constructor.

Parameters

head	Monte Carlo run header
Elog10	application of log10 to energy

Definition at line 36 of file JVolume.hh.

                                        :
      elog  (Elog10),
      E(0.0, 0.0),
      alpha (0.0),
      Wall  (1.0)
    {
      const JHead buffer(head);
 
      if        (buffer.is_valid(&JHead::spectrum) && 
                 buffer.is_valid(&JHead::cut_nu)   && 
                 buffer.is_valid(&JHead::genvol)) {
 
        alpha  = buffer.spectrum.alpha;
        E      = buffer.cut_nu.E;
        Wall   = (1.0e-9 * (getW(E.getUpperLimit()) -
                            getW(E.getLowerLimit())) *
                  buffer.genvol.volume / buffer.genvol.numberOfEvents);    // km^3
 
      } else if (buffer.is_valid(&JHead::cut_in) &&
                 buffer.is_valid(&JHead::livetime)) {
 
        E      = buffer.cut_in.E;
        Wall   = 1.0 / buffer.livetime.numberOfSeconds;                     // Hz
      }
    }

Member Function Documentation

getAlpha()

double JAANET::JVolume::getAlpha ( ) const

inline

Get spectral index of energy distribution.

Returns

spectral index

Definition at line 69 of file JVolume.hh.

    {
      return alpha;
    }

getWall()

double JAANET::JVolume::getWall ( ) const

inline

Get generation dependent weight.

Returns

weight

Definition at line 80 of file JVolume.hh.

    {
      return Wall;
    }

getXmin()

Double_t JAANET::JVolume::getXmin ( ) const

inline

Get minimal abscissa value.

Returns

abscissa value

Definition at line 91 of file JVolume.hh.

    {
      return getX(E.getLowerLimit());
    }

getXmax()

Double_t JAANET::JVolume::getXmax ( ) const

inline

Get maximal abscissa value.

Returns

abscissa value

Definition at line 102 of file JVolume.hh.

    {
      return getX(E.getUpperLimit());
    }

getX()

Double_t JAANET::JVolume::getX ( const Double_t E, double constrain = false ) const

inline

Get abscissa value.

Parameters

E	energy
constrain	constrain

Returns

abscissa value

Definition at line 115 of file JVolume.hh.

    {
      double x = (elog ? log10(E) : E);
 
      if (constrain) {
        if        (x < getXmin()) {
          return getXmin();
        } else if (x > getXmax()) {
          return getXmax();
        }
      }
 
      return x;
    }

getE()

Double_t JAANET::JVolume::getE ( const Double_t x, double constrain = false ) const

inline

Get energy.

Parameters

x	abscissa value
constrain	constrain

Returns

energy

Definition at line 138 of file JVolume.hh.

    {
      const double Ex = (elog ? pow(10.0, x) : x);
 
      if (constrain)
        return E.constrain(Ex);
      else
        return Ex;
    }

getW() [1/2]

Double_t JAANET::JVolume::getW ( TAxis * axis, const Double_t E ) const

inline

Get bin width corrected energy spectrum dependent weight.

Parameters

axis	axis
E	energy

Returns

weight [km^3]

Definition at line 156 of file JVolume.hh.

    {
      const Int_t    index = axis->FindBin(getX(E));
 
      const Double_t xmin  = axis->GetBinLowEdge(index);
      const Double_t xmax  = axis->GetBinUpEdge (index);
      
      const Double_t Wmin  = getW(getE(xmin));
      const Double_t Wmax  = getW(getE(xmax));
 
      return Wall / (Wmax - Wmin);
    }

getW() [2/2]

double JAANET::JVolume::getW ( const double E ) const

inline

Get generation dependent integral value of given energy.

Parameters

E

energy

Returns

integral value

Definition at line 176 of file JVolume.hh.

    {
      if (alpha != -1.0)
        return pow(E, 1.0 + alpha) / (1.0 + alpha);
      else
        return log(E);
    }

mul()

JVolume & JAANET::JVolume::mul ( const double factor )

inline

Multiply weight.

Parameters

factor

factor

Returns

this volume

Definition at line 191 of file JVolume.hh.

    {
      Wall *= factor;
 
      return *this;
    }

div()

JVolume & JAANET::JVolume::div ( const double factor )

inline

Divide weight.

Parameters

factor

factor

Returns

this volume

Definition at line 205 of file JVolume.hh.

    {
      Wall /= factor;
 
      return *this;
    }

Member Data Documentation

elog

bool JAANET::JVolume::elog

protected

histogram option

Definition at line 214 of file JVolume.hh.

E

JTOOLS::JRange<double> JAANET::JVolume::E

protected

Energy range [GeV].

Definition at line 215 of file JVolume.hh.

alpha

double JAANET::JVolume::alpha

protected

spectral index

Definition at line 216 of file JVolume.hh.

Wall

double JAANET::JVolume::Wall

protected

generation volume

Definition at line 217 of file JVolume.hh.

---

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

• JVolume.hh