DumpChannelMap_module.cc

Go to the documentation of this file.

/**
 * @file    DumpChannelMap_module.cc
 * @brief   Prints on screen the current channel-wire map
 * @author  Gianluca Petrillo (petrillo@fnal.gov)
 * @date    October 27th, 2015
 *
 */

// LArSoft libraries
#include "larcore/Geometry/Geometry.h"
#include "larcorealg/Geometry/GeometryCore.h"
#include "larcorealg/Geometry/OpDetGeo.h"
#include "larcoreobj/SimpleTypesAndConstants/RawTypes.h" // raw::ChannelID_t
#include "larcoreobj/SimpleTypesAndConstants/geo_types.h" // geo::WireID

// framework libraries
#include "art/Framework/Services/Registry/ServiceHandle.h"
#include "art/Framework/Core/EDAnalyzer.h"
#include "art/Framework/Core/ModuleMacros.h"
#include "canvas/Utilities/Exception.h"
#include "messagefacility/MessageLogger/MessageLogger.h"
#include "fhiclcpp/types/Atom.h"
#include "fhiclcpp/types/Comment.h"
#include "fhiclcpp/types/Name.h"

// C/C++ standard libraries
#include <string>

namespace geo {
  class DumpChannelMap;
}

/** ****************************************************************************
 * @brief Prints on screen the current channel-wire and optical detector maps.
 *
 * One print is performed at the beginning of each run.
 *
 *
 * Configuration parameters
 * =========================
 *
 * - *ChannelToWires* (boolean, default: true): prints all the wires
 *   corresponding to each channel
 * - *WireToChannel* (boolean, default: false): prints which channel covers
 *   each wire
 * - *OpDetChannels* (boolean, default: false): prints for each optical detector
 *   channel ID the optical detector ID and its center
 * - *FirstChannel* (integer, default: no limit): ID of the lowest channel to be
 *   printed
 * - *LastChannel* (integer, default: no limit): ID of the highest channel to be
 *   printed
 * - *OutputCategory* (string, default: DumpChannelMap): output category used
 *   by the message facility to output information (INFO level)
 *
 */


class geo::DumpChannelMap: public art::EDAnalyzer {
public:
  
  /// Module configuration.
  struct Config {
    using Name = fhicl::Name;
    using Comment = fhicl::Comment;
    
    fhicl::Atom<std::string> OutputCategory {
      Name("OutputCategory"),
      Comment(
        "output category used by the message facility to output information (INFO level)"
        ),
      "DumpChannelMap"
      };
    
    fhicl::Atom<bool> ChannelToWires {
      Name("ChannelToWires"),
      Comment("print all the wires corresponding to each channel"),
      true
      };
    
    fhicl::Atom<bool> WireToChannel {
      Name("WireToChannel"),
      Comment("print which channel covers each wire"),
      false
      };
    
    fhicl::Atom<bool> OpDetChannels {
      Name("OpDetChannels"),
      Comment(
        "print for each optical detector channel ID the optical detector ID and its center"
        ),
      false
      };
    
    fhicl::Atom<raw::ChannelID_t> FirstChannel {
      Name("FirstChannel"),
      Comment("ID of the lowest channel to be printed (default: no limit)"),
      raw::InvalidChannelID
      };
    
    fhicl::Atom<raw::ChannelID_t> LastChannel {
      Name("LastChannel"),
      Comment("ID of the highest channel to be printed (default: no limit)"),
      raw::InvalidChannelID
      };
    
  }; // Config
  
  using Parameters = art::EDAnalyzer::Table<Config>;
  
  
  explicit DumpChannelMap(Parameters const& config);

  // Plugins should not be copied or assigned.
  DumpChannelMap(DumpChannelMap const &) = delete;
  DumpChannelMap(DumpChannelMap &&) = delete;
  DumpChannelMap & operator = (DumpChannelMap const &) = delete;
  DumpChannelMap & operator = (DumpChannelMap &&) = delete;

  // Required functions
  void analyze(art::Event const&) override {}

  /// Drives the dumping
  void beginRun(art::Run const&) override;

    private:

  std::string OutputCategory; ///< Name of the category for output.
  bool DoChannelToWires; ///< Dump channel -> wires mapping.
  bool DoWireToChannel; ///< Dump wire -> channel mapping.
  bool DoOpDetChannels; ///< Dump optical detector channel -> optical detector.

  raw::ChannelID_t FirstChannel; ///< First channel to be printed.
  raw::ChannelID_t LastChannel; ///< Last channel to be printed.

}; // geo::DumpChannelMap


//==============================================================================
//=== Algorithms declaration
//===

namespace {

  /// Dumps channel-to-wires mapping
  class DumpChannelToWires {
      public:

    /// Constructor; includes a working default configuration
    DumpChannelToWires()
      : FirstChannel(raw::InvalidChannelID)
      , LastChannel(raw::InvalidChannelID)
      {}

    /// Sets up the required environment
    void Setup(geo::GeometryCore const& geometry)
      { pGeom = &geometry; }

    /// Sets the lowest and highest channel ID to be printed (inclusive)
    void SetLimits
      (raw::ChannelID_t first_channel, raw::ChannelID_t last_channel)
      { FirstChannel = first_channel; LastChannel = last_channel; }

    /// Dumps to the specified output category
    void Dump(std::string OutputCategory) const;


      protected:
    geo::GeometryCore const* pGeom = nullptr; ///< pointer to geometry

    raw::ChannelID_t FirstChannel; ///< lowest channel to be printed
    raw::ChannelID_t LastChannel; ///< highest channel to be printed

    /// Throws an exception if the object is not ready to dump
    void CheckConfig() const;

  }; // class DumpChannelToWires


  /// Dumps wire-to-channel mapping
  class DumpWireToChannel {
      public:

    /// Constructor; includes a working default configuration
    DumpWireToChannel() {}

    /// Sets up the required environment
    void Setup(geo::GeometryCore const& geometry)
      { pGeom = &geometry; }

    /// Dumps to the specified output category
    void Dump(std::string OutputCategory) const;


      protected:
    geo::GeometryCore const* pGeom = nullptr; ///< pointer to geometry

    /// Throws an exception if the object is not ready to dump
    void CheckConfig() const;

  }; // class DumpWireToChannel


  /// Dumps optical detector channel-to-optical detector mapping.
  class DumpOpticalDetectorChannels {
      public:

    /// Constructor; includes a working default configuration
    DumpOpticalDetectorChannels() {}

    /// Sets up the required environment
    void Setup(geo::GeometryCore const& geometry)
      { pGeom = &geometry; }

    /// Dumps to the specified output category
    void Dump(std::string OutputCategory) const;


      protected:
    geo::GeometryCore const* pGeom = nullptr; ///< pointer to geometry

    /// Throws an exception if the object is not ready to dump
    void CheckConfig() const;

    /// Returns the optical detector serving `channelID`,
    /// `nullptr` if not found.
    geo::OpDetGeo const* getOpticalDetector(unsigned int channelID) const;
    
  }; // class DumpOpticalDetectorChannels


} // local namespace


//==============================================================================
//=== Module implementation
//===

//------------------------------------------------------------------------------
geo::DumpChannelMap::DumpChannelMap(Parameters const& config)
  : art::EDAnalyzer(config)
  , OutputCategory  (config().OutputCategory())
  , DoChannelToWires(config().ChannelToWires())
  , DoWireToChannel (config().WireToChannel())
  , DoOpDetChannels (config().OpDetChannels())
  , FirstChannel    (config().FirstChannel())
  , LastChannel     (config().LastChannel())
{

} // geo::DumpChannelMap::DumpChannelMap()

//------------------------------------------------------------------------------
void geo::DumpChannelMap::beginRun(art::Run const&) {

  geo::GeometryCore const& geom = *(art::ServiceHandle<geo::Geometry const>());

  if (DoChannelToWires) {
    DumpChannelToWires dumper;
    dumper.Setup(geom);
    dumper.SetLimits(FirstChannel, LastChannel);
    dumper.Dump(OutputCategory);
  }

  if (DoWireToChannel) {
    DumpWireToChannel dumper;
    dumper.Setup(geom);
  //  dumper.SetLimits(FirstChannel, LastChannel);
    dumper.Dump(OutputCategory);
  }

  if (DoOpDetChannels) {
    DumpOpticalDetectorChannels dumper;
    dumper.Setup(geom);
    dumper.Dump(OutputCategory);
  }

} // geo::DumpChannelMap::beginRun()

//==============================================================================
//===  Algorithm implementation
//===


//------------------------------------------------------------------------------
//--- DumpChannelToWires
//------------------------------------------------------------------------------
void DumpChannelToWires::CheckConfig() const {

  /// check that the configuration is complete
  if (!pGeom) {
    throw art::Exception(art::errors::LogicError)
      << "DumpChannelToWires: no valid geometry available!";
  }
} // DumpChannelToWires::CheckConfig()

//------------------------------------------------------------------------------
void DumpChannelToWires::Dump(std::string OutputCategory) const {

  /// check that the configuration is complete
  CheckConfig();

  /// extract general channel range information
  unsigned int const NChannels = pGeom->Nchannels();

  if (NChannels == 0) {
    mf::LogError(OutputCategory)
      << "Nice detector we have here, with no channels.";
    return;
  }

  raw::ChannelID_t const PrintFirst
    = raw::isValidChannelID(FirstChannel)? FirstChannel: raw::ChannelID_t(0);
  raw::ChannelID_t const PrintLast
    = raw::isValidChannelID(LastChannel)? LastChannel: raw::ChannelID_t(NChannels-1);

  // print intro
  unsigned int const NPrintedChannels = (PrintLast - PrintFirst) + 1;
  if (NPrintedChannels == NChannels) {
    mf::LogInfo(OutputCategory) << "Printing all " << NChannels << " channels";
  }
  else {
    mf::LogInfo(OutputCategory) << "Printing channels from " << PrintFirst
      << " to " << LastChannel << " (" << NPrintedChannels
      << " channels out of " << NChannels << ")";
  }

  // print map
  mf::LogVerbatim log(OutputCategory);
  for (raw::ChannelID_t channel = PrintFirst; channel <= PrintLast; ++channel) {
    std::vector<geo::WireID> const Wires = pGeom->ChannelToWire(channel);

    log << "\n " << ((int) channel) << " ->";
    switch (Wires.size()) {
      case 0:  log << " no wires";                       break;
      case 1:                                            break;
      default: log << " [" << Wires.size() << " wires]"; break;
    } // switch

    for (geo::WireID const& wireID: Wires)
      log << " { " << std::string(wireID) << " };";

  } // for (channels)

} // DumpChannelToWires::Dump()

//------------------------------------------------------------------------------
//--- DumpWireToChannel
//------------------------------------------------------------------------------
void DumpWireToChannel::CheckConfig() const {

  /// check that the configuration is complete
  if (!pGeom) {
    throw art::Exception(art::errors::LogicError)
      << "DumpWireToChannel: no valid geometry available!";
  }
} // DumpWireToChannel::CheckConfig()

//------------------------------------------------------------------------------
void DumpWireToChannel::Dump(std::string OutputCategory) const {

  /// check that the configuration is complete
  CheckConfig();

  /// extract general channel range information
  unsigned int const NChannels = pGeom->Nchannels();

  if (NChannels == 0) {
    mf::LogError(OutputCategory)
      << "Nice detector we have here, with no channels.";
    return;
  }

  // print intro
  mf::LogInfo(OutputCategory)
    << "Printing wire channels for up to " << NChannels << " channels";

  // print map
  mf::LogVerbatim log(OutputCategory);
  for (geo::WireID const& wireID: pGeom->IterateWireIDs()) {
    raw::ChannelID_t channel = pGeom->PlaneWireToChannel(wireID);
    log << "\n { " << std::string(wireID) << " } => ";
    if (raw::isValidChannelID(channel)) log << channel;
    else                                log << "invalid!";
  } // for

} // DumpWireToChannel::Dump()


//------------------------------------------------------------------------------
//--- DumpOpticalDetectorChannels
//------------------------------------------------------------------------------
void DumpOpticalDetectorChannels::CheckConfig() const {

  /// check that the configuration is complete
  if (!pGeom) {
    throw art::Exception(art::errors::LogicError)
      << "DumpOpticalDetectorChannels: no valid geometry available!";
  }
} // DumpOpticalDetectorChannels::CheckConfig()


//------------------------------------------------------------------------------
geo::OpDetGeo const* DumpOpticalDetectorChannels::getOpticalDetector
  (unsigned int channelID) const
{
  try {
    return &(pGeom->OpDetGeoFromOpChannel(channelID));
  }
  catch (cet::exception const&) {
    return nullptr;
  }
} // DumpOpticalDetectorChannels::getOpticalDetector()


//------------------------------------------------------------------------------
void DumpOpticalDetectorChannels::Dump(std::string OutputCategory) const {

  /// check that the configuration is complete
  CheckConfig();
  
  
  /// extract general channel range information
  unsigned int const NChannels = pGeom->NOpChannels();

  if (NChannels == 0) {
    mf::LogError(OutputCategory)
      << "Nice detector we have here, with no optical channels.";
    return;
  }

  // print intro
  mf::LogInfo(OutputCategory)
    << "Printing optical detectors for up to " << NChannels << " channels";

  // print map
  mf::LogVerbatim log(OutputCategory);
  for (unsigned int channelID = 0; channelID < NChannels; ++channelID) {
    log << "\nChannel " << channelID << " => ";
    geo::OpDetGeo const* opDet = getOpticalDetector(channelID);
    if (!opDet) {
      log << "invalid";
      continue;
    }
    log << opDet->ID() << " at " << opDet->GetCenter() << " cm";
  } // for

} // DumpOpticalDetectorChannels::Dump()

DEFINE_ART_MODULE(geo::DumpChannelMap)