CMS 3D CMS Logo

Public Member Functions | Private Attributes | Friends

FSimDisplacedVertex Class Reference

A FSimDisplacedVertex extends the FSimVertex with VertexType information. More...

#include <FSimDisplacedVertex.h>

List of all members.

Public Member Functions

const std::vector< int > & daughterIds () const
 FSimDisplacedVertex ()
 FSimDisplacedVertex (const SimVertex &vertex, unsigned id, int motherId, unsigned nCharged, const std::vector< int > &daughterIds, const FSimVertexType::VertexType vertexType)
 FSimDisplacedVertex (const FSimDisplacedVertex &other)
int id () const
const bool isRecoVertex () const
int motherId () const
unsigned int nChargedDaughters () const
unsigned int nDaughters () const
const int recoVertexId () const
void removeRecoVertex ()
 Remove the associated reconstructed DispacedVertex.
void setRecoVertex (int recoVertexId)
 Set the associated reconstructed DispacedVertex.
const SimVertex vertex () const
const FSimVertexType::VertexType vertexType () const
virtual ~FSimDisplacedVertex ()

Private Attributes

std::vector< int > daughterIds_
 Vector of daughter ids in the track collection.
int id_
bool isRecoVertex_
 Flag to indicate if a reconstructed DisplacedVertex was found and associated.
int motherId_
 id of mother particle. -1 if no mother
unsigned int nCharged_
 Number of charged daughters.
int recoVertexId_
SimVertex vertex_
 Sim Vertex.
FSimVertexType::VertexType vertexType_
 Vertex Type.

Friends

std::ostream & operator<< (std::ostream &out, const FSimDisplacedVertex &co)

Detailed Description

A FSimDisplacedVertex extends the FSimVertex with VertexType information.

Format FSimDisplacedVertex

This data format is designed to combine the informations from FSimVertex and its FSimVertexType. It is not part of general FAMOS sequence and useful for private productions and analyses. The format contains also an integer identifier which may be optionally used to associate it to reconstruced nuclear Interaction: boolean isRecoVertex and int recoVertexId;

Author:
Maxime Gouzevitch
Date:
November 2009

Definition at line 28 of file FSimDisplacedVertex.h.


Constructor & Destructor Documentation

FSimDisplacedVertex::FSimDisplacedVertex ( )

Definition at line 5 of file FSimDisplacedVertex.cc.

FSimDisplacedVertex::FSimDisplacedVertex ( const SimVertex vertex,
unsigned  id,
int  motherId,
unsigned  nCharged,
const std::vector< int > &  daughterIds,
const FSimVertexType::VertexType  vertexType 
)
FSimDisplacedVertex::FSimDisplacedVertex ( const FSimDisplacedVertex other)

Definition at line 32 of file FSimDisplacedVertex.cc.

virtual FSimDisplacedVertex::~FSimDisplacedVertex ( ) [inline, virtual]

Definition at line 44 of file FSimDisplacedVertex.h.

{}

Member Function Documentation

const std::vector<int>& FSimDisplacedVertex::daughterIds ( ) const [inline]
Returns:
vector of daughter ids

Definition at line 62 of file FSimDisplacedVertex.h.

References daughterIds_.

{return daughterIds_;}
int FSimDisplacedVertex::id ( void  ) const [inline]
Returns:
the id of the vertex in the collection

Definition at line 50 of file FSimDisplacedVertex.h.

References id_.

Referenced by operator<<().

{ return id_; }
const bool FSimDisplacedVertex::isRecoVertex ( ) const [inline]
Returns:
indicated if there is a Displaced Vertex associated

Definition at line 68 of file FSimDisplacedVertex.h.

References isRecoVertex_.

{return isRecoVertex_;}
int FSimDisplacedVertex::motherId ( ) const [inline]
Returns:
mother id in the track collection

Definition at line 53 of file FSimDisplacedVertex.h.

References motherId_.

Referenced by operator<<().

{ return motherId_; }
unsigned int FSimDisplacedVertex::nChargedDaughters ( ) const [inline]
Returns:
the number of charged daughters

Definition at line 59 of file FSimDisplacedVertex.h.

References nCharged_.

Referenced by operator<<().

{ return nCharged_;}
unsigned int FSimDisplacedVertex::nDaughters ( ) const [inline]
Returns:
the number of daughters

Definition at line 56 of file FSimDisplacedVertex.h.

References daughterIds_.

Referenced by operator<<().

{ return daughterIds_.size();}
const int FSimDisplacedVertex::recoVertexId ( ) const [inline]
Returns:
the reconstructed Displaced Vertex index

Definition at line 71 of file FSimDisplacedVertex.h.

References recoVertexId_.

Referenced by operator<<(), and setRecoVertex().

{return recoVertexId_;}
void FSimDisplacedVertex::removeRecoVertex ( ) [inline]

Remove the associated reconstructed DispacedVertex.

Definition at line 80 of file FSimDisplacedVertex.h.

References isRecoVertex_, and recoVertexId_.

                          {
    isRecoVertex_ = false;
    recoVertexId_ = -1;
  }
void FSimDisplacedVertex::setRecoVertex ( int  recoVertexId) [inline]

Set the associated reconstructed DispacedVertex.

Definition at line 74 of file FSimDisplacedVertex.h.

References isRecoVertex_, recoVertexId(), and recoVertexId_.

const SimVertex FSimDisplacedVertex::vertex ( ) const [inline]
Returns:
the SimVertex

Definition at line 47 of file FSimDisplacedVertex.h.

References vertex_.

Referenced by operator<<().

{ return vertex_; }
const FSimVertexType::VertexType FSimDisplacedVertex::vertexType ( ) const [inline]
Returns:
the vertex type

Definition at line 65 of file FSimDisplacedVertex.h.

References vertexType_.

Referenced by operator<<().

{ return vertexType_;}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const FSimDisplacedVertex co 
) [friend]

Definition at line 44 of file FSimDisplacedVertex.cc.

                                                         {  
  
  return out << "id = " <<  co.id() 
             << " mother = " <<  co.motherId() 
             << " N daugh. = " << co.nDaughters()
             << " N charged " << co.nChargedDaughters()
             << " Type = " << co.vertexType()
             << " recoVertexId = " << co.recoVertexId() << " "
             << co.vertex();

}

Member Data Documentation

std::vector<int> FSimDisplacedVertex::daughterIds_ [private]

Vector of daughter ids in the track collection.

Definition at line 103 of file FSimDisplacedVertex.h.

Referenced by daughterIds(), and nDaughters().

int FSimDisplacedVertex::id_ [private]
Returns:
the id in the vertex in the collection. -1 if the default value

Definition at line 94 of file FSimDisplacedVertex.h.

Referenced by id().

Flag to indicate if a reconstructed DisplacedVertex was found and associated.

Definition at line 109 of file FSimDisplacedVertex.h.

Referenced by isRecoVertex(), removeRecoVertex(), and setRecoVertex().

id of mother particle. -1 if no mother

Definition at line 97 of file FSimDisplacedVertex.h.

Referenced by motherId().

unsigned int FSimDisplacedVertex::nCharged_ [private]

Number of charged daughters.

Definition at line 100 of file FSimDisplacedVertex.h.

Referenced by nChargedDaughters().

The index of the reconstructed DisplacedVertex associated. By default the value is -1. The association may be done in the dedicated algorithm of the producer.

Definition at line 114 of file FSimDisplacedVertex.h.

Referenced by recoVertexId(), removeRecoVertex(), and setRecoVertex().

Sim Vertex.

Definition at line 90 of file FSimDisplacedVertex.h.

Referenced by vertex().

Vertex Type.

Definition at line 106 of file FSimDisplacedVertex.h.

Referenced by vertexType().