tools/reconstruction.hh File Reference

Auxiliary methods for selection of reconstructed tracks. More...

#include <limits>
#include <algorithm>
#include "km3net-dataformat/offline/Hit.hh"
#include "km3net-dataformat/offline/Vec.hh"
#include "km3net-dataformat/offline/Trk.hh"
#include "km3net-dataformat/offline/Evt.hh"
#include "km3net-dataformat/offline/Exception.hh"
#include "km3net-dataformat/definitions/reconstruction.hh"

Go to the source code of this file.

Classes
struct	rec_stages_range
	Range of reconstruction stages. More...
struct	quality_sorter< reconstruction_type >
	Reconstruction type dependent comparison of track quality. More...
struct	has_history
	Auxiliary class to test whether given track has specified history. More...

Functions
bool	has_jppmuon_prefit (const Trk &track)
	Test whether given track has muon prefit in history. More...
bool	has_jppmuon_simplex (const Trk &track)
	Test whether given track has muon simplex fit in history. More...
bool	has_jppmuon_gandalf (const Trk &track)
	Test whether given track has muon gandalf fit in history. More...
bool	has_jppmuon_energy (const Trk &track)
	Test whether given track has muon energy fit in history. More...
bool	has_jppmuon_start (const Trk &track)
	Test whether given track has muon start fit in history. More...
bool	has_jppmuon_fit (const Trk &track)
	Test whether given track has default muon fit in history. More...
bool	has_shower_prefit (const Trk &track)
	Test whether given track has shower prefit in history. More...
bool	has_shower_positionfit (const Trk &track)
	Test whether given track has shower position fit in history. More...
bool	has_shower_completefit (const Trk &track)
	Test whether given track has shower complete fit in history. More...
bool	has_shower_fit (const Trk &track)
	Test whether given track has default shower fit in history. More...
bool	has_aashower_fit (const Trk &track)
	Test whether given track has default shower fit in history. More...
template<class JTrackSelector_t >
bool	has_reconstructed_track (const Evt &evt, JTrackSelector_t selector)
	Test whether given event has a track according selection. More...
template<int reconstruction_type>
bool	has_reconstructed_track (const Evt &evt, const rec_stages_range range=rec_stages_range())
	Test whether given event has a track according selection. More...
bool	has_reconstructed_jppmuon (const Evt &evt)
	Test whether given event has a track with muon reconstruction. More...
bool	has_reconstructed_jppshower (const Evt &evt)
	Test whether given event has a track with shower reconstruction. More...
bool	has_reconstructed_aashower (const Evt &evt)
	Test whether given event has a track with aashower reconstruction. More...
template<class JTrackSelector_t , class JQualitySorter_t >
const Trk &	get_best_reconstructed_track (const Evt &evt, JTrackSelector_t selector, JQualitySorter_t comparator)
	Get best reconstructed track. More...
template<int reconstruction_type>
const Trk &	get_best_reconstructed_track (const Evt &evt, const rec_stages_range range=rec_stages_range())
	Get best reconstructed track. More...
const Trk &	get_best_reconstructed_jppmuon (const Evt &evt)
	Get best reconstructed muon. More...
const Trk &	get_best_reconstructed_jppshower (const Evt &evt)
	Get best reconstructed shower. More...
const Trk &	get_best_reconstructed_aashower (const Evt &evt)
	Get best reconstructed aashower. More...

Detailed Description

Auxiliary methods for selection of reconstructed tracks.

Author

mdejong

Definition in file tools/reconstruction.hh.

Function Documentation

has_jppmuon_prefit()

bool has_jppmuon_prefit ( const Trk &  track )

inline

Test whether given track has muon prefit in history.

Parameters

track

track

Returns

true if muon prefit in history; else false

Definition at line 144 of file tools/reconstruction.hh.

{
  return ::has_history(JPP_RECONSTRUCTION_TYPE, JMUONPREFIT)(track);
}

has_jppmuon_simplex()

bool has_jppmuon_simplex ( const Trk &  track )

inline

Test whether given track has muon simplex fit in history.

Parameters

track

track

Returns

true if muon simplex fit in history; else false

Definition at line 156 of file tools/reconstruction.hh.

{
  return ::has_history(JPP_RECONSTRUCTION_TYPE, JMUONSIMPLEX)(track);
}

has_jppmuon_gandalf()

bool has_jppmuon_gandalf ( const Trk &  track )

inline

Test whether given track has muon gandalf fit in history.

Parameters

track

track

Returns

true if muon gandalf fit in history; else false

Definition at line 168 of file tools/reconstruction.hh.

{
  return ::has_history(JPP_RECONSTRUCTION_TYPE, JMUONGANDALF)(track);
}

has_jppmuon_energy()

bool has_jppmuon_energy ( const Trk &  track )

inline

Test whether given track has muon energy fit in history.

Parameters

track

track

Returns

true if muon energy fit in history; else false

Definition at line 180 of file tools/reconstruction.hh.

{
  return ::has_history(JPP_RECONSTRUCTION_TYPE, JMUONENERGY)(track);
}

has_jppmuon_start()

bool has_jppmuon_start ( const Trk &  track )

inline

Test whether given track has muon start fit in history.

Parameters

track

track

Returns

true if muon start fit in history; else false

Definition at line 192 of file tools/reconstruction.hh.

{
  return ::has_history(JPP_RECONSTRUCTION_TYPE, JMUONSTART)(track);
}

has_jppmuon_fit()

bool has_jppmuon_fit ( const Trk &  track )

inline

Test whether given track has default muon fit in history.

Parameters

track

track

Returns

true if muon fit in history; else false

Definition at line 204 of file tools/reconstruction.hh.

{
  return ::has_history(JPP_RECONSTRUCTION_TYPE, rec_stages_range(JMUONBEGIN, JMUONEND))(track);
}  

has_shower_prefit()

bool has_shower_prefit ( const Trk &  track )

inline

Test whether given track has shower prefit in history.

Parameters

track

track

Returns

true if shower prefit in history; else false

Definition at line 216 of file tools/reconstruction.hh.

{
  return ::has_history(JPP_RECONSTRUCTION_TYPE, JSHOWERPREFIT)(track);
}

has_shower_positionfit()

bool has_shower_positionfit ( const Trk &  track )

inline

Test whether given track has shower position fit in history.

Parameters

track

track

Returns

true if shower position fit in history; else false

Definition at line 228 of file tools/reconstruction.hh.

{
  return ::has_history(JPP_RECONSTRUCTION_TYPE, JSHOWERPOSITIONFIT)(track);
}  

has_shower_completefit()

bool has_shower_completefit ( const Trk &  track )

inline

Test whether given track has shower complete fit in history.

Parameters

track

track

Returns

true if shower complete fit in history; else false

Definition at line 240 of file tools/reconstruction.hh.

{
  return ::has_history(JPP_RECONSTRUCTION_TYPE, JSHOWERCOMPLETEFIT)(track);
}

has_shower_fit()

bool has_shower_fit ( const Trk &  track )

inline

Test whether given track has default shower fit in history.

Parameters

track

track

Returns

true if shower fit in history; else false

Definition at line 252 of file tools/reconstruction.hh.

{
  return ::has_history(JPP_RECONSTRUCTION_TYPE, rec_stages_range(JSHOWERBEGIN, JSHOWEREND))(track);
}

has_aashower_fit()

bool has_aashower_fit ( const Trk &  track )

inline

Test whether given track has default shower fit in history.

Parameters

track

track

Returns

true if shower fit in history; else false

Definition at line 264 of file tools/reconstruction.hh.

{
  return ::has_history(AANET_RECONSTRUCTION_TYPE, rec_stages_range(AASHOWERBEGIN, AASHOWEREND))(track);
}

has_reconstructed_track() [1/2]

template<class JTrackSelector_t >

bool has_reconstructed_track ( const Evt &  evt, JTrackSelector_t  selector  )

inline

Test whether given event has a track according selection.

The track selector corresponds to the function operator bool selector(const Trk&);.

Parameters

evt	event
selector	track selector

Returns

true if at least one corresponding track; else false

Definition at line 279 of file tools/reconstruction.hh.

{
  return std::find_if(evt.trks.begin(), evt.trks.end(), selector) != evt.trks.end();
}

has_reconstructed_track() [2/2]

template<int reconstruction_type>

bool has_reconstructed_track ( const Evt &  evt, const rec_stages_range  range = rec_stages_range()  )

inline

Test whether given event has a track according selection.

Parameters

evt	event
range	range of application types

Returns

true if at least one corresponding track; else false

Definition at line 293 of file tools/reconstruction.hh.

{
  return ::has_reconstructed_track(evt, ::has_history(reconstruction_type, range));
}

has_reconstructed_jppmuon()

bool has_reconstructed_jppmuon ( const Evt &  evt )

inline

Test whether given event has a track with muon reconstruction.

Parameters

evt

event

Returns

true if at least one reconstructed muon; else false

Definition at line 305 of file tools/reconstruction.hh.

{
  return ::has_reconstructed_track(evt, has_jppmuon_fit);
}

has_reconstructed_jppshower()

bool has_reconstructed_jppshower ( const Evt &  evt )

inline

Test whether given event has a track with shower reconstruction.

Parameters

evt

event

Returns

true if at least one reconstructed shower; else false

Definition at line 317 of file tools/reconstruction.hh.

{
  return ::has_reconstructed_track(evt, ::has_shower_fit);
}

has_reconstructed_aashower()

bool has_reconstructed_aashower ( const Evt &  evt )

inline

Test whether given event has a track with aashower reconstruction.

Parameters

evt

event

Returns

true if at least one reconstructed shower; else false

Definition at line 329 of file tools/reconstruction.hh.

{
  return ::has_reconstructed_track(evt, has_aashower_fit);
}

get_best_reconstructed_track() [1/2]

template<class JTrackSelector_t , class JQualitySorter_t >

const Trk& get_best_reconstructed_track ( const Evt &  evt, JTrackSelector_t  selector, JQualitySorter_t  comparator  )

inline

Get best reconstructed track.

The track selector corresponds to the function operator bool selector(const Trk&); and the track comparator to bool comparator(const Trk&, const Trk&);.
This method throws an exception in case no track is present.
The method has_reconstructed_track can be used to avoid this exception.

Parameters

evt	event
selector	track selector
comparator	track comparator

Returns

track

Definition at line 348 of file tools/reconstruction.hh.

{
  std::vector<Trk>::const_iterator p = std::find_if(evt.trks.begin(), evt.trks.end(), selector);
 
  for (std::vector<Trk>::const_iterator i = p; i != evt.trks.end(); ++i) {
    if (selector(*i) && comparator(*i, *p)) {
      p = i;
    }
  }
 
  if (p != evt.trks.end())
    return *p;
  else
    THROW(Exception, "This event has no reconstructed track with given selector.");
}

get_best_reconstructed_track() [2/2]

template<int reconstruction_type>

const Trk& get_best_reconstructed_track ( const Evt &  evt, const rec_stages_range  range = rec_stages_range()  )

inline

Get best reconstructed track.

Parameters

evt	event
range	range of application types

Returns

track

Definition at line 375 of file tools/reconstruction.hh.

{
  return get_best_reconstructed_track(evt, ::has_history(reconstruction_type, range), quality_sorter<reconstruction_type>());
}

get_best_reconstructed_jppmuon()

const Trk& get_best_reconstructed_jppmuon ( const Evt &  evt )

inline

Get best reconstructed muon.

Parameters

evt

event

Returns

track

Definition at line 387 of file tools/reconstruction.hh.

{
  return get_best_reconstructed_track(evt, has_jppmuon_fit, quality_sorter<JPP_RECONSTRUCTION_TYPE>());
}

get_best_reconstructed_jppshower()

const Trk& get_best_reconstructed_jppshower ( const Evt &  evt )

inline

Get best reconstructed shower.

Parameters

evt

event

Returns

track

Definition at line 399 of file tools/reconstruction.hh.

{
  return get_best_reconstructed_track(evt, ::has_shower_fit, quality_sorter<JPP_RECONSTRUCTION_TYPE>());
}

get_best_reconstructed_aashower()

const Trk& get_best_reconstructed_aashower ( const Evt &  evt )

inline

Get best reconstructed aashower.

Parameters

evt

event

Returns

track

Definition at line 411 of file tools/reconstruction.hh.

{
  return get_best_reconstructed_track(evt, ::has_aashower_fit, quality_sorter<AANET_RECONSTRUCTION_TYPE>());
}