Skip to content

Commit

Permalink
docs: vis module
Browse files Browse the repository at this point in the history
  • Loading branch information
hanatos committed Jan 13, 2025
1 parent 26da0cc commit 7f41f54
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions src/pipe/modules/vis/readme.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# vis: visualise input data with colour ramps

this converts the luminance of the linear input signal to an srgb viridis colour map.
this converts the luminance of the linear input signal to an srgb viridis colour map,
like in the following example:

[![viridis map](scatter.jpg)](scatter.jpg)

note that the output will be sRGB, so if you need rec2020, insert an instance
of `colour` after this and set it to `image` mode.


## connectors

* `input`
* `output`
* `input` rec2020 values, the luminance will be visualised
* `output` the sRGB viridis coloured version of the input

## parameters

Expand Down

0 comments on commit 7f41f54

Please sign in to comment.