QwTrackingTreeRegion.h

Go to the documentation of this file.

/*!
 * \file   QwTrackingTree.h
 * \brief  Definition of the track search tree
 *
 * \author Wouter Deconinck
 * \date   2009-12-11
 */

#ifndef QWTRACKINGTREEREGION_H
#define QWTRACKINGTREEREGION_H

// System headers
#include <iostream>

// Qweak headers
#include "VQwTrackingElement.h"
#include "shortnode.h"
#include "shorttree.h"
using QwTracking::shortnode;
using QwTracking::shorttree;

/**
 * \class QwTrackingTreeRegion
 * \ingroup QwTracking
 *
 * \author  Burnham Stokes <bestokes@jlab.org>
 * \author  Wouter Deconinck <wdconinc@jlab.org>
 * \date  2009-09-04 18:06:23
 *
 * \brief A container for the pattern databases for each detector region.
 *
 * It is useful to separate the pattern database into multiple detector regions
 * to reduce the extent by which a set of hits are compared to a pattern.
 * For instance, there are two databases for the region 3 set of detectors.
 * One for the 'upper' and one for the 'lower' detector sets.  Track segments
 * in the area downstream of the QTOR magnet are approximated by straight lines.
 * Only the VDC is designed to measure track positions, so these two databases
 * designed to contain patterns which ressemble tracks passing through the VDC.
 *
 * The structure of a tree region is as follows.  The tree region contains a
 * flat list of shorttree objects which is read in sequentially from the cached
 * tree file.  The shorttree objects have son pointers to shortnode objects.
 * For each shorttree there is a linked list of shortnode objects using the
 * next pointers, which branches off to other trees using the tree pointers.
 */
class QwTrackingTreeRegion:
    public VQwTrackingElement,
    public QwObjectCounter<QwTrackingTreeRegion> {

  public:

    /// Default constructor
    QwTrackingTreeRegion(): fDebug(0) { };
    /// \brief Destructor
    virtual ~QwTrackingTreeRegion();

    /// \brief Is this region searchable?
    bool IsSearchable() const { return fSearchable; };
    /// \brief Set this tree region to searchable
    void SetSearchable(bool searchable = true) { fSearchable = searchable; };

    /// \brief Get the node to this tree region
    shortnode* GetNode() { return &fNode; };

    /// \brief Get the width
    double GetWidth() const { return fWidth; };
    /// \brief Set the width
    void SetWidth(double width) { fWidth = width; };

    /// Print the lists of trees and nodes
    void Print(const Option_t* options = 0) const { PrintTrees(); PrintNodes(); };
    /// \brief Print the list of trees
    void PrintTrees() const;
    /// \brief Print the list of nodes
    void PrintNodes() const;

  private:

    int fDebug;   ///< Debug level

    bool fSearchable; ///< Is this tree region searchable?

    shortnode fNode;  ///< Top node of this tree region

    double fWidth;  ///< Width of the detector plane (i.e. number of wires * wire spacing)

}; // class QwTrackingTreeRegion

#endif // QWTRACKINGTREEREGION_H