Logo ROOT  
Reference Guide
Loading...
Searching...
No Matches
ROOT::Internal::RDF::SnapshotHelperWithVariations Class Reference

TTree snapshot helper with systematic variations.

Definition at line 272 of file SnapshotHelpers.hxx.

Public Member Functions

 SnapshotHelperWithVariations (SnapshotHelperWithVariations &&) noexcept=default
 SnapshotHelperWithVariations (SnapshotHelperWithVariations const &) noexcept=delete
 SnapshotHelperWithVariations (std::string_view filename, std::string_view dirname, std::string_view treename, const ColumnNames_t &, const ColumnNames_t &bnames, const RSnapshotOptions &options, std::vector< bool > &&, ROOT::Detail::RDF::RLoopManager *outputLoopMgr, ROOT::Detail::RDF::RLoopManager *inputLoopMgr, const std::vector< const std::type_info * > &colTypeIDs)
 ~SnapshotHelperWithVariations ()=default
auto CallFinalizeTask (unsigned int slot) -> decltype(std::declval< T >().FinalizeTask(slot))
SnapshotHelperWithVariations CallMakeNew (void *typeErasedResSharedPtr, std::string_view variation="nominal")
auto CallPartialUpdate (unsigned int slot) -> decltype(std::declval< H >().PartialUpdate(slot),(void *)(nullptr))
void Exec (unsigned int, const std::vector< void * > &values, std::vector< bool > const &filterPassed)
 Connect all output fields to the values pointed to by values, fill the output dataset, call the Fill of the output tree, and clear the mask bits that show whether a variation was reached.
void Finalize ()
std::string GetActionName ()
virtual std::unique_ptr< RMergeableValueBaseGetMergeableValue () const
virtual ROOT::RDF::SampleCallback_t GetSampleCallback ()
 Override this method to register a callback that is executed before the processing a new data sample starts.
void Initialize ()
 Nothing to do. All initialisations run in the constructor or InitTask().
void InitTask (TTreeReader *, unsigned int slot)
 Bind all output branches to RDF columns for the given slots.
SnapshotHelperWithVariationsoperator= (SnapshotHelperWithVariations &&) noexcept=default
SnapshotHelperWithVariationsoperator= (SnapshotHelperWithVariations const &)=delete
void RegisterVariedColumn (unsigned int slot, unsigned int columnIndex, unsigned int originalColumnIndex, unsigned int varationIndex, std::string const &variationName)
 Register a new column as a variation of the column at originalColumnIndex, and clone its properties.

Private Member Functions

void ClearOutputBranches ()

Private Attributes

std::vector< RBranchDatafBranchData
ROOT::Detail::RDF::RLoopManagerfInputLoopManager = nullptr
TTreefInputTree = nullptr
RSnapshotOptions fOptions
std::shared_ptr< SnapshotOutputWriterfOutputHandle
ROOT::Detail::RDF::RLoopManagerfOutputLoopManager = nullptr

#include <ROOT/RDF/SnapshotHelpers.hxx>

Inheritance diagram for ROOT::Internal::RDF::SnapshotHelperWithVariations:
ROOT::Detail::RDF::RActionImpl< SnapshotHelperWithVariations >

Constructor & Destructor Documentation

◆ SnapshotHelperWithVariations() [1/3]

ROOT::Internal::RDF::SnapshotHelperWithVariations::SnapshotHelperWithVariations ( std::string_view filename,
std::string_view dirname,
std::string_view treename,
const ColumnNames_t & vbnames,
const ColumnNames_t & bnames,
const RSnapshotOptions & options,
std::vector< bool > && isDefine,
ROOT::Detail::RDF::RLoopManager * outputLoopMgr,
ROOT::Detail::RDF::RLoopManager * inputLoopMgr,
const std::vector< const std::type_info * > & colTypeIDs )

Definition at line 1116 of file RDFSnapshotHelpers.cxx.

◆ SnapshotHelperWithVariations() [2/3]

ROOT::Internal::RDF::SnapshotHelperWithVariations::SnapshotHelperWithVariations ( SnapshotHelperWithVariations const & )
deletenoexcept

◆ SnapshotHelperWithVariations() [3/3]

ROOT::Internal::RDF::SnapshotHelperWithVariations::SnapshotHelperWithVariations ( SnapshotHelperWithVariations && )
defaultnoexcept

◆ ~SnapshotHelperWithVariations()

ROOT::Internal::RDF::SnapshotHelperWithVariations::~SnapshotHelperWithVariations ( )
default

Member Function Documentation

◆ CallFinalizeTask()

auto ROOT::Detail::RDF::RActionImpl< SnapshotHelperWithVariations >::CallFinalizeTask ( unsigned int slot) -> decltype(std::declval< T >().FinalizeTask(slot))
inlineinherited

Definition at line 44 of file RActionImpl.hxx.

◆ CallMakeNew()

SnapshotHelperWithVariations ROOT::Detail::RDF::RActionImpl< SnapshotHelperWithVariations >::CallMakeNew ( void * typeErasedResSharedPtr,
std::string_view variation = "nominal" )
inlineinherited

Definition at line 64 of file RActionImpl.hxx.

◆ CallPartialUpdate()

auto ROOT::Detail::RDF::RActionImpl< SnapshotHelperWithVariations >::CallPartialUpdate ( unsigned int slot) -> decltype(std::declval< H >().PartialUpdate(slot),(void *)(nullptr))
inlineinherited

Definition at line 53 of file RActionImpl.hxx.

◆ ClearOutputBranches()

void ROOT::Internal::RDF::SnapshotHelperWithVariations::ClearOutputBranches ( )
private

◆ Exec()

void ROOT::Internal::RDF::SnapshotHelperWithVariations::Exec ( unsigned int ,
const std::vector< void * > & values,
std::vector< bool > const & filterPassed )

Connect all output fields to the values pointed to by values, fill the output dataset, call the Fill of the output tree, and clear the mask bits that show whether a variation was reached.

Definition at line 1215 of file RDFSnapshotHelpers.cxx.

◆ Finalize()

void ROOT::Internal::RDF::SnapshotHelperWithVariations::Finalize ( )

Definition at line 1249 of file RDFSnapshotHelpers.cxx.

◆ GetActionName()

std::string ROOT::Internal::RDF::SnapshotHelperWithVariations::GetActionName ( )
inline

Definition at line 309 of file SnapshotHelpers.hxx.

◆ GetMergeableValue()

virtual std::unique_ptr< RMergeableValueBase > ROOT::Detail::RDF::RActionImpl< SnapshotHelperWithVariations >::GetMergeableValue ( ) const
inlinevirtualinherited

Definition at line 79 of file RActionImpl.hxx.

◆ GetSampleCallback()

virtual ROOT::RDF::SampleCallback_t ROOT::Detail::RDF::RActionImpl< SnapshotHelperWithVariations >::GetSampleCallback ( )
inlinevirtualinherited

Override this method to register a callback that is executed before the processing a new data sample starts.

The callback will be invoked in the same conditions as with DefinePerSample().

Definition at line 86 of file RActionImpl.hxx.

◆ Initialize()

void ROOT::Internal::RDF::SnapshotHelperWithVariations::Initialize ( )
inline

Nothing to do. All initialisations run in the constructor or InitTask().

Definition at line 305 of file SnapshotHelpers.hxx.

◆ InitTask()

void ROOT::Internal::RDF::SnapshotHelperWithVariations::InitTask ( TTreeReader * ,
unsigned int slot )

Bind all output branches to RDF columns for the given slots.

Definition at line 1197 of file RDFSnapshotHelpers.cxx.

◆ operator=() [1/2]

SnapshotHelperWithVariations & ROOT::Internal::RDF::SnapshotHelperWithVariations::operator= ( SnapshotHelperWithVariations && )
defaultnoexcept

◆ operator=() [2/2]

SnapshotHelperWithVariations & ROOT::Internal::RDF::SnapshotHelperWithVariations::operator= ( SnapshotHelperWithVariations const & )
delete

◆ RegisterVariedColumn()

void ROOT::Internal::RDF::SnapshotHelperWithVariations::RegisterVariedColumn ( unsigned int slot,
unsigned int columnIndex,
unsigned int originalColumnIndex,
unsigned int variationIndex,
std::string const & variationName )

Register a new column as a variation of the column at originalColumnIndex, and clone its properties.

If a nominal column is registered here, it is written without changes, but it means that it will be masked in case its selection cuts don't pass.

Parameters
slotTask ID for MT runs.
columnIndexIndex where the data of this column will be passed into the helper.
originalColumnIndexIf the column being registered is a variation of a "nominal" column, this designates the original. Properties such as name and output type are cloned from the original.
variationNameThe variation that this column belongs to. If "nominal" is used, this column is considered as the original.

Definition at line 1168 of file RDFSnapshotHelpers.cxx.

Member Data Documentation

◆ fBranchData

std::vector<RBranchData> ROOT::Internal::RDF::SnapshotHelperWithVariations::fBranchData
private

Definition at line 277 of file SnapshotHelpers.hxx.

◆ fInputLoopManager

ROOT::Detail::RDF::RLoopManager* ROOT::Internal::RDF::SnapshotHelperWithVariations::fInputLoopManager = nullptr
private

Definition at line 278 of file SnapshotHelpers.hxx.

◆ fInputTree

TTree* ROOT::Internal::RDF::SnapshotHelperWithVariations::fInputTree = nullptr
private

Definition at line 276 of file SnapshotHelpers.hxx.

◆ fOptions

RSnapshotOptions ROOT::Internal::RDF::SnapshotHelperWithVariations::fOptions
private

Definition at line 274 of file SnapshotHelpers.hxx.

◆ fOutputHandle

std::shared_ptr<SnapshotOutputWriter> ROOT::Internal::RDF::SnapshotHelperWithVariations::fOutputHandle
private

Definition at line 275 of file SnapshotHelpers.hxx.

◆ fOutputLoopManager

ROOT::Detail::RDF::RLoopManager* ROOT::Internal::RDF::SnapshotHelperWithVariations::fOutputLoopManager = nullptr
private

Definition at line 279 of file SnapshotHelpers.hxx.


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