Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

treewide: use podio:output_collections instead of deprecated podio:output_include_collections #1578

Merged
merged 1 commit into from
Aug 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/linux-eic-shell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ jobs:
export DETECTOR_CONFIG=${DETECTOR}_${{ matrix.detector_config }}
export LD_LIBRARY_PATH=$PWD/install/lib:$LD_LIBRARY_PATH
export JANA_PLUGIN_PATH=$PWD/install/lib/EICrecon/plugins${JANA_PLUGIN_PATH:+:${JANA_PLUGIN_PATH}}
$PWD/install/bin/eicrecon $JANA_OPTIONS -Ppodio:output_include_collections=EventHeader,MCParticles,EcalBarrelScFiRawHits,EcalBarrelImagingRawHits -Ppodio:output_file=two_stage_raw_${{ matrix.particle }}_1GeV_20GeV_${{ matrix.detector_config }}.edm4eic.root sim_${{ matrix.particle }}_1GeV_20GeV_${{ matrix.detector_config }}.edm4hep.root -Pplugins=dump_flags,janadot -Pdump_flags:json=${{ matrix.particle }}_${{ matrix.detector_config }}_flags.json
$PWD/install/bin/eicrecon $JANA_OPTIONS -Ppodio:output_collections=EventHeader,MCParticles,EcalBarrelScFiRawHits,EcalBarrelImagingRawHits -Ppodio:output_file=two_stage_raw_${{ matrix.particle }}_1GeV_20GeV_${{ matrix.detector_config }}.edm4eic.root sim_${{ matrix.particle }}_1GeV_20GeV_${{ matrix.detector_config }}.edm4hep.root -Pplugins=dump_flags,janadot -Pdump_flags:json=${{ matrix.particle }}_${{ matrix.detector_config }}_flags.json
- name: Upload digitization output
uses: actions/upload-artifact@v4
with:
Expand All @@ -512,7 +512,7 @@ jobs:
export DETECTOR_CONFIG=${DETECTOR}_${{ matrix.detector_config }}
export LD_LIBRARY_PATH=$PWD/install/lib:$LD_LIBRARY_PATH
export JANA_PLUGIN_PATH=$PWD/install/lib/EICrecon/plugins${JANA_PLUGIN_PATH:+:${JANA_PLUGIN_PATH}}
$PWD/install/bin/eicrecon $JANA_OPTIONS -Ppodio:output_include_collections=EcalBarrelClusters,EcalBarrelClusterAssociations -Ppodio:output_file=two_stage_rec_${{ matrix.particle }}_1GeV_20GeV_${{ matrix.detector_config }}.edm4eic.root two_stage_raw_${{ matrix.particle }}_1GeV_20GeV_${{ matrix.detector_config }}.edm4eic.root -Pplugins=dump_flags,janadot -Pdump_flags:json=${{ matrix.particle }}_${{ matrix.detector_config }}_flags.json
$PWD/install/bin/eicrecon $JANA_OPTIONS -Ppodio:output_collections=EcalBarrelClusters,EcalBarrelClusterAssociations -Ppodio:output_file=two_stage_rec_${{ matrix.particle }}_1GeV_20GeV_${{ matrix.detector_config }}.edm4eic.root two_stage_raw_${{ matrix.particle }}_1GeV_20GeV_${{ matrix.detector_config }}.edm4eic.root -Pplugins=dump_flags,janadot -Pdump_flags:json=${{ matrix.particle }}_${{ matrix.detector_config }}_flags.json
- name: Upload reconstruction output
uses: actions/upload-artifact@v4
with:
Expand Down Expand Up @@ -809,7 +809,7 @@ jobs:
export DETECTOR_CONFIG=${DETECTOR}_${{ matrix.detector_config }}
export LD_LIBRARY_PATH=$PWD/install/lib:$LD_LIBRARY_PATH
export JANA_PLUGIN_PATH=$PWD/install/lib/EICrecon/plugins:/usr/local/plugins
$PWD/install/bin/eicrecon $JANA_OPTIONS -Ppodio:output_file=rec_${{ matrix.particle }}_EcalLumiSpec_${{ matrix.detector_config }}.edm4eic.root sim_${{ matrix.particle }}_EcalLumiSpec_${{ matrix.detector_config }}.edm4hep.root -Ppodio:output_include_collections=EcalLumiSpecRawHits,EcalLumiSpecRecHits,EcalLumiSpecClusters,EcalLumiSpecClusterAssociations -PLUMISPECCAL:EcalLumiSpecIslandProtoClusters:splitCluster=1 -Pplugins=dump_flags,janadot,janatop $(<${{ github.workspace }}/.github/janadot.groups) -Pdump_flags:json=${{ matrix.particle }}_${{ matrix.detector_config }}_flags.json
$PWD/install/bin/eicrecon $JANA_OPTIONS -Ppodio:output_file=rec_${{ matrix.particle }}_EcalLumiSpec_${{ matrix.detector_config }}.edm4eic.root sim_${{ matrix.particle }}_EcalLumiSpec_${{ matrix.detector_config }}.edm4hep.root -Ppodio:output_collections=EcalLumiSpecRawHits,EcalLumiSpecRecHits,EcalLumiSpecClusters,EcalLumiSpecClusterAssociations -PLUMISPECCAL:EcalLumiSpecIslandProtoClusters:splitCluster=1 -Pplugins=dump_flags,janadot,janatop $(<${{ github.workspace }}/.github/janadot.groups) -Pdump_flags:json=${{ matrix.particle }}_${{ matrix.detector_config }}_flags.json
- uses: actions/upload-artifact@v4
with:
name: rec_${{ matrix.particle }}_EcalLumiSpec_${{ matrix.detector_config }}.edm4eic.root
Expand Down
6 changes: 3 additions & 3 deletions docs/howto/visualize_callgraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,20 @@ By default `eicrecon` activates the full reconstruction. This will
result in a very busy callgraph that can be hard to read if you
are only interested in one detector. (See [here](https://eic.github.io/EICrecon/howto/callgraphs/all.png).)
To activate for a specific factory, you can specify the relevant output
collection using the `podio:output_include_collections` parameter.
collection using the `podio:output_collections` parameter.
Here is an example for the *EcalEndcapN*:

~~~bash
eicrecon -Pplugins=janadot \
-Ppodio:output_include_collections=EcalEndcapNMergedClusters \
-Ppodio:output_collections=EcalEndcapNMergedClusters \
sim_file.edm4hep.root
~~~

The above will produce something like the following:
![EcalEndcapNMergedClusters](callgraphs/EcalEndcapNMergedClusters.png)

In the plot, the oval at the top is the JEventProcessor making the
initial request for objects. (This is where the *podio:output_include_collections*
initial request for objects. (This is where the *podio:output_collections*
parameter is used). The rectangles in the middle represent factories (i.e. algorithms).
The green trapezoid at the bottom is the object read from the input file.
This is representative of the flow JANA implements. Namely, the requests for
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial/02-work-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,11 @@ eicrecon 2022-09-26_ncdis10x100_minq2-1_100ev.edm4hep.root

## Generating a podio output file
To write reconstructed values to an output file, you need to tell *eicrecon* what to write.
There are several options available, but the mosrt useful one is *podio:output_include_collections*.
There are several options available, but the mosrt useful one is *podio:output_collections*.
This is a comma separated list of colelctions to write to the output file. For example:

```console
eicrecon -Ppodio:output_include_collections=ReconstructedParticles 2022-09-26_ncdis10x100_minq2-1_100ev.edm4hep.root
eicrecon -Ppodio:output_collections=ReconstructedParticles 2022-09-26_ncdis10x100_minq2-1_100ev.edm4hep.root
```

To see a list of possible collections, run *eicrecon -L* .
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/04-factory.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ extern "C" {
Finally, we go ahead and trigger the factory (remember, factories won't do anything unless activated by a JEventProcessor). You can open the

~~~ bash
eicrecon in.root -Ppodio:output_file=out.root -Ppodio:output_include_collections=EcalEndcapNIslandClusters -Pjana:nevents=10
eicrecon in.root -Ppodio:output_file=out.root -Ppodio:output_collections=EcalEndcapNIslandClusters -Pjana:nevents=10
~~~


Expand Down
4 changes: 2 additions & 2 deletions src/benchmarks/reconstruction/tof_efficiency/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export DETECTOR_PATH="/path/to/dd4hep/epic/"
export DETECTOR="epic_tracking_only"

# This makes tracking output data and input MC particles to be written to the output
-Ppodio:output_include_collections="ReconstructedParticles,TrackParameters,MCParticles"
-Ppodio:output_collections="ReconstructedParticles,TrackParameters,MCParticles"

# There is a centralized file where plugins can save their histograms:
-Phistsfile=/home/romanov/work/data/eicrecon_test/tracking_test_gun.ana.root
Expand All @@ -82,7 +82,7 @@ defining a list of objects and the output file name:

```bash
# This makes tracking output data and input MC particles to be written to the output
-Ppodio:output_include_collections="ReconstructedParticles,TrackParameters,MCParticles"
-Ppodio:output_collections="ReconstructedParticles,TrackParameters,MCParticles"

# This sets file path containing output tree
-Ppodio:output_file=/home/romanov/work/data/eicrecon_test/tracking_test_gun.edm4eic.root
Expand Down
4 changes: 2 additions & 2 deletions src/benchmarks/reconstruction/tracking_efficiency/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export DETECTOR_PATH="/path/to/dd4hep/epic/"
export DETECTOR="epic_tracking_only"

# This makes tracking output data and input MC particles to be written to the output
-Ppodio:output_include_collections="ReconstructedParticles,TrackParameters,MCParticles"
-Ppodio:output_collections="ReconstructedParticles,TrackParameters,MCParticles"

# There is a centralized file where plugins can save their histograms:
-Phistsfile=/home/romanov/work/data/eicrecon_test/tracking_test_gun.ana.root
Expand All @@ -84,7 +84,7 @@ defining a list of objects and the output file name:

```bash
# This makes tracking output data and input MC particles to be written to the output
-Ppodio:output_include_collections="ReconstructedParticles,TrackParameters,MCParticles"
-Ppodio:output_collections="ReconstructedParticles,TrackParameters,MCParticles"

# This sets file path containing output tree
-Ppodio:output_file=/home/romanov/work/data/eicrecon_test/tracking_test_gun.edm4eic.root
Expand Down
4 changes: 2 additions & 2 deletions src/detectors/LUMISPECCAL/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export DETECTOR_PATH="/path/to/dd4hep/epic/"
export DETECTOR="epic_tracking_only"

# This makes tracking output data and input MC particles to be written to the output
-Ppodio:output_include_collections="ReconstructedParticles,TrackParameters,MCParticles"
-Ppodio:output_collections="ReconstructedParticles,TrackParameters,MCParticles"

# There is a centralized file where plugins can save their histograms:
-Phistsfile=/home/romanov/work/data/eicrecon_test/tracking_test_gun.ana.root
Expand All @@ -84,7 +84,7 @@ defining a list of objects and the output file name:

```bash
# This makes tracking output data and input MC particles to be written to the output
-Ppodio:output_include_collections="ReconstructedParticles,TrackParameters,MCParticles"
-Ppodio:output_collections="ReconstructedParticles,TrackParameters,MCParticles"

# This sets file path containing output tree
-Ppodio:output_file=/home/romanov/work/data/eicrecon_test/tracking_test_gun.edm4eic.root
Expand Down
2 changes: 1 addition & 1 deletion src/services/io/podio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ You may specify both an include list and an exclude list.


Similar to the input, you may also specify which collections to write out using the
_podio:output_include_collections_ and _podio:output_exclude_collections_ configuration
_podio:output_collections_ and _podio:output_exclude_collections_ configuration
parameters.

### Testing
Expand Down
Loading