colour.models.describe_video_signal_transfer_characteristics

colour.models.describe_video_signal_transfer_characteristics(code_point: int, print_description: bool = True, **kwargs) → str

Describe given video signal transfer characteristics code point.

Parameters:

• code_point (int) – Video signal transfer characteristics code point to describe from colour.TRANSFER_CHARACTERISTICS_ITUTH273 attribute.

• print_description (bool) – Whether to print the description.

• padding – {colour.utilities.message_box()}, Padding on each side of the message.

• print_callable – {colour.utilities.message_box()}, Callable used to print the message box.

• width – {colour.utilities.message_box()}, Message box width.

Returns:

Video signal colour primaries code point description.

Return type:

str

References

[FFmpegDevelopers22c], [InternationalOfStandardization13], [InternationalOfStandardization21], [InternationalOfStandardization20], [InternationalTUnion21]

Examples

>>> description = describe_video_signal_transfer_characteristics(1, width=75)
... 
===========================================================================
*                                                                         *
*   Transfer Characteristics: 1                                           *
*   ---------------------------                                           *
*                                                                         *
*   Function         : <function oetf_BT709 at 0x...>...*
*   FFmpeg Constants : ['AVCOL_TRC_BT709', 'BT709']                       *
*                                                                         *
===========================================================================
>>> description = describe_video_signal_transfer_characteristics(2, width=75)
... 
===========================================================================
*                                                                         *
*   Transfer Characteristics: 2                                           *
*   ---------------------------                                           *
*                                                                         *
*   Function         : <function _unspecified at 0x...>...*
*   FFmpeg Constants : ['AVCOL_TRC_UNSPECIFIED', 'UNSPECIFIED']           *
*                                                                         *
===========================================================================
>>> description = describe_video_signal_transfer_characteristics(
...     FFmpegConstantsTransferCharacteristics_ITUTH273.SMPTE428, width=75
... )
... 
===========================================================================
*                                                                         *
*   Transfer Characteristics: 17                                          *
*   ----------------------------                                          *
*                                                                         *
*   Function         : <function eotf_inverse_H273_ST428_1 at             *
*   0x...>...*
*   FFmpeg Constants : ['AVCOL_TRC_SMPTE428', 'AVCOL_TRC_SMPTEST428_1',   *
*   'SMPTE428', 'SMPTEST428_1']                                           *
*                                                                         *
===========================================================================