colour.full_to_legal¶
- colour.full_to_legal(CV: Union[FloatingOrArrayLike, IntegerOrArrayLike], bit_depth: Integer = 10, in_int: Boolean = False, out_int: Boolean = False) Union[FloatingOrNDArray, IntegerOrNDArray] [source]¶
Convert given code value \(CV\) or float equivalent of a code value at a given bit depth from full range (full swing) to legal range (studio swing).
- Parameters
CV (Union[FloatingOrArrayLike, IntegerOrArrayLike]) – Full range code value \(CV\) or float equivalent of a code value at a given bit depth.
bit_depth (Integer) – Bit depth used for conversion.
in_int (Boolean) – Whether to treat the input value as integer code value or float equivalent of a code value at a given bit depth.
out_int (Boolean) – Whether to return value as integer code value or float equivalent of a code value at a given bit depth.
- Returns
Legal range code value \(CV\) or float equivalent of a code value at a given bit depth.
- Return type
Examples
>>> full_to_legal(0.0) 0.0625610... >>> full_to_legal(1.0) 0.9188660... >>> full_to_legal(0.0, out_int=True) 64 >>> full_to_legal(1.0, out_int=True) 940 >>> full_to_legal(0, in_int=True) 0.0625610... >>> full_to_legal(1023, in_int=True) 0.9188660... >>> full_to_legal(0, in_int=True, out_int=True) 64 >>> full_to_legal(1023, in_int=True, out_int=True) 940