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

Add API to EventSource for reading the reference metadata #2645

Open
maxnoe opened this issue Nov 11, 2024 · 0 comments
Open

Add API to EventSource for reading the reference metadata #2645

maxnoe opened this issue Nov 11, 2024 · 0 comments

Comments

@maxnoe
Copy link
Member

maxnoe commented Nov 11, 2024

Please describe the use case that requires this feature.

Add the moment, the Provenance system tries to read the input reference metadata itself in add_input_file, however,
this makes it very inflexible and violates in some ways the plugin architecture.

We should add an API to the EventSource to obtain the reference metadata, so that plugins can support reading the reference metadata for arbitrary inputs.

Describe the solution you'd like

Add a new property:

@property
@abstractmethod
def reference_metadata(self) -> ReferenceMetadata:

to the EventSource.

Describe alternatives you've considered

Alternative would be that we either
a) implement reading of reference metadata for all expected file types in ctapipe itself
or
b) live with missing input reference metadata for plugin event sources

both seem worse than adding this API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant