JRECONSTRUCTION::JStart Struct Reference

Auxiliary class for start or end point evaluation. More...

#include <JStart.hh>

Public Member Functions
	JStart ()
	Default constructor. More...
	JStart (const double Pmin1, const double Pmin2, const int Nmax2)
	Constructor. More...
bool	is_valid () const
	Check validity of start or end point conditions. More...
template<class T >
T	find (T __begin, T __end) const
	Get start point of muon trajectory. More...

Public Attributes
double	Pmin1
	minimal probability single observation More...
double	Pmin2
	minimal probability for twofold observations More...
int	Nmax2
	maximal number for twofold observations More...

Friends
std::istream &	operator>> (std::istream &in, JStart &parameters)
	Read parameters from input. More...
std::ostream &	operator<< (std::ostream &out, const JStart &parameters)
	Write parameters to output. More...

Detailed Description

Auxiliary class for start or end point evaluation.

Definition at line 21 of file JStart.hh.

Constructor & Destructor Documentation

JRECONSTRUCTION::JStart::JStart ( )

inline

Default constructor.

Definition at line 25 of file JStart.hh.

             :
      Pmin1(0.0),
      Pmin2(0.0),
      Nmax2(0)
    {}

JRECONSTRUCTION::JStart::JStart ( const double  Pmin1, const double  Pmin2, const int  Nmax2  )

inline

Constructor.

Parameters

Pmin1	minimal probability single observation
Pmin2	minimal probability for twofold observations
Nmax2	maximal number for twofold observations

Definition at line 39 of file JStart.hh.

                               :
      Pmin1(Pmin1),
      Pmin2(Pmin2),
      Nmax2(Nmax2)
    {}

Member Function Documentation

bool JRECONSTRUCTION::JStart::is_valid ( ) const

inline

Check validity of start or end point conditions.

Returns

true if valid; else false

Definition at line 53 of file JStart.hh.

    {
      return (Pmin1 >= 0.0 && Pmin1 <= 1.0 &&
              Pmin2 >= 0.0 && Pmin2 <= 1.0);
    }

template<class T >

T JRECONSTRUCTION::JStart::find ( T  __begin, T  __end  ) const

inline

Get start point of muon trajectory.

The template parameter should correspond to a data type which has the member method:

    double getP() const;    // return probability

The input data should have been sorted along the muon path beforehand.
A start point is triggered when an observed probability is less than Pmin1 or when there are two probabilities less than Pmin2 within Nmax2 consecutive observations.
The start or end point can found by providing the data in ascending or descending order, respectively.

Parameters

__begin	begin of data
__end	end of data

Returns

start point

Definition at line 77 of file JStart.hh.

    {
      for (T p = __begin; p != __end; ++p) {

        if (p->getP() < this->Pmin1) {
          return p;
        }

        if (p->getP() < this->Pmin2) {
          for (T q = p; ++q != __end && distance(p,q) < Nmax2; ) {
            if (q->getP() < this->Pmin2) {
              return p;
            }
          }
        }
      }
      
      return __end;
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JStart &  parameters  )

friend

Read parameters from input.

Parameters

in	input stream
parameters	parameters

Returns

input stream

Definition at line 105 of file JStart.hh.

    {
      in >> parameters.Pmin1 >> parameters.Pmin2 >> parameters.Nmax2;

      return in;
    }

std::ostream& operator<< ( std::ostream &  out, const JStart &  parameters  )

friend

Write parameters to output.

Parameters

out	output stream
parameters	parameters

Returns

output stream

Definition at line 120 of file JStart.hh.

    {
      out << parameters.Pmin1 << ' ' << parameters.Pmin2 << ' ' << parameters.Nmax2;

      return out;
    }

Member Data Documentation

double JRECONSTRUCTION::JStart::Pmin1

minimal probability single observation

Definition at line 128 of file JStart.hh.

double JRECONSTRUCTION::JStart::Pmin2

minimal probability for twofold observations

Definition at line 129 of file JStart.hh.

int JRECONSTRUCTION::JStart::Nmax2

maximal number for twofold observations

Definition at line 130 of file JStart.hh.

---

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

• JStart.hh