JAANET::JPowerLawFlux Struct Reference

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

#include <JPowerLawFlux.hh>

Inheritance diagram for JAANET::JPowerLawFlux:

Classes
struct	JPowerLawFluxHelper
	Auxiliary class for I/O of power-law flux. More...

Public Types
typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
	JPowerLawFlux ()
	Default constructor.
	JPowerLawFlux (const double normalisation, const double spectralIndex)
	Constructor.
bool	is_valid () const override final
	Check whether this power-law flux is valid.
double	getFactor (const Evt &evt) const override final
	Get flux of given event.
bool	equals (const JPowerLawFlux &object) const
	Check if this flux is identical to the given flux.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) override final
	Get properties of this class.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) const override final
	Get properties of this class.
std::istream &	read (std::istream &in) override final
	Stream input.
virtual clone_type	clone () const override
	Get clone of this object.

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

Detailed Description

Example function object for computing power-law flux.

Definition at line 31 of file JPowerLawFlux.hh.

Member Typedef Documentation

clone_type

template<class JClonable_t , class JDerived_t >

JClonable<JClonable_t>::clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone_type

inherited

Definition at line 61 of file JClonable.hh.

Constructor & Destructor Documentation

JPowerLawFlux() [1/2]

JAANET::JPowerLawFlux::JPowerLawFlux ( )

inline

Default constructor.

Definition at line 38 of file JPowerLawFlux.hh.

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

JPowerLawFlux() [2/2]

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 50 of file JPowerLawFlux.hh.

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

Member Function Documentation

is_valid()

bool JAANET::JPowerLawFlux::is_valid ( ) const

inlinefinaloverride

Check whether this power-law flux is valid.

Returns

true if valid; else false

Definition at line 64 of file JPowerLawFlux.hh.

    {
      return normalisation > 0.0;
    }

getFactor()

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

inlinefinaloverride

Get flux of given event.

Parameters

evt

event

Returns

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

Definition at line 76 of file JPowerLawFlux.hh.

    {
      using namespace std;
      using namespace JPP;
 
      const Trk& primary = get_primary(evt);
        
      return normalisation * pow(primary.E, -spectralIndex);
    }

equals()

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 93 of file JPowerLawFlux.hh.

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

getProperties() [1/2]

JProperties JAANET::JPowerLawFlux::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters() )

inlinefinaloverride

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 105 of file JPowerLawFlux.hh.

    {
      return JPowerLawFluxHelper(*this, eqpars);
    }

getProperties() [2/2]

JProperties JAANET::JPowerLawFlux::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters() ) const

inlinefinaloverride

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 116 of file JPowerLawFlux.hh.

    {
      return JPowerLawFluxHelper(*this, eqpars);      
    }

read()

std::istream & JAANET::JPowerLawFlux::read ( std::istream & in )

inlinefinaloverride

Stream input.

Parameters

in	input stream

Returns

input stream

Definition at line 128 of file JPowerLawFlux.hh.

    {
      using namespace std;
 
      streampos pos = in.tellg();
      
      if (!(in >> normalisation >> spectralIndex)) {
 
        in.clear();
        in.seekg(pos);
 
        JProperties properties = getProperties();
 
        in >> properties;
      }
 
      check_validity();
 
      return in;
    }

clone()

template<class JClonable_t , class JDerived_t >

virtual clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone ( ) const

inlineoverridevirtualinherited

Get clone of this object.

Returns

pointer to newly created object

Reimplemented in JPHYSICS::JPD0Transformer_t< JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 5, JArgument_t >, JPHYSICS::JPDFTransformer_t< JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, and JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer.

Definition at line 69 of file JClonable.hh.

    {
      return new JDerived_t(static_cast<const JDerived_t&>(*this));
    }

Member Data Documentation

normalisation

double JAANET::JPowerLawFlux::normalisation

private

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

Definition at line 177 of file JPowerLawFlux.hh.

spectralIndex

double JAANET::JPowerLawFlux::spectralIndex

private

spectral index >= 0

Definition at line 178 of file JPowerLawFlux.hh.

---

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

• JPowerLawFlux.hh