OpenColorIO icon indicating copy to clipboard operation
OpenColorIO copied to clipboard

Transform methods entirely undocumented

Open pyalot opened this issue 7 years ago • 6 comments

There's various transforms that can be configured in, they're all undocumented.

pyalot avatar Mar 17 '17 16:03 pyalot

http://opencolorio.org/developers/bindings/PythonTransforms.html

Is this not sufficient? Please point out specific cases for where documentation is lacking.

scoopxyz avatar Mar 17 '17 18:03 scoopxyz

It lists API calls, it does not list what values functions take, and what those mean.

pyalot avatar Mar 17 '17 18:03 pyalot

For example say a transform is listed as: - !<AllocationTransform> {allocation: uniform, vars: [0, 0.66]}. The configuration syntax documentation doesn't list what that does. The same goes for !<AllocationTransform> {allocation: lg2, vars: [-12.473931188, 12.526068812], direction: inverse} or !<FileTransform> {src: BT.1886_to_Linear.spi1d, interpolation: linear}. I can guess half of what they do, but it doesn't say so in the documentation. It also doesn't say where the difference is between interpolation methods like "best" or "linear". I guess best is a cubic spline, or something, again, not in the documentation.

pyalot avatar Mar 17 '17 18:03 pyalot

Allocation "documentation" exists here: http://opencolorio.org/configurations/allocation_vars.html

I agree they should be centralized, and logically organized. I cannot find documentation on the interpolation methods.

scoopxyz avatar Mar 17 '17 18:03 scoopxyz

I think that's what threw me off, I glanced at it, and could not find some logical listing of "you can use this directive with these options".

pyalot avatar Mar 17 '17 18:03 pyalot

http://opencolorio.org/userguide/config_syntax.html#available-transforms

dbr avatar Mar 17 '17 21:03 dbr