Trk::MultiComponentStateOnSurface Class Reference

#include <MultiComponentStateOnSurface.h>

Inheritance diagram for Trk::MultiComponentStateOnSurface:

Collaboration diagram for Trk::MultiComponentStateOnSurface:

Public Types
enum	TrackStateOnSurfaceType {   Measurement = 0 , InertMaterial = 1 , BremPoint = 2 , Scatterer = 3 ,   Perigee = 4 , Outlier = 5 , Hole = 6 , Unknown = 7 ,   CaloDeposit = 8 , Parameter = 9 , FitQuality = 10 , Alignment = 11 ,   NumberOfTrackStateOnSurfaceTypes = 12 }
enum	PersistencyHint {   PartialPersistification = 0 , PersistifyMeasurement = 1 , PersistifyTrackParameters = 2 , PersistifySlimCaloDeposit = 3 ,   NumberOfPersistencyHints = 4 }
enum	Variety { SingleComponent = 0 , MultiComponent = 1 , Align = 2 }

Public Member Functions
	MultiComponentStateOnSurface ()
	Default constructor for POOL.
	MultiComponentStateOnSurface (const FitQualityOnSurface &, std::unique_ptr< MeasurementBase >, std::unique_ptr< TrackParameters >, MultiComponentState &&, std::unique_ptr< MaterialEffectsBase > materialEffectsOnTrack=nullptr)
	Create a MultiComponentStateOnSurface Object with an explicit declaration of the track parameters to be passed to the Trk::TrackStateOnSurface base class.
	MultiComponentStateOnSurface (const FitQualityOnSurface &, std::unique_ptr< MeasurementBase >, std::unique_ptr< TrackParameters >, MultiComponentState &&, std::unique_ptr< MaterialEffectsBase >, const std::bitset< NumberOfTrackStateOnSurfaceTypes > &types)
	Create a MultiComponentStateOnSurface Object with an explicit declaration of the track parameters to be passed to the base and also a TrackStateOnSurfaceType.
	MultiComponentStateOnSurface (const MultiComponentStateOnSurface &other)
	Copy constructor and assignment.
MultiComponentStateOnSurface &	operator= (const MultiComponentStateOnSurface &other)
	MultiComponentStateOnSurface (MultiComponentStateOnSurface &&other) noexcept=default
	Move constructor and assignment.
MultiComponentStateOnSurface &	operator= (MultiComponentStateOnSurface &&other) noexcept=default
virtual	~MultiComponentStateOnSurface ()=default
	Virtual destructor.
virtual MultiComponentStateOnSurface *	clone () const override final
	Clone method for deep copy of MultiComponentStateOnSurface.
virtual TrackStateOnSurface::Variety	variety () const override final
	This is Multi.
const MultiComponentState &	components () const
	Method to return a referenceto the multi-component state const overload.
MultiComponentState &	components ()
	Method to return a reference to the multi-component state non const overload.
const FitQualityOnSurface &	fitQualityOnSurface () const
	return FitQuality On Surface const overload
FitQualityOnSurface &	fitQualityOnSurface ()
	return FitQuality On Surface non-const overload
const TrackParameters *	trackParameters () const
	return ptr to trackparameters const overload
TrackParameters *	trackParameters ()
	return ptr to trackparameters non-const overload
const MeasurementBase *	measurementOnTrack () const
	returns MeasurementBase const overload
MeasurementBase *	measurementOnTrack ()
	returns MeasurementBase non-const overload
const MaterialEffectsBase *	materialEffectsOnTrack () const
	return material effects const overload
MaterialEffectsBase *	materialEffectsOnTrack ()
	return material effects non-const overload
const AlignmentEffectsOnTrack *	alignmentEffectsOnTrack () const
	return the the alignment effects const overload
AlignmentEffectsOnTrack *	alignmentEffectsOnTrack ()
	return the the alignment effects non-const overload
bool	type (const TrackStateOnSurfaceType type) const
	Use this method to find out if the TSoS is of a certain type: i.e.
std::string	dumpType () const
	returns a string with the expanded type of the object (i.e.
const std::bitset< NumberOfTrackStateOnSurfaceTypes >	types () const
	returns a bitset with the types of this bitset.
void	setHints (const uint8_t hints) const
	Use this method to set persistification hints.
const std::bitset< NumberOfPersistencyHints >	hints () const
	Use this method to get the persistification hints.
const Trk::Surface &	surface () const
	return associated surface
bool	isSane () const

Static Public Member Functions
static unsigned int long	joinBitsets (const std::bitset< NumberOfTrackStateOnSurfaceTypes > &types, const std::bitset< NumberOfPersistencyHints > &hints)
static void	splitToBitsets (const unsigned int long input, std::bitset< NumberOfTrackStateOnSurfaceTypes > &types, std::bitset< NumberOfPersistencyHints > &hints)

Protected Attributes
uint16_t	m_typeFlags {}
std::atomic< uint8_t >	m_hints {}

Private Member Functions
void	setFlags ()
	set sensible default flags

Private Attributes
MultiComponentState	m_multiComponentState {}
FitQualityOnSurface	m_fitQualityOnSurface {}
std::unique_ptr< TrackParameters >	m_trackParameters {}
std::unique_ptr< MeasurementBase >	m_measurementOnTrack {}
std::unique_ptr< MaterialEffectsBase >	m_materialEffectsOnTrack {}
std::unique_ptr< AlignmentEffectsOnTrack >	m_alignmentEffectsOnTrack {}

Friends
class	::TrackCollectionCnv
class	::TrackStateOnSurfaceCnv_p3

Detailed Description

Definition at line 41 of file MultiComponentStateOnSurface.h.

Member Enumeration Documentation

PersistencyHint

enum Trk::TrackStateOnSurface::PersistencyHint

inherited

Enumerator
PartialPersistification
PersistifyMeasurement	Mark the measuremenet for persistification.
PersistifyTrackParameters	Mark track parameters for persisitification.
PersistifySlimCaloDeposit	Mark track parameters for persisitification.
NumberOfPersistencyHints

Definition at line 155 of file TrackStateOnSurface.h.

  {
 
    PartialPersistification = 0,
    PersistifyMeasurement = 1,

    PersistifyTrackParameters = 2,

    PersistifySlimCaloDeposit = 3,
 
    NumberOfPersistencyHints = 4
  };

TrackStateOnSurfaceType

enum Trk::TrackStateOnSurface::TrackStateOnSurfaceType

inherited

Enumerator
Measurement	This is a measurement, and will at least contain a Trk::MeasurementBase.
InertMaterial	This represents inert material, and so will contain MaterialEffectsBase.
BremPoint	This represents a brem point on the track, and so will contain TrackParameters and MaterialEffectsBase.
Scatterer	This represents a scattering point on the track, and so will contain TrackParameters and MaterialEffectsBase.
Perigee	This represents a perigee, and so will contain a Perigee object only.
Outlier	This TSoS contains an outlier, that is, it contains a MeasurementBase/RIO_OnTrack which was not used in the track fit.
Hole	A hole on the track - this is defined in the following way. A hole is a missing measurement BETWEEN the first and last actual measurements. i.e. if your track starts in the SCT, you should not consider a missing b-layer hit as a hole.
Unknown	For some reason this does not fall into any of the other categories PLEASE DO NOT USE THIS - DEPRECATED!
CaloDeposit	This TSOS contains a CaloEnergy object.
Parameter	This TSOS contains a Trk::ParameterBase.
FitQuality	This TSOS contains a Trk::FitQualityOnSurface.
Alignment	This TSOS contains a Trk::AlignmentEffectsOnTrack.
NumberOfTrackStateOnSurfaceTypes

Definition at line 97 of file TrackStateOnSurface.h.

  {
    Measurement = 0,

    InertMaterial = 1,

    BremPoint = 2,

    Scatterer = 3,

    Perigee = 4,

    Outlier = 5,

    Hole = 6,

    Unknown = 7,

    CaloDeposit = 8,

    Parameter = 9,

    FitQuality = 10,

    Alignment = 11,
 
    NumberOfTrackStateOnSurfaceTypes = 12
  };

Variety

enum Trk::TrackStateOnSurface::Variety

inherited

Enumerator
SingleComponent
MultiComponent
Align

Definition at line 211 of file TrackStateOnSurface.h.

  {
    SingleComponent = 0,
    MultiComponent = 1,
    Align = 2,
  };

Constructor & Destructor Documentation

MultiComponentStateOnSurface() [1/5]

Trk::MultiComponentStateOnSurface::MultiComponentStateOnSurface

(

)

Default constructor for POOL.

This should not be used!

Definition at line 14 of file MultiComponentStateOnSurface.cxx.

  : TrackStateOnSurface(
      {},
      nullptr,
      nullptr,
      nullptr,
      std::bitset<TrackStateOnSurface::NumberOfTrackStateOnSurfaceTypes>(
        1 << (int)TrackStateOnSurface::Measurement))
  , m_multiComponentState{}
{
}

MultiComponentStateOnSurface() [2/5]

Trk::MultiComponentStateOnSurface::MultiComponentStateOnSurface	(	const FitQualityOnSurface &	fitQualityOnSurface,
		std::unique_ptr< MeasurementBase >	measurementBase,
		std::unique_ptr< TrackParameters >	trackParameters,
		MultiComponentState &&	multiComponentState,
		std::unique_ptr< MaterialEffectsBase >	materialEffectsOnTrack = nullptr )

Create a MultiComponentStateOnSurface Object with an explicit declaration of the track parameters to be passed to the Trk::TrackStateOnSurface base class.

Definition at line 26 of file MultiComponentStateOnSurface.cxx.

  : TrackStateOnSurface(
      fitQualityOnSurface,
      std::move(measurementBase),
      std::move(trackParameters),
      std::move(materialEffectsOnTrack),
      std::bitset<TrackStateOnSurface::NumberOfTrackStateOnSurfaceTypes>(
        1 << (int)TrackStateOnSurface::Measurement))
  , m_multiComponentState(std::move(multiComponentState))
{
}

MultiComponentStateOnSurface() [3/5]

Trk::MultiComponentStateOnSurface::MultiComponentStateOnSurface	(	const FitQualityOnSurface &	fitQualityOnSurface,
		std::unique_ptr< MeasurementBase >	measurementBase,
		std::unique_ptr< TrackParameters >	trackParameters,
		MultiComponentState &&	multiComponentState,
		std::unique_ptr< MaterialEffectsBase >	materialEffectsOnTrack,
		const std::bitset< NumberOfTrackStateOnSurfaceTypes > &	types )

Create a MultiComponentStateOnSurface Object with an explicit declaration of the track parameters to be passed to the base and also a TrackStateOnSurfaceType.

Definition at line 43 of file MultiComponentStateOnSurface.cxx.

  : TrackStateOnSurface(fitQualityOnSurface,
                        std::move(measurementBase),
                        std::move(trackParameters),
                        std::move(materialEffectsOnTrack),
                        types)
  , m_multiComponentState(std::move(multiComponentState))
{
}

MultiComponentStateOnSurface() [4/5]

Trk::MultiComponentStateOnSurface::MultiComponentStateOnSurface

(

const MultiComponentStateOnSurface &

other

)

Copy constructor and assignment.

Definition at line 59 of file MultiComponentStateOnSurface.cxx.

  : TrackStateOnSurface(other)
  , m_multiComponentState(
      Trk::MultiComponentStateHelpers::clone(other.components()))
{
}

MultiComponentStateOnSurface() [5/5]

Trk::MultiComponentStateOnSurface::MultiComponentStateOnSurface ( MultiComponentStateOnSurface && other )

defaultnoexcept

Move constructor and assignment.

~MultiComponentStateOnSurface()

virtual Trk::MultiComponentStateOnSurface::~MultiComponentStateOnSurface ( )

virtualdefault

Virtual destructor.

Member Function Documentation

alignmentEffectsOnTrack() [1/2]

AlignmentEffectsOnTrack * Trk::TrackStateOnSurface::alignmentEffectsOnTrack ( )

inherited

return the the alignment effects non-const overload

alignmentEffectsOnTrack() [2/2]

const AlignmentEffectsOnTrack * Trk::TrackStateOnSurface::alignmentEffectsOnTrack ( ) const

inherited

return the the alignment effects const overload

clone()

Trk::MultiComponentStateOnSurface * Trk::MultiComponentStateOnSurface::clone ( ) const

finaloverridevirtual

Clone method for deep copy of MultiComponentStateOnSurface.

Reimplemented from Trk::TrackStateOnSurface.

Definition at line 80 of file MultiComponentStateOnSurface.cxx.

{
  return new MultiComponentStateOnSurface(*this);
}

components() [1/2]

MultiComponentState & Trk::MultiComponentStateOnSurface::components

(

)

Method to return a reference to the multi-component state non const overload.

components() [2/2]

const MultiComponentState & Trk::MultiComponentStateOnSurface::components

(

)

const

Method to return a referenceto the multi-component state const overload.

dumpType()

std::string Trk::TrackStateOnSurface::dumpType ( ) const

inherited

returns a string with the expanded type of the object (i.e.

if it has several type bits set, they all will be returned)

Definition at line 147 of file TrackStateOnSurface.cxx.

{
  std::string type;
  const auto& typesSet = types();
  if (typesSet.test(TrackStateOnSurface::Measurement)) {
    type += "Measurement ";
  }
  if (typesSet.test(TrackStateOnSurface::InertMaterial)) {
    type += "InertMaterial ";
  }
  if (typesSet.test(TrackStateOnSurface::BremPoint)) {
    type += "BremPoint ";
  }
  if (typesSet.test(TrackStateOnSurface::Scatterer)) {
    type += "Scatterer ";
  }
  if (typesSet.test(TrackStateOnSurface::Perigee)) {
    type += "Perigee ";
  }
  if (typesSet.test(TrackStateOnSurface::Outlier)) {
    type += "Outlier ";
  }
  if (typesSet.test(TrackStateOnSurface::Hole)) {
    type += "Hole ";
  }
  if (typesSet.test(TrackStateOnSurface::CaloDeposit)) {
    type += "CaloDeposit ";
  }
  if (typesSet.test(TrackStateOnSurface::Parameter)) {
    type += "Parameter ";
  }
  if (typesSet.test(TrackStateOnSurface::FitQuality)) {
    type += "FitQuality ";
  }
  if (typesSet.test(TrackStateOnSurface::Alignment)) {
    type += "Alignment ";
  }
  return type;
}

fitQualityOnSurface() [1/2]

FitQualityOnSurface & Trk::TrackStateOnSurface::fitQualityOnSurface ( )

inherited

return FitQuality On Surface non-const overload

fitQualityOnSurface() [2/2]

const FitQualityOnSurface & Trk::TrackStateOnSurface::fitQualityOnSurface ( ) const

inherited

return FitQuality On Surface const overload

hints()

const std::bitset< NumberOfPersistencyHints > Trk::TrackStateOnSurface::hints ( ) const

inherited

Use this method to get the persistification hints.

isSane()

bool Trk::TrackStateOnSurface::isSane ( ) const

inherited

Definition at line 203 of file TrackStateOnSurface.cxx.

{
  bool surfacesDiffer =
    not Trk::consistentSurfaces(trackParameters(),
                                measurementOnTrack(),
                                materialEffectsOnTrack());
  if (surfacesDiffer) {
    std::cerr << "TrackStateOnSurface::isSane. With :" << '\n';
    std::cerr << "Types : " << types().to_string() << '\n';
    std::cerr << "Hints " << hints().to_string() << '\n';
    std::cerr << "Surfaces differ! " << std::endl;
    if (m_trackParameters) {
      std::cerr << "ParamSurf: [" << &(m_trackParameters->associatedSurface())
                << "] " << m_trackParameters->associatedSurface() << std::endl;
    }
    if (m_measurementOnTrack) {
      std::cerr << "measSurf: [" << &(m_measurementOnTrack->associatedSurface())
                << "] " << m_measurementOnTrack->associatedSurface()
                << std::endl;
    }
    if (m_materialEffectsOnTrack) {
      std::cerr << "matSurf: ["
                << &(m_materialEffectsOnTrack->associatedSurface()) << "] "
                << m_materialEffectsOnTrack->associatedSurface() << std::endl;
    }
    return false;
  }
 
  return true;
}

joinBitsets()

unsigned int long Trk::TrackStateOnSurface::joinBitsets ( const std::bitset< NumberOfTrackStateOnSurfaceTypes > & types, const std::bitset< NumberOfPersistencyHints > & hints )

inlinestaticinherited

Definition at line 183 of file TrackStateOnSurface.h.

  {
    //put hints in place
    unsigned int long res = hints.to_ulong();
    //shift them up
    res = (res << NumberOfTrackStateOnSurfaceTypes);
    //Add type
    res += types.to_ulong();
    return res;
  }

materialEffectsOnTrack() [1/2]

MaterialEffectsBase * Trk::TrackStateOnSurface::materialEffectsOnTrack ( )

inherited

return material effects non-const overload

materialEffectsOnTrack() [2/2]

const MaterialEffectsBase * Trk::TrackStateOnSurface::materialEffectsOnTrack ( ) const

inherited

return material effects const overload

measurementOnTrack() [1/2]

MeasurementBase * Trk::TrackStateOnSurface::measurementOnTrack ( )

inherited

returns MeasurementBase non-const overload

measurementOnTrack() [2/2]

const MeasurementBase * Trk::TrackStateOnSurface::measurementOnTrack ( ) const

inherited

returns MeasurementBase const overload

operator=() [1/2]

Trk::MultiComponentStateOnSurface & Trk::MultiComponentStateOnSurface::operator=

(

const MultiComponentStateOnSurface &

other

)

Definition at line 68 of file MultiComponentStateOnSurface.cxx.

{
  if (this != &other) {
    TrackStateOnSurface::operator=(other);
    m_multiComponentState =
      Trk::MultiComponentStateHelpers::clone(other.components());
  }
  return *this;
}

operator=() [2/2]

MultiComponentStateOnSurface & Trk::MultiComponentStateOnSurface::operator= ( MultiComponentStateOnSurface && other )

defaultnoexcept

setFlags()

void Trk::TrackStateOnSurface::setFlags ( )

privateinherited

set sensible default flags

setHints()

void Trk::TrackStateOnSurface::setHints ( const uint8_t hints ) const

inherited

Use this method to set persistification hints.

This can be called only once per TSOS It will set a cached Value which we can not reset But this allows it to be const..

Definition at line 235 of file TrackStateOnSurface.cxx.

{
  // The extra "hidden" bit we save (1<<NumberOfPersistencyHints)
  // is to dissalow repeated calls to setHints(0).
  uint8_t exp = 0;
  if (!m_hints.compare_exchange_strong(
        exp, hints | (1 << NumberOfPersistencyHints))) {
    throw std::runtime_error(
      "TSOS trying to set again already set Persistification Hints");
  }
}

splitToBitsets()

void Trk::TrackStateOnSurface::splitToBitsets ( const unsigned int long input, std::bitset< NumberOfTrackStateOnSurfaceTypes > & types, std::bitset< NumberOfPersistencyHints > & hints )

inlinestaticinherited

Definition at line 196 of file TrackStateOnSurface.h.

  {
    // mask with NumberOfTrackStateOnSurfaceTypes bits set to 1
    constexpr unsigned int long maskTypesSet =
      (1 << NumberOfTrackStateOnSurfaceTypes) - 1;
    //keep just the Type part of the input
    types = std::bitset<NumberOfTrackStateOnSurfaceTypes>(input & maskTypesSet);
    //keep the upper Hints part of the input
    hints = std::bitset<NumberOfPersistencyHints>(
      input >> NumberOfTrackStateOnSurfaceTypes);
  }

surface()

const Surface & Trk::TrackStateOnSurface::surface ( ) const

inherited

return associated surface

Used to perform sanity checks on this object (i.e. all consistuents are on the same surface). Returns 'true' if it seems okay.

Definition at line 188 of file TrackStateOnSurface.cxx.

{
  if (m_trackParameters) {
    return m_trackParameters->associatedSurface();
  }
  if (m_measurementOnTrack) {
    return m_measurementOnTrack->associatedSurface();
  }
  if (m_materialEffectsOnTrack) {
    return m_materialEffectsOnTrack->associatedSurface();
  }
  throw std::runtime_error("TrackStateOnSurface without Surface!");
}

trackParameters() [1/2]

TrackParameters * Trk::TrackStateOnSurface::trackParameters ( )

inherited

return ptr to trackparameters non-const overload

trackParameters() [2/2]

const TrackParameters * Trk::TrackStateOnSurface::trackParameters ( ) const

inherited

return ptr to trackparameters const overload

type()

bool Trk::TrackStateOnSurface::type ( const TrackStateOnSurfaceType type ) const

inherited

Use this method to find out if the TSoS is of a certain type: i.e.

if ( tsos->type(TrackStateOnSurface::Measurement) { //etc }

Returns

true if the TrackStateOnSurface is of this type

types()

const std::bitset< NumberOfTrackStateOnSurfaceTypes > Trk::TrackStateOnSurface::types ( ) const

inherited

returns a bitset with the types of this bitset.

As an example of how this is used, see the type( const TrackStateOnSurfaceType& type ) method but a better example would be if you wanted to check several type flags at once.

const bitset<NumberOfTrackStateOnSurfaceTypes> mask;
mask.set(Measurement,true);
mask.set(BremPoint,true);
// loop over lots of TSoS and call:
if (tsos.types() & mask ) { // do something}

variety()

virtual TrackStateOnSurface::Variety Trk::MultiComponentStateOnSurface::variety ( ) const

finaloverridevirtual

This is Multi.

Reimplemented from Trk::TrackStateOnSurface.

Friends And Related Symbol Documentation

::TrackCollectionCnv

friend class ::TrackCollectionCnv

friend

Definition at line 44 of file MultiComponentStateOnSurface.h.

::TrackStateOnSurfaceCnv_p3

friend class ::TrackStateOnSurfaceCnv_p3

friend

Definition at line 45 of file MultiComponentStateOnSurface.h.

Member Data Documentation

m_alignmentEffectsOnTrack

std::unique_ptr<AlignmentEffectsOnTrack> Trk::TrackStateOnSurface::m_alignmentEffectsOnTrack {}

privateinherited

Definition at line 371 of file TrackStateOnSurface.h.

{};

m_fitQualityOnSurface

FitQualityOnSurface Trk::TrackStateOnSurface::m_fitQualityOnSurface {}

privateinherited

Definition at line 367 of file TrackStateOnSurface.h.

{};

m_hints

std::atomic<uint8_t> Trk::TrackStateOnSurface::m_hints {}

mutableprotectedinherited

Definition at line 374 of file TrackStateOnSurface.h.

{};

m_materialEffectsOnTrack

std::unique_ptr<MaterialEffectsBase> Trk::TrackStateOnSurface::m_materialEffectsOnTrack {}

privateinherited

Definition at line 370 of file TrackStateOnSurface.h.

{};

m_measurementOnTrack

std::unique_ptr<MeasurementBase> Trk::TrackStateOnSurface::m_measurementOnTrack {}

privateinherited

Definition at line 369 of file TrackStateOnSurface.h.

{};

m_multiComponentState

MultiComponentState Trk::MultiComponentStateOnSurface::m_multiComponentState {}

private

Definition at line 100 of file MultiComponentStateOnSurface.h.

{};

m_trackParameters

std::unique_ptr<TrackParameters> Trk::TrackStateOnSurface::m_trackParameters {}

privateinherited

Definition at line 368 of file TrackStateOnSurface.h.

{};

m_typeFlags

uint16_t Trk::TrackStateOnSurface::m_typeFlags {}

protectedinherited

Definition at line 373 of file TrackStateOnSurface.h.

{};

---

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

• MultiComponentStateOnSurface.h
• MultiComponentStateOnSurface.cxx