JAcoustics/JTriggerParameters.hh

Go to the documentation of this file.

#ifndef __JACOUSTICS__JTRIGGERPARAMETERS__
#define __JACOUSTICS__JTRIGGERPARAMETERS__

#include <istream>
#include <ostream>
#include <iomanip>

#include <TROOT.h>
#include <TObject.h>


/**
 * \file
 *
 * Acoustic trigger parameters.
 * \author mdejong
 */
namespace JACOUSTICS {}
namespace JPP { using namespace JACOUSTICS; }

namespace JACOUSTICS {

  /**
   * Trigger parameters.
   */
  struct JTriggerParameters :
    public TObject
  {
    /**
     * Default constructor.
     */
    JTriggerParameters() :
      Q(0.0),
      TMax_s(0.0),
      numberOfHits(0),
      numberOfOutliers(0),
      stdev(2.0)
    {}


    /**
     * Virtual destructor.
     */
    virtual ~JTriggerParameters()
    {}

    ClassDef(JTriggerParameters, 2);

    double   Q;                     ///< minimal quality if larger than one; else quantile
    double   TMax_s;                ///< maximal difference between times of emission [s]
    int      numberOfHits;          ///< minimal number of hits to trigger event
    int      numberOfOutliers;      ///< maximal number of outliers to be removed from event
    double   stdev;                 ///< minimal number of standard deviations for outlier removal
  };
}


/**
 * Read parameters from input stream.
 *
 * \param  in                      input stream
 * \param  parameters              parameters
 * \return                         input stream
 */
std::istream& operator>>(std::istream& in, JACOUSTICS::JTriggerParameters& parameters);


/**
 * Write parameters to output stream.
 *
 * \param  out                     output stream
 * \param  parameters              parameters
 * \return                         output stream
 */
std::ostream& operator<<(std::ostream& out, const JACOUSTICS::JTriggerParameters& parameters);

#endif