LArSoft
v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
|
Namespace for LArSoft dumping utilities. More...
Namespaces | |
details | |
Classes | |
struct | ArrayDumper |
Dumps the first N elements of an array. More... | |
struct | ArrayDumper< T * > |
struct | VectorDumper |
Manipulator managing the dump of the vector content into a stream. More... | |
struct | VectorDumper< T * > |
struct | VectorDumper< T[3]> |
Functions | |
template<size_t N, typename Array > | |
auto | array (Array const &a) |
Returns a manipulator which will print the specified array. More... | |
template<typename Vector > | |
auto | vector (Vector const &v) |
Returns a manipulator which will print the specified array. More... | |
template<typename Vector3D > | |
auto | vector3D (Vector3D const &v) |
Returns a manipulator which will print the specified vector. More... | |
template<typename Stream , typename Array > | |
Stream & | operator<< (Stream &&out, ArrayDumper< Array > &&manip) |
Dumps the array contained in the manipulator into a stream. More... | |
template<typename Stream , typename Vector > | |
Stream & | operator<< (Stream &&out, VectorDumper< Vector > &&manip) |
Dumps the vector contained in the manipulator into a stream. More... | |
template<typename String , typename Vector > | |
String | operator+ (String const &s, VectorDumper< Vector > const &manip) |
Concatenates a vector to the specified string. More... | |
template<typename Vector > | |
std::string | operator+ (const char *s, VectorDumper< Vector > const &manip) |
Creates a string with s concatenated to the rendered vector. More... | |
template<typename String , typename Vector > | |
String | operator+ (VectorDumper< Vector > const &manip, String const &s) |
template<typename Vector > | |
std::string | operator+ (VectorDumper< Vector > const &manip, const char *s) |
Creates a string with the rendered vector concatenated to s. More... | |
template<typename String , typename Vector > | |
String & | operator+= (String &s, VectorDumper< Vector > const &manip) |
Appends a string rendering of a vector to the specified string. More... | |
Namespace for LArSoft dumping utilities.
auto lar::dump::array | ( | Array const & | a | ) |
Returns a manipulator which will print the specified array.
N | the number of entries to be printed |
Array | the type of array to be printed |
a | the array to be printed |
Example of usage:
will produce an output like:
Addition of specific classes can be achieved via specialization of the class ArrayDumper
.
Array
is required to respond to a global function cbegin()
(like std::cbegin()
) with a forward iteratorArray
method must have its insertion operator into a stream defineda
must not fall out of scope until the insertion into the stream happens Definition at line 250 of file DumpUtils.h.
Referenced by lar_content::LArGraph::ConnectRegions(), util::LArFFTW::DoInvFFT(), lar_content::LArGraph::MakeGraph(), and geo::vect::details::makeIndexSeqImpl().
String lar::dump::operator+ | ( | String const & | s, |
VectorDumper< Vector > const & | manip | ||
) |
Concatenates a vector to the specified string.
String | a string type that can handle "addition" to std::string |
Vector3D | the type of 3D vector to be printed |
s | the string |
manip | the manipulator containing the vector to be printed |
Example of usage:
will produce an output like:
Vector3D
is required to provide constant accessor methods returning the vector components, called X()
, Y()
and Z()
Vector3D
methods must have their insertion operator into Stream defined Definition at line 435 of file DumpUtils.h.
std::string lar::dump::operator+ | ( | const char * | s, |
VectorDumper< Vector > const & | manip | ||
) |
Creates a string with s concatenated to the rendered vector.
Definition at line 442 of file DumpUtils.h.
String lar::dump::operator+ | ( | VectorDumper< Vector > const & | manip, |
String const & | s | ||
) |
Definition at line 449 of file DumpUtils.h.
std::string lar::dump::operator+ | ( | VectorDumper< Vector > const & | manip, |
const char * | s | ||
) |
Creates a string with the rendered vector concatenated to s.
Definition at line 456 of file DumpUtils.h.
String& lar::dump::operator+= | ( | String & | s, |
VectorDumper< Vector > const & | manip | ||
) |
Appends a string rendering of a vector to the specified string.
Definition at line 463 of file DumpUtils.h.
Referenced by util::quantities::concepts::Quantity< Unit, T >::operator value_t(), lar::sparse_vector< T >::const_iterator::operator++(), lar::sparse_vector< T >::iterator::operator++(), util::quantities::concepts::Interval< Q, Cat >::operator+=(), util::quantities::concepts::Point< Q, Cat, IV >::operator+=(), lar::sparse_vector< T >::const_iterator::operator-=(), lar::sparse_vector< T >::iterator::operator-=(), and sim::SimPhotons::SimPhotons().
Stream& lar::dump::operator<< | ( | Stream && | out, |
ArrayDumper< Array > && | manip | ||
) |
Dumps the array contained in the manipulator into a stream.
Stream | the type of output stream |
Array | the type of array to be printed |
NPrint | the number of element of the array to be printed |
out | the output stream |
manip | the manipulator containing the array to be printed |
Example of usage:
will produce an output like:
Vector3D
is required to provide constant accessor methods returning the vector components, called X()
, Y()
and Z()
Vector3D
methods must have their insertion operator into Stream
defined Definition at line 362 of file DumpUtils.h.
Stream& lar::dump::operator<< | ( | Stream && | out, |
VectorDumper< Vector > && | manip | ||
) |
Dumps the vector contained in the manipulator into a stream.
Stream | the type of output stream |
Vector3D | the type of 3D vector to be printed |
out | the output stream |
manip | the manipulator containing the vector to be printed |
Example of usage:
will produce an output like:
Vector3D
is required to provide constant accessor methods returning the vector components, called X()
, Y()
and Z()
Vector3D
methods must have their insertion operator into Stream defined Definition at line 398 of file DumpUtils.h.
auto lar::dump::vector | ( | Vector const & | v | ) |
Returns a manipulator which will print the specified array.
Vector | type of vector to be printed |
v | the vector to be printed |
Example of usage:
will produce an output like:
Addition of specific classes can be achieved via specialization of the class ArrayDumper
.
Vector::size() const
must be available returning the number of elements in the vectorVector
is required to respond to a global function cbegin()
(like std::cbegin()
) with a forward iteratorVector
method must have its insertion operator into a stream definedv
must not fall out of scope until the insertion into the stream happens Definition at line 289 of file DumpUtils.h.
Referenced by showerreco::ShowerRecoManager::Algo(), ClusteringValidation::ClusterAnalyser::Analyse(), ShowerQuality::analyze(), trkf::SpacePointAna::analyze(), pma::ProjectionMatchingAlg::autoFlip(), btutil::MCMatchAlg::BTAlg(), trkf::KalmanFilterAlg::buildTrack(), cluster::HoughBaseAlg::ChargeInfo_t::ChargeInfo_t(), shower::EMShowerAlg::CheckIsolatedHits_(), shower::EMShowerAlg::CheckShowerPlanes(), genf::GFTrack::clearFailedHits(), cluster::BlurredClusteringAlg::ConvertRecobHitsToVector(), tf::Graph::create(), util::CreateAssn(), evgb::util::CreateAssn(), hit::RFFHitFitter::CreateMergeVector(), fhicl::detail::ValidateThenSet::delegated_parameter(), pma::Dist2(), noisefilteralg::WireCellNoiseFilter::DoNoiseFilter(), trkf::Track3DKalmanSPS::dQdxCalc(), trkf::KalmanFilterAlg::extendTrack(), cluster::HoughBaseAlg::FastTransform(), raw::fibonacci_encode_table(), simfilter::FilterSimPhotonLiteTime::FilterSimPhotonLiteTime(), simfilter::FilterSimPhotonTime::FilterSimPhotonTime(), shower::EMShowerAlg::FindShowerStart_(), cluster::SmallClusterFinderAlg::FindSmallClusters(), ClusteringValidation::ClusterAnalyser::FindTrueTrack(), phot::PropagationTimeModel::generateVUVParams(), trkf::Geometric3DVertexFitter::Geometric3DVertexFitter(), geo::vect::details::BoundCoordGetter< CoordHelper, StoredVector >::get(), img::DataProviderAlg::getDriftIndex(), pma::PMAlgTrackingBase::getKinks(), cluster::ClusterMergeHelper::GetManager(), cluster::BlurredClusteringAlg::GetMinSize(), evwgh::WeightCalc::GetName(), lar_pandora::LArPandoraHelper::GetPFParticleMetadata(), trkf::SeedFinderAlgorithm::GetSeedsFromSortedHits(), cheat::BackTracker::GetSetOfEveIds(), trkf::SeedFinderModule::GetSortedHitsFromClusters(), trkf::SeedFinderAlgorithm::GetSpacePointAlg(), phot::PhotonVisibilityService::GetTimingTF1(), pma::PMAlgVertexing::getVertices(), shower::TrackShowerSeparationAlg::Gradient(), pma::Track3D::HasTPC(), cheat::BackTracker::HitToEveTrackIDEs(), cheat::BackTracker::HitToXYZ(), cluster::HoughBaseAlg::HoughBaseAlg(), pma::PMAlgTracker::init(), trkmkr::KalmanFilterFitTrackMaker::initEvent(), anab::FVectorWriter< N >::initOutputs(), artg4tk::ArtG4tkModelConfig::Insert(), pma::ProjectionMatchingAlg::isContained(), GFException::isFatal(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::IsResidualOK(), detinfo::LArPropertiesStandard::LArPropertiesStandard(), pma::Track3D::Length(), phot::PhotonVisibilityService::LoadTimingsForVUVPar(), shower::EMShowerAlg::MakeInitialTrack_(), cluster::BlurredClusteringAlg::MakeKernels(), shower::EMShowerAlg::MakeShower(), shower::TCShowerAlg::makeShowers(), shower::EMShowerAlg::MakeSpacePoints(), trkmkr::KalmanFilterFitTrackMaker::makeTrack(), trkmkr::TrackMaker::makeTrack(), pma::PMAlgTracker::matchCluster(), btutil::MCBTAlg::MCBTAlg(), cmtool::CMManagerBase::MergeTillConverge(), geo::vect::details::BoundCoordGetter< CoordHelper, StoredVector >::operator Scalar_t(), mvapid::MVAAlg::SumDistance2::operator()(), geo::vect::details::BoundCoordManager< CoordHelper, StoredVector >::operator*=(), geo::vect::details::BoundCoordManager< CoordHelper, StoredVector >::operator+=(), geo::vect::details::BoundCoordManager< CoordHelper, StoredVector >::operator-=(), geo::vect::details::BoundCoordManager< CoordHelper, StoredVector >::operator/=(), geo::vect::details::BoundCoordManager< CoordHelper, StoredVector >::operator=(), larg4::OpFastScintillation::OpFastScintillation(), cheat::PhotonBackTracker::OpHitToSimSDPs(), cheat::PhotonBackTracker::OpHitToTrackID(), shower::EMShowerAlg::OrderShowerHits(), nnet::PointIdAlg::outputLabels(), cmtool::PlaneClusterCombinations(), PointIdAlgTools::PointIdAlgKeras::PointIdAlgKeras(), DUNE::MuonTrackingEff::processEff(), art::Principal::processHistoryID(), trk::TrackContainmentAlg::ProcessTracks(), trkf::SpacePointCheater::produce(), trkf::SpacePointFinder::produce(), trkf::TrackStitcher::produce(), vertex::PrimaryVertexFinder::produce(), trkf::SpacePts::produce(), cluster::TrajCluster::produce(), trkf::TrackKalmanCheater::produce(), evd::GraphCluster::produce(), NuGraphInference::produce(), shower::EMShower::produce(), pma::ProjectionMatchingAlg::ProjectionMatchingAlg(), cheat::PhotonBackTrackerService::provider(), cheat::BackTrackerService::provider(), shower::EMShowerAlg::RelativeWireWidth_(), art::RPManager::RPManager(), tf::Graph::run(), nnet::ModelInterface::Run(), nnet::TfModelInterface::Run(), evd::HitSelector::SaveSeedLines(), cluster::SmallClusterFinderAlg::SelectLocalHitlist(), shower::TrackShowerSeparationAlg::SelectShowerHits(), util::SignalShaper::set_normflag(), cluster::ClusterMatchAlg::SetMCTruthModName(), cluster::ClusterMergeAlg::SetSquaredDistanceCut(), cluster::ClusterMergeAlg::SetTime2Cm(), shower::EMShowerAlg::ShowerCenter_(), shower::EMShowerAlg::ShowerDirection_(), shower::EMShowerAlg::ShowerHitRMS_(), shower::TrackShowerSeparationAlg::SpacePointsRMS(), cluster::ClusterMatchAlg::StoreSpacePoints(), trkf::TrackKalmanFitter::TrackKalmanFitter(), lcvn::PixelMapProducer< T, U >::TRes(), shower::LArPandoraShowerCheatingAlg::TrueParticleIDFromTrueChain(), pma::ProjectionMatchingAlg::validate(), art::OutputModule::writeProductDescriptionRegistry(), btutil::MCMatchAlg::~MCMatchAlg(), nnet::ModelInterface::~ModelInterface(), and geoalgo::Trajectory::~Trajectory().
auto lar::dump::vector3D | ( | Vector3D const & | v | ) |
Returns a manipulator which will print the specified vector.
Vector3D | the type of 3D vector to be printed |
v | the vector to be printed |
Example of usage:
will produce an output like:
Addition of specific classes can be achieved via specialization of the class VectorDumper
.
Vector3D
is required to provide constant accessor methods returning the vector components, called X()
, Y()
and Z()
Vector3D
methods must have their insertion operator into a stream definedv
must not fall out of scope until the insertion into the stream happens Definition at line 326 of file DumpUtils.h.
Referenced by phot::PhotonLibraryAnalyzer::beginJob(), checkTPCcoords(), detectGlobalDriftDir(), and sim::dump::DumpMCParticle().