colour.log_encoding#

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

Parameters:

value (_SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]) – Scene-referred exposure values.
function (Literal['ACEScc', 'ACEScct', 'ACESproxy', 'ARRI LogC3', 'ARRI LogC4', 'Apple Log Profile', 'Canon Log', 'Canon Log 2', 'Canon Log 3', 'Cineon', 'D-Log', 'ERIMM RGB', 'F-Log', 'F-Log2', '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) – Log encoding function.
kwargs (Any) – {colour.models.log_encoding_ACEScc(), colour.models.log_encoding_ACEScct(), colour.models.log_encoding_ACESproxy(), colour.models.log_encoding_AppleLogProfile(), colour.models.log_encoding_ARRILogC3(), colour.models.log_encoding_ARRILogC4(), colour.models.log_encoding_CanonLog2(), colour.models.log_encoding_CanonLog3(), colour.models.log_encoding_CanonLog(), colour.models.log_encoding_Cineon(), colour.models.log_encoding_DJIDLog(), colour.models.log_encoding_ERIMMRGB(), colour.models.log_encoding_FLog(), colour.models.log_encoding_FLog2(), colour.models.log_encoding_FilmicPro6(), colour.models.log_encoding_LLog(), colour.models.log_encoding_Log2(), colour.models.log_encoding_Log3G10(), colour.models.log_encoding_Log3G12(), colour.models.log_encoding_NLog(), colour.models.log_encoding_PivotedLog(), colour.models.log_encoding_Panalog(), colour.models.log_encoding_Protune(), colour.models.log_encoding_REDLog(), colour.models.log_encoding_REDLogFilm(), colour.models.log_encoding_SLog(), colour.models.log_encoding_SLog2(), colour.models.log_encoding_SLog3(), colour.models.log_encoding_FilmLightTLog(), colour.models.log_encoding_VLog(), colour.models.log_encoding_ViperLog()}, See the documentation of the previously listed definitions.

Returns:

Log values.

Return type:

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...