Coverage for colour/models/rgb/transfer_functions/__init__.py: 85%

1from __future__ import annotations 

2 

3import typing 

4from functools import partial 

5 

6if typing.TYPE_CHECKING: 

7 from colour.hints import ( 

8 Any, 

9 ArrayLike, 

10 NDArrayFloat, 

11 NDArrayInt, 

12 LiteralLogEncoding, 

13 LiteralLogDecoding, 

14 LiteralOETF, 

15 LiteralOETFInverse, 

16 LiteralEOTF, 

17 LiteralEOTFInverse, 

18 LiteralCCTFEncoding, 

19 LiteralCCTFDecoding, 

20 LiteralOOTF, 

21 LiteralOOTFInverse, 

22 ) 

23 

24from colour.utilities import ( 

25 CanonicalMapping, 

26 filter_kwargs, 

27 usage_warning, 

28 validate_method, 

29) 

30 

31# isort: split 

32 

33from .common import CV_range, full_to_legal, legal_to_full 

34from .gamma import gamma_function 

35 

36# isort: split 

37 

38from .aces import ( 

39 log_decoding_ACEScc, 

40 log_decoding_ACEScct, 

41 log_decoding_ACESproxy, 

42 log_encoding_ACEScc, 

43 log_encoding_ACEScct, 

44 log_encoding_ACESproxy, 

45) 

46from .apple_log_profile import ( 

47 log_decoding_AppleLogProfile, 

48 log_encoding_AppleLogProfile, 

49) 

50from .arib_std_b67 import oetf_ARIBSTDB67, oetf_inverse_ARIBSTDB67 

51from .arri import ( 

52 log_decoding_ARRILogC3, 

53 log_decoding_ARRILogC4, 

54 log_encoding_ARRILogC3, 

55 log_encoding_ARRILogC4, 

56) 

57from .blackmagic_design import ( 

58 oetf_BlackmagicFilmGeneration5, 

59 oetf_inverse_BlackmagicFilmGeneration5, 

60) 

61from .canon import ( 

62 CANON_LOG_2_DECODING_METHODS, 

63 CANON_LOG_2_ENCODING_METHODS, 

64 CANON_LOG_3_DECODING_METHODS, 

65 CANON_LOG_3_ENCODING_METHODS, 

66 CANON_LOG_DECODING_METHODS, 

67 CANON_LOG_ENCODING_METHODS, 

68 log_decoding_CanonLog, 

69 log_decoding_CanonLog2, 

70 log_decoding_CanonLog3, 

71 log_encoding_CanonLog, 

72 log_encoding_CanonLog2, 

73 log_encoding_CanonLog3, 

74) 

75from .cineon import log_decoding_Cineon, log_encoding_Cineon 

76from .davinci_intermediate import ( 

77 oetf_DaVinciIntermediate, 

78 oetf_inverse_DaVinciIntermediate, 

79) 

80from .dcdm import eotf_DCDM, eotf_inverse_DCDM 

81from .dicom_gsdf import eotf_DICOMGSDF, eotf_inverse_DICOMGSDF 

82from .dji_d_log import log_decoding_DJIDLog, log_encoding_DJIDLog 

83from .exponent import exponent_function_basic, exponent_function_monitor_curve 

84from .filmic_pro import log_decoding_FilmicPro6, log_encoding_FilmicPro6 

85from .filmlight_t_log import ( 

86 log_decoding_FilmLightTLog, 

87 log_encoding_FilmLightTLog, 

88) 

89from .fujifilm_f_log import ( 

90 log_decoding_FLog, 

91 log_decoding_FLog2, 

92 log_encoding_FLog, 

93 log_encoding_FLog2, 

94) 

95from .gopro import log_decoding_Protune, log_encoding_Protune 

96from .itur_bt_601 import oetf_BT601, oetf_inverse_BT601 

97from .itur_bt_709 import oetf_BT709, oetf_inverse_BT709 

98from .itur_bt_1361 import oetf_BT1361, oetf_inverse_BT1361 

99from .itur_bt_1886 import eotf_BT1886, eotf_inverse_BT1886 

100from .itur_bt_2020 import oetf_BT2020, oetf_inverse_BT2020 

101 

102# isort: split 

103 

104from .st_2084 import eotf_inverse_ST2084, eotf_ST2084 

105 

106# isort: split 

107 

108from .itur_bt_2100 import ( 

109 BT2100_HLG_EOTF_INVERSE_METHODS, 

110 BT2100_HLG_EOTF_METHODS, 

111 BT2100_HLG_OOTF_INVERSE_METHODS, 

112 BT2100_HLG_OOTF_METHODS, 

113 eotf_BT2100_HLG, 

114 eotf_BT2100_PQ, 

115 eotf_inverse_BT2100_HLG, 

116 eotf_inverse_BT2100_PQ, 

117 oetf_BT2100_HLG, 

118 oetf_BT2100_PQ, 

119 oetf_inverse_BT2100_HLG, 

120 oetf_inverse_BT2100_PQ, 

121 ootf_BT2100_HLG, 

122 ootf_BT2100_PQ, 

123 ootf_inverse_BT2100_HLG, 

124 ootf_inverse_BT2100_PQ, 

125) 

126from .leica_l_log import log_decoding_LLog, log_encoding_LLog 

127from .linear import linear_function 

128from .log import ( 

129 log_decoding_Log2, 

130 log_encoding_Log2, 

131 logarithmic_function_basic, 

132 logarithmic_function_camera, 

133 logarithmic_function_quasilog, 

134) 

135from .nikon_n_log import log_decoding_NLog, log_encoding_NLog 

136from .panalog import log_decoding_Panalog, log_encoding_Panalog 

137from .panasonic_v_log import log_decoding_VLog, log_encoding_VLog 

138from .pivoted_log import log_decoding_PivotedLog, log_encoding_PivotedLog 

139from .red import ( 

140 LOG3G10_DECODING_METHODS, 

141 LOG3G10_ENCODING_METHODS, 

142 log_decoding_Log3G10, 

143 log_decoding_Log3G12, 

144 log_decoding_REDLog, 

145 log_decoding_REDLogFilm, 

146 log_encoding_Log3G10, 

147 log_encoding_Log3G12, 

148 log_encoding_REDLog, 

149 log_encoding_REDLogFilm, 

150) 

151from .rimm_romm_rgb import ( 

152 cctf_decoding_ProPhotoRGB, 

153 cctf_decoding_RIMMRGB, 

154 cctf_decoding_ROMMRGB, 

155 cctf_encoding_ProPhotoRGB, 

156 cctf_encoding_RIMMRGB, 

157 cctf_encoding_ROMMRGB, 

158 log_decoding_ERIMMRGB, 

159 log_encoding_ERIMMRGB, 

160) 

161from .smpte_240m import eotf_SMPTE240M, oetf_SMPTE240M 

162from .sony import ( 

163 log_decoding_SLog, 

164 log_decoding_SLog2, 

165 log_decoding_SLog3, 

166 log_encoding_SLog, 

167 log_encoding_SLog2, 

168 log_encoding_SLog3, 

169) 

170from .srgb import eotf_inverse_sRGB, eotf_sRGB 

171from .viper_log import log_decoding_ViperLog, log_encoding_ViperLog 

172from .xiaomi_mi_log import log_decoding_MiLog, log_encoding_MiLog 

173 

174# isort: split 

175 

176from .itut_h_273 import ( 

177 eotf_H273_ST428_1, 

178 eotf_inverse_H273_ST428_1, 

179 oetf_H273_IEC61966_2, 

180 oetf_H273_Log, 

181 oetf_H273_LogSqrt, 

182 oetf_inverse_H273_IEC61966_2, 

183 oetf_inverse_H273_Log, 

184 oetf_inverse_H273_LogSqrt, 

185) 

186 

187__all__ = [ 

188 "CV_range", 

189 "full_to_legal", 

190 "legal_to_full", 

191] 

192__all__ += [ 

193 "gamma_function", 

194] 

195__all__ += [ 

196 "log_decoding_ACEScc", 

197 "log_decoding_ACEScct", 

198 "log_decoding_ACESproxy", 

199 "log_encoding_ACEScc", 

200 "log_encoding_ACEScct", 

201 "log_encoding_ACESproxy", 

202] 

203__all__ += [ 

204 "log_decoding_AppleLogProfile", 

205 "log_encoding_AppleLogProfile", 

206] 

207__all__ += [ 

208 "oetf_ARIBSTDB67", 

209 "oetf_inverse_ARIBSTDB67", 

210] 

211__all__ += [ 

212 "log_decoding_ARRILogC3", 

213 "log_decoding_ARRILogC4", 

214 "log_encoding_ARRILogC3", 

215 "log_encoding_ARRILogC4", 

216] 

217__all__ += [ 

218 "oetf_BlackmagicFilmGeneration5", 

219 "oetf_inverse_BlackmagicFilmGeneration5", 

220] 

221__all__ += [ 

222 "CANON_LOG_2_DECODING_METHODS", 

223 "CANON_LOG_2_ENCODING_METHODS", 

224 "CANON_LOG_3_DECODING_METHODS", 

225 "CANON_LOG_3_ENCODING_METHODS", 

226 "CANON_LOG_DECODING_METHODS", 

227 "CANON_LOG_ENCODING_METHODS", 

228 "log_decoding_CanonLog", 

229 "log_decoding_CanonLog2", 

230 "log_decoding_CanonLog3", 

231 "log_encoding_CanonLog", 

232 "log_encoding_CanonLog2", 

233 "log_encoding_CanonLog3", 

234] 

235__all__ += [ 

236 "log_decoding_Cineon", 

237 "log_encoding_Cineon", 

238] 

239__all__ += [ 

240 "oetf_DaVinciIntermediate", 

241 "oetf_inverse_DaVinciIntermediate", 

242] 

243__all__ += [ 

244 "eotf_DCDM", 

245 "eotf_inverse_DCDM", 

246] 

247__all__ += [ 

248 "eotf_DICOMGSDF", 

249 "eotf_inverse_DICOMGSDF", 

250] 

251__all__ += [ 

252 "log_decoding_DJIDLog", 

253 "log_encoding_DJIDLog", 

254] 

255__all__ += [ 

256 "exponent_function_basic", 

257 "exponent_function_monitor_curve", 

258] 

259__all__ += [ 

260 "log_decoding_FilmicPro6", 

261 "log_encoding_FilmicPro6", 

262] 

263__all__ += [ 

264 "log_decoding_FilmLightTLog", 

265 "log_encoding_FilmLightTLog", 

266] 

267__all__ += [ 

268 "log_decoding_FLog", 

269 "log_decoding_FLog2", 

270 "log_encoding_FLog", 

271 "log_encoding_FLog2", 

272] 

273__all__ += [ 

274 "log_decoding_Protune", 

275 "log_encoding_Protune", 

276] 

277__all__ += [ 

278 "oetf_BT601", 

279 "oetf_inverse_BT601", 

280] 

281__all__ += [ 

282 "oetf_BT709", 

283 "oetf_inverse_BT709", 

284] 

285__all__ += [ 

286 "oetf_BT1361", 

287 "oetf_inverse_BT1361", 

288] 

289__all__ += [ 

290 "eotf_BT1886", 

291 "eotf_inverse_BT1886", 

292] 

293__all__ += [ 

294 "oetf_BT2020", 

295 "oetf_inverse_BT2020", 

296] 

297__all__ += [ 

298 "eotf_inverse_ST2084", 

299 "eotf_ST2084", 

300] 

301__all__ += [ 

302 "BT2100_HLG_EOTF_INVERSE_METHODS", 

303 "BT2100_HLG_EOTF_METHODS", 

304 "BT2100_HLG_OOTF_INVERSE_METHODS", 

305 "BT2100_HLG_OOTF_METHODS", 

306 "eotf_BT2100_HLG", 

307 "eotf_BT2100_PQ", 

308 "eotf_inverse_BT2100_HLG", 

309 "eotf_inverse_BT2100_PQ", 

310 "oetf_BT2100_HLG", 

311 "oetf_BT2100_PQ", 

312 "oetf_inverse_BT2100_HLG", 

313 "oetf_inverse_BT2100_PQ", 

314 "ootf_BT2100_HLG", 

315 "ootf_BT2100_PQ", 

316 "ootf_inverse_BT2100_HLG", 

317 "ootf_inverse_BT2100_PQ", 

318] 

319__all__ += [ 

320 "log_decoding_LLog", 

321 "log_encoding_LLog", 

322] 

323__all__ += [ 

324 "linear_function", 

325] 

326__all__ += [ 

327 "log_decoding_Log2", 

328 "log_encoding_Log2", 

329 "logarithmic_function_basic", 

330 "logarithmic_function_camera", 

331 "logarithmic_function_quasilog", 

332] 

333__all__ += [ 

334 "log_decoding_NLog", 

335 "log_encoding_NLog", 

336] 

337__all__ += [ 

338 "log_decoding_Panalog", 

339 "log_encoding_Panalog", 

340] 

341__all__ += [ 

342 "log_decoding_VLog", 

343 "log_encoding_VLog", 

344] 

345__all__ += [ 

346 "log_decoding_PivotedLog", 

347 "log_encoding_PivotedLog", 

348] 

349__all__ += [ 

350 "LOG3G10_DECODING_METHODS", 

351 "LOG3G10_ENCODING_METHODS", 

352 "log_decoding_Log3G10", 

353 "log_decoding_Log3G12", 

354 "log_decoding_REDLog", 

355 "log_decoding_REDLogFilm", 

356 "log_encoding_Log3G10", 

357 "log_encoding_Log3G12", 

358 "log_encoding_REDLog", 

359 "log_encoding_REDLogFilm", 

360] 

361__all__ += [ 

362 "cctf_decoding_ProPhotoRGB", 

363 "cctf_decoding_RIMMRGB", 

364 "cctf_decoding_ROMMRGB", 

365 "cctf_encoding_ProPhotoRGB", 

366 "cctf_encoding_RIMMRGB", 

367 "cctf_encoding_ROMMRGB", 

368 "log_decoding_ERIMMRGB", 

369 "log_encoding_ERIMMRGB", 

370] 

371__all__ += [ 

372 "eotf_SMPTE240M", 

373 "oetf_SMPTE240M", 

374] 

375__all__ += [ 

376 "log_decoding_SLog", 

377 "log_decoding_SLog2", 

378 "log_decoding_SLog3", 

379 "log_encoding_SLog", 

380 "log_encoding_SLog2", 

381 "log_encoding_SLog3", 

382] 

383__all__ += [ 

384 "eotf_inverse_sRGB", 

385 "eotf_sRGB", 

386] 

387__all__ += [ 

388 "log_decoding_ViperLog", 

389 "log_encoding_ViperLog", 

390] 

391__all__ += [ 

392 "log_decoding_MiLog", 

393 "log_encoding_MiLog", 

394] 

395__all__ += [ 

396 "eotf_H273_ST428_1", 

397 "eotf_inverse_H273_ST428_1", 

398 "oetf_H273_IEC61966_2", 

399 "oetf_H273_Log", 

400 "oetf_H273_LogSqrt", 

401 "oetf_inverse_H273_IEC61966_2", 

402 "oetf_inverse_H273_Log", 

403 "oetf_inverse_H273_LogSqrt", 

404] 

405 

406LOG_ENCODINGS: CanonicalMapping = CanonicalMapping( 

407 { 

408 "ACEScc": log_encoding_ACEScc, 

409 "ACEScct": log_encoding_ACEScct, 

410 "ACESproxy": log_encoding_ACESproxy, 

411 "Apple Log Profile": log_encoding_AppleLogProfile, 

412 "ARRI LogC3": log_encoding_ARRILogC3, 

413 "ARRI LogC4": log_encoding_ARRILogC4, 

414 "Canon Log 2": log_encoding_CanonLog2, 

415 "Canon Log 3": log_encoding_CanonLog3, 

416 "Canon Log": log_encoding_CanonLog, 

417 "Cineon": log_encoding_Cineon, 

418 "D-Log": log_encoding_DJIDLog, 

419 "ERIMM RGB": log_encoding_ERIMMRGB, 

420 "F-Log": log_encoding_FLog, 

421 "F-Log2": log_encoding_FLog2, 

422 "Filmic Pro 6": log_encoding_FilmicPro6, 

423 "L-Log": log_encoding_LLog, 

424 "Log2": log_encoding_Log2, 

425 "Log3G10": log_encoding_Log3G10, 

426 "Log3G12": log_encoding_Log3G12, 

427 "Mi-Log": log_encoding_MiLog, 

428 "N-Log": log_encoding_NLog, 

429 "PLog": log_encoding_PivotedLog, 

430 "Panalog": log_encoding_Panalog, 

431 "Protune": log_encoding_Protune, 

432 "REDLog": log_encoding_REDLog, 

433 "REDLogFilm": log_encoding_REDLogFilm, 

434 "S-Log": log_encoding_SLog, 

435 "S-Log2": log_encoding_SLog2, 

436 "S-Log3": log_encoding_SLog3, 

437 "T-Log": log_encoding_FilmLightTLog, 

438 "V-Log": log_encoding_VLog, 

439 "ViperLog": log_encoding_ViperLog, 

440 } 

441) 

442LOG_ENCODINGS.__doc__ = """ 

443Supported *log* encoding functions. 

444""" 

445 

446 

447def log_encoding( 

448 value: ArrayLike, function: LiteralLogEncoding | str = "Cineon", **kwargs: Any 

449) -> NDArrayFloat | NDArrayInt: 

450 """ 

451 Apply the specified log encoding opto-electronic transfer function (OETF). 

452 

453 Parameters 

454 ---------- 

455 value 

456 Scene-linear value. 

457 function 

458 *Log* encoding function. 

459 

460 Other Parameters 

461 ---------------- 

462 kwargs 

463 {:func:`colour.models.log_encoding_ACEScc`, 

464 :func:`colour.models.log_encoding_ACEScct`, 

465 :func:`colour.models.log_encoding_ACESproxy`, 

466 :func:`colour.models.log_encoding_AppleLogProfile`, 

467 :func:`colour.models.log_encoding_ARRILogC3`, 

468 :func:`colour.models.log_encoding_ARRILogC4`, 

469 :func:`colour.models.log_encoding_CanonLog2`, 

470 :func:`colour.models.log_encoding_CanonLog3`, 

471 :func:`colour.models.log_encoding_CanonLog`, 

472 :func:`colour.models.log_encoding_Cineon`, 

473 :func:`colour.models.log_encoding_DJIDLog`, 

474 :func:`colour.models.log_encoding_ERIMMRGB`, 

475 :func:`colour.models.log_encoding_FLog`, 

476 :func:`colour.models.log_encoding_FLog2`, 

477 :func:`colour.models.log_encoding_FilmicPro6`, 

478 :func:`colour.models.log_encoding_LLog`, 

479 :func:`colour.models.log_encoding_Log2`, 

480 :func:`colour.models.log_encoding_Log3G10`, 

481 :func:`colour.models.log_encoding_Log3G12`, 

482 :func:`colour.models.log_encoding_MiLog`, 

483 :func:`colour.models.log_encoding_NLog`, 

484 :func:`colour.models.log_encoding_PivotedLog`, 

485 :func:`colour.models.log_encoding_Panalog`, 

486 :func:`colour.models.log_encoding_Protune`, 

487 :func:`colour.models.log_encoding_REDLog`, 

488 :func:`colour.models.log_encoding_REDLogFilm`, 

489 :func:`colour.models.log_encoding_SLog`, 

490 :func:`colour.models.log_encoding_SLog2`, 

491 :func:`colour.models.log_encoding_SLog3`, 

492 :func:`colour.models.log_encoding_FilmLightTLog`, 

493 :func:`colour.models.log_encoding_VLog`, 

494 :func:`colour.models.log_encoding_ViperLog`}, 

495 See the documentation of the previously listed definitions. 

496 

497 Returns 

498 ------- 

499 :class:`numpy.ndarray` 

500 Logarithmic encoded value. 

501 

502 Examples 

503 -------- 

504 >>> log_encoding(0.18) # doctest: +ELLIPSIS 

505 0.4573196... 

506 >>> log_encoding(0.18, function="ACEScc") # doctest: +ELLIPSIS 

507 0.4135884... 

508 >>> log_encoding(0.18, function="PLog", log_reference=400) 

509 ... # doctest: +ELLIPSIS 

510 0.3910068... 

511 >>> log_encoding(0.18, function="S-Log") # doctest: +ELLIPSIS 

512 0.3849708... 

513 """ 

514 

515 function = validate_method( 

516 function, 

517 tuple(LOG_ENCODINGS), 

518 '"{0}" "log" encoding function is invalid, it must be one of {1}!', 

519 ) 

520 

521 callable_ = LOG_ENCODINGS[function] 

522 

523 return callable_(value, **filter_kwargs(callable_, **kwargs)) 

524 

525 

526LOG_DECODINGS: CanonicalMapping = CanonicalMapping( 

527 { 

528 "ACEScc": log_decoding_ACEScc, 

529 "ACEScct": log_decoding_ACEScct, 

530 "ACESproxy": log_decoding_ACESproxy, 

531 "Apple Log Profile": log_decoding_AppleLogProfile, 

532 "ARRI LogC3": log_decoding_ARRILogC3, 

533 "ARRI LogC4": log_decoding_ARRILogC4, 

534 "Canon Log 2": log_decoding_CanonLog2, 

535 "Canon Log 3": log_decoding_CanonLog3, 

536 "Canon Log": log_decoding_CanonLog, 

537 "Cineon": log_decoding_Cineon, 

538 "D-Log": log_decoding_DJIDLog, 

539 "ERIMM RGB": log_decoding_ERIMMRGB, 

540 "F-Log": log_decoding_FLog, 

541 "F-Log2": log_decoding_FLog2, 

542 "Filmic Pro 6": log_decoding_FilmicPro6, 

543 "L-Log": log_decoding_LLog, 

544 "Log2": log_decoding_Log2, 

545 "Log3G10": log_decoding_Log3G10, 

546 "Log3G12": log_decoding_Log3G12, 

547 "Mi-Log": log_decoding_MiLog, 

548 "N-Log": log_decoding_NLog, 

549 "PLog": log_decoding_PivotedLog, 

550 "Panalog": log_decoding_Panalog, 

551 "Protune": log_decoding_Protune, 

552 "REDLog": log_decoding_REDLog, 

553 "REDLogFilm": log_decoding_REDLogFilm, 

554 "S-Log": log_decoding_SLog, 

555 "S-Log2": log_decoding_SLog2, 

556 "S-Log3": log_decoding_SLog3, 

557 "T-Log": log_decoding_FilmLightTLog, 

558 "V-Log": log_decoding_VLog, 

559 "ViperLog": log_decoding_ViperLog, 

560 } 

561) 

562LOG_DECODINGS.__doc__ = """ 

563Supported *log* decoding functions. 

564""" 

565 

566 

567def log_decoding( 

568 value: ArrayLike, 

569 function: LiteralLogDecoding | str = "Cineon", 

570 **kwargs: Any, 

571) -> NDArrayFloat: 

572 """ 

573 Apply the specified log decoding inverse opto-electronic transfer function (OETF). 

574 

575 Parameters 

576 ---------- 

577 value 

578 Logarithmic encoded value. 

579 function 

580 *Log* decoding function. 

581 

582 Other Parameters 

583 ---------------- 

584 kwargs 

585 {:func:`colour.models.log_decoding_ACEScc`, 

586 :func:`colour.models.log_decoding_ACEScct`, 

587 :func:`colour.models.log_decoding_ACESproxy`, 

588 :func:`colour.models.log_decoding_AppleLogProfile`, 

589 :func:`colour.models.log_decoding_ARRILogC3`, 

590 :func:`colour.models.log_decoding_ARRILogC4`, 

591 :func:`colour.models.log_decoding_CanonLog2`, 

592 :func:`colour.models.log_decoding_CanonLog3`, 

593 :func:`colour.models.log_decoding_CanonLog`, 

594 :func:`colour.models.log_decoding_Cineon`, 

595 :func:`colour.models.log_decoding_DJIDLog`, 

596 :func:`colour.models.log_decoding_ERIMMRGB`, 

597 :func:`colour.models.log_decoding_FLog`, 

598 :func:`colour.models.log_decoding_FLog2`, 

599 :func:`colour.models.log_decoding_FilmicPro6`, 

600 :func:`colour.models.log_decoding_LLog`, 

601 :func:`colour.models.log_decoding_Log2`, 

602 :func:`colour.models.log_decoding_Log3G10`, 

603 :func:`colour.models.log_decoding_Log3G12`, 

604 :func:`colour.models.log_decoding_MiLog`, 

605 :func:`colour.models.log_decoding_NLog`, 

606 :func:`colour.models.log_decoding_PivotedLog`, 

607 :func:`colour.models.log_decoding_Panalog`, 

608 :func:`colour.models.log_decoding_Protune`, 

609 :func:`colour.models.log_decoding_REDLog`, 

610 :func:`colour.models.log_decoding_REDLogFilm`, 

611 :func:`colour.models.log_decoding_SLog`, 

612 :func:`colour.models.log_decoding_SLog2`, 

613 :func:`colour.models.log_decoding_SLog3`, 

614 :func:`colour.models.log_decoding_FilmLightTLog`, 

615 :func:`colour.models.log_decoding_VLog`, 

616 :func:`colour.models.log_decoding_ViperLog`}, 

617 See the documentation of the previously listed definitions. 

618 

619 Returns 

620 ------- 

621 :class:`numpy.ndarray` 

622 Scene-linear value. 

623 

624 Examples 

625 -------- 

626 >>> log_decoding(0.457319613085418) # doctest: +ELLIPSIS 

627 0.1... 

628 >>> log_decoding(0.413588402492442, function="ACEScc") 

629 ... # doctest: +ELLIPSIS 

630 0.1... 

631 >>> log_decoding(0.391006842619746, function="PLog", log_reference=400) 

632 ... # doctest: +ELLIPSIS 

633 0.1... 

634 >>> log_decoding(0.376512722254600, function="S-Log") 

635 ... # doctest: +ELLIPSIS 

636 0.1... 

637 """ 

638 

639 function = validate_method( 

640 function, 

641 tuple(LOG_DECODINGS), 

642 '"{0}" "log" decoding function is invalid, it must be one of {1}!', 

643 ) 

644 

645 callable_ = LOG_DECODINGS[function] 

646 

647 return callable_(value, **filter_kwargs(callable_, **kwargs)) 

648 

649 

650__all__ += [ 

651 "LOG_ENCODINGS", 

652 "LOG_DECODINGS", 

653] 

654__all__ += [ 

655 "log_encoding", 

656 "log_decoding", 

657] 

658 

659OETFS: CanonicalMapping = CanonicalMapping( 

660 { 

661 "ARIB STD-B67": oetf_ARIBSTDB67, 

662 "Blackmagic Film Generation 5": oetf_BlackmagicFilmGeneration5, 

663 "DaVinci Intermediate": oetf_DaVinciIntermediate, 

664 "ITU-R BT.2020": oetf_BT2020, 

665 "ITU-R BT.2100 HLG": oetf_BT2100_HLG, 

666 "ITU-R BT.2100 PQ": oetf_BT2100_PQ, 

667 "ITU-R BT.601": oetf_BT601, 

668 "ITU-R BT.709": oetf_BT709, 

669 "ITU-T H.273 Log": oetf_H273_Log, 

670 "ITU-T H.273 Log Sqrt": oetf_H273_LogSqrt, 

671 "ITU-T H.273 IEC 61966-2": oetf_H273_IEC61966_2, 

672 "SMPTE 240M": oetf_SMPTE240M, 

673 } 

674) 

675OETFS.__doc__ = """ 

676Supported opto-electrical transfer functions (OETFs / OECFs). 

677""" 

678 

679 

680def oetf( 

681 value: ArrayLike, function: LiteralOETF | str = "ITU-R BT.709", **kwargs: Any 

682) -> NDArrayFloat: 

683 """ 

684 Apply the specified opto-electronic transfer function (OETF). 

685 

686 Parameters 

687 ---------- 

688 value 

689 Scene-linear value. 

690 function 

691 Opto-electronic transfer function (OETF). 

692 

693 Other Parameters 

694 ---------------- 

695 kwargs 

696 {:func:`colour.models.oetf_ARIBSTDB67`, 

697 :func:`colour.models.oetf_BlackmagicFilmGeneration5`, 

698 :func:`colour.models.oetf_DaVinciIntermediate`, 

699 :func:`colour.models.oetf_BT2020`, 

700 :func:`colour.models.oetf_BT2100_HLG`, 

701 :func:`colour.models.oetf_BT2100_PQ`, 

702 :func:`colour.models.oetf_BT601`, 

703 :func:`colour.models.oetf_BT709`, 

704 :func:`colour.models.oetf_SMPTE240M`}, 

705 See the documentation of the previously listed definitions. 

706 

707 Returns 

708 ------- 

709 :class:`numpy.ndarray` 

710 Non-linear signal value. 

711 

712 Examples 

713 -------- 

714 >>> oetf(0.18) # doctest: +ELLIPSIS 

715 0.4090077... 

716 >>> oetf(0.18, function="ITU-R BT.601") # doctest: +ELLIPSIS 

717 0.4090077... 

718 """ 

719 

720 function = validate_method( 

721 function, 

722 tuple(OETFS), 

723 '"{0}" "OETF" is invalid, it must be one of {1}!', 

724 ) 

725 

726 callable_ = OETFS[function] 

727 

728 return callable_(value, **filter_kwargs(callable_, **kwargs)) 

729 

730 

731OETF_INVERSES: CanonicalMapping = CanonicalMapping( 

732 { 

733 "ARIB STD-B67": oetf_inverse_ARIBSTDB67, 

734 "Blackmagic Film Generation 5": oetf_inverse_BlackmagicFilmGeneration5, 

735 "DaVinci Intermediate": oetf_inverse_DaVinciIntermediate, 

736 "ITU-R BT.2020": oetf_inverse_BT2020, 

737 "ITU-R BT.2100 HLG": oetf_inverse_BT2100_HLG, 

738 "ITU-R BT.2100 PQ": oetf_inverse_BT2100_PQ, 

739 "ITU-R BT.601": oetf_inverse_BT601, 

740 "ITU-R BT.709": oetf_inverse_BT709, 

741 "ITU-T H.273 Log": oetf_inverse_H273_Log, 

742 "ITU-T H.273 Log Sqrt": oetf_inverse_H273_LogSqrt, 

743 "ITU-T H.273 IEC 61966-2": oetf_inverse_H273_IEC61966_2, 

744 } 

745) 

746OETF_INVERSES.__doc__ = """ 

747Supported inverse opto-electrical transfer functions (OETFs / OECFs). 

748""" 

749 

750 

751def oetf_inverse( 

752 value: ArrayLike, 

753 function: LiteralOETFInverse | str = "ITU-R BT.709", 

754 **kwargs: Any, 

755) -> NDArrayFloat: 

756 """ 

757 Apply the specified inverse opto-electronic transfer function (OETF). 

758 

759 Parameters 

760 ---------- 

761 value 

762 Non-linear signal value. 

763 function 

764 Inverse opto-electronic transfer function (OETF). 

765 

766 Other Parameters 

767 ---------------- 

768 kwargs 

769 {:func:`colour.models.oetf_inverse_ARIBSTDB67`, 

770 :func:`colour.models.oetf_inverse_BlackmagicFilmGeneration5`, 

771 :func:`colour.models.oetf_inverse_DaVinciIntermediate`, 

772 :func:`colour.models.oetf_inverse_BT2020`, 

773 :func:`colour.models.oetf_inverse_BT2100_HLG`, 

774 :func:`colour.models.oetf_inverse_BT2100_PQ`, 

775 :func:`colour.models.oetf_inverse_BT601`, 

776 :func:`colour.models.oetf_inverse_BT709`}, 

777 See the documentation of the previously listed definitions. 

778 

779 Returns 

780 ------- 

781 :class:`numpy.ndarray` 

782 Scene-linear value. 

783 

784 Examples 

785 -------- 

786 >>> oetf_inverse(0.409007728864150) # doctest: +ELLIPSIS 

787 0.1... 

788 >>> oetf_inverse( # doctest: +ELLIPSIS 

789 ... 0.409007728864150, function="ITU-R BT.601" 

790 ... ) 

791 0.1... 

792 """ 

793 

794 function = validate_method( 

795 function, 

796 tuple(OETF_INVERSES), 

797 '"{0}" inverse "OETF" is invalid, it must be one of {1}!', 

798 ) 

799 

800 callable_ = OETF_INVERSES[function] 

801 

802 return callable_(value, **filter_kwargs(callable_, **kwargs)) 

803 

804 

805EOTFS: CanonicalMapping = CanonicalMapping( 

806 { 

807 "DCDM": eotf_DCDM, 

808 "DICOM GSDF": eotf_DICOMGSDF, 

809 "ITU-R BT.1886": eotf_BT1886, 

810 "ITU-R BT.2100 HLG": eotf_BT2100_HLG, 

811 "ITU-R BT.2100 PQ": eotf_BT2100_PQ, 

812 "ITU-T H.273 ST.428-1": eotf_H273_ST428_1, 

813 "SMPTE 240M": eotf_SMPTE240M, 

814 "ST 2084": eotf_ST2084, 

815 "sRGB": eotf_sRGB, 

816 } 

817) 

818EOTFS.__doc__ = """ 

819Supported electro-optical transfer functions (EOTFs / EOCFs). 

820""" 

821 

822 

823def eotf( 

824 value: ArrayLike, 

825 function: LiteralEOTF | str = "ITU-R BT.1886", 

826 **kwargs: Any, 

827) -> NDArrayFloat: 

828 """ 

829 Apply the specified electro-optical transfer function (EOTF). 

830 

831 Parameters 

832 ---------- 

833 value 

834 Non-linear signal value. 

835 function 

836 Electro-optical transfer function (EOTF). 

837 

838 Other Parameters 

839 ---------------- 

840 kwargs 

841 {:func:`colour.models.eotf_DCDM`, 

842 :func:`colour.models.eotf_DICOMGSDF`, 

843 :func:`colour.models.eotf_BT1886`, 

844 :func:`colour.models.eotf_BT2100_HLG`, 

845 :func:`colour.models.eotf_BT2100_PQ`, 

846 :func:`colour.models.eotf_SMPTE240M`, 

847 :func:`colour.models.eotf_ST2084`, 

848 :func:`colour.models.eotf_sRGB`}, 

849 See the documentation of the previously listed definitions. 

850 

851 Returns 

852 ------- 

853 :class:`numpy.ndarray` 

854 Display-linear value. 

855 

856 Examples 

857 -------- 

858 >>> eotf(0.461356129500442) # doctest: +ELLIPSIS 

859 0.1... 

860 >>> eotf(0.182011532850008, function="ST 2084", L_p=1000) 

861 ... # doctest: +ELLIPSIS 

862 0.1... 

863 """ 

864 

865 function = validate_method( 

866 function, 

867 tuple(EOTFS), 

868 '"{0}" "EOTF" is invalid, it must be one of {1}!', 

869 ) 

870 

871 callable_ = EOTFS[function] 

872 

873 return callable_(value, **filter_kwargs(callable_, **kwargs)) 

874 

875 

876EOTF_INVERSES: CanonicalMapping = CanonicalMapping( 

877 { 

878 "DCDM": eotf_inverse_DCDM, 

879 "DICOM GSDF": eotf_inverse_DICOMGSDF, 

880 "ITU-R BT.1886": eotf_inverse_BT1886, 

881 "ITU-R BT.2100 HLG": eotf_inverse_BT2100_HLG, 

882 "ITU-R BT.2100 PQ": eotf_inverse_BT2100_PQ, 

883 "ITU-T H.273 ST.428-1": eotf_inverse_H273_ST428_1, 

884 "ST 2084": eotf_inverse_ST2084, 

885 "sRGB": eotf_inverse_sRGB, 

886 } 

887) 

888EOTF_INVERSES.__doc__ = """ 

889Supported inverse electro-optical transfer functions (EOTFs / EOCFs). 

890""" 

891 

892 

893def eotf_inverse( 

894 value: ArrayLike, 

895 function: LiteralEOTFInverse | str = "ITU-R BT.1886", 

896 **kwargs: Any, 

897) -> NDArrayFloat | NDArrayInt: 

898 """ 

899 Apply the specified inverse electro-optical transfer function (EOTF). 

900 

901 Parameters 

902 ---------- 

903 value 

904 Display-linear value. 

905 function 

906 Inverse electro-optical transfer function (EOTF). 

907 

908 Other Parameters 

909 ---------------- 

910 kwargs 

911 {:func:`colour.models.eotf_inverse_DCDM`, 

912 :func:`colour.models.eotf_inverse_DICOMGSDF`, 

913 :func:`colour.models.eotf_inverse_BT1886`, 

914 :func:`colour.models.eotf_inverse_BT2100_HLG`, 

915 :func:`colour.models.eotf_inverse_BT2100_PQ`, 

916 :func:`colour.models.eotf_inverse_ST2084`, 

917 :func:`colour.models.eotf_inverse_sRGB`}, 

918 See the documentation of the previously listed definitions. 

919 

920 Returns 

921 ------- 

922 :class:`numpy.ndarray` 

923 Non-linear signal value. 

924 

925 Examples 

926 -------- 

927 >>> eotf_inverse(0.11699185725296059) # doctest: +ELLIPSIS 

928 0.4090077... 

929 >>> eotf_inverse( # doctest: +ELLIPSIS 

930 ... 0.11699185725296059, function="ITU-R BT.1886" 

931 ... ) 

932 0.4090077... 

933 """ 

934 

935 function = validate_method( 

936 function, 

937 tuple(EOTF_INVERSES), 

938 '"{0}" inverse "EOTF" is invalid, it must be one of {1}!', 

939 ) 

940 

941 callable_ = EOTF_INVERSES[function] 

942 

943 return callable_(value, **filter_kwargs(callable_, **kwargs)) 

944 

945 

946__all__ += [ 

947 "OETFS", 

948 "OETF_INVERSES", 

949 "EOTFS", 

950 "EOTF_INVERSES", 

951] 

952__all__ += [ 

953 "oetf", 

954 "oetf_inverse", 

955 "eotf", 

956 "eotf_inverse", 

957] 

958 

959CCTF_ENCODINGS: CanonicalMapping = CanonicalMapping( 

960 { 

961 "Gamma 2.2": partial(gamma_function, exponent=1 / 2.2), 

962 "Gamma 2.4": partial(gamma_function, exponent=1 / 2.4), 

963 "Gamma 2.6": partial(gamma_function, exponent=1 / 2.6), 

964 "ProPhoto RGB": cctf_encoding_ProPhotoRGB, 

965 "RIMM RGB": cctf_encoding_RIMMRGB, 

966 "ROMM RGB": cctf_encoding_ROMMRGB, 

967 } 

968) 

969CCTF_ENCODINGS.update(LOG_ENCODINGS) 

970CCTF_ENCODINGS.update(OETFS) 

971CCTF_ENCODINGS.update(EOTF_INVERSES) 

972CCTF_ENCODINGS.__doc__ = """ 

973Supported encoding colour component transfer functions (encoding CCTFs), a 

974collection comprising functions from :attr:`colour.LOG_ENCODINGS`, 

975:attr:`colour.OETFS`, :attr:`colour.EOTF_INVERSES`, 

976:func:`colour.models.cctf_encoding_ProPhotoRGB`, 

977:func:`colour.models.cctf_encoding_RIMMRGB`, 

978:func:`colour.models.cctf_encoding_ROMMRGB`, and three gamma encoding 

979functions (1/2.2, 1/2.4, 1/2.6). 

980 

981Warnings 

982-------- 

983For *ITU-R BT.2100*, only the inverse electro-optical transfer functions 

984(EOTFs) are exposed by this definition, See the :func:`colour.oetf` 

985definition for the opto-electronic transfer functions (OETF). 

986""" 

987 

988 

989def cctf_encoding( 

990 value: ArrayLike, function: LiteralCCTFEncoding | str = "sRGB", **kwargs: Any 

991) -> NDArrayFloat | NDArrayInt: 

992 """ 

993 Apply the specified encoding colour component transfer function (Encoding 

994 CCTF). 

995 

996 Parameters 

997 ---------- 

998 value 

999 Linear RGB value. 

1000 function 

1001 Encoding colour component transfer function. 

1002 

1003 Other Parameters 

1004 ---------------- 

1005 kwargs 

1006 Keywords arguments for the relevant encoding *CCTF* of the 

1007 :attr:`colour.CCTF_ENCODINGS` attribute collection. 

1008 

1009 Warnings 

1010 -------- 

1011 For *ITU-R BT.2100*, only the inverse electro-optical transfer functions 

1012 (EOTFs) are exposed by this definition, See the :func:`colour.oetf` 

1013 definition for the opto-electronic transfer functions (OETF). 

1014 

1015 Returns 

1016 ------- 

1017 :class:`numpy.ndarray` 

1018 Non-linear RGB value. 

1019 

1020 Examples 

1021 -------- 

1022 >>> cctf_encoding(0.18, function="PLog", log_reference=400) 

1023 ... # doctest: +ELLIPSIS 

1024 0.3910068... 

1025 >>> cctf_encoding(0.18, function="ST 2084", L_p=1000) 

1026 ... # doctest: +ELLIPSIS 

1027 0.1820115... 

1028 >>> cctf_encoding( # doctest: +ELLIPSIS 

1029 ... 0.11699185725296059, function="ITU-R BT.1886" 

1030 ... ) 

1031 0.4090077... 

1032 """ 

1033 

1034 function = validate_method( 

1035 function, 

1036 tuple(CCTF_ENCODINGS), 

1037 '"{0}" encoding "CCTF" is invalid, it must be one of {1}!', 

1038 ) 

1039 

1040 if "itu-r bt.2100" in function: 

1041 usage_warning( 

1042 'With the "ITU-R BT.2100" method, only the inverse ' 

1043 "electro-optical transfer functions (EOTFs / EOCFs) are exposed " 

1044 'by this definition, See the "colour.oetf" definition ' 

1045 "for the opto-electronic transfer functions (OETF)." 

1046 ) 

1047 

1048 callable_ = CCTF_ENCODINGS[function] 

1049 

1050 return callable_(value, **filter_kwargs(callable_, **kwargs)) 

1051 

1052 

1053CCTF_DECODINGS: CanonicalMapping = CanonicalMapping( 

1054 { 

1055 "Gamma 2.2": partial(gamma_function, exponent=2.2), 

1056 "Gamma 2.4": partial(gamma_function, exponent=2.4), 

1057 "Gamma 2.6": partial(gamma_function, exponent=2.6), 

1058 "ProPhoto RGB": cctf_decoding_ProPhotoRGB, 

1059 "RIMM RGB": cctf_decoding_RIMMRGB, 

1060 "ROMM RGB": cctf_decoding_ROMMRGB, 

1061 } 

1062) 

1063CCTF_DECODINGS.update(LOG_DECODINGS) 

1064CCTF_DECODINGS.update(OETF_INVERSES) 

1065CCTF_DECODINGS.update(EOTFS) 

1066CCTF_DECODINGS.__doc__ = """ 

1067Supported decoding colour component transfer functions (decoding CCTFs), a 

1068collection comprising functions from :attr:`colour.LOG_DECODINGS`, 

1069:attr:`colour.OETF_INVERSES`, :attr:`colour.EOTFS`, 

1070:func:`colour.models.cctf_decoding_ProPhotoRGB`, 

1071:func:`colour.models.cctf_decoding_RIMMRGB`, 

1072:func:`colour.models.cctf_decoding_ROMMRGB`, and three gamma decoding 

1073functions (2.2, 2.4, 2.6). 

1074 

1075Warnings 

1076-------- 

1077For *ITU-R BT.2100*, only the electro-optical transfer functions 

1078(EOTFs) are exposed by this attribute. See :attr:`colour.OETF_INVERSES` 

1079for the inverse opto-electronic transfer functions (OETFs). 

1080""" 

1081 

1082 

1083def cctf_decoding( 

1084 value: ArrayLike, 

1085 function: LiteralCCTFDecoding | str = "sRGB", 

1086 **kwargs: Any, 

1087) -> NDArrayFloat: 

1088 """ 

1089 Apply the specified decoding colour component transfer function (Decoding 

1090 CCTF). 

1091 

1092 Parameters 

1093 ---------- 

1094 value 

1095 Non-linear RGB value. 

1096 function 

1097 Decoding colour component transfer function. 

1098 

1099 Other Parameters 

1100 ---------------- 

1101 kwargs 

1102 Keywords arguments for the relevant decoding *CCTF* of the 

1103 :attr:`colour.CCTF_DECODINGS` attribute collection. 

1104 

1105 Warnings 

1106 -------- 

1107 For *ITU-R BT.2100*, only the electro-optical transfer functions 

1108 (EOTFs) are exposed by this attribute. See :attr:`colour.OETF_INVERSES` 

1109 for the inverse opto-electronic transfer functions (OETFs). 

1110 

1111 Returns 

1112 ------- 

1113 :class:`numpy.ndarray`