MuonML::NodeFeatureList Class Reference

#include <NodeFeatureList.h>

Collaboration diagram for MuonML::NodeFeatureList:

Public Types
using	Feature_t = std::shared_ptr< const NodeFeature >
using	Connector_t = std::shared_ptr< const NodeConnector >
using	Bucket_t = NodeFeature::Bucket_t

Public Member Functions
	NodeFeatureList ()=default
	Empty standard constructor. More...
bool	operator== (const NodeFeatureList &other) const
	Returns true if the features have pairwise the same name. More...
bool	isValid () const
	Returns whether the NodeFeatureList is complete, i.e. More...
size_t	numFeatures () const
	Returns the number of features in the list. More...
std::vector< std::string >	featureNames () const
	Returns the name of the features in the list. More...
void	fillInData (const Bucket_t &bucket, GraphRawData &graphData) const
	More...
bool	addFeature (const std::string &featName, MsgStream &msg)
	Tries to add a new feature to the list using the predefined list of features in the GraphFeatureFactory. More...
bool	addFeature (const Feature_t &featPtr, MsgStream &msg)
	Tries to add a particular feature to the list. More...
bool	setConnector (const std::string &conName, MsgStream &msg)
	Tries to set the graph connector based on the connector name. More...
void	setConnector (const std::string &conName, NodeConnector::Evaluator_t evalFunc)
	Sets the More...

Private Attributes
std::vector< Feature_t >	m_features {}
Connector_t	m_connector {}

Detailed Description

Definition at line 14 of file NodeFeatureList.h.

Member Typedef Documentation

Bucket_t

using MuonML::NodeFeatureList::Bucket_t = NodeFeature::Bucket_t

Definition at line 20 of file NodeFeatureList.h.

Connector_t

using MuonML::NodeFeatureList::Connector_t = std::shared_ptr<const NodeConnector>

Definition at line 18 of file NodeFeatureList.h.

Feature_t

using MuonML::NodeFeatureList::Feature_t = std::shared_ptr<const NodeFeature>

Definition at line 17 of file NodeFeatureList.h.

Constructor & Destructor Documentation

NodeFeatureList()

MuonML::NodeFeatureList::NodeFeatureList ( )

default

Empty standard constructor.

Member Function Documentation

addFeature() [1/2]

bool MuonML::NodeFeatureList::addFeature	(	const Feature_t &	featPtr,
		MsgStream &	msg
	)

Tries to add a particular feature to the list.

Parameters

featPtr	Pointer to the instantiated feature
msg	Reference to the message stream object for logging.

Definition at line 56 of file NodeFeatureList.cxx.

                                                                             {
      if (!newFeat) {
         msg<<MSG::ERROR<<"No feature has been parsed. "<<endmsg;
         return false;
      }
      if (std::ranges::find_if(m_features, [&newFeat](const Feature_t& known){
         return known == newFeat || known->name() == newFeat->name();
      }) != m_features.end()) {
         msg<<MSG::ERROR<<" The feature "<<newFeat->name()<<" has already been added & "
                        <<" cannot be added again. "<<endmsg;
         return false;
      }
      if (msg.level() <= MSG::DEBUG) {
         msg<<MSG::DEBUG<<__FILE__<<":"<<__LINE__<<" - Add new feature "<< newFeat->name()<<endmsg;
      }
      m_features.push_back(newFeat);
      return true;
   }

addFeature() [2/2]

bool MuonML::NodeFeatureList::addFeature	(	const std::string &	featName,
		MsgStream &	msg
	)

Tries to add a new feature to the list using the predefined list of features in the GraphFeatureFactory.

Parameters

featName	Name of the feature in the factory
msg	Reference to the message stream object for logging.

Definition at line 52 of file NodeFeatureList.cxx.

                                                                             {
      return addFeature(Factory::makeFeature(featName, msg), msg);
   }

featureNames()

std::vector< std::string > MuonML::NodeFeatureList::featureNames

(

)

const

Returns the name of the features in the list.

Definition at line 45 of file NodeFeatureList.cxx.

                                                            {
      std::vector<std::string> names{};
      std::ranges::transform(m_features,std::back_inserter(names),
                              [](const Feature_t& ft){ return ft->name();});
      return names;
   }

fillInData()

void MuonML::NodeFeatureList::fillInData	(	const Bucket_t &	bucket,
		GraphRawData &	graphData
	)		const

Fill the graph features

Connection i->j

Connection j-> i

Definition at line 75 of file NodeFeatureList.cxx.

                                                                   {
      for (size_t sp = 0 ; sp < bucket.size(); ++sp) {
         for(const Feature_t& feat : m_features) {
            assert(prepGraph.currLeave != prepGraph.featureLeaves.end());
            (*prepGraph.currLeave++) = feat->eval(bucket, sp);
         }
         for (size_t ot = 0; ot < sp; ++ot) {
            size_t from = prepGraph.nodeIndex +sp;
            size_t to = prepGraph.nodeIndex + ot;
            if (m_connector->connect(bucket, sp, ot)) {
               prepGraph.srcEdges.emplace_back(from);
               prepGraph.desEdges.emplace_back(to);
               prepGraph.srcEdges.emplace_back(to);
               prepGraph.desEdges.emplace_back(from);
            }
         }
      }
      prepGraph.nodeIndex+=bucket.size();
   }

isValid()

bool MuonML::NodeFeatureList::isValid

(

)

const

Returns whether the NodeFeatureList is complete, i.e.

it must have at least one feature and the node connector

Definition at line 15 of file NodeFeatureList.cxx.

                                       {
      return m_connector && numFeatures();
   }

numFeatures()

size_t MuonML::NodeFeatureList::numFeatures

(

)

const

Returns the number of features in the list.

Definition at line 40 of file NodeFeatureList.cxx.

                                             {
      return m_features.size();
   }

operator==()

bool MuonML::NodeFeatureList::operator==

(

const NodeFeatureList &

other

)

const

Returns true if the features have pairwise the same name.

Definition at line 26 of file NodeFeatureList.cxx.

                                                                      {
      if (numFeatures() != other.numFeatures()) {
         return false;
      }
      if (!m_connector || !other.m_connector || m_connector->name() != other.m_connector->name()) {
         return false;
      }
      for (size_t f =0 ; f < numFeatures(); ++f) {
         if (m_features[f]->name() != other.m_features[f]->name()) {
            return false;
         }
      }
      return true;
   }

setConnector() [1/2]

bool MuonML::NodeFeatureList::setConnector	(	const std::string &	conName,
		MsgStream &	msg
	)

Tries to set the graph connector based on the connector name.

Parameters

conName	Name of the connector to extract from the factory
msg	Reference to the message stream object for logging.

Definition at line 18 of file NodeFeatureList.cxx.

                                                                              {
      m_connector = Factory::makeConnector(conName , msg);
      return m_connector != nullptr;
   }

setConnector() [2/2]

void MuonML::NodeFeatureList::setConnector	(	const std::string &	conName,
		NodeConnector::Evaluator_t	evalFunc
	)

Sets the

Definition at line 23 of file NodeFeatureList.cxx.

                                                                                                 {
      m_connector = std::make_unique<NodeConnector>(conName, evalFunc);
   }

Member Data Documentation

m_connector

Connector_t MuonML::NodeFeatureList::m_connector {}

private

Definition at line 57 of file NodeFeatureList.h.

m_features

std::vector<Feature_t> MuonML::NodeFeatureList::m_features {}

private

Definition at line 56 of file NodeFeatureList.h.

---

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

• NodeFeatureList.h
• NodeFeatureList.cxx