Update README.md
Browse files
README.md
CHANGED
@@ -75,16 +75,6 @@ To facilitate downloading, the HTTP links for all data files are provided in [`f
|
|
75 |
1. The dataset's extensive phase space coverage and high statistics enable model developers to focus on specific regions of interest, or work with the entire dataset, enabling the creation of specialized models for particular phase spaces or pre-training a more general model.
|
76 |
1. The dataset contains detailed low-level information to support customized model training strategies, including kinematic features, particle IDs, and trajectory displacement information for both jet constituent particles and relevant generator-level particles (see details in the next section).
|
77 |
|
78 |
-
<!-- ### Direct Use -->
|
79 |
-
|
80 |
-
<!-- This section describes suitable use cases for the dataset. -->
|
81 |
-
|
82 |
-
<!-- ### Out-of-Scope Use -->
|
83 |
-
|
84 |
-
<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
|
85 |
-
|
86 |
-
<!-- [More Information Needed] -->
|
87 |
-
|
88 |
## Dataset Structure
|
89 |
|
90 |
The JetClass-II dataset includes the following variables:
|
@@ -120,7 +110,7 @@ The JetClass-II dataset includes the following variables:
|
|
120 |
| `part_isPhoton` | vector\<bool\> | if the particle is an photon (`pid==22`) | ✔️
|
121 |
| `part_isChargedHadron` | vector\<bool\> | if the particle is a charged hadron (`charge!=0 && !isElectron && !isMuon`) | ✔️
|
122 |
| `part_isNeutralHadron` | vector\<bool\> | if the particle is a neutral hadron (`charge==0 && !isPhoton`) | ✔️
|
123 |
-
| **For
|
124 |
| `jet_pt` | float | jet's transverse momentum \\(p_\mathrm{T}\\) | ✔️
|
125 |
| `jet_eta` | float | jet's pseudorapidity \\(\eta\\) | ✔️
|
126 |
| `jet_phi` | float | jet's azimuthal angle \\(\phi\\) | ✔️
|
@@ -144,7 +134,7 @@ The JetClass-II dataset includes the following variables:
|
|
144 |
| `genpart_z` | vector\<float\> | \\(z\\) coordinate of the particle's production vertex, in mm | 🆕
|
145 |
| `genpart_t` | vector\<float\> | \\(t\\) coordinate of the particle's production vertex, in mm/c | 🆕
|
146 |
| `genpart_pid` | vector\<int32_t\> | particle's PDGID | 🆕
|
147 |
-
| **For GEN-
|
148 |
| `genjet_pt` | float | GEN-jet's transverse momentum \\(p_\mathrm{T}\\) | 🆕
|
149 |
| `genjet_eta` | float | GEN-jet's pseudorapidity \\(\eta\\) | 🆕
|
150 |
| `genjet_phi` | float | GEN-jet's azimuthal angle \\(\phi\\) | 🆕
|
@@ -176,6 +166,7 @@ The Delphes card can be found in the [`jetclass2-generation`](https://github.com
|
|
176 |
|
177 |
The complete generation script (the one-stop MadGraph + Pythia + Delphes production) and the n-tuplizer script are provided in the [`jetclass2-generation`](https://github.com/jet-universe/jetclass2_generation) repository to facilitate reproducibility.
|
178 |
|
|
|
179 |
|
180 |
## Citation
|
181 |
|
@@ -202,12 +193,28 @@ If you use the JetClass-II dataset, please cite:
|
|
202 |
|
203 |
<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
|
204 |
|
205 |
-
|
206 |
|
207 |
-
|
208 |
|
209 |
-
|
|
|
|
|
|
|
|
|
210 |
|
211 |
-
|
212 |
|
213 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
75 |
1. The dataset's extensive phase space coverage and high statistics enable model developers to focus on specific regions of interest, or work with the entire dataset, enabling the creation of specialized models for particular phase spaces or pre-training a more general model.
|
76 |
1. The dataset contains detailed low-level information to support customized model training strategies, including kinematic features, particle IDs, and trajectory displacement information for both jet constituent particles and relevant generator-level particles (see details in the next section).
|
77 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
78 |
## Dataset Structure
|
79 |
|
80 |
The JetClass-II dataset includes the following variables:
|
|
|
110 |
| `part_isPhoton` | vector\<bool\> | if the particle is an photon (`pid==22`) | ✔️
|
111 |
| `part_isChargedHadron` | vector\<bool\> | if the particle is a charged hadron (`charge!=0 && !isElectron && !isMuon`) | ✔️
|
112 |
| `part_isNeutralHadron` | vector\<bool\> | if the particle is a neutral hadron (`charge==0 && !isPhoton`) | ✔️
|
113 |
+
| **For jets** | | | |
|
114 |
| `jet_pt` | float | jet's transverse momentum \\(p_\mathrm{T}\\) | ✔️
|
115 |
| `jet_eta` | float | jet's pseudorapidity \\(\eta\\) | ✔️
|
116 |
| `jet_phi` | float | jet's azimuthal angle \\(\phi\\) | ✔️
|
|
|
134 |
| `genpart_z` | vector\<float\> | \\(z\\) coordinate of the particle's production vertex, in mm | 🆕
|
135 |
| `genpart_t` | vector\<float\> | \\(t\\) coordinate of the particle's production vertex, in mm/c | 🆕
|
136 |
| `genpart_pid` | vector\<int32_t\> | particle's PDGID | 🆕
|
137 |
+
| **For GEN-jets** (if matched to a jet) | | | |
|
138 |
| `genjet_pt` | float | GEN-jet's transverse momentum \\(p_\mathrm{T}\\) | 🆕
|
139 |
| `genjet_eta` | float | GEN-jet's pseudorapidity \\(\eta\\) | 🆕
|
140 |
| `genjet_phi` | float | GEN-jet's azimuthal angle \\(\phi\\) | 🆕
|
|
|
166 |
|
167 |
The complete generation script (the one-stop MadGraph + Pythia + Delphes production) and the n-tuplizer script are provided in the [`jetclass2-generation`](https://github.com/jet-universe/jetclass2_generation) repository to facilitate reproducibility.
|
168 |
|
169 |
+
Truth particles are selected using [Insert criteria]. GEN-jets are clustered truth particles matched to jets using [Insert criteria].
|
170 |
|
171 |
## Citation
|
172 |
|
|
|
193 |
|
194 |
<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
|
195 |
|
196 |
+
A good resource is the CERN Open Data Portal Glossary: https://opendata.cern.ch/search?q=&f=type%3AGlossary&l=list&order=asc&p=1&s=10&sort=title
|
197 |
|
198 |
+
**Jet**: A jet is a shower of hadrons, which originate from a quark or a gluon, clustered together after being produced in particle collisions.
|
199 |
|
200 |
+
**Constituent particle**:
|
201 |
+
|
202 |
+
**GEN-Jet**:
|
203 |
+
|
204 |
+
**Truth particle**:
|
205 |
|
206 |
+
**Pseudorapidity \\(\eta\\)**: The pseudorapidity \\(\eta\\) is a coordinate that describes the angle of a particle (or jet) produced in an event relative to the beam axis. It is calculated as \\(\eta = - \ln \left ( \tan \frac{\theta}{2} \right )\\), with \\(\theta\\) the angle between the three-momentum and the beam axis. \\(\eta=0\\) means the produced particle/jet is perpendicular to the beam axis, while a higher pseudorapidity means it is closer to the beam.
|
207 |
|
208 |
+
**Transverse momentum \\(\p_\mathrm{T}\\)**:
|
209 |
+
|
210 |
+
**Pseudoangular distance \\(\Delta R\\)**:
|
211 |
+
|
212 |
+
**Impact parameter**:
|
213 |
+
|
214 |
+
**PDG particle ID**:
|
215 |
+
|
216 |
+
[More Information Needed]
|
217 |
+
|
218 |
+
## Dataset Card Authors and Contacts
|
219 |
+
|
220 |
+
@jmgduarte, @colizz
|