Wire.h

Go to the documentation of this file.

/*
 * Changes
 * 20190510 Gianluca Petrillo (petrillo@slac.stanford.edu)
 *   updated documentation
 * 20141211 Gianluca Petrillo (petrillo@fnal.gov)
 *   data architecture revision changes:
 *   - fSignalType and SignalType() removed
 *   - fRawDigit and RawDigit() removed
 *   - fChannel and Channel() added
 *   - constructors now take directly a RawDigit, not its art::Ptr
 *
 * ****************************************************************************/

#ifndef LARDATAOBJ_RECOBASE_WIRE_H
#define LARDATAOBJ_RECOBASE_WIRE_H

// LArSoft libraries
#include "larcoreobj/SimpleTypesAndConstants/RawTypes.h" // raw::ChannelID_t
#include "larcoreobj/SimpleTypesAndConstants/geo_types.h"
#include "lardataobj/Utilities/sparse_vector.h"

// C/C++ standard libraries
#include <cstddef> // std::size_t
#include <vector>

namespace recob {

  class Wire {
  public:
    typedef lar::sparse_vector<float> RegionsOfInterest_t;

    Wire();

  private:
    raw::ChannelID_t fChannel;      
    geo::View_t fView;              
    RegionsOfInterest_t fSignalROI; 

    friend class WireCreator; // helper to create wires in art

  public:
    // --- BEGIN -- Constructors ---------------------------------------------
    Wire(RegionsOfInterest_t const& sigROIlist, raw::ChannelID_t channel, geo::View_t view);

    Wire(RegionsOfInterest_t&& sigROIlist, raw::ChannelID_t channel, geo::View_t view);
    // --- END -- Constructors -----------------------------------------------

    // --- BEGIN -- Accessors ------------------------------------------------

    std::vector<float> Signal() const;

    const RegionsOfInterest_t& SignalROI() const;

    std::size_t NSignal() const;

    geo::View_t View() const;

    raw::ChannelID_t Channel() const;

    // --- END -- Accessors --------------------------------------------------

    // --- BEGIN -- Sorting and comparison operations ------------------------

    bool operator<(const Wire& than) const;

    // --- END -- Sorting and comparison operations --------------------------

  }; // class Wire

} // namespace recob

//------------------------------------------------------------------------------
//--- inline implementation
//------------------------------------------------------------------------------
inline const recob::Wire::RegionsOfInterest_t& recob::Wire::SignalROI() const
{
  return fSignalROI;
}
inline std::size_t recob::Wire::NSignal() const
{
  return fSignalROI.size();
}
inline geo::View_t recob::Wire::View() const
{
  return fView;
}
inline raw::ChannelID_t recob::Wire::Channel() const
{
  return fChannel;
}
inline bool recob::Wire::operator<(const Wire& than) const
{
  return Channel() < than.Channel();
}

//------------------------------------------------------------------------------

#endif // LARDATAOBJ_RECOBASE_WIRE_H