Skip to content

Commit 9125dfc

Browse files
aphecetcheshahor02
authored andcommitted
📝 [MCH] Small improvement in documentation
1 parent d1f5475 commit 9125dfc

File tree

1 file changed

+13
-3
lines changed
  • Detectors/MUON/MCH/Geometry/Transformer

1 file changed

+13
-3
lines changed

Detectors/MUON/MCH/Geometry/Transformer/README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Here you will find functions to perform transformations on MCH geometry : local
88
to global, global to local, and various (mis)alignement ones.
99

10-
# MCH Transformations in JSON format
10+
## MCH Transformations in JSON format
1111

1212
Also available is a CLI utility to extract MCH transformations (rotations and
1313
translations) from a Root geometry file and export them in JSON format :
@@ -16,11 +16,21 @@ translations) from a Root geometry file and export them in JSON format :
1616
o2-mch-convert-geometry --geom o2sim_geometry.root > geom.json
1717
```
1818

19-
The JSON output can be manipulated (like any other json file) with e.g. [jq](https://stedolan.github.io/jq/)
19+
The JSON output is compact on purpose, to save some space (e.g. on github).
2020

21-
For instance, to sort the output per detection element id :
21+
But as any JSON it can be manipulated further with e.g. [jq](https://stedolan.github.io/jq/)
22+
23+
For instance you can pretty-print it :
24+
25+
```shell
26+
cat output.json | jq .
27+
```
28+
29+
Or sort the output per detection element id :
2230

2331
```shell
2432
cat output.json | jq '.alignables|=sort_by(.deid)'
2533
```
2634

35+
That last command being the one that was used to produce the example [ideal-geometry-o2.json](../Test/ideal-geometry-o2.json) file.
36+

0 commit comments

Comments
 (0)