UCL / UCL/STIR

Remove need for STIR_REGISTRIES (better STIR plug-ins)

Open
#212 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C++
Stars
160
Forks
113
Avg merge
12d 15h
Merged PRs (30d)
1

Description

It might be better to remove the need for explicit linking of the registry files (see #211 and #83).

This seems to need a number of function like init_IO_registries, to be called at the start of every main(), or STIR library initialisation (e.g. for Python).

This is ugly however. Worse, we don't know what that function should do. A developer can currently extend STIR (using the STIR_local CMake variable) and add her own registry variables. This allows anyone to add new IO/filter/whatever functionality, used by the rest of STIR. Indeed, they can add new registries as well. So, we'd need to provide hooks for that.

This is of course standard plug-in stuff. I'm sure there are nice and easy ways to solve this. suggestions welcome.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the related issues #211 and #83, then trace how STIR registry files are linked and where main() or library initialization occurs. Identify the requirements for extensions using STIR_local, including custom registries and Python initialization. Done means the plugin and registry approach is defined well enough to remove explicit registry linking without breaking existing extension points.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, cpp
Domain
build-system, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.