Basic container for event feature data. More...

#include <EventFeature.h>

Collaboration diagram for EventFeature:

Public Types
enum	FeatureType { ETDENSITY = 0x1000, ETDENSITY_JETAREA = 0x1100, ETDENSITY_JETAREA_ETA = 0x1101, ETDENSITY_ETA_WINDOWS = 0x1201, ETDENSITY_USER = 0x0010, UNKNOWN = 0x0000, DEFAULT = 0xffff }
	@ More...

enum	FeatureStructureMask { NDATAWORDS = 0x0000007f, NDATABLOCKS = 0x00003f80, TAGBITS = 0x0000c000, MASKLENGTH = 0x0000ffff, BITSHIFT = 0x00000007 }
	Feature structure descriptors. More...

Public Member Functions
	EventFeature ()
	Default constructor. More...

	EventFeature (FeatureType type, const std::string &tag, const std::vector< double > &dataList)
	Loaded constructor. More...

	EventFeature (FeatureType type, const std::string &tag, unsigned int dataStructure, const std::vector< double > &dataList)
	Loaded constructor. More...

	EventFeature (FeatureType type, const std::string &tag, unsigned int dataStructure)
	Loaded constructor. More...

	EventFeature (const EventFeature &feature)
	Copy constructor. More...

virtual	~EventFeature ()
	Destructor. More...

EventFeature &	operator= (const EventFeature &feature)
	Assignment operator. More...

const std::string &	tag () const
	Retrieve feature tag. More...

FeatureType	type () const
	Retrieve feature type. More...

unsigned int	featureStructure () const
	Retrieve data structure descriptor. More...

size_t	numberDataBlocks ()
	Retrieve number of data blocks. More...

size_t	numberDataWords () const
	Retrieve number of words in data block. More...

const std::vector< double > &	dataList () const
	Retrieve reference to vector store. More...

std::vector< double > &	dataList ()
	Retrieve reference to vector store. More...

bool	dataBlock (size_t blockIdx, std::vector< double > &data)
	Return one datablock. More...

void	setTag (const std::string &tag)
	Set feature tag. More...

void	setType (FeatureType type)
	Set feature type. More...

void	setNumberDataBlocks (size_t nBlocks)
	Set number of blocks. More...

void	setNumberDataWords (size_t nWords)
	Set number of data words per block. More...

void	setDataList (const std::vector< double > &data)
	Set vector data store. More...

bool	setDataBlock (size_t blockIdx, const std::vector< double > &data, bool replace=true)
	Set one data block. More...

bool	addDataBlock (const std::vector< double > &data)

unsigned int	buildFeatureStructure ()
	Build compressed feature structure. More...

Static Public Member Functions
static FeatureType	featureType (const std::string &typeTag)
	Binned scalar data model. More...

static FeatureType	featureType ()
	Default feature type. More...

static const std::string &	featureTag (FeatureType type)
	Convert a `FeatureType` to a tag. More...

static const std::string &	featureTag ()
	Default feature tag. More...

Private Types
typedef std::pair< size_t, size_t >	index_t

Private Member Functions
void	setFeatureStructure (bool updateCache=false)
	Set/update feature structure. More...

bool	insertDataBlock (size_t startIdx, size_t endIdx, const std::vector< double > &data)

bool	addDataBlock (size_t startIdx, size_t endIdx, const std::vector< double > &data)

bool	indexRange (size_t startIdx, index_t &idx)

Private Attributes
FeatureType	m_type
	Internal cache for feature type. More...

std::string	m_tag
	Internal cache for feature tag. More...

unsigned int	m_dataWords
	Internal cache data structure description (words per block) More...

unsigned int	m_dataBlocks
	Internal cache for data structure descriptor (number of blocks) More...

unsigned int	m_featureStructure
	Internal cache for compressed data structure descriptor. More...

std::vector< double >	m_dataList
	Internal cache for vector data. More...

bool	m_structureFixed
	Control flag for setting number of data words. More...

Static Private Attributes
static const std::map< FeatureType, std::string >	m_featureTags
	Lookup for feature type and tag matches. More...

Detailed Description

Basic container for event feature data.

Basic container for event feature data or parameters. Each entry is characterized by the type of information, a tag, and possibly scalar (number) and/or vector (list of numbers or list of number patterns). The possible interpretation of the number patterns depends on the feature type and is usually implemented in the tool producing the EventFeature object.

Definition at line 17 of file EventFeature.h.

Member Typedef Documentation

◆ index_t

typedef std::pair<size_t,size_t> EventFeature::index_t

private

Definition at line 206 of file EventFeature.h.

Member Enumeration Documentation

◆ FeatureStructureMask

enum EventFeature::FeatureStructureMask

Feature structure descriptors.

Mostly useful for T/P converter yet public for converter access

Enumerator
NDATAWORDS
NDATABLOCKS
TAGBITS
MASKLENGTH
BITSHIFT

Definition at line 39 of file EventFeature.h.

                             { NDATAWORDS  = 0x0000007f, /*<! Mask for number of
                               data words/block (max 
                               accomodation 128)*/
                   NDATABLOCKS = 0x00003f80, /*<! Mask for number of
                               data blocks (max 
                               accommodation 128)*/
                   TAGBITS     = 0x0000c000, /*<! Mask for additional
                               tag bits (2 bits)*/
                   MASKLENGTH  = 0x0000ffff, /*<! Mask for total
                               used bit range (16)*/
                   BITSHIFT    = 0x00000007 }; /*<! Shift step */    

◆ FeatureType

enum EventFeature::FeatureType

@

Type enumerators

Enumerator
ETDENSITY
ETDENSITY_JETAREA	`FastJet` density
ETDENSITY_JETAREA_ETA	`FastJet` density, \( \eta \) dependent
ETDENSITY_ETA_WINDOWS	density in sliding \( \eta \) windows
ETDENSITY_USER	User defined density.
UNKNOWN	Unknown type.
DEFAULT	Default type.

Definition at line 23 of file EventFeature.h.

     { ETDENSITY             = 0x1000, 
       ETDENSITY_JETAREA     = 0x1100,  
       ETDENSITY_JETAREA_ETA = 0x1101,  
       ETDENSITY_ETA_WINDOWS = 0x1201, 
       ETDENSITY_USER    = 0x0010,     
       UNKNOWN           = 0x0000,     
       DEFAULT           = 0xffff      
   };

Constructor & Destructor Documentation

◆ EventFeature() [1/5]

EventFeature::EventFeature ( )

Default constructor.

Instantiates empty data object, with defaults:

type = EventFeature::UNKNOWN; tag = "Default"; dataList = std::vector<double>();

This object also has no internal data structure (0 data words in 0 blocks).

Definition at line 53 of file EventFeature.cxx.

   : m_type(UNKNOWN)
   , m_tag("Default")
   , m_dataWords(0)
   , m_dataBlocks(0)
   , m_featureStructure(0)
   , m_dataList(std::vector<double>())
   , m_structureFixed(false)
 { }

◆ EventFeature() [2/5]

EventFeature::EventFeature	(	FeatureType	type,
		const std::string &	tag,
		const std::vector< double > &	dataList
	)

Loaded constructor.

Parameters

[in]	type	`EventFeature` type
[in]	tag	`string` identifier/tag for data
[in]	dataList	reference to non-modifiable data vector to be copied to internal store

Note: Flat data structure with dataList.size() words in one block.

Definition at line 63 of file EventFeature.cxx.

   : m_type(type)
   , m_tag(tag)
   , m_dataWords(dataList.size())
   , m_dataBlocks(1)
   , m_dataList(dataList.begin(),dataList.end())
   , m_structureFixed(true)
 {
   this->setFeatureStructure(); 
 }

◆ EventFeature() [3/5]

EventFeature::EventFeature	(	FeatureType	type,
		const std::string &	tag,
		unsigned int	dataStructure,
		const std::vector< double > &	dataList
	)

Loaded constructor.

Parameters

[in]	type	`EventFeature` type
[in]	tag	`string` identifier/tag for data
[in]	data	scalar (number) data word to be stored internally
[in]	dataList	reference to non-modifiable data vector to be copied to internal store

Definition at line 76 of file EventFeature.cxx.

   : m_type(type)
   , m_tag(tag)
   , m_dataWords(nWords)
   , m_dataBlocks(dataList.size()/m_dataWords)
   , m_dataList(dataList.begin(),dataList.end())
   , m_structureFixed(true)
 {
   this->setFeatureStructure();
 }

◆ EventFeature() [4/5]

EventFeature::EventFeature	(	FeatureType	type,
		const std::string &	tag,
		unsigned int	dataStructure
	)

Loaded constructor.

Parameters

[in]	type	`EventFeature` type
[in]	tag	`string` identifier/tag for data
[in]	data	scalar (number) data word to be stored internally

Note: Internal multiple (vector) store is set to its default value (std::vector<double>() ).

Definition at line 89 of file EventFeature.cxx.

   : m_type(type)
   , m_tag(tag)
   , m_dataWords(nWords)
   , m_dataBlocks(0)
   , m_dataList(std::vector<double>())
   , m_structureFixed(true)
 {
   this->setFeatureStructure(); 
 }

◆ EventFeature() [5/5]

EventFeature::EventFeature ( const EventFeature & feature )

Copy constructor.

Definition at line 101 of file EventFeature.cxx.

   : m_type(feature.m_type)
   , m_tag(feature.m_tag)
   , m_dataWords(feature.m_dataWords)
   , m_dataBlocks(feature.m_dataBlocks)
   , m_dataList(feature.dataList().begin(),feature.dataList().end())
   , m_structureFixed(feature.m_structureFixed)
 {
   this->setFeatureStructure(); 
 }

◆ ~EventFeature()

EventFeature::~EventFeature ( )

virtual

Destructor.

Definition at line 112 of file EventFeature.cxx.

113 { }

Member Function Documentation

◆ addDataBlock() [1/2]

bool EventFeature::addDataBlock ( const std::vector< double > & data )

Definition at line 165 of file EventFeature.cxx.

 {
   index_t idx(0,0);
   this->indexRange(m_dataBlocks+1,idx);
   return addDataBlock(idx.first,idx.second,data);
 }

◆ addDataBlock() [2/2]

bool EventFeature::addDataBlock	(	size_t	startIdx,
		size_t	endIdx,
		const std::vector< double > &	data
	)

private

Definition at line 172 of file EventFeature.cxx.

 {
   m_dataList.resize(endIdx,EventShapeConstants::nullValue());
   size_t imax(std::min(endIdx-startIdx,data.size()));
   for ( size_t i(0); i<imax; ++i ) { m_dataList[i+startIdx] = data.at(i); }
   this->setFeatureStructure();
   return imax>0;
 } 

◆ buildFeatureStructure()

unsigned int EventFeature::buildFeatureStructure ( )

Build compressed feature structure.

Definition at line 224 of file EventFeature.cxx.

 {
   m_featureStructure = 
     (m_dataWords&(unsigned int)NDATAWORDS) |
     ((m_dataBlocks&(unsigned int)NDATABLOCKS)<<(unsigned int)BITSHIFT);
   return m_featureStructure;
 }

◆ dataBlock()

bool EventFeature::dataBlock	(	size_t	blockIdx,
		std::vector< double > &	data
	)

Return one datablock.

Definition at line 138 of file EventFeature.cxx.

 {
  
   // get index range
   index_t idx(0,0);
   if ( !this->indexRange(blockIdx,idx) ) return false;
   // copy data
   for ( size_t i(idx.first); i<idx.second; ++i )
     {
       data.push_back(m_dataList.at(i));
     }
   return !data.empty();
 }

◆ dataList() [1/2]

std::vector< double > & EventFeature::dataList ( )

inline

Retrieve reference to vector store.

Returns: const reference to modifiable vector data store.

Definition at line 292 of file EventFeature.h.

293 { return m_dataList; }

◆ dataList() [2/2]

const std::vector< double > & EventFeature::dataList ( ) const

inline

Retrieve reference to vector store.

Returns: const reference to non-modifiable vector data store.

Definition at line 289 of file EventFeature.h.

290 { return m_dataList; }

◆ featureStructure()

unsigned int EventFeature::featureStructure ( ) const

inline

Retrieve data structure descriptor.

Returns: Copy of data structure descriptor

Definition at line 286 of file EventFeature.h.

287 { return m_featureStructure; }

◆ featureTag() [1/2]

const std::string & EventFeature::featureTag ( )

static

Default feature tag.

Definition at line 35 of file EventFeature.cxx.

 {
   auto it = m_featureTags.find(DEFAULT);
   if (it == m_featureTags.end()) std::abort();
   return it->second;
 }

◆ featureTag() [2/2]

const std::string & EventFeature::featureTag ( FeatureType type )

static

Convert a FeatureType to a tag.

Definition at line 42 of file EventFeature.cxx.

 {
   std::map<FeatureType,std::string>::const_iterator fMap(m_featureTags.find(type));
   if (fMap != m_featureTags.end()) {
     return fMap->second;
   }
   fMap = m_featureTags.find (UNKNOWN);
   if (fMap == m_featureTags.end()) std::abort();
   return fMap->second;
 }

◆ featureType() [1/2]

EventFeature::FeatureType EventFeature::featureType ( )

static

Default feature type.

Definition at line 24 of file EventFeature.cxx.

25 { return EventFeature::DEFAULT; }

◆ featureType() [2/2]

EventFeature::FeatureType EventFeature::featureType ( const std::string & typeTag )

static

Binned scalar data model.

Parameters

[in] lmin minimum ‍/ void setBinnedData(double lmin,double lmax,double data);

/*! Convert feature tag to FeatureType

Definition at line 27 of file EventFeature.cxx.

 {
   std::map<FeatureType,std::string>::const_iterator fMap(m_featureTags.begin());
   std::map<FeatureType,std::string>::const_iterator lMap(m_featureTags.end());
   while ( fMap != lMap && tag != fMap->second ) { ++ fMap; }
   return fMap != lMap ? fMap->first : UNKNOWN; 
 }

◆ indexRange()

bool EventFeature::indexRange	(	size_t	startIdx,
		index_t &	idx
	)

private

Definition at line 232 of file EventFeature.cxx.

 {
   this->setFeatureStructure(false);
   size_t locIdx(startIdx*m_dataWords+m_dataBlocks);
   if ( locIdx > m_dataList.size() ) return false;
   idx.first  = startIdx;
   idx.second = locIdx; 
   return true;
 }

◆ insertDataBlock()

bool EventFeature::insertDataBlock	(	size_t	startIdx,
		size_t	endIdx,
		const std::vector< double > &	data
	)

private

Definition at line 182 of file EventFeature.cxx.

 {
   size_t imax(std::min(endIdx-startIdx,data.size()));
   for ( size_t i(0); i<imax; ++i ) { m_dataList[i+startIdx] = data.at(i); } 
   return imax>0;
 }

◆ numberDataBlocks()

size_t EventFeature::numberDataBlocks ( )

inline

Retrieve number of data blocks.

Returns: Number of data blocks

Definition at line 311 of file EventFeature.h.

312 { this->setFeatureStructure(); return m_dataBlocks; }

◆ numberDataWords()

size_t EventFeature::numberDataWords ( ) const

inline

Retrieve number of words in data block.

Returns: Number of words in data block

Definition at line 308 of file EventFeature.h.

309 { return m_dataWords; }

◆ operator=()

EventFeature & EventFeature::operator= ( const EventFeature & feature )

Assignment operator.

Copies data content from EventFeature source.

Parameters

[in] feature reference to non-modifiable EventFeature object

Definition at line 115 of file EventFeature.cxx.

 {
   if (this != &feature) {
     m_type           = feature.m_type;
     m_tag            = feature.m_tag;
     m_dataWords      = feature.m_dataWords;
     m_dataBlocks     = feature.m_dataBlocks;
     m_structureFixed = feature.m_structureFixed; 
     if ( feature.m_dataList.empty() )
     {
       m_dataList.clear();
     }
     else
     {
       m_dataList.resize(feature.m_dataList.size());
       std::copy(feature.m_dataList.begin(),feature.m_dataList.end(),
         m_dataList.begin());
     }
     this->setFeatureStructure();
   }
   return *this;
 }

◆ setDataBlock()

bool EventFeature::setDataBlock	(	size_t	blockIdx,
		const std::vector< double > &	data,
		bool	replace = `true`
	)

Set one data block.

Definition at line 152 of file EventFeature.cxx.

 {
   // get index range and check if replacement 
   index_t idx(0,0);
   bool inRange(this->indexRange(blockIdx,idx));
   if (  inRange && !replace ) return false;
   // replace or add
   if ( !inRange ) return this->addDataBlock(idx.first,idx.second,data);
   return this->insertDataBlock(idx.first,idx.second,data);
 }

◆ setDataList()

void EventFeature::setDataList ( const std::vector< double > & data )

inline

Set vector data store.

Parameters

[in] data reference to non-modifiable data vector

Definition at line 301 of file EventFeature.h.

 { 
   m_dataList.resize(data.size()); 
   std::copy(data.begin(),data.end(),m_dataList.begin());
   this->setFeatureStructure();
 }

◆ setFeatureStructure()

void EventFeature::setFeatureStructure ( bool updateCache = false )

private

Set/update feature structure.

Definition at line 211 of file EventFeature.cxx.

 {
   if ( updateCache )
     {
       size_t cacheSize(m_dataWords*m_dataBlocks);
       m_dataList.resize(cacheSize,EventShapeConstants::invalidValue());
     }
   // update 
   if ( m_dataWords > 0 ) m_dataBlocks = m_dataList.size()/m_dataWords;
   // construct feature structure
   this->buildFeatureStructure();
 }

◆ setNumberDataBlocks()

void EventFeature::setNumberDataBlocks ( size_t nBlocks )

Set number of blocks.

Parameters

[in] nBlocks number of data blocks

Definition at line 201 of file EventFeature.cxx.

 {
   if ( nBlocks <= (size_t)
        (((unsigned int)NDATABLOCKS)>>(unsigned int)BITSHIFT) )
     {
       m_dataBlocks = nBlocks;
       this->setFeatureStructure(true);
     }
 }

◆ setNumberDataWords()

void EventFeature::setNumberDataWords ( size_t nWords )

Set number of data words per block.

Parameters

[in] nWords number of data words per block

Definition at line 190 of file EventFeature.cxx.

 {
   if ( !m_structureFixed &&  nWords <= (unsigned int)NDATAWORDS )
     {
       m_dataWords  = nWords;
       m_dataBlocks = 0;
       this->setFeatureStructure(true);
       m_structureFixed = true;
     }
 }

◆ setTag()

void EventFeature::setTag ( const std::string & tag )

inline

Set feature tag.

Parameters

[in] tag reference to non-modifiable tag string

Definition at line 298 of file EventFeature.h.

299 { m_tag = tag; }

◆ setType()

void EventFeature::setType ( FeatureType type )

inline

Set feature type.

Parameters

[in] type feature type

Definition at line 295 of file EventFeature.h.

296 { m_type = type; }

◆ tag()

const std::string & EventFeature::tag ( ) const

inline

Retrieve feature tag.

Returns: const reference to non-modifiable feature tag (string).

Definition at line 280 of file EventFeature.h.

281 { return m_tag; }

◆ type()

EventFeature::FeatureType EventFeature::type ( ) const

inline

Retrieve feature type.

Returns: Copy of feature type.

Definition at line 283 of file EventFeature.h.

284 { return m_type; }

Member Data Documentation

◆ m_dataBlocks

unsigned int EventFeature::m_dataBlocks

private

Internal cache for data structure descriptor (number of blocks)

Definition at line 229 of file EventFeature.h.

◆ m_dataList

std::vector<double> EventFeature::m_dataList

private

Internal cache for vector data.

Definition at line 233 of file EventFeature.h.

◆ m_dataWords

unsigned int EventFeature::m_dataWords

private

Internal cache data structure description (words per block)

Definition at line 227 of file EventFeature.h.

◆ m_featureStructure

unsigned int EventFeature::m_featureStructure

private

Internal cache for compressed data structure descriptor.

Definition at line 231 of file EventFeature.h.

◆ m_featureTags

const std::map< EventFeature::FeatureType, std::string > EventFeature::m_featureTags

staticprivate

Initial value:

= {
  {ETDENSITY,             "ETDENSITY"},
  {ETDENSITY_JETAREA,     "ETDESNSITY_JETAREA"},
  {ETDENSITY_JETAREA_ETA, "ETDENSITY_JETAREA_ETA"},
  {ETDENSITY_ETA_WINDOWS, "ETDENSITY_ETA_WINDOWS"},
  {ETDENSITY_USER,        "ETDENSITY_USER"},
  {UNKNOWN,               "UNKNOWN"},
  {DEFAULT,               "DEFAULT"},
}

Lookup for feature type and tag matches.

Definition at line 242 of file EventFeature.h.

◆ m_structureFixed

bool EventFeature::m_structureFixed

private

Control flag for setting number of data words.

Can only be done once!

Definition at line 239 of file EventFeature.h.

◆ m_tag

std::string EventFeature::m_tag

private

Internal cache for feature tag.

Definition at line 225 of file EventFeature.h.

◆ m_type

FeatureType EventFeature::m_type

private

Internal cache for feature type.

Definition at line 223 of file EventFeature.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ index_t

Member Enumeration Documentation

◆ FeatureStructureMask

◆ FeatureType

Constructor & Destructor Documentation

◆ EventFeature() [1/5]

◆ EventFeature() [2/5]

◆ EventFeature() [3/5]

◆ EventFeature() [4/5]

◆ EventFeature() [5/5]

◆ ~EventFeature()

Member Function Documentation

◆ addDataBlock() [1/2]

◆ addDataBlock() [2/2]

◆ buildFeatureStructure()

◆ dataBlock()

◆ dataList() [1/2]

◆ dataList() [2/2]

◆ featureStructure()

◆ featureTag() [1/2]

◆ featureTag() [2/2]

◆ featureType() [1/2]

◆ featureType() [2/2]

◆ indexRange()

◆ insertDataBlock()

◆ numberDataBlocks()

◆ numberDataWords()

◆ operator=()

◆ setDataBlock()

◆ setDataList()

◆ setFeatureStructure()

◆ setNumberDataBlocks()

◆ setNumberDataWords()

◆ setTag()

◆ setType()

◆ tag()

◆ type()

Member Data Documentation

◆ m_dataBlocks

◆ m_dataList

◆ m_dataWords

◆ m_featureStructure

◆ m_featureTags

◆ m_structureFixed

◆ m_tag

◆ m_type