art::ProductRetriever Class Reference

#include "ProductRetriever.h"

Inheritance diagram for art::ProductRetriever:

Public Member Functions
	~ProductRetriever ()
	ProductRetriever (BranchType bt, Principal const &p, ModuleContext const &mc, bool recordParents)
	ProductRetriever (ProductRetriever const &)=delete
	ProductRetriever (ProductRetriever &&)=delete
ProductRetriever &	operator= (ProductRetriever const &)=delete
ProductRetriever &	operator= (ProductRetriever &)=delete
template<typename PROD >
PROD const &	getProduct (InputTag const &tag) const
template<typename PROD >
PROD const &	getProduct (ProductToken< PROD > const &token) const
template<typename PROD >
Handle< PROD >	getHandle (SelectorBase const &) const
template<typename PROD >
Handle< PROD >	getHandle (ProductID const pid) const
template<typename PROD >
Handle< PROD >	getHandle (InputTag const &tag) const
template<typename PROD >
Handle< PROD >	getHandle (ProductToken< PROD > const &token) const
template<typename PROD >
ValidHandle< PROD >	getValidHandle (InputTag const &tag) const
template<typename PROD >
ValidHandle< PROD >	getValidHandle (ProductToken< PROD > const &token) const
template<typename PROD >
std::vector< InputTag >	getInputTags (SelectorBase const &selector=MatchAllSelector{}) const
template<typename PROD >
std::vector< ProductToken< PROD > >	getProductTokens (SelectorBase const &selector=MatchAllSelector{}) const
template<typename PROD >
std::vector< Handle< PROD > >	getMany (SelectorBase const &selector=MatchAllSelector{}) const
template<typename PROD >
bool	get (SelectorBase const &, Handle< PROD > &result) const
template<typename PROD >
bool	get (ProductID const pid, Handle< PROD > &result) const
template<typename PROD >
bool	getByLabel (std::string const &label, std::string const &instance, Handle< PROD > &result) const
template<typename PROD >
bool	getByLabel (std::string const &label, std::string const &instance, std::string const &process, Handle< PROD > &result) const
template<typename PROD >
bool	getByLabel (InputTag const &tag, Handle< PROD > &result) const
template<typename ELEMENT >
std::size_t	getView (std::string const &moduleLabel, std::string const &productInstanceName, std::string const &processName, std::vector< ELEMENT const * > &result) const
template<typename ELEMENT >
std::size_t	getView (std::string const &moduleLabel, std::string const &productInstanceName, std::vector< ELEMENT const * > &result) const
template<typename ELEMENT >
std::size_t	getView (InputTag const &, std::vector< ELEMENT const * > &result) const
template<typename ELEMENT >
std::size_t	getView (ViewToken< ELEMENT > const &, std::vector< ELEMENT const * > &result) const
template<typename ELEMENT >
bool	getView (std::string const &moduleLabel, std::string const &productInstanceName, std::string const &processName, View< ELEMENT > &result) const
template<typename ELEMENT >
bool	getView (std::string const &moduleLabel, std::string const &productInstanceName, View< ELEMENT > &result) const
template<typename ELEMENT >
bool	getView (InputTag const &, View< ELEMENT > &result) const
template<typename ELEMENT >
bool	getView (ViewToken< ELEMENT > const &, View< ELEMENT > &result) const
std::vector< ProductID >	retrievedPIDs () const
std::optional< Provenance const >	getProductProvenance (ProductID) const
std::optional< fhicl::ParameterSet const >	getProcessParameterSet (std::string const &process) const
cet::exempt_ptr< BranchDescription const >	getProductDescription (ProductID) const
EDProductGetter const *	productGetter (ProductID const pid) const
template<typename T >
ProductID	getProductID (std::string const &instance_name="") const

Private Member Functions
void	recordAsParent_ (cet::exempt_ptr< Group const > grp) const
cet::exempt_ptr< Group const >	getContainerForView_ (TypeID const &, std::string const &moduleLabel, std::string const &productInstanceName, ProcessTag const &processTag) const
ProductID	getProductID_ (TypeID const &typeID, std::string const &instance) const
std::vector< InputTag >	getInputTags_ (WrappedTypeID const &wrapped, SelectorBase const &selector) const
GroupQueryResult	getByLabel_ (WrappedTypeID const &wrapped, InputTag const &tag) const
GroupQueryResult	getBySelector_ (WrappedTypeID const &wrapped, SelectorBase const &selector) const
GroupQueryResult	getByProductID_ (ProductID productID) const
std::vector< GroupQueryResult >	getMany_ (WrappedTypeID const &wrapped, SelectorBase const &sel) const

Private Attributes
std::recursive_mutex	mutex_ {}
BranchType const	branchType_
Principal const &	principal_
ModuleContext const &	mc_
ModuleDescription const &	md_
bool const	recordParents_
std::set< ProductID >	retrievedProducts_ {}

Detailed Description

Definition at line 49 of file ProductRetriever.h.

Constructor & Destructor Documentation

art::ProductRetriever::~ProductRetriever ( )

default

art::ProductRetriever::ProductRetriever ( BranchType  bt, Principal const &  p, ModuleContext const &  mc, bool  recordParents  )

explicit

Definition at line 34 of file ProductRetriever.cc.

References mc_, md_, principal_, and recordParents_.

    : branchType_{bt}
    , principal_{principal}
    , mc_{mc}
    , md_{mc.moduleDescription()}
    , recordParents_{recordParents}
  {}

art::ProductRetriever::ProductRetriever ( ProductRetriever const &  )

delete

art::ProductRetriever::ProductRetriever ( ProductRetriever &&  )

delete

Member Function Documentation

template<typename PROD >

bool art::ProductRetriever::get	(	SelectorBase const &	sel,
		Handle< PROD > &	result
	)		const

Definition at line 417 of file ProductRetriever.h.

Referenced by art::Observer::getTriggerResults(), and art::detail::ProcessAndEventSelector::triggerResults().

  {
    result = getHandle<PROD>(sel);
    return static_cast<bool>(result);
  }

template<typename PROD >

bool art::ProductRetriever::get	(	ProductID const	pid,
		Handle< PROD > &	result
	)		const

Definition at line 425 of file ProductRetriever.h.

  {
    result = getHandle<PROD>(pid);
    return static_cast<bool>(result);
  }

template<typename PROD >

bool art::ProductRetriever::getByLabel	(	std::string const &	label,
		std::string const &	instance,
		Handle< PROD > &	result
	)		const

Definition at line 444 of file ProductRetriever.h.

Referenced by lar::util::details::FindAllP< Source, Dest >::Add(), reco3d::PlotSpacePoints::analyze(), opdet::OpDigiAna::analyze(), opdet::FIFOHistogramAna::analyze(), opdet::OpFlashMCTruthAna::analyze(), cheat::CheckBackTracking::analyze(), calo::PrintCalorimetry::analyze(), opdet::OpFlashSimpleAna::analyze(), shower::TCShowerAnalysis::analyze(), opdet::OpHitAna::analyze(), opdet::OpFlashAna::analyze(), pid::PIDAAnalyzer::analyze(), trk::TrackContainmentAnalyzer::analyze(), MCBTDemo::analyze(), vertex::AggregateVertexAna::analyze(), detsim::SimWireAna::analyze(), shower::TCShowerElectronLikelihood::analyze(), shower::TCShowerTemplateMaker::analyze(), detsim::WienerFilterAna::analyze(), larg4::ISCalcAna::analyze(), microboone::CosmicRemovalAna::analyze(), vertex::FeatureVertexFinderAna::analyze(), cluster::HoughLineFinderAna::analyze(), opdet::FlashHypothesisAna::analyze(), hit::MagDriftAna::analyze(), pfpf::PFPAna::analyze(), calo::CaloChecker::analyze(), pdsp::CheckCNNScore::analyze(), caldata::CalWireAna::analyze(), opreco::OpticalRecoAna::analyze(), cluster::ClusterAna::analyze(), cluster::ClusterPCA::analyze(), lar_pandora::ConsolidatedPFParticleAnalysisTemplate::analyze(), opdet::LEDCalibrationAna::analyze(), hit::GausHitFinderAna::analyze(), hit::HitAnaModule::analyze(), cluster::DBclusterAna::analyze(), hit::HitFinderAna::analyze(), trkf::SpacePointAna::analyze(), cluster::ClusterTrackAna::analyze(), cheat::RecoCheckAna::analyze(), rwgt::ReweightAna::analyze(), nnet::EvaluateROIEff::analyze(), NuShowerEff::analyze(), nnet::RawWaveformDump::analyze(), nnet::PointIdEffTest::analyze(), nnet::RawWaveformClnSigDump::analyze(), ems::MultiEMShowers::analyze(), lar::example::AnalysisExample::analyze(), trkf::SeedAna::analyze(), trkf::TrackAna::analyze(), ClusteringValidation::ClusteringValidation::analyze(), trkf::TrackAna::anaStitch(), lar_pandora::LArPandoraHelper::BuildMCParticleHitMaps(), evd::AnalysisBaseDrawer::CalorShower(), evd::HitSelector::ChangeHit(), lar_cluster3d::StandardHit3DBuilder::CollectArtHits(), lar_cluster3d::SnippetHit3DBuilder::CollectArtHits(), lar_pandora::LArPandoraHelper::CollectClusters(), lar_pandora::LArPandoraHelper::CollectCosmicTags(), lar_pandora::LArPandoraHelper::CollectGeneratorMCParticles(), lar_pandora::LArPandoraHelper::CollectHits(), lar_pandora::LArPandoraHelper::CollectMCParticles(), lar_pandora::LArPandoraSliceIdHelper::CollectNeutrinoMCParticles(), lar_pandora::LArPandoraHelper::CollectPFParticleMetadata(), lar_pandora::LArPandoraExternalEventBuilding::CollectPFParticles(), lar_pandora::LArPandoraHelper::CollectPFParticles(), lar_pandora::LArPandoraHelper::CollectSeeds(), ems::EMShower3D::CollectShower2D(), lar_pandora::LArPandoraHelper::CollectShowers(), lar_pandora::LArPandoraHelper::CollectSimChannels(), lar_pandora::LArPandoraHelper::CollectSpacePoints(), lar_pandora::LArPandoraHelper::CollectT0s(), lar_pandora::LArPandoraHelper::CollectTracks(), lar_pandora::LArPandoraHelper::CollectVertices(), lar_pandora::LArPandoraHelper::CollectWires(), ems::MultiEMShowers::convCluster(), t0::IndirectHitParticleAssns::CreateHitParticleAssociations(), t0::DirectHitParticleAssns::CreateHitParticleAssociations(), evdb_tool::DrawSimPhoton3D::Draw(), evdb_tool::DrawLArVoxel3D::Draw(), evdb_tool::DrawSimEnergyDeposit3D::drawAll(), evd::AnalysisBaseDrawer::DrawDeDx(), evd::AnalysisBaseDrawer::DrawKineticEnergy(), evdb_tool::DrawSimEnergyDeposit3D::drawMCPartAssociated(), evd::RecoBaseDrawer::DrawTrackVertexAssns2D(), lcvn::LArNuCVNZlibMaker::endSubRun(), sim::POTaccumulator::endSubRun(), filt::LArG4ParticleFilter::filter(), filt::FinalStateParticleFilter::filter(), simfilter::FilterNoDirtNeutrinos::filter(), filter::MuonFilter::filter(), trkf::StitchAlg::FindHeadsAndTails(), anab::FVectorReader< T, N >::FVectorReader(), trkf::Track3DKalmanHit::getAllHits(), lar_pandora::LArPandoraHelper::GetAssociatedHits(), lar_pandora::LArPandoraSliceIdHelper::GetBeamNeutrinoMCTruth(), trkf::Track3DKalmanHit::getClusteredHits(), evd::RecoBaseDrawer::GetClusters(), evd::RecoBaseDrawer::GetEdges(), evd::RecoBaseDrawer::GetEndPoint2D(), evd::RecoBaseDrawer::GetEvents(), lar_pandora::LArPandoraSliceIdHelper::GetHitOrigins(), trkf::SeedFinderModule::GetHitsFromEvent(), evd::RecoBaseDrawer::GetOpFlashes(), evd::RecoBaseDrawer::GetPFParticles(), trkf::Track3DKalmanHit::getPFParticleStuff(), lar_pandora::LArPandoraSliceIdHelper::GetPFParticleToHitsMap(), evd::RecoBaseDrawer::GetSeeds(), sim::SimListUtils::GetSimPhotonsCollection(), evd::RecoBaseDrawer::GetSlices(), trkf::SeedFinderModule::GetSortedHitsFromClusters(), evd::RecoBaseDrawer::GetSpacePoints(), evd::RecoBaseDrawer::GetVertices(), quad::GetVtxByAssns(), evd::RecoBaseDrawer::GetWires(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), lar_pandora::LArPandoraEventDump::PandoraData::LoadCollection(), evgb::MCTruthAndFriendsItr::MCTruthAndFriendsItr(), mvapid::MVAAlg::PrepareEvent(), wc::CellTree::processCalib(), DUNE::NeutrinoShowerEff::processEff(), DUNE::MuonTrackingEff::processEff(), DUNE::NeutrinoTrackingEff::processEff(), wc::CellTree::processMC(), wc::CellTree::processOpFlash(), wc::CellTree::processOpHit(), wc::CellTree::processRaw(), wc::CellTree::processSimChannel(), wc::CellTree::processSpacePointTruthDepo(), wc::CellTree::processTrigger(), opdet::OpticalRawDigitReformatter::produce(), pid::Chi2ParticleID::produce(), cosmic::TrackPFParticleMatch::produce(), MCReco::produce(), vertex::VertexCheater::produce(), hit::DisambigCheater::produce(), hit::MCHitFinder::produce(), shwf::ShowerCheater::produce(), trk::TrackContainmentTagger::produce(), event::EventCheater::produce(), cosmic::CosmicClusterTagger::produce(), trkf::FeatureTracker::produce(), cosmic::CosmicTrackTagger::produce(), hit::TTHitFinder::produce(), trkf::SpacePointCheater::produce(), trkf::SpacePointFinder::produce(), apa::APAHitFinder::produce(), hit::RawHitFinder::produce(), cosmic::CosmicPFParticleTagger::produce(), sppt::TTSpacePointFinder::produce(), trkf::TrackCheater::produce(), hit::RFFHitFinder::produce(), hit::FFTHitFinder::produce(), cluster::ClusterCheater::produce(), shwf::ShowerFinder::produce(), trkf::TrackStitcher::produce(), noisefilteralg::WireCellNoiseFilter::produce(), vertex::PrimaryVertexFinder::produce(), cluster::DBcluster::produce(), caldata::CalWire::produce(), cosmic::BeamFlashTrackMatchTagger::produce(), cluster::EndPointModule::produce(), caldata::CalWireT962::produce(), cluster::LineMerger::produce(), reco3d::SpacePointSolver::produce(), cosmic::CosmicPCAxisTagger::produce(), shower::TCShower::produce(), CRHitRemoval::produce(), calo::TrackCalorimetry::produce(), trkf::SpacePts::produce(), ShowerReco3D::produce(), t0::MCParticleTrackMatching::produce(), trkf::Track3Dreco::produce(), t0::MCParticleShowerMatching::produce(), cluster::BlurredClustering::produce(), nnet::WaveformRoiFinder::produce(), sce::SCECorrection::produce(), cluster::TrajCluster::produce(), trkf::MCSFitProducer::produce(), ems::EMShower3D::produce(), phot::PDFastSimPVS::produce(), trkf::CCTrackMaker::produce(), shwf::ShowerReco::produce(), phot::PDFastSimANN::produce(), trkf::Track3DKalman::produce(), hit::GausHitFinder::produce(), cluster::SmallClusterFinder::produce(), trkf::TrackKalmanCheater::produce(), quad::QuadVtx::produce(), hit::DPRawHitFinder::produce(), CRHitRemovalByPCA::produce(), vertex::VertexFinder2D::produce(), lbne::PhotonCounterT0Matching::produce(), NuGraphInference::produce(), vertex::FeatureVertexFinder::produce(), shower::EMShower::produce(), trkf::PMAlgTrajFitter::produce(), detsim::DriftElectronstoPlane::produce(), t0::MCTruthT0Matching::produce(), calo::Calorimetry::produce(), trkf::Track3DKalmanSPS::produce(), detsim::SimDriftElectrons::produce(), trkf::KalmanFilterTrajectoryFitter::produce(), calo::GnocchiCalorimetry::produce(), phot::PDFastSimPAR::produce(), opdet::OpHitFinder::produce(), trkf::CosmicTracker::produce(), larg4::LArG4::produce(), evd::details::RawDigitCacheDataClass::ReadProduct(), evd::InfoTransfer::Rebuild(), cheat::PhotonBackTracker::Rebuild(), evd::HitSelector::SaveHits(), evd::HitSelector::SaveSeedLines(), cluster::ClusterMergeHelper::SetClusters(), nnet::TrainingDataAlg::setDataEventData(), tss::TrackShowerHits::sortHits(), and evd::details::RawDigitCacheDataClass::Update().

  {
    result = getHandle<PROD>({moduleLabel, instance});
    return static_cast<bool>(result);
  }

template<typename PROD >

bool art::ProductRetriever::getByLabel	(	std::string const &	label,
		std::string const &	instance,
		std::string const &	process,
		Handle< PROD > &	result
	)		const

Definition at line 433 of file ProductRetriever.h.

  {
    result = getHandle<PROD>({moduleLabel, productInstanceName, processName});
    return static_cast<bool>(result);
  }

template<typename PROD >

bool art::ProductRetriever::getByLabel	(	InputTag const &	tag,
		Handle< PROD > &	result
	)		const

Definition at line 454 of file ProductRetriever.h.

  {
    result = getHandle<PROD>(tag);
    return static_cast<bool>(result);
  }

GroupQueryResult art::ProductRetriever::getByLabel_ ( WrappedTypeID const &  wrapped, InputTag const &  tag  ) const

private

Definition at line 202 of file ProductRetriever.cc.

References branchType_, art::GroupQueryResult::failed(), art::Principal::getByLabel(), art::InputTag::instance(), art::ConsumesInfo::instance(), art::InputTag::label(), mc_, md_, mutex_, principal_, art::InputTag::process(), art::ModuleDescription::processName(), art::ProductInfo::Product, art::WrappedTypeID::product_type, recordAsParent_(), recordParents_, art::GroupQueryResult::result(), art::GroupQueryResult::succeeded(), and art::ConsumesInfo::validateConsumedProduct().

  {
    std::lock_guard lock{mutex_};
    ProcessTag const processTag{tag.process(), md_.processName()};
    ProductInfo const pinfo{ProductInfo::ConsumableType::Product,
                            wrapped.product_type,
                            tag.label(),
                            tag.instance(),
                            processTag};
    ConsumesInfo::instance()->validateConsumedProduct(branchType_, md_, pinfo);
    GroupQueryResult qr = principal_.getByLabel(
      mc_, wrapped, tag.label(), tag.instance(), processTag);
    bool const ok = qr.succeeded() && !qr.failed();
    if (recordParents_ && ok) {
      recordAsParent_(qr.result());
    }
    return qr;
  }

GroupQueryResult art::ProductRetriever::getByProductID_ ( ProductID  productID ) const

private

Definition at line 238 of file ProductRetriever.cc.

References art::Principal::getByProductID(), mutex_, principal_, recordAsParent_(), recordParents_, and art::GroupQueryResult::succeeded().

  {
    std::lock_guard lock{mutex_};
    auto qr = principal_.getByProductID(pid);
    bool const ok = qr.succeeded() && !qr.failed();
    if (recordParents_ && ok) {
      recordAsParent_(qr.result());
    }
    return qr;
  }

GroupQueryResult art::ProductRetriever::getBySelector_ ( WrappedTypeID const &  wrapped, SelectorBase const &  selector  ) const

private

Definition at line 223 of file ProductRetriever.cc.

References art::Principal::getBySelector(), mc_, md_, mutex_, principal_, art::ModuleDescription::processName(), recordAsParent_(), recordParents_, and art::GroupQueryResult::succeeded().

  {
    std::lock_guard lock{mutex_};
    // We do *not* track whether consumes was called for a SelectorBase.
    ProcessTag const processTag{"", md_.processName()};
    auto qr = principal_.getBySelector(mc_, wrapped, sel, processTag);
    bool const ok = qr.succeeded() && !qr.failed();
    if (recordParents_ && ok) {
      recordAsParent_(qr.result());
    }
    return qr;
  }

cet::exempt_ptr< Group const > art::ProductRetriever::getContainerForView_ ( TypeID const &  typeID, std::string const &  moduleLabel, std::string const &  productInstanceName, ProcessTag const &  processTag  ) const

private

Definition at line 114 of file ProductRetriever.cc.

References branchType_, e, art::Principal::getMatchingSequence(), art::ConsumesInfo::instance(), mc_, md_, art::ProcessTag::name(), principal_, art::errors::ProductNotFound, art::resolve_products(), art::TypeID::typeInfo(), art::detail::upcastAllowed(), art::ConsumesInfo::validateConsumedProduct(), and art::ProductInfo::ViewElement.

  {
    // Check that the consumesView<ELEMENT, BT>(InputTag),
    // or the mayConsumeView<ELEMENT, BT>(InputTag)
    // is actually present.
    ConsumesInfo::instance()->validateConsumedProduct(
      branchType_,
      md_,
      ProductInfo{ProductInfo::ConsumableType::ViewElement,
                  typeID,
                  moduleLabel,
                  productInstanceName,
                  processTag});
    // Fetch the specified data products, which must be containers.
    auto const groups = principal_.getMatchingSequence(
      mc_,
      Selector{ModuleLabelSelector{moduleLabel} &&
               ProductInstanceNameSelector{productInstanceName} &&
               ProcessNameSelector{processTag.name()}},
      processTag);
    auto qrs = resolve_products(groups, TypeID{});
    // Remove any containers that do not allow upcasting of their
    // elements to the desired element type.
    auto new_end =
      remove_if(qrs.begin(), qrs.end(), [&typeID](auto const& gqr) {
        auto const group = gqr.result();
        assert(group->productDescription().supportsView());
        return !detail::upcastAllowed(*group->uniqueProduct()->typeInfo(),
                                      typeID.typeInfo());
      });
    qrs.erase(new_end, qrs.end());
    // Throw if there is not one and only one container to return.
    if (qrs.size() != 1) {
      Exception e{errors::ProductNotFound};
      e << "getView: Found "
        << (qrs.empty() ? "no products" : "more than one product")
        << " matching all criteria\n"
        << "Looking for sequence of type: " << typeID << '\n'
        << "Looking for module label: " << moduleLabel << '\n'
        << "Looking for productInstanceName: " << productInstanceName << '\n';
      if (!processTag.name().empty()) {
        e << "Looking for processName: " << processTag.name() << '\n';
      }
      throw e;
    }
    // And return the single result.
    return qrs[0].result();
  }

template<typename PROD >

Handle< PROD > art::ProductRetriever::getHandle

(

SelectorBase const &

sel

)

const

Definition at line 236 of file ProductRetriever.h.

Referenced by NuGraphAnalyzer::analyze(), lcvn::LArNuCVNZlibMaker::analyze(), opdet::SimPhotonCounter::analyze(), shower::TCShower::getShowersWithoutSlices(), shower::TCShower::getShowersWithSlices(), larg4::larg4Main::inputCollections(), lcvn::LArCVNEvaluator::produce(), lcvn::ICVNMapper< T, U >::produce(), evgb::RetrieveGHEPs(), dnn::SavePiMu::saveImage(), and art::TriggerNamesService::triggerResults().

  {
    auto qr = getBySelector_(WrappedTypeID::make<PROD>(), sel);
    return Handle<PROD>{qr};
  }

template<typename PROD >

Handle< PROD > art::ProductRetriever::getHandle

(

ProductID const

pid

)

const

Definition at line 244 of file ProductRetriever.h.

  {
    auto qr = getByProductID_(pid);
    return Handle<PROD>{qr};
  }

template<typename PROD >

Handle< PROD > art::ProductRetriever::getHandle

(

InputTag const &

tag

)

const

Definition at line 252 of file ProductRetriever.h.

  {
    auto qr = getByLabel_(WrappedTypeID::make<PROD>(), tag);
    return Handle<PROD>{qr};
  }

template<typename PROD >

Handle< PROD > art::ProductRetriever::getHandle

(

ProductToken< PROD > const &

token

)

const

Definition at line 260 of file ProductRetriever.h.

References art::ProductToken< T >::inputTag().

  {
    return getHandle<PROD>(token.inputTag());
  }

template<typename PROD >

std::vector< InputTag > art::ProductRetriever::getInputTags

(

SelectorBase const &

selector = MatchAllSelector{}

)

const

Definition at line 283 of file ProductRetriever.h.

  {
    return getInputTags_(WrappedTypeID::make<PROD>(), selector);
  }

std::vector< InputTag > art::ProductRetriever::getInputTags_ ( WrappedTypeID const &  wrapped, SelectorBase const &  selector  ) const

private

Definition at line 194 of file ProductRetriever.cc.

References art::Principal::getInputTags(), mc_, md_, principal_, and art::ModuleDescription::processName().

  {
    ProcessTag const processTag{"", md_.processName()};
    return principal_.getInputTags(mc_, wrapped, selector, processTag);
  }

template<typename PROD >

std::vector< Handle< PROD > > art::ProductRetriever::getMany

(

SelectorBase const &

selector = MatchAllSelector{}

)

const

Definition at line 303 of file ProductRetriever.h.

Referenced by opdet::PhotonInf::analyze(), opdet::SimPhotonCounter::analyze(), nnet::RawWaveformDump::analyze(), nnet::RawWaveformClnSigDump::analyze(), artg4tk::dataFromRunOrService(), evd::RecoBaseDrawer::DrawShower3D(), evd::RecoBaseDrawer::DrawShowerOrtho(), evd::RecoBaseDrawer::DrawTrack3D(), evd::RecoBaseDrawer::DrawTrackOrtho(), simfilter::FilterCryostatNus::filter(), simfilter::FilterGenInTime::filter(), artg4tk::PrimaryEventActionService::generatePrimaries(), evdb_tool::DrawLArVoxel3D::GetMCTruth(), evd::SimulationDrawer::GetMCTruth(), evwgh::PPFXThinNucAWeightCalc::GetWeight(), evwgh::PPFXCVWeightCalc::GetWeight(), evwgh::PPFXTotAbsorpWeightCalc::GetWeight(), evwgh::PPFXWeightCalc::GetWeight(), evwgh::PPFXMIPPPionWeightCalc::GetWeight(), evwgh::PPFXOtherWeightCalc::GetWeight(), evwgh::PPFXTargAttenWeightCalc::GetWeight(), evwgh::PPFXThinKaonWeightCalc::GetWeight(), evwgh::PPFXThinMesonWeightCalc::GetWeight(), evwgh::PPFXMIPPKaonWeightCalc::GetWeight(), evwgh::PPFXThinNucWeightCalc::GetWeight(), evwgh::PPFXThinPionWeightCalc::GetWeight(), evwgh::PPFXThinNeutronPionWeightCalc::GetWeight(), larg4::IonAndScint::inputCollections(), larg4::larg4Main::inputCollections(), evgb::MCTruthAndFriendsItr::MCTruthAndFriendsItr(), geo::AuxDetGeometry::preBeginRun(), sim::GenericCRT::produce(), sim::PhotonHitConverter::produce(), larg4::LArG4::produce(), geo::GeometryConfigurationWriter::readRunData(), and evdb::ScanFrame::Record().

  {
    auto const qrs = getMany_(WrappedTypeID::make<PROD>(), sel);
    std::vector<Handle<PROD>> products;
    products.reserve(qrs.size());
    cet::transform_all(qrs, back_inserter(products), [](auto const& qr) {
      return Handle<PROD>{qr};
    });
    return products;
  }

std::vector< GroupQueryResult > art::ProductRetriever::getMany_ ( WrappedTypeID const &  wrapped, SelectorBase const &  sel  ) const

private

Definition at line 250 of file ProductRetriever.cc.

References branchType_, art::Principal::getMany(), art::ConsumesInfo::instance(), art::ProductInfo::Many, mc_, md_, mutex_, principal_, art::ModuleDescription::processName(), art::WrappedTypeID::product_type, recordAsParent_(), recordParents_, and art::ConsumesInfo::validateConsumedProduct().

  {
    std::lock_guard lock{mutex_};
    ConsumesInfo::instance()->validateConsumedProduct(
      branchType_,
      md_,
      ProductInfo{ProductInfo::ConsumableType::Many, wrapped.product_type});
    ProcessTag const processTag{"", md_.processName()};
    auto qrs = principal_.getMany(mc_, wrapped, sel, processTag);
    for (auto const& qr : qrs) {
      if (recordParents_) {
        recordAsParent_(qr.result());
      }
    }
    return qrs;
  }

std::optional< fhicl::ParameterSet const > art::ProductRetriever::getProcessParameterSet

(

std::string const &

process

)

const

Definition at line 53 of file ProductRetriever.cc.

References fhicl::ParameterSetRegistry::get(), art::ProcessHistory::getConfigurationForProcess(), mutex_, principal_, and art::Principal::processHistory().

  {
    std::lock_guard lock{mutex_};
    auto const config =
      principal_.processHistory().getConfigurationForProcess(processName);
    if (!config) {
      return std::nullopt;
    }

    if (fhicl::ParameterSet ps;
        fhicl::ParameterSetRegistry::get(config->parameterSetID(), ps)) {
      return std::make_optional(std::move(ps));
    }
    return std::nullopt;
  }

template<typename PROD >

PROD const & art::ProductRetriever::getProduct

(

InputTag const &

tag

)

const

Definition at line 221 of file ProductRetriever.h.

Referenced by pid::DumpParticleIDs::analyze(), evwgh::GenieWeightCalc::GetWeight(), sim::MergeSimSources::produce(), geo::Geometry::ReadConfigurationInfo(), and dnn::SavePiMu::saveImage().

  {
    return *getValidHandle<PROD>(tag);
  }

template<typename PROD >

PROD const & art::ProductRetriever::getProduct

(

ProductToken< PROD > const &

token

)

const

Definition at line 228 of file ProductRetriever.h.

  {
    return *getValidHandle(token);
  }

cet::exempt_ptr< BranchDescription const > art::ProductRetriever::getProductDescription

(

ProductID

pid

)

const

Definition at line 95 of file ProductRetriever.cc.

References art::Principal::getProductDescription(), and principal_.

  {
    return principal_.getProductDescription(pid);
  }

template<typename PROD >

ProductID art::ProductRetriever::getProductID

(

std::string const &

instance_name = ""

)

const

Definition at line 213 of file ProductRetriever.h.

Referenced by evgb::util::CreateAssn(), trkf::Track3DKalmanHit::createOutputs(), trkf::SpacePointCheater::produce(), trkf::SpacePointFinder::produce(), larg4::larg4Main::produce(), shwf::ShowerReco::produce(), trkf::TrackKalmanCheater::produce(), evd::GraphCluster::produce(), trkf::PMAlgTrajFitter::produce(), trkf::KalmanFilterTrajectoryFitter::produce(), and trkf::KalmanFilterFinalTrackFitter::produce().

  {
    return getProductID_(TypeID{typeid(PROD)}, instance);
  }

ProductID art::ProductRetriever::getProductID_ ( TypeID const &  typeID, std::string const &  instance  ) const

private

Definition at line 167 of file ProductRetriever.cc.

References branchType_, art::canonicalProductName(), art::TypeID::friendlyClassName(), art::Principal::getProductDescription(), instance, md_, art::ModuleDescription::moduleLabel(), mutex_, principal_, art::ModuleDescription::processName(), and art::errors::ProductRegistrationFailure.

  {
    std::lock_guard lock{mutex_};
    auto const& product_name = canonicalProductName(
      type.friendlyClassName(), md_.moduleLabel(), instance, md_.processName());
    ProductID const pid{product_name};
    auto desc = principal_.getProductDescription(pid);
    if (!desc) {
      throw Exception(errors::ProductRegistrationFailure,
                      "ProductRetriever::getProductID: error while trying to "
                      "retrieve product description:\n")
        << "No product is registered for\n"
        << "  process name:                '" << md_.processName() << "'\n"
        << "  module label:                '" << md_.moduleLabel() << "'\n"
        << "  product friendly class name: '" << type.friendlyClassName()
        << "'\n"
        << "  product instance name:       '" << instance << "'\n"
        << "  branch type:                 '" << branchType_ << "'\n";
    }
    // The description object is owned by either the source or the
    // event processor, whose lifetimes exceed that of the
    // ProductRetriever object.  It is therefore safe to dereference.
    return desc->productID();
  }

std::optional< Provenance const > art::ProductRetriever::getProductProvenance

(

ProductID

pid

)

const

Definition at line 78 of file ProductRetriever.cc.

References art::Principal::getByProductID(), principal_, and art::GroupQueryResult::result().

  {
    auto gqr = principal_.getByProductID(pid);
    if (gqr.failed()) {
      return std::nullopt;
    }

    auto group = gqr.result();
    if (!group->productProvenance()) {
      // This can happen if someone tries to access the provenance
      // before the product has been produced.
      return std::nullopt;
    }
    return std::make_optional<Provenance const>(group);
  }

template<typename PROD >

std::vector< ProductToken< PROD > > art::ProductRetriever::getProductTokens

(

SelectorBase const &

selector = MatchAllSelector{}

)

const

Definition at line 290 of file ProductRetriever.h.

  {
    auto const tags = getInputTags<PROD>(selector);
    std::vector<ProductToken<PROD>> tokens;
    tokens.reserve(tags.size());
    cet::transform_all(tags, back_inserter(tokens), [](auto const& tag) {
      return ProductToken<PROD>{tag};
    });
    return tokens;
  }

template<typename PROD >

ValidHandle< PROD > art::ProductRetriever::getValidHandle

(

InputTag const &

tag

)

const

Definition at line 268 of file ProductRetriever.h.

References art::ValidHandle< T >::product().

Referenced by quad::EvalVtx::analyze(), hit::MCHitAnaExample::analyze(), detsim::SimDriftedElectronClusterAna::analyze(), larg::LArSimChannelAna::analyze(), vertex::FeatureVertexFinderAna::analyze(), ShowerQuality::analyze(), recob::DumpVertices::analyze(), hit::HitAnaModule::analyze(), nnet::WaveformDenoiseTest::analyze(), nnet::NoiseWaveformDump::analyze(), nnet::EvaluateROIEff::analyze(), sim::DumpMCTruth::analyze(), recob::DumpPCAxes::analyze(), recob::DumpSeeds::analyze(), recob::DumpSpacePoints::analyze(), sim::DumpGTruth::analyze(), hit::DumpHits::analyze(), recob::DumpClusters::analyze(), nnet::RawWaveformDump::analyze(), nnet::PointIdEffTest::analyze(), detsim::DumpRawDigits::analyze(), caldata::DumpWires::analyze(), nnet::RawWaveformClnSigDump::analyze(), recob::DumpPFParticles::analyze(), recob::DumpTracks::analyze(), ShowerRecoTools::ShowerExampleTool::CalculateElement(), ShowerRecoTools::ShowerLengthPercentile::CalculateElement(), ShowerRecoTools::ShowerTrackTrajToSpacePoint::CalculateElement(), ShowerRecoTools::Shower3DCylinderTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerTrackHitDirection::CalculateElement(), ShowerRecoTools::ShowerStartPositionCheater::CalculateElement(), ShowerRecoTools::ShowerTrackFinderCheater::CalculateElement(), ShowerRecoTools::ShowerPCAPropergationStartPosition::CalculateElement(), ShowerRecoTools::ShowerPFPVertexStartPosition::CalculateElement(), ShowerRecoTools::Shower2DLinearRegressionTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerLinearEnergy::CalculateElement(), ShowerRecoTools::ShowerDirectionCheater::CalculateElement(), ShowerRecoTools::ShowerTrackPCADirection::CalculateElement(), ShowerRecoTools::ShowerNumElectronsEnergy::CalculateElement(), ShowerRecoTools::ShowerPCADirection::CalculateElement(), ShowerRecoTools::ShowerIncrementalTrackHitFinder::CalculateElement(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), shower::LArPandoraShowerCheatingAlg::CheatDebugEVD(), nnet::EmTrack< N >::classify_hits(), t0::IndirectHitParticleAssns::CreateHitParticleAssociations(), t0::DirectHitParticleAssns::CreateHitParticleAssociations(), shower::LArPandoraShowerAlg::DebugEVD(), simfilter::FilterNoMCParticles::filter(), simfilter::FilterSimPhotonTime::filter(), cluster::SmallClusterFilter::filter(), simfilter::FilterSimPhotonLiteTime::filter(), anab::FVectorReader< T, N >::FVectorReader(), quad::GetFirstVertex(), trkmkr::KalmanFilterFitTrackMaker::initEvent(), nnet::EmTrack< N >::make_clusters(), nnet::EmTrack< N >::make_tracks(), MCReco::MakeMCEdep(), lar_cluster3d::StandardHit3DBuilder::makeRawDigitAssns(), lar_cluster3d::SnippetHit3DBuilder::makeRawDigitAssns(), lar_cluster3d::StandardHit3DBuilder::makeWireAssns(), lar_cluster3d::SnippetHit3DBuilder::makeWireAssns(), MCReco::produce(), hit::HitFinder::produce(), trkf::TCTrack::produce(), reco::shower::LArPandoraModularShowerCreation::produce(), cluster::LineCluster::produce(), opdet::OpFlashFinder::produce(), cluster::ClusterCrawler::produce(), hit::HitCheater::produce(), opdet::OpMCDigi::produce(), evwgh::EventWeight::produce(), spacecharge::ShiftEdepSCE::produce(), NuSliceHitsProducer::produce(), cluster::DBCluster3D::produce(), cluster::HoughLineFinder::produce(), TrackProducerFromTrack::produce(), TrackProducerFromTrackTrajectory::produce(), calo::ShowerCalorimetry::produce(), cluster::TrajCluster::produce(), TrackProducerFromPFParticle::produce(), trkf::VertexFitter::produce(), nnet::EmTrack< N >::produce(), nnet::ParticleDecayId::produce(), t0::MCTruthT0Matching::produce(), nnet::EmTrackClusterId2out::produce(), nnet::EmTrackClusterId::produce(), nnet::EmTrackMichelId::produce(), trkf::KalmanFilterTrajectoryFitter::produce(), trkf::PMAlgTrackMaker::produce(), sim::MergeSimSources::produce(), phot::PhotonLibraryPropagation::produce(), and trkf::KalmanFilterFinalTrackFitter::produce().

  {
    auto h = getHandle<PROD>(tag);
    return ValidHandle{h.product(), h.productGetter(), *h.provenance()};
  }

template<typename PROD >

ValidHandle< PROD > art::ProductRetriever::getValidHandle

(

ProductToken< PROD > const &

token

)

const

Definition at line 276 of file ProductRetriever.h.

References art::ProductToken< T >::inputTag().

  {
    return getValidHandle<PROD>(token.inputTag());
  }

template<typename ELEMENT >

std::size_t art::ProductRetriever::getView	(	std::string const &	moduleLabel,
		std::string const &	productInstanceName,
		std::string const &	processName,
		std::vector< ELEMENT const * > &	result
	)		const

Definition at line 316 of file ProductRetriever.h.

Referenced by larg4::LArG4Ana::analyze(), pmtana::PMTAna::analyze(), opdet::SimPhotonCounter::analyze(), evd::RecoBaseDrawer::CountHits(), cluster::ClusterMatchAlg::FillMCInfo(), filter::ADCFilter::filter(), evd::RecoBaseDrawer::GetHits(), sim::SimListUtils::GetLArVoxelList(), evd::SimulationDrawer::GetParticle(), evd::RecoBaseDrawer::GetShowers(), evd::RecoBaseDrawer::GetTracks(), opdet::OpticalRawDigitReformatter::produce(), event::EventCheater::produce(), hit::HitCheater::produce(), detsim::SimWire::produce(), and opdet::OpHitFinder::produce().

  {
    std::lock_guard lock{mutex_};
    std::size_t const orig_size = result.size();
    auto grp = getContainerForView_(TypeID{typeid(ELEMENT)},
                                    moduleLabel,
                                    productInstanceName,
                                    ProcessTag{processName, md_.processName()});
    if (recordParents_) {
      recordAsParent_(grp);
    }
    auto const view = grp->uniqueProduct()->getView();
    std::vector<ELEMENT const*> castedView;
    for (auto p : view) {
      castedView.push_back(static_cast<ELEMENT const*>(p));
    }
    result = std::move(castedView);
    return result.size() - orig_size;
  }

template<typename ELEMENT >

std::size_t art::ProductRetriever::getView	(	std::string const &	moduleLabel,
		std::string const &	productInstanceName,
		std::vector< ELEMENT const * > &	result
	)		const

Definition at line 341 of file ProductRetriever.h.

  {
    return getView(moduleLabel, productInstanceName, {}, result);
  }

template<typename ELEMENT >

std::size_t art::ProductRetriever::getView	(	InputTag const &	tag,
		std::vector< ELEMENT const * > &	result
	)		const

Definition at line 350 of file ProductRetriever.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

  {
    return getView(tag.label(), tag.instance(), tag.process(), result);
  }

template<typename ELEMENT >

std::size_t art::ProductRetriever::getView	(	ViewToken< ELEMENT > const &	token,
		std::vector< ELEMENT const * > &	result
	)		const

Definition at line 358 of file ProductRetriever.h.

References art::ViewToken< Element >::inputTag().

  {
    return getView(token.inputTag(), result);
  }

template<typename ELEMENT >

bool art::ProductRetriever::getView	(	std::string const &	moduleLabel,
		std::string const &	productInstanceName,
		std::string const &	processName,
		View< ELEMENT > &	result
	)		const

Definition at line 366 of file ProductRetriever.h.

  {
    std::lock_guard lock{mutex_};
    auto grp = getContainerForView_(TypeID{typeid(ELEMENT)},
                                    moduleLabel,
                                    productInstanceName,
                                    ProcessTag{processName, md_.processName()});
    if (recordParents_) {
      recordAsParent_(grp);
    }
    auto const view = grp->uniqueProduct()->getView();
    std::vector<ELEMENT const*> castedView;
    for (auto p : view) {
      castedView.push_back(static_cast<ELEMENT const*>(p));
    }
    result =
      View{std::move(castedView), grp->productID(), grp->uniqueProduct()};
    return true;
  }

template<typename ELEMENT >

bool art::ProductRetriever::getView	(	std::string const &	moduleLabel,
		std::string const &	productInstanceName,
		View< ELEMENT > &	result
	)		const

Definition at line 391 of file ProductRetriever.h.

  {
    return getView(moduleLabel, productInstanceName, {}, result);
  }

template<typename ELEMENT >

bool art::ProductRetriever::getView	(	InputTag const &	tag,
		View< ELEMENT > &	result
	)		const

Definition at line 400 of file ProductRetriever.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

  {
    return getView(tag.label(), tag.instance(), tag.process(), result);
  }

template<typename ELEMENT >

bool art::ProductRetriever::getView	(	ViewToken< ELEMENT > const &	token,
		View< ELEMENT > &	result
	)		const

Definition at line 407 of file ProductRetriever.h.

References art::ViewToken< Element >::inputTag().

  {
    return getView(token.inputTag(), result);
  }

ProductRetriever& art::ProductRetriever::operator= ( ProductRetriever const &  )

delete

ProductRetriever& art::ProductRetriever::operator= ( ProductRetriever &  )

delete

EDProductGetter const * art::ProductRetriever::productGetter

(

ProductID const

pid

)

const

Definition at line 46 of file ProductRetriever.cc.

References mutex_, principal_, and art::Principal::productGetter().

Referenced by evgb::util::CreateAssn(), evgb::util::CreateAssnD(), trkf::Track3DKalmanHit::createOutputs(), trkf::SpacePointFinder::produce(), trkf::SpacePointCheater::produce(), larg4::larg4Main::produce(), shwf::ShowerReco::produce(), trkf::TrackKalmanCheater::produce(), evd::GraphCluster::produce(), trkf::PMAlgTrajFitter::produce(), trkf::KalmanFilterTrajectoryFitter::produce(), and trkf::KalmanFilterFinalTrackFitter::produce().

  {
    std::lock_guard lock{mutex_};
    return principal_.productGetter(pid);
  }

void art::ProductRetriever::recordAsParent_ ( cet::exempt_ptr< Group const >  grp ) const

private

Definition at line 101 of file ProductRetriever.cc.

References util::cbegin(), util::cend(), and retrievedProducts_.

Referenced by getByLabel_(), getByProductID_(), getBySelector_(), and getMany_().

  {
    if (grp->productDescription().transient()) {
      // If the product retrieved is transient, don't use its
      // ProductID; use the ProductID's of its parents.
      auto const& parents = grp->productProvenance()->parentage().parents();
      retrievedProducts_.insert(cbegin(parents), cend(parents));
    } else {
      retrievedProducts_.insert(grp->productDescription().productID());
    }
  }

std::vector< ProductID > art::ProductRetriever::retrievedPIDs

(

)

const

Definition at line 70 of file ProductRetriever.cc.

References util::begin(), util::end(), mutex_, and retrievedProducts_.

Referenced by art::Event::commitProducts().

  {
    std::lock_guard lock{mutex_};
    return std::vector<ProductID>(begin(retrievedProducts_),
                                  end(retrievedProducts_));
  }

Member Data Documentation

BranchType const art::ProductRetriever::branchType_

private

Definition at line 189 of file ProductRetriever.h.

Referenced by getByLabel_(), getContainerForView_(), getMany_(), and getProductID_().

ModuleContext const& art::ProductRetriever::mc_

private

Definition at line 195 of file ProductRetriever.h.

Referenced by getByLabel_(), getBySelector_(), getContainerForView_(), getInputTags_(), getMany_(), and ProductRetriever().

ModuleDescription const& art::ProductRetriever::md_

private

Definition at line 198 of file ProductRetriever.h.

Referenced by getByLabel_(), getBySelector_(), getContainerForView_(), getInputTags_(), getMany_(), getProductID_(), and ProductRetriever().

std::recursive_mutex art::ProductRetriever::mutex_ {}

mutableprivate

Definition at line 186 of file ProductRetriever.h.

Referenced by getByLabel_(), getByProductID_(), getBySelector_(), getMany_(), getProcessParameterSet(), getProductID_(), productGetter(), and retrievedPIDs().

Principal const& art::ProductRetriever::principal_

private

Definition at line 192 of file ProductRetriever.h.

Referenced by getByLabel_(), getByProductID_(), getBySelector_(), getContainerForView_(), getInputTags_(), getMany_(), getProcessParameterSet(), getProductDescription(), getProductID_(), getProductProvenance(), productGetter(), and ProductRetriever().

bool const art::ProductRetriever::recordParents_

private

Definition at line 204 of file ProductRetriever.h.

Referenced by getByLabel_(), getByProductID_(), getBySelector_(), getMany_(), and ProductRetriever().

std::set<ProductID> art::ProductRetriever::retrievedProducts_ {}

mutableprivate

Definition at line 208 of file ProductRetriever.h.

Referenced by recordAsParent_(), and retrievedPIDs().

---

The documentation for this class was generated from the following files:

• art/Framework/Principal/ProductRetriever.h
• art/Framework/Principal/ProductRetriever.cc