JACOUSTICS::JHead Struct Reference

Acoustic event header. More...

#include <JEvt.hh>

Inheritance diagram for JACOUSTICS::JHead:

Public Member Functions
	JHead ()
	Default constructor. More...
	JHead (const std::string &oid, const JTimeRange &range, const int nhit, const int nfit, const int npar, const double ndf, const double chi2)
	Constructor. More...
virtual	~JHead ()
	Virtual destructor. More...
	ClassDef (JHead, 5)

Public Attributes
std::string	oid
	detector identifier More...
double	UNIXTimeStart
	start time More...
double	UNIXTimeStop
	stop time More...
int	nhit
	number of hits More...
int	nfit
	number of hits used in fit (after outlier removal) More...
int	npar
	number of fit parameters More...
double	ndf
	weighed number of degrees of freedom More...
double	chi2
	chi2 More...

Friends
JReader &	operator>> (JReader &in, JHead &object)
	Read head from input. More...
JWriter &	operator<< (JWriter &out, const JHead &object)
	Write head to output. More...

Detailed Description

Acoustic event header.

Definition at line 158 of file JAcoustics/JEvt.hh.

Constructor & Destructor Documentation

JACOUSTICS::JHead::JHead ( )

inline

Default constructor.

Definition at line 162 of file JAcoustics/JEvt.hh.

            :
      oid (),
      UNIXTimeStart(0.0),
      UNIXTimeStop (0.0),
      nhit(0),
      nfit(0),
      npar(0),
      ndf (0.0),
      chi2(0.0)
    {}

JACOUSTICS::JHead::JHead ( const std::string &  oid, const JTimeRange &  range, const int  nhit, const int  nfit, const int  npar, const double  ndf, const double  chi2  )

inline

Constructor.

Parameters

oid	detector identifer
range	UNIX start and stop time [s]
nhit	number of hits
nfit	number of hits used in fit (after outlier removal)
npar	number of fit parameters
ndf	weighed number of degrees of freedom
chi2	chi2

Definition at line 185 of file JAcoustics/JEvt.hh.

                             :
      oid (oid),
      UNIXTimeStart(range.getLowerLimit()),
      UNIXTimeStop (range.getUpperLimit()),
      nhit(nhit),
      nfit(nfit),
      npar(npar),
      ndf (ndf),
      chi2(chi2)
    {}

virtual JACOUSTICS::JHead::~JHead ( )

inlinevirtual

Virtual destructor.

Definition at line 206 of file JAcoustics/JEvt.hh.

    {}

Member Function Documentation

JACOUSTICS::JHead::ClassDef	(	JHead	,
		5
	)

Friends And Related Function Documentation

JReader& operator>> ( JReader &  in, JHead &  object  )

friend

Read head from input.

Parameters

in	reader
object	head

Returns

reader

Definition at line 217 of file JAcoustics/JEvt.hh.

    {
      in >> object.oid;
      in >> object.UNIXTimeStart;
      in >> object.UNIXTimeStop;
      in >> object.nhit;
      in >> object.nfit;
      in >> object.npar;
      in >> object.ndf;
      in >> object.chi2;

      return in;
    }

JWriter& operator<< ( JWriter &  out, const JHead &  object  )

friend

Write head to output.

Parameters

out	writer
object	head

Returns

writer

Definition at line 239 of file JAcoustics/JEvt.hh.

    {
      out << object.oid;
      out << object.UNIXTimeStart;
      out << object.UNIXTimeStop;
      out << object.nhit;
      out << object.nfit;
      out << object.npar;
      out << object.ndf;
      out << object.chi2;

      return out;
    }

Member Data Documentation

std::string JACOUSTICS::JHead::oid

detector identifier

Definition at line 255 of file JAcoustics/JEvt.hh.

double JACOUSTICS::JHead::UNIXTimeStart

start time

Definition at line 256 of file JAcoustics/JEvt.hh.

double JACOUSTICS::JHead::UNIXTimeStop

stop time

Definition at line 257 of file JAcoustics/JEvt.hh.

int JACOUSTICS::JHead::nhit

number of hits

Definition at line 258 of file JAcoustics/JEvt.hh.

int JACOUSTICS::JHead::nfit

number of hits used in fit (after outlier removal)

Definition at line 259 of file JAcoustics/JEvt.hh.

int JACOUSTICS::JHead::npar

number of fit parameters

Definition at line 260 of file JAcoustics/JEvt.hh.

double JACOUSTICS::JHead::ndf

weighed number of degrees of freedom

Definition at line 261 of file JAcoustics/JEvt.hh.

double JACOUSTICS::JHead::chi2

chi2

Definition at line 262 of file JAcoustics/JEvt.hh.

---

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

• JAcoustics/JEvt.hh