recob::TrajectoryPointFlags Class Reference

Set of flags pertaining a point of the track. More...

#include "TrajectoryPointFlags.h"

Public Types
using	flag = TrajectoryPointFlagTraits
	Type of flag traits (indices and meaning of flags). More...
using	Flags_t = flag::Flags_t
	Type holding the flags. More...
using	Mask_t = Flags_t::Mask_t
	Type holding the flags. More...
using	Flag_t = Flags_t::Flag_t
	Type of single flag. More...
using	FlagIndex_t = Flags_t::FlagIndex_t
	Type of index of single flag. More...
using	HitIndex_t = unsigned int
	Type for hit index. More...

Public Member Functions
constexpr	TrajectoryPointFlags ()=default
constexpr	TrajectoryPointFlags (HitIndex_t fromHit)
	Constructor: specified hit index, default flags. More...
constexpr	TrajectoryPointFlags (HitIndex_t fromHit, Mask_t flags)
	Constructor: copies all the flags. More...
template<typename... Flags>
constexpr	TrajectoryPointFlags (HitIndex_t fromHit, Flags...flags)
	Constructor: activates only the specified flags. More...
constexpr Mask_t const &	mask () const
	Returns the entire set of bits as a bit mask. More...
constexpr Flags_t const &	flags () const
	Returns the entire set of bits. More...
constexpr bool	operator== (TrajectoryPointFlags const &other) const
	Returns whether other has the same content as this one. More...
constexpr bool	operator!= (TrajectoryPointFlags const &other) const
	Returns whether other has content different than this one. More...
template<typename Stream >
void	dump (Stream &&out, unsigned int verbosity, std::string indent, std::string indentFirst) const
	Prints the flags content into a stream. More...
template<typename Stream >
void	dump (Stream &&out, unsigned int verbosity=1, std::string indent={}) const
	Prints flag content into a stream. More...
template<typename... Flags>
constexpr recob::TrajectoryPointFlags::Mask_t	makeMask (Flags...flags)
Access to flags by index
constexpr bool	isAllocated (FlagIndex_t flagIndex) const
	Returns whether there is room for a flag with the specified index. More...
constexpr FlagIndex_t	nFlags () const
	Returns the number of defined flags. More...
constexpr bool	isFlag (FlagIndex_t flagIndex) const
constexpr bool	isFlag (Flag_t flag) const
bool	test (FlagIndex_t index) const
	Returns whether the specified flag is set. More...
bool	test (Flag_t flag) const
	Returns whether the specified flag is set. More...
bool	get (Flag_t flag) const
	Returns whether the specified flag is set. More...
bool	isDefined (Flag_t flag) const
	Returns true if the flag has been assigned a value. More...
bool	isSet (Flag_t flag) const
	Returns true if the flag exists and is set. More...
bool	isUnset (Flag_t flag) const
	Returns true if the flag exists and is not set. More...
bool	match (Mask_t mask) const
	Returns true if the specified mask is matched. More...
Multiple flag access
Note This implementation is partial. Please contact the author to discuss your need.
bool	anySet (Mask_t mask) const
	Returns whether any of the bits set in the mask are set. More...
bool	noneSet (Mask_t mask) const
	Returns whether none of the bits set in the mask is set. More...
Access to flags by meaning
bool	isHitIgnored () const
	Returns whether the associated hit is considered ignored. More...
bool	isPointValid () const
	Returns whether the associated point is valid. More...
bool	isMerged () const
	Returns whether the point has the Merged flag set. More...
bool	isShared () const
	Returns whether the point has the Shared flag set. More...
bool	isDeltaRay () const
	Returns whether the point has the DeltaRay flag set. More...
bool	hasDetectorIssues () const
	Returns whether the point has the DetectorIssue flag set. More...
bool	isOtherwiseSuspicious () const
	Returns whether the point has the Suspicious flag set. More...
bool	isExclusive () const
bool	isExcludedFromFit () const
	Returns whether the point has the ExcludedFromFit flag set. More...
bool	belongsToTrack () const
	Returns whether the point has the Rejected flag set. More...
bool	isHitReinterpreted () const
	Returns whether the point has the Reinterpreted flag set. More...
bool	isIncludedInFit () const
bool	isPointFlawed () const
	Returns whether the trajectory point has any problem flagged. More...
bool	isPointFlawless () const
	Returns whether the trajectory point has no flagged problem. More...
Access to hit index
constexpr bool	hasOriginalHitIndex () const
constexpr HitIndex_t	fromHit () const

Static Public Member Functions
template<typename... Flags>
static constexpr Mask_t	makeMask (Flags...flags)
	Returns a bit mask with only the specified bit set. More...
static constexpr Mask_t	DefaultFlagsMask ()
	Flags used in default construction. More...

Static Public Attributes
static constexpr HitIndex_t	InvalidHitIndex = std::numeric_limits<HitIndex_t>::max()
	Value marking an invalid hit index. More...

Private Member Functions
constexpr bool	sameAs (TrajectoryPointFlags const &other) const
	Implementation detail of operator==() More...

Static Private Member Functions
static constexpr Mask_t	ImperfectPointMask ()
	Flags to define a non-perfect trajectory point. More...
static constexpr Mask_t	SomehowSharedMask ()
	Flags to define a hit that is in some way shared. More...
static constexpr Mask_t	ExcludedFromTrackFitMask ()
	Flags to define a hit that is not included in the track fit. More...

Private Attributes
HitIndex_t	fFromHit = InvalidHitIndex
	Index of the original hit. More...
Flags_t	fFlags {DefaultFlagsMask()}
	Set of flags. More...

Detailed Description

Set of flags pertaining a point of the track.

Template Parameters

FlagTraits

type with the definition of the flag values

See also

recob::TrackTrajectory

The "flags" contain metadata pertaining a single point in a trajectory or track.

The metadata includes:

• a set of flags, including some for a trajectory, some specific to a fitted track, some reserved for future use and some available to the users
• an index pointing to the position of the hit in an originating trajectory, if such a trajectory exists. The specific convention to use this index must be documented by the using class (see recob::TrackTrajectory)

The meaning of the flags is described in the FlagTraits type. This type needs to provide a maxFlags() static constexpr method to express how many flags should be stored, d

Definition at line 304 of file TrajectoryPointFlags.h.

Member Typedef Documentation

using recob::TrajectoryPointFlags::flag = TrajectoryPointFlagTraits

Type of flag traits (indices and meaning of flags).

Definition at line 308 of file TrajectoryPointFlags.h.

using recob::TrajectoryPointFlags::Flag_t = Flags_t::Flag_t

Type of single flag.

Definition at line 314 of file TrajectoryPointFlags.h.

using recob::TrajectoryPointFlags::FlagIndex_t = Flags_t::FlagIndex_t

Type of index of single flag.

Definition at line 316 of file TrajectoryPointFlags.h.

using recob::TrajectoryPointFlags::Flags_t = flag::Flags_t

Type holding the flags.

Definition at line 310 of file TrajectoryPointFlags.h.

using recob::TrajectoryPointFlags::HitIndex_t = unsigned int

Type for hit index.

Definition at line 318 of file TrajectoryPointFlags.h.

using recob::TrajectoryPointFlags::Mask_t = Flags_t::Mask_t

Type holding the flags.

Definition at line 312 of file TrajectoryPointFlags.h.

Constructor & Destructor Documentation

constexpr recob::TrajectoryPointFlags::TrajectoryPointFlags ( )

default

Default constructor: invalid hit index, default flags (DefaultFlagsMask()).

constexpr recob::TrajectoryPointFlags::TrajectoryPointFlags ( HitIndex_t  fromHit )

inline

Constructor: specified hit index, default flags.

Parameters

fromHit

the original hit index

This constructor can be used in constexpr flag definitions:

using trkflag = recob::TrajectoryPointFlags::flag;
constexpr recob::TrajectoryPointFlags flags(12);

Definition at line 337 of file TrajectoryPointFlags.h.

: fFromHit(fromHit) {}

constexpr recob::TrajectoryPointFlags::TrajectoryPointFlags ( HitIndex_t  fromHit, Mask_t  flags  )

inline

Constructor: copies all the flags.

Parameters

fromHit	the original hit index
flags	all the flags to set, as a bit mask

This constructor can be used in constexpr flag definitions:

using trkflag = recob::TrajectoryPointFlags::flag;
constexpr recob::TrajectoryPointFlags flags(
  12,
  recob::TrajectoryPointFlags::makeMask(
    trkflag::NoPoint,
    trkflag::HitIgnored
    )
  );

Definition at line 356 of file TrajectoryPointFlags.h.

      : fFromHit(fromHit), fFlags(flags)
    {}

template<typename... Flags>

constexpr recob::TrajectoryPointFlags::TrajectoryPointFlags ( HitIndex_t  fromHit, Flags...  flags  )

inline

Constructor: activates only the specified flags.

Template Parameters

Flags

the type of flags to be set

Parameters

fromHit	the original hit index
flags	all the flags to set

This constructor can be used in constexpr flag definitions:

using trkflag = recob::TrajectoryPointFlags::flag;
constexpr recob::TrajectoryPointFlags flags(
  recob::TrajectoryPointFlags::InvalidHitIndex,
  trkflag::NoPoint,
  trkflag::Merged
  );

Definition at line 377 of file TrajectoryPointFlags.h.

      : TrajectoryPointFlags(fromHit, makeMask(flags...))
    {}

Member Function Documentation

bool recob::TrajectoryPointFlags::anySet ( Mask_t  mask ) const

inline

Returns whether any of the bits set in the mask are set.

Parameters

mask	mask with the bits to be checked defined and set (isSet())

Returns

whether any of the bits set in the mask are set

The method returns true if of all the flags that are set (Mask_t::isSet()) in mask, at least one is set. Flags of mask that are unset or undefined are ignored.

Definition at line 504 of file TrajectoryPointFlags.h.

{ return flags().anySet(mask); }

bool recob::TrajectoryPointFlags::belongsToTrack ( ) const

inline

Returns whether the point has the Rejected flag set.

Definition at line 550 of file TrajectoryPointFlags.h.

{ return !isSet(flag::Rejected); }

constexpr recob::TrajectoryPointFlags::Mask_t recob::TrajectoryPointFlags::DefaultFlagsMask ( )

inlinestatic

Flags used in default construction.

Definition at line 731 of file TrajectoryPointFlags.h.

References util::flags::makeMask().

Referenced by trkf::TrackKalmanFitter::setupInputStates().

{
  return makeMask(-flag::NoPoint);
} // recob::TrajectoryPointFlags::DefaultFlagsMask()

template<typename Stream >

void recob::TrajectoryPointFlags::dump	(	Stream &&	out,
		unsigned int	verbosity,
		std::string	indent,
		std::string	indentFirst
	)		const

Prints the flags content into a stream.

Template Parameters

Stream

type of the output stream

Parameters

out	stream to output the information into
verbosity	verbosity level (default: 1)
indent	indentation string (default: none)
indentFirst	indentation for first output line (default: as indent)

Prints on a single line all the flags that are set.

Currently indent is not used since the output is single line.

Information printed out (verbosity argument)

• level 0: number of the flags set, and index
• level 1: name of the flags set, and index

Referenced by recob::operator<<().

template<typename Stream >

void recob::TrajectoryPointFlags::dump ( Stream &&  out, unsigned int  verbosity = 1, std::string  indent = {}  ) const

inline

Prints flag content into a stream.

Template Parameters

Stream

type of the output stream

Parameters

out	stream to output the information into
verbosity	verbosity level (default: 1)
indent	indentation string (default: none)

See also

Dump(Stream&&, unsigned int, std::string, std::string)

Implementation detail for Dump(Stream&&, unsigned int, std::string, std::string).

Definition at line 634 of file TrajectoryPointFlags.h.

References util::flags::makeMask().

                                                                           {}) const
    {
      dump(std::forward<Stream>(out), verbosity, indent, indent);
    }

constexpr recob::TrajectoryPointFlags::Mask_t recob::TrajectoryPointFlags::ExcludedFromTrackFitMask ( )

inlinestaticprivate

Flags to define a hit that is not included in the track fit.

Definition at line 724 of file TrajectoryPointFlags.h.

{
  return flag::ExcludedFromFit + flag::Rejected;
}

constexpr Flags_t const& recob::TrajectoryPointFlags::flags ( ) const

inline

Returns the entire set of bits.

Definition at line 485 of file TrajectoryPointFlags.h.

Referenced by sameAs().

{ return fFlags; }

constexpr HitIndex_t recob::TrajectoryPointFlags::fromHit ( ) const

inline

Returns the original index of the hit.

Returns

the index of the original hit (InvalidHitIndex if not set)

See also

hasOriginalHitIndex()

Definition at line 587 of file TrajectoryPointFlags.h.

References art::detail::indent(), util::details::operator!=(), util::details::operator==(), and fhicl::other.

Referenced by trkmkr::KalmanFilterFitTrackMaker::restoreInputPoints(), and sameAs().

{ return fFromHit; }

bool recob::TrajectoryPointFlags::get ( Flag_t  flag ) const

inline

Returns whether the specified flag is set.

Parameters

flag	index of the flag to be tested

Returns

whether the specified flag is set

A single flag is tested. If the flag is not defined (invalid index), the result is undefined.

Definition at line 439 of file TrajectoryPointFlags.h.

{ return flags().get(flag); }

bool recob::TrajectoryPointFlags::hasDetectorIssues ( ) const

inline

Returns whether the point has the DetectorIssue flag set.

Definition at line 537 of file TrajectoryPointFlags.h.

{ return isSet(flag::DetectorIssue); }

constexpr bool recob::TrajectoryPointFlags::hasOriginalHitIndex ( ) const

inline

Returns whether the original hit index is valid.

See also

fromHit()

Definition at line 582 of file TrajectoryPointFlags.h.

{ return fromHit() != InvalidHitIndex; }

constexpr recob::TrajectoryPointFlags::Mask_t recob::TrajectoryPointFlags::ImperfectPointMask ( )

inlinestaticprivate

Flags to define a non-perfect trajectory point.

Definition at line 711 of file TrajectoryPointFlags.h.

{
  return flag::NoPoint + flag::HitIgnored + flag::Suspicious + flag::Merged + flag::DeltaRay +
         flag::DetectorIssue + flag::Shared;
} // recob::TrajectoryPointFlags::ImperfectPointMask()

constexpr bool recob::TrajectoryPointFlags::isAllocated ( FlagIndex_t  flagIndex ) const

inline

Returns whether there is room for a flag with the specified index.

Parameters

flagIndex

index of the flag

Returns

whether there is room for a flag with the specified index.

See also

isFlag()

The flag may still be not present, in the sense that the allocated bit has no meaning associated to it and that flag is "unknown".

Definition at line 393 of file TrajectoryPointFlags.h.

    {
      return flagIndex < flags().capacity();
    }

bool recob::TrajectoryPointFlags::isDefined ( Flag_t  flag ) const

inline

Returns true if the flag has been assigned a value.

Parameters

flag	the flag index

Returns

true if the flag has been assigned a value

See also

isSet(), isUnset(), test()

Definition at line 447 of file TrajectoryPointFlags.h.

{ return flags().isDefined(flag); }

bool recob::TrajectoryPointFlags::isDeltaRay ( ) const

inline

Returns whether the point has the DeltaRay flag set.

Definition at line 534 of file TrajectoryPointFlags.h.

{ return isSet(flag::DeltaRay); }

bool recob::TrajectoryPointFlags::isExcludedFromFit ( ) const

inline

Returns whether the point has the ExcludedFromFit flag set.

Definition at line 547 of file TrajectoryPointFlags.h.

{ return get(flag::ExcludedFromFit); }

bool recob::TrajectoryPointFlags::isExclusive ( ) const

inline

Returns whether the point has no flag set among Shared, DeltaRay and Merged.

Definition at line 544 of file TrajectoryPointFlags.h.

{ return noneSet(SomehowSharedMask()); }

constexpr bool recob::TrajectoryPointFlags::isFlag ( FlagIndex_t  flagIndex ) const

inline

Returns whether a flag with the specified index is known. (all allocated flags are)

Definition at line 403 of file TrajectoryPointFlags.h.

{ return flags().isFlag(flagIndex); }

constexpr bool recob::TrajectoryPointFlags::isFlag ( Flag_t  flag ) const

inline

Returns whether a flag with the specified index is known. (all allocated flags are)

Definition at line 407 of file TrajectoryPointFlags.h.

{ return flags().isFlag(flag); }

bool recob::TrajectoryPointFlags::isHitIgnored ( ) const

inline

Returns whether the associated hit is considered ignored.

Definition at line 522 of file TrajectoryPointFlags.h.

{ return isSet(flag::HitIgnored); }

bool recob::TrajectoryPointFlags::isHitReinterpreted ( ) const

inline

Returns whether the point has the Reinterpreted flag set.

Definition at line 553 of file TrajectoryPointFlags.h.

{ return isSet(flag::Reinterpreted); }

bool recob::TrajectoryPointFlags::isIncludedInFit ( ) const

inline

Returns false if the point has the ExcludedFromFit or Rejected flag set.

Definition at line 557 of file TrajectoryPointFlags.h.

{ return noneSet(ExcludedFromTrackFitMask()); }

bool recob::TrajectoryPointFlags::isMerged ( ) const

inline

Returns whether the point has the Merged flag set.

Definition at line 528 of file TrajectoryPointFlags.h.

{ return isSet(flag::Merged); }

bool recob::TrajectoryPointFlags::isOtherwiseSuspicious ( ) const

inline

Returns whether the point has the Suspicious flag set.

Definition at line 540 of file TrajectoryPointFlags.h.

{ return isSet(flag::Suspicious); }

bool recob::TrajectoryPointFlags::isPointFlawed ( ) const

inline

Returns whether the trajectory point has any problem flagged.

A problematic point is basically one with any of the defined trajectory point flags set.

Definition at line 565 of file TrajectoryPointFlags.h.

{ return anySet(ImperfectPointMask()); }

bool recob::TrajectoryPointFlags::isPointFlawless ( ) const

inline

Returns whether the trajectory point has no flagged problem.

A problematic point is basically one with any of the defined trajectory point flags set.

Definition at line 573 of file TrajectoryPointFlags.h.

{ return noneSet(ImperfectPointMask()); }

bool recob::TrajectoryPointFlags::isPointValid ( ) const

inline

Returns whether the associated point is valid.

Definition at line 525 of file TrajectoryPointFlags.h.

{ return !isSet(flag::NoPoint); }

bool recob::TrajectoryPointFlags::isSet ( Flag_t  flag ) const

inline

Returns true if the flag exists and is set.

Parameters

flag	the flag index

Returns

true if the flag exists and is set

See also

isUnset()

Definition at line 455 of file TrajectoryPointFlags.h.

Referenced by recob::TrackTrajectory::HasValidPoint().

{ return flags().isSet(flag); }

bool recob::TrajectoryPointFlags::isShared ( ) const

inline

Returns whether the point has the Shared flag set.

Definition at line 531 of file TrajectoryPointFlags.h.

{ return isSet(flag::Shared); }

bool recob::TrajectoryPointFlags::isUnset ( Flag_t  flag ) const

inline

Returns true if the flag exists and is not set.

Parameters

flag	the flag index

Returns

true if the flag exists and is not set

See also

isSet()

Definition at line 463 of file TrajectoryPointFlags.h.

{ return flags().isUnset(flag); }

template<typename... Flags>

static constexpr Mask_t recob::TrajectoryPointFlags::makeMask ( Flags...  flags )

static

Returns a bit mask with only the specified bit set.

Template Parameters

Flags

the type of flags to be set

Parameters

flags

all the flags to set

This method can be used in constexpr flag definitions:

using trkflag = recob::TrajectoryPointFlags::flag;
constexpr auto mask = recob::TrajectoryPointFlags::makeMask
  (trkflag::NoPoint, trkflag::Merged);

Referenced by pma::convertFrom(), and trkf::KGTrack::fillTrack().

template<typename... Flags>

constexpr recob::TrajectoryPointFlags::Mask_t recob::TrajectoryPointFlags::makeMask ( Flags...  flags )

inline

Definition at line 685 of file TrajectoryPointFlags.h.

{
  return Mask_t(flags...);
}

constexpr Mask_t const& recob::TrajectoryPointFlags::mask ( ) const

inline

Returns the entire set of bits as a bit mask.

Definition at line 482 of file TrajectoryPointFlags.h.

Referenced by trkmkr::KalmanFilterFitTrackMaker::restoreInputPoints().

{ return flags().mask(); }

bool recob::TrajectoryPointFlags::match ( Mask_t  mask ) const

inline

Returns true if the specified mask is matched.

Parameters

mask	the mask of flags to be tested

Returns

true if the specified mask is matched

See also

util::flags::BitMask::match()

The current flags are tested against the specified mask. The flags that in mask are undefined are not tested at all. For this method to return true, all the remaining flags (that is, all the flags defined in mask) must be defined, and their value must match the one in mask.

Definition at line 477 of file TrajectoryPointFlags.h.

{ return flags().match(mask); }

constexpr FlagIndex_t recob::TrajectoryPointFlags::nFlags ( ) const

inline

Returns the number of defined flags.

Definition at line 399 of file TrajectoryPointFlags.h.

{ return flag::maxFlags(); }

bool recob::TrajectoryPointFlags::noneSet ( Mask_t  mask ) const

inline

Returns whether none of the bits set in the mask is set.

Parameters

mask	mask with the bits to be checked defined and set (isSet())

Returns

whether none of the bits set in the mask is set

See also

anySet()

This is the logical negation of anySet().

Definition at line 514 of file TrajectoryPointFlags.h.

{ return flags().noneSet(mask); }

constexpr bool recob::TrajectoryPointFlags::operator!= ( TrajectoryPointFlags const &  other ) const

inline

Returns whether other has content different than this one.

Definition at line 703 of file TrajectoryPointFlags.h.

{
  return !sameAs(other);
}

constexpr bool recob::TrajectoryPointFlags::operator== ( TrajectoryPointFlags const &  other ) const

inline

Returns whether other has the same content as this one.

Definition at line 697 of file TrajectoryPointFlags.h.

{
  return sameAs(other);
}

constexpr bool recob::TrajectoryPointFlags::sameAs ( TrajectoryPointFlags const &  other ) const

inlineprivate

Implementation detail of operator==()

Definition at line 692 of file TrajectoryPointFlags.h.

References flags(), and fromHit().

{
  return (flags() == other.flags()) && (fromHit() == other.fromHit());
}

constexpr recob::TrajectoryPointFlags::Mask_t recob::TrajectoryPointFlags::SomehowSharedMask ( )

inlinestaticprivate

Flags to define a hit that is in some way shared.

Definition at line 718 of file TrajectoryPointFlags.h.

{
  return flag::Merged + flag::DeltaRay + flag::Shared;
}

bool recob::TrajectoryPointFlags::test ( FlagIndex_t  index ) const

inline

Returns whether the specified flag is set.

Parameters

index

index of the flag to be tested

Returns

whether the specified flag is set

Exceptions

Flags_t::OutOfRangeError	if the flag is not known (invalid index)
Flags_t::FlagNotDefinedError	if the flag is not defined

A single flag is tested.

Definition at line 418 of file TrajectoryPointFlags.h.

{ return flags().test(index); }

bool recob::TrajectoryPointFlags::test ( Flag_t  flag ) const

inline

Returns whether the specified flag is set.

Parameters

flag	flag to be tested

Returns

whether the specified flag is set

Exceptions

Flags_t::OutOfRangeError	if the flag is not known (invalid index)
Flags_t::FlagNotDefinedError	if the flag is not defined

A single flag is tested.

Definition at line 429 of file TrajectoryPointFlags.h.

{ return flags().test(flag); }

Member Data Documentation

Flags_t recob::TrajectoryPointFlags::fFlags {DefaultFlagsMask()}

private

Set of flags.

Definition at line 672 of file TrajectoryPointFlags.h.

HitIndex_t recob::TrajectoryPointFlags::fFromHit = InvalidHitIndex

private

Index of the original hit.

Definition at line 658 of file TrajectoryPointFlags.h.

constexpr HitIndex_t recob::TrajectoryPointFlags::InvalidHitIndex = std::numeric_limits<HitIndex_t>::max()

static

Value marking an invalid hit index.

Definition at line 321 of file TrajectoryPointFlags.h.

Referenced by lar_pandora::LArPandoraTrackCreation::BuildTrack(), ShowerRecoTools::ShowerTrackDirection::CalculateElement(), and ShowerRecoTools::ShowerPandoraSlidingFitTrackFinder::CalculateElement().

---

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

• lardataobj/v09_18_03/source/lardataobj/RecoBase/TrajectoryPointFlags.h