colour.models.describe_video_signal_matrix_coefficients#

colour.models.describe_video_signal_matrix_coefficients(code_point: int, print_description: bool = True, **kwargs) → str[source]#

Describe given video signal matrix coefficients code point.

Parameters:

code_point (int) – Video signal matrix coefficients code point to describe from colour.MATRIX_COEFFICIENTS_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

[FFmpegDevelopers22b], [InternationalOfStandardization13], [InternationalOfStandardization21], [InternationalOfStandardization20], [InternationalTUnion21]

Examples

>>> description = describe_video_signal_matrix_coefficients(1, width=75)
===========================================================================
*                                                                         *
*   Matrix Coefficients: 1                                                *
*   ----------------------                                                *
*                                                                         *
*   Matrix Coefficients : [ 0.2126  0.0722]                               *
*   FFmpeg Constants    : ['AVCOL_SPC_BT709', 'BT709']                    *
*                                                                         *
===========================================================================
>>> description = describe_video_signal_matrix_coefficients(2, width=75)
===========================================================================
*                                                                         *
*   Matrix Coefficients: 2                                                *
*   ----------------------                                                *
*                                                                         *
*   Matrix Coefficients : Unspecified                                     *
*   FFmpeg Constants    : ['AVCOL_SPC_UNSPECIFIED', 'UNSPECIFIED']        *
*                                                                         *
===========================================================================
>>> description = describe_video_signal_matrix_coefficients(
...     FFmpegConstantsMatrixCoefficients_ITUTH273.ICTCP, width=75
... )
... 
===========================================================================
*                                                                         *
*   Matrix Coefficients: 14                                               *
*   -----------------------                                               *
*                                                                         *
*   Matrix Coefficients : ICTCP                                           *
*   FFmpeg Constants    : ['AVCOL_SPC_ICTCP', 'ICTCP']                    *
*                                                                         *
===========================================================================