colour.log_encoding#

colour.log_encoding(value: Union[float, numpy.typing._array_like._SupportsArray[numpy.dtype], numpy.typing._nested_sequence._NestedSequence[numpy.typing._array_like._SupportsArray[numpy.dtype]], bool, int, complex, str, bytes, numpy.typing._nested_sequence._NestedSequence[Union[bool, int, float, complex, str, bytes]]], function: Union[Literal['ACEScc', 'ACEScct', 'ACESproxy', 'ALEXA Log C', 'Canon Log 2', 'Canon Log 3', 'Canon Log', 'Cineon', 'D-Log', 'ERIMM RGB', 'F-Log', 'Filmic Pro 6', 'L-Log', 'Log2', 'Log3G10', 'Log3G12', 'N-Log', 'PLog', 'Panalog', 'Protune', 'REDLog', 'REDLogFilm', 'S-Log', 'S-Log2', 'S-Log3', 'T-Log', 'V-Log', 'ViperLog'], str] = 'Cineon', **kwargs: Any) Union[float, numpy.ndarray, int][source]#

Encode scene-referred exposure values to \(R'G'B'\) video component signal value using given log encoding function.

Parameters
Returns

Log values.

Return type

numpy.floating or numpy.integer or numpy.ndarray

Examples

>>> log_encoding(0.18)  
0.4573196...
>>> log_encoding(0.18, function='ACEScc')  
0.4135884...
>>> log_encoding(0.18, function='PLog', log_reference=400)
... 
0.3910068...
>>> log_encoding(0.18, function='S-Log')  
0.3849708...