DiamondLightSource / DiamondLightSource/httomo

Document pipeline transformations applied by `UiLayer`

Open
#585 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
10
Forks
5
Avg merge
5d 17h
Merged PRs (30d)
1

Description

From the signature of its single public method: https://github.com/DiamondLightSource/httomo/blob/c7e399d09f56a238e4c731c5f66857047f7f4752/httomo/ui_layer.py#L50

it's clear enough that `UiLayer` is used to produce a `Pipeline`.

However, transforming pipeline data from some external format (eg, YAML) into a `Pipeline` is not all that it does, it makes some additional changes. These additional changes should be documented somewhere (possibly in the class docstring).

The only transformation it applies I think is taking side output references and inserting appropriate `OutputRef` objects into the parameter dicts of the relevant method wrappers.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.