ATLAS Offline Software
Public Member Functions | Private Attributes | List of all members
IJetGroomer Class Referenceabstract

#include <IJetGroomer.h>

Inheritance diagram for IJetGroomer:
Collaboration diagram for IJetGroomer:

Public Member Functions

 IJetGroomer ()
 Ctor. More...
 
virtual ~IJetGroomer ()
 Destructor. More...
 
virtual int groom (const xAOD::Jet &jin, const PseudoJetContainer &, xAOD::JetContainer &jout) const =0
 Transform jet. More...
 
virtual const IJetPseudojetRetrieverpseudojetRetriever () const
 Return the pseudojet retriever associated with this tool. More...
 
virtual void setPseudojetRetriever (const IJetPseudojetRetriever *ppjr)
 Set the pseudojet retriever associated with this tool. More...
 
virtual void print () const =0
 Print the state of the tool. More...
 

Private Attributes

const IJetPseudojetRetrieverm_ppjr
 Pseudojet retriever. More...
 

Detailed Description

Definition at line 23 of file IJetGroomer.h.

Constructor & Destructor Documentation

◆ IJetGroomer()

IJetGroomer::IJetGroomer ( )

Ctor.

Definition at line 11 of file IJetGroomer.cxx.

11 : m_ppjr(nullptr) { }

◆ ~IJetGroomer()

IJetGroomer::~IJetGroomer ( )
virtual

Destructor.

Definition at line 15 of file IJetGroomer.cxx.

15  {
16  m_ppjr = nullptr;
17 }

Member Function Documentation

◆ groom()

virtual int IJetGroomer::groom ( const xAOD::Jet jin,
const PseudoJetContainer ,
xAOD::JetContainer jout 
) const
pure virtual

Transform jet.

If accepted, the new jet is added to the container. Return codes:

  • 0 for success.
  • >0 if jet is rejected
  • <0 for error

Implemented in JetModifiedMassDrop, JetReclusterer, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetPruner, and JetTrimmer.

◆ print()

virtual void asg::IAsgTool::print ( ) const
pure virtualinherited

◆ pseudojetRetriever()

const IJetPseudojetRetriever * IJetGroomer::pseudojetRetriever ( ) const
virtual

Return the pseudojet retriever associated with this tool.

Definition at line 21 of file IJetGroomer.cxx.

21  {
22  return m_ppjr;
23 }

◆ setPseudojetRetriever()

void IJetGroomer::setPseudojetRetriever ( const IJetPseudojetRetriever ppjr)
virtual

Set the pseudojet retriever associated with this tool.

Definition at line 27 of file IJetGroomer.cxx.

27  {
28  m_ppjr = ppjr;
29 }

Member Data Documentation

◆ m_ppjr

const IJetPseudojetRetriever* IJetGroomer::m_ppjr
private

Pseudojet retriever.

Definition at line 52 of file IJetGroomer.h.


The documentation for this class was generated from the following files:
IJetGroomer::m_ppjr
const IJetPseudojetRetriever * m_ppjr
Pseudojet retriever.
Definition: IJetGroomer.h:52