Skip to content

Commit e9942be

Browse files
authored
Merge pull request #2 from alibuild/alibot-cleanup-ml-331
[MegaLinter] Apply linters automatic fixes to #331
2 parents 174eb7c + fd3908f commit e9942be

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

docs/analysis-tools/PID.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,30 +53,28 @@ The ITS PID columns are only dynamical and do not need a task to produce them, h
5353
Tables for PID values in O2 are defined in the following header files:
5454

5555
| Detector | Header File | Usage | Description |
56-
| -------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ------------------- |
56+
|----------|---------------------------------------------------------------------------------------------------------------|------------------------------------------------|---------------------|
5757
| ITS | [`PIDResponseITS.h`](https://github.com/AliceO2Group/O2Physics/blob/master/Common/DataModel/PIDResponseITS.h) | `#include "Common/DataModel/PIDResponseITS.h"` | ITS PID information |
5858
| TPC | [`PIDResponseTPC.h`](https://github.com/AliceO2Group/O2Physics/blob/master/Common/DataModel/PIDResponseTPC.h) | `#include "Common/DataModel/PIDResponseTPC.h"` | TPC PID information |
5959
| TOF | [`PIDResponseTOF.h`](https://github.com/AliceO2Group/O2Physics/blob/master/Common/DataModel/PIDResponseTOF.h) | `#include "Common/DataModel/PIDResponseTOF.h"` | TOF PID information |
6060

61-
6261
## Available PID Information
6362

6463
The following table shows the available PID methods for each detector and particle species:
6564

6665
| Information Type | Description | TOF Methods | TPC Methods | ITS Methods |
67-
| ----------------------- | ---------------------------------------- | ---------------------- | ---------------------- | -------------------------- |
66+
|-------------------------|------------------------------------------|------------------------|------------------------|----------------------------|
6867
| **nSigma** | Nsigma separation value | `tofNSigmaXX()` | `tpcNSigmaXX()` | `itsNSigmaXX()` |
6968
| **Expected Signal** | Expected detector signal | `tofExpSignalXX()` | `tpcExpSignalXX()` | `expSignal<PID::XX>()` |
7069
| **Expected Resolution** | Expected detector resolution | `tofExpSigmaXX()` | `tpcExpSigmaXX()` | `expResolution<PID::XX>()` |
7170
| **Signal Difference** | Difference between measured and expected | `tofExpSignalDiffXX()` | `tpcExpSignalDiffXX()` | - |
7271

73-
7472
## Supported Particle Species
7573

7674
The following nine (9) stable particle species are supported for PID calculations:
7775

7876
| Symbol | Particle | Mass Hypothesis |
79-
| ------ | -------- | --------------- |
77+
|--------|----------|-----------------|
8078
| `El` | Electron | e⁻ |
8179
| `Mu` | Muon | μ⁻ |
8280
| `Pi` | Pion | π± |
@@ -92,7 +90,7 @@ The following nine (9) stable particle species are supported for PID calculation
9290
The TOF detector provides additional specialized information beyond the standard PID methods:
9391

9492
| Information Type | Description | TOF Methods | Notes |
95-
| -------------------- | -------------------------------------- | --------------------- | ----------------------------------------- |
93+
|----------------------|----------------------------------------|-----------------------|-------------------------------------------|
9694
| **Beta** | Velocity as fraction of speed of light | `beta()`, `tofBeta()` | β = v/c, fundamental for mass calculation |
9795
| **Beta Error** | Uncertainty on beta measurement | `betaerror()` | Statistical uncertainty on β |
9896
| **TOF Mass** | Reconstructed particle mass | `mass()`, `tofMass()` | Calculated from momentum and β |
@@ -209,6 +207,7 @@ Complete workflow including QA:
209207
```
210208

211209
**Components:**
210+
212211
- [`o2-analysis-pid-tof-merge`](https://github.com/AliceO2Group/O2Physics/tree/master/Common/TableProducer/PID/pidTOFMerge.cxx): Main TOF PID task
213212
- `o2-analysis-pid-tof-qa`: Optional QA histograms
214213

@@ -221,11 +220,11 @@ Complete workflow including QA:
221220
```
222221

223222
**Components:**
223+
224224
- [`o2-analysis-pid-tpc`](https://github.com/AliceO2Group/O2Physics/tree/master/Common/TableProducer/PID/pidTPC.cxx): Main TPC PID task
225225
- `o2-analysis-pid-tpc-base`: Base TPC PID processing
226226
- `o2-analysis-pid-tpc-qa`: Optional QA histograms
227227

228-
229228
### ITS PID Workflow
230229

231230
Complete workflow including QA:
@@ -235,10 +234,10 @@ Complete workflow including QA:
235234
```
236235

237236
**Components:**
237+
238238
- [`o2-analysis-pid-its`](https://github.com/AliceO2Group/O2Physics/tree/master/Common/TableProducer/PID/pidITS.cxx): Main ITS PID task (needed only to set the ITS PID Response parameters)
239239
- `o2-analysis-pid-its-qa`: Optional QA histograms
240240

241-
242241
**Note:** The `...` represents other tasks in your analysis workflow.
243242

244243
## Enabling QA histograms
@@ -248,18 +247,21 @@ QA histograms are essential for monitoring PID performance and can be enabled by
248247
### Enabling QA Tasks
249248

250249
**TOF QA histograms:**
250+
251251
```bash
252252
... | o2-analysis-pid-tof-qa | ...
253253
```
254254

255255
**TPC QA histograms:**
256+
256257
```bash
257258
... | o2-analysis-pid-tpc-qa | ...
258259
```
259260

260261
### QA Output
261262

262263
The QA tasks provide:
264+
263265
- nSigma distributions for each particle species
264266
- Detector response monitoring
265267
- Calibration validation plots
@@ -271,7 +273,7 @@ The QA tasks provide:
271273

272274
Beyond the basic PID functionality, the O2 Analysis Framework provides several advanced features for sophisticated particle identification workflows. These features are designed for users who need more control over PID calculations, better performance optimization, or specialized analysis requirements.
273275

274-
### Key Advanced Features:
276+
### Key Advanced Features
275277

276278
1. **Dynamic Columns**: Compute PID quantities on-the-fly without storing pre-calculated tables
277279
2. **Custom Parameterizations**: Use detector-specific response parameterizations from CCDB
@@ -280,6 +282,7 @@ Beyond the basic PID functionality, the O2 Analysis Framework provides several a
280282
5. **Binned Storage**: Use compressed storage formats for large-scale analyses
281283

282284
These advanced features are particularly useful for:
285+
283286
- **High-precision analyses** requiring detector-specific tuning
284287
- **Large-scale productions** where storage optimization is critical
285288
- **Development workflows** where PID parameters need frequent updates
@@ -290,7 +293,7 @@ These advanced features are particularly useful for:
290293
TOF beta and mass can be calculated dynamically using the following columns:
291294

292295
| Dynamic Column | Method | Description | Dependencies |
293-
| -------------- | ----------- | ------------------------------ | --------------------------------------- |
296+
|----------------|-------------|--------------------------------|-----------------------------------------|
294297
| **TOF Beta** | `tofBeta()` | Dynamically calculated β value | Length, TOFSignal, TOFEvTime |
295298
| **TOF Mass** | `tofMass()` | Dynamically calculated mass | Length, TOFSignal, TOFEvTime, TOFExpMom |
296299

@@ -299,14 +302,15 @@ TOF beta and mass can be calculated dynamically using the following columns:
299302
For advanced use cases, nSigma values can be computed dynamically for all detectors:
300303

301304
| Detector | Dynamic Column | Method | Description | Requirements |
302-
| -------- | ---------------- | ------------------ | ----------------------------- | ----------------------------------- |
305+
|----------|------------------|--------------------|-------------------------------|-------------------------------------|
303306
| **TOF** | `TOFNSigmaDynXX` | `tofNSigmaDynXX()` | On-the-fly nSigma calculation | TOF response service initialization |
304307
| **TPC** | `TPCNSigmaDynXX` | `tpcNSigmaDynXX()` | On-the-fly nSigma calculation | Standard table approach |
305308
| **ITS** | `ITSNSigmaXX` | `itsNSigmaXX()` | On-the-fly nSigma calculation | Parameter initialization |
306309

307310
Where `XX` represents the particle species (`El`, `Mu`, `Pi`, `Ka`, `Pr`, `De`, `Tr`, `He`, `Al`).
308311

309312
**Dynamic nSigma advantages:**
313+
310314
- Use the most current detector calibrations
311315
- Avoid pre-computed table storage requirements
312316
- Allow for real-time parameter adjustments
@@ -317,6 +321,7 @@ Where `XX` represents the particle species (`El`, `Mu`, `Pi`, `Ka`, `Pr`, `De`,
317321
### Example Usage
318322

319323
**Basic dynamic columns:**
324+
320325
```c++
321326
// TOF Beta calculation
322327
using TOFBeta = o2::aod::TOFBeta;
@@ -332,6 +337,7 @@ void process(soa::Join<aod::Tracks, TOFMass>::iterator const& track) {
332337
```
333338
334339
**Advanced dynamic nSigma with TOF response service:**
340+
335341
```c++
336342
#include "Common/Core/PID/PIDTOFParamService.h"
337343

0 commit comments

Comments
 (0)