JAANET::JPowerLawFlux Struct Reference

Example function object for computing power-law flux. More...

#include <JPowerLawFlux.hh>

Inheritance diagram for JAANET::JPowerLawFlux:

Public Member Functions
	JPowerLawFlux ()
	Default constructor. More...
	JPowerLawFlux (const double normalisation, const double spectralIndex)
	Constructor. More...
double	operator() (const Evt &evt) const
	Get flux of given event. More...
bool	equals (const JPowerLawFlux &object) const
	Check if this flux is identical to the given flux. More...

Public Attributes
double	normalisation
	normalisation [GeV * m^-2 * sr^-1 * s^-1] More...
double	spectralIndex
	spectral index >= 0 More...

Friends
std::istream &	operator>> (std::istream &in, JPowerLawFlux &object)
	Stream input. More...
std::ostream &	operator<< (std::ostream &out, const JPowerLawFlux &object)
	Write power-law parameters to output stream. More...

Detailed Description

Example function object for computing power-law flux.

Definition at line 21 of file JPowerLawFlux.hh.

Constructor & Destructor Documentation

JAANET::JPowerLawFlux::JPowerLawFlux ( )

inline

Default constructor.

Definition at line 27 of file JPowerLawFlux.hh.

                    :
      normalisation(1.0),
      spectralIndex(0.0)
    {}

JAANET::JPowerLawFlux::JPowerLawFlux ( const double  normalisation, const double  spectralIndex  )

inline

Constructor.

Parameters

normalisation	normalisation [GeV * m^-2 * sr^-1 * s^-1]
spectralIndex	spectral index

Definition at line 39 of file JPowerLawFlux.hh.

                                              :
      normalisation(normalisation),
      spectralIndex(spectralIndex)
    {}

Member Function Documentation

double JAANET::JPowerLawFlux::operator() ( const Evt &  evt ) const

inline

Get flux of given event.

Parameters

evt

event

Returns

flux [GeV * m^-2 * sr^-1 * s^-1]

Definition at line 52 of file JPowerLawFlux.hh.

    {
      using namespace std;
      using namespace JPP;

      if (has_neutrino(evt)) {

        const Trk& neutrino = get_neutrino(evt);
        
        return normalisation * pow(neutrino.E, -spectralIndex);

      } else {
        
        THROW(JNullPointerException, "JPowerLawFlux::operator(): No neutrino for event " << evt.id << '.' << endl);     
      }
    }

bool JAANET::JPowerLawFlux::equals ( const JPowerLawFlux &  object ) const

inline

Check if this flux is identical to the given flux.

Parameters

object

power-law flux object

Returns

true if this flux is identical to given flux; else flase

Definition at line 76 of file JPowerLawFlux.hh.

    {
      return (object.normalisation == this->normalisation &&
              object.spectralIndex == this->spectralIndex);
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JPowerLawFlux &  object  )

friend

Stream input.

Parameters

in	input stream
object	power-law flux

Returns

input stream

Definition at line 90 of file JPowerLawFlux.hh.

    {
      return in >> object.normalisation
                >> object.spectralIndex;
    }

std::ostream& operator<< ( std::ostream &  out, const JPowerLawFlux &  object  )

friend

Write power-law parameters to output stream.

Parameters

out	output stream
object	power-law flux

Returns

output stream

Definition at line 105 of file JPowerLawFlux.hh.

    {
      const JFormat format(out);
      
      out << FIXED(5,3) << object.normalisation << ' '
          << FIXED(5,3) << object.spectralIndex;

      return out;
    }

Member Data Documentation

double JAANET::JPowerLawFlux::normalisation

normalisation [GeV * m^-2 * sr^-1 * s^-1]

Definition at line 117 of file JPowerLawFlux.hh.

double JAANET::JPowerLawFlux::spectralIndex

spectral index >= 0

Definition at line 118 of file JPowerLawFlux.hh.

---

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

• JPowerLawFlux.hh