Skip to content

Extend documentation on getting CCDB objects #2504

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.

Sign up for GitHub

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

Merged
Barthelemy merged 1 commit into from
Feb 11, 2025
Merged

Extend documentation on getting CCDB objects #2504

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 26 additions & 2 deletions doc/Advanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -751,13 +751,37 @@ The recommended way (excluding postprocessing) to access these conditions is to
```
The timestamp of the CCDB object will be aligned with the data timestamp.

If a task needs both sampled input and a CCDB object, it is advised to use two data sources as such:
```json
"tasks": {
"MyTask": {
...
"dataSources": [{
"type": "dataSamplingPolicy",
"name": "mftclusters"
}, {
"type": "direct",
"query": "cldict:MFT/CLUSDICT/0?lifetime=condition&ccdb-path=MFT/Calib/ClusterDictionary"
}],
}
},
```

The requested CCDB object can be accessed like any other DPL input in `monitorData`:
```
void QcMFTClusterTask::monitorData(o2::framework::ProcessingContext& ctx)
{
...
auto mDictPtr = ctx.inputs().get<o2::itsmft::TopologyDictionary*>("cldict");
```

Geometry and General Run Parameters (GRP) can be also accessed with the [GRP Geom Helper](#access-grp-objects-with-grp-geom-helper).

If your task accesses CCDB objects using `TaskInterface::retrieveCondition`, please migrate to using one of the methods mentioned above.
If your task accesses CCDB objects using `UserCodeInterface::retrieveConditionAny`, please migrate to using one of the methods mentioned above.

### Accessing from a Postprocessing task

PostProcessingTasks do not take DPL inputs, so in this case `TaskInterface::retrieveCondition` should be used.
PostProcessingTasks do not take DPL inputs, so in this case `ConditionAccess::retrieveConditionAny` should be used (it's inherited by `PostProcessingInterface` and any children).

## Access GRP objects with GRP Geom Helper

Expand Down