siscone is hosted by Hepforge, IPPP Durham

The SISCone Jet Algorithm

Version 3.0.6



SISCone 3.0.6

list of element in the vicinity of a parent. More...

#include <vicinity.h>

Inheritance diagram for siscone::Cvicinity:
Collaboration diagram for siscone::Cvicinity:

Public Member Functions

 Cvicinity ()
 default constructor More...
 
 Cvicinity (std::vector< Cmomentum > &_particle_list)
 constructor with initialisation (see set_particle_list)
 
 ~Cvicinity ()
 default destructor More...
 
void set_particle_list (std::vector< Cmomentum > &_particle_list)
 set the particle_list More...
 
void build (Cmomentum *_parent, double _VR)
 build the vicinity list from the list of points. More...
 

Public Attributes

Cmomentumparent
 parent vector More...
 
double VR
 radius of the vicinity More...
 
double VR2
 squared radius of the vicinity More...
 
double R
 normal radius More...
 
double R2
 squared normal radius More...
 
double inv_R_EPS_COCIRC
 R / EPSILON_COCIRCULAR. More...
 
double inv_R_2EPS_COCIRC
 R / (2*EPSILON_COCIRCULAR) More...
 
int n_part
 number of particles More...
 
std::vector< Cmomentumplist
 the list of particles More...
 
std::vector< Cvicinity_inclusionpincluded
 the inclusion state of particles More...
 
Cvicinity_elmve_list
 list of vicinity elements built from particle list (size=2*n) More...
 
std::vector< Cvicinity_elm * > vicinity
 list of points in parent's vicinity More...
 
unsigned int vicinity_size
 number of elements in vicinity More...
 

Protected Member Functions

void append_to_vicinity (Cmomentum *v)
 append a particle to the 'vicinity' list after having tested it and computed the angular-ordering quantities More...
 

Protected Attributes

double pcx
 parent centre (eta) More...
 
double pcy
 parent centre (phi) More...
 

Detailed Description

list of element in the vicinity of a parent.

class used to manage the points which are in the vicinity of a parent point.

Definition at line 95 of file vicinity.h.

Constructor & Destructor Documentation

◆ Cvicinity()

siscone::Cvicinity::Cvicinity ( )

default constructor

Definition at line 60 of file vicinity.cpp.

References n_part, parent, ve_list, VR, and VR2.

◆ ~Cvicinity()

siscone::Cvicinity::~Cvicinity ( )

default destructor

Definition at line 88 of file vicinity.cpp.

References ve_list.

Member Function Documentation

◆ append_to_vicinity()

void siscone::Cvicinity::append_to_vicinity ( Cmomentum v)
protected

append a particle to the 'vicinity' list after having tested it and computed the angular-ordering quantities

Parameters
vvector to test

Definition at line 220 of file vicinity.cpp.

References siscone::Cvicinity_elm::angle, siscone::Cvicinity_elm::cocircular, siscone::Cvicinity_elm::cocircular_range, siscone::Cmomentum::eta, siscone::Cvicinity_elm::eta, siscone::Cmomentum::index, inv_R_2EPS_COCIRC, inv_R_EPS_COCIRC, parent, pcx, pcy, siscone::Cmomentum::phi, siscone::Cvicinity_elm::phi, R2, siscone::Cvicinity_elm::side, twopi, ve_list, vicinity, and VR2.

Referenced by build().

◆ build()

void siscone::Cvicinity::build ( Cmomentum _parent,
double  _VR 
)

build the vicinity list from the list of points.

Parameters
_parentreference particle
_VRvicinity radius

Definition at line 176 of file vicinity.cpp.

References append_to_vicinity(), EPSILON_COCIRCULAR, siscone::Cmomentum::eta, inv_R_2EPS_COCIRC, inv_R_EPS_COCIRC, n_part, parent, pcx, pcy, siscone::Cmomentum::phi, plist, R, R2, vicinity, vicinity_size, VR, and VR2.

Referenced by siscone::Cstable_cones::get_stable_cones().

◆ set_particle_list()

void siscone::Cvicinity::set_particle_list ( std::vector< Cmomentum > &  _particle_list)

set the particle_list

Parameters
_particle_listlist of particles (type Cmomentum)

Definition at line 103 of file vicinity.cpp.

References siscone::Cvicinity_elm::is_inside, n_part, pincluded, plist, siscone::Cvicinity_elm::v, ve_list, and vicinity.

Referenced by siscone::Cstable_cones::init().

Member Data Documentation

◆ inv_R_2EPS_COCIRC

double siscone::Cvicinity::inv_R_2EPS_COCIRC

R / (2*EPSILON_COCIRCULAR)

Definition at line 126 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ inv_R_EPS_COCIRC

double siscone::Cvicinity::inv_R_EPS_COCIRC

R / EPSILON_COCIRCULAR.

Definition at line 125 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ n_part

int siscone::Cvicinity::n_part

number of particles

Definition at line 129 of file vicinity.h.

Referenced by build(), Cvicinity(), siscone::Cstable_cones::get_stable_cones(), and set_particle_list().

◆ parent

Cmomentum* siscone::Cvicinity::parent

parent vector

Definition at line 120 of file vicinity.h.

Referenced by append_to_vicinity(), build(), Cvicinity(), and siscone::Cstable_cones::get_stable_cones().

◆ pcx

double siscone::Cvicinity::pcx
protected

parent centre (eta)

Definition at line 150 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ pcy

double siscone::Cvicinity::pcy
protected

parent centre (phi)

Definition at line 151 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ pincluded

std::vector<Cvicinity_inclusion> siscone::Cvicinity::pincluded

the inclusion state of particles

Definition at line 131 of file vicinity.h.

Referenced by set_particle_list().

◆ plist

std::vector<Cmomentum> siscone::Cvicinity::plist

the list of particles

Definition at line 130 of file vicinity.h.

Referenced by build(), siscone::Cstable_cones::get_stable_cones(), and set_particle_list().

◆ R

double siscone::Cvicinity::R

normal radius

Definition at line 123 of file vicinity.h.

Referenced by build().

◆ R2

double siscone::Cvicinity::R2

squared normal radius

Definition at line 124 of file vicinity.h.

Referenced by append_to_vicinity(), and build().

◆ ve_list

Cvicinity_elm* siscone::Cvicinity::ve_list

list of vicinity elements built from particle list (size=2*n)

Definition at line 132 of file vicinity.h.

Referenced by append_to_vicinity(), Cvicinity(), set_particle_list(), and ~Cvicinity().

◆ vicinity

std::vector<Cvicinity_elm*> siscone::Cvicinity::vicinity

list of points in parent's vicinity

Definition at line 138 of file vicinity.h.

Referenced by append_to_vicinity(), build(), and set_particle_list().

◆ vicinity_size

unsigned int siscone::Cvicinity::vicinity_size

number of elements in vicinity

Definition at line 139 of file vicinity.h.

Referenced by build(), and siscone::Cstable_cones::get_stable_cones().

◆ VR

double siscone::Cvicinity::VR

radius of the vicinity

Definition at line 121 of file vicinity.h.

Referenced by build(), and Cvicinity().

◆ VR2

double siscone::Cvicinity::VR2

squared radius of the vicinity

Definition at line 122 of file vicinity.h.

Referenced by append_to_vicinity(), build(), and Cvicinity().


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

The SISCone project has been developed by Gavin Salam and Gregory Soyez
Documentation generated on Tue Jun 20 2023 18:08:37 for SISCone by  Doxygen 1.9.4