Cell used by the cellular automata. More...

#include <AutomatonCell.h>

Public Types
enum	ECellFlag : unsigned int { c_Assigned = 1 , c_Start = 2 , c_PriorityPath = 4 , c_Cycle = 8 , c_Masked = 16 , c_Taken = 32 , c_Background = 64 , c_Priority = 128 , c_Reverse = 256 , c_Alias = 512 , c_BadADCOrTOT = 1024 }
	Type for the status flags of cells in the cellular automata. More...

using	ECellFlags = ECellFlag
	Type for an ordered combination of the status flags of cells in the cellular automata.

Public Member Functions
	AutomatonCell ()
	Default constructor for ROOT compatibility. Cell weight defaults to 0.

	AutomatonCell (const Weight &cellWeight)
	Constructor with a certain cell weight.

	AutomatonCell (const Weight &cellWeight, const ECellFlags &initialFlags)
	Constructor with a certain cell weight and initial flags to be set.

Weight	getCellState () const
	Getter for the cell state.

void	setCellState (Weight state)
	Setter for the cell state.

Weight	getCellWeight () const
	Getter for the cell weight.

void	setCellWeight (Weight weight)
	Setter for the cell weight.

void	setAssignedFlag (bool setTo=true)
	Sets the already assigned marker flag to the given value. Default value true.

void	unsetAssignedFlag ()
	Resets the already assigned marker flag to false.

bool	hasAssignedFlag () const
	Gets the current state of the already assigned marker flag.

void	setStartFlag (bool setTo=true)
	Sets the start marker flag to the given value. Default value true.

void	unsetStartFlag ()
	Resets the start marker flag to false.

bool	hasStartFlag () const
	Gets the current state of the start marker flag.

void	setPriorityPathFlag (bool setTo=true)
	Sets the priority path marker flag to the given value. Default value true.

void	unsetPriorityPathFlag ()
	Resets the priority path marker flag to false.

bool	hasPriorityPathFlag () const
	Gets the current state of the priority path marker flag.

void	setCycleFlag (bool setTo=true)
	Sets the cycle marker flag to the given value. Default value true.

void	unsetCycleFlag ()
	Resets the cycle marker flag to false.

bool	hasCycleFlag () const
	Gets the current state of the cycle marker flag.

void	unsetTemporaryFlags ()
	Resets the assigned, start and cycle marker flag.

void	setMaskedFlag (bool setTo=true)
	Sets the masked flag to the given value. Default value true.

void	unsetMaskedFlag ()
	Resets the masked flag to false.

bool	hasMaskedFlag () const
	Gets the current state of the masked marker flag.

void	setTakenFlag (bool setTo=true)
	Sets the taken flag to the given value. Default value true.

void	unsetTakenFlag ()
	Resets the taken flag to false.

bool	hasTakenFlag () const
	Gets the current state of the taken marker flag.

void	setBackgroundFlag (bool setTo=true)
	Sets the background flag to the given value. Default value true.

void	unsetBackgroundFlag ()
	Resets the background flag to false.

bool	hasBackgroundFlag () const
	Gets the current state of the do not use flag marker flag.

void	setBadADCOrTOTFlag (bool setTo=true)
	Sets the bad ADC or TOT flag to the given value.

void	unsetBadADCOrTOTFlag ()
	Resets the bad ADC or TOT flag to false.

bool	hasBadADCOrTOTFlag () const
	Gets the current state of the bad ADC or TOT flag.

void	setPriorityFlag (bool setTo=true)
	Sets the priority flag to the given value. Default value true.

void	unsetPriorityFlag ()
	Resets the priority flag to false.

bool	hasPriorityFlag () const
	Gets the current state of the do not use flag marker flag.

void	setReverseFlag (bool setTo=true)
	Sets the reverse flag to the given value. Default value true.

void	unsetReverseFlag ()
	Resets the reverse flag to false.

bool	hasReverseFlag () const
	Gets the current state of the do not use flag marker flag.

void	setAliasFlag (bool setTo=true)
	Sets the alias flag to the given value. Default value true.

void	unsetAliasFlag ()
	Resets the alias flag to false.

bool	hasAliasFlag () const
	Gets the current state of the do not use flag marker flag.

template<ECellFlags cellFlag>
void	setFlags (bool setTo)
	Setting accessing the flag by tag.

const ECellFlags &	getFlags () const
	Getter for the ordered combination of the cell flags to mark some status of the cell.

void	setFlags (ECellFlags flags)
	Setter for the cell flags.

void	clearFlags (ECellFlags flags=c_AllFlags)
	Clear all flags.

bool	hasAnyFlags (ECellFlags flags) const
	Checks if a cell has any of a sum of given flags.

Static Public Attributes
static const ECellFlags	c_AllFlags
	Constant summing all possible cell flags.

static const ECellFlags	c_TemporaryFlags
	Flags that are reset at the start of each run of the cellular automaton.

Private Attributes
Weight	m_weight = 1
	Storage for the cell weight.

ECellFlags	m_flags = ECellFlag(0)
	Storage for the cell status flags.

Weight	m_state = 0
	Storage for the cell state set by the cellular automata.

Detailed Description

Cell used by the cellular automata.

This class represents a cell in the cellular automata algorithm the local tracking is build on. Different to the ordinary cellular automaton algorithms this class stores the state not as a integer number but
as a float value. This enables to have fractional measures of quality attached to the cell if say one new item
is not worth a full point, but a probability measure which is additive. The points that can be gained by picking
this cell are stored in the cell weight property. Moreover the class defines status flags to be set and/or read by
the cellular automaton.

Definition at line 29 of file AutomatonCell.h.

Member Typedef Documentation

◆ ECellFlags

using ECellFlags = ECellFlag

Type for an ordered combination of the status flags of cells in the cellular automata.

Definition at line 50 of file AutomatonCell.h.

Member Enumeration Documentation

◆ ECellFlag

enum ECellFlag : unsigned int

Type for the status flags of cells in the cellular automata.

Definition at line 33 of file AutomatonCell.h.

                     : unsigned int {
        c_Assigned = 1,
        c_Start = 2,
        c_PriorityPath = 4,
        c_Cycle = 8,
 
        c_Masked = 16,
 
        c_Taken = 32,
        c_Background = 64,
        c_Priority = 128,
        c_Reverse = 256,
        c_Alias = 512,
        c_BadADCOrTOT = 1024, // A CDCWireHit with bad ADC or TOT should not be used in pattern recognition.
      };

Constructor & Destructor Documentation

◆ AutomatonCell() [1/3]

AutomatonCell ( )

inline

Default constructor for ROOT compatibility. Cell weight defaults to 0.

Definition at line 72 of file AutomatonCell.h.

        : m_weight(0)
        , m_flags(ECellFlag(0))
        , m_state(0)
      {
      }

◆ AutomatonCell() [2/3]

AutomatonCell ( const Weight & cellWeight )

inlineexplicit

Constructor with a certain cell weight.

Definition at line 80 of file AutomatonCell.h.

        : m_weight(cellWeight)
        , m_flags(ECellFlag(0))
        , m_state(0)
      {
      }

◆ AutomatonCell() [3/3]

AutomatonCell	(	const Weight &	cellWeight,
		const ECellFlags &	initialFlags
	)

inline

Constructor with a certain cell weight and initial flags to be set.

Definition at line 88 of file AutomatonCell.h.

        : m_weight(cellWeight)
        , m_flags(initialFlags)
        , m_state(0)
      {
      }

Member Function Documentation

◆ clearFlags()

void clearFlags ( ECellFlags flags = c_AllFlags )

inline

Clear all flags.

Definition at line 360 of file AutomatonCell.h.

361 { m_flags = ECellFlags(m_flags bitand ~flags); }

Belle2::TrackFindingCDC::AutomatonCell::ECellFlags

ECellFlag ECellFlags

Type for an ordered combination of the status flags of cells in the cellular automata.

Definition: AutomatonCell.h:50

◆ getCellState()

Weight getCellState ( ) const

inline

Getter for the cell state.

Definition at line 96 of file AutomatonCell.h.

      {
        return m_state;
      }

◆ getCellWeight()

Weight getCellWeight ( ) const

inline

Getter for the cell weight.

The cell might carry more than one unit of information to be added to the path.
The weight describes an additive constant to be gained when picking up this cell.
For instance segments may provide their number of hits as weight.
Or they could have a reduced number of hits diminished by the quality of a fit to the segment.
For on the other side wire hits this should be one.

Definition at line 116 of file AutomatonCell.h.

      {
        return m_weight;
      }

◆ getFlags()

const ECellFlags & getFlags ( ) const

inline

Getter for the ordered combination of the cell flags to mark some status of the cell.

Give the ordered combination of all cell flags, therefore providing a bit pattern.
Use rather hasAnyFlags() to retrieve stats even for single state values.

Definition at line 352 of file AutomatonCell.h.

353 { return m_flags; }

◆ hasAliasFlag()

bool hasAliasFlag ( ) const

inline

Gets the current state of the do not use flag marker flag.

Definition at line 331 of file AutomatonCell.h.

      {
        return hasAnyFlags(ECellFlag::c_Alias);
      }

◆ hasAnyFlags()

bool hasAnyFlags ( ECellFlags flags ) const

inline

Checks if a cell has any of a sum of given flags.

Definition at line 364 of file AutomatonCell.h.

365 { return m_flags bitand flags; }

◆ hasAssignedFlag()

bool hasAssignedFlag ( ) const

inline

Gets the current state of the already assigned marker flag.

Definition at line 140 of file AutomatonCell.h.

      {
        return hasAnyFlags(ECellFlag::c_Assigned);
      }

◆ hasBackgroundFlag()

bool hasBackgroundFlag ( ) const

inline

Gets the current state of the do not use flag marker flag.

Definition at line 257 of file AutomatonCell.h.

      {
        return hasAnyFlags(ECellFlag::c_Background);
      }

◆ hasBadADCOrTOTFlag()

bool hasBadADCOrTOTFlag ( ) const

inline

Gets the current state of the bad ADC or TOT flag.

Definition at line 277 of file AutomatonCell.h.

      {
        return hasAnyFlags(ECellFlag::c_BadADCOrTOT);
      }

◆ hasCycleFlag()

bool hasCycleFlag ( ) const

inline

Gets the current state of the cycle marker flag.

Definition at line 194 of file AutomatonCell.h.

      {
        return hasAnyFlags(ECellFlag::c_Cycle);
      }

◆ hasMaskedFlag()

bool hasMaskedFlag ( ) const

inline

Gets the current state of the masked marker flag.

Definition at line 218 of file AutomatonCell.h.

      {
        return hasAnyFlags(ECellFlag::c_Masked);
      }

◆ hasPriorityFlag()

bool hasPriorityFlag ( ) const

inline

Gets the current state of the do not use flag marker flag.

Definition at line 295 of file AutomatonCell.h.

      {
        return hasAnyFlags(ECellFlag::c_Priority);
      }

◆ hasPriorityPathFlag()

bool hasPriorityPathFlag ( ) const

inline

Gets the current state of the priority path marker flag.

Definition at line 176 of file AutomatonCell.h.

      {
        return hasAnyFlags(ECellFlag::c_PriorityPath);
      }

◆ hasReverseFlag()

bool hasReverseFlag ( ) const

inline

Gets the current state of the do not use flag marker flag.

Definition at line 313 of file AutomatonCell.h.

      {
        return hasAnyFlags(ECellFlag::c_Reverse);
      }

◆ hasStartFlag()

bool hasStartFlag ( ) const

inline

Gets the current state of the start marker flag.

Definition at line 158 of file AutomatonCell.h.

      {
        return hasAnyFlags(ECellFlag::c_Start);
      }

◆ hasTakenFlag()

bool hasTakenFlag ( ) const

inline

Gets the current state of the taken marker flag.

Taken means that the hit has been either assigned to a track or has been classified as background should therefore be not used for any track fitting

Definition at line 239 of file AutomatonCell.h.

      {
        return hasAnyFlags(ECellFlag::c_Taken);
      }

◆ setAliasFlag()

void setAliasFlag ( bool setTo = true )

inline

Sets the alias flag to the given value. Default value true.

Definition at line 319 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Alias>(setTo);
      }

◆ setAssignedFlag()

void setAssignedFlag ( bool setTo = true )

inline

Sets the already assigned marker flag to the given value. Default value true.

Definition at line 128 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Assigned>(setTo);
      }

◆ setBackgroundFlag()

void setBackgroundFlag ( bool setTo = true )

inline

Sets the background flag to the given value. Default value true.

Definition at line 245 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Background>(setTo);
      }

◆ setBadADCOrTOTFlag()

void setBadADCOrTOTFlag ( bool setTo = true )

inline

Sets the bad ADC or TOT flag to the given value.

Default value true. The CDCWireHit with bad ADC or TOT should not be used in pattern recognition, but may be added to the track after the track finding if it is very close to the found track.

Definition at line 265 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_BadADCOrTOT>(setTo);
      }

◆ setCellState()

void setCellState ( Weight state )

inline

Setter for the cell state.

Definition at line 102 of file AutomatonCell.h.

      {
        m_state = state;
      }

◆ setCellWeight()

void setCellWeight ( Weight weight )

inline

Setter for the cell weight.

Definition at line 122 of file AutomatonCell.h.

      {
        m_weight = weight;
      }

◆ setCycleFlag()

void setCycleFlag ( bool setTo = true )

inline

Sets the cycle marker flag to the given value. Default value true.

Definition at line 182 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Cycle>(setTo);
      }

◆ setFlags() [1/2]

void setFlags ( bool setTo )

inline

Setting accessing the flag by tag.

Definition at line 338 of file AutomatonCell.h.

      {
        if (setTo) {
          setFlags(cellFlag);
        } else {
          clearFlags(cellFlag);
        }
      }

◆ setFlags() [2/2]

void setFlags ( ECellFlags flags )

inline

Setter for the cell flags.

Definition at line 356 of file AutomatonCell.h.

357 { m_flags = ECellFlags(m_flags bitor flags); }

◆ setMaskedFlag()

void setMaskedFlag ( bool setTo = true )

inline

Sets the masked flag to the given value. Default value true.

Definition at line 206 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Masked>(setTo);
      }

◆ setPriorityFlag()

void setPriorityFlag ( bool setTo = true )

inline

Sets the priority flag to the given value. Default value true.

Definition at line 283 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Priority>(setTo);
      }

◆ setPriorityPathFlag()

void setPriorityPathFlag ( bool setTo = true )

inline

Sets the priority path marker flag to the given value. Default value true.

Definition at line 164 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_PriorityPath>(setTo);
      }

◆ setReverseFlag()

void setReverseFlag ( bool setTo = true )

inline

Sets the reverse flag to the given value. Default value true.

Definition at line 301 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Reverse>(setTo);
      }

◆ setStartFlag()

void setStartFlag ( bool setTo = true )

inline

Sets the start marker flag to the given value. Default value true.

Definition at line 146 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Start>(setTo);
      }

◆ setTakenFlag()

void setTakenFlag ( bool setTo = true )

inline

Sets the taken flag to the given value. Default value true.

Definition at line 224 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Taken>(setTo);
      }

◆ unsetAliasFlag()

void unsetAliasFlag ( )

inline

Resets the alias flag to false.

Definition at line 325 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Alias>(false);
      }

◆ unsetAssignedFlag()

void unsetAssignedFlag ( )

inline

Resets the already assigned marker flag to false.

Definition at line 134 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Assigned>(false);
      }

◆ unsetBackgroundFlag()

void unsetBackgroundFlag ( )

inline

Resets the background flag to false.

Definition at line 251 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Background>(false);
      }

◆ unsetBadADCOrTOTFlag()

void unsetBadADCOrTOTFlag ( )

inline

Resets the bad ADC or TOT flag to false.

Definition at line 271 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_BadADCOrTOT>(false);
      }

◆ unsetCycleFlag()

void unsetCycleFlag ( )

inline

Resets the cycle marker flag to false.

Definition at line 188 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Cycle>(false);
      }

◆ unsetMaskedFlag()

void unsetMaskedFlag ( )

inline

Resets the masked flag to false.

Definition at line 212 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Masked>(false);
      }

◆ unsetPriorityFlag()

void unsetPriorityFlag ( )

inline

Resets the priority flag to false.

Definition at line 289 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Priority>(false);
      }

◆ unsetPriorityPathFlag()

void unsetPriorityPathFlag ( )

inline

Resets the priority path marker flag to false.

Definition at line 170 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_PriorityPath>(false);
      }

◆ unsetReverseFlag()

void unsetReverseFlag ( )

inline

Resets the reverse flag to false.

Definition at line 307 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Reverse>(false);
      }

◆ unsetStartFlag()

void unsetStartFlag ( )

inline

Resets the start marker flag to false.

Definition at line 152 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Start>(false);
      }

◆ unsetTakenFlag()

void unsetTakenFlag ( )

inline

Resets the taken flag to false.

Definition at line 230 of file AutomatonCell.h.

      {
        setFlags<ECellFlag::c_Taken>(false);
      }

◆ unsetTemporaryFlags()

void unsetTemporaryFlags ( )

inline

Resets the assigned, start and cycle marker flag.

Definition at line 200 of file AutomatonCell.h.

      {
        setFlags<c_TemporaryFlags>(false);
      }

Member Data Documentation

◆ c_AllFlags

const ECellFlags c_AllFlags

static

Initial value:

= ECellFlags(ECellFlag::c_Assigned +
                                                      ECellFlag::c_Start +
                                                      ECellFlag::c_PriorityPath +
                                                      ECellFlag::c_Cycle +
                                                      ECellFlag::c_Masked +
                                                      ECellFlag::c_Taken +
                                                      ECellFlag::c_Background +
                                                      ECellFlag::c_Reverse +
                                                      ECellFlag::c_Alias +
                                                      ECellFlag::c_BadADCOrTOT)

Constant summing all possible cell flags.

Definition at line 53 of file AutomatonCell.h.

◆ c_TemporaryFlags

const ECellFlags c_TemporaryFlags

static

Initial value:

= ECellFlags(ECellFlag::c_Assigned +
                                                            ECellFlag::c_Start +
                                                            ECellFlag::c_PriorityPath +
                                                            ECellFlag::c_Cycle)

Flags that are reset at the start of each run of the cellular automaton.

Definition at line 65 of file AutomatonCell.h.

◆ m_flags

ECellFlags m_flags = ECellFlag(0)

private

Storage for the cell status flags.

Definition at line 372 of file AutomatonCell.h.

◆ m_state

Weight m_state = 0

private

Storage for the cell state set by the cellular automata.

Definition at line 375 of file AutomatonCell.h.

◆ m_weight

Weight m_weight = 1

private

Storage for the cell weight.

Definition at line 369 of file AutomatonCell.h.

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

tracking/trackFindingCDC/ca/include/AutomatonCell.h

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ECellFlags

Member Enumeration Documentation

◆ ECellFlag

Constructor & Destructor Documentation

◆ AutomatonCell() [1/3]

◆ AutomatonCell() [2/3]

◆ AutomatonCell() [3/3]

Member Function Documentation

◆ clearFlags()

◆ getCellState()

◆ getCellWeight()

◆ getFlags()

◆ hasAliasFlag()

◆ hasAnyFlags()

◆ hasAssignedFlag()

◆ hasBackgroundFlag()

◆ hasBadADCOrTOTFlag()

◆ hasCycleFlag()

◆ hasMaskedFlag()

◆ hasPriorityFlag()

◆ hasPriorityPathFlag()

◆ hasReverseFlag()

◆ hasStartFlag()

◆ hasTakenFlag()

◆ setAliasFlag()

◆ setAssignedFlag()

◆ setBackgroundFlag()

◆ setBadADCOrTOTFlag()

◆ setCellState()

◆ setCellWeight()

◆ setCycleFlag()

◆ setFlags() [1/2]

◆ setFlags() [2/2]

◆ setMaskedFlag()

◆ setPriorityFlag()

◆ setPriorityPathFlag()

◆ setReverseFlag()

◆ setStartFlag()

◆ setTakenFlag()

◆ unsetAliasFlag()

◆ unsetAssignedFlag()

◆ unsetBackgroundFlag()

◆ unsetBadADCOrTOTFlag()

◆ unsetCycleFlag()

◆ unsetMaskedFlag()

◆ unsetPriorityFlag()

◆ unsetPriorityPathFlag()

◆ unsetReverseFlag()

◆ unsetStartFlag()

◆ unsetTakenFlag()

◆ unsetTemporaryFlags()

Member Data Documentation

◆ c_AllFlags

◆ c_TemporaryFlags

◆ m_flags

◆ m_state

◆ m_weight