diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index adc2413ada..7af778fd14 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -20,8 +20,8 @@ is available to guide the process: https://www.colour-science.org/contributing/. - [ ] New transformations have been added to the _Automatic Colour Conversion Graph_. - [ ] New transformations have been exported to the relevant namespaces, e.g. `colour`, `colour.models`. - - + + **Documentation** diff --git a/.github/workflows/continuous-integration-documentation.yml b/.github/workflows/continuous-integration-documentation.yml index 6e9f0d8178..706ed17fa0 100644 --- a/.github/workflows/continuous-integration-documentation.yml +++ b/.github/workflows/continuous-integration-documentation.yml @@ -7,12 +7,12 @@ jobs: name: ${{ matrix.os }} - Python ${{ matrix.python-version }} strategy: matrix: - os: [ubuntu-22.04] + os: [ubuntu-latest] python-version: [3.11] fail-fast: false runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v4 - name: Environment Variables run: | echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV @@ -22,31 +22,27 @@ jobs: echo "COLOUR_SCIENCE__DOCUMENTATION_BUILD=True" >> $GITHUB_ENV shell: bash - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - name: Install Dependencies run: | sudo apt-get update sudo apt-get --yes install graphviz graphviz-dev latexmk texlive-full - - name: Install Poetry - env: - POETRY_VERSION: 1.4.0 + - name: Install uv run: | - curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 - - echo "$HOME/.poetry/bin" >> $GITHUB_PATH + pip install uv shell: bash - name: Install Package Dependencies run: | - poetry run python -m pip install --upgrade pip - poetry install - poetry run python -c "import imageio;imageio.plugins.freeimage.download()" + uv sync --all-extras --no-dev + uv run python -c "import imageio;imageio.plugins.freeimage.download()" shell: bash - name: Build Documentation run: | - poetry run invoke docs + uv run invoke docs shell: bash - - uses: actions/upload-artifact@v2 + - uses: actions/upload-artifact@v4 with: name: ${{ env.CI_PACKAGE }}-plots path: | diff --git a/.github/workflows/continuous-integration-quality-unit-tests.yml b/.github/workflows/continuous-integration-quality-unit-tests.yml index 35ecdfe0c8..81772e281e 100644 --- a/.github/workflows/continuous-integration-quality-unit-tests.yml +++ b/.github/workflows/continuous-integration-quality-unit-tests.yml @@ -7,12 +7,12 @@ jobs: name: ${{ matrix.os }} - Python ${{ matrix.python-version }} strategy: matrix: - os: [macOS-latest, ubuntu-22.04, windows-latest] - python-version: [3.9, "3.10", 3.11, 3.12] + os: [macOS-latest, ubuntu-latest, windows-latest] + python-version: ["3.10", 3.11, 3.12, 3.13] fail-fast: false runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v4 - name: Environment Variables run: | echo "CI_PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV @@ -20,62 +20,58 @@ jobs: echo "CI_SHA=${{ github.sha }}" >> $GITHUB_ENV echo "COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_REPO_TOKEN }}" >> $GITHUB_ENV echo "MPLBACKEND=AGG" >> $GITHUB_ENV + # https://github.com/scipy/scipy/issues/20613 + echo "OMP_NUM_THREADS=1" >> $GITHUB_ENV shell: bash - - name: Set up Python 3.9 for Pre-Commit - uses: actions/setup-python@v4 + - name: Set up Python 3.10 for Pre-Commit + uses: actions/setup-python@v5 with: - python-version: 3.9 + python-version: "3.10" - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + - name: Install Dependencies (macOS) + if: matrix.os == 'macOS-latest' + run: | + brew install freeimage + # TODO: Drop when https://github.com/imageio/imageio/issues/628 is addressed + echo "IMAGEIO_FREEIMAGE_LIB=/opt/homebrew/Cellar/freeimage/3.18.0/lib/libfreeimage.3.18.0.dylib" >> $GITHUB_ENV - name: Install Dependencies (Ubuntu) - if: matrix.os == 'ubuntu-22.04' + if: matrix.os == 'ubuntu-latest' run: | sudo apt-get update - sudo apt-get --yes install graphviz graphviz-dev libboost-all-dev libilmbase-dev libopenexr-dev libpng-dev libtiff5-dev - - name: Install Poetry - env: - POETRY_VERSION: 1.4.0 - run: | - curl -sSL https://install.python-poetry.org | POETRY_HOME=$HOME/.poetry python3 - - echo "$HOME/.poetry/bin" >> $GITHUB_PATH - shell: bash - - name: Install Package Dependencies (Ubuntu) - if: matrix.os == 'ubuntu-22.04' + sudo apt-get --yes install graphviz graphviz-dev + - name: Install uv run: | - poetry run python -m pip install --upgrade pip - poetry install - poetry run python -c "import imageio;imageio.plugins.freeimage.download()" + pip install uv shell: bash - - name: Install Package Dependencies (macOS & Windows) - if: matrix.os == 'macOS-latest' || matrix.os == 'windows-latest' + - name: Install Package Dependencies run: | - poetry run python -m pip install --upgrade pip - poetry install --without graphviz - poetry run python -c "import imageio;imageio.plugins.freeimage.download()" + uv sync --all-extras --no-dev + uv run python -c "import imageio;imageio.plugins.freeimage.download()" shell: bash - name: Install OpenImageIO (macOs) - if: matrix.os == 'macOS-latest' && matrix.python-version == '3.11' + if: matrix.os == 'macOS-latest' && matrix.python-version == '3.12' run: | brew install openimageio - ls /usr/local/Cellar/openimageio/*/lib/python*/site-packages/OpenImageIO/ - ln -s /usr/local/Cellar/openimageio/*/lib/python*/site-packages/OpenImageIO/OpenImageIO*.so /Library/Frameworks/Python.framework/Versions/${{ matrix.python-version }}/lib/python${{ matrix.python-version }}/site-packages/OpenImageIO.so + ln -s /opt/homebrew/Cellar/openimageio/*/lib/python*/site-packages/OpenImageIO/OpenImageIO*.so ./.venv/lib/python3.12/site-packages/OpenImageIO.so + uv run python -c "import OpenImageIO;print(OpenImageIO.__version__)" shell: bash - name: Pre-Commit (All Files) run: | - poetry run pre-commit run --all-files + uv run pre-commit run --all-files shell: bash - name: Test Optimised Python Execution run: | - poetry run python -OO -c "import $CI_PACKAGE" + uv run python -OO -c "import $CI_PACKAGE" shell: bash - name: Test with Pytest run: | - poetry run python -W ignore -m pytest --doctest-modules --ignore=$CI_PACKAGE/examples --cov=$CI_PACKAGE $CI_PACKAGE + uv run python -W ignore -m pytest --doctest-modules --ignore=$CI_PACKAGE/examples --cov=$CI_PACKAGE $CI_PACKAGE shell: bash - name: Upload Coverage to coveralls.io - if: matrix.os == 'macOS-latest' && matrix.python-version == '3.11' + if: matrix.os == 'macOS-latest' && matrix.python-version == '3.12' run: | - if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo \"COVERALLS_REPO_TOKEN\" secret is undefined!; else poetry run coveralls; fi + if [ -z "$COVERALLS_REPO_TOKEN" ]; then echo \"COVERALLS_REPO_TOKEN\" secret is undefined!; else uv run coveralls; fi shell: bash diff --git a/.github/workflows/continuous-integration-static-type-checking.yml b/.github/workflows/continuous-integration-static-type-checking.yml index 9fcc2a16de..295179ed3c 100644 --- a/.github/workflows/continuous-integration-static-type-checking.yml +++ b/.github/workflows/continuous-integration-static-type-checking.yml @@ -8,28 +8,29 @@ jobs: strategy: matrix: os: [macOS-latest] - python-version: [3.11] + python-version: [3.13] fail-fast: false runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v4 - name: Environment Variables run: | echo "CI_PACKAGE=colour" >> $GITHUB_ENV shell: bash - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - name: Install Dependencies (macOS) if: matrix.os == 'macOS-latest' run: | - brew install graphviz - export GRAPHVIZ_DIR="/usr/local/Cellar/graphviz/" - pip install pygraphviz --global-option=build_ext --global-option="-I$GRAPHVIZ_DIR/include" --global-option="-L$GRAPHVIZ_DIR/lib" + brew install freeimage graphviz + pip install --no-cache-dir --config-settings="--global-option=build_ext" --config-settings="--global-option=-I$(brew --prefix graphviz)/include/" --config-settings="--global-option=-L$(brew --prefix graphviz)/lib/" pygraphviz + # TODO: Drop when https://github.com/imageio/imageio/issues/628 is addressed + echo "IMAGEIO_FREEIMAGE_LIB=/opt/homebrew/Cellar/freeimage/3.18.0/lib/libfreeimage.3.18.0.dylib" >> $GITHUB_ENV - name: Install Package Dependencies run: | - pip install -r requirements.txt + cat requirements.txt | grep -Eo '(^[^#]+)' | xargs -n 1 pip install || true - name: Static Type Checking run: | - pyright --skipunannotated + pyright --threads --skipunannotated diff --git a/.gitignore b/.gitignore index 360e0ee3c7..6ea4c9488f 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,7 @@ .fleet .idea .ipynb_checkpoints +.python-version .vs .vscode .sandbox @@ -20,5 +21,5 @@ docs/_static/Examples_*.png docs/_static/Plotting_*.png docs/_static/Tutorial_*.png docs/generated -poetry.lock references +uv.lock diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index bf8cbc0bcf..354f8a58ea 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -27,23 +27,19 @@ repos: - id: flynt args: [--verbose] - repo: https://github.com/PyCQA/isort - rev: "5.12.0" + rev: "5.13.2" hooks: - id: isort - repo: https://github.com/astral-sh/ruff-pre-commit - rev: "v0.1.6" + rev: "v0.1.14" hooks: + - id: ruff-format - id: ruff - - repo: https://github.com/psf/black-pre-commit-mirror - rev: 23.11.0 - hooks: - - id: black - language_version: python3.9 - repo: https://github.com/adamchainz/blacken-docs rev: 1.16.0 hooks: - id: blacken-docs - language_version: python3.9 + language_version: python3.10 - repo: https://github.com/pre-commit/mirrors-prettier rev: "v3.1.0" hooks: diff --git a/BIBLIOGRAPHY.bib b/BIBLIOGRAPHY.bib index fab24e24b2..12b86647be 100644 --- a/BIBLIOGRAPHY.bib +++ b/BIBLIOGRAPHY.bib @@ -9,7 +9,7 @@ @book{ANSI2018 {{Evaluating Light Source Color Rendition}}}, author = {{ANSI} and {IES Color Committee}}, year = 2018, - publisher = {{ANSI/IES}}, + publisher = {ANSI/IES}, isbn = {978-0-87995-379-9}, annotation = {thomas.mansencal@gmail.com}, } @@ -90,10 +90,10 @@ @article{Abebe2017 pages = {1--19}, issn = 15443558, doi = {10.1145/3086577}, - abstract = {{\textcopyright} 2017 ACM. The human visual system - (HVS) non-linearly processes light from the real world, allowing - us to perceive detail over a wide range of illumination. Although - models that describe this non-linearity are constructed based on + abstract = {{\copyright} 2017 ACM. The human visual system (HVS) + non-linearly processes light from the real world, allowing us to + perceive detail over a wide range of illumination. Although models + that describe this non-linearity are constructed based on psycho-visual experiments, they generally apply to a limited range of illumination and therefore may not fully explain the behavior of theHVS under more extreme illumination conditions. We propose a @@ -173,7 +173,7 @@ @book{Barten1999 year = 1999, month = dec, number = 1999, - publisher = {{SPIE}}, + publisher = {SPIE}, issn = 10924388, doi = {10.1117/3.353254}, isbn = {978-0-8194-7849-8}, @@ -369,7 +369,7 @@ @misc{Broadbent2009a author = {Broadbent, A. D.}, year = 2009, journal = {Qu{\'e}bec, Canada: D{\'e}partement de g{\'e}nie - chimique, {\ldots}}, + chimique, {\dots}}, pages = {1--17}, urldate = {2014-06-12}, abstract = {This paper describes all the steps in the @@ -391,8 +391,8 @@ @book{Burger2009b title = {Principles of {{Digital Image Processing}}}, author = {Burger, Wilhelm and Burge, Mark James}, year = 2009, - publisher = {{Springer London}}, - address = {{London}}, + publisher = {Springer London}, + address = {London}, doi = {10.1007/978-1-84800-195-4}, isbn = {978-1-84800-194-7}, } @@ -401,7 +401,7 @@ @book{CIEDivision12022 Appearance Model}} for {{Colour Management Systems}}: {{CIECAM16}}}, author = {{CIE Division 1} and {CIE Division 8}}, year = 2022, - publisher = {{Commission Internationale de l'Eclairage}}, + publisher = {Commission Internationale de l'Eclairage}, isbn = {978-3-902842-94-7}, } @book{CIETC1-321994b, @@ -410,7 +410,7 @@ @book{CIETC1-321994b {{Illuminance Adaptations}}}, author = {{CIE TC 1-32}}, year = 1994, - publisher = {{Commission Internationale de l'Eclairage}}, + publisher = {Commission Internationale de l'Eclairage}, isbn = {978-3-900734-51-0}, } @book{CIETC1-362006a, @@ -418,7 +418,7 @@ @book{CIETC1-362006a Diagram}} with {{Physiological Axes}} - {{Part}} 1}, author = {{CIE TC 1-36}}, year = 2006, - publisher = {{Commission Internationale de l'Eclairage}}, + publisher = {Commission Internationale de l'Eclairage}, isbn = {978-3-901906-46-6}, } @incollection{CIETC1-382005e, @@ -476,7 +476,7 @@ @book{CIETC1-482004h author = {{CIE TC 1-48}}, year = 2004, journal = {CIE 015:2004 Colorimetry, 3rd Edition}, - publisher = {{Commission Internationale de l'Eclairage}}, + publisher = {Commission Internationale de l'Eclairage}, isbn = {978-3-901906-33-6}, } @incollection{CIETC1-482004i, @@ -545,8 +545,8 @@ @book{CIETC1-902017 year = 2017, series = {{Technical report / CIE}}, number = 224, - publisher = {{CIE Central Bureau}}, - address = {{Vienna}}, + publisher = {CIE Central Bureau}, + address = {Vienna}, isbn = {978-3-902842-61-9}, langid = {eng fre ger}, annotation = {OCLC: 988568299}, @@ -682,8 +682,8 @@ @techreport{Carter2018 J.H.}, year = 2018, month = oct, - address = {{Vienna}}, - institution = {{International Commission on Illumination}}, + address = {Vienna}, + institution = {International Commission on Illumination}, doi = {10.25039/TR.015.2018}, isbn = 9783902842138, } @@ -900,12 +900,10 @@ @article{Cui2002 CIE94 colour-difference formulas and only slightly worse than CIEDE2000 (which was optimized on the experimental data). However, these formulas all have an associated UCS. The spaces are similar - in form to L*a*b*. {\textcopyright} 2002 Wiley Periodicals, Inc. - Col Res Appl, 27, 282{\textendash}290, 2002; Published online in - Wiley InterScience (www.interscience.wiley.com). DOI - 10.1002/col.10066}, - copyright = {Copyright {\textcopyright} 2002 Wiley Periodicals, - Inc.}, + in form to L*a*b*. {\copyright} 2002 Wiley Periodicals, Inc. Col + Res Appl, 27, 282--290, 2002; Published online in Wiley + InterScience (www.interscience.wiley.com). DOI 10.1002/col.10066}, + copyright = {Copyright {\copyright} 2002 Wiley Periodicals, Inc.}, langid = {english}, keywords = {colour discrimination ellipses,colour-difference metrics,uniform colour space}, @@ -980,15 +978,15 @@ @article{Davis2010a doi = {10.1117/1.3360335}, abstract = {The color rendering index (CRI) has been shown to have deficiencies when applied to white - light-emitting-diode{\textendash}based sources. Furthermore, - evidence suggests that the restricted scope of the CRI - unnecessarily penalizes some light sources with desirable color - qualities. To solve the problems of the CRI and include other - dimensions of color quality, the color quality scale (CQS) has - been developed. Although the CQS uses many of elements of the CRI, - there are a number of fundamental differences. Like the CRI, the - CQS is a test-samples method that compares the appearance of a set - of reflective samples when illuminated by the test lamp to their + light-emitting-diode--based sources. Furthermore, evidence + suggests that the restricted scope of the CRI unnecessarily + penalizes some light sources with desirable color qualities. To + solve the problems of the CRI and include other dimensions of + color quality, the color quality scale (CQS) has been developed. + Although the CQS uses many of elements of the CRI, there are a + number of fundamental differences. Like the CRI, the CQS is a + test-samples method that compares the appearance of a set of + reflective samples when illuminated by the test lamp to their appearance under a reference illuminant. The CQS uses a larger set of reflective samples, all of high chroma, and combines the color differences of the samples with a root mean square. Additionally, @@ -1215,7 +1213,7 @@ @incollection{Fairchild2004c year = 2004, edition = 2, pages = {289--301}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-470-01216-1}, } @inproceedings{Fairchild2010, @@ -1251,7 +1249,7 @@ @incollection{Fairchild2013ba year = 2013, edition = 3, pages = {4810--5085}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {B00DAYO8E2}, } @incollection{Fairchild2013s, @@ -1261,7 +1259,7 @@ @incollection{Fairchild2013s year = 2013, edition = 3, pages = {4418--4495}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {B00DAYO8E2}, } @incollection{Fairchild2013t, @@ -1271,7 +1269,7 @@ @incollection{Fairchild2013t year = 2013, edition = 3, pages = {4179--4252}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {B00DAYO8E2}, } @incollection{Fairchild2013u, @@ -1281,7 +1279,7 @@ @incollection{Fairchild2013u year = 2013, edition = 3, pages = {5094--5556}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {B00DAYO8E2}, } @incollection{Fairchild2013v, @@ -1291,7 +1289,7 @@ @incollection{Fairchild2013v year = 2013, edition = 3, pages = {5852--5991}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {B00DAYO8E2}, } @incollection{Fairchild2013w, @@ -1301,7 +1299,7 @@ @incollection{Fairchild2013w year = 2013, edition = 3, pages = {5563--5824}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {B00DAYO8E2}, } @incollection{Fairchild2013x, @@ -1311,7 +1309,7 @@ @incollection{Fairchild2013x year = 2013, edition = 3, pages = {6025--6178}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {B00DAYO8E2}, } @incollection{Fairchild2013y, @@ -1321,7 +1319,7 @@ @incollection{Fairchild2013y year = 2013, edition = 3, pages = {6197--6223}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {B00DAYO8E2}, } @article{Fairchild2020, @@ -1399,6 +1397,22 @@ @misc{FiLMiCInc2017 year = 2017, pages = {1--46}, } +@article{Fichet2021, + title = {An {{OpenEXR Layout}} for {{Spectral Images}}}, + author = {Fichet, A and Pacanowski, R and Wilkie, A}, + year = 2021, + volume = 10, + number = 3, + urldate = {2024-04-26}, + abstract = {We propose a standardized layout to organize + spectral data stored in OpenEXR images. We motivate why we chose + the OpenEXR format as the basis for our work, and we explain our + choices with regard to data selection and organization: our goal + is to define a standard for the exchange of measured or simulated + spectral and bi-spectral data. We also provide sample code to + store spectral images in OpenEXR format.}, + langid = {english}, +} @article{Finlayson2015, title = {Color {{Correction Using Root-Polynomial Regression}}}, @@ -1414,18 +1428,18 @@ @article{Finlayson2015 doi = {10.1109/TIP.2015.2405336}, abstract = {Cameras record three color responses (RGB) which are device dependent. Camera coordinates are mapped to a standard - color space, such as XYZ{\textemdash}useful for color - measurement{\textemdash}by amapping function, e.g., the simple - 3{\texttimes}3 linear transform (usually derived through - regression). This mapping, which we will refer to as linear color - correction (LCC), has been demonstrated to work well in the number - of studies. However, it can map RGBs to XYZs with high error. The - advantage of the LCC is that it is independent of camera exposure. - An alternative and potentially more powerful method for color - correction is polynomial color correction (PCC). Here, the R, - G,and B values at a pixel are extended by the polynomial terms. - For a given calibration training set PCC can significantly reduce - the colorimetric error. However, the PCC fit depends on exposure, + color space, such as XYZ---useful for color measurement---by + amapping function, e.g., the simple 3{\texttimes}3 linear + transform (usually derived through regression). This mapping, + which we will refer to as linear color correction (LCC), has been + demonstrated to work well in the number of studies. However, it + can map RGBs to XYZs with high error. The advantage of the LCC is + that it is independent of camera exposure. An alternative and + potentially more powerful method for color correction is + polynomial color correction (PCC). Here, the R, G,and B values at + a pixel are extended by the polynomial terms. For a given + calibration training set PCC can significantly reduce the + colorimetric error. However, the PCC fit depends on exposure, i.e., as exposure changes the vector of polynomial components is altered in a nonlinear way which results in hue and saturation shifts. This paper proposes a new polynomial-type regression @@ -1450,7 +1464,7 @@ @misc{Frohlich2017 Imagery}, author = {Fr{\"o}hlich, Jan}, year = 2017, - publisher = {{Universit{\"a}t Stuttgart}}, + publisher = {Universit{\"a}t Stuttgart}, urldate = {2021-08-07}, abstract = {In dieser Dissertation wird ein szenischer Bewegtbilddatensatz mit erweitertem Dynamikumfang (High Dynamic @@ -1552,7 +1566,7 @@ @article{Glasser1958a volume = 48, number = 10, pages = 736, - publisher = {{OSA}}, + publisher = {OSA}, issn = {0030-3941}, doi = {10.1364/JOSA.48.000736}, abstract = {A visually uniform color coordinate system, based @@ -1620,8 +1634,8 @@ @inproceedings{Hanbury2003 editor = {Bigun, Josef and Gustavsson, Tomas}, year = 2003, pages = {804--811}, - publisher = {{Springer Berlin Heidelberg}}, - address = {{Berlin, Heidelberg}}, + publisher = {Springer Berlin Heidelberg}, + address = {Berlin, Heidelberg}, abstract = {Representations of the RGB space in terms of 3D-polar coordinates (hue, saturation and brightness) are often used in image analysis. The literature describes a large number of @@ -1686,7 +1700,7 @@ @article{Hellwig2022 } @article{Hellwig2022a, title = {Extending {{CIECAM02}} and {{CAM16}} for the - {{Helmholtz}}{\textendash}{{Kohlrausch}} Effect}, + {{Helmholtz}}--{{Kohlrausch}} Effect}, shorttitle = {Extending}, author = {Hellwig, Luke and Stolitzka, Dale and Fairchild, Mark D.}, @@ -1710,8 +1724,8 @@ @article{Hernandez-Andres1999a volume = 38, number = 27, pages = 5703, - publisher = {{Departamento de Optica, Facultad de Ciencias, - Universidad de Granada, Granada 18071, Spain.}}, + publisher = {Departamento de Optica, Facultad de Ciencias, + Universidad de Granada, Granada 18071, Spain.}, issn = {0003-6935}, doi = {10.1364/AO.38.005703}, abstract = {Natural outdoor illumination daily undergoes large @@ -1779,8 +1793,8 @@ @book{Hunt2004b year = 2004, month = sep, edition = 6, - publisher = {{John Wiley \& Sons, Ltd}}, - address = {{Chichester, UK}}, + publisher = {John Wiley \& Sons, Ltd}, + address = {Chichester, UK}, doi = {10.1002/0470024275}, isbn = {978-0-470-02427-0}, keywords = {calanus finmarchicus,egg production,gonad @@ -1828,7 +1842,7 @@ @book{IESComputerCommittee2014a author = {{IES Computer Committee} and {TM-27-14 Working Group}}, year = 2014, - publisher = {{Illuminating Engineering Society}}, + publisher = {Illuminating Engineering Society}, isbn = {978-0-87995-295-2}, } @misc{ImageEngineering2017, @@ -2012,7 +2026,7 @@ @inproceedings{Jiang2013 year = 2013, month = jan, pages = {168--179}, - publisher = {{IEEE}}, + publisher = {IEEE}, issn = 21583978, doi = {10.1109/WACV.2013.6475015}, abstract = {Camera spectral sensitivity functions relate scene @@ -2131,8 +2145,8 @@ @article{Konovalenko2021 to perform linear colour analysis.}, archiveprefix = {arxiv}, langid = {english}, - keywords = {⛔ No DOI found,Computer Science - Computer Vision - and Pattern Recognition}, + keywords = {Computer Science - Computer Vision and Pattern + Recognition,No DOI found}, } @misc{Konovalenko2021a, title = {{{proLab}}\_param.m}, @@ -2148,7 +2162,7 @@ @article{Krystek1985b volume = 10, number = 1, pages = {38--40}, - publisher = {{Wiley Subscription Services, Inc., A Wiley Company}}, + publisher = {Wiley Subscription Services, Inc., A Wiley Company}, issn = 03612317, doi = {10.1002/col.5080100109}, } @@ -2300,23 +2314,23 @@ @article{Lu2016c pages = {32--38}, abstract = {High Dynamic Range (HDR) and Wider Colour Gamut (WCG) content represents a greater range of luminance levels and a - more complete reproduction of colours found in - real{$\hyphenbullet$}world scenes. The current video distribution - environments deliver Standard Dynamic Range (SDR) signal - Y{${'}$}CbCr. For HDR and WCG content, it is desirable to examine - if such signal format still works well for compression, and to - know if the overall system performance can be further improved by - exploring different signal formats. In this paper, ITP (ICTCP) - colour space is presented. The paper concentrates on examining the - two aspects of ITP colour space: 1) ITP characteristics in terms - of signal quantization at a given bit depth; 2) ITP compression - performance. The analysis and simulation results show that ITP 10 - bit has better properties than Y{${'}$}CbCr{$\hyphenbullet$}PQ - 10bit in colour quantization, constant luminance, hue property and - chroma subsampling, and it also has good compression efficiency. - Therefore it is desirable to adopt ITP colour space as a new - signal format for HDR/WCG video compression.}, - keywords = {HDR,ICT CP,ITP,WCG,Y{${'}$}CbCr}, + more complete reproduction of colours found in real⁃world scenes. + The current video distribution environments deliver Standard + Dynamic Range (SDR) signal Y{$\prime$}CbCr. For HDR and WCG + content, it is desirable to examine if such signal format still + works well for compression, and to know if the overall system + performance can be further improved by exploring different signal + formats. In this paper, ITP (ICTCP) colour space is presented. The + paper concentrates on examining the two aspects of ITP colour + space: 1) ITP characteristics in terms of signal quantization at a + given bit depth; 2) ITP compression performance. The analysis and + simulation results show that ITP 10 bit has better properties than + Y{$\prime$}CbCr⁃PQ 10bit in colour quantization, constant + luminance, hue property and chroma subsampling, and it also has + good compression efficiency. Therefore it is desirable to adopt + ITP colour space as a new signal format for HDR/WCG video + compression.}, + keywords = {HDR,ICT CP,ITP,WCG,Y'CbCr}, } @article{Luo1996b, title = {The {{LLAB}} (l:C) Colour Model}, @@ -2327,7 +2341,7 @@ @article{Luo1996b volume = 21, number = 6, pages = {412--429}, - publisher = {{Wiley Subscription Services, Inc., A Wiley Company}}, + publisher = {Wiley Subscription Services, Inc., A Wiley Company}, issn = {0361-2317}, doi = {10.1002/(SICI)1520-6378(199612)21:6<412::AID-COL4>3.0.CO;2-Z}, abstract = {A new colour model, named LLAB(l:c) is derived. It @@ -2350,7 +2364,7 @@ @article{Luo1996b constancy, and quantification of colour-rendering properties. The model does not give predictions for chroma (as distinct from colourfulness), or for brightness, and it does not include any rod - response. {\textcopyright} 1996 John Wiley \& Sons, Inc.}, + response. {\copyright} 1996 John Wiley \& Sons, Inc.}, keywords = {chromatic adaptation transform,colour appearance,colour appearance model,colour difference,colour difference formula,corresponding colours,uniform colour space}, @@ -2359,8 +2373,8 @@ @inproceedings{Luo1996c title = {Two {{Unsolved Issues}} in {{Colour Management}} - {{Colour Appearance}} and {{Gamut Mapping}}}, booktitle = {Conference: 5th {{International Conference}} on - {{High Technology}}: {{Imaging Science}} and {{Technology}} - {\textendash} {{Evolution}} \& {{Promise}}}, + {{High Technology}}: {{Imaging Science}} and {{Technology}} -- + {{Evolution}} \& {{Promise}}}, author = {Luo, Ming Ronnier and Morovic, J{\'a}n}, year = 1996, pages = {136--147}, @@ -2444,8 +2458,8 @@ @incollection{Luo2013 editor = {{Fernandez-Maloigne}, Christine}, year = 2013, pages = {19--58}, - publisher = {{Springer New York}}, - address = {{New York, NY}}, + publisher = {Springer New York}, + address = {New York, NY}, doi = {10.1007/978-1-4419-6190-7}, urldate = {2014-09-27}, isbn = {978-1-4419-6189-1}, @@ -2453,6 +2467,32 @@ @incollection{Luo2013 model,colour appearance attributes,tation transforms,uniform colour spaces,visual phenomena}, } +@article{Luo2024, + title = {The New Preferred Memory Color ( {{{\textsc{PMC}}}} + ) Chart}, + shorttitle = {The New Preferred Memory Color (}, + author = {Luo, Ming Ronnier}, + year = 2024, + month = may, + journal = {Color Research \& Application}, + pages = {col.22940}, + issn = {0361-2317, 1520-6378}, + doi = {10.1002/col.22940}, + urldate = {2024-05-28}, + abstract = {Abstract A color rendition chart, the preferred + memory color (PMC) chart, has been produced. It comprises 30 + colored patches, divided into three groups: preferred memory + colors, reference color-gamut colors, and a gray scale. The main + purpose of the new chart is to enable users to produce + satisfactory preferred color reproduction using digital cameras, + displays, and printing systems. The methods used to develop the + various colors, and the color specification of each color are + presented. Finally, several potential applications of the chart + for the characterization of imaging devices, for the evaluation of + image color quality, and for the calculation of color rendering + indices for lighting are suggested.}, + langid = {english}, +} @article{MacAdam1935a, title = {Maximum {{Visual Efficiency}} of {{Colored Materials}}}, @@ -2463,7 +2503,7 @@ @article{MacAdam1935a volume = 25, number = 11, pages = {361--367}, - publisher = {{OSA}}, + publisher = {OSA}, doi = {10.1364/JOSA.25.000361}, abstract = {Tristimulus values have been computed for hypothetical spectrophotometric curves of the type found to give @@ -2580,7 +2620,7 @@ @article{Mallett2019 journal = {Eurographics Symposium on Rendering - DL-only and Industry Track}, pages = {7 pages}, - publisher = {{The Eurographics Association}}, + publisher = {The Eurographics Association}, issn = {1727-3463}, doi = {10.2312/SR.20191216}, urldate = {2020-08-08}, @@ -2705,7 +2745,7 @@ @article{Mokrzycki2011 popular colors spaces, as both linear and nonlinear due to perceptual abilities, and are briefly discussed and compared to the sample values.}, - keywords = {⛔ No DOI found}, + keywords = {No DOI found}, } @article{Moroney2003, title = {A {{Radial Sampling}} of the {{OSA Uniform Color @@ -2735,7 +2775,7 @@ @article{Moroney2003 parent_itemid = {infobike://ist/cic}, publication_date = {2003-01-01T00:00:00}, publishercode = {ist}, - keywords = {⛔ No DOI found}, + keywords = {No DOI found}, } @article{Moroneya, title = {The {{CIECAM02}} Color Appearance Model}, @@ -2777,7 +2817,7 @@ @article{Morovic2000 Descriptor obtained using the Segment Maxima Method. Throughout the article, the focus is both on colour reproduction media and colour images as well as on the suitability of the methods for use - in gamut mapping. {\textcopyright} 2000 John Wiley \& Sons. Inc.}, + in gamut mapping. {\copyright} 2000 John Wiley \& Sons. Inc.}, keywords = {Cross-media reproduction,Gamut boundary calculation,Gamut mapping}, } @@ -2814,7 +2854,7 @@ @article{Nayatani1995a volume = 20, number = 3, pages = {156--167}, - publisher = {{Wiley Subscription Services, Inc., A Wiley Company}}, + publisher = {Wiley Subscription Services, Inc., A Wiley Company}, issn = 03612317, doi = {10.1002/col.5080200305}, keywords = {color-vision model,lightness dependency of @@ -2822,7 +2862,7 @@ @article{Nayatani1995a } @article{Nayatani1997, title = {Simple Estimation Methods for the - {{Helmholtz}}{\textemdash}{{Kohlrausch}} Effect}, + {{Helmholtz}}---{{Kohlrausch}} Effect}, author = {Nayatani, Yoshinobu}, year = 1997, journal = {Color Research \& Application}, @@ -2833,32 +2873,29 @@ @article{Nayatani1997 doi = {10.1002/(SICI)1520-6378(199712)22:6<385::AID-COL6>3.0.CO;2-R}, urldate = {2021-06-22}, abstract = {Four kinds of simple estimation equations are - proposed for the Helmholtz{\textemdash}Kohlrausch effect. Two of - them can be used for luminous colors, and the other two for object - colors. In each of luminous and object colors, the two estimation - equations are given to each of the Variable-Achromatic-Color (VAC) - and the Variable-Chromatic-Color (VCC) methods. All the equations - are similar in type to the Ware{\textemdash}Cowan equation. They - give the ratio between luminance (or metric lightness) of test - color stimulus and its equivalent luminance (or equivalent - lightness) directly. Though their computations are simple, they - can apply to various H{\textemdash}K effects including their - adapting luminance dependency. The applicable fields of the - proposed equations are wider than those of the - Ware{\textemdash}Cowan equation. The proposed equations can be - applied to predict the H{\textemdash}K effect within the whole - chromaticity gamut including spectral colors, spectral luminosity - functions based on direct color matching from 0.01 Td to 100 000 - Td using the photopic and the scotopic spectral luminosity - functions specified by CIE, equivalent lightness values of NCS - colors, and others. {\textcopyright} 1997 John Wiley \& Sons, Inc. - Col Res Appl. 22, 385{\textendash}401, 1997}, - copyright = {Copyright {\textcopyright} 1997 John Wiley \& Sons, - Inc.}, + proposed for the Helmholtz---Kohlrausch effect. Two of them can be + used for luminous colors, and the other two for object colors. In + each of luminous and object colors, the two estimation equations + are given to each of the Variable-Achromatic-Color (VAC) and the + Variable-Chromatic-Color (VCC) methods. All the equations are + similar in type to the Ware---Cowan equation. They give the ratio + between luminance (or metric lightness) of test color stimulus and + its equivalent luminance (or equivalent lightness) directly. + Though their computations are simple, they can apply to various + H---K effects including their adapting luminance dependency. The + applicable fields of the proposed equations are wider than those + of the Ware---Cowan equation. The proposed equations can be + applied to predict the H---K effect within the whole chromaticity + gamut including spectral colors, spectral luminosity functions + based on direct color matching from 0.01 Td to 100 000 Td using + the photopic and the scotopic spectral luminosity functions + specified by CIE, equivalent lightness values of NCS colors, and + others. {\copyright} 1997 John Wiley \& Sons, Inc. Col Res Appl. + 22, 385--401, 1997}, + copyright = {Copyright {\copyright} 1997 John Wiley \& Sons, Inc.}, langid = {english}, keywords = {CIELUV formula,color appearance,equivalent - lightness,equivalent luminance,Helmholtz{\textemdash}Kohlrausch - effect}, + lightness,equivalent luminance,Helmholtz-Kohlrausch effect}, } @article{Newhall1943a, title = {Final {{Report}} of the {{OSA Subcommittee}} on the @@ -3219,8 +3256,8 @@ @inproceedings{Smith1978b author = {Smith, Alvy Ray}, year = 1978, pages = {12--19}, - publisher = {{ACM Press}}, - address = {{New York, New York, USA}}, + publisher = {ACM Press}, + address = {New York, New York, USA}, doi = {10.1145/800248.807361}, keywords = {Brightness,Color,Color transform,color transforms,Gamut,HSL,HSV,Hue,Luminance,NTSC,RGB,Saturation,Value}, @@ -3235,7 +3272,7 @@ @article{Smits1999a volume = 4, number = 4, pages = {11--22}, - publisher = {{AK Peters, Ltd.}}, + publisher = {AK Peters, Ltd.}, issn = {1086-7651}, doi = {10.1080/10867651.1999.10487511}, urldate = {2014-09-19}, @@ -3308,7 +3345,7 @@ @misc{SocietyofMotionPictureandTelevisionEngineers2014a } @misc{SocietyofMotionPictureandTelevisionEngineers2019, title = {{{ST}} 428-1:2019 - {{D-Cinema Distribution Master}} - {\textemdash} {{Image Characteristic}}}, + --- {{Image Characteristic}}}, author = {{Society of Motion Picture and Television Engineers}}, year = 2019, doi = {10.5594/SMPTE.ST428-1.2019}, @@ -3388,7 +3425,7 @@ @article{Stearns1988a volume = 13, number = 4, pages = {257--259}, - publisher = {{Wiley Subscription Services, Inc., A Wiley Company}}, + publisher = {Wiley Subscription Services, Inc., A Wiley Company}, issn = 03612317, doi = {10.1002/col.5080130410}, } @@ -3623,7 +3660,7 @@ @article{Ward2002 year = 2002, journal = {Eurographics workshop on Rendering}, pages = {117--124}, - publisher = {{Eurographics Association}}, + publisher = {Eurographics Association}, doi = {10.2312/EGWR/EGWR02/117-124}, urldate = {2014-09-27}, abstract = {Abstract Accurate color requires the consideration @@ -3658,8 +3695,8 @@ @incollection{Westland2004 month = mar, edition = 1, pages = 137, - publisher = {{John Wiley \& Sons, Ltd}}, - address = {{Chichester, UK}}, + publisher = {John Wiley \& Sons, Ltd}, + address = {Chichester, UK}, doi = {10.1002/0470020326}, isbn = {978-0-470-84562-2}, } @@ -3790,11 +3827,11 @@ @misc{Wikipedia2003e howpublished = {https://en.wikipedia.org/wiki/Vandermonde\_matrix}, } @misc{Wikipedia2003f, - title = {Rayleigh{\textendash}{{Jeans}} Law}, + title = {Rayleigh--{{Jeans}} Law}, author = {{Wikipedia}}, year = 2003, urldate = {2022-02-12}, - howpublished = {https://en.wikipedia.org/wiki/Rayleigh{\textendash}Jeans\_law}, + howpublished = {https://en.wikipedia.org/wiki/Rayleigh--Jeans\_law}, } @misc{Wikipedia2004, title = {Peak Signal-to-Noise Ratio}, @@ -3966,7 +4003,7 @@ @article{Wyszecki1963b volume = 53, number = 11, pages = 1318, - publisher = {{OSA}}, + publisher = {OSA}, issn = {0030-3941}, doi = {10.1364/JOSA.53.001318}, urldate = {2014-09-26}, @@ -3981,7 +4018,7 @@ @incollection{Wyszecki2000 author = {Wyszecki, G{\"u}nther and Stiles, W S}, year = 2000, pages = 309, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @incollection{Wyszecki2000a, @@ -3991,7 +4028,7 @@ @incollection{Wyszecki2000a author = {Wyszecki, G{\"u}nther and Stiles, W S}, year = 2000, pages = 8, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @incollection{Wyszecki2000ba, @@ -4002,7 +4039,7 @@ @incollection{Wyszecki2000ba author = {Wyszecki, G{\"u}nther and Stiles, W. S.}, year = 2000, pages = {837--839}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @incollection{Wyszecki2000bb, @@ -4012,7 +4049,7 @@ @incollection{Wyszecki2000bb author = {Wyszecki, G{\"u}nther and Stiles, W. S.}, year = 2000, pages = {776--777}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @incollection{Wyszecki2000bd, @@ -4023,7 +4060,7 @@ @incollection{Wyszecki2000bd author = {Wyszecki, G{\"u}nther and Stiles, W. S.}, year = 2000, pages = 167, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @incollection{Wyszecki2000be, @@ -4033,7 +4070,7 @@ @incollection{Wyszecki2000be author = {Wyszecki, G{\"u}nther and Stiles, W. S.}, year = 2000, pages = 141, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @incollection{Wyszecki2000bf, @@ -4043,7 +4080,7 @@ @incollection{Wyszecki2000bf author = {Wyszecki, G{\"u}nther and Stiles, W. S.}, year = 2000, pages = {158--163}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @incollection{Wyszecki2000bg, @@ -4053,7 +4090,7 @@ @incollection{Wyszecki2000bg author = {Wyszecki, G{\"u}nther and Stiles, W. S.}, year = 2000, pages = {138--139}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @incollection{Wyszecki2000bh, @@ -4063,7 +4100,7 @@ @incollection{Wyszecki2000bh author = {Wyszecki, G{\"u}nther and Stiles, W. S.}, year = 2000, pages = {778--779}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @incollection{Wyszecki2000s, @@ -4073,7 +4110,7 @@ @incollection{Wyszecki2000s author = {Wyszecki, G{\"u}nther and Stiles, W. S.}, year = 2000, pages = {256--259,395}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @incollection{Wyszecki2000x, @@ -4083,7 +4120,7 @@ @incollection{Wyszecki2000x author = {Wyszecki, G{\"u}nther and Stiles, W. S.}, year = 2000, pages = 228, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @incollection{Wyszecki2000y, @@ -4094,7 +4131,7 @@ @incollection{Wyszecki2000y author = {Wyszecki, G{\"u}nther and Stiles, W. S.}, year = 2000, pages = {224--229}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @incollection{Wyszecki2000z, @@ -4104,7 +4141,7 @@ @incollection{Wyszecki2000z author = {Wyszecki, G{\"u}nther and Stiles, W. S.}, year = 2000, pages = {145--146}, - publisher = {{Wiley}}, + publisher = {Wiley}, isbn = {978-0-471-39918-6}, } @misc{X-Rite2012a, diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index e43153ff4b..331d13d42c 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -4,7 +4,7 @@ Contributors The Colour Developers --------------------- -- **Thomas Mansencal**, *Technology Supervisor @ Wētā FX* +- **Thomas Mansencal**, *Principal Pipeline Programmer @ Epic Games* Maintainer, project coordination, overall development. diff --git a/README.rst b/README.rst index 0b995c4323..f8e48efb3b 100644 --- a/README.rst +++ b/README.rst @@ -26,13 +26,13 @@ :target: https://coveralls.io/r/colour-science/colour :alt: Coverage Status .. |codacy| image:: https://img.shields.io/codacy/grade/1f3b8d3bba7440ba9ebc1170589628b1/develop.svg?style=flat-square - :target: https://www.codacy.com/app/colour-science/colour + :target: https://app.codacy.com/gh/colour-science/colour :alt: Code Grade .. |version| image:: https://img.shields.io/pypi/v/colour-science.svg?style=flat-square :target: https://pypi.org/project/colour-science :alt: Package Version -.. |zenodo| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.10396329-blue.svg?style=flat-square - :target: https://dx.doi.org/10.5281/zenodo.10396329 +.. |zenodo| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.13910741-blue.svg?style=flat-square + :target: https://dx.doi.org/10.5281/zenodo.13910741 :alt: DOI .. end-badges @@ -93,8 +93,48 @@ If you'd like to join them, please consider

Joseph Goldstone

- - + + + +

Colorhythm

+ + + + + +.. raw:: html + +

Silver Sponsors

+ +.. raw:: html + + + + + + + + + @@ -129,9 +169,10 @@ If you'd like to join them, please consider

Studio Zhanna Alekseeva.NYC

- - - + + + @@ -53,9 +54,10 @@ If you'd like to join them, please consider - - - + + +
+ + + +

Nick Shaw

+ 		+ + + + + + + + + + + + + +
- - + + +

James Howard

 @@ -199,12 +240,6 @@ If you'd like to join them, please consider

Liam Collod

 - - - -

Nick Shaw

- 		@@ -223,19 +258,19 @@ If you'd like to join them, please consider

Zack Lewis

Frederic Savoir

- - + + -

Howard Colin

+

Howard Colin

 @@ -249,6 +284,12 @@ If you'd like to join them, please consider

Mario Rokicki

 + + + +

Joshua Pines

+ 		@@ -321,13 +362,14 @@ Chromatic Adaptation - ``colour.adaptation`` array([ 0.2533053 , 0.13765138, 0.01543307]) + .. code-block:: python sorted(colour.CHROMATIC_ADAPTATION_METHODS) .. code-block:: text - ['CIE 1994', 'CMCCAT2000', 'Fairchild 1990', 'Von Kries', 'Zhai 2018'] + ['CIE 1994', 'CMCCAT2000', 'Fairchild 1990', 'Von Kries', 'Zhai 2018', 'vK20'] Algebra - ``colour.algebra`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -875,6 +917,18 @@ Images (276, 281, 3) +Spectral Images - Fichet et al. (2021) +************************************** + +.. code-block:: python + + components = colour.read_spectral_image_Fichet2021("Polarised.exr") + list(components.keys()) + +.. code-block:: text + + ['S0', 'S1', 'S2', 'S3'] + Look Up Table (LUT) Data ************************ @@ -2092,7 +2146,7 @@ by issuing this command in a shell: The detailed installation procedure for the secondary dependencies is described in the `Installation Guide `__. -**Colour** is also available for `Anaconda `__ +**Colour** is also available for `Anaconda `__ from *Continuum Analytics* via `conda-forge `__: .. code-block:: bash @@ -2138,8 +2192,8 @@ API Reference The main technical reference for **Colour** is the *API Reference*: -- `Release `__. -- `Develop `__. +- `Release `__ +- `Develop `__ See Also -------- @@ -2149,6 +2203,7 @@ Software **Python** +- `ColorAide `__ by Muse, I. - `ColorPy `__ by Kness, M. - `Colorspacious `__ by Smith, N. J., et al. - `python-colormath `__ by Taylor, G., et al. diff --git a/SPONSORS.rst b/SPONSORS.rst index 4f10955dc2..84f5d8aa87 100644 --- a/SPONSORS.rst +++ b/SPONSORS.rst @@ -34,9 +34,10 @@ If you'd like to join them, please consider

Joseph Goldstone

 - - + + +

Colorhythm
- - + + +

Nick Shaw

 @@ -109,9 +111,10 @@ If you'd like to join them, please consider

Studio Zhanna Alekseeva.NYC

 - - + + +

James Howard

 @@ -238,12 +241,6 @@ If you'd like to join them, please consider

Liam Collod

 - - - -

Nick Shaw

- 		@@ -262,19 +259,19 @@ If you'd like to join them, please consider

Zack Lewis

Frederic Savoir

- + -

Howard Colin

+

Howard Colin

 @@ -288,6 +285,12 @@ If you'd like to join them, please consider

Mario Rokicki

 + + + +

Joshua Pines

+ 		diff --git a/TODO.rst b/TODO.rst index cd5cac176b..5047449e5c 100644 --- a/TODO.rst +++ b/TODO.rst @@ -6,164 +6,173 @@ TODO - colour/__init__.py - - Line 878 : # TODO: Remove legacy printing support when deemed appropriate. + - Line 913 : # TODO: Remove legacy printing support when deemed appropriate. - colour/colorimetry/spectrum.py - - Line 1190 : # TODO: Provide support for fractional interval like 0.1, etc... + - Line 1174 : # TODO: Provide support for fractional interval like 0.1, etc... - colour/colorimetry/tristimulus_values.py - - Line 1071 : # TODO: Investigate code vectorisation. + - Line 1050 : # TODO: Investigate code vectorisation. - colour/appearance/ciecam02.py - - Line 377 : # TODO: Compute hue composition. + - Line 369 : # TODO: Compute hue composition. - colour/appearance/ciecam16.py - - Line 325 : # TODO: Compute hue composition. + - Line 322 : # TODO: Compute hue composition. - colour/appearance/cam16.py - - Line 313 : # TODO: Compute hue composition. + - Line 308 : # TODO: Compute hue composition. - colour/appearance/hellwig2022.py - - Line 355 : # TODO: Compute hue composition. + - Line 354 : # TODO: Compute hue composition. - colour/appearance/hunt.py - - Line 487 : # TODO: Implement hue quadrature & composition computation. - - Line 518 : # TODO: Implement whiteness-blackness :math:`Q_{wb}` computation. + - Line 478 : # TODO: Implement hue quadrature & composition computation. + - Line 509 : # TODO: Implement whiteness-blackness :math:`Q_{wb}` computation. - colour/appearance/rlab.py - - Line 287 : # TODO: Implement hue composition computation. + - Line 283 : # TODO: Implement hue composition computation. - colour/appearance/nayatani95.py - - Line 311 : # TODO: Implement hue quadrature & composition computation. - - Line 324 : # TODO: Investigate components usage. M_RG, M_YB = tsplit(colourfulness_components(C_RG, C_YB, brightness_ideal_white)) + - Line 307 : # TODO: Implement hue quadrature & composition computation. + - Line 318 : # TODO: Investigate components usage. M_RG, M_YB = tsplit(colourfulness_components(C_RG, C_YB, brightness_ideal_white)) - colour/appearance/llab.py - - Line 396 : # TODO: Implement hue composition computation. + - Line 362 : # TODO: Implement hue composition computation. - colour/recovery/tests/test_jiang2013.py - - Line 63 : # TODO: Last eigen value seems to be very sensitive and produce differences on ARM. + - Line 66 : # TODO: Last eigen value seems to be very sensitive and produce differences on ARM. -- colour/io/ocio.py +- colour/io/fichet2021.py - - Line 30 : # TODO: Reinstate coverage and doctests when "Pypi" wheel compatible with "ARM" on "macOS" is released. + - Line 644 : # TODO: Implement support for integration of bi-spectral component. + - Line 651 : # TODO: Implement support for re-binning component with non-uniform interval. - colour/io/ctl.py - - Line 64 : # TODO: Reinstate coverage when "ctlrender" is trivially available cross-platform. + - Line 65 : # TODO: Reinstate coverage when "ctlrender" is trivially available cross-platform. - colour/io/tests/test_ocio.py - - Line 39 : # TODO: Remove when "Pypi" wheel compatible with "ARM" on "macOS" is released. + - Line 37 : # TODO: Remove when "Pypi" wheel compatible with "ARM" on "macOS" is released. - colour/io/tests/test_ctl.py - - Line 41 : # TODO: Reinstate coverage when "ctlrender" is tivially available cross-platform. + - Line 39 : # TODO: Reinstate coverage when "ctlrender" is tivially available cross-platform. - colour/io/tests/test_image.py - - Line 314 : # TODO: Investigate "OIIO" behaviour here: 1.0 != 15360.0 image = read_image_OpenImageIO( os.path.join(ROOT_RESOURCES, 'Colour_Logo.png'), 'float16') self.assertIs(image.dtype, np.dtype('float16')) self.assertEqual(np.min(image), 0.0) self.assertEqual(np.max(image), 1.0) + - Line 322 : # TODO: Investigate "OIIO" behaviour here: 1.0 != 15360.0 image = read_image_OpenImageIO( os.path.join(ROOT_RESOURCES, 'Colour_Logo.png'), 'float16') self.assertIs(image.dtype, np.dtype('float16')) self.assertEqual(np.min(image), 0.0) self.assertEqual(np.max(image), 1.0) - colour/models/rgb/derivation.py - - Line 231 : # TODO: Investigate if we return an ndarray here with primaries and whitepoint stacked together. + - Line 230 : # TODO: Investigate if we return an ndarray here with primaries and whitepoint stacked together. - colour/models/rgb/tests/test_rgb_colourspace.py - - Line 348 : # TODO: Remove tests when dropping deprecated signature support. - - Line 551 : # TODO: Remove tests when dropping deprecated signature support. + - Line 340 : # TODO: Remove tests when dropping deprecated signature support. + - Line 541 : # TODO: Remove tests when dropping deprecated signature support. - colour/models/rgb/tests/test_derivation.py - - Line 339 : # TODO: Simplify that monster. + - Line 327 : # TODO: Simplify that monster. - colour/utilities/verbose.py - - Line 669 : # TODO: Implement support for "pyproject.toml" file whenever "TOML" is supported in the standard library. NOTE: A few clauses are not reached and a few packages are not available during continuous integration and are thus ignored for coverage. + - Line 795 : # TODO: Implement support for "pyproject.toml" file whenever "TOML" is supported in the standard library. NOTE: A few clauses are not reached and a few packages are not available during continuous integration and are thus ignored for coverage. + + +- colour/utilities/network.py + + - Line 587 : # TODO: Consider using an ordered set instead of a dict. + - Line 1064 : # TODO: Consider using ordered set. + - Line 1070 : # TODO: Consider using ordered set. + - Line 1907 : # TODO: Implement solid control flow based processing using a stack. - colour/utilities/array.py - - Line 577 : # TODO: Remove when https://github.com/numpy/numpy/issues/5718 is addressed. - - Line 865 : # TODO: Investigate behaviour on Windows. - - Line 922 : # TODO: Annotate with "Union[Literal['ignore', 'reference', '1', '100'], str]" when Python 3.7 is dropped. + - Line 573 : # TODO: Remove when https://github.com/numpy/numpy/issues/5718 is addressed. + - Line 853 : # TODO: Investigate behaviour on Windows. + - Line 914 : # TODO: Annotate with "Union[Literal['ignore', 'reference', '1', '100'], str]" when Python 3.7 is dropped. - colour/plotting/models.py - - Line 1939 : # TODO: Filter appropriate colour models. NOTE: "dtype=object" is required for ragged array support in "Numpy" 1.24.0. + - Line 1925 : # TODO: Filter appropriate colour models. NOTE: "dtype=object" is required for ragged array support in "Numpy" 1.24.0. - colour/plotting/graph.py - - Line 88 : # TODO: Investigate API to trigger the conversion graph build. + - Line 86 : # TODO: Investigate API to trigger the conversion graph build. - colour/plotting/common.py - - Line 870 : # TODO: Reassess according to https://github.com/matplotlib/matplotlib/issues/1077 - - Line 989 : # TODO: Consider using "MutableMapping" here. + - Line 871 : # TODO: Reassess according to https://github.com/matplotlib/matplotlib/issues/1077 + - Line 987 : # TODO: Consider using "MutableMapping" here. - colour/characterisation/aces_it.py - - Line 397 : # TODO: Remove when removing the "colour.sd_blackbody" definition warning. + - Line 395 : # TODO: Remove when removing the "colour.sd_blackbody" definition warning. - colour/characterisation/correction.py - - Line 461 : # TODO: Generalise polynomial expansion. + - Line 459 : # TODO: Generalise polynomial expansion. - colour/notation/munsell.py - - Line 1251 : # TODO: Consider refactoring implementation. + - Line 1236 : # TODO: Consider refactoring implementation. - colour/continuous/signal.py - - Line 424 : # TODO: Check for interpolator compatibility. - - Line 484 : # TODO: Check for extrapolator compatibility. + - Line 422 : # TODO: Check for interpolator compatibility. + - Line 482 : # TODO: Check for extrapolator compatibility. - colour/hints/__init__.py - - Line 135 : # TODO: Revisit to use Protocol. + - Line 137 : # TODO: Revisit to use Protocol. - colour/algebra/tests/test_interpolation.py - - Line 1176 : # TODO: Revisit if the interpolator can be applied on non-uniform "x" independent variable. + - Line 1168 : # TODO: Revisit if the interpolator can be applied on non-uniform "x" independent variable. About ----- diff --git a/colour/__init__.py b/colour/__init__.py index e2767b1654..b7d49dd41a 100644 --- a/colour/__init__.py +++ b/colour/__init__.py @@ -45,11 +45,30 @@ """ import contextlib +import json import os import sys import numpy as np +# Loading the "colour-science" JEnv file. +_JENV_FILE_PATH = os.path.join( + os.path.expanduser("~"), + ".colour-science", + "colour-science.jenv", +) + +if os.path.exists(_JENV_FILE_PATH): + with open(_JENV_FILE_PATH) as _JENV_FILE: + for _KEY, _VALUE in json.loads(_JENV_FILE.read()).items(): + os.environ[_KEY] = str(_VALUE) + + del _JENV_FILE, _KEY, _VALUE + +del _JENV_FILE_PATH + +# ruff: noqa: E402 + from colour import plotting # noqa: F401 from .adaptation import ( @@ -235,6 +254,7 @@ LUT3x1D, LUTOperatorMatrix, LUTSequence, + Specification_Fichet2021, SpectralDistribution_IESTM2714, SpectralDistribution_Sekonic, SpectralDistribution_UPRTek, @@ -243,15 +263,18 @@ read_sds_from_csv_file, read_sds_from_xrite_file, read_spectral_data_from_csv_file, + read_spectral_image_Fichet2021, write_image, write_LUT, write_sds_to_csv_file, + write_spectral_image_Fichet2021, ) from .models import ( CCTF_DECODINGS, CCTF_ENCODINGS, COLOUR_PRIMARIES_ITUTH273, COLOURSPACE_MODELS, + COLOURSPACE_MODELS_POLAR_CONVERSIONS, DATA_MACADAM_1942_ELLIPSES, EOTF_INVERSES, EOTFS, @@ -279,6 +302,8 @@ CAM16SCD_to_XYZ, CAM16UCS_to_JMh_CAM16, CAM16UCS_to_XYZ, + CIE1960UCS_to_XYZ, + CIE1976UCS_to_XYZ, CMY_to_CMYK, CMY_to_RGB, CMYK_to_CMY, @@ -306,11 +331,7 @@ JMh_CIECAM02_to_CAM02UCS, Jzazbz_to_XYZ, Lab_to_DIN99, - Lab_to_LCHab, Lab_to_XYZ, - LCHab_to_Lab, - LCHuv_to_Luv, - Luv_to_LCHuv, Luv_to_uv, Luv_to_XYZ, Luv_uv_to_xy, @@ -343,6 +364,8 @@ XYZ_to_CAM16LCD, XYZ_to_CAM16SCD, XYZ_to_CAM16UCS, + XYZ_to_CIE1960UCS, + XYZ_to_CIE1976UCS, XYZ_to_DIN99, XYZ_to_hdr_CIELab, XYZ_to_hdr_IPT, @@ -439,8 +462,7 @@ get_domain_range_scale, set_domain_range_scale, ) -from .utilities.deprecation import ModuleAPI, build_API_changes -from .utilities.documentation import is_documentation_building +from .utilities.deprecation import ModuleAPI from .volume import ( OPTIMAL_COLOUR_STIMULI_ILLUMINANTS, RGB_colourspace_limits, @@ -613,6 +635,7 @@ "LUT3D", "LUTOperatorMatrix", "LUTSequence", + "Specification_Fichet2021", "READ_IMAGE_METHODS", "SpectralDistribution_IESTM2714", "WRITE_IMAGE_METHODS", @@ -621,31 +644,36 @@ "read_sds_from_csv_file", "read_sds_from_xrite_file", "read_spectral_data_from_csv_file", + "read_spectral_image_Fichet2021", "SpectralDistribution_UPRTek", "SpectralDistribution_Sekonic", "write_image", "write_LUT", "write_sds_to_csv_file", + "write_spectral_image_Fichet2021", ] __all__ += [ "CAM02LCD_to_JMh_CIECAM02", - "CAM02SCD_to_JMh_CIECAM02", - "CAM02UCS_to_JMh_CIECAM02", "CAM02LCD_to_XYZ", + "CAM02SCD_to_JMh_CIECAM02", "CAM02SCD_to_XYZ", + "CAM02UCS_to_JMh_CIECAM02", "CAM02UCS_to_XYZ", "CAM16LCD_to_JMh_CAM16", - "CAM16SCD_to_JMh_CAM16", - "CAM16UCS_to_JMh_CAM16", "CAM16LCD_to_XYZ", + "CAM16SCD_to_JMh_CAM16", "CAM16SCD_to_XYZ", + "CAM16UCS_to_JMh_CAM16", "CAM16UCS_to_XYZ", "CCTF_DECODINGS", "CCTF_ENCODINGS", + "CIE1960UCS_to_XYZ", + "CIE1976UCS_to_XYZ", "CMYK_to_CMY", "CMY_to_CMYK", "CMY_to_RGB", "COLOURSPACE_MODELS", + "COLOURSPACE_MODELS_POLAR_CONVERSIONS", "COLOUR_PRIMARIES_ITUTH273", "CV_range", "DATA_MACADAM_1942_ELLIPSES", @@ -664,10 +692,10 @@ "ICtCp_to_RGB", "ICtCp_to_XYZ", "IHLS_to_RGB", - "IgPgTg_to_XYZ", + "IPT_Ragoo2021_to_XYZ", "IPT_hue_angle", "IPT_to_XYZ", - "IPT_Ragoo2021_to_XYZ", + "IgPgTg_to_XYZ", "JMh_CAM16_to_CAM16LCD", "JMh_CAM16_to_CAM16SCD", "JMh_CAM16_to_CAM16UCS", @@ -675,14 +703,10 @@ "JMh_CIECAM02_to_CAM02SCD", "JMh_CIECAM02_to_CAM02UCS", "Jzazbz_to_XYZ", - "LCHab_to_Lab", - "LCHuv_to_Luv", "LOG_DECODINGS", "LOG_ENCODINGS", "Lab_to_DIN99", - "Lab_to_LCHab", "Lab_to_XYZ", - "Luv_to_LCHuv", "Luv_to_XYZ", "Luv_to_uv", "Luv_uv_to_xy", @@ -723,14 +747,16 @@ "XYZ_to_CAM16LCD", "XYZ_to_CAM16SCD", "XYZ_to_CAM16UCS", + "XYZ_to_CIE1960UCS", + "XYZ_to_CIE1976UCS", "XYZ_to_DIN99", "XYZ_to_Hunter_Lab", "XYZ_to_Hunter_Rdab", "XYZ_to_ICaCb", "XYZ_to_ICtCp", - "XYZ_to_IgPgTg", "XYZ_to_IPT", "XYZ_to_IPT_Ragoo2021", + "XYZ_to_IgPgTg", "XYZ_to_Jzazbz", "XYZ_to_K_ab_HunterLab1966", "XYZ_to_Lab", @@ -741,12 +767,12 @@ "XYZ_to_RGB", "XYZ_to_UCS", "XYZ_to_UVW", + "XYZ_to_Yrg", "XYZ_to_hdr_CIELab", "XYZ_to_hdr_IPT", "XYZ_to_sRGB", "XYZ_to_xy", "XYZ_to_xyY", - "XYZ_to_Yrg", "YCbCr_to_RGB", "YCoCg_to_RGB", "YcCbcCrc_to_RGB", @@ -866,14 +892,23 @@ "convert", ] +# Programmatically defining the colourspace models polar conversions. +for _Jab, _JCh in COLOURSPACE_MODELS_POLAR_CONVERSIONS: + for name in (f"{_Jab}_to_{_JCh}", f"{_JCh}_to_{_Jab}"): + _module = sys.modules["colour"] + _sub_module = sys.modules["colour.models"] + setattr(_module, name, getattr(_sub_module, name)) + __all__.append(name) + +del _JCh, _Jab, _module, _sub_module + + __application_name__ = "Colour" __major_version__ = "0" __minor_version__ = "4" -__change_version__ = "4" -__version__ = ".".join( - (__major_version__, __minor_version__, __change_version__) -) +__change_version__ = "5" +__version__ = ".".join((__major_version__, __minor_version__, __change_version__)) # TODO: Remove legacy printing support when deemed appropriate. with contextlib.suppress(TypeError): @@ -899,58 +934,6 @@ def __getattr__(self, attribute) -> Any: colour.__change_version__ = __change_version__ # pyright: ignore colour.__version__ = __version__ # pyright: ignore -# v0.4.0 -API_CHANGES = { - "ObjectRenamed": [ - [ - "colour.RGB_to_ICTCP", - "colour.RGB_to_ICtCp", - ], - [ - "colour.ICTCP_to_RGB", - "colour.ICtCp_to_RGB", - ], - [ - "colour.RGB_to_IGPGTG", - "colour.RGB_to_IgPgTg", - ], - [ - "colour.IGPGTG_to_RGB", - "colour.IgPgTg_to_RGB", - ], - [ - "colour.XYZ_to_JzAzBz", - "colour.XYZ_to_Jzazbz", - ], - [ - "colour.JzAzBz_to_XYZ", - "colour.Jzazbz_to_XYZ", - ], - ] -} - -# v0.4.3 -API_CHANGES["ObjectRenamed"].extend( - [ - [ - "colour.XYZ_to_IPT_Munish2021", - "colour.XYZ_to_IPT_Ragoo2021", - ], - [ - "colour.IPT_Munish2021_to_XYZ", - "colour.IPT_Ragoo2021_to_XYZ", - ], - ] -) -"""Defines the *colour.models* sub-package API changes.""" - -if not is_documentation_building(): - sys.modules["colour"] = colour( # pyright: ignore - sys.modules["colour"], build_API_changes(API_CHANGES) - ) - - del ModuleAPI, is_documentation_building, build_API_changes - colour.__disable_lazy_load__ = True # pyright: ignore __disable_lazy_load__ = colour.__disable_lazy_load__ # pyright: ignore """ @@ -967,13 +950,13 @@ def __getattr__(self, attribute) -> Any: # - https://github.com/colour-science/colour/issues/958 # - https://github.com/colour-science/colour/issues/1221 # - https://github.com/vaab/colour/issues/62 -for _path in sys.path: +for _path in sys.path: # pragma: no cover _module_path = os.path.join(_path, "colour.py") if os.path.exists(_module_path): import colour # pyright: ignore if not os.environ.get("COLOUR_SCIENCE__COLOUR__IMPORT_VAAB_COLOUR"): - colour.utilities.warning( # pyright: ignore + colour.utilities.runtime_warning( # pyright: ignore '"vaab/colour" was detected in "sys.path", please define a ' '"COLOUR_SCIENCE__COLOUR__IMPORT_VAAB_COLOUR=True" environment ' 'variable to import its objects into "colour" namespace!' @@ -1018,7 +1001,7 @@ def __getattr__(self, attribute) -> Any: "web2rgb", ]: if name in dir(_module): - colour.utilities.warning( # pyright: ignore + colour.utilities.runtime_warning( # pyright: ignore f'Importing "vaab/colour" "{name}" object into ' f'"Colour"\'s namespace!' ) diff --git a/colour/adaptation/__init__.py b/colour/adaptation/__init__.py index 92168edf54..05a13de33c 100644 --- a/colour/adaptation/__init__.py +++ b/colour/adaptation/__init__.py @@ -13,6 +13,9 @@ - :cite:`Fairchild2013t` : Fairchild, M. D. (2013). Chromatic Adaptation Models. In Color Appearance Models (3rd ed., pp. 4179-4252). Wiley. ISBN:B00DAYO8E2 +- :cite:`Fairchild2020` : Fairchild, M. D. (2020). Von Kries 2020: Evolution + of degree of chromatic adaptation. Color and Imaging Conference, 28(1), + 252-257. doi:10.2352/issn.2169-2629.2020.28.40 - :cite:`Li2002a` : Li, C., Luo, M. R., Rigg, B., & Hunt, R. W. G. (2002). CMC 2000 chromatic adaptation transform: CMCCAT2000. Color Research & Application, 27(1), 49-58. doi:10.1002/col.10005 @@ -54,6 +57,11 @@ chromatic_adaptation_VonKries, ) from .fairchild1990 import chromatic_adaptation_Fairchild1990 +from .fairchild2020 import ( + CONDITIONS_DEGREE_OF_ADAPTATION_VK20, + matrix_chromatic_adaptation_vk20, + chromatic_adaptation_vK20, +) from .cmccat2000 import ( InductionFactors_CMCCAT2000, VIEWING_CONDITIONS_CMCCAT2000, @@ -87,6 +95,11 @@ __all__ += [ "chromatic_adaptation_Fairchild1990", ] +__all__ += [ + "CONDITIONS_DEGREE_OF_ADAPTATION_VK20", + "matrix_chromatic_adaptation_vk20", + "chromatic_adaptation_vK20", +] __all__ += [ "InductionFactors_CMCCAT2000", "VIEWING_CONDITIONS_CMCCAT2000", @@ -108,6 +121,7 @@ "Fairchild 1990": chromatic_adaptation_Fairchild1990, "Von Kries": chromatic_adaptation_VonKries, "Zhai 2018": chromatic_adaptation_Zhai2018, + "vK20": chromatic_adaptation_vK20, } ) CHROMATIC_ADAPTATION_METHODS.__doc__ = """ @@ -116,8 +130,8 @@ References ---------- :cite:`CIETC1-321994b`, :cite:`Fairchild1991a`, :cite:`Fairchild2013s`, -:cite:`Fairchild2013t`, :cite:`Li2002a`, :cite:`Westland2012k`, -:cite:`Zhai2018` +:cite:`Fairchild2013t`, :cite:`Fairchild2020`, :cite:`Li2002a`, +:cite:`Westland2012k`, :cite:`Zhai2018` """ @@ -125,10 +139,17 @@ def chromatic_adaptation( XYZ: ArrayLike, XYZ_w: ArrayLike, XYZ_wr: ArrayLike, - method: Literal[ - "CIE 1994", "CMCCAT2000", "Fairchild 1990", "Zhai 2018", "Von Kries" - ] - | str = "Von Kries", + method: ( + Literal[ + "CIE 1994", + "CMCCAT2000", + "Fairchild 1990", + "Von Kries", + "Zhai 2018", + "vK20", + ] + | str + ) = "Von Kries", **kwargs: Any, ) -> NDArrayFloat: """ @@ -188,8 +209,16 @@ def chromatic_adaptation( {:func:`colour.adaptation.chromatic_adaptation_Zhai2018`}, Degree of adaptation :math:`D_\\Delta` of output illuminant :math:`\\Delta`. + XYZ_r + {:func:`colour.adaptation.chromatic_adaptation_vK20`}, + Reference viewing conditions *CIE XYZ* tristimulus values of + whitepoint. + coefficients + {:func:`colour.adaptation.chromatic_adaptation_vK20`}, + *vK20* degree of adaptation coefficients. transform {:func:`colour.adaptation.chromatic_adaptation_VonKries`, + :func:`colour.adaptation.chromatic_adaptation_vK20`, :func:`colour.adaptation.chromatic_adaptation_Zhai2018`}, Chromatic adaptation transform. XYZ_wo @@ -240,6 +269,14 @@ def chromatic_adaptation( ... # doctest: +ELLIPSIS array([ 0.2163881..., 0.1257 , 0.0384749...]) + *vK2020* chromatic adaptation: + + >>> XYZ_w = np.array([0.95045593, 1.00000000, 1.08905775]) + >>> XYZ_wr = np.array([0.96429568, 1.00000000, 0.82510460]) + >>> chromatic_adaptation(XYZ, XYZ_w, XYZ_wr, method="vK20") + ... # doctest: +ELLIPSIS + array([ 0.2146884..., 0.1245616..., 0.0466255...]) + *CIE 1994* chromatic adaptation, requires extra *kwargs*: >>> XYZ = np.array([0.2800, 0.2126, 0.0527]) @@ -269,9 +306,7 @@ def chromatic_adaptation( >>> XYZ = np.array([0.1953, 0.2307, 0.2497]) >>> Y_n = 200 - >>> chromatic_adaptation( - ... XYZ, XYZ_w, XYZ_wr, method="Fairchild 1990", Y_n=Y_n - ... ) + >>> chromatic_adaptation(XYZ, XYZ_w, XYZ_wr, method="Fairchild 1990", Y_n=Y_n) ... # doctest: +ELLIPSIS array([ 0.2332526..., 0.2332455..., 0.7611593...]) @@ -328,6 +363,8 @@ def chromatic_adaptation( kwargs.update({"XYZ_n": XYZ_w, "XYZ_r": XYZ_wr}) elif function is chromatic_adaptation_Zhai2018: kwargs.update({"XYZ_wb": XYZ_w, "XYZ_wd": XYZ_wr}) + elif function is chromatic_adaptation_vK20: + kwargs.update({"XYZ_p": XYZ_w, "XYZ_n": XYZ_wr}) XYZ_c = function(XYZ, **filter_kwargs(function, **kwargs)) diff --git a/colour/adaptation/cie1994.py b/colour/adaptation/cie1994.py index 442a3ebc96..4c3459eee1 100644 --- a/colour/adaptation/cie1994.py +++ b/colour/adaptation/cie1994.py @@ -2,7 +2,7 @@ CIE 1994 Chromatic Adaptation Model =================================== -Defines the *CIE 1994* chromatic adaptation model objects: +Define the *CIE 1994* chromatic adaptation model objects: - :func:`colour.adaptation.chromatic_adaptation_CIE1994` @@ -19,7 +19,7 @@ import numpy as np from colour.adaptation import CAT_VON_KRIES -from colour.algebra import sdiv, sdiv_mode, spow, vector_dot +from colour.algebra import sdiv, sdiv_mode, spow, vecmul from colour.hints import ArrayLike, NDArrayFloat from colour.utilities import ( as_float_array, @@ -58,9 +58,7 @@ responses matrix. """ -MATRIX_RGB_TO_XYZ_CIE1994: NDArrayFloat = np.linalg.inv( - MATRIX_XYZ_TO_RGB_CIE1994 -) +MATRIX_RGB_TO_XYZ_CIE1994: NDArrayFloat = np.linalg.inv(MATRIX_XYZ_TO_RGB_CIE1994) """ *CIE 1994* colour appearance model cone responses to *CIE XYZ* tristimulus values matrix. @@ -163,9 +161,7 @@ def chromatic_adaptation_CIE1994( K = K_coefficient(xez_1, xez_2, bRGB_o1, bRGB_o2, Y_o, n) - RGB_2 = corresponding_colour( - RGB_1, xez_1, xez_2, bRGB_o1, bRGB_o2, Y_o, K, n - ) + RGB_2 = corresponding_colour(RGB_1, xez_1, xez_2, bRGB_o1, bRGB_o2, Y_o, K, n) XYZ_2 = RGB_to_XYZ_CIE1994(RGB_2) return from_range_100(XYZ_2) @@ -192,7 +188,7 @@ def XYZ_to_RGB_CIE1994(XYZ: ArrayLike) -> NDArrayFloat: array([ 25.8244273..., 18.6791422..., 4.8390194...]) """ - return vector_dot(MATRIX_XYZ_TO_RGB_CIE1994, XYZ) + return vecmul(MATRIX_XYZ_TO_RGB_CIE1994, XYZ) def RGB_to_XYZ_CIE1994(RGB: ArrayLike) -> NDArrayFloat: @@ -216,7 +212,7 @@ def RGB_to_XYZ_CIE1994(RGB: ArrayLike) -> NDArrayFloat: array([ 28. , 21.26, 5.27]) """ - return vector_dot(MATRIX_RGB_TO_XYZ_CIE1994, RGB) + return vecmul(MATRIX_RGB_TO_XYZ_CIE1994, RGB) def intermediate_values(xy_o: ArrayLike) -> NDArrayFloat: diff --git a/colour/adaptation/cmccat2000.py b/colour/adaptation/cmccat2000.py index 9167f44cd2..b1855a2f87 100644 --- a/colour/adaptation/cmccat2000.py +++ b/colour/adaptation/cmccat2000.py @@ -2,7 +2,7 @@ CMCCAT2000 Chromatic Adaptation Model ===================================== -Defines the *CMCCAT2000* chromatic adaptation model objects: +Define the *CMCCAT2000* chromatic adaptation model objects: - :class:`colour.adaptation.InductionFactors_CMCCAT2000` - :class:`colour.VIEWING_CONDITIONS_CMCCAT2000` @@ -27,7 +27,7 @@ import numpy as np from colour.adaptation import CAT_CMCCAT2000 -from colour.algebra import vector_dot +from colour.algebra import vecmul from colour.hints import ArrayLike, Literal, NDArrayFloat from colour.utilities import ( CanonicalMapping, @@ -100,9 +100,7 @@ def chromatic_adaptation_forward_CMCCAT2000( XYZ_wr: ArrayLike, L_A1: ArrayLike, L_A2: ArrayLike, - surround: InductionFactors_CMCCAT2000 = VIEWING_CONDITIONS_CMCCAT2000[ - "Average" - ], + surround: InductionFactors_CMCCAT2000 = VIEWING_CONDITIONS_CMCCAT2000["Average"], ) -> NDArrayFloat: """ Adapt given stimulus *CIE XYZ* tristimulus values from test viewing @@ -170,9 +168,9 @@ def chromatic_adaptation_forward_CMCCAT2000( L_A1 = as_float_array(L_A1) L_A2 = as_float_array(L_A2) - RGB = vector_dot(CAT_CMCCAT2000, XYZ) - RGB_w = vector_dot(CAT_CMCCAT2000, XYZ_w) - RGB_wr = vector_dot(CAT_CMCCAT2000, XYZ_wr) + RGB = vecmul(CAT_CMCCAT2000, XYZ) + RGB_w = vecmul(CAT_CMCCAT2000, XYZ_w) + RGB_wr = vecmul(CAT_CMCCAT2000, XYZ_wr) D = surround.F * ( 0.08 * np.log10(0.5 * (L_A1 + L_A2)) @@ -184,7 +182,7 @@ def chromatic_adaptation_forward_CMCCAT2000( a = D * XYZ_w[..., 1] / XYZ_wr[..., 1] RGB_c = RGB * (a[..., None] * (RGB_wr / RGB_w) + 1 - D[..., None]) - XYZ_c = vector_dot(CAT_INVERSE_CMCCAT2000, RGB_c) + XYZ_c = vecmul(CAT_INVERSE_CMCCAT2000, RGB_c) return from_range_100(XYZ_c) @@ -195,9 +193,7 @@ def chromatic_adaptation_inverse_CMCCAT2000( XYZ_wr: ArrayLike, L_A1: ArrayLike, L_A2: ArrayLike, - surround: InductionFactors_CMCCAT2000 = VIEWING_CONDITIONS_CMCCAT2000[ - "Average" - ], + surround: InductionFactors_CMCCAT2000 = VIEWING_CONDITIONS_CMCCAT2000["Average"], ) -> NDArrayFloat: """ Adapt given stimulus corresponding colour *CIE XYZ* tristimulus values @@ -254,9 +250,7 @@ def chromatic_adaptation_inverse_CMCCAT2000( >>> XYZ_wr = np.array([94.81, 100.00, 107.30]) >>> L_A1 = 200 >>> L_A2 = 200 - >>> chromatic_adaptation_inverse_CMCCAT2000( - ... XYZ_c, XYZ_w, XYZ_wr, L_A1, L_A2 - ... ) + >>> chromatic_adaptation_inverse_CMCCAT2000(XYZ_c, XYZ_w, XYZ_wr, L_A1, L_A2) ... # doctest: +ELLIPSIS array([ 22.4839876..., 22.7419485..., 8.5393392...]) """ @@ -267,9 +261,9 @@ def chromatic_adaptation_inverse_CMCCAT2000( L_A1 = as_float_array(L_A1) L_A2 = as_float_array(L_A2) - RGB_c = vector_dot(CAT_CMCCAT2000, XYZ_c) - RGB_w = vector_dot(CAT_CMCCAT2000, XYZ_w) - RGB_wr = vector_dot(CAT_CMCCAT2000, XYZ_wr) + RGB_c = vecmul(CAT_CMCCAT2000, XYZ_c) + RGB_w = vecmul(CAT_CMCCAT2000, XYZ_w) + RGB_wr = vecmul(CAT_CMCCAT2000, XYZ_wr) D = surround.F * ( 0.08 * np.log10(0.5 * (L_A1 + L_A2)) @@ -281,7 +275,7 @@ def chromatic_adaptation_inverse_CMCCAT2000( a = D * XYZ_w[..., 1] / XYZ_wr[..., 1] RGB = RGB_c / (a[..., None] * (RGB_wr / RGB_w) + 1 - D[..., None]) - XYZ = vector_dot(CAT_INVERSE_CMCCAT2000, RGB) + XYZ = vecmul(CAT_INVERSE_CMCCAT2000, RGB) return from_range_100(XYZ) @@ -292,9 +286,7 @@ def chromatic_adaptation_CMCCAT2000( XYZ_wr: ArrayLike, L_A1: ArrayLike, L_A2: ArrayLike, - surround: InductionFactors_CMCCAT2000 = VIEWING_CONDITIONS_CMCCAT2000[ - "Average" - ], + surround: InductionFactors_CMCCAT2000 = VIEWING_CONDITIONS_CMCCAT2000["Average"], direction: Literal["Forward", "Inverse"] | str = "Forward", ) -> NDArrayFloat: """ diff --git a/colour/adaptation/datasets/cat.py b/colour/adaptation/datasets/cat.py index a93f2f5344..ad7f4306b1 100644 --- a/colour/adaptation/datasets/cat.py +++ b/colour/adaptation/datasets/cat.py @@ -2,7 +2,7 @@ Chromatic Adaptation Transforms =============================== -Defines various chromatic adaptation transforms (CAT): +Define various chromatic adaptation transforms (CAT): - :attr:`colour.adaptation.CAT_XYZ_SCALING`: *XYZ Scaling* chromatic adaptation transform. @@ -101,7 +101,7 @@ "CHROMATIC_ADAPTATION_TRANSFORMS", ] -CAT_XYZ_SCALING: NDArrayFloat = np.array(np.identity(3)).reshape([3, 3]) +CAT_XYZ_SCALING: NDArrayFloat = np.reshape(np.array(np.identity(3)), (3, 3)) """ *XYZ Scaling* chromatic adaptation transform. diff --git a/colour/adaptation/fairchild1990.py b/colour/adaptation/fairchild1990.py index ba5afce035..4e92fbfcca 100644 --- a/colour/adaptation/fairchild1990.py +++ b/colour/adaptation/fairchild1990.py @@ -2,7 +2,7 @@ Fairchild (1990) Chromatic Adaptation Model =========================================== -Defines the *Fairchild (1990)* chromatic adaptation model objects: +Define the *Fairchild (1990)* chromatic adaptation model objects: - :func:`colour.adaptation.chromatic_adaptation_Fairchild1990` @@ -20,7 +20,7 @@ import numpy as np from colour.adaptation import CAT_VON_KRIES -from colour.algebra import sdiv, sdiv_mode, spow, vector_dot +from colour.algebra import sdiv, sdiv_mode, spow, vecmul from colour.hints import ArrayLike, NDArrayFloat from colour.utilities import ( as_float_array, @@ -129,13 +129,11 @@ def chromatic_adaptation_Fairchild1990( XYZ_r = to_domain_100(XYZ_r) Y_n = as_float_array(Y_n) - LMS_1 = vector_dot(MATRIX_XYZ_TO_RGB_FAIRCHILD1990, XYZ_1) - LMS_n = vector_dot(MATRIX_XYZ_TO_RGB_FAIRCHILD1990, XYZ_n) - LMS_r = vector_dot(MATRIX_XYZ_TO_RGB_FAIRCHILD1990, XYZ_r) + LMS_1 = vecmul(MATRIX_XYZ_TO_RGB_FAIRCHILD1990, XYZ_1) + LMS_n = vecmul(MATRIX_XYZ_TO_RGB_FAIRCHILD1990, XYZ_n) + LMS_r = vecmul(MATRIX_XYZ_TO_RGB_FAIRCHILD1990, XYZ_r) - p_LMS = degrees_of_adaptation( - LMS_1, Y_n, discount_illuminant=discount_illuminant - ) + p_LMS = degrees_of_adaptation(LMS_1, Y_n, discount_illuminant=discount_illuminant) a_LMS_1 = p_LMS / LMS_n a_LMS_2 = p_LMS / LMS_r @@ -143,16 +141,16 @@ def chromatic_adaptation_Fairchild1990( A_1 = row_as_diagonal(a_LMS_1) A_2 = row_as_diagonal(a_LMS_2) - LMSp_1 = vector_dot(A_1, LMS_1) + LMSp_1 = vecmul(A_1, LMS_1) c = 0.219 - 0.0784 * np.log10(Y_n) C = row_as_diagonal(tstack([c, c, c])) - LMS_a = vector_dot(C, LMSp_1) - LMSp_2 = vector_dot(np.linalg.inv(C), LMS_a) + LMS_a = vecmul(C, LMSp_1) + LMSp_2 = vecmul(np.linalg.inv(C), LMS_a) - LMS_c = vector_dot(np.linalg.inv(A_2), LMSp_2) - XYZ_c = vector_dot(MATRIX_RGB_TO_XYZ_FAIRCHILD1990, LMS_c) + LMS_c = vecmul(np.linalg.inv(A_2), LMSp_2) + XYZ_c = vecmul(MATRIX_RGB_TO_XYZ_FAIRCHILD1990, LMS_c) return from_range_100(XYZ_c) @@ -178,7 +176,7 @@ def XYZ_to_RGB_Fairchild1990(XYZ: ArrayLike) -> NDArrayFloat: array([ 22.1231935..., 23.6054224..., 22.9279534...]) """ - return vector_dot(MATRIX_XYZ_TO_RGB_FAIRCHILD1990, XYZ) + return vecmul(MATRIX_XYZ_TO_RGB_FAIRCHILD1990, XYZ) def RGB_to_XYZ_Fairchild1990(RGB: ArrayLike) -> NDArrayFloat: @@ -202,7 +200,7 @@ def RGB_to_XYZ_Fairchild1990(RGB: ArrayLike) -> NDArrayFloat: array([ 19.53, 23.07, 24.97]) """ - return vector_dot(MATRIX_RGB_TO_XYZ_FAIRCHILD1990, RGB) + return vecmul(MATRIX_RGB_TO_XYZ_FAIRCHILD1990, RGB) def degrees_of_adaptation( @@ -249,7 +247,7 @@ def degrees_of_adaptation( v = as_float_array(v) # E illuminant. - LMS_E = vector_dot(CAT_VON_KRIES, ones(LMS.shape)) + LMS_E = vecmul(CAT_VON_KRIES, ones(LMS.shape)) Ye_n = spow(Y_n, v) diff --git a/colour/adaptation/fairchild2020.py b/colour/adaptation/fairchild2020.py new file mode 100644 index 0000000000..86ca34a78c --- /dev/null +++ b/colour/adaptation/fairchild2020.py @@ -0,0 +1,321 @@ +""" +Von Kries 2020 (vK20) Chromatic Adaptation Model +================================================ + +Define the *Von Kries 2020* (*vK20*) chromatic adaptation model objects: + +- :attr:`colour.adaptation.CONDITIONS_DEGREE_OF_ADAPTATION_VK20` +- :func:`colour.adaptation.matrix_chromatic_adaptation_vk20` +- :func:`colour.adaptation.chromatic_adaptation_vK20` + +References +---------- +- :cite:`Fairchild2020` : Fairchild, M. D. (2020). Von Kries 2020: Evolution + of degree of chromatic adaptation. Color and Imaging Conference, 28(1), + 252-257. doi:10.2352/issn.2169-2629.2020.28.40 +""" + +from __future__ import annotations + +from collections import namedtuple + +import numpy as np + +from colour.adaptation import CHROMATIC_ADAPTATION_TRANSFORMS +from colour.algebra import sdiv, sdiv_mode, vecmul +from colour.hints import ArrayLike, Literal, NDArrayFloat +from colour.utilities import ( + CanonicalMapping, + as_float_array, + from_range_1, + row_as_diagonal, + to_domain_1, + validate_method, +) + +__author__ = "Colour Developers" +__copyright__ = "Copyright 2013 Colour Developers" +__license__ = "New BSD License - https://opensource.org/licenses/BSD-3-Clause" +__maintainer__ = "Colour Developers" +__email__ = "colour-developers@colour-science.org" +__status__ = "Production" + +__all__ = [ + "Coefficients_DegreeOfAdaptation_vK20", + "CONDITIONS_DEGREE_OF_ADAPTATION_VK20", + "TVS_XYZ_R_VK20", + "matrix_chromatic_adaptation_vk20", + "chromatic_adaptation_vK20", +] + + +class Coefficients_DegreeOfAdaptation_vK20( + namedtuple("Coefficients_DegreeOfAdaptation_vK20", ("D_n", "D_r", "D_p")) +): + """ + *Von Kries 2020* (*vK20*) degree of adaptation coefficients. + + Parameters + ---------- + D_n + Degree of adaptation for the adapting illuminant. + D_r + Degree of adaptation for the reference illuminant. + D_p + Degree of adaptation for the previous illuminant. + + References + ---------- + :cite:`Fairchild2020` + """ + + +CONDITIONS_DEGREE_OF_ADAPTATION_VK20: CanonicalMapping = CanonicalMapping( + { + "Fairchild": Coefficients_DegreeOfAdaptation_vK20(0.7, 0.3, 0), + "Hands": Coefficients_DegreeOfAdaptation_vK20(0.95, 0.05, 0), + "No Hands": Coefficients_DegreeOfAdaptation_vK20(0.85, 0.15, 0), + "Ordinal 1st": Coefficients_DegreeOfAdaptation_vK20(0.9, 0.1, 0), + "Ordinal 2nd": Coefficients_DegreeOfAdaptation_vK20(0.8, 0.1, 0.1), + "Reversibility Trial 1st": Coefficients_DegreeOfAdaptation_vK20(0.7, 0.3, 0.1), + "Reversibility Trial 2nd": Coefficients_DegreeOfAdaptation_vK20(0.6, 0.3, 0.1), + "Ma et al.": Coefficients_DegreeOfAdaptation_vK20(1 / 3, 1 / 3, 1 / 3), + "Hunt & Winter": Coefficients_DegreeOfAdaptation_vK20(0.6, 0.2, 0.2), + "Hurvich & Jameson": Coefficients_DegreeOfAdaptation_vK20(0.7, 0.3, 0), + "Simple von Kries": Coefficients_DegreeOfAdaptation_vK20(1, 0, 0), + } +) +CONDITIONS_DEGREE_OF_ADAPTATION_VK20.__doc__ = """ +Conditions for the *Von Kries 2020* (*vK20*) degree of adaptation coefficients. + +References +---------- +:cite:`Fairchild2020` +""" + +TVS_XYZ_R_VK20 = np.array([0.97941176, 1.00000000, 1.73235294]) +""" +*Von Kries 2020* (*vK20*) reference illuminant (taken to be +u' = 0.185, v' = 0.425, approximately 15000K, sky blue). + +References +---------- +:cite:`Fairchild2020` +""" + + +def matrix_chromatic_adaptation_vk20( + XYZ_p: ArrayLike, + XYZ_n: ArrayLike, + XYZ_r: ArrayLike = TVS_XYZ_R_VK20, + transform: Literal[ + "Bianco 2010", + "Bianco PC 2010", + "Bradford", + "CAT02 Brill 2008", + "CAT02", + "CAT16", + "CMCCAT2000", + "CMCCAT97", + "Fairchild", + "Sharp", + "Von Kries", + "XYZ Scaling", + ] + | str = "CAT02", + coefficients: Coefficients_DegreeOfAdaptation_vK20 = ( + CONDITIONS_DEGREE_OF_ADAPTATION_VK20["Fairchild"] + ), +) -> NDArrayFloat: + """ + Compute the *chromatic adaptation* matrix from previous viewing conditions + to adapting viewing conditions using *Von Kries 2020* (*vK20*) method. + + Parameters + ---------- + XYZ_p + Previous viewing conditions *CIE XYZ* tristimulus values of whitepoint. + XYZ_n + Adapting viewing conditions *CIE XYZ* tristimulus values of whitepoint. + XYZ_r + Reference viewing conditions *CIE XYZ* tristimulus values of + whitepoint. + transform + Chromatic adaptation transform. + coefficients + *vK20* degree of adaptation coefficients. + + Returns + ------- + :class:`numpy.ndarray` + Chromatic adaptation matrix :math:`M_{cat}`. + + Notes + ----- + +------------+-----------------------+---------------+ + | **Domain** | **Scale - Reference** | **Scale - 1** | + +============+=======================+===============+ + | ``XYZ_p`` | [0, 1] | [0, 1] | + +------------+-----------------------+---------------+ + | ``XYZ_n`` | [0, 1] | [0, 1] | + +------------+-----------------------+---------------+ + | ``XYZ_r`` | [0, 1] | [0, 1] | + +------------+-----------------------+---------------+ + + References + ---------- + :cite:`Fairchild2020` + + Examples + -------- + >>> XYZ_p = np.array([0.95045593, 1.00000000, 1.08905775]) + >>> XYZ_n = np.array([0.96429568, 1.00000000, 0.82510460]) + >>> matrix_chromatic_adaptation_vk20(XYZ_p, XYZ_n) + ... # doctest: +ELLIPSIS + array([[ 1.0279139...e+00, 2.9137117...e-02, -2.2794068...e-02], + [ 2.0702840...e-02, 9.9005316...e-01, -9.2143464...e-03], + [ -6.3758553...e-04, -1.1577319...e-03, 9.1296320...e-01]]) + + Using *Bradford* transform: + + >>> XYZ_p = np.array([0.95045593, 1.00000000, 1.08905775]) + >>> XYZ_n = np.array([0.96429568, 1.00000000, 0.82510460]) + >>> transform = "Bradford" + >>> matrix_chromatic_adaptation_vk20(XYZ_p, XYZ_n, transform=transform) + ... # doctest: +ELLIPSIS + array([[ 1.0367230..., 0.0195580..., -0.0219321...], + [ 0.0276321..., 0.9822296..., -0.0082419...], + [-0.0029508..., 0.0040690..., 0.9102430...]]) + """ + + XYZ_n = as_float_array(XYZ_n) + XYZ_r = as_float_array(XYZ_r) + XYZ_p = as_float_array(XYZ_p) + + transform = validate_method( + transform, + tuple(CHROMATIC_ADAPTATION_TRANSFORMS), + '"{0}" chromatic adaptation transform is invalid, it must be one of {1}!', + ) + + M = CHROMATIC_ADAPTATION_TRANSFORMS[transform] + + D_n, D_r, D_p = coefficients + + LMS_n = vecmul(M, XYZ_n) + LMS_r = vecmul(M, XYZ_r) + LMS_p = vecmul(M, XYZ_p) + + with sdiv_mode(): + D = row_as_diagonal(sdiv(1, (D_n * LMS_n + D_r * LMS_r + D_p * LMS_p))) + + M_CAT = np.matmul(np.linalg.inv(M), D) + M_CAT = np.matmul(M_CAT, M) + + return M_CAT + + +def chromatic_adaptation_vK20( + XYZ: ArrayLike, + XYZ_p: ArrayLike, + XYZ_n: ArrayLike, + XYZ_r: ArrayLike = TVS_XYZ_R_VK20, + transform: Literal[ + "Bianco 2010", + "Bianco PC 2010", + "Bradford", + "CAT02 Brill 2008", + "CAT02", + "CAT16", + "CMCCAT2000", + "CMCCAT97", + "Fairchild", + "Sharp", + "Von Kries", + "XYZ Scaling", + ] + | str = "CAT02", + coefficients: Coefficients_DegreeOfAdaptation_vK20 = ( + CONDITIONS_DEGREE_OF_ADAPTATION_VK20["Fairchild"] + ), +) -> NDArrayFloat: + """ + Adapt given stimulus from previous viewing conditions to adapting viewing + conditions using *Von Kries 2020* (*vK20*) method. + + Parameters + ---------- + XYZ + *CIE XYZ* tristimulus values of stimulus to adapt. + XYZ_p + Previous viewing conditions *CIE XYZ* tristimulus values of whitepoint. + XYZ_n + Adapting viewing conditions *CIE XYZ* tristimulus values of whitepoint. + XYZ_r + Reference viewing conditions *CIE XYZ* tristimulus values of + whitepoint. + transform + Chromatic adaptation transform. + coefficients + *vK20* degree of adaptation coefficients. + + Returns + ------- + :class:`numpy.ndarray` + *CIE XYZ_c* tristimulus values of the stimulus corresponding colour. + + Notes + ----- + +------------+-----------------------+---------------+ + | **Domain** | **Scale - Reference** | **Scale - 1** | + +============+=======================+===============+ + | ``XYZ`` | [0, 1] | [0, 1] | + +------------+-----------------------+---------------+ + | ``XYZ_p`` | [0, 1] | [0, 1] | + +------------+-----------------------+---------------+ + | ``XYZ_n`` | [0, 1] | [0, 1] | + +------------+-----------------------+---------------+ + | ``XYZ_r`` | [0, 1] | [0, 1] | + +------------+-----------------------+---------------+ + + +------------+-----------------------+---------------+ + | **Range** | **Scale - Reference** | **Scale - 1** | + +============+=======================+===============+ + | ``XYZ_a`` | [0, 1] | [0, 1] | + +------------+-----------------------+---------------+ + + References + ---------- + :cite:`Fairchild2020` + + Examples + -------- + >>> XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) + >>> XYZ_p = np.array([0.95045593, 1.00000000, 1.08905775]) + >>> XYZ_n = np.array([0.96429568, 1.00000000, 0.82510460]) + >>> chromatic_adaptation_vK20(XYZ, XYZ_p, XYZ_n) + ... # doctest: +ELLIPSIS + array([ 0.2146884..., 0.1245616..., 0.0466255...]) + + Using *Bradford* transform: + + >>> XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) + >>> XYZ_p = np.array([0.95045593, 1.00000000, 1.08905775]) + >>> XYZ_n = np.array([0.96429568, 1.00000000, 0.82510460]) + >>> transform = "Bradford" + >>> chromatic_adaptation_vK20(XYZ, XYZ_p, XYZ_n, transform=transform) + ... # doctest: +ELLIPSIS + array([ 0.2153837..., 0.1250885..., 0.0466455...]) + """ + + XYZ = to_domain_1(XYZ) + XYZ_p = to_domain_1(XYZ_p) + XYZ_n = to_domain_1(XYZ_n) + XYZ_r = to_domain_1(XYZ_r) + + M_CAT = matrix_chromatic_adaptation_vk20( + XYZ_p, XYZ_n, XYZ_r, transform, coefficients + ) + XYZ_a = vecmul(M_CAT, XYZ) + + return from_range_1(XYZ_a) diff --git a/colour/adaptation/tests/test__init__.py b/colour/adaptation/tests/test__init__.py index dc2cf044cd..e27bf38787 100644 --- a/colour/adaptation/tests/test__init__.py +++ b/colour/adaptation/tests/test__init__.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.adaptation` module.""" -import unittest import numpy as np @@ -21,7 +19,7 @@ ] -class TestChromaticAdaptation(unittest.TestCase): +class TestChromaticAdaptation: """ Define :func:`colour.adaptation.chromatic_adaptation` definition unit tests methods. @@ -66,9 +64,7 @@ def test_chromatic_adaptation(self): Y_n = 200 np.testing.assert_allclose( - chromatic_adaptation( - XYZ, XYZ_w, XYZ_wr, method="Fairchild 1990", Y_n=Y_n - ), + chromatic_adaptation(XYZ, XYZ_w, XYZ_wr, method="Fairchild 1990", Y_n=Y_n), np.array([0.21394049, 0.12262315, 0.03891917]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -124,7 +120,3 @@ def test_domain_range_scale_chromatic_adaptation(self): value * factor, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/adaptation/tests/test_cie1994.py b/colour/adaptation/tests/test_cie1994.py index 4e052e921e..bbb96a54c4 100644 --- a/colour/adaptation/tests/test_cie1994.py +++ b/colour/adaptation/tests/test_cie1994.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.adaptation.cie1994` module.""" -import unittest from itertools import product import numpy as np @@ -22,7 +20,7 @@ ] -class TestChromaticAdaptationCIE1994(unittest.TestCase): +class TestChromaticAdaptationCIE1994: """ Define :func:`colour.adaptation.cie1994.chromatic_adaptation_CIE1994` definition unit tests methods. @@ -85,9 +83,7 @@ def test_n_dimensional_chromatic_adaptation_CIE1994(self): Y_o = 20 E_o1 = 1000 E_o2 = 1000 - XYZ_2 = chromatic_adaptation_CIE1994( - XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2 - ) + XYZ_2 = chromatic_adaptation_CIE1994(XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2) XYZ_1 = np.tile(XYZ_1, (6, 1)) XYZ_2 = np.tile(XYZ_2, (6, 1)) @@ -133,9 +129,7 @@ def test_domain_range_scale_chromatic_adaptation_CIE1994(self): Y_o = 20 E_o1 = 1000 E_o2 = 1000 - XYZ_2 = chromatic_adaptation_CIE1994( - XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2 - ) + XYZ_2 = chromatic_adaptation_CIE1994(XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2) d_r = (("reference", 1), ("1", 0.01), ("100", 1)) for scale, factor in d_r: @@ -165,7 +159,3 @@ def test_nan_chromatic_adaptation_CIE1994(self): cases[..., 0], cases[..., 0], ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/adaptation/tests/test_cmccat2000.py b/colour/adaptation/tests/test_cmccat2000.py index dbebf4d2e0..4e9c809f78 100644 --- a/colour/adaptation/tests/test_cmccat2000.py +++ b/colour/adaptation/tests/test_cmccat2000.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.adaptation.cmccat2000.""" -import unittest from itertools import product import numpy as np @@ -26,7 +24,7 @@ ] -class TestChromaticAdaptationForwardCMCCAT2000(unittest.TestCase): +class TestChromaticAdaptationForwardCMCCAT2000: """ Define :func:`colour.adaptation.cmccat2000.\ chromatic_adaptation_forward_CMCCAT2000` definition unit tests methods. @@ -86,16 +84,12 @@ def test_n_dimensional_chromatic_adaptation_forward_CMCCAT2000(self): XYZ_wr = np.array([94.81, 100.00, 107.30]) L_A1 = 200 L_A2 = 200 - XYZ_c = chromatic_adaptation_forward_CMCCAT2000( - XYZ, XYZ_w, XYZ_wr, L_A1, L_A2 - ) + XYZ_c = chromatic_adaptation_forward_CMCCAT2000(XYZ, XYZ_w, XYZ_wr, L_A1, L_A2) XYZ = np.tile(XYZ, (6, 1)) XYZ_c = np.tile(XYZ_c, (6, 1)) np.testing.assert_allclose( - chromatic_adaptation_forward_CMCCAT2000( - XYZ, XYZ_w, XYZ_wr, L_A1, L_A2 - ), + chromatic_adaptation_forward_CMCCAT2000(XYZ, XYZ_w, XYZ_wr, L_A1, L_A2), XYZ_c, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -105,9 +99,7 @@ def test_n_dimensional_chromatic_adaptation_forward_CMCCAT2000(self): L_A1 = np.tile(L_A1, 6) L_A2 = np.tile(L_A2, 6) np.testing.assert_allclose( - chromatic_adaptation_forward_CMCCAT2000( - XYZ, XYZ_w, XYZ_wr, L_A1, L_A2 - ), + chromatic_adaptation_forward_CMCCAT2000(XYZ, XYZ_w, XYZ_wr, L_A1, L_A2), XYZ_c, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -119,9 +111,7 @@ def test_n_dimensional_chromatic_adaptation_forward_CMCCAT2000(self): L_A2 = np.reshape(L_A2, (2, 3)) XYZ_c = np.reshape(XYZ_c, (2, 3, 3)) np.testing.assert_allclose( - chromatic_adaptation_forward_CMCCAT2000( - XYZ, XYZ_w, XYZ_wr, L_A1, L_A2 - ), + chromatic_adaptation_forward_CMCCAT2000(XYZ, XYZ_w, XYZ_wr, L_A1, L_A2), XYZ_c, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -138,9 +128,7 @@ def test_domain_range_scale_chromatic_adaptation_CMCCAT2000(self): XYZ_wr = np.array([94.81, 100.00, 107.30]) L_A1 = 200 L_A2 = 200 - XYZ_c = chromatic_adaptation_forward_CMCCAT2000( - XYZ, XYZ_w, XYZ_wr, L_A1, L_A2 - ) + XYZ_c = chromatic_adaptation_forward_CMCCAT2000(XYZ, XYZ_w, XYZ_wr, L_A1, L_A2) d_r = (("reference", 1), ("1", 0.01), ("100", 1)) for scale, factor in d_r: @@ -171,7 +159,7 @@ def test_nan_chromatic_adaptation_forward_CMCCAT2000(self): ) -class TestChromaticAdaptationInverseCMCCAT2000(unittest.TestCase): +class TestChromaticAdaptationInverseCMCCAT2000: """ Define :func:`colour.adaptation.cmccat2000.\ chromatic_adaptation_inverse_CMCCAT2000` definition unit tests methods. @@ -231,16 +219,12 @@ def test_n_dimensional_chromatic_adaptation_inverse_CMCCAT2000(self): XYZ_wr = np.array([94.81, 100.00, 107.30]) L_A1 = 200 L_A2 = 200 - XYZ = chromatic_adaptation_inverse_CMCCAT2000( - XYZ_c, XYZ_w, XYZ_wr, L_A1, L_A2 - ) + XYZ = chromatic_adaptation_inverse_CMCCAT2000(XYZ_c, XYZ_w, XYZ_wr, L_A1, L_A2) XYZ_c = np.tile(XYZ_c, (6, 1)) XYZ = np.tile(XYZ, (6, 1)) np.testing.assert_allclose( - chromatic_adaptation_inverse_CMCCAT2000( - XYZ_c, XYZ_w, XYZ_wr, L_A1, L_A2 - ), + chromatic_adaptation_inverse_CMCCAT2000(XYZ_c, XYZ_w, XYZ_wr, L_A1, L_A2), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -250,9 +234,7 @@ def test_n_dimensional_chromatic_adaptation_inverse_CMCCAT2000(self): L_A1 = np.tile(L_A1, 6) L_A2 = np.tile(L_A2, 6) np.testing.assert_allclose( - chromatic_adaptation_inverse_CMCCAT2000( - XYZ_c, XYZ_w, XYZ_wr, L_A1, L_A2 - ), + chromatic_adaptation_inverse_CMCCAT2000(XYZ_c, XYZ_w, XYZ_wr, L_A1, L_A2), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -264,9 +246,7 @@ def test_n_dimensional_chromatic_adaptation_inverse_CMCCAT2000(self): L_A2 = np.reshape(L_A2, (2, 3)) XYZ = np.reshape(XYZ, (2, 3, 3)) np.testing.assert_allclose( - chromatic_adaptation_inverse_CMCCAT2000( - XYZ_c, XYZ_w, XYZ_wr, L_A1, L_A2 - ), + chromatic_adaptation_inverse_CMCCAT2000(XYZ_c, XYZ_w, XYZ_wr, L_A1, L_A2), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -283,9 +263,7 @@ def test_domain_range_scale_chromatic_adaptation_CMCCAT2000(self): XYZ_wr = np.array([94.81, 100.00, 107.30]) L_A1 = 200 L_A2 = 200 - XYZ = chromatic_adaptation_inverse_CMCCAT2000( - XYZ_c, XYZ_w, XYZ_wr, L_A1, L_A2 - ) + XYZ = chromatic_adaptation_inverse_CMCCAT2000(XYZ_c, XYZ_w, XYZ_wr, L_A1, L_A2) d_r = (("reference", 1), ("1", 0.01), ("100", 1)) for scale, factor in d_r: @@ -314,7 +292,3 @@ def test_nan_chromatic_adaptation_inverse_CMCCAT2000(self): chromatic_adaptation_inverse_CMCCAT2000( cases, cases, cases, cases[..., 0], cases[..., 0] ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/adaptation/tests/test_fairchild1990.py b/colour/adaptation/tests/test_fairchild1990.py index 17a8cd7962..d7fbb5b478 100644 --- a/colour/adaptation/tests/test_fairchild1990.py +++ b/colour/adaptation/tests/test_fairchild1990.py @@ -1,8 +1,6 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.adaptation.fairchild1990` module.""" import contextlib -import unittest from itertools import product import numpy as np @@ -24,7 +22,7 @@ ] -class TestChromaticAdaptationFairchild1990(unittest.TestCase): +class TestChromaticAdaptationFairchild1990: """ Define :func:`colour.adaptation.fairchild1990.\ chromatic_adaptation_Fairchild1990` definition unit tests methods. @@ -148,7 +146,3 @@ def test_nan_chromatic_adaptation_Fairchild1990(self): Y_n = case[0] with contextlib.suppress(LinAlgError): chromatic_adaptation_Fairchild1990(XYZ_1, XYZ_n, XYZ_r, Y_n) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/adaptation/tests/test_fairchild2020.py b/colour/adaptation/tests/test_fairchild2020.py new file mode 100644 index 0000000000..9827062427 --- /dev/null +++ b/colour/adaptation/tests/test_fairchild2020.py @@ -0,0 +1,329 @@ +""" +Define the unit tests for the :mod:`colour.adaptation.fairchild2020` module. +""" + +import unittest +from itertools import product + +import numpy as np + +from colour.adaptation import ( + chromatic_adaptation_vK20, + matrix_chromatic_adaptation_vk20, +) +from colour.adaptation.fairchild2020 import ( + CONDITIONS_DEGREE_OF_ADAPTATION_VK20, +) +from colour.constants import TOLERANCE_ABSOLUTE_TESTS +from colour.utilities import domain_range_scale, ignore_numpy_errors + +__author__ = "Colour Developers" +__copyright__ = "Copyright 2013 Colour Developers" +__license__ = "New BSD License - https://opensource.org/licenses/BSD-3-Clause" +__maintainer__ = "Colour Developers" +__email__ = "colour-developers@colour-science.org" +__status__ = "Production" + +__all__ = [ + "TestMatrixChromaticAdaptationVonKries", + "TestChromaticAdaptationVonKries", +] + + +class TestMatrixChromaticAdaptationVonKries(unittest.TestCase): + """ + Define :func:`colour.adaptation.fairchild2020.\ +matrix_chromatic_adaptation_vk20` definition unit tests methods. + """ + + def test_matrix_chromatic_adaptation_vk20(self): + """ + Test :func:`colour.adaptation.fairchild2020.\ +matrix_chromatic_adaptation_vk20` definition. + """ + + np.testing.assert_array_almost_equal( + matrix_chromatic_adaptation_vk20( + np.array([0.95045593, 1.00000000, 1.08905775]), + np.array([0.96429568, 1.00000000, 0.82510460]), + ), + np.array( + [ + [1.02791390, 0.02913712, -0.02279407], + [0.02070284, 0.99005317, -0.00921435], + [-0.00063759, -0.00115773, 0.91296320], + ] + ), + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_array_almost_equal( + matrix_chromatic_adaptation_vk20( + np.array([0.95045593, 1.00000000, 1.08905775]), + np.array([1.09846607, 1.00000000, 0.35582280]), + ), + np.array( + [ + [0.94760338, -0.05816939, 0.06647414], + [-0.04151006, 1.02361127, 0.02667016], + [0.00163074, 0.00391656, 1.29341031], + ] + ), + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_array_almost_equal( + matrix_chromatic_adaptation_vk20( + np.array([0.95045593, 1.00000000, 1.08905775]), + np.array([0.96429568, 1.00000000, 0.82510460]), + transform="XYZ Scaling", + ), + np.array( + [ + [1.03217229, 0.00000000, 0.00000000], + [0.00000000, 1.00000000, 0.00000000], + [0.00000000, 0.00000000, 0.91134516], + ] + ), + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_array_almost_equal( + matrix_chromatic_adaptation_vk20( + np.array([0.95045593, 1.00000000, 1.08905775]), + np.array([0.96429568, 1.00000000, 0.82510460]), + transform="Bradford", + ), + np.array( + [ + [1.03672305, 0.01955802, -0.02193210], + [0.02763218, 0.98222961, -0.00824197], + [-0.00295083, 0.00406903, 0.91024305], + ] + ), + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_array_almost_equal( + matrix_chromatic_adaptation_vk20( + np.array([0.95045593, 1.00000000, 1.08905775]), + np.array([0.96429568, 1.00000000, 0.82510460]), + transform="Von Kries", + coefficients=CONDITIONS_DEGREE_OF_ADAPTATION_VK20["Simple Von Kries"], + ), + np.array( + [ + [0.98446157, -0.05474538, 0.06773143], + [-0.00601339, 1.00479590, 0.00121235], + [0.00000000, 0.00000000, 1.31990977], + ] + ), + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + def test_n_dimensional_matrix_chromatic_adaptation_vk20(self): + """ + Test :func:`colour.adaptation.fairchild2020.\ +matrix_chromatic_adaptation_vk20` definition n-dimensional arrays support. + """ + + XYZ_p = np.array([0.95045593, 1.00000000, 1.08905775]) + XYZ_n = np.array([0.96429568, 1.00000000, 0.82510460]) + M = matrix_chromatic_adaptation_vk20(XYZ_p, XYZ_n) + + XYZ_p = np.tile(XYZ_p, (6, 1)) + XYZ_n = np.tile(XYZ_n, (6, 1)) + M = np.reshape(np.tile(M, (6, 1)), (6, 3, 3)) + np.testing.assert_array_almost_equal( + matrix_chromatic_adaptation_vk20(XYZ_p, XYZ_n), + M, + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + XYZ_p = np.reshape(XYZ_p, (2, 3, 3)) + XYZ_n = np.reshape(XYZ_n, (2, 3, 3)) + M = np.reshape(M, (2, 3, 3, 3)) + np.testing.assert_array_almost_equal( + matrix_chromatic_adaptation_vk20(XYZ_p, XYZ_n), + M, + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + def test_domain_range_scale_matrix_chromatic_adaptation_vk20(self): + """ + Test :func:`colour.adaptation.fairchild2020.\ +matrix_chromatic_adaptation_vk20` definition domain and range scale + support. + """ + + XYZ_p = np.array([0.95045593, 1.00000000, 1.08905775]) + XYZ_n = np.array([0.96429568, 1.00000000, 0.82510460]) + XYZ_r = np.array([0.97941176, 1.00000000, 1.73235294]) + M = matrix_chromatic_adaptation_vk20(XYZ_p, XYZ_n) + + d_r = (("reference", 1), ("1", 1), ("100", 1)) + for scale, factor in d_r: + with domain_range_scale(scale): + np.testing.assert_array_almost_equal( + matrix_chromatic_adaptation_vk20( + XYZ_p * factor, XYZ_n * factor, XYZ_r * factor + ), + M, + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + @ignore_numpy_errors + def test_nan_matrix_chromatic_adaptation_vk20(self): + """ + Test :func:`colour.adaptation.fairchild2020.\ +matrix_chromatic_adaptation_vk20` definition nan support. + """ + + cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] + cases = np.array(list(set(product(cases, repeat=3)))) + matrix_chromatic_adaptation_vk20(cases, cases) + + +class TestChromaticAdaptationVonKries(unittest.TestCase): + """ + Define :func:`colour.adaptation.fairchild2020.chromatic_adaptation_vK20` + definition unit tests methods. + """ + + def test_chromatic_adaptation_vK20(self): + """ + Test :func:`colour.adaptation.fairchild2020.chromatic_adaptation_vK20` + definition. + """ + + np.testing.assert_array_almost_equal( + chromatic_adaptation_vK20( + np.array([0.20654008, 0.12197225, 0.05136952]), + np.array([0.95045593, 1.00000000, 1.08905775]), + np.array([0.96429568, 1.00000000, 0.82510460]), + ), + np.array([0.21468842, 0.12456164, 0.04662558]), + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_array_almost_equal( + chromatic_adaptation_vK20( + np.array([0.14222010, 0.23042768, 0.10495772]), + np.array([0.95045593, 1.00000000, 1.08905775]), + np.array([1.09846607, 1.00000000, 0.35582280]), + ), + np.array([0.12834138, 0.23276404, 0.13688781]), + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_array_almost_equal( + chromatic_adaptation_vK20( + np.array([0.07818780, 0.06157201, 0.28099326]), + np.array([0.95045593, 1.00000000, 1.08905775]), + np.array([0.99144661, 1.00000000, 0.67315942]), + ), + np.array([0.07908008, 0.06167829, 0.28354175]), + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_array_almost_equal( + chromatic_adaptation_vK20( + np.array([0.20654008, 0.12197225, 0.05136952]), + np.array([0.95045593, 1.00000000, 1.08905775]), + np.array([0.96429568, 1.00000000, 0.82510460]), + transform="XYZ Scaling", + ), + np.array([0.21318495, 0.12197225, 0.04681536]), + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_array_almost_equal( + chromatic_adaptation_vK20( + np.array([0.20654008, 0.12197225, 0.05136952]), + np.array([0.95045593, 1.00000000, 1.08905775]), + np.array([0.96429568, 1.00000000, 0.82510460]), + transform="Bradford", + ), + np.array([0.21538376, 0.12508852, 0.04664559]), + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_array_almost_equal( + chromatic_adaptation_vK20( + np.array([0.20654008, 0.12197225, 0.05136952]), + np.array([0.95045593, 1.00000000, 1.08905775]), + np.array([0.96429568, 1.00000000, 0.82510460]), + transform="Von Kries", + coefficients=CONDITIONS_DEGREE_OF_ADAPTATION_VK20["Simple Von Kries"], + ), + np.array([0.20013269, 0.12137749, 0.06780313]), + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + def test_n_dimensional_chromatic_adaptation_vK20(self): + """ + Test :func:`colour.adaptation.fairchild2020.chromatic_adaptation_vK20` + definition n-dimensional arrays support. + """ + + XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) + XYZ_p = np.array([0.95045593, 1.00000000, 1.08905775]) + XYZ_n = np.array([0.96429568, 1.00000000, 0.82510460]) + XYZ_a = chromatic_adaptation_vK20(XYZ, XYZ_p, XYZ_n) + + XYZ = np.tile(XYZ, (6, 1)) + XYZ_p = np.tile(XYZ_p, (6, 1)) + XYZ_n = np.tile(XYZ_n, (6, 1)) + XYZ_a = np.tile(XYZ_a, (6, 1)) + np.testing.assert_array_almost_equal( + chromatic_adaptation_vK20(XYZ, XYZ_p, XYZ_n), + XYZ_a, + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + XYZ = np.reshape(XYZ, (2, 3, 3)) + XYZ_p = np.reshape(XYZ_p, (2, 3, 3)) + XYZ_n = np.reshape(XYZ_n, (2, 3, 3)) + XYZ_a = np.reshape(XYZ_a, (2, 3, 3)) + np.testing.assert_array_almost_equal( + chromatic_adaptation_vK20(XYZ, XYZ_p, XYZ_n), + XYZ_a, + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + def test_domain_range_scale_chromatic_adaptation_vK20(self): + """ + Test :func:`colour.adaptation.fairchild2020.chromatic_adaptation_vK20` + definition domain and range scale support. + """ + + XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) + XYZ_p = np.array([0.95045593, 1.00000000, 1.08905775]) + XYZ_n = np.array([0.96429568, 1.00000000, 0.82510460]) + XYZ_r = np.array([0.97941176, 1.00000000, 1.73235294]) + XYZ_a = chromatic_adaptation_vK20(XYZ, XYZ_p, XYZ_n) + + d_r = (("reference", 1), ("1", 1), ("100", 100)) + for scale, factor in d_r: + with domain_range_scale(scale): + np.testing.assert_array_almost_equal( + chromatic_adaptation_vK20( + XYZ * factor, + XYZ_p * factor, + XYZ_n * factor, + XYZ_r * factor, + ), + XYZ_a * factor, + decimal=TOLERANCE_ABSOLUTE_TESTS, + ) + + @ignore_numpy_errors + def test_nan_chromatic_adaptation_vK20(self): + """ + Test :func:`colour.adaptation.fairchild2020.chromatic_adaptation_vK20` + definition nan support. + """ + + cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] + cases = np.array(list(set(product(cases, repeat=3)))) + chromatic_adaptation_vK20(cases, cases, cases) diff --git a/colour/adaptation/tests/test_vonkries.py b/colour/adaptation/tests/test_vonkries.py index 79b5c95677..a5b0bc55ea 100644 --- a/colour/adaptation/tests/test_vonkries.py +++ b/colour/adaptation/tests/test_vonkries.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.adaptation.vonkries` module.""" -import unittest from itertools import product import numpy as np @@ -26,7 +24,7 @@ ] -class TestMatrixChromaticAdaptationVonKries(unittest.TestCase): +class TestMatrixChromaticAdaptationVonKries: """ Define :func:`colour.adaptation.vonkries.\ matrix_chromatic_adaptation_VonKries` definition unit tests methods. @@ -158,7 +156,7 @@ def test_n_dimensional_matrix_chromatic_adaptation_VonKries(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - def test_domain_range_scale_chromatic_adaptation_VonKries(self): + def test_domain_range_scale_matrix_chromatic_adaptation_VonKries(self): """ Test :func:`colour.adaptation.vonkries.\ matrix_chromatic_adaptation_VonKries` definition domain and range scale @@ -169,7 +167,7 @@ def test_domain_range_scale_chromatic_adaptation_VonKries(self): XYZ_wr = np.array([0.96429568, 1.00000000, 0.82510460]) M = matrix_chromatic_adaptation_VonKries(XYZ_w, XYZ_wr) - d_r = (("reference", 1), ("1", 1), ("100", 0.01)) + d_r = (("reference", 1), ("1", 1), ("100", 100)) for scale, factor in d_r: with domain_range_scale(scale): np.testing.assert_allclose( @@ -192,7 +190,7 @@ def test_nan_matrix_chromatic_adaptation_VonKries(self): matrix_chromatic_adaptation_VonKries(cases, cases) -class TestChromaticAdaptationVonKries(unittest.TestCase): +class TestChromaticAdaptationVonKries: """ Define :func:`colour.adaptation.vonkries.chromatic_adaptation_VonKries` definition unit tests methods. @@ -309,7 +307,7 @@ def test_domain_range_scale_chromatic_adaptation_VonKries(self): XYZ_wr = np.array([0.96429568, 1.00000000, 0.82510460]) XYZ_a = chromatic_adaptation_VonKries(XYZ, XYZ_w, XYZ_wr) - d_r = (("reference", 1), ("1", 1), ("100", 0.01)) + d_r = (("reference", 1), ("1", 1), ("100", 100)) for scale, factor in d_r: with domain_range_scale(scale): np.testing.assert_allclose( @@ -330,7 +328,3 @@ def test_nan_chromatic_adaptation_VonKries(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) chromatic_adaptation_VonKries(cases, cases, cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/adaptation/tests/test_zhai2018.py b/colour/adaptation/tests/test_zhai2018.py index 3260eb0bc6..ad42fdfdf1 100644 --- a/colour/adaptation/tests/test_zhai2018.py +++ b/colour/adaptation/tests/test_zhai2018.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.adaptation.zhai2018` module.""" -import unittest from itertools import product import numpy as np @@ -22,7 +20,7 @@ ] -class TestChromaticAdaptationZhai2018(unittest.TestCase): +class TestChromaticAdaptationZhai2018: """ Define :func:`colour.adaptation.zhai2018.chromatic_adaptation_Zhai2018` definition unit tests methods. @@ -175,7 +173,3 @@ def test_nan_chromatic_adaptation_Zhai2018(self): chromatic_adaptation_Zhai2018( cases, cases, cases, cases[0, 0], cases[0, 0], cases ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/adaptation/vonkries.py b/colour/adaptation/vonkries.py index 040d378dbc..919a3298bf 100644 --- a/colour/adaptation/vonkries.py +++ b/colour/adaptation/vonkries.py @@ -2,7 +2,7 @@ Von Kries Chromatic Adaptation Model ==================================== -Defines the *Von Kries* chromatic adaptation model objects: +Define the *Von Kries* chromatic adaptation model objects: - :func:`colour.adaptation.matrix_chromatic_adaptation_VonKries` - :func:`colour.adaptation.chromatic_adaptation_VonKries` @@ -19,13 +19,14 @@ import numpy as np from colour.adaptation import CHROMATIC_ADAPTATION_TRANSFORMS -from colour.algebra import matrix_dot, sdiv, sdiv_mode, vector_dot +from colour.algebra import sdiv, sdiv_mode, vecmul from colour.hints import ( ArrayLike, LiteralChromaticAdaptationTransform, NDArrayFloat, ) from colour.utilities import ( + as_float_array, from_range_1, row_as_diagonal, to_domain_1, @@ -93,40 +94,39 @@ def matrix_chromatic_adaptation_VonKries( [ 0.0221934..., 1.0018566..., -0.0210737...], [-0.0011648..., -0.0034205..., 0.7617890...]]) - Using Bradford method: + Using *Bradford* transform: >>> XYZ_w = np.array([0.95045593, 1.00000000, 1.08905775]) >>> XYZ_wr = np.array([0.96429568, 1.00000000, 0.82510460]) - >>> method = "Bradford" - >>> matrix_chromatic_adaptation_VonKries(XYZ_w, XYZ_wr, method) + >>> transform = "Bradford" + >>> matrix_chromatic_adaptation_VonKries(XYZ_w, XYZ_wr, transform) ... # doctest: +ELLIPSIS array([[ 1.0479297..., 0.0229468..., -0.0501922...], [ 0.0296278..., 0.9904344..., -0.0170738...], [-0.0092430..., 0.0150551..., 0.7518742...]]) """ - XYZ_w = to_domain_1(XYZ_w) - XYZ_wr = to_domain_1(XYZ_wr) + XYZ_w = as_float_array(XYZ_w) + XYZ_wr = as_float_array(XYZ_wr) transform = validate_method( transform, tuple(CHROMATIC_ADAPTATION_TRANSFORMS), - '"{0}" chromatic adaptation transform is invalid, ' - "it must be one of {1}!", + '"{0}" chromatic adaptation transform is invalid, it must be one of {1}!', ) M = CHROMATIC_ADAPTATION_TRANSFORMS[transform] - RGB_w = np.einsum("...i,...ij->...j", XYZ_w, np.transpose(M)) - RGB_wr = np.einsum("...i,...ij->...j", XYZ_wr, np.transpose(M)) + RGB_w = vecmul(M, XYZ_w) + RGB_wr = vecmul(M, XYZ_wr) with sdiv_mode(): D = sdiv(RGB_wr, RGB_w) D = row_as_diagonal(D) - M_CAT = matrix_dot(np.linalg.inv(M), D) - M_CAT = matrix_dot(M_CAT, M) + M_CAT = np.matmul(np.linalg.inv(M), D) + M_CAT = np.matmul(M_CAT, M) return M_CAT @@ -173,7 +173,7 @@ def chromatic_adaptation_VonKries( +------------+-----------------------+---------------+ | **Range** | **Scale - Reference** | **Scale - 1** | +============+=======================+===============+ - | ``XYZ_c`` | [0, 1] | [0, 1] | + | ``XYZ_a`` | [0, 1] | [0, 1] | +------------+-----------------------+---------------+ References @@ -188,7 +188,7 @@ def chromatic_adaptation_VonKries( >>> chromatic_adaptation_VonKries(XYZ, XYZ_w, XYZ_wr) # doctest: +ELLIPSIS array([ 0.2163881..., 0.1257 , 0.0384749...]) - Using Bradford method: + Using *Bradford* transform: >>> XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) >>> XYZ_w = np.array([0.95045593, 1.00000000, 1.08905775]) @@ -202,6 +202,6 @@ def chromatic_adaptation_VonKries( XYZ = to_domain_1(XYZ) M_CAT = matrix_chromatic_adaptation_VonKries(XYZ_w, XYZ_wr, transform) - XYZ_a = vector_dot(M_CAT, XYZ) + XYZ_a = vecmul(M_CAT, XYZ) return from_range_1(XYZ_a) diff --git a/colour/adaptation/zhai2018.py b/colour/adaptation/zhai2018.py index a77b70adc6..8cf261ba79 100644 --- a/colour/adaptation/zhai2018.py +++ b/colour/adaptation/zhai2018.py @@ -2,7 +2,7 @@ Zhai and Luo (2018) Chromatic Adaptation Model ============================================== -Defines the *Zhai and Luo (2018)* chromatic adaptation model object: +Define the *Zhai and Luo (2018)* chromatic adaptation model object: - :func:`colour.adaptation.chromatic_adaptation_Zhai2018` @@ -16,7 +16,7 @@ import numpy as np from colour.adaptation import CHROMATIC_ADAPTATION_TRANSFORMS -from colour.algebra import vector_dot +from colour.algebra import vecmul from colour.hints import ArrayLike, Literal, NDArrayFloat, Union from colour.utilities import ( as_float_array, @@ -152,10 +152,10 @@ def chromatic_adaptation_Zhai2018( transform = validate_method(transform, ("CAT02", "CAT16")) M = CHROMATIC_ADAPTATION_TRANSFORMS[transform] - RGB_b = vector_dot(M, XYZ_b) - RGB_wb = vector_dot(M, XYZ_wb) - RGB_wd = vector_dot(M, XYZ_wd) - RGB_wo = vector_dot(M, XYZ_wo) + RGB_b = vecmul(M, XYZ_b) + RGB_wb = vecmul(M, XYZ_wb) + RGB_wd = vecmul(M, XYZ_wd) + RGB_wo = vecmul(M, XYZ_wo) D_RGB_b = D_b * (Y_wb / Y_wo) * (RGB_wo / RGB_wb) + 1 - D_b D_RGB_d = D_d * (Y_wd / Y_wo) * (RGB_wo / RGB_wd) + 1 - D_d @@ -164,6 +164,6 @@ def chromatic_adaptation_Zhai2018( RGB_d = D_RGB * RGB_b - XYZ_d = vector_dot(np.linalg.inv(M), RGB_d) + XYZ_d = vecmul(np.linalg.inv(M), RGB_d) return from_range_100(XYZ_d) diff --git a/colour/algebra/__init__.py b/colour/algebra/__init__.py index 77a2679e8e..2e7daba63c 100644 --- a/colour/algebra/__init__.py +++ b/colour/algebra/__init__.py @@ -16,8 +16,7 @@ spow, normalise_vector, normalise_maximum, - vector_dot, - matrix_dot, + vecmul, euclidean_distance, manhattan_distance, linear_conversion, @@ -65,8 +64,7 @@ "spow", "normalise_vector", "normalise_maximum", - "vector_dot", - "matrix_dot", + "vecmul", "euclidean_distance", "manhattan_distance", "linear_conversion", @@ -120,49 +118,22 @@ def __getattr__(self, attribute) -> Any: return super().__getattr__(attribute) -# v0.4.2 -API_CHANGES = { - "ObjectFutureAccessChange": [ +# v0.4.5 +API_CHANGES: dict = { + "ObjectRenamed": [ [ - "colour.algebra.ellipse_coefficients_general_form", - "colour.geometry.ellipse_coefficients_general_form", - ], - [ - "colour.algebra.ellipse_coefficients_canonical_form", - "colour.geometry.ellipse_coefficients_canonical_form", - ], - [ - "colour.algebra.point_at_angle_on_ellipse", - "colour.geometry.point_at_angle_on_ellipse", - ], - [ - "colour.algebra.ellipse_fitting_Halir1998", - "colour.geometry.ellipse_fitting_Halir1998", - ], - [ - "colour.algebra.ELLIPSE_FITTING_METHODS", - "colour.geometry.ELLIPSE_FITTING_METHODS", - ], - [ - "colour.algebra.ellipse_fitting", - "colour.geometry.ellipse_fitting", - ], - [ - "colour.algebra.extend_line_segment", - "colour.geometry.extend_line_segment", - ], - [ - "colour.algebra.extend_line_segment", - "colour.geometry.intersect_line_segments", - ], - [ - "colour.algebra.extend_line_segment", - "colour.geometry.LineSegmentsIntersections_Specification", + "colour.algebra.vector_dot", + "colour.algebra.vecmul", ], ] } """Defines the *colour.algebra* sub-package API changes.""" + +API_CHANGES["ObjectRemoved"] = [ # pyright: ignore + "colour.algebra.matrix_dot", +] + if not is_documentation_building(): sys.modules["colour.algebra"] = algebra( # pyright: ignore sys.modules["colour.algebra"], build_API_changes(API_CHANGES) diff --git a/colour/algebra/common.py b/colour/algebra/common.py index 93905ba75c..44da826520 100644 --- a/colour/algebra/common.py +++ b/colour/algebra/common.py @@ -2,7 +2,7 @@ Common Utilities ================ -Defines the common algebra utilities objects that don't fall in any specific +Define the common algebra utilities objects that don't fall in any specific category. """ @@ -47,8 +47,7 @@ "spow", "normalise_vector", "normalise_maximum", - "vector_dot", - "matrix_dot", + "vecmul", "euclidean_distance", "manhattan_distance", "linear_conversion", @@ -100,11 +99,9 @@ def get_sdiv_mode() -> ( -------- >>> with sdiv_mode("Numpy"): ... get_sdiv_mode() - ... 'numpy' >>> with sdiv_mode("Ignore Zero Conversion"): ... get_sdiv_mode() - ... 'ignore zero conversion' """ @@ -112,17 +109,19 @@ def get_sdiv_mode() -> ( def set_sdiv_mode( - mode: Literal[ - "Numpy", - "Ignore", - "Warning", - "Raise", - "Ignore Zero Conversion", - "Warning Zero Conversion", - "Ignore Limit Conversion", - "Warning Limit Conversion", - ] - | str + mode: ( + Literal[ + "Numpy", + "Ignore", + "Warning", + "Raise", + "Ignore Zero Conversion", + "Warning Zero Conversion", + "Ignore Limit Conversion", + "Warning Limit Conversion", + ] + | str + ), ): """ Set *Colour* safe division function mode. @@ -139,7 +138,6 @@ def set_sdiv_mode( ... print(get_sdiv_mode()) ... set_sdiv_mode("Raise") ... print(get_sdiv_mode()) - ... ignore zero conversion raise """ @@ -187,17 +185,19 @@ class sdiv_mode: def __init__( self, - mode: Literal[ - "Numpy", - "Ignore", - "Warning", - "Raise", - "Ignore Zero Conversion", - "Warning Zero Conversion", - "Ignore Limit Conversion", - "Warning Limit Conversion", - ] - | None = None, + mode: ( + Literal[ + "Numpy", + "Ignore", + "Warning", + "Raise", + "Ignore Zero Conversion", + "Warning Zero Conversion", + "Ignore Limit Conversion", + "Warning Limit Conversion", + ] + | None + ) = None, ) -> None: self._mode = optional(mode, get_sdiv_mode()) self._previous_mode = get_sdiv_mode() @@ -283,23 +283,18 @@ def sdiv(a: ArrayLike, b: ArrayLike) -> NDArrayFloat: ... sdiv(a, b) ... except Exception as error: ... error # doctest: +ELLIPSIS - ... FloatingPointError('divide by zero encountered in...divide') >>> with sdiv_mode("Ignore Zero Conversion"): ... sdiv(a, b) - ... array([ 0., 1., 0.]) >>> with sdiv_mode("Warning Zero Conversion"): ... sdiv(a, b) - ... array([ 0., 1., 0.]) >>> with sdiv_mode("Ignore Limit Conversion"): ... sdiv(a, b) # doctest: +SKIP - ... array([ 0.00000000e+000, 1.00000000e+000, 1.79769313e+308]) >>> with sdiv_mode("Warning Limit Conversion"): ... sdiv(a, b) # doctest: +SKIP - ... array([ 0.00000000e+000, 1.00000000e+000, 1.79769313e+308]) """ @@ -367,11 +362,9 @@ def is_spow_enabled() -> bool: -------- >>> with spow_enable(False): ... is_spow_enabled() - ... False >>> with spow_enable(True): ... is_spow_enabled() - ... True """ @@ -393,7 +386,6 @@ def set_spow_enable(enable: bool): ... print(is_spow_enabled()) ... set_spow_enable(False) ... print(is_spow_enabled()) - ... True False """ @@ -561,13 +553,15 @@ def normalise_maximum( return np.clip(a, 0, factor) if clip else a -def vector_dot(m: ArrayLike, v: ArrayLike) -> NDArrayFloat: +def vecmul(m: ArrayLike, v: ArrayLike) -> NDArrayFloat: """ - Perform the dot product of the matrix array :math:`m` with the vector - array :math:`v`. + Perform the batched multiplication between the matrix array :math:`m` and + vector array :math:`v`. - This definition is a convenient wrapper around :func:`np.einsum` with the - following subscripts: *'...ij,...j->...i'*. + It is in intent equivalent to :func:`np.matmul` but with the specific intent + of vector multiplication by a matrix. With that intent, vector dimensionality + will be increased to enable broadcasting. This definition can be expressed + with :func:`np.einsum` using the following subscripts: *'...ij,...j->...i'*. Parameters ---------- @@ -579,7 +573,7 @@ def vector_dot(m: ArrayLike, v: ArrayLike) -> NDArrayFloat: Returns ------- :class:`numpy.ndarray` - Transformed vector array :math:`v`. + Multiplied vector array :math:`v`. Examples -------- @@ -593,7 +587,7 @@ def vector_dot(m: ArrayLike, v: ArrayLike) -> NDArrayFloat: >>> m = np.reshape(np.tile(m, (6, 1)), (6, 3, 3)) >>> v = np.array([0.20654008, 0.12197225, 0.05136952]) >>> v = np.tile(v, (6, 1)) - >>> vector_dot(m, v) # doctest: +ELLIPSIS + >>> vecmul(m, v) # doctest: +ELLIPSIS array([[ 0.1954094..., 0.0620396..., 0.0527952...], [ 0.1954094..., 0.0620396..., 0.0527952...], [ 0.1954094..., 0.0620396..., 0.0527952...], @@ -602,68 +596,7 @@ def vector_dot(m: ArrayLike, v: ArrayLike) -> NDArrayFloat: [ 0.1954094..., 0.0620396..., 0.0527952...]]) """ - return np.einsum("...ij,...j->...i", as_float_array(m), as_float_array(v)) - - -def matrix_dot(a: ArrayLike, b: ArrayLike) -> NDArrayFloat: - """ - Perform the dot product of the matrix array :math:`a` with the matrix - array :math:`b`. - - This definition is a convenient wrapper around :func:`np.einsum` with the - following subscripts: *'...ij,...jk->...ik'*. - - Parameters - ---------- - a - Matrix array :math:`a`. - b - Matrix array :math:`b`. - - Returns - ------- - :class:`numpy.ndarray` - - Examples - -------- - >>> a = np.array( - ... [ - ... [0.7328, 0.4296, -0.1624], - ... [-0.7036, 1.6975, 0.0061], - ... [0.0030, 0.0136, 0.9834], - ... ] - ... ) - >>> a = np.reshape(np.tile(a, (6, 1)), (6, 3, 3)) - >>> b = a - >>> matrix_dot(a, b) # doctest: +ELLIPSIS - array([[[ 0.2342420..., 1.0418482..., -0.2760903...], - [-1.7099407..., 2.5793226..., 0.1306181...], - [-0.0044203..., 0.0377490..., 0.9666713...]], - - [[ 0.2342420..., 1.0418482..., -0.2760903...], - [-1.7099407..., 2.5793226..., 0.1306181...], - [-0.0044203..., 0.0377490..., 0.9666713...]], - - [[ 0.2342420..., 1.0418482..., -0.2760903...], - [-1.7099407..., 2.5793226..., 0.1306181...], - [-0.0044203..., 0.0377490..., 0.9666713...]], - - [[ 0.2342420..., 1.0418482..., -0.2760903...], - [-1.7099407..., 2.5793226..., 0.1306181...], - [-0.0044203..., 0.0377490..., 0.9666713...]], - - [[ 0.2342420..., 1.0418482..., -0.2760903...], - [-1.7099407..., 2.5793226..., 0.1306181...], - [-0.0044203..., 0.0377490..., 0.9666713...]], - - [[ 0.2342420..., 1.0418482..., -0.2760903...], - [-1.7099407..., 2.5793226..., 0.1306181...], - [-0.0044203..., 0.0377490..., 0.9666713...]]]) - """ - - return np.einsum( - "...ij,...jk->...ik", as_float_array(a), as_float_array(b) - ) + return np.matmul(as_float_array(m), as_float_array(v)[..., None]).squeeze(-1) def euclidean_distance(a: ArrayLike, b: ArrayLike) -> NDArrayFloat: @@ -695,9 +628,7 @@ def euclidean_distance(a: ArrayLike, b: ArrayLike) -> NDArrayFloat: 451.7133019... """ - return as_float( - np.linalg.norm(as_float_array(a) - as_float_array(b), axis=-1) - ) + return as_float(np.linalg.norm(as_float_array(a) - as_float_array(b), axis=-1)) def manhattan_distance(a: ArrayLike, b: ArrayLike) -> NDArrayFloat: @@ -729,9 +660,7 @@ def manhattan_distance(a: ArrayLike, b: ArrayLike) -> NDArrayFloat: 604.9396351... """ - return as_float( - np.sum(np.abs(as_float_array(a) - as_float_array(b)), axis=-1) - ) + return as_float(np.sum(np.abs(as_float_array(a) - as_float_array(b)), axis=-1)) def linear_conversion( @@ -831,9 +760,9 @@ def smoothstep_function( x Array :math:`x`. a - Low input domain limit, i.e. the left edge. + Low input domain limit, i.e., the left edge. b - High input domain limit, i.e. the right edge. + High input domain limit, i.e., the right edge. clip Whether to scale, bias and clip input values to domain [``a``, ``b``]. @@ -877,9 +806,9 @@ def is_identity(a: ArrayLike) -> bool: Examples -------- - >>> is_identity(np.array([1, 0, 0, 0, 1, 0, 0, 0, 1]).reshape(3, 3)) + >>> is_identity(np.reshape(np.array([1, 0, 0, 0, 1, 0, 0, 0, 1]), (3, 3))) True - >>> is_identity(np.array([1, 2, 0, 0, 1, 0, 0, 0, 1]).reshape(3, 3)) + >>> is_identity(np.reshape(np.array([1, 2, 0, 0, 1, 0, 0, 0, 1]), (3, 3))) False """ diff --git a/colour/algebra/coordinates/tests/test_transformations.py b/colour/algebra/coordinates/tests/test_transformations.py index 182674c691..6595ff4aec 100644 --- a/colour/algebra/coordinates/tests/test_transformations.py +++ b/colour/algebra/coordinates/tests/test_transformations.py @@ -3,7 +3,6 @@ :mod:`colour.algebra.coordinates.transformations` module. """ -import unittest from itertools import product import numpy as np @@ -36,7 +35,7 @@ ] -class TestCartesianToSpherical(unittest.TestCase): +class TestCartesianToSpherical: """ Define :func:`colour.algebra.coordinates.transformations.\ cartesian_to_spherical` definition unit tests methods. @@ -99,7 +98,7 @@ def test_nan_cartesian_to_spherical(self): cartesian_to_spherical(cases) -class TestSphericalToCartesian(unittest.TestCase): +class TestSphericalToCartesian: """ Define :func:`colour.algebra.coordinates.transformations.\ spherical_to_cartesian` definition unit tests methods. @@ -112,25 +111,19 @@ def test_spherical_to_cartesian(self): """ np.testing.assert_allclose( - spherical_to_cartesian( - np.array([6.78232998, 0.48504979, 0.32175055]) - ), + spherical_to_cartesian(np.array([6.78232998, 0.48504979, 0.32175055])), np.array([3.00000000, 0.99999999, 6.00000000]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - spherical_to_cartesian( - np.array([18.38477631, 0.51501513, 1.68145355]) - ), + spherical_to_cartesian(np.array([18.38477631, 0.51501513, 1.68145355])), np.array([-1.00000003, 9.00000007, 15.99999996]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - spherical_to_cartesian( - np.array([19.64342307, 0.33250603, -0.14626640]) - ), + spherical_to_cartesian(np.array([19.64342307, 0.33250603, -0.14626640])), np.array([6.34339996, -0.93449999, 18.56750001]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -168,7 +161,7 @@ def test_nan_spherical_to_cartesian(self): spherical_to_cartesian(cases) -class TestCartesianToPolar(unittest.TestCase): +class TestCartesianToPolar: """ Define :func:`colour.algebra.coordinates.transformations.\ cartesian_to_polar` definition unit tests methods. @@ -231,7 +224,7 @@ def test_nan_cartesian_to_polar(self): cartesian_to_polar(cases) -class TestPolarToCartesian(unittest.TestCase): +class TestPolarToCartesian: """ Define :func:`colour.algebra.coordinates.transformations.\ polar_to_cartesian` definition unit tests methods. @@ -294,7 +287,7 @@ def test_nan_polar_to_cartesian(self): polar_to_cartesian(cases) -class TestCartesianToCylindrical(unittest.TestCase): +class TestCartesianToCylindrical: """ Define :func:`colour.algebra.coordinates.transformations.\ cartesian_to_cylindrical` definition unit tests methods. @@ -357,7 +350,7 @@ def test_nan_cartesian_to_cylindrical(self): cartesian_to_cylindrical(cases) -class TestCylindricalToCartesian(unittest.TestCase): +class TestCylindricalToCartesian: """ Define :func:`colour.algebra.coordinates.transformations.\ cylindrical_to_cartesian` definition unit tests methods. @@ -370,25 +363,19 @@ def test_cylindrical_to_cartesian(self): """ np.testing.assert_allclose( - cylindrical_to_cartesian( - np.array([0.32175055, 1.08574654, 6.78232998]) - ), + cylindrical_to_cartesian(np.array([0.32175055, 1.08574654, 6.78232998])), np.array([0.15001697, 0.28463718, 6.78232998]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - cylindrical_to_cartesian( - np.array([1.68145355, 1.05578119, 18.38477631]) - ), + cylindrical_to_cartesian(np.array([1.68145355, 1.05578119, 18.38477631])), np.array([0.82819662, 1.46334425, 18.38477631]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - cylindrical_to_cartesian( - np.array([-0.14626640, 1.23829030, 19.64342307]) - ), + cylindrical_to_cartesian(np.array([-0.14626640, 1.23829030, 19.64342307])), np.array([-0.04774323, -0.13825500, 19.64342307]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -424,7 +411,3 @@ def test_nan_cylindrical_to_cartesian(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) cylindrical_to_cartesian(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/algebra/coordinates/transformations.py b/colour/algebra/coordinates/transformations.py index a29d75eef9..8bbb2475d6 100644 --- a/colour/algebra/coordinates/transformations.py +++ b/colour/algebra/coordinates/transformations.py @@ -2,7 +2,7 @@ Coordinates System Transformations ================================== -Defines the objects to apply transformations on coordinates systems. +Define the objects to apply transformations on coordinates systems. The following transformations are available: @@ -68,8 +68,8 @@ def cartesian_to_spherical(a: ArrayLike) -> NDArrayFloat: ------- :class:`numpy.ndarray` Spherical coordinates array :math:`\\rho\\theta\\phi`, :math:`\\rho` is - in range [0, +inf], :math:`\\theta` is in range [0, pi] radians, i.e. - [0, 180] degrees, and :math:`\\phi` is in range [-pi, pi] radians, i.e. + in range [0, +inf], :math:`\\theta` is in range [0, pi] radians, i.e., + [0, 180] degrees, and :math:`\\phi` is in range [-pi, pi] radians, i.e., [-180, 180] degrees. References @@ -106,8 +106,8 @@ def spherical_to_cartesian(a: ArrayLike) -> NDArrayFloat: a Spherical coordinates array :math:`\\rho\\theta\\phi` to transform, :math:`\\rho` is in range [0, +inf], :math:`\\theta` is in range - [0, pi] radians, i.e. [0, 180] degrees, and :math:`\\phi` is in range - [-pi, pi] radians, i.e. [-180, 180] degrees. + [0, pi] radians, i.e., [0, 180] degrees, and :math:`\\phi` is in range + [-pi, pi] radians, i.e., [-180, 180] degrees. Returns ------- @@ -151,7 +151,7 @@ def cartesian_to_polar(a: ArrayLike) -> NDArrayFloat: ------- :class:`numpy.ndarray` Polar coordinates array :math:`\\rho\\phi`, :math:`\\rho` is - in range [0, +inf], :math:`\\phi` is in range [-pi, pi] radians, i.e. + in range [0, +inf], :math:`\\phi` is in range [-pi, pi] radians, i.e., [-180, 180] degrees. References @@ -183,7 +183,7 @@ def polar_to_cartesian(a: ArrayLike) -> NDArrayFloat: a Polar coordinates array :math:`\\rho\\phi` to transform, :math:`\\rho` is in range [0, +inf], :math:`\\phi` is in range [-pi, pi] radians - i.e. [-180, 180] degrees. + i.e., [-180, 180] degrees. Returns ------- @@ -224,7 +224,7 @@ def cartesian_to_cylindrical(a: ArrayLike) -> NDArrayFloat: ------- :class:`numpy.ndarray` Cylindrical coordinates array :math:`\\rho\\phi z`, :math:`\\rho` is in - range [0, +inf], :math:`\\phi` is in range [-pi, pi] radians i.e. + range [0, +inf], :math:`\\phi` is in range [-pi, pi] radians i.e., [-180, 180] degrees, :math:`z` is in range [0, +inf]. References @@ -256,7 +256,7 @@ def cylindrical_to_cartesian(a: ArrayLike) -> NDArrayFloat: a Cylindrical coordinates array :math:`\\rho\\phi z` to transform, :math:`\\rho` is in range [0, +inf], :math:`\\phi` is in range - [-pi, pi] radians i.e. [-180, 180] degrees, :math:`z` is in range + [-pi, pi] radians i.e., [-180, 180] degrees, :math:`z` is in range [0, +inf]. Returns diff --git a/colour/algebra/extrapolation.py b/colour/algebra/extrapolation.py index 7ca33eecdd..271af7f9aa 100644 --- a/colour/algebra/extrapolation.py +++ b/colour/algebra/extrapolation.py @@ -2,7 +2,7 @@ Extrapolation ============= -Defines the classes for extrapolating variables: +Define the classes for extrapolating variables: - :class:`colour.Extrapolator`: 1-D function extrapolation. @@ -37,7 +37,6 @@ as_float_array, attest, is_numeric, - is_string, optional, validate_method, ) @@ -218,7 +217,7 @@ def method(self, value: Literal["Linear", "Constant"] | str): """Setter for the **self.method** property.""" attest( - is_string(value), + isinstance(value, str), f'"method" property: "{value}" type is not "str"!', ) diff --git a/colour/algebra/interpolation.py b/colour/algebra/interpolation.py index d5752a710a..bb08f32510 100644 --- a/colour/algebra/interpolation.py +++ b/colour/algebra/interpolation.py @@ -2,7 +2,7 @@ Interpolation ============= -Defines the classes and definitions for interpolating variables. +Define the classes and definitions for interpolating variables. - :class:`colour.KernelInterpolator`: 1-D function generic interpolation with arbitrary kernel. @@ -302,10 +302,7 @@ def kernel_cardinal_spline( x_abs = np.abs(x) y = np.where( x_abs < 1, - (-6 * a - 9 * b + 12) * x_abs**3 - + (6 * a + 12 * b - 18) * x_abs**2 - - 2 * b - + 6, + (-6 * a - 9 * b + 12) * x_abs**3 + (6 * a + 12 * b - 18) * x_abs**2 - 2 * b + 6, (-6 * a - b) * x_abs**3 + (30 * a + 6 * b) * x_abs**2 + (-48 * a - 12 * b) * x_abs @@ -543,9 +540,7 @@ def window(self) -> float: def window(self, value: float): """Setter for the **self.window** property.""" - attest( - bool(value >= 1), '"window" must be equal to or greater than 1!' - ) + attest(bool(value >= 1), '"window" must be equal to or greater than 1!') self._window = value @@ -690,9 +685,7 @@ def _evaluate(self, x: NDArrayFloat) -> NDArrayFloat: x_interval = interval(self._x)[0] x_f = np.floor(x / x_interval) - windows = x_f[..., None] + np.arange( - -self._window + 1, self._window + 1 - ) + windows = x_f[..., None] + np.arange(-self._window + 1, self._window + 1) clip_l = min(self._x_p) / x_interval clip_h = max(self._x_p) / x_interval windows = np.clip(windows, clip_l, clip_h) - clip_l @@ -701,9 +694,7 @@ def _evaluate(self, x: NDArrayFloat) -> NDArrayFloat: return np.sum( self._y_p[windows] * self._kernel( - x[..., None] / x_interval - - windows - - min(self._x_p) / x_interval, + x[..., None] / x_interval - windows - min(self._x_p) / x_interval, **self._kernel_kwargs, ), axis=-1, @@ -797,9 +788,7 @@ class LinearInterpolator: -------- Interpolating a single numeric variable: - >>> y = np.array( - ... [5.9200, 9.3700, 10.8135, 4.5100, 69.5900, 27.8007, 86.0500] - ... ) + >>> y = np.array([5.9200, 9.3700, 10.8135, 4.5100, 69.5900, 27.8007, 86.0500]) >>> x = np.arange(len(y)) >>> f = LinearInterpolator(x, y) >>> f(0.5) # doctest: +ELLIPSIS @@ -1000,9 +989,7 @@ class SpragueInterpolator: -------- Interpolating a single numeric variable: - >>> y = np.array( - ... [5.9200, 9.3700, 10.8135, 4.5100, 69.5900, 27.8007, 86.0500] - ... ) + >>> y = np.array([5.9200, 9.3700, 10.8135, 4.5100, 69.5900, 27.8007, 86.0500]) >>> x = np.arange(len(y)) >>> f = SpragueInterpolator(x, y) >>> f(0.5) # doctest: +ELLIPSIS @@ -1140,42 +1127,14 @@ def y(self, value: ArrayLike): self._y = value - yp1 = np.ravel( - ( - np.dot( - self.SPRAGUE_C_COEFFICIENTS[0], - np.array(value[0:6]).reshape([6, 1]), - ) - ) - / 209 - )[0] - yp2 = np.ravel( - ( - np.dot( - self.SPRAGUE_C_COEFFICIENTS[1], - np.array(value[0:6]).reshape([6, 1]), - ) - ) - / 209 - )[0] - yp3 = np.ravel( - ( - np.dot( - self.SPRAGUE_C_COEFFICIENTS[2], - np.array(value[-6:]).reshape([6, 1]), - ) - ) - / 209 - )[0] - yp4 = np.ravel( - ( - np.dot( - self.SPRAGUE_C_COEFFICIENTS[3], - np.array(value[-6:]).reshape([6, 1]), - ) + yp1, yp2, yp3, yp4 = ( + np.sum( + self.SPRAGUE_C_COEFFICIENTS + * np.asarray((value[0:6], value[0:6], value[-6:], value[-6:])), + axis=1, ) / 209 - )[0] + ) self._yp = np.concatenate( [ @@ -1230,47 +1189,24 @@ def _evaluate(self, x: NDArrayFloat) -> NDArrayFloat: r = self._yp - a0p = r[i] - a1p = ( - 2 * r[i - 2] - 16 * r[i - 1] + 16 * r[i + 1] - 2 * r[i + 2] - ) / 24 - a2p = ( - -r[i - 2] + 16 * r[i - 1] - 30 * r[i] + 16 * r[i + 1] - r[i + 2] - ) / 24 - a3p = ( - -9 * r[i - 2] - + 39 * r[i - 1] - - 70 * r[i] - + 66 * r[i + 1] - - 33 * r[i + 2] - + 7 * r[i + 3] - ) / 24 - a4p = ( - 13 * r[i - 2] - - 64 * r[i - 1] - + 126 * r[i] - - 124 * r[i + 1] - + 61 * r[i + 2] - - 12 * r[i + 3] - ) / 24 - a5p = ( - -5 * r[i - 2] - + 25 * r[i - 1] - - 50 * r[i] - + 50 * r[i + 1] - - 25 * r[i + 2] - + 5 * r[i + 3] - ) / 24 - - y = ( - a0p - + a1p * X - + a2p * X**2 - + a3p * X**3 - + a4p * X**4 - + a5p * X**5 + r_s = np.asarray((r[i - 2], r[i - 1], r[i], r[i + 1], r[i + 2], r[i + 3])) + w_s = np.asarray( + ( + (2, -16, 0, 16, -2, 0), + (-1, 16, -30, 16, -1, 0), + (-9, 39, -70, 66, -33, 7), + (13, -64, 126, -124, 61, -12), + (-5, 25, -50, 50, -25, 5), + ) ) + a = np.dot(w_s, r_s) / 24 + # Fancy vector code here... use underlying numpy structures to accelerate + # parts of the linear algebra. + + y = r[i] + (a.reshape(5, -1) * X ** np.arange(1, 6).reshape(-1, 1)).sum(axis=0) + if y.size == 1: + return y[0] return y def _validate_dimensions(self): @@ -1332,9 +1268,7 @@ class PchipInterpolator(scipy.interpolate.PchipInterpolator): class. """ - def __init__( - self, x: ArrayLike, y: ArrayLike, *args: Any, **kwargs: Any - ) -> None: + def __init__(self, x: ArrayLike, y: ArrayLike, *args: Any, **kwargs: Any) -> None: super().__init__(x, y, *args, **kwargs) self._y: NDArrayFloat = as_float_array(y) @@ -1368,7 +1302,7 @@ def y(self, value: ArrayLike): class NullInterpolator: """ - Perform 1-D function null interpolation, i.e. a call within given + Perform 1-D function null interpolation, i.e., a call within given tolerances will return existing :math:`y` variable values and ``default`` if outside tolerances. @@ -1404,9 +1338,7 @@ class NullInterpolator: Examples -------- - >>> y = np.array( - ... [5.9200, 9.3700, 10.8135, 4.5100, 69.5900, 27.8007, 86.0500] - ... ) + >>> y = np.array([5.9200, 9.3700, 10.8135, 4.5100, 69.5900, 27.8007, 86.0500]) >>> x = np.arange(len(y)) >>> f = NullInterpolator(x, y) >>> f(0.5) @@ -1699,9 +1631,7 @@ def lagrange_coefficients(r: float, n: int = 4) -> NDArrayFloat: r_i = np.arange(n) L_n = [] for j in range(len(r_i)): - basis = [ - (r - r_i[i]) / (r_i[j] - r_i[i]) for i in range(len(r_i)) if i != j - ] + basis = [(r - r_i[i]) / (r_i[j] - r_i[i]) for i in range(len(r_i)) if i != j] L_n.append(reduce(lambda x, y: x * y, basis)) return np.array(L_n) @@ -1811,9 +1741,7 @@ def vertices_and_relative_coordinates( # forming a cube around it: vertices = np.array( [ - table[ - i_f_c[i[0]][..., 0], i_f_c[i[1]][..., 1], i_f_c[i[2]][..., 2] - ] + table[i_f_c[i[0]][..., 0], i_f_c[i[1]][..., 1], i_f_c[i[2]][..., 2]] for i in itertools.product(*zip([0, 0, 0], [1, 1, 1])) ] ) @@ -1821,9 +1749,7 @@ def vertices_and_relative_coordinates( return vertices, V_xyzr -def table_interpolation_trilinear( - V_xyz: ArrayLike, table: ArrayLike -) -> NDArrayFloat: +def table_interpolation_trilinear(V_xyz: ArrayLike, table: ArrayLike) -> NDArrayFloat: """ Perform the trilinear interpolation of given :math:`V_{xyz}` values using given interpolation table. @@ -1901,9 +1827,7 @@ def table_interpolation_trilinear( return xyz_o -def table_interpolation_tetrahedral( - V_xyz: ArrayLike, table: ArrayLike -) -> NDArrayFloat: +def table_interpolation_tetrahedral(V_xyz: ArrayLike, table: ArrayLike) -> NDArrayFloat: """ Perform the tetrahedral interpolation of given :math:`V_{xyz}` values using given interpolation table. diff --git a/colour/algebra/prng.py b/colour/algebra/prng.py index 33f136c9e7..0033ceeaa8 100644 --- a/colour/algebra/prng.py +++ b/colour/algebra/prng.py @@ -2,7 +2,7 @@ Random Numbers Utilities ======================== -Defines the random number generator objects: +Define the random number generator objects: - :func:`colour.algebra.random_triplet_generator` diff --git a/colour/algebra/regression.py b/colour/algebra/regression.py index 2610c6c608..2064828658 100644 --- a/colour/algebra/regression.py +++ b/colour/algebra/regression.py @@ -2,7 +2,7 @@ Regression ========== -Defines various objects to perform regression: +Define various objects to perform regression: - :func:`colour.algebra.least_square_mapping_MoorePenrose`: *Least-squares* mapping using *Moore-Penrose* inverse. @@ -33,9 +33,7 @@ ] -def least_square_mapping_MoorePenrose( - y: ArrayLike, x: ArrayLike -) -> NDArrayFloat: +def least_square_mapping_MoorePenrose(y: ArrayLike, x: ArrayLike) -> NDArrayFloat: """ Compute the *least-squares* mapping from dependent variable :math:`y` to independent variable :math:`x` using *Moore-Penrose* inverse. diff --git a/colour/algebra/tests/test_common.py b/colour/algebra/tests/test_common.py index d542a401d7..1a7845ef93 100644 --- a/colour/algebra/tests/test_common.py +++ b/colour/algebra/tests/test_common.py @@ -1,10 +1,9 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.algebra.common` module.""" -import unittest from itertools import product import numpy as np +import pytest from colour.algebra import ( eigen_decomposition, @@ -15,7 +14,6 @@ linear_conversion, linstep_function, manhattan_distance, - matrix_dot, normalise_maximum, normalise_vector, sdiv, @@ -25,7 +23,7 @@ smoothstep_function, spow, spow_enable, - vector_dot, + vecmul, ) from colour.constants import TOLERANCE_ABSOLUTE_TESTS from colour.utilities import ignore_numpy_errors @@ -50,7 +48,6 @@ "TestNormaliseVector", "TestNormaliseMaximum", "TestVectorDot", - "TestMatrixDot", "TestEuclideanDistance", "TestManhattanDistance", "TestLinearConversion", @@ -60,7 +57,7 @@ ] -class TestGetSdivMode(unittest.TestCase): +class TestGetSdivMode: """ Define :func:`colour.algebra.common.get_sdiv_mode` definition unit tests methods. @@ -70,31 +67,31 @@ def test_get_sdiv_mode(self): """Test :func:`colour.algebra.common.get_sdiv_mode` definition.""" with sdiv_mode("Numpy"): - self.assertEqual(get_sdiv_mode(), "numpy") + assert get_sdiv_mode() == "numpy" with sdiv_mode("Ignore"): - self.assertEqual(get_sdiv_mode(), "ignore") + assert get_sdiv_mode() == "ignore" with sdiv_mode("Warning"): - self.assertEqual(get_sdiv_mode(), "warning") + assert get_sdiv_mode() == "warning" with sdiv_mode("Raise"): - self.assertEqual(get_sdiv_mode(), "raise") + assert get_sdiv_mode() == "raise" with sdiv_mode("Ignore Zero Conversion"): - self.assertEqual(get_sdiv_mode(), "ignore zero conversion") + assert get_sdiv_mode() == "ignore zero conversion" with sdiv_mode("Warning Zero Conversion"): - self.assertEqual(get_sdiv_mode(), "warning zero conversion") + assert get_sdiv_mode() == "warning zero conversion" with sdiv_mode("Ignore Limit Conversion"): - self.assertEqual(get_sdiv_mode(), "ignore limit conversion") + assert get_sdiv_mode() == "ignore limit conversion" with sdiv_mode("Warning Limit Conversion"): - self.assertEqual(get_sdiv_mode(), "warning limit conversion") + assert get_sdiv_mode() == "warning limit conversion" -class TestSetSdivMode(unittest.TestCase): +class TestSetSdivMode: """ Define :func:`colour.algebra.common.set_sdiv_mode` definition unit tests methods. @@ -105,31 +102,31 @@ def test_set_sdiv_mode(self): with sdiv_mode(get_sdiv_mode()): set_sdiv_mode("Numpy") - self.assertEqual(get_sdiv_mode(), "numpy") + assert get_sdiv_mode() == "numpy" set_sdiv_mode("Ignore") - self.assertEqual(get_sdiv_mode(), "ignore") + assert get_sdiv_mode() == "ignore" set_sdiv_mode("Warning") - self.assertEqual(get_sdiv_mode(), "warning") + assert get_sdiv_mode() == "warning" set_sdiv_mode("Raise") - self.assertEqual(get_sdiv_mode(), "raise") + assert get_sdiv_mode() == "raise" set_sdiv_mode("Ignore Zero Conversion") - self.assertEqual(get_sdiv_mode(), "ignore zero conversion") + assert get_sdiv_mode() == "ignore zero conversion" set_sdiv_mode("Warning Zero Conversion") - self.assertEqual(get_sdiv_mode(), "warning zero conversion") + assert get_sdiv_mode() == "warning zero conversion" set_sdiv_mode("Ignore Limit Conversion") - self.assertEqual(get_sdiv_mode(), "ignore limit conversion") + assert get_sdiv_mode() == "ignore limit conversion" set_sdiv_mode("Warning Limit Conversion") - self.assertEqual(get_sdiv_mode(), "warning limit conversion") + assert get_sdiv_mode() == "warning limit conversion" -class TestSdivMode(unittest.TestCase): +class TestSdivMode: """ Define :func:`colour.algebra.common.sdiv_mode` definition unit tests methods. @@ -139,16 +136,16 @@ def test_sdiv_mode(self): """Test :func:`colour.algebra.common.sdiv_mode` definition.""" with sdiv_mode("Raise"): - self.assertEqual(get_sdiv_mode(), "raise") + assert get_sdiv_mode() == "raise" with sdiv_mode("Ignore Zero Conversion"): - self.assertEqual(get_sdiv_mode(), "ignore zero conversion") + assert get_sdiv_mode() == "ignore zero conversion" @sdiv_mode("Raise") def fn_a(): """:func:`sdiv_mode` unit tests :func:`fn_a` definition.""" - self.assertEqual(get_sdiv_mode(), "raise") + assert get_sdiv_mode() == "raise" fn_a() @@ -156,12 +153,12 @@ def fn_a(): def fn_b(): """:func:`sdiv_mode` unit tests :func:`fn_b` definition.""" - self.assertEqual(get_sdiv_mode(), "ignore zero conversion") + assert get_sdiv_mode() == "ignore zero conversion" fn_b() -class TestSdiv(unittest.TestCase): +class TestSdiv: """ Define :func:`colour.algebra.common.sdiv` definition unit tests methods. @@ -174,38 +171,34 @@ def test_sdiv(self): b = np.array([2, 1, 0]) with sdiv_mode("Numpy"): - self.assertWarns(RuntimeWarning, sdiv, a, b) + pytest.warns(RuntimeWarning, sdiv, a, b) with sdiv_mode("Ignore"): np.testing.assert_equal(sdiv(a, b), np.array([0, 1, np.inf])) with sdiv_mode("Warning"): - self.assertWarns(RuntimeWarning, sdiv, a, b) + pytest.warns(RuntimeWarning, sdiv, a, b) np.testing.assert_equal(sdiv(a, b), np.array([0, 1, np.inf])) with sdiv_mode("Raise"): - self.assertRaises(FloatingPointError, sdiv, a, b) + pytest.raises(FloatingPointError, sdiv, a, b) with sdiv_mode("Ignore Zero Conversion"): np.testing.assert_equal(sdiv(a, b), np.array([0, 1, 0])) with sdiv_mode("Warning Zero Conversion"): - self.assertWarns(RuntimeWarning, sdiv, a, b) + pytest.warns(RuntimeWarning, sdiv, a, b) np.testing.assert_equal(sdiv(a, b), np.array([0, 1, 0])) with sdiv_mode("Ignore Limit Conversion"): - np.testing.assert_equal( - sdiv(a, b), np.nan_to_num(np.array([0, 1, np.inf])) - ) + np.testing.assert_equal(sdiv(a, b), np.nan_to_num(np.array([0, 1, np.inf]))) with sdiv_mode("Warning Limit Conversion"): - self.assertWarns(RuntimeWarning, sdiv, a, b) - np.testing.assert_equal( - sdiv(a, b), np.nan_to_num(np.array([0, 1, np.inf])) - ) + pytest.warns(RuntimeWarning, sdiv, a, b) + np.testing.assert_equal(sdiv(a, b), np.nan_to_num(np.array([0, 1, np.inf]))) -class TestIsSpowEnabled(unittest.TestCase): +class TestIsSpowEnabled: """ Define :func:`colour.algebra.common.is_spow_enabled` definition unit tests methods. @@ -215,13 +208,13 @@ def test_is_spow_enabled(self): """Test :func:`colour.algebra.common.is_spow_enabled` definition.""" with spow_enable(True): - self.assertTrue(is_spow_enabled()) + assert is_spow_enabled() with spow_enable(False): - self.assertFalse(is_spow_enabled()) + assert not is_spow_enabled() -class TestSetSpowEnabled(unittest.TestCase): +class TestSetSpowEnabled: """ Define :func:`colour.algebra.common.set_spow_enable` definition unit tests methods. @@ -232,14 +225,14 @@ def test_set_spow_enable(self): with spow_enable(is_spow_enabled()): set_spow_enable(True) - self.assertTrue(is_spow_enabled()) + assert is_spow_enabled() with spow_enable(is_spow_enabled()): set_spow_enable(False) - self.assertFalse(is_spow_enabled()) + assert not is_spow_enabled() -class TestSpowEnable(unittest.TestCase): +class TestSpowEnable: """ Define :func:`colour.algebra.common.spow_enable` definition unit tests methods. @@ -249,16 +242,16 @@ def test_spow_enable(self): """Test :func:`colour.algebra.common.spow_enable` definition.""" with spow_enable(True): - self.assertTrue(is_spow_enabled()) + assert is_spow_enabled() with spow_enable(False): - self.assertFalse(is_spow_enabled()) + assert not is_spow_enabled() @spow_enable(True) def fn_a(): """:func:`spow_enable` unit tests :func:`fn_a` definition.""" - self.assertTrue(is_spow_enabled()) + assert is_spow_enabled() fn_a() @@ -266,12 +259,12 @@ def fn_a(): def fn_b(): """:func:`spow_enable` unit tests :func:`fn_b` definition.""" - self.assertFalse(is_spow_enabled()) + assert not is_spow_enabled() fn_b() -class TestSpow(unittest.TestCase): +class TestSpow: """ Define :func:`colour.algebra.common.spow` definition unit tests methods. @@ -280,9 +273,9 @@ class TestSpow(unittest.TestCase): def test_spow(self): """Test :func:`colour.algebra.common.spow` definition.""" - self.assertEqual(spow(2, 2), 4.0) + assert spow(2, 2) == 4.0 - self.assertEqual(spow(-2, 2), -4.0) + assert spow(-2, 2) == -4.0 np.testing.assert_allclose( spow([2, -2, -2, 0], [2, 2, 0.15, 0]), @@ -299,7 +292,7 @@ def test_spow(self): np.testing.assert_equal(spow(-2, 0.15), np.nan) -class TestNormaliseVector(unittest.TestCase): +class TestNormaliseVector: """ Define :func:`colour.algebra.common.normalise_vector` definition unit tests methods. @@ -327,7 +320,7 @@ def test_normalise_vector(self): ) -class TestNormaliseMaximum(unittest.TestCase): +class TestNormaliseMaximum: """ Define :func:`colour.algebra.common.normalise_maximum` definition unit tests methods. @@ -392,9 +385,7 @@ def test_normalise_maximum(self): ) np.testing.assert_allclose( - normalise_maximum( - np.array([-0.11518475, -0.10080000, 0.05089373]) - ), + normalise_maximum(np.array([-0.11518475, -0.10080000, 0.05089373])), np.array([0.00000000, 0.00000000, 1.00000000]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -408,14 +399,14 @@ def test_normalise_maximum(self): ) -class TestVectorDot(unittest.TestCase): +class TestVectorDot: """ - Define :func:`colour.algebra.common.vector_dot` definition unit tests + Define :func:`colour.algebra.common.vecmul` definition unit tests methods. """ - def test_vector_dot(self): - """Test :func:`colour.algebra.common.vector_dot` definition.""" + def test_vecmul(self): + """Test :func:`colour.algebra.common.vecmul` definition.""" m = np.array( [ @@ -430,7 +421,7 @@ def test_vector_dot(self): v = np.tile(v, (6, 1)) np.testing.assert_allclose( - vector_dot(m, v), + vecmul(m, v), np.array( [ [0.19540944, 0.06203965, 0.05279523], @@ -445,67 +436,7 @@ def test_vector_dot(self): ) -class TestMatrixDot(unittest.TestCase): - """ - Define :func:`colour.algebra.common.matrix_dot` definition unit tests - methods. - """ - - def test_matrix_dot(self): - """Test :func:`colour.algebra.common.matrix_dot` definition.""" - - a = np.array( - [ - [0.7328, 0.4296, -0.1624], - [-0.7036, 1.6975, 0.0061], - [0.0030, 0.0136, 0.9834], - ] - ) - a = np.reshape(np.tile(a, (6, 1)), (6, 3, 3)) - - b = a - - np.testing.assert_allclose( - matrix_dot(a, b), - np.array( - [ - [ - [0.23424208, 1.04184824, -0.27609032], - [-1.70994078, 2.57932265, 0.13061813], - [-0.00442036, 0.03774904, 0.96667132], - ], - [ - [0.23424208, 1.04184824, -0.27609032], - [-1.70994078, 2.57932265, 0.13061813], - [-0.00442036, 0.03774904, 0.96667132], - ], - [ - [0.23424208, 1.04184824, -0.27609032], - [-1.70994078, 2.57932265, 0.13061813], - [-0.00442036, 0.03774904, 0.96667132], - ], - [ - [0.23424208, 1.04184824, -0.27609032], - [-1.70994078, 2.57932265, 0.13061813], - [-0.00442036, 0.03774904, 0.96667132], - ], - [ - [0.23424208, 1.04184824, -0.27609032], - [-1.70994078, 2.57932265, 0.13061813], - [-0.00442036, 0.03774904, 0.96667132], - ], - [ - [0.23424208, 1.04184824, -0.27609032], - [-1.70994078, 2.57932265, 0.13061813], - [-0.00442036, 0.03774904, 0.96667132], - ], - ] - ), - atol=TOLERANCE_ABSOLUTE_TESTS, - ) - - -class TestEuclideanDistance(unittest.TestCase): +class TestEuclideanDistance: """ Define :func:`colour.algebra.common.euclidean_distance` definition unit tests methods. @@ -577,7 +508,7 @@ def test_nan_euclidean_distance(self): euclidean_distance(cases, cases) -class TestManhattanDistance(unittest.TestCase): +class TestManhattanDistance: """ Define :func:`colour.algebra.common.manhattan_distance` definition unit tests methods. @@ -649,7 +580,7 @@ def test_nan_manhattan_distance(self): manhattan_distance(cases, cases) -class TestLinearConversion(unittest.TestCase): +class TestLinearConversion: """ Define :func:`colour.algebra.common.linear_conversion` definition unit tests methods. @@ -680,7 +611,7 @@ def test_linear_conversion(self): ) -class TestLinstepFunction(unittest.TestCase): +class TestLinstepFunction: """ Define :func:`colour.algebra.common.linstep_function` definition unit tests methods. @@ -737,7 +668,7 @@ def test_linstep_function(self): ) -class TestSmoothstepFunction(unittest.TestCase): +class TestSmoothstepFunction: """ Define :func:`colour.algebra.common.smoothstep_function` definition unit tests methods. @@ -746,9 +677,9 @@ class TestSmoothstepFunction(unittest.TestCase): def test_smoothstep_function(self): """Test :func:`colour.algebra.common.smoothstep_function` definition.""" - self.assertEqual(smoothstep_function(0.5), 0.5) - self.assertEqual(smoothstep_function(0.25), 0.15625) - self.assertEqual(smoothstep_function(0.75), 0.84375) + assert smoothstep_function(0.5) == 0.5 + assert smoothstep_function(0.25) == 0.15625 + assert smoothstep_function(0.75) == 0.84375 x = np.linspace(-2, 2, 5) np.testing.assert_allclose( @@ -763,7 +694,7 @@ def test_smoothstep_function(self): ) -class TestIsIdentity(unittest.TestCase): +class TestIsIdentity: """ Define :func:`colour.algebra.common.is_identity` definition unit tests methods. @@ -772,20 +703,18 @@ class TestIsIdentity(unittest.TestCase): def test_is_identity(self): """Test :func:`colour.algebra.common.is_identity` definition.""" - self.assertTrue( - is_identity(np.array([1, 0, 0, 0, 1, 0, 0, 0, 1]).reshape([3, 3])) - ) + assert is_identity(np.reshape(np.array([1, 0, 0, 0, 1, 0, 0, 0, 1]), (3, 3))) - self.assertFalse( - is_identity(np.array([1, 2, 0, 0, 1, 0, 0, 0, 1]).reshape([3, 3])) + assert not is_identity( + np.reshape(np.array([1, 2, 0, 0, 1, 0, 0, 0, 1]), (3, 3)) ) - self.assertTrue(is_identity(np.array([1, 0, 0, 1]).reshape([2, 2]))) + assert is_identity(np.reshape(np.array([1, 0, 0, 1]), (2, 2))) - self.assertFalse(is_identity(np.array([1, 2, 0, 1]).reshape([2, 2]))) + assert not is_identity(np.reshape(np.array([1, 2, 0, 1]), (2, 2))) -class TestEigenDecomposition(unittest.TestCase): +class TestEigenDecomposition: """ Define :func:`colour.algebra.common.eigen_decomposition` definition unit tests methods. @@ -818,14 +747,8 @@ def test_is_identity(self): v, np.array([[0.0, 0.0, 1.0], [0.0, 1.0, 0.0], [1.0, 0.0, 0.0]]) ) - w, v = eigen_decomposition( - a, descending_order=False, covariance_matrix=True - ) + w, v = eigen_decomposition(a, descending_order=False, covariance_matrix=True) np.testing.assert_equal(w, np.array([1.0, 4.0, 9.0])) np.testing.assert_equal( v, np.array([[1.0, 0.0, 0.0], [0.0, 1.0, 0.0], [0.0, 0.0, 1.0]]) ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/algebra/tests/test_extrapolation.py b/colour/algebra/tests/test_extrapolation.py index 32f086a92c..a6affe8696 100644 --- a/colour/algebra/tests/test_extrapolation.py +++ b/colour/algebra/tests/test_extrapolation.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.algebra.extrapolation` module.""" -import unittest from itertools import product import numpy as np @@ -27,7 +25,7 @@ ] -class TestExtrapolator(unittest.TestCase): +class TestExtrapolator: """ Define :class:`colour.algebra.extrapolation.Extrapolator` class unit tests methods. @@ -39,7 +37,7 @@ def test_required_attributes(self): required_attributes = ("interpolator",) for attribute in required_attributes: - self.assertIn(attribute, dir(Extrapolator)) + assert attribute in dir(Extrapolator) def test_required_methods(self): """Test the presence of required methods.""" @@ -47,7 +45,7 @@ def test_required_methods(self): required_methods = ("__init__",) for method in required_methods: # pragma: no cover - self.assertIn(method, dir(Extrapolator)) + assert method in dir(Extrapolator) def test_interpolator(self): """ @@ -58,7 +56,7 @@ def test_interpolator(self): extrapolator = Extrapolator( LinearInterpolator(np.array([5, 6, 7]), np.array([5, 6, 7])) ) - self.assertIsInstance(extrapolator.interpolator, LinearInterpolator) + assert isinstance(extrapolator.interpolator, LinearInterpolator) def test_method(self): """ @@ -69,13 +67,13 @@ def test_method(self): extrapolator = Extrapolator( LinearInterpolator(np.array([5, 6, 7]), np.array([5, 6, 7])) ) - self.assertEqual(extrapolator.method, "linear") + assert extrapolator.method == "linear" extrapolator = Extrapolator( LinearInterpolator(np.array([5, 6, 7]), np.array([5, 6, 7])), method="Constant", ) - self.assertEqual(extrapolator.method, "constant") + assert extrapolator.method == "constant" def test_left(self): """ @@ -87,7 +85,7 @@ def test_left(self): LinearInterpolator(np.array([5, 6, 7]), np.array([5, 6, 7])), left=0, ) - self.assertEqual(extrapolator.left, 0) + assert extrapolator.left == 0 def test_right(self): """ @@ -99,7 +97,7 @@ def test_right(self): LinearInterpolator(np.array([5, 6, 7]), np.array([5, 6, 7])), right=0, ) - self.assertEqual(extrapolator.right, 0) + assert extrapolator.right == 0 def test__call__(self): """ @@ -111,48 +109,40 @@ def test__call__(self): LinearInterpolator(np.array([5, 6, 7]), np.array([5, 6, 7])) ) np.testing.assert_array_equal(extrapolator((4, 8)), (4, 8)) - self.assertEqual(extrapolator(4), 4) + assert extrapolator(4) == 4 extrapolator = Extrapolator( LinearInterpolator(np.array([3, 4, 5]), np.array([1, 2, 3])), method="Constant", ) - np.testing.assert_array_equal( - extrapolator((0.1, 0.2, 8, 9)), (1, 1, 3, 3) - ) - self.assertEqual(extrapolator(0.1), 1.0) + np.testing.assert_array_equal(extrapolator((0.1, 0.2, 8, 9)), (1, 1, 3, 3)) + assert extrapolator(0.1) == 1.0 extrapolator = Extrapolator( LinearInterpolator(np.array([3, 4, 5]), np.array([1, 2, 3])), method="Constant", left=0, ) - np.testing.assert_array_equal( - extrapolator((0.1, 0.2, 8, 9)), (0, 0, 3, 3) - ) - self.assertEqual(extrapolator(0.1), 0) + np.testing.assert_array_equal(extrapolator((0.1, 0.2, 8, 9)), (0, 0, 3, 3)) + assert extrapolator(0.1) == 0 extrapolator = Extrapolator( LinearInterpolator(np.array([3, 4, 5]), np.array([1, 2, 3])), method="Constant", right=0, ) - np.testing.assert_array_equal( - extrapolator((0.1, 0.2, 8, 9)), (1, 1, 0, 0) - ) - self.assertEqual(extrapolator(9), 0) + np.testing.assert_array_equal(extrapolator((0.1, 0.2, 8, 9)), (1, 1, 0, 0)) + assert extrapolator(9) == 0 extrapolator = Extrapolator( - CubicSplineInterpolator( - np.array([3, 4, 5, 6]), np.array([1, 2, 3, 4]) - ) + CubicSplineInterpolator(np.array([3, 4, 5, 6]), np.array([1, 2, 3, 4])) ) np.testing.assert_allclose( extrapolator((0.1, 0.2, 8.0, 9.0)), (-1.9, -1.8, 6.0, 7.0), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(extrapolator(9), 7) + assert extrapolator(9) == 7 extrapolator = Extrapolator( PchipInterpolator(np.array([3, 4, 5]), np.array([1, 2, 3])) @@ -162,7 +152,7 @@ def test__call__(self): (-1.9, -1.8, 6.0, 7.0), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(extrapolator(9), 7.0) + assert extrapolator(9) == 7.0 @ignore_numpy_errors def test_nan__call__(self): @@ -176,7 +166,3 @@ def test_nan__call__(self): for case in cases: extrapolator = Extrapolator(LinearInterpolator(case, case)) extrapolator(case[0]) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/algebra/tests/test_interpolation.py b/colour/algebra/tests/test_interpolation.py index 37ab8c5b7e..de01063893 100644 --- a/colour/algebra/tests/test_interpolation.py +++ b/colour/algebra/tests/test_interpolation.py @@ -11,10 +11,10 @@ from __future__ import annotations import os -import unittest from itertools import product import numpy as np +import pytest from colour.algebra import ( CubicSplineInterpolator, @@ -500,7 +500,7 @@ ).table -class TestKernelNearestNeighbour(unittest.TestCase): +class TestKernelNearestNeighbour: """ Define :func:`colour.algebra.interpolation.kernel_nearest_neighbour` definition unit tests methods. @@ -547,7 +547,7 @@ def test_kernel_nearest(self): ) -class TestKernelLinear(unittest.TestCase): +class TestKernelLinear: """ Define :func:`colour.algebra.interpolation.kernel_linear` definition unit tests methods. @@ -591,7 +591,7 @@ def test_kernel_linear(self): ) -class TestKernelSinc(unittest.TestCase): +class TestKernelSinc: """ Define :func:`colour.algebra.interpolation.kernel_sinc` definition unit tests methods. @@ -669,7 +669,7 @@ def test_kernel_sinc(self): ) -class TestKernelLanczos(unittest.TestCase): +class TestKernelLanczos: """ Define :func:`colour.algebra.interpolation.kernel_lanczos` definition unit tests methods. @@ -747,7 +747,7 @@ def test_kernel_lanczos(self): ) -class TestKernelCardinalSpline(unittest.TestCase): +class TestKernelCardinalSpline: """ Define :func:`colour.algebra.interpolation.kernel_cardinal_spline` definition unit tests methods. @@ -828,7 +828,7 @@ def test_kernel_cardinal_spline(self): ) -class TestKernelInterpolator(unittest.TestCase): +class TestKernelInterpolator: """ Define :class:`colour.algebra.interpolation.KernelInterpolator` class unit tests methods. @@ -847,7 +847,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(KernelInterpolator)) + assert attribute in dir(KernelInterpolator) def test_required_methods(self): """Test the presence of required methods.""" @@ -855,7 +855,7 @@ def test_required_methods(self): required_methods = ("__init__", "__call__") for method in required_methods: # pragma: no cover - self.assertIn(method, dir(KernelInterpolator)) + assert method in dir(KernelInterpolator) def test_x(self): """ @@ -888,7 +888,7 @@ def test_window(self): x = y = np.linspace(0, 1, 10) kernel_interpolator = KernelInterpolator(x, y, window=3) - self.assertEqual(kernel_interpolator.window, 3) + assert kernel_interpolator.window == 3 def test_kernel(self): """ @@ -899,7 +899,7 @@ def test_kernel(self): x = y = np.linspace(0, 1, 10) kernel_interpolator = KernelInterpolator(x, y, kernel=kernel_linear) - self.assertIs(kernel_interpolator.kernel, kernel_linear) + assert kernel_interpolator.kernel is kernel_linear def test_kernel_kwargs(self): """ @@ -909,11 +909,9 @@ def test_kernel_kwargs(self): x = y = np.linspace(0, 1, 10) kernel_kwargs = {"a": 1} - kernel_interpolator = KernelInterpolator( - x, y, kernel_kwargs=kernel_kwargs - ) + kernel_interpolator = KernelInterpolator(x, y, kernel_kwargs=kernel_kwargs) - self.assertDictEqual(kernel_interpolator.kernel_kwargs, kernel_kwargs) + assert kernel_interpolator.kernel_kwargs == kernel_kwargs def test_padding_kwargs(self): """ @@ -923,13 +921,9 @@ def test_padding_kwargs(self): x = y = np.linspace(0, 1, 10) padding_kwargs = {"pad_width": (3, 3), "mode": "mean"} - kernel_interpolator = KernelInterpolator( - x, y, padding_kwargs=padding_kwargs - ) + kernel_interpolator = KernelInterpolator(x, y, padding_kwargs=padding_kwargs) - self.assertDictEqual( - kernel_interpolator.padding_kwargs, padding_kwargs - ) + assert kernel_interpolator.padding_kwargs == padding_kwargs def test_raise_exception___init__(self): """ @@ -937,7 +931,7 @@ def test_raise_exception___init__(self): method raised exception. """ - self.assertRaises( + pytest.raises( ValueError, KernelInterpolator, np.linspace(0, 1, 10), @@ -1059,9 +1053,7 @@ def test__call__(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - kernel_interpolator = KernelInterpolator( - x, y, window=1, kernel_kwargs={"a": 1} - ) + kernel_interpolator = KernelInterpolator(x, y, window=1, kernel_kwargs={"a": 1}) np.testing.assert_allclose( kernel_interpolator(x_i), np.array( @@ -1160,9 +1152,9 @@ def test_raise_exception___call__(self): x = y = np.linspace(0, 1, 10) kernel_interpolator = KernelInterpolator(x, y) - self.assertRaises(ValueError, kernel_interpolator, -1) + pytest.raises(ValueError, kernel_interpolator, -1) - self.assertRaises(ValueError, kernel_interpolator, 11) + pytest.raises(ValueError, kernel_interpolator, 11) @ignore_numpy_errors def test_nan__call__(self): @@ -1177,7 +1169,7 @@ def test_nan__call__(self): # independent variable. -class TestNearestNeighbourInterpolator(unittest.TestCase): +class TestNearestNeighbourInterpolator: """ Define :class:`colour.algebra.interpolation.NearestNeighbourInterpolator` class unit tests methods. @@ -1189,7 +1181,7 @@ def test_required_attributes(self): required_attributes = () for attribute in required_attributes: # pragma: no cover - self.assertIn(attribute, dir(NearestNeighbourInterpolator)) + assert attribute in dir(NearestNeighbourInterpolator) def test_required_methods(self): """Test the presence of required methods.""" @@ -1197,7 +1189,7 @@ def test_required_methods(self): required_methods = ("__init__",) for method in required_methods: # pragma: no cover - self.assertIn(method, dir(NearestNeighbourInterpolator)) + assert method in dir(NearestNeighbourInterpolator) def test___init__(self): """ @@ -1210,10 +1202,10 @@ def test___init__(self): x, y, kernel_kwargs={"a": 1} ) - self.assertDictEqual(nearest_neighbour_interpolator.kernel_kwargs, {}) + assert nearest_neighbour_interpolator.kernel_kwargs == {} -class TestLinearInterpolator(unittest.TestCase): +class TestLinearInterpolator: """ Define :class:`colour.algebra.interpolation.LinearInterpolator` class unit tests methods. @@ -1225,7 +1217,7 @@ def test_required_attributes(self): required_attributes = ("x", "y") for attribute in required_attributes: - self.assertIn(attribute, dir(LinearInterpolator)) + assert attribute in dir(LinearInterpolator) def test_required_methods(self): """Test the presence of required methods.""" @@ -1233,7 +1225,7 @@ def test_required_methods(self): required_methods = ("__init__", "__call__") for method in required_methods: # pragma: no cover - self.assertIn(method, dir(LinearInterpolator)) + assert method in dir(LinearInterpolator) def test_raise_exception___init__(self): """ @@ -1242,7 +1234,7 @@ def test_raise_exception___init__(self): """ x, y = np.linspace(0, 1, 10), np.linspace(0, 1, 15) - self.assertRaises(ValueError, LinearInterpolator, x, y) + pytest.raises(ValueError, LinearInterpolator, x, y) def test__call__(self): """ @@ -1280,9 +1272,9 @@ def test_raise_exception___call__(self): x = y = np.linspace(0, 1, 10) linear_interpolator = LinearInterpolator(x, y) - self.assertRaises(ValueError, linear_interpolator, -1) + pytest.raises(ValueError, linear_interpolator, -1) - self.assertRaises(ValueError, linear_interpolator, 11) + pytest.raises(ValueError, linear_interpolator, 11) @ignore_numpy_errors def test_nan__call__(self): @@ -1301,7 +1293,7 @@ def test_nan__call__(self): pass -class TestSpragueInterpolator(unittest.TestCase): +class TestSpragueInterpolator: """ Define :class:`colour.algebra.interpolation.SpragueInterpolator` class unit tests methods. @@ -1313,7 +1305,7 @@ def test_required_attributes(self): required_attributes = ("x", "y") for attribute in required_attributes: - self.assertIn(attribute, dir(SpragueInterpolator)) + assert attribute in dir(SpragueInterpolator) def test_required_methods(self): """Test the presence of required methods.""" @@ -1321,7 +1313,7 @@ def test_required_methods(self): required_methods = ("__init__", "__call__") for method in required_methods: # pragma: no cover - self.assertIn(method, dir(SpragueInterpolator)) + assert method in dir(SpragueInterpolator) def test_raise_exception___init__(self): """ @@ -1330,7 +1322,7 @@ def test_raise_exception___init__(self): """ x, y = np.linspace(0, 1, 10), np.linspace(0, 1, 15) - self.assertRaises(ValueError, SpragueInterpolator, x, y) + pytest.raises(ValueError, SpragueInterpolator, x, y) def test__call__(self): """ @@ -1368,9 +1360,9 @@ def test_raise_exception___call__(self): x = y = np.linspace(0, 1, 10) sprague_interpolator = SpragueInterpolator(x, y) - self.assertRaises(ValueError, sprague_interpolator, -1) + pytest.raises(ValueError, sprague_interpolator, -1) - self.assertRaises(ValueError, sprague_interpolator, 11) + pytest.raises(ValueError, sprague_interpolator, 11) @ignore_numpy_errors def test_nan__call__(self): @@ -1389,7 +1381,7 @@ def test_nan__call__(self): pass -class TestCubicSplineInterpolator(unittest.TestCase): +class TestCubicSplineInterpolator: """ Define :class:`colour.algebra.interpolation.CubicSplineInterpolator` class unit tests methods. @@ -1415,7 +1407,7 @@ def test__call__(self): ) -class TestPchipInterpolator(unittest.TestCase): +class TestPchipInterpolator: """ Define :class:`colour.algebra.interpolation.PchipInterpolator` class unit tests methods. @@ -1427,7 +1419,7 @@ def test_required_attributes(self): required_attributes = ("x", "y") for attribute in required_attributes: - self.assertIn(attribute, dir(PchipInterpolator)) + assert attribute in dir(PchipInterpolator) def test_required_methods(self): """Test the presence of required methods.""" @@ -1435,10 +1427,21 @@ def test_required_methods(self): required_methods = ("__init__",) for method in required_methods: # pragma: no cover - self.assertIn(method, dir(PchipInterpolator)) + assert method in dir(PchipInterpolator) + + def test_y(self): + """ + Test :attr:`colour.algebra.interpolation.PchipInterpolator.y` property. + """ + + interpolator = PchipInterpolator(np.linspace(0, 1, 10), np.linspace(0, 1, 10)) + interpolator.y = np.linspace(0, 1, 10) -class TestNullInterpolator(unittest.TestCase): + assert interpolator(5) == 5 + + +class TestNullInterpolator: """ Define :class:`colour.algebra.interpolation.NullInterpolator` class unit tests methods. @@ -1450,7 +1453,7 @@ def test_required_attributes(self): required_attributes = ("x", "y") for attribute in required_attributes: - self.assertIn(attribute, dir(NullInterpolator)) + assert attribute in dir(NullInterpolator) def test_required_methods(self): """Test the presence of required methods.""" @@ -1458,7 +1461,7 @@ def test_required_methods(self): required_methods = ("__init__", "__call__") for method in required_methods: # pragma: no cover - self.assertIn(method, dir(NullInterpolator)) + assert method in dir(NullInterpolator) def test_x(self): """ @@ -1522,7 +1525,7 @@ def test_raise_exception___init__(self): """ x, y = np.linspace(0, 1, 10), np.linspace(0, 1, 15) - self.assertRaises(ValueError, NullInterpolator, x, y) + pytest.raises(ValueError, NullInterpolator, x, y) def test__call__(self): """ @@ -1554,9 +1557,9 @@ def test_raise_exception___call__(self): x = y = np.linspace(0, 1, 10) null_interpolator = NullInterpolator(x, y) - self.assertRaises(ValueError, null_interpolator, -1) + pytest.raises(ValueError, null_interpolator, -1) - self.assertRaises(ValueError, null_interpolator, 11) + pytest.raises(ValueError, null_interpolator, 11) @ignore_numpy_errors def test_nan__call__(self): @@ -1575,7 +1578,7 @@ def test_nan__call__(self): pass -class TestLagrangeCoefficients(unittest.TestCase): +class TestLagrangeCoefficients: """ Define :func:`colour.algebra.interpolation.lagrange_coefficients` definition unit tests methods. @@ -1607,7 +1610,7 @@ def test_lagrange_coefficients(self): ) -class TestVerticesAndRelativeCoordinates(unittest.TestCase): +class TestVerticesAndRelativeCoordinates: """ Define :func:`colour.algebra.interpolation.\ vertices_and_relative_coordinates` definition unit tests methods. @@ -1695,7 +1698,7 @@ def test_vertices_and_relative_coordinates(self): ) -class TestTableInterpolationTrilinear(unittest.TestCase): +class TestTableInterpolationTrilinear: """ Define :func:`colour.algebra.interpolation.\ table_interpolation_trilinear` definition unit tests methods. @@ -1737,7 +1740,7 @@ def test_interpolation_trilinear(self): ) -class TestTableInterpolationTetrahedral(unittest.TestCase): +class TestTableInterpolationTetrahedral: """ Define :func:`colour.algebra.interpolation.\ table_interpolation_tetrahedral` definition unit tests methods. @@ -1777,7 +1780,3 @@ def test_interpolation_tetrahedral(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/algebra/tests/test_prng.py b/colour/algebra/tests/test_prng.py index a4d326ca06..1245218e59 100644 --- a/colour/algebra/tests/test_prng.py +++ b/colour/algebra/tests/test_prng.py @@ -12,8 +12,6 @@ from __future__ import annotations -import unittest - import numpy as np from colour.algebra import random_triplet_generator @@ -48,7 +46,7 @@ ) -class TestRandomTripletGenerator(unittest.TestCase): +class TestRandomTripletGenerator: """ Define :func:`colour.algebra.prng.random_triplet_generator` definition unit tests methods. @@ -73,7 +71,3 @@ def test_random_triplet_generator(self): random_triplet_generator(10, random_state=prng), atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/algebra/tests/test_regression.py b/colour/algebra/tests/test_regression.py index edf425575a..a971cb7cd0 100644 --- a/colour/algebra/tests/test_regression.py +++ b/colour/algebra/tests/test_regression.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.algebra.regression` module.""" -import unittest import numpy as np @@ -20,7 +18,7 @@ ] -class TestLeastSquareMappingMoorePenrose(unittest.TestCase): +class TestLeastSquareMappingMoorePenrose: """ Define :func:`colour.algebra.regression.\ least_square_mapping_MoorePenrose` definition unit tests methods. @@ -86,7 +84,3 @@ def test_least_square_mapping_MoorePenrose(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/appearance/atd95.py b/colour/appearance/atd95.py index ec1086fa9d..d3a5b79cc5 100644 --- a/colour/appearance/atd95.py +++ b/colour/appearance/atd95.py @@ -2,7 +2,7 @@ ATD (1995) Colour Vision Model ============================== -Defines the *ATD (1995)* colour vision model objects: +Define the *ATD (1995)* colour vision model objects: - :class:`colour.CAM_Specification_ATD95` - :func:`colour.XYZ_to_ATD95` @@ -30,7 +30,7 @@ import numpy as np -from colour.algebra import spow, vector_dot +from colour.algebra import spow, vecmul from colour.hints import ArrayLike, NDArrayFloat from colour.utilities import ( MixinDataclassArithmetic, @@ -275,9 +275,7 @@ def XYZ_to_ATD95( ) -def luminance_to_retinal_illuminance( - XYZ: ArrayLike, Y_c: ArrayLike -) -> NDArrayFloat: +def luminance_to_retinal_illuminance(XYZ: ArrayLike, Y_c: ArrayLike) -> NDArrayFloat: """ Convert from luminance in :math:`cd/m^2` to retinal illuminance in trolands. @@ -329,7 +327,7 @@ def XYZ_to_LMS_ATD95(XYZ: ArrayLike) -> NDArrayFloat: array([ 6.2283272..., 7.4780666..., 3.8859772...]) """ - LMS = vector_dot( + LMS = vecmul( [ [0.2435, 0.8524, -0.0516], [-0.3954, 1.1642, 0.0837], diff --git a/colour/appearance/cam16.py b/colour/appearance/cam16.py index c120b0dd7f..d1f9ddc51f 100644 --- a/colour/appearance/cam16.py +++ b/colour/appearance/cam16.py @@ -2,7 +2,7 @@ CAM16 Colour Appearance Model ============================= -Defines the *CAM16* colour appearance model objects: +Define the *CAM16* colour appearance model objects: - :class:`colour.appearance.InductionFactors_CAM16` - :attr:`colour.VIEWING_CONDITIONS_CAM16` @@ -26,7 +26,7 @@ import numpy as np from colour.adaptation import CAT_CAT16 -from colour.algebra import spow, vector_dot +from colour.algebra import spow, vecmul from colour.appearance.ciecam02 import ( VIEWING_CONDITIONS_CIECAM02, InductionFactors_CIECAM02, @@ -89,9 +89,7 @@ """Inverse adaptation matrix :math:`M^{-1}_{16}`.""" -class InductionFactors_CAM16( - namedtuple("InductionFactors_CAM16", ("F", "c", "N_c")) -): +class InductionFactors_CAM16(namedtuple("InductionFactors_CAM16", ("F", "c", "N_c"))): """ *CAM16* colour appearance model induction factors. @@ -171,8 +169,9 @@ def XYZ_to_CAM16( XYZ_w: ArrayLike, L_A: ArrayLike, Y_b: ArrayLike, - surround: InductionFactors_CIECAM02 - | InductionFactors_CAM16 = VIEWING_CONDITIONS_CAM16["Average"], + surround: ( + InductionFactors_CIECAM02 | InductionFactors_CAM16 + ) = VIEWING_CONDITIONS_CAM16["Average"], discount_illuminant: bool = False, compute_H: bool = True, ) -> CAM_Specification_CAM16: @@ -262,7 +261,7 @@ def XYZ_to_CAM16( # Step 0 # Converting *CIE XYZ* tristimulus values to sharpened *RGB* values. - RGB_w = vector_dot(MATRIX_16, XYZ_w) + RGB_w = vecmul(MATRIX_16, XYZ_w) # Computing degree of adaptation :math:`D`. D = ( @@ -271,24 +270,20 @@ def XYZ_to_CAM16( else ones(L_A.shape) ) - n, F_L, N_bb, N_cb, z = viewing_conditions_dependent_parameters( - Y_b, Y_w, L_A - ) + n, F_L, N_bb, N_cb, z = viewing_conditions_dependent_parameters(Y_b, Y_w, L_A) D_RGB = D[..., None] * Y_w[..., None] / RGB_w + 1 - D[..., None] RGB_wc = D_RGB * RGB_w # Applying forward post-adaptation non-linear response compression. - RGB_aw = post_adaptation_non_linear_response_compression_forward( - RGB_wc, F_L - ) + RGB_aw = post_adaptation_non_linear_response_compression_forward(RGB_wc, F_L) # Computing achromatic responses for the whitepoint. A_w = achromatic_response_forward(RGB_aw, N_bb) # Step 1 # Converting *CIE XYZ* tristimulus values to sharpened *RGB* values. - RGB = vector_dot(MATRIX_16, XYZ) + RGB = vecmul(MATRIX_16, XYZ) # Step 2 RGB_c = D_RGB * RGB @@ -351,8 +346,9 @@ def CAM16_to_XYZ( XYZ_w: ArrayLike, L_A: ArrayLike, Y_b: ArrayLike, - surround: InductionFactors_CIECAM02 - | InductionFactors_CAM16 = VIEWING_CONDITIONS_CAM16["Average"], + surround: ( + InductionFactors_CIECAM02 | InductionFactors_CAM16 + ) = VIEWING_CONDITIONS_CAM16["Average"], discount_illuminant: bool = False, ) -> NDArrayFloat: """ @@ -364,7 +360,7 @@ def CAM16_to_XYZ( *CAM16* colour appearance model specification. Correlate of *Lightness* :math:`J`, correlate of *chroma* :math:`C` or correlate of *colourfulness* :math:`M` and *hue* angle :math:`h` in degrees must be - specified, e.g. :math:`JCh` or :math:`JMh`. + specified, e.g., :math:`JCh` or :math:`JMh`. XYZ_w *CIE XYZ* tristimulus values of reference white. L_A @@ -449,7 +445,7 @@ def CAM16_to_XYZ( # Step 0 # Converting *CIE XYZ* tristimulus values to sharpened *RGB* values. - RGB_w = vector_dot(MATRIX_16, XYZ_w) + RGB_w = vecmul(MATRIX_16, XYZ_w) # Computing degree of adaptation :math:`D`. D = ( @@ -458,17 +454,13 @@ def CAM16_to_XYZ( else ones(L_A.shape) ) - n, F_L, N_bb, N_cb, z = viewing_conditions_dependent_parameters( - Y_b, Y_w, L_A - ) + n, F_L, N_bb, N_cb, z = viewing_conditions_dependent_parameters(Y_b, Y_w, L_A) D_RGB = D[..., None] * Y_w[..., None] / RGB_w + 1 - D[..., None] RGB_wc = D_RGB * RGB_w # Applying forward post-adaptation non-linear response compression. - RGB_aw = post_adaptation_non_linear_response_compression_forward( - RGB_wc, F_L - ) + RGB_aw = post_adaptation_non_linear_response_compression_forward(RGB_wc, F_L) # Computing achromatic responses for the whitepoint. A_w = achromatic_response_forward(RGB_aw, N_bb) @@ -513,6 +505,6 @@ def CAM16_to_XYZ( RGB = RGB_c / D_RGB # Step 7 - XYZ = vector_dot(MATRIX_INVERSE_16, RGB) + XYZ = vecmul(MATRIX_INVERSE_16, RGB) return from_range_100(XYZ) diff --git a/colour/appearance/ciecam02.py b/colour/appearance/ciecam02.py index fa7a03b574..6f6346c0bd 100644 --- a/colour/appearance/ciecam02.py +++ b/colour/appearance/ciecam02.py @@ -2,7 +2,7 @@ CIECAM02 Colour Appearance Model ================================ -Defines the *CIECAM02* colour appearance model objects: +Define the *CIECAM02* colour appearance model objects: - :class:`colour.appearance.InductionFactors_CIECAM02` - :attr:`colour.VIEWING_CONDITIONS_CIECAM02` @@ -38,7 +38,7 @@ import numpy as np from colour.adaptation import CAT_CAT02 -from colour.algebra import matrix_dot, sdiv, sdiv_mode, spow, vector_dot +from colour.algebra import sdiv, sdiv_mode, spow, vecmul from colour.appearance.hunt import ( MATRIX_HPE_TO_XYZ, MATRIX_XYZ_TO_HPE, @@ -162,9 +162,7 @@ class InductionFactors_CIECAM02( } CAM_KWARGS_CIECAM02_sRGB: dict = { - "XYZ_w": xy_to_XYZ( - CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"] - ) + "XYZ_w": xy_to_XYZ(CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"]) * 100, "L_A": 64 / np.pi * 0.2, "Y_b": 20, @@ -228,9 +226,7 @@ def XYZ_to_CIECAM02( XYZ_w: ArrayLike, L_A: ArrayLike, Y_b: ArrayLike, - surround: InductionFactors_CIECAM02 = VIEWING_CONDITIONS_CIECAM02[ - "Average" - ], + surround: InductionFactors_CIECAM02 = VIEWING_CONDITIONS_CIECAM02["Average"], discount_illuminant: bool = False, compute_H: bool = True, ) -> CAM_Specification_CIECAM02: @@ -336,14 +332,12 @@ def XYZ_to_CIECAM02( L_A = as_float_array(L_A) Y_b = as_float_array(Y_b) - n, F_L, N_bb, N_cb, z = viewing_conditions_dependent_parameters( - Y_b, Y_w, L_A - ) + n, F_L, N_bb, N_cb, z = viewing_conditions_dependent_parameters(Y_b, Y_w, L_A) # Converting *CIE XYZ* tristimulus values to *CMCCAT2000* transform # sharpened *RGB* values. - RGB = vector_dot(CAT_CAT02, XYZ) - RGB_w = vector_dot(CAT_CAT02, XYZ_w) + RGB = vecmul(CAT_CAT02, XYZ) + RGB_w = vecmul(CAT_CAT02, XYZ_w) # Computing degree of adaptation :math:`D`. D = ( @@ -362,9 +356,7 @@ def XYZ_to_CIECAM02( # Applying forward post-adaptation non-linear response compression. RGB_a = post_adaptation_non_linear_response_compression_forward(RGB_p, F_L) - RGB_aw = post_adaptation_non_linear_response_compression_forward( - RGB_pw, F_L - ) + RGB_aw = post_adaptation_non_linear_response_compression_forward(RGB_pw, F_L) # Converting to preliminary cartesian coordinates. a, b = tsplit(opponent_colour_dimensions_forward(RGB_a)) @@ -415,9 +407,7 @@ def CIECAM02_to_XYZ( XYZ_w: ArrayLike, L_A: ArrayLike, Y_b: ArrayLike, - surround: InductionFactors_CIECAM02 = VIEWING_CONDITIONS_CIECAM02[ - "Average" - ], + surround: InductionFactors_CIECAM02 = VIEWING_CONDITIONS_CIECAM02["Average"], discount_illuminant: bool = False, ) -> NDArrayFloat: """ @@ -429,7 +419,7 @@ def CIECAM02_to_XYZ( *CIECAM02* colour appearance model specification. Correlate of *Lightness* :math:`J`, correlate of *chroma* :math:`C` or correlate of *colourfulness* :math:`M` and *hue* angle :math:`h` in degrees must be - specified, e.g. :math:`JCh` or :math:`JMh`. + specified, e.g., :math:`JCh` or :math:`JMh`. XYZ_w *CIE XYZ* tristimulus values of reference white. L_A @@ -532,9 +522,7 @@ def CIECAM02_to_XYZ( XYZ_w = to_domain_100(XYZ_w) _X_w, Y_w, _Z_w = tsplit(XYZ_w) - n, F_L, N_bb, N_cb, z = viewing_conditions_dependent_parameters( - Y_b, Y_w, L_A - ) + n, F_L, N_bb, N_cb, z = viewing_conditions_dependent_parameters(Y_b, Y_w, L_A) if has_only_nan(C) and not has_only_nan(M): C = M / spow(F_L, 0.25) @@ -546,7 +534,7 @@ def CIECAM02_to_XYZ( # Converting *CIE XYZ* tristimulus values to *CMCCAT2000* transform # sharpened *RGB* values. - RGB_w = vector_dot(CAT_CAT02, XYZ_w) + RGB_w = vecmul(CAT_CAT02, XYZ_w) # Computing degree of adaptation :math:`D`. D = ( @@ -562,9 +550,7 @@ def CIECAM02_to_XYZ( RGB_pw = RGB_to_rgb(RGB_wc) # Applying post-adaptation non-linear response compression. - RGB_aw = post_adaptation_non_linear_response_compression_forward( - RGB_pw, F_L - ) + RGB_aw = post_adaptation_non_linear_response_compression_forward(RGB_pw, F_L) # Computing achromatic response for the whitepoint. A_w = achromatic_response_forward(RGB_aw, N_bb) @@ -600,7 +586,7 @@ def CIECAM02_to_XYZ( # Converting *CMCCAT2000* transform sharpened *RGB* values to *CIE XYZ* # tristimulus values. - XYZ = vector_dot(CAT_INVERSE_CAT02, RGB) + XYZ = vecmul(CAT_INVERSE_CAT02, RGB) return from_range_100(XYZ) @@ -788,9 +774,7 @@ def full_chromatic_adaptation_forward( D = as_float_array(D) with sdiv_mode(): - RGB_c = ( - Y_w[..., None] * sdiv(D[..., None], RGB_w) + 1 - D[..., None] - ) * RGB + RGB_c = (Y_w[..., None] * sdiv(D[..., None], RGB_w) + 1 - D[..., None]) * RGB return cast(NDArrayFloat, RGB_c) @@ -838,9 +822,7 @@ def full_chromatic_adaptation_inverse( D = as_float_array(D) with sdiv_mode(): - RGB_c = RGB / ( - Y_w[..., None] * sdiv(D[..., None], RGB_w) + 1 - D[..., None] - ) + RGB_c = RGB / (Y_w[..., None] * sdiv(D[..., None], RGB_w) + 1 - D[..., None]) return cast(NDArrayFloat, RGB_c) @@ -867,7 +849,7 @@ def RGB_to_rgb(RGB: ArrayLike) -> NDArrayFloat: array([ 19.9969397..., 20.0018612..., 20.0135053...]) """ - rgb = vector_dot(matrix_dot(MATRIX_XYZ_TO_HPE, CAT_INVERSE_CAT02), RGB) + rgb = vecmul(np.matmul(MATRIX_XYZ_TO_HPE, CAT_INVERSE_CAT02), RGB) return rgb @@ -894,7 +876,7 @@ def rgb_to_RGB(rgb: ArrayLike) -> NDArrayFloat: array([ 19.9937078..., 20.0039363..., 20.0132638...]) """ - RGB = vector_dot(matrix_dot(CAT_CAT02, MATRIX_HPE_TO_XYZ), rgb) + RGB = vecmul(np.matmul(CAT_CAT02, MATRIX_HPE_TO_XYZ), rgb) return RGB @@ -1017,9 +999,7 @@ def opponent_colour_dimensions_forward(RGB: ArrayLike) -> NDArrayFloat: return ab -def opponent_colour_dimensions_inverse( - P_n: ArrayLike, h: ArrayLike -) -> NDArrayFloat: +def opponent_colour_dimensions_inverse(P_n: ArrayLike, h: ArrayLike) -> NDArrayFloat: """ Return opponent colour dimensions from given points :math:`P_n` and hue :math:`h` in degrees for inverse *CIECAM02* implementation. @@ -1173,9 +1153,7 @@ def hue_quadrature(h: ArrayLike) -> NDArrayFloat: h_ii1 = h_i[i + 1] e_ii1 = e_i[i + 1] - H = H_ii + ( - (100 * (h - h_ii) / e_ii) / ((h - h_ii) / e_ii + (h_ii1 - h) / e_ii1) - ) + H = H_ii + ((100 * (h - h_ii) / e_ii) / ((h - h_ii) / e_ii + (h_ii1 - h) / e_ii1)) H = np.where( h < 20.14, @@ -1184,11 +1162,7 @@ def hue_quadrature(h: ArrayLike) -> NDArrayFloat: ) H = np.where( h >= 237.53, - H_ii - + ( - (85.9 * (h - h_ii) / e_ii) - / ((h - h_ii) / e_ii + (360 - h) / 0.856) - ), + H_ii + ((85.9 * (h - h_ii) / e_ii) / ((h - h_ii) / e_ii + (360 - h) / 0.856)), H, ) return as_float(H) @@ -1222,9 +1196,7 @@ def eccentricity_factor(h: ArrayLike) -> NDArrayFloat: return e_t -def achromatic_response_forward( - RGB: ArrayLike, N_bb: ArrayLike -) -> NDArrayFloat: +def achromatic_response_forward(RGB: ArrayLike, N_bb: ArrayLike) -> NDArrayFloat: """ Return the achromatic response :math:`A` from given compressed *CMCCAT2000* transform sharpened *RGB* array and :math:`N_{bb}` chromatic @@ -1717,7 +1689,7 @@ def matrix_post_adaptation_non_linear_response_compression( b = as_float_array(b) RGB_a = ( - vector_dot( + vecmul( [ [460, 451, 288], [460, -891, -261], diff --git a/colour/appearance/ciecam16.py b/colour/appearance/ciecam16.py index cbc3163277..b30c7bb473 100644 --- a/colour/appearance/ciecam16.py +++ b/colour/appearance/ciecam16.py @@ -2,7 +2,7 @@ CIECAM16 Colour Appearance Model ================================ -Defines the *CIECAM16* colour appearance model objects: +Define the *CIECAM16* colour appearance model objects: - :class:`colour.appearance.InductionFactors_CIECAM16` - :attr:`colour.VIEWING_CONDITIONS_CIECAM16` @@ -25,7 +25,7 @@ import numpy as np -from colour.algebra import spow, vector_dot +from colour.algebra import spow, vecmul from colour.appearance.cam16 import MATRIX_16, MATRIX_INVERSE_16 from colour.appearance.ciecam02 import ( VIEWING_CONDITIONS_CIECAM02, @@ -166,8 +166,9 @@ def XYZ_to_CIECAM16( XYZ_w: ArrayLike, L_A: ArrayLike, Y_b: ArrayLike, - surround: InductionFactors_CIECAM02 - | InductionFactors_CIECAM16 = VIEWING_CONDITIONS_CIECAM16["Average"], + surround: ( + InductionFactors_CIECAM02 | InductionFactors_CIECAM16 + ) = VIEWING_CONDITIONS_CIECAM16["Average"], discount_illuminant: bool = False, compute_H: bool = True, ) -> CAM_Specification_CIECAM16: @@ -274,7 +275,7 @@ def XYZ_to_CIECAM16( # Step 0 # Converting *CIE XYZ* tristimulus values to sharpened *RGB* values. - RGB_w = vector_dot(MATRIX_16, XYZ_w) + RGB_w = vecmul(MATRIX_16, XYZ_w) # Computing degree of adaptation :math:`D`. D = ( @@ -283,24 +284,20 @@ def XYZ_to_CIECAM16( else ones(L_A.shape) ) - n, F_L, N_bb, N_cb, z = viewing_conditions_dependent_parameters( - Y_b, Y_w, L_A - ) + n, F_L, N_bb, N_cb, z = viewing_conditions_dependent_parameters(Y_b, Y_w, L_A) D_RGB = D[..., None] * 100 / RGB_w + 1 - D[..., None] RGB_wc = D_RGB * RGB_w # Applying forward post-adaptation non-linear response compression. - RGB_aw = post_adaptation_non_linear_response_compression_forward( - RGB_wc, F_L - ) + RGB_aw = post_adaptation_non_linear_response_compression_forward(RGB_wc, F_L) # Computing achromatic responses for the whitepoint. A_w = achromatic_response_forward(RGB_aw, N_bb) # Step 1 # Converting *CIE XYZ* tristimulus values to sharpened *RGB* values. - RGB = vector_dot(MATRIX_16, XYZ) + RGB = vecmul(MATRIX_16, XYZ) # Step 2 RGB_c = D_RGB * RGB @@ -363,8 +360,9 @@ def CIECAM16_to_XYZ( XYZ_w: ArrayLike, L_A: ArrayLike, Y_b: ArrayLike, - surround: InductionFactors_CIECAM02 - | InductionFactors_CIECAM16 = VIEWING_CONDITIONS_CIECAM16["Average"], + surround: ( + InductionFactors_CIECAM02 | InductionFactors_CIECAM16 + ) = VIEWING_CONDITIONS_CIECAM16["Average"], discount_illuminant: bool = False, ) -> NDArrayFloat: """ @@ -376,7 +374,7 @@ def CIECAM16_to_XYZ( *CIECAM16* colour appearance model specification. Correlate of *Lightness* :math:`J`, correlate of *chroma* :math:`C` or correlate of *colourfulness* :math:`M` and *hue* angle :math:`h` in degrees must be - specified, e.g. :math:`JCh` or :math:`JMh`. + specified, e.g., :math:`JCh` or :math:`JMh`. XYZ_w *CIE XYZ* tristimulus values of reference white. L_A @@ -480,7 +478,7 @@ def CIECAM16_to_XYZ( # Step 0 # Converting *CIE XYZ* tristimulus values to sharpened *RGB* values. - RGB_w = vector_dot(MATRIX_16, XYZ_w) + RGB_w = vecmul(MATRIX_16, XYZ_w) # Computing degree of adaptation :math:`D`. D = ( @@ -489,17 +487,13 @@ def CIECAM16_to_XYZ( else ones(L_A.shape) ) - n, F_L, N_bb, N_cb, z = viewing_conditions_dependent_parameters( - Y_b, Y_w, L_A - ) + n, F_L, N_bb, N_cb, z = viewing_conditions_dependent_parameters(Y_b, Y_w, L_A) D_RGB = D[..., None] * 100 / RGB_w + 1 - D[..., None] RGB_wc = D_RGB * RGB_w # Applying forward post-adaptation non-linear response compression. - RGB_aw = post_adaptation_non_linear_response_compression_forward( - RGB_wc, F_L - ) + RGB_aw = post_adaptation_non_linear_response_compression_forward(RGB_wc, F_L) # Computing achromatic responses for the whitepoint. A_w = achromatic_response_forward(RGB_aw, N_bb) @@ -544,7 +538,7 @@ def CIECAM16_to_XYZ( RGB = RGB_c / D_RGB # Step 7 - XYZ = vector_dot(MATRIX_INVERSE_16, RGB) + XYZ = vecmul(MATRIX_INVERSE_16, RGB) return from_range_100(XYZ) @@ -650,9 +644,7 @@ def f_e_inverse(RGB_a: ArrayLike, F_L: ArrayLike) -> NDArrayFloat: ], [ q_U + (RGB_a - f_q_F_L_q_U) / d_f_q_F_L_q_U, - 100 - / F_L[..., None] - * spow((27.13 * RGB_a) / (400 - RGB_a), 1 / 0.42), + 100 / F_L[..., None] * spow((27.13 * RGB_a) / (400 - RGB_a), 1 / 0.42), q_L * RGB_a / f_q_F_L_q_L, ], ) diff --git a/colour/appearance/hellwig2022.py b/colour/appearance/hellwig2022.py index 8903672b37..11c2940146 100644 --- a/colour/appearance/hellwig2022.py +++ b/colour/appearance/hellwig2022.py @@ -2,7 +2,7 @@ Hellwig and Fairchild (2022) Colour Appearance Model ==================================================== -Defines the *Hellwig and Fairchild (2022)* colour appearance model objects: +Define the *Hellwig and Fairchild (2022)* colour appearance model objects: - :class:`colour.appearance.InductionFactors_Hellwig2022` - :attr:`colour.VIEWING_CONDITIONS_HELLWIG2022` @@ -29,7 +29,7 @@ import numpy as np -from colour.algebra import sdiv, sdiv_mode, spow, vector_dot +from colour.algebra import sdiv, sdiv_mode, spow, vecmul from colour.appearance.cam16 import ( MATRIX_16, MATRIX_INVERSE_16, @@ -186,8 +186,9 @@ def XYZ_to_Hellwig2022( XYZ_w: ArrayLike, L_A: ArrayLike, Y_b: ArrayLike, - surround: InductionFactors_CIECAM02 - | InductionFactors_Hellwig2022 = VIEWING_CONDITIONS_HELLWIG2022["Average"], + surround: ( + InductionFactors_CIECAM02 | InductionFactors_Hellwig2022 + ) = VIEWING_CONDITIONS_HELLWIG2022["Average"], discount_illuminant: bool = False, compute_H: bool = True, ) -> CAM_Specification_Hellwig2022: @@ -306,7 +307,7 @@ def XYZ_to_Hellwig2022( # Step 0 # Converting *CIE XYZ* tristimulus values to sharpened *RGB* values. - RGB_w = vector_dot(MATRIX_16, XYZ_w) + RGB_w = vecmul(MATRIX_16, XYZ_w) # Computing degree of adaptation :math:`D`. D = ( @@ -321,16 +322,14 @@ def XYZ_to_Hellwig2022( RGB_wc = D_RGB * RGB_w # Applying forward post-adaptation non-linear response compression. - RGB_aw = post_adaptation_non_linear_response_compression_forward( - RGB_wc, F_L - ) + RGB_aw = post_adaptation_non_linear_response_compression_forward(RGB_wc, F_L) # Computing achromatic responses for the whitepoint. A_w = achromatic_response_forward(RGB_aw) # Step 1 # Converting *CIE XYZ* tristimulus values to sharpened *RGB* values. - RGB = vector_dot(MATRIX_16, XYZ) + RGB = vecmul(MATRIX_16, XYZ) # Step 2 RGB_c = D_RGB * RGB @@ -399,8 +398,9 @@ def Hellwig2022_to_XYZ( XYZ_w: ArrayLike, L_A: ArrayLike, Y_b: ArrayLike, - surround: InductionFactors_CIECAM02 - | InductionFactors_Hellwig2022 = VIEWING_CONDITIONS_HELLWIG2022["Average"], + surround: ( + InductionFactors_CIECAM02 | InductionFactors_Hellwig2022 + ) = VIEWING_CONDITIONS_HELLWIG2022["Average"], discount_illuminant: bool = False, ) -> NDArrayFloat: """ @@ -416,7 +416,7 @@ def Hellwig2022_to_XYZ( *Hellwig and Fairchild (2022)* colour appearance model specification. Correlate of *Lightness* :math:`J`, correlate of *chroma* :math:`C` or correlate of *colourfulness* :math:`M` and *hue* angle :math:`h` in - degrees must be specified, e.g. :math:`JCh` or :math:`JMh`. + degrees must be specified, e.g., :math:`JCh` or :math:`JMh`. XYZ_w *CIE XYZ* tristimulus values of reference white. L_A @@ -549,7 +549,7 @@ def Hellwig2022_to_XYZ( # Step 0 # Converting *CIE XYZ* tristimulus values to sharpened *RGB* values. - RGB_w = vector_dot(MATRIX_16, XYZ_w) + RGB_w = vecmul(MATRIX_16, XYZ_w) # Computing degree of adaptation :math:`D`. D = ( @@ -564,9 +564,7 @@ def Hellwig2022_to_XYZ( RGB_wc = D_RGB * RGB_w # Applying forward post-adaptation non-linear response compression. - RGB_aw = post_adaptation_non_linear_response_compression_forward( - RGB_wc, F_L - ) + RGB_aw = post_adaptation_non_linear_response_compression_forward(RGB_wc, F_L) # Computing achromatic responses for the whitepoint. A_w = achromatic_response_forward(RGB_aw) @@ -602,15 +600,13 @@ def Hellwig2022_to_XYZ( # Step 5 # Applying inverse post-adaptation non-linear response compression. - RGB_c = post_adaptation_non_linear_response_compression_inverse( - RGB_a + 0.1, F_L - ) + RGB_c = post_adaptation_non_linear_response_compression_inverse(RGB_a + 0.1, F_L) # Step 6 RGB = RGB_c / D_RGB # Step 7 - XYZ = vector_dot(MATRIX_INVERSE_16, RGB) + XYZ = vecmul(MATRIX_INVERSE_16, RGB) return from_range_100(XYZ) diff --git a/colour/appearance/hke.py b/colour/appearance/hke.py index 48d5fecc98..c811d7a510 100644 --- a/colour/appearance/hke.py +++ b/colour/appearance/hke.py @@ -2,7 +2,7 @@ Helmholtz—Kohlrausch Effect =========================== -Defines the following methods for estimating Helmholtz-Kohlrausch effect (HKE): +Define the following methods for estimating Helmholtz-Kohlrausch effect (HKE): - :attr:`colour.HKE_NAYATANI1997_METHODS`: Nayatani HKE computation methods, choice between variable achromatic colour ('VAC') and variable chromatic @@ -172,9 +172,7 @@ def HelmholtzKohlrausch_effect_luminous_Nayatani1997( return ( 0.4462 * ( - HelmholtzKohlrausch_effect_object_Nayatani1997( - uv, uv_c, L_a, method - ) + HelmholtzKohlrausch_effect_object_Nayatani1997(uv, uv_c, L_a, method) + 0.3086 ) ** 3 diff --git a/colour/appearance/hunt.py b/colour/appearance/hunt.py index 726b0a0f12..627cc6ae81 100644 --- a/colour/appearance/hunt.py +++ b/colour/appearance/hunt.py @@ -2,7 +2,7 @@ Hunt Colour Appearance Model ============================ -Defines the *Hunt* colour appearance model objects: +Define the *Hunt* colour appearance model objects: - :class:`colour.appearance.InductionFactors_Hunt` - :attr:`colour.VIEWING_CONDITIONS_HUNT` @@ -24,7 +24,7 @@ import numpy as np -from colour.algebra import spow, vector_dot +from colour.algebra import spow, vecmul from colour.hints import ArrayLike, NDArrayFloat, cast from colour.utilities import ( CanonicalMapping, @@ -116,15 +116,11 @@ def __new__(cls, N_c, N_b, N_cb=None, N_bb=None): VIEWING_CONDITIONS_HUNT: CanonicalMapping = CanonicalMapping( { - "Small Areas, Uniform Background & Surrounds": InductionFactors_Hunt( - 1, 300 - ), + "Small Areas, Uniform Background & Surrounds": InductionFactors_Hunt(1, 300), "Normal Scenes": InductionFactors_Hunt(1, 75), "Television & CRT, Dim Surrounds": InductionFactors_Hunt(1, 25), "Large Transparencies On Light Boxes": InductionFactors_Hunt(0.7, 25), - "Projected Transparencies, Dark Surrounds": InductionFactors_Hunt( - 0.7, 10 - ), + "Projected Transparencies, Dark Surrounds": InductionFactors_Hunt(0.7, 10), } ) VIEWING_CONDITIONS_HUNT.__doc__ = """ @@ -395,14 +391,10 @@ def XYZ_to_Hunt( if surround.N_cb is None: N_cb = 0.725 * spow(Y_w / Y_b, 0.2) - usage_warning( - f'Unspecified "N_cb" argument, using approximation: "{N_cb}"' - ) + usage_warning(f'Unspecified "N_cb" argument, using approximation: "{N_cb}"') if surround.N_bb is None: N_bb = 0.725 * spow(Y_w / Y_b, 0.2) - usage_warning( - f'Unspecified "N_bb" argument, using approximation: "{N_bb}"' - ) + usage_warning(f'Unspecified "N_bb" argument, using approximation: "{N_bb}"') if L_AS is None and CCT_w is None: raise ValueError( @@ -413,8 +405,7 @@ def XYZ_to_Hunt( elif L_AS is None and CCT_w is not None: L_AS = illuminant_scotopic_luminance(L_A, CCT_w) usage_warning( - f'Unspecified "L_AS" argument, using approximation from "CCT": ' - f'"{L_AS}"' + f'Unspecified "L_AS" argument, using approximation from "CCT": "{L_AS}"' ) if (S is None and S_w is not None) or (S is not None and S_w is None): @@ -575,9 +566,7 @@ def luminance_level_adaptation_factor( return as_float(F_L) -def illuminant_scotopic_luminance( - L_A: ArrayLike, CCT: ArrayLike -) -> NDArrayFloat: +def illuminant_scotopic_luminance(L_A: ArrayLike, CCT: ArrayLike) -> NDArrayFloat: """ Return the approximate scotopic luminance :math:`L_{AS}` of the illuminant. @@ -630,7 +619,7 @@ def XYZ_to_rgb(XYZ: ArrayLike) -> NDArrayFloat: array([ 19.4743367..., 20.3101217..., 21.78 ]) """ - return vector_dot(MATRIX_XYZ_TO_HPE, XYZ) + return vecmul(MATRIX_XYZ_TO_HPE, XYZ) def f_n(x: ArrayLike) -> NDArrayFloat: @@ -748,9 +737,7 @@ def chromatic_adaptation( # Computing chromatic adaptation factors. if not discount_illuminant: L_A_p = spow(L_A, 1 / 3) - F_rgb = cast( - NDArrayFloat, (1 + L_A_p + h_rgb) / (1 + L_A_p + (1 / h_rgb)) - ) + F_rgb = cast(NDArrayFloat, (1 + L_A_p + h_rgb) / (1 + L_A_p + (1 / h_rgb))) else: F_rgb = ones(cast(NDArrayFloat, h_rgb).shape) @@ -770,7 +757,7 @@ def chromatic_adaptation( rgb_w = adjusted_reference_white_signals(rgb_p, B_rgb, rgb_w, p) # Computing adapted cone responses. - rgb_a = 1 + B_rgb * (f_n(F_L[..., None] * F_rgb * rgb / rgb_w) + D_rgb) + rgb_a = 1.0 + B_rgb * (f_n(F_L[..., None] * F_rgb * rgb / rgb_w) + D_rgb) return rgb_a @@ -912,18 +899,14 @@ def hue_angle(C: ArrayLike) -> NDArrayFloat: Examples -------- - >>> C = np.array( - ... [-5.365865581996587e-05, -0.000571699383647, 0.000625358039467] - ... ) + >>> C = np.array([-5.365865581996587e-05, -0.000571699383647, 0.000625358039467]) >>> hue_angle(C) # doctest: +ELLIPSIS 269.2737594... """ C_1, C_2, C_3 = tsplit(C) - hue = ( - 180 * np.arctan2(0.5 * (C_2 - C_3) / 4.5, C_1 - (C_2 / 11)) / np.pi - ) % 360 + hue = (180 * np.arctan2(0.5 * (C_2 - C_3) / 4.5, C_1 - (C_2 / 11)) / np.pi) % 360 return as_float(hue) @@ -1020,9 +1003,7 @@ def yellowness_blueness_response( Examples -------- - >>> C = np.array( - ... [-5.365865581996587e-05, -0.000571699383647, 0.000625358039467] - ... ) + >>> C = np.array([-5.365865581996587e-05, -0.000571699383647, 0.000625358039467]) >>> e_s = 1.110836504862630 >>> N_c = 1.0 >>> N_cb = 0.725000000000000 @@ -1038,9 +1019,7 @@ def yellowness_blueness_response( N_cb = as_float_array(N_cb) F_t = as_float_array(F_t) - M_yb = ( - 100 * (0.5 * (C_2 - C_3) / 4.5) * (e_s * (10 / 13) * N_c * N_cb * F_t) - ) + M_yb = 100 * (0.5 * (C_2 - C_3) / 4.5) * (e_s * (10 / 13) * N_c * N_cb * F_t) return as_float(M_yb) @@ -1072,9 +1051,7 @@ def redness_greenness_response( Examples -------- - >>> C = np.array( - ... [-5.365865581996587e-05, -0.000571699383647, 0.000625358039467] - ... ) + >>> C = np.array([-5.365865581996587e-05, -0.000571699383647, 0.000625358039467]) >>> e_s = 1.110836504862630 >>> N_c = 1.0 >>> N_cb = 0.725000000000000 @@ -1092,9 +1069,7 @@ def redness_greenness_response( return as_float(M_rg) -def overall_chromatic_response( - M_yb: ArrayLike, M_rg: ArrayLike -) -> NDArrayFloat: +def overall_chromatic_response(M_yb: ArrayLike, M_rg: ArrayLike) -> NDArrayFloat: """ Return the overall chromatic response :math:`M`. @@ -1369,10 +1344,7 @@ def chroma_correlate( Y_b_Y_w = Y_b / Y_w C_94 = ( - 2.44 - * spow(s, 0.69) - * (spow(Q / Q_w, Y_b_Y_w)) - * (1.64 - spow(0.29, Y_b_Y_w)) + 2.44 * spow(s, 0.69) * (spow(Q / Q_w, Y_b_Y_w)) * (1.64 - spow(0.29, Y_b_Y_w)) ) return C_94 diff --git a/colour/appearance/kim2009.py b/colour/appearance/kim2009.py index ab0cbaec91..8c296c3425 100644 --- a/colour/appearance/kim2009.py +++ b/colour/appearance/kim2009.py @@ -2,7 +2,7 @@ Kim, Weyrich and Kautz (2009) Colour Appearance Model ===================================================== -Defines the *Kim, Weyrich and Kautz (2009)* colour appearance model objects: +Define the *Kim, Weyrich and Kautz (2009)* colour appearance model objects: - :class:`colour.appearance.InductionFactors_Kim2009` - :attr:`colour.VIEWING_CONDITIONS_KIM2009` @@ -27,7 +27,7 @@ import numpy as np from colour.adaptation import CAT_CAT02 -from colour.algebra import spow, vector_dot +from colour.algebra import spow, vecmul from colour.appearance.ciecam02 import ( CAT_INVERSE_CAT02, VIEWING_CONDITIONS_CIECAM02, @@ -165,13 +165,11 @@ def __new__(cls, E): MEDIA_PARAMETERS_KIM2009["bright_lcd_display"] = MEDIA_PARAMETERS_KIM2009[ "High-luminance LCD Display" ] -MEDIA_PARAMETERS_KIM2009[ - "advertising_transparencies" -] = MEDIA_PARAMETERS_KIM2009["Transparent Advertising Media"] -MEDIA_PARAMETERS_KIM2009["crt"] = MEDIA_PARAMETERS_KIM2009["CRT Displays"] -MEDIA_PARAMETERS_KIM2009["paper"] = MEDIA_PARAMETERS_KIM2009[ - "Reflective Paper" +MEDIA_PARAMETERS_KIM2009["advertising_transparencies"] = MEDIA_PARAMETERS_KIM2009[ + "Transparent Advertising Media" ] +MEDIA_PARAMETERS_KIM2009["crt"] = MEDIA_PARAMETERS_KIM2009["CRT Displays"] +MEDIA_PARAMETERS_KIM2009["paper"] = MEDIA_PARAMETERS_KIM2009["Reflective Paper"] @dataclass @@ -307,8 +305,8 @@ def XYZ_to_Kim2009( # Converting *CIE XYZ* tristimulus values to *CMCCAT2000* transform # sharpened *RGB* values. - RGB = vector_dot(CAT_CAT02, XYZ) - RGB_w = vector_dot(CAT_CAT02, XYZ_w) + RGB = vecmul(CAT_CAT02, XYZ) + RGB_w = vecmul(CAT_CAT02, XYZ_w) # Computing degree of adaptation :math:`D`. D = ( @@ -340,9 +338,7 @@ def XYZ_to_Kim2009( # Perceived *Lightness* :math:`J_p`. a_j, b_j, o_j, n_j = 0.89, 0.24, 0.65, 3.65 A_A_w = A / A_w - J_p = spow( - (-(A_A_w - b_j) * spow(o_j, n_j)) / (A_A_w - b_j - a_j), 1 / n_j - ) + J_p = spow((-(A_A_w - b_j) * spow(o_j, n_j)) / (A_A_w - b_j - a_j), 1 / n_j) # Computing the media dependent *Lightness* :math:`J`. J = 100 * (media.E * (J_p - 1) + 1) @@ -403,7 +399,7 @@ def Kim2009_to_XYZ( *Kim, Weyrich and Kautz (2009)* colour appearance model specification. Correlate of *Lightness* :math:`J`, correlate of *chroma* :math:`C` or correlate of *colourfulness* :math:`M` and *hue* angle :math:`h` in - degrees must be specified, e.g. :math:`JCh` or :math:`JMh`. + degrees must be specified, e.g., :math:`JCh` or :math:`JMh`. XYZ_w *CIE XYZ* tristimulus values of reference white. L_A @@ -487,7 +483,7 @@ def Kim2009_to_XYZ( # Converting *CIE XYZ* tristimulus values to *CMCCAT2000* transform # sharpened *RGB* values. - RGB_w = vector_dot(CAT_CAT02, XYZ_w) + RGB_w = vecmul(CAT_CAT02, XYZ_w) # Computing degree of adaptation :math:`D`. D = ( @@ -544,7 +540,7 @@ def Kim2009_to_XYZ( [1.0000, -0.1568, -4.4904], ] ) - LMS_p = vector_dot(M, tstack([A, a, b])) + LMS_p = vecmul(M, tstack([A, a, b])) LMS = spow((-spow(L_A, n_c) * LMS_p) / (LMS_p - 1), 1 / n_c) # Converting to *Hunt-Pointer-Estevez* colourspace. @@ -553,6 +549,6 @@ def Kim2009_to_XYZ( # Applying inverse full chromatic adaptation. RGB = full_chromatic_adaptation_inverse(RGB_c, RGB_w, Y_w, D) - XYZ = vector_dot(CAT_INVERSE_CAT02, RGB) + XYZ = vecmul(CAT_INVERSE_CAT02, RGB) return from_range_100(XYZ) diff --git a/colour/appearance/llab.py b/colour/appearance/llab.py index 6c9ff8f8b6..0e157b3a83 100644 --- a/colour/appearance/llab.py +++ b/colour/appearance/llab.py @@ -2,7 +2,7 @@ :math:`LLAB(l:c)` Colour Appearance Model ========================================= -Defines the *:math:`LLAB(l:c)`* colour appearance model objects: +Define the *:math:`LLAB(l:c)`* colour appearance model objects: - :class:`colour.appearance.InductionFactors_LLAB` - :attr:`colour.VIEWING_CONDITIONS_LLAB` @@ -35,7 +35,7 @@ sdiv, sdiv_mode, spow, - vector_dot, + vecmul, ) from colour.hints import ArrayLike, NDArrayFloat, Optional, Union from colour.utilities import ( @@ -110,9 +110,7 @@ class InductionFactors_LLAB( "Television & VDU Displays, Dim Surround": ( InductionFactors_LLAB(0.7, 3.5, 1, 1) ), - "Cut Sheet Transparency, Dim Surround": ( - InductionFactors_LLAB(1, 5, 1, 1.1) - ), + "Cut Sheet Transparency, Dim Surround": (InductionFactors_LLAB(1, 5, 1, 1.1)), "35mm Projection Transparency, Dark Surround": ( InductionFactors_LLAB(0.7, 4, 1, 1) ), @@ -203,30 +201,14 @@ class CAM_ReferenceSpecification_LLAB(MixinDataclassArithmetic): :cite:`Fairchild2013x`, :cite:`Luo1996b`, :cite:`Luo1996c` """ - L_L: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - Ch_L: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - h_L: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - s_L: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - C_L: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - HC: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - A_L: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - B_L: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) + L_L: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + Ch_L: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + h_L: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + s_L: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + C_L: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + HC: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + A_L: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + B_L: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) @dataclass @@ -266,30 +248,14 @@ class CAM_Specification_LLAB(MixinDataclassArithmetic): :cite:`Fairchild2013x`, :cite:`Luo1996b`, :cite:`Luo1996c` """ - J: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - C: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - h: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - s: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - M: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - HC: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - a: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) - b: Optional[Union[float, NDArrayFloat]] = field( - default_factory=lambda: None - ) + J: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + C: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + h: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + s: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + M: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + HC: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + a: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) + b: Optional[Union[float, NDArrayFloat]] = field(default_factory=lambda: None) def XYZ_to_LLAB( @@ -436,7 +402,7 @@ def XYZ_to_RGB_LLAB(XYZ: ArrayLike) -> NDArrayFloat: XYZ = as_float_array(XYZ) with sdiv_mode(): - return vector_dot(MATRIX_XYZ_TO_RGB_LLAB, sdiv(XYZ, XYZ[..., 1, None])) + return vecmul(MATRIX_XYZ_TO_RGB_LLAB, sdiv(XYZ, XYZ[..., 1, None])) def chromatic_adaptation( @@ -495,7 +461,7 @@ def chromatic_adaptation( Y = tstack([Y, Y, Y]) - XYZ_r = vector_dot(MATRIX_RGB_TO_XYZ_LLAB, RGB_r * Y) + XYZ_r = vecmul(MATRIX_RGB_TO_XYZ_LLAB, RGB_r * Y) return XYZ_r diff --git a/colour/appearance/nayatani95.py b/colour/appearance/nayatani95.py index b286b32213..c8911408f9 100644 --- a/colour/appearance/nayatani95.py +++ b/colour/appearance/nayatani95.py @@ -2,7 +2,7 @@ Nayatani (1995) Colour Appearance Model ======================================= -Defines the *Nayatani (1995)* colour appearance model objects: +Define the *Nayatani (1995)* colour appearance model objects: - :class:`colour.CAM_Specification_Nayatani95` - :func:`colour.XYZ_to_Nayatani95` @@ -30,7 +30,7 @@ exponential_factors, intermediate_values, ) -from colour.algebra import spow, vector_dot +from colour.algebra import spow, vecmul from colour.hints import ArrayLike, NDArrayFloat, cast from colour.models import XYZ_to_xy from colour.utilities import ( @@ -293,27 +293,21 @@ def XYZ_to_Nayatani95( B_r = brightness_correlate(bRGB_o, bL_or, Q_response) # Computing *brightness* :math:`B_{rw}` of ideal white. - brightness_ideal_white = ideal_white_brightness_correlate( - bRGB_o, xez, bL_or, n - ) + brightness_ideal_white = ideal_white_brightness_correlate(bRGB_o, xez, bL_or, n) # Computing the correlate of achromatic *Lightness* :math:`L_p^\\star`. L_star_P = achromatic_lightness_correlate(Q_response) # Computing the correlate of normalised achromatic *Lightness* # :math:`L_n^\\star`. - L_star_N = normalised_achromatic_lightness_correlate( - B_r, brightness_ideal_white - ) + L_star_N = normalised_achromatic_lightness_correlate(B_r, brightness_ideal_white) # Computing the *hue* angle :math:`\\theta`. theta = hue_angle(p_response, t_response) # TODO: Implement hue quadrature & composition computation. # Computing the correlate of *saturation* :math:`S`. - S_RG, S_YB = tsplit( - saturation_components(theta, bL_or, t_response, p_response) - ) + S_RG, S_YB = tsplit(saturation_components(theta, bL_or, t_response, p_response)) S = saturation_correlate(S_RG, S_YB) # Computing the correlate of *chroma* :math:`C`. @@ -389,7 +383,7 @@ def XYZ_to_RGB_Nayatani95(XYZ: ArrayLike) -> NDArrayFloat: array([ 20.0005206..., 19.999783 ..., 19.9988316...]) """ - return vector_dot(MATRIX_XYZ_TO_RGB_NAYATANI95, XYZ) + return vecmul(MATRIX_XYZ_TO_RGB_NAYATANI95, XYZ) def scaling_coefficient(x: ArrayLike, y: ArrayLike) -> NDArrayFloat: diff --git a/colour/appearance/rlab.py b/colour/appearance/rlab.py index 3b2a5e29a4..9708f2a136 100644 --- a/colour/appearance/rlab.py +++ b/colour/appearance/rlab.py @@ -2,7 +2,7 @@ RLAB Colour Appearance Model ============================ -Defines the *RLAB* colour appearance model objects: +Define the *RLAB* colour appearance model objects: - :attr:`colour.VIEWING_CONDITIONS_RLAB` - :attr:`colour.D_FACTOR_RLAB` @@ -24,7 +24,7 @@ import numpy as np -from colour.algebra import matrix_dot, sdiv, sdiv_mode, spow, vector_dot +from colour.algebra import sdiv, sdiv_mode, spow, vecmul from colour.appearance.hunt import MATRIX_XYZ_TO_HPE, XYZ_to_rgb from colour.hints import ArrayLike, NDArrayFloat from colour.utilities import ( @@ -96,9 +96,7 @@ """ D_FACTOR_RLAB["hard_cp_img"] = D_FACTOR_RLAB["Hard Copy Images"] D_FACTOR_RLAB["soft_cp_img"] = D_FACTOR_RLAB["Soft Copy Images"] -D_FACTOR_RLAB["projected_dark"] = D_FACTOR_RLAB[ - "Projected Transparencies, Dark Room" -] +D_FACTOR_RLAB["projected_dark"] = D_FACTOR_RLAB["Projected Transparencies, Dark Room"] @dataclass @@ -268,10 +266,8 @@ def XYZ_to_RLAB( LMS_a_L = (LMS_p_L + D[..., None] * (1 - LMS_p_L)) / LMS_n - M = matrix_dot( - matrix_dot(MATRIX_R, row_as_diagonal(LMS_a_L)), MATRIX_XYZ_TO_HPE - ) - XYZ_ref = vector_dot(M, XYZ) + M = np.matmul(np.matmul(MATRIX_R, row_as_diagonal(LMS_a_L)), MATRIX_XYZ_TO_HPE) + XYZ_ref = vecmul(M, XYZ) X_ref, Y_ref, Z_ref = tsplit(XYZ_ref) diff --git a/colour/appearance/tests/test_atd95.py b/colour/appearance/tests/test_atd95.py index 7edafe3a9f..556194913c 100644 --- a/colour/appearance/tests/test_atd95.py +++ b/colour/appearance/tests/test_atd95.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.appearance.atd95` module.""" -import unittest from itertools import product import numpy as np @@ -26,7 +24,7 @@ ] -class TestXYZ_to_ATD95(unittest.TestCase): +class TestXYZ_to_ATD95: """ Define :func:`colour.appearance.atd95.XYZ_to_ATD95` definition unit tests methods. @@ -188,9 +186,7 @@ def test_domain_range_scale_XYZ_to_ATD95(self): for scale, factor_a, factor_b in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - XYZ_to_ATD95( - XYZ * factor_a, XYZ_0 * factor_a, Y_0, k_1, k_2 - ), + XYZ_to_ATD95(XYZ * factor_a, XYZ_0 * factor_a, Y_0, k_1, k_2), as_float_array(specification) * factor_b, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -205,7 +201,3 @@ def test_nan_XYZ_to_ATD95(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) XYZ_to_ATD95(cases, cases, cases[..., 0], cases[..., 0], cases[..., 0]) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/appearance/tests/test_cam16.py b/colour/appearance/tests/test_cam16.py index c6fc2dad32..c256901ca1 100644 --- a/colour/appearance/tests/test_cam16.py +++ b/colour/appearance/tests/test_cam16.py @@ -1,10 +1,9 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.appearance.cam16` module.""" -import unittest from itertools import product import numpy as np +import pytest from colour.appearance import ( VIEWING_CONDITIONS_CAM16, @@ -34,7 +33,7 @@ ] -class TestXYZ_to_CAM16(unittest.TestCase): +class TestXYZ_to_CAM16: """ Define :func:`colour.appearance.cam16.XYZ_to_CAM16` definition unit tests methods. @@ -221,9 +220,7 @@ def test_domain_range_scale_XYZ_to_CAM16(self): for scale, factor_a, factor_b in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - XYZ_to_CAM16( - XYZ * factor_a, XYZ_w * factor_a, L_A, Y_b, surround - ), + XYZ_to_CAM16(XYZ * factor_a, XYZ_w * factor_a, L_A, Y_b, surround), as_float_array(specification) * factor_b, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -237,13 +234,11 @@ def test_nan_XYZ_to_CAM16(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - surround = InductionFactors_CAM16( - cases[0, 0], cases[0, 0], cases[0, 0] - ) + surround = InductionFactors_CAM16(cases[0, 0], cases[0, 0], cases[0, 0]) XYZ_to_CAM16(cases, cases, cases[..., 0], cases[..., 0], surround) -class TestCAM16_to_XYZ(unittest.TestCase): +class TestCAM16_to_XYZ: """ Define :func:`colour.appearance.cam16.CAM16_to_XYZ` definition unit tests methods. @@ -252,9 +247,7 @@ class TestCAM16_to_XYZ(unittest.TestCase): def test_CAM16_to_XYZ(self): """Test :func:`colour.appearance.cam16.CAM16_to_XYZ` definition.""" - specification = CAM_Specification_CAM16( - 41.73120791, 0.10335574, 217.06795977 - ) + specification = CAM_Specification_CAM16(41.73120791, 0.10335574, 217.06795977) XYZ_w = np.array([95.05, 100.00, 108.88]) L_A = 318.31 Y_b = 20 @@ -265,9 +258,7 @@ def test_CAM16_to_XYZ(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - specification = CAM_Specification_CAM16( - 65.42828069, 49.67956420, 17.48659243 - ) + specification = CAM_Specification_CAM16(65.42828069, 49.67956420, 17.48659243) L_A = 31.83 np.testing.assert_allclose( CAM16_to_XYZ(specification, XYZ_w, L_A, Y_b, surround), @@ -275,9 +266,7 @@ def test_CAM16_to_XYZ(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - specification = CAM_Specification_CAM16( - 21.36052893, 50.99381895, 178.86724266 - ) + specification = CAM_Specification_CAM16(21.36052893, 50.99381895, 178.86724266) XYZ_w = np.array([109.85, 100, 35.58]) L_A = 318.31 np.testing.assert_allclose( @@ -286,9 +275,7 @@ def test_CAM16_to_XYZ(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - specification = CAM_Specification_CAM16( - 41.36326063, 52.81154022, 258.88676291 - ) + specification = CAM_Specification_CAM16(41.36326063, 52.81154022, 258.88676291) L_A = 318.31 np.testing.assert_allclose( CAM16_to_XYZ(specification, XYZ_w, L_A, Y_b, surround), @@ -296,9 +283,7 @@ def test_CAM16_to_XYZ(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - specification = CAM_Specification_CAM16( - 21.03801957, 457.78881613, 350.06445098 - ) + specification = CAM_Specification_CAM16(21.03801957, 457.78881613, 350.06445098) XYZ_w = np.array([95.05, 100.00, 108.88]) L_A = 4.074366543152521 np.testing.assert_allclose( @@ -409,12 +394,10 @@ def test_raise_exception_CAM16_to_XYZ(self): exception. """ - self.assertRaises( + pytest.raises( ValueError, CAM16_to_XYZ, - CAM_Specification_CAM16( - 41.731207905126638, None, 217.06795976739301 - ), + CAM_Specification_CAM16(41.731207905126638, None, 217.06795976739301), np.array([95.05, 100.00, 108.88]), 318.31, 20.0, @@ -430,19 +413,11 @@ def test_nan_CAM16_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - surround = InductionFactors_CAM16( - cases[0, 0], cases[0, 0], cases[0, 0] - ) + surround = InductionFactors_CAM16(cases[0, 0], cases[0, 0], cases[0, 0]) CAM16_to_XYZ( - CAM_Specification_CAM16( - cases[..., 0], cases[..., 0], cases[..., 0], M=50 - ), + CAM_Specification_CAM16(cases[..., 0], cases[..., 0], cases[..., 0], M=50), cases, cases[..., 0], cases[..., 0], surround, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/appearance/tests/test_ciecam02.py b/colour/appearance/tests/test_ciecam02.py index f848b95b05..f128973ef1 100644 --- a/colour/appearance/tests/test_ciecam02.py +++ b/colour/appearance/tests/test_ciecam02.py @@ -1,10 +1,9 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.appearance.ciecam02` module.""" -import unittest from itertools import product import numpy as np +import pytest from colour.appearance import ( VIEWING_CONDITIONS_CIECAM02, @@ -34,7 +33,7 @@ ] -class TestXYZ_to_CIECAM02(unittest.TestCase): +class TestXYZ_to_CIECAM02: """ Define :func:`colour.appearance.ciecam02.XYZ_to_CIECAM02` definition unit tests methods. @@ -66,9 +65,7 @@ def test_XYZ_to_CIECAM02(self): L_A = 31.83 np.testing.assert_allclose( XYZ_to_CIECAM02(XYZ, XYZ_w, L_A, Y_b, surround), - np.array( - [65.96, 48.57, 19.6, 52.25, 152.67, 41.67, 399.6, np.nan] - ), + np.array([65.96, 48.57, 19.6, 52.25, 152.67, 41.67, 399.6, np.nan]), atol=0.05, ) @@ -77,9 +74,7 @@ def test_XYZ_to_CIECAM02(self): L_A = 318.31 np.testing.assert_allclose( XYZ_to_CIECAM02(XYZ, XYZ_w, L_A, Y_b, surround), - np.array( - [21.79, 46.94, 177.1, 58.79, 141.17, 48.8, 220.4, np.nan] - ), + np.array([21.79, 46.94, 177.1, 58.79, 141.17, 48.8, 220.4, np.nan]), atol=0.05, ) @@ -87,9 +82,7 @@ def test_XYZ_to_CIECAM02(self): L_A = 31.83 np.testing.assert_allclose( XYZ_to_CIECAM02(XYZ, XYZ_w, L_A, Y_b, surround), - np.array( - [42.53, 51.92, 248.9, 60.22, 122.83, 44.54, 305.8, np.nan] - ), + np.array([42.53, 51.92, 248.9, 60.22, 122.83, 44.54, 305.8, np.nan]), atol=0.05, ) @@ -207,13 +200,11 @@ def test_nan_XYZ_to_CIECAM02(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - surround = InductionFactors_CIECAM02( - cases[0, 0], cases[0, 0], cases[0, 0] - ) + surround = InductionFactors_CIECAM02(cases[0, 0], cases[0, 0], cases[0, 0]) XYZ_to_CIECAM02(cases, cases, cases[..., 0], cases[..., 0], surround) -class TestCIECAM02_to_XYZ(unittest.TestCase): +class TestCIECAM02_to_XYZ: """ Define :func:`colour.appearance.ciecam02.CIECAM02_to_XYZ` definition unit tests methods. @@ -386,12 +377,10 @@ def test_raise_exception_CIECAM02_to_XYZ(self): raised exception. """ - self.assertRaises( + pytest.raises( ValueError, CIECAM02_to_XYZ, - CAM_Specification_CIECAM02( - 41.731091132513917, None, 219.04843265831178 - ), + CAM_Specification_CIECAM02(41.731091132513917, None, 219.04843265831178), np.array([95.05, 100.00, 108.88]), 318.31, 20.0, @@ -407,9 +396,7 @@ def test_nan_CIECAM02_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - surround = InductionFactors_CIECAM02( - cases[0, 0], cases[0, 0], cases[0, 0] - ) + surround = InductionFactors_CIECAM02(cases[0, 0], cases[0, 0], cases[0, 0]) CIECAM02_to_XYZ( CAM_Specification_CIECAM02( cases[..., 0], cases[..., 0], cases[..., 0], M=50 @@ -419,7 +406,3 @@ def test_nan_CIECAM02_to_XYZ(self): cases[..., 0], surround, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/appearance/tests/test_ciecam16.py b/colour/appearance/tests/test_ciecam16.py index c7ad6522b6..da6d4ec102 100644 --- a/colour/appearance/tests/test_ciecam16.py +++ b/colour/appearance/tests/test_ciecam16.py @@ -1,10 +1,9 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.appearance.ciecam16` module.""" -import unittest from itertools import product import numpy as np +import pytest from colour.appearance import ( VIEWING_CONDITIONS_CIECAM16, @@ -34,7 +33,7 @@ ] -class TestXYZ_to_CIECAM16(unittest.TestCase): +class TestXYZ_to_CIECAM16: """ Define :func:`colour.appearance.ciecam16.XYZ_to_CIECAM16` definition unit tests methods. @@ -260,13 +259,11 @@ def test_nan_XYZ_to_CIECAM16(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - surround = InductionFactors_CIECAM16( - cases[0, 0], cases[0, 0], cases[0, 0] - ) + surround = InductionFactors_CIECAM16(cases[0, 0], cases[0, 0], cases[0, 0]) XYZ_to_CIECAM16(cases, cases, cases[..., 0], cases[..., 0], surround) -class TestCIECAM16_to_XYZ(unittest.TestCase): +class TestCIECAM16_to_XYZ: """ Define :func:`colour.appearance.ciecam16.CIECAM16_to_XYZ` definition unit tests methods. @@ -444,12 +441,10 @@ def test_raise_exception_CIECAM16_to_XYZ(self): raised exception. """ - self.assertRaises( + pytest.raises( ValueError, CIECAM16_to_XYZ, - CAM_Specification_CIECAM16( - 41.731207905126638, None, 217.06795976739301 - ), + CAM_Specification_CIECAM16(41.731207905126638, None, 217.06795976739301), np.array([95.05, 100.00, 108.88]), 318.31, 20.0, @@ -465,9 +460,7 @@ def test_nan_CIECAM16_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - surround = InductionFactors_CIECAM16( - cases[0, 0], cases[0, 0], cases[0, 0] - ) + surround = InductionFactors_CIECAM16(cases[0, 0], cases[0, 0], cases[0, 0]) CIECAM16_to_XYZ( CAM_Specification_CIECAM16( cases[..., 0], cases[..., 0], cases[..., 0], M=50 @@ -477,7 +470,3 @@ def test_nan_CIECAM16_to_XYZ(self): cases[..., 0], surround, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/appearance/tests/test_hellwig2022.py b/colour/appearance/tests/test_hellwig2022.py index d9d6f69967..730bab5fc5 100644 --- a/colour/appearance/tests/test_hellwig2022.py +++ b/colour/appearance/tests/test_hellwig2022.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """ Define the unit tests for the :mod:`colour.appearance.hellwig2022` module. @@ -8,10 +7,10 @@ Discussion with Mansencal, T. """ -import unittest from itertools import product import numpy as np +import pytest from colour.appearance import ( VIEWING_CONDITIONS_HELLWIG2022, @@ -41,7 +40,7 @@ ] -class TestXYZ_to_Hellwig2022(unittest.TestCase): +class TestXYZ_to_Hellwig2022: """ Define :func:`colour.appearance.hellwig2022.XYZ_to_Hellwig2022` definition unit tests methods. @@ -238,15 +237,11 @@ def test_nan_XYZ_to_Hellwig2022(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - surround = InductionFactors_Hellwig2022( - cases[0, 0], cases[0, 0], cases[0, 0] - ) - XYZ_to_Hellwig2022( - cases, cases, cases[..., 0], cases[..., 0], surround - ) + surround = InductionFactors_Hellwig2022(cases[0, 0], cases[0, 0], cases[0, 0]) + XYZ_to_Hellwig2022(cases, cases, cases[..., 0], cases[..., 0], surround) -class TestHellwig2022_to_XYZ(unittest.TestCase): +class TestHellwig2022_to_XYZ: """ Define :func:`colour.appearance.hellwig2022.Hellwig2022_to_XYZ` definition unit tests methods. @@ -418,7 +413,7 @@ def test_raise_exception_Hellwig2022_to_XYZ(self): Test :func:`colour.appearance.hellwig2022.Hellwig2022_to_XYZ` definition raised exception. """ - self.assertRaises( + pytest.raises( ValueError, Hellwig2022_to_XYZ, CAM_Specification_Hellwig2022( @@ -430,12 +425,10 @@ def test_raise_exception_Hellwig2022_to_XYZ(self): VIEWING_CONDITIONS_HELLWIG2022["Average"], ) - self.assertRaises( + pytest.raises( ValueError, Hellwig2022_to_XYZ, - CAM_Specification_Hellwig2022( - 41.731207905126638, None, 217.06795976739301 - ), + CAM_Specification_Hellwig2022(41.731207905126638, None, 217.06795976739301), np.array([95.05, 100.00, 108.88]), 318.31, 20.0, @@ -451,9 +444,7 @@ def test_nan_Hellwig2022_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - surround = InductionFactors_Hellwig2022( - cases[0, 0], cases[0, 0], cases[0, 0] - ) + surround = InductionFactors_Hellwig2022(cases[0, 0], cases[0, 0], cases[0, 0]) Hellwig2022_to_XYZ( CAM_Specification_Hellwig2022( cases[..., 0], cases[..., 0], cases[..., 0], M=50 @@ -463,7 +454,3 @@ def test_nan_Hellwig2022_to_XYZ(self): cases[..., 0], surround, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/appearance/tests/test_hke.py b/colour/appearance/tests/test_hke.py index ca6b2157c4..2bd07867b9 100644 --- a/colour/appearance/tests/test_hke.py +++ b/colour/appearance/tests/test_hke.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.appearance.hke` module.""" -import unittest from itertools import product import numpy as np @@ -30,7 +28,7 @@ ] -class TestHelmholtzKohlrauschEffectObjectNayatani1997(unittest.TestCase): +class TestHelmholtzKohlrauschEffectObjectNayatani1997: """ Define :func:`colour.colour.appearance.hke.\ HelmholtzKohlrausch_effect_object_Nayatani1997` definition unit tests methods. @@ -139,7 +137,7 @@ def test_nan_HelmholtzKohlrausch_effect_object_Nayatani1997(self): HelmholtzKohlrausch_effect_object_Nayatani1997(case, case, case[0]) -class TestHelmholtzKohlrauschEffectLuminousNayatani1997(unittest.TestCase): +class TestHelmholtzKohlrauschEffectLuminousNayatani1997: """ Define :func:`colour.appearance.hke.\ HelmholtzKohlrausch_effect_luminous_Nayatani1997` definition unit tests @@ -246,12 +244,10 @@ def test_nan_HelmholtzKohlrausch_effect_luminous_Nayatani1997(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=2)))) for case in cases: - HelmholtzKohlrausch_effect_luminous_Nayatani1997( - case, case, case[0] - ) + HelmholtzKohlrausch_effect_luminous_Nayatani1997(case, case, case[0]) -class TestCoefficient_K_Br_Nayatani1997(unittest.TestCase): +class TestCoefficient_K_Br_Nayatani1997: """ Define :func:`colour.appearance.hke.coefficient_K_Br_Nayatani1997` definition unit tests methods. @@ -331,7 +327,7 @@ def test_nan_coefficient_K_Br_Nayatani1997(self): coefficient_K_Br_Nayatani1997(cases) -class TestCoefficient_q_Nayatani1997(unittest.TestCase): +class TestCoefficient_q_Nayatani1997: """ Define :func:`colour.appearance.hke.coefficient_q_Nayatani1997` definition unit tests methods. @@ -403,7 +399,3 @@ def test_nan_coefficient_q_Nayatani1997(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] coefficient_q_Nayatani1997(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/appearance/tests/test_hunt.py b/colour/appearance/tests/test_hunt.py index 1ada17da5f..db909d06c8 100644 --- a/colour/appearance/tests/test_hunt.py +++ b/colour/appearance/tests/test_hunt.py @@ -1,8 +1,6 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.appearance.hunt` module.""" import contextlib -import unittest from itertools import product import numpy as np @@ -31,7 +29,7 @@ ] -class TestXYZ_to_Hunt(unittest.TestCase): +class TestXYZ_to_Hunt: """ Define :func:`colour.appearance.hunt.XYZ_to_Hunt` definition unit tests methods. @@ -64,9 +62,7 @@ def test_XYZ_to_Hunt(self): L_A = 31.83 np.testing.assert_allclose( XYZ_to_Hunt(XYZ, XYZ_w, XYZ_b, L_A, surround, CCT_w=CCT_w), - np.array( - [66.76, 63.89, 18.6, 153.36, 31.22, 58.28, np.nan, np.nan] - ), + np.array([66.76, 63.89, 18.6, 153.36, 31.22, 58.28, np.nan, np.nan]), atol=0.05, ) @@ -76,9 +72,7 @@ def test_XYZ_to_Hunt(self): CCT_w = 2856 np.testing.assert_allclose( XYZ_to_Hunt(XYZ, XYZ_w, XYZ_b, L_A, surround, CCT_w=CCT_w), - np.array( - [19.56, 74.58, 178.3, 245.4, 18.9, 76.33, np.nan, np.nan] - ), + np.array([19.56, 74.58, 178.3, 245.4, 18.9, 76.33, np.nan, np.nan]), atol=0.05, ) @@ -86,9 +80,7 @@ def test_XYZ_to_Hunt(self): L_A = 31.83 np.testing.assert_allclose( XYZ_to_Hunt(XYZ, XYZ_w, XYZ_b, L_A, surround, CCT_w=CCT_w), - np.array( - [40.27, 73.84, 262.8, 209.29, 22.15, 67.35, np.nan, np.nan] - ), + np.array([40.27, 73.84, 262.8, 209.29, 22.15, 67.35, np.nan, np.nan]), atol=0.05, ) @@ -104,9 +96,7 @@ def test_n_dimensional_XYZ_to_Hunt(self): L_A = 318.31 surround = VIEWING_CONDITIONS_HUNT["Normal Scenes"] CCT_w = 6504.0 - specification = XYZ_to_Hunt( - XYZ, XYZ_w, XYZ_b, L_A, surround, CCT_w=CCT_w - ) + specification = XYZ_to_Hunt(XYZ, XYZ_w, XYZ_b, L_A, surround, CCT_w=CCT_w) XYZ = np.tile(XYZ, (6, 1)) specification = np.tile(specification, (6, 1)) @@ -146,9 +136,7 @@ def test_domain_range_scale_XYZ_to_Hunt(self): L_A = 318.31 surround = VIEWING_CONDITIONS_HUNT["Normal Scenes"] CCT_w = 6504.0 - specification = XYZ_to_Hunt( - XYZ, XYZ_w, XYZ_b, L_A, surround, CCT_w=CCT_w - ) + specification = XYZ_to_Hunt(XYZ, XYZ_w, XYZ_b, L_A, surround, CCT_w=CCT_w) d_r = ( ("reference", 1, 1), @@ -252,7 +240,3 @@ def test_nan_XYZ_to_Hunt(self): cases[0, 0], CCT_w=cases, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/appearance/tests/test_kim2009.py b/colour/appearance/tests/test_kim2009.py index ccc9c9a38b..45dd85df14 100644 --- a/colour/appearance/tests/test_kim2009.py +++ b/colour/appearance/tests/test_kim2009.py @@ -1,10 +1,9 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.appearance.kim2009` module.""" -import unittest from itertools import product import numpy as np +import pytest from colour.appearance import ( MEDIA_PARAMETERS_KIM2009, @@ -36,7 +35,7 @@ ] -class TestXYZ_to_Kim2009(unittest.TestCase): +class TestXYZ_to_Kim2009: """ Define :func:`colour.appearance.kim2009.XYZ_to_Kim2009` definition unit tests methods. @@ -220,13 +219,11 @@ def test_nan_XYZ_to_Kim2009(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) media = MediaParameters_Kim2009(cases[0, 0]) - surround = InductionFactors_Kim2009( - cases[0, 0], cases[0, 0], cases[0, 0] - ) + surround = InductionFactors_Kim2009(cases[0, 0], cases[0, 0], cases[0, 0]) XYZ_to_Kim2009(cases, cases, cases[0, 0], media, surround) -class TestKim2009_to_XYZ(unittest.TestCase): +class TestKim2009_to_XYZ: """ Define :func:`colour.appearance.kim2009.Kim2009_to_XYZ` definition unit tests methods. @@ -409,7 +406,7 @@ def test_raise_exception_Kim2009_to_XYZ(self): raised exception. """ - self.assertRaises( + pytest.raises( ValueError, Kim2009_to_XYZ, CAM_Specification_Kim2009( @@ -433,9 +430,7 @@ def test_nan_Kim2009_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) media = MediaParameters_Kim2009(cases[0, 0]) - surround = InductionFactors_Kim2009( - cases[0, 0], cases[0, 0], cases[0, 0] - ) + surround = InductionFactors_Kim2009(cases[0, 0], cases[0, 0], cases[0, 0]) Kim2009_to_XYZ( CAM_Specification_Kim2009( cases[..., 0], cases[..., 0], cases[..., 0], M=50 @@ -445,7 +440,3 @@ def test_nan_Kim2009_to_XYZ(self): media, surround, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/appearance/tests/test_llab.py b/colour/appearance/tests/test_llab.py index ccc9c9a38b..45dd85df14 100644 --- a/colour/appearance/tests/test_llab.py +++ b/colour/appearance/tests/test_llab.py @@ -1,10 +1,9 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.appearance.kim2009` module.""" -import unittest from itertools import product import numpy as np +import pytest from colour.appearance import ( MEDIA_PARAMETERS_KIM2009, @@ -36,7 +35,7 @@ ] -class TestXYZ_to_Kim2009(unittest.TestCase): +class TestXYZ_to_Kim2009: """ Define :func:`colour.appearance.kim2009.XYZ_to_Kim2009` definition unit tests methods. @@ -220,13 +219,11 @@ def test_nan_XYZ_to_Kim2009(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) media = MediaParameters_Kim2009(cases[0, 0]) - surround = InductionFactors_Kim2009( - cases[0, 0], cases[0, 0], cases[0, 0] - ) + surround = InductionFactors_Kim2009(cases[0, 0], cases[0, 0], cases[0, 0]) XYZ_to_Kim2009(cases, cases, cases[0, 0], media, surround) -class TestKim2009_to_XYZ(unittest.TestCase): +class TestKim2009_to_XYZ: """ Define :func:`colour.appearance.kim2009.Kim2009_to_XYZ` definition unit tests methods. @@ -409,7 +406,7 @@ def test_raise_exception_Kim2009_to_XYZ(self): raised exception. """ - self.assertRaises( + pytest.raises( ValueError, Kim2009_to_XYZ, CAM_Specification_Kim2009( @@ -433,9 +430,7 @@ def test_nan_Kim2009_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) media = MediaParameters_Kim2009(cases[0, 0]) - surround = InductionFactors_Kim2009( - cases[0, 0], cases[0, 0], cases[0, 0] - ) + surround = InductionFactors_Kim2009(cases[0, 0], cases[0, 0], cases[0, 0]) Kim2009_to_XYZ( CAM_Specification_Kim2009( cases[..., 0], cases[..., 0], cases[..., 0], M=50 @@ -445,7 +440,3 @@ def test_nan_Kim2009_to_XYZ(self): media, surround, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/appearance/tests/test_nayatani95.py b/colour/appearance/tests/test_nayatani95.py index 758108cdfd..b460492fb0 100644 --- a/colour/appearance/tests/test_nayatani95.py +++ b/colour/appearance/tests/test_nayatani95.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.appearance.nayatani95` module.""" -import unittest from itertools import product import numpy as np @@ -26,7 +24,7 @@ ] -class TestXYZ_to_Nayatani95(unittest.TestCase): +class TestXYZ_to_Nayatani95: """ Define :func:`colour.appearance.nayatani95.XYZ_to_Nayatani95` definition unit tests methods. @@ -68,9 +66,7 @@ def test_XYZ_to_Nayatani95(self): E_o = 5000 np.testing.assert_allclose( XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or), - np.array( - [24.5, 49.3, 190.6, 81.3, 37.5, 62.1, np.nan, np.nan, 29.7] - ), + np.array([24.5, 49.3, 190.6, 81.3, 37.5, 62.1, np.nan, np.nan, 29.7]), atol=0.05, ) @@ -78,9 +74,7 @@ def test_XYZ_to_Nayatani95(self): E_o = 500 np.testing.assert_allclose( XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or), - np.array( - [49.4, 39.9, 236.3, 40.2, 44.2, 35.8, np.nan, np.nan, 49.4] - ), + np.array([49.4, 39.9, 236.3, 40.2, 44.2, 35.8, np.nan, np.nan, 49.4]), atol=0.05, ) @@ -146,9 +140,7 @@ def test_domain_range_scale_XYZ_to_Nayatani95(self): for scale, factor_a, factor_b in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - XYZ_to_Nayatani95( - XYZ * factor_a, XYZ_n * factor_a, Y_o, E_o, E_or - ), + XYZ_to_Nayatani95(XYZ * factor_a, XYZ_n * factor_a, Y_o, E_o, E_or), as_float_array(specification) * factor_b, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -162,10 +154,4 @@ def test_nan_XYZ_to_Nayatani95(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - XYZ_to_Nayatani95( - cases, cases, cases[..., 0], cases[..., 0], cases[..., 0] - ) - - -if __name__ == "__main__": - unittest.main() + XYZ_to_Nayatani95(cases, cases, cases[..., 0], cases[..., 0], cases[..., 0]) diff --git a/colour/appearance/tests/test_rlab.py b/colour/appearance/tests/test_rlab.py index 758108cdfd..b460492fb0 100644 --- a/colour/appearance/tests/test_rlab.py +++ b/colour/appearance/tests/test_rlab.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.appearance.nayatani95` module.""" -import unittest from itertools import product import numpy as np @@ -26,7 +24,7 @@ ] -class TestXYZ_to_Nayatani95(unittest.TestCase): +class TestXYZ_to_Nayatani95: """ Define :func:`colour.appearance.nayatani95.XYZ_to_Nayatani95` definition unit tests methods. @@ -68,9 +66,7 @@ def test_XYZ_to_Nayatani95(self): E_o = 5000 np.testing.assert_allclose( XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or), - np.array( - [24.5, 49.3, 190.6, 81.3, 37.5, 62.1, np.nan, np.nan, 29.7] - ), + np.array([24.5, 49.3, 190.6, 81.3, 37.5, 62.1, np.nan, np.nan, 29.7]), atol=0.05, ) @@ -78,9 +74,7 @@ def test_XYZ_to_Nayatani95(self): E_o = 500 np.testing.assert_allclose( XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or), - np.array( - [49.4, 39.9, 236.3, 40.2, 44.2, 35.8, np.nan, np.nan, 49.4] - ), + np.array([49.4, 39.9, 236.3, 40.2, 44.2, 35.8, np.nan, np.nan, 49.4]), atol=0.05, ) @@ -146,9 +140,7 @@ def test_domain_range_scale_XYZ_to_Nayatani95(self): for scale, factor_a, factor_b in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - XYZ_to_Nayatani95( - XYZ * factor_a, XYZ_n * factor_a, Y_o, E_o, E_or - ), + XYZ_to_Nayatani95(XYZ * factor_a, XYZ_n * factor_a, Y_o, E_o, E_or), as_float_array(specification) * factor_b, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -162,10 +154,4 @@ def test_nan_XYZ_to_Nayatani95(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - XYZ_to_Nayatani95( - cases, cases, cases[..., 0], cases[..., 0], cases[..., 0] - ) - - -if __name__ == "__main__": - unittest.main() + XYZ_to_Nayatani95(cases, cases, cases[..., 0], cases[..., 0], cases[..., 0]) diff --git a/colour/appearance/tests/test_zcam.py b/colour/appearance/tests/test_zcam.py index 758108cdfd..2ba077f983 100644 --- a/colour/appearance/tests/test_zcam.py +++ b/colour/appearance/tests/test_zcam.py @@ -1,171 +1,509 @@ -# !/usr/bin/env python -"""Define the unit tests for the :mod:`colour.appearance.nayatani95` module.""" +""" +Define the unit tests for the :mod:`colour.appearance.zcam` module. +""" -import unittest -from itertools import product +from itertools import permutations import numpy as np +import pytest -from colour.appearance import XYZ_to_Nayatani95 -from colour.constants import TOLERANCE_ABSOLUTE_TESTS +from colour.appearance import ( + VIEWING_CONDITIONS_ZCAM, + CAM_Specification_ZCAM, + InductionFactors_ZCAM, + XYZ_to_ZCAM, + ZCAM_to_XYZ, +) from colour.utilities import ( as_float_array, domain_range_scale, ignore_numpy_errors, + tsplit, ) __author__ = "Colour Developers" -__copyright__ = "Copyright 2013 Colour Developers" -__license__ = "BSD-3-Clause - https://opensource.org/licenses/BSD-3-Clause" +__copyright__ = "Copyright (C) 2013-2021 - Colour Developers" +__license__ = "New BSD License - https://opensource.org/licenses/BSD-3-Clause" __maintainer__ = "Colour Developers" __email__ = "colour-developers@colour-science.org" __status__ = "Production" -__all__ = [ - "TestXYZ_to_Nayatani95", -] +__all__ = ["TestXYZ_to_ZCAM", "TestZCAM_to_XYZ"] -class TestXYZ_to_Nayatani95(unittest.TestCase): +class TestXYZ_to_ZCAM: """ - Define :func:`colour.appearance.nayatani95.XYZ_to_Nayatani95` definition - unit tests methods. + Defines :func:`colour.appearance.zcam.XYZ_to_ZCAM` definition unit tests + methods. """ - def test_XYZ_to_Nayatani95(self): + def test_XYZ_to_ZCAM(self): """ - Test :func:`colour.appearance.nayatani95.XYZ_to_Nayatani95` - definition. - - Notes - ----- - - The test values have been generated from data of the following file - by *Fairchild (2013)*: - http://rit-mcsl.org/fairchild//files/AppModEx.xls + Tests :func:`colour.appearance.zcam.XYZ_to_ZCAM` definition. """ - XYZ = np.array([19.01, 20.00, 21.78]) - XYZ_n = np.array([95.05, 100.00, 108.88]) - Y_o = 20 - E_o = 5000 - E_or = 1000 + XYZ = np.array([185, 206, 163]) + XYZ_w = np.array([256, 264, 202]) + L_a = 264 + Y_b = 100 + surround = VIEWING_CONDITIONS_ZCAM["Average"] np.testing.assert_allclose( - XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or), - np.array([50, 0.01, 257.5, 0.01, 62.6, 0.02, np.nan, np.nan, 50]), - atol=0.05, + XYZ_to_ZCAM(XYZ, XYZ_w, L_a, Y_b, surround), + np.array( + [ + 92.2520, + 3.0216, + 196.3524, + 19.1314, + 321.3464, + 10.5252, + 237.6401, + np.nan, + 34.7022, + 25.2994, + 91.6837, + ] + ), + rtol=0.025, + atol=0.025, ) - XYZ = np.array([57.06, 43.06, 31.96]) - E_o = 500 + XYZ = np.array([89, 96, 120]) np.testing.assert_allclose( - XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or), - np.array([73, 48.3, 21.6, 37.1, 67.3, 42.9, np.nan, np.nan, 75.9]), - atol=0.05, + XYZ_to_ZCAM(XYZ, XYZ_w, L_a, Y_b, surround), + np.array( + [ + 71.2071, + 6.8539, + 250.6422, + 32.7963, + 248.0394, + 23.8744, + 307.0595, + np.nan, + 18.2796, + 40.4621, + 70.4026, + ] + ), + rtol=0.025, + atol=0.025, + ) + + # NOTE: Hue quadrature :math:`H_z` is significantly different for this + # test, i.e., 47.748252 vs 43.8258. + # NOTE: :math:`F_L` as reported in the supplemental document has the + # same value as for :math:`L_a` = 264 instead of 150. The values seem + # to be computed for :math:`L_a` = 264 and :math:`Y_b` = 100. + XYZ = np.array([79, 81, 62]) + # L_a = 150 + # Y_b = 60 + surround = VIEWING_CONDITIONS_ZCAM["Dim"] + np.testing.assert_allclose( + XYZ_to_ZCAM(XYZ, XYZ_w, L_a, Y_b, surround), + np.array( + [ + 68.8890, + 0.9774, + 58.7532, + 12.5916, + 196.7686, + 2.7918, + 43.8258, + np.nan, + 11.0371, + 44.4143, + 68.8737, + ] + ), + rtol=0.025, + atol=4, ) - XYZ = np.array([3.53, 6.56, 2.14]) - XYZ_n = np.array([109.85, 100.00, 35.58]) - E_o = 5000 + XYZ = np.array([910, 1114, 500]) + XYZ_w = np.array([2103, 2259, 1401]) + L_a = 359 + Y_b = 16 + surround = VIEWING_CONDITIONS_ZCAM["Dark"] np.testing.assert_allclose( - XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or), + XYZ_to_ZCAM(XYZ, XYZ_w, L_a, Y_b, surround), np.array( - [24.5, 49.3, 190.6, 81.3, 37.5, 62.1, np.nan, np.nan, 29.7] + [ + 82.6445, + 13.0838, + 123.9464, + 44.7277, + 114.7431, + 18.1655, + 178.6422, + np.nan, + 34.4874, + 26.8778, + 78.2653, + ] ), - atol=0.05, + rtol=0.025, + atol=0.025, ) - XYZ = np.array([19.01, 20.00, 21.78]) - E_o = 500 + XYZ = np.array([96, 67, 28]) np.testing.assert_allclose( - XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or), + XYZ_to_ZCAM(XYZ, XYZ_w, L_a, Y_b, surround), np.array( - [49.4, 39.9, 236.3, 40.2, 44.2, 35.8, np.nan, np.nan, 49.4] + [ + 33.0139, + 19.4070, + 389.7720 % 360, + 86.1882, + 45.8363, + 26.9446, + 397.3301, + np.nan, + 43.6447, + 47.9942, + 30.2593, + ] ), - atol=0.05, + rtol=0.025, + atol=0.025, ) - def test_n_dimensional_XYZ_to_Nayatani95(self): + def test_n_dimensional_XYZ_to_ZCAM(self): """ - Test :func:`colour.appearance.nayatani95.XYZ_to_Nayatani95` definition + Tests :func:`colour.appearance.zcam.XYZ_to_ZCAM` definition n-dimensional support. """ - XYZ = np.array([19.01, 20.00, 21.78]) - XYZ_n = np.array([95.05, 100.00, 108.88]) - Y_o = 20 - E_o = 5000 - E_or = 1000 - specification = XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or) + XYZ = np.array([185, 206, 163]) + XYZ_w = np.array([256, 264, 202]) + L_a = 264 + Y_b = 100 + surround = VIEWING_CONDITIONS_ZCAM["Average"] + specification = XYZ_to_ZCAM(XYZ, XYZ_w, L_a, Y_b, surround) XYZ = np.tile(XYZ, (6, 1)) specification = np.tile(specification, (6, 1)) - np.testing.assert_allclose( - XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or), - specification, - atol=TOLERANCE_ABSOLUTE_TESTS, + np.testing.assert_almost_equal( + XYZ_to_ZCAM(XYZ, XYZ_w, L_a, Y_b, surround), specification, decimal=7 ) - XYZ_n = np.tile(XYZ_n, (6, 1)) - np.testing.assert_allclose( - XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or), - specification, - atol=TOLERANCE_ABSOLUTE_TESTS, + XYZ_w = np.tile(XYZ_w, (6, 1)) + np.testing.assert_almost_equal( + XYZ_to_ZCAM(XYZ, XYZ_w, L_a, Y_b, surround), specification, decimal=7 ) XYZ = np.reshape(XYZ, (2, 3, 3)) - XYZ_n = np.reshape(XYZ_n, (2, 3, 3)) - specification = np.reshape(specification, (2, 3, 9)) - np.testing.assert_allclose( - XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or), - specification, - atol=TOLERANCE_ABSOLUTE_TESTS, + XYZ_w = np.reshape(XYZ_w, (2, 3, 3)) + specification = np.reshape(specification, (2, 3, 11)) + np.testing.assert_almost_equal( + XYZ_to_ZCAM(XYZ, XYZ_w, L_a, Y_b, surround), specification, decimal=7 ) - def test_domain_range_scale_XYZ_to_Nayatani95(self): + @ignore_numpy_errors + def test_domain_range_scale_XYZ_to_ZCAM(self): """ - Test :func:`colour.appearance.nayatani95.XYZ_to_Nayatani95` definition + Tests :func:`colour.appearance.zcam.XYZ_to_ZCAM` definition domain and range scale support. """ - XYZ = np.array([19.01, 20.00, 21.78]) - XYZ_n = np.array([95.05, 100.00, 108.88]) - Y_o = 20.0 - E_o = 5000.0 - E_or = 1000.0 - specification = XYZ_to_Nayatani95(XYZ, XYZ_n, Y_o, E_o, E_or) + XYZ = np.array([185, 206, 163]) + XYZ_w = np.array([256, 264, 202]) + L_a = 264 + Y_b = 100 + surround = VIEWING_CONDITIONS_ZCAM["Average"] + specification = XYZ_to_ZCAM(XYZ, XYZ_w, L_a, Y_b, surround) d_r = ( ("reference", 1, 1), - ("1", 0.01, np.array([1, 1, 1 / 360, 1, 1, 1, np.nan, np.nan, 1])), + (1, 1, np.array([1, 1, 1 / 360, 1, 1, 1, 1 / 400, np.nan, 1, 1, 1])), ( - "100", - 1, - np.array([1, 1, 100 / 360, 1, 1, 1, np.nan, np.nan, 1]), + 100, + 100, + np.array( + [ + 100, + 100, + 100 / 360, + 100, + 100, + 100, + 100 / 400, + np.nan, + 100, + 100, + 100, + ] + ), ), ) for scale, factor_a, factor_b in d_r: with domain_range_scale(scale): - np.testing.assert_allclose( - XYZ_to_Nayatani95( - XYZ * factor_a, XYZ_n * factor_a, Y_o, E_o, E_or - ), + np.testing.assert_almost_equal( + XYZ_to_ZCAM(XYZ * factor_a, XYZ_w * factor_a, L_a, Y_b, surround), as_float_array(specification) * factor_b, - atol=TOLERANCE_ABSOLUTE_TESTS, + decimal=7, ) @ignore_numpy_errors - def test_nan_XYZ_to_Nayatani95(self): + def test_nan_XYZ_to_ZCAM(self): """ - Test :func:`colour.appearance.nayatani95.XYZ_to_Nayatani95` definition + Tests :func:`colour.appearance.zcam.XYZ_to_ZCAM` definition nan support. """ cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] - cases = np.array(list(set(product(cases, repeat=3)))) - XYZ_to_Nayatani95( - cases, cases, cases[..., 0], cases[..., 0], cases[..., 0] + cases = set(permutations(cases * 3, r=3)) + for case in cases: + XYZ = np.array(case) + XYZ_w = np.array(case) + L_a = case[0] + Y_b = 100 + surround = InductionFactors_ZCAM(case[0], case[0], case[0], case[0]) + XYZ_to_ZCAM(XYZ, XYZ_w, L_a, Y_b, surround) + + +class TestZCAM_to_XYZ: + """ + Defines :func:`colour.appearance.zcam.ZCAM_to_XYZ` definition unit + tests methods. + """ + + def test_ZCAM_to_XYZ(self): + """ + Tests :func:`colour.appearance.zcam.ZCAM_to_XYZ` definition. + """ + + specification = CAM_Specification_ZCAM( + 92.2520, + 3.0216, + 196.3524, + 19.1314, + 321.3464, + 10.5252, + 237.6401, + np.nan, + 34.7022, + 25.2994, + 91.6837, + ) + XYZ_w = np.array([256, 264, 202]) + L_a = 264 + Y_b = 100 + surround = VIEWING_CONDITIONS_ZCAM["Average"] + np.testing.assert_allclose( + ZCAM_to_XYZ(specification, XYZ_w, L_a, Y_b, surround), + np.array([185, 206, 163]), + atol=0.01, + rtol=0.01, + ) + + specification = CAM_Specification_ZCAM( + 71.2071, + 6.8539, + 250.6422, + 32.7963, + 248.0394, + 23.8744, + 307.0595, + np.nan, + 18.2796, + 40.4621, + 70.4026, + ) + np.testing.assert_allclose( + ZCAM_to_XYZ(specification, XYZ_w, L_a, Y_b, surround), + np.array([89, 96, 120]), + atol=0.01, + rtol=0.01, + ) + + specification = CAM_Specification_ZCAM( + 68.8890, + 0.9774, + 58.7532, + 12.5916, + 196.7686, + 2.7918, + 43.8258, + np.nan, + 11.0371, + 44.4143, + 68.8737, + ) + surround = VIEWING_CONDITIONS_ZCAM["Dim"] + np.testing.assert_allclose( + ZCAM_to_XYZ(specification, XYZ_w, L_a, Y_b, surround), + np.array([79, 81, 62]), + atol=0.01, + rtol=0.01, + ) + + specification = CAM_Specification_ZCAM( + 82.6445, + 13.0838, + 123.9464, + 44.7277, + 114.7431, + 18.1655, + 178.6422, + np.nan, + 34.4874, + 26.8778, + 78.2653, + ) + XYZ_w = np.array([2103, 2259, 1401]) + L_a = 359 + Y_b = 16 + surround = VIEWING_CONDITIONS_ZCAM["Dark"] + np.testing.assert_allclose( + ZCAM_to_XYZ(specification, XYZ_w, L_a, Y_b, surround), + np.array([910, 1114, 500]), + atol=0.01, + rtol=0.01, + ) + + specification = CAM_Specification_ZCAM( + 33.0139, + 19.4070, + 389.7720 % 360, + 86.1882, + 45.8363, + 26.9446, + 397.3301, + np.nan, + 43.6447, + 47.9942, + 30.2593, + ) + np.testing.assert_allclose( + ZCAM_to_XYZ(specification, XYZ_w, L_a, Y_b, surround), + np.array([96, 67, 28]), + atol=0.01, + rtol=0.01, ) + def test_n_dimensional_ZCAM_to_XYZ(self): + """ + Tests :func:`colour.appearance.zcam.ZCAM_to_XYZ` definition + n-dimensional support. + """ + + XYZ = np.array([185, 206, 163]) + XYZ_w = np.array([256, 264, 202]) + L_a = 264 + Y_b = 100 + surround = VIEWING_CONDITIONS_ZCAM["Average"] + specification = XYZ_to_ZCAM(XYZ, XYZ_w, L_a, Y_b, surround) + XYZ = ZCAM_to_XYZ(specification, XYZ_w, L_a, Y_b, surround) + + specification = CAM_Specification_ZCAM( + *np.transpose(np.tile(tsplit(specification), (6, 1))).tolist() + ) + XYZ = np.tile(XYZ, (6, 1)) + np.testing.assert_almost_equal( + ZCAM_to_XYZ(specification, XYZ_w, L_a, Y_b, surround), XYZ, decimal=7 + ) + + XYZ_w = np.tile(XYZ_w, (6, 1)) + np.testing.assert_almost_equal( + ZCAM_to_XYZ(specification, XYZ_w, L_a, Y_b, surround), XYZ, decimal=7 + ) + + specification = CAM_Specification_ZCAM( + *tsplit(np.reshape(specification, (2, 3, 11))).tolist() + ) + XYZ_w = np.reshape(XYZ_w, (2, 3, 3)) + XYZ = np.reshape(XYZ, (2, 3, 3)) + np.testing.assert_almost_equal( + ZCAM_to_XYZ(specification, XYZ_w, L_a, Y_b, surround), XYZ, decimal=7 + ) + + @ignore_numpy_errors + def test_domain_range_scale_ZCAM_to_XYZ(self): + """ + Tests :func:`colour.appearance.zcam.ZCAM_to_XYZ` definition + domain and range scale support. + """ + + XYZ_i = np.array([185, 206, 163]) + XYZ_w = np.array([256, 264, 202]) + L_a = 264 + Y_b = 100 + surround = VIEWING_CONDITIONS_ZCAM["Average"] + specification = XYZ_to_ZCAM(XYZ_i, XYZ_w, L_a, Y_b, surround) + XYZ = ZCAM_to_XYZ(specification, XYZ_w, L_a, Y_b, surround) + + d_r = ( + ("reference", 1, 1), + (1, np.array([1, 1, 1 / 360, 1, 1, 1, 1 / 400, np.nan, 1, 1, 1]), 1), + ( + 100, + np.array( + [ + 100, + 100, + 100 / 360, + 100, + 100, + 100, + 100 / 400, + np.nan, + 100, + 100, + 100, + ] + ), + 100, + ), + ) + for scale, factor_a, factor_b in d_r: + with domain_range_scale(scale): + np.testing.assert_almost_equal( + ZCAM_to_XYZ( + specification * factor_a, XYZ_w * factor_b, L_a, Y_b, surround + ), + XYZ * factor_b, + decimal=7, + ) -if __name__ == "__main__": - unittest.main() + @ignore_numpy_errors + def test_raise_exception_ZCAM_to_XYZ(self): + """ + Tests :func:`colour.appearance.zcam.ZCAM_to_XYZ` definition + raised exception. + """ + + pytest.raises( + ValueError, + ZCAM_to_XYZ, + CAM_Specification_ZCAM( + 41.731091132513917, + None, + 219.04843265831178, + ), + np.array([256, 264, 202]), + 318.31, + 20.0, + VIEWING_CONDITIONS_ZCAM["Average"], + ) + + @ignore_numpy_errors + def test_nan_ZCAM_to_XYZ(self): + """ + Tests :func:`colour.appearance.zcam.ZCAM_to_XYZ` definition nan + support. + """ + + cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] + cases = set(permutations(cases * 3, r=3)) + for case in cases: + J = case[0] + C = case[0] + h = case[0] + XYZ_w = np.array(case) + L_a = case[0] + Y_b = 100 + surround = InductionFactors_ZCAM(case[0], case[0], case[0], case[0]) + ZCAM_to_XYZ( + CAM_Specification_ZCAM(J, C, h, M=50), XYZ_w, L_a, Y_b, surround + ) diff --git a/colour/appearance/zcam.py b/colour/appearance/zcam.py index 79f8299a91..6464345498 100644 --- a/colour/appearance/zcam.py +++ b/colour/appearance/zcam.py @@ -2,7 +2,7 @@ ZCAM Colour Appearance Model ============================ -Defines the *ZCAM* colour appearance model objects: +Define the *ZCAM* colour appearance model objects: - :class:`colour.appearance.InductionFactors_ZCAM` - :attr:`colour.VIEWING_CONDITIONS_ZCAM` @@ -104,15 +104,9 @@ class InductionFactors_ZCAM( VIEWING_CONDITIONS_ZCAM: CanonicalMapping = CanonicalMapping( { - "Average": InductionFactors_ZCAM( - 0.69, *VIEWING_CONDITIONS_CIECAM02["Average"] - ), - "Dim": InductionFactors_ZCAM( - 0.59, *VIEWING_CONDITIONS_CIECAM02["Dim"] - ), - "Dark": InductionFactors_ZCAM( - 0.525, *VIEWING_CONDITIONS_CIECAM02["Dark"] - ), + "Average": InductionFactors_ZCAM(0.69, *VIEWING_CONDITIONS_CIECAM02["Average"]), + "Dim": InductionFactors_ZCAM(0.59, *VIEWING_CONDITIONS_CIECAM02["Dim"]), + "Dark": InductionFactors_ZCAM(0.525, *VIEWING_CONDITIONS_CIECAM02["Dark"]), } ) VIEWING_CONDITIONS_ZCAM.__doc__ = """ @@ -435,11 +429,7 @@ def XYZ_to_ZCAM( # Step 0 (Forward) - Chromatic adaptation from reference illuminant to # "CIE Standard Illuminant D65" illuminant using "CAT02". # Computing degree of adaptation :math:`D`. - D = ( - degree_of_adaptation(F, L_A) - if not discount_illuminant - else ones(L_A.shape) - ) + D = degree_of_adaptation(F, L_A) if not discount_illuminant else ones(L_A.shape) XYZ_D65 = chromatic_adaptation_Zhai2018( XYZ, XYZ_w, TVS_D65, D, D, transform="CAT02" @@ -457,9 +447,7 @@ def XYZ_to_ZCAM( # and yellowness-blueness (:math:`b_z`, :math:`b_{z,w}`). with domain_range_scale("ignore"): I_z, a_z, b_z = tsplit(XYZ_to_Izazbz(XYZ_D65, method="Safdar 2021")) - I_z_w, _a_z_w, _b_z_w = tsplit( - XYZ_to_Izazbz(XYZ_w, method="Safdar 2021") - ) + I_z_w, _a_z_w, _b_z_w = tsplit(XYZ_to_Izazbz(XYZ_w, method="Safdar 2021")) # Step 3 (Forward) - Computing hue angle :math:`h_z` h_z = hue_angle(a_z, b_z) @@ -482,10 +470,7 @@ def XYZ_to_ZCAM( M_z = ( 100 * (a_z**2 + b_z**2) ** 0.37 - * ( - (spow(e_z, 0.068) * spow(F_L, 0.2)) - / (F_b**0.1 * spow(I_z_w, 0.78)) - ) + * ((spow(e_z, 0.068) * spow(F_L, 0.2)) / (F_b**0.1 * spow(I_z_w, 0.78))) ) C_z = 100 * M_z / Q_z_w @@ -533,7 +518,7 @@ def ZCAM_to_XYZ( *ZCAM* colour appearance model specification. Correlate of *Lightness* :math:`J`, correlate of *chroma* :math:`C` or correlate of *colourfulness* :math:`M` and *hue* angle :math:`h` in - degrees must be specified, e.g. :math:`JCh` or :math:`JMh`. + degrees must be specified, e.g., :math:`JCh` or :math:`JMh`. XYZ_w Absolute *CIE XYZ* tristimulus values of the white under reference illuminant. @@ -644,9 +629,7 @@ def ZCAM_to_XYZ( array([ 185., 206., 163.]) """ - J_z, C_z, h_z, _S_z, _Q_z, M_z, _H, _H_Z, _V_z, _K_z, _W_z = astuple( - specification - ) + J_z, C_z, h_z, _S_z, _Q_z, M_z, _H, _H_Z, _V_z, _K_z, _W_z = astuple(specification) J_z = to_domain_1(J_z) C_z = to_domain_1(C_z) @@ -663,11 +646,7 @@ def ZCAM_to_XYZ( # Step 0 (Forward) - Chromatic adaptation from reference illuminant to # "CIE Standard Illuminant D65" illuminant using "CAT02". # Computing degree of adaptation :math:`D`. - D = ( - degree_of_adaptation(F, L_A) - if not discount_illuminant - else ones(L_A.shape) - ) + D = degree_of_adaptation(F, L_A) if not discount_illuminant else ones(L_A.shape) # Step 1 (Forward) - Computing factors related with viewing conditions and # independent of the test stimulus. @@ -680,9 +659,7 @@ def ZCAM_to_XYZ( # redness-greenness (:math:`a_{z,w}`), and yellowness-blueness # (:math:`b_{z,w}`). with domain_range_scale("ignore"): - I_z_w, _A_z_w, _B_z_w = tsplit( - XYZ_to_Izazbz(XYZ_w, method="Safdar 2021") - ) + I_z_w, _A_z_w, _B_z_w = tsplit(XYZ_to_Izazbz(XYZ_w, method="Safdar 2021")) # Step 1 (Inverse) - Computing achromatic response (:math:`I_z`). Q_z_p = (1.6 * F_s) / spow(F_b, 0.12) @@ -759,7 +736,7 @@ def hue_quadrature(h: ArrayLike) -> NDArrayFloat: e_i = HUE_DATA_FOR_HUE_QUADRATURE["e_i"] H_i = HUE_DATA_FOR_HUE_QUADRATURE["H_i"] - # :math:`h_p` = :math:`h_z` + 360 if :math:`h_z` < :math:`h_1, i.e. h_i[0] + # :math:`h_p` = :math:`h_z` + 360 if :math:`h_z` < :math:`h_1, i.e., h_i[0] h[h <= h_i[0]] += 360 # *np.searchsorted* returns an erroneous index if a *nan* is used as input. h[np.asarray(np.isnan(h))] = 0 diff --git a/colour/biochemistry/__init__.py b/colour/biochemistry/__init__.py index e991b94072..af5d4d1cc8 100644 --- a/colour/biochemistry/__init__.py +++ b/colour/biochemistry/__init__.py @@ -1,10 +1,3 @@ -import sys - -from colour.utilities.deprecation import ModuleAPI, build_API_changes -from colour.utilities.documentation import is_documentation_building - -from colour.hints import Any - from .michaelis_menten import ( REACTION_RATE_MICHAELISMENTEN_METHODS, reaction_rate_MichaelisMenten, @@ -30,38 +23,3 @@ "reaction_rate_MichaelisMenten_Abebe2017", "substrate_concentration_MichaelisMenten_Abebe2017", ] - - -# ----------------------------------------------------------------------------# -# --- API Changes and Deprecation Management ---# -# ----------------------------------------------------------------------------# -class biochemistry(ModuleAPI): - """Define a class acting like the *biochemistry* module.""" - - def __getattr__(self, attribute) -> Any: - """Return the value from the attribute with given name.""" - - return super().__getattr__(attribute) - - -# v0.4.0 -API_CHANGES = { - "ObjectRenamed": [ - [ - "colour.biochemistry.reaction_rate_MichealisMenten", - "colour.biochemistry.reaction_rate_MichaelisMenten", - ], - [ - "colour.biochemistry.substrate_concentration_MichealisMenten", - "colour.biochemistry.substrate_concentration_MichaelisMenten", - ], - ] -} -"""Defines the *colour.biochemistry* sub-package API changes.""" - -if not is_documentation_building(): - sys.modules["colour.biochemistry"] = biochemistry( # pyright: ignore - sys.modules["colour.biochemistry"], build_API_changes(API_CHANGES) - ) - - del ModuleAPI, is_documentation_building, build_API_changes, sys diff --git a/colour/biochemistry/michaelis_menten.py b/colour/biochemistry/michaelis_menten.py index 7cec5251c8..def5af287c 100644 --- a/colour/biochemistry/michaelis_menten.py +++ b/colour/biochemistry/michaelis_menten.py @@ -2,7 +2,7 @@ Michaelis-Menten Kinetics ========================= -Implements support for *Michaelis-Menten* kinetics, a model of enzyme kinetics: +Implement support for *Michaelis-Menten* kinetics, a model of enzyme kinetics: - :func:`colour.biochemistry.reaction_rate_MichaelisMenten_Michaelis1913` - :func:`colour.biochemistry.reaction_rate_MichaelisMenten_Abebe2017` @@ -217,9 +217,7 @@ def reaction_rate_MichaelisMenten( 1.0360547... """ - method = validate_method( - method, tuple(REACTION_RATE_MICHAELISMENTEN_METHODS) - ) + method = validate_method(method, tuple(REACTION_RATE_MICHAELISMENTEN_METHODS)) function = REACTION_RATE_MICHAELISMENTEN_METHODS[method] @@ -323,9 +321,7 @@ def substrate_concentration_MichaelisMenten_Abebe2017( return as_float(S) -SUBSTRATE_CONCENTRATION_MICHAELISMENTEN_METHODS: ( - CanonicalMapping -) = CanonicalMapping( +SUBSTRATE_CONCENTRATION_MICHAELISMENTEN_METHODS: CanonicalMapping = CanonicalMapping( { "Michaelis 1913": substrate_concentration_MichaelisMenten_Michaelis1913, "Abebe 2017": substrate_concentration_MichaelisMenten_Abebe2017, diff --git a/colour/biochemistry/tests/test_michaelis_menten.py b/colour/biochemistry/tests/test_michaelis_menten.py index 7add626d9d..755cced973 100644 --- a/colour/biochemistry/tests/test_michaelis_menten.py +++ b/colour/biochemistry/tests/test_michaelis_menten.py @@ -3,7 +3,6 @@ module. """ -import unittest from itertools import product import numpy as np @@ -32,7 +31,7 @@ ] -class TestReactionRateMichaelisMentenMichaelis1913(unittest.TestCase): +class TestReactionRateMichaelisMentenMichaelis1913: """ Define :func:`colour.biochemistry.michaelis_menten.\ reaction_rate_MichaelisMenten_Michaelis1913` definition unit tests methods. @@ -112,9 +111,7 @@ def test_nan_reaction_rate_MichaelisMenten_Michaelis1913(self): reaction_rate_MichaelisMenten_Michaelis1913(cases, cases, cases) -class TestSubstrateConcentrationMichaelisMentenMichaelis1913( - unittest.TestCase -): +class TestSubstrateConcentrationMichaelisMentenMichaelis1913: """ Define :func:`colour.biochemistry.michaelis_menten.\ reaction_rate_MichaelisMenten_Michaelis1913` definition unit tests methods. @@ -127,25 +124,19 @@ def test_substrate_concentration_MichaelisMenten_Michaelis1913(self): """ np.testing.assert_allclose( - substrate_concentration_MichaelisMenten_Michaelis1913( - 0.25, 0.5, 0.25 - ), + substrate_concentration_MichaelisMenten_Michaelis1913(0.25, 0.5, 0.25), 0.250000000000000, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - substrate_concentration_MichaelisMenten_Michaelis1913( - 1 / 3, 0.5, 0.25 - ), + substrate_concentration_MichaelisMenten_Michaelis1913(1 / 3, 0.5, 0.25), 0.500000000000000, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - substrate_concentration_MichaelisMenten_Michaelis1913( - 0.4875, 0.75, 0.35 - ), + substrate_concentration_MichaelisMenten_Michaelis1913(0.4875, 0.75, 0.35), 0.650000000000000, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -162,16 +153,12 @@ def test_n_dimensional_substrate_concentration_MichaelisMenten_Michaelis1913( S = 1 / 3 V_max = 0.5 K_m = 0.25 - v = substrate_concentration_MichaelisMenten_Michaelis1913( - S, V_max, K_m - ) + v = substrate_concentration_MichaelisMenten_Michaelis1913(S, V_max, K_m) S = np.tile(S, (6, 1)) v = np.tile(v, (6, 1)) np.testing.assert_allclose( - substrate_concentration_MichaelisMenten_Michaelis1913( - S, V_max, K_m - ), + substrate_concentration_MichaelisMenten_Michaelis1913(S, V_max, K_m), v, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -179,9 +166,7 @@ def test_n_dimensional_substrate_concentration_MichaelisMenten_Michaelis1913( V_max = np.tile(V_max, (6, 1)) K_m = np.tile(K_m, (6, 1)) np.testing.assert_allclose( - substrate_concentration_MichaelisMenten_Michaelis1913( - S, V_max, K_m - ), + substrate_concentration_MichaelisMenten_Michaelis1913(S, V_max, K_m), v, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -191,9 +176,7 @@ def test_n_dimensional_substrate_concentration_MichaelisMenten_Michaelis1913( K_m = np.reshape(K_m, (2, 3, 1)) v = np.reshape(v, (2, 3, 1)) np.testing.assert_allclose( - substrate_concentration_MichaelisMenten_Michaelis1913( - S, V_max, K_m - ), + substrate_concentration_MichaelisMenten_Michaelis1913(S, V_max, K_m), v, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -207,12 +190,10 @@ def test_nan_substrate_concentration_MichaelisMenten_Michaelis1913(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - substrate_concentration_MichaelisMenten_Michaelis1913( - cases, cases, cases - ) + substrate_concentration_MichaelisMenten_Michaelis1913(cases, cases, cases) -class TestReactionRateMichaelisMentenAbebe2017(unittest.TestCase): +class TestReactionRateMichaelisMentenAbebe2017: """ Define :func:`colour.biochemistry.michaelis_menten.\ reaction_rate_MichaelisMenten_Abebe2017` definition unit tests methods. @@ -295,7 +276,7 @@ def test_nan_reaction_rate_MichaelisMenten_Abebe2017(self): reaction_rate_MichaelisMenten_Abebe2017(cases, cases, cases, cases) -class TestSubstrateConcentrationMichaelisMentenAbebe2017(unittest.TestCase): +class TestSubstrateConcentrationMichaelisMentenAbebe2017: """ Define :func:`colour.biochemistry.michaelis_menten.\ reaction_rate_MichaelisMenten_Abebe2017` definition unit tests methods. @@ -344,16 +325,12 @@ def test_n_dimensional_substrate_concentration_MichaelisMenten_Abebe2017( V_max = 0.5 K_m = 0.25 b_m = 0.25 - v = substrate_concentration_MichaelisMenten_Abebe2017( - S, V_max, K_m, b_m - ) + v = substrate_concentration_MichaelisMenten_Abebe2017(S, V_max, K_m, b_m) S = np.tile(S, (6, 1)) v = np.tile(v, (6, 1)) np.testing.assert_allclose( - substrate_concentration_MichaelisMenten_Abebe2017( - S, V_max, K_m, b_m - ), + substrate_concentration_MichaelisMenten_Abebe2017(S, V_max, K_m, b_m), v, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -362,9 +339,7 @@ def test_n_dimensional_substrate_concentration_MichaelisMenten_Abebe2017( K_m = np.tile(K_m, (6, 1)) b_m = np.tile(b_m, (6, 1)) np.testing.assert_allclose( - substrate_concentration_MichaelisMenten_Abebe2017( - S, V_max, K_m, b_m - ), + substrate_concentration_MichaelisMenten_Abebe2017(S, V_max, K_m, b_m), v, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -375,9 +350,7 @@ def test_n_dimensional_substrate_concentration_MichaelisMenten_Abebe2017( b_m = np.reshape(b_m, (2, 3, 1)) v = np.reshape(v, (2, 3, 1)) np.testing.assert_allclose( - substrate_concentration_MichaelisMenten_Abebe2017( - S, V_max, K_m, b_m - ), + substrate_concentration_MichaelisMenten_Abebe2017(S, V_max, K_m, b_m), v, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -391,10 +364,4 @@ def test_nan_substrate_concentration_MichaelisMenten_Abebe2017(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - substrate_concentration_MichaelisMenten_Abebe2017( - cases, cases, cases, cases - ) - - -if __name__ == "__main__": - unittest.main() + substrate_concentration_MichaelisMenten_Abebe2017(cases, cases, cases, cases) diff --git a/colour/blindness/datasets/machado2010.py b/colour/blindness/datasets/machado2010.py index 132f4e07af..3e7614abd6 100644 --- a/colour/blindness/datasets/machado2010.py +++ b/colour/blindness/datasets/machado2010.py @@ -2,7 +2,7 @@ Pre-Computed Matrices for simulation of CVD - Machado (2009) ============================================================ -Defines the pre-computed matrices for simulation of colour vision deficiency +Define the pre-computed matrices for simulation of colour vision deficiency from Machado (2010). References diff --git a/colour/blindness/machado2009.py b/colour/blindness/machado2009.py index c1d5b1d5e9..8eaeb1826e 100644 --- a/colour/blindness/machado2009.py +++ b/colour/blindness/machado2009.py @@ -2,7 +2,7 @@ Simulation of CVD - Machado, Oliveira and Fernandes (2009) ========================================================== -Defines the *Machado et al. (2009)* objects for simulation of colour vision +Define the *Machado et al. (2009)* objects for simulation of colour vision deficiency: - :func:`colour.msds_cmfs_anomalous_trichromacy_Machado2009` @@ -30,7 +30,7 @@ import numpy as np -from colour.algebra import matrix_dot, vector_dot +from colour.algebra import vecmul from colour.blindness import CVD_MATRICES_MACHADO2010 from colour.characterisation import RGB_DisplayPrimaries from colour.colorimetry import ( @@ -108,7 +108,7 @@ def matrix_RGB_to_WSYBRG( """ wavelengths = cmfs.wavelengths - WSYBRG = vector_dot(MATRIX_LMS_TO_WSYBRG, cmfs.values) + WSYBRG = vecmul(MATRIX_LMS_TO_WSYBRG, cmfs.values) WS, YB, RG = tsplit(WSYBRG) primaries = reshape_msds( @@ -120,17 +120,17 @@ def matrix_RGB_to_WSYBRG( R, G, B = tsplit(primaries.values) - WS_R = np.trapz(R * WS, wavelengths) - WS_G = np.trapz(G * WS, wavelengths) - WS_B = np.trapz(B * WS, wavelengths) + WS_R = np.trapezoid(R * WS, wavelengths) # pyright: ignore + WS_G = np.trapezoid(G * WS, wavelengths) # pyright: ignore + WS_B = np.trapezoid(B * WS, wavelengths) # pyright: ignore - YB_R = np.trapz(R * YB, wavelengths) - YB_G = np.trapz(G * YB, wavelengths) - YB_B = np.trapz(B * YB, wavelengths) + YB_R = np.trapezoid(R * YB, wavelengths) # pyright: ignore + YB_G = np.trapezoid(G * YB, wavelengths) # pyright: ignore + YB_B = np.trapezoid(B * YB, wavelengths) # pyright: ignore - RG_R = np.trapz(R * RG, wavelengths) - RG_G = np.trapz(G * RG, wavelengths) - RG_B = np.trapz(B * RG, wavelengths) + RG_R = np.trapezoid(R * RG, wavelengths) # pyright: ignore + RG_G = np.trapezoid(G * RG, wavelengths) # pyright: ignore + RG_B = np.trapezoid(B * RG, wavelengths) # pyright: ignore M_G = as_float_array( [ @@ -193,9 +193,7 @@ def msds_cmfs_anomalous_trichromacy_Machado2009( >>> cmfs = MSDS_CMFS_LMS["Stockman & Sharpe 2 Degree Cone Fundamentals"] >>> cmfs[450] array([ 0.0498639, 0.0870524, 0.955393 ]) - >>> msds_cmfs_anomalous_trichromacy_Machado2009( - ... cmfs, np.array([15, 0, 0]) - ... )[ + >>> msds_cmfs_anomalous_trichromacy_Machado2009(cmfs, np.array([15, 0, 0]))[ ... 450 ... ] # doctest: +ELLIPSIS array([ 0.0891288..., 0.0870524 , 0.955393 ]) @@ -221,8 +219,8 @@ def msds_cmfs_anomalous_trichromacy_Machado2009( "deuteranomaly simulation." ) - area_L = np.trapz(L, cmfs.wavelengths) - area_M = np.trapz(M, cmfs.wavelengths) + area_L = np.trapezoid(L, cmfs.wavelengths) # pyright: ignore + area_M = np.trapezoid(M, cmfs.wavelengths) # pyright: ignore def alpha(x: NDArrayFloat) -> NDArrayFloat: """Compute :math:`alpha` factor.""" @@ -310,7 +308,7 @@ def matrix_anomalous_trichromacy_Machado2009( cmfs_a = msds_cmfs_anomalous_trichromacy_Machado2009(cmfs, d_LMS) M_a = matrix_RGB_to_WSYBRG(cmfs_a, primaries) - return matrix_dot(np.linalg.inv(M_n), M_a) + return np.matmul(np.linalg.inv(M_n), M_a) def matrix_cvd_Machado2009( diff --git a/colour/blindness/tests/test_machado2009.py b/colour/blindness/tests/test_machado2009.py index fd419c88bd..a5428d7f7c 100644 --- a/colour/blindness/tests/test_machado2009.py +++ b/colour/blindness/tests/test_machado2009.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.blindness.machado2009` module.""" -import unittest import numpy as np @@ -30,7 +28,7 @@ ] -class TestMsdsCmfsAnomalousTrichromacyMachado2009(unittest.TestCase): +class TestMsdsCmfsAnomalousTrichromacyMachado2009: """ Define :func:`colour.blindness.machado2009.\ msds_cmfs_anomalous_trichromacy_Machado2009` definition unit tests methods. @@ -121,7 +119,7 @@ def test_msds_cmfs_anomalous_trichromacy_Machado2009(self): ) -class TestMatrixAnomalousTrichromacyMachado2009(unittest.TestCase): +class TestMatrixAnomalousTrichromacyMachado2009: """ Define :func:`colour.blindness.machado2009.\ matrix_anomalous_trichromacy_Machado2009` definition unit tests methods. @@ -216,7 +214,7 @@ def test_matrix_anomalous_trichromacy_Machado2009(self): ) -class TestMatrixCvdMachado2009(unittest.TestCase): +class TestMatrixCvdMachado2009: """ Define :func:`colour.blindness.machado2009.matrix_cvd_Machado2009` definition unit tests methods. @@ -285,7 +283,3 @@ def test_nan_matrix_cvd_Machado2009(self): for case in [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]: matrix_cvd_Machado2009("Tritanomaly", case) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/characterisation/__init__.py b/colour/characterisation/__init__.py index 15f0627f4d..ef485daccb 100644 --- a/colour/characterisation/__init__.py +++ b/colour/characterisation/__init__.py @@ -1,10 +1,3 @@ -import sys - -from colour.utilities.deprecation import ModuleAPI, build_API_changes -from colour.utilities.documentation import is_documentation_building - -from colour.hints import Any - from .cameras import RGB_CameraSensitivities from .displays import RGB_DisplayPrimaries from .datasets import * # noqa: F403 @@ -96,36 +89,3 @@ "matrix_idt", "camera_RGB_to_ACES2065_1", ] - - -# ----------------------------------------------------------------------------# -# --- API Changes and Deprecation Management ---# -# ----------------------------------------------------------------------------# -class characterisation(ModuleAPI): - """Define a class acting like the *characterisation* module.""" - - def __getattr__(self, attribute) -> Any: - """Return the value from the attribute with given name.""" - - return super().__getattr__(attribute) - - -# v0.4.0 -API_CHANGES = { - "ObjectRenamed": [ - [ - "colour.characterisation.optimisation_factory_JzAzBz", - "colour.characterisation.optimisation_factory_Jzazbz", - ], - ] -} -"""Defines the *colour.characterisation* sub-package API changes.""" - -if not is_documentation_building(): - sys.modules[ - "colour.characterisation" - ] = characterisation( # pyright: ignore - sys.modules["colour.characterisation"], build_API_changes(API_CHANGES) - ) - - del ModuleAPI, is_documentation_building, build_API_changes, sys diff --git a/colour/characterisation/aces_it.py b/colour/characterisation/aces_it.py index 34f6e7c47c..724f3a237e 100644 --- a/colour/characterisation/aces_it.py +++ b/colour/characterisation/aces_it.py @@ -2,7 +2,7 @@ Academy Color Encoding System - Input Transform =============================================== -Defines the *Academy Color Encoding System* (ACES) *Input Transform* utilities: +Define the *Academy Color Encoding System* (ACES) *Input Transform* utilities: - :func:`colour.sd_to_aces_relative_exposure_values` - :func:`colour.sd_to_ACES2065_1` @@ -63,7 +63,7 @@ from colour.adaptation import matrix_chromatic_adaptation_VonKries from colour.algebra import ( euclidean_distance, - vector_dot, + vecmul, ) from colour.characterisation import ( MSDS_ACES_RICD, @@ -161,9 +161,9 @@ def sd_to_aces_relative_exposure_values( sd: SpectralDistribution, illuminant: SpectralDistribution | None = None, - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", **kwargs, ) -> NDArrayFloat: """ @@ -213,9 +213,7 @@ def sd_to_aces_relative_exposure_values( ... sd, chromatic_adaptation_transform=None ... ) # doctest: +ELLIPSIS array([ 0.1171814..., 0.0866360..., 0.0589726...]) - >>> sd_to_aces_relative_exposure_values( - ... sd, apply_chromatic_adaptation=True - ... ) + >>> sd_to_aces_relative_exposure_values(sd, apply_chromatic_adaptation=True) ... # doctest: +ELLIPSIS array([ 0.1180779..., 0.0869031..., 0.0589125...]) """ @@ -300,7 +298,7 @@ def k(x: NDArrayFloat, y: NDArrayFloat) -> DTypeFloat: ----- - *Colour* only ships a minimal dataset from *RAW to ACES*, please see `Colour - Datasets `_ - for the complete *RAW to ACES* v1 dataset, i.e. *3372171*. + for the complete *RAW to ACES* v1 dataset, i.e., *3372171*. """ _TRAINING_DATA_RAWTOACES_V1: MultiSpectralDistributions | None = None @@ -404,9 +402,7 @@ def generate_illuminants_rawtoaces_v1() -> CanonicalMapping: # A.M.P.A.S. variant of ISO 7589 Studio Tungsten. sd = read_sds_from_csv_file( - os.path.join( - ROOT_RESOURCES_RAWTOACES, "AMPAS_ISO_7589_Tungsten.csv" - ) + os.path.join(ROOT_RESOURCES_RAWTOACES, "AMPAS_ISO_7589_Tungsten.csv") )["iso7589"] illuminants.update({sd.name: sd}) @@ -444,9 +440,7 @@ def white_balance_multipliers( ... ROOT_RESOURCES_RAWTOACES, ... "CANON_EOS_5DMark_II_RGB_Sensitivities.csv", ... ) - >>> sensitivities = sds_and_msds_to_msds( - ... read_sds_from_csv_file(path).values() - ... ) + >>> sensitivities = sds_and_msds_to_msds(read_sds_from_csv_file(path).values()) >>> illuminant = SDS_ILLUMINANTS["D55"] >>> white_balance_multipliers(sensitivities, illuminant) ... # doctest: +ELLIPSIS @@ -455,14 +449,10 @@ def white_balance_multipliers( shape = sensitivities.shape if illuminant.shape != shape: - runtime_warning( - f'Aligning "{illuminant.name}" illuminant shape to "{shape}".' - ) + runtime_warning(f'Aligning "{illuminant.name}" illuminant shape to "{shape}".') illuminant = reshape_sd(illuminant, shape, copy=False) - RGB_w = 1 / np.sum( - sensitivities.values * illuminant.values[..., None], axis=0 - ) + RGB_w = 1 / np.sum(sensitivities.values * illuminant.values[..., None], axis=0) RGB_w *= 1 / np.min(RGB_w) return RGB_w @@ -497,13 +487,9 @@ def best_illuminant( ... ROOT_RESOURCES_RAWTOACES, ... "CANON_EOS_5DMark_II_RGB_Sensitivities.csv", ... ) - >>> sensitivities = sds_and_msds_to_msds( - ... read_sds_from_csv_file(path).values() - ... ) + >>> sensitivities = sds_and_msds_to_msds(read_sds_from_csv_file(path).values()) >>> illuminants = generate_illuminants_rawtoaces_v1() - >>> RGB_w = white_balance_multipliers( - ... sensitivities, SDS_ILLUMINANTS["FL2"] - ... ) + >>> RGB_w = white_balance_multipliers(sensitivities, SDS_ILLUMINANTS["FL2"]) >>> best_illuminant(RGB_w, sensitivities, illuminants).name 'D40' """ @@ -550,9 +536,7 @@ def normalise_illuminant( ... ROOT_RESOURCES_RAWTOACES, ... "CANON_EOS_5DMark_II_RGB_Sensitivities.csv", ... ) - >>> sensitivities = sds_and_msds_to_msds( - ... read_sds_from_csv_file(path).values() - ... ) + >>> sensitivities = sds_and_msds_to_msds(read_sds_from_csv_file(path).values()) >>> illuminant = SDS_ILLUMINANTS["D55"] >>> np.sum(illuminant.values) # doctest: +ELLIPSIS 7276.1490000... @@ -563,9 +547,7 @@ def normalise_illuminant( shape = sensitivities.shape if illuminant.shape != shape: - runtime_warning( - f'Aligning "{illuminant.name}" illuminant shape to "{shape}".' - ) + runtime_warning(f'Aligning "{illuminant.name}" illuminant shape to "{shape}".') illuminant = reshape_sd(illuminant, shape) c_i = np.argmax(np.max(sensitivities.values, axis=0)) @@ -604,16 +586,10 @@ def training_data_sds_to_RGB( ... ROOT_RESOURCES_RAWTOACES, ... "CANON_EOS_5DMark_II_RGB_Sensitivities.csv", ... ) - >>> sensitivities = sds_and_msds_to_msds( - ... read_sds_from_csv_file(path).values() - ... ) - >>> illuminant = normalise_illuminant( - ... SDS_ILLUMINANTS["D55"], sensitivities - ... ) + >>> sensitivities = sds_and_msds_to_msds(read_sds_from_csv_file(path).values()) + >>> illuminant = normalise_illuminant(SDS_ILLUMINANTS["D55"], sensitivities) >>> training_data = read_training_data_rawtoaces_v1() - >>> RGB, RGB_w = training_data_sds_to_RGB( - ... training_data, sensitivities, illuminant - ... ) + >>> RGB, RGB_w = training_data_sds_to_RGB(training_data, sensitivities, illuminant) >>> RGB[:5] # doctest: +ELLIPSIS array([[ 0.0207582..., 0.0196857..., 0.0213935...], [ 0.0895775..., 0.0891922..., 0.0891091...], @@ -626,9 +602,7 @@ def training_data_sds_to_RGB( shape = sensitivities.shape if illuminant.shape != shape: - runtime_warning( - f'Aligning "{illuminant.name}" illuminant shape to "{shape}".' - ) + runtime_warning(f'Aligning "{illuminant.name}" illuminant shape to "{shape}".') illuminant = reshape_sd(illuminant, shape, copy=False) if training_data.shape != shape: @@ -653,9 +627,9 @@ def training_data_sds_to_XYZ( training_data: MultiSpectralDistributions, cmfs: MultiSpectralDistributions, illuminant: SpectralDistribution, - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", ) -> NDArrayFloat: """ Convert given training data to *CIE XYZ* tristimulus values using given @@ -686,12 +660,8 @@ def training_data_sds_to_XYZ( ... "CANON_EOS_5DMark_II_RGB_Sensitivities.csv", ... ) >>> cmfs = MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] - >>> sensitivities = sds_and_msds_to_msds( - ... read_sds_from_csv_file(path).values() - ... ) - >>> illuminant = normalise_illuminant( - ... SDS_ILLUMINANTS["D55"], sensitivities - ... ) + >>> sensitivities = sds_and_msds_to_msds(read_sds_from_csv_file(path).values()) + >>> illuminant = normalise_illuminant(SDS_ILLUMINANTS["D55"], sensitivities) >>> training_data = read_training_data_rawtoaces_v1() >>> training_data_sds_to_XYZ(training_data, cmfs, illuminant)[:5] ... # doctest: +ELLIPSIS @@ -704,9 +674,7 @@ def training_data_sds_to_XYZ( shape = cmfs.shape if illuminant.shape != shape: - runtime_warning( - f'Aligning "{illuminant.name}" illuminant shape to "{shape}".' - ) + runtime_warning(f'Aligning "{illuminant.name}" illuminant shape to "{shape}".') illuminant = reshape_sd(illuminant, shape, copy=False) if training_data.shape != shape: @@ -732,7 +700,7 @@ def training_data_sds_to_XYZ( chromatic_adaptation_transform, ) - XYZ = vector_dot(M_CAT, XYZ) + XYZ = vecmul(M_CAT, XYZ) return XYZ @@ -758,7 +726,7 @@ def whitepoint_preserving_matrix( Examples -------- - >>> M = np.arange(9).reshape([3, 3]) + >>> M = np.reshape(np.arange(9), (3, 3)) >>> whitepoint_preserving_matrix(M) array([[ 0., 1., 0.], [ 3., 4., -6.], @@ -813,9 +781,7 @@ def objective_function( M = finaliser_function(M) - XYZ_t = vector_dot( - RGB_COLOURSPACE_ACES2065_1.matrix_RGB_to_XYZ, vector_dot(M, RGB) - ) + XYZ_t = vecmul(RGB_COLOURSPACE_ACES2065_1.matrix_RGB_to_XYZ, vecmul(M, RGB)) Lab_t = XYZ_to_optimization_colour_model(XYZ_t) return as_float(np.linalg.norm(Lab_t - Lab)) @@ -840,9 +806,7 @@ def finaliser_function(M: ArrayLike) -> NDArrayFloat: ) -def optimisation_factory_Jzazbz() -> ( - Tuple[NDArrayFloat, Callable, Callable, Callable] -): +def optimisation_factory_Jzazbz() -> Tuple[NDArrayFloat, Callable, Callable, Callable]: """ Produce the objective function and *CIE XYZ* colourspace to optimisation colourspace/colour model function based on the :math:`J_za_zb_z` @@ -881,9 +845,7 @@ def objective_function( M = finaliser_function(M) - XYZ_t = vector_dot( - RGB_COLOURSPACE_ACES2065_1.matrix_RGB_to_XYZ, vector_dot(M, RGB) - ) + XYZ_t = vecmul(RGB_COLOURSPACE_ACES2065_1.matrix_RGB_to_XYZ, vecmul(M, RGB)) Jab_t = XYZ_to_optimization_colour_model(XYZ_t) return as_float(np.sum(euclidean_distance(Jab, Jab_t))) @@ -959,9 +921,7 @@ def objective_function( RGB_COLOURSPACE_ACES2065_1.matrix_RGB_to_XYZ, np.dot( M, - np.transpose( - polynomial_expansion_Finlayson2015(RGB, 2, True) - ), + np.transpose(polynomial_expansion_Finlayson2015(RGB, 2, True)), ), ) ) @@ -997,9 +957,9 @@ def matrix_idt( cmfs: MultiSpectralDistributions | None = None, optimisation_factory: Callable = optimisation_factory_rawtoaces_v1, optimisation_kwargs: dict | None = None, - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", additional_data: bool = False, ) -> ( Tuple[NDArrayFloat, NDArrayFloat, NDArrayFloat, NDArrayFloat] @@ -1053,9 +1013,7 @@ def matrix_idt( ... ROOT_RESOURCES_RAWTOACES, ... "CANON_EOS_5DMark_II_RGB_Sensitivities.csv", ... ) - >>> sensitivities = sds_and_msds_to_msds( - ... read_sds_from_csv_file(path).values() - ... ) + >>> sensitivities = sds_and_msds_to_msds(read_sds_from_csv_file(path).values()) >>> illuminant = SDS_ILLUMINANTS["D55"] >>> M, RGB_w = matrix_idt(sensitivities, illuminant) >>> np.around(M, 3) @@ -1118,9 +1076,7 @@ def matrix_idt( illuminant = normalise_illuminant(illuminant, sensitivities) - RGB, RGB_w = training_data_sds_to_RGB( - training_data, sensitivities, illuminant - ) + RGB, RGB_w = training_data_sds_to_RGB(training_data, sensitivities, illuminant) XYZ = training_data_sds_to_XYZ( training_data, cmfs, illuminant, chromatic_adaptation_transform @@ -1198,9 +1154,7 @@ def camera_RGB_to_ACES2065_1( ... ROOT_RESOURCES_RAWTOACES, ... "CANON_EOS_5DMark_II_RGB_Sensitivities.csv", ... ) - >>> sensitivities = sds_and_msds_to_msds( - ... read_sds_from_csv_file(path).values() - ... ) + >>> sensitivities = sds_and_msds_to_msds(read_sds_from_csv_file(path).values()) >>> illuminant = SDS_ILLUMINANTS["D55"] >>> B, b = matrix_idt(sensitivities, illuminant) >>> camera_RGB_to_ACES2065_1(np.array([0.1, 0.2, 0.3]), B, b) @@ -1217,4 +1171,4 @@ def camera_RGB_to_ACES2065_1( RGB_r = np.clip(RGB_r, -np.inf, 1) if clip else RGB_r - return k * vector_dot(B, RGB_r) + return k * vecmul(B, RGB_r) diff --git a/colour/characterisation/cameras.py b/colour/characterisation/cameras.py index 5687082965..a56139d28b 100644 --- a/colour/characterisation/cameras.py +++ b/colour/characterisation/cameras.py @@ -2,7 +2,7 @@ Cameras Sensitivities ===================== -Defines the spectral distributions classes for the datasets from +Define the spectral distributions classes for the datasets from the :mod:`colour.characterisation.datasets.cameras` module: - :class:`colour.characterisation.RGB_CameraSensitivities`: Implement support @@ -87,20 +87,20 @@ class instances :attr:`colour.continuous.Signal.wavelengths` attribute def __init__( self, - data: ArrayLike - | DataFrame - | dict - | MultiSignals - | MultiSpectralDistributions - | Sequence - | Series - | Signal - | SpectralDistribution - | None = None, + data: ( + ArrayLike + | DataFrame + | dict + | MultiSignals + | MultiSpectralDistributions + | Sequence + | Series + | Signal + | SpectralDistribution + | None + ) = None, domain: ArrayLike | SpectralShape | None = None, labels: Sequence | None = None, # noqa: ARG002 **kwargs: Any, ) -> None: - super().__init__( - data, domain, labels=("red", "green", "blue"), **kwargs - ) + super().__init__(data, domain, labels=("red", "green", "blue"), **kwargs) diff --git a/colour/characterisation/correction.py b/colour/characterisation/correction.py index 2f8b46aba6..007a187a86 100644 --- a/colour/characterisation/correction.py +++ b/colour/characterisation/correction.py @@ -2,7 +2,7 @@ Colour Correction ================= -Defines various objects for colour correction, like colour matching two images: +Define various objects for colour correction, like colour matching two images: - :func:`colour.characterisation.matrix_augmented_Cheung2004` : Polynomial expansion using *Cheung, Westland, Connah and Ripamonti (2004)* method. @@ -157,9 +157,7 @@ def matrix_augmented_Cheung2004( R, G, B = tsplit(RGB) tail = ones(R.shape) - existing_terms = np.array( - [3, 4, 5, 7, 8, 10, 11, 14, 16, 17, 19, 20, 22, 35] - ) + existing_terms = np.array([3, 4, 5, 7, 8, 10, 11, 14, 16, 17, 19, 20, 22, 35]) closest_terms = as_int(closest(existing_terms, terms)) if closest_terms != terms: raise ValueError( @@ -609,9 +607,7 @@ def polynomial_expansion_Finlayson2015( ) -def polynomial_expansion_Vandermonde( - a: ArrayLike, degree: int = 1 -) -> NDArrayFloat: +def polynomial_expansion_Vandermonde(a: ArrayLike, degree: int = 1) -> NDArrayFloat: """ Perform polynomial expansion of given :math:`a` array using *Vandermonde* method. @@ -666,8 +662,9 @@ def polynomial_expansion_Vandermonde( def polynomial_expansion( a: ArrayLike, - method: Literal["Cheung 2004", "Finlayson 2015", "Vandermonde"] - | str = "Cheung 2004", + method: ( + Literal["Cheung 2004", "Finlayson 2015", "Vandermonde"] | str + ) = "Cheung 2004", **kwargs: Any, ) -> NDArrayFloat: """ @@ -806,9 +803,7 @@ def matrix_colour_correction_Finlayson2015( """ return least_square_mapping_MoorePenrose( - polynomial_expansion_Finlayson2015( - M_T, degree, root_polynomial_expansion - ), + polynomial_expansion_Finlayson2015(M_T, degree, root_polynomial_expansion), M_R, ) @@ -874,8 +869,9 @@ def matrix_colour_correction_Vandermonde( def matrix_colour_correction( M_T: ArrayLike, M_R: ArrayLike, - method: Literal["Cheung 2004", "Finlayson 2015", "Vandermonde"] - | str = "Cheung 2004", + method: ( + Literal["Cheung 2004", "Finlayson 2015", "Vandermonde"] | str + ) = "Cheung 2004", **kwargs: Any, ) -> NDArrayFloat: """ @@ -1030,9 +1026,7 @@ def apply_matrix_colour_correction_Cheung2004( ... [0.05725508, -0.20526336, 1.10151945], ... ] ... ) - >>> apply_matrix_colour_correction_Cheung2004( - ... RGB, CCM - ... ) # doctest: +ELLIPSIS + >>> apply_matrix_colour_correction_Cheung2004(RGB, CCM) # doctest: +ELLIPSIS array([ 0.1793456..., 0.1003392..., 0.0617218...]) """ @@ -1087,9 +1081,7 @@ def apply_matrix_colour_correction_Finlayson2015( ... [0.05725508, -0.20526336, 1.10151945], ... ] ... ) - >>> apply_matrix_colour_correction_Finlayson2015( - ... RGB, CCM - ... ) # doctest: +ELLIPSIS + >>> apply_matrix_colour_correction_Finlayson2015(RGB, CCM) # doctest: +ELLIPSIS array([ 0.1793456..., 0.1003392..., 0.0617218...]) """ @@ -1098,9 +1090,7 @@ def apply_matrix_colour_correction_Finlayson2015( RGB = np.reshape(RGB, (-1, 3)) - RGB_e = polynomial_expansion_Finlayson2015( - RGB, degree, root_polynomial_expansion - ) + RGB_e = polynomial_expansion_Finlayson2015(RGB, degree, root_polynomial_expansion) return np.reshape(np.transpose(np.dot(CCM, np.transpose(RGB_e))), shape) @@ -1141,9 +1131,7 @@ def apply_matrix_colour_correction_Vandermonde( ... [0.07446128, -0.18728192, 1.12780782, -0.03180856], ... ] ... ) - >>> apply_matrix_colour_correction_Vandermonde( - ... RGB, CCM - ... ) # doctest: +ELLIPSIS + >>> apply_matrix_colour_correction_Vandermonde(RGB, CCM) # doctest: +ELLIPSIS array([ 0.2128689..., 0.1106242..., 0.0362129...]) """ @@ -1177,8 +1165,9 @@ def apply_matrix_colour_correction_Vandermonde( def apply_matrix_colour_correction( RGB: ArrayLike, CCM: ArrayLike, - method: Literal["Cheung 2004", "Finlayson 2015", "Vandermonde"] - | str = "Cheung 2004", + method: ( + Literal["Cheung 2004", "Finlayson 2015", "Vandermonde"] | str + ) = "Cheung 2004", **kwargs: Any, ) -> NDArrayFloat: """ @@ -1234,9 +1223,7 @@ def apply_matrix_colour_correction( array([ 0.1793456..., 0.1003392..., 0.0617218...]) """ - method = validate_method( - method, tuple(APPLY_MATRIX_COLOUR_CORRECTION_METHODS) - ) + method = validate_method(method, tuple(APPLY_MATRIX_COLOUR_CORRECTION_METHODS)) function = APPLY_MATRIX_COLOUR_CORRECTION_METHODS[method] @@ -1407,8 +1394,9 @@ def colour_correction( RGB: ArrayLike, M_T: ArrayLike, M_R: ArrayLike, - method: Literal["Cheung 2004", "Finlayson 2015", "Vandermonde"] - | str = "Cheung 2004", + method: ( + Literal["Cheung 2004", "Finlayson 2015", "Vandermonde"] | str + ) = "Cheung 2004", **kwargs: Any, ) -> NDArrayFloat: """ diff --git a/colour/characterisation/datasets/aces_it.py b/colour/characterisation/datasets/aces_it.py index 0ae922edf3..779a4d51ea 100644 --- a/colour/characterisation/datasets/aces_it.py +++ b/colour/characterisation/datasets/aces_it.py @@ -2,7 +2,7 @@ Academy Color Encoding System - Input Transform Dataset ======================================================= -Defines the *Academy Color Encoding System* (ACES) *Input Transform* dataset. +Define the *Academy Color Encoding System* (ACES) *Input Transform* dataset. References ---------- diff --git a/colour/characterisation/datasets/cameras/dslr/sensitivities.py b/colour/characterisation/datasets/cameras/dslr/sensitivities.py index 845aa586a8..8ac62c343e 100644 --- a/colour/characterisation/datasets/cameras/dslr/sensitivities.py +++ b/colour/characterisation/datasets/cameras/dslr/sensitivities.py @@ -2,7 +2,7 @@ Sensitivities of *DSLR* Cameras =============================== -Defines the sensitivities of *DSLR* cameras. +Define the sensitivities of *DSLR* cameras. Each *DSLR* camera data is in the form of a *dict* of :class:`colour.characterisation.RGB_CameraSensitivities` classes as follows:: diff --git a/colour/characterisation/datasets/colour_checkers/chromaticity_coordinates.py b/colour/characterisation/datasets/colour_checkers/chromaticity_coordinates.py index c3e2eb4d83..9988098419 100644 --- a/colour/characterisation/datasets/colour_checkers/chromaticity_coordinates.py +++ b/colour/characterisation/datasets/colour_checkers/chromaticity_coordinates.py @@ -2,7 +2,7 @@ Chromaticity Coordinates of the Colour Checkers =============================================== -Defines the chromaticity coordinates of the colour checkers. +Define the chromaticity coordinates of the colour checkers. Each colour checker data is in the form of an :class:`dict` class instance of 24 samples as follows:: @@ -22,13 +22,19 @@ measurements of 30 *ColorChecker Classic* charts. - :attr:`colour.characterisation.datasets.colour_checkers.\ chromaticity_coordinates.CCS_COLORCHECKER24_BEFORE_NOV2014`: - *ColorChecker Classic* reference data from *X-Rite* published in 2015 and + *ColorChecker Classic* reference data from *X-Rite* published in 2016 and matching the data from *GretagMacbeth* published in 2005. - :attr:`colour.characterisation.datasets.colour_checkers.\ chromaticity_coordinates.CCS_COLORCHECKER24_AFTER_NOV2014`: - *ColorChecker Classic* reference data from *X-Rite* published in 2015 and + *ColorChecker Classic* reference data from *X-Rite* published in 2016 and matching the *ColorChecker Classic* edition after November 2014. - :attr:`colour.characterisation.datasets.colour_checkers.\ +chromaticity_coordinates.CCS_COLORCHECKERSG_BEFORE_NOV2014`: + *ColorChecker SG* reference data from *X-Rite* published in 2016 +- :attr:`colour.characterisation.datasets.colour_checkers.\ +chromaticity_coordinates.CCS_COLORCHECKERSG_AFTER_NOV2014`: + *ColorChecker SG* reference data from *X-Rite* published in 2016 +- :attr:`colour.characterisation.datasets.colour_checkers.\ chromaticity_coordinates. CCS_TE226_V2`: Reference data from *TE226 V2*. References @@ -87,20 +93,29 @@ "DATA_COLORCHECKER24_BEFORE_NOV2014", "CCS_ILLUMINANT_COLORCHECKER24_BEFORE_NOV2014", "CCS_COLORCHECKER24_BEFORE_NOV2014", - "DATA_COLORCHECKER24_AFTER_NOV2014", + "DATA_COLORCHECKER24_AFTER_NOV2014_CIE_LAB", "DATA_COLORCHECKER24_AFTER_NOV2014", "CCS_ILLUMINANT_COLORCHECKER24_AFTER_NOV2014", "CCS_COLORCHECKER24_AFTER_NOV2014", + "SAMPLE_LABELS_COLORCHECKER_SG", + "DATA_COLORCHECKERSG_BEFORE_NOV2014_CIE_LAB", + "DATA_COLORCHECKERSG_BEFORE_NOV2014", + "CCS_ILLUMINANT_COLORCHECKERSG_BEFORE_NOV2014", + "CCS_COLORCHECKERSG_BEFORE_NOV2014", + "DATA_COLORCHECKERSG_AFTER_NOV2014_CIE_LAB", + "DATA_COLORCHECKERSG_AFTER_NOV2014", + "CCS_ILLUMINANT_COLORCHECKERSG_AFTER_NOV2014", + "CCS_COLORCHECKERSG_AFTER_NOV2014", + "DATA_TE226_V2_CIE_XYZ", "DATA_TE226_V2", + "CCS_ILLUMINANT_TE226_V2", "CCS_TE226_V2", "CCS_COLOURCHECKERS", ] class ColourChecker( - namedtuple( - "ColourChecker", ("name", "data", "illuminant", "rows", "columns") - ) + namedtuple("ColourChecker", ("name", "data", "illuminant", "rows", "columns")) ): """ *Colour Checker* data. @@ -146,7 +161,7 @@ class ColourChecker( "neutral 3.5 (1.05 D)", "black 2 (1.5 D)", ) -"""*ColorChecker Classic* illuminant.""" +"""*ColorChecker Classic* sample labels.""" DATA_COLORCHECKER1976: dict = dict( zip( @@ -326,9 +341,7 @@ class ColourChecker( XYZ_to_xyY( Lab_to_XYZ( list(DATA_COLORCHECKER24_BEFORE_NOV2014_CIE_LAB.values()), - CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ - "ICC D50" - ], + CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["ICC D50"], ) ), ) @@ -347,7 +360,7 @@ class ColourChecker( 6, ) """ -Reference *ColorChecker Classic* data from *X-Rite (2015)*. +Reference *ColorChecker Classic* data from *X-Rite (2016)*. Notes ----- @@ -356,32 +369,37 @@ class ColourChecker( original *CIE L\\*a\\*b\\** colourspace values. """ -DATA_COLORCHECKER24_AFTER_NOV2014_CIE_LAB: dict = { - "dark skin": np.array([37.54, 14.37, 14.92]), - "light skin": np.array([64.66, 19.27, 17.5]), - "blue sky": np.array([49.32, -3.82, -22.54]), - "foliage": np.array([43.46, -12.74, 22.72]), - "blue flower": np.array([54.94, 9.61, -24.79]), - "bluish green": np.array([70.48, -32.26, -0.37]), - "orange": np.array([62.73, 35.83, 56.5]), - "purplish blue": np.array([39.43, 10.75, -45.17]), - "moderate red": np.array([50.57, 48.64, 16.67]), - "purple": np.array([30.1, 22.54, -20.87]), - "yellow green": np.array([71.77, -24.13, 58.19]), - "orange yellow": np.array([71.51, 18.24, 67.37]), - "blue": np.array([28.37, 15.42, -49.8]), - "green": np.array([54.38, -39.72, 32.27]), - "red": np.array([42.43, 51.05, 28.62]), - "yellow": np.array([81.8, 2.67, 80.41]), - "magenta": np.array([50.63, 51.28, -14.12]), - "cyan": np.array([49.57, -29.71, -28.32]), - "white 9.5 (.05 D)": np.array([95.19, -1.03, 2.93]), - "neutral 8 (.23 D)": np.array([81.29, -0.57, 0.44]), - "neutral 6.5 (.44 D)": np.array([66.89, -0.75, -0.06]), - "neutral 5 (.70 D)": np.array([50.76, -0.13, 0.14]), - "neutral 3.5 (1.05 D)": np.array([35.63, -0.46, -0.48]), - "black 2 (1.5 D)": np.array([20.64, 0.07, -0.46]), -} +DATA_COLORCHECKER24_AFTER_NOV2014_CIE_LAB: dict = dict( + zip( + SAMPLE_LABELS_COLORCHECKER_CLASSIC, + [ + np.array([37.54, 14.37, 14.92]), + np.array([64.66, 19.27, 17.5]), + np.array([49.32, -3.82, -22.54]), + np.array([43.46, -12.74, 22.72]), + np.array([54.94, 9.61, -24.79]), + np.array([70.48, -32.26, -0.37]), + np.array([62.73, 35.83, 56.5]), + np.array([39.43, 10.75, -45.17]), + np.array([50.57, 48.64, 16.67]), + np.array([30.1, 22.54, -20.87]), + np.array([71.77, -24.13, 58.19]), + np.array([71.51, 18.24, 67.37]), + np.array([28.37, 15.42, -49.8]), + np.array([54.38, -39.72, 32.27]), + np.array([42.43, 51.05, 28.62]), + np.array([81.8, 2.67, 80.41]), + np.array([50.63, 51.28, -14.12]), + np.array([49.57, -29.71, -28.32]), + np.array([95.19, -1.03, 2.93]), + np.array([81.29, -0.57, 0.44]), + np.array([66.89, -0.75, -0.06]), + np.array([50.76, -0.13, 0.14]), + np.array([35.63, -0.46, -0.48]), + np.array([20.64, 0.07, -0.46]), + ], + ) +) DATA_COLORCHECKER24_AFTER_NOV2014: dict = dict( zip( @@ -389,9 +407,7 @@ class ColourChecker( XYZ_to_xyY( Lab_to_XYZ( list(DATA_COLORCHECKER24_AFTER_NOV2014_CIE_LAB.values()), - CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ - "ICC D50" - ], + CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["ICC D50"], ) ), ) @@ -410,10 +426,549 @@ class ColourChecker( 6, ) """ -Reference *ColorChecker Classic* data from *X-Rite (2015)* and matching the +Reference *ColorChecker Classic* data from *X-Rite (2016)* and matching the *ColorChecker Classic* edition after November 2014. """ +SAMPLE_LABELS_COLORCHECKER_SG: tuple = ( + "A1", + "A2", + "A3", + "A4", + "A5", + "A6", + "A7", + "A8", + "A9", + "A10", + "B1", + "B2", + "B3", + "B4", + "B5", + "B6", + "B7", + "B8", + "B9", + "B10", + "C1", + "C2", + "C3", + "C4", + "C5", + "C6", + "C7", + "C8", + "C9", + "C10", + "D1", + "D2", + "D3", + "D4", + "D5", + "D6", + "D7", + "D8", + "D9", + "D10", + "E1", + "E2", + "E3", + "E4", + "E5", + "E6", + "E7", + "E8", + "E9", + "E10", + "F1", + "F2", + "F3", + "F4", + "F5", + "F6", + "F7", + "F8", + "F9", + "F10", + "G1", + "G2", + "G3", + "G4", + "G5", + "G6", + "G7", + "G8", + "G9", + "G10", + "H1", + "H2", + "H3", + "H4", + "H5", + "H6", + "H7", + "H8", + "H9", + "H10", + "I1", + "I2", + "I3", + "I4", + "I5", + "I6", + "I7", + "I8", + "I9", + "I10", + "J1", + "J2", + "J3", + "J4", + "J5", + "J6", + "J7", + "J8", + "J9", + "J10", + "K1", + "K2", + "K3", + "K4", + "K5", + "K6", + "K7", + "K8", + "K9", + "K10", + "L1", + "L2", + "L3", + "L4", + "L5", + "L6", + "L7", + "L8", + "L9", + "L10", + "M1", + "M2", + "M3", + "M4", + "M5", + "M6", + "M7", + "M8", + "M9", + "M10", + "N1", + "N2", + "N3", + "N4", + "N5", + "N6", + "N7", + "N8", + "N9", + "N10", +) +"""*ColorChecker SG* sample labels.""" + +DATA_COLORCHECKERSG_BEFORE_NOV2014_CIE_LAB: dict = dict( + zip( + SAMPLE_LABELS_COLORCHECKER_SG, + [ + np.array([96.55, -0.91, 0.57]), + np.array([6.43, -0.06, -0.41]), + np.array([49.7, -0.18, 0.03]), + np.array([96.5, -0.89, 0.59]), + np.array([6.5, -0.06, -0.44]), + np.array([49.66, -0.2, 0.01]), + np.array([96.52, -0.91, 0.58]), + np.array([6.49, -0.02, -0.28]), + np.array([49.72, -0.2, 0.04]), + np.array([96.43, -0.91, 0.67]), + np.array([49.72, -0.19, 0.02]), + np.array([32.6, 51.58, -10.85]), + np.array([60.75, 26.22, -18.69]), + np.array([28.69, 48.28, -39]), + np.array([49.38, -15.43, -48.48]), + np.array([60.63, -30.77, -26.23]), + np.array([19.29, -26.37, -6.15]), + np.array([60.15, -41.77, -12.6]), + np.array([21.42, 1.67, 8.79]), + np.array([49.69, -0.2, 0.01]), + np.array([6.5, -0.03, -0.67]), + np.array([21.82, 17.33, -18.35]), + np.array([41.53, 18.48, -37.26]), + np.array([19.99, -0.16, -36.29]), + np.array([60.16, -18.45, -31.42]), + np.array([19.94, -17.92, -20.96]), + np.array([60.68, -6.05, -32.81]), + np.array([50.81, -49.8, -9.63]), + np.array([60.65, -39.77, 20.76]), + np.array([6.53, -0.03, -0.43]), + np.array([96.56, -0.91, 0.59]), + np.array([84.19, -1.95, -8.23]), + np.array([84.75, 14.55, 0.23]), + np.array([84.87, -19.07, -0.82]), + np.array([85.15, 13.48, 6.82]), + np.array([84.17, -10.45, 26.78]), + np.array([61.74, 31.06, 36.42]), + np.array([64.37, 20.82, 18.92]), + np.array([50.4, -53.22, 14.62]), + np.array([96.51, -0.89, 0.65]), + np.array([49.74, -0.19, 0.03]), + np.array([31.91, 18.62, 21.99]), + np.array([60.74, 38.66, 70.97]), + np.array([19.35, 22.23, -58.86]), + np.array([96.52, -0.91, 0.62]), + np.array([6.66, 0, -0.3]), + np.array([76.51, 20.81, 22.72]), + np.array([72.79, 29.15, 24.18]), + np.array([22.33, -20.7, 5.75]), + np.array([49.7, -0.19, 0.01]), + np.array([6.53, -0.05, -0.61]), + np.array([63.42, 20.19, 19.22]), + np.array([34.94, 11.64, -50.7]), + np.array([52.03, -44.15, 39.04]), + np.array([79.43, 0.29, -0.17]), + np.array([30.67, -0.14, -0.53]), + np.array([63.6, 14.44, 26.07]), + np.array([64.37, 14.5, 17.05]), + np.array([60.01, -44.33, 8.49]), + np.array([6.63, -0.01, -0.47]), + np.array([96.56, -0.93, 0.59]), + np.array([46.37, -5.09, -24.46]), + np.array([47.08, 52.97, 20.49]), + np.array([36.04, 64.92, 38.51]), + np.array([65.05, 0, -0.32]), + np.array([40.14, -0.19, -0.38]), + np.array([43.77, 16.46, 27.12]), + np.array([64.39, 17, 16.59]), + np.array([60.79, -29.74, 41.5]), + np.array([96.48, -0.89, 0.64]), + np.array([49.75, -0.21, 0.01]), + np.array([38.18, -16.99, 30.87]), + np.array([21.31, 29.14, -27.51]), + np.array([80.57, 3.85, 89.61]), + np.array([49.71, -0.2, 0.03]), + np.array([60.27, 0.08, -0.41]), + np.array([67.34, 14.45, 16.9]), + np.array([64.69, 16.95, 18.57]), + np.array([51.12, -49.31, 44.41]), + np.array([49.7, -0.2, 0.02]), + np.array([6.67, -0.05, -0.64]), + np.array([51.56, 9.16, -26.88]), + np.array([70.83, -24.26, 64.77]), + np.array([48.06, 55.33, -15.61]), + np.array([35.26, -0.09, -0.24]), + np.array([75.16, 0.25, -0.2]), + np.array([44.54, 26.27, 38.93]), + np.array([35.91, 16.59, 26.46]), + np.array([61.49, -52.73, 47.3]), + np.array([6.59, -0.05, -0.5]), + np.array([96.58, -0.9, 0.61]), + np.array([68.93, -34.58, -0.34]), + np.array([69.65, 20.09, 78.57]), + np.array([47.79, -33.18, -30.21]), + np.array([15.94, -0.42, -1.2]), + np.array([89.02, -0.36, -0.48]), + np.array([63.43, 25.44, 26.25]), + np.array([65.75, 22.06, 27.82]), + np.array([61.47, 17.1, 50.72]), + np.array([96.53, -0.89, 0.66]), + np.array([49.79, -0.2, 0.03]), + np.array([85.17, 10.89, 17.26]), + np.array([89.74, -16.52, 6.19]), + np.array([84.55, 5.07, -6.12]), + np.array([84.02, -13.87, -8.72]), + np.array([70.76, 0.07, -0.35]), + np.array([45.59, -0.05, 0.23]), + np.array([20.3, 0.07, -0.32]), + np.array([61.79, -13.41, 55.42]), + np.array([49.72, -0.19, 0.02]), + np.array([6.77, -0.05, -0.44]), + np.array([21.85, 34.37, 7.83]), + np.array([42.66, 67.43, 48.42]), + np.array([60.33, 36.56, 3.56]), + np.array([61.22, 36.61, 17.32]), + np.array([62.07, 52.8, 77.14]), + np.array([72.42, -9.82, 89.66]), + np.array([62.03, 3.53, 57.01]), + np.array([71.95, -27.34, 73.69]), + np.array([6.59, -0.04, -0.45]), + np.array([49.77, -0.19, 0.04]), + np.array([41.84, 62.05, 10.01]), + np.array([19.78, 29.16, -7.85]), + np.array([39.56, 65.98, 33.71]), + np.array([52.39, 68.33, 47.84]), + np.array([81.23, 24.12, 87.51]), + np.array([81.8, 6.78, 95.75]), + np.array([71.72, -16.23, 76.28]), + np.array([20.31, 14.45, 16.74]), + np.array([49.68, -0.19, 0.05]), + np.array([96.48, -0.88, 0.68]), + np.array([49.69, -0.18, 0.03]), + np.array([6.39, -0.04, -0.33]), + np.array([96.54, -0.9, 0.67]), + np.array([49.72, -0.18, 0.05]), + np.array([6.49, -0.03, -0.41]), + np.array([96.51, -0.9, 0.69]), + np.array([49.7, -0.19, 0.07]), + np.array([6.47, 0, -0.38]), + np.array([96.46, -0.89, 0.71]), + ], + ) +) + +_DATA_COLORCHECKERSG_BEFORE_NOV2014 = np.reshape( + np.transpose( + np.reshape( + np.array( + list( + zip( + SAMPLE_LABELS_COLORCHECKER_SG, + DATA_COLORCHECKERSG_BEFORE_NOV2014_CIE_LAB.values(), + ) + ), + dtype=object, + ), + (14, 10, 2), + ), + [1, 0, 2], + ), + (-1, 2), +) + +DATA_COLORCHECKERSG_BEFORE_NOV2014: dict = dict( + zip( + _DATA_COLORCHECKERSG_BEFORE_NOV2014[..., 0], + XYZ_to_xyY( + Lab_to_XYZ( + list(_DATA_COLORCHECKERSG_BEFORE_NOV2014[..., 1]), + CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["ICC D50"], + ) + ), + ) +) + +del _DATA_COLORCHECKERSG_BEFORE_NOV2014 + +CCS_ILLUMINANT_COLORCHECKERSG_BEFORE_NOV2014: NDArrayFloat = CCS_ILLUMINANTS[ + "CIE 1931 2 Degree Standard Observer" +]["ICC D50"] +"""*ColorCheckerSG - Before November 2014* illuminant.""" + +CCS_COLORCHECKERSG_BEFORE_NOV2014: ColourChecker = ColourChecker( + "ColorCheckerSG - Before November 2014", + DATA_COLORCHECKERSG_BEFORE_NOV2014, + CCS_ILLUMINANT_COLORCHECKERSG_BEFORE_NOV2014, + 10, + 14, +) +""" +Reference *ColorChecker SG* data from *X-Rite (2016)*. +""" + +DATA_COLORCHECKERSG_AFTER_NOV2014_CIE_LAB: dict = dict( + zip( + SAMPLE_LABELS_COLORCHECKER_SG, + [ + np.array([96.71, -0.62, 2.06]), + np.array([8.05, 0.17, -0.69]), + np.array([49.76, 0.11, 0.72]), + np.array([96.72, -0.63, 2.06]), + np.array([8.17, 0.15, -0.65]), + np.array([49.68, 0.14, 0.74]), + np.array([96.60, -0.62, 2.11]), + np.array([7.99, 0.21, -0.75]), + np.array([49.67, 0.15, 0.73]), + np.array([96.51, -0.63, 2.11]), + np.array([49.70, 0.12, 0.68]), + np.array([33.02, 52.00, -10.30]), + np.array([61.40, 27.14, -18.42]), + np.array([30.54, 50.39, -41.79]), + np.array([49.56, -13.90, -49.65]), + np.array([60.62, -29.91, -27.54]), + np.array([20.13, -24.81, -7.50]), + np.array([60.32, -40.29, -13.25]), + np.array([19.62, 1.77, 11.99]), + np.array([49.68, 0.15, 0.78]), + np.array([8.13, 0.15, -0.76]), + np.array([19.65, 20.42, -18.82]), + np.array([41.70, 18.90, -37.42]), + np.array([20.25, 0.26, -36.44]), + np.array([60.13, -17.88, -32.08]), + np.array([19.75, -17.79, -22.37]), + np.array([60.43, -5.12, -32.79]), + np.array([50.46, -47.90, -11.56]), + np.array([60.53, -40.75, 19.37]), + np.array([8.09, 0.19, -0.69]), + np.array([96.79, -0.66, 1.99]), + np.array([84.00, -1.70, -8.37]), + np.array([85.48, 15.15, 0.79]), + np.array([84.56, -19.74, -1.13]), + np.array([85.26, 13.37, 7.95]), + np.array([84.38, -11.97, 27.16]), + np.array([62.35, 29.94, 36.89]), + np.array([64.17, 21.34, 19.36]), + np.array([50.48, -53.21, 12.65]), + np.array([96.57, -0.64, 2.00]), + np.array([49.79, 0.13, 0.66]), + np.array([32.77, 19.91, 22.33]), + np.array([62.28, 37.56, 68.87]), + np.array([19.92, 25.07, -61.05]), + np.array([96.78, -0.66, 2.01]), + np.array([8.07, 0.12, -0.93]), + np.array([77.37, 20.28, 24.27]), + np.array([74.01, 29.00, 25.80]), + np.array([20.33, -23.98, 7.20]), + np.array([49.72, 0.14, 0.71]), + np.array([8.09, 0.19, -0.69]), + np.array([63.88, 20.34, 19.93]), + np.array([35.28, 12.93, -51.17]), + np.array([52.75, -44.12, 38.68]), + np.array([79.65, -0.08, 0.62]), + np.array([30.32, -0.10, 0.22]), + np.array([63.46, 13.53, 26.37]), + np.array([64.44, 14.31, 17.63]), + np.array([60.05, -44.00, 7.27]), + np.array([8.08, 0.18, -0.78]), + np.array([96.70, -0.66, 1.97]), + np.array([45.84, -3.74, -25.32]), + np.array([47.60, 53.66, 22.15]), + np.array([36.88, 65.72, 41.63]), + np.array([65.22, -0.27, 0.16]), + np.array([39.55, -0.37, -0.09]), + np.array([44.49, 16.06, 26.79]), + np.array([64.97, 15.89, 16.79]), + np.array([60.77, -30.19, 40.76]), + np.array([96.71, -0.64, 2.01]), + np.array([49.74, 0.14, 0.68]), + np.array([38.29, -17.44, 30.22]), + np.array([20.76, 31.66, -28.04]), + np.array([81.43, 2.41, 88.98]), + np.array([49.71, 0.12, 0.69]), + np.array([60.04, 0.09, 0.05]), + np.array([67.60, 14.47, 17.12]), + np.array([64.75, 17.30, 18.88]), + np.array([51.26, -50.65, 43.80]), + np.array([49.76, 0.14, 0.71]), + np.array([8.10, 0.19, -0.93]), + np.array([51.36, 9.52, -26.98]), + np.array([71.62, -24.77, 64.10]), + np.array([48.75, 57.24, -14.45]), + np.array([34.85, -0.21, 0.73]), + np.array([75.36, 0.35, 0.26]), + np.array([45.14, 26.38, 41.24]), + np.array([36.20, 16.70, 27.06]), + np.array([61.65, -54.33, 46.18]), + np.array([7.97, 0.14, -0.80]), + np.array([96.69, -0.67, 1.95]), + np.array([68.71, -35.41, -1.11]), + np.array([70.39, 19.37, 79.73]), + np.array([47.42, -30.91, -32.27]), + np.array([15.43, -0.24, -0.25]), + np.array([88.85, -0.59, 0.25]), + np.array([64.00, 25.09, 27.14]), + np.array([66.65, 22.21, 28.81]), + np.array([62.05, 16.45, 51.74]), + np.array([96.71, -0.64, 2.02]), + np.array([49.72, 0.12, 0.64]), + np.array([85.68, 10.75, 18.39]), + np.array([89.35, -16.38, 6.41]), + np.array([84.59, 5.21, -5.87]), + np.array([83.63, -12.47, -8.89]), + np.array([70.60, -0.24, 0.07]), + np.array([45.14, -0.04, 0.86]), + np.array([20.33, 0.40, -0.21]), + np.array([62.33, -14.54, 54.58]), + np.array([49.74, 0.14, 0.69]), + np.array([8.08, 0.13, -0.81]), + np.array([23.03, 33.95, 8.88]), + np.array([44.35, 67.94, 50.62]), + np.array([60.91, 36.55, 4.15]), + np.array([62.20, 37.45, 18.18]), + np.array([63.33, 51.30, 81.88]), + np.array([73.74, -11.45, 85.07]), + np.array([62.35, 1.96, 57.52]), + np.array([72.77, -29.09, 71.26]), + np.array([8.13, 0.15, -0.86]), + np.array([49.71, 0.12, 0.62]), + np.array([42.52, 63.55, 11.43]), + np.array([18.09, 32.61, -5.90]), + np.array([40.66, 65.54, 31.98]), + np.array([53.13, 68.44, 49.57]), + np.array([82.08, 23.39, 87.24]), + np.array([82.50, 5.29, 96.68]), + np.array([71.90, -17.32, 77.72]), + np.array([21.95, 13.41, 16.36]), + np.array([49.74, 0.12, 0.69]), + np.array([96.79, -0.67, 1.97]), + np.array([49.78, 0.12, 0.65]), + np.array([8.23, 0.18, -0.82]), + np.array([96.73, -0.67, 1.99]), + np.array([49.80, 0.11, 0.67]), + np.array([8.18, 0.15, -0.84]), + np.array([96.73, -0.65, 2.01]), + np.array([49.75, 0.13, 0.67]), + np.array([8.11, 0.15, -0.90]), + np.array([96.55, -0.64, 2.02]), + ], + ) +) + +_DATA_COLORCHECKERSG_AFTER_NOV2014 = np.reshape( + np.transpose( + np.reshape( + np.array( + list( + zip( + SAMPLE_LABELS_COLORCHECKER_SG, + DATA_COLORCHECKERSG_AFTER_NOV2014_CIE_LAB.values(), + ) + ), + dtype=object, + ), + (14, 10, 2), + ), + [1, 0, 2], + ), + (-1, 2), +) + +DATA_COLORCHECKERSG_AFTER_NOV2014: dict = dict( + zip( + _DATA_COLORCHECKERSG_AFTER_NOV2014[..., 0], + XYZ_to_xyY( + Lab_to_XYZ( + list(_DATA_COLORCHECKERSG_AFTER_NOV2014[..., 1]), + CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["ICC D50"], + ) + ), + ) +) + +del _DATA_COLORCHECKERSG_AFTER_NOV2014 + +CCS_ILLUMINANT_COLORCHECKERSG_AFTER_NOV2014: NDArrayFloat = CCS_ILLUMINANTS[ + "CIE 1931 2 Degree Standard Observer" +]["ICC D50"] +"""*ColorCheckerSG - After November 2014* illuminant.""" + +CCS_COLORCHECKERSG_AFTER_NOV2014: ColourChecker = ColourChecker( + "ColorCheckerSG - After November 2014", + DATA_COLORCHECKERSG_AFTER_NOV2014, + CCS_ILLUMINANT_COLORCHECKERSG_AFTER_NOV2014, + 10, + 14, +) +""" +Reference *ColorChecker SG* data from *X-Rite (2016)* and matching the +*ColorChecker SG* edition after November 2014. +""" + DATA_TE226_V2_CIE_XYZ: dict = { "dark skin": np.array([0.1278, 0.1074, 0.0726]), "light skin": np.array([0.4945, 0.4484, 0.3586]), @@ -490,6 +1045,8 @@ class ColourChecker( "BabelColor Average": CCS_BABELCOLOR_AVERAGE, "ColorChecker24 - Before November 2014": CCS_COLORCHECKER24_BEFORE_NOV2014, "ColorChecker24 - After November 2014": CCS_COLORCHECKER24_AFTER_NOV2014, + "ColorCheckerSG - Before November 2014": CCS_COLORCHECKERSG_BEFORE_NOV2014, + "ColorCheckerSG - After November 2014": CCS_COLORCHECKERSG_AFTER_NOV2014, "TE226 V2": CCS_TE226_V2, } ) diff --git a/colour/characterisation/datasets/colour_checkers/sds.py b/colour/characterisation/datasets/colour_checkers/sds.py index c45ba674c4..92846e735d 100644 --- a/colour/characterisation/datasets/colour_checkers/sds.py +++ b/colour/characterisation/datasets/colour_checkers/sds.py @@ -2,7 +2,7 @@ Spectral Distributions of the Colour Checkers ============================================= -Defines the spectral distributions of the colour checkers. +Define the spectral distributions of the colour checkers. Each colour checker data is in the form of :class:`dict` class instance of :class:`colour.SpectralDistribution` classes as follows:: @@ -16,6 +16,8 @@ of 30 *ColorChecker Classic* charts. - :attr:`colour.characterisation.datasets.colour_checkers.sds.\ SDS_COLORCHECKER_N_OHTA`: Measured by Ohta (1997). +- :attr:`colour.characterisation.datasets.colour_checkers.sds.\ +SDS_PMC`: The new preferred memory color (PMC) chart. Notes ----- @@ -35,6 +37,8 @@ 17321-1 - Graphic technology and photography - Colour characterisation of digital still cameras (DSCs) - Part 1: Stimuli, metrology and test procedures. +- :cite:`Luo2024` : Luo, M. R. (2024). The new preferred memory color ( PMC ) + chart. Color Research & Application, col.22940. doi:10.1002/col.22940 - :cite:`MunsellColorScienceb` : Munsell Color Science. (n.d.). Macbeth Colorchecker. http://www.rit-mcsl.org/UsefulData/MacbethColorChecker.xls - :cite:`Ohta1997a` : Ohta, N. (1997). The basis of color reproduction @@ -3002,10 +3006,1019 @@ :cite:`Ohta1997a`, :cite:`MunsellColorScienceb` """ +DATA_PMC: dict = { + "Caucasian": { + 400: 16.32, + 410: 18.14, + 420: 18.74, + 430: 19.53, + 440: 20.69, + 450: 21.47, + 460: 21.5, + 470: 21.38, + 480: 21.27, + 490: 21.44, + 500: 22.03, + 510: 22.87, + 520: 23.66, + 530: 24.48, + 540: 25.72, + 550: 28.03, + 560: 31.48, + 570: 35.78, + 580: 40.99, + 590: 46.22, + 600: 49.97, + 610: 52.05, + 620: 52.99, + 630: 53.38, + 640: 53.64, + 650: 53.92, + 660: 54.36, + 670: 54.85, + 680: 55.52, + 690: 56.32, + 700: 57.3, + }, + "Oriental": { + 400: 15.11, + 410: 16.59, + 420: 17.08, + 430: 17.76, + 440: 18.8, + 450: 19.49, + 460: 19.58, + 470: 19.5, + 480: 19.42, + 490: 19.66, + 500: 20.18, + 510: 20.88, + 520: 21.66, + 530: 22.49, + 540: 23.54, + 550: 25.61, + 560: 29.35, + 570: 34.12, + 580: 39.12, + 590: 43.49, + 600: 46.36, + 610: 47.69, + 620: 48.03, + 630: 48.12, + 640: 48.62, + 650: 49.59, + 660: 50.81, + 670: 51.73, + 680: 52.31, + 690: 52.8, + 700: 53.09, + }, + "South Asian": { + 400: 13.96, + 410: 14.78, + 420: 14.6, + 430: 14.36, + 440: 14.22, + 450: 14.25, + 460: 14.46, + 470: 14.9, + 480: 15.43, + 490: 16, + 500: 16.46, + 510: 16.75, + 520: 16.86, + 530: 17.09, + 540: 17.77, + 550: 19.5, + 560: 22.66, + 570: 26.49, + 580: 30.54, + 590: 34.19, + 600: 36.81, + 610: 38.31, + 620: 39.02, + 630: 39.28, + 640: 39.42, + 650: 39.57, + 660: 39.77, + 670: 39.92, + 680: 40, + 690: 40.27, + 700: 40.66, + }, + "African": { + 400: 6.26, + 410: 6.38, + 420: 6.37, + 430: 6.32, + 440: 6.32, + 450: 6.39, + 460: 6.46, + 470: 6.62, + 480: 6.88, + 490: 7.11, + 500: 7.29, + 510: 7.39, + 520: 7.34, + 530: 7.36, + 540: 7.83, + 550: 9.35, + 560: 11.87, + 570: 14.06, + 580: 15.85, + 590: 18.11, + 600: 20.19, + 610: 20.98, + 620: 20.83, + 630: 20.37, + 640: 19.94, + 650: 19.59, + 660: 19.27, + 670: 18.96, + 680: 18.55, + 690: 18.21, + 700: 17.96, + }, + "Pork": { + 400: 21.9, + 410: 24.44, + 420: 24.09, + 430: 23.38, + 440: 22.7, + 450: 22.11, + 460: 21.45, + 470: 20.77, + 480: 20.04, + 490: 19.55, + 500: 18.8, + 510: 18.12, + 520: 17.85, + 530: 17.71, + 540: 17.34, + 550: 17.77, + 560: 21.48, + 570: 29.09, + 580: 39.34, + 590: 49.78, + 600: 56.81, + 610: 60.01, + 620: 61.12, + 630: 61.49, + 640: 61.61, + 650: 61.66, + 660: 61.67, + 670: 61.64, + 680: 61.54, + 690: 61.63, + 700: 61.86, + }, + "Carrot": { + 400: 5.55, + 410: 5.65, + 420: 5.68, + 430: 5.71, + 440: 5.72, + 450: 5.74, + 460: 5.76, + 470: 5.83, + 480: 5.86, + 490: 5.92, + 500: 5.95, + 510: 5.93, + 520: 5.97, + 530: 6.16, + 540: 6.71, + 550: 8.44, + 560: 12.41, + 570: 18.11, + 580: 24.44, + 590: 30.47, + 600: 35.28, + 610: 38.39, + 620: 39.99, + 630: 40.65, + 640: 41.12, + 650: 41.64, + 660: 42.42, + 670: 43.41, + 680: 44.58, + 690: 46.07, + 700: 47.89, + }, + "Orange": { + 400: 4.65, + 410: 4.71, + 420: 4.74, + 430: 4.8, + 440: 4.94, + 450: 5.12, + 460: 5.43, + 470: 5.92, + 480: 6.73, + 490: 7.88, + 500: 9.42, + 510: 10.85, + 520: 11.7, + 530: 12.26, + 540: 13.34, + 550: 16.92, + 560: 26.02, + 570: 39.71, + 580: 52.19, + 590: 57.47, + 600: 56.31, + 610: 53.64, + 620: 51.79, + 630: 50.62, + 640: 49.71, + 650: 49.02, + 660: 49.32, + 670: 50.21, + 680: 50.85, + 690: 51.79, + 700: 53.26, + }, + "Orange Yellow": { + 400: 6.42, + 410: 6.53, + 420: 6.57, + 430: 6.69, + 440: 6.91, + 450: 7.26, + 460: 7.84, + 470: 8.7, + 480: 10.15, + 490: 12.11, + 500: 14.64, + 510: 17.07, + 520: 20.37, + 530: 27.24, + 540: 37.88, + 550: 46.91, + 560: 51.7, + 570: 54.47, + 580: 58.87, + 590: 64.26, + 600: 66.98, + 610: 67.24, + 620: 66.71, + 630: 66.28, + 640: 65.94, + 650: 65.74, + 660: 65.77, + 670: 65.7, + 680: 65.38, + 690: 65.81, + 700: 67.07, + }, + "Banana": { + 400: 5.33, + 410: 5.39, + 420: 5.42, + 430: 5.5, + 440: 5.66, + 450: 5.91, + 460: 6.31, + 470: 7.02, + 480: 8.34, + 490: 10.59, + 500: 14.98, + 510: 21.43, + 520: 29.59, + 530: 38.93, + 540: 48.94, + 550: 57.61, + 560: 63.53, + 570: 66.59, + 580: 67.51, + 590: 66.82, + 600: 65.22, + 610: 63.61, + 620: 62.54, + 630: 61.97, + 640: 61.52, + 650: 61.26, + 660: 61.44, + 670: 61.9, + 680: 62.26, + 690: 63.09, + 700: 64.61, + }, + "Yellow Green": { + 400: 7.81, + 410: 8.05, + 420: 8.06, + 430: 8.16, + 440: 8.35, + 450: 8.81, + 460: 9.7, + 470: 11.33, + 480: 14.22, + 490: 18.53, + 500: 26.25, + 510: 36.97, + 520: 48.12, + 530: 55.6, + 540: 58.46, + 550: 57.86, + 560: 55.25, + 570: 51.75, + 580: 47.62, + 590: 42.58, + 600: 37.44, + 610: 33.86, + 620: 32.05, + 630: 31.22, + 640: 30.58, + 650: 30.13, + 660: 30.5, + 670: 31.81, + 680: 33.41, + 690: 35, + 700: 36.5, + }, + "Green Apple": { + 400: 7.04, + 410: 7.21, + 420: 7.2, + 430: 7.25, + 440: 7.41, + 450: 7.7, + 460: 8.28, + 470: 9.25, + 480: 10.97, + 490: 13.69, + 500: 18.1, + 510: 23.02, + 520: 26.28, + 530: 27.27, + 540: 27.51, + 550: 28, + 560: 27.83, + 570: 26.28, + 580: 24.14, + 590: 21.95, + 600: 19.76, + 610: 18.14, + 620: 17.32, + 630: 16.9, + 640: 16.6, + 650: 16.65, + 660: 17.13, + 670: 17.67, + 680: 17.83, + 690: 17.73, + 700: 17.29, + }, + "Summer Grass": { + 400: 5.2, + 410: 5.26, + 420: 5.29, + 430: 5.37, + 440: 5.51, + 450: 5.81, + 460: 6.26, + 470: 7.02, + 480: 8.31, + 490: 10.12, + 500: 12.42, + 510: 14.38, + 520: 16.84, + 530: 21.64, + 540: 26.47, + 550: 26.48, + 560: 22.61, + 570: 18.27, + 580: 14.45, + 590: 11.29, + 600: 9.04, + 610: 7.88, + 620: 7.37, + 630: 7.16, + 640: 7.02, + 650: 6.92, + 660: 7.02, + 670: 7.32, + 680: 7.72, + 690: 8.12, + 700: 8.56, + }, + "Bluish Green": { + 400: 25.62, + 410: 31.07, + 420: 32.88, + 430: 33.88, + 440: 35.3, + 450: 37.4, + 460: 40.96, + 470: 45.74, + 480: 50.79, + 490: 54.59, + 500: 56.44, + 510: 56.25, + 520: 54.62, + 530: 52.87, + 540: 50.86, + 550: 47.81, + 560: 43.7, + 570: 39.41, + 580: 35.11, + 590: 30.43, + 600: 26.03, + 610: 23.11, + 620: 21.62, + 630: 20.97, + 640: 20.5, + 650: 20.25, + 660: 20.56, + 670: 21.7, + 680: 23.21, + 690: 24.73, + 700: 26, + }, + "Smurf": { + 400: 36.56, + 410: 52.72, + 420: 60.7, + 430: 63.99, + 440: 68.21, + 450: 71.13, + 460: 70.99, + 470: 69.75, + 480: 66.8, + 490: 63.39, + 500: 59.21, + 510: 54.6, + 520: 49, + 530: 43.71, + 540: 39.17, + 550: 34.38, + 560: 29.09, + 570: 24.94, + 580: 22.51, + 590: 21.05, + 600: 19.73, + 610: 18.69, + 620: 18.19, + 630: 17.92, + 640: 17.89, + 650: 18.46, + 660: 19.42, + 670: 19.88, + 680: 19.4, + 690: 18.55, + 700: 17.33, + }, + "Blue Sky": { + 400: 31.07, + 410: 42.51, + 420: 47.71, + 430: 50.19, + 440: 52.91, + 450: 53.82, + 460: 52.13, + 470: 49.45, + 480: 44.94, + 490: 40.21, + 500: 35.24, + 510: 30.87, + 520: 26.51, + 530: 23.14, + 540: 21.23, + 550: 19.54, + 560: 17.23, + 570: 15.39, + 580: 14.6, + 590: 14.3, + 600: 13.83, + 610: 13.21, + 620: 12.77, + 630: 12.54, + 640: 12.66, + 650: 13.28, + 660: 14.21, + 670: 14.73, + 680: 14.52, + 690: 13.92, + 700: 13.07, + }, + "Lavender": { + 400: 26.47, + 410: 33.57, + 420: 35.95, + 430: 36.3, + 440: 35.77, + 450: 34.11, + 460: 31.58, + 470: 28.86, + 480: 25.14, + 490: 21.57, + 500: 18.38, + 510: 15.74, + 520: 13.16, + 530: 11.37, + 540: 10.79, + 550: 10.64, + 560: 10.18, + 570: 10.12, + 580: 11.23, + 590: 12.96, + 600: 14.21, + 610: 14.32, + 620: 13.72, + 630: 13.41, + 640: 14.22, + 650: 16.01, + 660: 18.35, + 670: 20.21, + 680: 21.05, + 690: 21.05, + 700: 20.37, + }, + "Purple": { + 400: 16.67, + 410: 19.01, + 420: 19.39, + 430: 18.99, + 440: 17.79, + 450: 16.16, + 460: 14.4, + 470: 12.82, + 480: 10.94, + 490: 9.39, + 500: 8.2, + 510: 7.28, + 520: 6.39, + 530: 5.88, + 540: 5.8, + 550: 5.89, + 560: 5.9, + 570: 6.15, + 580: 6.98, + 590: 8.42, + 600: 10.03, + 610: 10.7, + 620: 10.21, + 630: 9.96, + 640: 11.04, + 650: 13.63, + 660: 17.81, + 670: 23.31, + 680: 29.64, + 690: 36.2, + 700: 43.04, + }, + "Purple Cabbage": { + 400: 14.78, + 410: 16.32, + 420: 16.12, + 430: 15.28, + 440: 13.84, + 450: 12.29, + 460: 10.81, + 470: 9.61, + 480: 8.28, + 490: 7.36, + 500: 6.7, + 510: 6.12, + 520: 5.52, + 530: 5.2, + 540: 5.2, + 550: 5.28, + 560: 5.31, + 570: 5.59, + 580: 6.43, + 590: 8.24, + 600: 11.51, + 610: 15.76, + 620: 18.78, + 630: 20.29, + 640: 22.81, + 650: 27.2, + 660: 32.81, + 670: 38.58, + 680: 43.77, + 690: 48.41, + 700: 52.92, + }, + "Unitary red": { + 400: 5.75, + 410: 5.63, + 420: 5.47, + 430: 5.32, + 440: 5.21, + 450: 5.12, + 460: 5.03, + 470: 4.99, + 480: 4.89, + 490: 4.85, + 500: 4.82, + 510: 4.81, + 520: 4.76, + 530: 4.68, + 540: 4.67, + 550: 4.78, + 560: 5.03, + 570: 5.31, + 580: 6.86, + 590: 12.8, + 600: 24.04, + 610: 37.08, + 620: 48.57, + 630: 56.26, + 640: 60.4, + 650: 62.58, + 660: 64.09, + 670: 64.52, + 680: 63.92, + 690: 63.3, + 700: 62.81, + }, + "Unitary yellow": { + 400: 8.59, + 410: 8.89, + 420: 8.92, + 430: 9.01, + 440: 9.24, + 450: 9.71, + 460: 10.75, + 470: 12.57, + 480: 15.68, + 490: 20.1, + 500: 27.53, + 510: 37.26, + 520: 47.54, + 530: 56.12, + 540: 62.49, + 550: 66.81, + 560: 69.45, + 570: 70.75, + 580: 71.21, + 590: 71.17, + 600: 70.88, + 610: 70.59, + 620: 70.28, + 630: 70.09, + 640: 69.89, + 650: 69.71, + 660: 69.57, + 670: 69.32, + 680: 68.89, + 690: 68.86, + 700: 69.3, + }, + "Unitary green": { + 400: 9.06, + 410: 9.61, + 420: 9.89, + 430: 10.25, + 440: 10.77, + 450: 11.62, + 460: 13.09, + 470: 15.26, + 480: 18.45, + 490: 22.45, + 500: 27.37, + 510: 31.31, + 520: 32.65, + 530: 31.42, + 540: 28.35, + 550: 24.26, + 560: 20.02, + 570: 16.32, + 580: 13.13, + 590: 10.43, + 600: 8.47, + 610: 7.46, + 620: 7.05, + 630: 6.89, + 640: 6.77, + 650: 6.73, + 660: 6.87, + 670: 7.2, + 680: 7.62, + 690: 8.08, + 700: 8.52, + }, + "Unitary blue": { + 400: 22.16, + 410: 28.4, + 420: 31.24, + 430: 32.59, + 440: 33.16, + 450: 32.26, + 460: 29.86, + 470: 26.69, + 480: 22.34, + 490: 18.51, + 500: 15.06, + 510: 12.1, + 520: 9.58, + 530: 7.88, + 540: 6.96, + 550: 6.37, + 560: 5.88, + 570: 5.63, + 580: 5.56, + 590: 5.5, + 600: 5.43, + 610: 5.44, + 620: 5.45, + 630: 5.54, + 640: 5.75, + 650: 6.03, + 660: 6.45, + 670: 6.98, + 680: 7.58, + 690: 8.15, + 700: 8.56, + }, + "Magenta": { + 400: 28.46, + 410: 35.22, + 420: 36.11, + 430: 34.67, + 440: 32.39, + 450: 29.75, + 460: 27.17, + 470: 24.81, + 480: 21.78, + 490: 19.28, + 500: 17.31, + 510: 15.34, + 520: 12.78, + 530: 10.84, + 540: 10.33, + 550: 10.39, + 560: 10.02, + 570: 10.42, + 580: 13.86, + 590: 21.7, + 600: 32.91, + 610: 44.45, + 620: 53.78, + 630: 59.67, + 640: 62.91, + 650: 64.56, + 660: 65.35, + 670: 65.65, + 680: 65.61, + 690: 65.77, + 700: 66.34, + }, + "Cyan": { + 400: 19.71, + 410: 24.27, + 420: 26.53, + 430: 28.6, + 440: 31.76, + 450: 35.32, + 460: 39.48, + 470: 43.57, + 480: 45.64, + 490: 45.53, + 500: 43.12, + 510: 38.61, + 520: 32.85, + 530: 27.55, + 540: 22.67, + 550: 17.93, + 560: 13.82, + 570: 11.12, + 580: 9.65, + 590: 8.8, + 600: 8.14, + 610: 7.71, + 620: 7.52, + 630: 7.44, + 640: 7.4, + 650: 7.51, + 660: 7.75, + 670: 7.91, + 680: 7.91, + 690: 7.77, + 700: 7.57, + }, + "White": { + 400: 43.21, + 410: 69.12, + 420: 86.19, + 430: 90.28, + 440: 90.5, + 450: 90.62, + 460: 90.7, + 470: 90.85, + 480: 90.71, + 490: 90.83, + 500: 90.83, + 510: 90.77, + 520: 90.43, + 530: 90.14, + 540: 90.07, + 550: 90.19, + 560: 90.22, + 570: 90.32, + 580: 90.7, + 590: 91.04, + 600: 91.09, + 610: 91.11, + 620: 91.12, + 630: 91.18, + 640: 91.3, + 650: 91.38, + 660: 91.44, + 670: 91.38, + 680: 91.29, + 690: 91.27, + 700: 91.21, + }, + "Gray-80": { + 400: 39.08, + 410: 55.13, + 420: 61.08, + 430: 60.74, + 440: 60.09, + 450: 59.85, + 460: 60.1, + 470: 60.77, + 480: 61.05, + 490: 61.1, + 500: 60.87, + 510: 60.43, + 520: 59.64, + 530: 59.02, + 540: 58.99, + 550: 59.7, + 560: 60.34, + 570: 60.3, + 580: 60.6, + 590: 61.01, + 600: 60.41, + 610: 59.58, + 620: 59.13, + 630: 58.82, + 640: 58.71, + 650: 59.13, + 660: 59.91, + 670: 60.13, + 680: 59.53, + 690: 58.68, + 700: 57.33, + }, + "Gray-70": { + 400: 30.42, + 410: 37.67, + 420: 38.74, + 430: 37.84, + 440: 37.15, + 450: 36.81, + 460: 37.05, + 470: 37.76, + 480: 38.14, + 490: 38.23, + 500: 37.93, + 510: 37.43, + 520: 36.65, + 530: 35.97, + 540: 36.01, + 550: 37.01, + 560: 37.98, + 570: 37.88, + 580: 37.54, + 590: 37.76, + 600: 37.62, + 610: 37.03, + 620: 36.56, + 630: 36.21, + 640: 36.02, + 650: 36.41, + 660: 37.16, + 670: 37.41, + 680: 36.81, + 690: 35.87, + 700: 34.51, + }, + "Gray-50": { + 400: 18.32, + 410: 20.22, + 420: 20.23, + 430: 20.02, + 440: 19.9, + 450: 19.86, + 460: 19.84, + 470: 19.88, + 480: 19.88, + 490: 19.93, + 500: 19.91, + 510: 19.82, + 520: 19.67, + 530: 19.58, + 540: 19.59, + 550: 19.79, + 560: 20.1, + 570: 20.24, + 580: 20.23, + 590: 20.13, + 600: 19.97, + 610: 19.79, + 620: 19.54, + 630: 19.32, + 640: 19.18, + 650: 19.06, + 660: 18.88, + 670: 18.7, + 680: 18.47, + 690: 18.26, + 700: 18.13, + }, + "Gray-35": { + 400: 9.22, + 410: 9.64, + 420: 9.71, + 430: 9.86, + 440: 10.07, + 450: 10.19, + 460: 10.12, + 470: 10.02, + 480: 9.9, + 490: 9.87, + 500: 9.88, + 510: 9.9, + 520: 9.89, + 530: 9.86, + 540: 9.84, + 550: 9.82, + 560: 9.93, + 570: 10.08, + 580: 10.14, + 590: 10.08, + 600: 9.92, + 610: 9.79, + 620: 9.65, + 630: 9.54, + 640: 9.46, + 650: 9.44, + 660: 9.4, + 670: 9.35, + 680: 9.25, + 690: 9.11, + 700: 9.02, + }, + "Black": { + 400: 4.57, + 410: 4.56, + 420: 4.55, + 430: 4.55, + 440: 4.53, + 450: 4.52, + 460: 4.53, + 470: 4.55, + 480: 4.52, + 490: 4.51, + 500: 4.53, + 510: 4.52, + 520: 4.51, + 530: 4.52, + 540: 4.53, + 550: 4.57, + 560: 4.63, + 570: 4.65, + 580: 4.64, + 590: 4.61, + 600: 4.6, + 610: 4.59, + 620: 4.58, + 630: 4.58, + 640: 4.56, + 650: 4.58, + 660: 4.54, + 670: 4.56, + 680: 4.55, + 690: 4.55, + 700: 4.58, + }, +} + +SDS_PMC: LazyCanonicalMapping = LazyCanonicalMapping( + ( + key, + partial(SpectralDistribution, {w: v / 100 for w, v in value.items()}, name=key), + ) + for key, value in DATA_PMC.items() +) +""" +The new preferred memory color (PMC) chart. + +References +---------- +:cite:`Luo2024` +""" + SDS_COLOURCHECKERS: CanonicalMapping = CanonicalMapping( { "BabelColor Average": SDS_BABELCOLOR_AVERAGE, "ColorChecker N Ohta": SDS_COLORCHECKER_N_OHTA, + "PMC": SDS_PMC, } ) SDS_COLOURCHECKERS.__doc__ = """ @@ -3013,9 +4026,9 @@ References ---------- -:cite:`Ohta1997a`, :cite:`BabelColor2012b`, :cite:`BabelColor2012c`, -:cite:`MunsellColorScienceb`, -:cite:`InternationalOrganizationforStandardization2012` +:cite:`BabelColor2012b`, :cite:`BabelColor2012c`, +:cite:`InternationalOrganizationforStandardization2012`, :cite:`Luo2024`, +:cite:`MunsellColorScienceb`, :cite:`Ohta1997a`, Notes ----- diff --git a/colour/characterisation/datasets/displays/crt/primaries.py b/colour/characterisation/datasets/displays/crt/primaries.py index d637b2e440..d1db116028 100644 --- a/colour/characterisation/datasets/displays/crt/primaries.py +++ b/colour/characterisation/datasets/displays/crt/primaries.py @@ -2,7 +2,7 @@ Primaries of CRT Displays ========================= -Defines the primaries multi-spectral distributions of *CRT* displays. +Define the primaries multi-spectral distributions of *CRT* displays. Each *CRT* display data is in the form of a *dict* of :class:`colour.characterisation.RGB_DisplayPrimaries` classes as follows:: diff --git a/colour/characterisation/datasets/displays/lcd/primaries.py b/colour/characterisation/datasets/displays/lcd/primaries.py index 26881f28e2..f9efa47678 100644 --- a/colour/characterisation/datasets/displays/lcd/primaries.py +++ b/colour/characterisation/datasets/displays/lcd/primaries.py @@ -2,7 +2,7 @@ Primaries of LCD Displays ========================= -Defines the primaries multi-spectral distributions of *LCD* displays. +Define the primaries multi-spectral distributions of *LCD* displays. Each *LCD* display data is in the form of a *dict* of :class:`colour.characterisation.RGB_DisplayPrimaries` classes as follows:: diff --git a/colour/characterisation/datasets/filters/sds.py b/colour/characterisation/datasets/filters/sds.py index c546edb607..e4c28a0c15 100644 --- a/colour/characterisation/datasets/filters/sds.py +++ b/colour/characterisation/datasets/filters/sds.py @@ -2,7 +2,7 @@ Spectral Distributions of Filters ================================= -Defines the spectral distributions of filters. +Define the spectral distributions of filters. Each filter data is in the form of :class:`dict` class instance of :class:`colour.SpectralDistribution` classes as follows:: diff --git a/colour/characterisation/datasets/lenses/sds.py b/colour/characterisation/datasets/lenses/sds.py index 4c918d4fb7..e498f67a06 100644 --- a/colour/characterisation/datasets/lenses/sds.py +++ b/colour/characterisation/datasets/lenses/sds.py @@ -2,7 +2,7 @@ Spectral Distributions of Lenses ================================ -Defines the spectral distributions of lenses. +Define the spectral distributions of lenses. Each lens data is in the form of :class:`dict` class instance of :class:`colour.SpectralDistribution` classes as follows:: diff --git a/colour/characterisation/displays.py b/colour/characterisation/displays.py index 5b891fa968..89c19ebc2b 100644 --- a/colour/characterisation/displays.py +++ b/colour/characterisation/displays.py @@ -2,7 +2,7 @@ RGB Display Primaries ===================== -Defines the spectral distributions classes for the datasets from +Define the spectral distributions classes for the datasets from the :mod:`colour.characterisation.datasets.displays` module: - :class:`colour.characterisation.RGB_DisplayPrimaries`: Implements support @@ -89,20 +89,20 @@ class instances :attr:`colour.continuous.Signal.wavelengths` attribute def __init__( self, - data: ArrayLike - | DataFrame - | dict - | MultiSignals - | MultiSpectralDistributions - | Sequence - | Series - | Signal - | SpectralDistribution - | None = None, + data: ( + ArrayLike + | DataFrame + | dict + | MultiSignals + | MultiSpectralDistributions + | Sequence + | Series + | Signal + | SpectralDistribution + | None + ) = None, domain: ArrayLike | SpectralShape | None = None, labels: Sequence | None = None, # noqa: ARG002 **kwargs: Any, ) -> None: - super().__init__( - data, domain, labels=("red", "green", "blue"), **kwargs - ) + super().__init__(data, domain, labels=("red", "green", "blue"), **kwargs) diff --git a/colour/characterisation/tests/test_aces_it.py b/colour/characterisation/tests/test_aces_it.py index 93ec2b4255..0ee49a435d 100644 --- a/colour/characterisation/tests/test_aces_it.py +++ b/colour/characterisation/tests/test_aces_it.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """ Define the unit tests for the :mod:`colour.characterisation.aces_it` module. """ @@ -6,7 +5,6 @@ from __future__ import annotations import os -import unittest import numpy as np @@ -82,14 +80,12 @@ ) ) -SD_AMPAS_ISO7589_STUDIO_TUNGSTEN: SpectralDistribution = ( - read_sds_from_csv_file( - os.path.join(ROOT_RESOURCES_RAWTOACES, "AMPAS_ISO_7589_Tungsten.csv") - )["iso7589"] -) +SD_AMPAS_ISO7589_STUDIO_TUNGSTEN: SpectralDistribution = read_sds_from_csv_file( + os.path.join(ROOT_RESOURCES_RAWTOACES, "AMPAS_ISO_7589_Tungsten.csv") +)["iso7589"] -class TestSdToAcesRelativeExposureValues(unittest.TestCase): +class TestSdToAcesRelativeExposureValues: """ Define :func:`colour.characterisation.aces_it.\ sd_to_aces_relative_exposure_values` definition unit tests methods. @@ -116,39 +112,32 @@ def test_sd_to_aces_relative_exposure_values(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - # NOTE: Reduced precision for random unit tests failure. dark_skin = SDS_COLOURCHECKERS["ColorChecker N Ohta"]["dark skin"] np.testing.assert_allclose( sd_to_aces_relative_exposure_values(dark_skin), np.array([0.11807796, 0.08690312, 0.05891252]), - atol=1e-5, + atol=TOLERANCE_ABSOLUTE_TESTS, ) - # NOTE: Reduced precision for random unit tests failure. - dark_skin = SDS_COLOURCHECKERS["ColorChecker N Ohta"]["dark skin"] np.testing.assert_allclose( - sd_to_aces_relative_exposure_values( - dark_skin, SDS_ILLUMINANTS["A"] - ), + sd_to_aces_relative_exposure_values(dark_skin, SDS_ILLUMINANTS["A"]), np.array([0.12937082, 0.09120875, 0.06110636]), - atol=1e-4, + atol=TOLERANCE_ABSOLUTE_TESTS, ) - dark_skin = SDS_COLOURCHECKERS["ColorChecker N Ohta"]["dark skin"] np.testing.assert_allclose( sd_to_aces_relative_exposure_values(dark_skin), np.array([0.11807796, 0.08690312, 0.05891252]), - atol=1e-5, + atol=TOLERANCE_ABSOLUTE_TESTS, ) - dark_skin = SDS_COLOURCHECKERS["ColorChecker N Ohta"]["dark skin"] np.testing.assert_allclose( sd_to_aces_relative_exposure_values( dark_skin, chromatic_adaptation_transform="Bradford", ), np.array([0.11805993, 0.08689013, 0.05900396]), - atol=1e-5, + atol=TOLERANCE_ABSOLUTE_TESTS, ) def test_domain_range_scale_spectral_to_aces_relative_exposure_values( @@ -174,7 +163,7 @@ def test_domain_range_scale_spectral_to_aces_relative_exposure_values( ) -class TestReadTrainingDataRawtoacesV1(unittest.TestCase): +class TestReadTrainingDataRawtoacesV1: """ Define :func:`colour.characterisation.aces_it.\ read_training_data_rawtoaces_v1` definition unit tests methods. @@ -186,10 +175,10 @@ def test_read_training_data_rawtoaces_v1(self): read_training_data_rawtoaces_v1` definition. """ - self.assertEqual(len(read_training_data_rawtoaces_v1().labels), 190) + assert len(read_training_data_rawtoaces_v1().labels) == 190 -class TestGenerateIlluminantsRawtoacesV1(unittest.TestCase): +class TestGenerateIlluminantsRawtoacesV1: """ Define :func:`colour.characterisation.aces_it.\ generate_illuminants_rawtoaces_v1` definition unit tests methods. @@ -201,64 +190,61 @@ def test_generate_illuminants_rawtoaces_v1(self): generate_illuminants_rawtoaces_v1` definition. """ - self.assertListEqual( - sorted(generate_illuminants_rawtoaces_v1().keys()), - [ - "1000K Blackbody", - "1500K Blackbody", - "2000K Blackbody", - "2500K Blackbody", - "3000K Blackbody", - "3500K Blackbody", - "D100", - "D105", - "D110", - "D115", - "D120", - "D125", - "D130", - "D135", - "D140", - "D145", - "D150", - "D155", - "D160", - "D165", - "D170", - "D175", - "D180", - "D185", - "D190", - "D195", - "D200", - "D205", - "D210", - "D215", - "D220", - "D225", - "D230", - "D235", - "D240", - "D245", - "D250", - "D40", - "D45", - "D50", - "D55", - "D60", - "D65", - "D70", - "D75", - "D80", - "D85", - "D90", - "D95", - "iso7589", - ], - ) - - -class TestWhiteBalanceMultipliers(unittest.TestCase): + assert sorted(generate_illuminants_rawtoaces_v1().keys()) == [ + "1000K Blackbody", + "1500K Blackbody", + "2000K Blackbody", + "2500K Blackbody", + "3000K Blackbody", + "3500K Blackbody", + "D100", + "D105", + "D110", + "D115", + "D120", + "D125", + "D130", + "D135", + "D140", + "D145", + "D150", + "D155", + "D160", + "D165", + "D170", + "D175", + "D180", + "D185", + "D190", + "D195", + "D200", + "D205", + "D210", + "D215", + "D220", + "D225", + "D230", + "D235", + "D240", + "D245", + "D250", + "D40", + "D45", + "D50", + "D55", + "D60", + "D65", + "D70", + "D75", + "D80", + "D85", + "D90", + "D95", + "iso7589", + ] + + +class TestWhiteBalanceMultipliers: """ Define :func:`colour.characterisation.aces_it.white_balance_multipliers` definition unit tests methods. @@ -271,9 +257,7 @@ def test_white_balance_multipliers(self): """ np.testing.assert_allclose( - white_balance_multipliers( - MSDS_CANON_EOS_5DMARK_II, SDS_ILLUMINANTS["D55"] - ), + white_balance_multipliers(MSDS_CANON_EOS_5DMARK_II, SDS_ILLUMINANTS["D55"]), np.array([2.34141541, 1.00000000, 1.51633759]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -288,7 +272,7 @@ def test_white_balance_multipliers(self): ) -class TestBestIlluminant(unittest.TestCase): +class TestBestIlluminant: """ Define :func:`colour.characterisation.aces_it.best_illuminant` definition unit tests methods. @@ -300,30 +284,30 @@ def test_best_illuminant(self): definition. """ - self.assertEqual( + assert ( best_illuminant( white_balance_multipliers( MSDS_CANON_EOS_5DMARK_II, SDS_ILLUMINANTS["FL2"] ), MSDS_CANON_EOS_5DMARK_II, generate_illuminants_rawtoaces_v1(), - ).name, - "D40", + ).name + == "D40" ) - self.assertEqual( + assert ( best_illuminant( white_balance_multipliers( MSDS_CANON_EOS_5DMARK_II, SDS_ILLUMINANTS["A"] ), MSDS_CANON_EOS_5DMARK_II, generate_illuminants_rawtoaces_v1(), - ).name, - "3000K Blackbody", + ).name + == "3000K Blackbody" ) -class TestNormaliseIlluminant(unittest.TestCase): +class TestNormaliseIlluminant: """ Define :func:`colour.characterisation.aces_it.normalise_illuminant` definition unit tests methods. @@ -346,7 +330,7 @@ def test_normalise_illuminant(self): ) -class TestTrainingDataSdsToRGB(unittest.TestCase): +class TestTrainingDataSdsToRGB: """ Define :func:`colour.characterisation.aces_it.training_data_sds_to_RGB` definition unit tests methods. @@ -614,7 +598,7 @@ def test_training_data_sds_to_RGB(self): ) -class TestTrainingDataSdsToXYZ(unittest.TestCase): +class TestTrainingDataSdsToXYZ: """ Define :func:`colour.characterisation.aces_it.training_data_sds_to_XYZ` definition unit tests methods. @@ -833,7 +817,6 @@ def test_training_data_sds_to_XYZ(self): SDS_COLOURCHECKERS["BabelColor Average"].values() ) - # NOTE: Reduced precision for random unit tests failure. np.testing.assert_allclose( training_data_sds_to_XYZ( training_data, @@ -868,10 +851,9 @@ def test_training_data_sds_to_XYZ(self): [0.03058273, 0.03200953, 0.03277947], ] ), - atol=1e-6, + atol=TOLERANCE_ABSOLUTE_TESTS, ) - # NOTE: Reduced precision for random unit tests failure. np.testing.assert_allclose( training_data_sds_to_XYZ( training_data, @@ -907,11 +889,11 @@ def test_training_data_sds_to_XYZ(self): [0.03058222, 0.03200864, 0.03278183], ] ), - atol=1e-6, + atol=TOLERANCE_ABSOLUTE_TESTS, ) -class TestWhitepointPreservingMatrix(unittest.TestCase): +class TestWhitepointPreservingMatrix: """ Define :func:`colour.characterisation.aces_it.whitepoint_preserving_matrix` definition unit tests methods. @@ -924,24 +906,24 @@ def test_whitepoint_preserving_matrix(self): """ np.testing.assert_array_equal( - whitepoint_preserving_matrix(np.arange(9).reshape([3, 3])), + whitepoint_preserving_matrix(np.reshape(np.arange(9), (3, 3))), np.array([[0, 1, 0], [3, 4, -6], [6, 7, -12]]), ) np.testing.assert_array_equal( - whitepoint_preserving_matrix(np.arange(12).reshape([3, 4])), + whitepoint_preserving_matrix(np.reshape(np.arange(12), (3, 4))), np.array([[0, 1, 2, -2], [4, 5, 6, -14], [8, 9, 10, -26]]), ) np.testing.assert_array_equal( whitepoint_preserving_matrix( - np.arange(9).reshape([3, 3]), np.array([1, 2, 3]) + np.reshape(np.arange(9), (3, 3)), np.array([1, 2, 3]) ), np.array([[0, 1, 0], [3, 4, -5], [6, 7, -10]]), ) -class TestOptimizationFactoryRawtoacesV1(unittest.TestCase): +class TestOptimizationFactoryRawtoacesV1: """ Define :func:`colour.characterisation.aces_it.\ optimisation_factory_rawtoaces_v1` definition unit tests methods. @@ -953,10 +935,10 @@ def test_optimisation_factory_rawtoaces_v1(self): optimisation_factory_rawtoaces_v1` definition. """ - self.assertEqual(len(optimisation_factory_rawtoaces_v1()), 4) + assert len(optimisation_factory_rawtoaces_v1()) == 4 -class TestOptimizationFactoryJzazbz(unittest.TestCase): +class TestOptimizationFactoryJzazbz: """ Define :func:`colour.characterisation.aces_it.\ optimisation_factory_Jzazbz` definition unit tests methods. @@ -968,10 +950,10 @@ def test_optimisation_factory_Jzazbz(self): optimisation_factory_Jzazbz` definition. """ - self.assertEqual(len(optimisation_factory_Jzazbz()), 4) + assert len(optimisation_factory_Jzazbz()) == 4 -class TestOptimizationFactoryOklab18(unittest.TestCase): +class TestOptimizationFactoryOklab18: """ Define :func:`colour.characterisation.aces_it.\ optimisation_factory_Oklab_15` definition unit tests methods. @@ -983,10 +965,10 @@ def test_optimisation_factory_Oklab_18(self): optimisation_factory_Oklab_15` definition. """ - self.assertEqual(len(optimisation_factory_Oklab_15()), 4) + assert len(optimisation_factory_Oklab_15()) == 4 -class TestMatrixIdt(unittest.TestCase): +class TestMatrixIdt: """ Define :func:`colour.characterisation.aces_it.matrix_idt` definition unit tests methods. @@ -1022,9 +1004,7 @@ def test_matrix_idt(self): # 0.021805 1.066614 -0.088418 # -0.019718 -0.206664 1.226381 np.testing.assert_allclose( - matrix_idt( - MSDS_CANON_EOS_5DMARK_II, SD_AMPAS_ISO7589_STUDIO_TUNGSTEN - )[0], + matrix_idt(MSDS_CANON_EOS_5DMARK_II, SD_AMPAS_ISO7589_STUDIO_TUNGSTEN)[0], np.array( [ [0.88849143, -0.07750529, 0.18901385], @@ -1199,7 +1179,7 @@ def test_matrix_idt(self): ) -class TestCamera_RGB_to_ACES2065_1(unittest.TestCase): +class TestCamera_RGB_to_ACES2065_1: """ Define :func:`colour.characterisation.aces_it.camera_RGB_to_ACES2065_1` definition unit tests methods. @@ -1229,7 +1209,3 @@ def test_camera_RGB_to_ACES2065_1(self): np.array([2.24358784, 0.98311459, 1.64045840]), atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/characterisation/tests/test_correction.py b/colour/characterisation/tests/test_correction.py index b6ef999b6a..9c76bc2424 100644 --- a/colour/characterisation/tests/test_correction.py +++ b/colour/characterisation/tests/test_correction.py @@ -7,10 +7,10 @@ import contextlib import platform -import unittest from itertools import product import numpy as np +import pytest from numpy.linalg import LinAlgError from colour.characterisation.correction import ( @@ -114,7 +114,7 @@ ) -class TestMatrixAugmentedCheung2004(unittest.TestCase): +class TestMatrixAugmentedCheung2004: """ Define :func:`colour.characterisation.correction.\ matrix_augmented_Cheung2004` definition unit tests methods. @@ -131,9 +131,7 @@ def test_matrix_augmented_Cheung2004(self): polynomials = [ np.array([0.17224810, 0.09170660, 0.06416938]), np.array([0.17224810, 0.09170660, 0.06416938, 1.00000000]), - np.array( - [0.17224810, 0.09170660, 0.06416938, 0.00101364, 1.00000000] - ), + np.array([0.17224810, 0.09170660, 0.06416938, 0.00101364, 1.00000000]), np.array( [ 0.17224810, @@ -359,9 +357,7 @@ def test_matrix_augmented_Cheung2004(self): ), ] - for i, terms in enumerate( - [3, 4, 5, 7, 8, 10, 11, 14, 16, 17, 19, 20, 22, 35] - ): + for i, terms in enumerate([3, 4, 5, 7, 8, 10, 11, 14, 16, 17, 19, 20, 22, 35]): np.testing.assert_allclose( matrix_augmented_Cheung2004(RGB, terms), polynomials[i], @@ -374,7 +370,7 @@ def test_raise_exception_matrix_augmented_Cheung2004(self): matrix_augmented_Cheung2004` definition raised exception. """ - self.assertRaises( + pytest.raises( ValueError, matrix_augmented_Cheung2004, np.array([0.17224810, 0.09170660, 0.06416938]), @@ -393,7 +389,7 @@ def test_nan_matrix_augmented_Cheung2004(self): matrix_augmented_Cheung2004(cases) -class TestPolynomialExpansionFinlayson2015(unittest.TestCase): +class TestPolynomialExpansionFinlayson2015: """ Define :func:`colour.characterisation.correction.\ polynomial_expansion_Finlayson2015` definition unit tests methods. @@ -565,7 +561,7 @@ def test_raise_exception_polynomial_expansion_Finlayson2015(self): polynomial_expansion_Finlayson2015` definition raised exception. """ - self.assertRaises( + pytest.raises( ValueError, polynomial_expansion_Finlayson2015, np.array([0.17224810, 0.09170660, 0.06416938]), @@ -584,7 +580,7 @@ def test_nan_polynomial_expansion_Finlayson2015(self): polynomial_expansion_Finlayson2015(cases) -class TestPolynomialExpansionVandermonde(unittest.TestCase): +class TestPolynomialExpansionVandermonde: """ Define :func:`colour.characterisation.correction.\ polynomial_expansion_Vandermonde` definition unit tests methods. @@ -663,7 +659,7 @@ def test_nan_polynomial_expansion_Vandermonde(self): polynomial_expansion_Vandermonde(cases) -class TestMatrixColourCorrectionCheung2004(unittest.TestCase): +class TestMatrixColourCorrectionCheung2004: """ Define :func:`colour.characterisation.correction.\ matrix_colour_correction_Cheung2004` definition unit tests methods. @@ -688,9 +684,7 @@ def test_matrix_colour_correction_Cheung2004(self): ) np.testing.assert_allclose( - matrix_colour_correction_Cheung2004( - MATRIX_TEST, MATRIX_REFERENCE, terms=7 - ), + matrix_colour_correction_Cheung2004(MATRIX_TEST, MATRIX_REFERENCE, terms=7), np.array( [ [ @@ -746,7 +740,7 @@ def test_nan_matrix_colour_correction_Cheung2004(self): # pragma: no cover ) -class TestMatrixColourCorrectionFinlayson2015(unittest.TestCase): +class TestMatrixColourCorrectionFinlayson2015: """ Define :func:`colour.characterisation.correction.\ matrix_colour_correction_Finlayson2015` definition unit tests methods. @@ -759,9 +753,7 @@ def test_matrix_colour_correction_Finlayson2015(self): """ np.testing.assert_allclose( - matrix_colour_correction_Finlayson2015( - MATRIX_TEST, MATRIX_REFERENCE - ), + matrix_colour_correction_Finlayson2015(MATRIX_TEST, MATRIX_REFERENCE), np.array( [ [0.69822661, 0.03071629, 0.16210422], @@ -851,7 +843,7 @@ def test_nan_matrix_colour_correction_Finlayson2015( ) -class TestMatrixColourCorrectionVandermonde(unittest.TestCase): +class TestMatrixColourCorrectionVandermonde: """ Define :func:`colour.characterisation.correction.\ matrix_colour_correction_Vandermonde` definition unit tests methods. @@ -864,9 +856,7 @@ def test_matrix_colour_correction_Vandermonde(self): """ np.testing.assert_allclose( - matrix_colour_correction_Vandermonde( - MATRIX_TEST, MATRIX_REFERENCE - ), + matrix_colour_correction_Vandermonde(MATRIX_TEST, MATRIX_REFERENCE), np.array( [ [0.66770040, 0.02514036, 0.12745797, 0.02485425], @@ -947,7 +937,7 @@ def test_nan_matrix_colour_correction_Vandermonde( ) -class TestApplyMatrixColourCorrectionCheung2004(unittest.TestCase): +class TestApplyMatrixColourCorrectionCheung2004: """ Define :func:`colour.characterisation.correction.\ apply_matrix_colour_correction_Cheung2004` definition unit tests methods. @@ -1031,7 +1021,7 @@ def test_nan_apply_matrix_colour_correction_Cheung2004( ) -class TestApplyMatrixColourCorrectionFinlayson2015(unittest.TestCase): +class TestApplyMatrixColourCorrectionFinlayson2015: """ Define :func:`colour.characterisation.correction.\ apply_matrix_colour_correction_Finlayson2015` definition unit tests methods. @@ -1115,7 +1105,7 @@ def test_nan_apply_matrix_colour_correction_Finlayson2015( ) -class TestApplyMatrixColourCorrectionVandermonde(unittest.TestCase): +class TestApplyMatrixColourCorrectionVandermonde: """ Define :func:`colour.characterisation.correction.\ apply_matrix_colour_correction_Vandermonde` definition unit tests methods. @@ -1199,7 +1189,7 @@ def test_nan_apply_matrix_colour_correction_Vandermonde( ) -class TestColourCorrectionCheung2004(unittest.TestCase): +class TestColourCorrectionCheung2004: """ Define :func:`colour.characterisation.correction.\ colour_correction_Cheung2004` definition unit tests methods. @@ -1220,9 +1210,7 @@ def test_colour_correction_Cheung2004(self): ) np.testing.assert_allclose( - colour_correction_Cheung2004( - RGB, MATRIX_TEST, MATRIX_REFERENCE, terms=7 - ), + colour_correction_Cheung2004(RGB, MATRIX_TEST, MATRIX_REFERENCE, terms=7), np.array([0.15850295, 0.09871628, 0.08105752]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -1234,9 +1222,7 @@ def test_n_dimensional_colour_correction_Cheung2004(self): """ RGB = np.array([0.17224810, 0.09170660, 0.06416938]) - RGB_c = colour_correction_Cheung2004( - RGB, MATRIX_TEST, MATRIX_REFERENCE - ) + RGB_c = colour_correction_Cheung2004(RGB, MATRIX_TEST, MATRIX_REFERENCE) RGB = np.tile(RGB, (6, 1)) RGB_c = np.tile(RGB_c, (6, 1)) @@ -1276,7 +1262,7 @@ def test_nan_colour_correction_Cheung2004(self): # pragma: no cover ) -class TestColourCorrectionFinlayson2015(unittest.TestCase): +class TestColourCorrectionFinlayson2015: """ Define :func:`colour.characterisation.correction.\ colour_correction_Finlayson2015` definition unit tests methods. @@ -1291,9 +1277,7 @@ def test_colour_correction_Finlayson2015(self): RGB = np.array([0.17224810, 0.09170660, 0.06416938]) np.testing.assert_allclose( - colour_correction_Finlayson2015( - RGB, MATRIX_TEST, MATRIX_REFERENCE - ), + colour_correction_Finlayson2015(RGB, MATRIX_TEST, MATRIX_REFERENCE), np.array([0.13348722, 0.08439216, 0.05990144]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -1313,16 +1297,12 @@ def test_n_dimensional_colour_correction_Finlayson2015(self): """ RGB = np.array([0.17224810, 0.09170660, 0.06416938]) - RGB_c = colour_correction_Finlayson2015( - RGB, MATRIX_TEST, MATRIX_REFERENCE - ) + RGB_c = colour_correction_Finlayson2015(RGB, MATRIX_TEST, MATRIX_REFERENCE) RGB = np.tile(RGB, (6, 1)) RGB_c = np.tile(RGB_c, (6, 1)) np.testing.assert_allclose( - colour_correction_Finlayson2015( - RGB, MATRIX_TEST, MATRIX_REFERENCE - ), + colour_correction_Finlayson2015(RGB, MATRIX_TEST, MATRIX_REFERENCE), RGB_c, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -1330,9 +1310,7 @@ def test_n_dimensional_colour_correction_Finlayson2015(self): RGB = np.reshape(RGB, (2, 3, 3)) RGB_c = np.reshape(RGB_c, (2, 3, 3)) np.testing.assert_allclose( - colour_correction_Finlayson2015( - RGB, MATRIX_TEST, MATRIX_REFERENCE - ), + colour_correction_Finlayson2015(RGB, MATRIX_TEST, MATRIX_REFERENCE), RGB_c, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -1359,7 +1337,7 @@ def test_nan_colour_correction_Finlayson2015(self): # pragma: no cover ) -class TestColourCorrectionVandermonde(unittest.TestCase): +class TestColourCorrectionVandermonde: """ Define :func:`colour.characterisation.correction.\ colour_correction_Vandermonde` definition unit tests methods. @@ -1380,9 +1358,7 @@ def test_colour_correction_Vandermonde(self): ) np.testing.assert_allclose( - colour_correction_Vandermonde( - RGB, MATRIX_TEST, MATRIX_REFERENCE, degree=3 - ), + colour_correction_Vandermonde(RGB, MATRIX_TEST, MATRIX_REFERENCE, degree=3), np.array([0.15747814, 0.10035799, 0.06616709]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -1394,9 +1370,7 @@ def test_n_dimensional_colour_correction_Vandermonde(self): """ RGB = np.array([0.17224810, 0.09170660, 0.06416938]) - RGB_c = colour_correction_Vandermonde( - RGB, MATRIX_TEST, MATRIX_REFERENCE - ) + RGB_c = colour_correction_Vandermonde(RGB, MATRIX_TEST, MATRIX_REFERENCE) RGB = np.tile(RGB, (6, 1)) RGB_c = np.tile(RGB_c, (6, 1)) @@ -1434,7 +1408,3 @@ def test_nan_colour_correction_Vandermonde(self): # pragma: no cover np.vstack([case, case, case]), np.transpose(np.vstack([case, case, case])), ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/blackbody.py b/colour/colorimetry/blackbody.py index db4761e8b6..83a6382d98 100644 --- a/colour/colorimetry/blackbody.py +++ b/colour/colorimetry/blackbody.py @@ -2,7 +2,7 @@ Blackbody - Planckian Radiator ============================== -Defines the objects to compute the spectral radiance of a planckian radiator +Define the objects to compute the spectral radiance of a planckian radiator and its spectral distribution. References @@ -186,7 +186,6 @@ def sd_blackbody( >>> with numpy_print_options(suppress=True): ... sd_blackbody(5000, shape=SpectralShape(400, 700, 20)) ... # doctest: +ELLIPSIS - ... SpectralDistribution([[ 400. , 8742.5713329...], [ 420. , 9651.6810212...], [ 440. , 10447.3423137...], @@ -216,9 +215,7 @@ def sd_blackbody( ) -def rayleigh_jeans_law( - wavelength: ArrayLike, temperature: ArrayLike -) -> NDArrayFloat: +def rayleigh_jeans_law(wavelength: ArrayLike, temperature: ArrayLike) -> NDArrayFloat: """ Return the approximation of the spectral radiance of a blackbody as a function of wavelength at thermodynamic temperature :math:`T[K]` according @@ -322,7 +319,6 @@ def sd_rayleigh_jeans( >>> with numpy_print_options(suppress=True): ... sd_rayleigh_jeans(5000, shape=SpectralShape(400, 700, 20)) ... # doctest: +ELLIPSIS - ... SpectralDistribution([[ 400. , 1616829.9106941...], [ 420. , 1330169.9688456...], [ 440. , 1104316.5840408...], diff --git a/colour/colorimetry/cmfs.py b/colour/colorimetry/cmfs.py index 2fd654c40c..5c37c52963 100644 --- a/colour/colorimetry/cmfs.py +++ b/colour/colorimetry/cmfs.py @@ -2,7 +2,7 @@ Colour Matching Functions ========================= -Defines the colour matching functions classes for the datasets from +Define the colour matching functions classes for the datasets from the :mod:`colour.colorimetry.datasets.cmfs` module: - :class:`colour.colorimetry.LMS_ConeFundamentals`: Implements support for @@ -95,16 +95,18 @@ class instances :attr:`colour.continuous.Signal.wavelengths` attribute def __init__( self, - data: ArrayLike - | DataFrame - | dict - | MultiSignals - | MultiSpectralDistributions - | Sequence - | Series - | Signal - | SpectralDistribution - | None = None, + data: ( + ArrayLike + | DataFrame + | dict + | MultiSignals + | MultiSpectralDistributions + | Sequence + | Series + | Signal + | SpectralDistribution + | None + ) = None, domain: ArrayLike | SpectralShape | None = None, labels: Sequence | None = None, # noqa: ARG002 **kwargs: Any, @@ -160,16 +162,18 @@ class instances :attr:`colour.continuous.Signal.wavelengths` attribute def __init__( self, - data: ArrayLike - | DataFrame - | dict - | MultiSignals - | MultiSpectralDistributions - | Sequence - | Series - | Signal - | SpectralDistribution - | None = None, + data: ( + ArrayLike + | DataFrame + | dict + | MultiSignals + | MultiSpectralDistributions + | Sequence + | Series + | Signal + | SpectralDistribution + | None + ) = None, domain: ArrayLike | SpectralShape | None = None, labels: Sequence | None = None, # noqa: ARG002 **kwargs: Any, @@ -226,16 +230,18 @@ class instances :attr:`colour.continuous.Signal.wavelengths` attribute def __init__( self, - data: ArrayLike - | DataFrame - | dict - | MultiSignals - | MultiSpectralDistributions - | Sequence - | Series - | Signal - | SpectralDistribution - | None = None, + data: ( + ArrayLike + | DataFrame + | dict + | MultiSignals + | MultiSpectralDistributions + | Sequence + | Series + | Signal + | SpectralDistribution + | None + ) = None, domain: ArrayLike | SpectralShape | None = None, labels: Sequence | None = None, # noqa: ARG002 **kwargs: Any, diff --git a/colour/colorimetry/correction.py b/colour/colorimetry/correction.py index 2cf88b798c..e7272424c1 100644 --- a/colour/colorimetry/correction.py +++ b/colour/colorimetry/correction.py @@ -2,7 +2,7 @@ Spectral Bandpass Dependence Correction ======================================= -Defines the objects to perform spectral bandpass dependence correction. +Define the objects to perform spectral bandpass dependence correction. The following correction methods are available: @@ -82,7 +82,6 @@ def bandpass_correction_Stearns1988( >>> with numpy_print_options(suppress=True): ... bandpass_correction_Stearns1988(SpectralDistribution(data)) ... # doctest: +ELLIPSIS - ... SpectralDistribution([[ 500. , 0.0646518...], [ 520. , 0.0704293...], [ 540. , 0.0769485...], @@ -102,9 +101,7 @@ def bandpass_correction_Stearns1988( values[-1] = (1 + A_S) * values[-1] - A_S * values[-2] for i in range(1, len(values) - 1): values[i] = ( - -A_S * values[i - 1] - + (1 + 2 * A_S) * values[i] - - A_S * values[i + 1] + -A_S * values[i - 1] + (1 + 2 * A_S) * values[i] - A_S * values[i + 1] ) sd.values = values @@ -159,7 +156,6 @@ def bandpass_correction( >>> with numpy_print_options(suppress=True): ... bandpass_correction(SpectralDistribution(data)) ... # doctest: +ELLIPSIS - ... SpectralDistribution([[ 500. , 0.0646518...], [ 520. , 0.0704293...], [ 540. , 0.0769485...], diff --git a/colour/colorimetry/datasets/cmfs.py b/colour/colorimetry/datasets/cmfs.py index 9078513778..79c78fabc6 100644 --- a/colour/colorimetry/datasets/cmfs.py +++ b/colour/colorimetry/datasets/cmfs.py @@ -2,7 +2,7 @@ Multi-Spectral Distributions of the Colour Matching Functions ============================================================= -Defines the multi-spectral distributions of the colour matching functions. +Define the multi-spectral distributions of the colour matching functions. The colour matching functions data is in the form of a *dict* of :class:`colour.colorimetry.MultiSpectralDistributions` classes as follows:: @@ -70,7 +70,7 @@ RGB_ColourMatchingFunctions, XYZ_ColourMatchingFunctions, ) -from colour.utilities import LazyCanonicalMapping, usage_warning +from colour.utilities import LazyCanonicalMapping __author__ = "Colour Developers" __copyright__ = "Copyright 2013 Colour Developers" @@ -3216,9 +3216,7 @@ ), "CIE 1964 10 Degree Standard Observer": partial( XYZ_ColourMatchingFunctions, - DATA_CMFS_STANDARD_OBSERVER[ - "CIE 1964 10 Degree Standard Observer" - ], + DATA_CMFS_STANDARD_OBSERVER["CIE 1964 10 Degree Standard Observer"], name="CIE 1964 10 Degree Standard Observer", display_name="CIE 1964 10$^\\circ$ Standard Observer", ), @@ -3230,9 +3228,7 @@ ), "CIE 2015 10 Degree Standard Observer": partial( XYZ_ColourMatchingFunctions, - DATA_CMFS_STANDARD_OBSERVER[ - "CIE 2015 10 Degree Standard Observer" - ], + DATA_CMFS_STANDARD_OBSERVER["CIE 2015 10 Degree Standard Observer"], name="CIE 2015 10 Degree Standard Observer", display_name="CIE 2015 10$^\\circ$ Standard Observer", ), @@ -3258,47 +3254,6 @@ "CIE 1964 10 Degree Standard Observer" ] - -# ----------------------------------------------------------------------------# -# --- API Changes and Deprecation Management ---# -# ----------------------------------------------------------------------------# -# v0.4.2 -def _CIE_2012_2_Degree_Standard_Observer(): - usage_warning( - 'The "CIE 2012 2 Degree Standard Observer" has been renamed to ' - '"CIE 2015 2 Degree Standard Observer" for consistency with the ' - "official CIE name which was adopted in 2015." - ) - - return XYZ_ColourMatchingFunctions( - DATA_CMFS_STANDARD_OBSERVER["CIE 2015 2 Degree Standard Observer"], - name="CIE 2015 2 Degree Standard Observer", - display_name="CIE 2015 2$^\\circ$ Standard Observer", - ) - - -def _CIE_2012_10_Degree_Standard_Observer(): - usage_warning( - 'The "CIE 2012 10 Degree Standard Observer" has been renamed to ' - '"CIE 2015 10 Degree Standard Observer" for consistency with the ' - "official CIE name which was adopted in 2015." - ) - - return XYZ_ColourMatchingFunctions( - DATA_CMFS_STANDARD_OBSERVER["CIE 2015 2 Degree Standard Observer"], - name="CIE 2015 2 Degree Standard Observer", - display_name="CIE 2015 2$^\\circ$ Standard Observer", - ) - - -MSDS_CMFS_STANDARD_OBSERVER[ - "CIE 2012 2 Degree Standard Observer" -] = _CIE_2012_2_Degree_Standard_Observer -MSDS_CMFS_STANDARD_OBSERVER[ - "CIE 2012 10 Degree Standard Observer" -] = _CIE_2012_10_Degree_Standard_Observer -# ----------------------------------------------------------------------------# - MSDS_CMFS = LazyCanonicalMapping(MSDS_CMFS_LMS) MSDS_CMFS.__doc__ = """ Multi-spectral distributions of the colour matching functions. diff --git a/colour/colorimetry/datasets/illuminants/chromaticity_coordinates.py b/colour/colorimetry/datasets/illuminants/chromaticity_coordinates.py index 263d6f298a..5a7f898b9f 100644 --- a/colour/colorimetry/datasets/illuminants/chromaticity_coordinates.py +++ b/colour/colorimetry/datasets/illuminants/chromaticity_coordinates.py @@ -2,7 +2,7 @@ Chromaticity Coordinates of Illuminants ======================================= -Defines the chromaticity coordinates of the illuminants for the +Define the chromaticity coordinates of the illuminants for the *CIE 1931 2 Degree Standard Observer* and *CIE 1964 10 Degree Standard Observer*. @@ -107,63 +107,63 @@ "CCS_ILLUMINANTS", ] -CCS_ILLUMINANTS_CIE_STANDARD_OBSERVER_2_DEGREE_CIE1931: ( - CanonicalMapping -) = CanonicalMapping( - { - "A": np.array([0.44758, 0.40745]), - "B": np.array([0.34842, 0.35161]), - "C": np.array([0.31006, 0.31616]), - "D50": np.array([0.34570, 0.35850]), - "D55": np.array([0.33243, 0.34744]), - "D60": np.array([0.321616709705268, 0.337619916550817]), - "D65": np.array([0.31270, 0.32900]), - "D75": np.array([0.29903, 0.31488]), - "E": np.array([1 / 3, 1 / 3]), - "FL1": np.array([0.31310, 0.33710]), - "FL2": np.array([0.37210, 0.37510]), - "FL3": np.array([0.40910, 0.39410]), - "FL4": np.array([0.44020, 0.40310]), - "FL5": np.array([0.31380, 0.34520]), - "FL6": np.array([0.37790, 0.38820]), - "FL7": np.array([0.31290, 0.32920]), - "FL8": np.array([0.34580, 0.35860]), - "FL9": np.array([0.37410, 0.37270]), - "FL10": np.array([0.34580, 0.35880]), - "FL11": np.array([0.38050, 0.37690]), - "FL12": np.array([0.43700, 0.40420]), - "FL3.1": np.array([0.44070, 0.40330]), - "FL3.2": np.array([0.38080, 0.37340]), - "FL3.3": np.array([0.31530, 0.34390]), - "FL3.4": np.array([0.44290, 0.40430]), - "FL3.5": np.array([0.37490, 0.36720]), - "FL3.6": np.array([0.34880, 0.36000]), - "FL3.7": np.array([0.43840, 0.40450]), - "FL3.8": np.array([0.38200, 0.38320]), - "FL3.9": np.array([0.34990, 0.35910]), - "FL3.10": np.array([0.34550, 0.35600]), - "FL3.11": np.array([0.32450, 0.34340]), - "FL3.12": np.array([0.43770, 0.40370]), - "FL3.13": np.array([0.38300, 0.37240]), - "FL3.14": np.array([0.34470, 0.36090]), - "FL3.15": np.array([0.31270, 0.32880]), - "HP1": np.array([0.53300, 0.4150]), - "HP2": np.array([0.47780, 0.41580]), - "HP3": np.array([0.43020, 0.40750]), - "HP4": np.array([0.38120, 0.37970]), - "HP5": np.array([0.37760, 0.37130]), - "LED-B1": np.array([0.45600, 0.40780]), - "LED-B2": np.array([0.43570, 0.40120]), - "LED-B3": np.array([0.37560, 0.37230]), - "LED-B4": np.array([0.34220, 0.35020]), - "LED-B5": np.array([0.31180, 0.32360]), - "LED-BH1": np.array([0.44740, 0.40660]), - "LED-RGB1": np.array([0.45570, 0.42110]), - "LED-V1": np.array([0.45480, 0.40440]), - "LED-V2": np.array([0.37810, 0.37750]), - "ID65": np.array([0.310656625403120, 0.330663091836953]), - "ID50": np.array([0.343211370103531, 0.360207541805137]), - } +CCS_ILLUMINANTS_CIE_STANDARD_OBSERVER_2_DEGREE_CIE1931: CanonicalMapping = ( + CanonicalMapping( + { + "A": np.array([0.44758, 0.40745]), + "B": np.array([0.34842, 0.35161]), + "C": np.array([0.31006, 0.31616]), + "D50": np.array([0.34570, 0.35850]), + "D55": np.array([0.33243, 0.34744]), + "D60": np.array([0.321616709705268, 0.337619916550817]), + "D65": np.array([0.31270, 0.32900]), + "D75": np.array([0.29903, 0.31488]), + "E": np.array([1 / 3, 1 / 3]), + "FL1": np.array([0.31310, 0.33710]), + "FL2": np.array([0.37210, 0.37510]), + "FL3": np.array([0.40910, 0.39410]), + "FL4": np.array([0.44020, 0.40310]), + "FL5": np.array([0.31380, 0.34520]), + "FL6": np.array([0.37790, 0.38820]), + "FL7": np.array([0.31290, 0.32920]), + "FL8": np.array([0.34580, 0.35860]), + "FL9": np.array([0.37410, 0.37270]), + "FL10": np.array([0.34580, 0.35880]), + "FL11": np.array([0.38050, 0.37690]), + "FL12": np.array([0.43700, 0.40420]), + "FL3.1": np.array([0.44070, 0.40330]), + "FL3.2": np.array([0.38080, 0.37340]), + "FL3.3": np.array([0.31530, 0.34390]), + "FL3.4": np.array([0.44290, 0.40430]), + "FL3.5": np.array([0.37490, 0.36720]), + "FL3.6": np.array([0.34880, 0.36000]), + "FL3.7": np.array([0.43840, 0.40450]), + "FL3.8": np.array([0.38200, 0.38320]), + "FL3.9": np.array([0.34990, 0.35910]), + "FL3.10": np.array([0.34550, 0.35600]), + "FL3.11": np.array([0.32450, 0.34340]), + "FL3.12": np.array([0.43770, 0.40370]), + "FL3.13": np.array([0.38300, 0.37240]), + "FL3.14": np.array([0.34470, 0.36090]), + "FL3.15": np.array([0.31270, 0.32880]), + "HP1": np.array([0.53300, 0.4150]), + "HP2": np.array([0.47780, 0.41580]), + "HP3": np.array([0.43020, 0.40750]), + "HP4": np.array([0.38120, 0.37970]), + "HP5": np.array([0.37760, 0.37130]), + "LED-B1": np.array([0.45600, 0.40780]), + "LED-B2": np.array([0.43570, 0.40120]), + "LED-B3": np.array([0.37560, 0.37230]), + "LED-B4": np.array([0.34220, 0.35020]), + "LED-B5": np.array([0.31180, 0.32360]), + "LED-BH1": np.array([0.44740, 0.40660]), + "LED-RGB1": np.array([0.45570, 0.42110]), + "LED-V1": np.array([0.45480, 0.40440]), + "LED-V2": np.array([0.37810, 0.37750]), + "ID65": np.array([0.310656625403120, 0.330663091836953]), + "ID50": np.array([0.343211370103531, 0.360207541805137]), + } + ) ) """ Chromaticity coordinates of the *CIE* illuminants for the @@ -174,12 +174,12 @@ :cite:`CIETC1-482004h`, :cite:`Wikipedia2006a` """ -CCS_ILLUMINANTS_ACES_STANDARD_OBSERVER_2_DEGREE_CIE1931: ( - CanonicalMapping -) = CanonicalMapping( - { - "ACES": np.array([0.32168, 0.33767]), - } +CCS_ILLUMINANTS_ACES_STANDARD_OBSERVER_2_DEGREE_CIE1931: CanonicalMapping = ( + CanonicalMapping( + { + "ACES": np.array([0.32168, 0.33767]), + } + ) ) """ Chromaticity coordinates of the *Academy Color Encoding System* (ACES) @@ -206,12 +206,12 @@ :cite:`BlackmagicDesign2021` """ -CCS_ILLUMINANTS_DCI_STANDARD_OBSERVER_2_DEGREE_CIE1931: ( - CanonicalMapping -) = CanonicalMapping( - { - "DCI-P3": np.array([0.31400, 0.35100]), - } +CCS_ILLUMINANTS_DCI_STANDARD_OBSERVER_2_DEGREE_CIE1931: CanonicalMapping = ( + CanonicalMapping( + { + "DCI-P3": np.array([0.31400, 0.35100]), + } + ) ) """ Chromaticity coordinates of the *DCI* illuminants for the @@ -222,10 +222,8 @@ :cite:`DigitalCinemaInitiatives2007b` """ -CCS_ILLUMINANTS_ICC_STANDARD_OBSERVER_2_DEGREE_CIE1931: ( - CanonicalMapping -) = CanonicalMapping( - {"ICC D50": np.array([0.345702914918791, 0.358538596679933])} +CCS_ILLUMINANTS_ICC_STANDARD_OBSERVER_2_DEGREE_CIE1931: CanonicalMapping = ( + CanonicalMapping({"ICC D50": np.array([0.345702914918791, 0.358538596679933])}) ) """ Chromaticity coordinates of the *ICC* illuminants for the @@ -236,32 +234,30 @@ :cite:`InternationalColorConsortium2010` """ -CCS_ILLUMINANTS_ISO_STANDARD_OBSERVER_2_DEGREE_CIE1931: ( - CanonicalMapping -) = CanonicalMapping( - { - "ISO 7589 Photographic Daylight": np.array( - [0.332039098470978, 0.347263885596614] - ), - "ISO 7589 Sensitometric Daylight": np.array( - [0.333818313227557, 0.353436231513603] - ), - "ISO 7589 Studio Tungsten": np.array( - [0.430944089109761, 0.403585442674295] - ), - "ISO 7589 Sensitometric Studio Tungsten": np.array( - [0.431418223648390, 0.407471441950342] - ), - "ISO 7589 Photoflood": np.array( - [0.411146015714843, 0.393719378241161] - ), - "ISO 7589 Sensitometric Photoflood": np.array( - [0.412024776908998, 0.398177410548532] - ), - "ISO 7589 Sensitometric Printer": np.array( - [0.412087967973680, 0.421104984758526] - ), - } +CCS_ILLUMINANTS_ISO_STANDARD_OBSERVER_2_DEGREE_CIE1931: CanonicalMapping = ( + CanonicalMapping( + { + "ISO 7589 Photographic Daylight": np.array( + [0.332039098470978, 0.347263885596614] + ), + "ISO 7589 Sensitometric Daylight": np.array( + [0.333818313227557, 0.353436231513603] + ), + "ISO 7589 Studio Tungsten": np.array( + [0.430944089109761, 0.403585442674295] + ), + "ISO 7589 Sensitometric Studio Tungsten": np.array( + [0.431418223648390, 0.407471441950342] + ), + "ISO 7589 Photoflood": np.array([0.411146015714843, 0.393719378241161]), + "ISO 7589 Sensitometric Photoflood": np.array( + [0.412024776908998, 0.398177410548532] + ), + "ISO 7589 Sensitometric Printer": np.array( + [0.412087967973680, 0.421104984758526] + ), + } + ) ) """ Chromaticity coordinates of the *ISO* illuminants for the @@ -272,9 +268,9 @@ :cite:`InternationalOrganizationforStandardization2002` """ -CCS_ILLUMINANTS_PLASA_STANDARD_OBSERVER_2_DEGREE_CIE1931: ( - CanonicalMapping -) = CanonicalMapping({"PLASA ANSI E1.54": np.array([0.4254, 0.4044])}) +CCS_ILLUMINANTS_PLASA_STANDARD_OBSERVER_2_DEGREE_CIE1931: CanonicalMapping = ( + CanonicalMapping({"PLASA ANSI E1.54": np.array([0.4254, 0.4044])}) +) """ Chromaticity coordinates of the *PLASA* illuminants for the *CIE 1931 2 Degree Standard Observer*. @@ -284,63 +280,63 @@ :cite:`PLASANorthAmerica2015` """ -CCS_ILLUMINANTS_CIE_STANDARD_OBSERVER_10_DEGREE_CIE1964: ( - CanonicalMapping -) = CanonicalMapping( - { - "A": np.array([0.45117, 0.40594]), - "B": np.array([0.34980, 0.35270]), - "C": np.array([0.31039, 0.31905]), - "D50": np.array([0.34773, 0.35952]), - "D55": np.array([0.33412, 0.34877]), - "D60": np.array([0.322986926715820, 0.339275732345997]), - "D65": np.array([0.31382, 0.33100]), - "D75": np.array([0.29968, 0.31740]), - "E": np.array([1 / 3, 1 / 3]), - "FL1": np.array([0.31811, 0.33559]), - "FL2": np.array([0.37925, 0.36733]), - "FL3": np.array([0.41761, 0.38324]), - "FL4": np.array([0.44920, 0.39074]), - "FL5": np.array([0.31975, 0.34246]), - "FL6": np.array([0.38660, 0.37847]), - "FL7": np.array([0.31569, 0.32960]), - "FL8": np.array([0.34902, 0.35939]), - "FL9": np.array([0.37829, 0.37045]), - "FL10": np.array([0.35090, 0.35444]), - "FL11": np.array([0.38541, 0.37123]), - "FL12": np.array([0.44256, 0.39717]), - "FL3.1": np.array([0.449830684010003, 0.390231404321266]), - "FL3.2": np.array([0.386924116672933, 0.365756034732821]), - "FL3.3": np.array([0.321176986855865, 0.340501092654981]), - "FL3.4": np.array([0.448121275113995, 0.397077112142482]), - "FL3.5": np.array([0.377814166608895, 0.366625766963060]), - "FL3.6": np.array([0.351976478983504, 0.361094432889677]), - "FL3.7": np.array([0.444309208810922, 0.396791387314871]), - "FL3.8": np.array([0.387588931999771, 0.376305569410173]), - "FL3.9": np.array([0.354688990710449, 0.353445033593383]), - "FL3.10": np.array([0.349344792334400, 0.354984421140869]), - "FL3.11": np.array([0.329267975695120, 0.338865386643537]), - "FL3.12": np.array([0.442252080438001, 0.401220551071252]), - "FL3.13": np.array([0.386275268780817, 0.374283190950586]), - "FL3.14": np.array([0.347255078638291, 0.366808242504180]), - "FL3.15": np.array([0.314613997909246, 0.333377149377113]), - "HP1": np.array([0.543334600247307, 0.405289298480431]), - "HP2": np.array([0.482647330648721, 0.410815644179685]), - "HP3": np.array([0.435560034503954, 0.398801084399711]), - "HP4": np.array([0.385193641123543, 0.368275479241015]), - "HP5": np.array([0.380316415606638, 0.366617114797851]), - "LED-B1": np.array([0.462504966271043, 0.403041801546906]), - "LED-B2": np.array([0.442119475258745, 0.396633702892576]), - "LED-B3": np.array([0.380851979328052, 0.368518548904765]), - "LED-B4": np.array([0.348371362473402, 0.345065503264192]), - "LED-B5": np.array([0.316916877024753, 0.322060276350364]), - "LED-BH1": np.array([0.452772610754910, 0.400032462750000]), - "LED-RGB1": np.array([0.457036370583652, 0.425381348780888]), - "LED-V1": np.array([0.453602699414564, 0.398199587905174]), - "LED-V2": np.array([0.377728483834020, 0.374512315539769]), - "ID65": np.array([0.312074043269908, 0.332660121024630]), - "ID50": np.array([0.345621427535976, 0.361228962209198]), - } +CCS_ILLUMINANTS_CIE_STANDARD_OBSERVER_10_DEGREE_CIE1964: CanonicalMapping = ( + CanonicalMapping( + { + "A": np.array([0.45117, 0.40594]), + "B": np.array([0.34980, 0.35270]), + "C": np.array([0.31039, 0.31905]), + "D50": np.array([0.34773, 0.35952]), + "D55": np.array([0.33412, 0.34877]), + "D60": np.array([0.322986926715820, 0.339275732345997]), + "D65": np.array([0.31382, 0.33100]), + "D75": np.array([0.29968, 0.31740]), + "E": np.array([1 / 3, 1 / 3]), + "FL1": np.array([0.31811, 0.33559]), + "FL2": np.array([0.37925, 0.36733]), + "FL3": np.array([0.41761, 0.38324]), + "FL4": np.array([0.44920, 0.39074]), + "FL5": np.array([0.31975, 0.34246]), + "FL6": np.array([0.38660, 0.37847]), + "FL7": np.array([0.31569, 0.32960]), + "FL8": np.array([0.34902, 0.35939]), + "FL9": np.array([0.37829, 0.37045]), + "FL10": np.array([0.35090, 0.35444]), + "FL11": np.array([0.38541, 0.37123]), + "FL12": np.array([0.44256, 0.39717]), + "FL3.1": np.array([0.449830684010003, 0.390231404321266]), + "FL3.2": np.array([0.386924116672933, 0.365756034732821]), + "FL3.3": np.array([0.321176986855865, 0.340501092654981]), + "FL3.4": np.array([0.448121275113995, 0.397077112142482]), + "FL3.5": np.array([0.377814166608895, 0.366625766963060]), + "FL3.6": np.array([0.351976478983504, 0.361094432889677]), + "FL3.7": np.array([0.444309208810922, 0.396791387314871]), + "FL3.8": np.array([0.387588931999771, 0.376305569410173]), + "FL3.9": np.array([0.354688990710449, 0.353445033593383]), + "FL3.10": np.array([0.349344792334400, 0.354984421140869]), + "FL3.11": np.array([0.329267975695120, 0.338865386643537]), + "FL3.12": np.array([0.442252080438001, 0.401220551071252]), + "FL3.13": np.array([0.386275268780817, 0.374283190950586]), + "FL3.14": np.array([0.347255078638291, 0.366808242504180]), + "FL3.15": np.array([0.314613997909246, 0.333377149377113]), + "HP1": np.array([0.543334600247307, 0.405289298480431]), + "HP2": np.array([0.482647330648721, 0.410815644179685]), + "HP3": np.array([0.435560034503954, 0.398801084399711]), + "HP4": np.array([0.385193641123543, 0.368275479241015]), + "HP5": np.array([0.380316415606638, 0.366617114797851]), + "LED-B1": np.array([0.462504966271043, 0.403041801546906]), + "LED-B2": np.array([0.442119475258745, 0.396633702892576]), + "LED-B3": np.array([0.380851979328052, 0.368518548904765]), + "LED-B4": np.array([0.348371362473402, 0.345065503264192]), + "LED-B5": np.array([0.316916877024753, 0.322060276350364]), + "LED-BH1": np.array([0.452772610754910, 0.400032462750000]), + "LED-RGB1": np.array([0.457036370583652, 0.425381348780888]), + "LED-V1": np.array([0.453602699414564, 0.398199587905174]), + "LED-V2": np.array([0.377728483834020, 0.374512315539769]), + "ID65": np.array([0.312074043269908, 0.332660121024630]), + "ID50": np.array([0.345621427535976, 0.361228962209198]), + } + ) ) """ Chromaticity coordinates of the *CIE* illuminants for the @@ -351,32 +347,30 @@ :cite:`CIETC1-482004h`, :cite:`Wikipedia2006a` """ -CCS_ILLUMINANTS_ISO_STANDARD_OBSERVER_10_DEGREE_CIE1964: ( - CanonicalMapping -) = CanonicalMapping( - { - "ISO 7589 Photographic Daylight": np.array( - [0.333716908394534, 0.348592494683065] - ), - "ISO 7589 Sensitometric Daylight": np.array( - [0.336125906007630, 0.354997062476417] - ), - "ISO 7589 Studio Tungsten": np.array( - [0.434575926493196, 0.402219691745325] - ), - "ISO 7589 Sensitometric Studio Tungsten": np.array( - [0.435607674215215, 0.406129244796761] - ), - "ISO 7589 Photoflood": np.array( - [0.414144647169611, 0.392458587686395] - ), - "ISO 7589 Sensitometric Photoflood": np.array( - [0.415625819190627, 0.397002292994179] - ), - "ISO 7589 Sensitometric Printer": np.array( - [0.418841052206998, 0.418695130974955] - ), - } +CCS_ILLUMINANTS_ISO_STANDARD_OBSERVER_10_DEGREE_CIE1964: CanonicalMapping = ( + CanonicalMapping( + { + "ISO 7589 Photographic Daylight": np.array( + [0.333716908394534, 0.348592494683065] + ), + "ISO 7589 Sensitometric Daylight": np.array( + [0.336125906007630, 0.354997062476417] + ), + "ISO 7589 Studio Tungsten": np.array( + [0.434575926493196, 0.402219691745325] + ), + "ISO 7589 Sensitometric Studio Tungsten": np.array( + [0.435607674215215, 0.406129244796761] + ), + "ISO 7589 Photoflood": np.array([0.414144647169611, 0.392458587686395]), + "ISO 7589 Sensitometric Photoflood": np.array( + [0.415625819190627, 0.397002292994179] + ), + "ISO 7589 Sensitometric Printer": np.array( + [0.418841052206998, 0.418695130974955] + ), + } + ) ) """ Chromaticity coordinates of the *ISO* illuminants for the @@ -449,12 +443,8 @@ - 'cie_2_1931': 'CIE 1931 2 Degree Standard Observer' - 'cie_10_1964': 'CIE 1964 10 Degree Standard Observer' """ -CCS_ILLUMINANTS["cie_2_1931"] = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" -] -CCS_ILLUMINANTS["cie_10_1964"] = CCS_ILLUMINANTS[ - "CIE 1964 10 Degree Standard Observer" -] +CCS_ILLUMINANTS["cie_2_1931"] = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"] +CCS_ILLUMINANTS["cie_10_1964"] = CCS_ILLUMINANTS["CIE 1964 10 Degree Standard Observer"] CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"].update( CCS_ILLUMINANTS_ACES_STANDARD_OBSERVER_2_DEGREE_CIE1931 diff --git a/colour/colorimetry/datasets/illuminants/hunterlab.py b/colour/colorimetry/datasets/illuminants/hunterlab.py index 9beea9ac88..12999afae6 100644 --- a/colour/colorimetry/datasets/illuminants/hunterlab.py +++ b/colour/colorimetry/datasets/illuminants/hunterlab.py @@ -2,7 +2,7 @@ CIE XYZ Tristimulus Values of the Hunter L,a,b Illuminants ========================================================== -Defines the *CIE XYZ* tristimulus values of the *Hunter L,a,b* illuminants +Define the *CIE XYZ* tristimulus values of the *Hunter L,a,b* illuminants dataset for the *CIE 1931 2 Degree Standard Observer* and *CIE 1964 10 Degree Standard Observer*. diff --git a/colour/colorimetry/datasets/illuminants/sds.py b/colour/colorimetry/datasets/illuminants/sds.py index 3afc36fac3..d2411561d5 100644 --- a/colour/colorimetry/datasets/illuminants/sds.py +++ b/colour/colorimetry/datasets/illuminants/sds.py @@ -2,7 +2,7 @@ Spectral Distributions of the Illuminants ========================================= -Defines the spectral distributions of the illuminants. +Define the spectral distributions of the illuminants. The illuminants data is in the form of a *dict* of :class:`colour.SpectralDistribution` classes as follows:: @@ -4895,9 +4895,7 @@ :cite:`InternationalOrganizationforStandardization2002` """ -SDS_ILLUMINANTS: LazyCanonicalMapping = LazyCanonicalMapping( - SDS_ILLUMINANTS_CIE -) +SDS_ILLUMINANTS: LazyCanonicalMapping = LazyCanonicalMapping(SDS_ILLUMINANTS_CIE) SDS_ILLUMINANTS.__doc__ = """ Spectral distributions of the illuminants. diff --git a/colour/colorimetry/datasets/illuminants/sds_d_illuminant_series.py b/colour/colorimetry/datasets/illuminants/sds_d_illuminant_series.py index 841c4dc970..d9631ac994 100644 --- a/colour/colorimetry/datasets/illuminants/sds_d_illuminant_series.py +++ b/colour/colorimetry/datasets/illuminants/sds_d_illuminant_series.py @@ -2,7 +2,7 @@ CIE Illuminant D Series :math:`S_n(\\lambda)` Distributions =========================================================== -Defines the *CIE Illuminant D Series* :math:`S_n(\\lambda)` distributions +Define the *CIE Illuminant D Series* :math:`S_n(\\lambda)` distributions involved in the computation of *CIE Illuminant D Series* spectral distributions. @@ -366,26 +366,26 @@ }, } -SDS_BASIS_FUNCTIONS_CIE_ILLUMINANT_D_SERIES: ( - LazyCanonicalMapping -) = LazyCanonicalMapping( - { - "S0": partial( - SpectralDistribution, - DATA_BASIS_FUNCTIONS_CIE_ILLUMINANT_D_SERIES["S0"], - name="S0", - ), - "S1": partial( - SpectralDistribution, - DATA_BASIS_FUNCTIONS_CIE_ILLUMINANT_D_SERIES["S1"], - name="S1", - ), - "S2": partial( - SpectralDistribution, - DATA_BASIS_FUNCTIONS_CIE_ILLUMINANT_D_SERIES["S2"], - name="S2", - ), - } +SDS_BASIS_FUNCTIONS_CIE_ILLUMINANT_D_SERIES: LazyCanonicalMapping = ( + LazyCanonicalMapping( + { + "S0": partial( + SpectralDistribution, + DATA_BASIS_FUNCTIONS_CIE_ILLUMINANT_D_SERIES["S0"], + name="S0", + ), + "S1": partial( + SpectralDistribution, + DATA_BASIS_FUNCTIONS_CIE_ILLUMINANT_D_SERIES["S1"], + name="S1", + ), + "S2": partial( + SpectralDistribution, + DATA_BASIS_FUNCTIONS_CIE_ILLUMINANT_D_SERIES["S2"], + name="S2", + ), + } + ) ) SDS_BASIS_FUNCTIONS_CIE_ILLUMINANT_D_SERIES.__doc__ = """ *CIE Illuminant D Series* :math:`S_n(\\lambda)` spectral distributions. diff --git a/colour/colorimetry/datasets/illuminants/tristimulus_values.py b/colour/colorimetry/datasets/illuminants/tristimulus_values.py index e197ccdbf3..c7b7ba2f1a 100644 --- a/colour/colorimetry/datasets/illuminants/tristimulus_values.py +++ b/colour/colorimetry/datasets/illuminants/tristimulus_values.py @@ -2,7 +2,7 @@ CIE XYZ Tristimulus Values of Illuminants ========================================= -Defines the *CIE XYZ* tristimulus values of the illuminants for the +Define the *CIE XYZ* tristimulus values of the illuminants for the *CIE 1931 2 Degree Standard Observer* and *CIE 1964 10 Degree Standard Observer*. @@ -49,17 +49,17 @@ "TVS_ILLUMINANTS", ] -TVS_ILLUMINANTS_CIE_STANDARD_OBSERVER_2_DEGREE_CIE1931: ( - CanonicalMapping -) = CanonicalMapping( - { - "A": np.array([109.85, 100.00, 35.58]), - "C": np.array([98.07, 100.00, 118.22]), - "D50": np.array([96.42, 100.00, 82.51]), - "D55": np.array([95.68, 100.00, 92.14]), - "D65": np.array([95.04, 100.00, 108.88]), - "D75": np.array([94.97, 100.00, 122.61]), - } +TVS_ILLUMINANTS_CIE_STANDARD_OBSERVER_2_DEGREE_CIE1931: CanonicalMapping = ( + CanonicalMapping( + { + "A": np.array([109.85, 100.00, 35.58]), + "C": np.array([98.07, 100.00, 118.22]), + "D50": np.array([96.42, 100.00, 82.51]), + "D55": np.array([95.68, 100.00, 92.14]), + "D65": np.array([95.04, 100.00, 108.88]), + "D75": np.array([94.97, 100.00, 122.61]), + } + ) ) """ *CIE XYZ* tristimulus values of the *CIE* illuminants for the @@ -70,17 +70,17 @@ :cite:`Carter2018` """ -TVS_ILLUMINANTS_CIE_STANDARD_OBSERVER_10_DEGREE_CIE1964: ( - CanonicalMapping -) = CanonicalMapping( - { - "A": np.array([111.14, 100.00, 35.20]), - "C": np.array([97.29, 100.00, 116.14]), - "D50": np.array([96.72, 100.00, 81.43]), - "D55": np.array([95.80, 100.00, 90.93]), - "D65": np.array([94.81, 100.00, 107.32]), - "D75": np.array([94.42, 100.00, 120.64]), - } +TVS_ILLUMINANTS_CIE_STANDARD_OBSERVER_10_DEGREE_CIE1964: CanonicalMapping = ( + CanonicalMapping( + { + "A": np.array([111.14, 100.00, 35.20]), + "C": np.array([97.29, 100.00, 116.14]), + "D50": np.array([96.72, 100.00, 81.43]), + "D55": np.array([95.80, 100.00, 90.93]), + "D65": np.array([94.81, 100.00, 107.32]), + "D75": np.array([94.42, 100.00, 120.64]), + } + ) ) """ *CIE XYZ* tristimulus values of the *CIE* illuminants for the @@ -116,9 +116,5 @@ - 'cie_2_1931': 'CIE 1931 2 Degree Standard Observer' - 'cie_10_1964': 'CIE 1964 10 Degree Standard Observer' """ -TVS_ILLUMINANTS["cie_2_1931"] = TVS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" -] -TVS_ILLUMINANTS["cie_10_1964"] = TVS_ILLUMINANTS[ - "CIE 1964 10 Degree Standard Observer" -] +TVS_ILLUMINANTS["cie_2_1931"] = TVS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"] +TVS_ILLUMINANTS["cie_10_1964"] = TVS_ILLUMINANTS["CIE 1964 10 Degree Standard Observer"] diff --git a/colour/colorimetry/datasets/lefs.py b/colour/colorimetry/datasets/lefs.py index 9548d6f042..8013984799 100644 --- a/colour/colorimetry/datasets/lefs.py +++ b/colour/colorimetry/datasets/lefs.py @@ -2,7 +2,7 @@ Spectral Distributions of the Luminous Efficiency Functions =========================================================== -Defines the spectral distributions of the luminous efficiency functions. +Define the spectral distributions of the luminous efficiency functions. The luminous efficiency data is in the form of a *dict* of :class:`colour.SpectralDistribution` classes as follows:: @@ -2354,39 +2354,29 @@ ), "Judd Modified CIE 1951 Photopic Standard Observer": partial( SpectralDistribution, - DATA_LEFS_PHOTOPIC[ - "Judd Modified CIE 1951 Photopic Standard Observer" - ], + DATA_LEFS_PHOTOPIC["Judd Modified CIE 1951 Photopic Standard Observer"], name="Judd Modified CIE 1951 Photopic Standard Observer", ), "Judd-Vos Modified CIE 1978 Photopic Standard Observer": partial( SpectralDistribution, - DATA_LEFS_PHOTOPIC[ - "Judd-Vos Modified CIE 1978 Photopic Standard Observer" - ], + DATA_LEFS_PHOTOPIC["Judd-Vos Modified CIE 1978 Photopic Standard Observer"], name="Judd-Vos Modified CIE 1978 Photopic Standard Observer", ), "CIE 1964 Photopic 10 Degree Standard Observer": partial( SpectralDistribution, - DATA_LEFS_PHOTOPIC[ - "CIE 1964 Photopic 10 Degree Standard Observer" - ], + DATA_LEFS_PHOTOPIC["CIE 1964 Photopic 10 Degree Standard Observer"], name="CIE 1964 Photopic 10 Degree Standard Observer", display_name="CIE 1964 Photopic 10$^\\circ$ Standard Observer", ), "CIE 2008 2 Degree Physiologically Relevant LEF": partial( SpectralDistribution, - DATA_LEFS_PHOTOPIC[ - "CIE 2008 2 Degree Physiologically Relevant LEF" - ], + DATA_LEFS_PHOTOPIC["CIE 2008 2 Degree Physiologically Relevant LEF"], name="CIE 2008 2 Degree Physiologically Relevant LEF", display_name="CIE 2008 2$^\\circ$ Physiologically Relevant LEF", ), "CIE 2008 10 Degree Physiologically Relevant LEF": partial( SpectralDistribution, - DATA_LEFS_PHOTOPIC[ - "CIE 2008 10 Degree Physiologically Relevant LEF" - ], + DATA_LEFS_PHOTOPIC["CIE 2008 10 Degree Physiologically Relevant LEF"], name="CIE 2008 10 Degree Physiologically Relevant LEF", display_name="CIE 2008 10$^\\circ$ Physiologically Relevant LEF", ), @@ -2837,9 +2827,7 @@ - 'cie_1951': 'CIE 1951 Scotopic Standard Observer' """ -SDS_LEFS_SCOTOPIC["cie_1951"] = SDS_LEFS_SCOTOPIC[ - "CIE 1951 Scotopic Standard Observer" -] +SDS_LEFS_SCOTOPIC["cie_1951"] = SDS_LEFS_SCOTOPIC["CIE 1951 Scotopic Standard Observer"] SDS_LEFS: LazyCanonicalMapping = LazyCanonicalMapping(SDS_LEFS_PHOTOPIC) SDS_LEFS.__doc__ = """ diff --git a/colour/colorimetry/datasets/light_sources/chromaticity_coordinates.py b/colour/colorimetry/datasets/light_sources/chromaticity_coordinates.py index 29f99116e5..bc13289b92 100644 --- a/colour/colorimetry/datasets/light_sources/chromaticity_coordinates.py +++ b/colour/colorimetry/datasets/light_sources/chromaticity_coordinates.py @@ -2,7 +2,7 @@ Chromaticity Coordinates of the Light Sources ============================================= -Defines the chromaticity coordinates of the light sources. +Define the chromaticity coordinates of the light sources. The following light sources are available: @@ -69,21 +69,19 @@ "CCS_LIGHT_SOURCES", ] -CCS_LIGHT_SOURCES_RIT_STANDARD_OBSERVER_2_DEGREE_CIE1931: ( - CanonicalMapping -) = CanonicalMapping( - { - "Natural": np.array([0.381585730647787, 0.359224138274067]), - "Philips TL-84": np.array([0.378413599970988, 0.379290254544090]), - "SA": np.array([0.447573030734154, 0.407438137156467]), - "SC": np.array([0.310056734303928, 0.316145704789204]), - "T8 Luxline Plus White": np.array( - [0.410492204086250, 0.388932529676840] - ), - "T8 Polylux 3000": np.array([0.431706082207185, 0.413877736072647]), - "T8 Polylux 4000": np.array([0.379219473139794, 0.384469085577631]), - "Thorn Kolor-rite": np.array([0.381919124282806, 0.374309261641251]), - } +CCS_LIGHT_SOURCES_RIT_STANDARD_OBSERVER_2_DEGREE_CIE1931: CanonicalMapping = ( + CanonicalMapping( + { + "Natural": np.array([0.381585730647787, 0.359224138274067]), + "Philips TL-84": np.array([0.378413599970988, 0.379290254544090]), + "SA": np.array([0.447573030734154, 0.407438137156467]), + "SC": np.array([0.310056734303928, 0.316145704789204]), + "T8 Luxline Plus White": np.array([0.410492204086250, 0.388932529676840]), + "T8 Polylux 3000": np.array([0.431706082207185, 0.413877736072647]), + "T8 Polylux 4000": np.array([0.379219473139794, 0.384469085577631]), + "Thorn Kolor-rite": np.array([0.381919124282806, 0.374309261641251]), + } + ) ) """ Chromaticity coordinates of the light sources from the *RIT* *PointerData.xls* @@ -100,21 +98,19 @@ :cite:`Pointer1980a` """ -CCS_LIGHT_SOURCES_RIT_STANDARD_OBSERVER_10_DEGREE_CIE1964: ( - CanonicalMapping -) = CanonicalMapping( - { - "Natural": np.array([0.384870991183035, 0.353869223366545]), - "Philips TL-84": np.array([0.383592002892950, 0.373922741815762]), - "SA": np.array([0.451176803594070, 0.405936046781591]), - "SC": np.array([0.310388637415649, 0.319050651220986]), - "T8 Luxline Plus White": np.array( - [0.416946978831203, 0.380991426462756] - ), - "T8 Polylux 3000": np.array([0.439038926288670, 0.404554330124715]), - "T8 Polylux 4000": np.array([0.385115161872875, 0.377800928395769]), - "Thorn Kolor-rite": np.array([0.385533929282467, 0.370840492090948]), - } +CCS_LIGHT_SOURCES_RIT_STANDARD_OBSERVER_10_DEGREE_CIE1964: CanonicalMapping = ( + CanonicalMapping( + { + "Natural": np.array([0.384870991183035, 0.353869223366545]), + "Philips TL-84": np.array([0.383592002892950, 0.373922741815762]), + "SA": np.array([0.451176803594070, 0.405936046781591]), + "SC": np.array([0.310388637415649, 0.319050651220986]), + "T8 Luxline Plus White": np.array([0.416946978831203, 0.380991426462756]), + "T8 Polylux 3000": np.array([0.439038926288670, 0.404554330124715]), + "T8 Polylux 4000": np.array([0.385115161872875, 0.377800928395769]), + "Thorn Kolor-rite": np.array([0.385533929282467, 0.370840492090948]), + } + ) ) """ Chromaticity coordinates of the light sources from the *RIT* *PointerData.xls* @@ -132,9 +128,7 @@ "LPS": np.array([0.575151311365165, 0.424232234924905]), "Mercury": np.array([0.392018457637112, 0.383777071984453]), "Metal Halide": np.array([0.372544558972793, 0.385603925927588]), - "Neodimium Incandescent": np.array( - [0.447398697052100, 0.395008601248268] - ), + "Neodimium Incandescent": np.array([0.447398697052100, 0.395008601248268]), "Super HPS": np.array([0.470061659271846, 0.406116584248741]), "Triphosphor FL": np.array([0.413163268257275, 0.396422053758680]), } @@ -160,9 +154,7 @@ "LPS": np.array([0.589960045887891, 0.410039954112109]), "Mercury": np.array([0.401266412873755, 0.364732538221183]), "Metal Halide": np.array([0.378786167751226, 0.377496928504661]), - "Neodimium Incandescent": np.array( - [0.447516717156694, 0.396734151368497] - ), + "Neodimium Incandescent": np.array([0.447516717156694, 0.396734151368497]), "Super HPS": np.array([0.473859567146135, 0.401381825309197]), "Triphosphor FL": np.array([0.418591963931736, 0.388947713332192]), } @@ -177,27 +169,15 @@ CanonicalMapping ) = CanonicalMapping( { - "3-LED-1 (457/540/605)": np.array( - [0.417057686949170, 0.396262457986602] - ), - "3-LED-2 (473/545/616)": np.array( - [0.417060475566006, 0.396268120523418] - ), + "3-LED-1 (457/540/605)": np.array([0.417057686949170, 0.396262457986602]), + "3-LED-2 (473/545/616)": np.array([0.417060475566006, 0.396268120523418]), "3-LED-2 Yellow": np.array([0.436563079184047, 0.443649619298676]), - "3-LED-3 (465/546/614)": np.array( - [0.380460502184482, 0.376772001481922] - ), - "3-LED-4 (455/547/623)": np.array( - [0.417067943691045, 0.396276280071757] - ), + "3-LED-3 (465/546/614)": np.array([0.380460502184482, 0.376772001481922]), + "3-LED-4 (455/547/623)": np.array([0.417067943691045, 0.396276280071757]), "4-LED No Yellow": np.array([0.417060589301332, 0.396268153712350]), "4-LED Yellow": np.array([0.417069637940463, 0.396276766014859]), - "4-LED-1 (461/526/576/624)": np.array( - [0.417067615440556, 0.396275056779587] - ), - "4-LED-2 (447/512/573/627)": np.array( - [0.417071570560054, 0.396278745130373] - ), + "4-LED-1 (461/526/576/624)": np.array([0.417067615440556, 0.396275056779587]), + "4-LED-2 (447/512/573/627)": np.array([0.417071570560054, 0.396278745130373]), "Luxeon WW 2880": np.array([0.459088527920913, 0.432916480607903]), "PHOS-1": np.array([0.436443167801164, 0.404616033549917]), "PHOS-2": np.array([0.452704462198571, 0.437584543052711]), @@ -216,27 +196,15 @@ CanonicalMapping ) = CanonicalMapping( { - "3-LED-1 (457/540/605)": np.array( - [0.425099988926548, 0.389451349911075] - ), - "3-LED-2 (473/545/616)": np.array( - [0.422222118774217, 0.401298495594226] - ), + "3-LED-1 (457/540/605)": np.array([0.425099988926548, 0.389451349911075]), + "3-LED-2 (473/545/616)": np.array([0.422222118774217, 0.401298495594226]), "3-LED-2 Yellow": np.array([0.446222216139125, 0.441646464276087]), - "3-LED-3 (465/546/614)": np.array( - [0.387470465801936, 0.376404716015666] - ), - "3-LED-4 (455/547/623)": np.array( - [0.422865464107041, 0.388772240171637] - ), + "3-LED-3 (465/546/614)": np.array([0.387470465801936, 0.376404716015666]), + "3-LED-4 (455/547/623)": np.array([0.422865464107041, 0.388772240171637]), "4-LED No Yellow": np.array([0.419807532952439, 0.399465294930377]), "4-LED Yellow": np.array([0.422720601750053, 0.390284663473479]), - "4-LED-1 (461/526/576/624)": np.array( - [0.423899783323037, 0.394170886226971] - ), - "4-LED-2 (447/512/573/627)": np.array( - [0.421571042053867, 0.394089741928601] - ), + "4-LED-1 (461/526/576/624)": np.array([0.423899783323037, 0.394170886226971]), + "4-LED-2 (447/512/573/627)": np.array([0.421571042053867, 0.394089741928601]), "Luxeon WW 2880": np.array([0.466639299623263, 0.430817417218051]), "PHOS-1": np.array([0.440120001281140, 0.403135783393416]), "PHOS-2": np.array([0.461487398870558, 0.436150294667024]), @@ -255,23 +223,13 @@ CanonicalMapping ) = CanonicalMapping( { - "60 A/W (Soft White)": np.array( - [0.450730217519680, 0.408046128945005] - ), + "60 A/W (Soft White)": np.array([0.450730217519680, 0.408046128945005]), "C100S54 (HPS)": np.array([0.529231515407657, 0.411370164988427]), "C100S54C (HPS)": np.array([0.502380414374839, 0.415877299905475]), - "F32T8/TL830 (Triphosphor)": np.array( - [0.443250764475753, 0.409523700296928] - ), - "F32T8/TL835 (Triphosphor)": np.array( - [0.407150274569933, 0.393172743482571] - ), - "F32T8/TL841 (Triphosphor)": np.array( - [0.385376686681605, 0.390370762102806] - ), - "F32T8/TL850 (Triphosphor)": np.array( - [0.343768910392287, 0.358447436104108] - ), + "F32T8/TL830 (Triphosphor)": np.array([0.443250764475753, 0.409523700296928]), + "F32T8/TL835 (Triphosphor)": np.array([0.407150274569933, 0.393172743482571]), + "F32T8/TL841 (Triphosphor)": np.array([0.385376686681605, 0.390370762102806]), + "F32T8/TL850 (Triphosphor)": np.array([0.343768910392287, 0.358447436104108]), "F32T8/TL865/PLUS (Triphosphor)": np.array( [0.316368879615201, 0.345320790143017] ), @@ -282,33 +240,17 @@ "F34T12WW/RS/EW (Warm White FL)": np.array( [0.438466967656789, 0.408635441565706] ), - "F40/C50 (Broadband FL)": np.array( - [0.345836574973021, 0.361724450389430] - ), - "F40/C75 (Broadband FL)": np.array( - [0.299966663385220, 0.316582165804824] - ), - "F40/CWX (Broadband FL)": np.array( - [0.375037045754214, 0.360543952129462] - ), - "F40/DX (Broadband FL)": np.array( - [0.311922310746537, 0.342802103417329] - ), - "F40/DXTP (Delux FL)": np.array( - [0.313066543826958, 0.342225714484412] - ), + "F40/C50 (Broadband FL)": np.array([0.345836574973021, 0.361724450389430]), + "F40/C75 (Broadband FL)": np.array([0.299966663385220, 0.316582165804824]), + "F40/CWX (Broadband FL)": np.array([0.375037045754214, 0.360543952129462]), + "F40/DX (Broadband FL)": np.array([0.311922310746537, 0.342802103417329]), + "F40/DXTP (Delux FL)": np.array([0.313066543826958, 0.342225714484412]), "F40/N (Natural FL)": np.array([0.376878697365115, 0.354153458302878]), - "H38HT-100 (Mercury)": np.array( - [0.311200590193641, 0.382944245857018] - ), - "H38JA-100/DX (Mercury DX)": np.array( - [0.389791630360359, 0.373394688931767] - ), + "H38HT-100 (Mercury)": np.array([0.311200590193641, 0.382944245857018]), + "H38JA-100/DX (Mercury DX)": np.array([0.389791630360359, 0.373394688931767]), "MHC100/U/MP/3K": np.array([0.428581768670222, 0.388168915678330]), "MHC100/U/MP/4K": np.array([0.373145253482762, 0.371366990216717]), - "SDW-T 100W/LV (Super HPS)": np.array( - [0.472339157938672, 0.407106330880316] - ), + "SDW-T 100W/LV (Super HPS)": np.array([0.472339157938672, 0.407106330880316]), } ) """ @@ -321,23 +263,13 @@ CanonicalMapping ) = CanonicalMapping( { - "60 A/W (Soft White)": np.array( - [0.454365604973572, 0.406573684216774] - ), + "60 A/W (Soft White)": np.array([0.454365604973572, 0.406573684216774]), "C100S54 (HPS)": np.array([0.538554605063010, 0.402575827972962]), "C100S54C (HPS)": np.array([0.509663059970892, 0.409064508209193]), - "F32T8/TL830 (Triphosphor)": np.array( - [0.448795219301811, 0.403574636091678] - ), - "F32T8/TL835 (Triphosphor)": np.array( - [0.412082534290652, 0.388001071127592] - ), - "F32T8/TL841 (Triphosphor)": np.array( - [0.390908619219527, 0.385290559992705] - ), - "F32T8/TL850 (Triphosphor)": np.array( - [0.347882431257452, 0.355845742210551] - ), + "F32T8/TL830 (Triphosphor)": np.array([0.448795219301811, 0.403574636091678]), + "F32T8/TL835 (Triphosphor)": np.array([0.412082534290652, 0.388001071127592]), + "F32T8/TL841 (Triphosphor)": np.array([0.390908619219527, 0.385290559992705]), + "F32T8/TL850 (Triphosphor)": np.array([0.347882431257452, 0.355845742210551]), "F32T8/TL865/PLUS (Triphosphor)": np.array( [0.320698199593768, 0.343871441043854] ), @@ -348,33 +280,17 @@ "F34T12WW/RS/EW (Warm White FL)": np.array( [0.448395377616960, 0.395666643335296] ), - "F40/C50 (Broadband FL)": np.array( - [0.349880827196884, 0.360661316491439] - ), - "F40/C75 (Broadband FL)": np.array( - [0.301988533872761, 0.318479025875818] - ), - "F40/CWX (Broadband FL)": np.array( - [0.378502309910296, 0.356371890168937] - ), - "F40/DX (Broadband FL)": np.array( - [0.316783037559153, 0.341749269085077] - ), - "F40/DXTP (Delux FL)": np.array( - [0.318774745065791, 0.339798825605488] - ), + "F40/C50 (Broadband FL)": np.array([0.349880827196884, 0.360661316491439]), + "F40/C75 (Broadband FL)": np.array([0.301988533872761, 0.318479025875818]), + "F40/CWX (Broadband FL)": np.array([0.378502309910296, 0.356371890168937]), + "F40/DX (Broadband FL)": np.array([0.316783037559153, 0.341749269085077]), + "F40/DXTP (Delux FL)": np.array([0.318774745065791, 0.339798825605488]), "F40/N (Natural FL)": np.array([0.378833157741751, 0.350724402658646]), - "H38HT-100 (Mercury)": np.array( - [0.326260627082484, 0.360001095895205] - ), - "H38JA-100/DX (Mercury DX)": np.array( - [0.397058597517533, 0.356532431806974] - ), + "H38HT-100 (Mercury)": np.array([0.326260627082484, 0.360001095895205]), + "H38JA-100/DX (Mercury DX)": np.array([0.397058597517533, 0.356532431806974]), "MHC100/U/MP/3K": np.array([0.431422986591898, 0.380642213887539]), "MHC100/U/MP/4K": np.array([0.375707105948115, 0.366156465779779]), - "SDW-T 100W/LV (Super HPS)": np.array( - [0.476461908192661, 0.402288012403575] - ), + "SDW-T 100W/LV (Super HPS)": np.array([0.476461908192661, 0.402288012403575]), } ) """ @@ -385,9 +301,7 @@ CCS_LIGHT_SOURCES_COMMON_STANDARD_OBSERVER_2_DEGREE_CIE1931: ( CanonicalMapping -) = CanonicalMapping( - {"Kinoton 75P": np.array([0.315252413629716, 0.332870794805328])} -) +) = CanonicalMapping({"Kinoton 75P": np.array([0.315252413629716, 0.332870794805328])}) """ Chromaticity coordinates of the common light sources for the *CIE 1931 2 Degree Standard Observer*. @@ -399,9 +313,7 @@ CCS_LIGHT_SOURCES_COMMON_STANDARD_OBSERVER_10_DEGREE_CIE1964: ( CanonicalMapping -) = CanonicalMapping( - {"Kinoton 75P": np.array([0.317086642148234, 0.336222428041514])} -) +) = CanonicalMapping({"Kinoton 75P": np.array([0.317086642148234, 0.336222428041514])}) """ Chromaticity coordinates of the common light sources for the *CIE 1964 10 Degree Standard Observer*. diff --git a/colour/colorimetry/datasets/light_sources/sds.py b/colour/colorimetry/datasets/light_sources/sds.py index cd1534b17c..5dae3c359e 100644 --- a/colour/colorimetry/datasets/light_sources/sds.py +++ b/colour/colorimetry/datasets/light_sources/sds.py @@ -2,7 +2,7 @@ Spectral Distributions of the Light Sources =========================================== -Defines the spectral distributions of the light sources. +Define the spectral distributions of the light sources. The light sources data is in the form of a *dict* of :class:`colour.SpectralDistribution` classes as follows:: @@ -744,7 +744,7 @@ }, } -SDS_LIGHT_SOURCES_RIT: (LazyCanonicalMapping) = LazyCanonicalMapping( +SDS_LIGHT_SOURCES_RIT: LazyCanonicalMapping = LazyCanonicalMapping( ( key, partial( @@ -1604,9 +1604,7 @@ }, } -SDS_LIGHT_SOURCES_NIST_TRADITIONAL: ( - LazyCanonicalMapping -) = LazyCanonicalMapping( +SDS_LIGHT_SOURCES_NIST_TRADITIONAL: LazyCanonicalMapping = LazyCanonicalMapping( ( key, partial( @@ -2875,7 +2873,7 @@ }, } -SDS_LIGHT_SOURCES_NIST_LED: (LazyCanonicalMapping) = LazyCanonicalMapping( +SDS_LIGHT_SOURCES_NIST_LED: LazyCanonicalMapping = LazyCanonicalMapping( ( key, partial( @@ -4721,7 +4719,7 @@ }, } -SDS_LIGHT_SOURCES_NIST_PHILIPS: (LazyCanonicalMapping) = LazyCanonicalMapping( +SDS_LIGHT_SOURCES_NIST_PHILIPS: LazyCanonicalMapping = LazyCanonicalMapping( ( key, partial( @@ -4944,7 +4942,7 @@ } } -SDS_LIGHT_SOURCES_COMMON: (LazyCanonicalMapping) = LazyCanonicalMapping( +SDS_LIGHT_SOURCES_COMMON: LazyCanonicalMapping = LazyCanonicalMapping( { "Kinoton 75P": partial( SpectralDistribution, @@ -4962,9 +4960,7 @@ :cite:`Houston2015a` """ -SDS_LIGHT_SOURCES: (LazyCanonicalMapping) = LazyCanonicalMapping( - SDS_LIGHT_SOURCES_RIT -) +SDS_LIGHT_SOURCES: LazyCanonicalMapping = LazyCanonicalMapping(SDS_LIGHT_SOURCES_RIT) SDS_LIGHT_SOURCES.__doc__ = """ Spectral distributions of the light sources. diff --git a/colour/colorimetry/dominant.py b/colour/colorimetry/dominant.py index 34abac7527..ab2d9b83b3 100644 --- a/colour/colorimetry/dominant.py +++ b/colour/colorimetry/dominant.py @@ -2,7 +2,7 @@ Dominant Wavelength and Purity ============================== -Defines the objects to compute the *dominant wavelength* and *purity* of a +Define the objects to compute the *dominant wavelength* and *purity* of a colour and related quantities: - :func:`colour.dominant_wavelength` @@ -109,11 +109,7 @@ def closest_spectral_locus_wavelength( xy_n = np.resize(xy_n, xy.shape) xy_s = as_float_array(xy_s) - xy_e = ( - extend_line_segment(xy, xy_n) - if inverse - else extend_line_segment(xy_n, xy) - ) + xy_e = extend_line_segment(xy, xy_n) if inverse else extend_line_segment(xy_n, xy) # Closing horse-shoe shape to handle line of purples intersections. xy_s = np.vstack([xy_s, xy_s[0, :]]) @@ -213,19 +209,13 @@ def dominant_wavelength( xy_cwl = xy_wl wl = cmfs.wavelengths[i_wl] - xy_e = ( - extend_line_segment(xy, xy_n) - if inverse - else extend_line_segment(xy_n, xy) - ) + xy_e = extend_line_segment(xy, xy_n) if inverse else extend_line_segment(xy_n, xy) intersect = intersect_line_segments( np.concatenate((xy_n, xy_e), -1), np.hstack([xy_s[0], xy_s[-1]]) ).intersect intersect = np.reshape(intersect, wl.shape) - i_wl_r, xy_cwl_r = closest_spectral_locus_wavelength( - xy, xy_n, xy_s, not inverse - ) + i_wl_r, xy_cwl_r = closest_spectral_locus_wavelength(xy, xy_n, xy_s, not inverse) wl_r = -cmfs.wavelengths[i_wl_r] wl = np.where(intersect, wl_r, wl) diff --git a/colour/colorimetry/generation.py b/colour/colorimetry/generation.py index 608e9949c3..114a756d98 100644 --- a/colour/colorimetry/generation.py +++ b/colour/colorimetry/generation.py @@ -2,7 +2,7 @@ Spectral Generation =================== -Defines various objects performing spectral generation: +Define various objects performing spectral generation: - :func:`colour.sd_constant` - :func:`colour.sd_zeros` @@ -267,9 +267,7 @@ def msds_constant( wavelengths = shape.wavelengths values = full((len(wavelengths), len(labels)), k) - return MultiSpectralDistributions( - values, wavelengths, labels=labels, **settings - ) + return MultiSpectralDistributions(values, wavelengths, labels=labels, **settings) def msds_zeros( @@ -438,7 +436,7 @@ def sd_gaussian_fwhm( peak_wavelength Wavelength the gaussian spectral distribution will peak at. fwhm - Full width at half maximum, i.e. width of the gaussian spectral + Full width at half maximum, i.e., width of the gaussian spectral distribution measured between those points on the *y* axis which are half the maximum amplitude. shape @@ -467,8 +465,8 @@ def sd_gaussian_fwhm( SpectralShape(360.0, 780.0, 1.0) >>> sd[555] # doctest: +SKIP 1.0 - >>> sd[530] - 0.0625 + >>> sd[530] # doctest: +ELLIPSIS + 0.062... """ settings = {"name": f"{peak_wavelength}nm - {fwhm} FWHM - Gaussian"} @@ -506,7 +504,7 @@ def sd_gaussian( peak at. sigma_fwhm Standard deviation :math:`sigma` of the gaussian spectral distribution - or full width at half maximum, i.e. width of the gaussian spectral + or full width at half maximum, i.e., width of the gaussian spectral distribution measured between those points on the *y* axis which are half the maximum amplitude. shape @@ -545,15 +543,13 @@ def sd_gaussian( SpectralShape(360.0, 780.0, 1.0) >>> sd[555] # doctest: +SKIP 1.0 - >>> sd[530] - 0.0625 + >>> sd[530] # doctest: +ELLIPSIS + 0.062... """ method = validate_method(method, tuple(SD_GAUSSIAN_METHODS)) - return SD_GAUSSIAN_METHODS[method]( - mu_peak_wavelength, sigma_fwhm, shape, **kwargs - ) + return SD_GAUSSIAN_METHODS[method](mu_peak_wavelength, sigma_fwhm, shape, **kwargs) def sd_single_led_Ohno2005( @@ -702,7 +698,7 @@ def sd_multi_leds_Ohno2005( Parameters ---------- peak_wavelengths - Wavelengths the multi *LED* spectral distribution will peak at, i.e. + Wavelengths the multi *LED* spectral distribution will peak at, i.e., the peaks for each generated single *LED* spectral distributions. half_spectral_widths Half spectral widths :math:`\\Delta\\lambda_{0.5}`. @@ -746,15 +742,11 @@ def sd_multi_leds_Ohno2005( """ peak_wavelengths = as_float_array(peak_wavelengths) - half_spectral_widths = np.resize( - half_spectral_widths, peak_wavelengths.shape - ) + half_spectral_widths = np.resize(half_spectral_widths, peak_wavelengths.shape) if peak_power_ratios is None: peak_power_ratios = ones(peak_wavelengths.shape) else: - peak_power_ratios = np.resize( - peak_power_ratios, peak_wavelengths.shape - ) + peak_power_ratios = np.resize(peak_power_ratios, peak_wavelengths.shape) sd = sd_zeros(shape) @@ -762,9 +754,7 @@ def sd_multi_leds_Ohno2005( peak_wavelengths, half_spectral_widths, peak_power_ratios ): sd += ( - sd_single_led_Ohno2005( - peak_wavelength, half_spectral_width, **kwargs - ) + sd_single_led_Ohno2005(peak_wavelength, half_spectral_width, **kwargs) * peak_power_ratio ) @@ -806,7 +796,7 @@ def sd_multi_leds( Parameters ---------- peak_wavelengths - Wavelengths the multi *LED* spectral distribution will peak at, i.e. + Wavelengths the multi *LED* spectral distribution will peak at, i.e., the peaks for each generated single *LED* spectral distributions. shape Spectral shape used to create the spectral distribution. diff --git a/colour/colorimetry/illuminants.py b/colour/colorimetry/illuminants.py index ff5743147d..3c10909776 100644 --- a/colour/colorimetry/illuminants.py +++ b/colour/colorimetry/illuminants.py @@ -2,7 +2,7 @@ Illuminants =========== -Defines the *CIE* illuminants computation related objects: +Define the *CIE* illuminants computation related objects: - :func:`colour.sd_CIE_standard_illuminant_A` - :func:`colour.sd_CIE_illuminant_D_series` @@ -182,7 +182,6 @@ def sd_CIE_illuminant_D_series( >>> xy = CCT_to_xy_CIE_D(CCT_D65) >>> with numpy_print_options(suppress=True): ... sd_CIE_illuminant_D_series(xy) # doctest: +ELLIPSIS - ... SpectralDistribution([[ 300. , 0.0341...], [ 305. , 1.6643...], [ 310. , 3.2945...], diff --git a/colour/colorimetry/lefs.py b/colour/colorimetry/lefs.py index 00547b9ef1..322759c50e 100644 --- a/colour/colorimetry/lefs.py +++ b/colour/colorimetry/lefs.py @@ -2,7 +2,7 @@ Luminous Efficiency Functions Spectral Distributions ==================================================== -Defines the luminous efficiency functions computation related objects. +Define the luminous efficiency functions computation related objects. References ---------- @@ -78,7 +78,7 @@ def mesopic_weighting_function( Examples -------- >>> mesopic_weighting_function(500, 0.2) # doctest: +ELLIPSIS - 0.7052200... + 0.7052... """ photopic_lef = optional( @@ -94,15 +94,12 @@ def mesopic_weighting_function( source = validate_method( source, ("Blue Heavy", "Red Heavy"), - '"{0}" light source colour temperature is invalid, ' - "it must be one of {1}!", + '"{0}" light source colour temperature is invalid, it must be one of {1}!', ) method = validate_method(method, ("MOVE", "LRC")) mesopic_x_luminance_values = sorted(DATA_MESOPIC_X.keys()) - index = mesopic_x_luminance_values.index( - closest(mesopic_x_luminance_values, L_p) - ) + index = mesopic_x_luminance_values.index(closest(mesopic_x_luminance_values, L_p)) x = DATA_MESOPIC_X[mesopic_x_luminance_values[index]][source][method] V_m = (1 - x) * scotopic_lef[wavelength] + x * photopic_lef[wavelength] @@ -150,7 +147,6 @@ def sd_mesopic_luminous_efficiency_function( >>> from colour.utilities import numpy_print_options >>> with numpy_print_options(suppress=True): ... sd_mesopic_luminous_efficiency_function(0.2) # doctest: +ELLIPSIS - ... SpectralDistribution([[ 380. , 0.000424 ...], [ 381. , 0.0004781...], [ 382. , 0.0005399...], diff --git a/colour/colorimetry/lightness.py b/colour/colorimetry/lightness.py index a2bbf50bc9..b5cc523a09 100644 --- a/colour/colorimetry/lightness.py +++ b/colour/colorimetry/lightness.py @@ -2,7 +2,7 @@ Lightness :math:`L` =================== -Defines the *Lightness* :math:`L` computation objects. +Define the *Lightness* :math:`L` computation objects. The following methods are available: @@ -307,16 +307,14 @@ def lightness_CIE1976(Y: ArrayLike, Y_n: ArrayLike = 100) -> NDArrayFloat: """ Y = to_domain_100(Y) - Y_n = as_float_array(Y_n) + Y_n = to_domain_100(Y_n) L_star = 116 * intermediate_lightness_function_CIE1976(Y, Y_n) - 16 return as_float(from_range_100(L_star)) -def lightness_Fairchild2010( - Y: ArrayLike, epsilon: ArrayLike = 1.836 -) -> NDArrayFloat: +def lightness_Fairchild2010(Y: ArrayLike, epsilon: ArrayLike = 1.836) -> NDArrayFloat: """ Compute *Lightness* :math:`L_{hdr}` of given *luminance* :math:`Y` using *Fairchild and Wyble (2010)* method according to *Michaelis-Menten* @@ -548,15 +546,17 @@ def lightness_Abebe2017( def lightness( Y: ArrayLike, - method: Literal[ - "Abebe 2017", - "CIE 1976", - "Glasser 1958", - "Fairchild 2010", - "Fairchild 2011", - "Wyszecki 1963", - ] - | str = "CIE 1976", + method: ( + Literal[ + "Abebe 2017", + "CIE 1976", + "Glasser 1958", + "Fairchild 2010", + "Fairchild 2011", + "Wyszecki 1963", + ] + | str + ) = "CIE 1976", **kwargs: Any, ) -> NDArrayFloat: """ @@ -649,12 +649,11 @@ def lightness( if function in domain_undefined and domain_range_1: Y = Y * 100 + kwargs["Y_n"] = kwargs.get("Y_n", 100) * 100 L = function(Y, **filter_kwargs(function, **kwargs)) - if function in domain_undefined and ( - domain_range_reference or domain_range_100 - ): + if function in domain_undefined and (domain_range_reference or domain_range_100): L *= 100 return L diff --git a/colour/colorimetry/luminance.py b/colour/colorimetry/luminance.py index 84d165ce68..87f8fb91ef 100644 --- a/colour/colorimetry/luminance.py +++ b/colour/colorimetry/luminance.py @@ -2,7 +2,7 @@ Luminance :math:`Y` =================== -Defines the *luminance* :math:`Y` computation objects. +Define the *luminance* :math:`Y` computation objects. The following methods are available: @@ -312,7 +312,7 @@ def luminance_CIE1976(L_star: ArrayLike, Y_n: ArrayLike = 100) -> NDArrayFloat: """ L_star = to_domain_100(L_star) - Y_n = as_float_array(Y_n) + Y_n = to_domain_100(Y_n) f_Y_Y_n = (L_star + 16) / 116 @@ -566,15 +566,17 @@ def luminance_Abebe2017( def luminance( LV: ArrayLike, - method: Literal[ - "Abebe 2017", - "CIE 1976", - "Glasser 1958", - "Fairchild 2010", - "Fairchild 2011", - "Wyszecki 1963", - ] - | str = "CIE 1976", + method: ( + Literal[ + "Abebe 2017", + "CIE 1976", + "Glasser 1958", + "Fairchild 2010", + "Fairchild 2011", + "Wyszecki 1963", + ] + | str + ) = "CIE 1976", **kwargs: Any, ) -> NDArrayFloat: """ @@ -663,6 +665,7 @@ def luminance( if function in domain_undefined and domain_range_1: LV = LV * 100 + kwargs["Y_n"] = kwargs.get("Y_n", 100) * 100 Y_V = function(LV, **filter_kwargs(function, **kwargs)) diff --git a/colour/colorimetry/photometry.py b/colour/colorimetry/photometry.py index 9136451398..e90c369c66 100644 --- a/colour/colorimetry/photometry.py +++ b/colour/colorimetry/photometry.py @@ -2,7 +2,7 @@ Photometry ========== -Defines the photometric quantities computation related objects. +Define the photometric quantities computation related objects. References ---------- @@ -75,9 +75,7 @@ def luminous_flux( 23807.6555273... """ - lef = optional( - lef, SDS_LEFS_PHOTOPIC["CIE 1924 Photopic Standard Observer"] - ) + lef = optional(lef, SDS_LEFS_PHOTOPIC["CIE 1924 Photopic Standard Observer"]) lef = reshape_sd( lef, @@ -86,7 +84,7 @@ def luminous_flux( extrapolator_kwargs={"method": "Constant", "left": 0, "right": 0}, ) - flux = K_m * np.trapz(lef.values * sd.values, sd.wavelengths) + flux = K_m * np.trapezoid(lef.values * sd.values, sd.wavelengths) # pyright: ignore return as_float_scalar(flux) @@ -123,9 +121,7 @@ def luminous_efficiency( 0.1994393... """ - lef = optional( - lef, SDS_LEFS_PHOTOPIC["CIE 1924 Photopic Standard Observer"] - ) + lef = optional(lef, SDS_LEFS_PHOTOPIC["CIE 1924 Photopic Standard Observer"]) lef = reshape_sd( lef, @@ -134,7 +130,9 @@ def luminous_efficiency( extrapolator_kwargs={"method": "Constant", "left": 0, "right": 0}, ) - efficiency = np.trapz(lef.values * sd.values, sd.wavelengths) / np.trapz( + efficiency = np.trapezoid( # pyright: ignore + lef.values * sd.values, sd.wavelengths + ) / np.trapezoid( # pyright: ignore sd.values, sd.wavelengths ) diff --git a/colour/colorimetry/spectrum.py b/colour/colorimetry/spectrum.py index 4a77b92fb9..e217b7dde0 100644 --- a/colour/colorimetry/spectrum.py +++ b/colour/colorimetry/spectrum.py @@ -2,7 +2,7 @@ Spectrum ======== -Defines the classes and objects handling spectral data computations: +Define the classes and objects handling spectral data computations: - :class:`colour.SPECTRAL_SHAPE_DEFAULT` - :class:`colour.SpectralShape` @@ -70,15 +70,12 @@ is_iterable, is_numeric, is_pandas_installed, - is_string, is_uniform, optional, runtime_warning, tstack, - usage_warning, validate_method, ) -from colour.utilities.deprecation import ObjectRenamed if TYPE_CHECKING or is_pandas_installed(): from pandas import DataFrame, Series # pragma: no cover @@ -152,8 +149,8 @@ class SpectralShape: """ def __init__(self, start: Real, end: Real, interval: Real) -> None: - self._start: Real = 360 - self._end: Real = 780 + self._start: Real = 0 + self._end: Real = np.inf self._interval: Real = 1 self.start = start self.end = end @@ -188,8 +185,7 @@ def start(self, value: Real): attest( bool(value < self._end), - f'"start" attribute value must be strictly less than ' - f'"{self._end}"!', + f'"start" attribute value must be strictly less than "{self._end}"!', ) self._start = value @@ -223,8 +219,7 @@ def end(self, value: Real): attest( bool(value > self._start), - f'"end" attribute value must be strictly greater than ' - f'"{self._start}"!', + f'"end" attribute value must be strictly greater than "{self._start}"!', ) self._end = value @@ -284,8 +279,7 @@ def boundaries(self, value: ArrayLike): attest( value.size == 2, - f'"boundaries" property: "{value}" must have exactly two ' - f"elements!", + f'"boundaries" property: "{value}" must have exactly two elements!', ) self.start, self.end = value @@ -353,7 +347,6 @@ def __iter__(self) -> Generator: >>> shape = SpectralShape(0, 10, 1) >>> for wavelength in shape: ... print(wavelength) - ... 0.0 1.0 2.0 @@ -403,7 +396,7 @@ def __contains__(self, wavelength: ArrayLike) -> bool: return bool( np.all( - np.in1d( + np.isin( # pyright: ignore np.around( wavelength, # pyright: ignore decimals, @@ -484,9 +477,7 @@ def __ne__(self, other: Any) -> bool: return not (self == other) - def range( # noqa: A003 - self, dtype: Type[DTypeFloat] | None = None - ) -> NDArrayFloat: + def range(self, dtype: Type[DTypeFloat] | None = None) -> NDArrayFloat: """ Return an iterable range for the spectral shape. @@ -635,7 +626,6 @@ class SpectralDistribution(Signal): ... } >>> with numpy_print_options(suppress=True): ... SpectralDistribution(data) # doctest: +ELLIPSIS - ... SpectralDistribution([[ 500. , 0.0651], [ 520. , 0.0705], [ 540. , 0.0772], @@ -653,7 +643,6 @@ class SpectralDistribution(Signal): >>> data[510] = 0.31416 >>> with numpy_print_options(suppress=True): ... SpectralDistribution(data) # doctest: +ELLIPSIS - ... SpectralDistribution([[ 500. , 0.0651 ], [ 510. , 0.31416], [ 520. , 0.0705 ], @@ -673,7 +662,6 @@ class SpectralDistribution(Signal): ... from pandas import Series ... ... print(SpectralDistribution(Series(data))) # doctest: +SKIP - ... [[ 5.0000000...e+02 6.5100000...e-02] [ 5.2000000...e+02 7.0500000...e-02] [ 5.4000000...e+02 7.7200000...e-02] @@ -689,9 +677,7 @@ def __init__( domain: ArrayLike | SpectralShape | None = None, **kwargs: Any, ) -> None: - domain = ( - domain.wavelengths if isinstance(domain, SpectralShape) else domain - ) + domain = domain.wavelengths if isinstance(domain, SpectralShape) else domain domain_unpacked, range_unpacked = self.signal_unpack_data(data, domain) @@ -699,9 +685,11 @@ def __init__( # defaults. kwargs["interpolator"] = kwargs.get( "interpolator", - SpragueInterpolator - if domain_unpacked.size != 0 and is_uniform(domain_unpacked) - else CubicSplineInterpolator, + ( + SpragueInterpolator + if domain_unpacked.size != 0 and is_uniform(domain_unpacked) + else CubicSplineInterpolator + ), ) kwargs["interpolator_kwargs"] = kwargs.get("interpolator_kwargs", {}) @@ -717,9 +705,7 @@ def __init__( self._shape: SpectralShape | None = None - self.register_callback( - "_domain", "on_domain_changed", self._on_domain_changed - ) + self.register_callback("_domain", "on_domain_changed", self._on_domain_changed) @staticmethod def _on_domain_changed(sd, name: str, value: NDArrayFloat) -> NDArrayFloat: @@ -752,7 +738,7 @@ def display_name(self, value: str): """Setter for the **self.display_name** property.""" attest( - is_string(value), + isinstance(value, str), f'"display_name" property: "{value}" type is not "str"!', ) @@ -953,7 +939,6 @@ def interpolate( >>> with numpy_print_options(suppress=True): ... print(sd.interpolate(SpectralShape(500, 600, 1))) ... # doctest: +ELLIPSIS - ... [[ 500. 0.0651 ...] [ 501. 0.0653522...] [ 502. 0.0656105...] @@ -1064,7 +1049,6 @@ def interpolate( >>> with numpy_print_options(suppress=True): ... print(sd.interpolate(SpectralShape(500, 600, 1))) ... # doctest: +ELLIPSIS - ... [[ 500. 0.0651 ...] [ 501. 0.1365202...] [ 502. 0.1953263...] @@ -1188,13 +1172,8 @@ def interpolate( # Defining proper interpolation bounds. # TODO: Provide support for fractional interval like 0.1, etc... - if ( - np.around(shape_start) != shape_start - or np.around(shape_end) != shape_end - ): - runtime_warning( - "Fractional bound encountered, rounding will occur!" - ) + if np.around(shape_start) != shape_start or np.around(shape_end) != shape_end: + runtime_warning("Fractional bound encountered, rounding will occur!") shape.start = max([shape.start, np.ceil(shape_start)]) shape.end = min([shape.end, np.floor(shape_end)]) @@ -1277,7 +1256,6 @@ def extrapolate( SpectralShape(400.0, 700.0, 20.0) >>> with numpy_print_options(suppress=True): ... print(sd) - ... [[ 400. 0.0651] [ 420. 0.0651] [ 440. 0.0651] @@ -1307,8 +1285,7 @@ def extrapolate( wavelengths = np.hstack( [ np.arange(shape.start, shape_start, shape_interval), - np.arange(shape_end, shape.end, shape_interval) - + shape_interval, + np.arange(shape_end, shape.end, shape_interval) + shape_interval, ] ) @@ -1410,7 +1387,6 @@ def align( >>> with numpy_print_options(suppress=True): ... print(sd.align(SpectralShape(505, 565, 1))) ... # doctest: +ELLIPSIS - ... [[ 505. 0.0663929...] [ 506. 0.0666509...] [ 507. 0.0669069...] @@ -1509,7 +1485,6 @@ def trim(self, shape: SpectralShape) -> Self: >>> with numpy_print_options(suppress=True): ... print(sd.trim(SpectralShape(520, 580, 5))) ... # doctest: +ELLIPSIS - ... [[ 520. 0.0705 ...] [ 521. 0.0708155...] [ 522. 0.0711336...] @@ -1576,9 +1551,7 @@ def trim(self, shape: SpectralShape) -> Self: start = max([shape.start, self.shape.start]) end = min([shape.end, self.shape.end]) - indexes = np.where( - np.logical_and(self.domain >= start, self.domain <= end) - ) + indexes = np.where(np.logical_and(self.domain >= start, self.domain <= end)) wavelengths = self.wavelengths[indexes] values = self.values[indexes] @@ -1621,7 +1594,6 @@ def normalise(self, factor: Real = 1) -> Self: >>> sd = SpectralDistribution(data) >>> with numpy_print_options(suppress=True): ... print(sd.normalise()) # doctest: +ELLIPSIS - ... [[ 500. 0.4786764...] [ 520. 0.5183823...] [ 540. 0.5676470...] @@ -1635,37 +1607,6 @@ def normalise(self, factor: Real = 1) -> Self: return self - # ------------------------------------------------------------------------# - # --- API Changes and Deprecation Management ---# - # ------------------------------------------------------------------------# - @property - def strict_name(self): # pragma: no cover # noqa: D102 - # Docstrings are omitted for documentation purposes. - usage_warning( - str( - ObjectRenamed( - "SpectralDistribution.strict_name", - "SpectralDistribution.display_name", - ) - ) - ) - - return self.display_name - - @strict_name.setter - def strict_name(self, value): # pragma: no cover - # Docstrings are omitted for documentation purposes. - usage_warning( - str( - ObjectRenamed( - "SpectralDistribution.strict_name", - "SpectralDistribution.display_name", - ) - ) - ) - - self.display_name = value - class MultiSpectralDistributions(MultiSignals): """ @@ -1839,32 +1780,26 @@ class instances :attr:`colour.continuous.Signal.wavelengths` attribute def __init__( self, - data: ArrayLike - | DataFrame - | dict - | MultiSignals - | Sequence - | Series - | Signal - | SpectralDistribution - | None = None, + data: ( + ArrayLike + | DataFrame + | dict + | MultiSignals + | Sequence + | Series + | Signal + | SpectralDistribution + | None + ) = None, domain: ArrayLike | SpectralShape | None = None, labels: Sequence | None = None, **kwargs: Any, ) -> None: - domain = ( - domain.wavelengths if isinstance(domain, SpectralShape) else domain - ) + domain = domain.wavelengths if isinstance(domain, SpectralShape) else domain signals = self.multi_signals_unpack_data(data, domain, labels) - domain = ( - signals[next(iter(signals.keys()))].domain if signals else None - ) - uniform = ( - is_uniform(domain) - if domain is not None and len(domain) > 0 - else True - ) + domain = signals[next(iter(signals.keys()))].domain if signals else None + uniform = is_uniform(domain) if domain is not None and len(domain) > 0 else True # Initialising with *CIE 15:2004* and *CIE 167:2005* recommendations # defaults. @@ -1880,16 +1815,12 @@ def __init__( {"method": "Constant", "left": None, "right": None}, ) - super().__init__( - signals, domain, signal_type=SpectralDistribution, **kwargs - ) + super().__init__(signals, domain, signal_type=SpectralDistribution, **kwargs) self._display_name: str = self.name self.display_name = kwargs.get("display_name", self._display_name) self._display_labels: list = list(self.signals.keys()) - self.display_labels = kwargs.get( - "display_labels", self._display_labels - ) + self.display_labels = kwargs.get("display_labels", self._display_labels) @property def display_name(self) -> str: @@ -1915,7 +1846,7 @@ def display_name(self, value: str): """Setter for the **self.display_name** property.""" attest( - is_string(value), + isinstance(value, str), f'"display_name" property: "{value}" type is not "str"!', ) @@ -1962,9 +1893,7 @@ def display_labels(self, value: Sequence): self._display_labels = [str(label) for label in value] for i, signal in enumerate(self.signals.values()): - cast( - SpectralDistribution, signal - ).display_name = self._display_labels[i] + cast(SpectralDistribution, signal).display_name = self._display_labels[i] @property def wavelengths(self) -> NDArrayFloat: @@ -2148,7 +2077,6 @@ def interpolate( >>> with numpy_print_options(suppress=True): ... print(msds.interpolate(SpectralShape(500, 560, 1))) ... # doctest: +ELLIPSIS - ... [[ 500. 0.0049 ... 0.323 ... 0.272 ...] [ 501. 0.0043252... 0.3400642... 0.2599848...] [ 502. 0.0037950... 0.3572165... 0.2479849...] @@ -2219,7 +2147,6 @@ def interpolate( >>> with numpy_print_options(suppress=True): ... print(msds.interpolate(SpectralShape(500, 560, 1))) ... # doctest: +ELLIPSIS - ... [[ 500. 0.0049 ... 0.323 ... 0.272 ...] [ 501. 0.0300110... 0.9455153... 0.5985102...] [ 502. 0.0462136... 1.3563103... 0.8066498...] @@ -2336,7 +2263,6 @@ def extrapolate( SpectralShape(400.0, 700.0, 10.0) >>> with numpy_print_options(suppress=True): ... print(msds) - ... [[ 400. 0.0049 0.323 0.272 ] [ 410. 0.0049 0.323 0.272 ] [ 420. 0.0049 0.323 0.272 ] @@ -2455,7 +2381,6 @@ def align( >>> with numpy_print_options(suppress=True): ... print(msds.align(SpectralShape(505, 565, 1))) ... # doctest: +ELLIPSIS - ... [[ 505. 0.0031582... 0.4091067... 0.2126801...] [ 506. 0.0035019... 0.4268629... 0.2012748...] [ 507. 0.0042365... 0.4450668... 0.1900968...] @@ -2561,7 +2486,6 @@ def trim(self, shape: SpectralShape) -> Self: >>> with numpy_print_options(suppress=True): ... print(msds.trim(SpectralShape(520, 580, 5))) ... # doctest: +ELLIPSIS - ... [[ 520. 0.06327 ... 0.71 ... 0.07825 ...] [ 521. 0.0715642... 0.7283456... 0.0728614...] [ 522. 0.0803970... 0.7459679... 0.0680051...] @@ -2645,7 +2569,6 @@ def normalise(self, factor: Real = 1) -> Self: >>> msds = MultiSpectralDistributions(data) >>> with numpy_print_options(suppress=True): ... print(msds.normalise()) # doctest: +ELLIPSIS - ... [[ 500. 0.0082422... 0.3246231... 1. ...] [ 510. 0.0156434... 0.5055276... 0.5816176...] [ 520. 0.1064255... 0.7135678... 0.2876838...] @@ -2686,7 +2609,6 @@ def to_sds(self) -> List[SpectralDistribution]: >>> with numpy_print_options(suppress=True): ... for sd in msds.to_sds(): ... print(sd) # doctest: +ELLIPSIS - ... [[ 500. 0.0049 ...] [ 510. 0.0093 ...] [ 520. 0.06327...] @@ -2715,65 +2637,6 @@ def to_sds(self) -> List[SpectralDistribution]: for signal in self.signals.values() ] - # ------------------------------------------------------------------------# - # --- API Changes and Deprecation Management ---# - # ------------------------------------------------------------------------# - @property - def strict_name(self): # pragma: no cover # noqa: D102 - # Docstrings are omitted for documentation purposes. - usage_warning( - str( - ObjectRenamed( - "MultiSpectralDistributions.strict_name", - "MultiSpectralDistributions.display_name", - ) - ) - ) - - return self.display_name - - @strict_name.setter - def strict_name(self, value): # pragma: no cover - # Docstrings are omitted for documentation purposes. - usage_warning( - str( - ObjectRenamed( - "MultiSpectralDistributions.strict_name", - "MultiSpectralDistributions.display_name", - ) - ) - ) - - self.display_name = value - - @property - def strict_labels(self): # pragma: no cover # noqa: D102 - # Docstrings are omitted for documentation purposes. - usage_warning( - str( - ObjectRenamed( - "MultiSpectralDistributions.strict_labels", - "MultiSpectralDistributions.display_labels", - ) - ) - ) - - return self.display_labels - - @strict_labels.setter - def strict_labels(self, value): # pragma: no cover - # Docstrings are omitted for documentation purposes. - usage_warning( - str( - ObjectRenamed( - "MultiSpectralDistributions.strict_labels", - "MultiSpectralDistributions.display_labels", - ) - ) - ) - - self.display_labels = value - _CACHE_RESHAPED_SDS_AND_MSDS: dict = CACHE_REGISTRY.register_cache( f"{__name__}._CACHE_RESHAPED_SDS_AND_MSDS" @@ -2787,8 +2650,7 @@ def strict_labels(self, value): # pragma: no cover def reshape_sd( sd: TypeSpectralDistribution, shape: SpectralShape = SPECTRAL_SHAPE_DEFAULT, - method: Literal["Align", "Extrapolate", "Interpolate", "Trim"] - | str = "Align", + method: (Literal["Align", "Extrapolate", "Interpolate", "Trim"] | str) = "Align", copy: bool = True, **kwargs: Any, ) -> TypeSpectralDistribution: @@ -2846,9 +2708,7 @@ def reshape_sd( function = getattr(sd, method) - reshaped_sd = getattr(sd.copy(), method)( - shape, **filter_kwargs(function, **kwargs) - ) + reshaped_sd = getattr(sd.copy(), method)(shape, **filter_kwargs(function, **kwargs)) _CACHE_RESHAPED_SDS_AND_MSDS[hash_key] = reshaped_sd @@ -2863,8 +2723,7 @@ def reshape_sd( def reshape_msds( msds: TypeMultiSpectralDistributions, shape: SpectralShape = SPECTRAL_SHAPE_DEFAULT, - method: Literal["Align", "Extrapolate", "Interpolate", "Trim"] - | str = "Align", + method: (Literal["Align", "Extrapolate", "Interpolate", "Trim"] | str) = "Align", copy: bool = True, **kwargs: Any, ) -> TypeMultiSpectralDistributions: @@ -2909,9 +2768,11 @@ def reshape_msds( def sds_and_msds_to_sds( - sds: Sequence[SpectralDistribution | MultiSpectralDistributions] - | SpectralDistribution - | MultiSpectralDistributions, + sds: ( + Sequence[SpectralDistribution | MultiSpectralDistributions] + | SpectralDistribution + | MultiSpectralDistributions + ), ) -> List[SpectralDistribution]: """ Convert given spectral and multi-spectral distributions to a list of @@ -2963,18 +2824,18 @@ def sds_and_msds_to_sds( sds_converted = [] for sd in sds: sds_converted += ( - sd.to_sds() - if isinstance(sd, MultiSpectralDistributions) - else [sd] + sd.to_sds() if isinstance(sd, MultiSpectralDistributions) else [sd] ) return sds_converted def sds_and_msds_to_msds( - sds: Sequence[SpectralDistribution | MultiSpectralDistributions] - | SpectralDistribution - | MultiSpectralDistributions, + sds: ( + Sequence[SpectralDistribution | MultiSpectralDistributions] + | SpectralDistribution + | MultiSpectralDistributions + ), ) -> MultiSpectralDistributions: """ Convert given spectral and multi-spectral distributions to @@ -3074,12 +2935,10 @@ def sds_and_msds_to_msds( display_labels = [] for sd in sds_converted: if sd.shape != shape: - sd = sd.align(shape) # noqa: PLW2901 + sd = sd.copy().align(shape) # noqa: PLW2901 values.append(sd.values) - labels.append( - sd.name if sd.name not in labels else f"{sd.name} ({id(sd)})" - ) + labels.append(sd.name if sd.name not in labels else f"{sd.name} ({id(sd)})") display_labels.append( sd.display_name if sd.display_name not in display_labels diff --git a/colour/colorimetry/tests/test_blackbody.py b/colour/colorimetry/tests/test_blackbody.py index afb9e34c3b..c4512c7e2a 100644 --- a/colour/colorimetry/tests/test_blackbody.py +++ b/colour/colorimetry/tests/test_blackbody.py @@ -1,12 +1,11 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.blackbody` module.""" from __future__ import annotations -import unittest from itertools import product import numpy as np +import pytest from colour.colorimetry import ( SpectralShape, @@ -1197,7 +1196,7 @@ ) -class TestPlanckLaw(unittest.TestCase): +class TestPlanckLaw: """ Define :func:`colour.colorimetry.blackbody.planck_law` definition unit tests methods. @@ -1268,7 +1267,7 @@ def test_raise_exception_planck_law(self): """ for wavelength in [-1.0, 0.0, -np.inf, np.nan]: - self.assertRaises(AssertionError, planck_law, wavelength, 5500) + pytest.raises(AssertionError, planck_law, wavelength, 5500) @ignore_numpy_errors def test_nan_planck_law(self): @@ -1283,7 +1282,7 @@ def test_nan_planck_law(self): planck_law(cases, cases) -class TestSdBlackbody(unittest.TestCase): +class TestSdBlackbody: """ Define :func:`colour.colorimetry.blackbody.sd_blackbody` definition unit tests methods. @@ -1299,7 +1298,7 @@ def test_sd_blackbody(self): ) -class TestRayleighJeansLaw(unittest.TestCase): +class TestRayleighJeansLaw: """ Define :func:`colour.colorimetry.blackbody.rayleigh_jeans_law` definition unit tests methods. @@ -1378,7 +1377,7 @@ def test_nan_rayleigh_jeans_law(self): rayleigh_jeans_law(cases, cases) -class TestSdRayleighJeans(unittest.TestCase): +class TestSdRayleighJeans: """ Define :func:`colour.colorimetry.blackbody.sd_rayleigh_jeans` definition unit tests methods. @@ -1395,7 +1394,3 @@ def test_sd_rayleigh_jeans(self): DATA_RAYLEIGH_JEANS, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_correction.py b/colour/colorimetry/tests/test_correction.py index 9956d308f4..dc66a42771 100644 --- a/colour/colorimetry/tests/test_correction.py +++ b/colour/colorimetry/tests/test_correction.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.correction` module.""" -import unittest import numpy as np @@ -63,7 +61,7 @@ ) -class TestBandpassCorrectionStearns1988(unittest.TestCase): +class TestBandpassCorrectionStearns1988: """ Define :func:`colour.colorimetry.correction.\ bandpass_correction_Stearns1988` definition unit tests methods. @@ -89,7 +87,3 @@ def test_bandpass_correction_Stearns1988(self): DATA_BANDPASS_CORRECTED, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_dominant.py b/colour/colorimetry/tests/test_dominant.py index 55456f8a58..ab3a5aade1 100644 --- a/colour/colorimetry/tests/test_dominant.py +++ b/colour/colorimetry/tests/test_dominant.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.dominant` module.""" -import unittest from itertools import product import numpy as np @@ -37,22 +35,18 @@ ] -class TestClosestSpectralLocusWavelength(unittest.TestCase): +class TestClosestSpectralLocusWavelength: """ Define :func:`colour.colorimetry.dominant.\ closest_spectral_locus_wavelength` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" - self._xy_s = XYZ_to_xy( - MSDS_CMFS["CIE 1931 2 Degree Standard Observer"].values - ) + self._xy_s = XYZ_to_xy(MSDS_CMFS["CIE 1931 2 Degree Standard Observer"].values) - self._xy_D65 = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ - "D65" - ] + self._xy_D65 = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"] def test_closest_spectral_locus_wavelength(self): """ @@ -64,7 +58,7 @@ def test_closest_spectral_locus_wavelength(self): xy_n = self._xy_D65 i_wl, xy_wl = closest_spectral_locus_wavelength(xy, xy_n, self._xy_s) - self.assertEqual(i_wl, np.array(256)) + assert i_wl == np.array(256) np.testing.assert_allclose( xy_wl, np.array([0.68354746, 0.31628409]), @@ -74,7 +68,7 @@ def test_closest_spectral_locus_wavelength(self): xy = np.array([0.37605506, 0.24452225]) i_wl, xy_wl = closest_spectral_locus_wavelength(xy, xy_n, self._xy_s) - self.assertEqual(i_wl, np.array(248)) + assert i_wl == np.array(248) np.testing.assert_allclose( xy_wl, np.array([0.45723147, 0.13628148]), @@ -92,9 +86,7 @@ def test_n_dimensional_closest_spectral_locus_wavelength(self): i_wl, xy_wl = closest_spectral_locus_wavelength(xy, xy_n, self._xy_s) i_wl_r, xy_wl_r = np.array(256), np.array([0.68354746, 0.31628409]) np.testing.assert_allclose(i_wl, i_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) - np.testing.assert_allclose( - xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) xy = np.tile(xy, (6, 1)) xy_n = np.tile(xy_n, (6, 1)) @@ -102,9 +94,7 @@ def test_n_dimensional_closest_spectral_locus_wavelength(self): i_wl_r = np.tile(i_wl_r, 6) xy_wl_r = np.tile(xy_wl_r, (6, 1)) np.testing.assert_allclose(i_wl, i_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) - np.testing.assert_allclose( - xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) xy = np.reshape(xy, (2, 3, 2)) xy_n = np.reshape(xy_n, (2, 3, 2)) @@ -112,9 +102,7 @@ def test_n_dimensional_closest_spectral_locus_wavelength(self): i_wl_r = np.reshape(i_wl_r, (2, 3)) xy_wl_r = np.reshape(xy_wl_r, (2, 3, 2)) np.testing.assert_allclose(i_wl, i_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) - np.testing.assert_allclose( - xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) @ignore_numpy_errors def test_nan_closest_spectral_locus_wavelength(self): @@ -129,18 +117,16 @@ def test_nan_closest_spectral_locus_wavelength(self): closest_spectral_locus_wavelength(case, case, self._xy_s) -class TestDominantWavelength(unittest.TestCase): +class TestDominantWavelength: """ Define :func:`colour.colorimetry.dominant.dominant_wavelength` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" - self._xy_D65 = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ - "D65" - ] + self._xy_D65 = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"] def test_dominant_wavelength(self): """ @@ -152,7 +138,7 @@ def test_dominant_wavelength(self): xy_n = self._xy_D65 wl, xy_wl, xy_cwl = dominant_wavelength(xy, xy_n) - self.assertEqual(wl, np.array(616.0)) + assert wl == np.array(616.0) np.testing.assert_allclose( xy_wl, np.array([0.68354746, 0.31628409]), @@ -167,7 +153,7 @@ def test_dominant_wavelength(self): xy = np.array([0.37605506, 0.24452225]) i_wl, xy_wl, xy_cwl = dominant_wavelength(xy, xy_n) - self.assertEqual(i_wl, np.array(-509.0)) + assert i_wl == np.array(-509.0) np.testing.assert_allclose( xy_wl, np.array([0.45723147, 0.13628148]), @@ -194,12 +180,8 @@ def test_n_dimensional_dominant_wavelength(self): np.array([0.68354746, 0.31628409]), ) np.testing.assert_allclose(wl, wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) - np.testing.assert_allclose( - xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) - np.testing.assert_allclose( - xy_cwl, xy_cwl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) + np.testing.assert_allclose(xy_cwl, xy_cwl_r, atol=TOLERANCE_ABSOLUTE_TESTS) xy = np.tile(xy, (6, 1)) xy_n = np.tile(xy_n, (6, 1)) @@ -208,12 +190,8 @@ def test_n_dimensional_dominant_wavelength(self): xy_wl_r = np.tile(xy_wl_r, (6, 1)) xy_cwl_r = np.tile(xy_cwl_r, (6, 1)) np.testing.assert_allclose(wl, wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) - np.testing.assert_allclose( - xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) - np.testing.assert_allclose( - xy_cwl, xy_cwl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) + np.testing.assert_allclose(xy_cwl, xy_cwl_r, atol=TOLERANCE_ABSOLUTE_TESTS) xy = np.reshape(xy, (2, 3, 2)) xy_n = np.reshape(xy_n, (2, 3, 2)) @@ -222,12 +200,8 @@ def test_n_dimensional_dominant_wavelength(self): xy_wl_r = np.reshape(xy_wl_r, (2, 3, 2)) xy_cwl_r = np.reshape(xy_cwl_r, (2, 3, 2)) np.testing.assert_allclose(wl, wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) - np.testing.assert_allclose( - xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) - np.testing.assert_allclose( - xy_cwl, xy_cwl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) + np.testing.assert_allclose(xy_cwl, xy_cwl_r, atol=TOLERANCE_ABSOLUTE_TESTS) @ignore_numpy_errors def test_nan_dominant_wavelength(self): @@ -242,18 +216,16 @@ def test_nan_dominant_wavelength(self): dominant_wavelength(case, case) -class TestComplementaryWavelength(unittest.TestCase): +class TestComplementaryWavelength: """ Define :func:`colour.colorimetry.dominant.complementary_wavelength` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" - self._xy_D65 = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ - "D65" - ] + self._xy_D65 = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"] def test_complementary_wavelength(self): """ @@ -265,7 +237,7 @@ def test_complementary_wavelength(self): xy_n = self._xy_D65 wl, xy_wl, xy_cwl = complementary_wavelength(xy, xy_n) - self.assertEqual(wl, np.array(492.0)) + assert wl == np.array(492.0) np.testing.assert_allclose( xy_wl, np.array([0.03647950, 0.33847127]), @@ -280,7 +252,7 @@ def test_complementary_wavelength(self): xy = np.array([0.37605506, 0.24452225]) i_wl, xy_wl, xy_cwl = complementary_wavelength(xy, xy_n) - self.assertEqual(i_wl, np.array(509.0)) + assert i_wl == np.array(509.0) np.testing.assert_allclose( xy_wl, np.array([0.01040962, 0.73207453]), @@ -307,12 +279,8 @@ def test_n_dimensional_complementary_wavelength(self): np.array([0.03647950, 0.33847127]), ) np.testing.assert_allclose(wl, wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) - np.testing.assert_allclose( - xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) - np.testing.assert_allclose( - xy_cwl, xy_cwl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) + np.testing.assert_allclose(xy_cwl, xy_cwl_r, atol=TOLERANCE_ABSOLUTE_TESTS) xy = np.tile(xy, (6, 1)) xy_n = np.tile(xy_n, (6, 1)) @@ -321,12 +289,8 @@ def test_n_dimensional_complementary_wavelength(self): xy_wl_r = np.tile(xy_wl_r, (6, 1)) xy_cwl_r = np.tile(xy_cwl_r, (6, 1)) np.testing.assert_allclose(wl, wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) - np.testing.assert_allclose( - xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) - np.testing.assert_allclose( - xy_cwl, xy_cwl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) + np.testing.assert_allclose(xy_cwl, xy_cwl_r, atol=TOLERANCE_ABSOLUTE_TESTS) xy = np.reshape(xy, (2, 3, 2)) xy_n = np.reshape(xy_n, (2, 3, 2)) @@ -335,12 +299,8 @@ def test_n_dimensional_complementary_wavelength(self): xy_wl_r = np.reshape(xy_wl_r, (2, 3, 2)) xy_cwl_r = np.reshape(xy_cwl_r, (2, 3, 2)) np.testing.assert_allclose(wl, wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) - np.testing.assert_allclose( - xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) - np.testing.assert_allclose( - xy_cwl, xy_cwl_r, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_wl, xy_wl_r, atol=TOLERANCE_ABSOLUTE_TESTS) + np.testing.assert_allclose(xy_cwl, xy_cwl_r, atol=TOLERANCE_ABSOLUTE_TESTS) @ignore_numpy_errors def test_nan_complementary_wavelength(self): @@ -355,18 +315,16 @@ def test_nan_complementary_wavelength(self): complementary_wavelength(case, case) -class TestExcitationPurity(unittest.TestCase): +class TestExcitationPurity: """ Define :func:`colour.colorimetry.dominant.excitation_purity` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" - self._xy_D65 = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ - "D65" - ] + self._xy_D65 = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"] def test_excitation_purity(self): """Test :func:`colour.colorimetry.dominant.excitation_purity` definition.""" @@ -424,18 +382,16 @@ def test_nan_excitation_purity(self): excitation_purity(case, case) -class TestColorimetricPurity(unittest.TestCase): +class TestColorimetricPurity: """ Define :func:`colour.colorimetry.dominant.colorimetric_purity` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" - self._xy_D65 = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ - "D65" - ] + self._xy_D65 = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"] def test_colorimetric_purity(self): """ @@ -494,7 +450,3 @@ def test_nan_colorimetric_purity(self): cases = np.array(list(set(product(cases, repeat=2)))) for case in cases: colorimetric_purity(case, case) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_generation.py b/colour/colorimetry/tests/test_generation.py index 0f2dc00d3e..58ef5dd894 100644 --- a/colour/colorimetry/tests/test_generation.py +++ b/colour/colorimetry/tests/test_generation.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.generation` module.""" -import unittest import numpy as np @@ -40,7 +38,7 @@ ] -class TestSdConstant(unittest.TestCase): +class TestSdConstant: """ Define :func:`colour.colorimetry.generation.sd_constant` definition unit tests methods. @@ -51,20 +49,14 @@ def test_sd_constant(self): sd = sd_constant(np.pi) - np.testing.assert_allclose( - sd[360], np.pi, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(sd[360], np.pi, atol=TOLERANCE_ABSOLUTE_TESTS) - np.testing.assert_allclose( - sd[555], np.pi, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(sd[555], np.pi, atol=TOLERANCE_ABSOLUTE_TESTS) - np.testing.assert_allclose( - sd[780], np.pi, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(sd[780], np.pi, atol=TOLERANCE_ABSOLUTE_TESTS) -class TestSdZeros(unittest.TestCase): +class TestSdZeros: """ Define :func:`colour.colorimetry.generation.sd_zeros` definition unit tests methods. @@ -78,14 +70,14 @@ def test_sd_zeros(self): sd = sd_zeros() - self.assertEqual(sd[360], 0) + assert sd[360] == 0 - self.assertEqual(sd[555], 0) + assert sd[555] == 0 - self.assertEqual(sd[780], 0) + assert sd[780] == 0 -class TestSdOnes(unittest.TestCase): +class TestSdOnes: """ Define :func:`colour.colorimetry.generation.sd_ones` definition unit tests methods. @@ -96,14 +88,14 @@ def test_sd_ones(self): sd = sd_ones() - self.assertEqual(sd[360], 1) + assert sd[360] == 1 - self.assertEqual(sd[555], 1) + assert sd[555] == 1 - self.assertEqual(sd[780], 1) + assert sd[780] == 1 -class TestMsdsConstant(unittest.TestCase): +class TestMsdsConstant: """ Define :func:`colour.colorimetry.generation.msds_constant` definition unit tests methods. @@ -133,7 +125,7 @@ def test_msds_constant(self): ) -class TestMsdsZeros(unittest.TestCase): +class TestMsdsZeros: """ Define :func:`colour.colorimetry.generation.msds_zeros` definition unit tests methods. @@ -154,7 +146,7 @@ def test_msds_zeros(self): np.testing.assert_equal(msds[780], np.array([0, 0, 0])) -class TestMsdsOnes(unittest.TestCase): +class TestMsdsOnes: """ Define :func:`colour.colorimetry.generation.msds_ones` definition unit tests methods. @@ -172,7 +164,7 @@ def test_msds_ones(self): np.testing.assert_equal(msds[780], np.array([1, 1, 1])) -class TestSdGaussianNormal(unittest.TestCase): +class TestSdGaussianNormal: """ Define :func:`colour.colorimetry.generation.sd_gaussian_normal` definition unit tests methods. @@ -197,7 +189,7 @@ def test_sd_gaussian_normal(self): ) -class TestSdGaussianFwhm(unittest.TestCase): +class TestSdGaussianFwhm: """ Define :func:`colour.colorimetry.generation.sd_gaussian_fwhm` definition unit tests methods. @@ -210,9 +202,7 @@ def test_sd_gaussian_fwhm(self): sd = sd_gaussian_fwhm(555, 25) - np.testing.assert_allclose( - sd[530], 0.0625, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(sd[530], 0.0625, atol=TOLERANCE_ABSOLUTE_TESTS) np.testing.assert_allclose(sd[555], 1, atol=TOLERANCE_ABSOLUTE_TESTS) @@ -220,12 +210,10 @@ def test_sd_gaussian_fwhm(self): sd[580], 0.062499999999999, atol=TOLERANCE_ABSOLUTE_TESTS ) - np.testing.assert_allclose( - sd[555 - 25 / 2], 0.5, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(sd[555 - 25 / 2], 0.5, atol=TOLERANCE_ABSOLUTE_TESTS) -class TestSdSingleLedOhno2005(unittest.TestCase): +class TestSdSingleLedOhno2005: """ Define :func:`colour.colorimetry.generation.sd_single_led_Ohno2005` definition unit tests methods. @@ -250,7 +238,7 @@ def test_sd_single_led_Ohno2005(self): ) -class TestSdMultiLedsOhno2005(unittest.TestCase): +class TestSdMultiLedsOhno2005: """ Define :func:`colour.colorimetry.generation.sd_multi_leds_Ohno2005` definition unit tests methods. @@ -296,7 +284,3 @@ def test_sd_multi_leds_Ohno2005(self): np.testing.assert_allclose( sd[640], 0.070140708922879, atol=TOLERANCE_ABSOLUTE_TESTS ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_illuminants.py b/colour/colorimetry/tests/test_illuminants.py index 254bc527ea..5facff02f5 100644 --- a/colour/colorimetry/tests/test_illuminants.py +++ b/colour/colorimetry/tests/test_illuminants.py @@ -1,10 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.illuminants` module.""" from __future__ import annotations -import unittest - import numpy as np from colour.colorimetry import ( @@ -134,7 +131,7 @@ ) -class TestSdCIEStandardIlluminantA(unittest.TestCase): +class TestSdCIEStandardIlluminantA: """ Define :func:`colour.colorimetry.illuminants.\ sd_CIE_standard_illuminant_A` definition unit tests methods. @@ -153,7 +150,7 @@ def test_sd_CIE_standard_illuminant_A(self): ) -class TestSdCIEIlluminantDSeries(unittest.TestCase): +class TestSdCIEIlluminantDSeries: """ Define :func:`colour.colorimetry.illuminants.sd_CIE_illuminant_D_series` definition unit tests methods. @@ -183,7 +180,7 @@ def test_sd_CIE_illuminant_D_series(self): ) -class TestDaylightLocusFunction(unittest.TestCase): +class TestDaylightLocusFunction: """ Define :func:`colour.colorimetry.illuminants.daylight_locus_function` definition unit tests methods. @@ -243,7 +240,3 @@ def test_nan_daylight_locus_function(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] daylight_locus_function(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_lefs.py b/colour/colorimetry/tests/test_lefs.py index c9ca33aa61..359e64214c 100644 --- a/colour/colorimetry/tests/test_lefs.py +++ b/colour/colorimetry/tests/test_lefs.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.lefs` module.""" -import unittest import numpy as np @@ -430,7 +428,7 @@ ) -class TestMesopicWeightingFunction(unittest.TestCase): +class TestMesopicWeightingFunction: """ Define :func:`colour.colorimetry.lefs.mesopic_weighting_function` definition unit tests methods. @@ -449,17 +447,13 @@ def test_mesopic_weighting_function(self): ) np.testing.assert_allclose( - mesopic_weighting_function( - 500, 0.2, source="Red Heavy", method="LRC" - ), + mesopic_weighting_function(500, 0.2, source="Red Heavy", method="LRC"), 0.90951000, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - mesopic_weighting_function( - 700, 10, source="Red Heavy", method="LRC" - ), + mesopic_weighting_function(700, 10, source="Red Heavy", method="LRC"), 0.00410200, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -504,12 +498,14 @@ def test_nan_mesopic_weighting_function(self): definition nan support. """ - mesopic_weighting_function( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]), 0.2 - ), + ( + mesopic_weighting_function( + np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]), 0.2 + ), + ) -class TestSdMesopicLuminousEfficiencyFunction(unittest.TestCase): +class TestSdMesopicLuminousEfficiencyFunction: """ Define :func:`colour.colorimetry.lefs.\ sd_mesopic_luminous_efficiency_function` definition unit tests methods. @@ -526,7 +522,3 @@ def test_sd_mesopic_luminous_efficiency_function(self): DATA_MESOPIC_LEF, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_lightness.py b/colour/colorimetry/tests/test_lightness.py index 91e2648893..449702748c 100644 --- a/colour/colorimetry/tests/test_lightness.py +++ b/colour/colorimetry/tests/test_lightness.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.lightness` module.""" -import unittest import numpy as np @@ -37,7 +35,7 @@ ] -class TestLightnessGlasser1958(unittest.TestCase): +class TestLightnessGlasser1958: """ Define :func:`colour.colorimetry.lightness.lightness_Glasser1958` definition unit tests methods. @@ -118,12 +116,10 @@ def test_nan_lightness_Glasser1958(self): definition nan support. """ - lightness_Glasser1958( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + lightness_Glasser1958(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLightnessWyszecki1963(unittest.TestCase): +class TestLightnessWyszecki1963: """ Define :func:`colour.colorimetry.lightness.lightness_Wyszecki1963` definition unit tests methods. @@ -204,12 +200,10 @@ def test_nan_lightness_Wyszecki1963(self): definition nan support. """ - lightness_Wyszecki1963( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + lightness_Wyszecki1963(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestIntermediateLightnessFunctionCIE1976(unittest.TestCase): +class TestIntermediateLightnessFunctionCIE1976: """ Define :func:`colour.colorimetry.lightness.\ intermediate_lightness_function_CIE1976` definition unit tests methods. @@ -302,7 +296,7 @@ def test_nan_intermediate_lightness_function_CIE1976(self): ) -class TestLightnessCIE1976(unittest.TestCase): +class TestLightnessCIE1976: """ Define :func:`colour.colorimetry.lightness.lightness_CIE1976` definition unit tests methods. @@ -389,7 +383,7 @@ def test_domain_range_scale_lightness_CIE1976(self): for scale, factor in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - lightness_CIE1976(12.19722535 * factor, 100), + lightness_CIE1976(12.19722535 * factor, 100 * factor), L_star * factor, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -404,7 +398,7 @@ def test_nan_lightness_CIE1976(self): lightness_CIE1976(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLightnessFairchild2010(unittest.TestCase): +class TestLightnessFairchild2010: """ Define :func:`colour.colorimetry.lightness.lightness_Fairchild2010` definition unit tests methods. @@ -503,12 +497,10 @@ def test_nan_lightness_Fairchild2010(self): definition nan support. """ - lightness_Fairchild2010( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + lightness_Fairchild2010(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLightnessFairchild2011(unittest.TestCase): +class TestLightnessFairchild2011: """ Define :func:`colour.colorimetry.lightness.lightness_Fairchild2011` definition unit tests methods. @@ -607,12 +599,10 @@ def test_nan_lightness_Fairchild2011(self): definition nan support. """ - lightness_Fairchild2011( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + lightness_Fairchild2011(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLightnessAbebe2017(unittest.TestCase): +class TestLightnessAbebe2017: """ Define :func:`colour.colorimetry.lightness.lightness_Abebe2017` definition unit tests methods. @@ -705,12 +695,10 @@ def test_nan_lightness_Abebe2017(self): definition nan support. """ - lightness_Abebe2017( - *[np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])] * 2 - ) + lightness_Abebe2017(*[np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])] * 2) -class TestLightness(unittest.TestCase): +class TestLightness: """ Define :func:`colour.colorimetry.lightness.lightness` definition unit tests methods. @@ -737,11 +725,7 @@ def test_domain_range_scale_lightness(self): for scale, factor in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - lightness(12.19722535 * factor, method, Y_n=100), + lightness(12.19722535 * factor, method, Y_n=100 * factor), value * factor, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_luminance.py b/colour/colorimetry/tests/test_luminance.py index b9c1f058b4..ee95beadd6 100644 --- a/colour/colorimetry/tests/test_luminance.py +++ b/colour/colorimetry/tests/test_luminance.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.luminance` module.""" -import unittest import numpy as np @@ -37,7 +35,7 @@ ] -class TestLuminanceNewhall1943(unittest.TestCase): +class TestLuminanceNewhall1943: """ Define :func:`colour.colorimetry.luminance.luminance_Newhall1943` definition unit tests methods. @@ -118,12 +116,10 @@ def test_nan_luminance_Newhall1943(self): definition nan support. """ - luminance_Newhall1943( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + luminance_Newhall1943(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLuminanceASTMD1535(unittest.TestCase): +class TestLuminanceASTMD1535: """ Define :func:`colour.colorimetry.luminance.luminance_ASTMD1535` definition unit tests methods. @@ -204,12 +200,10 @@ def test_nan_luminance_ASTMD1535(self): definition nan support. """ - luminance_ASTMD1535( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + luminance_ASTMD1535(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestIntermediateLuminanceFunctionCIE1976(unittest.TestCase): +class TestIntermediateLuminanceFunctionCIE1976: """ Define :func:`colour.colorimetry.luminance.\ intermediate_luminance_function_CIE1976` definition unit tests methods. @@ -285,9 +279,7 @@ def test_domain_range_scale_intermediate_luminance_function_CIE1976(self): for scale in ("reference", "1", "100"): with domain_range_scale(scale): np.testing.assert_allclose( - intermediate_luminance_function_CIE1976( - 41.527875844653451, 100 - ), + intermediate_luminance_function_CIE1976(41.527875844653451, 100), Y, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -304,7 +296,7 @@ def test_nan_intermediate_luminance_function_CIE1976(self): ) -class TestLuminanceCIE1976(unittest.TestCase): +class TestLuminanceCIE1976: """ Define :func:`colour.colorimetry.luminance.luminance_CIE1976` definition unit tests methods. @@ -391,7 +383,7 @@ def test_domain_range_scale_luminance_CIE1976(self): for scale, factor in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - luminance_CIE1976(41.527875844653451 * factor, 100), + luminance_CIE1976(41.527875844653451 * factor, 100 * factor), Y * factor, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -406,7 +398,7 @@ def test_nan_luminance_CIE1976(self): luminance_CIE1976(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLuminanceFairchild2010(unittest.TestCase): +class TestLuminanceFairchild2010: """ Define :func:`colour.colorimetry.luminance.luminance_Fairchild2010` definition unit tests methods. @@ -505,12 +497,10 @@ def test_nan_luminance_Fairchild2010(self): definition nan support. """ - luminance_Fairchild2010( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + luminance_Fairchild2010(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLuminanceFairchild2011(unittest.TestCase): +class TestLuminanceFairchild2011: """ Define :func:`colour.colorimetry.luminance.luminance_Fairchild2011` definition unit tests methods. @@ -609,12 +599,10 @@ def test_nan_luminance_Fairchild2011(self): definition nan support. """ - luminance_Fairchild2011( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + luminance_Fairchild2011(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLuminanceAbebe2017(unittest.TestCase): +class TestLuminanceAbebe2017: """ Define :func:`colour.colorimetry.luminance.luminance_Abebe2017` definition unit tests methods. @@ -695,9 +683,7 @@ def test_domain_range_scale_luminance_Abebe2017(self): for scale, factor in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - luminance_Abebe2017( - 0.486955571109229 * factor, 100 * factor - ), + luminance_Abebe2017(0.486955571109229 * factor, 100 * factor), L * factor, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -709,12 +695,10 @@ def test_nan_luminance_Abebe2017(self): definition nan support. """ - luminance_Abebe2017( - *[np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])] * 2 - ) + luminance_Abebe2017(*[np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])] * 2) -class TestLuminance(unittest.TestCase): +class TestLuminance: """ Define :func:`colour.colorimetry.luminance.luminance` definition unit tests methods. @@ -742,12 +726,8 @@ def test_domain_range_scale_luminance(self): with domain_range_scale(scale): np.testing.assert_allclose( luminance( - 41.527875844653451 * factor, method, Y_n=100 + 41.527875844653451 * factor, method, Y_n=100 * factor ), value * factor, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_photometry.py b/colour/colorimetry/tests/test_photometry.py index 5185f8b878..70c7e3e3bf 100644 --- a/colour/colorimetry/tests/test_photometry.py +++ b/colour/colorimetry/tests/test_photometry.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.photometry` module.""" -import unittest import numpy as np @@ -29,7 +27,7 @@ ] -class TestLuminousFlux(unittest.TestCase): +class TestLuminousFlux: """ Define :func:`colour.colorimetry.photometry.luminous_flux` definition unit tests methods. @@ -57,7 +55,7 @@ def test_luminous_flux(self): ) -class TestLuminousEfficiency(unittest.TestCase): +class TestLuminousEfficiency: """ Define :func:`colour.colorimetry.photometry.luminous_efficiency` definition unit tests methods. @@ -82,15 +80,13 @@ def test_luminous_efficiency(self): ) np.testing.assert_allclose( - luminous_efficiency( - SDS_LIGHT_SOURCES["F32T8/TL841 (Triphosphor)"] - ), + luminous_efficiency(SDS_LIGHT_SOURCES["F32T8/TL841 (Triphosphor)"]), 0.51080919, atol=TOLERANCE_ABSOLUTE_TESTS, ) -class TestLuminousEfficacy(unittest.TestCase): +class TestLuminousEfficacy: """ Define :func:`colour.colorimetry.photometry.luminous_efficacy` definition unit tests methods. @@ -125,7 +121,3 @@ def test_luminous_efficacy(self): np.testing.assert_allclose( luminous_efficacy(sd), 683.00000000, atol=TOLERANCE_ABSOLUTE_TESTS ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_spectrum.py b/colour/colorimetry/tests/test_spectrum.py index b677844e05..3838a40ec9 100644 --- a/colour/colorimetry/tests/test_spectrum.py +++ b/colour/colorimetry/tests/test_spectrum.py @@ -1,10 +1,9 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.spectrum` module.""" import pickle -import unittest import numpy as np +import pytest import colour from colour.algebra import CubicSplineInterpolator @@ -1248,7 +1247,7 @@ } -class TestSpectralShape(unittest.TestCase): +class TestSpectralShape: """ Define :class:`colour.colorimetry.spectrum.SpectralShape` class unit tests methods. @@ -1266,7 +1265,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(SpectralShape)) + assert attribute in dir(SpectralShape) def test_required_methods(self): """Test the presence of required methods.""" @@ -1285,7 +1284,7 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(SpectralShape)) + assert method in dir(SpectralShape) def test_pickling(self): """ @@ -1296,7 +1295,7 @@ class can be pickled. shape = SpectralShape(360, 830, 1) data = pickle.dumps(shape) data = pickle.loads(data) # noqa: S301 - self.assertEqual(shape, data) + assert shape == data def test_start(self): """ @@ -1304,20 +1303,20 @@ def test_start(self): attribute. """ - self.assertEqual(SpectralShape(360, 830, 1).start, 360) + assert SpectralShape(360, 830, 1).start == 360 - self.assertRaises(AssertionError, lambda: SpectralShape(360, 360, 1)) + pytest.raises(AssertionError, lambda: SpectralShape(360, 360, 1)) - self.assertRaises(AssertionError, lambda: SpectralShape(360, 0, 1)) + pytest.raises(AssertionError, lambda: SpectralShape(360, 0, 1)) def test_end(self): """Test :attr:`colour.colorimetry.spectrum.SpectralShape.end` property.""" - self.assertEqual(SpectralShape(360, 830, 1).end, 830) + assert SpectralShape(360, 830, 1).end == 830 - self.assertRaises(AssertionError, lambda: SpectralShape(830, 830, 1)) + pytest.raises(AssertionError, lambda: SpectralShape(830, 830, 1)) - self.assertRaises(AssertionError, lambda: SpectralShape(830, 0, 1)) + pytest.raises(AssertionError, lambda: SpectralShape(830, 0, 1)) def test_interval(self): """ @@ -1325,7 +1324,7 @@ def test_interval(self): property. """ - self.assertEqual(SpectralShape(360, 830, 1).interval, 1) + assert SpectralShape(360, 830, 1).interval == 1 def test_boundaries(self): """ @@ -1336,8 +1335,8 @@ def test_boundaries(self): shape = SpectralShape(400, 700, 1) shape.boundaries = (360, 830) - self.assertEqual(shape.start, 360) - self.assertEqual(shape.end, 830) + assert shape.start == 360 + assert shape.end == 830 def test_wavelengths(self): """ @@ -1356,7 +1355,7 @@ def test__hash__(self): method. """ - self.assertIsInstance(hash(SpectralShape(0, 10, 0.1)), int) + assert isinstance(hash(SpectralShape(0, 10, 0.1)), int) def test__iter__(self): """ @@ -1375,13 +1374,13 @@ def test__contains__(self): method. """ - self.assertIn(360.1, SpectralShape(360, 830, 0.1)) + assert 360.1 in SpectralShape(360, 830, 0.1) - self.assertNotIn(360.11, SpectralShape(360, 830, 0.1)) + assert 360.11 not in SpectralShape(360, 830, 0.1) - self.assertIn(np.array([0.5, 0.6]), SpectralShape(0, 10, 0.1)) + assert np.array([0.5, 0.6]) in SpectralShape(0, 10, 0.1) - self.assertNotIn(np.array([0.5, 0.61]), SpectralShape(0, 10, 0.1)) + assert np.array([0.5, 0.61]) not in SpectralShape(0, 10, 0.1) def test__len__(self): """ @@ -1389,7 +1388,7 @@ def test__len__(self): method. """ - self.assertEqual(len(SpectralShape(0, 10, 0.1)), 101) + assert len(SpectralShape(0, 10, 0.1)) == 101 def test__eq__(self): """ @@ -1397,8 +1396,8 @@ def test__eq__(self): method. """ - self.assertEqual(SpectralShape(0, 10, 0.1), SpectralShape(0, 10, 0.1)) - self.assertNotEqual(SpectralShape(0, 10, 0.1), None) + assert SpectralShape(0, 10, 0.1) == SpectralShape(0, 10, 0.1) + assert SpectralShape(0, 10, 0.1) != () def test__ne__(self): """ @@ -1406,9 +1405,7 @@ def test__ne__(self): method. """ - self.assertNotEqual( - SpectralShape(0, 10, 0.1), SpectralShape(1, 10, 0.1) - ) + assert SpectralShape(0, 10, 0.1) != SpectralShape(1, 10, 0.1) def test_range(self): """Test :func:`colour.colorimetry.spectrum.SpectralShape.range` method.""" @@ -1419,13 +1416,13 @@ def test_range(self): ) -class TestSpectralDistribution(unittest.TestCase): +class TestSpectralDistribution: """ Define :class:`colour.colorimetry.spectrum.SpectralDistribution` class unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._sd = SpectralDistribution(DATA_SAMPLE, name="Sample") @@ -1449,7 +1446,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(SpectralDistribution)) + assert attribute in dir(SpectralDistribution) def test_required_methods(self): """Test the presence of required methods.""" @@ -1464,7 +1461,7 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(SpectralDistribution)) + assert method in dir(SpectralDistribution) def test_pickling(self): """ @@ -1474,7 +1471,7 @@ def test_pickling(self): data = pickle.dumps(self._sd) data = pickle.loads(data) # noqa: S301 - self.assertEqual(self._sd, data) + assert self._sd == data def test_display_name(self): """ @@ -1482,10 +1479,8 @@ def test_display_name(self): property. """ - self.assertEqual(self._sd.display_name, "Sample") - self.assertEqual( - self._non_uniform_sd.display_name, "Display Non Uniform Sample" - ) + assert self._sd.display_name == "Sample" + assert self._non_uniform_sd.display_name == "Display Non Uniform Sample" def test_wavelengths(self): """ @@ -1517,7 +1512,7 @@ def test_shape(self): property. """ - self.assertEqual(self._sd.shape, SpectralShape(340, 820, 20)) + assert self._sd.shape == SpectralShape(340, 820, 20) def test__init__(self): """ @@ -1545,7 +1540,7 @@ def test_interpolate(self): np.testing.assert_allclose( sd.values, DATA_SAMPLE_INTERPOLATED, atol=TOLERANCE_ABSOLUTE_TESTS ) - self.assertEqual(sd.shape, shape) + assert sd.shape == shape shape = SpectralShape( self._non_uniform_sd.shape.start, @@ -1558,13 +1553,10 @@ def test_interpolate(self): DATA_SAMPLE_INTERPOLATED_NON_UNIFORM, atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual( - sd.shape, - SpectralShape( - np.ceil(self._non_uniform_sd.shape.start), - np.floor(self._non_uniform_sd.shape.end), - 1, - ), + assert sd.shape == SpectralShape( + np.ceil(self._non_uniform_sd.shape.start), + np.floor(self._non_uniform_sd.shape.end), + 1, ) def test_extrapolate(self): @@ -1580,9 +1572,7 @@ def test_extrapolate(self): np.testing.assert_allclose(sd[10], 0, atol=TOLERANCE_ABSOLUTE_TESTS) np.testing.assert_allclose(sd[50], 1, atol=TOLERANCE_ABSOLUTE_TESTS) - sd = SpectralDistribution( - np.linspace(0, 1, 10), np.linspace(25, 35, 10) - ) + sd = SpectralDistribution(np.linspace(0, 1, 10), np.linspace(25, 35, 10)) shape = SpectralShape(10, 50, 10) sd.extrapolate( shape, @@ -1607,10 +1597,10 @@ def test_align(self): """ shape = SpectralShape(100, 900, 5) - self.assertEqual(self._sd.copy().align(shape).shape, shape) + assert self._sd.copy().align(shape).shape == shape shape = SpectralShape(600, 650, 1) - self.assertEqual(self._sd.copy().align(shape).shape, shape) + assert self._sd.copy().align(shape).shape == shape def test_trim(self): """ @@ -1619,10 +1609,10 @@ def test_trim(self): """ shape = SpectralShape(400, 700, 20) - self.assertEqual(self._sd.copy().trim(shape).shape, shape) + assert self._sd.copy().trim(shape).shape == shape shape = SpectralShape(200, 900, 1) - self.assertEqual(self._sd.copy().trim(shape).shape, self._sd.shape) + assert self._sd.copy().trim(shape).shape == self._sd.shape def test_normalise(self): """ @@ -1643,18 +1633,18 @@ def test_callback_on_domain_changed(self): """ sd = self._sd.copy() - self.assertEqual(sd.shape, SpectralShape(340, 820, 20)) + assert sd.shape == SpectralShape(340, 820, 20) sd[840] = 0 - self.assertEqual(sd.shape, SpectralShape(340, 840, 20)) + assert sd.shape == SpectralShape(340, 840, 20) -class TestMultiSpectralDistributions(unittest.TestCase): +class TestMultiSpectralDistributions: """ Define :class:`colour.colorimetry.spectrum.MultiSpectralDistributions` class unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._labels = ("x_bar", "y_bar", "z_bar") @@ -1706,7 +1696,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(MultiSpectralDistributions)) + assert attribute in dir(MultiSpectralDistributions) def test_required_methods(self): """Test the presence of required methods.""" @@ -1722,7 +1712,7 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(MultiSpectralDistributions)) + assert method in dir(MultiSpectralDistributions) def test_pickling(self): """ @@ -1732,7 +1722,7 @@ def test_pickling(self): data = pickle.dumps(self._msds) data = pickle.loads(data) # noqa: S301 - self.assertEqual(self._msds, data) + assert self._msds == data def test_display_name(self): """ @@ -1740,10 +1730,10 @@ def test_display_name(self): property. """ - self.assertEqual(self._sample_msds.display_name, "Sample Observer") - self.assertEqual( - self._non_uniform_sample_msds.display_name, - "Display Non Uniform Sample Observer", + assert self._sample_msds.display_name == "Sample Observer" + assert ( + self._non_uniform_sample_msds.display_name + == "Display Non Uniform Sample Observer" ) def test_wavelengths(self): @@ -1752,9 +1742,7 @@ def test_wavelengths(self): property. """ - np.testing.assert_array_equal( - self._msds.wavelengths, self._msds.domain - ) + np.testing.assert_array_equal(self._msds.wavelengths, self._msds.domain) msds = self._msds.copy() msds.wavelengths = msds.wavelengths + 10 @@ -1778,12 +1766,11 @@ def test_display_labels(self): display_labels` property. """ - self.assertTupleEqual( - tuple(self._sample_msds.display_labels), self._labels - ) - self.assertEqual( - tuple(self._non_uniform_sample_msds.display_labels), - ("Display x_bar", "Display y_bar", "Display z_bar"), + assert tuple(self._sample_msds.display_labels) == self._labels + assert tuple(self._non_uniform_sample_msds.display_labels) == ( + "Display x_bar", + "Display y_bar", + "Display z_bar", ) def test_shape(self): @@ -1792,7 +1779,7 @@ def test_shape(self): property. """ - self.assertEqual(self._msds.shape, SpectralShape(380, 780, 5)) + assert self._msds.shape == SpectralShape(380, 780, 5) def test__init__(self): """ @@ -1825,7 +1812,7 @@ def test_interpolate(self): DATA_SAMPLE_INTERPOLATED, atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(msds.shape, shape) + assert msds.shape == shape shape = SpectralShape( self._non_uniform_sample_msds.shape.start, @@ -1843,13 +1830,10 @@ def test_interpolate(self): DATA_SAMPLE_INTERPOLATED_NON_UNIFORM, atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual( - msds.shape, - SpectralShape( - np.ceil(self._non_uniform_sample_msds.shape.start), - np.floor(self._non_uniform_sample_msds.shape.end), - 1, - ), + assert msds.shape == SpectralShape( + np.ceil(self._non_uniform_sample_msds.shape.start), + np.floor(self._non_uniform_sample_msds.shape.end), + 1, ) def test_extrapolate(self): @@ -1898,10 +1882,10 @@ def test_align(self): msds = self._sample_msds.copy() shape = SpectralShape(100, 900, 5) - self.assertEqual(msds.align(shape).shape, shape) + assert msds.align(shape).shape == shape shape = SpectralShape(600, 650, 1) - self.assertEqual(msds.align(shape).shape, shape) + assert msds.align(shape).shape == shape def test_trim(self): """ @@ -1910,10 +1894,10 @@ def test_trim(self): """ shape = SpectralShape(400, 700, 5) - self.assertEqual(self._msds.copy().trim(shape).shape, shape) + assert self._msds.copy().trim(shape).shape == shape shape = SpectralShape(200, 900, 1) - self.assertEqual(self._msds.copy().trim(shape).shape, self._msds.shape) + assert self._msds.copy().trim(shape).shape == self._msds.shape def test_normalise(self): """ @@ -1934,11 +1918,11 @@ def test_to_sds(self): """ sds = self._non_uniform_sample_msds.to_sds() - self.assertEqual(len(sds), 3) + assert len(sds) == 3 for i, sd in enumerate(sds): - self.assertEqual(sd.name, self._labels[i]) - self.assertEqual(sd.display_name, self._display_labels[i]) + assert sd.name == self._labels[i] + assert sd.display_name == self._display_labels[i] def test_callback_on_domain_changed(self): """ @@ -1948,12 +1932,12 @@ def test_callback_on_domain_changed(self): """ msds = self._msds.copy() - self.assertEqual(msds.shape, SpectralShape(380, 780, 5)) + assert msds.shape == SpectralShape(380, 780, 5) msds[785] = 0 - self.assertEqual(msds.shape, SpectralShape(380, 785, 5)) + assert msds.shape == SpectralShape(380, 785, 5) -class TestReshapeSd(unittest.TestCase): +class TestReshapeSd: """ Define :func:`colour.colorimetry.spectrum.reshape_sd` definition unit tests methods. @@ -1964,8 +1948,8 @@ def test_reshape_sd(self): sd = SpectralDistribution(DATA_SAMPLE_ABRIDGED) sd_reshaped = reshape_sd(sd) - self.assertEqual(sd_reshaped, sd.copy().align(SPECTRAL_SHAPE_DEFAULT)) - self.assertEqual(reshape_sd(sd), sd_reshaped) + assert sd_reshaped == sd.copy().align(SPECTRAL_SHAPE_DEFAULT) + assert reshape_sd(sd) == sd_reshaped shape = colour.SpectralShape(100, 900, 1) extrapolator_kwargs = { @@ -1979,11 +1963,8 @@ def test_reshape_sd(self): method="Extrapolate", extrapolator_kwargs=extrapolator_kwargs, ) - self.assertEqual( - sd_reshaped, - sd.copy().extrapolate( - shape, extrapolator_kwargs=extrapolator_kwargs - ), + assert sd_reshaped == sd.copy().extrapolate( + shape, extrapolator_kwargs=extrapolator_kwargs ) shape = colour.SpectralShape(400, 700, 1) @@ -1995,27 +1976,22 @@ def test_reshape_sd(self): interpolator=CubicSplineInterpolator, interpolator_kwargs=interpolator_kwargs, ) - self.assertEqual( - sd_reshaped, - sd.copy().interpolate( - shape, - interpolator=CubicSplineInterpolator, - interpolator_kwargs=interpolator_kwargs, - ), + assert sd_reshaped == sd.copy().interpolate( + shape, + interpolator=CubicSplineInterpolator, + interpolator_kwargs=interpolator_kwargs, ) sd = SpectralDistribution(DATA_SAMPLE) shape = colour.SpectralShape(500, 600, 1) sd_reshaped = reshape_sd(sd, shape, method="Trim") - self.assertEqual(sd_reshaped, sd.copy().trim(shape)) + assert sd_reshaped == sd.copy().trim(shape) if is_caching_enabled(): - self.assertIs( - reshape_sd(sd, shape, method="Trim", copy=False), sd_reshaped - ) + assert reshape_sd(sd, shape, method="Trim", copy=False) is sd_reshaped -class TestSdsAndMdsToSds(unittest.TestCase): +class TestSdsAndMdsToSds: """ Define :func:`colour.colorimetry.spectrum.sds_and_msds_to_sds` definition unit tests methods. @@ -2032,8 +2008,8 @@ def test_sds_and_msds_to_sds(self): multi_sds_1 = MultiSpectralDistributions(DATA_MULTI_SAMPLE_ABRIDGED) multi_sds_2 = MultiSpectralDistributions(DATA_MULTI_SAMPLE_ABRIDGED) - self.assertEqual(sds_and_msds_to_sds(sd_1), [sd_1]) - self.assertEqual( + assert sds_and_msds_to_sds(sd_1) == [sd_1] + assert ( len( sds_and_msds_to_sds( [ @@ -2043,14 +2019,14 @@ def test_sds_and_msds_to_sds(self): multi_sds_2, ] ) - ), - 8, + ) + == 8 ) - self.assertEqual(len(sds_and_msds_to_sds(multi_sds_1)), 3) + assert len(sds_and_msds_to_sds(multi_sds_1)) == 3 -class TestSdsAndMsdsToMsds(unittest.TestCase): +class TestSdsAndMsdsToMsds: """ Define :func:`colour.colorimetry.spectrum.sds_and_msds_to_msds` definition unit tests methods. @@ -2067,46 +2043,31 @@ def test_sds_and_msds_to_msds(self): multi_sds_1 = MultiSpectralDistributions(DATA_MULTI_SAMPLE_ABRIDGED) multi_sds_2 = MultiSpectralDistributions(DATA_MULTI_SAMPLE_ABRIDGED) - self.assertEqual(len(sds_and_msds_to_msds(sd_1)), 6) + assert len(sds_and_msds_to_msds(sd_1)) == 6 - self.assertEqual(sds_and_msds_to_msds(multi_sds_1), multi_sds_1) + assert sds_and_msds_to_msds(multi_sds_1) == multi_sds_1 multi_sds_0 = sds_and_msds_to_msds([multi_sds_1]) np.testing.assert_array_equal(multi_sds_0.range, multi_sds_1.range) - self.assertEqual(sds_and_msds_to_msds([multi_sds_1]), multi_sds_1) + assert sds_and_msds_to_msds([multi_sds_1]) == multi_sds_1 shape = SpectralShape(500, 560, 10) - self.assertEqual( - sds_and_msds_to_msds([sd_1, sd_2, multi_sds_1, multi_sds_2]).shape, - shape, + assert ( + sds_and_msds_to_msds([sd_1, sd_2, multi_sds_1, multi_sds_2]).shape == shape ) np.testing.assert_allclose( - sds_and_msds_to_msds( - [sd_1, sd_2, multi_sds_1, multi_sds_2] - ).wavelengths, + sds_and_msds_to_msds([sd_1, sd_2, multi_sds_1, multi_sds_2]).wavelengths, shape.wavelengths, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - sds_and_msds_to_msds( - [sd_1, sd_2, multi_sds_1, multi_sds_2] - ).values, + sds_and_msds_to_msds([sd_1, sd_2, multi_sds_1, multi_sds_2]).values, tstack( [sd_1.align(shape).values, sd_2.align(shape).values] - + [ - sd.values - for sd in sds_and_msds_to_sds(multi_sds_1.align(shape)) - ] - + [ - sd.values - for sd in sds_and_msds_to_sds(multi_sds_2.align(shape)) - ] + + [sd.values for sd in sds_and_msds_to_sds(multi_sds_1.align(shape))] + + [sd.values for sd in sds_and_msds_to_sds(multi_sds_2.align(shape))] ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_transformations.py b/colour/colorimetry/tests/test_transformations.py index 29b88ea0c3..4bd50667bc 100644 --- a/colour/colorimetry/tests/test_transformations.py +++ b/colour/colorimetry/tests/test_transformations.py @@ -3,7 +3,6 @@ module. """ -import unittest import numpy as np @@ -34,7 +33,7 @@ ] -class TestRGB_2_degree_cmfs_to_XYZ_2_degree_cmfs(unittest.TestCase): +class TestRGB_2_degree_cmfs_to_XYZ_2_degree_cmfs: """ Define :func:`colour.colorimetry.transformations.\ RGB_2_degree_cmfs_to_XYZ_2_degree_cmfs` definition unit tests methods. @@ -105,7 +104,7 @@ def test_nan_RGB_2_degree_cmfs_to_XYZ_2_degree_cmfs(self): ) -class TestRGB_10_degree_cmfs_to_XYZ_10_degree_cmfs(unittest.TestCase): +class TestRGB_10_degree_cmfs_to_XYZ_10_degree_cmfs: """ Define :func:`colour.colorimetry.transformations.\ RGB_10_degree_cmfs_to_XYZ_10_degree_cmfs` definition unit tests methods. @@ -182,7 +181,7 @@ def test_nan_RGB_10_degree_cmfs_to_XYZ_10_degree_cmfs(self): ) -class TestRGB_10_degree_cmfs_to_LMS_10_degree_cmfs(unittest.TestCase): +class TestRGB_10_degree_cmfs_to_LMS_10_degree_cmfs: """ Define :func:`colour.colorimetry.transformations.\ RGB_10_degree_cmfs_to_LMS_10_degree_cmfs` definition unit tests methods. @@ -259,7 +258,7 @@ def test_nan_RGB_10_degree_cmfs_to_LMS_10_degree_cmfs(self): ) -class TestLMS_2_degree_cmfs_to_XYZ_2_degree_cmfs(unittest.TestCase): +class TestLMS_2_degree_cmfs_to_XYZ_2_degree_cmfs: """ Define :func:`colour.colorimetry.transformations.\ LMS_2_degree_cmfs_to_XYZ_2_degree_cmfs` definition unit tests methods. @@ -336,7 +335,7 @@ def test_nan_LMS_2_degree_cmfs_to_XYZ_2_degree_cmfs(self): ) -class TestLMS_10_degree_cmfs_to_XYZ_10_degree_cmfs(unittest.TestCase): +class TestLMS_10_degree_cmfs_to_XYZ_10_degree_cmfs: """ Define :func:`colour.colorimetry.transformations.\ LMS_10_degree_cmfs_to_XYZ_10_degree_cmfs` definition unit tests methods. @@ -411,7 +410,3 @@ def test_nan_LMS_10_degree_cmfs_to_XYZ_10_degree_cmfs(self): LMS_10_degree_cmfs_to_XYZ_10_degree_cmfs( np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_tristimulus_values.py b/colour/colorimetry/tests/test_tristimulus_values.py index 4533db9857..61ad451b1c 100644 --- a/colour/colorimetry/tests/test_tristimulus_values.py +++ b/colour/colorimetry/tests/test_tristimulus_values.py @@ -11,11 +11,11 @@ from __future__ import annotations -import unittest - import numpy as np +import pytest from colour.algebra import LinearInterpolator, SpragueInterpolator +from colour.characterisation import SDS_COLOURCHECKERS from colour.colorimetry import ( MSDS_CMFS, SDS_ILLUMINANTS, @@ -37,6 +37,7 @@ sd_to_XYZ_integration, sd_to_XYZ_tristimulus_weighting_factors_ASTME308, sd_zeros, + sds_and_msds_to_msds, tristimulus_weighting_factors_ASTME2022, wavelength_to_XYZ, ) @@ -577,7 +578,7 @@ ) -class TestHandleSpectralArguments(unittest.TestCase): +class TestHandleSpectralArguments: """ Define :func:`colour.colorimetry.tristimulus_values.\ handle_spectral_arguments` definition unit tests methods. @@ -590,34 +591,26 @@ def test_handle_spectral_arguments(self): """ cmfs, illuminant = handle_spectral_arguments() - self.assertEqual( - cmfs, - reshape_msds(MSDS_CMFS["CIE 1931 2 Degree Standard Observer"]), - ) - self.assertEqual(illuminant, reshape_sd(SDS_ILLUMINANTS["D65"])) + assert cmfs == reshape_msds(MSDS_CMFS["CIE 1931 2 Degree Standard Observer"]) + assert illuminant == reshape_sd(SDS_ILLUMINANTS["D65"]) shape = SpectralShape(400, 700, 20) cmfs, illuminant = handle_spectral_arguments(shape_default=shape) - self.assertEqual(cmfs.shape, shape) - self.assertEqual(illuminant.shape, shape) + assert cmfs.shape == shape + assert illuminant.shape == shape cmfs, illuminant = handle_spectral_arguments( cmfs_default="CIE 2015 2 Degree Standard Observer", illuminant_default="E", shape_default=shape, ) - self.assertEqual( - cmfs, - reshape_msds( - MSDS_CMFS["CIE 2015 2 Degree Standard Observer"], shape=shape - ), - ) - self.assertEqual( - illuminant, sd_ones(shape, interpolator=LinearInterpolator) * 100 + assert cmfs == reshape_msds( + MSDS_CMFS["CIE 2015 2 Degree Standard Observer"], shape=shape ) + assert illuminant == sd_ones(shape, interpolator=LinearInterpolator) * 100 -class TestLagrangeCoefficientsASTME2022(unittest.TestCase): +class TestLagrangeCoefficientsASTME2022: """ Define :func:`colour.colorimetry.tristimulus_values.\ lagrange_coefficients_ASTME2022` definition unit tests methods. @@ -659,7 +652,7 @@ def test_lagrange_coefficients_ASTME2022(self): ) -class TestTristimulusWeightingFactorsASTME2022(unittest.TestCase): +class TestTristimulusWeightingFactorsASTME2022: """ Define :func:`colour.colorimetry.tristimulus_values.\ tristimulus_weighting_factors_ASTME2022` definition unit tests methods. @@ -687,16 +680,12 @@ def test_tristimulus_weighting_factors_ASTME2022(self): twf = tristimulus_weighting_factors_ASTME2022( cmfs, A, SpectralShape(360, 830, 10) ) - np.testing.assert_allclose( - np.round(twf, 3), TWF_A_CIE_1964_10_10, atol=1e-5 - ) + np.testing.assert_allclose(np.round(twf, 3), TWF_A_CIE_1964_10_10, atol=1e-5) twf = tristimulus_weighting_factors_ASTME2022( cmfs, A, SpectralShape(360, 830, 20) ) - np.testing.assert_allclose( - np.round(twf, 3), TWF_A_CIE_1964_10_20, atol=1e-5 - ) + np.testing.assert_allclose(np.round(twf, 3), TWF_A_CIE_1964_10_20, atol=1e-5) cmfs = MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] D65 = reshape_sd( @@ -752,7 +741,7 @@ def test_raise_exception_tristimulus_weighting_factors_ASTME2022(self): A_1 = sd_CIE_standard_illuminant_A(cmfs_1.shape) A_2 = sd_CIE_standard_illuminant_A(cmfs_2.shape) - self.assertRaises( + pytest.raises( ValueError, tristimulus_weighting_factors_ASTME2022, cmfs_1, @@ -760,7 +749,7 @@ def test_raise_exception_tristimulus_weighting_factors_ASTME2022(self): shape, ) - self.assertRaises( + pytest.raises( ValueError, tristimulus_weighting_factors_ASTME2022, cmfs_2, @@ -769,7 +758,7 @@ def test_raise_exception_tristimulus_weighting_factors_ASTME2022(self): ) -class TestAdjustTristimulusWeightingFactorsASTME308(unittest.TestCase): +class TestAdjustTristimulusWeightingFactorsASTME308: """ Define :func:`colour.colorimetry.tristimulus_values.\ adjust_tristimulus_weighting_factors_ASTME308` definition unit tests methods. @@ -792,7 +781,7 @@ def test_adjust_tristimulus_weighting_factors_ASTME308(self): ) -class TestSd_to_XYZ_integration(unittest.TestCase): +class TestSd_to_XYZ_integration: """ Define :func:`colour.colorimetry.tristimulus_values.sd_to_XYZ_integration` definition unit tests methods. @@ -835,11 +824,20 @@ def test_sd_to_XYZ_integration(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) + np.testing.assert_allclose( + sd_to_XYZ_integration(SD_SAMPLE, cmfs, SDS_ILLUMINANTS["FL2"], k=683), + np.array([1223.7509261493, 1055.7284645912, 417.8501342332]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + np.testing.assert_allclose( sd_to_XYZ_integration( - SD_SAMPLE, cmfs, SDS_ILLUMINANTS["FL2"], k=683 + SD_SAMPLE, + cmfs, + SDS_ILLUMINANTS["FL2"], + shape=SpectralShape(400, 700, 20), ), - np.array([1223.7509261493, 1055.7284645912, 417.8501342332]), + np.array([11.98232967, 10.13543929, 3.66442524]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -856,15 +854,13 @@ def test_domain_range_scale_sd_to_XYZ_integration(self): for scale, factor in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - sd_to_XYZ_integration( - SD_SAMPLE, cmfs, SDS_ILLUMINANTS["A"] - ), + sd_to_XYZ_integration(SD_SAMPLE, cmfs, SDS_ILLUMINANTS["A"]), XYZ * factor, atol=TOLERANCE_ABSOLUTE_TESTS, ) -class TestSd_to_XYZ_tristimulus_weighting_factors_ASTME308(unittest.TestCase): +class TestSd_to_XYZ_tristimulus_weighting_factors_ASTME308: """ Define :func:`colour.colorimetry.tristimulus_values.\ sd_to_XYZ_tristimulus_weighting_factors_ASTME308` @@ -916,9 +912,7 @@ def test_sd_to_XYZ_tristimulus_weighting_factors_ASTME308(self): np.testing.assert_allclose( sd_to_XYZ_tristimulus_weighting_factors_ASTME308( - reshape_sd( - SD_SAMPLE, SpectralShape(400, 700, 10), "Interpolate" - ), + reshape_sd(SD_SAMPLE, SpectralShape(400, 700, 10), "Interpolate"), cmfs, SDS_ILLUMINANTS["A"], ), @@ -928,9 +922,7 @@ def test_sd_to_XYZ_tristimulus_weighting_factors_ASTME308(self): np.testing.assert_allclose( sd_to_XYZ_tristimulus_weighting_factors_ASTME308( - reshape_sd( - SD_SAMPLE, SpectralShape(400, 700, 20), "Interpolate" - ), + reshape_sd(SD_SAMPLE, SpectralShape(400, 700, 20), "Interpolate"), cmfs, SDS_ILLUMINANTS["A"], ), @@ -940,9 +932,7 @@ def test_sd_to_XYZ_tristimulus_weighting_factors_ASTME308(self): np.testing.assert_allclose( sd_to_XYZ_tristimulus_weighting_factors_ASTME308( - reshape_sd( - SD_SAMPLE, SpectralShape(400, 700, 20), "Interpolate" - ), + reshape_sd(SD_SAMPLE, SpectralShape(400, 700, 20), "Interpolate"), cmfs, SDS_ILLUMINANTS["A"], k=1, @@ -975,13 +965,13 @@ def test_domain_range_scale_sd_to_XYZ_twf_ASTME308(self): ) -class TestSd_to_XYZ_ASTME308(unittest.TestCase): +class TestSd_to_XYZ_ASTME308: """ Define :func:`colour.colorimetry.tristimulus_values.sd_to_XYZ_ASTME308` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._sd = SD_SAMPLE.copy() @@ -1341,20 +1331,20 @@ def test_raise_exception_sd_to_XYZ_ASTME308(self): definition raised exception. """ - self.assertRaises( + pytest.raises( ValueError, sd_to_XYZ_ASTME308, reshape_sd(self._sd, SpectralShape(360, 820, 2)), ) -class TestSd_to_XYZ(unittest.TestCase): +class TestSd_to_XYZ: """ Define :func:`colour.colorimetry.tristimulus_values.sd_to_XYZ` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._cmfs = MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] @@ -1384,8 +1374,55 @@ def test_sd_to_XYZ(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) + np.testing.assert_allclose( + sd_to_XYZ( + self._sd, + self._cmfs, + self._A, + method="Integration", + shape=SpectralShape(400, 700, 20), + ), + np.array([14.52005467, 10.88000966, 2.03888717]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + sd_to_XYZ( + sds_and_msds_to_msds(SDS_COLOURCHECKERS["babel_average"].values()), + ), + np.array( + [ + [12.06344619, 10.33615020, 6.25100082], + [40.27284790, 35.29615976, 23.01540616], + [18.09306423, 18.50797244, 31.67770084], + [11.16523793, 13.25122619, 6.36666038], + [25.83420330, 23.32560917, 40.31232440], + [31.64244829, 41.64149301, 40.76605171], + [40.89999141, 31.22508083, 5.82002195], + [13.60742370, 11.51655221, 35.39885724], + [30.69032237, 19.87942885, 12.46562439], + [8.93362430, 6.46162368, 13.07228804], + [35.66114785, 44.08411919, 10.28724123], + [49.24169657, 43.46327044, 7.13506647], + [7.81888273, 5.89050934, 25.75773837], + [15.18817149, 22.93975934, 8.94663877], + [22.23187260, 12.73987267, 4.62599881], + [60.68157753, 60.55780947, 8.43465082], + [32.27071879, 20.22049576, 28.85354643], + [14.49902213, 19.10377565, 35.60283004], + [90.78293221, 91.26928233, 87.29499532], + [58.53195263, 58.84257471, 58.34877604], + [35.77113141, 35.94371650, 35.85712527], + [18.98962045, 19.11651714, 19.15115933], + [8.87518188, 8.93947283, 9.06486638], + [3.21099614, 3.20073667, 3.25495104], + ] + ), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + -class TestMsds_to_XYZ_integration(unittest.TestCase): +class TestMsds_to_XYZ_integration: """ Define :func:`colour.colorimetry.tristimulus_values.\ msds_to_XYZ_integration` definition unit tests methods. @@ -1449,7 +1486,7 @@ def test_domain_range_scale_msds_to_XYZ_integration(self): ) -class TestMsds_to_XYZ_ASTME308(unittest.TestCase): +class TestMsds_to_XYZ_ASTME308: """ Define :func:`colour.colorimetry.tristimulus_values.msds_to_XYZ_ASTME308` definition unit tests methods. @@ -1501,17 +1538,17 @@ def test_raise_exception_msds_to_XYZ_ASTME308(self): msds_to_XYZ_ASTME308` definition raise exception. """ - self.assertRaises(TypeError, msds_to_XYZ_ASTME308, DATA_TWO) + pytest.raises(TypeError, msds_to_XYZ_ASTME308, DATA_TWO) -class TestAbsoluteIntegrationToXYZ(unittest.TestCase): +class TestAbsoluteIntegrationToXYZ: """ Test the absolute integration to tristimulus values for :math:`k = 683` """ def test_absolute_integration_to_TVS_1nm(self): """ - Test the absolute, i.e. user given :math:`k` value, integration to + Test the absolute, i.e., user given :math:`k` value, integration to tristimulus values for 1nm interval. """ @@ -1532,10 +1569,13 @@ def test_absolute_integration_to_TVS_1nm(self): # Test single spectral distribution integration methods. for method in methods[0:3]: XYZ = method(sd, k=k) - XYZ = XYZ.reshape(3) if len(XYZ.shape) > 1 else XYZ - np.testing.assert_allclose(XYZ[1], k, atol=5e-5), ( - "1 watt @ 555nm should be approximately 683 candela." - f" Failed method: {method}" + XYZ = np.reshape(XYZ, 3) if len(XYZ.shape) > 1 else XYZ + ( + np.testing.assert_allclose(XYZ[1], k, atol=5e-5), + ( + "1 watt @ 555nm should be approximately 683 candela." + f" Failed method: {method}" + ), ) # Test multi-spectral distributions integration methods. @@ -1543,22 +1583,23 @@ def test_absolute_integration_to_TVS_1nm(self): for method in methods[3:6]: XYZ: np.ndarray = method(msds, k=k) if len(XYZ.shape) > 1: - XYZ = XYZ.reshape(3) - np.testing.assert_allclose(XYZ[1], k, atol=5e-5), ( - "1 watt @ 555nm should be approximately 683 candela." - f" Failed method: {method}" + XYZ = np.reshape(XYZ, 3) + ( + np.testing.assert_allclose(XYZ[1], k, atol=5e-5), + ( + "1 watt @ 555nm should be approximately 683 candela." + f" Failed method: {method}" + ), ) def test_absolute_integration_to_TVS_5nm(self): """ - Test the absolute, i.e. user given :math:`k` value, integration to + Test the absolute, i.e., user given :math:`k` value, integration to tristimulus values for 5nm interval by ensuring that the *Riemann Sum* accounts for the :math:`\\delta w` term. """ - sd = sd_zeros( - SpectralShape(380, 780, 5), interpolator=SpragueInterpolator - ) + sd = sd_zeros(SpectralShape(380, 780, 5), interpolator=SpragueInterpolator) # 1 watt at 555nm, 0 watt everywhere else. # For 5nm average sampling, this corresponds to 0.2 watt at 555nm. @@ -1577,10 +1618,13 @@ def test_absolute_integration_to_TVS_5nm(self): # Test single spectral distribution integration methods. for method in methods[0:3]: XYZ: np.ndarray = method(sd, k=k) - XYZ = XYZ.reshape(3) if len(XYZ.shape) > 1 else XYZ - np.testing.assert_allclose(XYZ[1], k, atol=5e-2), ( - "1 watt @ 555nm should be approximately 683 candela. " - f"Failed method: {method}" + XYZ = np.reshape(XYZ, 3) if len(XYZ.shape) > 1 else XYZ + ( + np.testing.assert_allclose(XYZ[1], k, atol=5e-2), + ( + "1 watt @ 555nm should be approximately 683 candela. " + f"Failed method: {method}" + ), ) # Test multi-spectral distributions integration methods. @@ -1588,14 +1632,17 @@ def test_absolute_integration_to_TVS_5nm(self): for method in methods[3:6]: XYZ: np.ndarray = method(msds, k=k) if len(XYZ.shape) > 1: - XYZ = XYZ.reshape(3) - np.testing.assert_allclose(XYZ[1], k, atol=5e-2), ( - "1 watt @ 555nm should be approximately 683 candela." - f"Failed method: {method}" + XYZ = np.reshape(XYZ, 3) + ( + np.testing.assert_allclose(XYZ[1], k, atol=5e-2), + ( + "1 watt @ 555nm should be approximately 683 candela." + f"Failed method: {method}" + ), ) -class TestWavelength_to_XYZ(unittest.TestCase): +class TestWavelength_to_XYZ: """ Define :func:`colour.colorimetry.tristimulus_values.wavelength_to_XYZ` definition unit tests methods. @@ -1608,25 +1655,19 @@ def test_wavelength_to_XYZ(self): """ np.testing.assert_allclose( - wavelength_to_XYZ( - 480, MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] - ), + wavelength_to_XYZ(480, MSDS_CMFS["CIE 1931 2 Degree Standard Observer"]), np.array([0.09564, 0.13902, 0.81295]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - wavelength_to_XYZ( - 480, MSDS_CMFS["CIE 2015 2 Degree Standard Observer"] - ), + wavelength_to_XYZ(480, MSDS_CMFS["CIE 2015 2 Degree Standard Observer"]), np.array([0.08182895, 0.17880480, 0.75523790]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - wavelength_to_XYZ( - 641.5, MSDS_CMFS["CIE 2015 2 Degree Standard Observer"] - ), + wavelength_to_XYZ(641.5, MSDS_CMFS["CIE 2015 2 Degree Standard Observer"]), np.array([0.44575583, 0.18184213, 0.00000000]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -1637,9 +1678,9 @@ def test_raise_exception_wavelength_to_XYZ(self): definition raised exception. """ - self.assertRaises(ValueError, wavelength_to_XYZ, 1) + pytest.raises(ValueError, wavelength_to_XYZ, 1) - self.assertRaises(ValueError, wavelength_to_XYZ, 1000) + pytest.raises(ValueError, wavelength_to_XYZ, 1000) def test_n_dimensional_wavelength_to_XYZ(self): """ @@ -1668,7 +1709,3 @@ def test_n_dimensional_wavelength_to_XYZ(self): np.testing.assert_allclose( wavelength_to_XYZ(wl, cmfs), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_uniformity.py b/colour/colorimetry/tests/test_uniformity.py index 46958a2498..e9bd5ea192 100644 --- a/colour/colorimetry/tests/test_uniformity.py +++ b/colour/colorimetry/tests/test_uniformity.py @@ -1,10 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.uniformity` module.""" from __future__ import annotations -import unittest - import numpy as np from colour.colorimetry import spectral_uniformity @@ -224,7 +221,7 @@ ) -class TestSpectralUniformity(unittest.TestCase): +class TestSpectralUniformity: """ Define :func:`colour.colorimetry.uniformity.spectral_uniformity` definition unit tests methods. @@ -245,13 +242,7 @@ def test_spectral_uniformity(self): ) np.testing.assert_allclose( - spectral_uniformity( - SDS_TCS.values(), use_second_order_derivatives=True - ), + spectral_uniformity(SDS_TCS.values(), use_second_order_derivatives=True), DATA_UNIFORMITY_SECOND_ORDER_DERIVATIVES, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_whiteness.py b/colour/colorimetry/tests/test_whiteness.py index f71fe15051..df51083ad1 100644 --- a/colour/colorimetry/tests/test_whiteness.py +++ b/colour/colorimetry/tests/test_whiteness.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.whiteness` module.""" -import unittest from itertools import product import numpy as np @@ -36,7 +34,7 @@ ] -class TestWhitenessBerger1959(unittest.TestCase): +class TestWhitenessBerger1959: """ Define :func:`colour.colorimetry.whiteness.whiteness_Berger1959` definition unit tests methods. @@ -130,7 +128,7 @@ def test_nan_whiteness_Berger1959(self): whiteness_Berger1959(cases, cases) -class TestWhitenessTaube1960(unittest.TestCase): +class TestWhitenessTaube1960: """ Define :func:`colour.colorimetry.whiteness.whiteness_Taube1960` definition unit tests methods. @@ -224,7 +222,7 @@ def test_nan_whiteness_Berger1959(self): whiteness_Berger1959(cases, cases) -class TestWhitenessStensby1968(unittest.TestCase): +class TestWhitenessStensby1968: """ Define :func:`colour.colorimetry.whiteness.whiteness_Stensby1968` definition unit tests methods. @@ -237,17 +235,13 @@ def test_whiteness_Stensby1968(self): """ np.testing.assert_allclose( - whiteness_Stensby1968( - np.array([100.00000000, -2.46875131, -16.72486654]) - ), + whiteness_Stensby1968(np.array([100.00000000, -2.46875131, -16.72486654])), 142.76834569, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - whiteness_Stensby1968( - np.array([100.00000000, 14.40943727, -9.61394885]) - ), + whiteness_Stensby1968(np.array([100.00000000, 14.40943727, -9.61394885])), 172.07015836, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -309,7 +303,7 @@ def test_nan_whiteness_Stensby1968(self): whiteness_Stensby1968(cases) -class TestWhitenessASTM313(unittest.TestCase): +class TestWhitenessASTM313: """ Define :func:`colour.colorimetry.whiteness.whiteness_ASTME313` definition unit tests methods. @@ -322,25 +316,19 @@ def test_whiteness_ASTME313(self): """ np.testing.assert_allclose( - whiteness_ASTME313( - np.array([95.00000000, 100.00000000, 105.00000000]) - ), + whiteness_ASTME313(np.array([95.00000000, 100.00000000, 105.00000000])), 55.740000000000009, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - whiteness_ASTME313( - np.array([105.00000000, 100.00000000, 95.00000000]) - ), + whiteness_ASTME313(np.array([105.00000000, 100.00000000, 95.00000000])), 21.860000000000014, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - whiteness_ASTME313( - np.array([100.00000000, 100.00000000, 100.00000000]) - ), + whiteness_ASTME313(np.array([100.00000000, 100.00000000, 100.00000000])), 38.800000000000011, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -396,7 +384,7 @@ def test_nan_whiteness_ASTME313(self): whiteness_ASTME313(cases) -class TestWhitenessGanz1979(unittest.TestCase): +class TestWhitenessGanz1979: """ Define :func:`colour.colorimetry.whiteness.whiteness_Ganz1979` definition unit tests methods. @@ -485,7 +473,7 @@ def test_nan_whiteness_Ganz1979(self): whiteness_Ganz1979(cases[..., 0:2], cases[..., 0]) -class TestWhitenessCIE2004(unittest.TestCase): +class TestWhitenessCIE2004: """ Define :func:`colour.colorimetry.whiteness.whiteness_CIE2004` definition unit tests methods. @@ -584,7 +572,7 @@ def test_nan_whiteness_CIE2004(self): whiteness_CIE2004(cases[..., 0:2], cases[..., 0], cases[..., 0:2]) -class TestWhiteness(unittest.TestCase): +class TestWhiteness: """ Define :func:`colour.colorimetry.whiteness.whiteness` definition unit tests methods. @@ -618,7 +606,3 @@ def test_domain_range_scale_whiteness(self): value * factor, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/tests/test_yellowness.py b/colour/colorimetry/tests/test_yellowness.py index ea1423f24d..e3f15b06ba 100644 --- a/colour/colorimetry/tests/test_yellowness.py +++ b/colour/colorimetry/tests/test_yellowness.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.colorimetry.yellowness` module.""" -import unittest from itertools import product import numpy as np @@ -33,7 +31,7 @@ ] -class TestYellownessASTMD1925(unittest.TestCase): +class TestYellownessASTMD1925: """ Define :func:`colour.colorimetry.yellowness.yellowness_ASTMD1925` definition unit tests methods. @@ -46,25 +44,19 @@ def test_yellowness_ASTMD1925(self): """ np.testing.assert_allclose( - yellowness_ASTMD1925( - np.array([95.00000000, 100.00000000, 105.00000000]) - ), + yellowness_ASTMD1925(np.array([95.00000000, 100.00000000, 105.00000000])), 10.299999999999997, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - yellowness_ASTMD1925( - np.array([105.00000000, 100.00000000, 95.00000000]) - ), + yellowness_ASTMD1925(np.array([105.00000000, 100.00000000, 95.00000000])), 33.700000000000003, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - yellowness_ASTMD1925( - np.array([100.00000000, 100.00000000, 100.00000000]) - ), + yellowness_ASTMD1925(np.array([100.00000000, 100.00000000, 100.00000000])), 22.0, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -120,7 +112,7 @@ def test_nan_yellowness_ASTMD1925(self): yellowness_ASTMD1925(cases) -class TestYellownessASTM313Alternative(unittest.TestCase): +class TestYellownessASTM313Alternative: """ Define :func:`colour.colorimetry.yellowness.\ yellowness_ASTME313_alternative` definition unit tests methods. @@ -211,7 +203,7 @@ def test_nan_yellowness_ASTME313_alternative(self): yellowness_ASTME313_alternative(cases) -class TestYellownessASTM313(unittest.TestCase): +class TestYellownessASTM313: """ Define :func:`colour.colorimetry.yellowness.yellowness_ASTME313` definition unit tests methods. @@ -224,25 +216,19 @@ def test_yellowness_ASTME313(self): """ np.testing.assert_allclose( - yellowness_ASTME313( - np.array([95.00000000, 100.00000000, 105.00000000]) - ), + yellowness_ASTME313(np.array([95.00000000, 100.00000000, 105.00000000])), 4.340000000000003, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - yellowness_ASTME313( - np.array([105.00000000, 100.00000000, 95.00000000]) - ), + yellowness_ASTME313(np.array([105.00000000, 100.00000000, 95.00000000])), 28.660000000000011, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - yellowness_ASTME313( - np.array([100.00000000, 100.00000000, 100.00000000]) - ), + yellowness_ASTME313(np.array([100.00000000, 100.00000000, 100.00000000])), 16.500000000000000, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -250,9 +236,9 @@ def test_yellowness_ASTME313(self): np.testing.assert_allclose( yellowness_ASTME313( np.array([95.00000000, 100.00000000, 105.00000000]), - YELLOWNESS_COEFFICIENTS_ASTME313[ - "CIE 1931 2 Degree Standard Observer" - ]["C"], + YELLOWNESS_COEFFICIENTS_ASTME313["CIE 1931 2 Degree Standard Observer"][ + "C" + ], ), 10.089500000000001, atol=TOLERANCE_ABSOLUTE_TESTS, @@ -309,7 +295,7 @@ def test_nan_yellowness_ASTME313(self): yellowness_ASTME313(cases) -class TestYellowness(unittest.TestCase): +class TestYellowness: """ Define :func:`colour.colorimetry.yellowness.yellowness` definition unit tests methods. @@ -335,7 +321,3 @@ def test_domain_range_scale_yellowness(self): value * factor, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/colorimetry/transformations.py b/colour/colorimetry/transformations.py index 7927684bd4..2cccb70eda 100644 --- a/colour/colorimetry/transformations.py +++ b/colour/colorimetry/transformations.py @@ -2,7 +2,7 @@ Colour Matching Functions Transformations ========================================= -Defines various educational objects for colour matching functions +Define various educational objects for colour matching functions transformations: - :func:`colour.colorimetry.RGB_2_degree_cmfs_to_XYZ_2_degree_cmfs` @@ -34,7 +34,7 @@ import numpy as np -from colour.algebra import vector_dot +from colour.algebra import vecmul from colour.colorimetry import ( MSDS_CMFS_LMS, MSDS_CMFS_RGB, @@ -91,7 +91,6 @@ def RGB_2_degree_cmfs_to_XYZ_2_degree_cmfs( >>> from colour.utilities import numpy_print_options >>> with numpy_print_options(suppress=True): ... RGB_2_degree_cmfs_to_XYZ_2_degree_cmfs(700) # doctest: +ELLIPSIS - ... array([ 0.0113577..., 0.004102 , 0. ]) """ @@ -117,7 +116,7 @@ def RGB_2_degree_cmfs_to_XYZ_2_degree_cmfs( ] ) - xyz = vector_dot(M1, rgb) / vector_dot(M2, rgb) + xyz = vecmul(M1, rgb) / vecmul(M2, rgb) x, y, z = xyz[..., 0], xyz[..., 1], xyz[..., 2] @@ -169,7 +168,6 @@ def RGB_10_degree_cmfs_to_XYZ_10_degree_cmfs( >>> from colour.utilities import numpy_print_options >>> with numpy_print_options(suppress=True): ... RGB_10_degree_cmfs_to_XYZ_10_degree_cmfs(700) # doctest: +ELLIPSIS - ... array([ 0.0096432..., 0.0037526..., -0.0000041...]) """ @@ -185,7 +183,7 @@ def RGB_10_degree_cmfs_to_XYZ_10_degree_cmfs( ] ) - xyz_bar = vector_dot(M, rgb_bar) + xyz_bar = vecmul(M, rgb_bar) return xyz_bar @@ -223,7 +221,6 @@ def RGB_10_degree_cmfs_to_LMS_10_degree_cmfs( >>> from colour.utilities import numpy_print_options >>> with numpy_print_options(suppress=True): ... RGB_10_degree_cmfs_to_LMS_10_degree_cmfs(700) # doctest: +ELLIPSIS - ... array([ 0.0052860..., 0.0003252..., 0. ]) """ @@ -239,7 +236,7 @@ def RGB_10_degree_cmfs_to_LMS_10_degree_cmfs( ] ) - lms_bar = vector_dot(M, rgb_bar) + lms_bar = vecmul(M, rgb_bar) lms_bar[..., -1][np.asarray(np.asarray(wavelength) > 505)] = 0 return lms_bar @@ -277,7 +274,6 @@ def LMS_2_degree_cmfs_to_XYZ_2_degree_cmfs( >>> from colour.utilities import numpy_print_options >>> with numpy_print_options(suppress=True): ... LMS_2_degree_cmfs_to_XYZ_2_degree_cmfs(700) # doctest: +ELLIPSIS - ... array([ 0.0109677..., 0.0041959..., 0. ]) """ @@ -293,7 +289,7 @@ def LMS_2_degree_cmfs_to_XYZ_2_degree_cmfs( ] ) - xyz_bar = vector_dot(M, lms_bar) + xyz_bar = vecmul(M, lms_bar) return xyz_bar @@ -330,7 +326,6 @@ def LMS_10_degree_cmfs_to_XYZ_10_degree_cmfs( >>> from colour.utilities import numpy_print_options >>> with numpy_print_options(suppress=True): ... LMS_10_degree_cmfs_to_XYZ_10_degree_cmfs(700) # doctest: +ELLIPSIS - ... array([ 0.0098162..., 0.0037761..., 0. ]) """ @@ -346,6 +341,6 @@ def LMS_10_degree_cmfs_to_XYZ_10_degree_cmfs( ] ) - xyz_bar = vector_dot(M, lms_bar) + xyz_bar = vecmul(M, lms_bar) return xyz_bar diff --git a/colour/colorimetry/tristimulus_values.py b/colour/colorimetry/tristimulus_values.py index 4215ec5a9e..6f3f441d9d 100644 --- a/colour/colorimetry/tristimulus_values.py +++ b/colour/colorimetry/tristimulus_values.py @@ -2,7 +2,7 @@ Tristimulus Values ================== -Defines the objects for tristimulus values computation from spectral data: +Define the objects for tristimulus values computation from spectral data: - :attr:`colour.SPECTRAL_SHAPE_ASTME308` - :func:`colour.colorimetry.handle_spectral_arguments` @@ -106,19 +106,15 @@ :cite:`ASTMInternational2015b` """ -_CACHE_LAGRANGE_INTERPOLATING_COEFFICIENTS: dict = ( - CACHE_REGISTRY.register_cache( - f"{__name__}._CACHE_LAGRANGE_INTERPOLATING_COEFFICIENTS" - ) +_CACHE_LAGRANGE_INTERPOLATING_COEFFICIENTS: dict = CACHE_REGISTRY.register_cache( + f"{__name__}._CACHE_LAGRANGE_INTERPOLATING_COEFFICIENTS" ) _CACHE_TRISTIMULUS_WEIGHTING_FACTORS: dict = CACHE_REGISTRY.register_cache( f"{__name__}._CACHE_TRISTIMULUS_WEIGHTING_FACTORS" ) -_CACHE_SD_TO_XYZ: dict = CACHE_REGISTRY.register_cache( - f"{__name__}._CACHE_SD_TO_XYZ" -) +_CACHE_SD_TO_XYZ: dict = CACHE_REGISTRY.register_cache(f"{__name__}._CACHE_SD_TO_XYZ") def handle_spectral_arguments( @@ -186,9 +182,7 @@ def handle_spectral_arguments( ) illuminant = optional( illuminant, - reshape_sd( - SDS_ILLUMINANTS[illuminant_default], cmfs.shape, copy=False - ), + reshape_sd(SDS_ILLUMINANTS[illuminant_default], cmfs.shape, copy=False), ) if illuminant.shape != cmfs.shape: @@ -262,10 +256,7 @@ def lagrange_coefficients_ASTME2022( ) hash_key = hash((interval, interval_type)) - if ( - is_caching_enabled() - and hash_key in _CACHE_LAGRANGE_INTERPOLATING_COEFFICIENTS - ): + if is_caching_enabled() and hash_key in _CACHE_LAGRANGE_INTERPOLATING_COEFFICIENTS: return np.copy(_CACHE_LAGRANGE_INTERPOLATING_COEFFICIENTS[hash_key]) r_n = np.linspace(1 / interval, 1 - (1 / interval), interval - 1) @@ -359,7 +350,6 @@ def tristimulus_weighting_factors_ASTME2022( ... cmfs, A, SpectralShape(360, 830, 20) ... ) ... # doctest: +ELLIPSIS - ... array([[ -0.0002981..., -0.0000317..., -0.0013301...], [ -0.0087155..., -0.0008915..., -0.0407436...], [ 0.0599679..., 0.0050203..., 0.2565018...], @@ -395,10 +385,7 @@ def tristimulus_weighting_factors_ASTME2022( global _CACHE_TRISTIMULUS_WEIGHTING_FACTORS # noqa: PLW0602 hash_key = hash((cmfs, illuminant, shape, k, get_domain_range_scale())) - if ( - is_caching_enabled() - and hash_key in _CACHE_TRISTIMULUS_WEIGHTING_FACTORS - ): + if is_caching_enabled() and hash_key in _CACHE_TRISTIMULUS_WEIGHTING_FACTORS: return np.copy(_CACHE_TRISTIMULUS_WEIGHTING_FACTORS[hash_key]) Y = cmfs.values @@ -437,9 +424,7 @@ def tristimulus_weighting_factors_ASTME2022( for k in range(i_cm, i_cm - 3, -1): W[k, i] = ( W[k, i] - + c_c[r_c - j - 1, i_cm - k] - * S[j + w_lif] - * Y[j + w_lif, i] + + c_c[r_c - j - 1, i_cm - k] * S[j + w_lif] * Y[j + w_lif, i] ) # Intermediate intervals. @@ -511,7 +496,6 @@ def adjust_tristimulus_weighting_factors_ASTME308( ... W, SpectralShape(360, 830, 20), SpectralShape(400, 700, 20) ... ) ... # doctest: +ELLIPSIS - ... array([[ 0.0509543..., 0.0040971..., 0.2144280...], [ 0.7734225..., 0.0779839..., 3.6965732...], [ 1.9000905..., 0.3037005..., 9.7554195...], @@ -563,7 +547,7 @@ def sd_to_XYZ_integration( ---------- sd Spectral distribution, if an `ArrayLike` the wavelengths are - expected to be in the last axis, e.g. for a spectral array with + expected to be in the last axis, e.g., for a spectral array with 77 bins, ``sd`` shape could be (77, ) or (1, 77). cmfs Standard observer colour matching functions, default to the @@ -586,8 +570,8 @@ def sd_to_XYZ_integration( be the spectral concentration of the radiometric quantity corresponding to the photometric quantity required. shape - Spectral shape of the spectral distribution, ``cmfs`` and - ``illuminant`` will be aligned to it if ``sd`` is an `ArrayLike`. + Spectral shape that ``sd``, ``cmfs`` and ``illuminant`` will be + aligned to it if passed. Returns ------- @@ -619,7 +603,7 @@ def sd_to_XYZ_integration( Examples -------- - >>> from colour import MSDS_CMFS, SDS_ILLUMINANTS, SpectralDistribution + >>> from colour import MSDS_CMFS, SDS_ILLUMINANTS >>> cmfs = MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] >>> illuminant = SDS_ILLUMINANTS["D65"] >>> shape = SpectralShape(400, 700, 20) @@ -663,9 +647,9 @@ def sd_to_XYZ_integration( # NOTE: The "illuminant" argument is reshaped by the # `handle_spectral_arguments` definition, but, in this case, it is not - # desirable as we want to reshape it according to the final "shape" which - # is only available after the subsequent if/else block thus we are careful - # not unpacking over it. + # desirable as we want to reshape it according to the final "shape" which, + # if not directly passed, is only available after the subsequent if/else + # block thus we are carefully avoiding to unpack over it. if illuminant is None: cmfs, illuminant = handle_spectral_arguments( cmfs, illuminant, illuminant_default="E" @@ -676,12 +660,14 @@ def sd_to_XYZ_integration( ) if isinstance(sd, (SpectralDistribution, MultiSpectralDistributions)): + if shape is not None: + cmfs = reshape_msds(cmfs, shape, copy=False) + illuminant = reshape_sd(illuminant, shape, copy=False) + shape = cmfs.shape if sd.shape != shape: - runtime_warning( - f'Aligning "{sd.name}" spectral data shape to "{shape}".' - ) + runtime_warning(f'Aligning "{sd.name}" spectral data shape to "{shape}".') sd = ( reshape_sd(sd, shape, copy=False) @@ -695,8 +681,7 @@ def sd_to_XYZ_integration( else: attest( shape is not None, - "A spectral shape must be explicitly passed with a spectral data " - "array!", + "A spectral shape must be explicitly passed with a spectral data array!", ) shape = cast(SpectralShape, shape) @@ -717,9 +702,7 @@ def sd_to_XYZ_integration( cmfs = reshape_msds(cmfs, shape, copy=False) if illuminant.shape != shape: - runtime_warning( - f'Aligning "{illuminant.name}" illuminant shape to "{shape}".' - ) + runtime_warning(f'Aligning "{illuminant.name}" illuminant shape to "{shape}".') illuminant = reshape_sd(illuminant, shape, copy=False) XYZ_b = cmfs.values @@ -729,9 +712,7 @@ def sd_to_XYZ_integration( d_w = cmfs.shape.interval with sdiv_mode(): - k = cast( - Real, optional(k, sdiv(100, (np.sum(XYZ_b[..., 1] * S) * d_w))) - ) + k = cast(Real, optional(k, sdiv(100, (np.sum(XYZ_b[..., 1] * S) * d_w)))) XYZ = k * np.dot(R * S, XYZ_b) * d_w @@ -798,7 +779,7 @@ def sd_to_XYZ_tristimulus_weighting_factors_ASTME308( Examples -------- - >>> from colour import MSDS_CMFS, SDS_ILLUMINANTS, SpectralDistribution + >>> from colour import MSDS_CMFS, SDS_ILLUMINANTS >>> cmfs = MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] >>> illuminant = SDS_ILLUMINANTS["D65"] >>> shape = SpectralShape(400, 700, 20) @@ -960,7 +941,7 @@ def sd_to_XYZ_ASTME308( Examples -------- - >>> from colour import MSDS_CMFS, SDS_ILLUMINANTS, SpectralDistribution + >>> from colour import MSDS_CMFS, SDS_ILLUMINANTS >>> cmfs = MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] >>> illuminant = SDS_ILLUMINANTS["D65"] >>> shape = SpectralShape(400, 700, 20) @@ -1062,9 +1043,7 @@ def sd_to_XYZ_ASTME308( ) i_e = len(sd.domain) - 1 - i sd[sd.wavelengths[i_e]] = ( - sd.values[i_e - 6] - - 3 * sd.values[i_e - 4] - + 3 * sd.values[i_e - 2] + sd.values[i_e - 6] - 3 * sd.values[i_e - 4] + 3 * sd.values[i_e - 2] ) # Interpolating every odd numbered values. @@ -1132,7 +1111,7 @@ def sd_to_XYZ( ---------- sd Spectral distribution, if an `ArrayLike` and ``method`` is - *Integration* the wavelengths are expected to be in the last axis, e.g. + *Integration* the wavelengths are expected to be in the last axis, e.g., for a spectral array with 77 bins, ``sd`` shape could be (77, ) or (1, 77). cmfs @@ -1171,8 +1150,9 @@ def sd_to_XYZ( tristimulus values will use a dedicated interpolation method instead of a table of tristimulus weighting factors. shape - Spectral shape of the spectral distribution, ``cmfs`` and - ``illuminant`` will be aligned to it if ``sd`` is an `ArrayLike`. + {:func:`colour.colorimetry.sd_to_XYZ_integration`}, + Spectral shape that ``sd``, ``cmfs`` and ``illuminant`` will be + aligned to it if passed. use_practice_range {:func:`colour.colorimetry.sd_to_XYZ_ASTME308`}, Practise *ASTM E308-15* working wavelengths range is [360, 780], @@ -1210,13 +1190,7 @@ def sd_to_XYZ( Examples -------- - >>> import numpy as np - >>> from colour import ( - ... MSDS_CMFS, - ... SDS_ILLUMINANTS, - ... SpectralDistribution, - ... SpectralShape, - ... ) + >>> from colour import MSDS_CMFS, SDS_ILLUMINANTS >>> cmfs = MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] >>> illuminant = SDS_ILLUMINANTS["D65"] >>> shape = SpectralShape(400, 700, 20) @@ -1272,11 +1246,11 @@ def sd_to_XYZ( hash_key = hash( ( - sd - if isinstance( - sd, (SpectralDistribution, MultiSpectralDistributions) - ) - else int_digest(sd.tobytes()), # pyright: ignore + ( + sd + if isinstance(sd, (SpectralDistribution, MultiSpectralDistributions)) + else int_digest(np.asarray(sd).tobytes()) # pyright: ignore + ), # pyright: ignore cmfs, illuminant, k, @@ -1289,11 +1263,16 @@ def sd_to_XYZ( if is_caching_enabled() and hash_key in _CACHE_SD_TO_XYZ: return np.copy(_CACHE_SD_TO_XYZ[hash_key]) - function = SD_TO_XYZ_METHODS[method] + if isinstance(sd, MultiSpectralDistributions): + runtime_warning( + "A multi-spectral distributions was passed, enforcing integration " + "method!" + ) + function = sd_to_XYZ_integration + else: + function = SD_TO_XYZ_METHODS[method] - XYZ = function( - sd, cmfs, illuminant, k=k, **filter_kwargs(function, **kwargs) - ) + XYZ = function(sd, cmfs, illuminant, k=k, **filter_kwargs(function, **kwargs)) _CACHE_SD_TO_XYZ[hash_key] = np.copy(XYZ) @@ -1319,7 +1298,7 @@ def msds_to_XYZ_integration( ---------- msds Multi-spectral distributions, if an `ArrayLike` the wavelengths are - expected to be in the last axis, e.g. for a 512x384 multi-spectral + expected to be in the last axis, e.g., for a 512x384 multi-spectral image with 77 bins, ``msds`` shape should be (384, 512, 77). cmfs Standard observer colour matching functions, default to the @@ -1342,8 +1321,8 @@ def msds_to_XYZ_integration( be the spectral concentration of the radiometric quantity corresponding to the photometric quantity required. shape - Spectral shape of the multi-spectral distributions, ``cmfs`` and - ``illuminant`` will be aligned to it if ``msds`` is an `ArrayLike`. + Spectral shape that ``sd``, ``cmfs`` and ``illuminant`` will be + aligned to it if passed. Returns ------- @@ -1806,7 +1785,7 @@ def msds_to_XYZ( ---------- msds Multi-spectral distributions, if an `ArrayLike` the wavelengths are - expected to be in the last axis, e.g. for a 512x384 multi-spectral + expected to be in the last axis, e.g., for a 512x384 multi-spectral image with 77 bins, ``msds`` shape should be (384, 512, 77). cmfs Standard observer colour matching functions, default to the @@ -1845,8 +1824,8 @@ def msds_to_XYZ( of a table of tristimulus weighting factors. shape {:func:`colour.colorimetry.msds_to_XYZ_integration`}, - Spectral shape of the multi-spectral distributions array :math:`msds`, - ``cmfs`` and ``illuminant`` will be aligned to it. + Spectral shape that ``sd``, ``cmfs`` and ``illuminant`` will be + aligned to it if passed. use_practice_range {:func:`colour.colorimetry.msds_to_XYZ_ASTME308`}, Practise *ASTM E308-15* working wavelengths range is [360, 780], @@ -1899,7 +1878,7 @@ class on the last / tail axis as follows: Examples -------- - >>> from colour import MSDS_CMFS, SDS_ILLUMINANTS, SpectralDistribution + >>> from colour import MSDS_CMFS, SDS_ILLUMINANTS >>> cmfs = MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] >>> illuminant = SDS_ILLUMINANTS["D65"] >>> shape = SpectralShape(400, 700, 60) @@ -2046,9 +2025,7 @@ class on the last / tail axis as follows: function = MSDS_TO_XYZ_METHODS[method] - return function( - msds, cmfs, illuminant, k, **filter_kwargs(function, **kwargs) - ) + return function(msds, cmfs, illuminant, k, **filter_kwargs(function, **kwargs)) def wavelength_to_XYZ( diff --git a/colour/colorimetry/uniformity.py b/colour/colorimetry/uniformity.py index 9a637f1485..25c75f1418 100644 --- a/colour/colorimetry/uniformity.py +++ b/colour/colorimetry/uniformity.py @@ -2,7 +2,7 @@ Spectral Uniformity =================== -Defines the objects to compute the *spectral uniformity* +Define the objects to compute the *spectral uniformity* (or *spectral flatness*) of spectral distributions. References @@ -37,9 +37,11 @@ def spectral_uniformity( - sds: Sequence[SpectralDistribution | MultiSpectralDistributions] - | SpectralDistribution - | MultiSpectralDistributions, + sds: ( + Sequence[SpectralDistribution | MultiSpectralDistributions] + | SpectralDistribution + | MultiSpectralDistributions + ), use_second_order_derivatives: bool = False, ) -> NDArrayFloat: """ diff --git a/colour/colorimetry/whiteness.py b/colour/colorimetry/whiteness.py index 2d401294b3..bbe1d8056e 100644 --- a/colour/colorimetry/whiteness.py +++ b/colour/colorimetry/whiteness.py @@ -2,7 +2,7 @@ Whiteness Index :math:`W` ========================= -Defines the *whiteness* index :math:`W` computation objects: +Define the *whiteness* index :math:`W` computation objects: - :func:`colour.colorimetry.whiteness_Berger1959`: *Whiteness* index :math:`WI` computation of given sample *CIE XYZ* tristimulus values using @@ -469,15 +469,17 @@ def whiteness_CIE2004( def whiteness( XYZ: ArrayLike, XYZ_0: ArrayLike, - method: Literal[ - "ASTM E313", - "CIE 2004", - "Berger 1959", - "Ganz 1979", - "Stensby 1968", - "Taube 1960", - ] - | str = "CIE 2004", + method: ( + Literal[ + "ASTM E313", + "CIE 2004", + "Berger 1959", + "Ganz 1979", + "Stensby 1968", + "Taube 1960", + ] + | str + ) = "CIE 2004", **kwargs: Any, ) -> NDArrayFloat: """ @@ -561,8 +563,6 @@ def whiteness( from colour.models import XYZ_to_xy _X_0, Y_0, _Z_0 = tsplit(XYZ_0) - kwargs.update( - {"xy": XYZ_to_xy(XYZ), "Y": Y_0, "xy_n": XYZ_to_xy(XYZ_0)} - ) + kwargs.update({"xy": XYZ_to_xy(XYZ), "Y": Y_0, "xy_n": XYZ_to_xy(XYZ_0)}) return function(**filter_kwargs(function, **kwargs)) diff --git a/colour/colorimetry/yellowness.py b/colour/colorimetry/yellowness.py index 7eb3490767..82c0380f85 100644 --- a/colour/colorimetry/yellowness.py +++ b/colour/colorimetry/yellowness.py @@ -2,7 +2,7 @@ Yellowness Index :math:`Y` ========================== -Defines the *yellowness* index :math:`Y` computation objects: +Define the *yellowness* index :math:`Y` computation objects: - :func:`colour.colorimetry.yellowness_ASTMD1925`: *Yellowness* index :math:`YI` computation of given sample *CIE XYZ* tristimulus values using @@ -207,12 +207,12 @@ def yellowness_ASTME313_alternative(XYZ: ArrayLike) -> NDArrayFloat: - 'cie_2_1931': 'CIE 1931 2 Degree Standard Observer' - 'cie_10_1964': 'CIE 1964 10 Degree Standard Observer' """ -YELLOWNESS_COEFFICIENTS_ASTME313[ - "cie_2_1931" -] = YELLOWNESS_COEFFICIENTS_ASTME313["CIE 1931 2 Degree Standard Observer"] -YELLOWNESS_COEFFICIENTS_ASTME313[ - "cie_10_1964" -] = YELLOWNESS_COEFFICIENTS_ASTME313["CIE 1964 10 Degree Standard Observer"] +YELLOWNESS_COEFFICIENTS_ASTME313["cie_2_1931"] = YELLOWNESS_COEFFICIENTS_ASTME313[ + "CIE 1931 2 Degree Standard Observer" +] +YELLOWNESS_COEFFICIENTS_ASTME313["cie_10_1964"] = YELLOWNESS_COEFFICIENTS_ASTME313[ + "CIE 1964 10 Degree Standard Observer" +] def yellowness_ASTME313( @@ -295,8 +295,9 @@ def yellowness_ASTME313( def yellowness( XYZ: ArrayLike, - method: Literal["ASTM D1925", "ASTM E313", "ASTM E313 Alternative"] - | str = "ASTM E313", + method: ( + Literal["ASTM D1925", "ASTM E313", "ASTM E313 Alternative"] | str + ) = "ASTM E313", **kwargs: Any, ) -> NDArrayFloat: """ diff --git a/colour/constants/__init__.py b/colour/constants/__init__.py index e9898fd333..56dbcd2208 100644 --- a/colour/constants/__init__.py +++ b/colour/constants/__init__.py @@ -6,8 +6,8 @@ CONSTANT_PLANCK, ) from .common import ( - FLOATING_POINT_NUMBER_PATTERN, - INTEGER_THRESHOLD, + PATTERN_FLOATING_POINT_NUMBER, + THRESHOLD_INTEGER, EPSILON, DTYPE_INT_DEFAULT, DTYPE_FLOAT_DEFAULT, @@ -28,8 +28,8 @@ "CONSTANT_PLANCK", ] __all__ += [ - "FLOATING_POINT_NUMBER_PATTERN", - "INTEGER_THRESHOLD", + "PATTERN_FLOATING_POINT_NUMBER", + "THRESHOLD_INTEGER", "EPSILON", "DTYPE_INT_DEFAULT", "DTYPE_FLOAT_DEFAULT", diff --git a/colour/constants/cie.py b/colour/constants/cie.py index 79e1bc6f05..5634cb5554 100644 --- a/colour/constants/cie.py +++ b/colour/constants/cie.py @@ -2,7 +2,7 @@ CIE Constants ============= -Defines the *CIE* constants. +Define the *CIE* constants. References ---------- diff --git a/colour/constants/codata.py b/colour/constants/codata.py index 408be3c837..034804df12 100644 --- a/colour/constants/codata.py +++ b/colour/constants/codata.py @@ -2,7 +2,7 @@ Fundamental Physical Constants ============================== -Defines various constants from recommended values by the Committee on Data for +Define various constants from recommended values by the Committee on Data for Science and Technology (CODATA). """ diff --git a/colour/constants/common.py b/colour/constants/common.py index 924b10c061..621e9b8e52 100644 --- a/colour/constants/common.py +++ b/colour/constants/common.py @@ -2,7 +2,7 @@ Common Constants ================ -Defines the common constants objects that don't belong to any specific +Define the common constants objects that don't belong to any specific category. """ @@ -26,8 +26,8 @@ __status__ = "Production" __all__ = [ - "FLOATING_POINT_NUMBER_PATTERN", - "INTEGER_THRESHOLD", + "PATTERN_FLOATING_POINT_NUMBER", + "THRESHOLD_INTEGER", "EPSILON", "DTYPE_INT_DEFAULT", "DTYPE_FLOAT_DEFAULT", @@ -37,18 +37,18 @@ "TOLERANCE_RELATIVE_TESTS", ] -FLOATING_POINT_NUMBER_PATTERN: str = "[0-9]*\\.?[0-9]+([eE][-+]?[0-9]+)?" -"""float point number regex matching pattern.""" +PATTERN_FLOATING_POINT_NUMBER: str = "[0-9]*\\.?[0-9]+([eE][-+]?[0-9]+)?" +"""Floating point number regex matching pattern.""" -INTEGER_THRESHOLD: float = 1e-3 +THRESHOLD_INTEGER: float = 1e-3 if is_documentation_building(): # pragma: no cover - INTEGER_THRESHOLD = DocstringFloat(INTEGER_THRESHOLD) - INTEGER_THRESHOLD.__doc__ = """ -int threshold value when checking if a float point number is almost an + THRESHOLD_INTEGER = DocstringFloat(THRESHOLD_INTEGER) + THRESHOLD_INTEGER.__doc__ = """ +Integer threshold value when checking if a float point number is almost an int. """ -EPSILON: float = cast(float, np.finfo(np.float_).eps) +EPSILON: float = cast(float, np.finfo(np.double).eps) """ Default epsilon value for tolerance and singularities avoidance in various computations. diff --git a/colour/continuous/abstract.py b/colour/continuous/abstract.py index 8f12ce7329..6787edc3c7 100644 --- a/colour/continuous/abstract.py +++ b/colour/continuous/abstract.py @@ -2,7 +2,7 @@ Abstract Continuous Function ============================ -Defines the abstract class implementing support for abstract continuous +Define the abstract class implementing support for abstract continuous function: - :class:`colour.continuous.AbstractContinuousFunction`. @@ -34,7 +34,6 @@ as_float, attest, closest, - is_string, is_uniform, optional, ) @@ -148,7 +147,7 @@ def name(self, value: str): """Setter for the **self.name** property.""" attest( - is_string(value), + isinstance(value, str), f'"name" property: "{value}" type is not "str"!', ) @@ -218,7 +217,7 @@ def domain(self, value: ArrayLike): @property @abstractmethod - def range(self) -> NDArrayFloat: # noqa: A003 + def range(self) -> NDArrayFloat: """ Getter and setter property for the abstract continuous function corresponding range variable :math:`y`, must be reimplemented by @@ -241,7 +240,7 @@ def range(self) -> NDArrayFloat: # noqa: A003 @range.setter @abstractmethod - def range(self, value: ArrayLike): # noqa: A003 + def range(self, value: ArrayLike): """ Setter for the **self.range** property, must be reimplemented by sub-classes. diff --git a/colour/continuous/multi_signals.py b/colour/continuous/multi_signals.py index b25691fb91..1eb92f4961 100644 --- a/colour/continuous/multi_signals.py +++ b/colour/continuous/multi_signals.py @@ -2,7 +2,7 @@ Multi Signals ============= -Defines the class implementing support for multi-continuous signals: +Define the class implementing support for multi-continuous signals: - :class:`colour.continuous.MultiSignals` """ @@ -212,7 +212,6 @@ class MultiSignals(AbstractContinuousFunction): >>> class NotSignal(Signal): ... pass - ... >>> multi_signals = MultiSignals(range_, domain, signal_type=NotSignal) >>> print(multi_signals) @@ -239,7 +238,6 @@ class MultiSignals(AbstractContinuousFunction): ... Series(dict(zip(domain, np.linspace(10, 100, 10)))) ... ) ... ) - ... [[ 100. 10.] [ 200. 20.] [ 300. 30.] @@ -258,7 +256,6 @@ class MultiSignals(AbstractContinuousFunction): ... ... data = dict(zip(["a", "b", "c"], tsplit(range_))) ... print(MultiSignals(DataFrame(data, domain))) # doctest: +SKIP - ... [[ 100. 10. 20. 30.] [ 200. 20. 30. 40.] [ 300. 30. 40. 50.] @@ -302,14 +299,9 @@ class MultiSignals(AbstractContinuousFunction): def __init__( self, - data: ArrayLike - | DataFrame - | dict - | Self - | Sequence - | Series - | Signal - | None = None, + data: ( + ArrayLike | DataFrame | dict | Self | Sequence | Series | Signal | None + ) = None, domain: ArrayLike | None = None, labels: Sequence | None = None, **kwargs: Any, @@ -376,7 +368,7 @@ def domain(self, value: ArrayLike): signal.domain = as_float_array(value, self.dtype) @property - def range(self) -> NDArrayFloat: # noqa: A003 + def range(self) -> NDArrayFloat: """ Getter and setter property for the :class:`colour.continuous.Signal` sub-class instances corresponding range variable :math:`y`. @@ -397,7 +389,7 @@ def range(self) -> NDArrayFloat: # noqa: A003 return tstack([signal.range for signal in self._signals.values()]) @range.setter - def range(self, value: ArrayLike): # noqa: A003 + def range(self, value: ArrayLike): """Setter for the **self.range** property.""" value = as_float_array(value) @@ -612,8 +604,7 @@ def labels(self, value: Sequence): ) self._signals = { - str(value[i]): signal - for i, signal in enumerate(self._signals.values()) + str(value[i]): signal for i, signal in enumerate(self._signals.values()) } @property @@ -876,7 +867,7 @@ def __setitem__(self, x: ArrayLike | slice, y: ArrayLike): [ 7. 80. 90. 100. ] [ 8. 90. 100. 110. ] [ 9. 100. 110. 120. ]] - >>> y = np.arange(1, 10, 1).reshape(3, 3) + >>> y = np.reshape(np.arange(1, 10, 1), (3, 3)) >>> multi_signals[np.array([0, 1, 2])] = y >>> print(multi_signals) [[ 0. 1. 2. 3. ] @@ -1011,11 +1002,9 @@ def __eq__(self, other: Any) -> bool: np.array_equal(self.domain, other.domain), np.array_equal(self.range, other.range), self.interpolator is other.interpolator, - str(self.interpolator_kwargs) - == str(other.interpolator_kwargs), + str(self.interpolator_kwargs) == str(other.interpolator_kwargs), self.extrapolator is other.extrapolator, - str(self.extrapolator_kwargs) - == str(other.extrapolator_kwargs), + str(self.extrapolator_kwargs) == str(other.extrapolator_kwargs), self.labels == other.labels, ] ) @@ -1142,7 +1131,7 @@ def arithmetical_operation( [ 8. 200. 220. 240.] [ 9. 220. 240. 260.]] - >>> a = np.arange(0, 30, 1).reshape([10, 3]) + >>> a = np.reshape(np.arange(0, 30, 1), (10, 3)) >>> print(multi_signals_1.arithmetical_operation(a, "+", True)) [[ 0. 40. 61. 82.] [ 1. 63. 84. 105.] @@ -1158,11 +1147,7 @@ def arithmetical_operation( Adding a :class:`colour.continuous.Signal` sub-class: >>> multi_signals_2 = MultiSignals(range_) - >>> print( - ... multi_signals_1.arithmetical_operation( - ... multi_signals_2, "+", True - ... ) - ... ) + >>> print(multi_signals_1.arithmetical_operation(multi_signals_2, "+", True)) [[ 0. 50. 81. 112.] [ 1. 83. 114. 145.] [ 2. 116. 147. 178.] @@ -1207,23 +1192,23 @@ def arithmetical_operation( 'underlying "Signal" components!', ) - for signal, y in zip( - multi_signals.signals.values(), tsplit(a) - ): + for signal, y in zip(multi_signals.signals.values(), tsplit(a)): signal.arithmetical_operation(y, operation, True) return multi_signals @staticmethod def multi_signals_unpack_data( - data: ArrayLike - | DataFrame - | dict - | MultiSignals - | Sequence - | Series - | Signal - | None = None, + data: ( + ArrayLike + | DataFrame + | dict + | MultiSignals + | Sequence + | Series + | Signal + | None + ) = None, domain: ArrayLike | None = None, labels: Sequence | None = None, dtype: Type[DTypeFloat] | None = None, @@ -1333,9 +1318,7 @@ def multi_signals_unpack_data( Unpacking using a *dict*: - >>> signals = MultiSignals.multi_signals_unpack_data( - ... dict(zip(domain, range_)) - ... ) + >>> signals = MultiSignals.multi_signals_unpack_data(dict(zip(domain, range_))) >>> list(signals.keys()) ['0', '1', '2'] >>> print(signals["2"]) @@ -1373,9 +1356,7 @@ def multi_signals_unpack_data( Unpacking using *MultiSignals.multi_signals_unpack_data* method output: - >>> signals = MultiSignals.multi_signals_unpack_data( - ... dict(zip(domain, range_)) - ... ) + >>> signals = MultiSignals.multi_signals_unpack_data(dict(zip(domain, range_))) >>> signals = MultiSignals.multi_signals_unpack_data(signals) >>> list(signals.keys()) ['0', '1', '2'] @@ -1400,7 +1381,6 @@ def multi_signals_unpack_data( ... Series(dict(zip(domain, np.linspace(10, 100, 10)))) ... ) ... print(signals[0]) # doctest: +SKIP - ... [[ 100. 10.] [ 200. 20.] [ 300. 30.] @@ -1422,7 +1402,6 @@ def multi_signals_unpack_data( ... DataFrame(data, domain) ... ) ... print(signals["c"]) # doctest: +SKIP - ... [[ 100. 30.] [ 200. 40.] [ 300. 50.] @@ -1477,15 +1456,11 @@ def multi_signals_unpack_data( data_array = data_array[None, :] for i, range_unpacked in enumerate(data_array): - signals[str(i)] = signal_type( - range_unpacked, domain, **settings - ) + signals[str(i)] = signal_type(range_unpacked, domain, **settings) elif issubclass(type(data), Mapping) or isinstance(data, dict): data_mapping = dict(cast(Mapping, data)) - is_signal = all( - isinstance(i, Signal) for i in data_mapping.values() - ) + is_signal = all(isinstance(i, Signal) for i in data_mapping.values()) if is_signal: for label, signal in data_mapping.items(): @@ -1493,9 +1468,7 @@ def multi_signals_unpack_data( signal.range, signal.domain, **settings ) else: - domain_unpacked, range_unpacked = zip( - *sorted(data_mapping.items()) - ) + domain_unpacked, range_unpacked = zip(*sorted(data_mapping.items())) for i, values_unpacked in enumerate(tsplit(range_unpacked)): signals[str(i)] = signal_type( values_unpacked, domain_unpacked, **settings @@ -1531,16 +1504,14 @@ def multi_signals_unpack_data( if labels is not None: attest( len(labels) == len(signals), - 'User "labels" length is not compatible with unpacked ' - '"signals"!', + 'User "labels" length is not compatible with unpacked "signals"!', ) if len(labels) != len(set(labels)): labels = [f"{label} - {i}" for i, label in enumerate(labels)] signals = { - str(labels[i]): signal - for i, signal in enumerate(signals.values()) + str(labels[i]): signal for i, signal in enumerate(signals.values()) } for label in signals: @@ -1641,7 +1612,6 @@ class instance. ... range_ += np.array([0, 10, 20]) ... multi_signals = MultiSignals(range_) ... print(multi_signals.to_dataframe()) # doctest: +SKIP - ... 0 1 2 0.0 10.0 20.0 30.0 1.0 20.0 30.0 40.0 @@ -1656,5 +1626,7 @@ class instance. """ return DataFrame( - data=self.range, index=self.domain, columns=self.labels + data=self.range, + index=self.domain, + columns=self.labels, # pyright: ignore ) diff --git a/colour/continuous/signal.py b/colour/continuous/signal.py index 7f37e87023..d49b5008dd 100644 --- a/colour/continuous/signal.py +++ b/colour/continuous/signal.py @@ -2,7 +2,7 @@ Signal ====== -Defines the class implementing support for continuous signal: +Define the class implementing support for continuous signal: - :class:`colour.continuous.Signal` """ @@ -206,7 +206,6 @@ class Signal(AbstractContinuousFunction): ... from pandas import Series ... ... print(Signal(Series(dict(zip(domain, range_))))) # doctest: +SKIP - ... [[ 100. 10.] [ 200. 20.] [ 300. 30.] @@ -302,8 +301,7 @@ def dtype(self, value: Type[DTypeFloat]): attest( value in DTypeFloat.__args__, # pyright: ignore - f'"dtype" must be one of the following types: ' - f"{DTypeFloat.__args__}", # pyright: ignore + f'"dtype" must be one of the following types: {DTypeFloat.__args__}', # pyright: ignore ) self._dtype = value @@ -358,7 +356,7 @@ def domain(self, value: ArrayLike): self._function = None # Invalidate the underlying continuous function. @property - def range(self) -> NDArrayFloat: # noqa: A003 + def range(self) -> NDArrayFloat: """ Getter and setter property for the continuous signal corresponding range variable :math:`y`. @@ -378,7 +376,7 @@ def range(self) -> NDArrayFloat: # noqa: A003 return ndarray_copy(self._range) @range.setter - def range(self, value: ArrayLike): # noqa: A003 + def range(self, value: ArrayLike): """Setter for the **self.range** property.""" value = as_float_array(value, self.dtype) @@ -543,7 +541,8 @@ def function(self) -> Callable: else: def _undefined_function( - *args: Any, **kwargs: Any # noqa: ARG001 + *args: Any, # noqa: ARG001 + **kwargs: Any, # noqa: ARG001 ): """ Raise a :class:`ValueError` exception. @@ -795,7 +794,7 @@ def __setitem__(self, x: ArrayLike | slice, y: ArrayLike): y = np.resize(y, x.shape) # Matching domain, updating existing `self._range` values. - mask = np.in1d(x, self._domain) + mask = np.isin(x, self._domain) # pyright: ignore x_m = x[mask] indexes = np.searchsorted(self._domain, x_m) self._range[indexes] = y[mask] @@ -892,11 +891,9 @@ def __eq__(self, other: Any) -> bool: np.array_equal(self._domain, other.domain), np.array_equal(self._range, other.range), self._interpolator is other.interpolator, - repr(self._interpolator_kwargs) - == repr(other.interpolator_kwargs), + repr(self._interpolator_kwargs) == repr(other.interpolator_kwargs), self._extrapolator is other.extrapolator, - repr(self._extrapolator_kwargs) - == repr(other.extrapolator_kwargs), + repr(self._extrapolator_kwargs) == repr(other.extrapolator_kwargs), ] ) else: @@ -1147,9 +1144,7 @@ def signal_unpack_data( Unpacking using a *dict*: - >>> domain, range_ = Signal.signal_unpack_data( - ... dict(zip(domain, range_)) - ... ) + >>> domain, range_ = Signal.signal_unpack_data(dict(zip(domain, range_))) >>> print(domain) [ 100. 200. 300. 400. 500. 600. 700. 800. 900. 1000.] >>> print(range_) @@ -1164,7 +1159,6 @@ def signal_unpack_data( ... Series(dict(zip(domain, range_))) ... ) ... # doctest: +ELLIPSIS - ... >>> print(domain) # doctest: +SKIP [ 100. 200. 300. 400. 500. 600. 700. 800. 900. 1000.] >>> print(range_) # doctest: +SKIP @@ -1187,7 +1181,7 @@ def signal_unpack_data( if isinstance(data, Signal): domain_unpacked = data.domain range_unpacked = data.range - elif issubclass(type(data), Sequence) or isinstance( + elif issubclass(type(data), Sequence) or isinstance( # pyright: ignore data, (tuple, list, np.ndarray, Iterator, ValuesView) ): data_array = ( @@ -1202,7 +1196,7 @@ def signal_unpack_data( np.arange(0, data_array.size, dtype=dtype), data_array, ) - elif issubclass(type(data), Mapping) or isinstance(data, dict): + elif issubclass(type(data), Mapping) or isinstance(data, dict): # pyright: ignore domain_unpacked, range_unpacked = tsplit( sorted(cast(Mapping, data).items()) ) @@ -1313,7 +1307,6 @@ class instance. ... range_ = np.linspace(10, 100, 10) ... signal = Signal(range_) ... print(signal.to_series()) # doctest: +SKIP - ... 0.0 10.0 1.0 20.0 2.0 30.0 diff --git a/colour/continuous/tests/test_abstract.py b/colour/continuous/tests/test_abstract.py index 08d4e1f262..00b22a2f5a 100644 --- a/colour/continuous/tests/test_abstract.py +++ b/colour/continuous/tests/test_abstract.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.continuous.abstract` module.""" -import unittest from colour.continuous import AbstractContinuousFunction @@ -17,7 +15,7 @@ ] -class TestAbstractContinuousFunction(unittest.TestCase): +class TestAbstractContinuousFunction: """ Define :class:`colour.continuous.abstract.AbstractContinuousFunction` class unit tests methods. @@ -38,7 +36,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(AbstractContinuousFunction)) + assert attribute in dir(AbstractContinuousFunction) def test_required_methods(self): """Test the presence of required methods.""" @@ -73,8 +71,4 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(AbstractContinuousFunction)) - - -if __name__ == "__main__": - unittest.main() + assert method in dir(AbstractContinuousFunction) diff --git a/colour/continuous/tests/test_multi_signal.py b/colour/continuous/tests/test_multi_signal.py index 8385055a01..2627851073 100644 --- a/colour/continuous/tests/test_multi_signal.py +++ b/colour/continuous/tests/test_multi_signal.py @@ -1,11 +1,10 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.continuous.multi_signals` module.""" import pickle import textwrap -import unittest import numpy as np +import pytest from colour.algebra import ( CubicSplineInterpolator, @@ -34,13 +33,13 @@ ] -class TestMultiSignals(unittest.TestCase): +class TestMultiSignals: """ Define :class:`colour.continuous.multi_signals.MultiSignals` class unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._range_1 = np.linspace(10, 100, 10) @@ -68,7 +67,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(MultiSignals)) + assert attribute in dir(MultiSignals) def test_required_methods(self): """Test the presence of required methods.""" @@ -92,7 +91,7 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(MultiSignals)) + assert method in dir(MultiSignals) def test_pickling(self): """ @@ -102,7 +101,7 @@ def test_pickling(self): data = pickle.dumps(self._multi_signals) data = pickle.loads(data) # noqa: S301 - self.assertEqual(self._multi_signals, data) + assert self._multi_signals == data def test_dtype(self): """ @@ -110,11 +109,11 @@ def test_dtype(self): property. """ - self.assertEqual(self._multi_signals.dtype, DTYPE_FLOAT_DEFAULT) + assert self._multi_signals.dtype == DTYPE_FLOAT_DEFAULT multi_signals = self._multi_signals.copy() multi_signals.dtype = np.float32 - self.assertEqual(multi_signals.dtype, np.float32) + assert multi_signals.dtype == np.float32 def test_domain(self): """ @@ -126,23 +125,17 @@ def test_domain(self): np.testing.assert_allclose( multi_signals[np.array([0, 1, 2])], - np.array( - [[10.0, 20.0, 30.0], [20.0, 30.0, 40.0], [30.0, 40.0, 50.0]] - ), + np.array([[10.0, 20.0, 30.0], [20.0, 30.0, 40.0], [30.0, 40.0, 50.0]]), atol=TOLERANCE_ABSOLUTE_TESTS, ) multi_signals.domain = self._domain_1 * 10 - np.testing.assert_array_equal( - multi_signals.domain, self._domain_1 * 10 - ) + np.testing.assert_array_equal(multi_signals.domain, self._domain_1 * 10) np.testing.assert_allclose( multi_signals[np.array([0, 1, 2]) * 10], - np.array( - [[10.0, 20.0, 30.0], [20.0, 30.0, 40.0], [30.0, 40.0, 50.0]] - ), + np.array([[10.0, 20.0, 30.0], [20.0, 30.0, 40.0], [30.0, 40.0, 50.0]]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -154,7 +147,7 @@ def assert_warns(): multi_signals.domain = domain - self.assertWarns(ColourRuntimeWarning, assert_warns) + pytest.warns(ColourRuntimeWarning, assert_warns) def test_range(self): """ @@ -166,9 +159,7 @@ def test_range(self): np.testing.assert_allclose( multi_signals[np.array([0, 1, 2])], - np.array( - [[10.0, 20.0, 30.0], [20.0, 30.0, 40.0], [30.0, 40.0, 50.0]] - ), + np.array([[10.0, 20.0, 30.0], [20.0, 30.0, 40.0], [30.0, 40.0, 50.0]]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -180,10 +171,7 @@ def test_range(self): np.testing.assert_allclose( multi_signals[np.array([0, 1, 2])], - np.array( - [[10.0, 10.0, 10.0], [20.0, 20.0, 20.0], [30.0, 30.0, 30.0]] - ) - * 10, + np.array([[10.0, 10.0, 10.0], [20.0, 20.0, 20.0], [30.0, 30.0, 30.0]]) * 10, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -193,10 +181,7 @@ def test_range(self): np.testing.assert_allclose( multi_signals[np.array([0, 1, 2])], - np.array( - [[10.0, 20.0, 30.0], [20.0, 30.0, 40.0], [30.0, 40.0, 50.0]] - ) - * 10, + np.array([[10.0, 20.0, 30.0], [20.0, 30.0, 40.0], [30.0, 40.0, 50.0]]) * 10, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -285,7 +270,7 @@ def test_extrapolator(self): property. """ - self.assertIsInstance(self._multi_signals.extrapolator(), Extrapolator) + assert isinstance(self._multi_signals.extrapolator(), Extrapolator) def test_extrapolator_kwargs(self): """ @@ -303,9 +288,7 @@ def test_extrapolator_kwargs(self): np.testing.assert_allclose( multi_signals[np.array([-1000, 1000])], - np.array( - [[-9990.0, -9980.0, -9970.0], [10010.0, 10020.0, 10030.0]] - ), + np.array([[-9990.0, -9980.0, -9970.0], [10010.0, 10020.0, 10030.0]]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -323,7 +306,7 @@ def test_raise_exception_function(self): function` property raised exception. """ - self.assertRaises((ValueError, TypeError), MultiSignals().function, 0) + pytest.raises((ValueError, TypeError), MultiSignals().function, 0) def test_signals(self): """ @@ -335,9 +318,7 @@ def test_signals(self): multi_signals.signals = self._range_1 np.testing.assert_array_equal(multi_signals.domain, self._domain_1) - np.testing.assert_array_equal( - multi_signals.range, self._range_1[:, None] - ) + np.testing.assert_array_equal(multi_signals.range, self._range_1[:, None]) def test_labels(self): """ @@ -345,13 +326,13 @@ def test_labels(self): property. """ - self.assertListEqual(self._multi_signals.labels, ["0", "1", "2"]) + assert self._multi_signals.labels == ["0", "1", "2"] multi_signals = self._multi_signals.copy() multi_signals.labels = ["a", "b", "c"] - self.assertListEqual(multi_signals.labels, ["a", "b", "c"]) + assert multi_signals.labels == ["a", "b", "c"] def test_signal_type(self): """ @@ -361,7 +342,7 @@ def test_signal_type(self): multi_signals = MultiSignals(signal_type=Signal) - self.assertEqual(multi_signals.signal_type, Signal) + assert multi_signals.signal_type == Signal def test__init__(self): """ @@ -371,15 +352,11 @@ def test__init__(self): multi_signals = MultiSignals(self._range_1) np.testing.assert_array_equal(multi_signals.domain, self._domain_1) - np.testing.assert_array_equal( - multi_signals.range, self._range_1[:, None] - ) + np.testing.assert_array_equal(multi_signals.range, self._range_1[:, None]) multi_signals = MultiSignals(self._range_1, self._domain_2) np.testing.assert_array_equal(multi_signals.domain, self._domain_2) - np.testing.assert_array_equal( - multi_signals.range, self._range_1[:, None] - ) + np.testing.assert_array_equal(multi_signals.range, self._range_1[:, None]) multi_signals = MultiSignals(self._range_2, self._domain_2) np.testing.assert_array_equal(multi_signals.domain, self._domain_2) @@ -397,11 +374,9 @@ class NotSignal(Signal): """Not :class:`Signal` class.""" multi_signals = MultiSignals(self._range_1, signal_type=NotSignal) - self.assertIsInstance(multi_signals.signals["0"], NotSignal) + assert isinstance(multi_signals.signals["0"], NotSignal) np.testing.assert_array_equal(multi_signals.domain, self._domain_1) - np.testing.assert_array_equal( - multi_signals.range, self._range_1[:, None] - ) + np.testing.assert_array_equal(multi_signals.range, self._range_1[:, None]) if is_pandas_installed(): from pandas import DataFrame, Series @@ -410,9 +385,7 @@ class NotSignal(Signal): Series(dict(zip(self._domain_2, self._range_1))) ) np.testing.assert_array_equal(multi_signals.domain, self._domain_2) - np.testing.assert_array_equal( - multi_signals.range, self._range_1[:, None] - ) + np.testing.assert_array_equal(multi_signals.range, self._range_1[:, None]) data = dict(zip(["a", "b", "c"], tsplit(self._range_2))) multi_signals = MultiSignals(DataFrame(data, self._domain_2)) @@ -425,7 +398,7 @@ def test__hash__(self): method. """ - self.assertIsInstance(hash(self._multi_signals), int) + assert isinstance(hash(self._multi_signals), int) def test__str__(self): """ @@ -433,10 +406,11 @@ def test__str__(self): method. """ - self.assertEqual( - str(self._multi_signals), - textwrap.dedent( - """ + assert ( + str(self._multi_signals) + == ( + textwrap.dedent( + """ [[ 0. 10. 20. 30.] [ 1. 20. 30. 40.] [ 2. 30. 40. 50.] @@ -447,10 +421,11 @@ def test__str__(self): [ 7. 80. 90. 100.] [ 8. 90. 100. 110.] [ 9. 100. 110. 120.]]""" - )[1:], + )[1:] + ) ) - self.assertIsInstance(str(MultiSignals()), str) + assert isinstance(str(MultiSignals()), str) def test__repr__(self): """ @@ -458,8 +433,7 @@ def test__repr__(self): method. """ - self.assertEqual( - repr(self._multi_signals), + assert repr(self._multi_signals) == ( textwrap.dedent( """ MultiSignals([[ 0., 10., 20., 30.], @@ -478,10 +452,10 @@ def test__repr__(self): Extrapolator, {'method': 'Constant', 'left': nan, 'right': nan}) """ - ).strip(), + ).strip() ) - self.assertIsInstance(repr(MultiSignals()), str) + assert isinstance(repr(MultiSignals()), str) def test__getitem__(self): """ @@ -685,9 +659,7 @@ def test__setitem__(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - multi_signals[np.array([0, 1, 2])] = np.reshape( - np.arange(1, 10, 1), (3, 3) - ) + multi_signals[np.array([0, 1, 2])] = np.reshape(np.arange(1, 10, 1), (3, 3)) np.testing.assert_allclose( multi_signals.range, np.array( @@ -760,9 +732,9 @@ def test__contains__(self): method. """ - self.assertIn(0, self._multi_signals) - self.assertIn(0.5, self._multi_signals) - self.assertNotIn(1000, self._multi_signals) + assert 0 in self._multi_signals + assert 0.5 in self._multi_signals + assert 1000 not in self._multi_signals def test__iter__(self): """Test :func:`colour.continuous.signal.Signal.__iter__` method.""" @@ -770,9 +742,7 @@ def test__iter__(self): domain = np.arange(0, 10) for i, domain_range_value in enumerate(self._multi_signals): np.testing.assert_array_equal(domain_range_value[0], domain[i]) - np.testing.assert_array_equal( - domain_range_value[1:], self._range_2[i] - ) + np.testing.assert_array_equal(domain_range_value[1:], self._range_2[i]) def test__len__(self): """ @@ -780,7 +750,7 @@ def test__len__(self): method. """ - self.assertEqual(len(self._multi_signals), 10) + assert len(self._multi_signals) == 10 def test__eq__(self): """ @@ -791,9 +761,9 @@ def test__eq__(self): signal_1 = self._multi_signals.copy() signal_2 = self._multi_signals.copy() - self.assertEqual(signal_1, signal_2) + assert signal_1 == signal_2 - self.assertNotEqual(signal_1, None) + assert signal_1 != () def test__ne__(self): """ @@ -805,41 +775,41 @@ def test__ne__(self): multi_signals_2 = self._multi_signals.copy() multi_signals_2[0] = 20 - self.assertNotEqual(multi_signals_1, multi_signals_2) + assert multi_signals_1 != multi_signals_2 multi_signals_2[0] = np.array([10, 20, 30]) - self.assertEqual(multi_signals_1, multi_signals_2) + assert multi_signals_1 == multi_signals_2 multi_signals_2.interpolator = CubicSplineInterpolator - self.assertNotEqual(multi_signals_1, multi_signals_2) + assert multi_signals_1 != multi_signals_2 multi_signals_2.interpolator = KernelInterpolator - self.assertEqual(multi_signals_1, multi_signals_2) + assert multi_signals_1 == multi_signals_2 multi_signals_2.interpolator_kwargs = {"window": 1} - self.assertNotEqual(multi_signals_1, multi_signals_2) + assert multi_signals_1 != multi_signals_2 multi_signals_2.interpolator_kwargs = {} - self.assertEqual(multi_signals_1, multi_signals_2) + assert multi_signals_1 == multi_signals_2 class NotExtrapolator(Extrapolator): """Not :class:`Extrapolator` class.""" multi_signals_2.extrapolator = NotExtrapolator - self.assertNotEqual(multi_signals_1, multi_signals_2) + assert multi_signals_1 != multi_signals_2 multi_signals_2.extrapolator = Extrapolator - self.assertEqual(multi_signals_1, multi_signals_2) + assert multi_signals_1 == multi_signals_2 multi_signals_2.extrapolator_kwargs = {} - self.assertNotEqual(multi_signals_1, multi_signals_2) + assert multi_signals_1 != multi_signals_2 multi_signals_2.extrapolator_kwargs = { "method": "Constant", "left": np.nan, "right": np.nan, } - self.assertEqual(multi_signals_1, multi_signals_2) + assert multi_signals_1 == multi_signals_2 def test_arithmetical_operation(self): """ @@ -941,17 +911,13 @@ def test_arithmetical_operation(self): multi_signals = self._multi_signals.copy() np.testing.assert_allclose( - multi_signals.arithmetical_operation( - self._range_2, "+", False - ).range, + multi_signals.arithmetical_operation(self._range_2, "+", False).range, self._range_2 + self._range_2, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - multi_signals.arithmetical_operation( - multi_signals, "+", False - ).range, + multi_signals.arithmetical_operation(multi_signals, "+", False).range, self._range_2 + self._range_2, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -962,17 +928,17 @@ def test_is_uniform(self): method. """ - self.assertTrue(self._multi_signals.is_uniform()) + assert self._multi_signals.is_uniform() multi_signals = self._multi_signals.copy() multi_signals[0.5] = 1.0 - self.assertFalse(multi_signals.is_uniform()) + assert not multi_signals.is_uniform() def test_copy(self): """Test :func:`colour.continuous.multi_signals.MultiSignals.copy` method.""" - self.assertIsNot(self._multi_signals, self._multi_signals.copy()) - self.assertEqual(self._multi_signals, self._multi_signals.copy()) + assert self._multi_signals is not self._multi_signals.copy() + assert self._multi_signals == self._multi_signals.copy() def test_multi_signals_unpack_data(self): """ @@ -981,14 +947,12 @@ def test_multi_signals_unpack_data(self): """ signals = MultiSignals.multi_signals_unpack_data(self._range_1) - self.assertListEqual(list(signals.keys()), ["0"]) + assert list(signals.keys()) == ["0"] np.testing.assert_array_equal(signals["0"].domain, self._domain_1) np.testing.assert_array_equal(signals["0"].range, self._range_1) - signals = MultiSignals.multi_signals_unpack_data( - self._range_1, self._domain_2 - ) - self.assertListEqual(list(signals.keys()), ["0"]) + signals = MultiSignals.multi_signals_unpack_data(self._range_1, self._domain_2) + assert list(signals.keys()) == ["0"] np.testing.assert_array_equal(signals["0"].domain, self._domain_2) np.testing.assert_array_equal(signals["0"].range, self._range_1) @@ -997,10 +961,8 @@ def test_multi_signals_unpack_data(self): ) np.testing.assert_array_equal(signals["0"].domain, self._domain_2) - signals = MultiSignals.multi_signals_unpack_data( - self._range_2, self._domain_2 - ) - self.assertListEqual(list(signals.keys()), ["0", "1", "2"]) + signals = MultiSignals.multi_signals_unpack_data(self._range_2, self._domain_2) + assert list(signals.keys()) == ["0", "1", "2"] np.testing.assert_array_equal(signals["0"].range, self._range_1) np.testing.assert_array_equal(signals["1"].range, self._range_1 + 10) np.testing.assert_array_equal(signals["2"].range, self._range_1 + 20) @@ -1028,7 +990,7 @@ def test_multi_signals_unpack_data(self): signals = MultiSignals.multi_signals_unpack_data( dict(zip(self._domain_2, self._range_2)) ) - self.assertListEqual(list(signals.keys()), ["0", "1", "2"]) + assert list(signals.keys()) == ["0", "1", "2"] np.testing.assert_array_equal(signals["0"].range, self._range_1) np.testing.assert_array_equal(signals["1"].range, self._range_1 + 10) np.testing.assert_array_equal(signals["2"].range, self._range_1 + 20) @@ -1038,7 +1000,7 @@ def test_multi_signals_unpack_data(self): dict(zip(self._domain_2, self._range_2)) ) ) - self.assertListEqual(list(signals.keys()), ["0", "1", "2"]) + assert list(signals.keys()) == ["0", "1", "2"] np.testing.assert_array_equal(signals["0"].range, self._range_1) np.testing.assert_array_equal(signals["1"].range, self._range_1 + 10) np.testing.assert_array_equal(signals["2"].range, self._range_1 + 20) @@ -1046,7 +1008,7 @@ def test_multi_signals_unpack_data(self): signals = MultiSignals.multi_signals_unpack_data( dict(zip(self._domain_2, self._range_2)), labels=["0", "0", "0"] ) - self.assertListEqual(list(signals.keys()), ["0 - 0", "0 - 1", "0 - 2"]) + assert list(signals.keys()) == ["0 - 0", "0 - 1", "0 - 2"] if is_pandas_installed(): from pandas import DataFrame, Series @@ -1054,7 +1016,7 @@ def test_multi_signals_unpack_data(self): signals = MultiSignals.multi_signals_unpack_data( Series(dict(zip(self._domain_1, self._range_1))) ) - self.assertListEqual(list(signals.keys()), ["0"]) + assert list(signals.keys()) == ["0"] np.testing.assert_array_equal(signals["0"].domain, self._domain_1) np.testing.assert_array_equal(signals["0"].range, self._range_1) @@ -1062,14 +1024,10 @@ def test_multi_signals_unpack_data(self): signals = MultiSignals.multi_signals_unpack_data( DataFrame(data, self._domain_1) ) - self.assertListEqual(list(signals.keys()), ["a", "b", "c"]) + assert list(signals.keys()) == ["a", "b", "c"] np.testing.assert_array_equal(signals["a"].range, self._range_1) - np.testing.assert_array_equal( - signals["b"].range, self._range_1 + 10 - ) - np.testing.assert_array_equal( - signals["c"].range, self._range_1 + 20 - ) + np.testing.assert_array_equal(signals["b"].range, self._range_1 + 10) + np.testing.assert_array_equal(signals["c"].range, self._range_1 + 20) def test_fill_nan(self): """ @@ -1151,13 +1109,7 @@ def test_to_dataframe(self): data = dict(zip(["a", "b", "c"], tsplit(self._range_2))) attest( - MultiSignals( - self._range_2, self._domain_2, labels=["a", "b", "c"] - ) + MultiSignals(self._range_2, self._domain_2, labels=["a", "b", "c"]) .to_dataframe() .equals(DataFrame(data, self._domain_2)) ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/continuous/tests/test_signal.py b/colour/continuous/tests/test_signal.py index c5ade6088c..d2399cbb61 100644 --- a/colour/continuous/tests/test_signal.py +++ b/colour/continuous/tests/test_signal.py @@ -1,11 +1,10 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.continuous.signal` module.""" import pickle import textwrap -import unittest import numpy as np +import pytest from colour.algebra import ( CubicSplineInterpolator, @@ -28,10 +27,10 @@ ] -class TestSignal(unittest.TestCase): +class TestSignal: """Define :class:`colour.continuous.signal.Signal` class unit tests methods.""" - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._range = np.linspace(10, 100, 10) @@ -54,7 +53,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(Signal)) + assert attribute in dir(Signal) def test_required_methods(self): """Test the presence of required methods.""" @@ -78,7 +77,7 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(Signal)) + assert method in dir(Signal) def test_pickling(self): """ @@ -88,16 +87,16 @@ def test_pickling(self): data = pickle.dumps(self._signal) data = pickle.loads(data) # noqa: S301 - self.assertEqual(self._signal, data) + assert self._signal == data def test_dtype(self): """Test :func:`colour.continuous.signal.Signal.dtype` property.""" - self.assertEqual(self._signal.dtype, DTYPE_FLOAT_DEFAULT) + assert self._signal.dtype == DTYPE_FLOAT_DEFAULT signal = self._signal.copy() signal.dtype = np.float32 - self.assertEqual(signal.dtype, np.float32) + assert signal.dtype == np.float32 def test_domain(self): """Test :func:`colour.continuous.signal.Signal.domain` property.""" @@ -128,7 +127,7 @@ def assert_warns(): signal.domain = domain - self.assertWarns(ColourRuntimeWarning, assert_warns) + pytest.warns(ColourRuntimeWarning, assert_warns) def test_range(self): """Test :func:`colour.continuous.signal.Signal.range` property.""" @@ -156,7 +155,7 @@ def assert_warns(): signal.range = self._range * np.inf - self.assertWarns(ColourRuntimeWarning, assert_warns) + pytest.warns(ColourRuntimeWarning, assert_warns) def test_interpolator(self): """Test :func:`colour.continuous.signal.Signal.interpolator` property.""" @@ -226,7 +225,7 @@ def test_interpolator_kwargs(self): def test_extrapolator(self): """Test :func:`colour.continuous.signal.Signal.extrapolator` property.""" - self.assertIsInstance(self._signal.extrapolator(), Extrapolator) + assert isinstance(self._signal.extrapolator(), Extrapolator) def test_extrapolator_kwargs(self): """ @@ -259,7 +258,7 @@ def test_raise_exception_function(self): exception. """ - self.assertRaises(ValueError, Signal().function, 0) + pytest.raises(ValueError, Signal().function, 0) def test__init__(self): """Test :func:`colour.continuous.signal.Signal.__init__` method.""" @@ -290,15 +289,16 @@ def test__init__(self): def test__hash__(self): """Test :func:`colour.continuous.signal.Signal.__hash__` method.""" - self.assertIsInstance(hash(self._signal), int) + assert isinstance(hash(self._signal), int) def test__str__(self): """Test :func:`colour.continuous.signal.Signal.__str__` method.""" - self.assertEqual( - str(self._signal), - textwrap.dedent( - """ + assert ( + str(self._signal) + == ( + textwrap.dedent( + """ [[ 0. 10.] [ 1. 20.] [ 2. 30.] @@ -309,16 +309,16 @@ def test__str__(self): [ 7. 80.] [ 8. 90.] [ 9. 100.]]""" - )[1:], + )[1:] + ) ) - self.assertIsInstance(str(Signal()), str) + assert isinstance(str(Signal()), str) def test__repr__(self): """Test :func:`colour.continuous.signal.Signal.__repr__` method.""" - self.assertEqual( - repr(self._signal), + assert repr(self._signal) == ( textwrap.dedent( """ Signal([[ 0., 10.], @@ -336,15 +336,15 @@ def test__repr__(self): Extrapolator, {'method': 'Constant', 'left': nan, 'right': nan}) """ - ).strip(), + ).strip() ) - self.assertIsInstance(repr(Signal()), str) + assert isinstance(repr(Signal()), str) def test__getitem__(self): """Test :func:`colour.continuous.signal.Signal.__getitem__` method.""" - self.assertEqual(self._signal[0], 10.0) + assert self._signal[0] == 10.0 np.testing.assert_allclose( self._signal[np.array([0, 1, 2])], @@ -393,26 +393,20 @@ def test__setitem__(self): signal[0] = 20 np.testing.assert_allclose( signal.range, - np.array( - [20.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0, 90.0, 100.0] - ), + np.array([20.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0, 90.0, 100.0]), ) signal[np.array([0, 1, 2])] = 30 np.testing.assert_allclose( signal.range, - np.array( - [30.0, 30.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0, 90.0, 100.0] - ), + np.array([30.0, 30.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0, 90.0, 100.0]), atol=TOLERANCE_ABSOLUTE_TESTS, ) signal[0:3] = 40 np.testing.assert_allclose( signal.range, - np.array( - [40.0, 40.0, 40.0, 40.0, 50.0, 60.0, 70.0, 80.0, 90.0, 100.0] - ), + np.array([40.0, 40.0, 40.0, 40.0, 50.0, 60.0, 70.0, 80.0, 90.0, 100.0]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -486,9 +480,9 @@ def test__setitem__(self): def test__contains__(self): """Test :func:`colour.continuous.signal.Signal.__contains__` method.""" - self.assertIn(0, self._signal) - self.assertIn(0.5, self._signal) - self.assertNotIn(1000, self._signal) + assert 0 in self._signal + assert 0.5 in self._signal + assert 1000 not in self._signal def test__iter__(self): """Test :func:`colour.continuous.signal.Signal.__iter__` method.""" @@ -501,7 +495,7 @@ def test__iter__(self): def test__len__(self): """Test :func:`colour.continuous.signal.Signal.__len__` method.""" - self.assertEqual(len(self._signal), 10) + assert len(self._signal) == 10 def test__eq__(self): """Test :func:`colour.continuous.signal.Signal.__eq__` method.""" @@ -509,7 +503,7 @@ def test__eq__(self): signal_1 = self._signal.copy() signal_2 = self._signal.copy() - self.assertEqual(signal_1, signal_2) + assert signal_1 == signal_2 def test__ne__(self): """Test :func:`colour.continuous.signal.Signal.__ne__` method.""" @@ -518,41 +512,41 @@ def test__ne__(self): signal_2 = self._signal.copy() signal_2[0] = 20 - self.assertNotEqual(signal_1, signal_2) + assert signal_1 != signal_2 signal_2[0] = 10 - self.assertEqual(signal_1, signal_2) + assert signal_1 == signal_2 signal_2.interpolator = CubicSplineInterpolator - self.assertNotEqual(signal_1, signal_2) + assert signal_1 != signal_2 signal_2.interpolator = KernelInterpolator - self.assertEqual(signal_1, signal_2) + assert signal_1 == signal_2 signal_2.interpolator_kwargs = {"window": 1} - self.assertNotEqual(signal_1, signal_2) + assert signal_1 != signal_2 signal_2.interpolator_kwargs = {} - self.assertEqual(signal_1, signal_2) + assert signal_1 == signal_2 class NotExtrapolator(Extrapolator): """Not :class:`Extrapolator` class.""" signal_2.extrapolator = NotExtrapolator - self.assertNotEqual(signal_1, signal_2) + assert signal_1 != signal_2 signal_2.extrapolator = Extrapolator - self.assertEqual(signal_1, signal_2) + assert signal_1 == signal_2 signal_2.extrapolator_kwargs = {} - self.assertNotEqual(signal_1, signal_2) + assert signal_1 != signal_2 signal_2.extrapolator_kwargs = { "method": "Constant", "left": np.nan, "right": np.nan, } - self.assertEqual(signal_1, signal_2) + assert signal_1 == signal_2 def test_arithmetical_operation(self): """ @@ -669,17 +663,17 @@ def test_arithmetical_operation(self): def test_is_uniform(self): """Test :func:`colour.continuous.signal.Signal.is_uniform` method.""" - self.assertTrue(self._signal.is_uniform()) + assert self._signal.is_uniform() signal = self._signal.copy() signal[0.5] = 1.0 - self.assertFalse(signal.is_uniform()) + assert not signal.is_uniform() def test_copy(self): """Test :func:`colour.continuous.signal.Signal.copy` method.""" - self.assertIsNot(self._signal, self._signal.copy()) - self.assertEqual(self._signal, self._signal.copy()) + assert self._signal is not self._signal.copy() + assert self._signal == self._signal.copy() def test_signal_unpack_data(self): """ @@ -700,15 +694,11 @@ def test_signal_unpack_data(self): ) np.testing.assert_array_equal(domain, self._domain) - domain, range_ = Signal.signal_unpack_data( - dict(zip(self._domain, self._range)) - ) + domain, range_ = Signal.signal_unpack_data(dict(zip(self._domain, self._range))) np.testing.assert_array_equal(range_, self._range) np.testing.assert_array_equal(domain, self._domain) - domain, range_ = Signal.signal_unpack_data( - Signal(self._range, self._domain) - ) + domain, range_ = Signal.signal_unpack_data(Signal(self._range, self._domain)) np.testing.assert_array_equal(range_, self._range) np.testing.assert_array_equal(domain, self._domain) @@ -730,9 +720,7 @@ def test_fill_nan(self): np.testing.assert_allclose( signal.fill_nan().range, - np.array( - [10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0, 90.0, 100.0] - ), + np.array([10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 80.0, 90.0, 100.0]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -740,9 +728,7 @@ def test_fill_nan(self): np.testing.assert_allclose( signal.fill_nan(method="Constant").range, - np.array( - [10.0, 20.0, 30.0, 0.0, 0.0, 0.0, 0.0, 80.0, 90.0, 100.0] - ), + np.array([10.0, 20.0, 30.0, 0.0, 0.0, 0.0, 0.0, 80.0, 90.0, 100.0]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -767,11 +753,7 @@ def test_to_series(self): if is_pandas_installed(): from pandas import Series - self.assertEqual( - Signal(self._range, self._domain).to_series().all(), - Series(dict(zip(self._domain, self._range))).all(), + assert ( + Signal(self._range, self._domain).to_series().all() + == Series(dict(zip(self._domain, self._range))).all() ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/contrast/barten1999.py b/colour/contrast/barten1999.py index 7e7628e17b..70b9284053 100644 --- a/colour/contrast/barten1999.py +++ b/colour/contrast/barten1999.py @@ -2,7 +2,7 @@ Barten (1999) Contrast Sensitivity Function =========================================== -Defines the *Barten (1999)* contrast sensitivity function: +Define the *Barten (1999)* contrast sensitivity function: - :func:`colour.contrast.contrast_sensitivity_function_Barten1999` @@ -50,9 +50,7 @@ ] -def optical_MTF_Barten1999( - u: ArrayLike, sigma: ArrayLike = 0.01 -) -> NDArrayFloat: +def optical_MTF_Barten1999(u: ArrayLike, sigma: ArrayLike = 0.01) -> NDArrayFloat: """ Return the optical modulation transfer function (MTF) :math:`M_{opt}` of the eye using *Barten (1999)* method. @@ -219,7 +217,7 @@ def retinal_illuminance_Barten1999( Notes ----- - This definition is for use with photopic viewing conditions and thus - corrects for the Stiles-Crawford effect by default, i.e. directional + corrects for the Stiles-Crawford effect by default, i.e., directional sensitivity of the cone cells with lower response of cone cells receiving light from the edge of the pupil. @@ -291,9 +289,7 @@ def maximum_angular_size_Barten1999( X_max = as_float_array(X_max) N_max = as_float_array(N_max) - return as_float( - (1 / X_0**2 + 1 / X_max**2 + u**2 / N_max**2) ** -0.5 - ) + return as_float((1 / X_0**2 + 1 / X_max**2 + u**2 / N_max**2) ** -0.5) def contrast_sensitivity_function_Barten1999( @@ -499,10 +495,7 @@ def contrast_sensitivity_function_Barten1999( ) S = (M_opt / k) / np.sqrt( - 2 - / T - * M_as - * (1 / (n * p * E) + phi_0 / (1 - np.exp(-((u / u_0) ** 2)))) + 2 / T * M_as * (1 / (n * p * E) + phi_0 / (1 - np.exp(-((u / u_0) ** 2)))) ) return as_float(S) diff --git a/colour/contrast/tests/test_barten1999.py b/colour/contrast/tests/test_barten1999.py index c2e6e335d5..fdc976e311 100644 --- a/colour/contrast/tests/test_barten1999.py +++ b/colour/contrast/tests/test_barten1999.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.contrast.barten1999` module.""" -import unittest from itertools import product import numpy as np @@ -34,7 +32,7 @@ ] -class TestOpticalMTFBarten1999(unittest.TestCase): +class TestOpticalMTFBarten1999: """ Define :func:`colour.contrast.barten1999.optical_MTF_Barten1999` definition unit tests methods. @@ -104,7 +102,7 @@ def test_nan_optical_MTF_Barten1999(self): optical_MTF_Barten1999(cases, cases) -class TestPupilDiameterBarten1999(unittest.TestCase): +class TestPupilDiameterBarten1999: """ Define :func:`colour.contrast.barten1999.pupil_diameter_Barten1999` definition unit tests methods. @@ -175,7 +173,7 @@ def test_nan_pupil_diameter_Barten1999(self): pupil_diameter_Barten1999(cases, cases, cases) -class TestSigmaBarten1999(unittest.TestCase): +class TestSigmaBarten1999: """ Define :func:`colour.contrast.barten1999.sigma_Barten1999` definition unit tests methods. @@ -249,7 +247,7 @@ def test_nan_sigma_Barten1999(self): sigma_Barten1999(cases, cases, cases) -class TestRetinalIlluminanceBarten1999(unittest.TestCase): +class TestRetinalIlluminanceBarten1999: """ Define :func:`colour.contrast.barten1999.retinal_illuminance_Barten1999` definition unit tests methods. @@ -319,7 +317,7 @@ def test_nan_retinal_illuminance_Barten1999(self): retinal_illuminance_Barten1999(cases, cases) -class TestMaximumAngularSizeBarten1999(unittest.TestCase): +class TestMaximumAngularSizeBarten1999: """ Define :func:`colour.contrast.barten1999.maximum_angular_size_Barten1999` definition unit tests methods. @@ -403,7 +401,7 @@ def test_nan_maximum_angular_size_Barten1999(self): maximum_angular_size_Barten1999(cases, cases, cases, cases) -class TestContrastSensitivityFunctionBarten1999(unittest.TestCase): +class TestContrastSensitivityFunctionBarten1999: """ Define :func:`colour.contrast.barten1999.\ contrast_sensitivity_function_Barten1999` definition unit tests methods. @@ -554,17 +552,13 @@ def test_n_dimensional_contrast_sensitivity_function_Barten1999(self): sigma = np.array([0.01, 0.02, 0.04]) E = np.array([0.65, 90, 1500]) X_0 = np.array([60, 120, 240]) - S = contrast_sensitivity_function_Barten1999( - u=u, sigma=sigma, E=E, X_0=X_0 - ) + S = contrast_sensitivity_function_Barten1999(u=u, sigma=sigma, E=E, X_0=X_0) u = np.tile(u, (6, 1)) E = np.tile(E, (6, 1)) S = np.tile(S, (6, 1)) np.testing.assert_allclose( - contrast_sensitivity_function_Barten1999( - u=u, sigma=sigma, E=E, X_0=X_0 - ), + contrast_sensitivity_function_Barten1999(u=u, sigma=sigma, E=E, X_0=X_0), S, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -573,9 +567,7 @@ def test_n_dimensional_contrast_sensitivity_function_Barten1999(self): E = np.reshape(E, (2, 3, 3)) S = np.reshape(S, (2, 3, 3)) np.testing.assert_allclose( - contrast_sensitivity_function_Barten1999( - u=u, sigma=sigma, E=E, X_0=X_0 - ), + contrast_sensitivity_function_Barten1999(u=u, sigma=sigma, E=E, X_0=X_0), S, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -592,7 +584,3 @@ def test_nan_contrast_sensitivity_function_Barten1999(self): contrast_sensitivity_function_Barten1999( u=cases, sigma=cases, E=cases, X_0=cases ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/corresponding/datasets/breneman1987.py b/colour/corresponding/datasets/breneman1987.py index f41d07575f..75a19a1cb4 100644 --- a/colour/corresponding/datasets/breneman1987.py +++ b/colour/corresponding/datasets/breneman1987.py @@ -2,7 +2,7 @@ Breneman Corresponding Chromaticities Dataset ============================================= -Defines the *Breneman (1987)* results for corresponding chromaticities +Define the *Breneman (1987)* results for corresponding chromaticities experiments. References @@ -119,9 +119,7 @@ class PrimariesChromaticityCoordinates( Chromaticity coordinates :math:`uv^p` of primary :math:`T`. """ - def __new__( - cls, experiment, illuminants, Y, P_uvp=None, D_uvp=None, T_uvp=None - ): + def __new__(cls, experiment, illuminants, Y, P_uvp=None, D_uvp=None, T_uvp=None): """ Return a new instance of the :class:`colour.corresponding.datasets.corresponding_chromaticities.\ @@ -356,18 +354,12 @@ def __new__( BrenemanExperimentResult("Orange", (0.331, 0.548), (0.303, 0.545), (4, 3)), BrenemanExperimentResult("Brown", (0.322, 0.541), (0.303, 0.538), (4, 4)), BrenemanExperimentResult("Yellow", (0.268, 0.555), (0.264, 0.550), (3, 2)), - BrenemanExperimentResult( - "Foliage", (0.224, 0.538), (0.227, 0.535), (3, 3) - ), + BrenemanExperimentResult("Foliage", (0.224, 0.538), (0.227, 0.535), (3, 3)), BrenemanExperimentResult("Green", (0.134, 0.531), (0.159, 0.530), (9, 3)), - BrenemanExperimentResult( - "Blue-green", (0.145, 0.474), (0.165, 0.490), (8, 3) - ), + BrenemanExperimentResult("Blue-green", (0.145, 0.474), (0.165, 0.490), (8, 3)), BrenemanExperimentResult("Blue", (0.163, 0.329), (0.173, 0.378), (7, 12)), BrenemanExperimentResult("Sky", (0.179, 0.438), (0.189, 0.462), (5, 4)), - BrenemanExperimentResult( - "Purple", (0.245, 0.364), (0.239, 0.401), (4, 16) - ), + BrenemanExperimentResult("Purple", (0.245, 0.364), (0.239, 0.401), (4, 16)), ) """ *Breneman (1987)* experiment 5 results. @@ -436,18 +428,12 @@ def __new__( BrenemanExperimentResult("Orange", (0.331, 0.549), (0.305, 0.547), (5, 4)), BrenemanExperimentResult("Brown", (0.322, 0.541), (0.301, 0.539), (5, 2)), BrenemanExperimentResult("Yellow", (0.268, 0.555), (0.257, 0.552), (3, 4)), - BrenemanExperimentResult( - "Foliage", (0.225, 0.538), (0.222, 0.536), (3, 2) - ), + BrenemanExperimentResult("Foliage", (0.225, 0.538), (0.222, 0.536), (3, 2)), BrenemanExperimentResult("Green", (0.135, 0.531), (0.153, 0.529), (8, 2)), - BrenemanExperimentResult( - "Blue-green", (0.145, 0.475), (0.160, 0.484), (3, 5) - ), + BrenemanExperimentResult("Blue-green", (0.145, 0.475), (0.160, 0.484), (3, 5)), BrenemanExperimentResult("Blue", (0.163, 0.331), (0.171, 0.379), (4, 11)), BrenemanExperimentResult("Sky", (0.179, 0.438), (0.187, 0.452), (4, 7)), - BrenemanExperimentResult( - "Purple", (0.245, 0.365), (0.240, 0.398), (4, 10) - ), + BrenemanExperimentResult("Purple", (0.245, 0.365), (0.240, 0.398), (4, 10)), ) """ *Breneman (1987)* experiment 7 results. @@ -587,18 +573,12 @@ def __new__( BrenemanExperimentResult("Orange", (0.331, 0.549), (0.315, 0.536), (7, 8)), BrenemanExperimentResult("Brown", (0.323, 0.542), (0.310, 0.526), (6, 8)), BrenemanExperimentResult("Yellow", (0.268, 0.556), (0.268, 0.541), (3, 6)), - BrenemanExperimentResult( - "Foliage", (0.226, 0.538), (0.230, 0.525), (4, 8) - ), + BrenemanExperimentResult("Foliage", (0.226, 0.538), (0.230, 0.525), (4, 8)), BrenemanExperimentResult("Green", (0.135, 0.531), (0.158, 0.524), (6, 3)), - BrenemanExperimentResult( - "Blue-green", (0.145, 0.476), (0.161, 0.491), (4, 4) - ), + BrenemanExperimentResult("Blue-green", (0.145, 0.476), (0.161, 0.491), (4, 4)), BrenemanExperimentResult("Blue", (0.163, 0.330), (0.171, 0.377), (6, 19)), BrenemanExperimentResult("Sky", (0.179, 0.439), (0.187, 0.465), (5, 5)), - BrenemanExperimentResult( - "Purple", (0.245, 0.366), (0.240, 0.402), (3, 12) - ), + BrenemanExperimentResult("Purple", (0.245, 0.366), (0.240, 0.402), (3, 12)), ) """ *Breneman (1987)* experiment 10 results. diff --git a/colour/corresponding/prediction.py b/colour/corresponding/prediction.py index 60f1842f93..f6e60f408b 100644 --- a/colour/corresponding/prediction.py +++ b/colour/corresponding/prediction.py @@ -2,7 +2,7 @@ Corresponding Chromaticities Prediction ======================================= -Defines the objects to compute corresponding chromaticities prediction. +Define the objects to compute corresponding chromaticities prediction. References ---------- @@ -178,7 +178,7 @@ class CorrespondingChromaticitiesPrediction( def convert_experiment_results_Breneman1987( - experiment: Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] + experiment: Literal[1, 2, 3, 4, 6, 8, 9, 11, 12], ) -> CorrespondingColourDataset: """ Convert *Breneman (1987)* experiment results to a @@ -302,8 +302,7 @@ def convert_experiment_results_Breneman1987( def corresponding_chromaticities_prediction_Fairchild1990( - experiment: Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] - | CorrespondingColourDataset = 1 + experiment: (Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] | CorrespondingColourDataset) = 1, ) -> Tuple[CorrespondingChromaticitiesPrediction, ...]: """ Return the corresponding chromaticities prediction for *Fairchild (1990)* @@ -372,8 +371,7 @@ def corresponding_chromaticities_prediction_Fairchild1990( def corresponding_chromaticities_prediction_CIE1994( - experiment: Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] - | CorrespondingColourDataset = 1 + experiment: (Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] | CorrespondingColourDataset) = 1, ) -> Tuple[CorrespondingChromaticitiesPrediction, ...]: """ Return the corresponding chromaticities prediction for *CIE 1994* @@ -431,9 +429,7 @@ def corresponding_chromaticities_prediction_CIE1994( E_o1, E_o2 = experiment_results.Y_t, experiment_results.Y_r XYZ_1 = experiment_results.XYZ_ct - XYZ_2 = chromatic_adaptation_CIE1994( - XYZ_1, xy_o1, xy_o2, Y_r, E_o1, E_o2 - ) + XYZ_2 = chromatic_adaptation_CIE1994(XYZ_1, xy_o1, xy_o2, Y_r, E_o1, E_o2) uv_p = Luv_to_uv(XYZ_to_Luv(XYZ_2, xy_o2), xy_o2) return tuple( @@ -445,8 +441,7 @@ def corresponding_chromaticities_prediction_CIE1994( def corresponding_chromaticities_prediction_CMCCAT2000( - experiment: Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] - | CorrespondingColourDataset = 1 + experiment: (Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] | CorrespondingColourDataset) = 1, ) -> Tuple[CorrespondingChromaticitiesPrediction, ...]: """ Return the corresponding chromaticities prediction for *CMCCAT2000* @@ -504,9 +499,7 @@ def corresponding_chromaticities_prediction_CMCCAT2000( L_A2 = experiment_results.Y_r XYZ_1 = experiment_results.XYZ_ct - XYZ_2 = chromatic_adaptation_CMCCAT2000( - XYZ_1, XYZ_w, XYZ_wr, L_A1, L_A2 - ) + XYZ_2 = chromatic_adaptation_CMCCAT2000(XYZ_1, XYZ_w, XYZ_wr, L_A1, L_A2) uv_p = Luv_to_uv(XYZ_to_Luv(XYZ_2, xy_wr), xy_wr) return tuple( @@ -518,8 +511,7 @@ def corresponding_chromaticities_prediction_CMCCAT2000( def corresponding_chromaticities_prediction_VonKries( - experiment: Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] - | CorrespondingColourDataset = 1, + experiment: (Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] | CorrespondingColourDataset) = 1, transform: LiteralChromaticAdaptationTransform | str = "CAT02", ) -> Tuple[CorrespondingChromaticitiesPrediction, ...]: """ @@ -589,8 +581,7 @@ def corresponding_chromaticities_prediction_VonKries( def corresponding_chromaticities_prediction_Zhai2018( - experiment: Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] - | CorrespondingColourDataset = 1, + experiment: (Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] | CorrespondingColourDataset) = 1, D_b: ArrayLike = 1, D_d: ArrayLike = 1, XYZ_wo: ArrayLike = np.array([1, 1, 1]), @@ -700,12 +691,17 @@ def corresponding_chromaticities_prediction_Zhai2018( def corresponding_chromaticities_prediction( - experiment: Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] - | CorrespondingColourDataset = 1, - model: Literal[ - "CIE 1994", "CMCCAT2000", "Fairchild 1990", "Von Kries", "Zhai 2018" - ] - | str = "Von Kries", + experiment: (Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] | CorrespondingColourDataset) = 1, + model: ( + Literal[ + "CIE 1994", + "CMCCAT2000", + "Fairchild 1990", + "Von Kries", + "Zhai 2018", + ] + | str + ) = "Von Kries", **kwargs: Any, ) -> Tuple[CorrespondingChromaticitiesPrediction, ...]: """ diff --git a/colour/corresponding/tests/test_prediction.py b/colour/corresponding/tests/test_prediction.py index 3cb8122044..e4b9eb4a10 100644 --- a/colour/corresponding/tests/test_prediction.py +++ b/colour/corresponding/tests/test_prediction.py @@ -1,10 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.corresponding.prediction` module.""" from __future__ import annotations -import unittest - import numpy as np from colour.constants import TOLERANCE_ABSOLUTE_TESTS @@ -42,101 +39,95 @@ "TestCorrespondingChromaticitiesPredictionZhai2018", ] -DATASET_CORRESPONDING_COLOUR_1: CorrespondingColourDataset = ( - CorrespondingColourDataset( - name=1, - XYZ_r=np.array( - [0.947368421052632, 1.000000000000000, 1.000000000000000] - ), - XYZ_t=np.array( - [1.107889733840304, 1.000000000000000, 0.334125475285171] - ), - XYZ_cr=np.array( +DATASET_CORRESPONDING_COLOUR_1: CorrespondingColourDataset = CorrespondingColourDataset( + name=1, + XYZ_r=np.array([0.947368421052632, 1.000000000000000, 1.000000000000000]), + XYZ_t=np.array([1.107889733840304, 1.000000000000000, 0.334125475285171]), + XYZ_cr=np.array( + [ [ - [ - 372.358829568788565, - 405.000000000000000, - 345.746919917864489, - ], - [250.638506876227865, 135.000000000000000, 37.131630648330052], - [ - 456.541750503018136, - 405.000000000000000, - 267.487424547283638, - ], - [502.185218978102114, 405.000000000000000, 24.758211678831920], - [164.036312849162016, 135.000000000000000, 24.511173184357535], - [422.727888086642622, 405.000000000000000, 27.231498194945619], - [110.245746691871460, 135.000000000000000, 53.846880907372366], - [75.208733205374273, 135.000000000000000, 77.281669865642954], - [ - 258.414179104477626, - 405.000000000000000, - 479.480277185501166, - ], - [ - 141.154411764705856, - 135.000000000000000, - 469.124999999999943, - ], - [ - 380.757042253521092, - 405.000000000000000, - 700.193661971831261, - ], - [ - 192.236301369863071, - 135.000000000000000, - 370.510273972602761, - ], - ] - ), - XYZ_ct=np.array( + 372.358829568788565, + 405.000000000000000, + 345.746919917864489, + ], + [250.638506876227865, 135.000000000000000, 37.131630648330052], [ - [ - 450.407919847328230, - 405.000000000000000, - 143.566316793893037, - ], - [267.090517241379359, 135.000000000000000, 11.831896551724059], - [ - 531.851235741444839, - 405.000000000000000, - 107.602186311787023, - ], - [603.033088235294031, 405.000000000000000, 7.444852941176350], - [196.511090573012893, 135.000000000000000, 8.109981515711597], - [526.868181818181711, 405.000000000000000, 8.468181818181574], - [144.589483394833962, 135.000000000000000, 24.035977859778562], - [108.161900369003689, 135.000000000000000, 36.178505535055272], - [ - 317.877906976744100, - 405.000000000000000, - 223.691860465116235, - ], - [ - 126.960674157303373, - 135.000000000000000, - 192.792134831460686, - ], - [ - 419.434826883910489, - 405.000000000000000, - 309.730142566191489, - ], - [ - 185.180921052631589, - 135.000000000000000, - 151.430921052631589, - ], - ] - ), - Y_r=np.array(1500), - Y_t=np.array(1500), - B_r=0.3, - B_t=0.3, - metadata={}, - ) + 456.541750503018136, + 405.000000000000000, + 267.487424547283638, + ], + [502.185218978102114, 405.000000000000000, 24.758211678831920], + [164.036312849162016, 135.000000000000000, 24.511173184357535], + [422.727888086642622, 405.000000000000000, 27.231498194945619], + [110.245746691871460, 135.000000000000000, 53.846880907372366], + [75.208733205374273, 135.000000000000000, 77.281669865642954], + [ + 258.414179104477626, + 405.000000000000000, + 479.480277185501166, + ], + [ + 141.154411764705856, + 135.000000000000000, + 469.124999999999943, + ], + [ + 380.757042253521092, + 405.000000000000000, + 700.193661971831261, + ], + [ + 192.236301369863071, + 135.000000000000000, + 370.510273972602761, + ], + ] + ), + XYZ_ct=np.array( + [ + [ + 450.407919847328230, + 405.000000000000000, + 143.566316793893037, + ], + [267.090517241379359, 135.000000000000000, 11.831896551724059], + [ + 531.851235741444839, + 405.000000000000000, + 107.602186311787023, + ], + [603.033088235294031, 405.000000000000000, 7.444852941176350], + [196.511090573012893, 135.000000000000000, 8.109981515711597], + [526.868181818181711, 405.000000000000000, 8.468181818181574], + [144.589483394833962, 135.000000000000000, 24.035977859778562], + [108.161900369003689, 135.000000000000000, 36.178505535055272], + [ + 317.877906976744100, + 405.000000000000000, + 223.691860465116235, + ], + [ + 126.960674157303373, + 135.000000000000000, + 192.792134831460686, + ], + [ + 419.434826883910489, + 405.000000000000000, + 309.730142566191489, + ], + [ + 185.180921052631589, + 135.000000000000000, + 151.430921052631589, + ], + ] + ), + Y_r=np.array(1500), + Y_t=np.array(1500), + B_r=0.3, + B_t=0.3, + metadata={}, ) DATA_PREDICTION_FAIRCHILD1990: NDArrayFloat = np.array( @@ -225,7 +216,7 @@ ) -class TestConvertExperimentResultsBreneman1987(unittest.TestCase): +class TestConvertExperimentResultsBreneman1987: """ Define :func:`colour.corresponding.prediction.\ convert_experiment_results_Breneman1987` definition unit tests @@ -238,9 +229,7 @@ def test_convert_experiment_results_Breneman1987(self): convert_experiment_results_Breneman1987` definition. """ - corresponding_colour_dataset = convert_experiment_results_Breneman1987( - 1 - ) + corresponding_colour_dataset = convert_experiment_results_Breneman1987(1) np.testing.assert_allclose( corresponding_colour_dataset.XYZ_r, @@ -279,9 +268,7 @@ def test_convert_experiment_results_Breneman1987(self): ) -class TestCorrespondingChromaticitiesPredictionFairchild1990( - unittest.TestCase -): +class TestCorrespondingChromaticitiesPredictionFairchild1990: """ Define :func:`colour.corresponding.prediction.\ corresponding_chromaticities_prediction_Fairchild1990` definition unit tests @@ -306,7 +293,7 @@ def test_corresponding_chromaticities_prediction_Fairchild1990(self): ) -class TestCorrespondingChromaticitiesPredictionCIE1994(unittest.TestCase): +class TestCorrespondingChromaticitiesPredictionCIE1994: """ Define :func:`colour.corresponding.prediction.\ corresponding_chromaticities_prediction_CIE1994` definition unit tests methods. @@ -330,7 +317,7 @@ def test_corresponding_chromaticities_prediction_CIE1994(self): ) -class TestCorrespondingChromaticitiesPredictionCMCCAT2000(unittest.TestCase): +class TestCorrespondingChromaticitiesPredictionCMCCAT2000: """ Define :func:`colour.corresponding.prediction.\ corresponding_chromaticities_prediction_CMCCAT2000` definition unit tests @@ -355,7 +342,7 @@ def test_corresponding_chromaticities_prediction_CMCCAT2000(self): ) -class TestCorrespondingChromaticitiesPredictionVonKries(unittest.TestCase): +class TestCorrespondingChromaticitiesPredictionVonKries: """ Define :func:`colour.corresponding.prediction.\ corresponding_chromaticities_prediction_VonKries` definition unit tests @@ -380,7 +367,7 @@ def test_corresponding_chromaticities_prediction_VonKries(self): ) -class TestCorrespondingChromaticitiesPredictionZhai2018(unittest.TestCase): +class TestCorrespondingChromaticitiesPredictionZhai2018: """ Define :func:`colour.corresponding.prediction.\ corresponding_chromaticities_prediction_Zhai2018` definition unit tests diff --git a/colour/difference/__init__.py b/colour/difference/__init__.py index ded7f048c1..32922ec693 100644 --- a/colour/difference/__init__.py +++ b/colour/difference/__init__.py @@ -124,21 +124,23 @@ def delta_E( a: ArrayLike, b: ArrayLike, - method: Literal[ - "CIE 1976", - "CIE 1994", - "CIE 2000", - "CMC", - "ITP", - "CAM02-LCD", - "CAM02-SCD", - "CAM02-UCS", - "CAM16-LCD", - "CAM16-SCD", - "CAM16-UCS", - "DIN99", - ] - | str = "CIE 2000", + method: ( + Literal[ + "CIE 1976", + "CIE 1994", + "CIE 2000", + "CMC", + "ITP", + "CAM02-LCD", + "CAM02-SCD", + "CAM02-UCS", + "CAM16-LCD", + "CAM16-SCD", + "CAM16-UCS", + "DIN99", + ] + | str + ) = "CIE 2000", **kwargs: Any, ) -> NDArrayFloat: """ diff --git a/colour/difference/cam02_ucs.py b/colour/difference/cam02_ucs.py index 8480783806..2e88deaf14 100644 --- a/colour/difference/cam02_ucs.py +++ b/colour/difference/cam02_ucs.py @@ -2,7 +2,7 @@ :math:`\\Delta E'` - Delta E Colour Difference - Luo, Cui and Li (2006) ======================================================================= -Defines the :math:`\\Delta E'` colour difference computation objects based on +Define the :math:`\\Delta E'` colour difference computation objects based on *Luo et al. (2006)* *CAM02-LCD*, *CAM02-SCD*, and *CAM02-UCS* colourspaces: - :func:`colour.difference.delta_E_CAM02LCD` @@ -92,9 +92,7 @@ def delta_E_Luo2006( -------- >>> Jpapbp_1 = np.array([54.90433134, -0.08450395, -0.06854831]) >>> Jpapbp_2 = np.array([54.80352754, -3.96940084, -13.57591013]) - >>> delta_E_Luo2006( - ... Jpapbp_1, Jpapbp_2, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ... ) + >>> delta_E_Luo2006(Jpapbp_1, Jpapbp_2, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]) ... # doctest: +ELLIPSIS 14.0555464... """ @@ -104,9 +102,7 @@ def delta_E_Luo2006( K_L, _c_1, _c_2 = tsplit(coefficients) d_E = np.sqrt( - ((J_p_1 - J_p_2) / K_L) ** 2 - + (a_p_1 - a_p_2) ** 2 - + (b_p_1 - b_p_2) ** 2 + ((J_p_1 - J_p_2) / K_L) ** 2 + (a_p_1 - a_p_2) ** 2 + (b_p_1 - b_p_2) ** 2 ) return as_float(d_E) @@ -167,9 +163,7 @@ def delta_E_CAM02LCD(Jpapbp_1: ArrayLike, Jpapbp_2: ArrayLike) -> NDArrayFloat: 14.0555464... """ - return delta_E_Luo2006( - Jpapbp_1, Jpapbp_2, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ) + return delta_E_Luo2006(Jpapbp_1, Jpapbp_2, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]) def delta_E_CAM02SCD(Jpapbp_1: ArrayLike, Jpapbp_2: ArrayLike) -> NDArrayFloat: @@ -227,9 +221,7 @@ def delta_E_CAM02SCD(Jpapbp_1: ArrayLike, Jpapbp_2: ArrayLike) -> NDArrayFloat: 14.0551718... """ - return delta_E_Luo2006( - Jpapbp_1, Jpapbp_2, COEFFICIENTS_UCS_LUO2006["CAM02-SCD"] - ) + return delta_E_Luo2006(Jpapbp_1, Jpapbp_2, COEFFICIENTS_UCS_LUO2006["CAM02-SCD"]) def delta_E_CAM02UCS(Jpapbp_1: ArrayLike, Jpapbp_2: ArrayLike) -> NDArrayFloat: @@ -287,6 +279,4 @@ def delta_E_CAM02UCS(Jpapbp_1: ArrayLike, Jpapbp_2: ArrayLike) -> NDArrayFloat: 14.0552982... """ - return delta_E_Luo2006( - Jpapbp_1, Jpapbp_2, COEFFICIENTS_UCS_LUO2006["CAM02-UCS"] - ) + return delta_E_Luo2006(Jpapbp_1, Jpapbp_2, COEFFICIENTS_UCS_LUO2006["CAM02-UCS"]) diff --git a/colour/difference/cam16_ucs.py b/colour/difference/cam16_ucs.py index 06ccc3ae04..62de1db863 100644 --- a/colour/difference/cam16_ucs.py +++ b/colour/difference/cam16_ucs.py @@ -2,7 +2,7 @@ :math:`\\Delta E'` - Delta E Colour Difference - Li et al. (2017) ================================================================= -Defines the :math:`\\Delta E'` colour difference computation objects based on +Define the :math:`\\Delta E'` colour difference computation objects based on *Li, Li, Wang, Zu, Luo, Cui, Melgosa, Brill and Pointer (2017)* *CAM16-LCD*, *CAM16-SCD*, and *CAM16-UCS* colourspaces: @@ -44,9 +44,7 @@ ] delta_E_Li2017 = copy_definition(delta_E_Luo2006, "delta_E_Li2017") -delta_E_Li2017.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring( - delta_E_Luo2006 -) +delta_E_Li2017.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring(delta_E_Luo2006) delta_E_CAM16LCD = copy_definition(delta_E_CAM02LCD, "delta_E_CAM16LCD") delta_E_CAM16LCD.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring( diff --git a/colour/difference/delta_e.py b/colour/difference/delta_e.py index 72f3e7db01..caa5f7f13f 100644 --- a/colour/difference/delta_e.py +++ b/colour/difference/delta_e.py @@ -2,7 +2,7 @@ :math:`\\Delta E^*_{ab}` - Delta E Colour Difference ==================================================== -Defines the :math:`\\Delta E^*_{ab}` colour difference computation objects: +Define the :math:`\\Delta E^*_{ab}` colour difference computation objects: The following attributes and methods are available: @@ -72,7 +72,7 @@ JND_CIE1976 = DocstringFloat(JND_CIE1976) JND_CIE1976.__doc__ = """ Just Noticeable Difference (JND) according to *CIE 1976* colour difference -formula, i.e. Euclidean distance in *CIE L\\*a\\*b\\** colourspace. +formula, i.e., Euclidean distance in *CIE L\\*a\\*b\\** colourspace. Notes ----- diff --git a/colour/difference/din99.py b/colour/difference/din99.py index b2929e300f..e89669c78d 100644 --- a/colour/difference/din99.py +++ b/colour/difference/din99.py @@ -2,7 +2,7 @@ :math:`\\Delta E_{99}` DIN99 - Colour Difference Formula ======================================================== -Defines the :math:`\\Delta E_{99}` *DIN99* colour difference formula: +Define the :math:`\\Delta E_{99}` *DIN99* colour difference formula: - :func:`colour.difference.delta_E_DIN99` diff --git a/colour/difference/huang2015.py b/colour/difference/huang2015.py index ff09b59196..39854b3b65 100644 --- a/colour/difference/huang2015.py +++ b/colour/difference/huang2015.py @@ -2,7 +2,7 @@ Huang et al. (2015) Power-Functions =================================== -Defines the *Huang, Cui, Melgosa, Sanchez-Maranon, Li, Luo and Liu (2015)* +Define the *Huang, Cui, Melgosa, Sanchez-Maranon, Li, Luo and Liu (2015)* power-functions improving the performance of colour-difference formulas: - :func:`colour.difference.power_function_Huang2015` @@ -79,20 +79,22 @@ def power_function_Huang2015( d_E: ArrayLike, - coefficients: Literal[ - "CIE 1976", - "CIE 1994", - "CIE 2000", - "CMC", - "CAM02-LCD", - "CAM02-SCD", - "CAM16-UCS", - "DIN99d", - "OSA", - "OSA-GP-Euclidean", - "ULAB", - ] - | str = "CIE 2000", + coefficients: ( + Literal[ + "CIE 1976", + "CIE 1994", + "CIE 2000", + "CMC", + "CAM02-LCD", + "CAM02-SCD", + "CAM16-UCS", + "DIN99d", + "OSA", + "OSA-GP-Euclidean", + "ULAB", + ] + | str + ) = "CIE 2000", ) -> NDArrayFloat: """ Improve the performance of the :math:`\\Delta E` value for given diff --git a/colour/difference/stress.py b/colour/difference/stress.py index ac071d8223..2d0e54e3a8 100644 --- a/colour/difference/stress.py +++ b/colour/difference/stress.py @@ -2,7 +2,7 @@ Standardized Residual Sum of Squares (STRESS) Index =================================================== -Defines the *Kruskal's Standardized Residual Sum of Squares (:math:`STRESS`)* +Define the *Kruskal's Standardized Residual Sum of Squares (:math:`STRESS`)* index: - :func:`colour.index_stress_Garcia2007`: :math:`STRESS` index computation @@ -81,9 +81,7 @@ def index_stress_Garcia2007(d_E: ArrayLike, d_V: ArrayLike) -> NDArrayFloat: with sdiv_mode(): F_1 = sdiv(np.sum(d_E**2), np.sum(d_E * d_V)) - stress = np.sqrt( - sdiv(np.sum((d_E - F_1 * d_V) ** 2), np.sum(F_1**2 * d_V**2)) - ) + stress = np.sqrt(sdiv(np.sum((d_E - F_1 * d_V) ** 2), np.sum(F_1**2 * d_V**2))) return as_float(stress) diff --git a/colour/difference/tests/test__init__.py b/colour/difference/tests/test__init__.py index a5095bd5ee..33ec2f0312 100644 --- a/colour/difference/tests/test__init__.py +++ b/colour/difference/tests/test__init__.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.difference` module.""" -import unittest import numpy as np @@ -21,7 +19,7 @@ ] -class TestDelta_E(unittest.TestCase): +class TestDelta_E: """Define :func:`colour.difference.delta_E` definition unit tests methods.""" def test_domain_range_scale_delta_E(self): @@ -45,7 +43,3 @@ def test_domain_range_scale_delta_E(self): value, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/difference/tests/test_cam02_ucs.py b/colour/difference/tests/test_cam02_ucs.py index 375f847e31..e43ff51196 100644 --- a/colour/difference/tests/test_cam02_ucs.py +++ b/colour/difference/tests/test_cam02_ucs.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.difference.cam02_ucs` module.""" -import unittest from itertools import product import numpy as np @@ -28,7 +26,7 @@ ] -class TestDelta_E_Luo2006(unittest.TestCase): +class TestDelta_E_Luo2006: """ Define :func:`colour.difference.cam02_ucs.delta_E_Luo2006` definition unit tests methods. @@ -102,9 +100,7 @@ def test_n_dimensional_delta_E_Luo2006(self): Jpapbp_2 = np.tile(Jpapbp_2, (6, 1)) delta_E_p = np.tile(delta_E_p, 6) np.testing.assert_allclose( - delta_E_Luo2006( - Jpapbp_1, Jpapbp_2, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ), + delta_E_Luo2006(Jpapbp_1, Jpapbp_2, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]), delta_E_p, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -113,9 +109,7 @@ def test_n_dimensional_delta_E_Luo2006(self): Jpapbp_2 = np.reshape(Jpapbp_2, (2, 3, 3)) delta_E_p = np.reshape(delta_E_p, (2, 3)) np.testing.assert_allclose( - delta_E_Luo2006( - Jpapbp_1, Jpapbp_2, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ), + delta_E_Luo2006(Jpapbp_1, Jpapbp_2, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]), delta_E_p, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -130,7 +124,3 @@ def test_nan_delta_E_Luo2006(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) delta_E_Luo2006(cases, cases, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/difference/tests/test_cam16_ucs.py b/colour/difference/tests/test_cam16_ucs.py index ee1c659e06..410b164693 100644 --- a/colour/difference/tests/test_cam16_ucs.py +++ b/colour/difference/tests/test_cam16_ucs.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.difference.cam16_ucs` module.""" -import unittest from colour.difference.tests.test_cam02_ucs import TestDelta_E_Luo2006 @@ -28,7 +26,3 @@ class TestDelta_E_Li2017(TestDelta_E_Luo2006): of :func:`colour.difference.cam02_ucs.delta_E_Luo2006` and thus currently adopts the same unittests. """ - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/difference/tests/test_delta_e.py b/colour/difference/tests/test_delta_e.py index 939620af3a..99f97cc35a 100644 --- a/colour/difference/tests/test_delta_e.py +++ b/colour/difference/tests/test_delta_e.py @@ -9,7 +9,6 @@ 30(1), 21-30. doi:10.1002/col.20070 """ -import unittest from itertools import product import numpy as np @@ -41,7 +40,7 @@ ] -class TestDelta_E_CIE1976(unittest.TestCase): +class TestDelta_E_CIE1976: """ Define :func:`colour.difference.delta_e.delta_E_CIE1976` definition unit tests methods. @@ -58,8 +57,8 @@ def test_delta_E_CIE1976(self): Lab_1 = np.array([100.00000000, 21.57210357, 272.22819350]) Lab_2 = np.array([100.00000000, 426.67945353, 72.39590835]) - Lab_1 = np.tile(Lab_1, (6, 1)).reshape([2, 3, 3]) - Lab_2 = np.tile(Lab_2, (6, 1)).reshape([2, 3, 3]) + Lab_1 = np.reshape(np.tile(Lab_1, (6, 1)), (2, 3, 3)) + Lab_2 = np.reshape(np.tile(Lab_2, (6, 1)), (2, 3, 3)) np.testing.assert_allclose( delta_E_CIE1976(Lab_1, Lab_2), @@ -99,7 +98,7 @@ def test_nan_delta_E_CIE1976(self): """ -class TestDelta_E_CIE1994(unittest.TestCase): +class TestDelta_E_CIE1994: """ Define :func:`colour.difference.delta_e.delta_E_CIE1994` definition unit tests methods. @@ -224,7 +223,7 @@ def test_nan_delta_E_CIE1994(self): delta_E_CIE1994(cases, cases) -class TestDelta_E_CIE2000(unittest.TestCase): +class TestDelta_E_CIE2000: """ Define :func:`colour.difference.delta_e.delta_E_CIE2000` definition unit tests methods. @@ -513,12 +512,10 @@ def test_delta_E_CIE2000_Sharma2004(self): ] ) - np.testing.assert_allclose( - delta_E_CIE2000(Lab_1, Lab_2), d_E, atol=1e-4 - ) + np.testing.assert_allclose(delta_E_CIE2000(Lab_1, Lab_2), d_E, atol=1e-4) -class TestDelta_E_CMC(unittest.TestCase): +class TestDelta_E_CMC: """ Define :func:`colour.difference.delta_e.delta_E_CMC` definition unit tests methods. @@ -639,7 +636,7 @@ def test_nan_delta_E_CMC(self): delta_E_CMC(cases, cases) -class TestDelta_E_ITP(unittest.TestCase): +class TestDelta_E_ITP: """ Define :func:`colour.difference.delta_e.delta_E_ITP` definition unit tests methods. @@ -748,7 +745,3 @@ def test_nan_delta_E_ITP(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) delta_E_ITP(cases, cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/difference/tests/test_din99.py b/colour/difference/tests/test_din99.py index f7f99385ad..b71d680fd0 100644 --- a/colour/difference/tests/test_din99.py +++ b/colour/difference/tests/test_din99.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.difference.din99` module.""" -import unittest from itertools import product import numpy as np @@ -22,7 +20,7 @@ ] -class TestDelta_E_DIN99(unittest.TestCase): +class TestDelta_E_DIN99: """ Define :func:`colour.difference.din99.delta_E_DIN99` definition unit tests methods. @@ -141,7 +139,3 @@ def test_nan_delta_E_DIN99(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) delta_E_DIN99(cases, cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/difference/tests/test_huang2015.py b/colour/difference/tests/test_huang2015.py index 5dfa86cdc6..41ec9b7ce9 100644 --- a/colour/difference/tests/test_huang2015.py +++ b/colour/difference/tests/test_huang2015.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.difference.huang2015` module.""" -import unittest import numpy as np @@ -20,7 +18,7 @@ ] -class TestPowerFunctionHuang2015(unittest.TestCase): +class TestPowerFunctionHuang2015: """ Define :func:`colour.difference.huang2015.power_function_Huang2015` definition unit tests methods. @@ -39,7 +37,3 @@ def test_power_function_Huang2015(self): np.array([2.35748796, 2.98505036, 3.39651062]), atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/difference/tests/test_stress.py b/colour/difference/tests/test_stress.py index d3b887fac7..131c290f23 100644 --- a/colour/difference/tests/test_stress.py +++ b/colour/difference/tests/test_stress.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.difference.stress` module.""" -import unittest import numpy as np @@ -20,7 +18,7 @@ ] -class TestIndexStress(unittest.TestCase): +class TestIndexStress: """ Define :func:`colour.difference.stress.index_stress_Garcia2007` definition unit tests methods. @@ -40,7 +38,3 @@ def test_index_stress(self): 0.121170939369957, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/examples/adaptation/examples_cie1994.py b/colour/examples/adaptation/examples_cie1994.py index 2273a99fdb..df05973cfa 100644 --- a/colour/examples/adaptation/examples_cie1994.py +++ b/colour/examples/adaptation/examples_cie1994.py @@ -1,4 +1,4 @@ -"""Showcases *CIE 1994* chromatic adaptation model computations.""" +"""Showcase *CIE 1994* chromatic adaptation model computations.""" import numpy as np diff --git a/colour/examples/adaptation/examples_cmccat2000.py b/colour/examples/adaptation/examples_cmccat2000.py index 2e2f659117..caff3672bd 100644 --- a/colour/examples/adaptation/examples_cmccat2000.py +++ b/colour/examples/adaptation/examples_cmccat2000.py @@ -1,4 +1,4 @@ -"""Showcases *CMCCAT2000* chromatic adaptation model computations.""" +"""Showcase *CMCCAT2000* chromatic adaptation model computations.""" import numpy as np diff --git a/colour/examples/adaptation/examples_fairchild1990.py b/colour/examples/adaptation/examples_fairchild1990.py index ad3a05adae..69d2086023 100644 --- a/colour/examples/adaptation/examples_fairchild1990.py +++ b/colour/examples/adaptation/examples_fairchild1990.py @@ -1,4 +1,4 @@ -"""Showcases *Fairchild (1990)* chromatic adaptation model computations.""" +"""Showcase *Fairchild (1990)* chromatic adaptation model computations.""" import numpy as np @@ -20,13 +20,9 @@ f'\t"Y_n": {Y_n}' ) print( - colour.chromatic_adaptation( - XYZ_1, XYZ_n, XYZ_r, method="Fairchild 1990", Y_n=Y_n - ) + colour.chromatic_adaptation(XYZ_1, XYZ_n, XYZ_r, method="Fairchild 1990", Y_n=Y_n) ) print( - colour.adaptation.chromatic_adaptation_Fairchild1990( - XYZ_1 * 100, XYZ_n, XYZ_r, Y_n - ) + colour.adaptation.chromatic_adaptation_Fairchild1990(XYZ_1 * 100, XYZ_n, XYZ_r, Y_n) / 100 ) diff --git a/colour/examples/adaptation/examples_vonkries.py b/colour/examples/adaptation/examples_vonkries.py index 5986102e67..21047b8e56 100644 --- a/colour/examples/adaptation/examples_vonkries.py +++ b/colour/examples/adaptation/examples_vonkries.py @@ -1,4 +1,4 @@ -"""Showcases *Von Kries* chromatic adaptation model computations.""" +"""Showcase *Von Kries* chromatic adaptation model computations.""" import numpy as np diff --git a/colour/examples/adaptation/examples_zhai2018.py b/colour/examples/adaptation/examples_zhai2018.py index 39cd18e377..40ec3ef9a5 100644 --- a/colour/examples/adaptation/examples_zhai2018.py +++ b/colour/examples/adaptation/examples_zhai2018.py @@ -1,4 +1,4 @@ -"""Showcases *Zhai and Luo (2018)* chromatic adaptation model computations.""" +"""Showcase *Zhai and Luo (2018)* chromatic adaptation model computations.""" import numpy as np diff --git a/colour/examples/algebra/examples_interpolation.py b/colour/examples/algebra/examples_interpolation.py index 15cb37d5af..be4ae3757a 100644 --- a/colour/examples/algebra/examples_interpolation.py +++ b/colour/examples/algebra/examples_interpolation.py @@ -1,4 +1,4 @@ -"""Showcases interpolation computations.""" +"""Showcase interpolation computations.""" import os @@ -110,9 +110,7 @@ shape = sd_base.shape x_limit_min, x_limit_max, y_limit_min, y_limit_max = [], [], [], [] -plt.plot( - sd_base.wavelengths, sd_base.values, "ro-", label=sd_base.name, linewidth=1 -) +plt.plot(sd_base.wavelengths, sd_base.values, "ro-", label=sd_base.name, linewidth=1) plt.plot( uniform_interpolated_sd.wavelengths, uniform_interpolated_sd.values, diff --git a/colour/examples/appearance/examples_atd95.py b/colour/examples/appearance/examples_atd95.py index 8dd8f928bc..82c9e1eb5d 100644 --- a/colour/examples/appearance/examples_atd95.py +++ b/colour/examples/appearance/examples_atd95.py @@ -1,4 +1,4 @@ -"""Showcases *ATD (1995)* colour appearance model computations.""" +"""Showcase *ATD (1995)* colour appearance model computations.""" import numpy as np diff --git a/colour/examples/appearance/examples_cam16.py b/colour/examples/appearance/examples_cam16.py index b57fa75579..562d471f9f 100644 --- a/colour/examples/appearance/examples_cam16.py +++ b/colour/examples/appearance/examples_cam16.py @@ -1,4 +1,4 @@ -"""Showcases *CAM16* colour appearance model computations.""" +"""Showcase *CAM16* colour appearance model computations.""" import numpy as np diff --git a/colour/examples/appearance/examples_ciecam02.py b/colour/examples/appearance/examples_ciecam02.py index 3ef1c48586..ea78bcbd88 100644 --- a/colour/examples/appearance/examples_ciecam02.py +++ b/colour/examples/appearance/examples_ciecam02.py @@ -1,4 +1,4 @@ -"""Showcases *CIECAM02* colour appearance model computations.""" +"""Showcase *CIECAM02* colour appearance model computations.""" import numpy as np diff --git a/colour/examples/appearance/examples_ciecam16.py b/colour/examples/appearance/examples_ciecam16.py index 0d17fe50bc..5a0c534935 100644 --- a/colour/examples/appearance/examples_ciecam16.py +++ b/colour/examples/appearance/examples_ciecam16.py @@ -1,4 +1,4 @@ -"""Showcases *CIECAM16* colour appearance model computations.""" +"""Showcase *CIECAM16* colour appearance model computations.""" import numpy as np diff --git a/colour/examples/appearance/examples_hellwig2022.py b/colour/examples/appearance/examples_hellwig2022.py index 8081accf58..c5d06e2ef9 100644 --- a/colour/examples/appearance/examples_hellwig2022.py +++ b/colour/examples/appearance/examples_hellwig2022.py @@ -1,13 +1,11 @@ -"""Showcases *Hellwig and Fairchild (2022)* colour appearance model computations.""" +"""Showcase *Hellwig and Fairchild (2022)* colour appearance model computations.""" import numpy as np import colour from colour.utilities import message_box -message_box( - '"Hellwig and Fairchild (2022)" Colour Appearance Model Computations' -) +message_box('"Hellwig and Fairchild (2022)" Colour Appearance Model Computations') XYZ = np.array([19.01, 20.00, 21.78]) XYZ_w = np.array([95.05, 100.00, 108.88]) diff --git a/colour/examples/appearance/examples_hke.py b/colour/examples/appearance/examples_hke.py index 392c377a78..dea163904e 100644 --- a/colour/examples/appearance/examples_hke.py +++ b/colour/examples/appearance/examples_hke.py @@ -1,4 +1,4 @@ -"""Showcases Helmholtz—Kohlrausch effect estimation computations.""" +"""Showcase Helmholtz—Kohlrausch effect estimation computations.""" import colour from colour.plotting import colour_style, plot_multi_colour_swatches diff --git a/colour/examples/appearance/examples_hunt.py b/colour/examples/appearance/examples_hunt.py index da59e4baac..fb80fd46b2 100644 --- a/colour/examples/appearance/examples_hunt.py +++ b/colour/examples/appearance/examples_hunt.py @@ -1,4 +1,4 @@ -"""Showcases *Hunt* colour appearance model computations.""" +"""Showcase *Hunt* colour appearance model computations.""" import numpy as np @@ -25,9 +25,7 @@ f"\tCCT_w: {CCT_w}" ) -specification = colour.XYZ_to_Hunt( - XYZ, XYZ_w, XYZ_b, L_A, surround, CCT_w=CCT_w -) +specification = colour.XYZ_to_Hunt(XYZ, XYZ_w, XYZ_b, L_A, surround, CCT_w=CCT_w) print(specification) print("\n") diff --git a/colour/examples/appearance/examples_kim2009.py b/colour/examples/appearance/examples_kim2009.py index e52bea3217..adaf670835 100644 --- a/colour/examples/appearance/examples_kim2009.py +++ b/colour/examples/appearance/examples_kim2009.py @@ -1,13 +1,11 @@ -"""Showcases *Kim, Weyrich and Kautz (2009)* colour appearance model computations.""" +"""Showcase *Kim, Weyrich and Kautz (2009)* colour appearance model computations.""" import numpy as np import colour from colour.utilities import message_box -message_box( - '"Kim, Weyrich and Kautz (2009)" Colour Appearance Model Computations' -) +message_box('"Kim, Weyrich and Kautz (2009)" Colour Appearance Model Computations') XYZ = np.array([19.01, 20.00, 21.78]) XYZ_w = np.array([95.05, 100.00, 108.88]) diff --git a/colour/examples/appearance/examples_llab.py b/colour/examples/appearance/examples_llab.py index 3080111eff..fa914b5f76 100644 --- a/colour/examples/appearance/examples_llab.py +++ b/colour/examples/appearance/examples_llab.py @@ -1,4 +1,4 @@ -"""Showcases *LLAB(l:c)* colour appearance model computations.""" +"""Showcase *LLAB(l:c)* colour appearance model computations.""" import numpy as np diff --git a/colour/examples/appearance/examples_nayatani95.py b/colour/examples/appearance/examples_nayatani95.py index 1ec159478d..ef3471e692 100644 --- a/colour/examples/appearance/examples_nayatani95.py +++ b/colour/examples/appearance/examples_nayatani95.py @@ -1,4 +1,4 @@ -"""Showcases *Nayatani (1995)* colour appearance model computations.""" +"""Showcase *Nayatani (1995)* colour appearance model computations.""" import numpy as np diff --git a/colour/examples/appearance/examples_rlab.py b/colour/examples/appearance/examples_rlab.py index 5571b54e97..3631c6a2fa 100644 --- a/colour/examples/appearance/examples_rlab.py +++ b/colour/examples/appearance/examples_rlab.py @@ -1,4 +1,4 @@ -"""Showcases *RLAB* colour appearance model computations.""" +"""Showcase *RLAB* colour appearance model computations.""" import numpy as np diff --git a/colour/examples/appearance/examples_zcam.py b/colour/examples/appearance/examples_zcam.py index 27707f8193..d4504f495f 100644 --- a/colour/examples/appearance/examples_zcam.py +++ b/colour/examples/appearance/examples_zcam.py @@ -1,4 +1,4 @@ -"""Showcases *ZCAM* colour appearance model computations.""" +"""Showcase *ZCAM* colour appearance model computations.""" import numpy as np diff --git a/colour/examples/blindness/examples_machado2009.py b/colour/examples/blindness/examples_machado2009.py index 5bc3cf2afd..55ef575229 100644 --- a/colour/examples/blindness/examples_machado2009.py +++ b/colour/examples/blindness/examples_machado2009.py @@ -1,4 +1,4 @@ -"""Showcases Machado (2009) simulation of colour vision deficiency.""" +"""Showcase Machado (2009) simulation of colour vision deficiency.""" import numpy as np diff --git a/colour/examples/characterisation/examples_colour_checkers.py b/colour/examples/characterisation/examples_colour_checkers.py index 8236cb8751..e3185c656b 100644 --- a/colour/examples/characterisation/examples_colour_checkers.py +++ b/colour/examples/characterisation/examples_colour_checkers.py @@ -1,4 +1,4 @@ -"""Showcases colour rendition charts computations.""" +"""Showcase colour rendition charts computations.""" from pprint import pprint @@ -23,9 +23,7 @@ '"ColorChecker 2005" colour rendition chart chromaticity coordinates data:\n\n' '\t("Patch Number", "Patch Name", "xyY")' ) -name, data, illuminant, rows, columns = colour.CCS_COLOURCHECKERS[ - "ColorChecker 2005" -] +name, data, illuminant, rows, columns = colour.CCS_COLOURCHECKERS["ColorChecker 2005"] for name, xyY in data.items(): print(name, xyY) diff --git a/colour/examples/characterisation/examples_correction.py b/colour/examples/characterisation/examples_correction.py index c5294e0135..ea2d475d33 100644 --- a/colour/examples/characterisation/examples_correction.py +++ b/colour/examples/characterisation/examples_correction.py @@ -1,4 +1,4 @@ -"""Showcases colour correction computations.""" +"""Showcase colour correction computations.""" import numpy as np @@ -108,14 +108,8 @@ "with polynomial of degree 3." ) -print( - colour.characterisation.matrix_colour_correction_Finlayson2015(M_T, M_R, 3) -) -print( - colour.matrix_colour_correction( - M_T, M_R, method="Finlayson 2015", degree=3 - ) -) +print(colour.characterisation.matrix_colour_correction_Finlayson2015(M_T, M_R, 3)) +print(colour.matrix_colour_correction(M_T, M_R, method="Finlayson 2015", degree=3)) print("\n") @@ -136,12 +130,8 @@ '"Vandermonde" method with polynomial of degree 3.' ) -print( - colour.characterisation.matrix_colour_correction_Vandermonde(M_T, M_R, 3) -) -print( - colour.matrix_colour_correction(M_T, M_R, method="Vandermonde", degree=3) -) +print(colour.characterisation.matrix_colour_correction_Vandermonde(M_T, M_R, 3)) +print(colour.matrix_colour_correction(M_T, M_R, method="Vandermonde", degree=3)) print("\n") @@ -190,12 +180,8 @@ "degree 3." ) -print( - colour.characterisation.colour_correction_Finlayson2015(RGB, M_T, M_R, 3) -) -print( - colour.colour_correction(RGB, M_T, M_R, method="Finlayson 2015", degree=3) -) +print(colour.characterisation.colour_correction_Finlayson2015(RGB, M_T, M_R, 3)) +print(colour.colour_correction(RGB, M_T, M_R, method="Finlayson 2015", degree=3)) print("\n") diff --git a/colour/examples/colorimetry/examples_blackbody.py b/colour/examples/colorimetry/examples_blackbody.py index a84f71feb2..f0fe4e9cc2 100644 --- a/colour/examples/colorimetry/examples_blackbody.py +++ b/colour/examples/colorimetry/examples_blackbody.py @@ -1,4 +1,4 @@ -"""Showcases blackbody / planckian radiator computations.""" +"""Showcase blackbody / planckian radiator computations.""" import colour from colour.utilities import message_box diff --git a/colour/examples/colorimetry/examples_cmfs.py b/colour/examples/colorimetry/examples_cmfs.py index c01f6045d5..7aff963d4c 100644 --- a/colour/examples/colorimetry/examples_cmfs.py +++ b/colour/examples/colorimetry/examples_cmfs.py @@ -1,4 +1,4 @@ -"""Showcases colour matching functions computations.""" +"""Showcase colour matching functions computations.""" from pprint import pprint @@ -50,9 +50,9 @@ ) print(colour.MSDS_CMFS["Stockman & Sharpe 10 Degree Cone Fundamentals"][700]) print( - colour.colorimetry.MSDS_CMFS_LMS[ - "Stockman & Sharpe 10 Degree Cone Fundamentals" - ][700] + colour.colorimetry.MSDS_CMFS_LMS["Stockman & Sharpe 10 Degree Cone Fundamentals"][ + 700 + ] ) print(colour.colorimetry.RGB_10_degree_cmfs_to_LMS_10_degree_cmfs(700)) diff --git a/colour/examples/colorimetry/examples_correction.py b/colour/examples/colorimetry/examples_correction.py index 8f1677967d..b170576878 100644 --- a/colour/examples/colorimetry/examples_correction.py +++ b/colour/examples/colorimetry/examples_correction.py @@ -1,4 +1,4 @@ -"""Showcases colour spectral bandpass dependence correction computations.""" +"""Showcase colour spectral bandpass dependence correction computations.""" import numpy as np @@ -98,8 +98,4 @@ sd_sample = colour.SpectralDistribution(data_sample, name="Sample") uncorrected_values = sd_sample.values -print( - np.dstack( - [uncorrected_values, colour.bandpass_correction(sd_sample).values] - ) -) +print(np.dstack([uncorrected_values, colour.bandpass_correction(sd_sample).values])) diff --git a/colour/examples/colorimetry/examples_dominant.py b/colour/examples/colorimetry/examples_dominant.py index 3b9fd1bd97..dfe6c64838 100644 --- a/colour/examples/colorimetry/examples_dominant.py +++ b/colour/examples/colorimetry/examples_dominant.py @@ -1,4 +1,4 @@ -"""Showcases dominant wavelength and purity of a colour computations.""" +"""Showcase dominant wavelength and purity of a colour computations.""" import numpy as np diff --git a/colour/examples/colorimetry/examples_illuminants.py b/colour/examples/colorimetry/examples_illuminants.py index 5eb1e714c7..9c8484d4ef 100644 --- a/colour/examples/colorimetry/examples_illuminants.py +++ b/colour/examples/colorimetry/examples_illuminants.py @@ -1,4 +1,4 @@ -"""Showcases illuminants datasets.""" +"""Showcase illuminants datasets.""" from pprint import pprint diff --git a/colour/examples/colorimetry/examples_lefs.py b/colour/examples/colorimetry/examples_lefs.py index cbc2b6f6ae..ae56a0b878 100644 --- a/colour/examples/colorimetry/examples_lefs.py +++ b/colour/examples/colorimetry/examples_lefs.py @@ -1,4 +1,4 @@ -"""Showcases luminous efficiency functions computations.""" +"""Showcase luminous efficiency functions computations.""" from pprint import pprint @@ -12,7 +12,5 @@ print("\n") -message_box( - "Computing the mesopic luminous efficiency function for factor:\n\n\t0.2" -) +message_box("Computing the mesopic luminous efficiency function for factor:\n\n\t0.2") print(colour.sd_mesopic_luminous_efficiency_function(0.2).values) diff --git a/colour/examples/colorimetry/examples_light_sources.py b/colour/examples/colorimetry/examples_light_sources.py index 68cddba273..2e9e06d7d9 100644 --- a/colour/examples/colorimetry/examples_light_sources.py +++ b/colour/examples/colorimetry/examples_light_sources.py @@ -1,4 +1,4 @@ -"""Showcases light sources datasets.""" +"""Showcase light sources datasets.""" from pprint import pprint diff --git a/colour/examples/colorimetry/examples_lightness.py b/colour/examples/colorimetry/examples_lightness.py index 1b6d54f366..bbcd9c4e2d 100644 --- a/colour/examples/colorimetry/examples_lightness.py +++ b/colour/examples/colorimetry/examples_lightness.py @@ -1,4 +1,4 @@ -"""Showcases *Lightness* computations.""" +"""Showcase *Lightness* computations.""" import numpy as np diff --git a/colour/examples/colorimetry/examples_luminance.py b/colour/examples/colorimetry/examples_luminance.py index e94c90e073..88e825dbd3 100644 --- a/colour/examples/colorimetry/examples_luminance.py +++ b/colour/examples/colorimetry/examples_luminance.py @@ -1,4 +1,4 @@ -"""Showcases *Luminance* computations.""" +"""Showcase *Luminance* computations.""" import colour from colour.utilities import message_box @@ -17,8 +17,7 @@ L = 41.527875844653451 message_box( - f'Computing "luminance" using "CIE 1976" method for given ' - f'"Lightness":\n\n\t{L}' + f'Computing "luminance" using "CIE 1976" method for given "Lightness":\n\n\t{L}' ) print(colour.luminance(L)) print(colour.colorimetry.luminance_CIE1976(L)) diff --git a/colour/examples/colorimetry/examples_photometry.py b/colour/examples/colorimetry/examples_photometry.py index c3bae23671..264fede5b8 100644 --- a/colour/examples/colorimetry/examples_photometry.py +++ b/colour/examples/colorimetry/examples_photometry.py @@ -1,4 +1,4 @@ -"""Showcases *Photometry* computations.""" +"""Showcase *Photometry* computations.""" import colour from colour.utilities import message_box diff --git a/colour/examples/colorimetry/examples_spectrum.py b/colour/examples/colorimetry/examples_spectrum.py index f3e0fa5b32..d4008c1490 100644 --- a/colour/examples/colorimetry/examples_spectrum.py +++ b/colour/examples/colorimetry/examples_spectrum.py @@ -1,4 +1,4 @@ -"""Showcases colour spectrum computations.""" +"""Showcase colour spectrum computations.""" import numpy as np diff --git a/colour/examples/colorimetry/examples_tristimulus_values.py b/colour/examples/colorimetry/examples_tristimulus_values.py index 0aea836538..9dbeb0d8a6 100644 --- a/colour/examples/colorimetry/examples_tristimulus_values.py +++ b/colour/examples/colorimetry/examples_tristimulus_values.py @@ -1,4 +1,4 @@ -"""Showcases *CIE XYZ* tristimulus values computations.""" +"""Showcase *CIE XYZ* tristimulus values computations.""" import numpy as np @@ -113,8 +113,7 @@ print("\n") message_box( - "Computing *CIE XYZ* tristimulus values for a single given wavelength in " - "nm." + "Computing *CIE XYZ* tristimulus values for a single given wavelength in nm." ) print( colour.wavelength_to_XYZ( diff --git a/colour/examples/colorimetry/examples_uniformity.py b/colour/examples/colorimetry/examples_uniformity.py index 2a2a9f1bbd..5a4ee1fa5b 100644 --- a/colour/examples/colorimetry/examples_uniformity.py +++ b/colour/examples/colorimetry/examples_uniformity.py @@ -1,4 +1,4 @@ -"""Showcases spectral uniformity computations.""" +"""Showcase spectral uniformity computations.""" import colour from colour.quality.cfi2017 import load_TCS_CIE2017 @@ -7,18 +7,12 @@ message_box("Spectral Uniformity (or Flatness) Computations") -message_box( - 'Computing the spectral uniformity of the "CRI" test colour samples.' -) +message_box('Computing the spectral uniformity of the "CRI" test colour samples.') print(colour.spectral_uniformity(list(SDS_TCS.values()))) print("\n") -message_box( - 'Computing the spectral uniformity of the "CFI" test colour samples.' -) +message_box('Computing the spectral uniformity of the "CFI" test colour samples.') -print( - colour.spectral_uniformity(load_TCS_CIE2017(colour.SPECTRAL_SHAPE_DEFAULT)) -) +print(colour.spectral_uniformity(load_TCS_CIE2017(colour.SPECTRAL_SHAPE_DEFAULT))) diff --git a/colour/examples/colorimetry/examples_whiteness.py b/colour/examples/colorimetry/examples_whiteness.py index 6079897658..7da7daa038 100644 --- a/colour/examples/colorimetry/examples_whiteness.py +++ b/colour/examples/colorimetry/examples_whiteness.py @@ -1,4 +1,4 @@ -"""Showcases *whiteness* computations.""" +"""Showcase *whiteness* computations.""" import numpy as np diff --git a/colour/examples/colorimetry/examples_yellowness.py b/colour/examples/colorimetry/examples_yellowness.py index b8a2e66c88..adeff7d352 100644 --- a/colour/examples/colorimetry/examples_yellowness.py +++ b/colour/examples/colorimetry/examples_yellowness.py @@ -1,4 +1,4 @@ -"""Showcases *yellowness* computations.""" +"""Showcase *yellowness* computations.""" import numpy as np diff --git a/colour/examples/contrast/examples_contrast.py b/colour/examples/contrast/examples_contrast.py index 4f1e3f12f1..7b094cebef 100644 --- a/colour/examples/contrast/examples_contrast.py +++ b/colour/examples/contrast/examples_contrast.py @@ -1,4 +1,4 @@ -"""Showcases contrast sensitivity computations.""" +"""Showcase contrast sensitivity computations.""" from pprint import pprint @@ -20,9 +20,7 @@ '"Barten (1999)" method.' ) pprint(colour.contrast_sensitivity_function(u=4, X_0=60, E=65)) -pprint( - colour.contrast.contrast_sensitivity_function_Barten1999(u=4, X_0=60, E=65) -) +pprint(colour.contrast.contrast_sensitivity_function_Barten1999(u=4, X_0=60, E=65)) print("\n") @@ -75,7 +73,7 @@ def maximise_spatial_frequency(L: ArrayLike) -> NDArrayFloat: sigma=sigma, # noqa: B023 X_0=X_0, E=E, # noqa: B023 - **settings_BT2246 + **settings_BT2246, ) ), 0, @@ -126,5 +124,5 @@ def maximise_spatial_frequency(L: ArrayLike) -> NDArrayFloat: "x_label": "Luminance ($cd/m^2$)", "y_label": "Minimum Detectable Contrast", "axes.grid.which": "both", - } + }, ) diff --git a/colour/examples/corresponding/examples_prediction.py b/colour/examples/corresponding/examples_prediction.py index 88a624ecf6..cfa33eba6c 100644 --- a/colour/examples/corresponding/examples_prediction.py +++ b/colour/examples/corresponding/examples_prediction.py @@ -1,4 +1,4 @@ -"""Showcases corresponding chromaticities prediction computations.""" +"""Showcase corresponding chromaticities prediction computations.""" from pprint import pprint @@ -39,9 +39,7 @@ 'chromatic adaptation model for "Breneman (1987)" experiment number "1".' ) pprint(colour.corresponding_chromaticities_prediction(3, model="CMCCAT2000")) -pprint( - colour.corresponding.corresponding_chromaticities_prediction_CMCCAT2000(1) -) +pprint(colour.corresponding.corresponding_chromaticities_prediction_CMCCAT2000(1)) print("\n") @@ -49,11 +47,5 @@ 'Computing corresponding chromaticities prediction with Fairchild (1990)" ' 'chromatic adaptation model for "Breneman (1987)" experiment number "1".' ) -pprint( - colour.corresponding_chromaticities_prediction(3, model="Fairchild 1990") -) -pprint( - colour.corresponding.corresponding_chromaticities_prediction_Fairchild1990( - 1 - ) -) +pprint(colour.corresponding_chromaticities_prediction(3, model="Fairchild 1990")) +pprint(colour.corresponding.corresponding_chromaticities_prediction_Fairchild1990(1)) diff --git a/colour/examples/difference/examples_delta_e.py b/colour/examples/difference/examples_delta_e.py index 56bb7581db..54da74530e 100644 --- a/colour/examples/difference/examples_delta_e.py +++ b/colour/examples/difference/examples_delta_e.py @@ -1,4 +1,4 @@ -"""Showcases *Delta E* colour difference computations.""" +"""Showcase *Delta E* colour difference computations.""" import numpy as np diff --git a/colour/examples/examples_colour.py b/colour/examples/examples_colour.py index c7f1a9ca63..9785eb436c 100644 --- a/colour/examples/examples_colour.py +++ b/colour/examples/examples_colour.py @@ -1,4 +1,4 @@ -"""Showcases overall *Colour* examples.""" +"""Showcase overall *Colour* examples.""" import warnings @@ -163,9 +163,7 @@ f"\tE_o2: {E_o2!r}" ) print( - colour.adaptation.chromatic_adaptation_CIE1994( - XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2 - ) + colour.adaptation.chromatic_adaptation_CIE1994(XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2) ) print("\n") @@ -181,9 +179,7 @@ f"\tE_o2: {E_o2!r}" ) print( - colour.adaptation.chromatic_adaptation_CIE1994( - XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2 - ) + colour.adaptation.chromatic_adaptation_CIE1994(XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2) ) print("\n") @@ -203,9 +199,7 @@ f"\tE_o2: {E_o2!r}" ) print( - colour.adaptation.chromatic_adaptation_CIE1994( - XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2 - ) + colour.adaptation.chromatic_adaptation_CIE1994(XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2) ) print("\n") @@ -226,20 +220,14 @@ f"\tE_o2: {E_o2!r}" ) print( - colour.adaptation.chromatic_adaptation_CIE1994( - XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2 - ) + colour.adaptation.chromatic_adaptation_CIE1994(XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2) ) print("\n") message_box("Domain-Range Scales") -message_box( - '"Colour" uses two different domain-range scales: \n\n' - '- "Reference"\n' - '- "1"' -) +message_box('"Colour" uses two different domain-range scales: \n\n- "Reference"\n- "1"') print("\n") @@ -269,7 +257,5 @@ f"\tE_o2: {E_o2!r}" ) print( - colour.adaptation.chromatic_adaptation_CIE1994( - XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2 - ) + colour.adaptation.chromatic_adaptation_CIE1994(XYZ_1, xy_o1, xy_o2, Y_o, E_o1, E_o2) ) diff --git a/colour/examples/geometry/examples_geometry.py b/colour/examples/geometry/examples_geometry.py index 353bb8d589..304c0ba437 100644 --- a/colour/examples/geometry/examples_geometry.py +++ b/colour/examples/geometry/examples_geometry.py @@ -1,4 +1,4 @@ -"""Showcases geometry primitives generation examples.""" +"""Showcase geometry primitives generation examples.""" import numpy as np diff --git a/colour/examples/graph/examples_graph.py b/colour/examples/graph/examples_graph.py index 3cf1d364d6..bec9249c6d 100644 --- a/colour/examples/graph/examples_graph.py +++ b/colour/examples/graph/examples_graph.py @@ -1,4 +1,4 @@ -"""Showcases *Automatic Colour Conversion Graph* computations.""" +"""Showcase *Automatic Colour Conversion Graph* computations.""" import numpy as np @@ -16,10 +16,7 @@ print(colour.convert(sd_dark_skin, "Spectral Distribution", "sRGB")) print( colour.XYZ_to_sRGB( - colour.sd_to_XYZ( - sd_dark_skin, illuminant=colour.SDS_ILLUMINANTS["D65"] - ) - / 100 + colour.sd_to_XYZ(sd_dark_skin, illuminant=colour.SDS_ILLUMINANTS["D65"]) / 100 ) ) @@ -77,9 +74,7 @@ colour.CAM16_to_XYZ( specification, XYZ_w=colour.xy_to_XYZ( - colour.CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ - "D65" - ] + colour.CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"] ) * 100, L_A=64 / np.pi * 0.2, diff --git a/colour/examples/io/examples_ctl.py b/colour/examples/io/examples_ctl.py index 324ed2e38e..cdbddae3f2 100644 --- a/colour/examples/io/examples_ctl.py +++ b/colour/examples/io/examples_ctl.py @@ -1,240 +1,206 @@ -"""Showcases Color Transformation Language (CTL) related examples.""" +"""Showcase Color Transformation Language (CTL) related examples.""" import os import tempfile import colour -from colour.utilities import message_box - -ROOT_RESOURCES = os.path.join( - os.path.dirname(__file__), "..", "..", "io", "tests", "resources" -) - -message_box("Color Transformation Language (CTL)") - -message_box( - 'Using a "CTL" string and the "float" template to transform an image.' -) - -ctl_adjust_exposure_float = colour.io.template_ctl_transform_float( - "rIn * pow(2, exposure)", - "gIn * pow(2, exposure)", - "bIn * pow(2, exposure)", - description="Adjust Exposure", - parameters=["input float exposure = 0.0"], -) -print(ctl_adjust_exposure_float) -path_input = os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") -_descriptor, path_output = tempfile.mkstemp(suffix=".exr") -colour.io.ctl_render( - path_input, - path_output, - {ctl_adjust_exposure_float: ["-param1 exposure 3.0"]}, - "-verbose", - "-force", -) -print(colour.read_image(path_output)[:3]) - -print("\n") - -message_box( - 'Using a "CTL" "float" template based transform file to transform an image.' -) - -path_input = os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") -colour.io.ctl_render( - path_input, - path_output, - { - os.path.join(ROOT_RESOURCES, "Adjust_Exposure_Float.ctl"): [ - "-param1 exposure 3.0" - ] - }, - "-verbose", - "-force", -) -print(colour.read_image(path_output)[:3]) - -print("\n") - -message_box( - 'Using a "CTL" "float" template based transform file to transform an array.' -) - -print(os.path.join(ROOT_RESOURCES, "Adjust_Exposure_Float.ctl")) -a = colour.utilities.full((4, 2, 3), 0.18) # pyright: ignore -print( - colour.io.process_image_ctl( - a, - { - os.path.join(ROOT_RESOURCES, "Adjust_Exposure_Float.ctl"): [ - "-param1 exposure 3.0" - ] - }, +from colour.utilities import is_ctlrender_installed, message_box + +if is_ctlrender_installed(): + ROOT_RESOURCES = os.path.join( + os.path.dirname(__file__), "..", "..", "io", "tests", "resources" + ) + + message_box("Color Transformation Language (CTL)") + + message_box('Using a "CTL" string and the "float" template to transform an image.') + + ctl_adjust_exposure_float = colour.io.template_ctl_transform_float( + "rIn * pow(2, exposure)", + "gIn * pow(2, exposure)", + "bIn * pow(2, exposure)", + description="Adjust Exposure", + parameters=["input float exposure = 0.0"], + ) + print(ctl_adjust_exposure_float) + path_input = os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") + _descriptor, path_output = tempfile.mkstemp(suffix=".exr") + colour.io.ctl_render( + path_input, + path_output, + {ctl_adjust_exposure_float: ["-param1 exposure 3.0"]}, "-verbose", "-force", ) -) - -print("\n") - -message_box( - 'Using a "CTL" string and the "float3" template to transform an image.' -) - -ctl_adjust_exposure_float3 = colour.io.template_ctl_transform_float3( - "adjust_exposure(rgbIn, exposure)", - description="Adjust Exposure", - header=""" -float[3] adjust_exposure(float rgbIn[3], float exposureIn) -{ - float rgbOut[3]; - - float exposure = pow(2, exposureIn); - - rgbOut[0] = rgbIn[0] * exposure; - rgbOut[1] = rgbIn[1] * exposure; - rgbOut[2] = rgbIn[2] * exposure; - - return rgbOut; -}\n"""[ - 1: - ], - parameters=["input float exposure = 0.0"], -) -print(ctl_adjust_exposure_float3) -path_input = os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") -colour.io.ctl_render( - path_input, - path_output, - {ctl_adjust_exposure_float3: ["-param1 exposure 3.0"]}, - "-verbose", - "-force", -) -print(colour.read_image(path_output)[:3]) - -print("\n") - -message_box( - 'Using a "CTL" "float3" template based transform file to transform an image.' -) - -path_input = os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") -_descriptor, path_output = tempfile.mkstemp(suffix=".exr") -colour.io.ctl_render( - path_input, - path_output, - { - os.path.join(ROOT_RESOURCES, "Adjust_Exposure_Float3.ctl"): [ - "-param1 exposure 3.0" - ] - }, - "-verbose", - "-force", -) -print(colour.read_image(path_output)[:3]) -os.remove(path_output) - -print("\n") - -message_box( - 'Using a "CTL" "float3" template based transform file to transform an array.' -) - -print( - colour.io.process_image_ctl( - a, + print(colour.read_image(path_output)[:3]) + + print("\n") + + message_box( + 'Using a "CTL" "float" template based transform file to transform an image.' + ) + + path_input = os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") + colour.io.ctl_render( + path_input, + path_output, { - os.path.join(ROOT_RESOURCES, "Adjust_Exposure_Float3.ctl"): [ + os.path.join(ROOT_RESOURCES, "Adjust_Exposure_Float.ctl"): [ "-param1 exposure 3.0" ] }, "-verbose", "-force", ) -) - -print("\n") - -ROOT_ACES_DEV_TRANSFORMS = os.path.abspath( - os.path.join( - os.path.dirname(__file__), - "..", - "..", - "..", - "..", - "..", - "ampas", - "aces-dev", - "transforms", - "ctl", - ) -) + print(colour.read_image(path_output)[:3]) + + print("\n") -if os.path.exists(ROOT_ACES_DEV_TRANSFORMS): message_box( - 'Running the "aces-dev" "RRT" "CTL" function to transform an array.' + 'Using a "CTL" "float" template based transform file to transform an array.' ) - CTL_MODULE_PATH = ( - f"{ROOT_ACES_DEV_TRANSFORMS}:" - f"{ROOT_ACES_DEV_TRANSFORMS}/lib:" - f"{ROOT_ACES_DEV_TRANSFORMS}/utilities" - ) + print(os.path.join(ROOT_RESOURCES, "Adjust_Exposure_Float.ctl")) + a = colour.utilities.full((4, 2, 3), 0.18) # pyright: ignore print( colour.io.process_image_ctl( a, - {f"{ROOT_ACES_DEV_TRANSFORMS}/rrt/RRT.ctl": ["-param1 aIn 1.0"]}, - env=dict( - os.environ, - CTL_MODULE_PATH=CTL_MODULE_PATH, - ), + { + os.path.join(ROOT_RESOURCES, "Adjust_Exposure_Float.ctl"): [ + "-param1 exposure 3.0" + ] + }, + "-verbose", + "-force", ) ) print("\n") + message_box('Using a "CTL" string and the "float3" template to transform an image.') + + ctl_adjust_exposure_float3 = colour.io.template_ctl_transform_float3( + "adjust_exposure(rgbIn, exposure)", + description="Adjust Exposure", + header=""" + float[3] adjust_exposure(float rgbIn[3], float exposureIn) + { + float rgbOut[3]; + + float exposure = pow(2, exposureIn); + + rgbOut[0] = rgbIn[0] * exposure; + rgbOut[1] = rgbIn[1] * exposure; + rgbOut[2] = rgbIn[2] * exposure; + + return rgbOut; + }\n"""[1:], + parameters=["input float exposure = 0.0"], + ) + print(ctl_adjust_exposure_float3) + path_input = os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") + colour.io.ctl_render( + path_input, + path_output, + {ctl_adjust_exposure_float3: ["-param1 exposure 3.0"]}, + "-verbose", + "-force", + ) + print(colour.read_image(path_output)[:3]) + + print("\n") + message_box( - 'Running the "aces-dev" "Y_2_linCV" "CTL" function to transform an array.' + 'Using a "CTL" "float3" template based transform file to transform an image.' ) - def format_imports(imports): - """Format given imports.""" - return [f'import "{i}";' for i in imports] - - ctl_Y_2_linCV_float = colour.io.template_ctl_transform_float( - "Y_2_linCV(rIn, CINEMA_WHITE, CINEMA_BLACK)", - "Y_2_linCV(gIn, CINEMA_WHITE, CINEMA_BLACK)", - "Y_2_linCV(bIn, CINEMA_WHITE, CINEMA_BLACK)", - imports=format_imports( - [ - "ACESlib.Utilities", - "ACESlib.Transform_Common", - "ACESlib.ODT_Common", + path_input = os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") + _descriptor, path_output = tempfile.mkstemp(suffix=".exr") + colour.io.ctl_render( + path_input, + path_output, + { + os.path.join(ROOT_RESOURCES, "Adjust_Exposure_Float3.ctl"): [ + "-param1 exposure 3.0" ] - ), + }, + "-verbose", + "-force", ) - print(ctl_Y_2_linCV_float) + print(colour.read_image(path_output)[:3]) + os.remove(path_output) + + print("\n") + + message_box( + 'Using a "CTL" "float3" template based transform file to transform an array.' + ) + print( colour.io.process_image_ctl( a, - [ctl_Y_2_linCV_float], - env=dict( - os.environ, - CTL_MODULE_PATH=CTL_MODULE_PATH, - ), + { + os.path.join(ROOT_RESOURCES, "Adjust_Exposure_Float3.ctl"): [ + "-param1 exposure 3.0" + ] + }, + "-verbose", + "-force", ) ) print("\n") - message_box( - 'Running the "aces-dev" "darkSurround_to_dimSurround" "CTL" function ' - "to transform an array." + ROOT_ACES_DEV_TRANSFORMS = os.path.abspath( + os.path.join( + os.path.dirname(__file__), + "..", + "..", + "..", + "..", + "..", + "ampas", + "aces-dev", + "transforms", + "ctl", + ) ) - ctl_darkSurround_to_dimSurround_float3 = ( - colour.io.template_ctl_transform_float3( - "darkSurround_to_dimSurround(rgbIn)", + + if os.path.exists(ROOT_ACES_DEV_TRANSFORMS): + message_box( + 'Running the "aces-dev" "RRT" "CTL" function to transform an array.' + ) + + CTL_MODULE_PATH = ( + f"{ROOT_ACES_DEV_TRANSFORMS}:" + f"{ROOT_ACES_DEV_TRANSFORMS}/lib:" + f"{ROOT_ACES_DEV_TRANSFORMS}/utilities" + ) + print( + colour.io.process_image_ctl( + a, + {f"{ROOT_ACES_DEV_TRANSFORMS}/rrt/RRT.ctl": ["-param1 aIn 1.0"]}, + env=dict( + os.environ, + CTL_MODULE_PATH=CTL_MODULE_PATH, + ), + ) + ) + + print("\n") + + message_box( + 'Running the "aces-dev" "Y_2_linCV" "CTL" function to transform an array.' + ) + + def format_imports(imports): + """Format given imports.""" + return [f'import "{i}";' for i in imports] + + ctl_Y_2_linCV_float = colour.io.template_ctl_transform_float( + "Y_2_linCV(rIn, CINEMA_WHITE, CINEMA_BLACK)", + "Y_2_linCV(gIn, CINEMA_WHITE, CINEMA_BLACK)", + "Y_2_linCV(bIn, CINEMA_WHITE, CINEMA_BLACK)", imports=format_imports( [ "ACESlib.Utilities", @@ -243,15 +209,44 @@ def format_imports(imports): ] ), ) - ) - print(ctl_darkSurround_to_dimSurround_float3) - print( - colour.io.process_image_ctl( - a, - [ctl_darkSurround_to_dimSurround_float3], - env=dict( - os.environ, - CTL_MODULE_PATH=CTL_MODULE_PATH, - ), + print(ctl_Y_2_linCV_float) + print( + colour.io.process_image_ctl( + a, + [ctl_Y_2_linCV_float], + env=dict( + os.environ, + CTL_MODULE_PATH=CTL_MODULE_PATH, + ), + ) + ) + + print("\n") + + message_box( + 'Running the "aces-dev" "darkSurround_to_dimSurround" "CTL" function ' + "to transform an array." + ) + ctl_darkSurround_to_dimSurround_float3 = ( + colour.io.template_ctl_transform_float3( + "darkSurround_to_dimSurround(rgbIn)", + imports=format_imports( + [ + "ACESlib.Utilities", + "ACESlib.Transform_Common", + "ACESlib.ODT_Common", + ] + ), + ) + ) + print(ctl_darkSurround_to_dimSurround_float3) + print( + colour.io.process_image_ctl( + a, + [ctl_darkSurround_to_dimSurround_float3], + env=dict( + os.environ, + CTL_MODULE_PATH=CTL_MODULE_PATH, + ), + ) ) - ) diff --git a/colour/examples/io/examples_fichet2021.py b/colour/examples/io/examples_fichet2021.py new file mode 100644 index 0000000000..69d73eae87 --- /dev/null +++ b/colour/examples/io/examples_fichet2021.py @@ -0,0 +1,35 @@ +""" +Showcases *Fichet, Pacanowski and Wilkie (2021)* +*OpenEXR Layout for Spectral Images* related examples. +""" + +import os +import tempfile + +import colour +from colour.utilities import is_openimageio_installed, message_box + +if is_openimageio_installed(): + ROOT_RESOURCES = os.path.join( + os.path.dirname(__file__), "..", "..", "io", "tests", "resources" + ) + + message_box( + '"Fichet, Pacanowski and Wilkie (2021)" Spectral Image Reading and Writing' + ) + + message_box("Reading a spectral image.") + path = os.path.join(ROOT_RESOURCES, "Ohta1997.exr") + components, specification = colour.read_spectral_image_Fichet2021( + path, additional_data=True + ) + print(components) + print(specification) + + print("\n") + + message_box("Writing a spectral image.") + _descriptor, path = tempfile.mkstemp(suffix=".exr") + colour.write_spectral_image_Fichet2021(components, path) # pyright: ignore + components = colour.read_spectral_image_Fichet2021(path) + print(components) diff --git a/colour/examples/io/examples_ies_tm2714.py b/colour/examples/io/examples_ies_tm2714.py index 22b97b083c..372b075fea 100644 --- a/colour/examples/io/examples_ies_tm2714.py +++ b/colour/examples/io/examples_ies_tm2714.py @@ -1,4 +1,4 @@ -"""Showcases *IES TM-27-14* spectral data *XML* files input / output examples.""" +"""Showcase *IES TM-27-14* spectral data *XML* files input / output examples.""" import os diff --git a/colour/examples/io/examples_luts.py b/colour/examples/io/examples_luts.py index 7cde31369b..0732af3038 100644 --- a/colour/examples/io/examples_luts.py +++ b/colour/examples/io/examples_luts.py @@ -1,4 +1,4 @@ -"""Showcases Look Up Table (LUT) data related examples.""" +"""Showcase Look Up Table (LUT) data related examples.""" import os @@ -24,9 +24,7 @@ print("\n") message_box('Reading an "Iridas" ".cube" 3x1D LUT file.') -path = os.path.join( - ROOT_RESOURCES, "iridas_cube", "ACES_Proxy_10_to_ACES.cube" -) +path = os.path.join(ROOT_RESOURCES, "iridas_cube", "ACES_Proxy_10_to_ACES.cube") print(colour.io.read_LUT_IridasCube(path)) print("\n") print(colour.read_LUT(path)) @@ -82,9 +80,7 @@ print("\n") message_box(f'Applying a 3x1D LUT to given "RGB" values:\n\n\t{RGB}') -path = os.path.join( - ROOT_RESOURCES, "iridas_cube", "ACES_Proxy_10_to_ACES.cube" -) +path = os.path.join(ROOT_RESOURCES, "iridas_cube", "ACES_Proxy_10_to_ACES.cube") LUT = colour.io.read_LUT(path) print(LUT.apply(RGB)) @@ -95,9 +91,7 @@ LUT = colour.io.read_LUT(path) print(LUT.apply(RGB)) -message_box( - f'Applying a "Sony" ".spimtx" LUT to given "RGB" values:\n\n\t{RGB}' -) +message_box(f'Applying a "Sony" ".spimtx" LUT to given "RGB" values:\n\n\t{RGB}') path = os.path.join(ROOT_RESOURCES, "sony_spimtx", "dt.spimtx") LUT = colour.io.read_LUT(path) print(LUT.apply(RGB)) diff --git a/colour/examples/io/examples_tabular.py b/colour/examples/io/examples_tabular.py index 540dd6682c..a23177af43 100644 --- a/colour/examples/io/examples_tabular.py +++ b/colour/examples/io/examples_tabular.py @@ -1,4 +1,4 @@ -"""Showcases input / output *CSV* tabular data related examples.""" +"""Showcase input / output *CSV* tabular data related examples.""" import os from pprint import pprint @@ -19,8 +19,7 @@ print("\n") message_box( - 'Reading spectral data from a "CSV" file directly as spectral ' - "distributions." + 'Reading spectral data from a "CSV" file directly as spectral distributions.' ) sds_babelcolor_average = colour.read_sds_from_csv_file( os.path.join(ROOT_RESOURCES, "babelcolor_average.csv") diff --git a/colour/examples/models/examples_cmyk.py b/colour/examples/models/examples_cmyk.py index 03bb45a348..f4f4948d26 100644 --- a/colour/examples/models/examples_cmyk.py +++ b/colour/examples/models/examples_cmyk.py @@ -1,4 +1,4 @@ -"""Showcases Cyan-Magenta-Yellow (Black) (CMY(K)) colour transformations.""" +"""Showcase Cyan-Magenta-Yellow (Black) (CMY(K)) colour transformations.""" import numpy as np diff --git a/colour/examples/models/examples_cylindrical.py b/colour/examples/models/examples_cylindrical.py index 44333be5f9..3f9365c181 100644 --- a/colour/examples/models/examples_cylindrical.py +++ b/colour/examples/models/examples_cylindrical.py @@ -1,4 +1,4 @@ -"""Showcases cylindrical and spherical colour models computations.""" +"""Showcase cylindrical and spherical colour models computations.""" import numpy as np diff --git a/colour/examples/models/examples_derivation.py b/colour/examples/models/examples_derivation.py index ae414ce643..a10558d39f 100644 --- a/colour/examples/models/examples_derivation.py +++ b/colour/examples/models/examples_derivation.py @@ -1,4 +1,4 @@ -"""Showcases *RGB* colourspace derivation.""" +"""Showcase *RGB* colourspace derivation.""" import numpy as np @@ -99,9 +99,7 @@ print("\n") -message_box( - f'Computing the "RGB" luminance equation of given "RGB" values:\n\n\t{RGB}' -) +message_box(f'Computing the "RGB" luminance equation of given "RGB" values:\n\n\t{RGB}') print( colour.RGB_luminance( RGB, diff --git a/colour/examples/models/examples_ictcp.py b/colour/examples/models/examples_ictcp.py index ab1075d852..0fe33b425a 100644 --- a/colour/examples/models/examples_ictcp.py +++ b/colour/examples/models/examples_ictcp.py @@ -1,4 +1,4 @@ -"""Showcases *ICtCp* *colour encoding* computations.""" +"""Showcase *ICtCp* *colour encoding* computations.""" import numpy as np diff --git a/colour/examples/models/examples_models.py b/colour/examples/models/examples_models.py index 6cd972d9b5..0de71d3730 100644 --- a/colour/examples/models/examples_models.py +++ b/colour/examples/models/examples_models.py @@ -1,4 +1,4 @@ -"""Showcases colour models computations.""" +"""Showcase colour models computations.""" import numpy as np @@ -57,11 +57,7 @@ f"values:\n\n\t{XYZ}" ) D65 = colour.CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"] -print( - colour.XYZ_to_RGB( - XYZ, colour.RGB_COLOURSPACES["sRGB"], D65, "Bradford", True - ) -) +print(colour.XYZ_to_RGB(XYZ, colour.RGB_COLOURSPACES["sRGB"], D65, "Bradford", True)) print("\n") @@ -70,11 +66,7 @@ f'Converting to "CIE XYZ" tristimulus values from given "RGB" colourspace ' f"values:\n\n\t{RGB}" ) -print( - colour.RGB_to_XYZ( - RGB, colour.RGB_COLOURSPACES["sRGB"], D65, "Bradford", True - ) -) +print(colour.RGB_to_XYZ(RGB, colour.RGB_COLOURSPACES["sRGB"], D65, "Bradford", True)) print("\n") @@ -193,7 +185,7 @@ f'Converting to "CIE L*C*Huv" colourspace from given "CIE L*u*v*" ' f"colourspace values:\n\n\t{Luv}" ) -print(colour.Luv_to_LCHuv(Luv)) +print(colour.Luv_to_LCHuv(Luv)) # pyright: ignore print("\n") @@ -202,7 +194,7 @@ f'Converting to "CIE L*u*v*" colourspace from given "CIE L*C*Huv" ' f"colourspace values:\n\n\t{LCHuv}" ) -print(colour.LCHuv_to_Luv(LCHuv)) +print(colour.LCHuv_to_Luv(LCHuv)) # pyright: ignore print("\n") @@ -227,7 +219,7 @@ f'Converting to "CIE L*C*Hab" colourspace from given "CIE L*a*b*" ' f"colourspace values:\n\n\t{Lab}" ) -print(colour.Lab_to_LCHab(Lab)) +print(colour.Lab_to_LCHab(Lab)) # pyright: ignore print("\n") @@ -236,7 +228,7 @@ f'Converting to "CIE L*a*b*" colourspace from given "CIE L*C*Hab" ' f"colourspace values:\n\n\t{LCHab}" ) -print(colour.LCHab_to_Lab(LCHab)) +print(colour.LCHab_to_Lab(LCHab)) # pyright: ignore print("\n") @@ -481,9 +473,7 @@ specification_CAM16 = colour.XYZ_to_CAM16( XYZ, XYZ_w, L_A, Y_b, colour.VIEWING_CONDITIONS_CAM16["Average"] ) -JMh = np.array( - [specification_CAM16.J, specification_CAM16.M, specification_CAM16.h] -) +JMh = np.array([specification_CAM16.J, specification_CAM16.M, specification_CAM16.h]) message_box( f'Converting to "CAM16-UCS" colourspace from given "CAM16" colour ' f'appearance model "JMh" correlates:\n\n\t{JMh}' diff --git a/colour/examples/models/examples_prismatic.py b/colour/examples/models/examples_prismatic.py index a04bf5a9d4..189cdaa1cf 100644 --- a/colour/examples/models/examples_prismatic.py +++ b/colour/examples/models/examples_prismatic.py @@ -1,4 +1,4 @@ -"""Showcases *Prismatic* colourspace computations.""" +"""Showcase *Prismatic* colourspace computations.""" import numpy as np diff --git a/colour/examples/models/examples_rgb.py b/colour/examples/models/examples_rgb.py index 415ab3ffab..8660ea8025 100644 --- a/colour/examples/models/examples_rgb.py +++ b/colour/examples/models/examples_rgb.py @@ -1,4 +1,4 @@ -"""Showcases *RGB* *colourspaces* computations.""" +"""Showcase *RGB* *colourspaces* computations.""" from pprint import pprint @@ -22,10 +22,7 @@ f'\nNormalised primary matrix to "CIE XYZ" tristimulus values:\n' f"{colourspace.matrix_RGB_to_XYZ}" ) -print( - f'\nNormalised primary matrix to "ACES2065-1":\n' - f"{colourspace.matrix_XYZ_to_RGB}" -) +print(f'\nNormalised primary matrix to "ACES2065-1":\n {colourspace.matrix_XYZ_to_RGB}') print( f"\nOpto-electronic transfer function from linear to colourspace:\n" f"{colourspace.cctf_encoding}" @@ -38,8 +35,7 @@ print("\n") message_box( - 'Computing the "ACES2065-1" colourspace to "ITU-R BT.709" colourspace ' - "matrix." + 'Computing the "ACES2065-1" colourspace to "ITU-R BT.709" colourspace matrix.' ) cat = colour.adaptation.matrix_chromatic_adaptation_VonKries( colour.xy_to_XYZ(colourspace.whitepoint), @@ -70,13 +66,10 @@ print("\n") message_box( - '"Recommendation ITU-T H.273" ' - "Code points for Video Signal Type Identification" + '"Recommendation ITU-T H.273" Code points for Video Signal Type Identification' ) -message_box( - f"Colour Primaries: {list(colour.COLOUR_PRIMARIES_ITUTH273.keys())}" -) +message_box(f"Colour Primaries: {list(colour.COLOUR_PRIMARIES_ITUTH273.keys())}") colour.models.describe_video_signal_colour_primaries(1) print("\n") @@ -89,9 +82,6 @@ print("\n") -message_box( - f"Matrix Coefficients: " - f"{list(colour.MATRIX_COEFFICIENTS_ITUTH273.keys())}" -) +message_box(f"Matrix Coefficients: {list(colour.MATRIX_COEFFICIENTS_ITUTH273.keys())}") colour.models.describe_video_signal_matrix_coefficients(1) diff --git a/colour/examples/models/examples_transfer_functions.py b/colour/examples/models/examples_transfer_functions.py index 33021aed68..61c215f02b 100644 --- a/colour/examples/models/examples_transfer_functions.py +++ b/colour/examples/models/examples_transfer_functions.py @@ -1,4 +1,4 @@ -"""Showcases colour component transfer functions (CCTF) relates computations.""" +"""Showcase colour component transfer functions (CCTF) relates computations.""" import colour from colour.utilities import message_box @@ -33,9 +33,7 @@ print("\n") N = 0.45731961 -message_box( - f'Decoding to linear-light using given "Cineon" code value:\n\n\t{N}' -) +message_box(f'Decoding to linear-light using given "Cineon" code value:\n\n\t{N}') print(colour.log_decoding(N, function="Cineon")) print(colour.models.log_decoding_Cineon(N)) @@ -48,9 +46,7 @@ print("\n") N = 0.43499511 -message_box( - f'Decoding to linear-light value using given "PLog" code value:\n\n\t{N}' -) +message_box(f'Decoding to linear-light value using given "PLog" code value:\n\n\t{N}') print(colour.log_decoding(N, function="PLog")) print(colour.models.log_decoding_PivotedLog(N)) diff --git a/colour/examples/models/examples_ycbcr.py b/colour/examples/models/examples_ycbcr.py index 23d5a4bcae..055dfc3220 100644 --- a/colour/examples/models/examples_ycbcr.py +++ b/colour/examples/models/examples_ycbcr.py @@ -1,4 +1,4 @@ -"""Showcases *Y'CbCr* *colour encoding* computations.""" +"""Showcase *Y'CbCr* *colour encoding* computations.""" import numpy as np diff --git a/colour/examples/models/examples_ycocg.py b/colour/examples/models/examples_ycocg.py index 5c0e243a7f..7921031f19 100644 --- a/colour/examples/models/examples_ycocg.py +++ b/colour/examples/models/examples_ycocg.py @@ -1,4 +1,4 @@ -"""Showcases *YCoCg* *colour encoding* computations.""" +"""Showcase *YCoCg* *colour encoding* computations.""" import numpy as np diff --git a/colour/examples/notation/examples_hexadecimal.py b/colour/examples/notation/examples_hexadecimal.py index 0324cb2e9e..cb374b3f27 100644 --- a/colour/examples/notation/examples_hexadecimal.py +++ b/colour/examples/notation/examples_hexadecimal.py @@ -1,4 +1,4 @@ -"""Showcases hexadecimal computations.""" +"""Showcase hexadecimal computations.""" import numpy as np diff --git a/colour/examples/notation/examples_munsell.py b/colour/examples/notation/examples_munsell.py index 48d4cebd5b..561fd42b15 100644 --- a/colour/examples/notation/examples_munsell.py +++ b/colour/examples/notation/examples_munsell.py @@ -1,4 +1,4 @@ -"""Showcases *Munsell Renotation System* computations.""" +"""Showcase *Munsell Renotation System* computations.""" import numpy as np diff --git a/colour/examples/phenomena/examples_rayleigh.py b/colour/examples/phenomena/examples_rayleigh.py index a01a899ee0..a18fc47268 100644 --- a/colour/examples/phenomena/examples_rayleigh.py +++ b/colour/examples/phenomena/examples_rayleigh.py @@ -1,4 +1,4 @@ -"""Showcases *Rayleigh Optical Depth* computations examples.""" +"""Showcase *Rayleigh Optical Depth* computations examples.""" import colour from colour.utilities import message_box diff --git a/colour/examples/plotting/examples_blindness.py b/colour/examples/plotting/examples_blindness.py index bd58ad6e53..3d32660221 100644 --- a/colour/examples/plotting/examples_blindness.py +++ b/colour/examples/plotting/examples_blindness.py @@ -1,4 +1,4 @@ -"""Showcases corresponding colour blindness plotting examples.""" +"""Showcase corresponding colour blindness plotting examples.""" import os @@ -18,9 +18,7 @@ ISHIHARA_CBT_3_IMAGE = colour.cctf_decoding( colour.read_image( - os.path.join( - ROOT_RESOURCES, "Ishihara_Colour_Blindness_Test_Plate_3.png" - ) + os.path.join(ROOT_RESOURCES, "Ishihara_Colour_Blindness_Test_Plate_3.png") ), function="sRGB", ) diff --git a/colour/examples/plotting/examples_characterisation_plots.py b/colour/examples/plotting/examples_characterisation_plots.py index 18a63114b3..119125984b 100644 --- a/colour/examples/plotting/examples_characterisation_plots.py +++ b/colour/examples/plotting/examples_characterisation_plots.py @@ -1,4 +1,4 @@ -"""Showcases characterisation plotting examples.""" +"""Showcase characterisation plotting examples.""" from pprint import pprint @@ -17,17 +17,14 @@ message_box("Plotting colour rendition charts.") pprint(sorted(colour.CCS_COLOURCHECKERS.keys())) plot_single_colour_checker("ColorChecker 1976") -plot_single_colour_checker( - "BabelColor Average", text_kwargs={"visible": False} -) +plot_single_colour_checker("BabelColor Average", text_kwargs={"visible": False}) plot_single_colour_checker("ColorChecker 1976", text_kwargs={"visible": False}) plot_single_colour_checker("ColorChecker 2005", text_kwargs={"visible": False}) print("\n") message_box( - 'Plotting "BabelColor Average" colour rendition charts spectral ' - "distributions." + 'Plotting "BabelColor Average" colour rendition charts spectral distributions.' ) plot_multi_sds( colour.SDS_COLOURCHECKERS["BabelColor Average"].values(), diff --git a/colour/examples/plotting/examples_colorimetry_plots.py b/colour/examples/plotting/examples_colorimetry_plots.py index 5bdde1c1e0..aa958865d5 100644 --- a/colour/examples/plotting/examples_colorimetry_plots.py +++ b/colour/examples/plotting/examples_colorimetry_plots.py @@ -1,4 +1,4 @@ -"""Showcases colorimetry plotting examples.""" +"""Showcase colorimetry plotting examples.""" from pprint import pprint @@ -31,9 +31,7 @@ message_box("Plotting multiple illuminants spectral distributions.") pprint(sorted(colour.SDS_ILLUMINANTS.keys())) -plot_multi_illuminant_sds( - ["A", "B", "C", "D50", "D55", "D60", "D65", "D75", "FL1"] -) +plot_multi_illuminant_sds(["A", "B", "C", "D50", "D55", "D60", "D65", "D75", "FL1"]) print("\n") @@ -48,10 +46,7 @@ print("\n") -message_box( - 'Plotting "CIE Standard Illuminant D Series" "S" spectral ' - "distributions." -) +message_box('Plotting "CIE Standard Illuminant D Series" "S" spectral distributions.') plot_multi_sds( [ value @@ -829,9 +824,7 @@ 780: 8.8190000e-002, } -sd_street_light = colour.SpectralDistribution( - data_street_light, name="Street Light" -) +sd_street_light = colour.SpectralDistribution(data_street_light, name="Street Light") sd_bandpass_corrected_street_light = sd_street_light.copy() sd_bandpass_corrected_street_light.name = "Street Light (Bandpass Corrected)" @@ -944,12 +937,8 @@ plot_multi_sds( ( sd_mesopic_luminous_efficiency_function, - colour.colorimetry.SDS_LEFS_PHOTOPIC[ - "CIE 1924 Photopic Standard Observer" - ], - colour.colorimetry.SDS_LEFS_SCOTOPIC[ - "CIE 1951 Scotopic Standard Observer" - ], + colour.colorimetry.SDS_LEFS_PHOTOPIC["CIE 1924 Photopic Standard Observer"], + colour.colorimetry.SDS_LEFS_SCOTOPIC["CIE 1951 Scotopic Standard Observer"], ), y_label="Luminous Efficiency", ) @@ -967,9 +956,7 @@ print("\n") message_box("Plotting various blackbody spectral radiance.") -plot_blackbody_spectral_radiance( - temperature=3500, blackbody="VY Canis Majoris" -) +plot_blackbody_spectral_radiance(temperature=3500, blackbody="VY Canis Majoris") plot_blackbody_spectral_radiance(temperature=5778, blackbody="The Sun") plot_blackbody_spectral_radiance(temperature=12130, blackbody="Rigel") diff --git a/colour/examples/plotting/examples_common_plots.py b/colour/examples/plotting/examples_common_plots.py index 7ad13a163a..6f56f1a4d9 100644 --- a/colour/examples/plotting/examples_common_plots.py +++ b/colour/examples/plotting/examples_common_plots.py @@ -1,4 +1,4 @@ -"""Showcases common plotting examples.""" +"""Showcase common plotting examples.""" from colour.plotting import ( ColourSwatch, diff --git a/colour/examples/plotting/examples_corresponding.py b/colour/examples/plotting/examples_corresponding.py index a54f4bcd5c..6935db6767 100644 --- a/colour/examples/plotting/examples_corresponding.py +++ b/colour/examples/plotting/examples_corresponding.py @@ -1,4 +1,4 @@ -"""Showcases corresponding chromaticities prediction plotting examples.""" +"""Showcase corresponding chromaticities prediction plotting examples.""" from colour.plotting import ( colour_style, @@ -18,9 +18,7 @@ plot_corresponding_chromaticities_prediction( 2, "Von Kries", - corresponding_chromaticities_prediction_kwargs={ - "transform": "Bianco 2010" - }, + corresponding_chromaticities_prediction_kwargs={"transform": "Bianco 2010"}, ) print("\n") diff --git a/colour/examples/plotting/examples_diagrams_plots.py b/colour/examples/plotting/examples_diagrams_plots.py index 38edc31da2..d0a00eee2c 100644 --- a/colour/examples/plotting/examples_diagrams_plots.py +++ b/colour/examples/plotting/examples_diagrams_plots.py @@ -1,4 +1,4 @@ -"""Showcases *CIE* chromaticity diagrams plotting examples.""" +"""Showcase *CIE* chromaticity diagrams plotting examples.""" from colour import SDS_ILLUMINANTS from colour.plotting import ( diff --git a/colour/examples/plotting/examples_models_plots.py b/colour/examples/plotting/examples_models_plots.py index 4daaf99b93..c0b99df99e 100644 --- a/colour/examples/plotting/examples_models_plots.py +++ b/colour/examples/plotting/examples_models_plots.py @@ -1,4 +1,4 @@ -"""Showcases colour models plotting examples.""" +"""Showcase colour models plotting examples.""" from pprint import pprint @@ -22,9 +22,7 @@ colour_style() -message_box( - 'Plotting "RGB" colourspaces in the "CIE 1931 Chromaticity Diagram".' -) +message_box('Plotting "RGB" colourspaces in the "CIE 1931 Chromaticity Diagram".') pprint(sorted(colour.RGB_COLOURSPACES.keys())) plot_RGB_colourspaces_in_chromaticity_diagram_CIE1931( ["ITU-R BT.709", "ACEScg", "S-Gamut"], show_pointer_gamut=True @@ -32,10 +30,7 @@ print("\n") -message_box( - 'Plotting "RGB" colourspaces in the ' - '"CIE 1960 UCS Chromaticity Diagram".' -) +message_box('Plotting "RGB" colourspaces in the "CIE 1960 UCS Chromaticity Diagram".') pprint(sorted(colour.RGB_COLOURSPACES.keys())) plot_RGB_colourspaces_in_chromaticity_diagram_CIE1960UCS( ["ITU-R BT.709", "ACEScg", "S-Gamut"], show_pointer_gamut=True @@ -43,10 +38,7 @@ print("\n") -message_box( - 'Plotting "RGB" colourspaces in the ' - '"CIE 1976 UCS Chromaticity Diagram".' -) +message_box('Plotting "RGB" colourspaces in the "CIE 1976 UCS Chromaticity Diagram".') pprint(sorted(colour.RGB_COLOURSPACES.keys())) plot_RGB_colourspaces_in_chromaticity_diagram_CIE1976UCS( ["ITU-R BT.709", "ACEScg", "S-Gamut"], show_pointer_gamut=True @@ -57,8 +49,7 @@ RGB = np.random.random((32, 32, 3)) message_box( - 'Plotting "RGB" chromaticity coordinates in the ' - '"CIE 1931 Chromaticity Diagram".' + 'Plotting "RGB" chromaticity coordinates in the "CIE 1931 Chromaticity Diagram".' ) plot_RGB_chromaticities_in_chromaticity_diagram_CIE1931( RGB, @@ -111,9 +102,7 @@ whitepoint=np.array([1.0 / 3.0, 1.0 / 3.0]), ) pprint(sorted(colour.RGB_COLOURSPACES.keys())) -plot_RGB_colourspaces_in_chromaticity_diagram_CIE1931( - ["ITU-R BT.709", AWFUL_RGB] -) +plot_RGB_colourspaces_in_chromaticity_diagram_CIE1931(["ITU-R BT.709", AWFUL_RGB]) print("\n") diff --git a/colour/examples/plotting/examples_notation_plots.py b/colour/examples/plotting/examples_notation_plots.py index aae23a899d..d0e8969ef9 100644 --- a/colour/examples/plotting/examples_notation_plots.py +++ b/colour/examples/plotting/examples_notation_plots.py @@ -1,4 +1,4 @@ -"""Showcases colour notation systems plotting examples.""" +"""Showcase colour notation systems plotting examples.""" from colour.plotting import ( colour_style, diff --git a/colour/examples/plotting/examples_phenomena_plots.py b/colour/examples/plotting/examples_phenomena_plots.py index 2d33c4eb5f..dae150f6d9 100644 --- a/colour/examples/plotting/examples_phenomena_plots.py +++ b/colour/examples/plotting/examples_phenomena_plots.py @@ -1,4 +1,4 @@ -"""Showcases optical phenomena plotting examples.""" +"""Showcase optical phenomena plotting examples.""" from colour.phenomena import sd_rayleigh_scattering from colour.plotting import ( diff --git a/colour/examples/plotting/examples_quality_plots.py b/colour/examples/plotting/examples_quality_plots.py index 1af266349a..ff6e7c813d 100644 --- a/colour/examples/plotting/examples_quality_plots.py +++ b/colour/examples/plotting/examples_quality_plots.py @@ -1,4 +1,4 @@ -"""Showcases colour quality plotting examples.""" +"""Showcase colour quality plotting examples.""" import colour from colour.plotting import ( @@ -20,8 +20,7 @@ print("\n") message_box( - "Plotting various illuminants and light sources " - '"Colour Rendering Index (CRI)".' + 'Plotting various illuminants and light sources "Colour Rendering Index (CRI)".' ) plot_multi_sds_colour_rendering_indexes_bars( ( @@ -39,8 +38,7 @@ print("\n") message_box( - "Plotting various illuminants and light sources " - '"Colour Quality Scale (CQS)".' + 'Plotting various illuminants and light sources "Colour Quality Scale (CQS)".' ) plot_multi_sds_colour_quality_scales_bars( ( diff --git a/colour/examples/plotting/examples_section_plots.py b/colour/examples/plotting/examples_section_plots.py index d889b058cc..8b9909bf8c 100644 --- a/colour/examples/plotting/examples_section_plots.py +++ b/colour/examples/plotting/examples_section_plots.py @@ -1,4 +1,4 @@ -"""Showcases gamut section plotting examples.""" +"""Showcase gamut section plotting examples.""" import numpy as np from matplotlib.lines import Line2D diff --git a/colour/examples/plotting/examples_temperature_plots.py b/colour/examples/plotting/examples_temperature_plots.py index 7dbc7283d2..f797e27b3c 100644 --- a/colour/examples/plotting/examples_temperature_plots.py +++ b/colour/examples/plotting/examples_temperature_plots.py @@ -19,7 +19,5 @@ print("\n") -message_box( - 'Plotting planckian locus in the "CIE 1960 UCS Chromaticity Diagram".' -) +message_box('Plotting planckian locus in the "CIE 1960 UCS Chromaticity Diagram".') plot_planckian_locus_in_chromaticity_diagram_CIE1960UCS(["A", "B", "C"]) diff --git a/colour/examples/plotting/examples_tm3018.py b/colour/examples/plotting/examples_tm3018.py index 17d4f6431d..3c462ec5da 100644 --- a/colour/examples/plotting/examples_tm3018.py +++ b/colour/examples/plotting/examples_tm3018.py @@ -1,4 +1,4 @@ -"""Showcases *ANSI/IES TM-30-18 Colour Rendition Report* plotting examples.""" +"""Showcase *ANSI/IES TM-30-18 Colour Rendition Report* plotting examples.""" import colour from colour.plotting import ( @@ -18,9 +18,7 @@ print("\n") -message_box( - 'Plotting an intermediate "ANSI/IES TM-30-18 Colour Rendition Report".' -) +message_box('Plotting an intermediate "ANSI/IES TM-30-18 Colour Rendition Report".') plot_single_sd_colour_rendition_report(sd, "Intermediate") print("\n") diff --git a/colour/examples/plotting/examples_volume_plots.py b/colour/examples/plotting/examples_volume_plots.py index 796e98767f..e2e66ff45a 100644 --- a/colour/examples/plotting/examples_volume_plots.py +++ b/colour/examples/plotting/examples_volume_plots.py @@ -1,4 +1,4 @@ -"""Showcases colour models volume and gamut plotting examples.""" +"""Showcase colour models volume and gamut plotting examples.""" import numpy as np @@ -14,12 +14,9 @@ colour_style() message_box( - 'Plotting "ITU-R BT.709" RGB colourspace volume in the "CIE xyY" ' - "colourspace." -) -plot_RGB_colourspaces_gamuts( - ("ITU-R BT.709",), reference_colourspace="CIE xyY" + 'Plotting "ITU-R BT.709" RGB colourspace volume in the "CIE xyY" colourspace.' ) +plot_RGB_colourspaces_gamuts(("ITU-R BT.709",), reference_colourspace="CIE xyY") print("\n") @@ -38,9 +35,7 @@ print("\n") -message_box( - 'Plotting "ACEScg" colourspaces values in the "CIE L*a*b*" colourspace.' -) +message_box('Plotting "ACEScg" colourspaces values in the "CIE L*a*b*" colourspace.') RGB = np.random.random((32, 32, 3)) diff --git a/colour/examples/quality/examples_cfi.py b/colour/examples/quality/examples_cfi.py index 75b38fa6e4..1fb6c56fa8 100644 --- a/colour/examples/quality/examples_cfi.py +++ b/colour/examples/quality/examples_cfi.py @@ -1,4 +1,4 @@ -"""Showcases *Colour Fidelity Index* (CFI) computations.""" +"""Showcase *Colour Fidelity Index* (CFI) computations.""" from pprint import pprint @@ -9,24 +9,14 @@ message_box('Computing "F2" illuminant "Colour Fidelity Index (CFI)".') print(colour.colour_fidelity_index(colour.SDS_ILLUMINANTS["FL2"])) -print( - colour.colour_fidelity_index( - colour.SDS_ILLUMINANTS["FL2"], method="CIE 2017" - ) -) -print( - colour.quality.colour_fidelity_index_CIE2017(colour.SDS_ILLUMINANTS["FL2"]) -) +print(colour.colour_fidelity_index(colour.SDS_ILLUMINANTS["FL2"], method="CIE 2017")) +print(colour.quality.colour_fidelity_index_CIE2017(colour.SDS_ILLUMINANTS["FL2"])) print( colour.colour_fidelity_index( colour.SDS_ILLUMINANTS["FL2"], method="ANSI/IES TM-30-18" ) ) -print( - colour.quality.colour_fidelity_index_ANSIIESTM3018( - colour.SDS_ILLUMINANTS["FL2"] - ) -) +print(colour.quality.colour_fidelity_index_ANSIIESTM3018(colour.SDS_ILLUMINANTS["FL2"])) print("\n") @@ -35,9 +25,7 @@ "output data." ) pprint( - colour.colour_fidelity_index( - colour.SDS_ILLUMINANTS["FL2"], additional_data=True - ) + colour.colour_fidelity_index(colour.SDS_ILLUMINANTS["FL2"], additional_data=True) ) print( colour.colour_fidelity_index( @@ -64,9 +52,7 @@ print("\n") -message_box( - 'Computing "CIE Standard Illuminant A" "Colour Fidelity Index (CFI)".' -) +message_box('Computing "CIE Standard Illuminant A" "Colour Fidelity Index (CFI)".') print(colour.colour_fidelity_index(colour.SDS_ILLUMINANTS["A"])) print("\n") diff --git a/colour/examples/quality/examples_cqs.py b/colour/examples/quality/examples_cqs.py index 012aed1bd0..7652728d57 100644 --- a/colour/examples/quality/examples_cqs.py +++ b/colour/examples/quality/examples_cqs.py @@ -1,4 +1,4 @@ -"""Showcases *Colour Quality Scale* (CQS) computations.""" +"""Showcase *Colour Quality Scale* (CQS) computations.""" from pprint import pprint @@ -28,9 +28,7 @@ 'Computing the "SDW-T 100W/LV Super HPS" lamp "Colour Quality Scale (CQS)".' ) print( - colour.colour_quality_scale( - colour.SDS_LIGHT_SOURCES["SDW-T 100W/LV (Super HPS)"] - ) + colour.colour_quality_scale(colour.SDS_LIGHT_SOURCES["SDW-T 100W/LV (Super HPS)"]) ) print("\n") @@ -121,7 +119,5 @@ } print( - colour.colour_quality_scale( - colour.SpectralDistribution(data_sample, name="Sample") - ) + colour.colour_quality_scale(colour.SpectralDistribution(data_sample, name="Sample")) ) diff --git a/colour/examples/quality/examples_cri.py b/colour/examples/quality/examples_cri.py index ce1ad5bdf1..85d636a068 100644 --- a/colour/examples/quality/examples_cri.py +++ b/colour/examples/quality/examples_cri.py @@ -1,4 +1,4 @@ -"""Showcases *Colour Rendering Index* (CRI) computations.""" +"""Showcase *Colour Rendering Index* (CRI) computations.""" from pprint import pprint @@ -17,16 +17,12 @@ "detailed output data." ) pprint( - colour.colour_rendering_index( - colour.SDS_ILLUMINANTS["FL2"], additional_data=True - ) + colour.colour_rendering_index(colour.SDS_ILLUMINANTS["FL2"], additional_data=True) ) print("\n") -message_box( - 'Computing the "CIE Standard Illuminant A" "Colour Rendering Index (CRI)".' -) +message_box('Computing the "CIE Standard Illuminant A" "Colour Rendering Index (CRI)".') print(colour.colour_rendering_index(colour.SDS_ILLUMINANTS["A"])) print("\n") diff --git a/colour/examples/quality/examples_ssi.py b/colour/examples/quality/examples_ssi.py index a416ad78e8..c16f827a2c 100644 --- a/colour/examples/quality/examples_ssi.py +++ b/colour/examples/quality/examples_ssi.py @@ -1,4 +1,4 @@ -"""Showcases *Academy Spectral Similarity Index* (SSI) computations.""" +"""Showcase *Academy Spectral Similarity Index* (SSI) computations.""" import colour from colour.utilities import message_box diff --git a/colour/examples/recovery/examples_jakob2019.py b/colour/examples/recovery/examples_jakob2019.py index d9fe7a88b4..d1cb96e28f 100644 --- a/colour/examples/recovery/examples_jakob2019.py +++ b/colour/examples/recovery/examples_jakob2019.py @@ -1,4 +1,4 @@ -"""Showcases reflectance recovery computations using *Jakob et al. (2019)* method.""" +"""Showcase reflectance recovery computations using *Jakob et al. (2019)* method.""" import numpy as np diff --git a/colour/examples/recovery/examples_jiang2013.py b/colour/examples/recovery/examples_jiang2013.py index 160d15ad4e..bc9fe5c533 100644 --- a/colour/examples/recovery/examples_jiang2013.py +++ b/colour/examples/recovery/examples_jiang2013.py @@ -26,14 +26,12 @@ k=1, shape=colour.recovery.SPECTRAL_SHAPE_BASIS_FUNCTIONS_DYER2017, ) -msds_camera_sensitivities = ( - colour.recovery.RGB_to_msds_camera_sensitivities_Jiang2013( - RGB, - illuminant, - reflectances, - colour.recovery.BASIS_FUNCTIONS_DYER2017, - colour.recovery.SPECTRAL_SHAPE_BASIS_FUNCTIONS_DYER2017, - ) +msds_camera_sensitivities = colour.recovery.RGB_to_msds_camera_sensitivities_Jiang2013( + RGB, + illuminant, + reflectances, + colour.recovery.BASIS_FUNCTIONS_DYER2017, + colour.recovery.SPECTRAL_SHAPE_BASIS_FUNCTIONS_DYER2017, ) message_box( diff --git a/colour/examples/recovery/examples_meng2015.py b/colour/examples/recovery/examples_meng2015.py index 06aa2f1902..36208c407b 100644 --- a/colour/examples/recovery/examples_meng2015.py +++ b/colour/examples/recovery/examples_meng2015.py @@ -1,4 +1,4 @@ -"""Showcases reflectance recovery computations using *Meng et al. (2015)* method.""" +"""Showcase reflectance recovery computations using *Meng et al. (2015)* method.""" import numpy as np diff --git a/colour/examples/recovery/examples_otsu2018.py b/colour/examples/recovery/examples_otsu2018.py index 0a6e99ecd5..fcf76a65b4 100644 --- a/colour/examples/recovery/examples_otsu2018.py +++ b/colour/examples/recovery/examples_otsu2018.py @@ -1,4 +1,4 @@ -"""Showcases reflectance recovery computations using *Otsu et al. (2018)* method.""" +"""Showcase reflectance recovery computations using *Otsu et al. (2018)* method.""" import numpy as np @@ -22,8 +22,7 @@ print("\n") message_box( - 'Generating a spectral dataset according to the "Otsu et al. (2018) "' - "method :" + 'Generating a spectral dataset according to the "Otsu et al. (2018) method :' ) XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) reflectances = colour.colorimetry.sds_and_msds_to_msds( diff --git a/colour/examples/recovery/examples_smits1999.py b/colour/examples/recovery/examples_smits1999.py index 7f73d739d5..919ed93c08 100644 --- a/colour/examples/recovery/examples_smits1999.py +++ b/colour/examples/recovery/examples_smits1999.py @@ -1,4 +1,4 @@ -"""Showcases reflectance recovery computations using *Smits (1999)* method.""" +"""Showcase reflectance recovery computations using *Smits (1999)* method.""" import numpy as np diff --git a/colour/examples/temperature/examples_cct.py b/colour/examples/temperature/examples_cct.py index da82068e96..6382c26260 100644 --- a/colour/examples/temperature/examples_cct.py +++ b/colour/examples/temperature/examples_cct.py @@ -1,4 +1,4 @@ -"""Showcases correlated colour temperature computations.""" +"""Showcase correlated colour temperature computations.""" import colour from colour.utilities import message_box diff --git a/colour/examples/volume/examples_rgb.py b/colour/examples/volume/examples_rgb.py index 9e7226ae8e..d4125227fc 100644 --- a/colour/examples/volume/examples_rgb.py +++ b/colour/examples/volume/examples_rgb.py @@ -1,4 +1,4 @@ -"""Showcases RGB colourspace volume computations.""" +"""Showcase RGB colourspace volume computations.""" import colour from colour.utilities import message_box @@ -9,9 +9,7 @@ message_box("RGB Colourspace Volume Computations") message_box('Computing the "ProPhoto RGB" RGB colourspace limits.') - limits = colour.RGB_colourspace_limits( - colour.RGB_COLOURSPACES["ProPhoto RGB"] - ) + limits = colour.RGB_colourspace_limits(colour.RGB_COLOURSPACES["ProPhoto RGB"]) print(limits) print("\n") diff --git a/colour/geometry/__init__.py b/colour/geometry/__init__.py index 0edc667cf9..9b55aa2339 100644 --- a/colour/geometry/__init__.py +++ b/colour/geometry/__init__.py @@ -1,10 +1,3 @@ -import sys - -from colour.utilities.deprecation import ModuleAPI, build_API_changes -from colour.utilities.documentation import is_documentation_building - -from colour.hints import Any - from .ellipse import ( ellipse_coefficients_general_form, ellipse_coefficients_canonical_form, @@ -65,34 +58,3 @@ "PRIMITIVE_VERTICES_METHODS", "primitive_vertices", ] - - -# ----------------------------------------------------------------------------# -# --- API Changes and Deprecation Management ---# -# ----------------------------------------------------------------------------# -class geometry(ModuleAPI): - """Define a class acting like the *geometry* module.""" - - def __getattr__(self, attribute) -> Any: - """Return the value from the attribute with given name.""" - - return super().__getattr__(attribute) - - -# v0.4.0 -API_CHANGES = { - "ObjectRenamed": [ - [ - "colour.geometry.PLANE_TO_AXIS_MAPPING", - "colour.geometry.MAPPING_PLANE_TO_AXIS", - ], - ] -} -"""Defines the *colour.geometry* sub-package API changes.""" - -if not is_documentation_building(): - sys.modules["colour.geometry"] = geometry( # pyright: ignore - sys.modules["colour.geometry"], build_API_changes(API_CHANGES) - ) - - del ModuleAPI, is_documentation_building, build_API_changes, sys diff --git a/colour/geometry/ellipse.py b/colour/geometry/ellipse.py index bc2671984c..87a3a535d5 100644 --- a/colour/geometry/ellipse.py +++ b/colour/geometry/ellipse.py @@ -2,7 +2,7 @@ Ellipse ======= -Defines the objects related to ellipse computations: +Define the objects related to ellipse computations: - :func:`colour.algebra.ellipse_coefficients_general_form` - :func:`colour.algebra.ellipse_coefficients_canonical_form` @@ -165,9 +165,7 @@ def ellipse_coefficients_canonical_form( return np.array([x_c, y_c, a_a, a_b, theta]) -def point_at_angle_on_ellipse( - phi: ArrayLike, coefficients: ArrayLike -) -> NDArrayFloat: +def point_at_angle_on_ellipse(phi: ArrayLike, coefficients: ArrayLike) -> NDArrayFloat: """ Return the coordinates of the point at angle :math:`\\phi` in degrees on the ellipse with given canonical form coefficients. diff --git a/colour/geometry/intersection.py b/colour/geometry/intersection.py index 12b7318ba3..966cfd1857 100644 --- a/colour/geometry/intersection.py +++ b/colour/geometry/intersection.py @@ -2,7 +2,7 @@ Intersection Utilities ====================== -Defines the geometry intersection utilities objects. +Define the geometry intersection utilities objects. References ---------- @@ -201,9 +201,7 @@ def intersect_line_segments( r_1, c_1 = l_1.shape[0], l_1.shape[1] r_2, c_2 = l_2.shape[0], l_2.shape[1] - x_1, y_1, x_2, y_2 = ( - np.tile(l_1[:, i, None], (1, r_2)) for i in range(c_1) - ) + x_1, y_1, x_2, y_2 = (np.tile(l_1[:, i, None], (1, r_2)) for i in range(c_1)) l_2 = np.transpose(l_2) @@ -228,10 +226,6 @@ def intersect_line_segments( xy = tstack([x_1 + x_2_x_1 * u_a, y_1 + y_2_y_1 * u_a]) xy[~intersect] = np.nan parallel = denominator == 0 - coincident = np.logical_and.reduce( - (numerator_a == 0, numerator_b == 0, parallel) - ) + coincident = np.logical_and.reduce((numerator_a == 0, numerator_b == 0, parallel)) - return LineSegmentsIntersections_Specification( - xy, intersect, parallel, coincident - ) + return LineSegmentsIntersections_Specification(xy, intersect, parallel, coincident) diff --git a/colour/geometry/primitives.py b/colour/geometry/primitives.py index 16cfa15d7c..e66a353fd2 100644 --- a/colour/geometry/primitives.py +++ b/colour/geometry/primitives.py @@ -2,7 +2,7 @@ Geometry Primitives =================== -Defines various geometry primitives and their generation methods: +Define various geometry primitives and their generation methods: - :attr:`colour.geometry.MAPPING_PLANE_TO_AXIS` - :func:`colour.geometry.primitive_grid` @@ -234,10 +234,23 @@ def primitive_cube( width_segments: int = 1, height_segments: int = 1, depth_segments: int = 1, - planes: Literal[ - "-x", "+x", "-y", "+y", "-z", "+z", "xy", "xz", "yz", "yx", "zx", "zy" - ] - | None = None, + planes: ( + Literal[ + "-x", + "+x", + "-y", + "+y", + "-z", + "+z", + "xy", + "xz", + "yz", + "yx", + "zx", + "zy", + ] + | None + ) = None, dtype_vertices: Type[DTypeFloat] | None = None, dtype_indexes: Type[DTypeInt] | None = None, ) -> Tuple[NDArray, NDArray, NDArray]: @@ -346,9 +359,7 @@ def primitive_cube( axis = ( sorted(MAPPING_PLANE_TO_AXIS.values()) if planes is None - else [ - MAPPING_PLANE_TO_AXIS.get(plane, plane).lower() for plane in planes - ] + else [MAPPING_PLANE_TO_AXIS.get(plane, plane).lower() for plane in planes] ) dtype_vertices = optional(dtype_vertices, DTYPE_FLOAT_DEFAULT) diff --git a/colour/geometry/section.py b/colour/geometry/section.py index 5b8cd0a65d..33af5b9169 100644 --- a/colour/geometry/section.py +++ b/colour/geometry/section.py @@ -2,7 +2,7 @@ Geometry / Hull Section ======================= -Defines various objects to compute hull sections: +Define various objects to compute hull sections: - :func:`colour.geometry.hull_section` """ @@ -103,7 +103,7 @@ def edges_to_chord(edges: ArrayLike, index: int = 0) -> NDArrayFloat: edges_ordered.append(edge_list.pop(d_1_argmin)) segment = np.array(edges_ordered[-1][0]) - return as_float_array(edges_ordered).reshape([-1, segment.shape[-1]]) + return np.reshape(as_float_array(edges_ordered), (-1, segment.shape[-1])) def close_chord(vertices: ArrayLike) -> NDArrayFloat: @@ -158,9 +158,7 @@ def unique_vertices( Examples -------- - >>> unique_vertices( - ... np.array([[0.0, 0.5, 0.0], [0.0, 0.0, 0.5], [0.0, 0.5, 0.0]]) - ... ) + >>> unique_vertices(np.array([[0.0, 0.5, 0.0], [0.0, 0.0, 0.5], [0.0, 0.5, 0.0]])) array([[ 0. , 0.5, 0. ], [ 0. , 0. , 0.5]]) """ @@ -210,7 +208,6 @@ def hull_section( ... ... hull = trimesh.Trimesh(vertices["position"], faces, process=False) ... hull_section(hull, origin=0) - ... array([[-0. , -0.5, 0. ], [ 0.5, -0.5, 0. ], [ 0.5, 0. , -0. ], @@ -240,17 +237,14 @@ def hull_section( if normalise: vertices = hull.vertices * normal origin = as_float_scalar( - linear_conversion( - origin, [0, 1], [np.min(vertices), np.max(vertices)] - ) + linear_conversion(origin, [0, 1], [np.min(vertices), np.max(vertices)]) ) plane[plane != 0] = origin section = trimesh.intersections.mesh_plane(hull, normal, plane) if len(section) == 0: - raise ValueError( - f'No section exists on "{axis}" axis at {origin} origin!' - ) + raise ValueError(f'No section exists on "{axis}" axis at {origin} origin!') + section = close_chord(unique_vertices(edges_to_chord(section))) return section diff --git a/colour/geometry/tests/test_ellipse.py b/colour/geometry/tests/test_ellipse.py index f588c055e8..222205c988 100644 --- a/colour/geometry/tests/test_ellipse.py +++ b/colour/geometry/tests/test_ellipse.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.geometry.ellipse` module.""" -import unittest import numpy as np @@ -28,7 +26,7 @@ ] -class TestEllipseCoefficientsCanonicalForm(unittest.TestCase): +class TestEllipseCoefficientsCanonicalForm: """ Define :func:`colour.geometry.ellipse.ellipse_coefficients_canonical_form` definition unit tests methods. @@ -57,7 +55,7 @@ def test_ellipse_coefficients_canonical_form(self): ) -class TestEllipseCoefficientsGeneralForm(unittest.TestCase): +class TestEllipseCoefficientsGeneralForm: """ Define :func:`colour.geometry.ellipse.ellipse_coefficients_general_form` definition unit tests methods. @@ -82,7 +80,7 @@ def test_ellipse_coefficients_general_form(self): ) -class TestPointAtAngleOnEllipse(unittest.TestCase): +class TestPointAtAngleOnEllipse: """ Define :func:`colour.geometry.ellipse.point_at_angle_on_ellipse` definition unit tests methods. @@ -124,7 +122,7 @@ def test_point_at_angle_on_ellipse(self): ) -class TestEllipseFittingHalir1998(unittest.TestCase): +class TestEllipseFittingHalir1998: """ Define :func:`colour.geometry.ellipse.ellipse_fitting_Halir1998` definition unit tests methods. @@ -137,9 +135,7 @@ def test_ellipse_fitting_Halir1998(self): """ np.testing.assert_allclose( - ellipse_fitting_Halir1998( - np.array([[2, 0], [0, 1], [-2, 0], [0, -1]]) - ), + ellipse_fitting_Halir1998(np.array([[2, 0], [0, 1], [-2, 0], [0, -1]])), np.array( [ 0.24253563, @@ -152,7 +148,3 @@ def test_ellipse_fitting_Halir1998(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/geometry/tests/test_intersection.py b/colour/geometry/tests/test_intersection.py index 3a3cf7533d..884000ba93 100644 --- a/colour/geometry/tests/test_intersection.py +++ b/colour/geometry/tests/test_intersection.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.geometry.intersection` module.""" -import unittest import numpy as np @@ -24,7 +22,7 @@ ] -class TestExtendLineSegment(unittest.TestCase): +class TestExtendLineSegment: """ Define :func:`colour.geometry.intersection.extend_line_segment` definition unit tests methods. @@ -63,7 +61,7 @@ def test_extend_line_segment(self): ) -class TestIntersectLineSegments(unittest.TestCase): +class TestIntersectLineSegments: """ Define :func:`colour.geometry.intersection.intersect_line_segments` definition unit tests methods. @@ -120,18 +118,10 @@ def test_intersect_line_segments(self): np.testing.assert_array_equal( s.parallel, - np.array( - [[False, False, False, False], [False, False, False, True]] - ), + np.array([[False, False, False, False], [False, False, False, True]]), ) np.testing.assert_array_equal( s.coincident, - np.array( - [[False, False, False, False], [False, False, False, True]] - ), + np.array([[False, False, False, False], [False, False, False, True]]), ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/geometry/tests/test_primitives.py b/colour/geometry/tests/test_primitives.py index 16dcdb23a2..4549085551 100644 --- a/colour/geometry/tests/test_primitives.py +++ b/colour/geometry/tests/test_primitives.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.geometry.primitives` module.""" -import unittest import numpy as np @@ -25,7 +23,7 @@ ] -class TestPrimitiveGrid(unittest.TestCase): +class TestPrimitiveGrid: """ Define :func:`colour.geometry.primitives.primitive_grid` definition unit tests methods. @@ -78,9 +76,7 @@ def test_primitive_grid(self): np.testing.assert_equal(faces, np.array([[0, 2, 1], [2, 3, 1]])) - np.testing.assert_equal( - outline, np.array([[0, 2], [2, 3], [3, 1], [1, 0]]) - ) + np.testing.assert_equal(outline, np.array([[0, 2], [2, 3], [3, 1], [1, 0]])) vertices, faces, outline = primitive_grid( width=0.2, @@ -181,14 +177,12 @@ def test_primitive_grid(self): for plane in MAPPING_PLANE_TO_AXIS: np.testing.assert_allclose( primitive_grid(axis=plane)[0]["position"], - primitive_grid(axis=MAPPING_PLANE_TO_AXIS[plane])[0][ - "position" - ], + primitive_grid(axis=MAPPING_PLANE_TO_AXIS[plane])[0]["position"], atol=TOLERANCE_ABSOLUTE_TESTS, ) -class TestPrimitiveCube(unittest.TestCase): +class TestPrimitiveCube: """ Define :func:`colour.geometry.primitives.primitive_cube` definition unit tests methods. @@ -789,12 +783,6 @@ def test_primitive_cube(self): for plane in MAPPING_PLANE_TO_AXIS: np.testing.assert_allclose( primitive_cube(planes=[plane])[0]["position"], - primitive_cube(planes=[MAPPING_PLANE_TO_AXIS[plane]])[0][ - "position" - ], + primitive_cube(planes=[MAPPING_PLANE_TO_AXIS[plane]])[0]["position"], atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/geometry/tests/test_section.py b/colour/geometry/tests/test_section.py index ccc8d8e2e8..91447adc3b 100644 --- a/colour/geometry/tests/test_section.py +++ b/colour/geometry/tests/test_section.py @@ -1,9 +1,8 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.geometry.section` module.""" -import unittest import numpy as np +import pytest from colour.constants import TOLERANCE_ABSOLUTE_TESTS from colour.geometry import hull_section, primitive_cube @@ -29,7 +28,7 @@ ] -class TestEdgesToChord(unittest.TestCase): +class TestEdgesToChord: """ Define :func:`colour.geometry.section.edges_to_chord` definition unit tests methods. @@ -102,7 +101,7 @@ def test_edges_to_chord(self): ) -class TestCloseChord(unittest.TestCase): +class TestCloseChord: """ Define :func:`colour.geometry.section.close_chord` definition unit tests methods. @@ -118,7 +117,7 @@ def test_close_chord(self): ) -class TestUniqueVertices(unittest.TestCase): +class TestUniqueVertices: """ Define :func:`colour.geometry.section.unique_vertices` definition unit tests methods. @@ -137,9 +136,7 @@ def test_unique_vertices(self): np.testing.assert_allclose( unique_vertices( - np.array( - [[0.0, 0.51, 0.0], [0.0, 0.0, 0.51], [0.0, 0.52, 0.0]] - ), + np.array([[0.0, 0.51, 0.0], [0.0, 0.0, 0.51], [0.0, 0.52, 0.0]]), 1, ), np.array([[0.0, 0.5, 0.0], [0.0, 0.0, 0.5]]), @@ -147,7 +144,7 @@ def test_unique_vertices(self): ) -class TestHullSection(unittest.TestCase): +class TestHullSection: """ Define :func:`colour.geometry.section.hull_section` definition unit tests methods. @@ -237,8 +234,4 @@ def test_hull_section(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertRaises(ValueError, hull_section, hull, origin=-1) - - -if __name__ == "__main__": - unittest.main() + pytest.raises(ValueError, hull_section, hull, origin=-1) diff --git a/colour/geometry/tests/test_vertices.py b/colour/geometry/tests/test_vertices.py index 1984a50c37..4a0096b1ab 100644 --- a/colour/geometry/tests/test_vertices.py +++ b/colour/geometry/tests/test_vertices.py @@ -1,9 +1,8 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.geometry.vertices` module.""" -import unittest import numpy as np +import pytest from colour.constants import TOLERANCE_ABSOLUTE_TESTS from colour.geometry import ( @@ -29,7 +28,7 @@ ] -class TestPrimitiveVerticesQuadMpl(unittest.TestCase): +class TestPrimitiveVerticesQuadMpl: """ Define :func:`colour.geometry.vertices.primitive_vertices_quad_mpl` definition unit tests methods. @@ -104,12 +103,10 @@ def test_primitive_vertices_quad_mpl(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertRaises( - ValueError, lambda: primitive_vertices_quad_mpl(axis="Undefined") - ) + pytest.raises(ValueError, lambda: primitive_vertices_quad_mpl(axis="Undefined")) -class TestPrimitiveVerticesGridMpl(unittest.TestCase): +class TestPrimitiveVerticesGridMpl: """ Define :func:`colour.geometry.vertices.primitive_vertices_grid_mpl` definition unit tests methods. @@ -198,7 +195,7 @@ def test_primitive_vertices_grid_mpl(self): ) -class TestPrimitiveVerticesCubeMpl(unittest.TestCase): +class TestPrimitiveVerticesCubeMpl: """ Define :func:`colour.geometry.vertices.primitive_vertices_cube_mpl` definition unit tests methods. @@ -592,14 +589,12 @@ def test_primitive_vertices_cube_mpl(self): for plane in MAPPING_PLANE_TO_AXIS: np.testing.assert_allclose( primitive_vertices_cube_mpl(planes=[plane]), - primitive_vertices_cube_mpl( - planes=[MAPPING_PLANE_TO_AXIS[plane]] - ), + primitive_vertices_cube_mpl(planes=[MAPPING_PLANE_TO_AXIS[plane]]), atol=TOLERANCE_ABSOLUTE_TESTS, ) -class TestPrimitiveVerticesSphere(unittest.TestCase): +class TestPrimitiveVerticesSphere: """ Define :func:`colour.geometry.vertices.primitive_vertices_sphere` definition unit tests methods. @@ -998,10 +993,4 @@ def test_primitive_vertices_sphere(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertRaises( - ValueError, lambda: primitive_vertices_quad_mpl(axis="Undefined") - ) - - -if __name__ == "__main__": - unittest.main() + pytest.raises(ValueError, lambda: primitive_vertices_quad_mpl(axis="Undefined")) diff --git a/colour/geometry/vertices.py b/colour/geometry/vertices.py index a48dcfd958..389a773a62 100644 --- a/colour/geometry/vertices.py +++ b/colour/geometry/vertices.py @@ -2,7 +2,7 @@ Geometry Primitive Vertices =========================== -Defines various geometry primitive vertices generation methods: +Define various geometry primitive vertices generation methods: - :func:`colour.geometry.primitive_vertices_quad_mpl` - :func:`colour.geometry.primitive_vertices_grid_mpl` @@ -204,10 +204,23 @@ def primitive_vertices_cube_mpl( height_segments: int = 1, depth_segments: int = 1, origin: ArrayLike = np.array([0, 0, 0]), - planes: Literal[ - "-x", "+x", "-y", "+y", "-z", "+z", "xy", "xz", "yz", "yx", "zx", "zy" - ] - | None = None, + planes: ( + Literal[ + "-x", + "+x", + "-y", + "+y", + "-z", + "+z", + "xy", + "xz", + "yz", + "yx", + "zx", + "zy", + ] + | None + ) = None, ) -> NDArrayFloat: """ Return the vertices of a cube primitive made of grid primitives for use @@ -275,9 +288,7 @@ def primitive_vertices_cube_mpl( axis = ( sorted(MAPPING_PLANE_TO_AXIS.values()) if planes is None - else [ - MAPPING_PLANE_TO_AXIS.get(plane, plane).lower() for plane in planes - ] + else [MAPPING_PLANE_TO_AXIS.get(plane, plane).lower() for plane in planes] ) u, v, w = tsplit(origin) @@ -287,9 +298,7 @@ def primitive_vertices_cube_mpl( grids: list = [] if "-z" in axis: grids.extend( - primitive_vertices_grid_mpl( - width, depth, v, w_s, d_s, (u, w), "+z" - ) + primitive_vertices_grid_mpl(width, depth, v, w_s, d_s, (u, w), "+z") ) if "+z" in axis: grids.extend( @@ -300,9 +309,7 @@ def primitive_vertices_cube_mpl( if "-y" in axis: grids.extend( - primitive_vertices_grid_mpl( - width, height, w, w_s, h_s, (u, v), "+y" - ) + primitive_vertices_grid_mpl(width, height, w, w_s, h_s, (u, v), "+y") ) if "+y" in axis: grids.extend( @@ -313,9 +320,7 @@ def primitive_vertices_cube_mpl( if "-x" in axis: grids.extend( - primitive_vertices_grid_mpl( - depth, height, u, d_s, h_s, (w, v), "+x" - ) + primitive_vertices_grid_mpl(depth, height, u, d_s, h_s, (w, v), "+x") ) if "+x" in axis: grids.extend( @@ -464,8 +469,7 @@ def primitive_vertices_sphere( def primitive_vertices( - method: Literal["Cube MPL", "Quad MPL", "Grid MPL", "Sphere"] - | str = "Cube MPL", + method: (Literal["Cube MPL", "Quad MPL", "Grid MPL", "Sphere"] | str) = "Cube MPL", **kwargs: Any, ) -> NDArrayFloat: """ diff --git a/colour/graph/conversion.py b/colour/graph/conversion.py index d499939155..b93182c1dd 100644 --- a/colour/graph/conversion.py +++ b/colour/graph/conversion.py @@ -2,7 +2,7 @@ Automatic Colour Conversion Graph ================================= -Defines the automatic colour conversion graph objects: +Define the automatic colour conversion graph objects: - :func:`colour.describe_conversion_path` - :func:`colour.convert` @@ -11,6 +11,8 @@ from __future__ import annotations import inspect +import re +import sys import textwrap from collections import namedtuple from copy import copy @@ -20,6 +22,7 @@ import numpy as np import colour +import colour.models from colour.appearance import ( CAM16_to_XYZ, CAM_Specification_CAM16, @@ -68,16 +71,18 @@ List, Literal, NDArrayFloat, - Optional, cast, ) from colour.models import ( + COLOURSPACE_MODELS_POLAR_CONVERSIONS, CAM02LCD_to_JMh_CIECAM02, CAM02SCD_to_JMh_CIECAM02, CAM02UCS_to_JMh_CIECAM02, CAM16LCD_to_JMh_CAM16, CAM16SCD_to_JMh_CAM16, CAM16UCS_to_JMh_CAM16, + CIE1960UCS_to_XYZ, + CIE1976UCS_to_XYZ, CMY_to_CMYK, CMY_to_RGB, CMYK_to_CMY, @@ -100,11 +105,7 @@ JMh_CIECAM02_to_CAM02SCD, JMh_CIECAM02_to_CAM02UCS, Jzazbz_to_XYZ, - Lab_to_LCHab, Lab_to_XYZ, - LCHab_to_Lab, - LCHuv_to_Luv, - Luv_to_LCHuv, Luv_to_uv, Luv_to_XYZ, Luv_uv_to_xy, @@ -130,6 +131,8 @@ UCS_to_XYZ, UCS_uv_to_xy, UVW_to_XYZ, + XYZ_to_CIE1960UCS, + XYZ_to_CIE1976UCS, XYZ_to_DIN99, XYZ_to_hdr_CIELab, XYZ_to_hdr_IPT, @@ -223,9 +226,7 @@ class Conversion_Specification( - namedtuple( - "Conversion_Specification", ("source", "target", "conversion_function") - ) + namedtuple("Conversion_Specification", ("source", "target", "conversion_function")) ): """ Conversion specification for *Colour* graph for automatic colour @@ -247,9 +248,7 @@ def __new__(cls, source: str, target: str, conversion_function: Callable): :class:`colour.graph.conversion.Conversion_Specification` class. """ - return super().__new__( - cls, source.lower(), target.lower(), conversion_function - ) + return super().__new__(cls, source.lower(), target.lower(), conversion_function) def CIECAM02_to_JMh_CIECAM02( @@ -667,16 +666,12 @@ def mired_to_CCT_D_uv(mired: ArrayLike) -> NDArrayFloat: ("CIE xy", "CIE XYZ", xy_to_XYZ), ("CIE XYZ", "CIE Lab", XYZ_to_Lab), ("CIE Lab", "CIE XYZ", Lab_to_XYZ), - ("CIE Lab", "CIE LCHab", Lab_to_LCHab), - ("CIE LCHab", "CIE Lab", LCHab_to_Lab), ("CIE XYZ", "CIE Luv", XYZ_to_Luv), ("CIE Luv", "CIE XYZ", Luv_to_XYZ), ("CIE Luv", "CIE Luv uv", Luv_to_uv), ("CIE Luv uv", "CIE Luv", uv_to_Luv), ("CIE Luv uv", "CIE xy", Luv_uv_to_xy), ("CIE xy", "CIE Luv uv", xy_to_Luv_uv), - ("CIE Luv", "CIE LCHuv", Luv_to_LCHuv), - ("CIE LCHuv", "CIE Luv", LCHuv_to_Luv), ("CIE XYZ", "CIE UCS", XYZ_to_UCS), ("CIE UCS", "CIE XYZ", UCS_to_XYZ), ("CIE UCS", "CIE UCS uv", UCS_to_uv), @@ -694,9 +689,9 @@ def mired_to_CCT_D_uv(mired: ArrayLike) -> NDArrayFloat: "Hunter Lab", partial( XYZ_to_Hunter_Lab, - XYZ_n=TVS_ILLUMINANTS_HUNTERLAB[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"].XYZ_n + XYZ_n=TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ + "D65" + ].XYZ_n / 100, ), ), @@ -705,9 +700,9 @@ def mired_to_CCT_D_uv(mired: ArrayLike) -> NDArrayFloat: "CIE XYZ", partial( Hunter_Lab_to_XYZ, - XYZ_n=TVS_ILLUMINANTS_HUNTERLAB[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"].XYZ_n + XYZ_n=TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ + "D65" + ].XYZ_n / 100, ), ), @@ -716,9 +711,9 @@ def mired_to_CCT_D_uv(mired: ArrayLike) -> NDArrayFloat: "Hunter Rdab", partial( XYZ_to_Hunter_Rdab, - XYZ_n=TVS_ILLUMINANTS_HUNTERLAB[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"].XYZ_n + XYZ_n=TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ + "D65" + ].XYZ_n / 100, ), ), @@ -727,9 +722,9 @@ def mired_to_CCT_D_uv(mired: ArrayLike) -> NDArrayFloat: "CIE XYZ", partial( Hunter_Rdab_to_XYZ, - XYZ_n=TVS_ILLUMINANTS_HUNTERLAB[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"].XYZ_n + XYZ_n=TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ + "D65" + ].XYZ_n / 100, ), ), @@ -755,6 +750,12 @@ def mired_to_CCT_D_uv(mired: ArrayLike) -> NDArrayFloat: ("ProLab", "CIE XYZ", ProLab_to_XYZ), ("CIE XYZ", "Yrg", XYZ_to_Yrg), ("Yrg", "CIE XYZ", Yrg_to_XYZ), + ("CIE 1931", "CIE XYZ", xyY_to_XYZ), + ("CIE XYZ", "CIE 1931", XYZ_to_xyY), + ("CIE 1960 UCS", "CIE XYZ", CIE1960UCS_to_XYZ), + ("CIE XYZ", "CIE 1960 UCS", XYZ_to_CIE1960UCS), + ("CIE 1976 UCS", "CIE XYZ", CIE1976UCS_to_XYZ), + ("CIE XYZ", "CIE 1976 UCS", XYZ_to_CIE1976UCS), # RGB Colour Models ( "CIE XYZ", @@ -912,9 +913,7 @@ def mired_to_CCT_D_uv(mired: ArrayLike) -> NDArrayFloat: ( "CIE XYZ", "LLAB", - partial( - XYZ_to_LLAB, XYZ_0=_TVS_ILLUMINANT_DEFAULT, Y_b=80 * 0.2, L=80 - ), + partial(XYZ_to_LLAB, XYZ_0=_TVS_ILLUMINANT_DEFAULT, Y_b=80 * 0.2, L=80), ), ( "CIE XYZ", @@ -970,6 +969,41 @@ def mired_to_CCT_D_uv(mired: ArrayLike) -> NDArrayFloat: the edge in the graph. """ + +# Programmatically defining the colourspace models polar conversions. + + +def _format_node_name(name): + """Format given name by applying a series of substitutions.""" + + for pattern, substitution in [ + ("hdr_", "hdr-"), + ("-CIELab", "-CIELAB"), + ("_", " "), + ("^Lab", "CIE Lab"), + ("^LCHab", "CIE LCHab"), + ("^Luv", "CIE Luv"), + ("^LCHuv", "CIE LCHuv"), + ("Ragoo2021", "Ragoo 2021"), + ]: + name = re.sub(pattern, substitution, name) + + return name + + +for _Jab, _JCh in COLOURSPACE_MODELS_POLAR_CONVERSIONS: + _module = sys.modules["colour.models"] + _Jab_name = _format_node_name(_Jab) + _JCh_name = _format_node_name(_JCh) + CONVERSION_SPECIFICATIONS_DATA.append( + (_Jab_name, _JCh_name, getattr(_module, f"{_Jab}_to_{_JCh}")) + ) + CONVERSION_SPECIFICATIONS_DATA.append( + (_JCh_name, _Jab_name, getattr(_module, f"{_JCh}_to_{_Jab}")) + ) + +del _format_node_name, _JCh, _Jab, _module, _Jab_name, _JCh_name + CONVERSION_SPECIFICATIONS: list = [ Conversion_Specification(*specification) for specification in CONVERSION_SPECIFICATIONS_DATA @@ -1018,9 +1052,7 @@ def _build_graph() -> networkx.DiGraph: # pyright: ignore # noqa: F821 return graph -CONVERSION_GRAPH: ( - Optional[nx.DiGraph] # pyright: ignore # noqa: F821, UP007 -) = None +CONVERSION_GRAPH: nx.DiGraph | None = None # pyright: ignore # noqa: F821 """Automatic colour conversion graph.""" @@ -1040,7 +1072,7 @@ def _conversion_path(source: str, target: str) -> List[Callable]: Returns ------- :class:`list` - Conversion path from the source node to the target node, i.e. a list of + Conversion path from the source node to the target node, i.e., a list of conversion function callables. Examples @@ -1062,16 +1094,14 @@ def _conversion_path(source: str, target: str) -> List[Callable]: path = nx.shortest_path(cast(nx.DiGraph, CONVERSION_GRAPH), source, target) return [ - CONVERSION_GRAPH.get_edge_data(a, b)[ # pyright: ignore - "conversion_function" - ] + CONVERSION_GRAPH.get_edge_data(a, b)["conversion_function"] # pyright: ignore for a, b in zip(path[:-1], path[1:]) ] def _lower_order_function(callable_: Callable) -> Callable: """ - Return the lower order function associated with given callable, i.e. + Return the lower order function associated with given callable, i.e., the function wrapped by a partial object. Parameters @@ -1105,10 +1135,10 @@ def describe_conversion_path( Parameters ---------- source - Source colour representation, i.e. the source node in the automatic + Source colour representation, i.e., the source node in the automatic colour conversion graph. target - Target colour representation, i.e. the target node in the automatic + Target colour representation, i.e., the target node in the automatic colour conversion graph. mode Verbose mode: *Short* describes the conversion path, *Long* provides @@ -1170,9 +1200,7 @@ def describe_conversion_path( ) for conversion_function in conversion_path: - conversion_function_name = _lower_order_function( - conversion_function - ).__name__ + conversion_function_name = _lower_order_function(conversion_function).__name__ # Filtering compatible keyword arguments passed directly and # irrespective of any conversion function name. @@ -1186,9 +1214,7 @@ def describe_conversion_path( if mode in ("long", "extended"): signature = pformat( - signature_inspection( - _lower_order_function(conversion_function) - ) + signature_inspection(_lower_order_function(conversion_function)) ) message = ( f'[ "{_lower_order_function(conversion_function).__name__}" ]\n\n' @@ -1197,9 +1223,7 @@ def describe_conversion_path( ) if filtered_kwargs: - message += ( - f"\n\n[ Filtered Arguments ]\n\n{pformat(filtered_kwargs)}" - ) + message += f"\n\n[ Filtered Arguments ]\n\n{pformat(filtered_kwargs)}" if mode in ("extended",): docstring = textwrap.dedent( @@ -1246,10 +1270,10 @@ def convert(a: Any, source: str, target: str, **kwargs: Any) -> Any: viewed under *CIE Standard Illuminant D Series* *D65*. The illuminant can be changed on a per-definition basis along the conversion path. source - Source colour representation, i.e. the source node in the automatic + Source colour representation, i.e., the source node in the automatic colour conversion graph. target - Target colour representation, i.e. the target node in the automatic + Target colour representation, i.e., the target node in the automatic colour conversion graph. Other Parameters @@ -1330,9 +1354,9 @@ def convert(a: Any, source: str, target: str, **kwargs: Any) -> Any: Notes ----- - The **RGB** colour representation is assumed to be linear and - representing *scene-referred* imagery, i.e. **Scene-Referred RGB** + representing *scene-referred* imagery, i.e., **Scene-Referred RGB** representation. To encode such *RGB* values as *output-referred* - (*display-referred*) imagery, i.e. encode the *RGB* values using an + (*display-referred*) imagery, i.e., encode the *RGB* values using an encoding colour component transfer function (Encoding CCTF) / opto-electronic transfer function (OETF), the **Output-Referred RGB** representation must be used:: @@ -1360,7 +1384,7 @@ def convert(a: Any, source: str, target: str, **kwargs: Any) -> Any: Thus, decoding and encoding using the sRGB electro-optical transfer function (EOTF) and its inverse will be applied by default. - Most of the colour appearance models have defaults set according to - *IEC 61966-2-1:1999* viewing conditions, i.e. *sRGB* 64 Lux ambient + *IEC 61966-2-1:1999* viewing conditions, i.e., *sRGB* 64 Lux ambient illumination, 80 :math:`cd/m^2`, adapting field luminance about 20% of a white object in the scene. @@ -1417,9 +1441,7 @@ def convert(a: Any, source: str, target: str, **kwargs: Any) -> Any: verbose_kwargs = copy(kwargs) for conversion_function in conversion_path: - conversion_function_name = _lower_order_function( - conversion_function - ).__name__ + conversion_function_name = _lower_order_function(conversion_function).__name__ # Filtering compatible keyword arguments passed directly and # irrespective of any conversion function name. diff --git a/colour/graph/tests/test_conversion.py b/colour/graph/tests/test_conversion.py index fec2d7fde4..652316b3c1 100644 --- a/colour/graph/tests/test_conversion.py +++ b/colour/graph/tests/test_conversion.py @@ -1,9 +1,8 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.graph.conversion` module.""" -import unittest import numpy as np +import pytest from colour.characterisation import SDS_COLOURCHECKERS from colour.colorimetry import CCS_ILLUMINANTS, SDS_ILLUMINANTS @@ -24,7 +23,7 @@ ] -class TestDescribeConversionPath(unittest.TestCase): +class TestDescribeConversionPath: """ Define :func:`colour.graph.conversion.describe_conversion_path` definition unit tests methods. @@ -51,7 +50,7 @@ def test_describe_conversion_path(self): ) -class TestConvert(unittest.TestCase): +class TestConvert: """ Define :func:`colour.graph.conversion.convert` definition unit tests methods. @@ -60,7 +59,6 @@ class TestConvert(unittest.TestCase): def test_convert(self): """Test :func:`colour.graph.conversion.convert` definition.""" - # NOTE: Reduced precision for random unit tests failure. RGB_a = convert( SDS_COLOURCHECKERS["ColorChecker N Ohta"]["dark skin"], "Spectral Distribution", @@ -69,20 +67,17 @@ def test_convert(self): np.testing.assert_allclose( RGB_a, np.array([0.49034776, 0.30185875, 0.23587685]), - atol=5e-5, + atol=TOLERANCE_ABSOLUTE_TESTS, ) - # NOTE: Reduced precision for random unit tests failure. Jpapbp = convert(RGB_a, "Output-Referred RGB", "CAM16UCS") np.testing.assert_allclose( Jpapbp, np.array([0.40738741, 0.12046560, 0.09284385]), - atol=5e-4, + atol=TOLERANCE_ABSOLUTE_TESTS, ) - RGB_b = convert( - Jpapbp, "CAM16UCS", "sRGB", verbose={"mode": "Extended"} - ) + RGB_b = convert(Jpapbp, "CAM16UCS", "sRGB", verbose={"mode": "Extended"}) # NOTE: The "CIE XYZ" tristimulus values to "sRGB" matrix is given # rounded at 4 decimals as per "IEC 61966-2-1:1999" and thus preventing # exact roundtrip. @@ -114,7 +109,6 @@ def test_convert(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - # NOTE: Reduced precision for random unit tests failure. np.testing.assert_allclose( convert( RGB_a, @@ -123,7 +117,7 @@ def test_convert(self): RGB_to_RGB={"output_colourspace": RGB_COLOURSPACE_ACES2065_1}, ), np.array([0.37308227, 0.31241444, 0.24746366]), - atol=5e-5, + atol=TOLERANCE_ABSOLUTE_TESTS, ) # Consistency check to verify that all the colour models are properly @@ -142,13 +136,9 @@ def test_convert_direct_keyword_argument_passing(self): """ a = np.array([0.20654008, 0.12197225, 0.05136952]) - illuminant = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ - "D50" - ] + illuminant = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D50"] np.testing.assert_allclose( - convert( - a, "CIE XYZ", "CIE UVW", XYZ_to_UVW={"illuminant": illuminant} - ), + convert(a, "CIE XYZ", "CIE UVW", XYZ_to_UVW={"illuminant": illuminant}), convert(a, "CIE XYZ", "CIE UVW", illuminant=illuminant), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -156,7 +146,7 @@ def test_convert_direct_keyword_argument_passing(self): # Illuminant "ndarray" is converted to tuple here so that it can # be hashed by the "sd_to_XYZ" definition, this should never occur # in practical application. - self.assertRaises( + pytest.raises( AttributeError, lambda: convert( SDS_COLOURCHECKERS["ColorChecker N Ohta"]["dark skin"], @@ -165,7 +155,3 @@ def test_convert_direct_keyword_argument_passing(self): illuminant=tuple(illuminant), ), ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/hints/__init__.py b/colour/hints/__init__.py index 6736620c75..d4b7aaca74 100644 --- a/colour/hints/__init__.py +++ b/colour/hints/__init__.py @@ -2,7 +2,7 @@ Annotation Type Hints ===================== -Defines the annotation type hints, the module exposes many aliases from +Define the annotation type hints, the module exposes many aliases from :mod:`typing` and :mod:`numpy.typing` to avoid having to handle multiple imports. """ @@ -23,6 +23,7 @@ NewType, Optional, Protocol, + Set, SupportsIndex, TYPE_CHECKING, TextIO, @@ -63,6 +64,7 @@ "Optional", "Protocol", "Sequence", + "Set", "SupportsIndex", "TYPE_CHECKING", "TextIO", @@ -143,7 +145,7 @@ NDArrayStr = NDArray[np.str_] -class ProtocolInterpolator(Protocol): # noqa: D101 +class ProtocolInterpolator(Protocol): # noqa: D101 # pragma: no cover @property def x(self) -> NDArray: # noqa: D102 ... @@ -167,7 +169,7 @@ def __call__(self, x: ArrayLike) -> NDArray: # noqa: D102 ... # pragma: no cover -class ProtocolExtrapolator(Protocol): # noqa: D101 +class ProtocolExtrapolator(Protocol): # noqa: D101 # pragma: no cover @property def interpolator(self) -> ProtocolInterpolator: # noqa: D102 ... @@ -184,14 +186,12 @@ def __call__(self, x: ArrayLike) -> NDArray: # noqa: D102 @runtime_checkable -class ProtocolLUTSequenceItem(Protocol): # noqa: D101 +class ProtocolLUTSequenceItem(Protocol): # noqa: D101 # pragma: no cover def apply(self, RGB: ArrayLike, **kwargs: Any) -> NDArray: # noqa: D102 ... # pragma: no cover -LiteralWarning = Literal[ - "default", "error", "ignore", "always", "module", "once" -] +LiteralWarning = Literal["default", "error", "ignore", "always", "module", "once"] # NOTE: The following literals are automatically generated by the *invoke* # *literalise* task. Please do not edit this section manually! @@ -218,6 +218,9 @@ def apply(self, RGB: ArrayLike, **kwargs: Any) -> NDArray: # noqa: D102 "CAM16LCD", "CAM16SCD", "CAM16UCS", + "CIE 1931", + "CIE 1960 UCS", + "CIE 1976 UCS", "CIE Lab", "CIE Luv", "CIE UCS", @@ -252,7 +255,6 @@ def apply(self, RGB: ArrayLike, **kwargs: Any) -> NDArray: # noqa: D102 "ACEScct", "ACEScg", "ACESproxy", - "ALEXA Wide Gamut", "ARRI Wide Gamut 3", "ARRI Wide Gamut 4", "Adobe RGB (1998)", diff --git a/colour/io/__init__.py b/colour/io/__init__.py index e98a5be1ac..ce26ff650c 100644 --- a/colour/io/__init__.py +++ b/colour/io/__init__.py @@ -1,11 +1,31 @@ +import sys + +from colour.utilities.deprecation import ModuleAPI, build_API_changes +from colour.utilities.documentation import is_documentation_building + +from colour.hints import Any + from .luts import * # noqa: F403 from . import luts -from .image import ImageAttribute_Specification, convert_bit_depth +from .image import ( + Image_Specification_Attribute, + MAPPING_BIT_DEPTH, + image_specification_OpenImageIO, + convert_bit_depth, +) from .image import read_image_OpenImageIO, write_image_OpenImageIO from .image import read_image_Imageio, write_image_Imageio from .image import READ_IMAGE_METHODS, WRITE_IMAGE_METHODS from .image import read_image, write_image from .image import as_3_channels_image +from .fichet2021 import ( + ComponentsFichet2021, + sd_to_spectrum_attribute_Fichet2021, + spectrum_attribute_to_sd_Fichet2021, + Specification_Fichet2021, + read_spectral_image_Fichet2021, + write_spectral_image_Fichet2021, +) from .ctl import ( ctl_render, process_image_ctl, @@ -28,7 +48,9 @@ __all__ = [] __all__ += luts.__all__ __all__ += [ - "ImageAttribute_Specification", + "Image_Specification_Attribute", + "MAPPING_BIT_DEPTH", + "image_specification_OpenImageIO", "convert_bit_depth", ] __all__ += [ @@ -56,6 +78,14 @@ __all__ += [ "as_3_channels_image", ] +__all__ += [ + "ComponentsFichet2021", + "sd_to_spectrum_attribute_Fichet2021", + "spectrum_attribute_to_sd_Fichet2021", + "Specification_Fichet2021", + "read_spectral_image_Fichet2021", + "write_spectral_image_Fichet2021", +] __all__ += [ "process_image_OpenColorIO", ] @@ -75,3 +105,35 @@ __all__ += [ "read_sds_from_xrite_file", ] + + +# ----------------------------------------------------------------------------# +# --- API Changes and Deprecation Management ---# +# ----------------------------------------------------------------------------# +class io(ModuleAPI): + """Define a class acting like the *io* module.""" + + def __getattr__(self, attribute) -> Any: + """Return the value from the attribute with given name.""" + + return super().__getattr__(attribute) + + +# v0.4.5 +API_CHANGES = { + "ObjectRenamed": [ + [ + "colour.io.ImageAttribute_Specification", + "colour.io.Image_Specification_Attribute", + ], + ] +} + +"""Defines the *colour.io* sub-package API changes.""" + +if not is_documentation_building(): + sys.modules["colour.io"] = io( # pyright: ignore + sys.modules["colour.io"], build_API_changes(API_CHANGES) + ) + + del ModuleAPI, is_documentation_building, build_API_changes, sys diff --git a/colour/io/ctl.py b/colour/io/ctl.py index 9ecb7002cd..628610b9d7 100644 --- a/colour/io/ctl.py +++ b/colour/io/ctl.py @@ -2,7 +2,7 @@ CTL Processing ============== -Defines the object for the *Color Transformation Language* (CTL) processing: +Define the object for the *Color Transformation Language* (CTL) processing: - :func:`colour.io.ctl_render` - :func:`colour.io.process_image_ctl` @@ -16,6 +16,7 @@ import subprocess import tempfile import textwrap +from pathlib import Path import numpy as np @@ -67,8 +68,8 @@ @required("ctlrender") def ctl_render( - path_input: str, - path_output: str, + path_input: str | Path, + path_output: str | Path, ctl_transforms: Sequence[str] | Dict[str, Sequence[str]], *args: Any, **kwargs: Any, @@ -91,9 +92,9 @@ def ctl_render( Other Parameters ---------------- args - Arguments passed to *ctlrender*, e.g. ``-verbose``, ``-force``. + Arguments passed to *ctlrender*, e.g., ``-verbose``, ``-force``. kwargs - Keywords arguments passed to the sub-process calling *ctlrender*, e.g. + Keywords arguments passed to the sub-process calling *ctlrender*, e.g., to define the environment variables such as ``CTL_MODULE_PATH``. Notes @@ -149,6 +150,9 @@ def ctl_render( """ + path_input = str(path_input) + path_output = str(path_output) + if len(args) == 0: args = ARGUMENTS_CTL_RENDER_DEFAULTS @@ -171,9 +175,7 @@ def ctl_render( ctl_transform = temp_filename # noqa: PLW2901 temp_filenames.append(temp_filename) elif not os.path.exists(ctl_transform): - raise FileNotFoundError( - f'{ctl_transform} "CTL" transform does not exist!' - ) + raise FileNotFoundError(f'{ctl_transform} "CTL" transform does not exist!') command.extend(["-ctl", ctl_transform]) for parameter in parameters: @@ -185,7 +187,9 @@ def ctl_render( command += arg.split() completed_process = subprocess.run( - command, check=False, **kwargs # noqa: S603 + command, # noqa: S603 + check=False, + **kwargs, ) for temp_filename in temp_filenames: @@ -217,9 +221,9 @@ def process_image_ctl( Other Parameters ---------------- args - Arguments passed to *ctlrender*, e.g. ``-verbose``, ``-force``. + Arguments passed to *ctlrender*, e.g., ``-verbose``, ``-force``. kwargs - Keywords arguments passed to the sub-process calling *ctlrender*, e.g. + Keywords arguments passed to the sub-process calling *ctlrender*, e.g., to define the environment variables such as ``CTL_MODULE_PATH``. Notes @@ -365,7 +369,6 @@ def template_ctl_transform_float( } >>> def format_imports(imports): ... return [f'import "{i}";' for i in imports] - ... >>> print( ... template_ctl_transform_float( ... "Y_2_linCV(rIn, CINEMA_WHITE, CINEMA_BLACK)", @@ -488,7 +491,6 @@ def template_ctl_transform_float3( -------- >>> def format_imports(imports): ... return [f'import "{i}";' for i in imports] - ... >>> print( ... template_ctl_transform_float3( ... "darkSurround_to_dimSurround(rgbIn)", @@ -579,8 +581,6 @@ def template_ctl_transform_float3( bOut = rgbOut[2]; aOut = aIn; }} -""".strip().format( - RGB_function=RGB_function - ) +""".strip().format(RGB_function=RGB_function) return ctl_file_content diff --git a/colour/io/fichet2021.py b/colour/io/fichet2021.py new file mode 100644 index 0000000000..6400990886 --- /dev/null +++ b/colour/io/fichet2021.py @@ -0,0 +1,841 @@ +""" +OpenEXR Layout for Spectral Images - Fichet, Pacanowski and Wilkie (2021) +========================================================================= + +Define the *Fichet et al. (2021)* spectral image input / output objects. + +References +---------- +- :cite:`Fichet2021` : Fichet, A., Pacanowski, R., & Wilkie, A. (2021). An + OpenEXR Layout for Spectral Images. 10(3). Retrieved April 26, 2024, from + http://jcgt.org/published/0010/03/01/ +""" + +from __future__ import annotations + +import re +from collections import defaultdict +from dataclasses import dataclass, field +from pathlib import Path + +import numpy as np + +from colour.colorimetry import ( + MSDS_CMFS, + SDS_ILLUMINANTS, + MultiSpectralDistributions, + SpectralDistribution, + SpectralShape, + msds_to_XYZ, + sds_and_msds_to_msds, +) +from colour.constants import CONSTANT_LIGHT_SPEED +from colour.hints import ( + Callable, + Dict, + List, + Literal, + NDArrayFloat, + Sequence, + Tuple, + Union, +) +from colour.io.image import ( + MAPPING_BIT_DEPTH, + Image_Specification_Attribute, + add_attributes_to_image_specification_OpenImageIO, +) +from colour.models import RGB_COLOURSPACE_sRGB, XYZ_to_RGB +from colour.utilities import ( + as_float_array, + interval, + required, + usage_warning, + validate_method, +) + +__author__ = "Colour Developers" +__copyright__ = "Copyright 2013 Colour Developers" +__license__ = "BSD-3-Clause - https://opensource.org/licenses/BSD-3-Clause" +__maintainer__ = "Colour Developers" +__email__ = "colour-developers@colour-science.org" +__status__ = "Production" + +__all__ = [ + "MAPPING_UNIT_CONVERSION", + "PATTERN_FICHET2021", + "ComponentsFichet2021", + "match_groups_to_nm", + "sd_to_spectrum_attribute_Fichet2021", + "spectrum_attribute_to_sd_Fichet2021", + "Specification_Fichet2021", + "read_spectral_image_Fichet2021", + "sds_and_msds_to_components_Fichet2021", + "components_to_sRGB_Fichet2021", + "write_spectral_image_Fichet2021", +] + +MAPPING_UNIT_CONVERSION: dict = { + "Y": 1e24, + "Z": 1e21, + "E": 1e18, + "P": 1e15, + "T": 1e12, + "G": 1e9, + "M": 1e6, + "k": 1e3, + "h": 1e2, + "da": 1e1, + "": 1, + "d": 1e-1, + "c": 1e-2, + "m": 1e-3, + "u": 1e-6, + "n": 1e-9, + "p": 1e-12, +} +""" +Unit conversion mapping. + +References +---------- +:cite:`Fichet2021` +""" + +PATTERN_FICHET2021: str = ( + r"(\d*,?\d*([eE][-+]?\d+)?)(Y|Z|E|P|T|G|M|k|h|da|d|c|m|u|n|p|f|a|z|y)?(m|Hz)" +) +""" +Regex pattern for numbers and quantities. + +References +---------- +:cite:`Fichet2021` +""" + + +ComponentsFichet2021 = Dict[Union[str, float], Tuple[NDArrayFloat, NDArrayFloat]] + + +def match_groups_to_nm( + number: str, + multiplier: Literal[ + "Y", + "Z", + "E", + "P", + "T", + "G", + "M", + "k", + "h", + "da", + "", + "d", + "c", + "m", + "u", + "n", + "p", + ] + | str, + units: Literal["m", "Hz"] | str, +) -> float: + """ + Convert match groups of a wavelength (or frequency) to the nanometer value. + + Parameters + ---------- + number + Wavelength (or frequency) number to convert. + multiplier + Unit multiplier. + units + Frequency or wavelength. + + Returns + ------- + :class:`float` + Nanometer value. + + Examples + -------- + >>> match_groups_to_nm("555.5", "n", "m") + 555.5 + >>> match_groups_to_nm("555.5", "", "m") + 555500000000.0 + >>> from colour.constants import CONSTANT_LIGHT_SPEED + >>> match_groups_to_nm(str(CONSTANT_LIGHT_SPEED / (555 * 1e-9)), "", "Hz") + ... # doctest: +ELLIPSIS + 555.0000000... + """ + + multiplier = validate_method( + multiplier, tuple(MAPPING_UNIT_CONVERSION), as_lowercase=False + ) + units = validate_method(units, ("m", "Hz"), as_lowercase=False) + + v = float(number.replace(",", ".")) + + if multiplier == "n" and units == "m": + return v + + v *= MAPPING_UNIT_CONVERSION[multiplier] + + if units == "m": + v *= 1e9 + elif units == "Hz": + v = CONSTANT_LIGHT_SPEED / v * 1e9 + + return v + + +def sd_to_spectrum_attribute_Fichet2021( + sd: SpectralDistribution, decimals: int = 7 +) -> str: + """ + Convert a spectral distribution to a spectrum attribute value according to + *Fichet et al. (2021)*. + + Parameters + ---------- + sd + Spectral distribution to convert. + decimals + Formatting decimals. + + Returns + ------- + :class:`str` + Spectrum attribute value. + + References + ---------- + :cite:`Fichet2021` + + Examples + -------- + >>> sd_to_spectrum_attribute_Fichet2021(SDS_ILLUMINANTS["D65"], 2)[:56] + '300.00nm:0.03;305.00nm:1.66;310.00nm:3.29;315.00nm:11.77' + """ + + return ";".join( + f"{wavelength:.{decimals}f}nm:{value:.{decimals}f}" + for wavelength, value in zip(sd.wavelengths, sd.values) + ) + + +def spectrum_attribute_to_sd_Fichet2021( + spectrum_attribute: str, +) -> SpectralDistribution: + """ + Convert a spectrum attribute value to a spectral distribution according to + *Fichet et al. (2021)*. + + Parameters + ---------- + spectrum_attribute + Spectrum attribute value to convert. + + Returns + ------- + :class:`SpectralDistribution` + Spectral distribution. + + References + ---------- + :cite:`Fichet2021` + + Examples + -------- + >>> spectrum_attribute_to_sd_Fichet2021( + ... "300.00nm:0.03;305.00nm:1.66;310.00nm:3.29;315.00nm:11.77" + ... ) # doctest: +SKIP + SpectralDistribution([[ 3.0000000...e+02, 3.0000000...e-02], + [ 3.0500000...e+02, 1.6600000...e+00], + [ 3.1000000...e+02, 3.2900000...e+00], + [ 3.1500000...e+02, 1.1770000...e+01]], + SpragueInterpolator, + {}, + Extrapolator, + {'method': 'Constant', 'left': None, 'right': None}) + """ + + data = {} + pattern = re.compile(PATTERN_FICHET2021) + parts = spectrum_attribute.split(";") + for part in parts: + domain, range_ = part.split(":") + match = pattern.match(domain.replace(".", ",")) + if match is not None: + multiplier, units = match.group(3, 4) + wavelength = match_groups_to_nm(match.group(1), multiplier, units) + data[wavelength] = float(range_) + + return SpectralDistribution(data) + + +@dataclass +class Specification_Fichet2021: + """ + Define the *Fichet et al. (2021)* spectral image specification. + + Parameters + ---------- + path + Path of the spectral image. + components + Components of the spectral image, e.g., *S0*, *S1*, *S2*, *S3*, *T*, or + any wavelength number for bi-spectral images. + is_emissive + Whether the image is emissive, i.e, using the *S0* component. + is_polarised + Whether the image is polarised, i.e, using the *S0*, *S1*, *S2*, and + *S3* components. + is_bispectral + Whether the image is bi-spectral, i.e, using the *T*, and any + wavelength number. + attributes + An array of :class:`colour.io.Image_Specification_Attribute` class + instances used to set attributes of the image. + + Methods + ------- + - :meth:`~colour.Specification_Fichet2021.from_spectral_image` + + References + ---------- + :cite:`Fichet2021` + """ # noqa: D405, D407, D410, D411 + + path: str | None = field(default_factory=lambda: None) + components: defaultdict = field(default_factory=lambda: defaultdict(dict)) + is_emissive: bool = field(default_factory=lambda: False) + is_polarised: bool = field(default_factory=lambda: False) + is_bispectral: bool = field(default_factory=lambda: False) + attributes: List | None = field(default_factory=lambda: None) + + @staticmethod + @required("OpenImageIO") + def from_spectral_image(path: str | Path) -> Specification_Fichet2021: + """ + Create a *Fichet et al. (2021)* spectral image specification from given + image path. + + Parameters + ---------- + path + Image path + + Returns + ------- + :class:`Specification_Fichet2021` + *Fichet et al. (2021)* spectral image specification. + + Examples + -------- + >>> import os + >>> import colour + >>> path = os.path.join( + ... colour.__path__[0], + ... "io", + ... "tests", + ... "resources", + ... "D65.exr", + ... ) + >>> specification = Specification_Fichet2021.from_spectral_image(path) + ... # doctest: +SKIP + >>> specification.is_emissive # doctest: +SKIP + True + """ + + from OpenImageIO import ImageInput # pyright: ignore + + path = str(path) + + components = defaultdict(dict) + is_emissive = False + is_polarised = False + is_bispectral = False + + pattern_emissive = re.compile(rf"^(S[0-3])\.*{PATTERN_FICHET2021}$") + pattern_reflective = re.compile(rf"^T\.*{PATTERN_FICHET2021}$") + pattern_bispectral = re.compile( + rf"^T\.*{PATTERN_FICHET2021}\.*{PATTERN_FICHET2021}$" + ) + + image_specification = ImageInput.open(path).spec() + channels = image_specification.channelnames + + for i, channel in enumerate(channels): + match = pattern_emissive.match(channel) + if match: + is_emissive = True + + component = match.group(1) + multiplier, units = match.group(4, 5) + wavelength = match_groups_to_nm(match.group(2), multiplier, units) + components[component][wavelength] = i + + if len(components) > 1: + is_polarised = True + + match = pattern_bispectral.match(channel) + if match: + is_bispectral = True + + input_multiplier, input_units = match.group(3, 4) + input_wavelength = match_groups_to_nm( + match.group(1), input_multiplier, input_units + ) + output_multiplier, output_units = match.group(7, 8) + output_wavelength = match_groups_to_nm( + match.group(5), output_multiplier, output_units + ) + components[input_wavelength][output_wavelength] = i + + match = pattern_reflective.match(channel) + if match: + multiplier, units = match.group(3, 4) + wavelength = match_groups_to_nm(match.group(1), multiplier, units) + components["T"][wavelength] = i + + attributes = [] + for attribute in image_specification.extra_attribs: + attributes.append( + Image_Specification_Attribute( + attribute.name, attribute.value, attribute.type + ) + ) + + return Specification_Fichet2021( + path, + components, + is_emissive, + is_polarised, + is_bispectral, + attributes, + ) + + +@required("OpenImageIO") +def read_spectral_image_Fichet2021( + path: str | Path, + bit_depth: Literal["float16", "float32"] = "float32", + additional_data: bool = False, +) -> ComponentsFichet2021 | Tuple[ComponentsFichet2021, Specification_Fichet2021]: + """ + Read the *Fichet et al. (2021)* spectral image at given path using + *OpenImageIO*. + + Parameters + ---------- + path + Image path. + bit_depth + Returned image bit-depth. + additional_data + Whether to return additional data. + + Returns + ------- + :class:`dict` or :class:`tuple` + Dictionary of component names and their corresponding tuple of + wavelengths and values or tuple of the aforementioned dictionary and + :class:`colour.Specification_Fichet2021` class instance. + + Notes + ----- + - Spectrum attributes are not parsed but can be converted to spectral + distribution using the :func:`colour.io.spectrum_attribute_to_sd_Fichet2021` + definition. + + References + ---------- + :cite:`Fichet2021` + + Examples + -------- + >>> import os + >>> import colour + >>> path = os.path.join( + ... colour.__path__[0], + ... "io", + ... "tests", + ... "resources", + ... "D65.exr", + ... ) + >>> msds, specification = read_spectral_image_Fichet2021( + ... path, additional_data=True + ... ) # doctest: +SKIP + >>> components.keys() # doctest: +SKIP + dict_keys(['S0']) + >>> components["S0"][0].shape # doctest: +SKIP + (97,) + >>> components["S0"][1].shape # doctest: +SKIP + (1, 1, 97) + >>> specification.is_emissive # doctest: +SKIP + True + """ + + from OpenImageIO import ImageInput # pyright: ignore + + path = str(path) + + bit_depth_specification = MAPPING_BIT_DEPTH[bit_depth] + + specification = Specification_Fichet2021.from_spectral_image(path) + image = ImageInput.open(path).read_image(bit_depth_specification.openimageio) + + components = {} + for component, wavelengths_indexes in specification.components.items(): + wavelengths, indexes = zip(*wavelengths_indexes.items()) + values = as_float_array( + image[:, :, indexes], + dtype=bit_depth_specification.numpy, + ) + components[component] = ( + as_float_array(wavelengths), + np.array(values, dtype=bit_depth_specification.numpy), + ) + + if additional_data: + return components, specification + else: + return components + + +def sds_and_msds_to_components_Fichet2021( + sds: Sequence[SpectralDistribution | MultiSpectralDistributions] + | SpectralDistribution + | MultiSpectralDistributions, + specification: Specification_Fichet2021 = Specification_Fichet2021(), + **kwargs, +) -> ComponentsFichet2021: + """ + Convert given spectral and multi-spectral distributions to + *Fichet et al. (2021)* components. + + The spectral and multi-spectral distributions will be aligned to the + intersection of their spectral shapes. + + Parameters + ---------- + sds + Spectral and multi-spectral distributions to convert to + *Fichet et al. (2021)* components. + specification + *Fichet et al. (2021)* spectral image specification, used to generate + the proper component type, i.e., emissive or other. + + Other Parameters + ---------------- + shape + Optional shape the *Fichet et al. (2021)* components should take: Used + when converting spectral distributions of a colour + rendition chart to create a rectangular image rather than a single + line of values. + + Returns + ------- + :class:`dict` + Dictionary of component names and their corresponding tuple of + wavelengths and values. + + References + ---------- + :cite:`Fichet2021` + + Examples + -------- + >>> components = sds_and_msds_to_components_Fichet2021(SDS_ILLUMINANTS["D65"]) + >>> components.keys() + dict_keys(['T']) + >>> components = sds_and_msds_to_components_Fichet2021( + ... SDS_ILLUMINANTS["D65"], Specification_Fichet2021(is_emissive=True) + ... ) + >>> components.keys() + dict_keys(['S0']) + >>> components["S0"][0].shape + (97,) + >>> components["S0"][1].shape + (1, 1, 97) + """ + + msds = sds_and_msds_to_msds(sds) + component = "S0" if specification.is_emissive else "T" + + wavelengths = msds.wavelengths + values = np.transpose(msds.values) + values = np.reshape(values, (1, -1, values.shape[-1])) + + if "shape" in kwargs: + values = np.reshape(values, kwargs["shape"]) + + return {component: (wavelengths, values)} + + +@required("OpenImageIO") +def components_to_sRGB_Fichet2021( + components: ComponentsFichet2021, + specification: Specification_Fichet2021 = Specification_Fichet2021(), +) -> Tuple[NDArrayFloat | None, Sequence[Image_Specification_Attribute]]: + """ + Convert given *Fichet et al. (2021)* components to *sRGB* colourspace values. + + Parameters + ---------- + components + *Fichet et al. (2021)* components to convert. + specification + *Fichet et al. (2021)* spectral image specification, used to perform + the proper conversion to *sRGB* colourspace values. + + Returns + ------- + :class:`tuple` + Tuple of *sRGB* colourspace values and list of + :class:`colour.io.Image_Specification_Attribute` class instances. + + Warnings + -------- + - This definition currently assumes a uniform wavelength interval. + - This definition currently does not support integration of bi-spectral + component. + + Notes + ----- + - When an emissive component is given, its exposure will be normalised so + that its median is 0.18. + + References + ---------- + :cite:`Fichet2021` + + Examples + -------- + >>> specification = Specification_Fichet2021(is_emissive=True) + >>> components = sds_and_msds_to_components_Fichet2021( + ... SDS_ILLUMINANTS["D65"], + ... specification, + ... ) + >>> RGB, attributes = components_to_sRGB_Fichet2021( + ... components["S0"], specification + ... ) # doctest: +SKIP + >>> RGB # doctest: +SKIP + array([[[ 0.1799829..., 0.1800080..., 0.1800090...]]]) + >>> for attribute in attributes: + ... print(attribute.name) # doctest: +SKIP + X + Y + Z + illuminant + chromaticities + EV + """ + + from OpenImageIO import TypeDesc # pyright: ignore + + component = components.get("S0", components.get("T")) + + if component is None: + return None, [] + + # TODO: Implement support for integration of bi-spectral component. + if specification.is_bispectral: + usage_warning( + "Bi-spectral components conversion to *sRGB* colourspace values " + "is unsupported!" + ) + + # TODO: Implement support for re-binning component with non-uniform interval. + if len(interval(component[0])) != 1: + usage_warning( + "Components have a non-uniform interval, unexpected results might occur!" + ) + + msds = component[1] + shape = SpectralShape(component[0][0], component[0][-1], interval(component[0])[0]) + + cmfs = MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] + colourspace = RGB_COLOURSPACE_sRGB + + if specification.is_emissive: + illuminant = SDS_ILLUMINANTS["E"] + + XYZ = msds_to_XYZ(msds, cmfs=cmfs, method="Integration", shape=shape) + else: + illuminant = SDS_ILLUMINANTS["D65"] + + XYZ = ( + msds_to_XYZ( + msds, + cmfs=cmfs, + illuminant=illuminant, + method="Integration", + shape=shape, + ) + / 100 + ) + + RGB = XYZ_to_RGB(XYZ, colourspace) + + chromaticities = np.ravel( + np.vstack([colourspace.primaries, colourspace.whitepoint]) + ).tolist() + + attributes = [ + Image_Specification_Attribute( + "X", sd_to_spectrum_attribute_Fichet2021(cmfs.signals["x_bar"]) + ), + Image_Specification_Attribute( + "Y", sd_to_spectrum_attribute_Fichet2021(cmfs.signals["y_bar"]) + ), + Image_Specification_Attribute( + "Z", sd_to_spectrum_attribute_Fichet2021(cmfs.signals["z_bar"]) + ), + Image_Specification_Attribute( + "illuminant", sd_to_spectrum_attribute_Fichet2021(illuminant) + ), + Image_Specification_Attribute( + "chromaticities", chromaticities, TypeDesc("float[8]") + ), + ] + + if specification.is_emissive: + EV = np.mean(RGB) / 0.18 + RGB /= EV + attributes.append( + Image_Specification_Attribute("EV", np.log2(EV)), + ) + + return RGB, attributes + + +@required("OpenImageIO") +def write_spectral_image_Fichet2021( + components: Sequence[SpectralDistribution | MultiSpectralDistributions] + | SpectralDistribution + | MultiSpectralDistributions + | ComponentsFichet2021, + path: str | Path, + bit_depth: Literal["float16", "float32"] = "float32", + specification: Specification_Fichet2021 = Specification_Fichet2021(), + components_to_RGB_callable: Callable = components_to_sRGB_Fichet2021, + **kwargs, +): + """ + Write given *Fichet et al. (2021)* components to given path using *OpenImageIO*. + + Parameters + ---------- + components + *Fichet et al. (2021)* components. + path + Image path. + bit_depth + Bit-depth to write the image at, the bit-depth conversion behaviour is + ruled directly by *OpenImageIO*. + specification + *Fichet et al. (2021)* spectral image specification. + components_to_RGB_callable + Callable converting the components to a preview *RGB* image. + + Other Parameters + ---------------- + shape + Optional shape the *Fichet et al. (2021)* components should take: Used + when converting spectral distributions of a colour + rendition chart to create a rectangular image rather than a single + line of values. + + Returns + ------- + :class:`bool`: + Definition success. + + Examples + -------- + >>> import os + >>> import colour + >>> path = os.path.join( + ... colour.__path__[0], + ... "io", + ... "tests", + ... "resources", + ... "BabelColorAverage.exr", + ... ) + >>> msds = list(colour.SDS_COLOURCHECKERS["BabelColor Average"].values()) + >>> specification = Specification_Fichet2021(is_emissive=False) + >>> write_spectral_image_Fichet2021( + ... msds, + ... path, + ... "float16", + ... specification, + ... shape=(4, 6, len(msds[0].shape.wavelengths)), + ... ) # doctest: +SKIP + True + """ + + from OpenImageIO import ImageBuf, ImageBufAlgo # pyright: ignore + + path = str(path) + + if isinstance( + components, (Sequence, SpectralDistribution, MultiSpectralDistributions) + ): + components = sds_and_msds_to_components_Fichet2021( + components, specification, **kwargs + ) + + if specification.attributes is None: + specification.attributes = [ + Image_Specification_Attribute("spectralLayoutVersion", "1.0") + ] + + if specification.is_emissive: + specification.attributes.extend( + [ + Image_Specification_Attribute("polarisationHandedness", "right"), + Image_Specification_Attribute("emissiveUnits", "W.m^-2.sr^-1"), + ] + ) + + bit_depth_specification = MAPPING_BIT_DEPTH[bit_depth] + + channels = {} + + RGB, attributes = components_to_RGB_callable(components, specification) + if RGB is not None: + channels.update({"R": RGB[..., 0], "G": RGB[..., 1], "B": RGB[..., 2]}) + + for component, wavelengths_values in components.items(): + wavelengths, values = wavelengths_values + for i, wavelength in enumerate(wavelengths): + component_type = str(component)[0] + if component_type == "S": # Emissive Component Type # noqa: SIM114 + channel_name = f'{component}.{str(wavelength).replace(".", ",")}nm' + elif component_type == "T": # Reflectance et al. Component Type + channel_name = f'{component}.{str(wavelength).replace(".", ",")}nm' + else: # Bi-spectral Component Type + channel_name = ( + f'T.{str(component).replace(".", ",")}nm.' + f'{str(wavelength).replace(".", ",")}nm' + ) + + channels[channel_name] = values[..., i] + + image_buffer = ImageBuf() + for channel_name, channel_data in channels.items(): + channel_buffer = ImageBuf(channel_data.astype(bit_depth_specification.numpy)) + channel_specification = channel_buffer.specmod() + channel_specification.channelnames = [channel_name] + image_buffer = ImageBufAlgo.channel_append(image_buffer, channel_buffer) + + add_attributes_to_image_specification_OpenImageIO( + image_buffer.specmod(), [*specification.attributes, *attributes] + ) + + image_buffer.write(path) + + return True diff --git a/colour/io/image.py b/colour/io/image.py index 92e642a527..0e787c6c2f 100644 --- a/colour/io/image.py +++ b/colour/io/image.py @@ -2,12 +2,13 @@ Image Input / Output Utilities ============================== -Defines the image related input / output utilities objects. +Define the image related input / output utilities objects. """ from __future__ import annotations from dataclasses import dataclass, field +from pathlib import Path import numpy as np @@ -38,6 +39,7 @@ usage_warning, validate_method, ) +from colour.utilities.deprecation import handle_arguments_deprecation __author__ = "Colour Developers" __copyright__ = "Copyright 2013 Colour Developers" @@ -47,8 +49,11 @@ __status__ = "Production" __all__ = [ - "BitDepth_Specification", - "ImageAttribute_Specification", + "Image_Specification_BitDepth", + "Image_Specification_Attribute", + "MAPPING_BIT_DEPTH", + "add_attributes_to_image_specification_OpenImageIO", + "image_specification_OpenImageIO", "convert_bit_depth", "read_image_OpenImageIO", "read_image_Imageio", @@ -63,7 +68,7 @@ @dataclass(frozen=True) -class BitDepth_Specification: +class Image_Specification_BitDepth: """ Define a bit-depth specification. @@ -83,7 +88,7 @@ class BitDepth_Specification: @dataclass -class ImageAttribute_Specification: +class Image_Specification_Attribute: """ Define an image specification attribute. @@ -107,37 +112,149 @@ class ImageAttribute_Specification: if is_openimageio_installed(): # pragma: no cover - from OpenImageIO import DOUBLE, FLOAT, HALF, UINT8, UINT16 + from OpenImageIO import ImageSpec # pyright: ignore + from OpenImageIO import DOUBLE, FLOAT, HALF, UINT8, UINT16 # pyright: ignore MAPPING_BIT_DEPTH: CanonicalMapping = CanonicalMapping( { - "uint8": BitDepth_Specification("uint8", np.uint8, UINT8), - "uint16": BitDepth_Specification("uint16", np.uint16, UINT16), - "float16": BitDepth_Specification("float16", np.float16, HALF), - "float32": BitDepth_Specification("float32", np.float32, FLOAT), - "float64": BitDepth_Specification("float64", np.float64, DOUBLE), + "uint8": Image_Specification_BitDepth("uint8", np.uint8, UINT8), + "uint16": Image_Specification_BitDepth("uint16", np.uint16, UINT16), + "float16": Image_Specification_BitDepth("float16", np.float16, HALF), + "float32": Image_Specification_BitDepth("float32", np.float32, FLOAT), + "float64": Image_Specification_BitDepth("float64", np.float64, DOUBLE), } ) if not TYPE_CHECKING and hasattr(np, "float128"): # pragma: no cover - MAPPING_BIT_DEPTH["float128"] = BitDepth_Specification( + MAPPING_BIT_DEPTH["float128"] = Image_Specification_BitDepth( "float128", np.float128, DOUBLE ) else: # pragma: no cover + # + class ImageSpec: + attribute: Any + MAPPING_BIT_DEPTH: CanonicalMapping = CanonicalMapping( { - "uint8": BitDepth_Specification("uint8", np.uint8, None), - "uint16": BitDepth_Specification("uint16", np.uint16, None), - "float16": BitDepth_Specification("float16", np.float16, None), - "float32": BitDepth_Specification("float32", np.float32, None), - "float64": BitDepth_Specification("float64", np.float64, None), + "uint8": Image_Specification_BitDepth("uint8", np.uint8, None), + "uint16": Image_Specification_BitDepth("uint16", np.uint16, None), + "float16": Image_Specification_BitDepth("float16", np.float16, None), + "float32": Image_Specification_BitDepth("float32", np.float32, None), + "float64": Image_Specification_BitDepth("float64", np.float64, None), } ) if not TYPE_CHECKING and hasattr(np, "float128"): # pragma: no cover - MAPPING_BIT_DEPTH["float128"] = BitDepth_Specification( + MAPPING_BIT_DEPTH["float128"] = Image_Specification_BitDepth( "float128", np.float128, None ) +def add_attributes_to_image_specification_OpenImageIO( + image_specification: ImageSpec, attributes: Sequence +): + """ + Add given attributes to given *OpenImageIO* image specification. + + Parameters + ---------- + image_specification + *OpenImageIO* image specification. + attributes + An array of :class:`colour.io.Image_Specification_Attribute` class + instances used to set attributes of the image. + + Returns + ------- + :class:`ImageSpec` + *OpenImageIO*. image specification. + + Examples + -------- + >>> image_specification = image_specification_OpenImageIO( + ... 1920, 1080, 3, "float16" + ... ) # doctest: +SKIP + >>> compression = Image_Specification_Attribute("Compression", "none") + >>> image_specification = add_attributes_to_image_specification_OpenImageIO( + ... image_specification, [compression] + ... ) # doctest: +SKIP + >>> image_specification.extra_attribs[0].value # doctest: +SKIP + 'none' + """ # noqa: D405, D407, D410, D411 + + for attribute in attributes: + name = str(attribute.name) + value = ( + str(attribute.value) + if isinstance(attribute.value, str) + else attribute.value + ) + type_ = attribute.type_ + if attribute.type_ is None: + image_specification.attribute(name, value) + else: + image_specification.attribute(name, type_, value) + + return image_specification + + +@required("OpenImageIO") +def image_specification_OpenImageIO( + width: int, + height: int, + channels: int, + bit_depth: Literal[ + "uint8", "uint16", "float16", "float32", "float64", "float128" + ] = "float32", + attributes: Sequence | None = None, +) -> ImageSpec: + """ + Create an *OpenImageIO* image specification. + + Parameters + ---------- + width + Image width. + height + Image height. + channels + Image channel count. + bit_depth + Bit-depth to create the image with, the bit-depth conversion behaviour is + ruled directly by *OpenImageIO*. + attributes + An array of :class:`colour.io.Image_Specification_Attribute` class + instances used to set attributes of the image. + + Returns + ------- + :class:`ImageSpec` + *OpenImageIO*. image specification. + + Examples + -------- + >>> compression = Image_Specification_Attribute("Compression", "none") + >>> image_specification_OpenImageIO( + ... 1920, 1080, 3, "float16", [compression] + ... ) # doctest: +SKIP + + """ # noqa: D405, D407, D410, D411 + + from OpenImageIO import ImageSpec # pyright: ignore + + attributes = cast(list, optional(attributes, [])) + + bit_depth_specification = MAPPING_BIT_DEPTH[bit_depth] + + image_specification = ImageSpec( + width, height, channels, bit_depth_specification.openimageio + ) + + add_attributes_to_image_specification_OpenImageIO( + image_specification, attributes or [] + ) + + return image_specification + + def convert_bit_depth( a: ArrayLike, bit_depth: Literal[ @@ -195,7 +312,7 @@ def convert_bit_depth( if source_dtype == "uint8": if bit_depth == "uint16": - a = (a * 257).astype(target_dtype) + a = a.astype(target_dtype) * 257 elif bit_depth in ("float16", "float32", "float64", "float128"): a = (a / 255).astype(target_dtype) elif source_dtype == "uint16": @@ -216,11 +333,12 @@ def convert_bit_depth( @required("OpenImageIO") def read_image_OpenImageIO( - path: str, + path: str | Path, bit_depth: Literal[ "uint8", "uint16", "float16", "float32", "float64", "float128" ] = "float32", - attributes: bool = False, + additional_data: bool = False, + **kwargs: Any, ) -> NDArrayReal | Tuple[NDArrayReal, list]: """ Read the image data at given path using *OpenImageIO*. @@ -233,14 +351,14 @@ def read_image_OpenImageIO( Returned image bit-depth, the bit-depth conversion behaviour is driven directly by *OpenImageIO*, this definition only converts to the relevant data type after reading. - attributes - Whether to return the image attributes. + additional_data + Whether to return additional data. Returns ------- :class`numpy.ndarray` or :class:`tuple` Image data or tuple of image data and list of - :class:`colour.io.ImageAttribute_Specification` class instances. + :class:`colour.io.Image_Specification_Attribute` class instances. Notes ----- @@ -258,34 +376,43 @@ def read_image_OpenImageIO( ... "CMS_Test_Pattern.exr", ... ) >>> image = read_image_OpenImageIO(path) # doctest: +SKIP - """ # noqa: D405, D407, D410, D411 + """ - from OpenImageIO import ImageInput + from OpenImageIO import ImageInput # pyright: ignore path = str(path) + kwargs = handle_arguments_deprecation( + { + "ArgumentRenamed": [["attributes", "additional_data"]], + }, + **kwargs, + ) + + additional_data = kwargs.get("additional_data", additional_data) + bit_depth_specification = MAPPING_BIT_DEPTH[bit_depth] image_input = ImageInput.open(path) - specification = image_input.spec() + image_specification = image_input.spec() shape = ( - specification.height, - specification.width, - specification.nchannels, + image_specification.height, + image_specification.width, + image_specification.nchannels, ) image = image_input.read_image(bit_depth_specification.openimageio) image_input.close() - image = np.array(image, dtype=bit_depth_specification.numpy).reshape(shape) + image = np.reshape(np.array(image, dtype=bit_depth_specification.numpy), shape) image = cast(NDArrayReal, np.squeeze(image)) - if attributes: + if additional_data: extra_attributes = [] - for attribute in specification.extra_attribs: + for attribute in image_specification.extra_attribs: extra_attributes.append( - ImageAttribute_Specification( + Image_Specification_Attribute( attribute.name, attribute.value, attribute.type ) ) @@ -296,7 +423,7 @@ def read_image_OpenImageIO( def read_image_Imageio( - path: str, + path: str | Path, bit_depth: Literal[ "uint8", "uint16", "float16", "float32", "float64", "float128" ] = "float32", @@ -346,7 +473,9 @@ def read_image_Imageio( dtype('float32') """ - from imageio import imread + from imageio.v2 import imread + + path = str(path) image = np.squeeze(imread(path, **kwargs)) @@ -365,7 +494,7 @@ def read_image_Imageio( def read_image( - path: str, + path: str | Path, bit_depth: Literal[ "uint8", "uint16", "float16", "float32", "float64", "float128" ] = "float32", @@ -386,13 +515,13 @@ def read_image( conversion behaviour is driven directly by the library, this definition only converts to the relevant data type after reading. method - Read method, i.e. the image library used for reading images. + Read method, i.e., the image library used for reading images. Other Parameters ---------------- - attributes + additional_data {:func:`colour.io.read_image_OpenImageIO`}, - Whether to return the image attributes. + Whether to return additional data. Returns ------- @@ -423,13 +552,11 @@ def read_image( (1267, 1274, 3) >>> image.dtype dtype('float32') - """ # noqa: D405, D407, D410, D411, D414 + """ method = validate_method(method, tuple(READ_IMAGE_METHODS)) - if ( - method == "openimageio" and not is_openimageio_installed() - ): # pragma: no cover + if method == "openimageio" and not is_openimageio_installed(): # pragma: no cover usage_warning( '"OpenImageIO" related API features are not available, ' 'switching to "Imageio"!' @@ -447,7 +574,7 @@ def read_image( @required("OpenImageIO") def write_image_OpenImageIO( image: ArrayLike, - path: str, + path: str | Path, bit_depth: Literal[ "uint8", "uint16", "float16", "float32", "float64", "float128" ] = "float32", @@ -466,7 +593,7 @@ def write_image_OpenImageIO( Bit-depth to write the image at, the bit-depth conversion behaviour is ruled directly by *OpenImageIO*. attributes - An array of :class:`colour.io.ImageAttribute_Specification` class + An array of :class:`colour.io.Image_Specification_Attribute` class instances used to set attributes of the image. Returns @@ -500,7 +627,7 @@ def write_image_OpenImageIO( Advanced image writing while setting attributes: - >>> compression = ImageAttribute_Specification("Compression", "none") + >>> compression = Image_Specification_Attribute("Compression", "none") >>> write_image_OpenImageIO(image, path, "uint8", [compression]) ... # doctest: +SKIP True @@ -521,17 +648,16 @@ def write_image_OpenImageIO( ... 0.33767, ... ) ... attributes = [ - ... ImageAttribute_Specification("acesImageContainerFlag", True), - ... ImageAttribute_Specification( + ... Image_Specification_Attribute("acesImageContainerFlag", True), + ... Image_Specification_Attribute( ... "chromaticities", chromaticities, TypeDesc("float[8]") ... ), - ... ImageAttribute_Specification("compression", "none"), + ... Image_Specification_Attribute("compression", "none"), ... ] ... write_image_OpenImageIO(image, path, attributes=attributes) - ... """ # noqa: D405, D407, D410, D411 - from OpenImageIO import ImageOutput, ImageSpec + from OpenImageIO import ImageOutput # pyright: ignore image = as_float_array(image) path = str(path) @@ -557,25 +683,13 @@ def write_image_OpenImageIO( else: height, width, channels = image.shape - specification = ImageSpec( - width, height, channels, bit_depth_specification.openimageio + image_specification = image_specification_OpenImageIO( + width, height, channels, bit_depth, attributes ) - for attribute in attributes: - name = str(attribute.name) - value = ( - str(attribute.value) - if isinstance(attribute.value, str) - else attribute.value - ) - type_ = attribute.type_ - if attribute.type_ is None: - specification.attribute(name, value) - else: - specification.attribute(name, type_, value) image_output = ImageOutput.create(path) - image_output.open(path, specification) + image_output.open(path, image_specification) image_output.write_image(image) image_output.close() @@ -585,7 +699,7 @@ def write_image_OpenImageIO( def write_image_Imageio( image: ArrayLike, - path: str, + path: str | Path, bit_depth: Literal[ "uint8", "uint16", "float16", "float32", "float64", "float128" ] = "float32", @@ -646,7 +760,9 @@ def write_image_Imageio( True """ - from imageio import imwrite + from imageio.v2 import imwrite + + path = str(path) if all( [ @@ -676,7 +792,7 @@ def write_image_Imageio( def write_image( image: ArrayLike, - path: str, + path: str | Path, bit_depth: Literal[ "uint8", "uint16", "float16", "float32", "float64", "float128" ] = "float32", @@ -697,13 +813,13 @@ def write_image( data is converted with :func:`colour.io.convert_bit_depth` definition prior to writing the image. method - Write method, i.e. the image library used for writing images. + Write method, i.e., the image library used for writing images. Other Parameters ---------------- attributes {:func:`colour.io.write_image_OpenImageIO`}, - An array of :class:`colour.io.ImageAttribute_Specification` class + An array of :class:`colour.io.Image_Specification_Attribute` class instances used to set attributes of the image. Returns @@ -749,7 +865,7 @@ def write_image( Advanced image writing while setting attributes using *OpenImageIO*: - >>> compression = ImageAttribute_Specification("Compression", "none") + >>> compression = Image_Specification_Attribute("Compression", "none") >>> write_image(image, path, bit_depth="uint8", attributes=[compression]) ... # doctest: +SKIP True @@ -757,9 +873,7 @@ def write_image( method = validate_method(method, tuple(WRITE_IMAGE_METHODS)) - if ( - method == "openimageio" and not is_openimageio_installed() - ): # pragma: no cover + if method == "openimageio" and not is_openimageio_installed(): # pragma: no cover usage_warning( '"OpenImageIO" related API features are not available, ' 'switching to "Imageio"!' @@ -800,14 +914,25 @@ def as_3_channels_image(a: ArrayLike) -> NDArrayFloat: array([[[ 0.18, 0.18, 0.18]]]) >>> as_3_channels_image([[[0.18, 0.18, 0.18]]]) array([[[ 0.18, 0.18, 0.18]]]) + >>> as_3_channels_image([[[[0.18, 0.18, 0.18]]]]) + array([[[ 0.18, 0.18, 0.18]]]) """ - a = as_float_array(a) + a = np.squeeze(as_float_array(a)) - if len(a.shape) == 0: - a = tstack([a, a, a]) + if len(a.shape) > 3: + raise ValueError( + "Array has more than 3-dimensions and cannot be converted to a " + "3-channels image-like representation!" + ) + + if len(a.shape) > 0 and a.shape[-1] not in (1, 3): + raise ValueError( + "Array has more than 1 or 3 channels and cannot be converted to a " + "3-channels image-like representation!" + ) - if a.shape[-1] == 1: + if len(a.shape) == 0 or a.shape[-1] == 1: a = tstack([a, a, a]) if len(a.shape) == 1: diff --git a/colour/io/luts/__init__.py b/colour/io/luts/__init__.py index 30ff2737ce..5b09e748a2 100644 --- a/colour/io/luts/__init__.py +++ b/colour/io/luts/__init__.py @@ -14,6 +14,7 @@ from __future__ import annotations import os +from pathlib import Path from colour.hints import Any, LiteralLUTReadMethod, LiteralLUTWriteMethod from colour.utilities import ( @@ -101,7 +102,7 @@ def read_LUT( - path: str, + path: str | Path, method: LiteralLUTReadMethod | str | None = None, **kwargs: Any, ) -> LUT1D | LUT3x1D | LUT3D | LUTSequence | LUTOperatorMatrix: @@ -207,6 +208,8 @@ def read_LUT( Offset : [ 0. 0. 0. 0.] """ + path = str(path) + method = ( MAPPING_EXTENSION_TO_LUT_FORMAT[os.path.splitext(path)[-1]].lower() if method is None @@ -248,7 +251,7 @@ def read_LUT( def write_LUT( LUT: LUT1D | LUT3x1D | LUT3D | LUTSequence | LUTOperatorMatrix, - path: str, + path: str | Path, decimals: int = 7, method: LiteralLUTWriteMethod | str | None = None, **kwargs: Any, @@ -318,6 +321,8 @@ def write_LUT( >>> write_LUT(LUT, "My_LUT.cube") # doctest: +SKIP """ + path = str(path) + method = ( MAPPING_EXTENSION_TO_LUT_FORMAT[os.path.splitext(path)[-1]].lower() if method is None diff --git a/colour/io/luts/cinespace_csp.py b/colour/io/luts/cinespace_csp.py index d64d327e00..ddaa76e6a7 100644 --- a/colour/io/luts/cinespace_csp.py +++ b/colour/io/luts/cinespace_csp.py @@ -2,7 +2,7 @@ Cinespace .csp LUT Format Input / Output Utilities ================================================== -Defines the *Cinespace* *.csp* *LUT* format related input / output utilities +Define the *Cinespace* *.csp* *LUT* format related input / output utilities objects: - :func:`colour.io.read_LUT_Cinespace` @@ -17,6 +17,8 @@ from __future__ import annotations +from pathlib import Path + import numpy as np from colour.hints import ArrayLike, List, NDArrayFloat @@ -43,7 +45,7 @@ ] -def read_LUT_Cinespace(path: str) -> LUT3x1D | LUT3D | LUTSequence: +def read_LUT_Cinespace(path: str | Path) -> LUT3x1D | LUT3D | LUTSequence: """ Read given *Cinespace* *.csp* *LUT* file. @@ -114,9 +116,7 @@ def _parse_domain_section(lines: List[str]) -> NDArrayFloat: """Parse the domain at given lines.""" pre_LUT_size = max(int(lines[i]) for i in [0, 3, 6]) - pre_LUT = [ - as_float_array(lines[i].split()) for i in [1, 2, 4, 5, 7, 8] - ] + pre_LUT = [as_float_array(lines[i].split()) for i in [1, 2, 4, 5, 7, 8]] pre_LUT_padded = [] for array in pre_LUT: @@ -184,11 +184,9 @@ def _parse_table_section(lines): if ( is_3D and pre_LUT.shape == (6, 2) - and np.array_equal( - np.transpose(np.reshape(pre_LUT, (3, 4)))[2:4], unity_range - ) + and np.array_equal(np.transpose(np.reshape(pre_LUT, (3, 4)))[2:4], unity_range) ): - table = table.reshape([size[0], size[1], size[2], 3], order="F") + table = np.reshape(table, (size[0], size[1], size[2], 3), order="F") LUT = LUT3D( domain=np.transpose(np.reshape(pre_LUT, (3, 4)))[0:2], name=title, @@ -199,12 +197,10 @@ def _parse_table_section(lines): elif ( not is_3D and pre_LUT.shape == (6, 2) - and np.array_equal( - np.transpose(np.reshape(pre_LUT, (3, 4)))[2:4], unity_range - ) + and np.array_equal(np.transpose(np.reshape(pre_LUT, (3, 4)))[2:4], unity_range) ): LUT = LUT3x1D( - domain=pre_LUT.reshape([3, 4]).transpose()[0:2], + domain=np.reshape(pre_LUT, (3, 4)).transpose()[0:2], name=title, comments=comments, table=table, @@ -215,7 +211,7 @@ def _parse_table_section(lines): pre_table = tstack((pre_LUT[1], pre_LUT[3], pre_LUT[5])) shaper_name = f"{title} - Shaper" cube_name = f"{title} - Cube" - table = table.reshape([size[0], size[1], size[2], 3], order="F") + table = np.reshape(table, (size[0], size[1], size[2], 3), order="F") LUT = LUTSequence( LUT3x1D(pre_table, shaper_name, pre_domain), @@ -246,7 +242,7 @@ def _parse_table_section(lines): def write_LUT_Cinespace( - LUT: LUT3x1D | LUT3D | LUTSequence, path: str, decimals: int = 7 + LUT: LUT3x1D | LUT3D | LUTSequence, path: str | Path, decimals: int = 7 ) -> bool: """ Write given *LUT* to given *Cinespace* *.csp* *LUT* file. @@ -296,6 +292,8 @@ def write_LUT_Cinespace( >>> write_LUT_Cinespace(LUT, "My_LUT.cube") # doctest: +SKIP """ + path = str(path) + has_3D, has_3x1D = False, False if isinstance(LUT, LUTSequence): @@ -305,9 +303,7 @@ def write_LUT_Cinespace( and isinstance(LUT[1], LUT3D), '"LUTSequence" must be "1D + 3D" or "3x1D + 3D"!', ) - LUT[0] = ( - LUT[0].convert(LUT3x1D) if isinstance(LUT[0], LUT1D) else LUT[0] - ) + LUT[0] = LUT[0].convert(LUT3x1D) if isinstance(LUT[0], LUT1D) else LUT[0] name = f"{LUT[0].name} - {LUT[1].name}" has_3x1D = True has_3D = True @@ -336,9 +332,7 @@ def write_LUT_Cinespace( "Shaper size must be in domain [2, 65536]!", ) if has_3D: - attest( - 2 <= LUT[1].size <= 256, "Cube size must be in domain [2, 256]!" - ) + attest(2 <= LUT[1].size <= 256, "Cube size must be in domain [2, 256]!") def _ragged_size(table: ArrayLike) -> list: """Return the ragged size of given table.""" @@ -395,17 +389,13 @@ def _ragged_size(table: ArrayLike) -> list: ) ) - csp_file.write( - f"{format_array_as_row(entry, decimals)} " - ) + csp_file.write(f"{format_array_as_row(entry, decimals)} ") csp_file.write("\n") for j in range(size): entry = LUT[0].table[j][i] - csp_file.write( - f"{format_array_as_row(entry, decimals)} " - ) + csp_file.write(f"{format_array_as_row(entry, decimals)} ") csp_file.write("\n") else: @@ -415,16 +405,14 @@ def _ragged_size(table: ArrayLike) -> list: [LUT[1].domain[0][i], LUT[1].domain[1][i]], decimals ) csp_file.write(f"{domain}\n") - csp_file.write( - f"{format_array_as_row([0, 1], decimals)}\n" - ) + csp_file.write(f"{format_array_as_row([0, 1], decimals)}\n") csp_file.write( f"\n{LUT[1].table.shape[0]} " f"{LUT[1].table.shape[1]} " f"{LUT[1].table.shape[2]}\n" ) - table = LUT[1].table.reshape([-1, 3], order="F") + table = np.reshape(LUT[1].table, (-1, 3), order="F") for array in table: csp_file.write(f"{format_array_as_row(array, decimals)}\n") diff --git a/colour/io/luts/common.py b/colour/io/luts/common.py index 8053bb3054..8832f45626 100644 --- a/colour/io/luts/common.py +++ b/colour/io/luts/common.py @@ -2,7 +2,7 @@ LUT Processing Common Utilities =============================== -Defines the *LUT* processing common utilities objects that don't fall in any +Define the *LUT* processing common utilities objects that don't fall in any specific category. """ @@ -10,6 +10,7 @@ import os import re +from pathlib import Path __author__ = "Colour Developers" __copyright__ = "Copyright 2013 Colour Developers" @@ -23,7 +24,7 @@ ] -def path_to_title(path: str) -> str: +def path_to_title(path: str | Path) -> str: """ Convert given file path to title. @@ -39,10 +40,10 @@ def path_to_title(path: str) -> str: Examples -------- - >>> path_to_title( - ... "colour/io/luts/tests/resources/sony_spi3d/Colour_Correct.spi3d" - ... ) + >>> path_to_title("colour/io/luts/tests/resources/sony_spi3d/Colour_Correct.spi3d") 'Colour Correct' """ + path = str(path) + return re.sub("_|-|\\.", " ", os.path.splitext(os.path.basename(path))[0]) diff --git a/colour/io/luts/iridas_cube.py b/colour/io/luts/iridas_cube.py index 27a7f4bedc..eec9f4c8ca 100644 --- a/colour/io/luts/iridas_cube.py +++ b/colour/io/luts/iridas_cube.py @@ -2,7 +2,7 @@ Iridas .cube LUT Format Input / Output Utilities ================================================ -Defines the *Iridas* *.cube* *LUT* format related input / output utilities +Define the *Iridas* *.cube* *LUT* format related input / output utilities objects: - :func:`colour.io.read_LUT_IridasCube` @@ -16,6 +16,8 @@ from __future__ import annotations +from pathlib import Path + import numpy as np from colour.io.luts import LUT1D, LUT3D, LUT3x1D, LUTSequence @@ -41,7 +43,7 @@ ] -def read_LUT_IridasCube(path: str) -> LUT3x1D | LUT3D: +def read_LUT_IridasCube(path: str | Path) -> LUT3x1D | LUT3D: """ Read given *Iridas* *.cube* *LUT* file. @@ -118,6 +120,8 @@ def read_LUT_IridasCube(path: str) -> LUT3x1D | LUT3D: Comment 01 : Comments can go anywhere """ + path = str(path) + title = path_to_title(path) domain_min, domain_max = np.array([0, 0, 0]), np.array([1, 1, 1]) dimensions: int = 3 @@ -167,7 +171,7 @@ def read_LUT_IridasCube(path: str) -> LUT3x1D | LUT3D: # The lines of table data shall be in ascending index order, # with the first component index (Red) changing most rapidly, # and the last component index (Blue) changing least rapidly. - table = table.reshape([size, size, size, 3], order="F") + table = np.reshape(table, (size, size, size, 3), order="F") LUT = LUT3D( table, @@ -180,7 +184,7 @@ def read_LUT_IridasCube(path: str) -> LUT3x1D | LUT3D: def write_LUT_IridasCube( - LUT: LUT3x1D | LUT3D | LUTSequence, path: str, decimals: int = 7 + LUT: LUT3x1D | LUT3D | LUTSequence, path: str | Path, decimals: int = 7 ) -> bool: """ Write given *LUT* to given *Iridas* *.cube* *LUT* file. @@ -235,6 +239,8 @@ def write_LUT_IridasCube( >>> write_LUT_IridasCube(LUTxD, "My_LUT.cube") # doctest: +SKIP """ + path = str(path) + if isinstance(LUT, LUTSequence): usage_warning( f'"LUT" is a "LUTSequence" instance was passed, ' @@ -282,9 +288,7 @@ def write_LUT_IridasCube( ) table = ( - LUTxD.table.reshape([-1, 3], order="F") - if not is_3x1D - else LUTxD.table + np.reshape(LUTxD.table, (-1, 3), order="F") if not is_3x1D else LUTxD.table ) for array in table: diff --git a/colour/io/luts/lut.py b/colour/io/luts/lut.py index 7defade81b..64bfc9c031 100644 --- a/colour/io/luts/lut.py +++ b/colour/io/luts/lut.py @@ -2,7 +2,7 @@ LUT Processing ============== -Defines the classes and definitions handling *LUT* processing: +Define the classes and definitions handling *LUT* processing: - :class:`colour.LUT1D` - :class:`colour.LUT3x1D` @@ -56,7 +56,6 @@ full, is_iterable, is_numeric, - is_string, multiline_repr, multiline_str, optional, @@ -66,7 +65,6 @@ usage_warning, validate_method, ) -from colour.utilities.deprecation import ObjectRenamed __author__ = "Colour Developers" __copyright__ = "Copyright 2013 Colour Developers" @@ -212,7 +210,7 @@ def name(self, value: str): """Setter for the **self.name** property.""" attest( - is_string(value), + isinstance(value, str), f'"name" property: "{value}" type is not "str"!', ) @@ -609,9 +607,7 @@ def arithmetical_operation( }[operation] if in_place: - operand = ( - a.table if isinstance(a, AbstractLUT) else as_float_array(a) - ) + operand = a.table if isinstance(a, AbstractLUT) else as_float_array(a) self.table = operator(self.table, operand) @@ -809,7 +805,10 @@ def convert( """ return LUT_to_LUT( - self, cls, force_conversion, **kwargs # pyright: ignore + self, + cls, + force_conversion, + **kwargs, # pyright: ignore ) @@ -1133,27 +1132,6 @@ def apply(self, RGB: ArrayLike, **kwargs: Any) -> NDArrayFloat: return RGB_interpolator(RGB) - # ------------------------------------------------------------------------# - # --- API Changes and Deprecation Management ---# - # ------------------------------------------------------------------------# - def as_LUT( # noqa: D102 - self, - cls: Type[AbstractLUT], - force_conversion: bool = False, - **kwargs: Any, - ) -> AbstractLUT: # pragma: no cover - # Docstrings are omitted for documentation purposes. - usage_warning( - str( - ObjectRenamed( - "LUT1D.as_LUT", - "LUT1D.convert", - ) - ) - ) - - return self.convert(cls, force_conversion, **kwargs) # pyright: ignore - class LUT3x1D(AbstractLUT): """ @@ -1288,9 +1266,7 @@ def _validate_domain(self, domain: ArrayLike) -> NDArrayFloat: "The domain row count must be equal or greater than 2!", ) - attest( - domain.shape[1] == 3, "The domain column count must be equal to 3!" - ) + attest(domain.shape[1] == 3, "The domain column count must be equal to 3!") return domain @@ -1360,9 +1336,7 @@ def linear_table( Examples -------- - >>> LUT3x1D.linear_table( - ... 5, np.array([[-0.1, -0.2, -0.4], [1.5, 3.0, 6.0]]) - ... ) + >>> LUT3x1D.linear_table(5, np.array([[-0.1, -0.2, -0.4], [1.5, 3.0, 6.0]])) array([[-0.1, -0.2, -0.4], [ 0.3, 0.6, 1.2], [ 0.7, 1.4, 2.8], @@ -1400,15 +1374,12 @@ def linear_table( if domain.shape != (2, 3): return domain else: - size_array = ( - np.tile(size, 3) if is_numeric(size) else as_int_array(size) - ) + size_array = np.tile(size, 3) if is_numeric(size) else as_int_array(size) R, G, B = tsplit(domain) samples = [ - np.linspace(a[0], a[1], size_array[i]) - for i, a in enumerate([R, G, B]) + np.linspace(a[0], a[1], size_array[i]) for i, a in enumerate([R, G, B]) ] if len(np.unique(size_array)) != 1: @@ -1495,10 +1466,7 @@ def invert(self, **kwargs: Any) -> LUT3x1D: # noqa: ARG002 ] else: domain_min, domain_max = self.domain - domain = [ - np.linspace(domain_min[i], domain_max[i], size) - for i in range(3) - ] + domain = [np.linspace(domain_min[i], domain_max[i], size) for i in range(3)] LUT_i = LUT3x1D( table=tstack(domain), @@ -1595,8 +1563,7 @@ def apply(self, RGB: ArrayLike, **kwargs: Any) -> NDArrayFloat: else: domain_min, domain_max = LUT.domain samples = [ - np.linspace(domain_min[i], domain_max[i], size) - for i in range(3) + np.linspace(domain_min[i], domain_max[i], size) for i in range(3) ] R_t, G_t, B_t = tsplit(LUT.table) @@ -1612,27 +1579,6 @@ def apply(self, RGB: ArrayLike, **kwargs: Any) -> NDArrayFloat: return tstack(RGB_i) - # ------------------------------------------------------------------------# - # --- API Changes and Deprecation Management ---# - # ------------------------------------------------------------------------# - def as_LUT( # noqa: D102 - self, - cls: Type[AbstractLUT], - force_conversion: bool = False, - **kwargs: Any, - ) -> AbstractLUT: # pragma: no cover - # Docstrings are omitted for documentation purposes. - usage_warning( - str( - ObjectRenamed( - "LUT3x1D.as_LUT", - "LUT3x1D.convert", - ) - ) - ) - - return self.convert(cls, force_conversion, **kwargs) # pyright: ignore - class LUT3D(AbstractLUT): """ @@ -1770,9 +1716,7 @@ def _validate_domain(self, domain: ArrayLike) -> NDArrayFloat: "The domain row count must be equal or greater than 2!", ) - attest( - domain.shape[1] == 3, "The domain column count must be equal to 3!" - ) + attest(domain.shape[1] == 3, "The domain column count must be equal to 3!") return domain @@ -1804,9 +1748,7 @@ def is_domain_explicit(self) -> bool: -------- >>> LUT3D().is_domain_explicit() False - >>> domain = np.array( - ... [[-0.1, -0.2, -0.4], [0.7, 1.4, 6.0], [1.5, 3.0, np.nan]] - ... ) + >>> domain = np.array([[-0.1, -0.2, -0.4], [0.7, 1.4, 6.0], [1.5, 3.0, np.nan]]) >>> LUT3D(domain=domain).is_domain_explicit() True """ @@ -1837,9 +1779,7 @@ def linear_table( Examples -------- - >>> LUT3D.linear_table( - ... 3, np.array([[-0.1, -0.2, -0.4], [1.5, 3.0, 6.0]]) - ... ) + >>> LUT3D.linear_table(3, np.array([[-0.1, -0.2, -0.4], [1.5, 3.0, 6.0]])) array([[[[-0.1, -0.2, -0.4], [-0.1, -0.2, 2.8], [-0.1, -0.2, 6. ]], @@ -1909,9 +1849,7 @@ def linear_table( [[ 1.5, 3. , -0.4], [ 1.5, 3. , 6. ]]]]) - >>> domain = np.array( - ... [[-0.1, -0.2, -0.4], [0.7, 1.4, 6.0], [1.5, 3.0, np.nan]] - ... ) + >>> domain = np.array([[-0.1, -0.2, -0.4], [0.7, 1.4, 6.0], [1.5, 3.0, np.nan]]) >>> LUT3D.linear_table(domain=domain) array([[[[-0.1, -0.2, -0.4], [-0.1, -0.2, 6. ]], @@ -1963,21 +1901,19 @@ def linear_table( ) size_array = as_int_array([len(axes) for axes in samples]) else: - size_array = ( - np.tile(size, 3) if is_numeric(size) else as_int_array(size) - ) + size_array = np.tile(size, 3) if is_numeric(size) else as_int_array(size) R, G, B = tsplit(domain) size_array = np.flip(size_array, -1) samples = [ - np.linspace(a[0], a[1], size_array[i]) - for i, a in enumerate([B, G, R]) + np.linspace(a[0], a[1], size_array[i]) for i, a in enumerate([B, G, R]) ] table = np.flip( - np.transpose(np.meshgrid(*samples, indexing="ij")).reshape( - np.hstack([np.flip(size_array, -1), 3]) + np.reshape( + np.transpose(np.meshgrid(*samples, indexing="ij")), + np.hstack([np.flip(size_array, -1), 3]), ), -1, ) @@ -2034,21 +1970,16 @@ def invert(self, **kwargs: Any) -> LUT3D: if self.is_domain_explicit(): raise NotImplementedError( - 'Inverting a "LUT3D" with an explicit domain is not ' - "implemented!" + 'Inverting a "LUT3D" with an explicit domain is not implemented!' ) - interpolator = kwargs.get( - "interpolator", table_interpolation_trilinear - ) + interpolator = kwargs.get("interpolator", table_interpolation_trilinear) extrapolate = kwargs.get("extrapolate", False) query_size = kwargs.get("query_size", 3) LUT = self.copy() source_size = LUT.size - target_size = kwargs.get( - "size", (as_int(2 ** (np.sqrt(source_size) + 1) + 1)) - ) + target_size = kwargs.get("size", (as_int(2 ** (np.sqrt(source_size) + 1) + 1))) if target_size > 129: # pragma: no cover usage_warning("LUT3D inverse computation time could be excessive!") @@ -2074,17 +2005,18 @@ def invert(self, **kwargs: Any) -> LUT3D: tree = KDTree(np.reshape(LUT_t.table, (-1, 3))) - # "LUT_q" stores the indexes of the KDTree query, i.e. the closest + # "LUT_q" stores the indexes of the KDTree query, i.e., the closest # entry of "LUT_t" for any searched table sample. LUT_q = LUT3D(size=target_size, domain=LUT.domain) query = tree.query(table, query_size)[-1] if query_size == 1: - LUT_q.table = table[query].reshape( - [target_size, target_size, target_size, 3] + LUT_q.table = np.reshape( + table[query], (target_size, target_size, target_size, 3) ) else: - LUT_q.table = np.mean(table[query], axis=-2).reshape( - [target_size, target_size, target_size, 3] + LUT_q.table = np.reshape( + np.mean(table[query], axis=-2), + (target_size, target_size, target_size, 3), ) LUT_q.name = f"{self.name} - Inverse" @@ -2157,9 +2089,7 @@ def apply(self, RGB: ArrayLike, **kwargs: Any) -> NDArrayFloat: kwargs.get("direction", "Forward"), ("Forward", "Inverse") ) - interpolator = kwargs.get( - "interpolator", table_interpolation_trilinear - ) + interpolator = kwargs.get("interpolator", table_interpolation_trilinear) interpolator_kwargs = kwargs.get("interpolator_kwargs", {}) R, G, B = tsplit(RGB) @@ -2191,31 +2121,10 @@ def apply(self, RGB: ArrayLike, **kwargs: Any) -> NDArrayFloat: return RGB_i - # ------------------------------------------------------------------------# - # --- API Changes and Deprecation Management ---# - # ------------------------------------------------------------------------# - def as_LUT( # noqa: D102 - self, - cls: Type[AbstractLUT], - force_conversion: bool = False, - **kwargs: Any, - ) -> AbstractLUT: # pragma: no cover - # Docstrings are omitted for documentation purposes. - usage_warning( - str( - ObjectRenamed( - "LUT3D.as_LUT", - "LUT3D.convert", - ) - ) - ) - - return self.convert(cls, force_conversion, **kwargs) # pyright: ignore - def LUT_to_LUT( LUT, - cls: AbstractLUT, + cls: Type[AbstractLUT], force_conversion: bool = False, **kwargs: Any, ) -> AbstractLUT: @@ -2285,13 +2194,8 @@ def LUT_to_LUT( ranks = {LUT1D: 1, LUT3x1D: 2, LUT3D: 3} path = (ranks[LUT.__class__], ranks[cls]) # pyright: ignore - path_verbose = [ - f"{element}D" if element != 2 else "3x1D" for element in path - ] - if ( - path in ((1, 3), (2, 1), (2, 3), (3, 1), (3, 2)) - and not force_conversion - ): + path_verbose = [f"{element}D" if element != 2 else "3x1D" for element in path] + if path in ((1, 3), (2, 1), (2, 3), (3, 1), (3, 2)) and not force_conversion: raise ValueError( f'Conversion of a "LUT" {path_verbose[0]} to a "LUT" ' f"{path_verbose[1]} is destructive, please use the " @@ -2310,9 +2214,7 @@ def LUT_to_LUT( if "size" in kwargs: del kwargs["size"] - channel_weights = as_float_array( - kwargs.get("channel_weights", full(3, 1 / 3)) - ) + channel_weights = as_float_array(kwargs.get("channel_weights", full(3, 1 / 3))) if "channel_weights" in kwargs: del kwargs["channel_weights"] diff --git a/colour/io/luts/operator.py b/colour/io/luts/operator.py index c81f9048ce..74785e56b6 100644 --- a/colour/io/luts/operator.py +++ b/colour/io/luts/operator.py @@ -2,7 +2,7 @@ LUT Operator ============ -Defines the *LUT* operator classes: +Define the *LUT* operator classes: - :class:`colour.io.AbstractLUTSequenceOperator` - :class:`colour.LUTOperatorMatrix` @@ -14,7 +14,7 @@ import numpy as np -from colour.algebra import vector_dot +from colour.algebra import vecmul from colour.hints import ( Any, ArrayLike, @@ -26,7 +26,6 @@ as_float_array, attest, is_iterable, - is_string, ones, optional, zeros, @@ -102,7 +101,7 @@ def name(self, value: str): """Setter for the **self.name** property.""" attest( - is_string(value), + isinstance(value, str), f'"name" property: "{value}" type is not "str"!', ) @@ -279,7 +278,7 @@ def matrix(self, value: ArrayLike): shape_t = value.shape[-1] - value = value.reshape([shape_t, shape_t]) + value = np.reshape(value, (shape_t, shape_t)) attest( value.shape in [(3, 3), (4, 4)], @@ -380,9 +379,7 @@ def __repr__(self) -> str: Examples -------- - >>> LUTOperatorMatrix( - ... comments=["A first comment.", "A second comment."] - ... ) + >>> LUTOperatorMatrix(comments=["A first comment.", "A second comment."]) ... # doctest: +ELLIPSIS LUTOperatorMatrix([[ 1., 0., 0., 0.], [ 0., 1., 0., 0.], @@ -394,9 +391,7 @@ def __repr__(self) -> str: """ representation = repr(self._matrix) - representation = representation.replace( - "array", self.__class__.__name__ - ) + representation = representation.replace("array", self.__class__.__name__) representation = representation.replace( " [", f"{' ' * (len(self.__class__.__name__) + 2)}[" ) @@ -404,9 +399,7 @@ def __repr__(self) -> str: indentation = " " * (len(self.__class__.__name__) + 1) comments = ( - f",\n{indentation}comments={self._comments!r}" - if self._comments - else "" + f",\n{indentation}comments={self._comments!r}" if self._comments else "" ) return "\n".join( @@ -465,7 +458,7 @@ def __ne__(self, other: Any) -> bool: Examples -------- >>> LUTOperatorMatrix() != LUTOperatorMatrix( - ... np.linspace(0, 1, 16).reshape([4, 4]) + ... np.reshape(np.linspace(0, 1, 16), (4, 4)) ... ) True """ @@ -473,7 +466,10 @@ def __ne__(self, other: Any) -> bool: return not (self == other) def apply( - self, RGB: ArrayLike, *args: Any, **kwargs: Any # noqa: ARG002 + self, + RGB: ArrayLike, + *args: Any, # noqa: ARG002 + **kwargs: Any, ) -> NDArrayFloat: """ Apply the *LUT* operator to given *RGB* array. @@ -522,7 +518,7 @@ def apply( if apply_offset_first: RGB += offset - RGB = vector_dot(M, RGB) + RGB = vecmul(M, RGB) if not apply_offset_first: RGB += offset diff --git a/colour/io/luts/resolve_cube.py b/colour/io/luts/resolve_cube.py index 1fa8ae1619..f95e1808bb 100644 --- a/colour/io/luts/resolve_cube.py +++ b/colour/io/luts/resolve_cube.py @@ -2,7 +2,7 @@ Resolve .cube LUT Format Input / Output Utilities ================================================= -Defines the *Resolve* *.cube* *LUT* format related input / output utilities +Define the *Resolve* *.cube* *LUT* format related input / output utilities objects: - :func:`colour.io.read_LUT_ResolveCube` @@ -17,6 +17,8 @@ from __future__ import annotations +from pathlib import Path + import numpy as np from colour.io.luts import LUT1D, LUT3D, LUT3x1D, LUTSequence @@ -42,7 +44,7 @@ ] -def read_LUT_ResolveCube(path: str) -> LUT3x1D | LUT3D | LUTSequence: +def read_LUT_ResolveCube(path: str | Path) -> LUT3x1D | LUT3D | LUTSequence: """ Read given *Resolve* *.cube* *LUT* file. @@ -160,6 +162,8 @@ def read_LUT_ResolveCube(path: str) -> LUT3x1D | LUT3D | LUTSequence: Comment 04 : A second "LUT3D" comment. """ + path = str(path) + title = path_to_title(path) domain_3x1D, domain_3D = None, None size_3x1D: int = 2 @@ -204,8 +208,8 @@ def read_LUT_ResolveCube(path: str) -> LUT3x1D | LUT3D | LUTSequence: # The lines of table data shall be in ascending index order, # with the first component index (Red) changing most rapidly, # and the last component index (Blue) changing least rapidly. - table_3D = table[int(size_3x1D) :].reshape( - (size_3D, size_3D, size_3D, 3), order="F" + table_3D = np.reshape( + table[int(size_3x1D) :], (size_3D, size_3D, size_3D, 3), order="F" ) LUT = LUTSequence( LUT3x1D( @@ -226,7 +230,7 @@ def read_LUT_ResolveCube(path: str) -> LUT3x1D | LUT3D | LUTSequence: # The lines of table data shall be in ascending index order, # with the first component index (Red) changing most rapidly, # and the last component index (Blue) changing least rapidly. - table = table.reshape([size_3D, size_3D, size_3D, 3], order="F") + table = np.reshape(table, (size_3D, size_3D, size_3D, 3), order="F") LUT = LUT3D(table, title, domain_3D, comments=comments) return LUT @@ -234,7 +238,7 @@ def read_LUT_ResolveCube(path: str) -> LUT3x1D | LUT3D | LUTSequence: def write_LUT_ResolveCube( LUT: LUT1D | LUT3x1D | LUT3D | LUTSequence, - path: str, + path: str | Path, decimals: int = 7, ) -> bool: """ @@ -294,7 +298,6 @@ def write_LUT_ResolveCube( ... H[H > 1] -= 1 ... H[H < 0] += 1 ... return HSV_to_RGB([H, S, V]) - ... >>> domain = np.array([[-0.1, -0.1, -0.1], [3.0, 3.0, 3.0]]) >>> shaper = LUT3x1D( ... spow(LUT3x1D.linear_table(10, domain), 1 / 2.2), @@ -315,6 +318,8 @@ def write_LUT_ResolveCube( >>> write_LUT_ResolveCube(LUT_sequence, "My_LUT.cube") # doctest: +SKIP """ + path = str(path) + has_3D, has_3x1D = False, False if isinstance(LUT, LUTSequence): @@ -347,15 +352,10 @@ def write_LUT_ResolveCube( raise TypeError("LUT must be 1D, 3x1D, 3D, 1D + 3D or 3x1D + 3D!") for i in range(2): - attest( - not LUT[i].is_domain_explicit(), '"LUT" domain must be implicit!' - ) + attest(not LUT[i].is_domain_explicit(), '"LUT" domain must be implicit!') attest( - ( - len(np.unique(LUT[0].domain)) == 2 - and len(np.unique(LUT[1].domain)) == 2 - ), + (len(np.unique(LUT[0].domain)) == 2 and len(np.unique(LUT[1].domain)) == 2), '"LUT" domain must be 1D!', ) @@ -365,9 +365,7 @@ def write_LUT_ResolveCube( "Shaper size must be in domain [2, 65536]!", ) if has_3D: - attest( - 2 <= LUT[1].size <= 256, "Cube size must be in domain [2, 256]!" - ) + attest(2 <= LUT[1].size <= 256, "Cube size must be in domain [2, 256]!") with open(path, "w") as cube_file: cube_file.write(f'TITLE "{name}"\n') @@ -405,7 +403,7 @@ def write_LUT_ResolveCube( cube_file.write("\n") if has_3D: - table = LUT[1].table.reshape([-1, 3], order="F") + table = np.reshape(LUT[1].table, (-1, 3), order="F") for vector in table: cube_file.write(f"{format_array_as_row(vector, decimals)}\n") diff --git a/colour/io/luts/sequence.py b/colour/io/luts/sequence.py index dd697f9dbe..49176981f3 100644 --- a/colour/io/luts/sequence.py +++ b/colour/io/luts/sequence.py @@ -2,7 +2,7 @@ LUT Operator ============ -Defines the *LUT* sequence class: +Define the *LUT* sequence class: - :class:`colour.LUTSequence` """ @@ -37,7 +37,7 @@ class LUTSequence(MutableSequence): """ - Define the base class for a *LUT* sequence, i.e. a series of *LUTs*, + Define the base class for a *LUT* sequence, i.e., a series of *LUTs*, *LUT* operators or objects implementing the :class:`colour.hints.ProtocolLUTSequenceItem` protocol. @@ -315,8 +315,7 @@ def insert(self, index: int, value: ProtocolLUTSequenceItem): attest( isinstance(value, ProtocolLUTSequenceItem), - '"value" items must implement the "ProtocolLUTSequenceItem" ' - "protocol!", + '"value" items must implement the "ProtocolLUTSequenceItem" protocol!', ) self._sequence.insert(index, value) @@ -371,9 +370,7 @@ def apply(self, RGB: ArrayLike, **kwargs: Any) -> NDArrayFloat: RGB_o = RGB for operator in self: - RGB_o = operator.apply( - RGB_o, **kwargs.get(operator.__class__.__name__, {}) - ) + RGB_o = operator.apply(RGB_o, **kwargs.get(operator.__class__.__name__, {})) return RGB_o diff --git a/colour/io/luts/sony_spi1d.py b/colour/io/luts/sony_spi1d.py index 9911a757cc..1c4bcc67be 100644 --- a/colour/io/luts/sony_spi1d.py +++ b/colour/io/luts/sony_spi1d.py @@ -2,7 +2,7 @@ Sony .spi1d LUT Format Input / Output Utilities =============================================== -Defines the *Sony* *.spi1d* *LUT* format related input / output utilities +Define the *Sony* *.spi1d* *LUT* format related input / output utilities objects: - :func:`colour.io.read_LUT_SonySPI1D` @@ -11,6 +11,8 @@ from __future__ import annotations +from pathlib import Path + import numpy as np from colour.io.luts import LUT1D, LUT3x1D, LUTSequence @@ -36,7 +38,7 @@ ] -def read_LUT_SonySPI1D(path: str) -> LUT1D | LUT3x1D: +def read_LUT_SonySPI1D(path: str | Path) -> LUT1D | LUT3x1D: """ Read given *Sony* *.spi1d* *LUT* file. @@ -154,7 +156,7 @@ def read_LUT_SonySPI1D(path: str) -> LUT1D | LUT3x1D: def write_LUT_SonySPI1D( - LUT: LUT1D | LUT3x1D | LUTSequence, path: str, decimals: int = 7 + LUT: LUT1D | LUT3x1D | LUTSequence, path: str | Path, decimals: int = 7 ) -> bool: """ Write given *LUT* to given *Sony* *.spi1d* *LUT* file. @@ -205,6 +207,8 @@ def write_LUT_SonySPI1D( >>> write_LUT_SonySPI1D(LUT, "My_LUT.cube") # doctest: +SKIP """ + path = str(path) + if isinstance(LUT, LUTSequence): usage_warning( f'"LUT" is a "LUTSequence" instance was passed, using first ' diff --git a/colour/io/luts/sony_spi3d.py b/colour/io/luts/sony_spi3d.py index 19c99a7ea6..9d2a8e7b38 100644 --- a/colour/io/luts/sony_spi3d.py +++ b/colour/io/luts/sony_spi3d.py @@ -2,7 +2,7 @@ Sony .spi3d LUT Format Input / Output Utilities =============================================== -Defines the *Sony* *.spi3d* *LUT* format related input / output utilities +Define the *Sony* *.spi3d* *LUT* format related input / output utilities objects: - :func:`colour.io.read_LUT_SonySPI3D` @@ -11,6 +11,8 @@ from __future__ import annotations +from pathlib import Path + import numpy as np from colour.io.luts import LUT3D, LUTSequence @@ -37,7 +39,7 @@ ] -def read_LUT_SonySPI3D(path: str) -> LUT3D: +def read_LUT_SonySPI3D(path: str | Path) -> LUT3D: """ Read given *Sony* *.spi3d* *LUT* file. @@ -90,6 +92,8 @@ def read_LUT_SonySPI3D(path: str) -> LUT3D: Comment 01 : Adapted from a LUT generated by Foundry::LUT. """ + path = str(path) + title = path_to_title(path) domain_min, domain_max = np.array([0, 0, 0]), np.array([1, 1, 1]) size: int = 2 @@ -122,24 +126,22 @@ def read_LUT_SonySPI3D(path: str) -> LUT3D: attest( np.array_equal( indexes[sorting_indexes], - as_int_array( - np.around(LUT3D.linear_table(size) * (size - 1)) - ).reshape((-1, 3)), + np.reshape( + as_int_array(np.around(LUT3D.linear_table(size) * (size - 1))), (-1, 3) + ), ), 'Indexes do not match expected "LUT3D" indexes!', ) - table = as_float_array(data_table)[sorting_indexes].reshape( - [size, size, size, 3] + table = np.reshape( + as_float_array(data_table)[sorting_indexes], (size, size, size, 3) ) - return LUT3D( - table, title, np.vstack([domain_min, domain_max]), comments=comments - ) + return LUT3D(table, title, np.vstack([domain_min, domain_max]), comments=comments) def write_LUT_SonySPI3D( - LUT: LUT3D | LUTSequence, path: str, decimals: int = 7 + LUT: LUT3D | LUTSequence, path: str | Path, decimals: int = 7 ) -> bool: """ Write given *LUT* to given *Sony* *.spi3d* *LUT* file. @@ -177,6 +179,8 @@ def write_LUT_SonySPI3D( >>> write_LUT_SonySPI3D(LUT, "My_LUT.cube") # doctest: +SKIP """ + path = str(path) + if isinstance(LUT, LUTSequence): usage_warning( f'"LUT" is a "LUTSequence" instance was passed, using first ' @@ -210,10 +214,11 @@ def write_LUT_SonySPI3D( spi3d_file.write(f"{LUTxD.size} {LUTxD.size} {LUTxD.size}\n") - indexes = as_int_array( - np.around(LUTxD.linear_table(LUTxD.size) * (LUTxD.size - 1)) - ).reshape([-1, 3]) - table = LUTxD.table.reshape([-1, 3]) + indexes = np.reshape( + as_int_array(np.around(LUTxD.linear_table(LUTxD.size) * (LUTxD.size - 1))), + (-1, 3), + ) + table = np.reshape(LUTxD.table, (-1, 3)) for i, array in enumerate(indexes): spi3d_file.write("{:d} {:d} {:d}".format(*array)) diff --git a/colour/io/luts/sony_spimtx.py b/colour/io/luts/sony_spimtx.py index a56751624d..f19d630cd7 100644 --- a/colour/io/luts/sony_spimtx.py +++ b/colour/io/luts/sony_spimtx.py @@ -2,7 +2,7 @@ Sony .spimtx LUT Format Input / Output Utilities ================================================ -Defines *Sony* *.spimtx* *LUT* format related input / output utilities objects. +Define *Sony* *.spimtx* *LUT* format related input / output utilities objects. - :func:`colour.io.read_LUT_SonySPImtx` - :func:`colour.io.write_LUT_SonySPImtx` @@ -10,6 +10,8 @@ from __future__ import annotations +from pathlib import Path + import numpy as np from colour.constants import DTYPE_FLOAT_DEFAULT @@ -29,7 +31,7 @@ ] -def read_LUT_SonySPImtx(path: str) -> LUTOperatorMatrix: +def read_LUT_SonySPImtx(path: str | Path) -> LUTOperatorMatrix: """ Read given *Sony* *.spimtx* *LUT* file. @@ -64,6 +66,8 @@ def read_LUT_SonySPImtx(path: str) -> LUTOperatorMatrix: Offset : [ 0. 0. 0. 0.] """ + path = str(path) + matrix = np.loadtxt(path, dtype=DTYPE_FLOAT_DEFAULT) matrix = np.reshape(matrix, (3, 4)) offset = matrix[:, 3] / 65535 @@ -75,7 +79,7 @@ def read_LUT_SonySPImtx(path: str) -> LUTOperatorMatrix: def write_LUT_SonySPImtx( - LUT: LUTOperatorMatrix, path: str, decimals: int = 7 + LUT: LUTOperatorMatrix, path: str | Path, decimals: int = 7 ) -> bool: """ Write given *LUT* to given *Sony* *.spimtx* *LUT* file. @@ -108,6 +112,8 @@ def write_LUT_SonySPImtx( >>> write_LUT_SonySPI1D(M, "My_LUT.spimtx") # doctest: +SKIP """ + path = str(path) + matrix, offset = LUT.matrix, LUT.offset offset *= 65535 diff --git a/colour/io/luts/tests/test__init__.py b/colour/io/luts/tests/test__init__.py index 83482edd90..0435fc9496 100644 --- a/colour/io/luts/tests/test__init__.py +++ b/colour/io/luts/tests/test__init__.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.luts.__init__` module.""" from __future__ import annotations @@ -6,9 +5,9 @@ import os import shutil import tempfile -import unittest import numpy as np +import pytest from colour.constants import TOLERANCE_ABSOLUTE_TESTS from colour.io import LUTSequence, read_LUT, write_LUT @@ -29,7 +28,7 @@ ROOT_LUTS: str = os.path.join(os.path.dirname(__file__), "resources") -class TestReadLUT(unittest.TestCase): +class TestReadLUT: """ Define :func:`colour.io.luts.__init__.read_LUT` definition unit tests methods. @@ -38,9 +37,7 @@ class TestReadLUT(unittest.TestCase): def test_read_LUT(self): """Test :func:`colour.io.luts.__init__.read_LUT` definition.""" - LUT_1 = read_LUT( - os.path.join(ROOT_LUTS, "sony_spi1d", "eotf_sRGB_1D.spi1d") - ) + LUT_1 = read_LUT(os.path.join(ROOT_LUTS, "sony_spi1d", "eotf_sRGB_1D.spi1d")) np.testing.assert_allclose( LUT_1.table, @@ -66,18 +63,16 @@ def test_read_LUT(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(LUT_1.name, "eotf sRGB 1D") - self.assertEqual(LUT_1.dimensions, 1) + assert LUT_1.name == "eotf sRGB 1D" + assert LUT_1.dimensions == 1 np.testing.assert_array_equal(LUT_1.domain, np.array([-0.1, 1.5])) - self.assertEqual(LUT_1.size, 16) - self.assertListEqual( - LUT_1.comments, - ['Generated by "Colour 0.3.11".', '"colour.models.eotf_sRGB".'], - ) + assert LUT_1.size == 16 + assert LUT_1.comments == [ + 'Generated by "Colour 0.3.11".', + '"colour.models.eotf_sRGB".', + ] - LUT_2 = read_LUT( - os.path.join(ROOT_LUTS, "resolve_cube", "LogC_Video.cube") - ) + LUT_2 = read_LUT(os.path.join(ROOT_LUTS, "resolve_cube", "LogC_Video.cube")) np.testing.assert_allclose( LUT_2[0].table, np.array( @@ -102,16 +97,13 @@ def test_read_LUT(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(LUT_2[1].size, 4) + assert LUT_2[1].size == 4 - self.assertEqual( - read_LUT( - os.path.join(ROOT_LUTS, "sony_spi1d", "eotf_sRGB_1D.spi1d") - ), - read_LUT( - os.path.join(ROOT_LUTS, "sony_spi1d", "eotf_sRGB_1D.spi1d"), - method="Sony SPI1D", - ), + assert read_LUT( + os.path.join(ROOT_LUTS, "sony_spi1d", "eotf_sRGB_1D.spi1d") + ) == read_LUT( + os.path.join(ROOT_LUTS, "sony_spi1d", "eotf_sRGB_1D.spi1d"), + method="Sony SPI1D", ) def test_raise_exception_read_LUT(self): @@ -120,25 +112,25 @@ def test_raise_exception_read_LUT(self): exception. """ - self.assertRaises( + pytest.raises( ValueError, read_LUT, os.path.join(ROOT_LUTS, "sony_spi1d", "Exception_Raising.spi1d"), ) -class TestWriteLUT(unittest.TestCase): +class TestWriteLUT: """ Define :func:`colour.io.luts.__init__.write_LUT` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -146,9 +138,7 @@ def tearDown(self): def test_write_LUT(self): """Test :func:`colour.io.luts.__init__.write_LUT` definition.""" - LUT_1_r = read_LUT( - os.path.join(ROOT_LUTS, "sony_spi1d", "eotf_sRGB_1D.spi1d") - ) + LUT_1_r = read_LUT(os.path.join(ROOT_LUTS, "sony_spi1d", "eotf_sRGB_1D.spi1d")) write_LUT( LUT_1_r, @@ -159,14 +149,14 @@ def test_write_LUT(self): os.path.join(self._temporary_directory, "eotf_sRGB_1D.spi1d") ) - self.assertEqual(LUT_1_r, LUT_1_t) + assert LUT_1_r == LUT_1_t write_LUT( LUTSequence(LUT_1_r), os.path.join(self._temporary_directory, "eotf_sRGB_1D.spi1d"), ) - self.assertEqual(LUT_1_r, LUT_1_t) + assert LUT_1_r == LUT_1_t LUT_2_r = read_LUT( os.path.join( @@ -191,7 +181,7 @@ def test_write_LUT(self): ) ) - self.assertEqual(LUT_2_r, LUT_2_t) + assert LUT_2_r == LUT_2_t write_LUT( LUT_1_r, @@ -199,16 +189,9 @@ def test_write_LUT(self): method="Sony SPI1D", ) - self.assertEqual( - read_LUT( - os.path.join(self._temporary_directory, "eotf_sRGB_1D.spi1d") - ), - read_LUT( - os.path.join(self._temporary_directory, "eotf_sRGB_1D"), - method="Sony SPI1D", - ), + assert read_LUT( + os.path.join(self._temporary_directory, "eotf_sRGB_1D.spi1d") + ) == read_LUT( + os.path.join(self._temporary_directory, "eotf_sRGB_1D"), + method="Sony SPI1D", ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/io/luts/tests/test_cinespace_csp.py b/colour/io/luts/tests/test_cinespace_csp.py index 0f2530d27f..6920117006 100644 --- a/colour/io/luts/tests/test_cinespace_csp.py +++ b/colour/io/luts/tests/test_cinespace_csp.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.luts.cinespace_csp` module.""" from __future__ import annotations @@ -6,9 +5,9 @@ import os import shutil import tempfile -import unittest import numpy as np +import pytest from colour.constants import TOLERANCE_ABSOLUTE_TESTS from colour.io import LUT1D, LUT3x1D, read_LUT_Cinespace, write_LUT_Cinespace @@ -27,12 +26,10 @@ "TestWriteLUTCinespace", ] -ROOT_LUTS: str = os.path.join( - os.path.dirname(__file__), "resources", "cinespace" -) +ROOT_LUTS: str = os.path.join(os.path.dirname(__file__), "resources", "cinespace") -class TestReadLUTCinespace(unittest.TestCase): +class TestReadLUTCinespace: """ Define :func:`colour.io.luts.cinespace_csp.read_LUT_Cinespace` definition unit tests methods. @@ -44,9 +41,7 @@ def test_read_LUT_Cinespace(self): definition. """ - LUT_1 = read_LUT_Cinespace( - os.path.join(ROOT_LUTS, "ACES_Proxy_10_to_ACES.csp") - ) + LUT_1 = read_LUT_Cinespace(os.path.join(ROOT_LUTS, "ACES_Proxy_10_to_ACES.csp")) np.testing.assert_allclose( LUT_1.table, @@ -88,53 +83,45 @@ def test_read_LUT_Cinespace(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(LUT_1.name, "ACES Proxy 10 to ACES") - self.assertEqual(LUT_1.dimensions, 2) - np.testing.assert_array_equal( - LUT_1.domain, np.array([[0, 0, 0], [1, 1, 1]]) - ) - self.assertEqual(LUT_1.size, 32) - self.assertListEqual(LUT_1.comments, []) + assert LUT_1.name == "ACES Proxy 10 to ACES" + assert LUT_1.dimensions == 2 + np.testing.assert_array_equal(LUT_1.domain, np.array([[0, 0, 0], [1, 1, 1]])) + assert LUT_1.size == 32 + assert LUT_1.comments == [] LUT_2 = read_LUT_Cinespace(os.path.join(ROOT_LUTS, "Demo.csp")) - self.assertListEqual( - LUT_2.comments, ["Comments are ignored by most parsers"] - ) - np.testing.assert_array_equal( - LUT_2.domain, np.array([[0, 0, 0], [1, 2, 3]]) - ) + assert LUT_2.comments == ["Comments are ignored by most parsers"] + np.testing.assert_array_equal(LUT_2.domain, np.array([[0, 0, 0], [1, 2, 3]])) LUT_3 = read_LUT_Cinespace( os.path.join(ROOT_LUTS, "Three_Dimensional_Table.csp") ) - self.assertEqual(LUT_3.dimensions, 3) - self.assertEqual(LUT_3.size, 2) + assert LUT_3.dimensions == 3 + assert LUT_3.size == 2 - LUT_4 = read_LUT_Cinespace( - os.path.join(ROOT_LUTS, "Explicit_Domain.csp") - ) - self.assertEqual(LUT_4[0].is_domain_explicit(), True) - self.assertEqual(LUT_4[1].table.shape, (2, 3, 4, 3)) + LUT_4 = read_LUT_Cinespace(os.path.join(ROOT_LUTS, "Explicit_Domain.csp")) + assert LUT_4[0].is_domain_explicit() is True + assert LUT_4[1].table.shape == (2, 3, 4, 3) LUT_5 = read_LUT_Cinespace( os.path.join(ROOT_LUTS, "Uncommon_3x1D_With_Pre_Lut.csp") ) - self.assertIsInstance(LUT_5[0], LUT3x1D) - self.assertIsInstance(LUT_5[1], LUT3x1D) + assert isinstance(LUT_5[0], LUT3x1D) + assert isinstance(LUT_5[1], LUT3x1D) -class TestWriteLUTCinespace(unittest.TestCase): +class TestWriteLUTCinespace: """ Define :func:`colour.io.luts.cinespace_csp.write_LUT_Cinespace` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -150,17 +137,13 @@ def test_write_LUT_Cinespace(self): ) write_LUT_Cinespace( LUT_1_r, - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.csp" - ), + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.csp"), ) LUT_1_t = read_LUT_Cinespace( - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.csp" - ) + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.csp") ) - self.assertEqual(LUT_1_r, LUT_1_t) - self.assertEqual(LUT_1_r, LUT_1_t) + assert LUT_1_r == LUT_1_t + assert LUT_1_r == LUT_1_t LUT_2_r = read_LUT_Cinespace(os.path.join(ROOT_LUTS, "Demo.csp")) write_LUT_Cinespace( @@ -169,24 +152,20 @@ def test_write_LUT_Cinespace(self): LUT_2_t = read_LUT_Cinespace( os.path.join(self._temporary_directory, "Demo.csp") ) - self.assertEqual(LUT_2_r, LUT_2_t) - self.assertListEqual(LUT_2_r.comments, LUT_2_t.comments) + assert LUT_2_r == LUT_2_t + assert LUT_2_r.comments == LUT_2_t.comments LUT_3_r = read_LUT_Cinespace( os.path.join(ROOT_LUTS, "Three_Dimensional_Table.csp") ) write_LUT_Cinespace( LUT_3_r, - os.path.join( - self._temporary_directory, "Three_Dimensional_Table.csp" - ), + os.path.join(self._temporary_directory, "Three_Dimensional_Table.csp"), ) LUT_3_t = read_LUT_Cinespace( - os.path.join( - self._temporary_directory, "Three_Dimensional_Table.csp" - ) + os.path.join(self._temporary_directory, "Three_Dimensional_Table.csp") ) - self.assertEqual(LUT_3_r, LUT_3_t) + assert LUT_3_r == LUT_3_t domain = tstack( ( @@ -195,16 +174,12 @@ def test_write_LUT_Cinespace(self): np.array([-1.0, -0.5, 0.0, 0.5, 1.0, np.nan]), ) ) - LUT_4_t = LUT3x1D( - domain=domain, table=domain * 2, name="Ragged Domain" - ) + LUT_4_t = LUT3x1D(domain=domain, table=domain * 2, name="Ragged Domain") write_LUT_Cinespace( LUT_4_t, os.path.join(self._temporary_directory, "Ragged_Domain.csp"), ) - LUT_4_r = read_LUT_Cinespace( - os.path.join(ROOT_LUTS, "Ragged_Domain.csp") - ) + LUT_4_r = read_LUT_Cinespace(os.path.join(ROOT_LUTS, "Ragged_Domain.csp")) np.testing.assert_allclose( LUT_4_t.domain, LUT_4_r.domain, atol=TOLERANCE_ABSOLUTE_TESTS ) @@ -213,9 +188,7 @@ def test_write_LUT_Cinespace(self): LUT_5_r = read_LUT_Cinespace( os.path.join(ROOT_LUTS, "Three_Dimensional_Table_With_Shaper.csp") ) - LUT_5_r.sequence[0] = LUT_5_r.sequence[0].convert( - LUT1D, force_conversion=True - ) + LUT_5_r.sequence[0] = LUT_5_r.sequence[0].convert(LUT1D, force_conversion=True) write_LUT_Cinespace( LUT_5_r, os.path.join( @@ -232,7 +205,7 @@ def test_write_LUT_Cinespace(self): "Three_Dimensional_Table_With_Shaper.csp", ) ) - self.assertEqual(LUT_5_r, LUT_5_t) + assert LUT_5_r == LUT_5_t LUT_6_r = read_LUT_Cinespace( os.path.join(ROOT_LUTS, "Three_Dimensional_Table_With_Shaper.csp") @@ -256,23 +229,19 @@ def test_write_LUT_Cinespace(self): "Three_Dimensional_Table_With_Shaper.csp", ) ) - self.assertEqual(LUT_6_r, LUT_6_t) + assert LUT_6_r == LUT_6_t LUT_7_r = read_LUT_Cinespace( os.path.join(ROOT_LUTS, "ACES_Proxy_10_to_ACES.csp") ) write_LUT_Cinespace( LUT_7_r.convert(LUT1D, force_conversion=True), - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.csp" - ), + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.csp"), ) LUT_7_t = read_LUT_Cinespace( - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.csp" - ) + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.csp") ) - self.assertEqual(LUT_7_r, LUT_7_t) + assert LUT_7_r == LUT_7_t def test_raise_exception_write_LUT_Cinespace(self): """ @@ -280,8 +249,4 @@ def test_raise_exception_write_LUT_Cinespace(self): definition raised exception. """ - self.assertRaises(TypeError, write_LUT_Cinespace, object(), "") - - -if __name__ == "__main__": - unittest.main() + pytest.raises(TypeError, write_LUT_Cinespace, object(), "") diff --git a/colour/io/luts/tests/test_common.py b/colour/io/luts/tests/test_common.py index 37a1c516a2..120e76b9e8 100644 --- a/colour/io/luts/tests/test_common.py +++ b/colour/io/luts/tests/test_common.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.luts.common` module.""" -import unittest from colour.io.luts.common import path_to_title @@ -17,7 +15,7 @@ ] -class TestPathToTitle(unittest.TestCase): +class TestPathToTitle: """ Define :func:`colour.io.luts.common.path_to_title` definition unit tests methods. @@ -26,13 +24,7 @@ class TestPathToTitle(unittest.TestCase): def test_path_to_title(self): """Test :func:`colour.io.luts.common.path_to_title` definition.""" - self.assertEqual( - path_to_title( - "colour/io/luts/tests/resources/cinespace/RGB_1_0.5_0.25.csp" - ), - "RGB 1 0 5 0 25", + assert ( + path_to_title("colour/io/luts/tests/resources/cinespace/RGB_1_0.5_0.25.csp") + == "RGB 1 0 5 0 25" ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/io/luts/tests/test_iridas_cube.py b/colour/io/luts/tests/test_iridas_cube.py index ea30ad9600..b65e80f208 100644 --- a/colour/io/luts/tests/test_iridas_cube.py +++ b/colour/io/luts/tests/test_iridas_cube.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.luts.iridas_cube` module.""" from __future__ import annotations @@ -6,7 +5,6 @@ import os import shutil import tempfile -import unittest import numpy as np @@ -31,12 +29,10 @@ "TestWriteLUTIridasCube", ] -ROOT_LUTS: str = os.path.join( - os.path.dirname(__file__), "resources", "iridas_cube" -) +ROOT_LUTS: str = os.path.join(os.path.dirname(__file__), "resources", "iridas_cube") -class TestReadLUTIridasCube(unittest.TestCase): +class TestReadLUTIridasCube: """ Define :func:`colour.io.luts.iridas_cube.read_LUT_IridasCube` definition unit tests methods. @@ -92,39 +88,35 @@ def test_read_LUT_IridasCube(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(LUT_1.name, "ACES Proxy 10 to ACES") - self.assertEqual(LUT_1.dimensions, 2) - np.testing.assert_array_equal( - LUT_1.domain, np.array([[0, 0, 0], [1, 1, 1]]) - ) - self.assertEqual(LUT_1.size, 32) - self.assertListEqual(LUT_1.comments, []) + assert LUT_1.name == "ACES Proxy 10 to ACES" + assert LUT_1.dimensions == 2 + np.testing.assert_array_equal(LUT_1.domain, np.array([[0, 0, 0], [1, 1, 1]])) + assert LUT_1.size == 32 + assert LUT_1.comments == [] LUT_2 = read_LUT_IridasCube(os.path.join(ROOT_LUTS, "Demo.cube")) - self.assertListEqual(LUT_2.comments, ["Comments can go anywhere"]) - np.testing.assert_array_equal( - LUT_2.domain, np.array([[0, 0, 0], [1, 2, 3]]) - ) + assert LUT_2.comments == ["Comments can go anywhere"] + np.testing.assert_array_equal(LUT_2.domain, np.array([[0, 0, 0], [1, 2, 3]])) LUT_3 = read_LUT_IridasCube( os.path.join(ROOT_LUTS, "Three_Dimensional_Table.cube") ) - self.assertEqual(LUT_3.dimensions, 3) - self.assertEqual(LUT_3.size, 2) + assert LUT_3.dimensions == 3 + assert LUT_3.size == 2 -class TestWriteLUTIridasCube(unittest.TestCase): +class TestWriteLUTIridasCube: """ Define :func:`colour.io.luts.iridas_cube.write_LUT_IridasCube` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -140,24 +132,18 @@ def test_write_LUT_IridasCube(self): ) write_LUT_IridasCube( LUT_1_r, - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.cube" - ), + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.cube"), ) LUT_1_t = read_LUT_IridasCube( - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.cube" - ) + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.cube") ) - self.assertEqual(LUT_1_r, LUT_1_t) + assert LUT_1_r == LUT_1_t write_LUT_IridasCube( LUTSequence(LUT_1_r), - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.cube" - ), + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.cube"), ) - self.assertEqual(LUT_1_r, LUT_1_t) + assert LUT_1_r == LUT_1_t LUT_2_r = read_LUT_IridasCube(os.path.join(ROOT_LUTS, "Demo.cube")) write_LUT_IridasCube( @@ -166,41 +152,29 @@ def test_write_LUT_IridasCube(self): LUT_2_t = read_LUT_IridasCube( os.path.join(self._temporary_directory, "Demo.cube") ) - self.assertEqual(LUT_2_r, LUT_2_t) - self.assertListEqual(LUT_2_r.comments, LUT_2_t.comments) + assert LUT_2_r == LUT_2_t + assert LUT_2_r.comments == LUT_2_t.comments LUT_3_r = read_LUT_IridasCube( os.path.join(ROOT_LUTS, "Three_Dimensional_Table.cube") ) write_LUT_IridasCube( LUT_3_r, - os.path.join( - self._temporary_directory, "Three_Dimensional_Table.cube" - ), + os.path.join(self._temporary_directory, "Three_Dimensional_Table.cube"), ) LUT_3_t = read_LUT_IridasCube( - os.path.join( - self._temporary_directory, "Three_Dimensional_Table.cube" - ) + os.path.join(self._temporary_directory, "Three_Dimensional_Table.cube") ) - self.assertEqual(LUT_3_r, LUT_3_t) + assert LUT_3_r == LUT_3_t LUT_4_r = read_LUT_IridasCube( os.path.join(ROOT_LUTS, "ACES_Proxy_10_to_ACES.cube") ) write_LUT_IridasCube( LUT_4_r.convert(LUT1D, force_conversion=True), - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.cube" - ), + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.cube"), ) LUT_4_t = read_LUT_IridasCube( - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.cube" - ) + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.cube") ) - self.assertEqual(LUT_4_r, LUT_4_t) - - -if __name__ == "__main__": - unittest.main() + assert LUT_4_r == LUT_4_t diff --git a/colour/io/luts/tests/test_lut.py b/colour/io/luts/tests/test_lut.py index 3ddcc65bd3..daebf7e970 100644 --- a/colour/io/luts/tests/test_lut.py +++ b/colour/io/luts/tests/test_lut.py @@ -1,13 +1,12 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.luts.lut` module.""" from __future__ import annotations import os import textwrap -import unittest import numpy as np +import pytest from colour.algebra import ( CubicSplineInterpolator, @@ -40,7 +39,7 @@ "ROOT_RESOURCES", "RANDOM_TRIPLETS", "TestAbstractLUT", - "AbstractLUTTest", + "FixtureAbstractLUT", "TestLUT1D", "TestLUT3x1D", "TestLUT3D", @@ -54,7 +53,7 @@ ) -class TestAbstractLUT(unittest.TestCase): +class TestAbstractLUT: """Define :class:`colour.io.luts.lut.AbstractLUT` class unit tests methods.""" def test_required_attributes(self): @@ -70,7 +69,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(AbstractLUT)) + assert attribute in dir(AbstractLUT) def test_required_methods(self): """Test the presence of required methods.""" @@ -101,27 +100,19 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(AbstractLUT)) + assert method in dir(AbstractLUT) -class AbstractLUTTest(unittest.TestCase): +class FixtureAbstractLUT: """ - Define :class:`colour.io.luts.lut.LUT1D`, + Define the :class:`colour.io.luts.lut.LUT1D`, :class:`colour.io.luts.lut.LUT3x1D` and - :class:`colour.io.luts.lut.LUT3D` classes common unit tests methods. + :class:`colour.io.luts.lut.LUT3D` classes fixture. """ - def __init__(self, *args: Any) -> None: - """ - Create an instance of the class. - - Other Parameters - ---------------- - args - Arguments. - """ - - super().__init__(*args) + @pytest.fixture(autouse=True) + def setup_fixture_abstract_lut(self) -> None: + """Configure the class instance.""" self._LUT_factory: Any = None @@ -136,13 +127,9 @@ def __init__(self, *args: Any) -> None: self._table_1_kwargs: dict | None = None self._table_2_kwargs: dict | None = None self._table_3_kwargs: dict | None = None - self._interpolator_1: Callable | Type[ - ProtocolInterpolator - ] | None = None + self._interpolator_1: Callable | Type[ProtocolInterpolator] | None = None self._interpolator_kwargs_1: dict = {} - self._interpolator_2: Callable | Type[ - ProtocolInterpolator - ] | None = None + self._interpolator_2: Callable | Type[ProtocolInterpolator] | None = None self._interpolator_kwargs_2: dict = {} self._invert_kwargs_1: dict = {} self._invert_kwargs_2: dict = {} @@ -169,7 +156,7 @@ def test_required_methods(self): for class_ in (LUT1D, LUT3x1D, LUT3D): for method in required_methods: - self.assertIn(method, dir(class_)) + assert method in dir(class_) def test__init__(self): """ @@ -178,24 +165,20 @@ def test__init__(self): :class:`colour.io.luts.lut.LUT3D.__init__` methods. """ - if self._LUT_factory is None: - return - LUT = self._LUT_factory(self._table_1) np.testing.assert_allclose( LUT.table, self._table_1, atol=TOLERANCE_ABSOLUTE_TESTS ) - self.assertEqual(str(id(LUT)), LUT.name) + assert str(id(LUT)) == LUT.name np.testing.assert_array_equal(LUT.domain, self._domain_1) - self.assertEqual(LUT.dimensions, self._dimensions) + assert LUT.dimensions == self._dimensions - self.assertIsInstance( - self._LUT_factory(self._table_3, domain=self._domain_3), - self._LUT_factory, + assert isinstance( + self._LUT_factory(self._table_3, domain=self._domain_3), self._LUT_factory ) def test_table(self): @@ -205,18 +188,13 @@ def test_table(self): :class:`colour.io.luts.lut.LUT3D.table` properties. """ - if self._LUT_factory is None: - return - LUT = self._LUT_factory() np.testing.assert_array_equal(LUT.table, LUT.linear_table(self._size)) table_1 = self._table_1 * 0.8 + 0.1 LUT.table = table_1 - np.testing.assert_allclose( - LUT.table, table_1, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(LUT.table, table_1, atol=TOLERANCE_ABSOLUTE_TESTS) def test_name(self): """ @@ -225,16 +203,13 @@ def test_name(self): :class:`colour.io.luts.lut.LUT3D.name` properties. """ - if self._LUT_factory is None: - return - LUT = self._LUT_factory(self._table_1) - self.assertEqual(LUT.name, str(id(LUT))) + assert LUT.name == str(id(LUT)) LUT = self._LUT_factory() - self.assertEqual(LUT.name, f"Unity {self._table_1.shape[0]}") + assert LUT.name == f"Unity {self._table_1.shape[0]}" def test_domain(self): """ @@ -243,9 +218,6 @@ def test_domain(self): :class:`colour.io.luts.lut.LUT3D.domain` properties. """ - if self._LUT_factory is None: - return - LUT = self._LUT_factory() np.testing.assert_array_equal(LUT.domain, self._domain_1) @@ -261,12 +233,9 @@ def test_size(self): :class:`colour.io.luts.lut.LUT3D.size` properties. """ - if self._LUT_factory is None: - return - LUT = self._LUT_factory() - self.assertEqual(LUT.size, LUT.table.shape[0]) + assert LUT.size == LUT.table.shape[0] def test_dimensions(self): """ @@ -275,12 +244,9 @@ def test_dimensions(self): :class:`colour.io.luts.lut.LUT3D.dimensions` properties. """ - if self._LUT_factory is None: - return - LUT = self._LUT_factory() - self.assertEqual(LUT.dimensions, self._dimensions) + assert LUT.dimensions == self._dimensions def test_comments(self): """ @@ -289,16 +255,13 @@ def test_comments(self): :class:`colour.io.luts.lut.LUT3D.comments` properties. """ - if self._LUT_factory is None: - return - LUT = self._LUT_factory() - self.assertListEqual(LUT.comments, []) + assert LUT.comments == [] comments = ["A first comment.", "A second comment."] LUT = self._LUT_factory(comments=comments) - self.assertListEqual(LUT.comments, comments) + assert LUT.comments == comments def test__str__(self): """ @@ -307,12 +270,9 @@ def test__str__(self): :class:`colour.io.luts.lut.LUT3D.__str__` methods. """ - if self._LUT_factory is None: - return - LUT = self._LUT_factory(name="Nemo") - self.assertEqual(str(LUT), self._str) + assert str(LUT) == self._str def test__repr__(self): """ @@ -321,9 +281,6 @@ def test__repr__(self): :class:`colour.io.luts.lut.LUT3D.__repr__` methods. """ - if self._LUT_factory is None: - return - LUT = self._LUT_factory( name="Nemo", comments=["A first comment.", "A second comment."] ) @@ -335,7 +292,7 @@ def test__repr__(self): if self._dimensions == 3: return - self.assertEqual(repr(LUT), self._repr) + assert repr(LUT) == self._repr def test__eq__(self): """ @@ -344,13 +301,10 @@ def test__eq__(self): :class:`colour.io.luts.lut.LUT3D.__eq__` methods. """ - if self._LUT_factory is None: - return - LUT_1 = self._LUT_factory() LUT_2 = self._LUT_factory() - self.assertEqual(LUT_1, LUT_2) + assert LUT_1 == LUT_2 def test__ne__(self): """ @@ -359,18 +313,15 @@ def test__ne__(self): :class:`colour.io.luts.lut.LUT3D.__ne__` methods. """ - if self._LUT_factory is None: - return - LUT_1 = self._LUT_factory() LUT_2 = self._LUT_factory() LUT_2 += 0.1 - self.assertNotEqual(LUT_1, LUT_2) + assert LUT_1 != LUT_2 LUT_2 = self._LUT_factory() LUT_2.domain = self._domain_1 * 0.8 + 0.1 - self.assertNotEqual(LUT_1, LUT_2) + assert LUT_1 != LUT_2 def test_is_domain_explicit(self): """ @@ -379,16 +330,11 @@ def test_is_domain_explicit(self): :class:`colour.io.luts.lut.LUT3D.is_domain_explicit` methods. """ - if self._LUT_factory is None: - return - - self.assertFalse(self._LUT_factory().is_domain_explicit()) + assert not self._LUT_factory().is_domain_explicit() - self.assertTrue( - self._LUT_factory( - self._table_3, domain=self._domain_3 - ).is_domain_explicit() - ) + assert self._LUT_factory( + self._table_3, domain=self._domain_3 + ).is_domain_explicit() def test_arithmetical_operation(self): """ @@ -397,9 +343,6 @@ def test_arithmetical_operation(self): :class:`colour.io.luts.lut.LUT3D.arithmetical_operation` methods. """ - if self._LUT_factory is None: - return - LUT_1 = self._LUT_factory() LUT_2 = self._LUT_factory() @@ -514,9 +457,6 @@ def test_linear_table(self): :class:`colour.io.luts.lut.LUT3D.linear_table` methods. """ - if self._LUT_factory is None: - return - LUT_1 = self._LUT_factory() np.testing.assert_allclose( @@ -526,9 +466,7 @@ def test_linear_table(self): ) np.testing.assert_allclose( - spow( - self._LUT_factory.linear_table(**self._table_3_kwargs), 1 / 2.6 - ), + spow(self._LUT_factory.linear_table(**self._table_3_kwargs), 1 / 2.6), self._table_3, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -540,13 +478,10 @@ def test_copy(self): :class:`colour.io.luts.lut.LUT3D.copy` methods. """ - if self._LUT_factory is None: - return - LUT_1 = self._LUT_factory() - self.assertIsNot(LUT_1, LUT_1.copy()) - self.assertEqual(LUT_1, LUT_1.copy()) + assert LUT_1 is not LUT_1.copy() + assert LUT_1.copy() == LUT_1 def test_invert(self): """ @@ -555,9 +490,6 @@ def test_invert(self): :class:`colour.io.luts.lut.LUT3D.invert` methods. """ - if self._LUT_factory is None: - return - LUT_i = self._LUT_factory(self._table_2).invert( interpolator=self._interpolator_1, **self._invert_kwargs_1 ) @@ -600,9 +532,6 @@ def test_apply(self): :class:`colour.io.luts.lut.LUT3D.apply` methods. """ - if self._LUT_factory is None: - return - LUT_1 = self._LUT_factory(self._table_2) np.testing.assert_allclose( @@ -643,20 +572,12 @@ def test_apply(self): ) -class TestLUT1D(AbstractLUTTest): +class TestLUT1D(FixtureAbstractLUT): """Define :class:`colour.io.luts.lut.LUT1D` class unit tests methods.""" - def __init__(self, *args: Any) -> None: - """ - Create an instance of the class. - - Other Parameters - ---------------- - args - Arguments. - """ - - super().__init__(*args) + @pytest.fixture(autouse=True) + def setup_test_lut_1_d(self) -> None: + """Configure the class instance.""" self._LUT_factory = LUT1D @@ -784,20 +705,12 @@ def __init__(self, *args: Any) -> None: self._applied_4 = self._inverted_apply_1 -class TestLUT3x1D(AbstractLUTTest): +class TestLUT3x1D(FixtureAbstractLUT): """Define :class:`colour.io.luts.lut.LUT3x1D` class unit tests methods.""" - def __init__(self, *args: Any) -> None: - """ - Create an instance of the class. - - Other Parameters - ---------------- - args - Arguments. - """ - - super().__init__(*args) + @pytest.fixture(autouse=True) + def setup_test_lut_3_x_1_d(self) -> None: + """Configure the class instance.""" self._LUT_factory = LUT3x1D @@ -956,20 +869,12 @@ def __init__(self, *args: Any) -> None: self._applied_4 = self._inverted_apply_1 -class TestLUT3D(AbstractLUTTest): +class TestLUT3D(FixtureAbstractLUT): """Define :class:`colour.io.luts.lut.LUT3D` class unit tests methods.""" - def __init__(self, *args: Any) -> None: - """ - Create an instance of the class. - - Other Parameters - ---------------- - args - Arguments. - """ - - super().__init__(*args) + @pytest.fixture(autouse=True) + def setup_test_lut_3_d(self) -> None: + """Configure the class instance.""" self._LUT_factory = LUT3D @@ -990,15 +895,18 @@ def __init__(self, *args: Any) -> None: self._domain_4 = self._domain_3 self._table_1 = as_float_array( np.flip( - np.transpose( - np.meshgrid( - *[ - np.linspace(axes[0], axes[1], 33) - for axes in reversed(tsplit(self._domain_1)) - ], - indexing="ij", - ) - ).reshape([33, 33, 33, 3]), + np.reshape( + np.transpose( + np.meshgrid( + *[ + np.linspace(axes[0], axes[1], 33) + for axes in reversed(tsplit(self._domain_1)) + ], + indexing="ij", + ) + ), + (33, 33, 33, 3), + ), -1, ) ) @@ -1006,15 +914,18 @@ def __init__(self, *args: Any) -> None: self._table_3 = as_float_array( spow( np.flip( - np.transpose( - np.meshgrid( - *[ - axes[: (~np.isnan(axes)).cumsum().argmax() + 1] - for axes in reversed(tsplit(self._domain_3)) - ], - indexing="ij", - ) - ).reshape([10, 15, 20, 3]), + np.reshape( + np.transpose( + np.meshgrid( + *[ + axes[: (~np.isnan(axes)).cumsum().argmax() + 1] + for axes in reversed(tsplit(self._domain_3)) + ], + indexing="ij", + ) + ), + (10, 15, 20, 3), + ), -1, ), 1 / 2.6, @@ -1149,13 +1060,13 @@ def __init__(self, *args: Any) -> None: self._applied_4 = self._inverted_apply_1 -class TestLUT_to_LUT(unittest.TestCase): +class TestLUT_to_LUT: """ Define :func:`colour.io.luts.lut.LUT_to_LUT` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._domain = np.array([[0.0, -0.1, -0.2], [1.0, 1.5, 3.0]]) @@ -1165,9 +1076,7 @@ def setUp(self): LUT3x1D.linear_table(16) ** (1 / 2.2) * (1.0, 0.75, 0.5), domain=self._domain, ) - self._LUT_3 = LUT3D( - LUT3D.linear_table(16) ** (1 / 2.2), domain=self._domain - ) + self._LUT_3 = LUT3D(LUT3D.linear_table(16) ** (1 / 2.2), domain=self._domain) def test_LUT_to_LUT(self): """Test :func:`colour.io.luts.lut.LUT_to_LUT` definition.""" @@ -1175,16 +1084,16 @@ def test_LUT_to_LUT(self): # "LUT" 1D to "LUT" 1D. LUT = LUT_to_LUT(self._LUT_1, LUT1D) - self.assertEqual(LUT, self._LUT_1) + assert LUT == self._LUT_1 # "LUT" 1D to "LUT" 3x1D. LUT = LUT_to_LUT(self._LUT_1, LUT3x1D) table = LUT1D.linear_table(16) ** (1 / 2.2) - self.assertEqual(LUT, LUT3x1D(tstack([table, table, table]))) + assert LUT3x1D(tstack([table, table, table])) == LUT # "LUT" 1D to "LUT" 3D. - self.assertRaises(ValueError, lambda: LUT_to_LUT(self._LUT_1, LUT3D)) + pytest.raises(ValueError, lambda: LUT_to_LUT(self._LUT_1, LUT3D)) LUT = LUT_to_LUT(self._LUT_1, LUT3D, force_conversion=True, size=5) @@ -1383,7 +1292,7 @@ def test_LUT_to_LUT(self): ) # "LUT" 3x1D to "LUT" 1D. - self.assertRaises(ValueError, lambda: LUT_to_LUT(self._LUT_2, LUT1D)) + pytest.raises(ValueError, lambda: LUT_to_LUT(self._LUT_2, LUT1D)) channel_weights = np.array([1.0, 0.0, 0.0]) LUT = LUT_to_LUT( @@ -1404,21 +1313,21 @@ def test_LUT_to_LUT(self): channel_weights=channel_weights, ) - self.assertEqual( - LUT, + assert ( LUT1D( np.sum(self._LUT_2.table * channel_weights, axis=-1), domain=domain, - ), + ) + == LUT ) # "LUT" 3x1D to "LUT" 3x1D. LUT = LUT_to_LUT(self._LUT_2, LUT3x1D) - self.assertEqual(LUT, self._LUT_2) + assert LUT == self._LUT_2 # "LUT" 3x1D to "LUT" 3D. - self.assertRaises(ValueError, lambda: LUT_to_LUT(self._LUT_2, LUT3D)) + pytest.raises(ValueError, lambda: LUT_to_LUT(self._LUT_2, LUT3D)) LUT = LUT_to_LUT(self._LUT_2, LUT3D, force_conversion=True, size=5) @@ -1617,7 +1526,7 @@ def test_LUT_to_LUT(self): ) # "LUT" 3D to "LUT" 1D. - self.assertRaises(ValueError, lambda: LUT_to_LUT(self._LUT_3, LUT1D)) + pytest.raises(ValueError, lambda: LUT_to_LUT(self._LUT_3, LUT1D)) channel_weights = np.array([1.0, 0.0, 0.0]) LUT = LUT_to_LUT( @@ -1688,7 +1597,7 @@ def test_LUT_to_LUT(self): ) # "LUT" 3D to "LUT" 3x1D. - self.assertRaises(ValueError, lambda: LUT_to_LUT(self._LUT_3, LUT3x1D)) + pytest.raises(ValueError, lambda: LUT_to_LUT(self._LUT_3, LUT3x1D)) LUT = LUT_to_LUT(self._LUT_3, LUT3x1D, force_conversion=True, size=16) @@ -1720,8 +1629,4 @@ def test_LUT_to_LUT(self): # "LUT" 3D to "LUT" 3D. LUT = LUT_to_LUT(self._LUT_3, LUT3D) - self.assertEqual(LUT, self._LUT_3) - - -if __name__ == "__main__": - unittest.main() + assert LUT == self._LUT_3 diff --git a/colour/io/luts/tests/test_operator.py b/colour/io/luts/tests/test_operator.py index 9a1a2623a2..416ce1ba3d 100644 --- a/colour/io/luts/tests/test_operator.py +++ b/colour/io/luts/tests/test_operator.py @@ -1,8 +1,6 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.luts.operator` module.""" import textwrap -import unittest import numpy as np @@ -23,7 +21,7 @@ ] -class TestAbstractLUTSequenceOperator(unittest.TestCase): +class TestAbstractLUTSequenceOperator: """ Define :class:`colour.io.luts.operator.AbstractLUTSequenceOperator` class unit tests methods. @@ -35,7 +33,7 @@ def test_required_attributes(self): required_attributes = ("name", "comments") for method in required_attributes: - self.assertIn(method, dir(AbstractLUTSequenceOperator)) + assert method in dir(AbstractLUTSequenceOperator) def test_required_methods(self): """Test the presence of required methods.""" @@ -43,20 +41,20 @@ def test_required_methods(self): required_methods = ("apply",) for method in required_methods: - self.assertIn(method, dir(AbstractLUTSequenceOperator)) + assert method in dir(AbstractLUTSequenceOperator) -class TestLUTOperatorMatrix(unittest.TestCase): +class TestLUTOperatorMatrix: """ Define :class:`colour.io.luts.operator.LUTOperatorMatrix` class unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._lut_operator_matrix = LUTOperatorMatrix( - np.linspace(0, 1, 16).reshape([4, 4]), + np.reshape(np.linspace(0, 1, 16), (4, 4)), offset=np.array([0.25, 0.5, 0.75, 1.0]), name="Nemo Matrix", comments=["A first comment.", "A second comment."], @@ -68,7 +66,7 @@ def test_required_attributes(self): required_attributes = ("matrix", "offset") for method in required_attributes: - self.assertIn(method, dir(LUTOperatorMatrix)) + assert method in dir(LUTOperatorMatrix) def test_required_methods(self): """Test the presence of required methods.""" @@ -76,7 +74,7 @@ def test_required_methods(self): required_methods = ("__str__", "__repr__", "__eq__", "__ne__", "apply") for method in required_methods: - self.assertIn(method, dir(LUTOperatorMatrix)) + assert method in dir(LUTOperatorMatrix) def test_matrix(self): """ @@ -87,9 +85,7 @@ def test_matrix(self): M = np.identity(3) lut_operator_matrix = LUTOperatorMatrix(M) - np.testing.assert_array_equal( - lut_operator_matrix.matrix, np.identity(4) - ) + np.testing.assert_array_equal(lut_operator_matrix.matrix, np.identity(4)) def test_offset(self): """ @@ -108,10 +104,11 @@ def test__str__(self): method. """ - self.assertEqual( - str(self._lut_operator_matrix), - textwrap.dedent( - """ + assert ( + str(self._lut_operator_matrix) + == ( + textwrap.dedent( + """ LUTOperatorMatrix - Nemo Matrix ------------------------------- @@ -123,7 +120,8 @@ def test__str__(self): A first comment. A second comment.""" - )[1:], + )[1:] + ) ) def test__repr__(self): @@ -132,8 +130,7 @@ def test__repr__(self): method. """ - self.assertEqual( - repr(self._lut_operator_matrix), + assert repr(self._lut_operator_matrix) == ( textwrap.dedent( """ LUTOperatorMatrix([[ 0. , 0.06666667, 0.13333333, 0.2 ], @@ -142,21 +139,19 @@ def test__repr__(self): [ 0.8 , 0.86666667, 0.93333333, 1. ]], [ 0.25, 0.5 , 0.75, 1. ], name='Nemo Matrix', - comments=['A first comment.', 'A second comment.'])"""[ - 1: - ] - ), + comments=['A first comment.', 'A second comment.'])"""[1:] + ) ) def test__eq__(self): """Test :class:`colour.io.luts.operator.LUTOperatorMatrix.__eq__` method.""" matrix = LUTOperatorMatrix( - np.linspace(0, 1, 16).reshape([4, 4]), + np.reshape(np.linspace(0, 1, 16), (4, 4)), np.array([0.25, 0.5, 0.75, 1.0]), ) - self.assertEqual(self._lut_operator_matrix, matrix) + assert self._lut_operator_matrix == matrix def test__neq__(self): """ @@ -164,11 +159,9 @@ def test__neq__(self): method. """ - matrix = LUTOperatorMatrix( - np.linspace(0, 1, 16).reshape([4, 4]) * 0.75 - ) + matrix = LUTOperatorMatrix(np.reshape(np.linspace(0, 1, 16), (4, 4)) * 0.75) - self.assertNotEqual(self._lut_operator_matrix, matrix) + assert self._lut_operator_matrix != matrix def test_apply(self): """Test :class:`colour.io.luts.operator.LUTOperatorMatrix.apply` method.""" @@ -237,7 +230,3 @@ def test_apply(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/io/luts/tests/test_resolve_cube.py b/colour/io/luts/tests/test_resolve_cube.py index 26a41c37ec..4cb24be0a2 100644 --- a/colour/io/luts/tests/test_resolve_cube.py +++ b/colour/io/luts/tests/test_resolve_cube.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.luts.resolve_cube` module.""" from __future__ import annotations @@ -6,9 +5,9 @@ import os import shutil import tempfile -import unittest import numpy as np +import pytest from colour.constants import TOLERANCE_ABSOLUTE_TESTS from colour.io import LUT1D, read_LUT_ResolveCube, write_LUT_ResolveCube @@ -26,12 +25,10 @@ "TestWriteLUTResolveCube", ] -ROOT_LUTS: str = os.path.join( - os.path.dirname(__file__), "resources", "resolve_cube" -) +ROOT_LUTS: str = os.path.join(os.path.dirname(__file__), "resources", "resolve_cube") -class TestReadLUTResolveCube(unittest.TestCase): +class TestReadLUTResolveCube: """ Define :func:`colour.io.luts.resolve_cube.read_LUT_ResolveCube` definition unit tests methods. @@ -87,29 +84,23 @@ def test_read_LUT_ResolveCube(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(LUT_1.name, "ACES Proxy 10 to ACES") - self.assertEqual(LUT_1.dimensions, 2) - np.testing.assert_array_equal( - LUT_1.domain, np.array([[0, 0, 0], [1, 1, 1]]) - ) - self.assertEqual(LUT_1.size, 32) - self.assertListEqual(LUT_1.comments, []) + assert LUT_1.name == "ACES Proxy 10 to ACES" + assert LUT_1.dimensions == 2 + np.testing.assert_array_equal(LUT_1.domain, np.array([[0, 0, 0], [1, 1, 1]])) + assert LUT_1.size == 32 + assert LUT_1.comments == [] LUT_2 = read_LUT_ResolveCube(os.path.join(ROOT_LUTS, "Demo.cube")) - self.assertListEqual(LUT_2.comments, ["Comments can't go anywhere"]) - np.testing.assert_array_equal( - LUT_2.domain, np.array([[0, 0, 0], [3, 3, 3]]) - ) + assert LUT_2.comments == ["Comments can't go anywhere"] + np.testing.assert_array_equal(LUT_2.domain, np.array([[0, 0, 0], [3, 3, 3]])) LUT_3 = read_LUT_ResolveCube( os.path.join(ROOT_LUTS, "Three_Dimensional_Table.cube") ) - self.assertEqual(LUT_3.dimensions, 3) - self.assertEqual(LUT_3.size, 2) + assert LUT_3.dimensions == 3 + assert LUT_3.size == 2 - LUT_4 = read_LUT_ResolveCube( - os.path.join(ROOT_LUTS, "LogC_Video.cube") - ) + LUT_4 = read_LUT_ResolveCube(os.path.join(ROOT_LUTS, "LogC_Video.cube")) np.testing.assert_allclose( LUT_4[0].table, np.array( @@ -134,21 +125,21 @@ def test_read_LUT_ResolveCube(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(LUT_4[1].size, 4) + assert LUT_4[1].size == 4 -class TestWriteLUTResolveCube(unittest.TestCase): +class TestWriteLUTResolveCube: """ Define :func:`colour.io.luts.resolve_cube.write_LUT_ResolveCube` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -165,18 +156,14 @@ def test_write_LUT_ResolveCube(self): write_LUT_ResolveCube( LUT_1_r, - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.cube" - ), + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.cube"), ) LUT_1_t = read_LUT_ResolveCube( - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.cube" - ) + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.cube") ) - self.assertEqual(LUT_1_r, LUT_1_t) + assert LUT_1_r == LUT_1_t LUT_2_r = read_LUT_ResolveCube(os.path.join(ROOT_LUTS, "Demo.cube")) @@ -188,8 +175,8 @@ def test_write_LUT_ResolveCube(self): os.path.join(self._temporary_directory, "Demo.cube") ) - self.assertEqual(LUT_2_r, LUT_2_t) - self.assertListEqual(LUT_2_r.comments, LUT_2_t.comments) + assert LUT_2_r == LUT_2_t + assert LUT_2_r.comments == LUT_2_t.comments LUT_3_r = read_LUT_ResolveCube( os.path.join(ROOT_LUTS, "Three_Dimensional_Table.cube") @@ -197,26 +184,20 @@ def test_write_LUT_ResolveCube(self): write_LUT_ResolveCube( LUT_3_r, - os.path.join( - self._temporary_directory, "Three_Dimensional_Table.cube" - ), + os.path.join(self._temporary_directory, "Three_Dimensional_Table.cube"), ) LUT_3_t = read_LUT_ResolveCube( - os.path.join( - self._temporary_directory, "Three_Dimensional_Table.cube" - ) + os.path.join(self._temporary_directory, "Three_Dimensional_Table.cube") ) - self.assertEqual(LUT_3_r, LUT_3_t) + assert LUT_3_r == LUT_3_t LUT_4_r = read_LUT_ResolveCube( os.path.join(ROOT_LUTS, "Three_Dimensional_Table_With_Shaper.cube") ) - LUT_4_r.sequence[0] = LUT_4_r.sequence[0].convert( - LUT1D, force_conversion=True - ) + LUT_4_r.sequence[0] = LUT_4_r.sequence[0].convert(LUT1D, force_conversion=True) write_LUT_ResolveCube( LUT_4_r, @@ -237,7 +218,7 @@ def test_write_LUT_ResolveCube(self): os.path.join(ROOT_LUTS, "Three_Dimensional_Table_With_Shaper.cube") ) - self.assertEqual(LUT_4_r, LUT_4_t) + assert LUT_4_r == LUT_4_t LUT_5_r = read_LUT_ResolveCube( os.path.join(ROOT_LUTS, "ACES_Proxy_10_to_ACES.cube") @@ -245,18 +226,14 @@ def test_write_LUT_ResolveCube(self): write_LUT_ResolveCube( LUT_5_r.convert(LUT1D, force_conversion=True), - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.cube" - ), + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.cube"), ) LUT_5_t = read_LUT_ResolveCube( - os.path.join( - self._temporary_directory, "ACES_Proxy_10_to_ACES.cube" - ) + os.path.join(self._temporary_directory, "ACES_Proxy_10_to_ACES.cube") ) - self.assertEqual(LUT_5_r, LUT_5_t) + assert LUT_5_r == LUT_5_t def test_raise_exception_write_LUT_ResolveCube(self): """ @@ -264,8 +241,4 @@ def test_raise_exception_write_LUT_ResolveCube(self): definition raised exception. """ - self.assertRaises(TypeError, write_LUT_ResolveCube, object(), "") - - -if __name__ == "__main__": - unittest.main() + pytest.raises(TypeError, write_LUT_ResolveCube, object(), "") diff --git a/colour/io/luts/tests/test_sequence.py b/colour/io/luts/tests/test_sequence.py index 79b36e11c0..ee7967b236 100644 --- a/colour/io/luts/tests/test_sequence.py +++ b/colour/io/luts/tests/test_sequence.py @@ -1,10 +1,8 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.luts.sequence` module.""" from __future__ import annotations import textwrap -import unittest import numpy as np @@ -32,13 +30,13 @@ ] -class TestLUTSequence(unittest.TestCase): +class TestLUTSequence: """ Define :class:`colour.io.luts.sequence.LUTSequence` class unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._LUT_1 = LUT1D(LUT1D.linear_table(16) + 0.125, "Nemo 1D") @@ -56,7 +54,7 @@ def test_required_attributes(self): required_attributes = ("sequence",) for attribute in required_attributes: - self.assertIn(attribute, dir(LUTSequence)) + assert attribute in dir(LUTSequence) def test_required_methods(self): """Test the presence of required methods.""" @@ -77,7 +75,7 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(LUTSequence)) + assert method in dir(LUTSequence) def test_sequence(self): """Test :class:`colour.io.luts.sequence.LUTSequence.sequence` property.""" @@ -85,22 +83,19 @@ def test_sequence(self): sequence = [self._LUT_1, self._LUT_2, self._LUT_3] LUT_sequence = LUTSequence() LUT_sequence.sequence = sequence - self.assertListEqual(self._LUT_sequence.sequence, sequence) + assert self._LUT_sequence.sequence == sequence def test__init__(self): """Test :class:`colour.io.luts.sequence.LUTSequence.__init__` method.""" - self.assertEqual( - LUTSequence(self._LUT_1, self._LUT_2, self._LUT_3), - self._LUT_sequence, - ) + assert LUTSequence(self._LUT_1, self._LUT_2, self._LUT_3) == self._LUT_sequence def test__getitem__(self): """Test :class:`colour.io.luts.sequence.LUTSequence.__getitem__` method.""" - self.assertEqual(self._LUT_sequence[0], self._LUT_1) - self.assertEqual(self._LUT_sequence[1], self._LUT_2) - self.assertEqual(self._LUT_sequence[2], self._LUT_3) + assert self._LUT_sequence[0] == self._LUT_1 + assert self._LUT_sequence[1] == self._LUT_2 + assert self._LUT_sequence[2] == self._LUT_3 def test__setitem__(self): """Test :class:`colour.io.luts.sequence.LUTSequence.__setitem__` method.""" @@ -110,9 +105,9 @@ def test__setitem__(self): LUT_sequence[1] = self._LUT_1 LUT_sequence[2] = self._LUT_2 - self.assertEqual(LUT_sequence[1], self._LUT_1) - self.assertEqual(LUT_sequence[2], self._LUT_2) - self.assertEqual(LUT_sequence[0], self._LUT_3) + assert LUT_sequence[1] == self._LUT_1 + assert LUT_sequence[2] == self._LUT_2 + assert LUT_sequence[0] == self._LUT_3 def test__delitem__(self): """Test :class:`colour.io.luts.sequence.LUTSequence.__delitem__` method.""" @@ -122,18 +117,17 @@ def test__delitem__(self): del LUT_sequence[0] del LUT_sequence[0] - self.assertEqual(LUT_sequence[0], self._LUT_3) + assert LUT_sequence[0] == self._LUT_3 def test__len__(self): """Test :class:`colour.io.luts.sequence.LUTSequence.__len__` method.""" - self.assertEqual(len(self._LUT_sequence), 3) + assert len(self._LUT_sequence) == 3 def test__str__(self): """Test :class:`colour.io.luts.sequence.LUTSequence.__str__` method.""" - self.assertEqual( - str(self._LUT_sequence), + assert str(self._LUT_sequence) == ( textwrap.dedent( """ LUT Sequence @@ -168,7 +162,7 @@ def test__str__(self): [ 1. 1. 1.]] Size : (16, 3) """ - ).strip(), + ).strip() ) def test__repr__(self): @@ -177,8 +171,7 @@ def test__repr__(self): LUT_sequence = self._LUT_sequence.copy() LUT_sequence[1].table = LUT3D.linear_table(5) - self.assertEqual( - repr(LUT_sequence), + assert repr(LUT_sequence) == ( textwrap.dedent( """ LUTSequence( @@ -364,7 +357,7 @@ def test__repr__(self): 16) ) """.strip() - ), + ) ) def test__eq__(self): @@ -373,18 +366,17 @@ def test__eq__(self): LUT_sequence_1 = LUTSequence(self._LUT_1, self._LUT_2, self._LUT_3) LUT_sequence_2 = LUTSequence(self._LUT_1, self._LUT_2) - self.assertEqual(self._LUT_sequence, LUT_sequence_1) + assert self._LUT_sequence == LUT_sequence_1 - self.assertNotEqual(self._LUT_sequence, self._LUT_sequence[0]) + assert self._LUT_sequence != self._LUT_sequence[0] - self.assertNotEqual(LUT_sequence_1, LUT_sequence_2) + assert LUT_sequence_1 != LUT_sequence_2 def test__neq__(self): """Test :class:`colour.io.luts.sequence.LUTSequence.__neq__` method.""" - self.assertNotEqual( - self._LUT_sequence, - LUTSequence(self._LUT_1, self._LUT_2.copy() * 0.75, self._LUT_3), + assert self._LUT_sequence != LUTSequence( + self._LUT_1, self._LUT_2.copy() * 0.75, self._LUT_3 ) def test_insert(self): @@ -394,14 +386,11 @@ def test_insert(self): LUT_sequence.insert(1, self._LUT_2.copy()) - self.assertEqual( - LUT_sequence, - LUTSequence( - self._LUT_1, - self._LUT_2, - self._LUT_2, - self._LUT_3, - ), + assert LUT_sequence == LUTSequence( + self._LUT_1, + self._LUT_2, + self._LUT_2, + self._LUT_3, ) def test_apply(self): @@ -421,7 +410,10 @@ def __init__(self, gamma: ArrayLike = 1) -> None: self._gamma = as_float_array(gamma) def apply( - self, RGB: ArrayLike, *args: Any, **kwargs: Any # noqa: ARG002 + self, + RGB: ArrayLike, + *args: Any, # noqa: ARG002 + **kwargs: Any, ) -> NDArrayFloat: """ Apply the *LUT* sequence operator to given *RGB* colourspace @@ -441,11 +433,7 @@ def apply( direction = kwargs.get("direction", "Forward") - gamma = ( - self._gamma - if direction == "Forward" - else 1.0 / self._gamma - ) + gamma = self._gamma if direction == "Forward" else 1.0 / self._gamma return as_float_array(gamma_function(RGB, gamma)) @@ -467,7 +455,3 @@ def apply( ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/io/luts/tests/test_sony_spi1d.py b/colour/io/luts/tests/test_sony_spi1d.py index 26c4b4f280..0f38327c2b 100644 --- a/colour/io/luts/tests/test_sony_spi1d.py +++ b/colour/io/luts/tests/test_sony_spi1d.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.luts.sony_spi1d` module.""" from __future__ import annotations @@ -6,7 +5,6 @@ import os import shutil import tempfile -import unittest import numpy as np @@ -26,12 +24,10 @@ "TestWriteLUTSonySPI1D", ] -ROOT_LUTS: str = os.path.join( - os.path.dirname(__file__), "resources", "sony_spi1d" -) +ROOT_LUTS: str = os.path.join(os.path.dirname(__file__), "resources", "sony_spi1d") -class TestReadLUTSonySPI1D(unittest.TestCase): +class TestReadLUTSonySPI1D: """ Define :func:`colour.io.luts.sony_spi1d.read_LUT_SonySPI1D` definition unit tests methods. @@ -40,9 +36,7 @@ class TestReadLUTSonySPI1D(unittest.TestCase): def test_read_LUT_SonySPI1D(self): """Test :func:`colour.io.luts.sony_spi1d.read_LUT_SonySPI1D` definition.""" - LUT_1 = read_LUT_SonySPI1D( - os.path.join(ROOT_LUTS, "eotf_sRGB_1D.spi1d") - ) + LUT_1 = read_LUT_SonySPI1D(os.path.join(ROOT_LUTS, "eotf_sRGB_1D.spi1d")) np.testing.assert_allclose( LUT_1.table, @@ -68,39 +62,37 @@ def test_read_LUT_SonySPI1D(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(LUT_1.name, "eotf sRGB 1D") - self.assertEqual(LUT_1.dimensions, 1) + assert LUT_1.name == "eotf sRGB 1D" + assert LUT_1.dimensions == 1 np.testing.assert_array_equal(LUT_1.domain, np.array([-0.1, 1.5])) - self.assertEqual(LUT_1.size, 16) - self.assertListEqual( - LUT_1.comments, - ['Generated by "Colour 0.3.11".', '"colour.models.eotf_sRGB".'], - ) - - LUT_2 = read_LUT_SonySPI1D( - os.path.join(ROOT_LUTS, "eotf_sRGB_3x1D.spi1d") - ) - self.assertListEqual( - LUT_2.comments, - ['Generated by "Colour 0.3.11".', '"colour.models.eotf_sRGB".'], - ) + assert LUT_1.size == 16 + assert LUT_1.comments == [ + 'Generated by "Colour 0.3.11".', + '"colour.models.eotf_sRGB".', + ] + + LUT_2 = read_LUT_SonySPI1D(os.path.join(ROOT_LUTS, "eotf_sRGB_3x1D.spi1d")) + assert LUT_2.comments == [ + 'Generated by "Colour 0.3.11".', + '"colour.models.eotf_sRGB".', + ] np.testing.assert_array_equal( LUT_2.domain, np.array([[-0.1, -0.1, -0.1], [1.5, 1.5, 1.5]]) ) -class TestWriteLUTSonySPI1D(unittest.TestCase): +class TestWriteLUTSonySPI1D: """ Define :func:`colour.io.luts.sony_spi1d.write_LUT_SonySPI1D` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -108,9 +100,7 @@ def tearDown(self): def test_write_LUT_SonySPI1D(self): """Test :func:`colour.io.luts.sony_spi1d.write_LUT_SonySPI1D` definition.""" - LUT_1_r = read_LUT_SonySPI1D( - os.path.join(ROOT_LUTS, "eotf_sRGB_1D.spi1d") - ) + LUT_1_r = read_LUT_SonySPI1D(os.path.join(ROOT_LUTS, "eotf_sRGB_1D.spi1d")) write_LUT_SonySPI1D( LUT_1_r, os.path.join(self._temporary_directory, "eotf_sRGB_1D.spi1d"), @@ -118,11 +108,9 @@ def test_write_LUT_SonySPI1D(self): LUT_1_t = read_LUT_SonySPI1D( os.path.join(self._temporary_directory, "eotf_sRGB_1D.spi1d") ) - self.assertEqual(LUT_1_r, LUT_1_t) + assert LUT_1_r == LUT_1_t - LUT_2_r = read_LUT_SonySPI1D( - os.path.join(ROOT_LUTS, "eotf_sRGB_3x1D.spi1d") - ) + LUT_2_r = read_LUT_SonySPI1D(os.path.join(ROOT_LUTS, "eotf_sRGB_3x1D.spi1d")) write_LUT_SonySPI1D( LUT_2_r, os.path.join(self._temporary_directory, "eotf_sRGB_3x1D.spi1d"), @@ -130,9 +118,5 @@ def test_write_LUT_SonySPI1D(self): LUT_2_t = read_LUT_SonySPI1D( os.path.join(self._temporary_directory, "eotf_sRGB_3x1D.spi1d") ) - self.assertEqual(LUT_2_r, LUT_2_t) - self.assertListEqual(LUT_2_r.comments, LUT_2_t.comments) - - -if __name__ == "__main__": - unittest.main() + assert LUT_2_r == LUT_2_t + assert LUT_2_r.comments == LUT_2_t.comments diff --git a/colour/io/luts/tests/test_sony_spi3d.py b/colour/io/luts/tests/test_sony_spi3d.py index 8a243ea48f..84c0415385 100644 --- a/colour/io/luts/tests/test_sony_spi3d.py +++ b/colour/io/luts/tests/test_sony_spi3d.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.luts.sony_spi3d` module.""" from __future__ import annotations @@ -6,7 +5,6 @@ import os import shutil import tempfile -import unittest import numpy as np @@ -32,12 +30,10 @@ "TestWriteLUTSonySPI3D", ] -ROOT_LUTS: str = os.path.join( - os.path.dirname(__file__), "resources", "sony_spi3d" -) +ROOT_LUTS: str = os.path.join(os.path.dirname(__file__), "resources", "sony_spi3d") -class TestReadLUTSonySPI3D(unittest.TestCase): +class TestReadLUTSonySPI3D: """ Define :func:`colour.io.luts.sony_spi3d.read_LUT_SonySPI3D` definition unit tests methods. @@ -46,9 +42,7 @@ class TestReadLUTSonySPI3D(unittest.TestCase): def test_read_LUT_SonySPI3D(self): """Test :func:`colour.io.luts.sony_spi3d.read_LUT_SonySPI3D` definition.""" - LUT_1 = read_LUT_SonySPI3D( - os.path.join(ROOT_LUTS, "Colour_Correct.spi3d") - ) + LUT_1 = read_LUT_SonySPI3D(os.path.join(ROOT_LUTS, "Colour_Correct.spi3d")) np.testing.assert_allclose( LUT_1.table, @@ -162,41 +156,35 @@ def test_read_LUT_SonySPI3D(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(LUT_1.name, "Colour Correct") - self.assertEqual(LUT_1.dimensions, 3) - np.testing.assert_array_equal( - LUT_1.domain, np.array([[0, 0, 0], [1, 1, 1]]) - ) - self.assertEqual(LUT_1.size, 4) - self.assertListEqual( - LUT_1.comments, ["Adapted from a LUT generated by Foundry::LUT."] - ) + assert LUT_1.name == "Colour Correct" + assert LUT_1.dimensions == 3 + np.testing.assert_array_equal(LUT_1.domain, np.array([[0, 0, 0], [1, 1, 1]])) + assert LUT_1.size == 4 + assert LUT_1.comments == ["Adapted from a LUT generated by Foundry::LUT."] LUT_2 = read_LUT_SonySPI3D( os.path.join(ROOT_LUTS, "Colour_Correct_Unordered.spi3d") ) - self.assertEqual(LUT_2, LUT_1) - self.assertEqual(LUT_2.name, "Colour Correct Unordered") - self.assertEqual(LUT_2.dimensions, 3) - self.assertEqual(LUT_2.size, 4) - self.assertListEqual( - LUT_2.comments, ["Adapted from a LUT generated by Foundry::LUT."] - ) + assert LUT_2 == LUT_1 + assert LUT_2.name == "Colour Correct Unordered" + assert LUT_2.dimensions == 3 + assert LUT_2.size == 4 + assert LUT_2.comments == ["Adapted from a LUT generated by Foundry::LUT."] -class TestWriteLUTSonySPI3D(unittest.TestCase): +class TestWriteLUTSonySPI3D: """ Define :func:`colour.io.luts.sony_spi3d.write_LUT_SonySPI3D` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -204,9 +192,7 @@ def tearDown(self): def test_write_LUT_SonySPI3D(self): """Test :func:`colour.io.luts.sony_spi3d.write_LUT_SonySPI3D` definition.""" - LUT_r = read_LUT_SonySPI3D( - os.path.join(ROOT_LUTS, "Colour_Correct.spi3d") - ) + LUT_r = read_LUT_SonySPI3D(os.path.join(ROOT_LUTS, "Colour_Correct.spi3d")) write_LUT_SonySPI3D( LUT_r, @@ -215,13 +201,13 @@ def test_write_LUT_SonySPI3D(self): LUT_t = read_LUT_SonySPI3D( os.path.join(self._temporary_directory, "Colour_Correct.spi3d") ) - self.assertEqual(LUT_r, LUT_t) + assert LUT_r == LUT_t write_LUT_SonySPI3D( LUTSequence(LUT_r), os.path.join(self._temporary_directory, "Colour_Correct.spi3d"), ) - self.assertEqual(LUT_r, LUT_t) + assert LUT_r == LUT_t # Test for proper indexes sequentiality. path = os.path.join(self._temporary_directory, "Size_10_Indexes.spi3d") @@ -229,9 +215,7 @@ def test_write_LUT_SonySPI3D(self): indexes = [] with open(path) as spi3d_file: - lines = filter( - None, (line.strip() for line in spi3d_file.readlines()) - ) + lines = filter(None, (line.strip() for line in spi3d_file.readlines())) for line in lines: tokens = line.split() if len(tokens) == 6: @@ -444,7 +428,3 @@ def test_write_LUT_SonySPI3D(self): ] ), ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/io/luts/tests/test_sony_spimtx.py b/colour/io/luts/tests/test_sony_spimtx.py index 0c149cf2a3..b04d3bb9d5 100644 --- a/colour/io/luts/tests/test_sony_spimtx.py +++ b/colour/io/luts/tests/test_sony_spimtx.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.luts.sony_spimtx` module.""" from __future__ import annotations @@ -6,7 +5,6 @@ import os import shutil import tempfile -import unittest import numpy as np @@ -26,12 +24,10 @@ "TestWriteLUTSonySPImtx", ] -ROOT_LUTS: str = os.path.join( - os.path.dirname(__file__), "resources", "sony_spimtx" -) +ROOT_LUTS: str = os.path.join(os.path.dirname(__file__), "resources", "sony_spimtx") -class TestReadLUTSonySPImtx(unittest.TestCase): +class TestReadLUTSonySPImtx: """ Define :func:`colour.io.luts.sony_spimtx.read_LUT_SonySPImtx` definition unit tests methods. @@ -62,11 +58,9 @@ def test_read_LUT_SonySPImtx(self): np.array([0.000000, 0.000000, 0.000000, 0.000000]), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(LUT_1.name, "dt") + assert LUT_1.name == "dt" - LUT_2 = read_LUT_SonySPImtx( - os.path.join(ROOT_LUTS, "p3_to_xyz16.spimtx") - ) + LUT_2 = read_LUT_SonySPImtx(os.path.join(ROOT_LUTS, "p3_to_xyz16.spimtx")) np.testing.assert_allclose( LUT_2.matrix, np.array( @@ -84,11 +78,9 @@ def test_read_LUT_SonySPImtx(self): np.array([0.000000, 0.000000, 0.000000, 0.000000]), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(LUT_2.name, "p3 to xyz16") + assert LUT_2.name == "p3 to xyz16" - LUT_3 = read_LUT_SonySPImtx( - os.path.join(ROOT_LUTS, "Matrix_Offset.spimtx") - ) + LUT_3 = read_LUT_SonySPImtx(os.path.join(ROOT_LUTS, "Matrix_Offset.spimtx")) np.testing.assert_allclose( LUT_3.matrix, np.array( @@ -106,21 +98,21 @@ def test_read_LUT_SonySPImtx(self): np.array([0.0, 0.0, 1.0, 0.0]), atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(LUT_3.name, "Matrix Offset") + assert LUT_3.name == "Matrix Offset" -class TestWriteLUTSonySPImtx(unittest.TestCase): +class TestWriteLUTSonySPImtx: """ Define :func:`colour.io.luts.sony_spimtx.write_LUT_SonySPImtx` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -138,11 +130,9 @@ def test_write_LUT_SonySPImtx(self): LUT_1_t = read_LUT_SonySPImtx( os.path.join(self._temporary_directory, "dt.spimtx") ) - self.assertEqual(LUT_1_r, LUT_1_t) + assert LUT_1_r == LUT_1_t - LUT_2_r = read_LUT_SonySPImtx( - os.path.join(ROOT_LUTS, "p3_to_xyz16.spimtx") - ) + LUT_2_r = read_LUT_SonySPImtx(os.path.join(ROOT_LUTS, "p3_to_xyz16.spimtx")) write_LUT_SonySPImtx( LUT_2_r, os.path.join(self._temporary_directory, "p3_to_xyz16.spimtx"), @@ -150,9 +140,5 @@ def test_write_LUT_SonySPImtx(self): LUT_2_t = read_LUT_SonySPImtx( os.path.join(self._temporary_directory, "p3_to_xyz16.spimtx") ) - self.assertEqual(LUT_2_r, LUT_2_t) - self.assertListEqual(LUT_2_r.comments, LUT_2_t.comments) - - -if __name__ == "__main__": - unittest.main() + assert LUT_2_r == LUT_2_t + assert LUT_2_r.comments == LUT_2_t.comments diff --git a/colour/io/ocio.py b/colour/io/ocio.py index 1057cd35a1..c29b209b6b 100644 --- a/colour/io/ocio.py +++ b/colour/io/ocio.py @@ -2,7 +2,7 @@ OpenColorIO Processing ====================== -Defines the object for *OpenColorIO* processing: +Define the object for *OpenColorIO* processing: - :func:`colour.io.process_image_OpenColorIO` """ @@ -27,14 +27,8 @@ ] -# TODO: Reinstate coverage and doctests when "Pypi" wheel compatible with "ARM" -# on "macOS" is released. - - @required("OpenColorIO") -def process_image_OpenColorIO( - a: ArrayLike, *args: Any, **kwargs: Any -) -> NDArrayFloat: # pragma: no cover +def process_image_OpenColorIO(a: ArrayLike, *args: Any, **kwargs: Any) -> NDArrayFloat: """ Process given image data with *OpenColorIO*. @@ -142,7 +136,7 @@ def process_image_OpenColorIO( a = as_float_array(a) shape, dtype = a.shape, a.dtype - a = as_3_channels_image(a).astype(np.float32) + a = np.ascontiguousarray(as_3_channels_image(a).astype(np.float32)) height, width, channels = a.shape @@ -154,7 +148,7 @@ def process_image_OpenColorIO( processor.apply(image_desc) - b = image_desc.getData().reshape([height, width, channels]).astype(dtype) + b = np.reshape(image_desc.getData(), (height, width, channels)).astype(dtype) if len(shape) == 0: return as_float(np.squeeze(b)[0]) diff --git a/colour/io/tabular.py b/colour/io/tabular.py index 13d1e8c647..5388793809 100644 --- a/colour/io/tabular.py +++ b/colour/io/tabular.py @@ -2,7 +2,7 @@ CSV Tabular Data Input / Output =============================== -Defines various input / output objects for *CSV* tabular data files: +Define various input / output objects for *CSV* tabular data files: - :func:`colour.read_spectral_data_from_csv_file` - :func:`colour.read_sds_from_csv_file` @@ -14,6 +14,7 @@ import csv import os import tempfile +from pathlib import Path import numpy as np @@ -37,16 +38,16 @@ def read_spectral_data_from_csv_file( - path: str, **kwargs: Any + path: str | Path, **kwargs: Any ) -> Dict[str, NDArrayFloat]: """ Read the spectral data from given *CSV* file in the following form:: - 390, 4.15003E-04, 3.68349E-04, 9.54729E-03 - 395, 1.05192E-03, 9.58658E-04, 2.38250E-02 - 400, 2.40836E-03, 2.26991E-03, 5.66498E-02 + 390, 4.15003e-04, 3.68349e-04, 9.54729e-03 + 395, 1.05192e-03, 9.58658e-04, 2.38250e-02 + 400, 2.40836e-03, 2.26991e-03, 5.66498e-02 ... - 830, 9.74306E-07, 9.53411E-08, 0.00000 + 830, 9.74306e-07, 9.53411e-08, 0.00000 and returns it as an *dict* as follows:: @@ -118,8 +119,13 @@ def read_spectral_data_from_csv_file( '24'] """ + path = str(path) + settings = { + "names": True, + "delimiter": ",", "case_sensitive": True, + # "case_sensitive": "lower", "deletechars": "", "replace_space": " ", "dtype": DTYPE_FLOAT_DEFAULT, @@ -129,29 +135,27 @@ def read_spectral_data_from_csv_file( transpose = settings.get("transpose") if transpose: delimiter = cast(str, settings.get("delimiter", ",")) - if settings.get("delimiter") is not None: - del settings["delimiter"] with open(path) as csv_file: content = zip(*csv.reader(csv_file, delimiter=delimiter)) - transposed_csv_file = tempfile.NamedTemporaryFile( - mode="w", delete=False - ) + settings["delimiter"] = "," + + transposed_csv_file = tempfile.NamedTemporaryFile(mode="w", delete=False) path = transposed_csv_file.name csv.writer(transposed_csv_file).writerows(content) transposed_csv_file.close() - data = np.recfromcsv(path, **filter_kwargs(np.genfromtxt, **settings)) + data = np.genfromtxt(path, **filter_kwargs(np.genfromtxt, **settings)) if transpose: os.unlink(transposed_csv_file.name) - return {name: data[name] for name in data.dtype.names} + return {name: data[name] for name in data.dtype.names} # pyright: ignore def read_sds_from_csv_file( - path: str, **kwargs: Any + path: str | Path, **kwargs: Any ) -> Dict[str, SpectralDistribution]: """ Read the spectral data from given *CSV* file and returns its content as a @@ -276,6 +280,8 @@ def read_sds_from_csv_file( {'method': 'Constant', 'left': None, 'right': None}) """ + path = str(path) + data = read_spectral_data_from_csv_file(path, **kwargs) fields = list(data.keys()) @@ -292,7 +298,7 @@ def read_sds_from_csv_file( def write_sds_to_csv_file( - sds: Dict[str, SpectralDistribution], path: str + sds: Dict[str, SpectralDistribution], path: str | Path ) -> bool: """ Write the given spectral distributions to given *CSV* file. @@ -315,6 +321,8 @@ def write_sds_to_csv_file( If the given spectral distributions have different shapes. """ + path = str(path) + if len(sds) != 1: shapes = [sd.shape for sd in sds.values()] if not all(shape == shapes[0] for shape in shapes): diff --git a/colour/io/tests/resources/BiSpectral.exr b/colour/io/tests/resources/BiSpectral.exr new file mode 100644 index 0000000000..c0885ae9e2 Binary files /dev/null and b/colour/io/tests/resources/BiSpectral.exr differ diff --git a/colour/io/tests/resources/D65.exr b/colour/io/tests/resources/D65.exr new file mode 100644 index 0000000000..c0a25fa28f Binary files /dev/null and b/colour/io/tests/resources/D65.exr differ diff --git a/colour/io/tests/resources/Ohta1997.exr b/colour/io/tests/resources/Ohta1997.exr new file mode 100644 index 0000000000..9050c9db60 Binary files /dev/null and b/colour/io/tests/resources/Ohta1997.exr differ diff --git a/colour/io/tests/resources/Polarised.exr b/colour/io/tests/resources/Polarised.exr new file mode 100644 index 0000000000..70052a0c1a Binary files /dev/null and b/colour/io/tests/resources/Polarised.exr differ diff --git a/colour/io/tests/test_ctl.py b/colour/io/tests/test_ctl.py index ee0146bfd2..f2e533b952 100644 --- a/colour/io/tests/test_ctl.py +++ b/colour/io/tests/test_ctl.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.ctl` module.""" from __future__ import annotations @@ -7,7 +6,6 @@ import shutil import tempfile import textwrap -import unittest import numpy as np @@ -42,15 +40,15 @@ # cross-platform. -class TestCtlRender(unittest.TestCase): +class TestCtlRender: """Define :func:`colour.io.ctl.ctl_render` definition unit tests methods.""" - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -119,7 +117,7 @@ def test_ctl_render(self): # pragma: no cover ) -class TestProcessImageCtl(unittest.TestCase): +class TestProcessImageCtl: """ Define :func:`colour.io.ctl.process_image_ctl` definition unit tests methods. @@ -197,7 +195,7 @@ def test_process_image_ctl(self): # pragma: no cover ) -class TestTemplateCtlTransformFloat(unittest.TestCase): +class TestTemplateCtlTransformFloat: """ Define :func:`colour.io.ctl.template_ctl_transform_float` definition unit tests methods. @@ -245,14 +243,12 @@ def test_template_ctl_transform_float(self): gOut = gIn + foo[1]; bOut = bIn + foo[2]; aOut = aIn; - }"""[ - 1: - ] + }"""[1:] ) - self.assertEqual(ctl_foo_bar_float, target) + assert ctl_foo_bar_float == target -class TestTemplateCtlTransformFloat3(unittest.TestCase): +class TestTemplateCtlTransformFloat3: """ Define :func:`colour.io.ctl.template_ctl_transform_float3` definition unit tests methods. @@ -285,9 +281,7 @@ def test_template_ctl_transform_float3(self): return rgbOut; } -"""[ - 1: - ] +"""[1:] ), ) # fmt: off @@ -336,8 +330,4 @@ def test_template_ctl_transform_float3(self): 1: ] ) - self.assertEqual(ctl_foo_bar_float3, target) - - -if __name__ == "__main__": - unittest.main() + assert ctl_foo_bar_float3 == target diff --git a/colour/io/tests/test_fichet2021.py b/colour/io/tests/test_fichet2021.py new file mode 100644 index 0000000000..1bc145328b --- /dev/null +++ b/colour/io/tests/test_fichet2021.py @@ -0,0 +1,531 @@ +"""Define the unit tests for the :mod:`colour.io.fichet2021` module.""" + +from __future__ import annotations + +import os +import shutil +import tempfile + +import numpy as np + +from colour.characterisation import SDS_COLOURCHECKERS +from colour.colorimetry import ( + MSDS_CMFS, + SDS_ILLUMINANTS, + SpectralShape, + sds_and_msds_to_msds, +) +from colour.constants import CONSTANT_LIGHT_SPEED, TOLERANCE_ABSOLUTE_TESTS +from colour.io import ( + Specification_Fichet2021, + read_spectral_image_Fichet2021, + sd_to_spectrum_attribute_Fichet2021, + spectrum_attribute_to_sd_Fichet2021, + write_spectral_image_Fichet2021, +) +from colour.io.fichet2021 import ( + components_to_sRGB_Fichet2021, + match_groups_to_nm, + sds_and_msds_to_components_Fichet2021, +) +from colour.utilities import is_openimageio_installed + +__author__ = "Colour Developers" +__copyright__ = "Copyright 2013 Colour Developers" +__license__ = "BSD-3-Clause - https://opensource.org/licenses/BSD-3-Clause" +__maintainer__ = "Colour Developers" +__email__ = "colour-developers@colour-science.org" +__status__ = "Production" + +__all__ = [ + "ROOT_RESOURCES", + "TestMatchGroupsToNm", + "TestSdToSpectrumAttributeFichet2021", + "TestSpectrumAttributeToSdFichet2021", + "TestSdsAndMsdsToComponentsFichet2021", + "TestComponentsToSRGBFichet2021", + "TestReadSpectralImageFichet2021", + "TestWriteSpectralImageFichet2021", +] + +ROOT_RESOURCES: str = os.path.join(os.path.dirname(__file__), "resources") + + +class TestMatchGroupsToNm: + """ + Define :func:`colour.io.fichet2021.match_groups_to_nm` definition unit + tests methods. + """ + + def test_match_groups_to_nm(self): + """Test :func:`colour.io.fichet2021.match_groups_to_nm` definition.""" + + np.testing.assert_allclose( + match_groups_to_nm("555.5", "n", "m"), + 555.5, + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + match_groups_to_nm("555.5", "", "m"), + 555500000000.0, + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + match_groups_to_nm(str(CONSTANT_LIGHT_SPEED / (555 * 1e-9)), "", "Hz"), + 555.0, + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + +class TestSdToSpectrumAttributeFichet2021: + """ + Define :func:`colour.io.fichet2021.sd_to_spectrum_attribute_Fichet2021` + definition unit tests methods. + """ + + def test_sd_to_spectrum_attribute_Fichet2021(self): + """ + Test :func:`colour.io.fichet2021.\ +sd_to_spectrum_attribute_Fichet2021` definition. + """ + + assert ( + sd_to_spectrum_attribute_Fichet2021(SDS_ILLUMINANTS["D65"], 2)[:56] + == "300.00nm:0.03;305.00nm:1.66;310.00nm:3.29;315.00nm:11.77" + ) + + +class TestSpectrumAttributeToSdFichet2021: + """ + Define :func:`colour.io.fichet2021.spectrum_attribute_to_sd_Fichet2021` + definition unit tests methods. + """ + + def test_spectrum_attribute_to_sd_Fichet2021(self): + """ + Test :func:`colour.io.fichet2021.\ +spectrum_attribute_to_sd_Fichet2021` definition. + """ + + sd = spectrum_attribute_to_sd_Fichet2021( + "300.00nm:0.03;305.00nm:1.66;310.00nm:3.29;315.00nm:11.77" + ) + + np.testing.assert_allclose( + sd.wavelengths, + np.array([300.0, 305.0, 310.0, 315.0]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + sd.values, + np.array([0.03, 1.66, 3.29, 11.77]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + +class TestSdsAndMsdsToComponentsFichet2021: + """ + Define :func:`colour.io.fichet2021.sds_and_msds_to_components_Fichet2021` + definition unit tests methods. + """ + + def test_sds_and_msds_to_components_Fichet2021(self): + """ + Test :func:`colour.io.fichet2021.\ +sds_and_msds_to_components_Fichet2021` definition. + """ + + components = sds_and_msds_to_components_Fichet2021(SDS_ILLUMINANTS["D65"]) + + assert "T" in components + + components = sds_and_msds_to_components_Fichet2021( + SDS_ILLUMINANTS["D65"], Specification_Fichet2021(is_emissive=True) + ) + + assert "S0" in components + + np.testing.assert_allclose( + components["S0"][0], + SDS_ILLUMINANTS["D65"].wavelengths, + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + components["S0"][1], + np.reshape(SDS_ILLUMINANTS["D65"].values, (1, 1, -1)), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + components = sds_and_msds_to_components_Fichet2021( + list(SDS_COLOURCHECKERS["ColorChecker N Ohta"].values()) + ) + + assert components["T"][1].shape == (1, 24, 81) + + +class TestComponentsToSRGBFichet2021: + """ + Define :func:`colour.io.fichet2021.components_to_sRGB_Fichet2021` + definition unit tests methods. + """ + + def test_components_to_sRGB_Fichet2021(self): + """ + Test :func:`colour.io.fichet2021.components_to_sRGB_Fichet2021` + definition. + """ + + if not is_openimageio_installed(): + return + + specification = Specification_Fichet2021(is_emissive=True) + components = sds_and_msds_to_components_Fichet2021( + SDS_ILLUMINANTS["D65"], specification + ) + RGB, attributes = components_to_sRGB_Fichet2021(components, specification) + + np.testing.assert_allclose( + RGB, + np.array([[[0.17998291, 0.18000802, 0.18000908]]]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + assert [attribute.name for attribute in attributes] == [ + "X", + "Y", + "Z", + "illuminant", + "chromaticities", + "EV", + ] + + for attribute in attributes: + if attribute.name == "X": + sd_X = spectrum_attribute_to_sd_Fichet2021(attribute.value) + np.testing.assert_allclose( + sd_X.values, + MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] + .signals["x_bar"] + .values, + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + elif attribute.name == "illuminant": + sd_illuminant = spectrum_attribute_to_sd_Fichet2021(attribute.value) + np.testing.assert_allclose( + sd_illuminant.values, + SDS_ILLUMINANTS["E"].values, + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + elif attribute.name == "chromaticities": + assert attribute.value == [ + 0.64, + 0.33, + 0.3, + 0.6, + 0.15, + 0.06, + 0.3127, + 0.329, + ] + + specification = Specification_Fichet2021(is_emissive=False) + components = sds_and_msds_to_components_Fichet2021( + list(SDS_COLOURCHECKERS["ColorChecker N Ohta"].values()), specification + ) + RGB, attributes = components_to_sRGB_Fichet2021(components, specification) + + np.testing.assert_allclose( + RGB, + np.array( + [ + [ + [0.17617566, 0.07822266, 0.05031637], + [0.55943028, 0.30875974, 0.22283237], + [0.11315875, 0.19922170, 0.33614049], + [0.09458646, 0.14840988, 0.04988729], + [0.23628263, 0.22587419, 0.44382286], + [0.13383963, 0.51702099, 0.40286142], + [0.70140973, 0.19925074, 0.02292392], + [0.06838428, 0.10600215, 0.37710859], + [0.55811797, 0.09062764, 0.12199424], + [0.10779019, 0.04434715, 0.14682113], + [0.34888054, 0.50195490, 0.04773998], + [0.79166868, 0.36502900, 0.02678776], + [0.02722027, 0.04781536, 0.30913913], + [0.06013188, 0.30558427, 0.06062012], + [0.44611192, 0.02849786, 0.04207225], + [0.85188200, 0.57960585, 0.01053590], + [0.50608734, 0.08898812, 0.29720873], + [-0.03338628, 0.24880620, 0.38541145], + [0.88687341, 0.88867240, 0.87460352], + [0.58637305, 0.58330907, 0.58216473], + [0.35827233, 0.35810703, 0.35873042], + [0.20316001, 0.20298624, 0.20353015], + [0.09106388, 0.09288101, 0.09424415], + [0.03266569, 0.03364008, 0.03526672], + ] + ] + ), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + assert [attribute.name for attribute in attributes] == [ + "X", + "Y", + "Z", + "illuminant", + "chromaticities", + ] + + for attribute in attributes: + if attribute.name == "illuminant": + sd_illuminant = spectrum_attribute_to_sd_Fichet2021(attribute.value) + np.testing.assert_allclose( + sd_illuminant.values, + SDS_ILLUMINANTS["D65"].values, + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + +def _test_spectral_image_D65(path): + """Test the *D65* spectral image.""" + + components = read_spectral_image_Fichet2021(path) + + assert "S0" in components + + np.testing.assert_allclose( + components["S0"][0], + SDS_ILLUMINANTS["D65"].wavelengths, + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + components["S0"][1], + np.reshape(SDS_ILLUMINANTS["D65"].values, (1, 1, -1)), + atol=0.05, + ) + + components, specification = read_spectral_image_Fichet2021( + os.path.join(ROOT_RESOURCES, "D65.exr"), additional_data=True + ) + + assert specification.is_emissive is True + assert specification.is_polarised is False + assert specification.is_bispectral is False + + attribute_names = [attribute.name for attribute in specification.attributes] + + for attribute_name in [ + "EV", + "X", + "Y", + "Z", + "chromaticities", + "emissiveUnits", + "illuminant", + "polarisationHandedness", + "spectralLayoutVersion", + ]: + assert attribute_name in attribute_names + + for attribute in specification.attributes: + if attribute.name == "spectralLayoutVersion": + assert attribute.value == "1.0" + elif attribute.name == "polarisationHandedness": + assert attribute.value == "right" + elif attribute.name == "emissiveUnits": + assert attribute.value == "W.m^-2.sr^-1" + elif attribute.name == "illuminant": + sd_illuminant = spectrum_attribute_to_sd_Fichet2021(attribute.value) + np.testing.assert_allclose( + sd_illuminant.values, + SDS_ILLUMINANTS["D65"].values, + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + +def _test_spectral_image_Ohta1997(path): + """Test the *Ohta (1997)* spectral image.""" + + components, specification = read_spectral_image_Fichet2021( + path, additional_data=True + ) + + assert "T" in components + + msds = sds_and_msds_to_msds( + [ + sd.copy().align(SpectralShape(400, 700, 20)) + for sd in SDS_COLOURCHECKERS["ColorChecker N Ohta"].values() + ] + ) + + np.testing.assert_allclose( + components["T"][0], + msds.wavelengths, + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + components["T"][1], + np.reshape(np.transpose(msds.values), (4, 6, -1)), + atol=0.0005, + ) + + assert specification.is_emissive is False + assert specification.is_polarised is False + assert specification.is_bispectral is False + + +def _test_spectral_image_Polarised(path): + """Test the *Polarised* spectral image.""" + + components, specification = read_spectral_image_Fichet2021( + path, additional_data=True + ) + + assert list(components.keys()) == ["S0", "S1", "S2", "S3"] + + assert specification.is_emissive is True + assert specification.is_polarised is True + assert specification.is_bispectral is False + + +def _test_spectral_image_BiSpectral(path): + """Test the *Bi-Spectral* image.""" + + components, specification = read_spectral_image_Fichet2021( + path, additional_data=True + ) + + assert list(components.keys()) == [ + "T", + 380.0, + 390.0, + 400.0, + 410.0, + 420.0, + 430.0, + 440.0, + 450.0, + 460.0, + 470.0, + 480.0, + 490.0, + 500.0, + 510.0, + 520.0, + 530.0, + 540.0, + 550.0, + 560.0, + 570.0, + 580.0, + 590.0, + 600.0, + 610.0, + 620.0, + 630.0, + 640.0, + 650.0, + 660.0, + 670.0, + 680.0, + 690.0, + 700.0, + 710.0, + 720.0, + 730.0, + 740.0, + 750.0, + 760.0, + 770.0, + ] + + assert specification.is_emissive is False + assert specification.is_polarised is False + assert specification.is_bispectral is True + + +class TestReadSpectralImageFichet2021: + """ + Define :func:`colour.io.fichet2021.read_spectral_image_Fichet2021` + definition unit tests methods. + """ + + def test_read_spectral_image_Fichet2021(self): + """ + Test :func:`colour.io.fichet2021.read_spectral_image_Fichet2021` + definition. + """ + + if not is_openimageio_installed(): + return + + _test_spectral_image_D65(os.path.join(ROOT_RESOURCES, "D65.exr")) + + _test_spectral_image_Ohta1997(os.path.join(ROOT_RESOURCES, "Ohta1997.exr")) + + _test_spectral_image_Polarised(os.path.join(ROOT_RESOURCES, "Polarised.exr")) + + _test_spectral_image_BiSpectral(os.path.join(ROOT_RESOURCES, "BiSpectral.exr")) + + +class TestWriteSpectralImageFichet2021: + """ + Define :func:`colour.io.fichet2021.write_spectral_image_Fichet2021` + definition unit tests methods. + """ + + def setup_method(self): + """Initialise the common tests attributes.""" + + self._temporary_directory = tempfile.mkdtemp() + + def teardown_method(self): + """After tests actions.""" + + shutil.rmtree(self._temporary_directory) + + def test_write_spectral_image_Fichet2021(self): + """ + Test :func:`colour.io.fichet2021.write_spectral_image_Fichet2021` + definition. + """ + + if not is_openimageio_installed(): + return + + path = os.path.join(self._temporary_directory, "D65.exr") + specification = Specification_Fichet2021(is_emissive=True) + write_spectral_image_Fichet2021( + SDS_ILLUMINANTS["D65"], path, "float16", specification + ) + _test_spectral_image_D65(path) + + path = os.path.join(self._temporary_directory, "D65.exr") + msds = [ + sd.copy().align(SpectralShape(400, 700, 20)) + for sd in SDS_COLOURCHECKERS["ColorChecker N Ohta"].values() + ] + specification = Specification_Fichet2021(is_emissive=False) + write_spectral_image_Fichet2021( + msds, path, "float16", specification, shape=(4, 6, 16) + ) + _test_spectral_image_Ohta1997(path) + + for basename, test_callable in [ + ("Polarised.exr", _test_spectral_image_Polarised), + ("BiSpectral.exr", _test_spectral_image_BiSpectral), + ]: + components, specification = read_spectral_image_Fichet2021( + os.path.join(ROOT_RESOURCES, basename), additional_data=True + ) + path = os.path.join(self._temporary_directory, basename) + write_spectral_image_Fichet2021(components, path, "float16", specification) + test_callable(path) diff --git a/colour/io/tests/test_image.py b/colour/io/tests/test_image.py index 6996957966..066a86ea2b 100644 --- a/colour/io/tests/test_image.py +++ b/colour/io/tests/test_image.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.image` module.""" from __future__ import annotations @@ -7,15 +6,16 @@ import platform import shutil import tempfile -import unittest import numpy as np +import pytest from colour.constants import TOLERANCE_ABSOLUTE_TESTS from colour.io import ( - ImageAttribute_Specification, + Image_Specification_Attribute, as_3_channels_image, convert_bit_depth, + image_specification_OpenImageIO, read_image, read_image_Imageio, read_image_OpenImageIO, @@ -34,18 +34,50 @@ __all__ = [ "ROOT_RESOURCES", + "TestImageSpecificationOpenImageIO", + "TestConvertBitDepth", "TestReadImageOpenImageIO", "TestWriteImageOpenImageIO", "TestReadImageImageio", "TestWriteImageImageio", "TestReadImage", "TestWriteImage", + "TestAs3ChannelsImage", ] ROOT_RESOURCES: str = os.path.join(os.path.dirname(__file__), "resources") -class TestConvertBitDepth(unittest.TestCase): +class TestImageSpecificationOpenImageIO: + """ + Define :func:`colour.io.image.image_specification_OpenImageIO` definition + unit tests methods. + """ + + def test_image_specification_OpenImageIO(self): # pragma: no cover + """ + Test :func:`colour.io.image.image_specification_OpenImageIO` + definition. + """ + + if not is_openimageio_installed(): + return + + from OpenImageIO import HALF + + compression = Image_Specification_Attribute("Compression", "none") + specification = image_specification_OpenImageIO( + 1920, 1080, 3, "float16", [compression] + ) + + assert specification.width == 1920 + assert specification.height == 1080 + assert specification.nchannels == 3 + assert specification.format == HALF + assert specification.extra_attribs[0].name == "Compression" + + +class TestConvertBitDepth: """ Define :func:`colour.io.image.convert_bit_depth` definition unit tests methods. @@ -55,10 +87,10 @@ def test_convert_bit_depth(self): """Test :func:`colour.io.image.convert_bit_depth` definition.""" a = np.around(np.linspace(0, 1, 10) * 255).astype("uint8") - self.assertIs(convert_bit_depth(a, "uint8").dtype, np.dtype("uint8")) + assert convert_bit_depth(a, "uint8").dtype is np.dtype("uint8") np.testing.assert_equal(convert_bit_depth(a, "uint8"), a) - self.assertIs(convert_bit_depth(a, "uint16").dtype, np.dtype("uint16")) + assert convert_bit_depth(a, "uint16").dtype is np.dtype("uint16") np.testing.assert_equal( convert_bit_depth(a, "uint16"), np.array( @@ -77,9 +109,7 @@ def test_convert_bit_depth(self): ), ) - self.assertIs( - convert_bit_depth(a, "float16").dtype, np.dtype("float16") - ) + assert convert_bit_depth(a, "float16").dtype is np.dtype("float16") np.testing.assert_allclose( convert_bit_depth(a, "float16"), np.array( @@ -99,9 +129,7 @@ def test_convert_bit_depth(self): atol=5e-4, ) - self.assertIs( - convert_bit_depth(a, "float32").dtype, np.dtype("float32") - ) + assert convert_bit_depth(a, "float32").dtype is np.dtype("float32") np.testing.assert_allclose( convert_bit_depth(a, "float32"), np.array( @@ -121,28 +149,22 @@ def test_convert_bit_depth(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertIs( - convert_bit_depth(a, "float64").dtype, np.dtype("float64") - ) + assert convert_bit_depth(a, "float64").dtype is np.dtype("float64") if hasattr(np, "float128"): # pragma: no cover - self.assertIs( - convert_bit_depth(a, "float128").dtype, np.dtype("float128") - ) + assert convert_bit_depth(a, "float128").dtype is np.dtype("float128") a = np.around(np.linspace(0, 1, 10) * 65535).astype("uint16") - self.assertIs(convert_bit_depth(a, "uint8").dtype, np.dtype("uint8")) + assert convert_bit_depth(a, "uint8").dtype is np.dtype("uint8") np.testing.assert_equal( convert_bit_depth(a, "uint8"), np.array([0, 28, 56, 85, 113, 141, 170, 198, 226, 255]), ) - self.assertIs(convert_bit_depth(a, "uint16").dtype, np.dtype("uint16")) + assert convert_bit_depth(a, "uint16").dtype is np.dtype("uint16") np.testing.assert_equal(convert_bit_depth(a, "uint16"), a) - self.assertIs( - convert_bit_depth(a, "float16").dtype, np.dtype("float16") - ) + assert convert_bit_depth(a, "float16").dtype is np.dtype("float16") np.testing.assert_allclose( convert_bit_depth(a, "float16"), np.array( @@ -162,9 +184,7 @@ def test_convert_bit_depth(self): atol=5e-2, ) - self.assertIs( - convert_bit_depth(a, "float32").dtype, np.dtype("float32") - ) + assert convert_bit_depth(a, "float32").dtype is np.dtype("float32") np.testing.assert_allclose( convert_bit_depth(a, "float32"), np.array( @@ -184,23 +204,19 @@ def test_convert_bit_depth(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertIs( - convert_bit_depth(a, "float64").dtype, np.dtype("float64") - ) + assert convert_bit_depth(a, "float64").dtype is np.dtype("float64") if hasattr(np, "float128"): # pragma: no cover - self.assertIs( - convert_bit_depth(a, "float128").dtype, np.dtype("float128") - ) + assert convert_bit_depth(a, "float128").dtype is np.dtype("float128") a = np.linspace(0, 1, 10, dtype=np.float64) - self.assertIs(convert_bit_depth(a, "uint8").dtype, np.dtype("uint8")) + assert convert_bit_depth(a, "uint8").dtype is np.dtype("uint8") np.testing.assert_equal( convert_bit_depth(a, "uint8"), np.array([0, 28, 57, 85, 113, 142, 170, 198, 227, 255]), ) - self.assertIs(convert_bit_depth(a, "uint16").dtype, np.dtype("uint16")) + assert convert_bit_depth(a, "uint16").dtype is np.dtype("uint16") np.testing.assert_equal( convert_bit_depth(a, "uint16"), np.array( @@ -219,9 +235,7 @@ def test_convert_bit_depth(self): ), ) - self.assertIs( - convert_bit_depth(a, "float16").dtype, np.dtype("float16") - ) + assert convert_bit_depth(a, "float16").dtype is np.dtype("float16") np.testing.assert_allclose( convert_bit_depth(a, "float16"), np.array( @@ -241,24 +255,18 @@ def test_convert_bit_depth(self): atol=5e-4, ) - self.assertIs( - convert_bit_depth(a, "float32").dtype, np.dtype("float32") - ) + assert convert_bit_depth(a, "float32").dtype is np.dtype("float32") np.testing.assert_allclose( convert_bit_depth(a, "float32"), a, atol=TOLERANCE_ABSOLUTE_TESTS ) - self.assertIs( - convert_bit_depth(a, "float64").dtype, np.dtype("float64") - ) + assert convert_bit_depth(a, "float64").dtype is np.dtype("float64") if hasattr(np, "float128"): # pragma: no cover - self.assertIs( - convert_bit_depth(a, "float128").dtype, np.dtype("float128") - ) + assert convert_bit_depth(a, "float128").dtype is np.dtype("float128") -class TestReadImageOpenImageIO(unittest.TestCase): +class TestReadImageOpenImageIO: """ Define :func:`colour.io.image.read_image_OpenImageIO` definition unit tests methods. @@ -273,43 +281,43 @@ def test_read_image_OpenImageIO(self): # pragma: no cover image = read_image_OpenImageIO( os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") ) - self.assertTupleEqual(image.shape, (1267, 1274, 3)) - self.assertIs(image.dtype, np.dtype("float32")) + assert image.shape == (1267, 1274, 3) + assert image.dtype is np.dtype("float32") image = read_image_OpenImageIO( os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr"), "float16", ) - self.assertIs(image.dtype, np.dtype("float16")) + assert image.dtype is np.dtype("float16") image, attributes = read_image_OpenImageIO( os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr"), - attributes=True, + additional_data=True, ) - self.assertTupleEqual(image.shape, (1267, 1274, 3)) - self.assertEqual(attributes[0].name, "oiio:ColorSpace") - self.assertEqual(attributes[0].value, "Linear") + assert image.shape == (1267, 1274, 3) + assert attributes[0].name == "oiio:ColorSpace" + assert attributes[0].value == "Linear" image = read_image_OpenImageIO( os.path.join(ROOT_RESOURCES, "Single_Channel.exr") ) - self.assertTupleEqual(image.shape, (256, 256)) + assert image.shape == (256, 256) image = read_image_OpenImageIO( os.path.join(ROOT_RESOURCES, "Colour_Logo.png"), "uint8" ) - self.assertTupleEqual(image.shape, (128, 256, 4)) - self.assertIs(image.dtype, np.dtype("uint8")) - self.assertEqual(np.min(image), 0) - self.assertEqual(np.max(image), 255) + assert image.shape == (128, 256, 4) + assert image.dtype is np.dtype("uint8") + assert np.min(image) == 0 + assert np.max(image) == 255 image = read_image_OpenImageIO( os.path.join(ROOT_RESOURCES, "Colour_Logo.png"), "uint16" ) - self.assertTupleEqual(image.shape, (128, 256, 4)) - self.assertIs(image.dtype, np.dtype("uint16")) - self.assertEqual(np.min(image), 0) - self.assertEqual(np.max(image), 65535) + assert image.shape == (128, 256, 4) + assert image.dtype is np.dtype("uint16") + assert np.min(image) == 0 + assert np.max(image) == 65535 # TODO: Investigate "OIIO" behaviour here: 1.0 != 15360.0 # image = read_image_OpenImageIO( @@ -321,23 +329,23 @@ def test_read_image_OpenImageIO(self): # pragma: no cover image = read_image_OpenImageIO( os.path.join(ROOT_RESOURCES, "Colour_Logo.png"), "float32" ) - self.assertIs(image.dtype, np.dtype("float32")) - self.assertEqual(np.min(image), 0.0) - self.assertEqual(np.max(image), 1.0) + assert image.dtype is np.dtype("float32") + assert np.min(image) == 0.0 + assert np.max(image) == 1.0 -class TestWriteImageOpenImageIO(unittest.TestCase): +class TestWriteImageOpenImageIO: """ Define :func:`colour.io.image.write_image_OpenImageIO` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -350,40 +358,34 @@ def test_write_image_OpenImageIO(self): # pragma: no cover from OpenImageIO import TypeDesc - image_path = os.path.join(self._temporary_directory, "8-bit.png") + path = os.path.join(self._temporary_directory, "8-bit.png") RGB = full((1, 1, 3), 255, np.uint8) - write_image_OpenImageIO(RGB, image_path, bit_depth="uint8") - image = read_image_OpenImageIO(image_path, bit_depth="uint8") + write_image_OpenImageIO(RGB, path, bit_depth="uint8") + image = read_image_OpenImageIO(path, bit_depth="uint8") np.testing.assert_equal(np.squeeze(RGB), image) - image_path = os.path.join(self._temporary_directory, "16-bit.png") + path = os.path.join(self._temporary_directory, "16-bit.png") RGB = full((1, 1, 3), 65535, np.uint16) - write_image_OpenImageIO(RGB, image_path, bit_depth="uint16") - image = read_image_OpenImageIO(image_path, bit_depth="uint16") + write_image_OpenImageIO(RGB, path, bit_depth="uint16") + image = read_image_OpenImageIO(path, bit_depth="uint16") np.testing.assert_equal(np.squeeze(RGB), image) - source_image_path = os.path.join( - ROOT_RESOURCES, "Overflowing_Gradient.png" - ) - target_image_path = os.path.join( + source_path = os.path.join(ROOT_RESOURCES, "Overflowing_Gradient.png") + target_path = os.path.join( self._temporary_directory, "Overflowing_Gradient.png" ) RGB = np.arange(0, 256, 1, dtype=np.uint8)[None] * 2 - write_image_OpenImageIO(RGB, target_image_path, bit_depth="uint8") - image = read_image_OpenImageIO(source_image_path, bit_depth="uint8") + write_image_OpenImageIO(RGB, target_path, bit_depth="uint8") + image = read_image_OpenImageIO(source_path, bit_depth="uint8") np.testing.assert_equal(np.squeeze(RGB), image) - source_image_path = os.path.join( - ROOT_RESOURCES, "CMS_Test_Pattern.exr" - ) - target_image_path = os.path.join( - self._temporary_directory, "CMS_Test_Pattern.exr" - ) - image = read_image_OpenImageIO(source_image_path) - write_image_OpenImageIO(image, target_image_path) - image = read_image_OpenImageIO(target_image_path) - self.assertTupleEqual(image.shape, (1267, 1274, 3)) - self.assertIs(image.dtype, np.dtype("float32")) + source_path = os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") + target_path = os.path.join(self._temporary_directory, "CMS_Test_Pattern.exr") + image = read_image_OpenImageIO(source_path) + write_image_OpenImageIO(image, target_path) + image = read_image_OpenImageIO(target_path) + assert image.shape == (1267, 1274, 3) + assert image.dtype is np.dtype("float32") chromaticities = ( 0.73470, @@ -396,17 +398,15 @@ def test_write_image_OpenImageIO(self): # pragma: no cover 0.33767, ) write_attributes = [ - ImageAttribute_Specification("acesImageContainerFlag", True), - ImageAttribute_Specification( + Image_Specification_Attribute("acesImageContainerFlag", True), + Image_Specification_Attribute( "chromaticities", chromaticities, TypeDesc("float[8]") ), - ImageAttribute_Specification("compression", "none"), + Image_Specification_Attribute("compression", "none"), ] - write_image_OpenImageIO( - image, target_image_path, attributes=write_attributes - ) + write_image_OpenImageIO(image, target_path, attributes=write_attributes) image, read_attributes = read_image_OpenImageIO( - target_image_path, attributes=True + target_path, additional_data=True ) for write_attribute in write_attributes: attribute_exists = False @@ -420,9 +420,7 @@ def test_write_image_OpenImageIO(self): # pragma: no cover atol=TOLERANCE_ABSOLUTE_TESTS, ) else: - self.assertEqual( - write_attribute.value, read_attribute.value - ) + assert write_attribute.value == read_attribute.value attest( attribute_exists, @@ -430,7 +428,7 @@ def test_write_image_OpenImageIO(self): # pragma: no cover ) -class TestReadImageImageio(unittest.TestCase): +class TestReadImageImageio: """ Define :func:`colour.io.image.read_image_Imageio` definition unit tests methods. @@ -439,67 +437,63 @@ class TestReadImageImageio(unittest.TestCase): def test_read_image_Imageio(self): """Test :func:`colour.io.image.read_image_Imageio` definition.""" - image = read_image_Imageio( - os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") - ) - self.assertTupleEqual(image.shape, (1267, 1274, 3)) - self.assertIs(image.dtype, np.dtype("float32")) + image = read_image_Imageio(os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr")) + assert image.shape == (1267, 1274, 3) + assert image.dtype is np.dtype("float32") image = read_image_Imageio( os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr"), "float16", ) - self.assertTupleEqual(image.shape, (1267, 1274, 3)) - self.assertIs(image.dtype, np.dtype("float16")) + assert image.shape == (1267, 1274, 3) + assert image.dtype is np.dtype("float16") - image = read_image_Imageio( - os.path.join(ROOT_RESOURCES, "Single_Channel.exr") - ) - self.assertTupleEqual(image.shape, (256, 256)) + image = read_image_Imageio(os.path.join(ROOT_RESOURCES, "Single_Channel.exr")) + assert image.shape == (256, 256) image = read_image_Imageio( os.path.join(ROOT_RESOURCES, "Colour_Logo.png"), "uint8" ) - self.assertTupleEqual(image.shape, (128, 256, 4)) - self.assertIs(image.dtype, np.dtype("uint8")) - self.assertEqual(np.min(image), 0) - self.assertEqual(np.max(image), 255) + assert image.shape == (128, 256, 4) + assert image.dtype is np.dtype("uint8") + assert np.min(image) == 0 + assert np.max(image) == 255 image = read_image_Imageio( os.path.join(ROOT_RESOURCES, "Colour_Logo.png"), "uint16" ) - self.assertTupleEqual(image.shape, (128, 256, 4)) - self.assertIs(image.dtype, np.dtype("uint16")) - self.assertEqual(np.min(image), 0) - self.assertEqual(np.max(image), 65535) + assert image.shape == (128, 256, 4) + assert image.dtype is np.dtype("uint16") + assert np.min(image) == 0 + assert np.max(image) == 65535 image = read_image_Imageio( os.path.join(ROOT_RESOURCES, "Colour_Logo.png"), "float16" ) - self.assertIs(image.dtype, np.dtype("float16")) - self.assertEqual(np.min(image), 0.0) - self.assertEqual(np.max(image), 1.0) + assert image.dtype is np.dtype("float16") + assert np.min(image) == 0.0 + assert np.max(image) == 1.0 image = read_image_Imageio( os.path.join(ROOT_RESOURCES, "Colour_Logo.png"), "float32" ) - self.assertIs(image.dtype, np.dtype("float32")) - self.assertEqual(np.min(image), 0.0) - self.assertEqual(np.max(image), 1.0) + assert image.dtype is np.dtype("float32") + assert np.min(image) == 0.0 + assert np.max(image) == 1.0 -class TestWriteImageImageio(unittest.TestCase): +class TestWriteImageImageio: """ Define :func:`colour.io.image.write_image_Imageio` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -507,47 +501,39 @@ def tearDown(self): def test_write_image_Imageio(self): """Test :func:`colour.io.image.write_image_Imageio` definition.""" - source_image_path = os.path.join( - ROOT_RESOURCES, "Overflowing_Gradient.png" - ) - target_image_path = os.path.join( + source_path = os.path.join(ROOT_RESOURCES, "Overflowing_Gradient.png") + target_path = os.path.join( self._temporary_directory, "Overflowing_Gradient.png" ) RGB = np.arange(0, 256, 1, dtype=np.uint8)[None] * 2 - write_image_Imageio(RGB, target_image_path, bit_depth="uint8") - image = read_image_Imageio(source_image_path, bit_depth="uint8") + write_image_Imageio(RGB, target_path, bit_depth="uint8") + image = read_image_Imageio(source_path, bit_depth="uint8") np.testing.assert_equal(np.squeeze(RGB), image) - source_image_path = os.path.join( - ROOT_RESOURCES, "CMS_Test_Pattern.exr" - ) - target_image_path = os.path.join( - self._temporary_directory, "CMS_Test_Pattern.exr" - ) - image = read_image_Imageio(source_image_path) - write_image_Imageio(image, target_image_path) - image = read_image_Imageio(target_image_path) - self.assertTupleEqual(image.shape, (1267, 1274, 3)) - self.assertIs(image.dtype, np.dtype("float32")) + source_path = os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") + target_path = os.path.join(self._temporary_directory, "CMS_Test_Pattern.exr") + image = read_image_Imageio(source_path) + write_image_Imageio(image, target_path) + image = read_image_Imageio(target_path) + assert image.shape == (1267, 1274, 3) + assert image.dtype is np.dtype("float32") # NOTE: Those unit tests are breaking unpredictably on Linux, skipping # for now. if platform.system() != "Linux": # pragma: no cover - target_image_path = os.path.join( - self._temporary_directory, "Full_White.exr" - ) + target_path = os.path.join(self._temporary_directory, "Full_White.exr") image = full((32, 16, 3), 1e6, dtype=np.float16) - write_image_Imageio(image, target_image_path) - image = read_image_Imageio(target_image_path) - self.assertEqual(np.max(image), np.inf) + write_image_Imageio(image, target_path) + image = read_image_Imageio(target_path) + assert np.max(image) == np.inf image = full((32, 16, 3), 1e6) - write_image_Imageio(image, target_image_path) - image = read_image_Imageio(target_image_path) - self.assertEqual(np.max(image), 1e6) + write_image_Imageio(image, target_path) + image = read_image_Imageio(target_path) + assert np.max(image) == 1e6 -class TestReadImage(unittest.TestCase): +class TestReadImage: """ Define :func:`colour.io.image.read_image` definition unit tests methods. @@ -556,25 +542,23 @@ class TestReadImage(unittest.TestCase): def test_read_image(self): """Test :func:`colour.io.image.read_image` definition.""" - image = read_image( - os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") - ) - self.assertTupleEqual(image.shape, (1267, 1274, 3)) - self.assertIs(image.dtype, np.dtype("float32")) + image = read_image(os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr")) + assert image.shape == (1267, 1274, 3) + assert image.dtype is np.dtype("float32") image = read_image(os.path.join(ROOT_RESOURCES, "Single_Channel.exr")) - self.assertTupleEqual(image.shape, (256, 256)) + assert image.shape == (256, 256) -class TestWriteImage(unittest.TestCase): +class TestWriteImage: """Define :func:`colour.io.image.write_image` definition unit tests methods.""" - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -582,20 +566,16 @@ def tearDown(self): def test_write_image(self): """Test :func:`colour.io.image.write_image` definition.""" - source_image_path = os.path.join( - ROOT_RESOURCES, "CMS_Test_Pattern.exr" - ) - target_image_path = os.path.join( - self._temporary_directory, "CMS_Test_Pattern.exr" - ) - image = read_image(source_image_path) - write_image(image, target_image_path) - image = read_image(target_image_path) - self.assertTupleEqual(image.shape, (1267, 1274, 3)) - self.assertIs(image.dtype, np.dtype("float32")) + source_path = os.path.join(ROOT_RESOURCES, "CMS_Test_Pattern.exr") + target_path = os.path.join(self._temporary_directory, "CMS_Test_Pattern.exr") + image = read_image(source_path) + write_image(image, target_path) + image = read_image(target_path) + assert image.shape == (1267, 1274, 3) + assert image.dtype is np.dtype("float32") -class TestAs3ChannelsImage(unittest.TestCase): +class TestAs3ChannelsImage: """ Define :func:`colour.io.image.as_3_channels_image` definition unit tests methods. @@ -615,7 +595,32 @@ def test_as_3_channels_image(self): np.testing.assert_equal(as_3_channels_image(a), b) a = np.array([[[0.18, 0.18, 0.18]]]) np.testing.assert_equal(as_3_channels_image(a), b) + a = np.array([[[[0.18, 0.18, 0.18]]]]) + np.testing.assert_equal(as_3_channels_image(a), b) + + def test_raise_exception_as_3_channels_image(self): + """ + Test :func:`colour.io.image.as_3_channels_image` definition raised + exception. + """ + pytest.raises( + ValueError, + as_3_channels_image, + [ + [ + [[0.18, 0.18, 0.18], [0.18, 0.18, 0.18]], + [[0.18, 0.18, 0.18], [0.18, 0.18, 0.18]], + ], + [ + [[0.18, 0.18, 0.18], [0.18, 0.18, 0.18]], + [[0.18, 0.18, 0.18], [0.18, 0.18, 0.18]], + ], + ], + ) -if __name__ == "__main__": - unittest.main() + pytest.raises( + ValueError, + as_3_channels_image, + [0.18, 0.18, 0.18, 0.18], + ) diff --git a/colour/io/tests/test_ocio.py b/colour/io/tests/test_ocio.py index a0ee3adf29..17021c4208 100644 --- a/colour/io/tests/test_ocio.py +++ b/colour/io/tests/test_ocio.py @@ -1,16 +1,14 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.ocio` module.""" from __future__ import annotations import os -import unittest import numpy as np from colour.constants import TOLERANCE_ABSOLUTE_TESTS from colour.io import process_image_OpenColorIO -from colour.utilities import full, is_opencolorio_installed +from colour.utilities import full, is_opencolorio_installed, tstack __author__ = "Colour Developers" __copyright__ = "Copyright 2013 Colour Developers" @@ -27,7 +25,7 @@ ROOT_RESOURCES: str = os.path.join(os.path.dirname(__file__), "resources") -class TestProcessImageOpenColorIO(unittest.TestCase): +class TestProcessImageOpenColorIO: """ Define :func:`colour.io.ocio.process_image_OpenColorIO` definition unit tests methods. @@ -43,9 +41,7 @@ def test_process_image_OpenColorIO(self): import PyOpenColorIO as ocio - config = os.path.join( - ROOT_RESOURCES, "config-aces-reference.ocio.yaml" - ) + config = os.path.join(ROOT_RESOURCES, "config-aces-reference.ocio.yaml") a = full([4, 2, 3], 0.18) @@ -108,6 +104,19 @@ def test_process_image_OpenColorIO(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - -if __name__ == "__main__": - unittest.main() + np.testing.assert_allclose( + process_image_OpenColorIO( + tstack(([0.2, 0.4, 0.6], [0.2, 0.4, 0.6], [0.2, 0.4, 0.6])), + "ACES - ACES2065-1", + "ACES - ACEScct", + config=config, + ), + np.array( + [ + [0.42226437, 0.42226437, 0.42226437], + [0.47934198, 0.47934198, 0.47934198], + [0.51273096, 0.51273096, 0.51273096], + ] + ), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) diff --git a/colour/io/tests/test_tabular.py b/colour/io/tests/test_tabular.py index 7f0ee8e8a3..5cc290263a 100644 --- a/colour/io/tests/test_tabular.py +++ b/colour/io/tests/test_tabular.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.tabular` module.""" from __future__ import annotations @@ -6,7 +5,8 @@ import os import shutil import tempfile -import unittest + +import pytest from colour.colorimetry import SpectralDistribution, SpectralShape from colour.io import ( @@ -117,7 +117,7 @@ } -class TestReadSpectralDataFromCsvFile(unittest.TestCase): +class TestReadSpectralDataFromCsvFile: """ Define :func:`colour.io.tabular.read_spectral_data_from_csv_file` definition unit tests methods. @@ -129,16 +129,10 @@ def test_read_spectral_data_from_csv_file(self): definition. """ - colour_checker_n_ohta = os.path.join( - ROOT_RESOURCES, "colorchecker_n_ohta.csv" - ) + colour_checker_n_ohta = os.path.join(ROOT_RESOURCES, "colorchecker_n_ohta.csv") data = read_spectral_data_from_csv_file(colour_checker_n_ohta) - self.assertListEqual( - list(data.keys()), ["wavelength"] + [str(x) for x in range(1, 25)] - ) - self.assertDictEqual( - dict(zip(data["wavelength"], data["1"])), COLOURCHECKER_N_OHTA_1 - ) + assert list(data.keys()) == ["wavelength"] + [str(x) for x in range(1, 25)] + assert dict(zip(data["wavelength"], data["1"])) == COLOURCHECKER_N_OHTA_1 colour_checker_n_ohta_transposed = os.path.join( ROOT_RESOURCES, "colorchecker_n_ohta_transposed.csv" @@ -146,12 +140,8 @@ def test_read_spectral_data_from_csv_file(self): data = read_spectral_data_from_csv_file( colour_checker_n_ohta_transposed, transpose=True, delimiter="\t" ) - self.assertListEqual( - list(data.keys()), ["wavelength"] + [str(x) for x in range(1, 25)] - ) - self.assertDictEqual( - dict(zip(data["wavelength"], data["1"])), COLOURCHECKER_N_OHTA_1 - ) + assert list(data.keys()) == ["wavelength"] + [str(x) for x in range(1, 25)] + assert dict(zip(data["wavelength"], data["1"])) == COLOURCHECKER_N_OHTA_1 linss2_10e_5 = os.path.join(ROOT_RESOURCES, "linss2_10e_5.csv") data = read_spectral_data_from_csv_file( @@ -159,19 +149,17 @@ def test_read_spectral_data_from_csv_file(self): names=["wavelength", "l_bar", "m_bar", "s_bar"], filling_values=0, ) - self.assertListEqual( - list(data.keys()), ["wavelength", "l_bar", "m_bar", "s_bar"] - ) - self.assertEqual(data["s_bar"][77], 0) + assert list(data.keys()) == ["wavelength", "l_bar", "m_bar", "s_bar"] + assert data["s_bar"][77] == 0 data = read_spectral_data_from_csv_file( linss2_10e_5, names=["wavelength", "l_bar", "m_bar", "s_bar"], filling_values=-1, ) - self.assertEqual(data["s_bar"][77], -1) + assert data["s_bar"][77] == -1 -class TestReadSdsFromCsvFile(unittest.TestCase): +class TestReadSdsFromCsvFile: """ Define :func:`colour.io.tabular.read_sds_from_csv_file` definition unit tests methods. @@ -180,30 +168,26 @@ class TestReadSdsFromCsvFile(unittest.TestCase): def test_read_sds_from_csv_file(self): """Test :func:`colour.io.tabular.read_sds_from_csv_file` definition.""" - colour_checker_n_ohta = os.path.join( - ROOT_RESOURCES, "colorchecker_n_ohta.csv" - ) + colour_checker_n_ohta = os.path.join(ROOT_RESOURCES, "colorchecker_n_ohta.csv") sds = read_sds_from_csv_file(colour_checker_n_ohta) for sd in sds.values(): - self.assertIsInstance(sd, SpectralDistribution) + assert isinstance(sd, SpectralDistribution) - self.assertEqual( - sds["1"], SpectralDistribution(COLOURCHECKER_N_OHTA_1, name="1") - ) + assert sds["1"] == SpectralDistribution(COLOURCHECKER_N_OHTA_1, name="1") -class TestWriteSdsToCsvFile(unittest.TestCase): +class TestWriteSdsToCsvFile: """ Define :func:`colour.io.tabular.write_sds_to_csv_file` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -211,9 +195,7 @@ def tearDown(self): def test_write_sds_to_csv_file(self): """Test :func:`colour.io.tabular.write_sds_to_csv_file` definition.""" - colour_checker_n_ohta = os.path.join( - ROOT_RESOURCES, "colorchecker_n_ohta.csv" - ) + colour_checker_n_ohta = os.path.join(ROOT_RESOURCES, "colorchecker_n_ohta.csv") sds = read_sds_from_csv_file(colour_checker_n_ohta) colour_checker_n_ohta_test = os.path.join( self._temporary_directory, "colorchecker_n_ohta.csv" @@ -221,7 +203,7 @@ def test_write_sds_to_csv_file(self): write_sds_to_csv_file(sds, colour_checker_n_ohta_test) sds_test = read_sds_from_csv_file(colour_checker_n_ohta_test) for key, value in sds.items(): - self.assertEqual(value, sds_test[key]) + assert value == sds_test[key] def test_raise_exception_write_sds_to_csv_file(self): """ @@ -229,15 +211,9 @@ def test_raise_exception_write_sds_to_csv_file(self): raised exception. """ - colour_checker_n_ohta = os.path.join( - ROOT_RESOURCES, "colorchecker_n_ohta.csv" - ) + colour_checker_n_ohta = os.path.join(ROOT_RESOURCES, "colorchecker_n_ohta.csv") sds = read_sds_from_csv_file(colour_checker_n_ohta) key = next(iter(sds.keys())) sds[key] = sds[key].align(SpectralShape(400, 700, 10)) - self.assertRaises(ValueError, write_sds_to_csv_file, sds, "") - - -if __name__ == "__main__": - unittest.main() + pytest.raises(ValueError, write_sds_to_csv_file, sds, "") diff --git a/colour/io/tests/test_tm2714.py b/colour/io/tests/test_tm2714.py index 5714692239..1001bc3885 100644 --- a/colour/io/tests/test_tm2714.py +++ b/colour/io/tests/test_tm2714.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.tm2714` module.""" from __future__ import annotations @@ -8,10 +7,10 @@ import shutil import tempfile import textwrap -import unittest from copy import deepcopy import numpy as np +import pytest from colour.colorimetry import SpectralDistribution from colour.constants import TOLERANCE_ABSOLUTE_TESTS @@ -145,13 +144,13 @@ } -class TestIES_TM2714_Header(unittest.TestCase): +class TestIES_TM2714_Header: """ Define :class:`colour.io.tm2714.Header_IESTM2714` class unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._header = Header_IESTM2714( @@ -187,7 +186,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(Header_IESTM2714)) + assert attribute in dir(Header_IESTM2714) def test_required_methods(self): """Test the presence of required methods.""" @@ -202,13 +201,12 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(Header_IESTM2714)) + assert method in dir(Header_IESTM2714) def test__str__(self): """Test :meth:`colour.io.tm2714.Header_IESTM2714.__str__` method.""" - self.assertEqual( - str(self._header), + assert str(self._header) == ( textwrap.dedent( """ Manufacturer : a @@ -223,14 +221,13 @@ def test__str__(self): Document Creation Date : j Comments : k """ - ).strip(), + ).strip() ) def test__repr__(self): """Test :meth:`colour.io.tm2714.Header_IESTM2714.__repr__` method.""" - self.assertEqual( - repr(self._header), + assert repr(self._header) == ( textwrap.dedent( """ Header_IESTM2714('a', @@ -245,16 +242,17 @@ def test__repr__(self): 'j', 'k') """ - ).strip(), + ).strip() ) def test__eq__(self): """Test :meth:`colour.io.tm2714.Header_IESTM2714.__eq__` method.""" header = deepcopy(self._header) - self.assertEqual(self._header, header) - self.assertNotEqual(self._header, None) + assert self._header == header + + assert self._header != () def test__ne__(self): """Test :meth:`colour.io.tm2714.Header_IESTM2714.__ne__` method.""" @@ -262,24 +260,24 @@ def test__ne__(self): header = deepcopy(self._header) header.manufacturer = "aa" - self.assertNotEqual(self._header, header) + assert self._header != header header.manufacturer = "a" - self.assertEqual(self._header, header) + assert self._header == header def test__hash__(self): """Test :meth:`colour.io.tm2714.Header_IESTM2714.__hash__` method.""" - self.assertIsInstance(hash(self._header), int) + assert isinstance(hash(self._header), int) -class TestIES_TM2714_Sd(unittest.TestCase): +class TestIES_TM2714_Sd: """ Define :class:`colour.io.tm2714.SpectralDistribution_IESTM2714` class unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() @@ -288,7 +286,7 @@ def setUp(self): os.path.join(ROOT_RESOURCES, "Fluorescent.spdx") ).read() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -308,7 +306,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(SpectralDistribution_IESTM2714)) + assert attribute in dir(SpectralDistribution_IESTM2714) def test_required_methods(self): """Test the presence of required methods.""" @@ -316,7 +314,7 @@ def test_required_methods(self): required_methods = ("__init__", "__str__", "__repr__", "read", "write") for method in required_methods: - self.assertIn(method, dir(SpectralDistribution_IESTM2714)) + assert method in dir(SpectralDistribution_IESTM2714) def test__str__(self): """ @@ -324,12 +322,11 @@ def test__str__(self): method. """ - self.assertEqual( - re.sub( - "Path :.*", - "Path :", - str(self._sd), - ), + assert re.sub( + "Path :.*", + "Path :", + str(self._sd), + ) == ( textwrap.dedent( """ IES TM-27-14 Spectral Distribution @@ -446,7 +443,7 @@ def test__str__(self): [ 8.12700000e+02 3.00000000e-02] [ 8.50100000e+02 3.00000000e-02]] """ - ).strip(), + ).strip() ) def test__repr__(self): @@ -455,12 +452,11 @@ def test__repr__(self): method. """ - self.assertEqual( - re.sub( - "SpectralDistribution_IESTM2714.*", - "SpectralDistribution_IESTM2714(...,", - repr(self._sd), - ), + assert re.sub( + "SpectralDistribution_IESTM2714.*", + "SpectralDistribution_IESTM2714(...,", + repr(self._sd), + ) == ( textwrap.dedent( """ SpectralDistribution_IESTM2714(..., @@ -570,7 +566,7 @@ def test__repr__(self): Extrapolator, {'method': 'Constant', 'left': None, 'right': None}) """ - ).strip(), + ).strip() ) def test_read(self, sd: SpectralDistribution | None = None): @@ -611,9 +607,7 @@ def test_read(self, sd: SpectralDistribution | None = None): for key, value in test.items(): for specification in read.mapping.elements: if key == specification.element: - self.assertEqual( - getattr(read, specification.attribute), value - ) + assert getattr(read, specification.attribute) == value def test_raise_exception_read(self): """ @@ -622,9 +616,9 @@ def test_raise_exception_read(self): """ sd = SpectralDistribution_IESTM2714() - self.assertRaises(ValueError, sd.read) + pytest.raises(ValueError, sd.read) - with self.assertRaises(ValueError): + with pytest.raises(ValueError): sd = SpectralDistribution_IESTM2714( os.path.join(ROOT_RESOURCES, "Invalid.spdx") ) @@ -638,11 +632,11 @@ def test_write(self): sd_r = self._sd sd_r.path = os.path.join(self._temporary_directory, "Fluorescent.spdx") - self.assertTrue(sd_r.write()) + assert sd_r.write() sd_t = SpectralDistribution_IESTM2714(sd_r.path).read() self.test_read(sd_t) - self.assertEqual(sd_r, sd_t) + assert sd_r == sd_t for attribute in ( "manufacturer", @@ -657,10 +651,7 @@ def test_write(self): "document_creation_date", "comments", ): - self.assertEqual( - getattr(sd_r.header, attribute), - getattr(sd_t.header, attribute), - ) + assert getattr(sd_r.header, attribute) == getattr(sd_t.header, attribute) for attribute in ( "spectral_quantity", @@ -669,9 +660,7 @@ def test_write(self): "bandwidth_FWHM", "bandwidth_corrected", ): - self.assertEqual( - getattr(sd_r, attribute), getattr(sd_t, attribute) - ) + assert getattr(sd_r, attribute) == getattr(sd_t, attribute) def test_raise_exception_write(self): """ @@ -680,8 +669,4 @@ def test_raise_exception_write(self): """ sd = SpectralDistribution_IESTM2714() - self.assertRaises(ValueError, sd.write) - - -if __name__ == "__main__": - unittest.main() + pytest.raises(ValueError, sd.write) diff --git a/colour/io/tests/test_uprtek_sekonic.py b/colour/io/tests/test_uprtek_sekonic.py index b1eaa9457b..d23fc275d5 100644 --- a/colour/io/tests/test_uprtek_sekonic.py +++ b/colour/io/tests/test_uprtek_sekonic.py @@ -4,9 +4,9 @@ import json import os -import unittest import numpy as np +import pytest from colour.colorimetry import SpectralDistribution from colour.constants import TOLERANCE_ABSOLUTE_TESTS @@ -24,7 +24,7 @@ __status__ = "Production" __all__ = [ "ROOT_RESOURCES", - "AbstractSpectralDistributionTest", + "FixtureAbstractSpectralDistribution", "TestSpectralDistributionUprTek", "TestSpectralDistributionSekonic", ] @@ -32,24 +32,16 @@ ROOT_RESOURCES: str = os.path.join(os.path.dirname(__file__), "resources") -class AbstractSpectralDistributionTest(unittest.TestCase): +class FixtureAbstractSpectralDistribution: """ Define :class:`colour.SpectralDistribution_UPRTek`, :class:`colour.SpectralDistribution_Sekonic` classes common unit tests methods. """ - def __init__(self, *args: Any) -> None: - """ - Create an instance of the class. - - Other Parameters - ---------------- - args - Arguments. - """ - - super().__init__(*args) + @pytest.fixture(autouse=True) + def setup_fixture_abstract_spectral_distribution(self) -> None: + """Configure the class instance.""" self._sd_factory: Any = None self._path: str | None = None @@ -72,7 +64,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(SpectralDistribution_UPRTek)) + assert attribute in dir(SpectralDistribution_UPRTek) def test_required_methods(self): """Test the presence of required methods.""" @@ -80,7 +72,7 @@ def test_required_methods(self): required_methods = ("__init__", "__str__", "read", "write") for method in required_methods: - self.assertIn(method, dir(SpectralDistribution_UPRTek)) + assert method in dir(SpectralDistribution_UPRTek) def test__str__(self): """ @@ -88,16 +80,9 @@ def test__str__(self): :meth:`colour.SpectralDistribution_Sekonic.__str__` methods. """ - if self._sd_factory is None: - return - - self.assertTrue( - str( - self._sd_factory( - os.path.join(ROOT_RESOURCES, self._path) - ).read() - ).startswith(self._prefix) - ) + assert str( + self._sd_factory(os.path.join(ROOT_RESOURCES, self._path)).read() + ).startswith(self._prefix) def test_read(self): """ @@ -105,9 +90,6 @@ def test_read(self): :meth:`colour.SpectralDistribution_Sekonic.read` methods. """ - if self._sd_factory is None: - return - sd = self._sd_factory(os.path.join(ROOT_RESOURCES, self._path)).read() sd_r = SpectralDistribution(self._spectral_data) @@ -121,32 +103,20 @@ def test_read(self): for specification in sd.header.mapping.elements: if key == specification.element: if key == "Comments": - self.assertDictEqual( - json.loads(sd.header.comments), value - ) + assert json.loads(sd.header.comments) == value else: - self.assertEqual( - getattr(sd.header, specification.attribute), value - ) + assert getattr(sd.header, specification.attribute) == value -class TestSpectralDistributionUprTek(AbstractSpectralDistributionTest): +class TestSpectralDistributionUprTek(FixtureAbstractSpectralDistribution): """ Define :class:`colour.SpectralDistribution_UPRTek` class unit tests methods. """ - def __init__(self, *args: Any) -> None: - """ - Create an instance of the class. - - Other Parameters - ---------------- - args - Arguments. - """ - - super().__init__(*args) + @pytest.fixture(autouse=True) + def setup_test_spectral_distribution_upr_tek(self) -> None: + """Configure the class instance.""" self._sd_factory = SpectralDistribution_UPRTek self._path = "ESPD2021_0104_231446.xls" @@ -611,23 +581,15 @@ def __init__(self, *args: Any) -> None: self._prefix = "UPRTek" -class TestSpectralDistributionSekonic(AbstractSpectralDistributionTest): +class TestSpectralDistributionSekonic(FixtureAbstractSpectralDistribution): """ Define :class:`colour.SpectralDistribution_Sekonic` class unit tests methods. """ - def __init__(self, *args: Any) -> None: - """ - Create an instance of the class. - - Other Parameters - ---------------- - args - Arguments. - """ - - super().__init__(*args) + @pytest.fixture(autouse=True) + def setup_test_spectral_distribution_sekonic(self) -> None: + """Configure the class instance.""" self._sd_factory = SpectralDistribution_Sekonic self._path = "RANDOM_001_02._3262K.csv" @@ -1116,7 +1078,3 @@ def __init__(self, *args: Any) -> None: "SpectralQuantity": "Irradiance", } self._prefix = "Sekonic" - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/io/tests/test_xrite.py b/colour/io/tests/test_xrite.py index 5dc7b641d0..74c517e2bb 100644 --- a/colour/io/tests/test_xrite.py +++ b/colour/io/tests/test_xrite.py @@ -1,10 +1,8 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.io.xrite` module.""" from __future__ import annotations import os -import unittest from colour.colorimetry import SpectralDistribution from colour.io import read_sds_from_xrite_file @@ -64,7 +62,7 @@ } -class TestReadSdsFromXRiteFile(unittest.TestCase): +class TestReadSdsFromXRiteFile: """ Define :func:`colour.io.xrite.read_sds_from_xrite_file` definition unit tests methods. @@ -78,12 +76,6 @@ def test_read_sds_from_xrite_file(self): ) sds = read_sds_from_xrite_file(colour_checker_xrite) for sd in sds.values(): - self.assertIsInstance(sd, SpectralDistribution) + assert isinstance(sd, SpectralDistribution) - self.assertEqual( - sds["X1"], SpectralDistribution(COLOURCHECKER_XRITE_1, name="X1") - ) - - -if __name__ == "__main__": - unittest.main() + assert sds["X1"] == SpectralDistribution(COLOURCHECKER_XRITE_1, name="X1") diff --git a/colour/io/tm2714.py b/colour/io/tm2714.py index 7bf3932ced..d393120dc7 100644 --- a/colour/io/tm2714.py +++ b/colour/io/tm2714.py @@ -2,7 +2,7 @@ IES TM-27-14 Data Input / Output ================================ -Defines the :class:`colour.SpectralDistribution_IESTM2714` class handling *IES +Define the :class:`colour.SpectralDistribution_IESTM2714` class handling *IES TM-27-14* spectral data *XML* files. References @@ -18,6 +18,7 @@ import os import re from dataclasses import dataclass, field +from pathlib import Path from xml.dom import minidom from xml.etree import ElementTree @@ -29,7 +30,6 @@ as_float_scalar, attest, is_numeric, - is_string, multiline_repr, multiline_str, optional, @@ -180,12 +180,8 @@ def __init__( **{ "element": "Header", "elements": ( - Element_Specification_IESTM2714( - "Manufacturer", "manufacturer" - ), - Element_Specification_IESTM2714( - "CatalogNumber", "catalog_number" - ), + Element_Specification_IESTM2714("Manufacturer", "manufacturer"), + Element_Specification_IESTM2714("CatalogNumber", "catalog_number"), Element_Specification_IESTM2714( "Description", "description", required=True ), @@ -198,23 +194,15 @@ def __init__( Element_Specification_IESTM2714( "MeasurementEquipment", "measurement_equipment" ), - Element_Specification_IESTM2714( - "Laboratory", "laboratory" - ), - Element_Specification_IESTM2714( - "ReportNumber", "report_number" - ), - Element_Specification_IESTM2714( - "ReportDate", "report_date" - ), + Element_Specification_IESTM2714("Laboratory", "laboratory"), + Element_Specification_IESTM2714("ReportNumber", "report_number"), + Element_Specification_IESTM2714("ReportDate", "report_date"), Element_Specification_IESTM2714( "DocumentCreationDate", "document_creation_date", required=True, ), - Element_Specification_IESTM2714( - "Comments", "comments", False - ), + Element_Specification_IESTM2714("Comments", "comments", False), ), } ) @@ -279,7 +267,7 @@ def manufacturer(self, value: str | None): if value is not None: attest( - is_string(value), + isinstance(value, str), f'"manufacturer" property: "{value}" type is not "str"!', ) @@ -309,7 +297,7 @@ def catalog_number(self, value: str | None): if value is not None: attest( - is_string(value), + isinstance(value, str), f'"catalog_number" property: "{value}" type is not "str"!', ) @@ -339,7 +327,7 @@ def description(self, value: str | None): if value is not None: attest( - is_string(value), + isinstance(value, str), f'"description" property: "{value}" type is not "str"!', ) @@ -369,7 +357,7 @@ def document_creator(self, value: str | None): if value is not None: attest( - is_string(value), + isinstance(value, str), f'"document_creator" property: "{value}" type is not "str"!', ) @@ -399,7 +387,7 @@ def unique_identifier(self, value: str | None): if value is not None: attest( - is_string(value), + isinstance(value, str), f'"unique_identifier" property: "{value}" type is not "str"!', ) @@ -429,7 +417,7 @@ def measurement_equipment(self, value: str | None): if value is not None: attest( - is_string(value), + isinstance(value, str), f'"measurement_equipment" property: "{value}" type is not "str"!', ) @@ -459,7 +447,7 @@ def laboratory(self, value: str | None): if value is not None: attest( - is_string(value), + isinstance(value, str), f'"laboratory" property: "{value}" type is not "str"!', ) @@ -489,7 +477,7 @@ def report_number(self, value: str | None): if value is not None: attest( - is_string(value), + isinstance(value, str), f'"report_number" property: "{value}" type is not "str"!', ) @@ -519,7 +507,7 @@ def report_date(self, value: str | None): if value is not None: attest( - is_string(value), + isinstance(value, str), f'"report_date" property: "{value}" type is not "str"!', ) @@ -549,7 +537,7 @@ def document_creation_date(self, value: str | None): if value is not None: attest( - is_string(value), + isinstance(value, str), f'"document_creation_date" property: "{value}" type is not "str"!', ) @@ -579,7 +567,7 @@ def comments(self, value: str | None): if value is not None: attest( - is_string(value), + isinstance(value, str), f'"comments" property: "{value}" type is not "str"!', ) @@ -735,8 +723,7 @@ def __eq__(self, other: Any) -> bool: self._laboratory == other.laboratory, self._report_number == other.report_number, self._report_date == other.report_date, - self._document_creation_date - == other.document_creation_date, + self._document_creation_date == other.document_creation_date, self._comments == other.comments, ] ) @@ -869,9 +856,7 @@ class SpectralDistribution_IESTM2714(SpectralDistribution): -------- >>> from os.path import dirname, join >>> directory = join(dirname(__file__), "tests", "resources") - >>> sd = SpectralDistribution_IESTM2714( - ... join(directory, "Fluorescent.spdx") - ... ) + >>> sd = SpectralDistribution_IESTM2714(join(directory, "Fluorescent.spdx")) >>> sd.name # doctest: +SKIP 'Unknown - N/A - Rare earth fluorescent lamp' >>> sd.header.comments @@ -882,42 +867,45 @@ class SpectralDistribution_IESTM2714(SpectralDistribution): def __init__( self, - path: str | None = None, + path: str | Path | None = None, header: Header_IESTM2714 | None = None, - spectral_quantity: Literal[ - "absorptance", - "exitance", - "flux", - "intensity", - "irradiance", - "radiance", - "reflectance", - "relative", - "transmittance", - "R-Factor", - "T-Factor", - "other", - ] - | None = None, - reflection_geometry: Literal[ - "di:8", - "de:8", - "8:di", - "8:de", - "d:d", - "d:0", - "45a:0", - "45c:0", - "0:45a", - "45x:0", - "0:45x", - "other", - ] - | None = None, - transmission_geometry: Literal[ - "0:0", "di:0", "de:0", "0:di", "0:de", "d:d", "other" - ] - | None = None, + spectral_quantity: ( + Literal[ + "absorptance", + "exitance", + "flux", + "intensity", + "irradiance", + "radiance", + "reflectance", + "relative", + "transmittance", + "R-Factor", + "T-Factor", + "other", + ] + | None + ) = None, + reflection_geometry: ( + Literal[ + "di:8", + "de:8", + "8:di", + "8:de", + "d:d", + "d:0", + "45a:0", + "45c:0", + "0:45a", + "45x:0", + "0:45x", + "other", + ] + | None + ) = None, + transmission_geometry: ( + Literal["0:0", "di:0", "de:0", "0:di", "0:de", "d:d", "other"] | None + ) = None, bandwidth_FWHM: float | None = None, bandwidth_corrected: bool | None = None, **kwargs, @@ -941,18 +929,14 @@ def __init__( "BandwidthFWHM", "bandwidth_FWHM", read_conversion=( - lambda x: None - if x == "None" - else as_float_scalar(x) + lambda x: (None if x == "None" else as_float_scalar(x)) ), ), Element_Specification_IESTM2714( "BandwidthCorrected", "bandwidth_corrected", read_conversion=(lambda x: bool(x == "true")), - write_conversion=( - lambda x: "true" if x is True else "false" - ), + write_conversion=(lambda x: "true" if x is True else "false"), ), ), "data": Element_Specification_IESTM2714( @@ -965,46 +949,54 @@ def __init__( self.path = path self._header: Header_IESTM2714 = Header_IESTM2714() self.header = optional(header, self._header) - self._spectral_quantity: Literal[ - "absorptance", - "exitance", - "flux", - "intensity", - "irradiance", - "radiance", - "reflectance", - "relative", - "transmittance", - "R-Factor", - "T-Factor", - "other", - ] | None = None + self._spectral_quantity: ( + Literal[ + "absorptance", + "exitance", + "flux", + "intensity", + "irradiance", + "radiance", + "reflectance", + "relative", + "transmittance", + "R-Factor", + "T-Factor", + "other", + ] + | None + ) = None self.spectral_quantity = spectral_quantity - self._reflection_geometry: Literal[ - "di:8", - "de:8", - "8:di", - "8:de", - "d:d", - "d:0", - "45a:0", - "45c:0", - "0:45a", - "45x:0", - "0:45x", - "other", - ] | None = None + self._reflection_geometry: ( + Literal[ + "di:8", + "de:8", + "8:di", + "8:de", + "d:d", + "d:0", + "45a:0", + "45c:0", + "0:45a", + "45x:0", + "0:45x", + "other", + ] + | None + ) = None self.reflection_geometry = reflection_geometry - self._transmission_geometry: Literal[ - "0:0", "di:0", "de:0", "0:di", "0:de", "d:d", "other" - ] | None = None + self._transmission_geometry: ( + Literal["0:0", "di:0", "de:0", "0:di", "0:de", "d:d", "other"] | None + ) = None self.transmission_geometry = transmission_geometry self._bandwidth_FWHM: float | None = None self.bandwidth_FWHM = bandwidth_FWHM self._bandwidth_corrected: bool | None = None self.bandwidth_corrected = bandwidth_corrected - if self.path is not None and os.path.exists(self.path): + if self.path is not None and os.path.exists( + self.path # pyright: ignore + ): self.read() @property @@ -1039,15 +1031,17 @@ def path(self) -> str | None: return self._path @path.setter - def path(self, value: str | None): + def path(self, value: str | Path | None): """Setter for the **self.path** property.""" if value is not None: attest( - is_string(value), - f'"path" property: "{value}" type is not "str"!', + isinstance(value, (str, Path)), + f'"path" property: "{value}" type is not "str" or "Path"!', ) + value = str(value) + self._path = value @property @@ -1118,27 +1112,29 @@ def spectral_quantity( @spectral_quantity.setter def spectral_quantity( self, - value: Literal[ - "absorptance", - "exitance", - "flux", - "intensity", - "irradiance", - "radiance", - "reflectance", - "relative", - "transmittance", - "R-Factor", - "T-Factor", - "other", - ] - | None, + value: ( + Literal[ + "absorptance", + "exitance", + "flux", + "intensity", + "irradiance", + "radiance", + "reflectance", + "relative", + "transmittance", + "R-Factor", + "T-Factor", + "other", + ] + | None + ), ): """Setter for the **self.spectral_quantity** property.""" if value is not None: attest( - is_string(value), + isinstance(value, str), f'"spectral_quantity" property: "{value}" type is not "str"!', ) @@ -1183,27 +1179,29 @@ def reflection_geometry( @reflection_geometry.setter def reflection_geometry( self, - value: Literal[ - "di:8", - "de:8", - "8:di", - "8:de", - "d:d", - "d:0", - "45a:0", - "45c:0", - "0:45a", - "45x:0", - "0:45x", - "other", - ] - | None, + value: ( + Literal[ + "di:8", + "de:8", + "8:di", + "8:de", + "d:d", + "d:0", + "45a:0", + "45c:0", + "0:45a", + "45x:0", + "0:45x", + "other", + ] + | None + ), ): """Setter for the **self.reflection_geometry** property.""" if value is not None: attest( - is_string(value), + isinstance(value, str), f'"reflection_geometry" property: "{value}" type is not "str"!', ) @@ -1232,14 +1230,13 @@ def transmission_geometry( @transmission_geometry.setter def transmission_geometry( self, - value: Literal["0:0", "di:0", "de:0", "0:di", "0:de", "d:d", "other"] - | None, + value: (Literal["0:0", "di:0", "de:0", "0:di", "0:de", "d:d", "other"] | None), ): """Setter for the **self.transmission_geometry** property.""" if value is not None: attest( - is_string(value), + isinstance(value, str), f'"transmission_geometry" property: "{value}" type is not "str"!', ) @@ -1322,11 +1319,7 @@ def __str__(self) -> str: -------- >>> from os.path import dirname, join >>> directory = join(dirname(__file__), "tests", "resources") - >>> print( - ... SpectralDistribution_IESTM2714( - ... join(directory, "Fluorescent.spdx") - ... ) - ... ) + >>> print(SpectralDistribution_IESTM2714(join(directory, "Fluorescent.spdx"))) ... # doctest: +ELLIPSIS IES TM-27-14 Spectral Distribution ================================== @@ -1482,7 +1475,7 @@ def __str__(self) -> str: {"formatter": lambda x: str_parent}, # noqa: ARG005 ], ) - except TypeError: + except TypeError: # pragma: no cover return super().__str__() def __repr__(self) -> str: @@ -1641,7 +1634,7 @@ def __repr__(self) -> str: {"name": "extrapolator_kwargs"}, ], ) - except TypeError: + except TypeError: # pragma: no cover return super().__repr__() def read(self) -> SpectralDistribution_IESTM2714: @@ -1662,9 +1655,7 @@ def read(self) -> SpectralDistribution_IESTM2714: -------- >>> from os.path import dirname, join >>> directory = join(dirname(__file__), "tests", "resources") - >>> sd = SpectralDistribution_IESTM2714( - ... join(directory, "Fluorescent.spdx") - ... ) + >>> sd = SpectralDistribution_IESTM2714(join(directory, "Fluorescent.spdx")) >>> sd.name # doctest: +SKIP 'Unknown - N/A - Rare earth fluorescent lamp' >>> sd.header.comments @@ -1713,9 +1704,7 @@ def read(self) -> SpectralDistribution_IESTM2714: for spectral_data in iterator( f"{{{namespace}}}{self.mapping.data.element}" ): - wavelengths.append( - spectral_data.attrib[self.mapping.data.attribute] - ) + wavelengths.append(spectral_data.attrib[self.mapping.data.attribute]) values.append(spectral_data.text) components = [ @@ -1727,9 +1716,7 @@ def read(self) -> SpectralDistribution_IESTM2714: ) if component is not None ] - self.name = ( - "Undefined" if len(components) == 0 else " - ".join(components) - ) + self.name = "Undefined" if len(components) == 0 else " - ".join(components) self.wavelengths = as_float_array(wavelengths) self.values = as_float_array(values) @@ -1755,9 +1742,7 @@ def write(self) -> bool: >>> from shutil import rmtree >>> from tempfile import mkdtemp >>> directory = join(dirname(__file__), "tests", "resources") - >>> sd = SpectralDistribution_IESTM2714( - ... join(directory, "Fluorescent.spdx") - ... ) + >>> sd = SpectralDistribution_IESTM2714(join(directory, "Fluorescent.spdx")) >>> temporary_directory = mkdtemp() >>> sd.path = join(temporary_directory, "Fluorescent.spdx") >>> sd.write() @@ -1793,9 +1778,7 @@ def write(self) -> bool: ) element_child.text = mapping.data.write_conversion(value) element_child.attrib = { - mapping.data.attribute: mapping.data.write_conversion( - wavelength - ) + mapping.data.attribute: mapping.data.write_conversion(wavelength) } xml = minidom.parseString( # noqa: S318 diff --git a/colour/io/uprtek_sekonic.py b/colour/io/uprtek_sekonic.py index 59e947cf08..efc9180091 100644 --- a/colour/io/uprtek_sekonic.py +++ b/colour/io/uprtek_sekonic.py @@ -2,7 +2,7 @@ UPRTek and Sekonic Spectral Data ================================ -Defines the input and output objects for *UPRTek* and *Sekonic* +Define the input and output objects for *UPRTek* and *Sekonic* *Pseudo-XLS*/*CSV* spectral data files. - :class:`colour.SpectralDistribution_UPRTek` @@ -16,6 +16,7 @@ import os import re from collections import defaultdict +from pathlib import Path from colour.hints import Any, cast from colour.io import SpectralDistribution_IESTM2714 @@ -160,7 +161,7 @@ class SpectralDistribution_UPRTek(SpectralDistribution_IESTM2714): _SPECTRAL_SECTION: str = "380" _SPECTRAL_DATA_PATTERN: str = "(\\d{3})nm" - def __init__(self, path: str, **kwargs: Any) -> None: + def __init__(self, path: str | Path, **kwargs: Any) -> None: self._metadata: dict = {} super().__init__(path, **kwargs) @@ -272,8 +273,10 @@ def __str__(self) -> str: representation = super().__str__() return representation.replace( - "IES TM-27-14 Spectral Distribution\n" - "==================================", + ( + "IES TM-27-14 Spectral Distribution\n" + "==================================" + ), "UPRTek\n======", ) @@ -396,9 +399,7 @@ def as_array(a: Any) -> list: if wavelength == self._SPECTRAL_SECTION: spectral_section += 1 - spectral_sections[spectral_section].append( - [wavelength, value] - ) + spectral_sections[spectral_section].append([wavelength, value]) else: for method in (int, float, as_array): try: @@ -452,9 +453,7 @@ class SpectralDistribution_Sekonic(SpectralDistribution_UPRTek): >>> from os.path import dirname, join >>> from colour import SpectralShape >>> directory = join(dirname(__file__), "tests", "resources") - >>> sd = SpectralDistribution_Sekonic( - ... join(directory, "RANDOM_001_02._3262K.csv") - ... ) + >>> sd = SpectralDistribution_Sekonic(join(directory, "RANDOM_001_02._3262K.csv")) >>> print(sd.read().align(SpectralShape(380, 780, 10))) ... # doctest: +ELLIPSIS Sekonic @@ -536,7 +535,7 @@ class SpectralDistribution_Sekonic(SpectralDistribution_UPRTek): _SPECTRAL_SECTION: str = "380" _SPECTRAL_DATA_PATTERN: str = "Spectral Data (\\d{3})\\[nm\\]" - def __init__(self, path: str, **kwargs: Any) -> None: + def __init__(self, path: str | Path, **kwargs: Any) -> None: super().__init__(path, **kwargs) def __str__(self) -> str: diff --git a/colour/io/xrite.py b/colour/io/xrite.py index a8abe36883..ebd4ed6255 100644 --- a/colour/io/xrite.py +++ b/colour/io/xrite.py @@ -2,7 +2,7 @@ X-Rite Data Input ================= -Defines the input object for *X-Rite* spectral data files: +Define the input object for *X-Rite* spectral data files: - :func:`colour.read_sds_from_xrite_file` """ @@ -11,6 +11,7 @@ import codecs import re +from pathlib import Path from colour.colorimetry import SpectralDistribution from colour.hints import Dict @@ -30,7 +31,9 @@ XRITE_FILE_ENCODING: str = "utf-8" -def read_sds_from_xrite_file(path: str) -> Dict[str, SpectralDistribution]: +def read_sds_from_xrite_file( + path: str | Path, +) -> Dict[str, SpectralDistribution]: """ Read the spectral data from given *X-Rite* file and returns it as a *dict* of :class:`colour.SpectralDistribution` class instances. @@ -64,6 +67,8 @@ def read_sds_from_xrite_file(path: str) -> Dict[str, SpectralDistribution]: ['X1', 'X2', 'X3', 'X4', 'X5', 'X6', 'X7', 'X8', 'X9', 'X10'] """ + path = str(path) + with codecs.open(path, encoding=XRITE_FILE_ENCODING) as xrite_file: lines = xrite_file.read().strip().split("\n") diff --git a/colour/models/__init__.py b/colour/models/__init__.py index 05efa58486..1131fc9278 100644 --- a/colour/models/__init__.py +++ b/colour/models/__init__.py @@ -1,9 +1,6 @@ import sys -from colour.utilities.deprecation import ModuleAPI, build_API_changes -from colour.utilities.documentation import is_documentation_building - -from colour.hints import Any +from colour.utilities import copy_definition from .common import ( COLOURSPACE_MODELS, @@ -50,7 +47,7 @@ xy_to_XYZ, XYZ_to_xy, ) -from .cie_lab import XYZ_to_Lab, Lab_to_XYZ, Lab_to_LCHab, LCHab_to_Lab +from .cie_lab import XYZ_to_Lab, Lab_to_XYZ from .cie_luv import ( XYZ_to_Luv, Luv_to_XYZ, @@ -58,8 +55,8 @@ uv_to_Luv, Luv_uv_to_xy, xy_to_Luv_uv, - Luv_to_LCHuv, - LCHuv_to_Luv, + XYZ_to_CIE1976UCS, + CIE1976UCS_to_XYZ, ) from .cie_ucs import ( XYZ_to_UCS, @@ -68,6 +65,8 @@ uv_to_UCS, UCS_uv_to_xy, xy_to_UCS_uv, + XYZ_to_CIE1960UCS, + CIE1960UCS_to_XYZ, ) from .cie_uvw import XYZ_to_UVW, UVW_to_XYZ from .din99 import Lab_to_DIN99, DIN99_to_Lab, XYZ_to_DIN99, DIN99_to_XYZ @@ -369,7 +368,125 @@ describe_video_signal_matrix_coefficients, ) -__all__ = [ +__all__ = [] + +# Programmatically defining the colourspace models polar conversions. +COLOURSPACE_MODELS_POLAR_CONVERSIONS = ( + ("Lab", "LCHab"), + ("Luv", "LCHuv"), + ("hdr_CIELab", "hdr_CIELCHab"), + ("Hunter_Lab", "Hunter_LCHab"), + ("Hunter_Rdab", "Hunter_RdCHab"), + ("ICaCb", "ICHab"), + ("ICtCp", "ICHtp"), + ("IgPgTg", "IgCHpt"), + ("IPT", "ICH"), + ("Izazbz", "IzCHab"), + ("Jzazbz", "JzCHab"), + ("hdr_IPT", "hdr_ICH"), + ("Oklab", "Oklch"), + ("ProLab", "ProLCHab"), + ("IPT_Ragoo2021", "ICH_Ragoo2021"), +) + +_DOCSTRING_JAB_TO_JCH = """ +Convert from *{Jab}* colourspace to *{JCh}* colourspace. + +This is a convenient definition wrapping :func:`colour.models.Jab_to_JCh` +definition. + +Parameters +---------- +Jab + *{Jab}* colourspace array. + +Returns +------- +:class:`numpy.ndarray` + *{JCh}* colourspace array. + +Notes +----- ++------------+-----------------------+-----------------+ +| **Domain** | **Scale - Reference** | **Scale - 1** | ++============+=======================+=================+ +| ``Jab`` | ``J`` : [0, 100] | ``J`` : [0, 1] | +| | | | +| | ``a`` : [-100, 100] | ``a`` : [-1, 1] | +| | | | +| | ``b`` : [-100, 100] | ``b`` : [-1, 1] | ++------------+-----------------------+-----------------+ + ++------------+-----------------------+-----------------+ +| **Range** | **Scale - Reference** | **Scale - 1** | ++============+=======================+=================+ +| ``JCh`` | ``J`` : [0, 100] | ``J`` : [0, 1] | +| | | | +| | ``C`` : [0, 100] | ``C`` : [0, 1] | +| | | | +| | ``h`` : [0, 360] | ``h`` : [0, 1] | ++------------+-----------------------+-----------------+ +""" + +_DOCSTRING_JCH_TO_JAB = """ +Convert from *{JCh}* colourspace to *{Jab}* colourspace. + +This is a convenient definition wrapping :func:`colour.models.JCh_to_Jab` +definition. + +Parameters +---------- +JCh + *{JCh}* colourspace array. + +Returns +------- +:class:`numpy.ndarray` + *{Jab}* colourspace array. + +Notes +----- ++-------------+-----------------------+-----------------+ +| **Domain** | **Scale - Reference** | **Scale - 1** | ++=============+=======================+=================+ +| ``JCh`` | ``J`` : [0, 100] | ``J`` : [0, 1] | +| | | | +| | ``C`` : [0, 100] | ``C`` : [0, 1] | +| | | | +| | ``h`` : [0, 360] | ``h`` : [0, 1] | ++-------------+-----------------------+-----------------+ + ++-------------+-----------------------+-----------------+ +| **Range** | **Scale - Reference** | **Scale - 1** | ++=============+=======================+=================+ +| ``Jab`` | ``J`` : [0, 100] | ``J`` : [0, 1] | +| | | | +| | ``a`` : [-100, 100] | ``a`` : [-1, 1] | +| | | | +| | ``b`` : [-100, 100] | ``b`` : [-1, 1] | ++-------------+-----------------------+-----------------+ +""" + +for _Jab, _JCh in COLOURSPACE_MODELS_POLAR_CONVERSIONS: + name = f"{_Jab}_to_{_JCh}" + _callable = copy_definition(Jab_to_JCh, name) + _callable.__doc__ = _DOCSTRING_JAB_TO_JCH.format(Jab=_Jab, JCh=_JCh) + _module = sys.modules["colour.models"] + setattr(_module, name, _callable) + __all__.append(name) + + name = f"{_JCh}_to_{_Jab}" + _callable = copy_definition(JCh_to_Jab, name) + _callable.__doc__ = _DOCSTRING_JCH_TO_JAB.format(JCh=_JCh, Jab=_Jab) + _module = sys.modules["colour.models"] + setattr(_module, name, _callable) + __all__.append(name) + +del _DOCSTRING_JAB_TO_JCH, _DOCSTRING_JCH_TO_JAB, _JCh, _Jab, _callable, _module + +__all__ += ["COLOURSPACE_MODELS_POLAR"] + +__all__ += [ "COLOURSPACE_MODELS", "COLOURSPACE_MODELS_AXIS_LABELS", "COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE", @@ -417,8 +534,6 @@ __all__ += [ "XYZ_to_Lab", "Lab_to_XYZ", - "Lab_to_LCHab", - "LCHab_to_Lab", ] __all__ += [ "XYZ_to_Luv", @@ -427,8 +542,8 @@ "uv_to_Luv", "Luv_uv_to_xy", "xy_to_Luv_uv", - "Luv_to_LCHuv", - "LCHuv_to_Luv", + "XYZ_to_CIE1976UCS", + "CIE1976UCS_to_XYZ", ] __all__ += [ "XYZ_to_UCS", @@ -437,6 +552,8 @@ "uv_to_UCS", "UCS_uv_to_xy", "xy_to_UCS_uv", + "XYZ_to_CIE1960UCS", + "CIE1960UCS_to_XYZ", ] __all__ += [ "XYZ_to_UVW", @@ -780,143 +897,3 @@ "describe_video_signal_transfer_characteristics", "describe_video_signal_matrix_coefficients", ] - - -# ----------------------------------------------------------------------------# -# --- API Changes and Deprecation Management ---# -# ----------------------------------------------------------------------------# -class models(ModuleAPI): - """Define a class acting like the *models* module.""" - - def __getattr__(self, attribute) -> Any: - """Return the value from the attribute with given name.""" - - return super().__getattr__(attribute) - - -# v0.4.0 -API_CHANGES = { - "ObjectRenamed": [ - [ - "colour.models.RGB_to_ICTCP", - "colour.models.RGB_to_ICtCp", - ], - [ - "colour.models.ICTCP_to_RGB", - "colour.models.ICtCp_to_RGB", - ], - [ - "colour.models.RGB_to_IGPGTG", - "colour.models.RGB_to_IgPgTg", - ], - [ - "colour.models.IGPGTG_to_RGB", - "colour.models.IgPgTg_to_RGB", - ], - [ - "colour.models.XYZ_to_JzAzBz", - "colour.models.XYZ_to_Jzazbz", - ], - [ - "colour.models.JzAzBz_to_XYZ", - "colour.models.Jzazbz_to_XYZ", - ], - ] -} - -# v0.4.2 -API_CHANGES["ObjectRenamed"].extend( - [ - [ - "colour.models.RGB_COLOURSPACE_ALEXA_WIDE_GAMUT", - "colour.models.RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3", - ], - [ - "colour.models.eotf_inverse_BT2020", - "colour.models.oetf_BT2020", - ], - [ - "colour.models.eotf_BT2020", - "colour.models.oetf_inverse_BT2020", - ], - [ - "colour.models.oetf_PQ_BT2100", - "colour.models.oetf_BT2100_PQ", - ], - [ - "colour.models.oetf_inverse_PQ_BT2100", - "colour.models.oetf_inverse_BT2100_PQ", - ], - [ - "colour.models.eotf_PQ_BT2100", - "colour.models.eotf_BT2100_PQ", - ], - [ - "colour.models.eotf_inverse_PQ_BT2100", - "colour.models.eotf_inverse_BT2100_PQ", - ], - [ - "colour.models.ootf_PQ_BT2100", - "colour.models.ootf_BT2100_PQ", - ], - [ - "colour.models.ootf_inverse_PQ_BT2100", - "colour.models.ootf_inverse_BT2100_PQ", - ], - [ - "colour.models.oetf_HLG_BT2100", - "colour.models.oetf_BT2100_HLG", - ], - [ - "colour.models.oetf_inverse_HLG_BT2100", - "colour.models.oetf_inverse_BT2100_HLG", - ], - [ - "colour.models.eotf_HLG_BT2100", - "colour.models.eotf_BT2100_HLG", - ], - [ - "colour.models.eotf_inverse_HLG_BT2100", - "colour.models.eotf_inverse_BT2100_HLG", - ], - [ - "colour.models.ootf_HLG_BT2100", - "colour.models.ootf_BT2100_HLG", - ], - [ - "colour.models.ootf_inverse_HLG_BT2100", - "colour.models.ootf_inverse_BT2100_HLG", - ], - [ - "colour.models.log_decoding_ALEXALogC", - "colour.models.log_decoding_ARRILogC3", - ], - [ - "colour.models.log_encoding_ALEXALogC", - "colour.models.log_encoding_ARRILogC3", - ], - ] -) - - -# v0.4.3 -API_CHANGES["ObjectRenamed"].extend( - [ - [ - "colour.models.XYZ_to_IPT_Munish2021", - "colour.models.XYZ_to_IPT_Ragoo2021", - ], - [ - "colour.models.IPT_Munish2021_to_XYZ", - "colour.models.IPT_Ragoo2021_to_XYZ", - ], - ] -) -"""Defines the *colour.models* sub-package API changes.""" - -if not is_documentation_building(): - sys.modules["colour.models"] = models( # pyright: ignore - sys.modules["colour.models"], build_API_changes(API_CHANGES) - ) - - del ModuleAPI, is_documentation_building, build_API_changes, sys diff --git a/colour/models/cam02_ucs.py b/colour/models/cam02_ucs.py index e66bda6064..dd9f00501b 100644 --- a/colour/models/cam02_ucs.py +++ b/colour/models/cam02_ucs.py @@ -2,7 +2,7 @@ CAM02-LCD, CAM02-SCD, and CAM02-UCS Colourspaces - Luo, Cui and Li (2006) ========================================================================= -Defines the *Luo et al. (2006)* *CAM02-LCD*, *CAM02-SCD*, and *CAM02-UCS* +Define the *Luo et al. (2006)* *CAM02-LCD*, *CAM02-SCD*, and *CAM02-UCS* colourspaces transformations: - :func:`colour.JMh_CIECAM02_to_CAM02LCD` @@ -227,9 +227,7 @@ def UCS_Luo2006_to_JMh_CIECAM02( Examples -------- >>> Jpapbp = np.array([54.90433134, -0.08450395, -0.06854831]) - >>> UCS_Luo2006_to_JMh_CIECAM02( - ... Jpapbp, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ... ) + >>> UCS_Luo2006_to_JMh_CIECAM02(Jpapbp, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]) ... # doctest: +ELLIPSIS array([ 4.1731091...e+01, 1.0884217...e-01, 2.1904843...e+02]) """ @@ -635,7 +633,7 @@ def XYZ_to_UCS_Luo2006( kwargs {:func:`colour.XYZ_to_CIECAM02`}, See the documentation of the previously listed definition. The default - viewing conditions are that of *IEC 61966-2-1:1999*, i.e. *sRGB* 64 Lux + viewing conditions are that of *IEC 61966-2-1:1999*, i.e., *sRGB* 64 Lux ambient illumination, 80 :math:`cd/m^2`, adapting field luminance about 20% of a white object in the scene. @@ -723,7 +721,7 @@ def UCS_Luo2006_to_XYZ( kwargs {:func:`colour.CIECAM02_to_XYZ`}, See the documentation of the previously listed definition. The default - viewing conditions are that of *IEC 61966-2-1:1999*, i.e. *sRGB* 64 Lux + viewing conditions are that of *IEC 61966-2-1:1999*, i.e., *sRGB* 64 Lux ambient illumination, 80 :math:`cd/m^2`, adapting field luminance about 20% of a white object in the scene. @@ -805,7 +803,7 @@ def XYZ_to_CAM02LCD(XYZ: ArrayLike, **kwargs: Any) -> NDArrayFloat: kwargs {:func:`colour.XYZ_to_CIECAM02`}, See the documentation of the previously listed definition. The default - viewing conditions are that of *IEC 61966-2-1:1999*, i.e. *sRGB* 64 Lux + viewing conditions are that of *IEC 61966-2-1:1999*, i.e., *sRGB* 64 Lux ambient illumination, 80 :math:`cd/m^2`, adapting field luminance about 20% of a white object in the scene. @@ -870,7 +868,7 @@ def CAM02LCD_to_XYZ(Jpapbp: ArrayLike, **kwargs: Any) -> NDArrayFloat: kwargs {:func:`colour.CIECAM02_to_XYZ`}, See the documentation of the previously listed definition. The default - viewing conditions are that of *IEC 61966-2-1:1999*, i.e. *sRGB* 64 Lux + viewing conditions are that of *IEC 61966-2-1:1999*, i.e., *sRGB* 64 Lux ambient illumination, 80 :math:`cd/m^2`, adapting field luminance about 20% of a white object in the scene. @@ -935,7 +933,7 @@ def XYZ_to_CAM02SCD(XYZ: ArrayLike, **kwargs: Any) -> NDArrayFloat: kwargs {:func:`colour.XYZ_to_CIECAM02`}, See the documentation of the previously listed definition. The default - viewing conditions are that of *IEC 61966-2-1:1999*, i.e. *sRGB* 64 Lux + viewing conditions are that of *IEC 61966-2-1:1999*, i.e., *sRGB* 64 Lux ambient illumination, 80 :math:`cd/m^2`, adapting field luminance about 20% of a white object in the scene. @@ -1000,7 +998,7 @@ def CAM02SCD_to_XYZ(Jpapbp: ArrayLike, **kwargs: Any) -> NDArrayFloat: kwargs {:func:`colour.CIECAM02_to_XYZ`}, See the documentation of the previously listed definition. The default - viewing conditions are that of *IEC 61966-2-1:1999*, i.e. *sRGB* 64 Lux + viewing conditions are that of *IEC 61966-2-1:1999*, i.e., *sRGB* 64 Lux ambient illumination, 80 :math:`cd/m^2`, adapting field luminance about 20% of a white object in the scene. @@ -1065,7 +1063,7 @@ def XYZ_to_CAM02UCS(XYZ: ArrayLike, **kwargs: Any) -> NDArrayFloat: kwargs {:func:`colour.XYZ_to_CIECAM02`}, See the documentation of the previously listed definition. The default - viewing conditions are that of *IEC 61966-2-1:1999*, i.e. *sRGB* 64 Lux + viewing conditions are that of *IEC 61966-2-1:1999*, i.e., *sRGB* 64 Lux ambient illumination, 80 :math:`cd/m^2`, adapting field luminance about 20% of a white object in the scene. @@ -1130,7 +1128,7 @@ def CAM02UCS_to_XYZ(Jpapbp: ArrayLike, **kwargs: Any) -> NDArrayFloat: kwargs {:func:`colour.CIECAM02_to_XYZ`}, See the documentation of the previously listed definition. The default - viewing conditions are that of *IEC 61966-2-1:1999*, i.e. *sRGB* 64 Lux + viewing conditions are that of *IEC 61966-2-1:1999*, i.e., *sRGB* 64 Lux ambient illumination, 80 :math:`cd/m^2`, adapting field luminance about 20% of a white object in the scene. diff --git a/colour/models/cam16_ucs.py b/colour/models/cam16_ucs.py index 830a10c47c..f3bab46cf0 100644 --- a/colour/models/cam16_ucs.py +++ b/colour/models/cam16_ucs.py @@ -2,7 +2,7 @@ CAM16-LCD, CAM16-SCD, and CAM16-UCS Colourspaces - Li et al. (2017) =================================================================== -Defines the *Li, Li, Wang, Zu, Luo, Cui, Melgosa, Brill and Pointer (2017)* +Define the *Li, Li, Wang, Zu, Luo, Cui, Melgosa, Brill and Pointer (2017)* *CAM16-LCD*, *CAM16-SCD*, and *CAM16-UCS* colourspaces transformations: - :func:`colour.JMh_CAM16_to_CAM16LCD` @@ -120,15 +120,15 @@ def _UCS_Luo2006_callable_to_UCS_Li2017_docstring(callable_: Callable) -> str: JMh_CAM16_to_UCS_Li2017 = copy_definition( JMh_CIECAM02_to_UCS_Luo2006, "JMh_CAM16_to_UCS_Li2017" ) -JMh_CAM16_to_UCS_Li2017.__doc__ = ( - _UCS_Luo2006_callable_to_UCS_Li2017_docstring(JMh_CIECAM02_to_UCS_Luo2006) +JMh_CAM16_to_UCS_Li2017.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring( + JMh_CIECAM02_to_UCS_Luo2006 ) UCS_Li2017_to_JMh_CAM16 = copy_definition( UCS_Luo2006_to_JMh_CIECAM02, "UCS_Li2017_to_JMh_CAM16" ) -UCS_Li2017_to_JMh_CAM16.__doc__ = ( - _UCS_Luo2006_callable_to_UCS_Li2017_docstring(UCS_Luo2006_to_JMh_CIECAM02) +UCS_Li2017_to_JMh_CAM16.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring( + UCS_Luo2006_to_JMh_CIECAM02 ) JMh_CAM16_to_CAM16LCD = partial( @@ -194,7 +194,7 @@ def XYZ_to_UCS_Li2017( kwargs {:func:`colour.XYZ_to_CAM16`}, See the documentation of the previously listed definition. The default - viewing conditions are that of *IEC 61966-2-1:1999*, i.e. *sRGB* 64 Lux + viewing conditions are that of *IEC 61966-2-1:1999*, i.e., *sRGB* 64 Lux ambient illumination, 80 :math:`cd/m^2`, adapting field luminance about 20% of a white object in the scene. @@ -237,9 +237,7 @@ def XYZ_to_UCS_Li2017( >>> from colour.appearance import CAM_KWARGS_CIECAM02_sRGB >>> XYZ_w = CAM_KWARGS_CIECAM02_sRGB["XYZ_w"] - >>> XYZ_to_UCS_Li2017( - ... XYZ, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"], XYZ_w=XYZ_w / 100 - ... ) + >>> XYZ_to_UCS_Li2017(XYZ, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"], XYZ_w=XYZ_w / 100) ... # doctest: +ELLIPSIS array([ 46.0658603..., 41.0758649..., 14.5102582...]) """ @@ -291,7 +289,7 @@ def UCS_Li2017_to_XYZ( kwargs {:func:`colour.CAM16_to_XYZ`}, See the documentation of the previously listed definition. The default - viewing conditions are that of *IEC 61966-2-1:1999*, i.e. *sRGB* 64 Lux + viewing conditions are that of *IEC 61966-2-1:1999*, i.e., *sRGB* 64 Lux ambient illumination, 80 :math:`cd/m^2`, adapting field luminance about 20% of a white object in the scene. @@ -370,41 +368,29 @@ def UCS_Li2017_to_XYZ( XYZ_to_CAM16LCD = partial( XYZ_to_UCS_Li2017, coefficients=COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] ) -XYZ_to_CAM16LCD.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring( - XYZ_to_CAM02LCD -) +XYZ_to_CAM16LCD.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring(XYZ_to_CAM02LCD) CAM16LCD_to_XYZ = partial( UCS_Li2017_to_XYZ, coefficients=COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] ) -CAM16LCD_to_XYZ.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring( - CAM02LCD_to_XYZ -) +CAM16LCD_to_XYZ.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring(CAM02LCD_to_XYZ) XYZ_to_CAM16SCD = partial( XYZ_to_UCS_Li2017, coefficients=COEFFICIENTS_UCS_LUO2006["CAM02-SCD"] ) -XYZ_to_CAM16SCD.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring( - XYZ_to_CAM02SCD -) +XYZ_to_CAM16SCD.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring(XYZ_to_CAM02SCD) CAM16SCD_to_XYZ = partial( UCS_Li2017_to_XYZ, coefficients=COEFFICIENTS_UCS_LUO2006["CAM02-SCD"] ) -CAM16SCD_to_XYZ.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring( - CAM02SCD_to_XYZ -) +CAM16SCD_to_XYZ.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring(CAM02SCD_to_XYZ) XYZ_to_CAM16UCS = partial( XYZ_to_UCS_Li2017, coefficients=COEFFICIENTS_UCS_LUO2006["CAM02-UCS"] ) -XYZ_to_CAM16UCS.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring( - XYZ_to_CAM02UCS -) +XYZ_to_CAM16UCS.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring(XYZ_to_CAM02UCS) CAM16UCS_to_XYZ = partial( UCS_Li2017_to_XYZ, coefficients=COEFFICIENTS_UCS_LUO2006["CAM02-UCS"] ) -CAM16UCS_to_XYZ.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring( - CAM02UCS_to_XYZ -) +CAM16UCS_to_XYZ.__doc__ = _UCS_Luo2006_callable_to_UCS_Li2017_docstring(CAM02UCS_to_XYZ) diff --git a/colour/models/cie_lab.py b/colour/models/cie_lab.py index fc33addc88..7603fb2d0b 100644 --- a/colour/models/cie_lab.py +++ b/colour/models/cie_lab.py @@ -2,12 +2,10 @@ CIE L*a*b* Colourspace ====================== -Defines the *CIE L\\*a\\*b\\** colourspace transformations: +Define the *CIE L\\*a\\*b\\** colourspace transformations: - :func:`colour.XYZ_to_Lab` - :func:`colour.Lab_to_XYZ` -- :func:`colour.Lab_to_LCHab` -- :func:`colour.LCHab_to_Lab` References ---------- @@ -24,7 +22,7 @@ intermediate_luminance_function_CIE1976, ) from colour.hints import ArrayLike, NDArrayFloat -from colour.models import Jab_to_JCh, JCh_to_Jab, xy_to_xyY, xyY_to_XYZ +from colour.models import xy_to_xyY, xyY_to_XYZ from colour.utilities import ( from_range_1, from_range_100, @@ -44,16 +42,14 @@ __all__ = [ "XYZ_to_Lab", "Lab_to_XYZ", - "Lab_to_LCHab", - "LCHab_to_Lab", ] def XYZ_to_Lab( XYZ: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], ) -> NDArrayFloat: """ Convert from *CIE XYZ* tristimulus values to *CIE L\\*a\\*b\\** @@ -122,9 +118,9 @@ def XYZ_to_Lab( def Lab_to_XYZ( Lab: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], ) -> NDArrayFloat: """ Convert from *CIE L\\*a\\*b\\** colourspace to *CIE XYZ* tristimulus @@ -190,107 +186,3 @@ def Lab_to_XYZ( XYZ = tstack([X, Y, Z]) return from_range_1(XYZ) - - -def Lab_to_LCHab(Lab: ArrayLike) -> NDArrayFloat: - """ - Convert from *CIE L\\*a\\*b\\** colourspace to *CIE L\\*C\\*Hab* - colourspace. - - Parameters - ---------- - Lab - *CIE L\\*a\\*b\\** colourspace array. - - Returns - ------- - :class:`numpy.ndarray` - *CIE L\\*C\\*Hab* colourspace array. - - Notes - ----- - +------------+-----------------------+-----------------+ - | **Domain** | **Scale - Reference** | **Scale - 1** | - +============+=======================+=================+ - | ``Lab`` | ``L`` : [0, 100] | ``L`` : [0, 1] | - | | | | - | | ``a`` : [-100, 100] | ``a`` : [-1, 1] | - | | | | - | | ``b`` : [-100, 100] | ``b`` : [-1, 1] | - +------------+-----------------------+-----------------+ - - +------------+-----------------------+------------------+ - | **Range** | **Scale - Reference** | **Scale - 1** | - +============+=======================+==================+ - | ``LCHab`` | ``L`` : [0, 100] | ``L`` : [0, 1] | - | | | | - | | ``C`` : [0, 100] | ``C`` : [0, 1] | - | | | | - | | ``Hab`` : [0, 360] | ``Hab`` : [0, 1] | - +------------+-----------------------+------------------+ - - References - ---------- - :cite:`CIETC1-482004m` - - Examples - -------- - >>> import numpy as np - >>> Lab = np.array([41.52787529, 52.63858304, 26.92317922]) - >>> Lab_to_LCHab(Lab) # doctest: +ELLIPSIS - array([ 41.5278752..., 59.1242590..., 27.0884878...]) - """ - - return Jab_to_JCh(Lab) - - -def LCHab_to_Lab(LCHab: ArrayLike) -> NDArrayFloat: - """ - Convert from *CIE L\\*C\\*Hab* colourspace to *CIE L\\*a\\*b\\** - colourspace. - - Parameters - ---------- - LCHab - *CIE L\\*C\\*Hab* colourspace array. - - Returns - ------- - :class:`numpy.ndarray` - *CIE L\\*a\\*b\\** colourspace array. - - Notes - ----- - +-------------+-----------------------+------------------+ - | **Domain** | **Scale - Reference** | **Scale - 1** | - +=============+=======================+==================+ - | ``LCHab`` | ``L`` : [0, 100] | ``L`` : [0, 1] | - | | | | - | | ``C`` : [0, 100] | ``C`` : [0, 1] | - | | | | - | | ``Hab`` : [0, 360] | ``Hab`` : [0, 1] | - +-------------+-----------------------+------------------+ - - +-------------+-----------------------+-----------------+ - | **Range** | **Scale - Reference** | **Scale - 1** | - +=============+=======================+=================+ - | ``Lab`` | ``L`` : [0, 100] | ``L`` : [0, 1] | - | | | | - | | ``a`` : [-100, 100] | ``a`` : [-1, 1] | - | | | | - | | ``b`` : [-100, 100] | ``b`` : [-1, 1] | - +-------------+-----------------------+-----------------+ - - References - ---------- - :cite:`CIETC1-482004m` - - Examples - -------- - >>> import numpy as np - >>> LCHab = np.array([41.52787529, 59.12425901, 27.08848784]) - >>> LCHab_to_Lab(LCHab) # doctest: +ELLIPSIS - array([ 41.5278752..., 52.6385830..., 26.9231792...]) - """ - - return JCh_to_Jab(LCHab) diff --git a/colour/models/cie_luv.py b/colour/models/cie_luv.py index 9ddf5a5acd..3fec113238 100644 --- a/colour/models/cie_luv.py +++ b/colour/models/cie_luv.py @@ -2,7 +2,7 @@ CIE L*u*v* Colourspace ====================== -Defines the *CIE L\\*u\\*v\\** colourspace transformations: +Define the *CIE L\\*u\\*v\\** colourspace transformations: - :func:`colour.XYZ_to_Luv` - :func:`colour.Luv_to_XYZ` @@ -10,8 +10,8 @@ - :func:`colour.uv_to_Luv` - :func:`colour.Luv_uv_to_xy` - :func:`colour.xy_to_Luv_uv` -- :func:`colour.Luv_to_LCHuv` -- :func:`colour.LCHuv_to_Luv` +- :func:`colour.XYZ_to_CIE1976UCS` +- :func:`colour.CIE1976UCS_to_XYZ` References ---------- @@ -30,6 +30,8 @@ from __future__ import annotations +import numpy as np + from colour.algebra import sdiv, sdiv_mode from colour.colorimetry import ( CCS_ILLUMINANTS, @@ -37,13 +39,11 @@ luminance_CIE1976, ) from colour.hints import ArrayLike, NDArrayFloat -from colour.models import Jab_to_JCh, JCh_to_Jab, xy_to_xyY, xyY_to_XYZ +from colour.models import xy_to_xyY, xyY_to_XYZ from colour.utilities import ( - as_float_scalar, domain_range_scale, from_range_1, from_range_100, - full, to_domain_1, to_domain_100, tsplit, @@ -64,16 +64,16 @@ "uv_to_Luv", "Luv_uv_to_xy", "xy_to_Luv_uv", - "Luv_to_LCHuv", - "LCHuv_to_Luv", + "XYZ_to_CIE1976UCS", + "CIE1976UCS_to_XYZ", ] def XYZ_to_Luv( XYZ: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], ) -> NDArrayFloat: """ Convert from *CIE XYZ* tristimulus values to *CIE L\\*u\\*v\\** @@ -128,7 +128,7 @@ def XYZ_to_Luv( X_r, Y_r, Z_r = tsplit(xyY_to_XYZ(xy_to_xyY(illuminant))) - with domain_range_scale("100"): + with domain_range_scale("ignore"): L = lightness_CIE1976(Y, Y_r) X_Y_Z = X + 15 * Y + 3 * Z @@ -145,9 +145,9 @@ def XYZ_to_Luv( def Luv_to_XYZ( Luv: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], ) -> NDArrayFloat: """ Convert from *CIE L\\*u\\*v\\** colourspace to *CIE XYZ* tristimulus @@ -202,7 +202,7 @@ def Luv_to_XYZ( X_r, Y_r, Z_r = tsplit(xyY_to_XYZ(xy_to_xyY(illuminant))) - with domain_range_scale("100"): + with domain_range_scale("ignore"): Y = luminance_CIE1976(L, Y_r) X_r_Y_r_Z_r = X_r + 15 * Y_r + 3 * Z_r @@ -227,9 +227,9 @@ def Luv_to_XYZ( def Luv_to_uv( Luv: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], ) -> NDArrayFloat: """ Return the :math:`uv^p` chromaticity coordinates from given @@ -288,10 +288,10 @@ def Luv_to_uv( def uv_to_Luv( uv: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], - Y: float = 1, + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], + L: NDArrayFloat = np.array(100), ) -> NDArrayFloat: """ Return the *CIE L\\*u\\*v\\** colourspace array from given :math:`uv^p` @@ -305,10 +305,10 @@ def uv_to_Luv( illuminant Reference *illuminant* *CIE xy* chromaticity coordinates or *CIE xyY* colourspace array. - Y - Optional :math:`Y` *luminance* value used to construct the intermediate - *CIE XYZ* colourspace array, the default :math:`Y` *luminance* value is - 1. + L + Optional :math:`L^*` *Lightness* value used to construct the intermediate + *CIE XYZ* colourspace array, the default :math:`L^*` *Lightness* value is + 100. Returns ------- @@ -337,18 +337,23 @@ def uv_to_Luv( -------- >>> import numpy as np >>> uv = np.array([0.37720213, 0.50120264]) - >>> uv_to_Luv(uv) # doctest: +ELLIPSIS - array([ 100. , 233.1837603..., 42.7474385...]) + >>> uv_to_Luv(uv, L=41.5278752) # doctest: +ELLIPSIS + array([ 41.5278752..., 96.8362609..., 17.7521029...]) """ u, v = tsplit(uv) - Y = as_float_scalar(to_domain_1(Y)) + L = to_domain_100(L) + + _X_r, Y_r, _Z_r = tsplit(xyY_to_XYZ(xy_to_xyY(illuminant))) + + with domain_range_scale("ignore"): + Y = luminance_CIE1976(L, Y_r) with sdiv_mode(): - X = 9 * sdiv(u, 4 * v) - Z = sdiv(-5 * Y * v - 3 * u / 4 + 3, v) + X = sdiv(9 * Y * u, 4 * v) + Z = sdiv(Y * (-3 * u - 20 * v + 12), 4 * v) - XYZ = tstack([X, full(u.shape, Y), Z]) + XYZ = tstack([X, np.resize(Y, u.shape), Z]) return XYZ_to_Luv(from_range_1(XYZ), illuminant) @@ -427,105 +432,129 @@ def xy_to_Luv_uv(xy: ArrayLike) -> NDArrayFloat: return uv -def Luv_to_LCHuv(Luv: ArrayLike) -> NDArrayFloat: +def XYZ_to_CIE1976UCS( + XYZ: ArrayLike, + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], +) -> NDArrayFloat: """ - Convert from *CIE L\\*u\\*v\\** colourspace to *CIE L\\*C\\*Huv* - colourspace. + Convert from *CIE XYZ* tristimulus values to :math:`uv^pL\\*` colourspace. + + This colourspace combines the :math:`uv^p` chromaticity coordinates with + the *Lightness* :math:`L\\*` from the *CIE L\\*u\\*v\\** colourspace. + + It is a convenient definition for use with the + *CIE 1976 UCS Chromaticity Diagram*. Parameters ---------- - Luv - *CIE L\\*u\\*v\\** colourspace array. + XYZ + *CIE XYZ* tristimulus values. + illuminant + Reference *illuminant* *CIE xy* chromaticity coordinates or *CIE xyY* + colourspace array. Returns ------- :class:`numpy.ndarray` - *CIE L\\*C\\*Huv* colourspace array. + :math:`uv^pL\\*` colourspace array. Notes ----- - +------------+-----------------------+-----------------+ - | **Domain** | **Scale - Reference** | **Scale - 1** | - +============+=======================+=================+ - | ``Luv`` | ``L`` : [0, 100] | ``L`` : [0, 1] | - | | | | - | | ``u`` : [-100, 100] | ``u`` : [-1, 1] | - | | | | - | | ``v`` : [-100, 100] | ``v`` : [-1, 1] | - +------------+-----------------------+-----------------+ - - +------------+-----------------------+------------------+ - | **Range** | **Scale - Reference** | **Scale - 1** | - +============+=======================+==================+ - | ``LCHuv`` | ``L`` : [0, 100] | ``L`` : [0, 1] | - | | | | - | | ``C`` : [0, 100] | ``C`` : [0, 1] | - | | | | - | | ``Huv`` : [0, 360] | ``Huv`` : [0, 1] | - +------------+-----------------------+------------------+ + +----------------+-----------------------+-----------------+ + | **Domain** | **Scale - Reference** | **Scale - 1** | + +================+=======================+=================+ + | ``XYZ`` | [0, 1] | [0, 1] | + +----------------+-----------------------+-----------------+ + | ``illuminant`` | [0, 1] | [0, 1] | + +----------------+-----------------------+-----------------+ - References - ---------- - :cite:`CIETC1-482004m` + +----------------+-----------------------+-----------------+ + | **Range** | **Scale - Reference** | **Scale - 1** | + +================+=======================+=================+ + | ``uvL`` | ``u`` : [-1, 1] | ``u`` : [-1, 1] | + | | | | + | | ``v`` : [-1, 1] | ``v`` : [-1, 1] | + | | | | + | | ``L`` : [0, 100] | ``L`` : [0, 1] | + +----------------+-----------------------+-----------------+ Examples -------- >>> import numpy as np - >>> Luv = np.array([41.52787529, 96.83626054, 17.75210149]) - >>> Luv_to_LCHuv(Luv) # doctest: +ELLIPSIS - array([ 41.5278752..., 98.4499795..., 10.3881634...]) + >>> XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) + >>> XYZ_to_CIE1976UCS(XYZ) # doctest: +ELLIPSIS + array([ 0.3772021..., 0.5012026..., 41.5278752...]) """ - return Jab_to_JCh(Luv) + Luv = XYZ_to_Luv(XYZ, illuminant) + + L, _u, _v = tsplit(Luv) + + u, v = tsplit(Luv_to_uv(Luv, illuminant)) + + return tstack([u, v, L]) -def LCHuv_to_Luv(LCHuv: ArrayLike) -> NDArrayFloat: +def CIE1976UCS_to_XYZ( + uvL: ArrayLike, + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], +) -> NDArrayFloat: """ - Convert from *CIE L\\*C\\*Huv* colourspace to *CIE L\\*u\\*v\\** - colourspace. + Convert from *CIE XYZ* tristimulus values to :math:`uv^pL\\*` colourspace. + + This colourspace combines the :math:`uv^p` chromaticity coordinates with + the *Lightness* :math:`L\\*` from the *CIE L\\*u\\*v\\** colourspace. + + It is a convenient definition for use with the + *CIE 1976 UCS Chromaticity Diagram*. Parameters ---------- - LCHuv - *CIE L\\*C\\*Huv* colourspace array. + uvL + :math:`uv^pL\\*` colourspace array. + illuminant + Reference *illuminant* *CIE xy* chromaticity coordinates or *CIE xyY* + colourspace array. Returns ------- :class:`numpy.ndarray` - *CIE L\\*u\\*v\\** colourspace array. + :math:`uv^pL\\*` colourspace array. Notes ----- - +------------+-----------------------+------------------+ - | **Domain** | **Scale - Reference** | **Scale - 1** | - +============+=======================+==================+ - | ``LCHuv`` | ``L`` : [0, 100] | ``L`` : [0, 1] | - | | | | - | | ``C`` : [0, 100] | ``C`` : [0, 1] | - | | | | - | | ``Huv`` : [0, 360] | ``Huv`` : [0, 1] | - +------------+-----------------------+------------------+ - - +------------+-----------------------+-----------------+ - | **Range** | **Scale - Reference** | **Scale - 1** | - +============+=======================+=================+ - | ``Luv`` | ``L`` : [0, 100] | ``L`` : [0, 1] | - | | | | - | | ``u`` : [-100, 100] | ``u`` : [-1, 1] | - | | | | - | | ``v`` : [-100, 100] | ``v`` : [-1, 1] | - +------------+-----------------------+-----------------+ + +----------------+-----------------------+-----------------+ + | **Domain** | **Scale - Reference** | **Scale - 1** | + +================+=======================+=================+ + | ``uvL`` | ``u`` : [-1, 1] | ``u`` : [-1, 1] | + | | | | + | | ``v`` : [-1, 1] | ``v`` : [-1, 1] | + | | | | + | | ``L`` : [0, 100] | ``L`` : [0, 1] | + +----------------+-----------------------+-----------------+ + | ``illuminant`` | [0, 1] | [0, 1] | + +----------------+-----------------------+-----------------+ - References - ---------- - :cite:`CIETC1-482004m` + +----------------+-----------------------+-----------------+ + | **Range** | **Scale - Reference** | **Scale - 1** | + +================+=======================+=================+ + | ``XYZ`` | [0, 1] | [0, 1] | + +----------------+-----------------------+-----------------+ Examples -------- >>> import numpy as np - >>> LCHuv = np.array([41.52787529, 98.44997950, 10.38816348]) - >>> LCHuv_to_Luv(LCHuv) # doctest: +ELLIPSIS - array([ 41.5278752..., 96.8362605..., 17.7521014...]) + >>> uvL = np.array([0.37720213, 0.50120264, 41.52787529]) + >>> CIE1976UCS_to_XYZ(uvL) # doctest: +ELLIPSIS + array([ 0.2065400..., 0.1219722..., 0.0513695...]) """ - return JCh_to_Jab(LCHuv) + u, v, L = tsplit(uvL) + + _L, u, v = tsplit(uv_to_Luv(tstack([u, v]), illuminant, L)) + + return Luv_to_XYZ(tstack([L, u, v]), illuminant) diff --git a/colour/models/cie_ucs.py b/colour/models/cie_ucs.py index 9e8513db35..d568d51208 100644 --- a/colour/models/cie_ucs.py +++ b/colour/models/cie_ucs.py @@ -2,7 +2,7 @@ CIE 1960 UCS Colourspace ======================== -Defines the *CIE 1960 UCS* colourspace transformations: +Define the *CIE 1960 UCS* colourspace transformations: - :func:`colour.XYZ_to_UCS` - :func:`colour.UCS_to_XYZ` @@ -10,6 +10,8 @@ - :func:`colour.uv_to_UCS` - :func:`colour.UCS_uv_to_xy` - :func:`colour.xy_to_UCS_uv` +- :func:`colour.XYZ_to_CIE1960UCS` +- :func:`colour.CIE1960UCS_to_XYZ` References ---------- @@ -22,12 +24,12 @@ from __future__ import annotations +import numpy as np + from colour.algebra import sdiv, sdiv_mode from colour.hints import ArrayLike, NDArrayFloat from colour.utilities import ( - as_float_scalar, from_range_1, - full, to_domain_1, tsplit, tstack, @@ -47,12 +49,15 @@ "uv_to_UCS", "UCS_uv_to_xy", "xy_to_UCS_uv", + "XYZ_to_CIE1960UCS", + "CIE1960UCS_to_XYZ", ] def XYZ_to_UCS(XYZ: ArrayLike) -> NDArrayFloat: """ - Convert from *CIE XYZ* tristimulus values to *CIE 1960 UCS* colourspace. + Convert from *CIE XYZ* tristimulus values to *CIE 1960 UCS* :math:`UVW` + colourspace. Parameters ---------- @@ -62,7 +67,7 @@ def XYZ_to_UCS(XYZ: ArrayLike) -> NDArrayFloat: Returns ------- :class:`numpy.ndarray` - *CIE 1960 UCS* colourspace array. + *CIE 1960 UCS* :math:`UVW` colourspace array. Notes ----- @@ -99,12 +104,13 @@ def XYZ_to_UCS(XYZ: ArrayLike) -> NDArrayFloat: def UCS_to_XYZ(UVW: ArrayLike) -> NDArrayFloat: """ - Convert from *CIE 1960 UCS* colourspace to *CIE XYZ* tristimulus values. + Convert from *CIE 1960 UCS* :math:`UVW` colourspace to *CIE XYZ* tristimulus + values. Parameters ---------- UVW - *CIE 1960 UCS* colourspace array. + *CIE 1960 UCS* :math:`UVW` colourspace array. Returns ------- @@ -147,12 +153,12 @@ def UCS_to_XYZ(UVW: ArrayLike) -> NDArrayFloat: def UCS_to_uv(UVW: ArrayLike) -> NDArrayFloat: """ Return the *uv* chromaticity coordinates from given *CIE 1960 UCS* - colourspace array. + :math:`UVW` colourspace array. Parameters ---------- UVW - *CIE 1960 UCS* colourspace array. + *CIE 1960 UCS* :math:`UVW` colourspace array. Returns ------- @@ -189,10 +195,10 @@ def UCS_to_uv(UVW: ArrayLike) -> NDArrayFloat: return uv -def uv_to_UCS(uv: ArrayLike, V: float = 1) -> NDArrayFloat: +def uv_to_UCS(uv: ArrayLike, V: NDArrayFloat = np.array(1)) -> NDArrayFloat: """ - Return the *CIE 1960 UCS* colourspace array from given *uv* chromaticity - coordinates. + Return the *CIE 1960 UCS* :math:`UVW` colourspace array from given *uv* + chromaticity coordinates. Parameters ---------- @@ -200,13 +206,13 @@ def uv_to_UCS(uv: ArrayLike, V: float = 1) -> NDArrayFloat: *uv* chromaticity coordinates. V Optional :math:`V` *luminance* value used to construct the - *CIE 1960 UCS* colourspace array, the default :math:`V` *luminance* is - set to 1. + *CIE 1960 UCS* :math:`UVW` colourspace array, the default :math:`V` + *luminance* is set to 1. Returns ------- :class:`numpy.ndarray` - *CIE 1960 UCS* colourspace array. + *CIE 1960 UCS* :math:`UVW` colourspace array. References ---------- @@ -221,12 +227,10 @@ def uv_to_UCS(uv: ArrayLike, V: float = 1) -> NDArrayFloat: """ u, v = tsplit(uv) - V = as_float_scalar(to_domain_1(V)) + V = to_domain_1(V) with sdiv_mode(): - UVW = tstack( - [V * sdiv(u, v), full(u.shape, V), -V * sdiv(u + v - 1, v)] - ) + UVW = tstack([V * sdiv(u, v), np.resize(V, u.shape), -V * sdiv(u + v - 1, v)]) return from_range_1(UVW) @@ -234,7 +238,7 @@ def uv_to_UCS(uv: ArrayLike, V: float = 1) -> NDArrayFloat: def UCS_uv_to_xy(uv: ArrayLike) -> NDArrayFloat: """ Return the *CIE xy* chromaticity coordinates from given *CIE 1960 UCS* - colourspace *uv* chromaticity coordinates. + :math:`UVW` colourspace *uv* chromaticity coordinates. Parameters ---------- @@ -270,8 +274,8 @@ def UCS_uv_to_xy(uv: ArrayLike) -> NDArrayFloat: def xy_to_UCS_uv(xy: ArrayLike) -> NDArrayFloat: """ - Return the *CIE 1960 UCS* colourspace *uv* chromaticity coordinates from - given *CIE xy* chromaticity coordinates. + Return the *CIE 1960 UCS* :math:`UVW` colourspace *uv* chromaticity + coordinates from given *CIE xy* chromaticity coordinates. Parameters ---------- @@ -303,3 +307,113 @@ def xy_to_UCS_uv(xy: ArrayLike) -> NDArrayFloat: uv = tstack([sdiv(4 * x, d), sdiv(6 * y, d)]) return uv + + +def XYZ_to_CIE1960UCS( + XYZ: ArrayLike, +) -> NDArrayFloat: + """ + Convert from *CIE XYZ* tristimulus values to :math:`uvV` colourspace. + + This colourspace combines the *CIE 1960 UCS* :math:`UVW` colourspace *uv* + chromaticity coordinates with the *luminance* :math:`V` from the + *CIE 1960 UCS* :math:`UVW` colourspace. + + It is a convenient definition for use with the + *CIE 1960 UCS Chromaticity Diagram*. + + Parameters + ---------- + XYZ + *CIE XYZ* tristimulus values. + + Returns + ------- + :class:`numpy.ndarray` + :math:`uvV` colourspace array. + + Notes + ----- + +----------------+-----------------------+-----------------+ + | **Domain** | **Scale - Reference** | **Scale - 1** | + +================+=======================+=================+ + | ``XYZ`` | [0, 1] | [0, 1] | + +----------------+-----------------------+-----------------+ + | ``illuminant`` | [0, 1] | [0, 1] | + +----------------+-----------------------+-----------------+ + + +----------------+-----------------------+-----------------+ + | **Range** | **Scale - Reference** | **Scale - 1** | + +================+=======================+=================+ + | ``uvV`` | [0, 1] | [0, 1] | + +----------------+-----------------------+-----------------+ + + Examples + -------- + >>> import numpy as np + >>> XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) + >>> XYZ_to_CIE1960UCS(XYZ) # doctest: +ELLIPSIS + array([ 0.3772021..., 0.3341350..., 0.12197225]) + """ + + UVW = XYZ_to_UCS(XYZ) + + _U, V, _W = tsplit(UVW) + + u, v = tsplit(UCS_to_uv(UVW)) + + return tstack([u, v, V]) + + +def CIE1960UCS_to_XYZ( + uvV: ArrayLike, +) -> NDArrayFloat: + """ + Convert from *CIE XYZ* tristimulus values to :math:`uvV` colourspace. + + This colourspace combines the *CIE 1960 UCS* :math:`UVW` colourspace *uv* + chromaticity coordinates with the *luminance* :math:`V` from the + *CIE 1960 UCS* :math:`UVW` colourspace. + + It is a convenient definition for use with the + *CIE 1960 UCS Chromaticity Diagram*. + + Parameters + ---------- + uvV + :math:`uvV` colourspace array. + + Returns + ------- + :class:`numpy.ndarray` + :math:`uvV` colourspace array. + + Notes + ----- + +----------------+-----------------------+-----------------+ + | **Domain** | **Scale - Reference** | **Scale - 1** | + +================+=======================+=================+ + | ``uvV`` | [0, 1] | [0, 1] | + +----------------+-----------------------+-----------------+ + | ``illuminant`` | [0, 1] | [0, 1] | + +----------------+-----------------------+-----------------+ + + +----------------+-----------------------+-----------------+ + | **Range** | **Scale - Reference** | **Scale - 1** | + +================+=======================+=================+ + | ``XYZ`` | [0, 1] | [0, 1] | + +----------------+-----------------------+-----------------+ + + Examples + -------- + >>> import numpy as np + >>> uvV = np.array([0.37720213, 0.33413509, 0.12197225]) + >>> CIE1960UCS_to_XYZ(uvV) # doctest: +ELLIPSIS + array([ 0.2065400..., 0.1219722..., 0.0513695...]) + """ + + u, v, V = tsplit(uvV) + + U, _V, W = tsplit(uv_to_UCS(tstack([u, v]), V)) + + return UCS_to_XYZ(tstack([U, V, W])) diff --git a/colour/models/cie_uvw.py b/colour/models/cie_uvw.py index f0fc79d89c..2564b5b85e 100644 --- a/colour/models/cie_uvw.py +++ b/colour/models/cie_uvw.py @@ -2,7 +2,7 @@ CIE 1964 U*V*W* Colourspace =========================== -Defines the *CIE 1964 U\\*V\\*W\\** colourspace transformations: +Define the *CIE 1964 U\\*V\\*W\\** colourspace transformations: - :func:`colour.XYZ_to_UVW` - :func:`colour.UVW_to_XYZ` @@ -43,9 +43,9 @@ def XYZ_to_UVW( XYZ: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], ) -> NDArrayFloat: """ Convert from *CIE XYZ* tristimulus values to *CIE 1964 U\\*V\\*W\\** @@ -115,9 +115,9 @@ def XYZ_to_UVW( def UVW_to_XYZ( UVW: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], ) -> NDArrayFloat: """ Convert *CIE 1964 U\\*V\\*W\\** colourspace to *CIE XYZ* tristimulus diff --git a/colour/models/cie_xyy.py b/colour/models/cie_xyy.py index a662488db7..b6c7b7d74d 100644 --- a/colour/models/cie_xyy.py +++ b/colour/models/cie_xyy.py @@ -2,7 +2,7 @@ Tristimulus Values, CIE xyY Colourspace and Chromaticity Coordinates ==================================================================== -Defines the *CIE xyY* colourspace transformations: +Define the *CIE xyY* colourspace transformations: - :func:`colour.XYZ_to_xyY` - :func:`colour.xyY_to_XYZ` @@ -24,17 +24,9 @@ import numpy as np +from colour.algebra import sdiv, sdiv_mode from colour.hints import ArrayLike, NDArrayFloat -from colour.utilities import ( - as_float_array, - as_float_scalar, - from_range_1, - full, - to_domain_1, - tsplit, - tstack, - zeros, -) +from colour.utilities import as_float_array, from_range_1, to_domain_1, tsplit, tstack __author__ = "Colour Developers" __copyright__ = "Copyright 2013 Colour Developers" @@ -96,21 +88,13 @@ def XYZ_to_xyY(XYZ: ArrayLike) -> NDArrayFloat: X, Y, Z = tsplit(XYZ) - xyY = zeros(XYZ.shape) - xyY[..., 0:2] = 0 + X_Y_Z = X + Y + Z - m_xyY = ~np.all(XYZ == 0, axis=-1) - X_Y_Z = (X + Y + Z)[m_xyY] + with sdiv_mode(): + x = sdiv(X, X_Y_Z) + y = sdiv(Y, X_Y_Z) - xyY[m_xyY] = ( - tstack( - [ - X[m_xyY] / X_Y_Z, - Y[m_xyY] / X_Y_Z, - from_range_1(Y[m_xyY]), - ] - ), - ) + xyY = tstack([x, y, from_range_1(Y)]) return xyY @@ -159,14 +143,10 @@ def xyY_to_XYZ(xyY: ArrayLike) -> NDArrayFloat: x, y, Y = tsplit(xyY) Y = to_domain_1(Y) - XYZ = zeros(xyY.shape) - m_XYZ = ~(y == 0) + with sdiv_mode(): + Y_y = sdiv(Y, y) - Y_y = Y[m_XYZ] / y[m_XYZ] - - XYZ[m_XYZ] = tstack( - [x[m_XYZ] * Y_y, Y[m_XYZ], (1 - x[m_XYZ] - y[m_XYZ]) * Y_y] - ) + XYZ = tstack([x * Y_y, Y, (1 - x - y) * Y_y]) return from_range_1(XYZ) @@ -223,7 +203,7 @@ def xyY_to_xy(xyY: ArrayLike) -> NDArrayFloat: return xy -def xy_to_xyY(xy: ArrayLike, Y: float = 1) -> NDArrayFloat: +def xy_to_xyY(xy: ArrayLike, Y: NDArrayFloat = np.array(1)) -> NDArrayFloat: """ Convert from *CIE xy* chromaticity coordinates to *CIE xyY* colourspace by extending the array last dimension with given :math:`Y` *luminance*. @@ -282,7 +262,7 @@ def xy_to_xyY(xy: ArrayLike, Y: float = 1) -> NDArrayFloat: """ xy = as_float_array(xy) - Y = as_float_scalar(to_domain_1(Y)) + Y = as_float_array(to_domain_1(Y)) # Assuming ``xy`` is actually a *CIE xyY* colourspace array argument and # returning it directly. @@ -291,7 +271,7 @@ def xy_to_xyY(xy: ArrayLike, Y: float = 1) -> NDArrayFloat: x, y = tsplit(xy) - xyY = tstack([x, y, full(x.shape, Y)]) + xyY = tstack([x, y, np.resize(Y, x.shape)]) return from_range_1(xyY, np.array([1, 1, 100])) diff --git a/colour/models/common.py b/colour/models/common.py index 485bf1d84b..f8df513587 100644 --- a/colour/models/common.py +++ b/colour/models/common.py @@ -2,7 +2,7 @@ Common Colour Models Utilities ============================== -Defines various colour models common utilities: +Define various colour models common utilities: - :attr:`colour.COLOURSPACE_MODELS` - :func:`colour.models.Jab_to_JCh` @@ -21,7 +21,7 @@ import numpy as np -from colour.algebra import cartesian_to_polar, polar_to_cartesian, vector_dot +from colour.algebra import cartesian_to_polar, polar_to_cartesian, vecmul from colour.hints import ArrayLike, Callable, NDArrayFloat from colour.utilities import ( CanonicalMapping, @@ -63,6 +63,9 @@ "CAM16LCD", "CAM16SCD", "CAM16UCS", + "CIE 1931", + "CIE 1960 UCS", + "CIE 1976 UCS", "CIE Lab", "CIE Luv", "CIE UCS", @@ -106,6 +109,9 @@ "CAM16LCD": ("$J^'$", "$a^'$", "$b^'$"), "CAM16SCD": ("$J^'$", "$a^'$", "$b^'$"), "CAM16UCS": ("$J^'$", "$a^'$", "$b^'$"), + "CIE 1931": ("x", "y", "Y"), + "CIE 1960 UCS": ("$u^'$", "$v^'$", "$L^*$"), + "CIE 1976 UCS": ("$u^'$", "$v^'$", "$L^*$"), "CIE Lab": ("$L^*$", "$a^*$", "$b^*$"), "CIE Luv": ("$L^*$", "$u^'$", "$v^'$"), "CIE UCS": ("U", "V", "W"), @@ -139,44 +145,47 @@ attest(tuple(COLOURSPACE_MODELS_AXIS_LABELS.keys()) == COLOURSPACE_MODELS) -COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE: ( - CanonicalMapping -) = CanonicalMapping( - { - "CAM02LCD": np.array([100, 100, 100]), - "CAM02SCD": np.array([100, 100, 100]), - "CAM02UCS": np.array([100, 100, 100]), - "CAM16LCD": np.array([100, 100, 100]), - "CAM16SCD": np.array([100, 100, 100]), - "CAM16UCS": np.array([100, 100, 100]), - "CIE Lab": np.array([100, 100, 100]), - "CIE Luv": np.array([100, 100, 100]), - "CIE UCS": np.array([1, 1, 1]), - "CIE UVW": np.array([100, 100, 100]), - "CIE XYZ": np.array([1, 1, 1]), - "CIE xyY": np.array([1, 1, 1]), - "DIN99": np.array([100, 100, 100]), - "HCL": np.array([1, 1, 1]), - "HSL": np.array([1, 1, 1]), - "HSV": np.array([1, 1, 1]), - "Hunter Lab": np.array([100, 100, 100]), - "Hunter Rdab": np.array([100, 100, 100]), - "ICaCb": np.array([1, 1, 1]), - "ICtCp": np.array([1, 1, 1]), - "IHLS": np.array([1, 1, 1]), - "IPT Ragoo 2021": np.array([1, 1, 1]), - "IPT": np.array([1, 1, 1]), - "IgPgTg": np.array([1, 1, 1]), - "Jzazbz": np.array([1, 1, 1]), - "OSA UCS": np.array([100, 100, 100]), - "Oklab": np.array([1, 1, 1]), - "RGB": np.array([1, 1, 1]), - "YCbCr": np.array([1, 1, 1]), - "YCoCg": np.array([1, 1, 1]), - "Yrg": np.array([1, 1, 1]), - "hdr-CIELAB": np.array([100, 100, 100]), - "hdr-IPT": np.array([100, 100, 100]), - } +COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE: CanonicalMapping = ( + CanonicalMapping( + { + "CAM02LCD": np.array([100, 100, 100]), + "CAM02SCD": np.array([100, 100, 100]), + "CAM02UCS": np.array([100, 100, 100]), + "CAM16LCD": np.array([100, 100, 100]), + "CAM16SCD": np.array([100, 100, 100]), + "CAM16UCS": np.array([100, 100, 100]), + "CIE 1931": np.array([1, 1, 1]), + "CIE 1960 UCS": np.array([1, 1, 100]), + "CIE 1976 UCS": np.array([1, 1, 100]), + "CIE Lab": np.array([100, 100, 100]), + "CIE Luv": np.array([100, 100, 100]), + "CIE UCS": np.array([1, 1, 1]), + "CIE UVW": np.array([100, 100, 100]), + "CIE XYZ": np.array([1, 1, 1]), + "CIE xyY": np.array([1, 1, 1]), + "DIN99": np.array([100, 100, 100]), + "HCL": np.array([1, 1, 1]), + "HSL": np.array([1, 1, 1]), + "HSV": np.array([1, 1, 1]), + "Hunter Lab": np.array([100, 100, 100]), + "Hunter Rdab": np.array([100, 100, 100]), + "ICaCb": np.array([1, 1, 1]), + "ICtCp": np.array([1, 1, 1]), + "IHLS": np.array([1, 1, 1]), + "IPT Ragoo 2021": np.array([1, 1, 1]), + "IPT": np.array([1, 1, 1]), + "IgPgTg": np.array([1, 1, 1]), + "Jzazbz": np.array([1, 1, 1]), + "OSA UCS": np.array([100, 100, 100]), + "Oklab": np.array([1, 1, 1]), + "RGB": np.array([1, 1, 1]), + "YCbCr": np.array([1, 1, 1]), + "YCoCg": np.array([1, 1, 1]), + "Yrg": np.array([1, 1, 1]), + "hdr-CIELAB": np.array([100, 100, 100]), + "hdr-IPT": np.array([100, 100, 100]), + } + ) ) """Colourspace models domain-range scale **'1'** to **'Reference'** mapping.""" @@ -299,9 +308,7 @@ def JCh_to_Jab(JCh: ArrayLike) -> NDArrayFloat: L, C, H = tsplit(JCh) - a, b = tsplit( - polar_to_cartesian(tstack([C, np.radians(to_domain_degrees(H))])) - ) + a, b = tsplit(polar_to_cartesian(tstack([C, np.radians(to_domain_degrees(H))]))) Jab = tstack([L, a, b]) @@ -322,8 +329,8 @@ def XYZ_to_Iab( values to *IPT* colourspace and for other similar conversions. It implements a generic transformation from *CIE XYZ* tristimulus values to *Lightness* :math:`I`, :math:`a` and :math:`b` representing - red-green dimension, i.e. the dimension lost by protanopes and - the yellow-blue dimension, i.e. the dimension lost by tritanopes, + red-green dimension, i.e., the dimension lost by protanopes and + the yellow-blue dimension, i.e., the dimension lost by tritanopes, respectively. Parameters @@ -388,9 +395,9 @@ def XYZ_to_Iab( XYZ = to_domain_1(XYZ) - LMS = vector_dot(matrix_XYZ_to_LMS, XYZ) + LMS = vecmul(matrix_XYZ_to_LMS, XYZ) LMS_p = LMS_to_LMS_p_callable(LMS) - Iab = vector_dot(matrix_LMS_p_to_Iab, LMS_p) + Iab = vecmul(matrix_LMS_p_to_Iab, LMS_p) return from_range_1(Iab) @@ -408,8 +415,8 @@ def Iab_to_XYZ( This definition is used to perform conversion from *IPT* colourspace to *CIE XYZ* tristimulus values and for other similar conversions. It implements a generic transformation from *Lightness* :math:`I`, :math:`a` - and :math:`b` representing red-green dimension, i.e. the dimension lost by - protanopes and the yellow-blue dimension, i.e. the dimension lost by + and :math:`b` representing red-green dimension, i.e., the dimension lost by + protanopes and the yellow-blue dimension, i.e., the dimension lost by tritanopes, respectively to *CIE XYZ* tristimulus values. Parameters @@ -478,8 +485,8 @@ def Iab_to_XYZ( Iab = to_domain_1(Iab) - LMS = vector_dot(matrix_Iab_to_LMS_p, Iab) + LMS = vecmul(matrix_Iab_to_LMS_p, Iab) LMS_p = LMS_p_to_LMS_callable(LMS) - XYZ = vector_dot(matrix_LMS_to_XYZ, LMS_p) + XYZ = vecmul(matrix_LMS_to_XYZ, LMS_p) return from_range_1(XYZ) diff --git a/colour/models/datasets/macadam_ellipses.py b/colour/models/datasets/macadam_ellipses.py index c298d468c9..c94af6ad04 100644 --- a/colour/models/datasets/macadam_ellipses.py +++ b/colour/models/datasets/macadam_ellipses.py @@ -2,7 +2,7 @@ MacAdam (1942) Ellipses (Observer PGN) ====================================== -Defines the *MacAdam (1942) Ellipses (Observer PGN)* ellipses data. +Define the *MacAdam (1942) Ellipses (Observer PGN)* ellipses data. References ---------- diff --git a/colour/models/datasets/pointer_gamut.py b/colour/models/datasets/pointer_gamut.py index e50ca69b45..da6bed7af4 100644 --- a/colour/models/datasets/pointer_gamut.py +++ b/colour/models/datasets/pointer_gamut.py @@ -2,7 +2,7 @@ Pointer's Gamut =============== -Defines the *Pointer's Gamut* data. +Define the *Pointer's Gamut* data. References ---------- @@ -34,7 +34,7 @@ "CIE 1931 2 Degree Standard Observer" ]["SC"] """ -*Pointer's Gamut* illuminant, i.e. *SC*. +*Pointer's Gamut* illuminant, i.e., *SC*. References ---------- diff --git a/colour/models/din99.py b/colour/models/din99.py index f65efb2fbd..bd2315af2b 100644 --- a/colour/models/din99.py +++ b/colour/models/din99.py @@ -2,7 +2,7 @@ DIN99 Colourspace and DIN99b, DIN99c, DIN99d Refined Formulas ============================================================= -Defines the *DIN99* colourspace and *DIN99b*, *DIN99c*, *DIN99d* refined +Define the *DIN99* colourspace and *DIN99b*, *DIN99c*, *DIN99d* refined formulas transformations: - :func:`colour.Lab_to_DIN99` @@ -58,16 +58,14 @@ "ASTMD2244-07": np.array( [105.509, 0.0158, 16.0, 0.7, 1, 9 / 200, 0.0, 9 / 200] ), - "DIN99": np.array( - [105.509, 0.0158, 16.0, 0.7, 1, 9 / 200, 0.0, 9 / 200] - ), + "DIN99": np.array([105.509, 0.0158, 16.0, 0.7, 1, 9 / 200, 0.0, 9 / 200]), "DIN99b": np.array([303.67, 0.0039, 26.0, 0.83, 23.0, 0.075, 26.0, 1]), "DIN99c": np.array([317.65, 0.0037, 0.0, 0.94, 23.0, 0.066, 0.0, 1]), "DIN99d": np.array([325.22, 0.0036, 50.0, 1.14, 22.5, 0.06, 50.0, 1]), } ) """ -*DIN99* colourspace methods, i.e. the coefficients for the *DIN99b*, *DIN99c*, +*DIN99* colourspace methods, i.e., the coefficients for the *DIN99b*, *DIN99c*, and *DIN99d* refined formulas according to *Cui et al. (2002)*. References @@ -80,8 +78,9 @@ def Lab_to_DIN99( Lab: ArrayLike, k_E: float = 1, k_CH: float = 1, - method: Literal["ASTMD2244-07", "DIN99", "DIN99b", "DIN99c", "DIN99d"] - | str = "DIN99", + method: ( + Literal["ASTMD2244-07", "DIN99", "DIN99b", "DIN99c", "DIN99d"] | str + ) = "DIN99", ) -> NDArrayFloat: """ Convert from *CIE L\\*a\\*b\\** colourspace to *DIN99* colourspace or @@ -171,8 +170,9 @@ def DIN99_to_Lab( Lab_99: ArrayLike, k_E: float = 1, k_CH: float = 1, - method: Literal["ASTMD2244-07", "DIN99", "DIN99b", "DIN99c", "DIN99d"] - | str = "DIN99", + method: ( + Literal["ASTMD2244-07", "DIN99", "DIN99b", "DIN99c", "DIN99d"] | str + ) = "DIN99", ) -> NDArrayFloat: """ Convert from *DIN99* colourspace or one of the *DIN99b*, *DIN99c*, @@ -260,13 +260,14 @@ def DIN99_to_Lab( def XYZ_to_DIN99( XYZ: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], k_E: float = 1, k_CH: float = 1, - method: Literal["ASTMD2244-07", "DIN99", "DIN99b", "DIN99c", "DIN99d"] - | str = "DIN99", + method: ( + Literal["ASTMD2244-07", "DIN99", "DIN99b", "DIN99c", "DIN99d"] | str + ) = "DIN99", ) -> NDArrayFloat: """ Convert from *CIE XYZ* tristimulus values to *DIN99* colourspace or @@ -334,13 +335,14 @@ def XYZ_to_DIN99( def DIN99_to_XYZ( Lab_99: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], k_E: float = 1, k_CH: float = 1, - method: Literal["ASTMD2244-07", "DIN99", "DIN99b", "DIN99c", "DIN99d"] - | str = "DIN99", + method: ( + Literal["ASTMD2244-07", "DIN99", "DIN99b", "DIN99c", "DIN99d"] | str + ) = "DIN99", ) -> NDArrayFloat: """ Convert from *DIN99* colourspace or one of the *DIN99b*, *DIN99c*, diff --git a/colour/models/hdr_cie_lab.py b/colour/models/hdr_cie_lab.py index e08e7155e5..86a876fbb0 100644 --- a/colour/models/hdr_cie_lab.py +++ b/colour/models/hdr_cie_lab.py @@ -2,7 +2,7 @@ Hdr-CIELAB Colourspace ====================== -Defines the *hdr-CIELAB* colourspace transformations: +Define the *hdr-CIELAB* colourspace transformations: - :attr:`colour.HDR_CIELAB_METHODS`: Supported *hdr-CIELAB* colourspace computation methods. @@ -79,8 +79,7 @@ def exponent_hdr_CIELab( Y_s: ArrayLike, Y_abs: ArrayLike, - method: Literal["Fairchild 2011", "Fairchild 2010"] - | str = "Fairchild 2011", + method: (Literal["Fairchild 2011", "Fairchild 2010"] | str) = "Fairchild 2011", ) -> NDArrayFloat: """ Compute *hdr-CIELAB* colourspace *Lightness* :math:`\\epsilon` exponent @@ -136,13 +135,12 @@ def exponent_hdr_CIELab( def XYZ_to_hdr_CIELab( XYZ: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], Y_s: ArrayLike = 0.2, Y_abs: ArrayLike = 100, - method: Literal["Fairchild 2011", "Fairchild 2010"] - | str = "Fairchild 2011", + method: (Literal["Fairchild 2011", "Fairchild 2010"] | str) = "Fairchild 2011", ) -> NDArrayFloat: """ Convert from *CIE XYZ* tristimulus values to *hdr-CIELAB* colourspace. @@ -235,13 +233,12 @@ def XYZ_to_hdr_CIELab( def hdr_CIELab_to_XYZ( Lab_hdr: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], Y_s: ArrayLike = 0.2, Y_abs: ArrayLike = 100, - method: Literal["Fairchild 2011", "Fairchild 2010"] - | str = "Fairchild 2011", + method: (Literal["Fairchild 2011", "Fairchild 2010"] | str) = "Fairchild 2011", ) -> NDArrayFloat: """ Convert from *hdr-CIELAB* colourspace to *CIE XYZ* tristimulus values. diff --git a/colour/models/hdr_ipt.py b/colour/models/hdr_ipt.py index 982d73234f..f186b3ffef 100644 --- a/colour/models/hdr_ipt.py +++ b/colour/models/hdr_ipt.py @@ -2,7 +2,7 @@ Hdr-IPT Colourspace =================== -Defines the *hdr-IPT* colourspace transformations: +Define the *hdr-IPT* colourspace transformations: - :attr:`colour.HDR_IPT_METHODS`: Supported *hdr-IPT* colourspace computation methods. @@ -25,7 +25,7 @@ import numpy as np -from colour.algebra import vector_dot +from colour.algebra import vecmul from colour.colorimetry import ( lightness_Fairchild2010, lightness_Fairchild2011, @@ -82,8 +82,7 @@ def exponent_hdr_IPT( Y_s: ArrayLike, Y_abs: ArrayLike, - method: Literal["Fairchild 2011", "Fairchild 2010"] - | str = "Fairchild 2011", + method: (Literal["Fairchild 2011", "Fairchild 2010"] | str) = "Fairchild 2011", ) -> NDArrayFloat: """ Compute *hdr-IPT* colourspace *Lightness* :math:`\\epsilon` exponent using @@ -141,8 +140,7 @@ def XYZ_to_hdr_IPT( XYZ: ArrayLike, Y_s: ArrayLike = 0.2, Y_abs: ArrayLike = 100, - method: Literal["Fairchild 2011", "Fairchild 2010"] - | str = "Fairchild 2011", + method: (Literal["Fairchild 2011", "Fairchild 2010"] | str) = "Fairchild 2011", ) -> NDArrayFloat: """ Convert from *CIE XYZ* tristimulus values to *hdr-IPT* colourspace. @@ -210,13 +208,13 @@ def XYZ_to_hdr_IPT( e = exponent_hdr_IPT(Y_s, Y_abs, method)[..., None] - LMS = vector_dot(MATRIX_IPT_XYZ_TO_LMS, XYZ) + LMS = vecmul(MATRIX_IPT_XYZ_TO_LMS, XYZ) # Domain and range scaling has already been handled. with domain_range_scale("ignore"): LMS_prime = np.sign(LMS) * np.abs(lightness_callable(LMS, e)) - IPT_hdr = vector_dot(MATRIX_IPT_LMS_P_TO_IPT, LMS_prime) + IPT_hdr = vecmul(MATRIX_IPT_LMS_P_TO_IPT, LMS_prime) return from_range_100(IPT_hdr) @@ -225,8 +223,7 @@ def hdr_IPT_to_XYZ( IPT_hdr: ArrayLike, Y_s: ArrayLike = 0.2, Y_abs: ArrayLike = 100, - method: Literal["Fairchild 2011", "Fairchild 2010"] - | str = "Fairchild 2011", + method: (Literal["Fairchild 2011", "Fairchild 2010"] | str) = "Fairchild 2011", ) -> NDArrayFloat: """ Convert from *hdr-IPT* colourspace to *CIE XYZ* tristimulus values. @@ -293,12 +290,12 @@ def hdr_IPT_to_XYZ( e = exponent_hdr_IPT(Y_s, Y_abs, method)[..., None] - LMS = vector_dot(MATRIX_IPT_IPT_TO_LMS_P, IPT_hdr) + LMS = vecmul(MATRIX_IPT_IPT_TO_LMS_P, IPT_hdr) # Domain and range scaling has already be handled. with domain_range_scale("ignore"): LMS_prime = np.sign(LMS) * np.abs(luminance_callable(LMS, e)) - XYZ = vector_dot(MATRIX_IPT_LMS_TO_XYZ, LMS_prime) + XYZ = vecmul(MATRIX_IPT_LMS_TO_XYZ, LMS_prime) return from_range_1(XYZ) diff --git a/colour/models/hunter_lab.py b/colour/models/hunter_lab.py index fe9f17b19f..392584b8a2 100644 --- a/colour/models/hunter_lab.py +++ b/colour/models/hunter_lab.py @@ -2,7 +2,7 @@ Hunter L,a,b Colour Scale ========================= -Defines the *Hunter L,a,b* colour scale transformations: +Define the *Hunter L,a,b* colour scale transformations: - :func:`colour.XYZ_to_K_ab_HunterLab1966` - :func:`colour.XYZ_to_Hunter_Lab` @@ -80,12 +80,12 @@ def XYZ_to_K_ab_HunterLab1966(XYZ: ArrayLike) -> NDArrayFloat: def XYZ_to_Hunter_Lab( XYZ: ArrayLike, - XYZ_n: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"].XYZ_n, - K_ab: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"].K_ab, + XYZ_n: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ + "D65" + ].XYZ_n, + K_ab: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ + "D65" + ].K_ab, ) -> NDArrayFloat: """ Convert from *CIE XYZ* tristimulus values to *Hunter L,a,b* colour scale. @@ -133,9 +133,7 @@ def XYZ_to_Hunter_Lab( Examples -------- >>> XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) * 100 - >>> D65 = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ - ... "D65" - ... ] + >>> D65 = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"]["D65"] >>> XYZ_to_Hunter_Lab(XYZ, D65.XYZ_n, D65.K_ab) # doctest: +ELLIPSIS array([ 34.9245257..., 47.0618985..., 14.3861510...]) """ @@ -143,9 +141,7 @@ def XYZ_to_Hunter_Lab( X, Y, Z = tsplit(to_domain_100(XYZ)) X_n, Y_n, Z_n = tsplit(to_domain_100(XYZ_n)) K_a, K_b = ( - tsplit(XYZ_to_K_ab_HunterLab1966(XYZ_n)) - if K_ab is None - else tsplit(K_ab) + tsplit(XYZ_to_K_ab_HunterLab1966(XYZ_n)) if K_ab is None else tsplit(K_ab) ) Y_Y_n = Y / Y_n @@ -162,12 +158,12 @@ def XYZ_to_Hunter_Lab( def Hunter_Lab_to_XYZ( Lab: ArrayLike, - XYZ_n: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"].XYZ_n, - K_ab: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"].K_ab, + XYZ_n: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ + "D65" + ].XYZ_n, + K_ab: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ + "D65" + ].K_ab, ) -> NDArrayFloat: """ Convert from *Hunter L,a,b* colour scale to *CIE XYZ* tristimulus values. @@ -215,9 +211,7 @@ def Hunter_Lab_to_XYZ( Examples -------- >>> Lab = np.array([34.92452577, 47.06189858, 14.38615107]) - >>> D65 = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ - ... "D65" - ... ] + >>> D65 = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"]["D65"] >>> Hunter_Lab_to_XYZ(Lab, D65.XYZ_n, D65.K_ab) array([ 20.654008, 12.197225, 5.136952]) """ @@ -225,9 +219,7 @@ def Hunter_Lab_to_XYZ( L, a, b = tsplit(to_domain_100(Lab)) X_n, Y_n, Z_n = tsplit(to_domain_100(XYZ_n)) K_a, K_b = ( - tsplit(XYZ_to_K_ab_HunterLab1966(XYZ_n)) - if K_ab is None - else tsplit(K_ab) + tsplit(XYZ_to_K_ab_HunterLab1966(XYZ_n)) if K_ab is None else tsplit(K_ab) ) L_100 = L / 100 diff --git a/colour/models/hunter_rdab.py b/colour/models/hunter_rdab.py index 6904569f26..35f20a01f0 100644 --- a/colour/models/hunter_rdab.py +++ b/colour/models/hunter_rdab.py @@ -2,7 +2,7 @@ Hunter Rd,a,b Colour Scale ========================== -Defines the *Hunter Rd,a,b* colour scale transformations: +Define the *Hunter Rd,a,b* colour scale transformations: - :func:`colour.XYZ_to_Hunter_Rdab` - :func:`colour.Hunter_Rdab_to_XYZ` @@ -37,12 +37,12 @@ def XYZ_to_Hunter_Rdab( XYZ: ArrayLike, - XYZ_n: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"].XYZ_n, - K_ab: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"].K_ab, + XYZ_n: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ + "D65" + ].XYZ_n, + K_ab: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ + "D65" + ].K_ab, ) -> NDArrayFloat: """ Convert from *CIE XYZ* tristimulus values to *Hunter Rd,a,b* colour scale. @@ -91,9 +91,7 @@ def XYZ_to_Hunter_Rdab( -------- >>> import numpy as np >>> XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) * 100 - >>> D65 = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ - ... "D65" - ... ] + >>> D65 = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"]["D65"] >>> XYZ_to_Hunter_Rdab(XYZ, D65.XYZ_n, D65.K_ab) ... # doctest: +ELLIPSIS array([ 12.197225 ..., 57.1253787..., 17.4624134...]) @@ -102,9 +100,7 @@ def XYZ_to_Hunter_Rdab( X, Y, Z = tsplit(to_domain_100(XYZ)) X_n, Y_n, Z_n = tsplit(to_domain_100(XYZ_n)) K_a, K_b = ( - tsplit(XYZ_to_K_ab_HunterLab1966(XYZ_n)) - if K_ab is None - else tsplit(K_ab) + tsplit(XYZ_to_K_ab_HunterLab1966(XYZ_n)) if K_ab is None else tsplit(K_ab) ) f = 0.51 * ((21 + 0.2 * Y) / (1 + 0.2 * Y)) @@ -121,12 +117,12 @@ def XYZ_to_Hunter_Rdab( def Hunter_Rdab_to_XYZ( R_d_ab: ArrayLike, - XYZ_n: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"].XYZ_n, - K_ab: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"].K_ab, + XYZ_n: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ + "D65" + ].XYZ_n, + K_ab: ArrayLike = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ + "D65" + ].K_ab, ) -> NDArrayFloat: """ Convert from *Hunter Rd,a,b* colour scale to *CIE XYZ* tristimulus values. @@ -175,9 +171,7 @@ def Hunter_Rdab_to_XYZ( -------- >>> import numpy as np >>> R_d_ab = np.array([12.19722500, 57.12537874, 17.46241341]) - >>> D65 = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"][ - ... "D65" - ... ] + >>> D65 = TVS_ILLUMINANTS_HUNTERLAB["CIE 1931 2 Degree Standard Observer"]["D65"] >>> Hunter_Rdab_to_XYZ(R_d_ab, D65.XYZ_n, D65.K_ab) array([ 20.654008, 12.197225, 5.136952]) """ @@ -185,9 +179,7 @@ def Hunter_Rdab_to_XYZ( R_d, a_Rd, b_Rd = tsplit(to_domain_100(R_d_ab)) X_n, Y_n, Z_n = tsplit(to_domain_100(XYZ_n)) K_a, K_b = ( - tsplit(XYZ_to_K_ab_HunterLab1966(XYZ_n)) - if K_ab is None - else tsplit(K_ab) + tsplit(XYZ_to_K_ab_HunterLab1966(XYZ_n)) if K_ab is None else tsplit(K_ab) ) f = 0.51 * ((21 + 0.2 * R_d) / (1 + 0.2 * R_d)) diff --git a/colour/models/icacb.py b/colour/models/icacb.py index 39a24aad8f..2fd8819d8b 100644 --- a/colour/models/icacb.py +++ b/colour/models/icacb.py @@ -2,7 +2,7 @@ :math:`IC_AC_B` Colourspace =========================== -Defines the :math:`IC_AC_B` colourspace transformations: +Define the :math:`IC_AC_B` colourspace transformations: - :func:`colour.XYZ_to_ICaCb` - :func:`colour.ICaCb_to_XYZ` @@ -62,9 +62,7 @@ ) """Normalised non-linear cone responses to :math:`IC_AC_B` colourspace matrix.""" -MATRIX_ICACB_LMS_TO_XYZ_2: NDArrayFloat = np.linalg.inv( - MATRIX_ICACB_XYZ_TO_LMS_2 -) +MATRIX_ICACB_LMS_TO_XYZ_2: NDArrayFloat = np.linalg.inv(MATRIX_ICACB_XYZ_TO_LMS_2) """:math:`IC_AC_B` to normalised non-linear cone responses colourspace matrix.""" diff --git a/colour/models/igpgtg.py b/colour/models/igpgtg.py index 4aecb0ca5f..6df496f6de 100644 --- a/colour/models/igpgtg.py +++ b/colour/models/igpgtg.py @@ -2,7 +2,7 @@ :math:`I_GP_GT_G` Colourspace ============================= -Defines the :math:`I_GP_GT_G` colourspace transformations: +Define the :math:`I_GP_GT_G` colourspace transformations: - :func:`colour.XYZ_to_IgPgTg` - :func:`colour.IgPgTg_to_XYZ` @@ -47,9 +47,7 @@ ) """*CIE XYZ* tristimulus values to normalised cone responses matrix.""" -MATRIX_IGPGTG_LMS_TO_XYZ: NDArrayFloat = np.linalg.inv( - MATRIX_IGPGTG_XYZ_TO_LMS -) +MATRIX_IGPGTG_LMS_TO_XYZ: NDArrayFloat = np.linalg.inv(MATRIX_IGPGTG_XYZ_TO_LMS) """Normalised cone responses to *CIE XYZ* tristimulus values matrix.""" MATRIX_IGPGTG_LMS_P_TO_IGPGTG: NDArrayFloat = np.array( diff --git a/colour/models/ipt.py b/colour/models/ipt.py index 9cdaf2653c..18ee651e4c 100644 --- a/colour/models/ipt.py +++ b/colour/models/ipt.py @@ -2,7 +2,7 @@ IPT Colourspace =============== -Defines the *IPT* colourspace transformations: +Define the *IPT* colourspace transformations: - :func:`colour.XYZ_to_IPT` - :func:`colour.IPT_to_XYZ` diff --git a/colour/models/jzazbz.py b/colour/models/jzazbz.py index 0f33fcf3e9..c52e7510ed 100644 --- a/colour/models/jzazbz.py +++ b/colour/models/jzazbz.py @@ -2,7 +2,7 @@ :math:`J_za_zb_z` Colourspace ============================= -Defines the :math:`J_za_zb_z` colourspace: +Define the :math:`J_za_zb_z` colourspace: - :func:`colour.models.IZAZBZ_METHODS` - :func:`colour.models.XYZ_to_Izazbz` @@ -25,7 +25,7 @@ import numpy as np -from colour.algebra import vector_dot +from colour.algebra import vecmul from colour.hints import ArrayLike, Literal, NDArrayFloat from colour.models.rgb.transfer_functions import ( eotf_inverse_ST2084, @@ -80,13 +80,11 @@ Notes ----- -- The :math:`m2` constant, i.e. the power factor has been re-optimized during +- The :math:`m2` constant, i.e., the power factor has been re-optimized during the development of the :math:`J_za_zb_z` colourspace. """ -CONSTANTS_JZAZBZ_SAFDAR2021: Structure = Structure( - **CONSTANTS_JZAZBZ_SAFDAR2017 -) +CONSTANTS_JZAZBZ_SAFDAR2021: Structure = Structure(**CONSTANTS_JZAZBZ_SAFDAR2017) CONSTANTS_JZAZBZ_SAFDAR2021.d_0 = 3.7035226210190005 * 10**-11 """:math:`J_za_zb_z` colourspace constants for the *ZCAM* colour appearance model.""" @@ -102,9 +100,7 @@ matrix. """ -MATRIX_JZAZBZ_LMS_TO_XYZ: NDArrayFloat = np.linalg.inv( - MATRIX_JZAZBZ_XYZ_TO_LMS -) +MATRIX_JZAZBZ_LMS_TO_XYZ: NDArrayFloat = np.linalg.inv(MATRIX_JZAZBZ_XYZ_TO_LMS) """ :math:`J_za_zb_z` normalised cone responses to *CIE XYZ* tristimulus values matrix. @@ -173,8 +169,7 @@ def XYZ_to_Izazbz( XYZ_D65: ArrayLike, constants: Structure | None = None, - method: Literal["Safdar 2017", "Safdar 2021", "ZCAM"] - | str = "Safdar 2017", + method: (Literal["Safdar 2017", "Safdar 2021", "ZCAM"] | str) = "Safdar 2017", ) -> NDArrayFloat: """ Convert from *CIE XYZ* tristimulus values to :math:`I_za_zb_z` @@ -244,9 +239,11 @@ def XYZ_to_Izazbz( constants = optional( constants, - CONSTANTS_JZAZBZ_SAFDAR2017 - if method == "safdar 2017" - else CONSTANTS_JZAZBZ_SAFDAR2021, + ( + CONSTANTS_JZAZBZ_SAFDAR2017 + if method == "safdar 2017" + else CONSTANTS_JZAZBZ_SAFDAR2021 + ), ) X_p_D65 = constants.b * X_D65 - (constants.b - 1) * Z_D65 @@ -254,15 +251,15 @@ def XYZ_to_Izazbz( XYZ_p_D65 = tstack([X_p_D65, Y_p_D65, Z_D65]) - LMS = vector_dot(MATRIX_JZAZBZ_XYZ_TO_LMS, XYZ_p_D65) + LMS = vecmul(MATRIX_JZAZBZ_XYZ_TO_LMS, XYZ_p_D65) with domain_range_scale("ignore"): LMS_p = eotf_inverse_ST2084(LMS, 10000, constants) if method == "safdar 2017": - Izazbz = vector_dot(MATRIX_JZAZBZ_LMS_P_TO_IZAZBZ_SAFDAR2017, LMS_p) + Izazbz = vecmul(MATRIX_JZAZBZ_LMS_P_TO_IZAZBZ_SAFDAR2017, LMS_p) else: - Izazbz = vector_dot(MATRIX_JZAZBZ_LMS_P_TO_IZAZBZ_SAFDAR2021, LMS_p) + Izazbz = vecmul(MATRIX_JZAZBZ_LMS_P_TO_IZAZBZ_SAFDAR2021, LMS_p) Izazbz[..., 0] -= constants.d_0 return Izazbz @@ -271,8 +268,7 @@ def XYZ_to_Izazbz( def Izazbz_to_XYZ( Izazbz: ArrayLike, constants: Structure | None = None, - method: Literal["Safdar 2017", "Safdar 2021", "ZCAM"] - | str = "Safdar 2017", + method: (Literal["Safdar 2017", "Safdar 2021", "ZCAM"] | str) = "Safdar 2017", ) -> NDArrayFloat: """ Convert from :math:`I_za_zb_z` colourspace to *CIE XYZ* tristimulus @@ -340,23 +336,23 @@ def Izazbz_to_XYZ( constants = optional( constants, - CONSTANTS_JZAZBZ_SAFDAR2017 - if method == "safdar 2017" - else CONSTANTS_JZAZBZ_SAFDAR2021, + ( + CONSTANTS_JZAZBZ_SAFDAR2017 + if method == "safdar 2017" + else CONSTANTS_JZAZBZ_SAFDAR2021 + ), ) if method == "safdar 2017": - LMS_p = vector_dot(MATRIX_JZAZBZ_IZAZBZ_TO_LMS_P_SAFDAR2017, Izazbz) + LMS_p = vecmul(MATRIX_JZAZBZ_IZAZBZ_TO_LMS_P_SAFDAR2017, Izazbz) else: Izazbz[..., 0] += constants.d_0 - LMS_p = vector_dot(MATRIX_JZAZBZ_IZAZBZ_TO_LMS_P_SAFDAR2021, Izazbz) + LMS_p = vecmul(MATRIX_JZAZBZ_IZAZBZ_TO_LMS_P_SAFDAR2021, Izazbz) with domain_range_scale("ignore"): LMS = eotf_ST2084(LMS_p, 10000, constants) - X_p_D65, Y_p_D65, Z_p_D65 = tsplit( - vector_dot(MATRIX_JZAZBZ_LMS_TO_XYZ, LMS) - ) + X_p_D65, Y_p_D65, Z_p_D65 = tsplit(vecmul(MATRIX_JZAZBZ_LMS_TO_XYZ, LMS)) X_D65 = (X_p_D65 + (constants.b - 1) * Z_p_D65) / constants.b Y_D65 = (Y_p_D65 + (constants.g - 1) * X_D65) / constants.g diff --git a/colour/models/oklab.py b/colour/models/oklab.py index 085b712272..d56d8563cf 100644 --- a/colour/models/oklab.py +++ b/colour/models/oklab.py @@ -2,7 +2,7 @@ Oklab Colourspace ================= -Defines the *Oklab* colourspace transformations: +Define the *Oklab* colourspace transformations: - :func:`colour.XYZ_to_Oklab` - :func:`colour.Oklab_to_XYZ` diff --git a/colour/models/osa_ucs.py b/colour/models/osa_ucs.py index e174f03c26..c64bf341e9 100644 --- a/colour/models/osa_ucs.py +++ b/colour/models/osa_ucs.py @@ -2,7 +2,7 @@ Optical Society of America Uniform Colour Scales (OSA UCS) ========================================================== -Defines the *OSA UCS* colourspace: +Define the *OSA UCS* colourspace: - :func:`colour.XYZ_to_OSA_UCS` - :func:`colour.OSA_UCS_to_XYZ` @@ -23,7 +23,7 @@ import numpy as np from scipy.optimize import fmin -from colour.algebra import sdiv, sdiv_mode, spow, vector_dot +from colour.algebra import sdiv, sdiv_mode, spow, vecmul from colour.hints import ArrayLike, NDArrayFloat from colour.models import XYZ_to_xyY from colour.utilities import ( @@ -117,12 +117,7 @@ def XYZ_to_OSA_UCS(XYZ: ArrayLike) -> NDArrayFloat: x, y, Y = tsplit(XYZ_to_xyY(XYZ)) Y_0 = Y * ( - 4.4934 * x**2 - + 4.3034 * y**2 - - 4.276 * x * y - - 1.3744 * x - - 2.5643 * y - + 1.8103 + 4.4934 * x**2 + 4.3034 * y**2 - 4.276 * x * y - 1.3744 * x - 2.5643 * y + 1.8103 ) o_3 = 1 / 3 @@ -131,7 +126,7 @@ def XYZ_to_OSA_UCS(XYZ: ArrayLike) -> NDArrayFloat: Y_0_s = Y_0 - 30 Lambda = 5.9 * (Y_0_es + 0.042 * spow(Y_0_s, o_3)) - RGB = vector_dot(MATRIX_XYZ_TO_RGB_OSA_UCS, XYZ) + RGB = vecmul(MATRIX_XYZ_TO_RGB_OSA_UCS, XYZ) RGB_3 = spow(RGB, 1 / 3) with sdiv_mode(): @@ -208,7 +203,7 @@ def OSA_UCS_to_XYZ( Ljg = to_domain_100(Ljg) shape = Ljg.shape - Ljg = np.atleast_1d(Ljg.reshape([-1, 3])) + Ljg = np.atleast_1d(np.reshape(Ljg, (-1, 3))) optimisation_settings = {"disp": False} if optimisation_kwargs is not None: @@ -225,10 +220,7 @@ def error_function(XYZ: NDArrayFloat, Ljg: NDArrayFloat) -> NDArrayFloat: x_0 = np.array([30, 30, 30]) XYZ = as_float_array( - [ - fmin(error_function, x_0, (Ljg_i,), **optimisation_settings) - for Ljg_i in Ljg - ] + [fmin(error_function, x_0, (Ljg_i,), **optimisation_settings) for Ljg_i in Ljg] ) return from_range_100(np.reshape(XYZ, shape)) diff --git a/colour/models/prolab.py b/colour/models/prolab.py index cfeba470da..68a2f41559 100644 --- a/colour/models/prolab.py +++ b/colour/models/prolab.py @@ -2,7 +2,7 @@ ProLab Colourspace ================== -Defines the *ProLab* colourspace transformations: +Define the *ProLab* colourspace transformations: - :func:`colour.XYZ_to_ProLab` - :func:`colour.ProLab_to_XYZ` @@ -86,9 +86,9 @@ def projective_transformation(a: ArrayLike, Q: ArrayLike) -> NDArrayFloat: def XYZ_to_ProLab( XYZ: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], ) -> NDArrayFloat: """ Convert from *CIE XYZ* tristimulus values to *ProLab* colourspace. @@ -145,9 +145,9 @@ def XYZ_to_ProLab( def ProLab_to_XYZ( ProLab: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], ) -> NDArrayFloat: """ Convert from *ProLab* colourspace to *CIE XYZ* tristimulus values. diff --git a/colour/models/ragoo2021.py b/colour/models/ragoo2021.py index 6439e1e388..104367cb18 100644 --- a/colour/models/ragoo2021.py +++ b/colour/models/ragoo2021.py @@ -2,7 +2,7 @@ Ragoo and Farup (2021) Optimised IPT Colourspace ================================================ -Defines the *Ragoo and Farup (2021)* *Optimised IPT* colourspace +Define the *Ragoo and Farup (2021)* *Optimised IPT* colourspace transformations: - :func:`colour.XYZ_to_IPT_Ragoo2021` diff --git a/colour/models/rgb/cmyk.py b/colour/models/rgb/cmyk.py index 01a3eda16c..babf47ef07 100644 --- a/colour/models/rgb/cmyk.py +++ b/colour/models/rgb/cmyk.py @@ -2,7 +2,7 @@ CMYK Colour Transformations =========================== -Defines various Cyan-Magenta-Yellow (Black) (CMY(K)) colour transformations: +Define various Cyan-Magenta-Yellow (Black) (CMY(K)) colour transformations: - :func:`colour.RGB_to_CMY` - :func:`colour.CMY_to_RGB` diff --git a/colour/models/rgb/common.py b/colour/models/rgb/common.py index 6ca47d453b..c92c6fad75 100644 --- a/colour/models/rgb/common.py +++ b/colour/models/rgb/common.py @@ -2,7 +2,7 @@ Common RGB Colour Models Utilities ================================== -Defines various RGB colour models common utilities. +Define various RGB colour models common utilities. """ from __future__ import annotations @@ -30,12 +30,12 @@ def XYZ_to_sRGB( XYZ: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", apply_cctf_encoding: bool = True, ) -> NDArrayFloat: """ @@ -91,12 +91,12 @@ def XYZ_to_sRGB( def sRGB_to_XYZ( RGB: ArrayLike, - illuminant: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", + illuminant: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", apply_cctf_decoding: bool = True, ) -> NDArrayFloat: """ diff --git a/colour/models/rgb/cylindrical.py b/colour/models/rgb/cylindrical.py index 6817745407..b0040508b0 100644 --- a/colour/models/rgb/cylindrical.py +++ b/colour/models/rgb/cylindrical.py @@ -2,7 +2,7 @@ Cylindrical & Spherical Colour Models ===================================== -Defines various cylindrical and spherical colour models: +Define various cylindrical and spherical colour models: - :func:`colour.RGB_to_HSV` - :func:`colour.HSV_to_RGB` @@ -323,9 +323,7 @@ def HSL_to_RGB(HSL: ArrayLike) -> NDArrayFloat: H, S, L = tsplit(to_domain_1(HSL)) - def H_to_RGB( - vi: NDArrayFloat, vj: NDArrayFloat, vH: NDArrayFloat - ) -> NDArrayFloat: + def H_to_RGB(vi: NDArrayFloat, vj: NDArrayFloat, vH: NDArrayFloat) -> NDArrayFloat: """Convert *hue* value to *RGB* colourspace.""" vH = as_float_array(vH) @@ -364,9 +362,7 @@ def H_to_RGB( return from_range_1(RGB) -def RGB_to_HCL( - RGB: ArrayLike, gamma: float = 3, Y_0: float = 100 -) -> NDArrayFloat: +def RGB_to_HCL(RGB: ArrayLike, gamma: float = 3, Y_0: float = 100) -> NDArrayFloat: """ Convert from *RGB* colourspace to *HCL* colourspace according to *Sarifuddin and Missaoui (2005)* method. @@ -458,9 +454,7 @@ def RGB_to_HCL( return from_range_1(HCL) -def HCL_to_RGB( - HCL: ArrayLike, gamma: float = 3, Y_0: float = 100 -) -> NDArrayFloat: +def HCL_to_RGB(HCL: ArrayLike, gamma: float = 3, Y_0: float = 100) -> NDArrayFloat: """ Convert from *HCL* colourspace to *RGB* colourspace according to *Sarifuddin and Missaoui (2005)* method. @@ -534,7 +528,7 @@ def _1_2_3(a: ArrayLike) -> NDArrayFloat: with sdiv_mode(): RGB = np.select( [ - _1_2_3(np.logical_and(0 <= H, r_p60 >= H)), + _1_2_3(np.logical_and(H >= 0, r_p60 >= H)), _1_2_3(np.logical_and(r_p60 < H, r_p120 >= H)), _1_2_3(np.logical_and(r_p120 < H, np.pi >= H)), _1_2_3(np.logical_and(r_n60 <= H, H < 0)), diff --git a/colour/models/rgb/datasets/__init__.py b/colour/models/rgb/datasets/__init__.py index 195c6026e6..61a180e256 100644 --- a/colour/models/rgb/datasets/__init__.py +++ b/colour/models/rgb/datasets/__init__.py @@ -1,6 +1,6 @@ from __future__ import annotations -from colour.utilities import LazyCanonicalMapping, usage_warning +from colour.utilities import LazyCanonicalMapping from .aces import ( RGB_COLOURSPACE_ACES2065_1, RGB_COLOURSPACE_ACESCC, @@ -98,12 +98,8 @@ """ RGB_COLOURSPACES["aces"] = RGB_COLOURSPACES[RGB_COLOURSPACE_ACES2065_1.name] -RGB_COLOURSPACES["adobe1998"] = RGB_COLOURSPACES[ - RGB_COLOURSPACE_ADOBE_RGB1998.name -] -RGB_COLOURSPACES["prophoto"] = RGB_COLOURSPACES[ - RGB_COLOURSPACE_PROPHOTO_RGB.name -] +RGB_COLOURSPACES["adobe1998"] = RGB_COLOURSPACES[RGB_COLOURSPACE_ADOBE_RGB1998.name] +RGB_COLOURSPACES["prophoto"] = RGB_COLOURSPACES[RGB_COLOURSPACE_PROPHOTO_RGB.name] __all__ = [ "RGB_COLOURSPACES", @@ -175,20 +171,3 @@ "RGB_COLOURSPACE_XTREME_RGB", "RGB_COLOURSPACE_F_GAMUT", ] - - -# ----------------------------------------------------------------------------# -# --- API Changes and Deprecation Management ---# -# ----------------------------------------------------------------------------# -# v0.4.2 -def _alexa_wide_gamut(): - usage_warning( - 'The "ALEXA Wide Gamut" RGB colourspace has been renamed to ' - '"ARRI Wide Gamut 3" for consistency with ARRI\'s new naming ' - "convention." - ) - - return RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3 - - -RGB_COLOURSPACES["ALEXA Wide Gamut"] = _alexa_wide_gamut diff --git a/colour/models/rgb/datasets/aces.py b/colour/models/rgb/datasets/aces.py index db52b3487d..c030e5e937 100644 --- a/colour/models/rgb/datasets/aces.py +++ b/colour/models/rgb/datasets/aces.py @@ -2,7 +2,7 @@ Academy Color Encoding System ============================= -Defines the *Academy Color Encoding System* (ACES) related encodings: +Define the *Academy Color Encoding System* (ACES) related encodings: - :attr:`colour.models.RGB_COLOURSPACE_ACES2065_1` - :attr:`colour.models.RGB_COLOURSPACE_ACESCG` @@ -139,9 +139,7 @@ ) """*CIE XYZ* tristimulus values to *ACES Primaries 0* matrix.""" -MATRIX_AP1_TO_XYZ: NDArrayFloat = normalised_primary_matrix( - AP1, CCS_WHITEPOINT_ACES -) +MATRIX_AP1_TO_XYZ: NDArrayFloat = normalised_primary_matrix(AP1, CCS_WHITEPOINT_ACES) """*ACES Primaries 1* to *CIE XYZ* tristimulus values matrix.""" MATRIX_XYZ_TO_AP1: NDArrayFloat = np.linalg.inv(MATRIX_AP1_TO_XYZ) diff --git a/colour/models/rgb/datasets/adobe_rgb_1998.py b/colour/models/rgb/datasets/adobe_rgb_1998.py index 791ecd2944..476148f093 100644 --- a/colour/models/rgb/datasets/adobe_rgb_1998.py +++ b/colour/models/rgb/datasets/adobe_rgb_1998.py @@ -2,7 +2,7 @@ Adobe RGB (1998) Colourspace ============================ -Defines the *Adobe RGB (1998)* *RGB* colourspace: +Define the *Adobe RGB (1998)* *RGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_ADOBE_RGB1998`. diff --git a/colour/models/rgb/datasets/adobe_wide_gamut_rgb.py b/colour/models/rgb/datasets/adobe_wide_gamut_rgb.py index 56fbd819e0..601c6ebda9 100644 --- a/colour/models/rgb/datasets/adobe_wide_gamut_rgb.py +++ b/colour/models/rgb/datasets/adobe_wide_gamut_rgb.py @@ -2,7 +2,7 @@ Adobe Wide Gamut RGB Colourspace ================================ -Defines the *Adobe Wide Gamut RGB* colourspace: +Define the *Adobe Wide Gamut RGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_ADOBE_WIDE_GAMUT_RGB`. diff --git a/colour/models/rgb/datasets/apple_rgb.py b/colour/models/rgb/datasets/apple_rgb.py index 7731d8b18b..f18ee6487e 100644 --- a/colour/models/rgb/datasets/apple_rgb.py +++ b/colour/models/rgb/datasets/apple_rgb.py @@ -2,7 +2,7 @@ Apple RGB Colourspace ===================== -Defines the *Apple RGB* colourspace: +Define the *Apple RGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_APPLE_RGB`. diff --git a/colour/models/rgb/datasets/arri.py b/colour/models/rgb/datasets/arri.py index 13ba9400fe..874604eb45 100644 --- a/colour/models/rgb/datasets/arri.py +++ b/colour/models/rgb/datasets/arri.py @@ -2,7 +2,7 @@ ARRI Colourspaces ================= -Defines the *ARRI* colourspaces: +Define the *ARRI* colourspaces: - :attr:`colour.models.RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3`. - :attr:`colour.models.RGB_COLOURSPACE_ARRI_WIDE_GAMUT_4`. @@ -125,9 +125,9 @@ MATRIX_ARRI_WIDE_GAMUT_4_TO_XYZ: NDArrayFloat = np.array( [ - [0.7048583204, 0.1297602952, 0.1158373115], - [0.2545241764, 0.7814777327, -0.0360019091], - [0.0000000000, 0.0000000000, 1.0890577508], + [0.704858320407232064, 0.129760295170463003, 0.115837311473976537], + [0.254524176404027025, 0.781477732712002049, -0.036001909116029039], + [0.000000000000000000, 0.000000000000000000, 1.089057750759878429], ] ) """*ARRI Wide Gamut 4* colourspace to *CIE XYZ* tristimulus values matrix.""" diff --git a/colour/models/rgb/datasets/best_rgb.py b/colour/models/rgb/datasets/best_rgb.py index f5628cadb6..89e31484ab 100644 --- a/colour/models/rgb/datasets/best_rgb.py +++ b/colour/models/rgb/datasets/best_rgb.py @@ -2,7 +2,7 @@ Best RGB Colourspace ==================== -Defines the *Best RGB* colourspace: +Define the *Best RGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_BEST_RGB`. diff --git a/colour/models/rgb/datasets/beta_rgb.py b/colour/models/rgb/datasets/beta_rgb.py index 32d0f53f64..555742512a 100644 --- a/colour/models/rgb/datasets/beta_rgb.py +++ b/colour/models/rgb/datasets/beta_rgb.py @@ -2,7 +2,7 @@ Beta RGB Colourspace ==================== -Defines the *Beta RGB* colourspace: +Define the *Beta RGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_BETA_RGB`. diff --git a/colour/models/rgb/datasets/blackmagic_design.py b/colour/models/rgb/datasets/blackmagic_design.py index 2e0fdd9712..0e5233477b 100644 --- a/colour/models/rgb/datasets/blackmagic_design.py +++ b/colour/models/rgb/datasets/blackmagic_design.py @@ -2,7 +2,7 @@ Blackmagic Design Colourspaces ============================== -Defines the *Blackmagic Design* *RGB* colourspaces: +Define the *Blackmagic Design* *RGB* colourspaces: - :attr:`colour.models.RGB_COLOURSPACE_BLACKMAGIC_WIDE_GAMUT`. diff --git a/colour/models/rgb/datasets/canon_cinema_gamut.py b/colour/models/rgb/datasets/canon_cinema_gamut.py index 6d827de421..4de1f02059 100644 --- a/colour/models/rgb/datasets/canon_cinema_gamut.py +++ b/colour/models/rgb/datasets/canon_cinema_gamut.py @@ -2,7 +2,7 @@ Canon Cinema Gamut Colourspace ============================== -Defines the *Canon Cinema Gamut* colourspace: +Define the *Canon Cinema Gamut* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_CINEMA_GAMUT`. @@ -51,7 +51,7 @@ ) """*Canon Cinema Gamut* colourspace primaries.""" -WHITEPOINT_NAME_CINEMA_GAMUT: str = "D65" +WHITEPOINT_NAME_CINEMA_GAMUT: str = "D55" """*Canon Cinema Gamut* colourspace whitepoint name.""" CCS_WHITEPOINT_CINEMA_GAMUT: NDArrayFloat = CCS_ILLUMINANTS[ @@ -64,9 +64,7 @@ ) """*Canon Cinema Gamut* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_CINEMA_GAMUT: NDArrayFloat = np.linalg.inv( - MATRIX_CINEMA_GAMUT_TO_XYZ -) +MATRIX_XYZ_TO_CINEMA_GAMUT: NDArrayFloat = np.linalg.inv(MATRIX_CINEMA_GAMUT_TO_XYZ) """*CIE XYZ* tristimulus values to *Canon Cinema Gamut* colourspace matrix.""" RGB_COLOURSPACE_CINEMA_GAMUT: RGB_Colourspace = RGB_Colourspace( diff --git a/colour/models/rgb/datasets/cie_rgb.py b/colour/models/rgb/datasets/cie_rgb.py index 268f28becf..3f61fc91d9 100644 --- a/colour/models/rgb/datasets/cie_rgb.py +++ b/colour/models/rgb/datasets/cie_rgb.py @@ -2,7 +2,7 @@ CIE RGB Colourspace =================== -Defines the *CIE RGB* colourspace: +Define the *CIE RGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_CIE_RGB`. diff --git a/colour/models/rgb/datasets/color_match_rgb.py b/colour/models/rgb/datasets/color_match_rgb.py index e8a3f0b8f9..9ff0f00421 100644 --- a/colour/models/rgb/datasets/color_match_rgb.py +++ b/colour/models/rgb/datasets/color_match_rgb.py @@ -2,7 +2,7 @@ ColorMatch RGB Colourspace ========================== -Defines the *ColorMatch RGB* colourspace: +Define the *ColorMatch RGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_COLOR_MATCH_RGB`. diff --git a/colour/models/rgb/datasets/davinci_wide_gamut.py b/colour/models/rgb/datasets/davinci_wide_gamut.py index 9c9cd00e5b..fdd18b4766 100644 --- a/colour/models/rgb/datasets/davinci_wide_gamut.py +++ b/colour/models/rgb/datasets/davinci_wide_gamut.py @@ -2,7 +2,7 @@ DaVinci Wide Gamut Colourspace ============================== -Defines the *DaVinci Wide Gamut* *RGB* colourspace: +Define the *DaVinci Wide Gamut* *RGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_DAVINCI_WIDE_GAMUT`. diff --git a/colour/models/rgb/datasets/dcdm_xyz.py b/colour/models/rgb/datasets/dcdm_xyz.py index c374de80d1..d1ddb3b0c5 100644 --- a/colour/models/rgb/datasets/dcdm_xyz.py +++ b/colour/models/rgb/datasets/dcdm_xyz.py @@ -2,7 +2,7 @@ Digital Cinema Distribution Master (DCDM) XYZ Colourspace ========================================================= -Defines the *DCDM XYZ* colourspace: +Define the *DCDM XYZ* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_DCDM_XYZ`. diff --git a/colour/models/rgb/datasets/dci_p3.py b/colour/models/rgb/datasets/dci_p3.py index c81c49c6cd..9ae2b7fb86 100644 --- a/colour/models/rgb/datasets/dci_p3.py +++ b/colour/models/rgb/datasets/dci_p3.py @@ -2,7 +2,7 @@ DCI-P3 & DCI-P3+ Colourspaces ============================= -Defines the *DCI-P3* and *DCI-P3+* colourspaces: +Define the *DCI-P3* and *DCI-P3+* colourspaces: - :attr:`colour.models.RGB_COLOURSPACE_DCI_P3`. - :attr:`colour.models.RGB_COLOURSPACE_DCI_P3_P`. diff --git a/colour/models/rgb/datasets/display_p3.py b/colour/models/rgb/datasets/display_p3.py index 6d47a008ce..004a348150 100644 --- a/colour/models/rgb/datasets/display_p3.py +++ b/colour/models/rgb/datasets/display_p3.py @@ -2,7 +2,7 @@ Display P3 Colourspace ====================== -Defines the *Display P3* colourspace: +Define the *Display P3* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_DISPLAY_P3`. @@ -59,9 +59,7 @@ ) """*Display P3* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_DISPLAY_P3: NDArrayFloat = np.linalg.inv( - MATRIX_DISPLAY_P3_TO_XYZ -) +MATRIX_XYZ_TO_DISPLAY_P3: NDArrayFloat = np.linalg.inv(MATRIX_DISPLAY_P3_TO_XYZ) """*CIE XYZ* tristimulus values to *Display P3* colourspace matrix.""" RGB_COLOURSPACE_DISPLAY_P3: RGB_Colourspace = RGB_Colourspace( diff --git a/colour/models/rgb/datasets/dji_d_gamut.py b/colour/models/rgb/datasets/dji_d_gamut.py index 49831695b9..d7b45165d0 100644 --- a/colour/models/rgb/datasets/dji_d_gamut.py +++ b/colour/models/rgb/datasets/dji_d_gamut.py @@ -2,7 +2,7 @@ DJI D-Gamut Colourspace ======================= -Defines the *DJI D-Gamut* colourspace: +Define the *DJI D-Gamut* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_DJI_D_GAMUT`. diff --git a/colour/models/rgb/datasets/don_rgb_4.py b/colour/models/rgb/datasets/don_rgb_4.py index cbefeaffac..25638df6b5 100644 --- a/colour/models/rgb/datasets/don_rgb_4.py +++ b/colour/models/rgb/datasets/don_rgb_4.py @@ -2,7 +2,7 @@ Don RGB 4 Colourspace ===================== -Defines the *Don RGB 4* colourspace: +Define the *Don RGB 4* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_DON_RGB_4`. diff --git a/colour/models/rgb/datasets/ebu_3213_e.py b/colour/models/rgb/datasets/ebu_3213_e.py index e6a3710117..b23fa883a7 100644 --- a/colour/models/rgb/datasets/ebu_3213_e.py +++ b/colour/models/rgb/datasets/ebu_3213_e.py @@ -2,7 +2,7 @@ EBU Tech. 3213-E Colourspace ============================ -Defines the *EBU Tech. 3213-E* colourspace: +Define the *EBU Tech. 3213-E* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_EBU_3213_E`. @@ -60,9 +60,7 @@ ) """*EBU Tech. 3213-E* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_EBU_3213_E_RGB: NDArrayFloat = np.linalg.inv( - MATRIX_EBU_3213_E_RGB_TO_XYZ -) +MATRIX_XYZ_TO_EBU_3213_E_RGB: NDArrayFloat = np.linalg.inv(MATRIX_EBU_3213_E_RGB_TO_XYZ) """*CIE XYZ* tristimulus values to *EBU Tech. 3213-E* colourspace matrix.""" RGB_COLOURSPACE_EBU_3213_E: RGB_Colourspace = RGB_Colourspace( diff --git a/colour/models/rgb/datasets/eci_rgb_v2.py b/colour/models/rgb/datasets/eci_rgb_v2.py index 6303dee61b..9db5d78f99 100644 --- a/colour/models/rgb/datasets/eci_rgb_v2.py +++ b/colour/models/rgb/datasets/eci_rgb_v2.py @@ -2,7 +2,7 @@ ECI RGB v2 Colourspace ====================== -Defines the *ECI RGB v2* colourspace: +Define the *ECI RGB v2* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_ECI_RGB_V2`. @@ -70,15 +70,11 @@ ) """*ECI RGB v2* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_ECI_RGB_V2: NDArrayFloat = np.linalg.inv( - MATRIX_ECI_RGB_V2_TO_XYZ -) +MATRIX_XYZ_TO_ECI_RGB_V2: NDArrayFloat = np.linalg.inv(MATRIX_ECI_RGB_V2_TO_XYZ) """*CIE XYZ* tristimulus values to *ECI RGB v2* colourspace matrix.""" -def _scale_domain_0_100_range_0_1( - a: ArrayLike, callable_: Callable -) -> NDArrayFloat: +def _scale_domain_0_100_range_0_1(a: ArrayLike, callable_: Callable) -> NDArrayFloat: """ Scale the input domain of given *luminance* :math:`Y` or *Lightness* :math:`L^*` array to [0, 100], call the given callable, and diff --git a/colour/models/rgb/datasets/ekta_space_ps5.py b/colour/models/rgb/datasets/ekta_space_ps5.py index a0c3e11de3..c0f6de3ddb 100644 --- a/colour/models/rgb/datasets/ekta_space_ps5.py +++ b/colour/models/rgb/datasets/ekta_space_ps5.py @@ -2,7 +2,7 @@ Ekta Space PS 5 Colourspace =========================== -Defines the *Ekta Space PS 5* colourspace: +Define the *Ekta Space PS 5* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_EKTA_SPACE_PS_5`. diff --git a/colour/models/rgb/datasets/filmlight_e_gamut.py b/colour/models/rgb/datasets/filmlight_e_gamut.py index e316f57da9..70bf0b7a26 100644 --- a/colour/models/rgb/datasets/filmlight_e_gamut.py +++ b/colour/models/rgb/datasets/filmlight_e_gamut.py @@ -2,7 +2,7 @@ FilmLight E-Gamut Colourspace ============================= -Defines the *FilmLight E-Gamut* colourspace: +Define the *FilmLight E-Gamut* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_FILMLIGHT_E_GAMUT`. diff --git a/colour/models/rgb/datasets/fujifilm_f_gamut.py b/colour/models/rgb/datasets/fujifilm_f_gamut.py index 631e40813a..afb2653b1d 100644 --- a/colour/models/rgb/datasets/fujifilm_f_gamut.py +++ b/colour/models/rgb/datasets/fujifilm_f_gamut.py @@ -2,7 +2,7 @@ Fujifilm F-Gamut Colourspace ============================ -Defines the *Fujifilm F-Gamut* colourspace: +Define the *Fujifilm F-Gamut* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_F_GAMUT`. diff --git a/colour/models/rgb/datasets/gopro.py b/colour/models/rgb/datasets/gopro.py index 3aa1cf2849..0009bb16c0 100644 --- a/colour/models/rgb/datasets/gopro.py +++ b/colour/models/rgb/datasets/gopro.py @@ -2,7 +2,7 @@ GoPro Colourspaces ================== -Defines the *GoPro* colourspaces: +Define the *GoPro* colourspaces: - :attr:`colour.models.RGB_COLOURSPACE_PROTUNE_NATIVE`. @@ -75,9 +75,7 @@ ) """*Protune Native* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_PROTUNE_NATIVE: NDArrayFloat = np.linalg.inv( - MATRIX_PROTUNE_NATIVE_TO_XYZ -) +MATRIX_XYZ_TO_PROTUNE_NATIVE: NDArrayFloat = np.linalg.inv(MATRIX_PROTUNE_NATIVE_TO_XYZ) """*CIE XYZ* tristimulus values to *Protune Native* colourspace matrix.""" RGB_COLOURSPACE_PROTUNE_NATIVE: RGB_Colourspace = RGB_Colourspace( diff --git a/colour/models/rgb/datasets/itur_bt_2020.py b/colour/models/rgb/datasets/itur_bt_2020.py index 170aa4fbcc..315e73ceba 100644 --- a/colour/models/rgb/datasets/itur_bt_2020.py +++ b/colour/models/rgb/datasets/itur_bt_2020.py @@ -2,7 +2,7 @@ Recommendation ITU-R BT.2020 Colourspace ======================================== -Defines the *RecommendationITU-R BT.2020* colourspace: +Define the *RecommendationITU-R BT.2020* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_BT2020`. diff --git a/colour/models/rgb/datasets/itur_bt_470.py b/colour/models/rgb/datasets/itur_bt_470.py index 07ace5308a..252c6b62c1 100644 --- a/colour/models/rgb/datasets/itur_bt_470.py +++ b/colour/models/rgb/datasets/itur_bt_470.py @@ -2,7 +2,7 @@ Recommendation ITU-R BT.470 Colourspaces ======================================== -Defines the *Recommendation ITU-R BT.470* colourspaces: +Define the *Recommendation ITU-R BT.470* colourspaces: - :attr:`colour.models.RGB_COLOURSPACE_BT470_525`. - :attr:`colour.models.RGB_COLOURSPACE_BT470_625`. diff --git a/colour/models/rgb/datasets/itur_bt_709.py b/colour/models/rgb/datasets/itur_bt_709.py index 36fbec7f76..8f35650ea8 100644 --- a/colour/models/rgb/datasets/itur_bt_709.py +++ b/colour/models/rgb/datasets/itur_bt_709.py @@ -2,7 +2,7 @@ Recommendation ITU-R BT.709 Colourspace ======================================= -Defines the *Recommendation ITU-R BT.709* colourspace: +Define the *Recommendation ITU-R BT.709* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_BT709`. diff --git a/colour/models/rgb/datasets/itut_h_273.py b/colour/models/rgb/datasets/itut_h_273.py index a8dd4c2fe9..233ecede50 100644 --- a/colour/models/rgb/datasets/itut_h_273.py +++ b/colour/models/rgb/datasets/itut_h_273.py @@ -2,7 +2,7 @@ Recommendation ITU-T H.273 Colour Primaries (and Colourspaces) ============================================================== -Defines the *Recommendation ITU-T H.273* colourspaces that do not belong in +Define the *Recommendation ITU-T H.273* colourspaces that do not belong in another specification or standard, or have been modified for inclusion: - :attr:`colour.models.RGB_COLOURSPACE_H273_GENERIC_FILM`. @@ -169,10 +169,8 @@ - :cite:`InternationalTelecommunicationUnion2021` """ -MATRIX_H273_22_UNSPECIFIED_RGB_TO_XYZ: NDArrayFloat = ( - normalised_primary_matrix( - PRIMARIES_H273_22_UNSPECIFIED, CCS_WHITEPOINT_H273_22_UNSPECIFIED - ) +MATRIX_H273_22_UNSPECIFIED_RGB_TO_XYZ: NDArrayFloat = normalised_primary_matrix( + PRIMARIES_H273_22_UNSPECIFIED, CCS_WHITEPOINT_H273_22_UNSPECIFIED ) """ Row *22* colourspace as given in diff --git a/colour/models/rgb/datasets/max_rgb.py b/colour/models/rgb/datasets/max_rgb.py index bdab619952..5b0206faf4 100644 --- a/colour/models/rgb/datasets/max_rgb.py +++ b/colour/models/rgb/datasets/max_rgb.py @@ -2,7 +2,7 @@ Max RGB Colourspace =================== -Defines the *Max RGB* colourspace: +Define the *Max RGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_MAX_RGB`. diff --git a/colour/models/rgb/datasets/nikon_n_gamut.py b/colour/models/rgb/datasets/nikon_n_gamut.py index b5e0645466..caad92211c 100644 --- a/colour/models/rgb/datasets/nikon_n_gamut.py +++ b/colour/models/rgb/datasets/nikon_n_gamut.py @@ -2,7 +2,7 @@ Nikon N-Gamut Colourspace ========================= -Defines the *Nikon N-Gamut* colourspace: +Define the *Nikon N-Gamut* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_N_GAMUT`. diff --git a/colour/models/rgb/datasets/ntsc.py b/colour/models/rgb/datasets/ntsc.py index 4df7eb700e..ad52d6a7d6 100644 --- a/colour/models/rgb/datasets/ntsc.py +++ b/colour/models/rgb/datasets/ntsc.py @@ -2,7 +2,7 @@ NTSC Colourspaces ================= -Defines the *NTSC* colourspaces: +Define the *NTSC* colourspaces: - :attr:`colour.models.RGB_COLOURSPACE_NTSC1953`. - :attr:`colour.models.RGB_COLOURSPACE_NTSC1987`. diff --git a/colour/models/rgb/datasets/p3_d65.py b/colour/models/rgb/datasets/p3_d65.py index 78d940ba8d..9fedf2e33e 100644 --- a/colour/models/rgb/datasets/p3_d65.py +++ b/colour/models/rgb/datasets/p3_d65.py @@ -2,7 +2,7 @@ P3-D65 Colourspace ================== -Defines the *P3-D65* colourspace: +Define the *P3-D65* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_P3_D65`. """ diff --git a/colour/models/rgb/datasets/pal_secam.py b/colour/models/rgb/datasets/pal_secam.py index 1fb6109b44..575c302aa5 100644 --- a/colour/models/rgb/datasets/pal_secam.py +++ b/colour/models/rgb/datasets/pal_secam.py @@ -2,7 +2,7 @@ Pal/Secam Colourspace ===================== -Defines the *Pal/Secam* colourspace: +Define the *Pal/Secam* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_PAL_SECAM`. diff --git a/colour/models/rgb/datasets/panasonic_v_gamut.py b/colour/models/rgb/datasets/panasonic_v_gamut.py index 642647f1b7..c3c8c53933 100644 --- a/colour/models/rgb/datasets/panasonic_v_gamut.py +++ b/colour/models/rgb/datasets/panasonic_v_gamut.py @@ -2,7 +2,7 @@ Panasonic V-Gamut Colourspace ============================= -Defines the *Panasonic V-Gamut* colourspace: +Define the *Panasonic V-Gamut* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_V_GAMUT`. diff --git a/colour/models/rgb/datasets/plasa_ansi_e154.py b/colour/models/rgb/datasets/plasa_ansi_e154.py index 2cca7a009e..6e6b515545 100644 --- a/colour/models/rgb/datasets/plasa_ansi_e154.py +++ b/colour/models/rgb/datasets/plasa_ansi_e154.py @@ -2,7 +2,7 @@ PLASA ANSI E1.54 Colourspace ============================ -Defines the *PLASA ANSI E1.54* colourspace: +Define the *PLASA ANSI E1.54* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_PLASA_ANSI_E154`. diff --git a/colour/models/rgb/datasets/red.py b/colour/models/rgb/datasets/red.py index d765763915..fa3d427f11 100644 --- a/colour/models/rgb/datasets/red.py +++ b/colour/models/rgb/datasets/red.py @@ -2,7 +2,7 @@ RED Colourspaces ================ -Defines the *RED* colourspaces: +Define the *RED* colourspaces: - :attr:`colour.models.RGB_COLOURSPACE_RED_COLOR` - :attr:`colour.models.RGB_COLOURSPACE_RED_COLOR_2` @@ -155,9 +155,7 @@ ) """*REDcolor2* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_RED_COLOR_2: NDArrayFloat = np.linalg.inv( - MATRIX_RED_COLOR_2_TO_XYZ -) +MATRIX_XYZ_TO_RED_COLOR_2: NDArrayFloat = np.linalg.inv(MATRIX_RED_COLOR_2_TO_XYZ) """*CIE XYZ* tristimulus values to *REDcolor2* colourspace matrix.""" RGB_COLOURSPACE_RED_COLOR_2: RGB_Colourspace = RGB_Colourspace( @@ -198,9 +196,7 @@ ) """*REDcolor3* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_RED_COLOR_3: NDArrayFloat = np.linalg.inv( - MATRIX_RED_COLOR_3_TO_XYZ -) +MATRIX_XYZ_TO_RED_COLOR_3: NDArrayFloat = np.linalg.inv(MATRIX_RED_COLOR_3_TO_XYZ) """*CIE XYZ* tristimulus values to *REDcolor3* colourspace matrix.""" RGB_COLOURSPACE_RED_COLOR_3: RGB_Colourspace = RGB_Colourspace( @@ -241,9 +237,7 @@ ) """*REDcolor4* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_RED_COLOR_4: NDArrayFloat = np.linalg.inv( - MATRIX_RED_COLOR_4_TO_XYZ -) +MATRIX_XYZ_TO_RED_COLOR_4: NDArrayFloat = np.linalg.inv(MATRIX_RED_COLOR_4_TO_XYZ) """*CIE XYZ* tristimulus values to *REDcolor4* colourspace matrix.""" RGB_COLOURSPACE_RED_COLOR_4: RGB_Colourspace = RGB_Colourspace( @@ -284,9 +278,7 @@ ) """*DRAGONcolor* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_DRAGON_COLOR: NDArrayFloat = np.linalg.inv( - MATRIX_DRAGON_COLOR_TO_XYZ -) +MATRIX_XYZ_TO_DRAGON_COLOR: NDArrayFloat = np.linalg.inv(MATRIX_DRAGON_COLOR_TO_XYZ) """*CIE XYZ* tristimulus values to *DRAGONcolor* colourspace matrix.""" RGB_COLOURSPACE_DRAGON_COLOR: RGB_Colourspace = RGB_Colourspace( @@ -327,9 +319,7 @@ ) """*DRAGONcolor2* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_DRAGON_COLOR_2: NDArrayFloat = np.linalg.inv( - MATRIX_DRAGON_COLOR_2_TO_XYZ -) +MATRIX_XYZ_TO_DRAGON_COLOR_2: NDArrayFloat = np.linalg.inv(MATRIX_DRAGON_COLOR_2_TO_XYZ) """*CIE XYZ* tristimulus values to *DRAGONcolor2* colourspace matrix.""" RGB_COLOURSPACE_DRAGON_COLOR_2: RGB_Colourspace = RGB_Colourspace( diff --git a/colour/models/rgb/datasets/rimm_romm_rgb.py b/colour/models/rgb/datasets/rimm_romm_rgb.py index 2e2a41c7f4..0b6f87ac35 100644 --- a/colour/models/rgb/datasets/rimm_romm_rgb.py +++ b/colour/models/rgb/datasets/rimm_romm_rgb.py @@ -2,7 +2,7 @@ RIMM, ROMM and ERIMM Encodings ============================== -Defines the *RIMM, ROMM and ERIMM* encodings: +Define the *RIMM, ROMM and ERIMM* encodings: - :attr:`colour.models.RGB_COLOURSPACE_ROMM_RGB`. - :attr:`colour.models.RGB_COLOURSPACE_RIMM_RGB`. diff --git a/colour/models/rgb/datasets/russell_rgb.py b/colour/models/rgb/datasets/russell_rgb.py index d28647295b..3932e3080f 100644 --- a/colour/models/rgb/datasets/russell_rgb.py +++ b/colour/models/rgb/datasets/russell_rgb.py @@ -2,7 +2,7 @@ Russell RGB Colourspace ======================= -Defines the *Russell RGB* colourspace: +Define the *Russell RGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_RUSSELL_RGB`. @@ -64,9 +64,7 @@ ) """*Russell RGB* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_RUSSELL_RGB: NDArrayFloat = np.linalg.inv( - MATRIX_RUSSELL_RGB_TO_XYZ -) +MATRIX_XYZ_TO_RUSSELL_RGB: NDArrayFloat = np.linalg.inv(MATRIX_RUSSELL_RGB_TO_XYZ) """*CIE XYZ* tristimulus values to *Russell RGB* colourspace matrix.""" RGB_COLOURSPACE_RUSSELL_RGB: RGB_Colourspace = RGB_Colourspace( diff --git a/colour/models/rgb/datasets/sharp.py b/colour/models/rgb/datasets/sharp.py index a7c6a82561..bf1b5ea1da 100644 --- a/colour/models/rgb/datasets/sharp.py +++ b/colour/models/rgb/datasets/sharp.py @@ -2,7 +2,7 @@ Sharp RGB Colourspace ===================== -Defines the *Sharp RGB* colourspace: +Define the *Sharp RGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_SHARP_RGB` diff --git a/colour/models/rgb/datasets/smpte_240m.py b/colour/models/rgb/datasets/smpte_240m.py index 1e8a8476b8..ed48a6ab82 100644 --- a/colour/models/rgb/datasets/smpte_240m.py +++ b/colour/models/rgb/datasets/smpte_240m.py @@ -2,7 +2,7 @@ SMPTE 240M Colourspace ====================== -Defines the *SMPTE 240M* colourspace: +Define the *SMPTE 240M* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_SMPTE_240M`. @@ -66,9 +66,7 @@ ) """*SMPTE 240M* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_SMPTE_240M: NDArrayFloat = np.linalg.inv( - MATRIX_SMPTE_240M_TO_XYZ -) +MATRIX_XYZ_TO_SMPTE_240M: NDArrayFloat = np.linalg.inv(MATRIX_SMPTE_240M_TO_XYZ) """*CIE XYZ* tristimulus values to *SMPTE 240M* colourspace matrix.""" RGB_COLOURSPACE_SMPTE_240M: RGB_Colourspace = RGB_Colourspace( diff --git a/colour/models/rgb/datasets/smpte_c.py b/colour/models/rgb/datasets/smpte_c.py index bcf937e6eb..6a509fecf3 100644 --- a/colour/models/rgb/datasets/smpte_c.py +++ b/colour/models/rgb/datasets/smpte_c.py @@ -2,7 +2,7 @@ SMPTE C Colourspace =================== -Defines the *SMPTE C* colourspace: +Define the *SMPTE C* colourspace: - :attr:`RGB_COLOURSPACE_SMPTE_C`. diff --git a/colour/models/rgb/datasets/sony.py b/colour/models/rgb/datasets/sony.py index 1deb4c4867..18b066c966 100644 --- a/colour/models/rgb/datasets/sony.py +++ b/colour/models/rgb/datasets/sony.py @@ -2,7 +2,7 @@ Sony Colourspaces ================= -Defines the *Sony* colourspaces: +Define the *Sony* colourspaces: - :attr:`colour.models.RGB_COLOURSPACE_S_GAMUT`. - :attr:`colour.models.RGB_COLOURSPACE_S_GAMUT3`. diff --git a/colour/models/rgb/datasets/srgb.py b/colour/models/rgb/datasets/srgb.py index daafc76e84..3b1224bebf 100644 --- a/colour/models/rgb/datasets/srgb.py +++ b/colour/models/rgb/datasets/srgb.py @@ -2,7 +2,7 @@ SRGB Colourspace ================ -Defines the *sRGB* colourspace: +Define the *sRGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_sRGB`. diff --git a/colour/models/rgb/datasets/tests/test__init__.py b/colour/models/rgb/datasets/tests/test__init__.py index cba5304f1d..308132bff6 100644 --- a/colour/models/rgb/datasets/tests/test__init__.py +++ b/colour/models/rgb/datasets/tests/test__init__.py @@ -1,8 +1,6 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.rgb.datasets` module.""" import pickle -import unittest from copy import deepcopy import numpy as np @@ -26,7 +24,7 @@ ] -class TestRGB_COLOURSPACES(unittest.TestCase): +class TestRGB_COLOURSPACES: """ Define :attr:`colour.models.rgb.datasets.RGB_COLOURSPACES` attribute unit tests methods. @@ -51,11 +49,9 @@ def test_transformation_matrices(self): "sRGB": 1e-4, "V-Gamut": 1e-6, } - XYZ_r = np.array([0.5, 0.5, 0.5]).reshape([3, 1]) + XYZ_r = np.reshape(np.array([0.5, 0.5, 0.5]), (3, 1)) for colourspace in RGB_COLOURSPACES.values(): - M = normalised_primary_matrix( - colourspace.primaries, colourspace.whitepoint - ) + M = normalised_primary_matrix(colourspace.primaries, colourspace.whitepoint) tolerance = tolerances.get(colourspace.name, 1e-7) np.testing.assert_allclose( @@ -165,7 +161,3 @@ def test_pickle(self): for colourspace in RGB_COLOURSPACES.values(): pickle.dumps(colourspace) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/datasets/xtreme_rgb.py b/colour/models/rgb/datasets/xtreme_rgb.py index d843d11482..7b1cd4a55a 100644 --- a/colour/models/rgb/datasets/xtreme_rgb.py +++ b/colour/models/rgb/datasets/xtreme_rgb.py @@ -2,7 +2,7 @@ Xtreme RGB Colourspace ====================== -Defines the *Xtreme RGB* colourspace: +Define the *Xtreme RGB* colourspace: - :attr:`colour.models.RGB_COLOURSPACE_XTREME_RGB`. @@ -64,9 +64,7 @@ ) """*Xtreme RGB* colourspace to *CIE XYZ* tristimulus values matrix.""" -MATRIX_XYZ_TO_XTREME_RGB: NDArrayFloat = np.linalg.inv( - MATRIX_XTREME_RGB_TO_XYZ -) +MATRIX_XYZ_TO_XTREME_RGB: NDArrayFloat = np.linalg.inv(MATRIX_XTREME_RGB_TO_XYZ) """*CIE XYZ* tristimulus values to *Xtreme RGB* colourspace matrix.""" RGB_COLOURSPACE_XTREME_RGB: RGB_Colourspace = RGB_Colourspace( diff --git a/colour/models/rgb/derivation.py b/colour/models/rgb/derivation.py index 88760d5849..91289f6bb5 100644 --- a/colour/models/rgb/derivation.py +++ b/colour/models/rgb/derivation.py @@ -2,7 +2,7 @@ RGB Colourspace Derivation ========================== -Defines the objects related to *RGB* colourspace derivation, essentially +Define the objects related to *RGB* colourspace derivation, essentially calculating the normalised primary matrix for given *RGB* colourspace primaries and whitepoint: @@ -134,8 +134,9 @@ def chromatically_adapted_primaries( primaries: ArrayLike, whitepoint_t: ArrayLike, whitepoint_r: ArrayLike, - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str = "CAT02", + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str + ) = "CAT02", ) -> NDArrayFloat: """ Chromatically adapt given *primaries* :math:`xy` chromaticity coordinates @@ -163,9 +164,7 @@ def chromatically_adapted_primaries( >>> w_t = np.array([0.31270, 0.32900]) >>> w_r = np.array([0.34570, 0.35850]) >>> chromatic_adaptation_transform = "Bradford" - >>> chromatically_adapted_primaries( - ... p, w_t, w_r, chromatic_adaptation_transform - ... ) + >>> chromatically_adapted_primaries(p, w_t, w_r, chromatic_adaptation_transform) ... # doctest: +ELLIPSIS array([[ 0.6484414..., 0.3308533...], [ 0.3211951..., 0.5978443...], @@ -292,8 +291,6 @@ def RGB_luminance( 0.1230145... """ - Y = np.sum( - normalised_primary_matrix(primaries, whitepoint)[1] * RGB, axis=-1 - ) + Y = np.sum(normalised_primary_matrix(primaries, whitepoint)[1] * RGB, axis=-1) return as_float(Y) diff --git a/colour/models/rgb/hanbury2003.py b/colour/models/rgb/hanbury2003.py index 91a3d92135..8d53a3774d 100644 --- a/colour/models/rgb/hanbury2003.py +++ b/colour/models/rgb/hanbury2003.py @@ -2,7 +2,7 @@ IHLS Colour Encoding ==================== -Defines the :math:`IHLS` (Improved HLS) colourspace related transformations: +Define the :math:`IHLS` (Improved HLS) colourspace related transformations: - :func:`colour.RGB_to_IHLS` - :func:`colour.IHLS_to_RGB` @@ -19,7 +19,7 @@ import numpy as np -from colour.algebra import sdiv, sdiv_mode, vector_dot +from colour.algebra import sdiv, sdiv_mode, vecmul from colour.hints import ArrayLike, NDArrayFloat from colour.utilities import ( from_range_1, @@ -96,7 +96,7 @@ def RGB_to_IHLS(RGB: ArrayLike) -> NDArrayFloat: RGB = to_domain_1(RGB) R, G, B = tsplit(RGB) - Y, C_1, C_2 = tsplit(vector_dot(MATRIX_RGB_TO_YC_1_C_2, RGB)) + Y, C_1, C_2 = tsplit(vecmul(MATRIX_RGB_TO_YC_1_C_2, RGB)) C = np.hypot(C_1, C_2) @@ -165,6 +165,6 @@ def IHLS_to_RGB(HYS: ArrayLike) -> NDArrayFloat: C_1 = C * np.cos(H) C_2 = -C * np.sin(H) - RGB = vector_dot(MATRIX_YC_1_C_2_TO_RGB, tstack([Y, C_1, C_2])) + RGB = vecmul(MATRIX_YC_1_C_2_TO_RGB, tstack([Y, C_1, C_2])) return from_range_1(RGB) diff --git a/colour/models/rgb/ictcp.py b/colour/models/rgb/ictcp.py index 4fd39de2c7..0c8d26e330 100644 --- a/colour/models/rgb/ictcp.py +++ b/colour/models/rgb/ictcp.py @@ -2,7 +2,7 @@ :math:`IC_TC_P` Colour Encoding =============================== -Defines the :math:`IC_TC_P` colour encoding related transformations: +Define the :math:`IC_TC_P` colour encoding related transformations: - :func:`colour.RGB_to_ICtCp` - :func:`colour.ICtCp_to_RGB` @@ -29,7 +29,7 @@ import numpy as np -from colour.algebra import vector_dot +from colour.algebra import vecmul from colour.colorimetry import CCS_ILLUMINANTS from colour.hints import ( ArrayLike, @@ -103,9 +103,7 @@ :math:`IC_TC_P` colour encoding matrix. """ -MATRIX_ICTCP_ICTCP_TO_LMS_P: NDArrayFloat = np.linalg.inv( - MATRIX_ICTCP_LMS_P_TO_ICTCP -) +MATRIX_ICTCP_ICTCP_TO_LMS_P: NDArrayFloat = np.linalg.inv(MATRIX_ICTCP_LMS_P_TO_ICTCP) """ :math:`IC_TC_P` colour encoding to :math:`LMS_p` *SMPTE ST 2084:2014* encoded normalised cone responses matrix. @@ -137,14 +135,16 @@ def RGB_to_ICtCp( RGB: ArrayLike, - method: Literal[ - "Dolby 2016", - "ITU-R BT.2100-1 HLG", - "ITU-R BT.2100-1 PQ", - "ITU-R BT.2100-2 HLG", - "ITU-R BT.2100-2 PQ", - ] - | str = "Dolby 2016", + method: ( + Literal[ + "Dolby 2016", + "ITU-R BT.2100-1 HLG", + "ITU-R BT.2100-1 PQ", + "ITU-R BT.2100-2 HLG", + "ITU-R BT.2100-2 PQ", + ] + | str + ) = "Dolby 2016", L_p: float = 10000, ) -> NDArrayFloat: """ @@ -251,19 +251,15 @@ def RGB_to_ICtCp( is_hlg_method = "hlg" in method is_BT2100_2_method = "2100-2" in method - LMS = vector_dot(MATRIX_ICTCP_RGB_TO_LMS, RGB) + LMS = vecmul(MATRIX_ICTCP_RGB_TO_LMS, RGB) with domain_range_scale("ignore"): - LMS_p = ( - oetf_BT2100_HLG(LMS) - if is_hlg_method - else eotf_inverse_ST2084(LMS, L_p) - ) + LMS_p = oetf_BT2100_HLG(LMS) if is_hlg_method else eotf_inverse_ST2084(LMS, L_p) ICtCp = ( - vector_dot(MATRIX_ICTCP_LMS_P_TO_ICTCP_BT2100_HLG_2, LMS_p) + vecmul(MATRIX_ICTCP_LMS_P_TO_ICTCP_BT2100_HLG_2, LMS_p) if (is_hlg_method and is_BT2100_2_method) - else vector_dot(MATRIX_ICTCP_LMS_P_TO_ICTCP, LMS_p) + else vecmul(MATRIX_ICTCP_LMS_P_TO_ICTCP, LMS_p) ) return ICtCp @@ -271,14 +267,16 @@ def RGB_to_ICtCp( def ICtCp_to_RGB( ICtCp: ArrayLike, - method: Literal[ - "Dolby 2016", - "ITU-R BT.2100-1 HLG", - "ITU-R BT.2100-1 PQ", - "ITU-R BT.2100-2 HLG", - "ITU-R BT.2100-2 PQ", - ] - | str = "Dolby 2016", + method: ( + Literal[ + "Dolby 2016", + "ITU-R BT.2100-1 HLG", + "ITU-R BT.2100-1 PQ", + "ITU-R BT.2100-2 HLG", + "ITU-R BT.2100-2 PQ", + ] + | str + ) = "Dolby 2016", L_p: float = 10000, ) -> NDArrayFloat: """ @@ -385,19 +383,17 @@ def ICtCp_to_RGB( is_BT2100_2_method = "2100-2" in method LMS_p = ( - vector_dot(MATRIX_ICTCP_ICTCP_TO_LMS_P_BT2100_HLG_2, ICtCp) + vecmul(MATRIX_ICTCP_ICTCP_TO_LMS_P_BT2100_HLG_2, ICtCp) if (is_hlg_method and is_BT2100_2_method) - else vector_dot(MATRIX_ICTCP_ICTCP_TO_LMS_P, ICtCp) + else vecmul(MATRIX_ICTCP_ICTCP_TO_LMS_P, ICtCp) ) with domain_range_scale("ignore"): LMS = ( - oetf_inverse_BT2100_HLG(LMS_p) - if is_hlg_method - else eotf_ST2084(LMS_p, L_p) + oetf_inverse_BT2100_HLG(LMS_p) if is_hlg_method else eotf_ST2084(LMS_p, L_p) ) - RGB = vector_dot(MATRIX_ICTCP_LMS_TO_RGB, LMS) + RGB = vecmul(MATRIX_ICTCP_LMS_TO_RGB, LMS) return RGB @@ -405,17 +401,19 @@ def ICtCp_to_RGB( def XYZ_to_ICtCp( XYZ: ArrayLike, illuminant=CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"], - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", - method: Literal[ - "Dolby 2016", - "ITU-R BT.2100-1 HLG", - "ITU-R BT.2100-1 PQ", - "ITU-R BT.2100-2 HLG", - "ITU-R BT.2100-2 PQ", - ] - | str = "Dolby 2016", + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", + method: ( + Literal[ + "Dolby 2016", + "ITU-R BT.2100-1 HLG", + "ITU-R BT.2100-1 PQ", + "ITU-R BT.2100-2 HLG", + "ITU-R BT.2100-2 PQ", + ] + | str + ) = "Dolby 2016", L_p: float = 10000, ) -> NDArrayFloat: """ @@ -524,17 +522,19 @@ def XYZ_to_ICtCp( def ICtCp_to_XYZ( ICtCp: ArrayLike, illuminant=CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"], - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", - method: Literal[ - "Dolby 2016", - "ITU-R BT.2100-1 HLG", - "ITU-R BT.2100-1 PQ", - "ITU-R BT.2100-2 HLG", - "ITU-R BT.2100-2 PQ", - ] - | str = "Dolby 2016", + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", + method: ( + Literal[ + "Dolby 2016", + "ITU-R BT.2100-1 HLG", + "ITU-R BT.2100-1 PQ", + "ITU-R BT.2100-2 HLG", + "ITU-R BT.2100-2 PQ", + ] + | str + ) = "Dolby 2016", L_p: float = 10000, ) -> NDArrayFloat: """ diff --git a/colour/models/rgb/itut_h_273.py b/colour/models/rgb/itut_h_273.py index 2323783c13..2dfb2d2e0b 100644 --- a/colour/models/rgb/itut_h_273.py +++ b/colour/models/rgb/itut_h_273.py @@ -2,7 +2,7 @@ Recommendation ITU-T H.273 Code points for Video Signal Type Identification =========================================================================== -Defines a set of standard video signal colour primaries, transfer functions and +Define a set of standard video signal colour primaries, transfer functions and matrix coefficients used in deriving luma and chroma signals along with related definitions: @@ -226,7 +226,6 @@ def _reserved(*args: Any): # noqa: ARG001 ... _reserved() ... except RuntimeError: ... pass - ... """ raise RuntimeError("Reserved; For future use by ITU-T | ISO/IEC.") @@ -242,7 +241,6 @@ def _unspecified(*args: Any): # noqa: ARG001 ... _unspecified() ... except RuntimeError: ... pass - ... """ raise RuntimeError( @@ -411,18 +409,14 @@ class FFmpegConstantsColourPrimaries_ITUTH273(IntEnum): 3: _reserved, # For future use by ITU-T | ISO/IEC. # - 4: _clipped_domain_function( - functools.partial(gamma_function, exponent=1 / 2.2) - ), + 4: _clipped_domain_function(functools.partial(gamma_function, exponent=1 / 2.2)), # Assumed display gamma 2.2 Rec. ITU-R BT.470-6 System M (historical) # United States National Television System Committee 1953 Recommendation # for transmission standards for color television United States Federal # Communications Commission (2003) Title 47 Code of Federal Regulations # 73.682 (a) (20) Rec. ITU-R BT.1700-0 625 PAL and 625 SECAM. # - 5: _clipped_domain_function( - functools.partial(gamma_function, exponent=1 / 2.8) - ), + 5: _clipped_domain_function(functools.partial(gamma_function, exponent=1 / 2.8)), # 5: Assumed display gamma 2.8 Rec. ITU-R BT.470-6 System B, G (historical). # 6: _clipped_domain_function(oetf_BT601), @@ -480,9 +474,7 @@ class FFmpegConstantsColourPrimaries_ITUTH273(IntEnum): # } if is_documentation_building(): # pragma: no cover - TRANSFER_CHARACTERISTICS_ITUTH273 = DocstringDict( - TRANSFER_CHARACTERISTICS_ITUTH273 - ) + TRANSFER_CHARACTERISTICS_ITUTH273 = DocstringDict(TRANSFER_CHARACTERISTICS_ITUTH273) TRANSFER_CHARACTERISTICS_ITUTH273.__doc__ = """ *TransferCharacteristics*, as specified in Table 3 of :cite:`InternationalOrganizationforStandardization2021` and @@ -1091,9 +1083,7 @@ def describe_video_signal_transfer_characteristics( Examples -------- - >>> description = describe_video_signal_transfer_characteristics( - ... 1, width=75 - ... ) + >>> description = describe_video_signal_transfer_characteristics(1, width=75) ... # doctest: +ELLIPSIS =========================================================================== * * @@ -1104,9 +1094,7 @@ def describe_video_signal_transfer_characteristics( * FFmpeg Constants : ['AVCOL_TRC_BT709', 'BT709'] * * * =========================================================================== - >>> description = describe_video_signal_transfer_characteristics( - ... 2, width=75 - ... ) + >>> description = describe_video_signal_transfer_characteristics(2, width=75) ... # doctest: +ELLIPSIS =========================================================================== * * @@ -1142,9 +1130,7 @@ class SpecificationTransferCharacteristics: function: Callable ffmpeg_constants: list - members = ( - FFmpegConstantsTransferCharacteristics_ITUTH273.__members__.items() - ) + members = FFmpegConstantsTransferCharacteristics_ITUTH273.__members__.items() ffmpeg_constants = [ name for name, member in members diff --git a/colour/models/rgb/prismatic.py b/colour/models/rgb/prismatic.py index a51d4e147f..68c8e39ff4 100644 --- a/colour/models/rgb/prismatic.py +++ b/colour/models/rgb/prismatic.py @@ -2,7 +2,7 @@ Prismatic Colourspace ===================== -Defines the *Prismatic* colourspace transformations: +Define the *Prismatic* colourspace transformations: - :func:`colour.RGB_to_Prismatic` - :func:`colour.Prismatic_to_RGB` diff --git a/colour/models/rgb/rgb_colourspace.py b/colour/models/rgb/rgb_colourspace.py index d3ae2d936e..88b4f5d72b 100644 --- a/colour/models/rgb/rgb_colourspace.py +++ b/colour/models/rgb/rgb_colourspace.py @@ -2,7 +2,7 @@ RGB Colourspace and Transformations =================================== -Defines the :class:`colour.RGB_Colourspace` class for the *RGB* colourspaces +Define the :class:`colour.RGB_Colourspace` class for the *RGB* colourspaces datasets from :mod:`colour.models.datasets.aces_rgb`, etc... and the following *RGB* colourspace transformations or helper definitions: @@ -30,7 +30,7 @@ import numpy as np from colour.adaptation import matrix_chromatic_adaptation_VonKries -from colour.algebra import matrix_dot, vector_dot +from colour.algebra import vecmul from colour.hints import ( Any, ArrayLike, @@ -51,7 +51,6 @@ domain_range_scale, filter_kwargs, from_range_1, - is_string, multiline_repr, multiline_str, optional, @@ -300,7 +299,7 @@ def name(self, value: str): """Setter for the **self.name** property.""" attest( - is_string(value), + isinstance(value, str), f'"name" property: "{value}" type is not "str"!', ) @@ -401,7 +400,7 @@ def whitepoint_name(self, value: str | None): if value is not None: attest( - is_string(value), + isinstance(value, str), f'"whitepoint_name" property: "{value}" type is not "str"!', ) @@ -426,10 +425,7 @@ def matrix_RGB_to_XYZ(self) -> NDArrayFloat: values. """ - if ( - self._matrix_RGB_to_XYZ is None - or self._use_derived_matrix_RGB_to_XYZ - ): + if self._matrix_RGB_to_XYZ is None or self._use_derived_matrix_RGB_to_XYZ: if self._derived_matrix_RGB_to_XYZ.size == 0: self._derive_transformation_matrices() return self._derived_matrix_RGB_to_XYZ @@ -470,10 +466,7 @@ def matrix_XYZ_to_RGB(self) -> NDArrayFloat: colourspace. """ - if ( - self._matrix_XYZ_to_RGB is None - or self._use_derived_matrix_XYZ_to_RGB - ): + if self._matrix_XYZ_to_RGB is None or self._use_derived_matrix_XYZ_to_RGB: if self._derived_matrix_XYZ_to_RGB.size == 0: self._derive_transformation_matrices() return self._derived_matrix_XYZ_to_RGB @@ -591,8 +584,7 @@ def use_derived_matrix_RGB_to_XYZ(self, value: bool): attest( isinstance(value, (bool, np.bool_)), - f'"use_derived_matrix_RGB_to_XYZ" property: "{value}" is not a ' - f'"bool"!', + f'"use_derived_matrix_RGB_to_XYZ" property: "{value}" is not a "bool"!', ) self._use_derived_matrix_RGB_to_XYZ = value @@ -627,8 +619,7 @@ def use_derived_matrix_XYZ_to_RGB(self, value: bool): attest( isinstance(value, (bool, np.bool_)), - f'"use_derived_matrix_XYZ_to_RGB" property: "{value}" is not a ' - f'"bool"!', + f'"use_derived_matrix_XYZ_to_RGB" property: "{value}" is not a "bool"!', ) self._use_derived_matrix_XYZ_to_RGB = value @@ -742,9 +733,7 @@ def __repr__(self) -> str: Examples -------- >>> from colour.models import linear_function - >>> p = np.array( - ... [0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700] - ... ) + >>> p = np.array([0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700]) >>> whitepoint = np.array([0.32168, 0.33767]) >>> matrix_RGB_to_XYZ = np.identity(3) >>> matrix_XYZ_to_RGB = np.identity(3) @@ -791,9 +780,11 @@ def __repr__(self) -> str: "formatter": lambda x: ( # noqa: ARG005 None if self.cctf_encoding is None - else self.cctf_encoding.__name__ - if hasattr(self.cctf_encoding, "__name__") - else str(self.cctf_encoding) + else ( + self.cctf_encoding.__name__ + if hasattr(self.cctf_encoding, "__name__") + else str(self.cctf_encoding) + ) ), }, { @@ -801,9 +792,11 @@ def __repr__(self) -> str: "formatter": lambda x: ( # noqa: ARG005 None if self.cctf_decoding is None - else self.cctf_decoding.__name__ - if hasattr(self.cctf_decoding, "__name__") - else str(self.cctf_decoding) + else ( + self.cctf_decoding.__name__ + if hasattr(self.cctf_decoding, "__name__") + else str(self.cctf_decoding) + ) ), }, {"name": "use_derived_matrix_RGB_to_XYZ"}, @@ -817,9 +810,6 @@ def _derive_transformation_matrices(self): matrix and its inverse. """ - if not hasattr(self, "_primaries") or not hasattr(self, "_whitepoint"): - return - if self._primaries is not None and self._whitepoint is not None: npm = normalised_primary_matrix(self._primaries, self._whitepoint) @@ -845,8 +835,9 @@ def chromatically_adapt( self, whitepoint: ArrayLike, whitepoint_name: str | None = None, - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str = "CAT02", + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str + ) = "CAT02", ) -> RGB_Colourspace: """ Chromatically adapt the *RGB* colourspace *primaries* :math:`xy` @@ -870,9 +861,7 @@ def chromatically_adapt( Examples -------- - >>> p = np.array( - ... [0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700] - ... ) + >>> p = np.array([0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700]) >>> w_t = np.array([0.32168, 0.33767]) >>> w_r = np.array([0.31270, 0.32900]) >>> colourspace = RGB_Colourspace("RGB Colourspace", p, w_t, "D65") @@ -940,9 +929,9 @@ def XYZ_to_RGB( XYZ: ArrayLike, colourspace: RGB_Colourspace | LiteralRGBColourspace | str, illuminant: ArrayLike | None = None, - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", apply_cctf_encoding: bool = False, *args: Any, **kwargs: Any, @@ -1033,9 +1022,7 @@ def XYZ_to_RGB( else "CAT02" ), ) - cctf_encoding = kwargs.pop( - "cctf_encoding", args[0] if len(args) == 1 else None - ) + cctf_encoding = kwargs.pop("cctf_encoding", args[0] if len(args) == 1 else None) apply_cctf_encoding = True else: if isinstance(colourspace, str): @@ -1047,7 +1034,8 @@ def XYZ_to_RGB( colourspace = RGB_COLOURSPACES[colourspace] illuminant_XYZ = optional( - illuminant, colourspace.whitepoint # pyright: ignore + illuminant, + colourspace.whitepoint, # pyright: ignore ) illuminant_RGB = colourspace.whitepoint # pyright: ignore matrix_XYZ_to_RGB = colourspace.matrix_XYZ_to_RGB # pyright: ignore @@ -1060,9 +1048,9 @@ def XYZ_to_RGB( transform=chromatic_adaptation_transform, ) - XYZ = vector_dot(M_CAT, XYZ) + XYZ = vecmul(M_CAT, XYZ) - RGB = vector_dot(matrix_XYZ_to_RGB, XYZ) + RGB = vecmul(matrix_XYZ_to_RGB, XYZ) if apply_cctf_encoding and cctf_encoding is not None: with domain_range_scale("ignore"): @@ -1075,9 +1063,9 @@ def RGB_to_XYZ( RGB: ArrayLike, colourspace: RGB_Colourspace | LiteralRGBColourspace | str, illuminant: ArrayLike | None = None, - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", apply_cctf_decoding: bool = False, *args, **kwargs, @@ -1168,9 +1156,7 @@ def RGB_to_XYZ( else "CAT02" ), ) - cctf_decoding = kwargs.pop( - "cctf_decoding", args[0] if len(args) == 1 else None - ) + cctf_decoding = kwargs.pop("cctf_decoding", args[0] if len(args) == 1 else None) apply_cctf_decoding = True else: if isinstance(colourspace, str): @@ -1182,7 +1168,8 @@ def RGB_to_XYZ( colourspace = RGB_COLOURSPACES[colourspace] illuminant_XYZ = optional( - illuminant, colourspace.whitepoint # pyright: ignore + illuminant, + colourspace.whitepoint, # pyright: ignore ) illuminant_RGB = colourspace.whitepoint # pyright: ignore matrix_RGB_to_XYZ = colourspace.matrix_RGB_to_XYZ # pyright: ignore @@ -1192,7 +1179,7 @@ def RGB_to_XYZ( with domain_range_scale("ignore"): RGB = cctf_decoding(RGB) - XYZ = vector_dot(matrix_RGB_to_XYZ, RGB) + XYZ = vecmul(matrix_RGB_to_XYZ, RGB) if chromatic_adaptation_transform is not None: M_CAT = matrix_chromatic_adaptation_VonKries( @@ -1201,7 +1188,7 @@ def RGB_to_XYZ( transform=chromatic_adaptation_transform, ) - XYZ = vector_dot(M_CAT, XYZ) + XYZ = vecmul(M_CAT, XYZ) return from_range_1(XYZ) @@ -1209,9 +1196,9 @@ def RGB_to_XYZ( def matrix_RGB_to_RGB( input_colourspace: RGB_Colourspace | LiteralRGBColourspace | str, output_colourspace: RGB_Colourspace | LiteralRGBColourspace | str, - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", ) -> NDArrayFloat: """ Compute the matrix :math:`M` converting from given input *RGB* @@ -1259,9 +1246,7 @@ def matrix_RGB_to_RGB( tuple(RGB_COLOURSPACES), '"{0}" "RGB" colourspace is invalid, it must be one of {1}!', ) - input_colourspace = cast( - RGB_Colourspace, RGB_COLOURSPACES[input_colourspace] - ) + input_colourspace = cast(RGB_Colourspace, RGB_COLOURSPACES[input_colourspace]) if isinstance(output_colourspace, str): output_colourspace = validate_method( @@ -1269,9 +1254,7 @@ def matrix_RGB_to_RGB( tuple(RGB_COLOURSPACES), '"{0}" "RGB" colourspace is invalid, it must be one of {1}!', ) - output_colourspace = cast( - RGB_Colourspace, RGB_COLOURSPACES[output_colourspace] - ) + output_colourspace = cast(RGB_Colourspace, RGB_COLOURSPACES[output_colourspace]) M = input_colourspace.matrix_RGB_to_XYZ @@ -1282,9 +1265,9 @@ def matrix_RGB_to_RGB( chromatic_adaptation_transform, ) - M = matrix_dot(M_CAT, input_colourspace.matrix_RGB_to_XYZ) + M = np.matmul(M_CAT, input_colourspace.matrix_RGB_to_XYZ) - M = matrix_dot(output_colourspace.matrix_XYZ_to_RGB, M) + M = np.matmul(output_colourspace.matrix_XYZ_to_RGB, M) return M @@ -1293,9 +1276,9 @@ def RGB_to_RGB( RGB: ArrayLike, input_colourspace: RGB_Colourspace | LiteralRGBColourspace | str, output_colourspace: RGB_Colourspace | LiteralRGBColourspace | str, - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", apply_cctf_decoding: bool = False, apply_cctf_encoding: bool = False, **kwargs: Any, @@ -1369,9 +1352,7 @@ def RGB_to_RGB( tuple(RGB_COLOURSPACES), '"{0}" "RGB" colourspace is invalid, it must be one of {1}!', ) - input_colourspace = cast( - RGB_Colourspace, RGB_COLOURSPACES[input_colourspace] - ) + input_colourspace = cast(RGB_Colourspace, RGB_COLOURSPACES[input_colourspace]) if isinstance(output_colourspace, str): output_colourspace = validate_method( @@ -1379,9 +1360,7 @@ def RGB_to_RGB( tuple(RGB_COLOURSPACES), '"{0}" "RGB" colourspace is invalid, it must be one of {1}!', ) - output_colourspace = cast( - RGB_Colourspace, RGB_COLOURSPACES[output_colourspace] - ) + output_colourspace = cast(RGB_Colourspace, RGB_COLOURSPACES[output_colourspace]) RGB = to_domain_1(RGB) @@ -1395,7 +1374,7 @@ def RGB_to_RGB( input_colourspace, output_colourspace, chromatic_adaptation_transform ) - RGB = vector_dot(M, RGB) + RGB = vecmul(M, RGB) if apply_cctf_encoding and output_colourspace.cctf_encoding is not None: with domain_range_scale("ignore"): diff --git a/colour/models/rgb/tests/test_cmyk.py b/colour/models/rgb/tests/test_cmyk.py index 61ccdb3d6c..2745f0280a 100644 --- a/colour/models/rgb/tests/test_cmyk.py +++ b/colour/models/rgb/tests/test_cmyk.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.rgb.cmyk` module.""" -import unittest from itertools import product import numpy as np @@ -30,7 +28,7 @@ ] -class TestRGB_to_CMY(unittest.TestCase): +class TestRGB_to_CMY: """ Define :func:`colour.models.rgb.cmyk.RGB_to_CMY` definition unit tests methods. @@ -68,15 +66,11 @@ def test_n_dimensional_RGB_to_CMY(self): RGB = np.tile(RGB, (6, 1)) CMY = np.tile(CMY, (6, 1)) - np.testing.assert_allclose( - RGB_to_CMY(RGB), CMY, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(RGB_to_CMY(RGB), CMY, atol=TOLERANCE_ABSOLUTE_TESTS) RGB = np.reshape(RGB, (2, 3, 3)) CMY = np.reshape(CMY, (2, 3, 3)) - np.testing.assert_allclose( - RGB_to_CMY(RGB), CMY, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(RGB_to_CMY(RGB), CMY, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_RGB_to_CMY(self): """ @@ -108,7 +102,7 @@ def test_nan_RGB_to_CMY(self): RGB_to_CMY(cases) -class TestCMY_to_RGB(unittest.TestCase): +class TestCMY_to_RGB: """ Define :func:`colour.models.rgb.cmyk.CMY_to_RGB` definition unit tests methods. @@ -146,15 +140,11 @@ def test_n_dimensional_CMY_to_RGB(self): CMY = np.tile(CMY, (6, 1)) RGB = np.tile(RGB, (6, 1)) - np.testing.assert_allclose( - CMY_to_RGB(CMY), RGB, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(CMY_to_RGB(CMY), RGB, atol=TOLERANCE_ABSOLUTE_TESTS) CMY = np.reshape(CMY, (2, 3, 3)) RGB = np.reshape(RGB, (2, 3, 3)) - np.testing.assert_allclose( - CMY_to_RGB(CMY), RGB, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(CMY_to_RGB(CMY), RGB, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_CMY_to_RGB(self): """ @@ -183,7 +173,7 @@ def test_nan_CMY_to_RGB(self): CMY_to_RGB(cases) -class TestCMY_to_CMYK(unittest.TestCase): +class TestCMY_to_CMYK: """ Define :func:`colour.models.rgb.cmyk.CMY_to_CMYK` definition unit tests methods. @@ -261,7 +251,7 @@ def test_nan_CMY_to_CMYK(self): CMY_to_CMYK(cases) -class TestCMYK_to_CMY(unittest.TestCase): +class TestCMYK_to_CMY: """ Define :func:`colour.models.rgb.cmyk.CMYK_to_CMY` definition unit tests methods. @@ -271,25 +261,19 @@ def test_CMYK_to_CMY(self): """Test :func:`colour.models.rgb.cmyk.CMYK_to_CMY` definition.""" np.testing.assert_allclose( - CMYK_to_CMY( - np.array([0.00000000, 0.93246304, 0.91030457, 0.54379481]) - ), + CMYK_to_CMY(np.array([0.00000000, 0.93246304, 0.91030457, 0.54379481])), np.array([0.54379481, 0.96918929, 0.95908048]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - CMYK_to_CMY( - np.array([0.00000000, 1.00000000, 1.00000000, 0.15000000]) - ), + CMYK_to_CMY(np.array([0.00000000, 1.00000000, 1.00000000, 0.15000000])), np.array([0.15000000, 1.00000000, 1.00000000]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - CMYK_to_CMY( - np.array([0.15000000, 0.00000000, 0.00000000, 0.00000000]) - ), + CMYK_to_CMY(np.array([0.15000000, 0.00000000, 0.00000000, 0.00000000])), np.array([0.15000000, 0.00000000, 0.00000000]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -343,7 +327,3 @@ def test_nan_CMYK_to_CMY(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=4)))) CMYK_to_CMY(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/tests/test_common.py b/colour/models/rgb/tests/test_common.py index 32502c04d6..a4face75b4 100644 --- a/colour/models/rgb/tests/test_common.py +++ b/colour/models/rgb/tests/test_common.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.rgb.common` module.""" -import unittest import numpy as np @@ -21,7 +19,7 @@ ] -class TestXYZ_to_sRGB(unittest.TestCase): +class TestXYZ_to_sRGB: """ Define :func:`colour.models.rgb.common.XYZ_to_sRGB` definition unit tests methods. @@ -80,7 +78,7 @@ def test_XYZ_to_sRGB(self): ) -class TestsRGB_to_XYZ(unittest.TestCase): +class TestsRGB_to_XYZ: """ Define :func:`colour.models.rgb.common.sRGB_to_XYZ` definition unit tests methods. @@ -137,7 +135,3 @@ def test_sRGB_to_XYZ(self): np.array([0.20654291, 0.12197943, 0.05137141]), atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/tests/test_cylindrical.py b/colour/models/rgb/tests/test_cylindrical.py index 7866c50381..4cee31734f 100644 --- a/colour/models/rgb/tests/test_cylindrical.py +++ b/colour/models/rgb/tests/test_cylindrical.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.rgb.cylindrical` module.""" -import unittest from itertools import product import numpy as np @@ -34,7 +32,7 @@ ] -class TestRGB_to_HSV(unittest.TestCase): +class TestRGB_to_HSV: """ Define :func:`colour.models.rgb.cylindrical.RGB_to_HSV` definition unit tests methods. @@ -78,15 +76,11 @@ def test_n_dimensional_RGB_to_HSV(self): RGB = np.tile(RGB, (6, 1)) HSV = np.tile(HSV, (6, 1)) - np.testing.assert_allclose( - RGB_to_HSV(RGB), HSV, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(RGB_to_HSV(RGB), HSV, atol=TOLERANCE_ABSOLUTE_TESTS) RGB = np.reshape(RGB, (2, 3, 3)) HSV = np.reshape(HSV, (2, 3, 3)) - np.testing.assert_allclose( - RGB_to_HSV(RGB), HSV, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(RGB_to_HSV(RGB), HSV, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_RGB_to_HSV(self): """ @@ -118,7 +112,7 @@ def test_nan_RGB_to_HSV(self): RGB_to_HSV(cases) -class TestHSV_to_RGB(unittest.TestCase): +class TestHSV_to_RGB: """ Define :func:`colour.models.rgb.cylindrical.HSV_to_RGB` definition unit tests methods. @@ -162,15 +156,11 @@ def test_n_dimensional_HSV_to_RGB(self): HSV = np.tile(HSV, (6, 1)) RGB = np.tile(RGB, (6, 1)) - np.testing.assert_allclose( - HSV_to_RGB(HSV), RGB, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(HSV_to_RGB(HSV), RGB, atol=TOLERANCE_ABSOLUTE_TESTS) HSV = np.reshape(HSV, (2, 3, 3)) RGB = np.reshape(RGB, (2, 3, 3)) - np.testing.assert_allclose( - HSV_to_RGB(HSV), RGB, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(HSV_to_RGB(HSV), RGB, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_HSV_to_RGB(self): """ @@ -202,7 +192,7 @@ def test_nan_HSV_to_RGB(self): HSV_to_RGB(cases) -class TestRGB_to_HSL(unittest.TestCase): +class TestRGB_to_HSL: """ Define :func:`colour.models.rgb.cylindrical.RGB_to_HSL` definition unit tests methods. @@ -246,15 +236,11 @@ def test_n_dimensional_RGB_to_HSL(self): RGB = np.tile(RGB, (6, 1)) HSL = np.tile(HSL, (6, 1)) - np.testing.assert_allclose( - RGB_to_HSL(RGB), HSL, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(RGB_to_HSL(RGB), HSL, atol=TOLERANCE_ABSOLUTE_TESTS) RGB = np.reshape(RGB, (2, 3, 3)) HSL = np.reshape(HSL, (2, 3, 3)) - np.testing.assert_allclose( - RGB_to_HSL(RGB), HSL, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(RGB_to_HSL(RGB), HSL, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_RGB_to_HSL(self): """ @@ -286,7 +272,7 @@ def test_nan_RGB_to_HSL(self): RGB_to_HSL(cases) -class TestHSL_to_RGB(unittest.TestCase): +class TestHSL_to_RGB: """ Define :func:`colour.models.rgb.cylindrical.HSL_to_RGB` definition unit tests methods. @@ -330,15 +316,11 @@ def test_n_dimensional_HSL_to_RGB(self): HSL = np.tile(HSL, (6, 1)) RGB = np.tile(RGB, (6, 1)) - np.testing.assert_allclose( - HSL_to_RGB(HSL), RGB, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(HSL_to_RGB(HSL), RGB, atol=TOLERANCE_ABSOLUTE_TESTS) HSL = np.reshape(HSL, (2, 3, 3)) RGB = np.reshape(RGB, (2, 3, 3)) - np.testing.assert_allclose( - HSL_to_RGB(HSL), RGB, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(HSL_to_RGB(HSL), RGB, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_HSL_to_RGB(self): """ @@ -370,7 +352,7 @@ def test_nan_HSL_to_RGB(self): HSL_to_RGB(cases) -class TestRGB_to_HCL(unittest.TestCase): +class TestRGB_to_HCL: """ Define :func:`colour.models.rgb.cylindrical.RGB_to_HCL` definition unit tests methods. @@ -414,15 +396,11 @@ def test_n_dimensional_RGB_to_HCL(self): RGB = np.tile(RGB, (6, 1)) HCL = np.tile(HCL, (6, 1)) - np.testing.assert_allclose( - RGB_to_HCL(RGB), HCL, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(RGB_to_HCL(RGB), HCL, atol=TOLERANCE_ABSOLUTE_TESTS) RGB = np.reshape(RGB, (2, 3, 3)) HCL = np.reshape(HCL, (2, 3, 3)) - np.testing.assert_allclose( - RGB_to_HCL(RGB), HCL, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(RGB_to_HCL(RGB), HCL, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_RGB_to_HCL(self): """ @@ -454,7 +432,7 @@ def test_nan_RGB_to_HCL(self): RGB_to_HCL(cases) -class TestHCL_to_RGB(unittest.TestCase): +class TestHCL_to_RGB: """ Define :func:`colour.models.rgb.cylindrical.HCL_to_RGB` definition unit tests methods. @@ -498,15 +476,11 @@ def test_n_dimensional_HCL_to_RGB(self): HCL = np.tile(HCL, (6, 1)) RGB = np.tile(RGB, (6, 1)) - np.testing.assert_allclose( - HCL_to_RGB(HCL), RGB, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(HCL_to_RGB(HCL), RGB, atol=TOLERANCE_ABSOLUTE_TESTS) HCL = np.reshape(HCL, (2, 3, 3)) RGB = np.reshape(RGB, (2, 3, 3)) - np.testing.assert_allclose( - HCL_to_RGB(HCL), RGB, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(HCL_to_RGB(HCL), RGB, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_HCL_to_RGB(self): """ @@ -536,7 +510,3 @@ def test_nan_HCL_to_RGB(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) HCL_to_RGB(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/tests/test_derivation.py b/colour/models/rgb/tests/test_derivation.py index 5183445ada..07a2c9ece4 100644 --- a/colour/models/rgb/tests/test_derivation.py +++ b/colour/models/rgb/tests/test_derivation.py @@ -1,9 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.rgb.derivation` module.""" import contextlib import re -import unittest from itertools import product import numpy as np @@ -37,7 +35,7 @@ ] -class Testxy_to_z(unittest.TestCase): +class Testxy_to_z: """ Define :func:`colour.models.rgb.derivation.xy_to_z` definition unit tests methods. @@ -78,15 +76,11 @@ def test_n_dimensional_xy_to_z(self): z, 6, ) - np.testing.assert_allclose( - xy_to_z(xy), z, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_to_z(xy), z, atol=TOLERANCE_ABSOLUTE_TESTS) xy = np.reshape(xy, (2, 3, 2)) z = np.reshape(z, (2, 3)) - np.testing.assert_allclose( - xy_to_z(xy), z, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_to_z(xy), z, atol=TOLERANCE_ABSOLUTE_TESTS) @ignore_numpy_errors def test_nan_xy_to_z(self): @@ -100,7 +94,7 @@ def test_nan_xy_to_z(self): xy_to_z(cases) -class TestNormalisedPrimaryMatrix(unittest.TestCase): +class TestNormalisedPrimaryMatrix: """ Define :func:`colour.models.rgb.derivation.normalised_primary_matrix` definition unit tests methods. @@ -114,9 +108,7 @@ def test_normalised_primary_matrix(self): np.testing.assert_allclose( normalised_primary_matrix( - np.array( - [0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700] - ), + np.array([0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700]), np.array([0.32168, 0.33767]), ), np.array( @@ -160,7 +152,7 @@ def test_nan_normalised_primary_matrix(self): normalised_primary_matrix(P, W) -class TestChromaticallyAdaptedPrimaries(unittest.TestCase): +class TestChromaticallyAdaptedPrimaries: """ Define :func:`colour.models.rgb.derivation.\ chromatically_adapted_primaries` definition unit tests methods. @@ -174,9 +166,7 @@ def test_chromatically_adapted_primaries(self): np.testing.assert_allclose( chromatically_adapted_primaries( - np.array( - [0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700] - ), + np.array([0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700]), np.array([0.32168, 0.33767]), np.array([0.34570, 0.35850]), ), @@ -238,7 +228,7 @@ def test_nan_chromatically_adapted_primaries(self): chromatically_adapted_primaries(P, W, W) -class TestPrimariesWhitepoint(unittest.TestCase): +class TestPrimariesWhitepoint: """ Define :func:`colour.models.rgb.derivation.primaries_whitepoint` definition unit tests methods. @@ -314,7 +304,7 @@ def test_nan_primaries_whitepoint(self): primaries_whitepoint(M) -class TestRGBLuminanceEquation(unittest.TestCase): +class TestRGBLuminanceEquation: """ Define :func:`colour.models.rgb.derivation.RGB_luminance_equation` definition unit tests methods. @@ -326,11 +316,9 @@ def test_RGB_luminance_equation(self): definition. """ - self.assertIsInstance( + assert isinstance( RGB_luminance_equation( - np.array( - [0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700] - ), + np.array([0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700]), np.array([0.32168, 0.33767]), ), str, @@ -344,15 +332,13 @@ def test_RGB_luminance_equation(self): "\\(B\\)" ) P = np.array([0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700]) - self.assertTrue( - re.match( - pattern, - RGB_luminance_equation(P, np.array([0.32168, 0.33767])), - ) + assert re.match( + pattern, + RGB_luminance_equation(P, np.array([0.32168, 0.33767])), ) -class TestRGBLuminance(unittest.TestCase): +class TestRGBLuminance: """ Define :func:`colour.models.rgb.derivation.RGB_luminance` definition unit tests methods. @@ -367,9 +353,7 @@ def test_RGB_luminance(self): np.testing.assert_allclose( RGB_luminance( np.array([0.18, 0.18, 0.18]), - np.array( - [0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700] - ), + np.array([0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700]), np.array([0.32168, 0.33767]), ), 0.18000000, @@ -379,9 +363,7 @@ def test_RGB_luminance(self): np.testing.assert_allclose( RGB_luminance( np.array([0.21959402, 0.06986677, 0.04703877]), - np.array( - [0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700] - ), + np.array([0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700]), np.array([0.32168, 0.33767]), ), 0.123014562384318, @@ -405,9 +387,7 @@ def test_n_dimensional_RGB_luminance(self): """ RGB = (np.array([0.18, 0.18, 0.18]),) - P = ( - np.array([0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700]), - ) + P = (np.array([0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700]),) W = np.array([0.32168, 0.33767]) Y = RGB_luminance(RGB, P, W) @@ -438,7 +418,3 @@ def test_nan_RGB_luminance(self): W = case[0:2] with contextlib.suppress(LinAlgError): RGB_luminance(RGB, P, W) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/tests/test_hanbury2003.py b/colour/models/rgb/tests/test_hanbury2003.py index 9de43e779e..4b99607b00 100644 --- a/colour/models/rgb/tests/test_hanbury2003.py +++ b/colour/models/rgb/tests/test_hanbury2003.py @@ -1,6 +1,5 @@ """Defines unit tests for :mod:`colour.models.rgb.hanbury2003` module.""" -import unittest from itertools import product import numpy as np @@ -22,7 +21,7 @@ ] -class TestRGB_to_IHLS(unittest.TestCase): +class TestRGB_to_IHLS: """ Define :func:`colour.models.rgb.hanbury2003.RGB_to_IHLS` definition unit tests methods. @@ -60,15 +59,11 @@ def test_n_dimensional_RGB_to_IHLS(self): RGB = np.tile(RGB, (6, 1)) HYS = np.tile(HYS, (6, 1)) - np.testing.assert_allclose( - RGB_to_IHLS(RGB), HYS, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(RGB_to_IHLS(RGB), HYS, atol=TOLERANCE_ABSOLUTE_TESTS) RGB = np.reshape(RGB, (2, 3, 3)) HYS = np.reshape(HYS, (2, 3, 3)) - np.testing.assert_allclose( - RGB_to_IHLS(RGB), HYS, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(RGB_to_IHLS(RGB), HYS, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_RGB_to_IHLS(self): """ @@ -100,7 +95,7 @@ def test_nan_RGB_to_IHLS(self): RGB_to_IHLS(cases) -class TestIHLS_to_RGB(unittest.TestCase): +class TestIHLS_to_RGB: """ Define :func:`colour.models.rgb.hanbury2003.RGB_to_IHLS` definition unit tests methods. @@ -138,15 +133,11 @@ def test_n_dimensional_IHLS_to_RGB(self): HYS = np.tile(HYS, (6, 1)) RGB = np.tile(RGB, (6, 1)) - np.testing.assert_allclose( - IHLS_to_RGB(HYS), RGB, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(IHLS_to_RGB(HYS), RGB, atol=TOLERANCE_ABSOLUTE_TESTS) HYS = np.reshape(HYS, (2, 3, 3)) RGB = np.reshape(RGB, (2, 3, 3)) - np.testing.assert_allclose( - IHLS_to_RGB(HYS), RGB, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(IHLS_to_RGB(HYS), RGB, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_IHLS_to_RGB(self): """ @@ -176,7 +167,3 @@ def test_nan_IHLS_to_RGB(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) IHLS_to_RGB(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/tests/test_ictcp.py b/colour/models/rgb/tests/test_ictcp.py index ea8fcf287c..034752ed26 100644 --- a/colour/models/rgb/tests/test_ictcp.py +++ b/colour/models/rgb/tests/test_ictcp.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.rgb.ictcp` module.""" -import unittest from itertools import product import numpy as np @@ -30,7 +28,7 @@ ] -class TestRGB_to_ICtCp(unittest.TestCase): +class TestRGB_to_ICtCp: """ Define :func:`colour.models.rgb.ictcp.TestRGB_to_ICtCp` definition unit tests methods. @@ -46,17 +44,13 @@ def test_RGB_to_ICtCp(self): ) np.testing.assert_allclose( - RGB_to_ICtCp( - np.array([0.45620519, 0.03081071, 0.04091952]), L_p=4000 - ), + RGB_to_ICtCp(np.array([0.45620519, 0.03081071, 0.04091952]), L_p=4000), np.array([0.10516931, 0.00514031, 0.12318730]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - RGB_to_ICtCp( - np.array([0.45620519, 0.03081071, 0.04091952]), L_p=1000 - ), + RGB_to_ICtCp(np.array([0.45620519, 0.03081071, 0.04091952]), L_p=1000), np.array([0.17079612, 0.00485580, 0.17431356]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -148,7 +142,7 @@ def test_nan_RGB_to_ICtCp(self): RGB_to_ICtCp(cases) -class TestICtCp_to_RGB(unittest.TestCase): +class TestICtCp_to_RGB: """ Define :func:`colour.models.rgb.ictcp.ICtCp_to_RGB` definition unit tests methods. @@ -164,17 +158,13 @@ def test_ICtCp_to_RGB(self): ) np.testing.assert_allclose( - ICtCp_to_RGB( - np.array([0.10516931, 0.00514031, 0.12318730]), L_p=4000 - ), + ICtCp_to_RGB(np.array([0.10516931, 0.00514031, 0.12318730]), L_p=4000), np.array([0.45620519, 0.03081071, 0.04091952]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - ICtCp_to_RGB( - np.array([0.17079612, 0.00485580, 0.17431356]), L_p=1000 - ), + ICtCp_to_RGB(np.array([0.17079612, 0.00485580, 0.17431356]), L_p=1000), np.array([0.45620519, 0.03081071, 0.04091952]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -266,7 +256,7 @@ def test_nan_ICtCp_to_RGB(self): ICtCp_to_RGB(cases) -class TestXYZ_to_ICtCp(unittest.TestCase): +class TestXYZ_to_ICtCp: """ Define :func:`colour.models.rgb.ictcp.TestXYZ_to_ICtCp` definition unit tests methods. @@ -301,17 +291,13 @@ def test_XYZ_to_ICtCp(self): ) np.testing.assert_allclose( - XYZ_to_ICtCp( - np.array([0.20654008, 0.12197225, 0.05136952]), L_p=4000 - ), + XYZ_to_ICtCp(np.array([0.20654008, 0.12197225, 0.05136952]), L_p=4000), np.array([0.09871102, -0.00447247, 0.07984812]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - XYZ_to_ICtCp( - np.array([0.20654008, 0.12197225, 0.05136952]), L_p=1000 - ), + XYZ_to_ICtCp(np.array([0.20654008, 0.12197225, 0.05136952]), L_p=1000), np.array([0.16173872, -0.00792543, 0.11409458]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -403,7 +389,7 @@ def test_nan_XYZ_to_ICtCp(self): XYZ_to_ICtCp(cases) -class TestICtCp_to_XYZ(unittest.TestCase): +class TestICtCp_to_XYZ: """ Define :func:`colour.models.rgb.ictcp.ICtCp_to_XYZ` definition unit tests methods. @@ -438,17 +424,13 @@ def test_ICtCp_to_XYZ(self): ) np.testing.assert_allclose( - ICtCp_to_XYZ( - np.array([0.09871102, -0.00447247, 0.07984812]), L_p=4000 - ), + ICtCp_to_XYZ(np.array([0.09871102, -0.00447247, 0.07984812]), L_p=4000), np.array([0.20654008, 0.12197225, 0.05136952]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - ICtCp_to_XYZ( - np.array([0.16173872, -0.00792543, 0.11409458]), L_p=1000 - ), + ICtCp_to_XYZ(np.array([0.16173872, -0.00792543, 0.11409458]), L_p=1000), np.array([0.20654008, 0.12197225, 0.05136952]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -538,7 +520,3 @@ def test_nan_ICtCp_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) ICtCp_to_XYZ(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/tests/test_itut_h_273.py b/colour/models/rgb/tests/test_itut_h_273.py index a1c4ad96fe..8d012cf348 100644 --- a/colour/models/rgb/tests/test_itut_h_273.py +++ b/colour/models/rgb/tests/test_itut_h_273.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.rgb.itut_h_273` module.""" -import unittest from colour.models import ( describe_video_signal_colour_primaries, @@ -23,7 +21,7 @@ ] -class TestDescribeVideoSignalColourPrimaries(unittest.TestCase): +class TestDescribeVideoSignalColourPrimaries: """ Define :func:`colour.models.rgb.itut_h_273.\ describe_video_signal_colour_primaries` definition unit tests methods. @@ -37,10 +35,10 @@ def test_describe_video_signal_colour_primaries(self): """ description = describe_video_signal_colour_primaries(1) - self.assertIsInstance(description, str) + assert isinstance(description, str) -class TestDescribeVideoSignalTransferCharacteristics(unittest.TestCase): +class TestDescribeVideoSignalTransferCharacteristics: """ Define :func:`colour.models.rgb.itut_h_273.\ describe_video_signal_transfer_characteristics` definition unit tests methods. @@ -53,10 +51,10 @@ def test_describe_video_signal_transfer_characteristics(self): """ description = describe_video_signal_transfer_characteristics(1) - self.assertIsInstance(description, str) + assert isinstance(description, str) -class TestDescribeVideoSignalMatrixCoefficients(unittest.TestCase): +class TestDescribeVideoSignalMatrixCoefficients: """ Define :func:`colour.models.rgb.itut_h_273.\ describe_video_signal_matrix_coefficients` definition unit tests methods. @@ -69,8 +67,4 @@ def test_describe_video_signal_matrix_coefficients(self): """ description = describe_video_signal_matrix_coefficients(1) - self.assertIsInstance(description, str) - - -if __name__ == "__main__": - unittest.main() + assert isinstance(description, str) diff --git a/colour/models/rgb/tests/test_prismatic.py b/colour/models/rgb/tests/test_prismatic.py index 65dcef7f6c..d434a94933 100644 --- a/colour/models/rgb/tests/test_prismatic.py +++ b/colour/models/rgb/tests/test_prismatic.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.rgb.prismatic` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class TestRGB_to_Prismatic(unittest.TestCase): +class TestRGB_to_Prismatic: """ Define :func:`colour.models.rgb.prismatic.TestRGB_to_Prismatic` definition unit tests methods. @@ -95,7 +93,7 @@ def test_nan_RGB_to_Prismatic(self): RGB_to_Prismatic(cases) -class TestPrismatic_to_RGB(unittest.TestCase): +class TestPrismatic_to_RGB: """ Define :func:`colour.models.rgb.prismatic.Prismatic_to_RGB` definition unit tests methods. @@ -111,9 +109,7 @@ def test_Prismatic_to_RGB(self): ) np.testing.assert_allclose( - Prismatic_to_RGB( - np.array([0.7500000, 0.1666667, 0.3333333, 0.5000000]) - ), + Prismatic_to_RGB(np.array([0.7500000, 0.1666667, 0.3333333, 0.5000000])), np.array([0.25, 0.50, 0.75]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -167,7 +163,3 @@ def test_nan_Prismatic_to_RGB(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) Prismatic_to_RGB(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/tests/test_rgb_colourspace.py b/colour/models/rgb/tests/test_rgb_colourspace.py index 974a50a726..d0cfc1d096 100644 --- a/colour/models/rgb/tests/test_rgb_colourspace.py +++ b/colour/models/rgb/tests/test_rgb_colourspace.py @@ -1,11 +1,9 @@ -# !/usr/bin/env python """ Define the unit tests for the :mod:`colour.models.rgb.rgb_colourspace` module. """ import re import textwrap -import unittest from itertools import product import numpy as np @@ -44,13 +42,13 @@ ] -class TestRGB_Colourspace(unittest.TestCase): +class TestRGB_Colourspace: """ Define :class:`colour.colour.models.RGB_Colourspace` class unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" p = np.array([0.73470, 0.26530, 0.00000, 1.00000, 0.00010, -0.07700]) @@ -85,7 +83,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(RGB_Colourspace)) + assert attribute in dir(RGB_Colourspace) def test_required_methods(self): """Test the presence of required methods.""" @@ -100,7 +98,7 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(RGB_Colourspace)) + assert method in dir(RGB_Colourspace) def test__str__(self): """ @@ -108,8 +106,7 @@ def test__str__(self): method. """ - self.assertEqual( - re.sub(" at 0x\\w+>", "", str(self._colourspace)), + assert re.sub(" at 0x\\w+>", "", str(self._colourspace)) == ( textwrap.dedent( """ RGB Colourspace @@ -137,7 +134,7 @@ def test__str__(self): Use Derived NPM : False Use Derived NPM -1 : False """ - ).strip(), + ).strip() ) def test__repr__(self): @@ -146,8 +143,7 @@ def test__repr__(self): __repr__` method. """ - self.assertEqual( - re.sub(" at 0x\\w+>", "", repr(self._colourspace)), + assert re.sub(" at 0x\\w+>", "", repr(self._colourspace)) == ( textwrap.dedent( """ RGB_Colourspace('RGB Colourspace', @@ -167,7 +163,7 @@ def test__repr__(self): False, False) """ - ).strip(), + ).strip() ) def test_use_derived_transformation_matrices(self): @@ -243,7 +239,7 @@ def test_chromatically_adapt(self): colourspace.whitepoint, whitepoint_t, atol=TOLERANCE_ABSOLUTE_TESTS ) - self.assertEqual(colourspace.whitepoint_name, "D50") + assert colourspace.whitepoint_name == "D50" np.testing.assert_allclose( colourspace.primaries, @@ -258,18 +254,14 @@ def test_chromatically_adapt(self): np.testing.assert_allclose( colourspace.matrix_RGB_to_XYZ, - normalised_primary_matrix( - colourspace.primaries, colourspace.whitepoint - ), + normalised_primary_matrix(colourspace.primaries, colourspace.whitepoint), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( colourspace.matrix_XYZ_to_RGB, np.linalg.inv( - normalised_primary_matrix( - colourspace.primaries, colourspace.whitepoint - ) + normalised_primary_matrix(colourspace.primaries, colourspace.whitepoint) ), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -280,10 +272,10 @@ def test_copy(self): method. """ - self.assertIsNot(self._colourspace.copy(), self) + assert self._colourspace.copy() is not self -class TestXYZ_to_RGB(unittest.TestCase): +class TestXYZ_to_RGB: """ Define :func:`colour.models.rgb.rgb_colourspace.XYZ_to_RGB` definition unit tests methods. @@ -480,13 +472,11 @@ def test_nan_XYZ_to_RGB(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - M = np.vstack([cases[0, ...], cases[0, ...], cases[0, ...]]).reshape( - [3, 3] - ) + M = np.reshape(np.vstack([cases[0, ...], cases[0, ...], cases[0, ...]]), (3, 3)) XYZ_to_RGB(cases, cases[..., 0:2], cases[..., 0:2], M) -class TestRGB_to_XYZ(unittest.TestCase): +class TestRGB_to_XYZ: """ Define :func:`colour.models.rgb.rgb_colourspace.RGB_to_XYZ` definition unit tests methods. @@ -683,13 +673,11 @@ def test_nan_RGB_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - M = np.vstack([cases[0, ...], cases[0, ...], cases[0, ...]]).reshape( - [3, 3] - ) + M = np.reshape(np.vstack([cases[0, ...], cases[0, ...], cases[0, ...]]), (3, 3)) RGB_to_XYZ(cases, cases[..., 0:2], cases[..., 0:2], M) -class TestMatrix_RGB_to_RGB(unittest.TestCase): +class TestMatrix_RGB_to_RGB: """ Define :func:`colour.models.rgb.rgb_colourspace.matrix_RGB_to_RGB` definition unit tests methods. @@ -730,9 +718,7 @@ def test_matrix_RGB_to_RGB(self): ) np.testing.assert_allclose( - matrix_RGB_to_RGB( - aces_2065_1_colourspace, aces_cg_colourspace, "Bradford" - ), + matrix_RGB_to_RGB(aces_2065_1_colourspace, aces_cg_colourspace, "Bradford"), np.array( [ [1.45143932, -0.23651075, -0.21492857], @@ -744,9 +730,7 @@ def test_matrix_RGB_to_RGB(self): ) np.testing.assert_allclose( - matrix_RGB_to_RGB( - aces_2065_1_colourspace, sRGB_colourspace, "Bradford" - ), + matrix_RGB_to_RGB(aces_2065_1_colourspace, sRGB_colourspace, "Bradford"), np.array( [ [2.52140089, -1.13399575, -0.38756186], @@ -776,7 +760,7 @@ def test_matrix_RGB_to_RGB(self): ) -class TestRGB_to_RGB(unittest.TestCase): +class TestRGB_to_RGB: """ Define :func:`colour.models.rgb.rgb_colourspace.RGB_to_RGB` definition unit tests methods. @@ -946,7 +930,3 @@ def test_nan_RGB_to_RGB(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) RGB_to_RGB(cases, aces_2065_1_colourspace, sRGB_colourspace) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/tests/test_ycbcr.py b/colour/models/rgb/tests/test_ycbcr.py index 24b3bffbf5..4f471f1e1d 100644 --- a/colour/models/rgb/tests/test_ycbcr.py +++ b/colour/models/rgb/tests/test_ycbcr.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.rgb.ycbcr` module.""" -import unittest from itertools import product import numpy as np @@ -39,7 +37,7 @@ ] -class TestRoundBT2100(unittest.TestCase): +class TestRoundBT2100: """ Define :func:`colour.models.rgb.ycbcr.round_BT2100` definition unit tests methods. @@ -54,7 +52,7 @@ def test_round_BT2100(self): ) -class TestRangeYCbCr(unittest.TestCase): +class TestRangeYCbCr: """ Define :func:`colour.models.rgb.ycbcr.ranges_YCbCr` definition unit tests methods. @@ -112,7 +110,7 @@ def test_ranges_YCbCr(self): ) -class TestMatrixYCbCr(unittest.TestCase): +class TestMatrixYCbCr: """ Define :func:`colour.models.rgb.ycbcr.matrix_YCbCr` definition unit tests methods. @@ -182,7 +180,7 @@ def test_matrix_YCbCr(self): ) -class TestOffsetYCbCr(unittest.TestCase): +class TestOffsetYCbCr: """ Define :func:`colour.models.rgb.ycbcr.offset_YCbCr` definition unit tests methods. @@ -216,7 +214,7 @@ def test_offset_YCbCr(self): ) -class TestRGB_to_YCbCr(unittest.TestCase): +class TestRGB_to_YCbCr: """ Define :func:`colour.models.rgb.ycbcr.RGB_to_YCbCr` definition unit tests methods. @@ -321,7 +319,7 @@ def test_nan_RGB_to_YCbCr(self): RGB_to_YCbCr(cases) -class TestYCbCr_to_RGB(unittest.TestCase): +class TestYCbCr_to_RGB: """ Define :func:`colour.models.rgb.ycbcr.YCbCr_to_RGB` definition unit tests methods. @@ -418,7 +416,7 @@ def test_nan_YCbCr_to_RGB(self): YCbCr_to_RGB(cases) -class TestRGB_to_YcCbcCrc(unittest.TestCase): +class TestRGB_to_YcCbcCrc: """ Define :func:`colour.models.rgb.ycbcr.RGB_to_YcCbcCrc` definition unit tests methods. @@ -508,7 +506,7 @@ def test_nan_RGB_to_YcCbcCrc(self): RGB_to_YcCbcCrc(cases) -class TestYcCbcCrc_to_RGB(unittest.TestCase): +class TestYcCbcCrc_to_RGB: """ Define :func:`colour.models.rgb.ycbcr.YCbCr_to_RGB` definition unit tests methods. @@ -596,7 +594,3 @@ def test_nan_YcCbcCrc_to_RGB(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) YcCbcCrc_to_RGB(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/tests/test_ycocg.py b/colour/models/rgb/tests/test_ycocg.py index 05630a2a83..3854535047 100644 --- a/colour/models/rgb/tests/test_ycocg.py +++ b/colour/models/rgb/tests/test_ycocg.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.rgb.ycocg` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class TestRGB_to_YCoCg(unittest.TestCase): +class TestRGB_to_YCoCg: """ Define :func:`colour.models.rgb.ycocg.RGB_to_YCoCg` definition unit tests methods. @@ -92,7 +90,7 @@ def test_nan_RGB_to_YCoCg(self): RGB_to_YCoCg(cases) -class TestYCoCg_to_RGB(unittest.TestCase): +class TestYCoCg_to_RGB: """ Define :func:`colour.models.rgb.ycocg.YCoCg_to_RGB` definition unit tests methods. @@ -159,7 +157,3 @@ def test_nan_YCoCg_to_RGB(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) YCoCg_to_RGB(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/__init__.py b/colour/models/rgb/transfer_functions/__init__.py index 0d0f021a9f..378dfbfdd2 100644 --- a/colour/models/rgb/transfer_functions/__init__.py +++ b/colour/models/rgb/transfer_functions/__init__.py @@ -418,9 +418,7 @@ def log_encoding( - value: ArrayLike, - function: Union[LiteralLogEncoding, str] = "Cineon", - **kwargs: Any + value: ArrayLike, function: Union[LiteralLogEncoding, str] = "Cineon", **kwargs: Any ) -> Union[NDArrayFloat, NDArrayInt]: """ Encode *scene-referred* exposure values to :math:`R'G'B'` video component @@ -541,7 +539,7 @@ def log_encoding( def log_decoding( value: Union[ArrayLike, ArrayLike], function: Union[LiteralLogDecoding, str] = "Cineon", - **kwargs: Any + **kwargs: Any, ) -> NDArrayFloat: """ Decode :math:`R'G'B'` video component signal value to *scene-referred* @@ -652,9 +650,7 @@ def log_decoding( def oetf( - value: ArrayLike, - function: Union[LiteralOETF, str] = "ITU-R BT.709", - **kwargs: Any + value: ArrayLike, function: Union[LiteralOETF, str] = "ITU-R BT.709", **kwargs: Any ) -> NDArrayFloat: """ Encode estimated tristimulus values in a scene to :math:`R'G'B'` video @@ -729,7 +725,7 @@ def oetf( def oetf_inverse( value: ArrayLike, function: Union[LiteralOETFInverse, str] = "ITU-R BT.709", - **kwargs: Any + **kwargs: Any, ) -> NDArrayFloat: """ Decode :math:`R'G'B'` video component signal value to tristimulus values @@ -804,7 +800,7 @@ def oetf_inverse( def eotf( value: Union[ArrayLike, ArrayLike], function: Union[LiteralEOTF, str] = "ITU-R BT.1886", - **kwargs: Any + **kwargs: Any, ) -> NDArrayFloat: """ Decode :math:`R'G'B'` video component signal value to tristimulus values @@ -875,7 +871,7 @@ def eotf( def eotf_inverse( value: ArrayLike, function: Union[LiteralEOTFInverse, str] = "ITU-R BT.1886", - **kwargs + **kwargs, ) -> Union[NDArrayFloat, NDArrayInt]: """ Encode estimated tristimulus values in a scene to :math:`R'G'B'` video @@ -972,9 +968,7 @@ def eotf_inverse( def cctf_encoding( - value: ArrayLike, - function: Union[LiteralCCTFEncoding, str] = "sRGB", - **kwargs: Any + value: ArrayLike, function: Union[LiteralCCTFEncoding, str] = "sRGB", **kwargs: Any ) -> Union[NDArrayFloat, NDArrayInt]: """ Encode linear :math:`RGB` values to non-linear :math:`R'G'B'` values using @@ -1078,7 +1072,7 @@ def cctf_encoding( def cctf_decoding( value: Union[ArrayLike, ArrayLike], function: Union[LiteralCCTFDecoding, str] = "sRGB", - **kwargs: Any + **kwargs: Any, ) -> NDArrayFloat: """ Decode non-linear :math:`R'G'B'` values to linear :math:`RGB` values using @@ -1166,7 +1160,7 @@ def cctf_decoding( def ootf( value: ArrayLike, function: Union[LiteralOOTF, str] = "ITU-R BT.2100 PQ", - **kwargs: Any + **kwargs: Any, ) -> NDArrayFloat: """ Map relative scene linear light to display linear light using given @@ -1224,7 +1218,7 @@ def ootf( def ootf_inverse( value: ArrayLike, function: Union[LiteralOOTFInverse, str] = "ITU-R BT.2100 PQ", - **kwargs: Any + **kwargs: Any, ) -> NDArrayFloat: """ Map relative display linear light to scene linear light using given diff --git a/colour/models/rgb/transfer_functions/aces.py b/colour/models/rgb/transfer_functions/aces.py index c35d18a6cf..beb6e7ffa0 100644 --- a/colour/models/rgb/transfer_functions/aces.py +++ b/colour/models/rgb/transfer_functions/aces.py @@ -2,7 +2,7 @@ Academy Color Encoding System - Log Encodings ============================================= -Defines the *Academy Color Encoding System* (ACES) log encodings: +Define the *Academy Color Encoding System* (ACES) log encodings: - :func:`colour.models.log_encoding_ACESproxy` - :func:`colour.models.log_decoding_ACESproxy` @@ -188,8 +188,7 @@ def float_2_cv(x: float) -> float: ACESproxy = np.where( lin_AP1 > 2**-9.72, float_2_cv( - (np.log2(lin_AP1) + mid_log_offset) * steps_per_stop - + mid_CV_offset + (np.log2(lin_AP1) + mid_log_offset) * steps_per_stop + mid_CV_offset ), np.resize(CV_min, lin_AP1.shape), ) @@ -271,9 +270,7 @@ def log_decoding_ACESproxy( if not in_int: ACESproxy = ACESproxy * (2**bit_depth - 1) - lin_AP1 = 2 ** ( - (ACESproxy - mid_CV_offset) / steps_per_stop - mid_log_offset - ) + lin_AP1 = 2 ** ((ACESproxy - mid_CV_offset) / steps_per_stop - mid_log_offset) return as_float(from_range_1(lin_AP1)) diff --git a/colour/models/rgb/transfer_functions/apple_log_profile.py b/colour/models/rgb/transfer_functions/apple_log_profile.py index d755e6d6f8..e1b6448b80 100644 --- a/colour/models/rgb/transfer_functions/apple_log_profile.py +++ b/colour/models/rgb/transfer_functions/apple_log_profile.py @@ -2,7 +2,7 @@ Apple Log Profile Log Encoding ============================== -Defines the *Apple Log Profile* log encoding: +Define the *Apple Log Profile* log encoding: - :func:`colour.models.log_encoding_AppleLogProfile` - :func:`colour.models.log_decoding_AppleLogProfile` diff --git a/colour/models/rgb/transfer_functions/arib_std_b67.py b/colour/models/rgb/transfer_functions/arib_std_b67.py index f9764fb90e..cd95bd9626 100644 --- a/colour/models/rgb/transfer_functions/arib_std_b67.py +++ b/colour/models/rgb/transfer_functions/arib_std_b67.py @@ -2,7 +2,7 @@ ARIB STD-B67 (Hybrid Log-Gamma) =============================== -Defines the *ARIB STD-B67 (Hybrid Log-Gamma)* opto-electrical transfer function +Define the *ARIB STD-B67 (Hybrid Log-Gamma)* opto-electrical transfer function (OETF) and its inverse: - :func:`colour.models.oetf_ARIBSTDB67` @@ -45,9 +45,7 @@ "oetf_inverse_ARIBSTDB67", ] -CONSTANTS_ARIBSTDB67: Structure = Structure( - a=0.17883277, b=0.28466892, c=0.55991073 -) +CONSTANTS_ARIBSTDB67: Structure = Structure(a=0.17883277, b=0.28466892, c=0.55991073) """*ARIB STD-B67 (Hybrid Log-Gamma)* constants.""" @@ -111,9 +109,7 @@ def oetf_ARIBSTDB67( b = constants.b c = constants.c - E_p = np.where( - E <= 1, r * gamma_function(E, 0.5, "mirror"), a * np.log(E - b) + c - ) + E_p = np.where(E <= 1, r * gamma_function(E, 0.5, "mirror"), a * np.log(E - b) + c) return as_float(from_range_1(E_p)) diff --git a/colour/models/rgb/transfer_functions/arri.py b/colour/models/rgb/transfer_functions/arri.py index 81e5ad812d..5da6b97afe 100644 --- a/colour/models/rgb/transfer_functions/arri.py +++ b/colour/models/rgb/transfer_functions/arri.py @@ -2,10 +2,12 @@ ARRI Log Encodings ================== -Defines the *ARRI LogC3* log encoding: +Define the *ARRI LogC3* and *ARRI LogC4* log encodings: - :func:`colour.models.log_encoding_ARRILogC3` - :func:`colour.models.log_decoding_ARRILogC3` +- :func:`colour.models.log_encoding_ARRILogC4` +- :func:`colour.models.log_decoding_ARRILogC4` References ---------- @@ -553,11 +555,10 @@ def log_encoding_ARRILogC3( x: ArrayLike, firmware: Literal["SUP 2.x", "SUP 3.x"] | str = "SUP 3.x", - method: Literal["Linear Scene Exposure Factor", "Normalised Sensor Signal"] - | str = "Linear Scene Exposure Factor", - EI: Literal[ - 160, 200, 250, 320, 400, 500, 640, 800, 1000, 1280, 1600 - ] = 800, + method: ( + Literal["Linear Scene Exposure Factor", "Normalised Sensor Signal"] | str + ) = "Linear Scene Exposure Factor", + EI: Literal[160, 200, 250, 320, 400, 500, 640, 800, 1000, 1280, 1600] = 800, ) -> NDArrayFloat: """ Define the *ARRI LogC3* log encoding curve / opto-electronic transfer @@ -609,9 +610,9 @@ def log_encoding_ARRILogC3( method, ("Linear Scene Exposure Factor", "Normalised Sensor Signal") ) - cut, a, b, c, d, e, f, _e_cut_f = DATA_ALEXA_LOG_C_CURVE_CONVERSION[ - firmware - ][method][EI] + cut, a, b, c, d, e, f, _e_cut_f = DATA_ALEXA_LOG_C_CURVE_CONVERSION[firmware][ + method + ][EI] t = np.where(x > cut, c * np.log10(a * x + b) + d, e * x + f) @@ -621,11 +622,10 @@ def log_encoding_ARRILogC3( def log_decoding_ARRILogC3( t: ArrayLike, firmware: Literal["SUP 2.x", "SUP 3.x"] | str = "SUP 3.x", - method: Literal["Linear Scene Exposure Factor", "Normalised Sensor Signal"] - | str = "Linear Scene Exposure Factor", - EI: Literal[ - 160, 200, 250, 320, 400, 500, 640, 800, 1000, 1280, 1600 - ] = 800, + method: ( + Literal["Linear Scene Exposure Factor", "Normalised Sensor Signal"] | str + ) = "Linear Scene Exposure Factor", + EI: Literal[160, 200, 250, 320, 400, 500, 640, 800, 1000, 1280, 1600] = 800, ) -> NDArrayFloat: """ Define the *ARRI LogC3* log decoding curve / electro-optical transfer @@ -676,9 +676,9 @@ def log_decoding_ARRILogC3( method, ("Linear Scene Exposure Factor", "Normalised Sensor Signal") ) - cut, a, b, c, d, e, f, _e_cut_f = DATA_ALEXA_LOG_C_CURVE_CONVERSION[ - firmware - ][method][EI] + cut, a, b, c, d, e, f, _e_cut_f = DATA_ALEXA_LOG_C_CURVE_CONVERSION[firmware][ + method + ][EI] x = np.where(t > e * cut + f, (10 ** ((t - d) / c) - b) / a, (t - f) / e) diff --git a/colour/models/rgb/transfer_functions/blackmagic_design.py b/colour/models/rgb/transfer_functions/blackmagic_design.py index dcf810d037..42e0c01aa7 100644 --- a/colour/models/rgb/transfer_functions/blackmagic_design.py +++ b/colour/models/rgb/transfer_functions/blackmagic_design.py @@ -2,7 +2,7 @@ Blackmagic Design Transfer Functions ==================================== -Defines the *Blackmagic Design* colour component transfer functions: +Define the *Blackmagic Design* colour component transfer functions: - :func:`colour.models.oetf_BlackmagicFilmGeneration5` - :func:`colour.models.oetf_inverse_BlackmagicFilmGeneration5` diff --git a/colour/models/rgb/transfer_functions/canon.py b/colour/models/rgb/transfer_functions/canon.py index daf9b58e79..f0878177a0 100644 --- a/colour/models/rgb/transfer_functions/canon.py +++ b/colour/models/rgb/transfer_functions/canon.py @@ -2,7 +2,7 @@ Canon Log Encodings =================== -Defines the *Canon Log* encodings: +Define the *Canon Log* encodings: - :attr:`colour.models.CANON_LOG_ENCODING_METHODS` - :func:`colour.models.log_encoding_CanonLog` @@ -161,9 +161,7 @@ def log_encoding_CanonLog_v1( 0.529136 * np.log10(10.1596 * x + 1) + 0.0730597, ) - clog_cv = ( - full_to_legal(clog, bit_depth) if out_normalised_code_value else clog - ) + clog_cv = full_to_legal(clog, bit_depth) if out_normalised_code_value else clog return as_float(from_range_1(clog_cv)) @@ -215,9 +213,7 @@ def log_decoding_CanonLog_v1( Examples -------- - >>> log_decoding_CanonLog_v1( - ... 34.338965172606912 / 100 - ... ) # doctest: +ELLIPSIS + >>> log_decoding_CanonLog_v1(34.338965172606912 / 100) # doctest: +ELLIPSIS 0.17999999... """ @@ -302,9 +298,7 @@ def log_encoding_CanonLog_v1_2( # NOTE: *Canon Log* v1.2 constants are expressed in legal range # (studio swing). - clog_cv = ( - clog if out_normalised_code_value else legal_to_full(clog, bit_depth) - ) + clog_cv = clog if out_normalised_code_value else legal_to_full(clog, bit_depth) return as_float(from_range_1(clog_cv)) @@ -454,9 +448,7 @@ def log_encoding_CanonLog( are obtained as follows: >>> x = np.array([0, 2, 18, 90, 720]) / 100 - >>> np.around( - ... log_encoding_CanonLog(x, method="v1") * (2**10 - 1) - ... ).astype(np.int_) + >>> np.around(log_encoding_CanonLog(x, method="v1") * (2**10 - 1)).astype(np.int_) array([ 128, 169, 351, 614, 1016]) >>> np.around(log_encoding_CanonLog(x, 10, False, method="v1") * 100, 1) array([ 7.3, 12. , 32.8, 62.7, 108.7]) @@ -612,9 +604,7 @@ def log_encoding_CanonLog2_v1( 0.281863093 * np.log10(x * 87.09937546 + 1) + 0.035388128, ) - clog2_cv = ( - full_to_legal(clog2, bit_depth) if out_normalised_code_value else clog2 - ) + clog2_cv = full_to_legal(clog2, bit_depth) if out_normalised_code_value else clog2 return as_float(from_range_1(clog2_cv)) @@ -666,17 +656,13 @@ def log_decoding_CanonLog2_v1( Examples -------- - >>> log_decoding_CanonLog2_v1( - ... 39.825469498316735 / 100 - ... ) # doctest: +ELLIPSIS + >>> log_decoding_CanonLog2_v1(39.825469498316735 / 100) # doctest: +ELLIPSIS 0.1799999... """ clog2 = to_domain_1(clog2) - clog2 = ( - legal_to_full(clog2, bit_depth) if in_normalised_code_value else clog2 - ) + clog2 = legal_to_full(clog2, bit_depth) if in_normalised_code_value else clog2 x = np.where( clog2 < 0.035388128, @@ -755,9 +741,7 @@ def log_encoding_CanonLog2_v1_2( # NOTE: *Canon Log 2* v1.2 constants are expressed in legal range # (studio swing). - clog2_cv = ( - clog2 if out_normalised_code_value else legal_to_full(clog2, bit_depth) - ) + clog2_cv = clog2 if out_normalised_code_value else legal_to_full(clog2, bit_depth) return as_float(from_range_1(clog2_cv)) @@ -818,9 +802,7 @@ def log_decoding_CanonLog2_v1_2( # NOTE: *Canon Log 2* v1.2 constants are expressed in legal range # (studio swing). - clog2 = ( - clog2 if in_normalised_code_value else full_to_legal(clog2, bit_depth) - ) + clog2 = clog2 if in_normalised_code_value else full_to_legal(clog2, bit_depth) x = np.where( clog2 < 0.092864125, @@ -1058,18 +1040,9 @@ def log_encoding_CanonLog3_v1( with domain_range_scale("ignore"): clog3 = np.select( ( - x - < log_decoding_CanonLog3_v1( - 0.04076162, bit_depth, False, False - ), - x - <= log_decoding_CanonLog3_v1( - 0.105357102, bit_depth, False, False - ), - x - > log_decoding_CanonLog3_v1( - 0.105357102, bit_depth, False, False - ), + x < log_decoding_CanonLog3_v1(0.04076162, bit_depth, False, False), + x <= log_decoding_CanonLog3_v1(0.105357102, bit_depth, False, False), + x > log_decoding_CanonLog3_v1(0.105357102, bit_depth, False, False), ), ( -0.42889912 * np.log10(-x * 14.98325 + 1) + 0.07623209, @@ -1078,9 +1051,7 @@ def log_encoding_CanonLog3_v1( ), ) - clog3_cv = ( - full_to_legal(clog3, bit_depth) if out_normalised_code_value else clog3 - ) + clog3_cv = full_to_legal(clog3, bit_depth) if out_normalised_code_value else clog3 return as_float(from_range_1(clog3_cv)) @@ -1132,17 +1103,13 @@ def log_decoding_CanonLog3_v1( Examples -------- - >>> log_decoding_CanonLog3_v1( - ... 34.338936938868677 / 100 - ... ) # doctest: +ELLIPSIS + >>> log_decoding_CanonLog3_v1(34.338936938868677 / 100) # doctest: +ELLIPSIS 0.1800000... """ clog3 = to_domain_1(clog3) - clog3 = ( - legal_to_full(clog3, bit_depth) if in_normalised_code_value else clog3 - ) + clog3 = legal_to_full(clog3, bit_depth) if in_normalised_code_value else clog3 x = np.select( (clog3 < 0.04076162, clog3 <= 0.105357102, clog3 > 0.105357102), @@ -1218,18 +1185,9 @@ def log_encoding_CanonLog3_v1_2( with domain_range_scale("ignore"): clog3 = np.select( ( - x - < log_decoding_CanonLog3_v1_2( - 0.097465473, bit_depth, True, False - ), - x - <= log_decoding_CanonLog3_v1_2( - 0.15277891, bit_depth, True, False - ), - x - > log_decoding_CanonLog3_v1_2( - 0.15277891, bit_depth, True, False - ), + x < log_decoding_CanonLog3_v1_2(0.097465473, bit_depth, True, False), + x <= log_decoding_CanonLog3_v1_2(0.15277891, bit_depth, True, False), + x > log_decoding_CanonLog3_v1_2(0.15277891, bit_depth, True, False), ), ( -0.36726845 * np.log10(-x * 14.98325 + 1) + 0.12783901, @@ -1240,9 +1198,7 @@ def log_encoding_CanonLog3_v1_2( # NOTE: *Canon Log 3* v1.2 constants are expressed in legal range # (studio swing). - clog3_cv = ( - clog3 if out_normalised_code_value else legal_to_full(clog3, bit_depth) - ) + clog3_cv = clog3 if out_normalised_code_value else legal_to_full(clog3, bit_depth) return as_float(from_range_1(clog3_cv)) @@ -1303,9 +1259,7 @@ def log_decoding_CanonLog3_v1_2( # NOTE: *Canon Log 3* v1.2 constants are expressed in legal range # (studio swing). - clog3 = ( - clog3 if in_normalised_code_value else full_to_legal(clog3, bit_depth) - ) + clog3 = clog3 if in_normalised_code_value else full_to_legal(clog3, bit_depth) x = np.select( (clog3 < 0.097465473, clog3 <= 0.15277891, clog3 > 0.15277891), diff --git a/colour/models/rgb/transfer_functions/cineon.py b/colour/models/rgb/transfer_functions/cineon.py index f7e5123d80..db81e5f4b4 100644 --- a/colour/models/rgb/transfer_functions/cineon.py +++ b/colour/models/rgb/transfer_functions/cineon.py @@ -2,7 +2,7 @@ Kodak Cineon Encoding ===================== -Defines the *Kodak Cineon* encoding: +Define the *Kodak Cineon* encoding: - :func:`colour.models.log_encoding_Cineon` - :func:`colour.models.log_decoding_Cineon` diff --git a/colour/models/rgb/transfer_functions/common.py b/colour/models/rgb/transfer_functions/common.py index 2aedcc85af..a209a30a35 100644 --- a/colour/models/rgb/transfer_functions/common.py +++ b/colour/models/rgb/transfer_functions/common.py @@ -2,7 +2,7 @@ Common Transfer Functions Utilities =================================== -Defines various transfer functions common utilities. +Define various transfer functions common utilities. """ from __future__ import annotations diff --git a/colour/models/rgb/transfer_functions/davinci_intermediate.py b/colour/models/rgb/transfer_functions/davinci_intermediate.py index d90a65a905..5f8592069f 100644 --- a/colour/models/rgb/transfer_functions/davinci_intermediate.py +++ b/colour/models/rgb/transfer_functions/davinci_intermediate.py @@ -2,7 +2,7 @@ DaVinci Intermediate ==================== -Defines the *DaVinci Intermediate* opto-electrical transfer function +Define the *DaVinci Intermediate* opto-electrical transfer function (OETF) and its inverse: - :func:`colour.models.oetf_DaVinciIntermediate` diff --git a/colour/models/rgb/transfer_functions/dcdm.py b/colour/models/rgb/transfer_functions/dcdm.py index efd51935cd..2d10b4d314 100644 --- a/colour/models/rgb/transfer_functions/dcdm.py +++ b/colour/models/rgb/transfer_functions/dcdm.py @@ -2,7 +2,7 @@ Digital Cinema Distribution Master (DCDM) ========================================= -Defines the *DCDM* electro-optical transfer function (EOTF) and its +Define the *DCDM* electro-optical transfer function (EOTF) and its inverse: - :func:`colour.models.eotf_inverse_DCDM` diff --git a/colour/models/rgb/transfer_functions/dicom_gsdf.py b/colour/models/rgb/transfer_functions/dicom_gsdf.py index d102ec3df9..9c93d8312c 100644 --- a/colour/models/rgb/transfer_functions/dicom_gsdf.py +++ b/colour/models/rgb/transfer_functions/dicom_gsdf.py @@ -2,7 +2,7 @@ DICOM - Grayscale Standard Display Function =========================================== -Defines the *DICOM - Grayscale Standard Display Function* electro-optical +Define the *DICOM - Grayscale Standard Display Function* electro-optical transfer function (EOTF) and its inverse: - :func:`colour.models.eotf_inverse_DICOMGSDF` diff --git a/colour/models/rgb/transfer_functions/dji_d_log.py b/colour/models/rgb/transfer_functions/dji_d_log.py index 04870fe4a5..d1add186a3 100644 --- a/colour/models/rgb/transfer_functions/dji_d_log.py +++ b/colour/models/rgb/transfer_functions/dji_d_log.py @@ -2,7 +2,7 @@ DJI D-Log Log Encoding ====================== -Defines the *DJI D-Log* log encoding: +Define the *DJI D-Log* log encoding: - :func:`colour.models.log_encoding_DJIDLog` - :func:`colour.models.log_decoding_DJIDLog` diff --git a/colour/models/rgb/transfer_functions/exponent.py b/colour/models/rgb/transfer_functions/exponent.py index 61f7ed5b37..3f3744830c 100644 --- a/colour/models/rgb/transfer_functions/exponent.py +++ b/colour/models/rgb/transfer_functions/exponent.py @@ -2,7 +2,7 @@ Basic and Monitor-Curve Exponent Transfer Functions =================================================== -Defines the exponent transfer functions: +Define the exponent transfer functions: - :func:`colour.models.exponent_function_basic` - :func:`colour.models.exponent_function_monitor_curve` @@ -43,15 +43,17 @@ def exponent_function_basic( x: ArrayLike, exponent: ArrayLike = 1, - style: Literal[ - "basicFwd", - "basicRev", - "basicMirrorFwd", - "basicMirrorRev", - "basicPassThruFwd", - "basicPassThruRev", - ] - | str = "basicFwd", + style: ( + Literal[ + "basicFwd", + "basicRev", + "basicMirrorFwd", + "basicMirrorRev", + "basicPassThruFwd", + "basicPassThruRev", + ] + | str + ) = "basicFwd", ) -> NDArrayFloat: """ Define the *basic* exponent transfer function. @@ -74,12 +76,12 @@ def exponent_function_basic( - *basicMirrorFwd*: *Basic Mirror Forward* exponential behaviour where the definition applies a basic power law using the exponent for values greater than or equal to zero and mirrors the function - for values less than zero (i.e. rotationally symmetric + for values less than zero (i.e., rotationally symmetric around the origin). - *basicMirrorRev*: *Basic Mirror Reverse* exponential behaviour where the definition applies a basic power law using the exponent for values greater than or equal to zero and mirrors the function - for values less than zero (i.e. rotationally symmetric around the + for values less than zero (i.e., rotationally symmetric around the origin). - *basicPassThruFwd*: *Basic Pass Forward* exponential behaviour where the definition applies a basic power law using the exponent @@ -190,10 +192,15 @@ def exponent_function_monitor_curve( x: ArrayLike, exponent: ArrayLike = 1, offset: ArrayLike = 0, - style: Literal[ - "monCurveFwd", "monCurveRev", "monCurveMirrorFwd", "monCurveMirrorRev" - ] - | str = "monCurveFwd", + style: ( + Literal[ + "monCurveFwd", + "monCurveRev", + "monCurveMirrorFwd", + "monCurveMirrorRev", + ] + | str + ) = "monCurveFwd", ) -> NDArrayFloat: """ Define the *Monitor Curve* exponent transfer function. @@ -218,11 +225,11 @@ def exponent_function_monitor_curve( - *monCurveMirrorFwd*: *Monitor Curve Mirror Forward* exponential behaviour where the definition applies a power law function with a linear segment near the origin and mirrors the function for values - less than zero (i.e. rotationally symmetric around the origin). + less than zero (i.e., rotationally symmetric around the origin). - *monCurveMirrorRev*: *Monitor Curve Mirror Reverse* exponential behaviour where the definition applies a power law function with a linear segment near the origin and mirrors the function for values - less than zero (i.e. rotationally symmetric around the origin). + less than zero (i.e., rotationally symmetric around the origin). Returns ------- @@ -280,8 +287,7 @@ def exponent_function_monitor_curve( with sdiv_mode(): s = as_float_array( sdiv(exponent - 1, offset) - * sdiv(exponent * offset, (exponent - 1) * (offset + 1)) - ** exponent + * sdiv(exponent * offset, (exponent - 1) * (offset + 1)) ** exponent ) def monitor_curve_forward( @@ -294,9 +300,7 @@ def monitor_curve_forward( y = as_float_array(x * s) - y[x >= x_break] = ( - (x[x >= x_break] + offset) / (1 + offset) - ) ** exponent + y[x >= x_break] = ((x[x >= x_break] + offset) / (1 + offset)) ** exponent return y @@ -312,9 +316,7 @@ def monitor_curve_reverse( x = as_float_array(y / s) - x[y >= y_break] = ( - (1 + offset) * (y[y >= y_break] ** (1 / exponent)) - ) - offset + x[y >= y_break] = ((1 + offset) * (y[y >= y_break] ** (1 / exponent))) - offset return x diff --git a/colour/models/rgb/transfer_functions/filmic_pro.py b/colour/models/rgb/transfer_functions/filmic_pro.py index 727b18ebda..8f9df6c718 100644 --- a/colour/models/rgb/transfer_functions/filmic_pro.py +++ b/colour/models/rgb/transfer_functions/filmic_pro.py @@ -2,7 +2,7 @@ FiLMiC Pro 6 Encoding ===================== -Defines the *FiLMiC Pro 6* encoding: +Define the *FiLMiC Pro 6* encoding: - :func:`colour.models.log_encoding_FilmicPro6` - :func:`colour.models.log_decoding_FilmicPro6` diff --git a/colour/models/rgb/transfer_functions/filmlight_t_log.py b/colour/models/rgb/transfer_functions/filmlight_t_log.py index 3f6fa3497b..13da6b24e1 100644 --- a/colour/models/rgb/transfer_functions/filmlight_t_log.py +++ b/colour/models/rgb/transfer_functions/filmlight_t_log.py @@ -2,7 +2,7 @@ FilmLight T-Log Log Encoding ============================ -Defines the *FilmLight T-Log* log encoding: +Define the *FilmLight T-Log* log encoding: - :func:`colour.models.log_encoding_FilmLightTLog` - :func:`colour.models.log_decoding_FilmLightTLog` diff --git a/colour/models/rgb/transfer_functions/fujifilm_f_log.py b/colour/models/rgb/transfer_functions/fujifilm_f_log.py index 1f6b39271a..7cdbf1f229 100644 --- a/colour/models/rgb/transfer_functions/fujifilm_f_log.py +++ b/colour/models/rgb/transfer_functions/fujifilm_f_log.py @@ -2,7 +2,7 @@ Fujifilm F-Log Log Encoding =========================== -Defines the *Fujifilm F-Log* log encoding: +Define the *Fujifilm F-Log* log encoding: - :func:`colour.models.log_encoding_FLog` - :func:`colour.models.log_decoding_FLog` @@ -148,9 +148,7 @@ def log_encoding_FLog( c * np.log10(a * in_r + b) + d, ) - out_r_cv = ( - out_r if out_normalised_code_value else legal_to_full(out_r, bit_depth) - ) + out_r_cv = out_r if out_normalised_code_value else legal_to_full(out_r, bit_depth) return as_float(from_range_1(out_r_cv)) @@ -211,9 +209,7 @@ def log_decoding_FLog( out_r = to_domain_1(out_r) - out_r = ( - out_r if in_normalised_code_value else full_to_legal(out_r, bit_depth) - ) + out_r = out_r if in_normalised_code_value else full_to_legal(out_r, bit_depth) cut2 = constants.cut2 a = constants.a diff --git a/colour/models/rgb/transfer_functions/gamma.py b/colour/models/rgb/transfer_functions/gamma.py index d330eefa16..74c47e4550 100644 --- a/colour/models/rgb/transfer_functions/gamma.py +++ b/colour/models/rgb/transfer_functions/gamma.py @@ -2,7 +2,7 @@ Gamma Colour Component Transfer Function ======================================== -Defines the gamma encoding / decoding colour component transfer function +Define the gamma encoding / decoding colour component transfer function related objects: - :func:`colour.gamma_function` @@ -31,10 +31,9 @@ def gamma_function( a: ArrayLike, exponent: ArrayLike = 1, - negative_number_handling: Literal[ - "Clamp", "Indeterminate", "Mirror", "Preserve" - ] - | str = "Indeterminate", + negative_number_handling: ( + Literal["Clamp", "Indeterminate", "Mirror", "Preserve"] | str + ) = "Indeterminate", ) -> NDArrayFloat: """ Define a typical gamma encoding / decoding function. @@ -52,10 +51,10 @@ def gamma_function( - *Indeterminate*: The behaviour will be indeterminate and definition return value might contain *nans*. - *Mirror*: The definition return value will be mirrored around - abscissa and ordinate axis, i.e. Blackmagic Design: Davinci Resolve + abscissa and ordinate axis, i.e., Blackmagic Design: Davinci Resolve behaviour. - *Preserve*: The definition will preserve any negative number in - ``a``, i.e. The Foundry Nuke behaviour. + ``a``, i.e., The Foundry Nuke behaviour. - *Clamp*: The definition will clamp any negative number in ``a`` to 0. diff --git a/colour/models/rgb/transfer_functions/gopro.py b/colour/models/rgb/transfer_functions/gopro.py index b7f0a7e074..5dd4db73f1 100644 --- a/colour/models/rgb/transfer_functions/gopro.py +++ b/colour/models/rgb/transfer_functions/gopro.py @@ -2,7 +2,7 @@ GoPro Encoding ============== -Defines the *GoPro* *Protune* encoding: +Define the *GoPro* *Protune* encoding: - :func:`colour.models.log_encoding_Protune` - :func:`colour.models.log_decoding_Protune` diff --git a/colour/models/rgb/transfer_functions/itur_bt_1361.py b/colour/models/rgb/transfer_functions/itur_bt_1361.py index 442d845e39..fb4f2adf08 100644 --- a/colour/models/rgb/transfer_functions/itur_bt_1361.py +++ b/colour/models/rgb/transfer_functions/itur_bt_1361.py @@ -2,7 +2,7 @@ Recommendation ITU-R BT.1361 ============================ -Defines the *Recommendation ITU-R BT.1361* opto-electrical transfer function +Define the *Recommendation ITU-R BT.1361* opto-electrical transfer function (OETF) and its inverse: - :func:`colour.models.oetf_BT1361` @@ -91,7 +91,7 @@ def oetf_BT1361(L): L >= 0, oetf_BT709(L), np.where( - -0.0045 >= L, + L <= -0.0045, # L in [-0.25, -0.0045] range -(1.099 * spow(-4 * L, 0.45) - 0.099) / 4, # L in [-0.0045, 0] range diff --git a/colour/models/rgb/transfer_functions/itur_bt_1886.py b/colour/models/rgb/transfer_functions/itur_bt_1886.py index c6e4e404b8..8011c0dd96 100644 --- a/colour/models/rgb/transfer_functions/itur_bt_1886.py +++ b/colour/models/rgb/transfer_functions/itur_bt_1886.py @@ -2,7 +2,7 @@ Recommendation ITU-R BT.1886 ============================ -Defines the *Recommendation ITU-R BT.1886* electro-optical transfer function +Define the *Recommendation ITU-R BT.1886* electro-optical transfer function (EOTF) and its inverse: - :func:`colour.models.eotf_inverse_BT1886` @@ -22,6 +22,7 @@ import numpy as np +from colour.algebra import spow from colour.hints import ArrayLike, NDArrayFloat from colour.utilities import as_float, from_range_1, to_domain_1 @@ -38,9 +39,7 @@ ] -def eotf_inverse_BT1886( - L: ArrayLike, L_B: float = 0, L_W: float = 1 -) -> NDArrayFloat: +def eotf_inverse_BT1886(L: ArrayLike, L_B: float = 0, L_W: float = 1) -> NDArrayFloat: """ Define *Recommendation ITU-R BT.1886* inverse electro-optical transfer function (EOTF). @@ -93,7 +92,7 @@ def eotf_inverse_BT1886( a = n**gamma b = L_B**gamma_d / n - V = (L / a) ** gamma_d - b + V = spow(L / a, gamma_d) - b return as_float(from_range_1(V)) @@ -153,6 +152,6 @@ def eotf_BT1886(V: ArrayLike, L_B: float = 0, L_W: float = 1) -> NDArrayFloat: n = L_W**gamma_d - L_B**gamma_d a = n**gamma b = L_B**gamma_d / n - L = a * np.maximum(V + b, 0) ** gamma + L = a * spow(np.maximum(V + b, 0), gamma) return as_float(from_range_1(L)) diff --git a/colour/models/rgb/transfer_functions/itur_bt_2020.py b/colour/models/rgb/transfer_functions/itur_bt_2020.py index 7055fdc6e1..d33ec8f649 100644 --- a/colour/models/rgb/transfer_functions/itur_bt_2020.py +++ b/colour/models/rgb/transfer_functions/itur_bt_2020.py @@ -2,7 +2,7 @@ Recommendation ITU-R BT.2020 ============================ -Defines the *Recommendation ITU-R BT.2020* opto-electrical transfer function +Define the *Recommendation ITU-R BT.2020* opto-electrical transfer function (OETF) and its inverse: - :func:`colour.models.oetf_BT2020` diff --git a/colour/models/rgb/transfer_functions/itur_bt_2100.py b/colour/models/rgb/transfer_functions/itur_bt_2100.py index e939cac4fa..6dabeeeb55 100644 --- a/colour/models/rgb/transfer_functions/itur_bt_2100.py +++ b/colour/models/rgb/transfer_functions/itur_bt_2100.py @@ -2,7 +2,7 @@ Recommendation ITU-R BT.2100 ============================ -Defines the *Recommendation ITU-R BT.2100* opto-electrical transfer functions +Define the *Recommendation ITU-R BT.2100* opto-electrical transfer functions (OETF), opto-optical transfer functions (OOTF / OOCF) and electro-optical transfer functions (EOTF) and their inverse: @@ -733,8 +733,7 @@ def eotf_BT2100_HLG_2( beta = black_level_lift_BT2100_HLG(L_B, L_W, gamma) return ootf_BT2100_HLG_2( - oetf_inverse_ARIBSTDB67((1 - beta) * E_p + beta, constants=constants) - / 12, + oetf_inverse_ARIBSTDB67((1 - beta) * E_p + beta, constants=constants) / 12, L_W, gamma, ) @@ -763,8 +762,7 @@ def eotf_BT2100_HLG( L_W: float = 1000, gamma: float | None = None, constants: Structure = CONSTANTS_BT2100_HLG, - method: Literal["ITU-R BT.2100-1", "ITU-R BT.2100-2"] - | str = "ITU-R BT.2100-2", + method: (Literal["ITU-R BT.2100-1", "ITU-R BT.2100-2"] | str) = "ITU-R BT.2100-2", ) -> NDArrayFloat: """ Define *Recommendation ITU-R BT.2100* *Reference HLG* electro-optical @@ -997,8 +995,7 @@ def eotf_inverse_BT2100_HLG( L_W: float = 1000, gamma: float | None = None, constants: Structure = CONSTANTS_BT2100_HLG, - method: Literal["ITU-R BT.2100-1", "ITU-R BT.2100-2"] - | str = "ITU-R BT.2100-2", + method: (Literal["ITU-R BT.2100-1", "ITU-R BT.2100-2"] | str) = "ITU-R BT.2100-2", ) -> NDArrayFloat: """ Define *Recommendation ITU-R BT.2100* *Reference HLG* inverse @@ -1061,9 +1058,7 @@ def eotf_inverse_BT2100_HLG( method = validate_method(method, tuple(BT2100_HLG_EOTF_INVERSE_METHODS)) - return BT2100_HLG_EOTF_INVERSE_METHODS[method]( - F_D, L_B, L_W, gamma, constants - ) + return BT2100_HLG_EOTF_INVERSE_METHODS[method](F_D, L_B, L_W, gamma, constants) def ootf_BT2100_HLG_1( @@ -1269,8 +1264,7 @@ def ootf_BT2100_HLG( L_B: float = 0, L_W: float = 1000, gamma: float | None = None, - method: Literal["ITU-R BT.2100-1", "ITU-R BT.2100-2"] - | str = "ITU-R BT.2100-2", + method: (Literal["ITU-R BT.2100-1", "ITU-R BT.2100-2"] | str) = "ITU-R BT.2100-2", ) -> NDArrayFloat: """ Define *Recommendation ITU-R BT.2100* *Reference HLG* opto-optical @@ -1565,8 +1559,7 @@ def ootf_inverse_BT2100_HLG( L_B: float = 0, L_W: float = 1000, gamma: float | None = None, - method: Literal["ITU-R BT.2100-1", "ITU-R BT.2100-2"] - | str = "ITU-R BT.2100-2", + method: (Literal["ITU-R BT.2100-1", "ITU-R BT.2100-2"] | str) = "ITU-R BT.2100-2", ) -> NDArrayFloat: """ Define *Recommendation ITU-R BT.2100* *Reference HLG* inverse opto-optical @@ -1618,9 +1611,7 @@ def ootf_inverse_BT2100_HLG( -------- >>> ootf_inverse_BT2100_HLG(63.095734448019336) # doctest: +ELLIPSIS 0.1000000... - >>> ootf_inverse_BT2100_HLG( - ... 63.105103490674857, 0.01, method="ITU-R BT.2100-1" - ... ) + >>> ootf_inverse_BT2100_HLG(63.105103490674857, 0.01, method="ITU-R BT.2100-1") ... # doctest: +ELLIPSIS 0.0999999... """ diff --git a/colour/models/rgb/transfer_functions/itur_bt_601.py b/colour/models/rgb/transfer_functions/itur_bt_601.py index ea022d4f17..f64f24a879 100644 --- a/colour/models/rgb/transfer_functions/itur_bt_601.py +++ b/colour/models/rgb/transfer_functions/itur_bt_601.py @@ -2,7 +2,7 @@ Recommendation ITU-R BT.601-7 ============================= -Defines the *Recommendation ITU-R BT.601-7* opto-electrical transfer function +Define the *Recommendation ITU-R BT.601-7* opto-electrical transfer function (OETF) and its inverse: - :func:`colour.models.oetf_BT601` diff --git a/colour/models/rgb/transfer_functions/itur_bt_709.py b/colour/models/rgb/transfer_functions/itur_bt_709.py index 817a403a55..e5fd8b86cb 100644 --- a/colour/models/rgb/transfer_functions/itur_bt_709.py +++ b/colour/models/rgb/transfer_functions/itur_bt_709.py @@ -2,7 +2,7 @@ Recommendation ITU-R BT.709-6 ============================= -Defines the *Recommendation ITU-R BT.709-6* opto-electrical transfer function +Define the *Recommendation ITU-R BT.709-6* opto-electrical transfer function (OETF) and its inverse: - :func:`colour.models.oetf_BT709` diff --git a/colour/models/rgb/transfer_functions/itut_h_273.py b/colour/models/rgb/transfer_functions/itut_h_273.py index ef6d2cbf58..e2a10e450a 100644 --- a/colour/models/rgb/transfer_functions/itut_h_273.py +++ b/colour/models/rgb/transfer_functions/itut_h_273.py @@ -2,7 +2,7 @@ Recommendation ITU-T H.273 Transfer Characteristics =================================================== -Defines the *Recommendation ITU-T H.273* transfer functions that do not belong +Define the *Recommendation ITU-T H.273* transfer functions that do not belong in another specification or standard, or have been modified for inclusion: - :func:`colour.models.oetf_H273_Log` diff --git a/colour/models/rgb/transfer_functions/leica_l_log.py b/colour/models/rgb/transfer_functions/leica_l_log.py index 7989568105..1322f3f51b 100644 --- a/colour/models/rgb/transfer_functions/leica_l_log.py +++ b/colour/models/rgb/transfer_functions/leica_l_log.py @@ -2,7 +2,7 @@ Leica L-Log Log Encoding ======================== -Defines the *Leica L-Log* log encoding: +Define the *Leica L-Log* log encoding: - :func:`colour.models.log_encoding_LLog` - :func:`colour.models.log_decoding_LLog` @@ -122,9 +122,7 @@ def log_encoding_LLog( c * np.log10(d * LSR + e) + f, ) - LLog_cv = ( - LLog if out_normalised_code_value else legal_to_full(LLog, bit_depth) - ) + LLog_cv = LLog if out_normalised_code_value else legal_to_full(LLog, bit_depth) return as_float(from_range_1(LLog_cv)) diff --git a/colour/models/rgb/transfer_functions/linear.py b/colour/models/rgb/transfer_functions/linear.py index 3bc829a673..16d3791e48 100644 --- a/colour/models/rgb/transfer_functions/linear.py +++ b/colour/models/rgb/transfer_functions/linear.py @@ -2,7 +2,7 @@ Linear Colour Component Transfer Function ========================================= -Defines the linear encoding / decoding colour component transfer function +Define the linear encoding / decoding colour component transfer function related objects: - :func:`colour.linear_function` diff --git a/colour/models/rgb/transfer_functions/log.py b/colour/models/rgb/transfer_functions/log.py index d90f41fd5e..bb9c557cd1 100644 --- a/colour/models/rgb/transfer_functions/log.py +++ b/colour/models/rgb/transfer_functions/log.py @@ -2,7 +2,7 @@ Common Log Encodings ==================== -Defines the common log encodings: +Define the common log encodings: - :func:`colour.models.logarithmic_function_basic` - :func:`colour.models.logarithmic_function_quasilog` @@ -76,10 +76,9 @@ def logarithmic_function_basic( x: ArrayLike, - style: Literal[ - "log10", "antiLog10", "log2", "antiLog2", "logB", "antiLogB" - ] - | str = "log2", + style: ( + Literal["log10", "antiLog10", "log2", "antiLog2", "logB", "antiLogB"] | str + ) = "log2", base: int = 2, ) -> NDArrayFloat: """ @@ -216,9 +215,7 @@ def logarithmic_function_quasilog( y = ( log_side_slope * ( - np.log( - np.maximum(lin_side_slope * x + lin_side_offset, FLT_MIN) - ) + np.log(np.maximum(lin_side_slope * x + lin_side_offset, FLT_MIN)) / np.log(base) ) + log_side_offset @@ -226,8 +223,7 @@ def logarithmic_function_quasilog( else: # style == 'logtolin' with sdiv_mode(): y = sdiv( - base ** sdiv(x - log_side_offset, log_side_slope) - - lin_side_offset, + base ** sdiv(x - log_side_offset, log_side_slope) - lin_side_offset, lin_side_slope, ) @@ -236,8 +232,7 @@ def logarithmic_function_quasilog( def logarithmic_function_camera( x: ArrayLike, - style: Literal["cameraLinToLog", "cameraLogToLin"] - | str = "cameraLinToLog", + style: (Literal["cameraLinToLog", "cameraLogToLin"] | str) = "cameraLinToLog", base: int = 2, log_side_slope: float = 1, lin_side_slope: float = 1, @@ -308,10 +303,7 @@ def logarithmic_function_camera( log_side_break = ( log_side_slope - * ( - np.log(lin_side_slope * lin_side_break + lin_side_offset) - / np.log(base) - ) + * (np.log(lin_side_slope * lin_side_break + lin_side_offset) / np.log(base)) + log_side_offset ) diff --git a/colour/models/rgb/transfer_functions/nikon_n_log.py b/colour/models/rgb/transfer_functions/nikon_n_log.py index 031ba765bb..833456e2cf 100644 --- a/colour/models/rgb/transfer_functions/nikon_n_log.py +++ b/colour/models/rgb/transfer_functions/nikon_n_log.py @@ -2,7 +2,7 @@ Nikon N-Log Log Encoding ======================== -Defines the *Nikon N-Log* log encoding: +Define the *Nikon N-Log* log encoding: - :func:`colour.models.log_encoding_NLog` - :func:`colour.models.log_decoding_NLog` diff --git a/colour/models/rgb/transfer_functions/panalog.py b/colour/models/rgb/transfer_functions/panalog.py index c85f39212f..3da6ad0597 100644 --- a/colour/models/rgb/transfer_functions/panalog.py +++ b/colour/models/rgb/transfer_functions/panalog.py @@ -2,7 +2,7 @@ Panalog Encoding ================ -Defines the *Panalog* encoding: +Define the *Panalog* encoding: - :func:`colour.models.log_encoding_Panalog` - :func:`colour.models.log_decoding_Panalog` diff --git a/colour/models/rgb/transfer_functions/panasonic_v_log.py b/colour/models/rgb/transfer_functions/panasonic_v_log.py index 1050bc1f45..255a7f6ada 100644 --- a/colour/models/rgb/transfer_functions/panasonic_v_log.py +++ b/colour/models/rgb/transfer_functions/panasonic_v_log.py @@ -2,7 +2,7 @@ Panasonic V-Log Log Encoding ============================ -Defines the *Panasonic V-Log* log encoding: +Define the *Panasonic V-Log* log encoding: - :func:`colour.models.log_encoding_VLog` - :func:`colour.models.log_decoding_VLog` @@ -126,9 +126,7 @@ def log_encoding_VLog( c * np.log10(L_in + b) + d, ) - V_out_cv = ( - V_out if out_normalised_code_value else legal_to_full(V_out, bit_depth) - ) + V_out_cv = V_out if out_normalised_code_value else legal_to_full(V_out, bit_depth) return as_float(from_range_1(V_out_cv)) @@ -189,9 +187,7 @@ def log_decoding_VLog( V_out = to_domain_1(V_out) - V_out = ( - V_out if in_normalised_code_value else full_to_legal(V_out, bit_depth) - ) + V_out = V_out if in_normalised_code_value else full_to_legal(V_out, bit_depth) cut2 = constants.cut2 b = constants.b diff --git a/colour/models/rgb/transfer_functions/pivoted_log.py b/colour/models/rgb/transfer_functions/pivoted_log.py index 37e661d114..054676986a 100644 --- a/colour/models/rgb/transfer_functions/pivoted_log.py +++ b/colour/models/rgb/transfer_functions/pivoted_log.py @@ -2,7 +2,7 @@ Pivoted Log Encoding ==================== -Defines the *Pivoted Log* encoding: +Define the *Pivoted Log* encoding: - :func:`colour.models.log_encoding_PivotedLog` - :func:`colour.models.log_decoding_PivotedLog` @@ -92,8 +92,7 @@ def log_encoding_PivotedLog( y = ( log_reference - + np.log10(x / linear_reference) - / (density_per_code_value / negative_gamma) + + np.log10(x / linear_reference) / (density_per_code_value / negative_gamma) ) / 1023 return as_float(from_range_1(y)) @@ -155,11 +154,7 @@ def log_decoding_PivotedLog( y = to_domain_1(y) x = ( - 10 - ** ( - (y * 1023 - log_reference) - * (density_per_code_value / negative_gamma) - ) + 10 ** ((y * 1023 - log_reference) * (density_per_code_value / negative_gamma)) * linear_reference ) diff --git a/colour/models/rgb/transfer_functions/red.py b/colour/models/rgb/transfer_functions/red.py index c0a857634b..7369f0d9da 100644 --- a/colour/models/rgb/transfer_functions/red.py +++ b/colour/models/rgb/transfer_functions/red.py @@ -2,7 +2,7 @@ RED Log Encodings ================= -Defines the *RED* log encodings: +Define the *RED* log encodings: - :func:`colour.models.log_encoding_REDLog` - :func:`colour.models.log_decoding_REDLog` @@ -410,11 +410,7 @@ def log_encoding_Log3G10_v2(x: ArrayLike) -> NDArrayFloat: x = to_domain_1(x) - y = ( - np.sign(x + 0.01) - * 0.224282 - * np.log10((np.abs(x + 0.01) * 155.975327) + 1) - ) + y = np.sign(x + 0.01) * 0.224282 * np.log10((np.abs(x + 0.01) * 155.975327) + 1) return as_float(from_range_1(y)) @@ -513,9 +509,7 @@ def log_encoding_Log3G10_v3(x: ArrayLike) -> NDArrayFloat: x = x + c - y = np.where( - x < 0.0, x * g, np.sign(x) * a * np.log10((np.abs(x) * b) + 1.0) - ) + y = np.where(x < 0.0, x * g, np.sign(x) * a * np.log10((np.abs(x) * b) + 1.0)) return as_float(from_range_1(y)) diff --git a/colour/models/rgb/transfer_functions/rimm_romm_rgb.py b/colour/models/rgb/transfer_functions/rimm_romm_rgb.py index 77fd1eaf67..d699d32e38 100644 --- a/colour/models/rgb/transfer_functions/rimm_romm_rgb.py +++ b/colour/models/rgb/transfer_functions/rimm_romm_rgb.py @@ -2,7 +2,7 @@ RIMM, ROMM and ERIMM Encodings ============================== -Defines the *RIMM, ROMM and ERIMM* encodings opto-electrical transfer functions +Define the *RIMM, ROMM and ERIMM* encodings opto-electrical transfer functions (OETF) and electro-optical transfer functions (EOTF): - :func:`colour.models.cctf_encoding_ROMMRGB` @@ -199,20 +199,16 @@ def cctf_decoding_ROMMRGB( ) # If-clause required for optimised python launch. if cctf_encoding_ProPhotoRGB.__doc__ is not None: - cctf_encoding_ProPhotoRGB.__doc__ = ( - cctf_encoding_ProPhotoRGB.__doc__.replace( - "*ROMM RGB*", "*ProPhoto RGB*" - ) + cctf_encoding_ProPhotoRGB.__doc__ = cctf_encoding_ProPhotoRGB.__doc__.replace( + "*ROMM RGB*", "*ProPhoto RGB*" ) cctf_decoding_ProPhotoRGB = copy_definition( cctf_decoding_ROMMRGB, "cctf_decoding_ProPhotoRGB" ) # If-clause required for optimised python launch. if cctf_decoding_ProPhotoRGB.__doc__ is not None: - cctf_decoding_ProPhotoRGB.__doc__ = ( - cctf_decoding_ProPhotoRGB.__doc__.replace( - "*ROMM RGB*", "*ProPhoto RGB*" - ) + cctf_decoding_ProPhotoRGB.__doc__ = cctf_decoding_ProPhotoRGB.__doc__.replace( + "*ROMM RGB*", "*ProPhoto RGB*" ) @@ -362,8 +358,7 @@ def cctf_decoding_RIMMRGB( with domain_range_scale("ignore"): X = np.where( - X_p / I_max - < cctf_encoding_RIMMRGB(0.018, bit_depth, E_clip=E_clip), + X_p / I_max < cctf_encoding_RIMMRGB(0.018, bit_depth, E_clip=E_clip), m / 4.5, spow((m + 0.099) / 1.099, 1 / 0.45), ) diff --git a/colour/models/rgb/transfer_functions/smpte_240m.py b/colour/models/rgb/transfer_functions/smpte_240m.py index 67ba7ee138..86cbc0a960 100644 --- a/colour/models/rgb/transfer_functions/smpte_240m.py +++ b/colour/models/rgb/transfer_functions/smpte_240m.py @@ -2,7 +2,7 @@ SMPTE 240M ========== -Defines the *SMPTE 240M* opto-electrical transfer function (OETF) and +Define the *SMPTE 240M* opto-electrical transfer function (OETF) and electro-optical transfer function (EOTF): - :func:`colour.models.oetf_SMPTE240M` diff --git a/colour/models/rgb/transfer_functions/sony.py b/colour/models/rgb/transfer_functions/sony.py index 4324cdea43..876d315c5b 100644 --- a/colour/models/rgb/transfer_functions/sony.py +++ b/colour/models/rgb/transfer_functions/sony.py @@ -2,7 +2,7 @@ Sony Encodings ============== -Defines the *Sony* log encodings: +Define the *Sony* log encodings: - :func:`colour.models.log_encoding_SLog` - :func:`colour.models.log_decoding_SLog` @@ -324,9 +324,7 @@ def log_decoding_SLog2( return ( 219 - * log_decoding_SLog( - y, bit_depth, in_normalised_code_value, out_reflection - ) + * log_decoding_SLog(y, bit_depth, in_normalised_code_value, out_reflection) / 155 ) diff --git a/colour/models/rgb/transfer_functions/srgb.py b/colour/models/rgb/transfer_functions/srgb.py index 31ab9e5205..76db90d0f5 100644 --- a/colour/models/rgb/transfer_functions/srgb.py +++ b/colour/models/rgb/transfer_functions/srgb.py @@ -2,7 +2,7 @@ SRGB ==== -Defines the *sRGB* electro-optical transfer function (EOTF) and its +Define the *sRGB* electro-optical transfer function (EOTF) and its inverse: - :func:`colour.models.eotf_inverse_sRGB` diff --git a/colour/models/rgb/transfer_functions/st_2084.py b/colour/models/rgb/transfer_functions/st_2084.py index e82710c1f3..4c82973834 100644 --- a/colour/models/rgb/transfer_functions/st_2084.py +++ b/colour/models/rgb/transfer_functions/st_2084.py @@ -2,7 +2,7 @@ SMPTE ST 2084:2014 ================== -Defines the *SMPTE ST 2084:2014* electro-optical transfer function (EOTF) and +Define the *SMPTE ST 2084:2014* electro-optical transfer function (EOTF) and its inverse: - :func:`colour.models.eotf_inverse_ST2084` diff --git a/colour/models/rgb/transfer_functions/tests/test__init__.py b/colour/models/rgb/transfer_functions/tests/test__init__.py index e17efcfa9b..ff9b2d27b1 100644 --- a/colour/models/rgb/transfer_functions/tests/test__init__.py +++ b/colour/models/rgb/transfer_functions/tests/test__init__.py @@ -3,9 +3,9 @@ :mod:`colour.models.rgb.transfer_functions.common` module. """ -import unittest import numpy as np +import pytest from colour.constants import TOLERANCE_ABSOLUTE_TESTS from colour.models.rgb.transfer_functions import ( @@ -38,7 +38,7 @@ ] -class TestCctfEncoding(unittest.TestCase): +class TestCctfEncoding: """ Define :func:`colour.models.rgb.transfer_functions.cctf_encoding` definition unit tests methods. @@ -50,13 +50,13 @@ def test_raise_exception_cctf_encoding(self): log_encoding_ACESproxy` definition raised exception. """ - self.assertWarns( + pytest.warns( ColourUsageWarning, cctf_encoding, 0.18, function="ITU-R BT.2100 HLG", ) - self.assertWarns( + pytest.warns( ColourUsageWarning, cctf_encoding, 0.18, @@ -64,7 +64,7 @@ def test_raise_exception_cctf_encoding(self): ) -class TestCctfDecoding(unittest.TestCase): +class TestCctfDecoding: """ Define :func:`colour.models.rgb.transfer_functions.cctf_decoding` definition unit tests methods. @@ -76,13 +76,13 @@ def test_raise_exception_cctf_decoding(self): log_encoding_ACESproxy` definition raised exception. """ - self.assertWarns( + pytest.warns( ColourUsageWarning, cctf_decoding, 0.18, function="ITU-R BT.2100 HLG", ) - self.assertWarns( + pytest.warns( ColourUsageWarning, cctf_decoding, 0.18, @@ -90,7 +90,7 @@ def test_raise_exception_cctf_decoding(self): ) -class TestTransferFunctions(unittest.TestCase): +class TestTransferFunctions: """Define the transfer functions unit tests methods.""" def test_transfer_functions(self): @@ -137,7 +137,3 @@ def test_transfer_functions(self): samples_d, atol=tolerance.get(name, TOLERANCE_ABSOLUTE_TESTS), ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_aces.py b/colour/models/rgb/transfer_functions/tests/test_aces.py index 00d7138aa2..5d4da46cd9 100644 --- a/colour/models/rgb/transfer_functions/tests/test_aces.py +++ b/colour/models/rgb/transfer_functions/tests/test_aces.py @@ -3,7 +3,6 @@ module. """ -import unittest import numpy as np @@ -34,7 +33,7 @@ ] -class TestLogEncoding_ACESproxy(unittest.TestCase): +class TestLogEncoding_ACESproxy: """ Define :func:`colour.models.rgb.transfer_functions.aces.\ log_encoding_ACESproxy` @@ -71,7 +70,7 @@ def test_log_encoding_ACESproxy(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(log_encoding_ACESproxy(0.18, out_int=True), 426) + assert log_encoding_ACESproxy(0.18, out_int=True) == 426 def test_n_dimensional_log_encoding_ACESproxy(self): """ @@ -131,12 +130,10 @@ def test_nan_log_encoding_ACESproxy(self): log_encoding_ACESproxy` definition nan support. """ - log_encoding_ACESproxy( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_ACESproxy(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_ACESproxy(unittest.TestCase): +class TestLogDecoding_ACESproxy: """ Define :func:`colour.models.rgb.transfer_functions.aces.\ log_decoding_ACESproxy` @@ -237,12 +234,10 @@ def test_nan_log_decoding_ACESproxy(self): log_decoding_ACESproxy` definition nan support. """ - log_decoding_ACESproxy( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_ACESproxy(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_ACEScc(unittest.TestCase): +class TestLogEncoding_ACEScc: """ Define :func:`colour.models.rgb.transfer_functions.aces.\ log_encoding_ACEScc` definition unit tests methods. @@ -324,12 +319,10 @@ def test_nan_log_encoding_ACEScc(self): log_encoding_ACEScc` definition nan support. """ - log_encoding_ACEScc( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_ACEScc(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_ACEScc(unittest.TestCase): +class TestLogDecoding_ACEScc: """ Define :func:`colour.models.rgb.transfer_functions.aces.\ log_decoding_ACEScc` definition unit tests methods. @@ -411,12 +404,10 @@ def test_nan_log_decoding_ACEScc(self): log_decoding_ACEScc` definition nan support. """ - log_decoding_ACEScc( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_ACEScc(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_ACEScct(unittest.TestCase): +class TestLogEncoding_ACEScct: """ Define :func:`colour.models.rgb.transfer_functions.aces.\ log_encoding_ACEScct` definition unit tests methods. @@ -520,12 +511,10 @@ def test_nan_log_encoding_ACEScct(self): log_encoding_ACEScct` definition nan support. """ - log_encoding_ACEScct( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_ACEScct(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_ACEScct(unittest.TestCase): +class TestLogDecoding_ACEScct: """ Define :func:`colour.models.rgb.transfer_functions.aces.\ log_decoding_ACEScct` definition unit tests methods. @@ -629,10 +618,4 @@ def test_nan_log_decoding_ACEScct(self): log_decoding_ACEScct` definition nan support. """ - log_decoding_ACEScct( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_ACEScct(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_apple_log_profile.py b/colour/models/rgb/transfer_functions/tests/test_apple_log_profile.py index 27d29587b3..fecf6f3807 100644 --- a/colour/models/rgb/transfer_functions/tests/test_apple_log_profile.py +++ b/colour/models/rgb/transfer_functions/tests/test_apple_log_profile.py @@ -3,7 +3,6 @@ apple_log_profile` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestLogEncoding_AppleLogProfile(unittest.TestCase): +class TestLogEncoding_AppleLogProfile: """ Define :func:`colour.models.rgb.transfer_functions.apple_log_profile.\ log_encoding_AppleLogProfile` definition unit tests methods. @@ -39,16 +38,22 @@ def test_log_encoding_AppleLogProfile(self): log_encoding_AppleLogProfile` definition. """ - self.assertAlmostEqual( - log_encoding_AppleLogProfile(0.0), 0.150476452300913, places=7 + np.testing.assert_allclose( + log_encoding_AppleLogProfile(0.0), + 0.150476452300913, + atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertAlmostEqual( - log_encoding_AppleLogProfile(0.18), 0.488272458526868, places=7 + np.testing.assert_allclose( + log_encoding_AppleLogProfile(0.18), + 0.488272458526868, + atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertAlmostEqual( - log_encoding_AppleLogProfile(1.0), 0.694552983055191, places=7 + np.testing.assert_allclose( + log_encoding_AppleLogProfile(1.0), + 0.694552983055191, + atol=TOLERANCE_ABSOLUTE_TESTS, ) def test_n_dimensional_log_encoding_DLog(self): @@ -108,7 +113,7 @@ def test_nan_log_encoding_DLog(self): ) -class TestLogDecoding_AppleLogProfile(unittest.TestCase): +class TestLogDecoding_AppleLogProfile: """ Define :func:`colour.models.rgb.transfer_functions.apple_log_profile.\ log_decoding_AppleLogProfile` definition unit tests methods. @@ -120,16 +125,22 @@ def test_log_decoding_AppleLogProfile(self): log_decoding_AppleLogProfile` definition. """ - self.assertAlmostEqual( - log_decoding_AppleLogProfile(0.150476452300913), 0.0, places=7 + np.testing.assert_allclose( + log_decoding_AppleLogProfile(0.150476452300913), + 0.0, + atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertAlmostEqual( - log_decoding_AppleLogProfile(0.488272458526868), 0.18, places=6 + np.testing.assert_allclose( + log_decoding_AppleLogProfile(0.488272458526868), + 0.18, + atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertAlmostEqual( - log_decoding_AppleLogProfile(0.694552983055191), 1.0, places=6 + np.testing.assert_allclose( + log_decoding_AppleLogProfile(0.694552983055191), + 1.0, + atol=TOLERANCE_ABSOLUTE_TESTS, ) def test_n_dimensional_log_decoding_DLog(self): @@ -187,7 +198,3 @@ def test_nan_log_decoding_DLog(self): log_decoding_AppleLogProfile( np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_arib_std_b67.py b/colour/models/rgb/transfer_functions/tests/test_arib_std_b67.py index 0a0e173756..6eaf8f4eb6 100644 --- a/colour/models/rgb/transfer_functions/tests/test_arib_std_b67.py +++ b/colour/models/rgb/transfer_functions/tests/test_arib_std_b67.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.arib_std_b67` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestOetf_ARIBSTDB67(unittest.TestCase): +class TestOetf_ARIBSTDB67: """ Define :func:`colour.models.rgb.transfer_functions.arib_std_b67.\ oetf_ARIBSTDB67` definition unit tests methods. @@ -118,7 +117,7 @@ def test_nan_oetf_ARIBSTDB67(self): oetf_ARIBSTDB67(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_inverse_ARIBSTDB67(unittest.TestCase): +class TestOetf_inverse_ARIBSTDB67: """ Define :func:`colour.models.rgb.transfer_functions.arib_std_b67.\ oetf_inverse_ARIBSTDB67` definition unit tests methods. @@ -208,10 +207,4 @@ def test_nan_oetf_inverse_ARIBSTDB67(self): oetf_inverse_ARIBSTDB67` definition nan support. """ - oetf_inverse_ARIBSTDB67( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + oetf_inverse_ARIBSTDB67(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_arri.py b/colour/models/rgb/transfer_functions/tests/test_arri.py index cbb02b119d..96e79bbe04 100644 --- a/colour/models/rgb/transfer_functions/tests/test_arri.py +++ b/colour/models/rgb/transfer_functions/tests/test_arri.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.arri` module. """ -import unittest import numpy as np @@ -31,7 +30,7 @@ ] -class TestLogEncoding_ARRILogC3(unittest.TestCase): +class TestLogEncoding_ARRILogC3: """ Define :func:`colour.models.rgb.transfer_functions.arri.\ log_encoding_ARRILogC3` definition unit tests methods. @@ -113,12 +112,10 @@ def test_nan_log_encoding_ARRILogC3(self): log_encoding_ARRILogC3` definition nan support. """ - log_encoding_ARRILogC3( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_ARRILogC3(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_ARRILogC3(unittest.TestCase): +class TestLogDecoding_ARRILogC3: """ Define :func:`colour.models.rgb.transfer_functions.arri.\ log_decoding_ARRILogC3` definition unit tests methods. @@ -200,12 +197,10 @@ def test_nan_log_decoding_ARRILogC3(self): log_decoding_ARRILogC3` definition nan support. """ - log_decoding_ARRILogC3( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_ARRILogC3(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_ARRILogC4(unittest.TestCase): +class TestLogEncoding_ARRILogC4: """ Define :func:`colour.models.rgb.transfer_functions.arri.\ log_encoding_ARRILogC4` definition unit tests methods. @@ -287,12 +282,10 @@ def test_nan_log_encoding_ARRILogC4(self): log_encoding_ARRILogC4` definition nan support. """ - log_encoding_ARRILogC4( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_ARRILogC4(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_ARRILogC4(unittest.TestCase): +class TestLogDecoding_ARRILogC4: """ Define :func:`colour.models.rgb.transfer_functions.arri.\ log_decoding_ARRILogC4` definition unit tests methods. @@ -374,10 +367,4 @@ def test_nan_log_decoding_ARRILogC4(self): log_decoding_ARRILogC4` definition nan support. """ - log_decoding_ARRILogC4( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_ARRILogC4(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_blackmagic_design.py b/colour/models/rgb/transfer_functions/tests/test_blackmagic_design.py index a0ff544456..ea5e403cee 100644 --- a/colour/models/rgb/transfer_functions/tests/test_blackmagic_design.py +++ b/colour/models/rgb/transfer_functions/tests/test_blackmagic_design.py @@ -3,7 +3,6 @@ blackmagic_design` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestOetf_BlackmagicFilmGeneration5(unittest.TestCase): +class TestOetf_BlackmagicFilmGeneration5: """ Define :func:`colour.models.rgb.transfer_functions.blackmagic_design.\ oetf_BlackmagicFilmGeneration5` definition unit tests methods. @@ -128,7 +127,7 @@ def test_nan_oetf_BlackmagicFilmGeneration5(self): ) -class TestOetf_inverse_BlackmagicFilmGeneration5(unittest.TestCase): +class TestOetf_inverse_BlackmagicFilmGeneration5: """ Define :func:`colour.models.rgb.transfer_functions.\ blackmagic_design.oetf_inverse_BlackmagicFilmGeneration5` definition unit tests @@ -235,7 +234,3 @@ def test_nan_oetf_inverse_BlackmagicFilmGeneration5(self): oetf_inverse_BlackmagicFilmGeneration5( np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_canon.py b/colour/models/rgb/transfer_functions/tests/test_canon.py index c382665b79..8cccb13b56 100644 --- a/colour/models/rgb/transfer_functions/tests/test_canon.py +++ b/colour/models/rgb/transfer_functions/tests/test_canon.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.canon` module. """ -import unittest import numpy as np @@ -47,7 +46,7 @@ ] -class TestLogEncoding_CanonLog_v1(unittest.TestCase): +class TestLogEncoding_CanonLog_v1: """ Define :func:`colour.models.rgb.transfer_functions.canon.\ log_encoding_CanonLog_v1` definition unit tests methods. @@ -153,12 +152,10 @@ def test_nan_log_encoding_CanonLog_v1(self): log_encoding_CanonLog_v1` definition nan support. """ - log_encoding_CanonLog_v1( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_CanonLog_v1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_CanonLog_v1(unittest.TestCase): +class TestLogDecoding_CanonLog_v1: """ Define :func:`colour.models.rgb.transfer_functions.canon.\ log_decoding_CanonLog_v1` definition unit tests methods. @@ -264,12 +261,10 @@ def test_nan_log_decoding_CanonLog_v1(self): log_decoding_CanonLog_v1` definition nan support. """ - log_decoding_CanonLog_v1( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_CanonLog_v1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_CanonLog_v1_2(unittest.TestCase): +class TestLogEncoding_CanonLog_v1_2: """ Define :func:`colour.models.rgb.transfer_functions.canon.\ log_encoding_CanonLog_v1_2` definition unit tests methods. @@ -339,9 +334,7 @@ def test_log_encoding_CanonLog_v1_2(self): np.testing.assert_allclose( log_encoding_CanonLog_v1(samples, out_normalised_code_value=False), - log_encoding_CanonLog_v1_2( - samples, out_normalised_code_value=False - ), + log_encoding_CanonLog_v1_2(samples, out_normalised_code_value=False), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( @@ -402,12 +395,10 @@ def test_nan_log_encoding_CanonLog_v1_2(self): log_encoding_CanonLog_v1_2` definition nan support. """ - log_encoding_CanonLog_v1_2( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_CanonLog_v1_2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_CanonLog_v1_2(unittest.TestCase): +class TestLogDecoding_CanonLog_v1_2: """ Define :func:`colour.models.rgb.transfer_functions.canon.\ log_decoding_CanonLog_v1_2` definition unit tests methods. @@ -477,9 +468,7 @@ def test_log_decoding_CanonLog_v1_2(self): np.testing.assert_allclose( log_decoding_CanonLog_v1(samples, in_normalised_code_value=False), - log_decoding_CanonLog_v1_2( - samples, in_normalised_code_value=False - ), + log_decoding_CanonLog_v1_2(samples, in_normalised_code_value=False), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( @@ -540,12 +529,10 @@ def test_nan_log_decoding_CanonLog_v1_2(self): log_decoding_CanonLog_v1_2` definition nan support. """ - log_decoding_CanonLog_v1_2( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_CanonLog_v1_2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_CanonLog2_v1(unittest.TestCase): +class TestLogEncoding_CanonLog2_v1: """ Define :func:`colour.models.rgb.transfer_functions.canon.\ log_encoding_CanonLog2_v1` definition unit tests methods. @@ -651,12 +638,10 @@ def test_nan_log_encoding_CanonLog2_v1(self): log_encoding_CanonLog2_v1` definition nan support. """ - log_encoding_CanonLog2_v1( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_CanonLog2_v1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_CanonLog2_v1(unittest.TestCase): +class TestLogDecoding_CanonLog2_v1: """ Define :func:`colour.models.rgb.transfer_functions.canon.\ log_decoding_CanonLog2_v1` definition unit tests methods. @@ -762,12 +747,10 @@ def test_nan_log_decoding_CanonLog2_v1(self): log_decoding_CanonLog2_v1` definition nan support. """ - log_decoding_CanonLog2_v1( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_CanonLog2_v1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_CanonLog2_v1_2(unittest.TestCase): +class TestLogEncoding_CanonLog2_v1_2: """ Define :func:`colour.models.rgb.transfer_functions.canon.\ log_encoding_CanonLog2_v1_2` definition unit tests methods. @@ -836,12 +819,8 @@ def test_log_encoding_CanonLog2_v1_2(self): ) np.testing.assert_allclose( - log_encoding_CanonLog2_v1( - samples, out_normalised_code_value=False - ), - log_encoding_CanonLog2_v1_2( - samples, out_normalised_code_value=False - ), + log_encoding_CanonLog2_v1(samples, out_normalised_code_value=False), + log_encoding_CanonLog2_v1_2(samples, out_normalised_code_value=False), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( @@ -908,12 +887,10 @@ def test_nan_log_encoding_CanonLog2_v1_2(self): log_encoding_CanonLog2_v1_2` definition nan support. """ - log_encoding_CanonLog2_v1_2( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_CanonLog2_v1_2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_CanonLog2_v1_2(unittest.TestCase): +class TestLogDecoding_CanonLog2_v1_2: """ Define :func:`colour.models.rgb.transfer_functions.canon.\ log_decoding_CanonLog2_v1_2` definition unit tests methods. @@ -983,9 +960,7 @@ def test_log_decoding_CanonLog2_v1_2(self): np.testing.assert_allclose( log_decoding_CanonLog_v1(samples, in_normalised_code_value=False), - log_decoding_CanonLog_v1_2( - samples, in_normalised_code_value=False - ), + log_decoding_CanonLog_v1_2(samples, in_normalised_code_value=False), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( @@ -1052,12 +1027,10 @@ def test_nan_log_decoding_CanonLog2_v1_2(self): log_decoding_CanonLog2_v1_2` definition nan support. """ - log_decoding_CanonLog2_v1_2( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_CanonLog2_v1_2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_CanonLog3_v1(unittest.TestCase): +class TestLogEncoding_CanonLog3_v1: """ Define :func:`colour.models.rgb.transfer_functions.canon.\ log_encoding_CanonLog3_v1` definition unit tests methods. @@ -1163,12 +1136,10 @@ def test_nan_log_encoding_CanonLog3_v1(self): log_encoding_CanonLog3_v1` definition nan support. """ - log_encoding_CanonLog3_v1( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_CanonLog3_v1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_CanonLog3_v1(unittest.TestCase): +class TestLogDecoding_CanonLog3_v1: """ Define :func:`colour.models.rgb.transfer_functions.canon.\ log_decoding_CanonLog3_v1` definition unit tests methods. @@ -1274,12 +1245,10 @@ def test_nan_log_decoding_CanonLog3_v1(self): log_decoding_CanonLog3_v1` definition nan support. """ - log_decoding_CanonLog3_v1( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_CanonLog3_v1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_CanonLog3_v1_2(unittest.TestCase): +class TestLogEncoding_CanonLog3_v1_2: """ Define :func:`colour.models.rgb.transfer_functions.canon.\ log_encoding_CanonLog3_v1_2` definition unit tests methods. @@ -1348,12 +1317,8 @@ def test_log_encoding_CanonLog3_v1_2(self): ) np.testing.assert_allclose( - log_encoding_CanonLog3_v1( - samples, out_normalised_code_value=False - ), - log_encoding_CanonLog3_v1_2( - samples, out_normalised_code_value=False - ), + log_encoding_CanonLog3_v1(samples, out_normalised_code_value=False), + log_encoding_CanonLog3_v1_2(samples, out_normalised_code_value=False), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( @@ -1420,12 +1385,10 @@ def test_nan_log_encoding_CanonLog3_v1_2(self): log_encoding_CanonLog3_v1_2` definition nan support. """ - log_encoding_CanonLog3_v1_2( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_CanonLog3_v1_2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_CanonLog3_v1_2(unittest.TestCase): +class TestLogDecoding_CanonLog3_v1_2: """ Define :func:`colour.models.rgb.transfer_functions.canon.\ log_decoding_CanonLog3_v1_2` definition unit tests methods. @@ -1495,9 +1458,7 @@ def test_log_decoding_CanonLog3_v1_2(self): np.testing.assert_allclose( log_decoding_CanonLog3_v1(samples, in_normalised_code_value=False), - log_decoding_CanonLog3_v1_2( - samples, in_normalised_code_value=False - ), + log_decoding_CanonLog3_v1_2(samples, in_normalised_code_value=False), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( @@ -1564,10 +1525,4 @@ def test_nan_log_decoding_CanonLog3_v1_2(self): log_decoding_CanonLog3_v1_2` definition nan support. """ - log_decoding_CanonLog3_v1_2( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_CanonLog3_v1_2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_cineon.py b/colour/models/rgb/transfer_functions/tests/test_cineon.py index 7b06586154..943db9cc51 100644 --- a/colour/models/rgb/transfer_functions/tests/test_cineon.py +++ b/colour/models/rgb/transfer_functions/tests/test_cineon.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.cineon` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestLogEncoding_Cineon(unittest.TestCase): +class TestLogEncoding_Cineon: """ Define :func:`colour.models.rgb.transfer_functions.cineon.\ log_encoding_Cineon` definition unit tests methods. @@ -109,12 +108,10 @@ def test_nan_log_encoding_Cineon(self): log_encoding_Cineon` definition nan support. """ - log_encoding_Cineon( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_Cineon(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_Cineon(unittest.TestCase): +class TestLogDecoding_Cineon: """ Define :func:`colour.models.rgb.transfer_functions.cineon.\ log_decoding_Cineon` definition unit tests methods. @@ -196,10 +193,4 @@ def test_nan_log_decoding_Cineon(self): log_decoding_Cineon` definition nan support. """ - log_decoding_Cineon( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_Cineon(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_common.py b/colour/models/rgb/transfer_functions/tests/test_common.py index 409bb03ab2..e13d015d20 100644 --- a/colour/models/rgb/transfer_functions/tests/test_common.py +++ b/colour/models/rgb/transfer_functions/tests/test_common.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.common` module. """ -import unittest import numpy as np @@ -29,7 +28,7 @@ ] -class TestCV_range(unittest.TestCase): +class TestCV_range: """ Define :func:`colour.models.rgb.transfer_functions.common.CV_range` definition unit tests methods. @@ -41,13 +40,9 @@ def test_CV_range(self): definition. """ - np.testing.assert_array_equal( - CV_range(8, True, True), np.array([16, 235]) - ) + np.testing.assert_array_equal(CV_range(8, True, True), np.array([16, 235])) - np.testing.assert_array_equal( - CV_range(8, False, True), np.array([0, 255]) - ) + np.testing.assert_array_equal(CV_range(8, False, True), np.array([0, 255])) np.testing.assert_allclose( CV_range(8, True, False), @@ -55,17 +50,11 @@ def test_CV_range(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - np.testing.assert_array_equal( - CV_range(8, False, False), np.array([0, 1]) - ) + np.testing.assert_array_equal(CV_range(8, False, False), np.array([0, 1])) - np.testing.assert_array_equal( - CV_range(10, True, True), np.array([64, 940]) - ) + np.testing.assert_array_equal(CV_range(10, True, True), np.array([64, 940])) - np.testing.assert_array_equal( - CV_range(10, False, True), np.array([0, 1023]) - ) + np.testing.assert_array_equal(CV_range(10, False, True), np.array([0, 1023])) np.testing.assert_allclose( CV_range(10, True, False), @@ -73,12 +62,10 @@ def test_CV_range(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - np.testing.assert_array_equal( - CV_range(10, False, False), np.array([0, 1]) - ) + np.testing.assert_array_equal(CV_range(10, False, False), np.array([0, 1])) -class TestLegalToFull(unittest.TestCase): +class TestLegalToFull: """ Define :func:`colour.models.rgb.transfer_functions.common.legal_to_full` definition unit tests methods. @@ -96,21 +83,15 @@ def test_legal_to_full(self): np.testing.assert_allclose(legal_to_full(64 / 1023, out_int=True), 0) - np.testing.assert_allclose( - legal_to_full(940 / 1023, out_int=True), 1023 - ) + np.testing.assert_allclose(legal_to_full(940 / 1023, out_int=True), 1023) np.testing.assert_allclose(legal_to_full(64, in_int=True), 0.0) np.testing.assert_allclose(legal_to_full(940, in_int=True), 1.0) - np.testing.assert_allclose( - legal_to_full(64, in_int=True, out_int=True), 0 - ) + np.testing.assert_allclose(legal_to_full(64, in_int=True, out_int=True), 0) - np.testing.assert_allclose( - legal_to_full(940, in_int=True, out_int=True), 1023 - ) + np.testing.assert_allclose(legal_to_full(940, in_int=True, out_int=True), 1023) def test_n_dimensional_legal_to_full(self): """ @@ -149,7 +130,7 @@ def test_nan_legal_to_full(self): legal_to_full(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]), 10) -class TestFullToLegal(unittest.TestCase): +class TestFullToLegal: """ Define :func:`colour.models.rgb.transfer_functions.common.full_to_legal` definition unit tests methods. @@ -169,21 +150,13 @@ def test_full_to_legal(self): np.testing.assert_allclose(full_to_legal(1.0, out_int=True), 940) - np.testing.assert_allclose( - full_to_legal(0, in_int=True), 0.062561094819159 - ) + np.testing.assert_allclose(full_to_legal(0, in_int=True), 0.062561094819159) - np.testing.assert_allclose( - full_to_legal(1023, in_int=True), 0.918866080156403 - ) + np.testing.assert_allclose(full_to_legal(1023, in_int=True), 0.918866080156403) - np.testing.assert_allclose( - full_to_legal(0, in_int=True, out_int=True), 64 - ) + np.testing.assert_allclose(full_to_legal(0, in_int=True, out_int=True), 64) - np.testing.assert_allclose( - full_to_legal(1023, in_int=True, out_int=True), 940 - ) + np.testing.assert_allclose(full_to_legal(1023, in_int=True, out_int=True), 940) def test_n_dimensional_full_to_legal(self): """ @@ -220,7 +193,3 @@ def test_nan_full_to_legal(self): """ full_to_legal(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]), 10) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_davinci_intermediate.py b/colour/models/rgb/transfer_functions/tests/test_davinci_intermediate.py index e51c0d335b..a9b561c70f 100644 --- a/colour/models/rgb/transfer_functions/tests/test_davinci_intermediate.py +++ b/colour/models/rgb/transfer_functions/tests/test_davinci_intermediate.py @@ -3,7 +3,6 @@ davinci_intermediate` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestOetf_DaVinciIntermediate(unittest.TestCase): +class TestOetf_DaVinciIntermediate: """ Define :func:`colour.models.rgb.transfer_functions.davinci_intermediate.\ oetf_DaVinciIntermediate` definition unit tests methods. @@ -121,12 +120,10 @@ def test_nan_oetf_DaVinciIntermediate(self): davinci_intermediate.oetf_DaVinciIntermediate` definition nan support. """ - oetf_DaVinciIntermediate( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + oetf_DaVinciIntermediate(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_inverse_DaVinciIntermediate(unittest.TestCase): +class TestOetf_inverse_DaVinciIntermediate: """ Define :func:`colour.models.rgb.transfer_functions.\ davinci_intermediate.oetf_inverse_DaVinciIntermediate` definition unit tests @@ -232,7 +229,3 @@ def test_nan_oetf_inverse_DaVinciIntermediate(self): oetf_inverse_DaVinciIntermediate( np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_dcdm.py b/colour/models/rgb/transfer_functions/tests/test_dcdm.py index f4f5fea48c..32d1aae3db 100644 --- a/colour/models/rgb/transfer_functions/tests/test_dcdm.py +++ b/colour/models/rgb/transfer_functions/tests/test_dcdm.py @@ -3,7 +3,6 @@ module. """ -import unittest import numpy as np @@ -24,7 +23,7 @@ ] -class TestEotf_inverse_DCDM(unittest.TestCase): +class TestEotf_inverse_DCDM: """ Define :func:`colour.models.rgb.transfer_functions.dcdm.eotf_inverse_DCDM` definition unit tests methods. @@ -48,7 +47,7 @@ def test_eotf_inverse_DCDM(self): eotf_inverse_DCDM(1.0), 0.21817973, atol=TOLERANCE_ABSOLUTE_TESTS ) - self.assertEqual(eotf_inverse_DCDM(0.18, out_int=True), 462) + assert eotf_inverse_DCDM(0.18, out_int=True) == 462 def test_n_dimensional_eotf_inverse_DCDM(self): """ @@ -105,7 +104,7 @@ def test_nan_eotf_inverse_DCDM(self): eotf_inverse_DCDM(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_DCDM(unittest.TestCase): +class TestEotf_DCDM: """ Define :func:`colour.models.rgb.transfer_functions.dcdm.eotf_DCDM` definition unit tests methods. @@ -117,9 +116,7 @@ def test_eotf_DCDM(self): definition. """ - np.testing.assert_allclose( - eotf_DCDM(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_DCDM(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS) np.testing.assert_allclose( eotf_DCDM(0.11281861), 0.18, atol=TOLERANCE_ABSOLUTE_TESTS @@ -129,9 +126,7 @@ def test_eotf_DCDM(self): eotf_DCDM(0.21817973), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS ) - np.testing.assert_allclose( - eotf_DCDM(462, in_int=True), 0.18, atol=1e-5 - ) + np.testing.assert_allclose(eotf_DCDM(462, in_int=True), 0.18, atol=1e-5) def test_n_dimensional_eotf_DCDM(self): """ @@ -144,21 +139,15 @@ def test_n_dimensional_eotf_DCDM(self): XYZ_p = np.tile(XYZ_p, 6) XYZ = np.tile(XYZ, 6) - np.testing.assert_allclose( - eotf_DCDM(XYZ_p), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_DCDM(XYZ_p), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) XYZ_p = np.reshape(XYZ_p, (2, 3)) XYZ = np.reshape(XYZ, (2, 3)) - np.testing.assert_allclose( - eotf_DCDM(XYZ_p), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_DCDM(XYZ_p), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) XYZ_p = np.reshape(XYZ_p, (2, 3, 1)) XYZ = np.reshape(XYZ, (2, 3, 1)) - np.testing.assert_allclose( - eotf_DCDM(XYZ_p), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_DCDM(XYZ_p), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_eotf_DCDM(self): """ @@ -186,7 +175,3 @@ def test_nan_eotf_DCDM(self): """ eotf_DCDM(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_dicom_gsdf.py b/colour/models/rgb/transfer_functions/tests/test_dicom_gsdf.py index 68acc94735..71f15e3c80 100644 --- a/colour/models/rgb/transfer_functions/tests/test_dicom_gsdf.py +++ b/colour/models/rgb/transfer_functions/tests/test_dicom_gsdf.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.dicom_gsdf` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestEotf_inverse_DICOMGSDF(unittest.TestCase): +class TestEotf_inverse_DICOMGSDF: """ Define :func:`colour.models.rgb.transfer_functions.dicom_gsdf.\ eotf_inverse_DICOMGSDF` definition unit tests methods. @@ -115,12 +114,10 @@ def test_nan_eotf_inverse_DICOMGSDF(self): eotf_inverse_DICOMGSDF` definition nan support. """ - eotf_inverse_DICOMGSDF( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + eotf_inverse_DICOMGSDF(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_DICOMGSDF(unittest.TestCase): +class TestEotf_DICOMGSDF: """ Define :func:`colour.models.rgb.transfer_functions.dicom_gsdf. eotf_DICOMGSDF` definition unit tests methods. @@ -167,21 +164,15 @@ def test_n_dimensional_eotf_DICOMGSDF(self): J = np.tile(J, 6) L = np.tile(L, 6) - np.testing.assert_allclose( - eotf_DICOMGSDF(J), L, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_DICOMGSDF(J), L, atol=TOLERANCE_ABSOLUTE_TESTS) J = np.reshape(J, (2, 3)) L = np.reshape(L, (2, 3)) - np.testing.assert_allclose( - eotf_DICOMGSDF(J), L, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_DICOMGSDF(J), L, atol=TOLERANCE_ABSOLUTE_TESTS) J = np.reshape(J, (2, 3, 1)) L = np.reshape(L, (2, 3, 1)) - np.testing.assert_allclose( - eotf_DICOMGSDF(J), L, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_DICOMGSDF(J), L, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_eotf_DICOMGSDF(self): """ @@ -209,7 +200,3 @@ def test_nan_eotf_DICOMGSDF(self): """ eotf_DICOMGSDF(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_dji_d_log.py b/colour/models/rgb/transfer_functions/tests/test_dji_d_log.py index 2866414a22..3cd58a2110 100644 --- a/colour/models/rgb/transfer_functions/tests/test_dji_d_log.py +++ b/colour/models/rgb/transfer_functions/tests/test_dji_d_log.py @@ -3,7 +3,6 @@ dji_d_log` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestLogEncoding_DJIDLog(unittest.TestCase): +class TestLogEncoding_DJIDLog: """ Define :func:`colour.models.rgb.transfer_functions.dji_d_log.\ log_encoding_DJIDLog` definition unit tests methods. @@ -105,12 +104,10 @@ def test_nan_log_encoding_DLog(self): log_encoding_DJIDLog` definition nan support. """ - log_encoding_DJIDLog( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_DJIDLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_DJIDLog(unittest.TestCase): +class TestLogDecoding_DJIDLog: """ Define :func:`colour.models.rgb.transfer_functions.dji_d_log.\ log_decoding_DJIDLog` definition unit tests methods. @@ -130,9 +127,7 @@ def test_log_decoding_DJIDLog(self): log_decoding_DJIDLog(0.398764556189331), 0.18, atol=1e-6 ) - np.testing.assert_allclose( - log_decoding_DJIDLog(0.584555), 1.0, atol=1e-6 - ) + np.testing.assert_allclose(log_decoding_DJIDLog(0.584555), 1.0, atol=1e-6) def test_n_dimensional_log_decoding_DLog(self): """ @@ -186,10 +181,4 @@ def test_nan_log_decoding_DLog(self): log_decoding_DJIDLog` definition nan support. """ - log_decoding_DJIDLog( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_DJIDLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_exponent.py b/colour/models/rgb/transfer_functions/tests/test_exponent.py index d13dbbbd54..6329f5b630 100644 --- a/colour/models/rgb/transfer_functions/tests/test_exponent.py +++ b/colour/models/rgb/transfer_functions/tests/test_exponent.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.exponent` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestExponentFunctionBasic(unittest.TestCase): +class TestExponentFunctionBasic: """ Define :func:`colour.models.rgb.transfer_functions.exponent.\ exponent_function_basic` definition unit tests methods. @@ -239,7 +238,7 @@ def test_nan_exponent_function_basic(self): exponent_function_basic(case, case) -class TestExponentFunctionMonitorCurve(unittest.TestCase): +class TestExponentFunctionMonitorCurve: """ Define :func:`colour.models.rgb.transfer_functions.exponent.\ exponent_function_monitor_curve` definition unit tests methods. @@ -260,9 +259,7 @@ def test_exponent_function_monitor_curve(self): ) np.testing.assert_allclose( - exponent_function_monitor_curve( - a, 2.2, 0.001, "monCurveMirrorFwd" - ), + exponent_function_monitor_curve(a, 2.2, 0.001, "monCurveMirrorFwd"), a_p, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -276,9 +273,7 @@ def test_exponent_function_monitor_curve(self): ) np.testing.assert_allclose( - exponent_function_monitor_curve( - a, 2.2, 0.001, "monCurveMirrorRev" - ), + exponent_function_monitor_curve(a, 2.2, 0.001, "monCurveMirrorRev"), a_p, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -291,9 +286,7 @@ def test_exponent_function_monitor_curve(self): ) np.testing.assert_allclose( - exponent_function_monitor_curve( - a, 2.2, 0.001, "monCurveMirrorFwd" - ), + exponent_function_monitor_curve(a, 2.2, 0.001, "monCurveMirrorFwd"), -0.0232240466001, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -306,9 +299,7 @@ def test_exponent_function_monitor_curve(self): ) np.testing.assert_allclose( - exponent_function_monitor_curve( - a, 2.2, 0.001, "monCurveMirrorRev" - ), + exponent_function_monitor_curve(a, 2.2, 0.001, "monCurveMirrorRev"), -0.0201036111565, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -330,9 +321,7 @@ def test_n_dimensional_exponent_function_monitor_curve(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - exponent_function_monitor_curve( - a, 2.2, 0.001, "monCurveMirrorFwd" - ), + exponent_function_monitor_curve(a, 2.2, 0.001, "monCurveMirrorFwd"), a_p, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -345,9 +334,7 @@ def test_n_dimensional_exponent_function_monitor_curve(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - exponent_function_monitor_curve( - a, 2.2, 0.001, "monCurveMirrorFwd" - ), + exponent_function_monitor_curve(a, 2.2, 0.001, "monCurveMirrorFwd"), a_p, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -360,9 +347,7 @@ def test_n_dimensional_exponent_function_monitor_curve(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - exponent_function_monitor_curve( - a, 2.2, 0.001, "monCurveMirrorFwd" - ), + exponent_function_monitor_curve(a, 2.2, 0.001, "monCurveMirrorFwd"), a_p, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -378,9 +363,7 @@ def test_n_dimensional_exponent_function_monitor_curve(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - exponent_function_monitor_curve( - a, 2.2, 0.001, "monCurveMirrorRev" - ), + exponent_function_monitor_curve(a, 2.2, 0.001, "monCurveMirrorRev"), a_p, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -393,9 +376,7 @@ def test_n_dimensional_exponent_function_monitor_curve(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - exponent_function_monitor_curve( - a, 2.2, 0.001, "monCurveMirrorRev" - ), + exponent_function_monitor_curve(a, 2.2, 0.001, "monCurveMirrorRev"), a_p, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -408,9 +389,7 @@ def test_n_dimensional_exponent_function_monitor_curve(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - exponent_function_monitor_curve( - a, 2.2, 0.001, "monCurveMirrorRev" - ), + exponent_function_monitor_curve(a, 2.2, 0.001, "monCurveMirrorRev"), a_p, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -425,7 +404,3 @@ def test_nan_exponent_function_monitor_curve(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] for case in cases: exponent_function_monitor_curve(case, case, case) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_filmic_pro.py b/colour/models/rgb/transfer_functions/tests/test_filmic_pro.py index 8705b89a64..a57437aa19 100644 --- a/colour/models/rgb/transfer_functions/tests/test_filmic_pro.py +++ b/colour/models/rgb/transfer_functions/tests/test_filmic_pro.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.filmic_pro` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestLogEncoding_FilmicPro6(unittest.TestCase): +class TestLogEncoding_FilmicPro6: """ Define :func:`colour.models.rgb.transfer_functions.filmic_pro.\ log_encoding_FilmicPro6` definition unit tests methods. @@ -109,12 +108,10 @@ def test_nan_log_encoding_FilmicPro6(self): log_encoding_FilmicPro6` definition nan support. """ - log_encoding_FilmicPro6( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_FilmicPro6(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_FilmicPro6(unittest.TestCase): +class TestLogDecoding_FilmicPro6: """ Define :func:`colour.models.rgb.transfer_functions.filmic_pro.\ log_decoding_FilmicPro6` definition unit tests methods. @@ -192,10 +189,4 @@ def test_nan_log_decoding_FilmicPro6(self): log_decoding_FilmicPro6` definition nan support. """ - log_decoding_FilmicPro6( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_FilmicPro6(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_filmlight_t_log.py b/colour/models/rgb/transfer_functions/tests/test_filmlight_t_log.py index 979a1d95d3..33b461e7f5 100644 --- a/colour/models/rgb/transfer_functions/tests/test_filmlight_t_log.py +++ b/colour/models/rgb/transfer_functions/tests/test_filmlight_t_log.py @@ -3,7 +3,6 @@ filmlight_t_log` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestLogEncoding_FilmLightTLog(unittest.TestCase): +class TestLogEncoding_FilmLightTLog: """ Define :func:`colour.models.rgb.transfer_functions.filmlight_t_log.\ log_encoding_FilmLightTLog` definition unit tests methods. @@ -109,12 +108,10 @@ def test_nan_log_encoding_TLog(self): log_encoding_FilmLightTLog` definition nan support. """ - log_encoding_FilmLightTLog( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_FilmLightTLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_FilmLightTLog(unittest.TestCase): +class TestLogDecoding_FilmLightTLog: """ Define :func:`colour.models.rgb.transfer_functions.filmlight_t_log.\ log_decoding_FilmLightTLog` definition unit tests methods. @@ -196,10 +193,4 @@ def test_nan_log_decoding_TLog(self): log_decoding_FilmLightTLog` definition nan support. """ - log_decoding_FilmLightTLog( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_FilmLightTLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_fujifilm_f_log.py b/colour/models/rgb/transfer_functions/tests/test_fujifilm_f_log.py index 74f718abc6..3d41f4868d 100644 --- a/colour/models/rgb/transfer_functions/tests/test_fujifilm_f_log.py +++ b/colour/models/rgb/transfer_functions/tests/test_fujifilm_f_log.py @@ -3,7 +3,6 @@ fujifilm_f_log` module. """ -import unittest import numpy as np @@ -31,7 +30,7 @@ ] -class TestLogEncoding_FLog(unittest.TestCase): +class TestLogEncoding_FLog: """ Define :func:`colour.models.rgb.transfer_functions.fujifilm_f_log.\ log_encoding_FLog` definition unit tests methods. @@ -134,7 +133,7 @@ def test_nan_log_encoding_FLog(self): log_encoding_FLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_FLog(unittest.TestCase): +class TestLogDecoding_FLog: """ Define :func:`colour.models.rgb.transfer_functions.fujifilm_f_log.\ log_decoding_FLog` definition unit tests methods. @@ -237,7 +236,7 @@ def test_nan_log_decoding_FLog(self): log_decoding_FLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_FLog2(unittest.TestCase): +class TestLogEncoding_FLog2: """ Define :func:`colour.models.rgb.transfer_functions.fujifilm_flog.\ log_encoding_FLog2` definition unit tests methods. @@ -338,7 +337,7 @@ def test_nan_log_encoding_FLog2(self): log_encoding_FLog2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_FLog2(unittest.TestCase): +class TestLogDecoding_FLog2: """ Define :func:`colour.models.rgb.transfer_functions.fujifilm_flog.\ log_decoding_FLog2` definition unit tests methods. @@ -438,7 +437,3 @@ def test_nan_log_decoding_FLog2(self): """ log_decoding_FLog2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_gamma.py b/colour/models/rgb/transfer_functions/tests/test_gamma.py index 4430b604c4..05a7e1cb99 100644 --- a/colour/models/rgb/transfer_functions/tests/test_gamma.py +++ b/colour/models/rgb/transfer_functions/tests/test_gamma.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.gamma` module. """ -import unittest import numpy as np @@ -23,7 +22,7 @@ ] -class TestGammaFunction(unittest.TestCase): +class TestGammaFunction: """ Define :func:`colour.models.rgb.transfer_functions.gamma.gamma_function` definition unit tests methods. @@ -219,7 +218,3 @@ def test_nan_gamma_function(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] gamma_function(cases, cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_gopro.py b/colour/models/rgb/transfer_functions/tests/test_gopro.py index 0852a7b7fe..1701ae53f5 100644 --- a/colour/models/rgb/transfer_functions/tests/test_gopro.py +++ b/colour/models/rgb/transfer_functions/tests/test_gopro.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.gopro` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestLogEncoding_Protune(unittest.TestCase): +class TestLogEncoding_Protune: """ Define :func:`colour.models.rgb.transfer_functions.gopro.\ log_encoding_Protune` definition unit tests methods. @@ -105,12 +104,10 @@ def test_nan_log_encoding_Protune(self): log_encoding_Protune` definition nan support. """ - log_encoding_Protune( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_Protune(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_Protune(unittest.TestCase): +class TestLogDecoding_Protune: """ Define :func:`colour.models.rgb.transfer_functions.gopro.\ log_decoding_Protune` definition unit tests methods. @@ -188,10 +185,4 @@ def test_nan_log_decoding_Protune(self): log_decoding_Protune` definition nan support. """ - log_decoding_Protune( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_Protune(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_itur_bt_1361.py b/colour/models/rgb/transfer_functions/tests/test_itur_bt_1361.py index c45121ba4e..f8d3944fc2 100644 --- a/colour/models/rgb/transfer_functions/tests/test_itur_bt_1361.py +++ b/colour/models/rgb/transfer_functions/tests/test_itur_bt_1361.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.itur_bt_1361` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestOetf_BT1361(unittest.TestCase): +class TestOetf_BT1361: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_1361.oetf_BT1361` definition unit tests methods. @@ -45,9 +44,7 @@ def test_oetf_BT1361(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - np.testing.assert_allclose( - oetf_BT1361(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT1361(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS) np.testing.assert_allclose( oetf_BT1361(0.015), @@ -59,9 +56,7 @@ def test_oetf_BT1361(self): oetf_BT1361(0.18), 0.409007728864150, atol=TOLERANCE_ABSOLUTE_TESTS ) - np.testing.assert_allclose( - oetf_BT1361(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT1361(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS) def test_n_dimensional_oetf_BT1361(self): """ @@ -74,21 +69,15 @@ def test_n_dimensional_oetf_BT1361(self): L = np.tile(L, 6) V = np.tile(V, 6) - np.testing.assert_allclose( - oetf_BT1361(L), V, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT1361(L), V, atol=TOLERANCE_ABSOLUTE_TESTS) L = np.reshape(L, (2, 3)) V = np.reshape(V, (2, 3)) - np.testing.assert_allclose( - oetf_BT1361(L), V, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT1361(L), V, atol=TOLERANCE_ABSOLUTE_TESTS) L = np.reshape(L, (2, 3, 1)) V = np.reshape(V, (2, 3, 1)) - np.testing.assert_allclose( - oetf_BT1361(L), V, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT1361(L), V, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_oetf_BT1361(self): """ @@ -118,7 +107,7 @@ def test_nan_oetf_BT1361(self): oetf_BT1361(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_inverse_BT1361(unittest.TestCase): +class TestOetf_inverse_BT1361: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_1361.\ oetf_inverse_BT1361` definition unit tests methods. @@ -208,10 +197,4 @@ def test_nan_oetf_inverse_BT1361(self): oetf_inverse_BT1361` definition nan support. """ - oetf_inverse_BT1361( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + oetf_inverse_BT1361(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_itur_bt_1886.py b/colour/models/rgb/transfer_functions/tests/test_itur_bt_1886.py index e94e977b6b..c1bf624831 100644 --- a/colour/models/rgb/transfer_functions/tests/test_itur_bt_1886.py +++ b/colour/models/rgb/transfer_functions/tests/test_itur_bt_1886.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.itur_bt_1886` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestEotf_inverse_BT1886(unittest.TestCase): +class TestEotf_inverse_BT1886: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_1886.\ eotf_inverse_BT1886` definition unit tests methods. @@ -105,12 +104,10 @@ def test_nan_eotf_inverse_BT1886(self): eotf_inverse_BT1886` definition nan support. """ - eotf_inverse_BT1886( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + eotf_inverse_BT1886(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_BT1886(unittest.TestCase): +class TestEotf_BT1886: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_1886.\ eotf_BT1886` definition unit tests methods. @@ -122,17 +119,13 @@ def test_eotf_BT1886(self): eotf_BT1886` definition. """ - np.testing.assert_allclose( - eotf_BT1886(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_BT1886(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS) np.testing.assert_allclose( eotf_BT1886(0.18), 0.016317514686316, atol=TOLERANCE_ABSOLUTE_TESTS ) - np.testing.assert_allclose( - eotf_BT1886(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_BT1886(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS) def test_n_dimensional_eotf_BT1886(self): """ @@ -145,21 +138,15 @@ def test_n_dimensional_eotf_BT1886(self): V = np.tile(V, 6) L = np.tile(L, 6) - np.testing.assert_allclose( - eotf_BT1886(V), L, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_BT1886(V), L, atol=TOLERANCE_ABSOLUTE_TESTS) V = np.reshape(V, (2, 3)) L = np.reshape(L, (2, 3)) - np.testing.assert_allclose( - eotf_BT1886(V), L, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_BT1886(V), L, atol=TOLERANCE_ABSOLUTE_TESTS) V = np.reshape(V, (2, 3, 1)) L = np.reshape(L, (2, 3, 1)) - np.testing.assert_allclose( - eotf_BT1886(V), L, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_BT1886(V), L, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_eotf_BT1886(self): """ @@ -187,7 +174,3 @@ def test_nan_eotf_BT1886(self): """ eotf_BT1886(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_itur_bt_2020.py b/colour/models/rgb/transfer_functions/tests/test_itur_bt_2020.py index 212314d6b9..06b8ebd6d4 100644 --- a/colour/models/rgb/transfer_functions/tests/test_itur_bt_2020.py +++ b/colour/models/rgb/transfer_functions/tests/test_itur_bt_2020.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.itur_bt_2020` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestOetf_BT2020(unittest.TestCase): +class TestOetf_BT2020: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2020.\ oetf_BT2020` definition unit tests methods. @@ -39,17 +38,13 @@ def test_oetf_BT2020(self): oetf_BT2020` definition. """ - np.testing.assert_allclose( - oetf_BT2020(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT2020(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS) np.testing.assert_allclose( oetf_BT2020(0.18), 0.409007728864150, atol=TOLERANCE_ABSOLUTE_TESTS ) - np.testing.assert_allclose( - oetf_BT2020(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT2020(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS) def test_n_dimensional_oetf_BT2020(self): """ @@ -62,21 +57,15 @@ def test_n_dimensional_oetf_BT2020(self): E = np.tile(E, 6) E_p = np.tile(E_p, 6) - np.testing.assert_allclose( - oetf_BT2020(E), E_p, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT2020(E), E_p, atol=TOLERANCE_ABSOLUTE_TESTS) E = np.reshape(E, (2, 3)) E_p = np.reshape(E_p, (2, 3)) - np.testing.assert_allclose( - oetf_BT2020(E), E_p, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT2020(E), E_p, atol=TOLERANCE_ABSOLUTE_TESTS) E = np.reshape(E, (2, 3, 1)) E_p = np.reshape(E_p, (2, 3, 1)) - np.testing.assert_allclose( - oetf_BT2020(E), E_p, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT2020(E), E_p, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_oetf_BT2020(self): """ @@ -106,7 +95,7 @@ def test_nan_oetf_BT2020(self): oetf_BT2020(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_inverse_BT2020(unittest.TestCase): +class TestOetf_inverse_BT2020: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2020.\ oetf_inverse_BT2020` definition unit tests methods. @@ -184,10 +173,4 @@ def test_nan_oetf_inverse_BT2020(self): oetf_inverse_BT2020` definition nan support. """ - oetf_inverse_BT2020( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + oetf_inverse_BT2020(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_itur_bt_2100.py b/colour/models/rgb/transfer_functions/tests/test_itur_bt_2100.py index e713c899a0..f23021bed9 100644 --- a/colour/models/rgb/transfer_functions/tests/test_itur_bt_2100.py +++ b/colour/models/rgb/transfer_functions/tests/test_itur_bt_2100.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.itur_bt_2100` module. """ -import unittest import numpy as np @@ -59,7 +58,7 @@ ] -class TestOetf_BT2100_PQ(unittest.TestCase): +class TestOetf_BT2100_PQ: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ oetf_BT2100_PQ` definition unit tests methods. @@ -144,7 +143,7 @@ def test_nan_oetf_BT2100_PQ(self): oetf_BT2100_PQ(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_inverse_BT2100_PQ(unittest.TestCase): +class TestOetf_inverse_BT2100_PQ: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ oetf_inverse_BT2100_PQ` definition unit tests methods. @@ -226,12 +225,10 @@ def test_nan_oetf_inverse_BT2100_PQ(self): oetf_inverse_BT2100_PQ` definition nan support. """ - oetf_inverse_BT2100_PQ( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + oetf_inverse_BT2100_PQ(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_BT2100_PQ(unittest.TestCase): +class TestEotf_BT2100_PQ: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ eotf_BT2100_PQ` definition unit tests methods. @@ -312,7 +309,7 @@ def test_nan_eotf_BT2100_PQ(self): eotf_BT2100_PQ(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_inverse_BT2100_PQ(unittest.TestCase): +class TestEotf_inverse_BT2100_PQ: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ eotf_inverse_BT2100_PQ` definition unit tests methods. @@ -392,12 +389,10 @@ def test_nan_eotf_inverse_BT2100_PQ(self): eotf_inverse_BT2100_PQ` definition nan support. """ - eotf_inverse_BT2100_PQ( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + eotf_inverse_BT2100_PQ(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOotf_BT2100_PQ(unittest.TestCase): +class TestOotf_BT2100_PQ: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ ootf_BT2100_PQ` definition unit tests methods. @@ -480,7 +475,7 @@ def test_nan_ootf_BT2100_PQ(self): ootf_BT2100_PQ(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOotf_inverse_BT2100_PQ(unittest.TestCase): +class TestOotf_inverse_BT2100_PQ: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ ootf_inverse_BT2100_PQ` definition unit tests methods. @@ -560,12 +555,10 @@ def test_nan_ootf_inverse_BT2100_PQ(self): ootf_inverse_BT2100_PQ` definition nan support. """ - ootf_inverse_BT2100_PQ( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + ootf_inverse_BT2100_PQ(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestGamma_function_BT2100_HLG(unittest.TestCase): +class TestGamma_function_BT2100_HLG: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ gamma_function_BT2100_HLG` definition unit tests methods. @@ -602,7 +595,7 @@ def test_gamma_function_BT2100_HLG(self): ) -class TestOetf_BT2100_HLG(unittest.TestCase): +class TestOetf_BT2100_HLG: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ oetf_BT2100_HLG` definition unit tests methods. @@ -685,7 +678,7 @@ def test_nan_oetf_BT2100_HLG(self): oetf_BT2100_HLG(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_inverse_BT2100_HLG(unittest.TestCase): +class TestOetf_inverse_BT2100_HLG: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ oetf_inverse_BT2100_HLG` definition unit tests methods. @@ -765,12 +758,10 @@ def test_nan_oetf_inverse_BT2100_HLG(self): oetf_inverse_BT2100_HLG` definition nan support. """ - oetf_inverse_BT2100_HLG( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + oetf_inverse_BT2100_HLG(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_BT2100_HLG_1(unittest.TestCase): +class TestEotf_BT2100_HLG_1: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ eotf_BT2100_HLG_1` definition unit tests methods. @@ -883,7 +874,7 @@ def test_nan_eotf_BT2100_HLG_1(self): eotf_BT2100_HLG_1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_BT2100_HLG_2(unittest.TestCase): +class TestEotf_BT2100_HLG_2: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ eotf_BT2100_HLG_2` definition unit tests methods. @@ -996,7 +987,7 @@ def test_nan_eotf_BT2100_HLG_2(self): eotf_BT2100_HLG_2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_inverse_BT2100_HLG_1(unittest.TestCase): +class TestEotf_inverse_BT2100_HLG_1: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ eotf_inverse_BT2100_HLG_1` definition unit tests methods. @@ -1106,12 +1097,10 @@ def test_nan_eotf_inverse_BT2100_HLG_1(self): eotf_inverse_BT2100_HLG_1` definition nan support. """ - eotf_inverse_BT2100_HLG_1( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + eotf_inverse_BT2100_HLG_1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_inverse_BT2100_HLG_2(unittest.TestCase): +class TestEotf_inverse_BT2100_HLG_2: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ eotf_inverse_BT2100_HLG_2` definition unit tests methods. @@ -1221,12 +1210,10 @@ def test_nan_eotf_inverse_BT2100_HLG_2(self): eotf_inverse_BT2100_HLG_2` definition nan support. """ - eotf_inverse_BT2100_HLG_2( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + eotf_inverse_BT2100_HLG_2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOotf_BT2100_HLG_1(unittest.TestCase): +class TestOotf_BT2100_HLG_1: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ ootf_BT2100_HLG_1` definition unit tests methods. @@ -1364,7 +1351,7 @@ def test_nan_ootf_BT2100_HLG_1(self): ootf_BT2100_HLG_1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOotf_BT2100_HLG_2(unittest.TestCase): +class TestOotf_BT2100_HLG_2: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ ootf_BT2100_HLG_2` definition unit tests methods. @@ -1502,7 +1489,7 @@ def test_nan_ootf_BT2100_HLG_1(self): ootf_BT2100_HLG_1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOotf_inverse_BT2100_HLG_1(unittest.TestCase): +class TestOotf_inverse_BT2100_HLG_1: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ ootf_inverse_BT2100_HLG_1` definition unit tests methods. @@ -1637,12 +1624,10 @@ def test_nan_ootf_inverse_BT2100_HLG_1(self): ootf_inverse_BT2100_HLG_1` definition nan support. """ - ootf_inverse_BT2100_HLG_1( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + ootf_inverse_BT2100_HLG_1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOotf_inverse_BT2100_HLG_2(unittest.TestCase): +class TestOotf_inverse_BT2100_HLG_2: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_2100.\ ootf_inverse_BT2100_HLG_2` definition unit tests methods. @@ -1777,10 +1762,4 @@ def test_nan_ootf_inverse_BT2100_HLG_2(self): ootf_inverse_BT2100_HLG_2` definition nan support. """ - ootf_inverse_BT2100_HLG_2( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + ootf_inverse_BT2100_HLG_2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_itur_bt_601.py b/colour/models/rgb/transfer_functions/tests/test_itur_bt_601.py index b73263959b..0acf687471 100644 --- a/colour/models/rgb/transfer_functions/tests/test_itur_bt_601.py +++ b/colour/models/rgb/transfer_functions/tests/test_itur_bt_601.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.itur_bt_601` module. """ -import unittest import numpy as np @@ -24,7 +23,7 @@ ] -class TestOetf_BT601(unittest.TestCase): +class TestOetf_BT601: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_601.oetf_BT601` definition unit tests methods. @@ -36,9 +35,7 @@ def test_oetf_BT601(self): oetf_BT601` definition. """ - np.testing.assert_allclose( - oetf_BT601(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT601(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS) np.testing.assert_allclose( oetf_BT601(0.015), 0.067500000000000, atol=TOLERANCE_ABSOLUTE_TESTS @@ -48,9 +45,7 @@ def test_oetf_BT601(self): oetf_BT601(0.18), 0.409007728864150, atol=TOLERANCE_ABSOLUTE_TESTS ) - np.testing.assert_allclose( - oetf_BT601(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT601(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS) def test_n_dimensional_oetf_BT601(self): """ @@ -63,21 +58,15 @@ def test_n_dimensional_oetf_BT601(self): L = np.tile(L, 6) E = np.tile(E, 6) - np.testing.assert_allclose( - oetf_BT601(L), E, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT601(L), E, atol=TOLERANCE_ABSOLUTE_TESTS) L = np.reshape(L, (2, 3)) E = np.reshape(E, (2, 3)) - np.testing.assert_allclose( - oetf_BT601(L), E, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT601(L), E, atol=TOLERANCE_ABSOLUTE_TESTS) L = np.reshape(L, (2, 3, 1)) E = np.reshape(E, (2, 3, 1)) - np.testing.assert_allclose( - oetf_BT601(L), E, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT601(L), E, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_oetf_BT601(self): """ @@ -107,7 +96,7 @@ def test_nan_oetf_BT601(self): oetf_BT601(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_inverse_BT601(unittest.TestCase): +class TestOetf_inverse_BT601: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_601.\ oetf_inverse_BT601` definition unit tests methods. @@ -192,7 +181,3 @@ def test_nan_oetf_inverse_BT601(self): """ oetf_inverse_BT601(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_itur_bt_709.py b/colour/models/rgb/transfer_functions/tests/test_itur_bt_709.py index d5a2f31ad6..4d2065e206 100644 --- a/colour/models/rgb/transfer_functions/tests/test_itur_bt_709.py +++ b/colour/models/rgb/transfer_functions/tests/test_itur_bt_709.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.itur_bt_709` module. """ -import unittest import numpy as np @@ -24,7 +23,7 @@ ] -class TestOetf_BT709(unittest.TestCase): +class TestOetf_BT709: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_709.oetf_BT709` definition unit tests methods. @@ -36,9 +35,7 @@ def test_oetf_BT709(self): oetf_BT709` definition. """ - np.testing.assert_allclose( - oetf_BT709(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT709(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS) np.testing.assert_allclose( oetf_BT709(0.015), 0.067500000000000, atol=TOLERANCE_ABSOLUTE_TESTS @@ -48,9 +45,7 @@ def test_oetf_BT709(self): oetf_BT709(0.18), 0.409007728864150, atol=TOLERANCE_ABSOLUTE_TESTS ) - np.testing.assert_allclose( - oetf_BT709(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT709(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS) def test_n_dimensional_oetf_BT709(self): """ @@ -63,21 +58,15 @@ def test_n_dimensional_oetf_BT709(self): L = np.tile(L, 6) V = np.tile(V, 6) - np.testing.assert_allclose( - oetf_BT709(L), V, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT709(L), V, atol=TOLERANCE_ABSOLUTE_TESTS) L = np.reshape(L, (2, 3)) V = np.reshape(V, (2, 3)) - np.testing.assert_allclose( - oetf_BT709(L), V, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT709(L), V, atol=TOLERANCE_ABSOLUTE_TESTS) L = np.reshape(L, (2, 3, 1)) V = np.reshape(V, (2, 3, 1)) - np.testing.assert_allclose( - oetf_BT709(L), V, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_BT709(L), V, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_oetf_BT709(self): """ @@ -107,7 +96,7 @@ def test_nan_oetf_BT709(self): oetf_BT709(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_inverse_BT709(unittest.TestCase): +class TestOetf_inverse_BT709: """ Define :func:`colour.models.rgb.transfer_functions.itur_bt_709.\ oetf_inverse_BT709` definition unit tests methods. @@ -192,7 +181,3 @@ def test_nan_oetf_inverse_BT709(self): """ oetf_inverse_BT709(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_itut_h_273.py b/colour/models/rgb/transfer_functions/tests/test_itut_h_273.py index ad00a662c9..e6c5577634 100644 --- a/colour/models/rgb/transfer_functions/tests/test_itut_h_273.py +++ b/colour/models/rgb/transfer_functions/tests/test_itut_h_273.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.itut_h_273` module. """ -import unittest import numpy as np @@ -39,7 +38,7 @@ ] -class TestOetf_H273_Log(unittest.TestCase): +class TestOetf_H273_Log: """ Define :func:`colour.models.rgb.transfer_functions.itut_h_273. oetf_H273_Log` definition unit tests methods. @@ -76,21 +75,15 @@ def test_n_dimensional_oetf_H273_Log(self): E = np.tile(E, 6) E_p = np.tile(E_p, 6) - np.testing.assert_allclose( - oetf_H273_Log(E), E_p, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_H273_Log(E), E_p, atol=TOLERANCE_ABSOLUTE_TESTS) E = np.reshape(E, (2, 3)) E_p = np.reshape(E_p, (2, 3)) - np.testing.assert_allclose( - oetf_H273_Log(E), E_p, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_H273_Log(E), E_p, atol=TOLERANCE_ABSOLUTE_TESTS) E = np.reshape(E, (2, 3, 1)) E_p = np.reshape(E_p, (2, 3, 1)) - np.testing.assert_allclose( - oetf_H273_Log(E), E_p, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(oetf_H273_Log(E), E_p, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_oetf_H273_Log(self): """ @@ -120,7 +113,7 @@ def test_nan_oetf_H273_Log(self): oetf_H273_Log(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_inverse_H273_Log(unittest.TestCase): +class TestOetf_inverse_H273_Log: """ Define :func:`colour.models.rgb.transfer_functions.itut_h_273.\ oetf_inverse_H273_Log` definition unit tests methods. @@ -200,12 +193,10 @@ def test_nan_oetf_inverse_H273_Log(self): oetf_inverse_H273_Log` definition nan support. """ - oetf_inverse_H273_Log( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + oetf_inverse_H273_Log(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_H273_LogSqrt(unittest.TestCase): +class TestOetf_H273_LogSqrt: """ Define :func:`colour.models.rgb.transfer_functions.itut_h_273. oetf_H273_LogSqrt` definition unit tests methods. @@ -286,7 +277,7 @@ def test_nan_oetf_H273_LogSqrt(self): oetf_H273_LogSqrt(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_inverse_H273_LogSqrt(unittest.TestCase): +class TestOetf_inverse_H273_LogSqrt: """ Define :func:`colour.models.rgb.transfer_functions.itut_h_273.\ oetf_inverse_H273_LogSqrt` definition unit tests methods. @@ -368,12 +359,10 @@ def test_nan_oetf_inverse_H273_LogSqrt(self): oetf_inverse_H273_LogSqrt` definition nan support. """ - oetf_inverse_H273_LogSqrt( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + oetf_inverse_H273_LogSqrt(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_H273_IEC61966_2(unittest.TestCase): +class TestOetf_H273_IEC61966_2: """ Define :func:`colour.models.rgb.transfer_functions.itut_h_273. oetf_H273_IEC61966_2` definition unit tests methods. @@ -457,12 +446,10 @@ def test_nan_oetf_H273_IEC61966_2(self): oetf_H273_IEC61966_2` definition nan support. """ - oetf_H273_IEC61966_2( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + oetf_H273_IEC61966_2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestOetf_inverse_H273_IEC61966_2(unittest.TestCase): +class TestOetf_inverse_H273_IEC61966_2: """ Define :func:`colour.models.rgb.transfer_functions.itut_h_273.\ oetf_inverse_H273_IEC61966_2` definition unit tests methods. @@ -555,7 +542,7 @@ def test_nan_oetf_inverse_H273_IEC61966_2(self): ) -class TestEotf_inverse_H273_ST428_1(unittest.TestCase): +class TestEotf_inverse_H273_ST428_1: """ Define :func:`colour.models.rgb.transfer_functions.itut_h_273. eotf_inverse_H273_ST428_1` definition unit tests methods. @@ -635,12 +622,10 @@ def test_nan_eotf_inverse_H273_ST428_1(self): eotf_inverse_H273_ST428_1` definition nan support. """ - eotf_inverse_H273_ST428_1( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + eotf_inverse_H273_ST428_1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_H273_ST428_1(unittest.TestCase): +class TestEotf_H273_ST428_1: """ Define :func:`colour.models.rgb.transfer_functions.itut_h_273.\ eotf_H273_ST428_1` definition unit tests methods. @@ -721,7 +706,3 @@ def test_nan_eotf_H273_ST428_1(self): """ eotf_H273_ST428_1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_leica_l_log.py b/colour/models/rgb/transfer_functions/tests/test_leica_l_log.py index ebf30f638a..9bd2be28db 100644 --- a/colour/models/rgb/transfer_functions/tests/test_leica_l_log.py +++ b/colour/models/rgb/transfer_functions/tests/test_leica_l_log.py @@ -3,7 +3,6 @@ leica_l_log` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestLogEncoding_LLog(unittest.TestCase): +class TestLogEncoding_LLog: """ Define :func:`colour.models.rgb.transfer_functions.leica_l_log.\ log_encoding_LLog` definition unit tests methods. @@ -130,7 +129,7 @@ def test_nan_log_encoding_LLog(self): log_encoding_LLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_LLog(unittest.TestCase): +class TestLogDecoding_LLog: """ Define :func:`colour.models.rgb.transfer_functions.leica_l_log.\ log_decoding_LLog` definition unit tests methods. @@ -231,7 +230,3 @@ def test_nan_log_decoding_LLog(self): """ log_decoding_LLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_linear.py b/colour/models/rgb/transfer_functions/tests/test_linear.py index d18f7c0568..6c867a80c6 100644 --- a/colour/models/rgb/transfer_functions/tests/test_linear.py +++ b/colour/models/rgb/transfer_functions/tests/test_linear.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.linear` module. """ -import unittest import numpy as np @@ -23,7 +22,7 @@ ] -class TestLinearFunction(unittest.TestCase): +class TestLinearFunction: """ Define :func:`colour.models.rgb.transfer_functions.linear.\ linear_function` definition unit tests methods. @@ -35,11 +34,11 @@ def test_linear_function(self): linear_function` definition. """ - self.assertEqual(linear_function(0.0), 0.0) + assert linear_function(0.0) == 0.0 - self.assertEqual(linear_function(0.18), 0.18) + assert linear_function(0.18) == 0.18 - self.assertEqual(linear_function(1.0), 1.0) + assert linear_function(1.0) == 1.0 def test_n_dimensional_linear_function(self): """ @@ -77,7 +76,3 @@ def test_nan_linear_function(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] linear_function(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_log.py b/colour/models/rgb/transfer_functions/tests/test_log.py index 7a8f4f74f0..28b387f00a 100644 --- a/colour/models/rgb/transfer_functions/tests/test_log.py +++ b/colour/models/rgb/transfer_functions/tests/test_log.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.log` module. """ -import unittest import numpy as np @@ -33,7 +32,7 @@ ] -class TestLogarithmFunction_Basic(unittest.TestCase): +class TestLogarithmFunction_Basic: """ Define :func:`colour.models.rgb.transfer_functions.log.\ logarithmic_function_basic` definition unit tests methods. @@ -130,7 +129,7 @@ def test_nan_logarithmic_function_basic(self): logarithmic_function_basic(cases, style) -class TestLogarithmFunction_Quasilog(unittest.TestCase): +class TestLogarithmFunction_Quasilog: """ Define :func:`colour.models.rgb.transfer_functions.log.\ logarithmic_function_quasilog` definition unit tests methods. @@ -173,9 +172,7 @@ def test_logarithmic_function_quasilog(self): ) np.testing.assert_allclose( - logarithmic_function_quasilog( - -0.558545621172520, "logToLin", 10, 0.75 - ), + logarithmic_function_quasilog(-0.558545621172520, "logToLin", 10, 0.75), 0.18, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -195,9 +192,7 @@ def test_logarithmic_function_quasilog(self): ) np.testing.assert_allclose( - logarithmic_function_quasilog( - 0.18, "linToLog", 10, 0.75, 0.75, 0.001 - ), + logarithmic_function_quasilog(0.18, "linToLog", 10, 0.75, 0.75, 0.001), -0.651249673628745, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -275,7 +270,7 @@ def test_nan_logarithmic_function_quasilog(self): logarithmic_function_quasilog(cases, style) -class TestLogarithmFunction_Camera(unittest.TestCase): +class TestLogarithmFunction_Camera: """ Define :func:`colour.models.rgb.transfer_functions.log.\ logarithmic_function_camera` definition unit tests methods. @@ -330,9 +325,7 @@ def test_logarithmic_function_camera(self): ) np.testing.assert_allclose( - logarithmic_function_camera( - -0.744727494896693, "cameraLogToLin", 10 - ), + logarithmic_function_camera(-0.744727494896693, "cameraLogToLin", 10), 0.180000000000000, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -344,17 +337,13 @@ def test_logarithmic_function_camera(self): ) np.testing.assert_allclose( - logarithmic_function_camera( - -0.186181873724173, "cameraLogToLin", 10, 0.25 - ), + logarithmic_function_camera(-0.186181873724173, "cameraLogToLin", 10, 0.25), 0.180000000000000, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - logarithmic_function_camera( - 0.18, "cameraLinToLog", 10, 0.25, 0.95 - ), + logarithmic_function_camera(0.18, "cameraLinToLog", 10, 0.25, 0.95), -0.191750972401961, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -368,9 +357,7 @@ def test_logarithmic_function_camera(self): ) np.testing.assert_allclose( - logarithmic_function_camera( - 0.18, "cameraLinToLog", 10, 0.25, 0.95, 0.6 - ), + logarithmic_function_camera(0.18, "cameraLinToLog", 10, 0.25, 0.95, 0.6), 0.408249027598038, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -495,7 +482,7 @@ def test_nan_logarithmic_function_camera(self): logarithmic_function_camera(cases, style) -class TestLogEncoding_Log2(unittest.TestCase): +class TestLogEncoding_Log2: """ Define :func:`colour.models.rgb.transfer_functions.log.\ log_encoding_Log2` definition unit tests methods. @@ -594,7 +581,7 @@ def test_nan_log_encoding_Log2(self): log_encoding_Log2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_Log2(unittest.TestCase): +class TestLogDecoding_Log2: """ Define :func:`colour.models.rgb.transfer_functions.log.\ log_decoding_Log2` definition unit tests methods. @@ -693,7 +680,3 @@ def test_nan_log_decoding_Log2(self): """ log_decoding_Log2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_nikon_n_log.py b/colour/models/rgb/transfer_functions/tests/test_nikon_n_log.py index 55f4b869c3..e6f542a83a 100644 --- a/colour/models/rgb/transfer_functions/tests/test_nikon_n_log.py +++ b/colour/models/rgb/transfer_functions/tests/test_nikon_n_log.py @@ -3,7 +3,6 @@ nikon_n_log` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestLogEncoding_NLog(unittest.TestCase): +class TestLogEncoding_NLog: """ Define :func:`colour.models.rgb.transfer_functions.nikon_n_log.\ log_encoding_NLog` definition unit tests methods. @@ -130,7 +129,7 @@ def test_nan_log_encoding_NLog(self): log_encoding_NLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_NLog(unittest.TestCase): +class TestLogDecoding_NLog: """ Define :func:`colour.models.rgb.transfer_functions.nikon_n_log.\ log_decoding_NLog` definition unit tests methods. @@ -231,7 +230,3 @@ def test_nan_log_decoding_NLog(self): """ log_decoding_NLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_panalog.py b/colour/models/rgb/transfer_functions/tests/test_panalog.py index a2eebe75ac..782f333d97 100644 --- a/colour/models/rgb/transfer_functions/tests/test_panalog.py +++ b/colour/models/rgb/transfer_functions/tests/test_panalog.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.panalog` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestLogEncoding_Panalog(unittest.TestCase): +class TestLogEncoding_Panalog: """ Define :func:`colour.models.rgb.transfer_functions.panalog.\ log_encoding_Panalog` definition unit tests methods. @@ -109,12 +108,10 @@ def test_nan_log_encoding_Panalog(self): log_encoding_Panalog` definition nan support. """ - log_encoding_Panalog( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_Panalog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_Panalog(unittest.TestCase): +class TestLogDecoding_Panalog: """ Define :func:`colour.models.rgb.transfer_functions.panalog.\ log_decoding_Panalog` definition unit tests methods. @@ -196,10 +193,4 @@ def test_nan_log_decoding_Panalog(self): log_decoding_Panalog` definition nan support. """ - log_decoding_Panalog( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_Panalog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_panasonic_vlog.py b/colour/models/rgb/transfer_functions/tests/test_panasonic_vlog.py index 8c8d3bc31a..b915cb8652 100644 --- a/colour/models/rgb/transfer_functions/tests/test_panasonic_vlog.py +++ b/colour/models/rgb/transfer_functions/tests/test_panasonic_vlog.py @@ -3,7 +3,6 @@ panasonic_v_log` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestLogEncoding_VLog(unittest.TestCase): +class TestLogEncoding_VLog: """ Define :func:`colour.models.rgb.transfer_functions.panasonic_v_log.\ log_encoding_VLog` definition unit tests methods. @@ -128,7 +127,7 @@ def test_nan_log_encoding_VLog(self): log_encoding_VLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_VLog(unittest.TestCase): +class TestLogDecoding_VLog: """ Define :func:`colour.models.rgb.transfer_functions.panasonic_v_log.\ log_decoding_VLog` definition unit tests methods. @@ -227,7 +226,3 @@ def test_nan_log_decoding_VLog(self): """ log_decoding_VLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_pivoted_log.py b/colour/models/rgb/transfer_functions/tests/test_pivoted_log.py index 81a16222ab..10416d4673 100644 --- a/colour/models/rgb/transfer_functions/tests/test_pivoted_log.py +++ b/colour/models/rgb/transfer_functions/tests/test_pivoted_log.py @@ -3,7 +3,6 @@ pivoted_log` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestLogEncoding_PivotedLog(unittest.TestCase): +class TestLogEncoding_PivotedLog: """ Define :func:`colour.models.rgb.transfer_functions.pivoted_log.\ log_encoding_PivotedLog` definition unit tests methods. @@ -109,12 +108,10 @@ def test_nan_log_encoding_PivotedLog(self): log_encoding_PivotedLog` definition nan support. """ - log_encoding_PivotedLog( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_PivotedLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_PivotedLog(unittest.TestCase): +class TestLogDecoding_PivotedLog: """ Define :func:`colour.models.rgb.transfer_functions.pivoted_log.\ log_decoding_PivotedLog` definition unit tests methods. @@ -196,10 +193,4 @@ def test_nan_log_decoding_PivotedLog(self): log_decoding_PivotedLog` definition nan support. """ - log_decoding_PivotedLog( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_PivotedLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_red.py b/colour/models/rgb/transfer_functions/tests/test_red.py index 186a1f3a71..3e8de13745 100644 --- a/colour/models/rgb/transfer_functions/tests/test_red.py +++ b/colour/models/rgb/transfer_functions/tests/test_red.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.red` module. """ -import unittest import numpy as np @@ -49,7 +48,7 @@ ] -class TestLogEncoding_REDLog(unittest.TestCase): +class TestLogEncoding_REDLog: """ Define :func:`colour.models.rgb.transfer_functions.red.\ log_encoding_REDLog` definition unit tests methods. @@ -127,12 +126,10 @@ def test_nan_log_encoding_REDLog(self): log_encoding_REDLog` definition nan support. """ - log_encoding_REDLog( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_REDLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_REDLog(unittest.TestCase): +class TestLogDecoding_REDLog: """ Define :func:`colour.models.rgb.transfer_functions.red.\ log_decoding_REDLog` definition unit tests methods. @@ -210,12 +207,10 @@ def test_nan_log_decoding_REDLog(self): log_decoding_REDLog` definition nan support. """ - log_decoding_REDLog( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_REDLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_REDLogFilm(unittest.TestCase): +class TestLogEncoding_REDLogFilm: """ Define :func:`colour.models.rgb.transfer_functions.red.\ log_encoding_REDLogFilm` definition unit tests methods. @@ -297,12 +292,10 @@ def test_nan_log_encoding_REDLogFilm(self): log_encoding_REDLogFilm` definition nan support. """ - log_encoding_REDLogFilm( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_REDLogFilm(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_REDLogFilm(unittest.TestCase): +class TestLogDecoding_REDLogFilm: """ Define :func:`colour.models.rgb.transfer_functions.red.\ log_decoding_REDLogFilm` definition unit tests methods. @@ -384,12 +377,10 @@ def test_nan_log_decoding_REDLogFilm(self): log_decoding_REDLogFilm` definition nan support. """ - log_decoding_REDLogFilm( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_REDLogFilm(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_Log3G10_v1(unittest.TestCase): +class TestLogEncoding_Log3G10_v1: """ Define :func:`colour.models.rgb.transfer_functions.red.\ log_encoding_Log3G10_v1` definition unit tests methods. @@ -469,12 +460,10 @@ def test_nan_log_encoding_Log3G10_v1(self): log_encoding_Log3G10_v1` definition nan support. """ - log_encoding_Log3G10_v1( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_Log3G10_v1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_Log3G10_v1(unittest.TestCase): +class TestLogDecoding_Log3G10_v1: """ Define :func:`colour.models.rgb.transfer_functions.red.\ log_decoding_Log3G10_v1` definition unit tests methods. @@ -554,12 +543,10 @@ def test_nan_log_decoding_Log3G10_v1(self): log_decoding_Log3G10_v1` definition nan support. """ - log_decoding_Log3G10_v1( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_Log3G10_v1(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_Log3G10_v2(unittest.TestCase): +class TestLogEncoding_Log3G10_v2: """ Define :func:`colour.models.rgb.transfer_functions.red.\ log_encoding_Log3G10_v2` definition unit tests methods. @@ -641,12 +628,10 @@ def test_nan_log_encoding_Log3G10_v2(self): log_encoding_Log3G10_v2` definition nan support. """ - log_encoding_Log3G10_v2( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_Log3G10_v2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_Log3G10_v2(unittest.TestCase): +class TestLogDecoding_Log3G10_v2: """ Define :func:`colour.models.rgb.transfer_functions.red.\ log_decoding_Log3G10_v2` definition unit tests methods. @@ -728,12 +713,10 @@ def test_nan_log_decoding_Log3G10_v2(self): log_decoding_Log3G10_v2` definition nan support. """ - log_decoding_Log3G10_v2( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_Log3G10_v2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_Log3G10_v3(unittest.TestCase): +class TestLogEncoding_Log3G10_v3: """ Define :func:`colour.models.rgb.transfer_functions.red.\ log_encoding_Log3G10_v3` definition unit tests methods. @@ -815,12 +798,10 @@ def test_nan_log_encoding_Log3G10_v3(self): log_encoding_Log3G10_v3` definition nan support. """ - log_encoding_Log3G10_v3( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_Log3G10_v3(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_Log3G10_v3(unittest.TestCase): +class TestLogDecoding_Log3G10_v3: """ Define :func:`colour.models.rgb.transfer_functions.red.\ log_decoding_Log3G10_v3` definition unit tests methods. @@ -902,12 +883,10 @@ def test_nan_log_decoding_Log3G10_v3(self): log_decoding_Log3G10_v3` definition nan support. """ - log_decoding_Log3G10_v3( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_decoding_Log3G10_v3(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_Log3G12(unittest.TestCase): +class TestLogEncoding_Log3G12: """ Define :func:`colour.models.rgb.transfer_functions.red.\ log_encoding_Log3G12` definition unit tests methods. @@ -993,12 +972,10 @@ def test_nan_log_encoding_Log3G12(self): log_encoding_Log3G12` definition nan support. """ - log_encoding_Log3G12( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_Log3G12(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_Log3G12(unittest.TestCase): +class TestLogDecoding_Log3G12: """ Define :func:`colour.models.rgb.transfer_functions.red.\ log_decoding_Log3G12` definition unit tests methods. @@ -1084,10 +1061,4 @@ def test_nan_log_decoding_Log3G12(self): log_decoding_Log3G12` definition nan support. """ - log_decoding_Log3G12( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_Log3G12(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_rimm_romm_rgb.py b/colour/models/rgb/transfer_functions/tests/test_rimm_romm_rgb.py index 4dab824f3e..4b2baa75bd 100644 --- a/colour/models/rgb/transfer_functions/tests/test_rimm_romm_rgb.py +++ b/colour/models/rgb/transfer_functions/tests/test_rimm_romm_rgb.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.rimm_romm_rgb` module. """ -import unittest import numpy as np @@ -35,7 +34,7 @@ ] -class TestCctfEncoding_ROMMRGB(unittest.TestCase): +class TestCctfEncoding_ROMMRGB: """ Define :func:`colour.models.rgb.transfer_functions.rimm_romm_rgb.\ cctf_encoding_ROMMRGB` definition unit tests methods. @@ -61,11 +60,9 @@ def test_cctf_encoding_ROMMRGB(self): cctf_encoding_ROMMRGB(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS ) - self.assertEqual(cctf_encoding_ROMMRGB(0.18, out_int=True), 98) + assert cctf_encoding_ROMMRGB(0.18, out_int=True) == 98 - self.assertEqual( - cctf_encoding_ROMMRGB(0.18, bit_depth=12, out_int=True), 1579 - ) + assert cctf_encoding_ROMMRGB(0.18, bit_depth=12, out_int=True) == 1579 def test_n_dimensional_cctf_encoding_ROMMRGB(self): """ @@ -119,12 +116,10 @@ def test_nan_cctf_encoding_ROMMRGB(self): cctf_encoding_ROMMRGB` definition nan support. """ - cctf_encoding_ROMMRGB( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + cctf_encoding_ROMMRGB(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestCctfDecoding_ROMMRGB(unittest.TestCase): +class TestCctfDecoding_ROMMRGB: """ Define :func:`colour.models.rgb.transfer_functions.rimm_romm_rgb. cctf_decoding_ROMMRGB` definition unit tests methods. @@ -214,12 +209,10 @@ def test_nan_cctf_decoding_ROMMRGB(self): cctf_decoding_ROMMRGB` definition nan support. """ - cctf_decoding_ROMMRGB( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + cctf_decoding_ROMMRGB(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestCctfEncoding_RIMMRGB(unittest.TestCase): +class TestCctfEncoding_RIMMRGB: """ Define :func:`colour.models.rgb.transfer_functions.rimm_romm_rgb.\ cctf_encoding_RIMMRGB` definition unit tests methods. @@ -247,11 +240,9 @@ def test_cctf_encoding_RIMMRGB(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(cctf_encoding_RIMMRGB(0.18, out_int=True), 74) + assert cctf_encoding_RIMMRGB(0.18, out_int=True) == 74 - self.assertEqual( - cctf_encoding_RIMMRGB(0.18, bit_depth=12, out_int=True), 1194 - ) + assert cctf_encoding_RIMMRGB(0.18, bit_depth=12, out_int=True) == 1194 def test_n_dimensional_cctf_encoding_RIMMRGB(self): """ @@ -305,12 +296,10 @@ def test_nan_cctf_encoding_RIMMRGB(self): cctf_encoding_RIMMRGB` definition nan support. """ - cctf_encoding_RIMMRGB( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + cctf_encoding_RIMMRGB(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestCctfDecoding_RIMMRGB(unittest.TestCase): +class TestCctfDecoding_RIMMRGB: """ Define :func:`colour.models.rgb.transfer_functions.rimm_romm_rgb. cctf_decoding_RIMMRGB` definition unit tests methods. @@ -402,12 +391,10 @@ def test_nan_cctf_decoding_RIMMRGB(self): cctf_decoding_RIMMRGB` definition nan support. """ - cctf_decoding_RIMMRGB( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + cctf_decoding_RIMMRGB(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLog_encoding_ERIMMRGB(unittest.TestCase): +class TestLog_encoding_ERIMMRGB: """ Define :func:`colour.models.rgb.transfer_functions.rimm_romm_rgb.\ log_encoding_ERIMMRGB` definition unit tests methods. @@ -435,11 +422,9 @@ def test_log_encoding_ERIMMRGB(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual(log_encoding_ERIMMRGB(0.18, out_int=True), 105) + assert log_encoding_ERIMMRGB(0.18, out_int=True) == 105 - self.assertEqual( - log_encoding_ERIMMRGB(0.18, bit_depth=12, out_int=True), 1679 - ) + assert log_encoding_ERIMMRGB(0.18, bit_depth=12, out_int=True) == 1679 def test_n_dimensional_log_encoding_ERIMMRGB(self): """ @@ -493,12 +478,10 @@ def test_nan_log_encoding_ERIMMRGB(self): log_encoding_ERIMMRGB` definition nan support. """ - log_encoding_ERIMMRGB( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_ERIMMRGB(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLog_decoding_ERIMMRGB(unittest.TestCase): +class TestLog_decoding_ERIMMRGB: """ Define :func:`colour.models.rgb.transfer_functions.rimm_romm_rgb. log_decoding_ERIMMRGB` definition unit tests methods. @@ -590,10 +573,4 @@ def test_nan_log_decoding_ERIMMRGB(self): log_decoding_ERIMMRGB` definition nan support. """ - log_decoding_ERIMMRGB( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_ERIMMRGB(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/tests/test_smpte_240m.py b/colour/models/rgb/transfer_functions/tests/test_smpte_240m.py index d23b9f541a..beb8fbf6f8 100644 --- a/colour/models/rgb/transfer_functions/tests/test_smpte_240m.py +++ b/colour/models/rgb/transfer_functions/tests/test_smpte_240m.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.smpte_240m` module. """ -import unittest import numpy as np @@ -24,7 +23,7 @@ ] -class TestOetf_SMPTE240M(unittest.TestCase): +class TestOetf_SMPTE240M: """ Define :func:`colour.models.rgb.transfer_functions.smpte_240m.\ oetf_SMPTE240M` definition unit tests methods. @@ -111,7 +110,7 @@ def test_nan_oetf_SMPTE240M(self): oetf_SMPTE240M(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_SMPTE240M(unittest.TestCase): +class TestEotf_SMPTE240M: """ Define :func:`colour.models.rgb.transfer_functions.smpte_240m.\ eotf_SMPTE240M` definition unit tests methods. @@ -196,7 +195,3 @@ def test_nan_eotf_SMPTE240M(self): """ eotf_SMPTE240M(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_sony.py b/colour/models/rgb/transfer_functions/tests/test_sony.py index 3b247b3f00..1845050839 100644 --- a/colour/models/rgb/transfer_functions/tests/test_sony.py +++ b/colour/models/rgb/transfer_functions/tests/test_sony.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.sony` module. """ -import unittest import numpy as np @@ -35,7 +34,7 @@ ] -class TestLogEncoding_SLog(unittest.TestCase): +class TestLogEncoding_SLog: """ Define :func:`colour.models.rgb.transfer_functions.sony.\ log_encoding_SLog` definition unit tests methods. @@ -138,7 +137,7 @@ def test_nan_log_encoding_SLog(self): log_encoding_SLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_SLog(unittest.TestCase): +class TestLogDecoding_SLog: """ Define :func:`colour.models.rgb.transfer_functions.sony.\ log_decoding_SLog` definition unit tests methods. @@ -241,7 +240,7 @@ def test_nan_log_decoding_SLog(self): log_decoding_SLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_SLog2(unittest.TestCase): +class TestLogEncoding_SLog2: """ Define :func:`colour.models.rgb.transfer_functions.sony.\ log_encoding_SLog2` definition unit tests methods. @@ -344,7 +343,7 @@ def test_nan_log_encoding_SLog2(self): log_encoding_SLog2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_SLog2(unittest.TestCase): +class TestLogDecoding_SLog2: """ Define :func:`colour.models.rgb.transfer_functions.sony.\ log_decoding_SLog2` definition unit tests methods. @@ -447,7 +446,7 @@ def test_nan_log_decoding_SLog2(self): log_decoding_SLog2(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogEncoding_SLog3(unittest.TestCase): +class TestLogEncoding_SLog3: """ Define :func:`colour.models.rgb.transfer_functions.sony.\ log_encoding_SLog3` definition unit tests methods. @@ -550,7 +549,7 @@ def test_nan_log_encoding_SLog3(self): log_encoding_SLog3(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_SLog3(unittest.TestCase): +class TestLogDecoding_SLog3: """ Define :func:`colour.models.rgb.transfer_functions.sony.\ log_decoding_SLog3` definition unit tests methods. @@ -651,7 +650,3 @@ def test_nan_log_decoding_SLog3(self): """ log_decoding_SLog3(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_srgb.py b/colour/models/rgb/transfer_functions/tests/test_srgb.py index 99c336a7c4..c3425ea903 100644 --- a/colour/models/rgb/transfer_functions/tests/test_srgb.py +++ b/colour/models/rgb/transfer_functions/tests/test_srgb.py @@ -3,7 +3,6 @@ module. """ -import unittest import numpy as np @@ -24,7 +23,7 @@ ] -class TestEotf_inverse_sRGB(unittest.TestCase): +class TestEotf_inverse_sRGB: """ Define :func:`colour.models.rgb.transfer_functions.sRGB.eotf_inverse_sRGB` definition unit tests methods. @@ -105,7 +104,7 @@ def test_nan_eotf_inverse_sRGB(self): eotf_inverse_sRGB(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_sRGB(unittest.TestCase): +class TestEotf_sRGB: """ Define :func:`colour.models.rgb.transfer_functions.sRGB.eotf_sRGB` definition unit tests methods. @@ -117,17 +116,13 @@ def test_eotf_sRGB(self): eotf_sRGB` definition. """ - np.testing.assert_allclose( - eotf_sRGB(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_sRGB(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS) np.testing.assert_allclose( eotf_sRGB(0.461356129500442), 0.18, atol=TOLERANCE_ABSOLUTE_TESTS ) - np.testing.assert_allclose( - eotf_sRGB(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_sRGB(1.0), 1.0, atol=TOLERANCE_ABSOLUTE_TESTS) def test_n_dimensional_eotf_sRGB(self): """ @@ -140,21 +135,15 @@ def test_n_dimensional_eotf_sRGB(self): V = np.tile(V, 6) L = np.tile(L, 6) - np.testing.assert_allclose( - eotf_sRGB(V), L, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_sRGB(V), L, atol=TOLERANCE_ABSOLUTE_TESTS) V = np.reshape(V, (2, 3)) L = np.reshape(L, (2, 3)) - np.testing.assert_allclose( - eotf_sRGB(V), L, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_sRGB(V), L, atol=TOLERANCE_ABSOLUTE_TESTS) V = np.reshape(V, (2, 3, 1)) L = np.reshape(L, (2, 3, 1)) - np.testing.assert_allclose( - eotf_sRGB(V), L, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_sRGB(V), L, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_eotf_sRGB(self): """ @@ -182,7 +171,3 @@ def test_nan_eotf_sRGB(self): """ eotf_sRGB(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_st_2084.py b/colour/models/rgb/transfer_functions/tests/test_st_2084.py index de7b742f0c..49e21f83bf 100644 --- a/colour/models/rgb/transfer_functions/tests/test_st_2084.py +++ b/colour/models/rgb/transfer_functions/tests/test_st_2084.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.st_2084` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestEotf_inverse_ST2084(unittest.TestCase): +class TestEotf_inverse_ST2084: """ Define :func:`colour.models.rgb.transfer_functions.st_2084.\ eotf_inverse_ST2084` definition unit tests methods. @@ -113,12 +112,10 @@ def test_nan_eotf_inverse_ST2084(self): eotf_inverse_ST2084` definition nan support. """ - eotf_inverse_ST2084( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + eotf_inverse_ST2084(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestEotf_ST2084(unittest.TestCase): +class TestEotf_ST2084: """ Define :func:`colour.models.rgb.transfer_functions.st_2084.eotf_ST2084` definition unit tests methods. @@ -130,9 +127,7 @@ def test_eotf_ST2084(self): eotf_ST2084` definition. """ - np.testing.assert_allclose( - eotf_ST2084(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_ST2084(0.0), 0.0, atol=TOLERANCE_ABSOLUTE_TESTS) np.testing.assert_allclose( eotf_ST2084(0.508078421517399), 100, atol=TOLERANCE_ABSOLUTE_TESTS @@ -157,21 +152,15 @@ def test_n_dimensional_eotf_ST2084(self): N = np.tile(N, 6) C = np.tile(C, 6) - np.testing.assert_allclose( - eotf_ST2084(N), C, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_ST2084(N), C, atol=TOLERANCE_ABSOLUTE_TESTS) N = np.reshape(N, (2, 3)) C = np.reshape(C, (2, 3)) - np.testing.assert_allclose( - eotf_ST2084(N), C, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_ST2084(N), C, atol=TOLERANCE_ABSOLUTE_TESTS) N = np.reshape(N, (2, 3, 1)) C = np.reshape(C, (2, 3, 1)) - np.testing.assert_allclose( - eotf_ST2084(N), C, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(eotf_ST2084(N), C, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_eotf_ST2084(self): """ @@ -199,7 +188,3 @@ def test_nan_eotf_ST2084(self): """ eotf_ST2084(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/rgb/transfer_functions/tests/test_viper_log.py b/colour/models/rgb/transfer_functions/tests/test_viper_log.py index d858005a29..df300893e8 100644 --- a/colour/models/rgb/transfer_functions/tests/test_viper_log.py +++ b/colour/models/rgb/transfer_functions/tests/test_viper_log.py @@ -3,7 +3,6 @@ :mod:`colour.models.rgb.transfer_functions.viper_log` module. """ -import unittest import numpy as np @@ -27,7 +26,7 @@ ] -class TestLogEncoding_ViperLog(unittest.TestCase): +class TestLogEncoding_ViperLog: """ Define :func:`colour.models.rgb.transfer_functions.viper_log.\ log_encoding_ViperLog` definition unit tests methods. @@ -105,12 +104,10 @@ def test_nan_log_encoding_ViperLog(self): log_encoding_ViperLog` definition nan support. """ - log_encoding_ViperLog( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + log_encoding_ViperLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestLogDecoding_ViperLog(unittest.TestCase): +class TestLogDecoding_ViperLog: """ Define :func:`colour.models.rgb.transfer_functions.viper_log.\ log_decoding_ViperLog` definition unit tests methods. @@ -188,10 +185,4 @@ def test_nan_log_decoding_ViperLog(self): log_decoding_ViperLog` definition nan support. """ - log_decoding_ViperLog( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) - - -if __name__ == "__main__": - unittest.main() + log_decoding_ViperLog(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) diff --git a/colour/models/rgb/transfer_functions/viper_log.py b/colour/models/rgb/transfer_functions/viper_log.py index d9ff20b404..ca08999035 100644 --- a/colour/models/rgb/transfer_functions/viper_log.py +++ b/colour/models/rgb/transfer_functions/viper_log.py @@ -2,7 +2,7 @@ Viper Log Encoding ================== -Defines the *Viper Log* encoding: +Define the *Viper Log* encoding: - :func:`colour.models.log_encoding_ViperLog` - :func:`colour.models.log_decoding_ViperLog` diff --git a/colour/models/rgb/ycbcr.py b/colour/models/rgb/ycbcr.py index 1dfe174146..5647ae8881 100644 --- a/colour/models/rgb/ycbcr.py +++ b/colour/models/rgb/ycbcr.py @@ -2,7 +2,7 @@ Y'CbCr Colour Encoding ====================== -Defines the *Y'CbCr* colour encoding related attributes and objects: +Define the *Y'CbCr* colour encoding related attributes and objects: - :attr:`colour.WEIGHTS_YCBCR` - :func:`colour.matrix_YCbCr` @@ -244,12 +244,12 @@ def matrix_YCbCr( Matching the default output of the :func:`colour.RGB_to_YCbCr` is done as follows: - >>> from colour.algebra import vector_dot + >>> from colour.algebra import vecmul >>> from colour.utilities import as_int_array >>> RGB = np.array([1.0, 1.0, 1.0]) >>> RGB_to_YCbCr(RGB) # doctest: +ELLIPSIS array([ 0.9215686..., 0.5019607..., 0.5019607...]) - >>> YCbCr = vector_dot(np.linalg.inv(matrix_YCbCr(is_legal=True)), RGB) + >>> YCbCr = vecmul(np.linalg.inv(matrix_YCbCr(is_legal=True)), RGB) >>> YCbCr += offset_YCbCr(is_legal=True) >>> YCbCr # doctest: +ELLIPSIS array([ 0.9215686..., 0.5019607..., 0.5019607...]) @@ -261,7 +261,7 @@ def matrix_YCbCr( >>> RGB_to_YCbCr(RGB, in_bits=8, in_int=True, out_bits=8, out_int=True) ... # doctest: +SKIP array([ 38, 140, 171]) - >>> YCbCr = vector_dot(np.linalg.inv(matrix_YCbCr(is_legal=True)), RGB) + >>> YCbCr = vecmul(np.linalg.inv(matrix_YCbCr(is_legal=True)), RGB) >>> YCbCr += offset_YCbCr(is_legal=True, is_int=True) >>> as_int_array(np.around(YCbCr)) ... # doctest: +SKIP @@ -348,7 +348,7 @@ def RGB_to_YCbCr( *(0.2126, 0.0722)*, the weightings for *ITU-R BT.709*. in_bits Bit-depth for int input, or used in the calculation of the - denominator for legal range float values, i.e. 8-bit means the float + denominator for legal range float values, i.e., 8-bit means the float value for legal white is *235 / 255*. Default is *10*. in_legal Whether to treat the input values as legal range. Default is *False*. @@ -357,7 +357,7 @@ def RGB_to_YCbCr( Default is *False*. out_bits Bit-depth for int output, or used in the calculation of the - denominator for legal range float values, i.e. 8-bit means the float + denominator for legal range float values, i.e., 8-bit means the float value for legal white is *235 / 255*. Ignored if ``out_legal`` and ``out_int`` are both *False*. Default is *8*. out_legal @@ -436,9 +436,7 @@ def RGB_to_YCbCr( Matching the float output of *The Foundry Nuke*'s *Colorspace* node set to *YCbCr*: - >>> RGB_to_YCbCr( - ... RGB, out_range=(16 / 255, 235 / 255, 15.5 / 255, 239.5 / 255) - ... ) + >>> RGB_to_YCbCr(RGB, out_range=(16 / 255, 235 / 255, 15.5 / 255, 239.5 / 255)) ... # doctest: +ELLIPSIS array([ 0.9215686..., 0.5 , 0.5 ]) @@ -493,9 +491,7 @@ def RGB_to_YCbCr( RGB = as_float_array(RGB) if in_int else to_domain_1(RGB) Kr, Kb = K - RGB_min, RGB_max = kwargs.get( - "in_range", CV_range(in_bits, in_legal, in_int) - ) + RGB_min, RGB_max = kwargs.get("in_range", CV_range(in_bits, in_legal, in_int)) Y_min, Y_max, C_min, C_max = kwargs.get( "out_range", ranges_YCbCr(out_bits, out_legal, out_int) ) @@ -518,9 +514,7 @@ def RGB_to_YCbCr( if out_int: return as_int_array( - round_BT2100( - np.clip(YCbCr, 0, 2**out_bits - 1) if clamp_int else YCbCr - ) + round_BT2100(np.clip(YCbCr, 0, 2**out_bits - 1) if clamp_int else YCbCr) ) else: return from_range_1(YCbCr) @@ -552,7 +546,7 @@ def YCbCr_to_RGB( *(0.2126, 0.0722)*, the weightings for *ITU-R BT.709*. in_bits Bit-depth for int input, or used in the calculation of the - denominator for legal range float values, i.e. 8-bit means the float + denominator for legal range float values, i.e., 8-bit means the float value for legal white is *235 / 255*. Default is *8*. in_legal Whether to treat the input values as legal range. Default is *True*. @@ -561,7 +555,7 @@ def YCbCr_to_RGB( Default is *False*. out_bits Bit-depth for int output, or used in the calculation of the - denominator for legal range float values, i.e. 8-bit means the float + denominator for legal range float values, i.e., 8-bit means the float value for legal white is *235 / 255*. Ignored if ``out_legal`` and ``out_int`` are both *False*. Default is *10*. out_legal @@ -636,9 +630,7 @@ def YCbCr_to_RGB( Y_min, Y_max, C_min, C_max = kwargs.get( "in_range", ranges_YCbCr(in_bits, in_legal, in_int) ) - RGB_min, RGB_max = kwargs.get( - "out_range", CV_range(out_bits, out_legal, out_int) - ) + RGB_min, RGB_max = kwargs.get("out_range", CV_range(out_bits, out_legal, out_int)) Y -= Y_min Cb -= (C_max + C_min) / 2 @@ -656,9 +648,7 @@ def YCbCr_to_RGB( RGB = ( as_int_array( - round_BT2100( - np.clip(RGB, 0, 2**out_bits - 1) if clamp_int else RGB - ) + round_BT2100(np.clip(RGB, 0, 2**out_bits - 1) if clamp_int else RGB) ) if out_int else from_range_1(RGB) @@ -685,7 +675,7 @@ def RGB_to_YcCbcCrc( Input *RGB* array of linear float values. out_bits Bit-depth for int output, or used in the calculation of the - denominator for legal range float values, i.e. 8-bit means the float + denominator for legal range float values, i.e., 8-bit means the float value for legal white is *235 / 255*. Ignored if ``out_legal`` and ``out_int`` are both *False*. Default is *10*. out_legal @@ -798,7 +788,7 @@ def YcCbcCrc_to_RGB( Input *Yc'Cbc'Crc'* colour encoding array of linear float values. in_bits Bit-depth for int input, or used in the calculation of the - denominator for legal range float values, i.e. 8-bit means the float + denominator for legal range float values, i.e., 8-bit means the float value for legal white is *235 / 255*. Default is *10*. in_legal Whether to treat the input values as legal range. Default is *False*. diff --git a/colour/models/rgb/ycocg.py b/colour/models/rgb/ycocg.py index 5e5741eeec..63b4b49757 100644 --- a/colour/models/rgb/ycocg.py +++ b/colour/models/rgb/ycocg.py @@ -2,7 +2,7 @@ YCoCg Colour Encoding ====================== -Defines the *YCoCg* colour encoding related transformations: +Define the *YCoCg* colour encoding related transformations: - :func:`colour.RGB_to_YCoCg` - :func:`colour.YCoCg_to_RGB` @@ -19,7 +19,7 @@ import numpy as np -from colour.algebra import vector_dot +from colour.algebra import vecmul from colour.hints import ArrayLike, NDArrayFloat __author__ = "Colour Developers" @@ -82,7 +82,7 @@ def RGB_to_YCoCg(RGB: ArrayLike) -> NDArrayFloat: array([ 0.5625, 0.125 , -0.0625]) """ - return vector_dot(MATRIX_RGB_TO_YCOCG, RGB) + return vecmul(MATRIX_RGB_TO_YCOCG, RGB) def YCoCg_to_RGB(YCoCg: ArrayLike) -> NDArrayFloat: @@ -112,4 +112,4 @@ def YCoCg_to_RGB(YCoCg: ArrayLike) -> NDArrayFloat: array([ 0.75, 0.5 , 0.5 ]) """ - return vector_dot(MATRIX_YCOCG_TO_RGB, YCoCg) + return vecmul(MATRIX_YCOCG_TO_RGB, YCoCg) diff --git a/colour/models/tests/test_cam02_ucs.py b/colour/models/tests/test_cam02_ucs.py index 6cd650871a..a34c09eaab 100644 --- a/colour/models/tests/test_cam02_ucs.py +++ b/colour/models/tests/test_cam02_ucs.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.cam02_ucs` module.""" -import unittest from itertools import product import numpy as np @@ -50,13 +48,13 @@ ] -class TestJMh_CIECAM02_to_UCS_Luo2006(unittest.TestCase): +class TestJMh_CIECAM02_to_UCS_Luo2006: """ Define :func:`colour.models.cam02_ucs.JMh_CIECAM02_to_UCS_Luo2006` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" XYZ = np.array([19.01, 20.00, 21.78]) @@ -66,9 +64,7 @@ def setUp(self): surround = VIEWING_CONDITIONS_CIECAM02["Average"] specification = XYZ_to_CIECAM02(XYZ, XYZ_w, L_A, Y_b, surround) - self._JMh = np.array( - [specification.J, specification.M, specification.h] - ) + self._JMh = np.array([specification.J, specification.M, specification.h]) def test_JMh_CIECAM02_to_UCS_Luo2006(self): """ @@ -131,16 +127,12 @@ def test_n_dimensional_JMh_CIECAM02_to_UCS_Luo2006(self): """ JMh = self._JMh - Jpapbp = JMh_CIECAM02_to_UCS_Luo2006( - JMh, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ) + Jpapbp = JMh_CIECAM02_to_UCS_Luo2006(JMh, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]) JMh = np.tile(JMh, (6, 1)) Jpapbp = np.tile(Jpapbp, (6, 1)) np.testing.assert_allclose( - JMh_CIECAM02_to_UCS_Luo2006( - JMh, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ), + JMh_CIECAM02_to_UCS_Luo2006(JMh, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]), Jpapbp, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -148,9 +140,7 @@ def test_n_dimensional_JMh_CIECAM02_to_UCS_Luo2006(self): JMh = np.reshape(JMh, (2, 3, 3)) Jpapbp = np.reshape(Jpapbp, (2, 3, 3)) np.testing.assert_allclose( - JMh_CIECAM02_to_UCS_Luo2006( - JMh, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ), + JMh_CIECAM02_to_UCS_Luo2006(JMh, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]), Jpapbp, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -162,9 +152,7 @@ def test_domain_range_scale_JMh_CIECAM02_to_UCS_Luo2006(self): """ JMh = self._JMh - Jpapbp = JMh_CIECAM02_to_UCS_Luo2006( - JMh, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ) + Jpapbp = JMh_CIECAM02_to_UCS_Luo2006(JMh, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]) d_r = ( ("reference", 1, 1), @@ -190,12 +178,10 @@ def test_nan_JMh_CIECAM02_to_UCS_Luo2006(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - JMh_CIECAM02_to_UCS_Luo2006( - cases, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ) + JMh_CIECAM02_to_UCS_Luo2006(cases, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]) -class TestUCS_Luo2006_to_JMh_CIECAM02(unittest.TestCase): +class TestUCS_Luo2006_to_JMh_CIECAM02: """ Define :func:`colour.models.cam02_ucs.UCS_Luo2006_to_JMh_CIECAM02` definition unit tests methods. @@ -221,9 +207,7 @@ def test_UCS_Luo2006_to_JMh_CIECAM02(self): np.array([54.90433134, -0.08442362, -0.06848314]), COEFFICIENTS_UCS_LUO2006["CAM02-LCD"], ), - CAM02LCD_to_JMh_CIECAM02( - np.array([54.90433134, -0.08442362, -0.06848314]) - ), + CAM02LCD_to_JMh_CIECAM02(np.array([54.90433134, -0.08442362, -0.06848314])), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -241,9 +225,7 @@ def test_UCS_Luo2006_to_JMh_CIECAM02(self): np.array([54.90433134, -0.08442362, -0.06848314]), COEFFICIENTS_UCS_LUO2006["CAM02-SCD"], ), - CAM02SCD_to_JMh_CIECAM02( - np.array([54.90433134, -0.08442362, -0.06848314]) - ), + CAM02SCD_to_JMh_CIECAM02(np.array([54.90433134, -0.08442362, -0.06848314])), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -261,9 +243,7 @@ def test_UCS_Luo2006_to_JMh_CIECAM02(self): np.array([54.90433134, -0.08442362, -0.06848314]), COEFFICIENTS_UCS_LUO2006["CAM02-UCS"], ), - CAM02UCS_to_JMh_CIECAM02( - np.array([54.90433134, -0.08442362, -0.06848314]) - ), + CAM02UCS_to_JMh_CIECAM02(np.array([54.90433134, -0.08442362, -0.06848314])), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -274,16 +254,12 @@ def test_n_dimensional_UCS_Luo2006_to_JMh_CIECAM02(self): """ Jpapbp = np.array([54.90433134, -0.08442362, -0.06848314]) - JMh = UCS_Luo2006_to_JMh_CIECAM02( - Jpapbp, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ) + JMh = UCS_Luo2006_to_JMh_CIECAM02(Jpapbp, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]) Jpapbp = np.tile(Jpapbp, (6, 1)) JMh = np.tile(JMh, (6, 1)) np.testing.assert_allclose( - UCS_Luo2006_to_JMh_CIECAM02( - Jpapbp, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ), + UCS_Luo2006_to_JMh_CIECAM02(Jpapbp, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]), JMh, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -291,9 +267,7 @@ def test_n_dimensional_UCS_Luo2006_to_JMh_CIECAM02(self): Jpapbp = np.reshape(Jpapbp, (2, 3, 3)) JMh = np.reshape(JMh, (2, 3, 3)) np.testing.assert_allclose( - UCS_Luo2006_to_JMh_CIECAM02( - Jpapbp, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ), + UCS_Luo2006_to_JMh_CIECAM02(Jpapbp, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]), JMh, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -305,9 +279,7 @@ def test_domain_range_scale_UCS_Luo2006_to_JMh_CIECAM02(self): """ Jpapbp = np.array([54.90433134, -0.08442362, -0.06848314]) - JMh = UCS_Luo2006_to_JMh_CIECAM02( - Jpapbp, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ) + JMh = UCS_Luo2006_to_JMh_CIECAM02(Jpapbp, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]) d_r = ( ("reference", 1, 1), @@ -334,12 +306,10 @@ def test_nan_UCS_Luo2006_to_JMh_CIECAM02(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - UCS_Luo2006_to_JMh_CIECAM02( - cases, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"] - ) + UCS_Luo2006_to_JMh_CIECAM02(cases, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]) -class TestXYZ_to_UCS_Luo2006(unittest.TestCase): +class TestXYZ_to_UCS_Luo2006: """ Define :func:`colour.models.cam02_ucs.XYZ_to_UCS_Luo2006` definition unit tests methods. @@ -462,7 +432,7 @@ def test_nan_XYZ_to_UCS_Luo2006(self): XYZ_to_UCS_Luo2006(cases, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]) -class TestUCS_Luo2006_to_XYZ(unittest.TestCase): +class TestUCS_Luo2006_to_XYZ: """ Define :func:`colour.models.cam02_ucs.UCS_Luo2006_to_XYZ` definition unit tests methods. @@ -587,7 +557,3 @@ def test_nan_UCS_Luo2006_to_XYZ(self): UCS_Luo2006_to_XYZ(case, COEFFICIENTS_UCS_LUO2006["CAM02-LCD"]) except ValueError as error: attest("CAM_Specification_CIECAM02" in str(error)) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_cam16_ucs.py b/colour/models/tests/test_cam16_ucs.py index 93988d37fd..513dd350cc 100644 --- a/colour/models/tests/test_cam16_ucs.py +++ b/colour/models/tests/test_cam16_ucs.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.cam16_ucs` module.""" -import unittest from colour.models.tests.test_cam02_ucs import ( TestJMh_CIECAM02_to_UCS_Luo2006, @@ -63,7 +61,3 @@ class TestUCS_Li2017_to_XYZ(TestUCS_Luo2006_to_XYZ): Define :func:`colour.models.cam16_ucs.UCS_Li2017_to_XYZ` definition unit tests methods. """ - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_cie_lab.py b/colour/models/tests/test_cie_lab.py index 7da98a5f02..82c5c02bca 100644 --- a/colour/models/tests/test_cie_lab.py +++ b/colour/models/tests/test_cie_lab.py @@ -1,13 +1,11 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.cie_lab` module.""" -import unittest from itertools import product import numpy as np from colour.constants import TOLERANCE_ABSOLUTE_TESTS -from colour.models import Lab_to_LCHab, Lab_to_XYZ, LCHab_to_Lab, XYZ_to_Lab +from colour.models import Lab_to_XYZ, XYZ_to_Lab from colour.utilities import domain_range_scale, ignore_numpy_errors __author__ = "Colour Developers" @@ -20,12 +18,10 @@ __all__ = [ "TestXYZ_to_Lab", "TestLab_to_XYZ", - "TestLab_to_LCHab", - "TestLCHab_to_Lab", ] -class TestXYZ_to_Lab(unittest.TestCase): +class TestXYZ_to_Lab: """ Define :func:`colour.models.cie_lab.XYZ_to_Lab` definition unit tests methods. @@ -135,7 +131,7 @@ def test_nan_XYZ_to_Lab(self): XYZ_to_Lab(cases, cases[..., 0:2]) -class TestLab_to_XYZ(unittest.TestCase): +class TestLab_to_XYZ: """ Define :func:`colour.models.cie_lab.Lab_to_XYZ` definition unit tests methods. @@ -243,171 +239,3 @@ def test_nan_Lab_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) Lab_to_XYZ(cases, cases[..., 0:2]) - - -class TestLab_to_LCHab(unittest.TestCase): - """ - Define :func:`colour.models.cie_lab.Lab_to_LCHab` definition unit tests - methods. - """ - - def test_Lab_to_LCHab(self): - """Test :func:`colour.models.cie_lab.Lab_to_LCHab` definition.""" - - np.testing.assert_allclose( - Lab_to_LCHab(np.array([41.52787529, 52.63858304, 26.92317922])), - np.array([41.52787529, 59.12425901, 27.08848784]), - atol=TOLERANCE_ABSOLUTE_TESTS, - ) - - np.testing.assert_allclose( - Lab_to_LCHab(np.array([55.11636304, -41.08791787, 30.91825778])), - np.array([55.11636304, 51.42135412, 143.03889556]), - atol=TOLERANCE_ABSOLUTE_TESTS, - ) - - np.testing.assert_allclose( - Lab_to_LCHab(np.array([29.80565520, 20.01830466, -48.34913874])), - np.array([29.80565520, 52.32945383, 292.49133666]), - atol=TOLERANCE_ABSOLUTE_TESTS, - ) - - def test_n_dimensional_Lab_to_LCHab(self): - """ - Test :func:`colour.models.cie_lab.Lab_to_LCHab` definition - n-dimensional arrays support. - """ - - Lab = np.array([41.52787529, 52.63858304, 26.92317922]) - LCHab = Lab_to_LCHab(Lab) - - Lab = np.tile(Lab, (6, 1)) - LCHab = np.tile(LCHab, (6, 1)) - np.testing.assert_allclose( - Lab_to_LCHab(Lab), LCHab, atol=TOLERANCE_ABSOLUTE_TESTS - ) - - Lab = np.reshape(Lab, (2, 3, 3)) - LCHab = np.reshape(LCHab, (2, 3, 3)) - np.testing.assert_allclose( - Lab_to_LCHab(Lab), LCHab, atol=TOLERANCE_ABSOLUTE_TESTS - ) - - def test_domain_range_scale_Lab_to_LCHab(self): - """ - Test :func:`colour.models.cie_lab.Lab_to_LCHab` definition domain and - range scale support. - """ - - Lab = np.array([41.52787529, 52.63858304, 26.92317922]) - LCHab = Lab_to_LCHab(Lab) - - d_r = ( - ("reference", 1, 1), - ("1", 0.01, np.array([0.01, 0.01, 1 / 360])), - ("100", 1, np.array([1, 1, 1 / 3.6])), - ) - for scale, factor_a, factor_b in d_r: - with domain_range_scale(scale): - np.testing.assert_allclose( - Lab_to_LCHab(Lab * factor_a), - LCHab * factor_b, - atol=TOLERANCE_ABSOLUTE_TESTS, - ) - - @ignore_numpy_errors - def test_nan_Lab_to_LCHab(self): - """ - Test :func:`colour.models.cie_lab.Lab_to_LCHab` definition nan - support. - """ - - cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] - cases = np.array(list(set(product(cases, repeat=3)))) - Lab_to_LCHab(cases) - - -class TestLCHab_to_Lab(unittest.TestCase): - """ - Define :func:`colour.models.cie_lab.LCHab_to_Lab` definition unit tests - methods. - """ - - def test_LCHab_to_Lab(self): - """Test :func:`colour.models.cie_lab.LCHab_to_Lab` definition.""" - - np.testing.assert_allclose( - LCHab_to_Lab(np.array([41.52787529, 59.12425901, 27.08848784])), - np.array([41.52787529, 52.63858304, 26.92317922]), - atol=TOLERANCE_ABSOLUTE_TESTS, - ) - - np.testing.assert_allclose( - LCHab_to_Lab(np.array([55.11636304, 51.42135412, 143.03889556])), - np.array([55.11636304, -41.08791787, 30.91825778]), - atol=TOLERANCE_ABSOLUTE_TESTS, - ) - - np.testing.assert_allclose( - LCHab_to_Lab(np.array([29.80565520, 52.32945383, 292.49133666])), - np.array([29.80565520, 20.01830466, -48.34913874]), - atol=TOLERANCE_ABSOLUTE_TESTS, - ) - - def test_n_dimensional_LCHab_to_Lab(self): - """ - Test :func:`colour.models.cie_lab.LCHab_to_Lab` definition - n-dimensional arrays support. - """ - - LCHab = np.array([41.52787529, 59.12425901, 27.08848784]) - Lab = LCHab_to_Lab(LCHab) - - LCHab = np.tile(LCHab, (6, 1)) - Lab = np.tile(Lab, (6, 1)) - np.testing.assert_allclose( - LCHab_to_Lab(LCHab), Lab, atol=TOLERANCE_ABSOLUTE_TESTS - ) - - LCHab = np.reshape(LCHab, (2, 3, 3)) - Lab = np.reshape(Lab, (2, 3, 3)) - np.testing.assert_allclose( - LCHab_to_Lab(LCHab), Lab, atol=TOLERANCE_ABSOLUTE_TESTS - ) - - def test_domain_range_scale_LCHab_to_Lab(self): - """ - Test :func:`colour.models.cie_lab.LCHab_to_Lab` definition domain and - range scale support. - """ - - LCHab = np.array([41.52787529, 59.12425901, 27.08848784]) - Lab = LCHab_to_Lab(LCHab) - - d_r = ( - ("reference", 1, 1), - ("1", np.array([0.01, 0.01, 1 / 360]), 0.01), - ("100", np.array([1, 1, 1 / 3.6]), 1), - ) - for scale, factor_a, factor_b in d_r: - with domain_range_scale(scale): - np.testing.assert_allclose( - LCHab_to_Lab(LCHab * factor_a), - Lab * factor_b, - atol=TOLERANCE_ABSOLUTE_TESTS, - ) - - @ignore_numpy_errors - def test_nan_LCHab_to_Lab(self): - """ - Test :func:`colour.models.cie_lab.LCHab_to_Lab` definition nan - support. - """ - - cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] - cases = np.array(list(set(product(cases, repeat=3)))) - LCHab_to_Lab(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_cie_luv.py b/colour/models/tests/test_cie_luv.py index 78028ce7ac..47acc2dccb 100644 --- a/colour/models/tests/test_cie_luv.py +++ b/colour/models/tests/test_cie_luv.py @@ -1,18 +1,16 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.cie_luv` module.""" -import unittest from itertools import product import numpy as np from colour.constants import TOLERANCE_ABSOLUTE_TESTS from colour.models import ( - LCHuv_to_Luv, - Luv_to_LCHuv, + CIE1976UCS_to_XYZ, Luv_to_uv, Luv_to_XYZ, Luv_uv_to_xy, + XYZ_to_CIE1976UCS, XYZ_to_Luv, uv_to_Luv, xy_to_Luv_uv, @@ -33,12 +31,12 @@ "Testuv_to_Luv", "TestLuv_uv_to_xy", "TestXy_to_Luv_uv", - "TestLuv_to_LCHuv", - "TestLCHuv_to_Luv", + "TestXYZ_to_CIE1976UCS", + "TestCIE1976UCS_to_XYZ", ] -class TestXYZ_to_Luv(unittest.TestCase): +class TestXYZ_to_Luv: """ Define :func:`colour.models.cie_luv.XYZ_to_Luv` definition unit tests methods. @@ -148,7 +146,7 @@ def test_nan_XYZ_to_Luv(self): XYZ_to_Luv(cases, cases[..., 0:2]) -class TestLuv_to_XYZ(unittest.TestCase): +class TestLuv_to_XYZ: """ Define :func:`colour.models.cie_luv.Luv_to_XYZ` definition unit tests methods. @@ -258,7 +256,7 @@ def test_nan_Luv_to_XYZ(self): Luv_to_XYZ(cases, cases[..., 0:2]) -class TestLuv_to_uv(unittest.TestCase): +class TestLuv_to_uv: """ Define :func:`colour.models.cie_luv.Luv_to_uv` definition unit tests methods. @@ -368,7 +366,7 @@ def test_nan_Luv_to_uv(self): Luv_to_uv(cases, cases[..., 0:2]) -class Testuv_to_Luv(unittest.TestCase): +class Testuv_to_Luv: """ Define :func:`colour.models.cie_luv.uv_to_Luv` definition unit tests methods. @@ -423,8 +421,8 @@ def test_uv_to_Luv(self): ) np.testing.assert_allclose( - uv_to_Luv(np.array([0.37720213, 0.50120264]), Y=0.18), - np.array([49.49610761, 115.41688496, -243.29048251]), + uv_to_Luv(np.array([0.37720213, 0.50120264]), L=41.5278752), + np.array([41.52787529, 96.83626054, 17.75210149]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -464,15 +462,15 @@ def test_domain_range_scale_uv_to_Luv(self): uv = np.array([0.37720213, 0.50120264]) illuminant = np.array([0.31270, 0.32900]) - Y = 1 - Luv = uv_to_Luv(uv, illuminant, Y) + L = 100 + Luv = uv_to_Luv(uv, illuminant, L) - d_r = (("reference", 1, 1), ("1", 1, 0.01), ("100", 100, 1)) - for scale, factor_a, factor_b in d_r: + d_r = (("reference", 1), ("1", 0.01), ("100", 1)) + for scale, factor in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - uv_to_Luv(uv, illuminant, Y * factor_a), - Luv * factor_b, + uv_to_Luv(uv, illuminant, L * factor), + Luv * factor, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -485,7 +483,7 @@ def test_nan_uv_to_Luv(self): uv_to_Luv(cases, cases[..., 0:2]) -class TestLuv_uv_to_xy(unittest.TestCase): +class TestLuv_uv_to_xy: """ Define :func:`colour.models.cie_luv.Luv_uv_to_xy` definition unit tests methods. @@ -523,15 +521,11 @@ def test_n_dimensional_Luv_uv_to_xy(self): uv = np.tile(uv, (6, 1)) xy = np.tile(xy, (6, 1)) - np.testing.assert_allclose( - Luv_uv_to_xy(uv), xy, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(Luv_uv_to_xy(uv), xy, atol=TOLERANCE_ABSOLUTE_TESTS) uv = np.reshape(uv, (2, 3, 2)) xy = np.reshape(xy, (2, 3, 2)) - np.testing.assert_allclose( - Luv_uv_to_xy(uv), xy, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(Luv_uv_to_xy(uv), xy, atol=TOLERANCE_ABSOLUTE_TESTS) @ignore_numpy_errors def test_nan_Luv_uv_to_xy(self): @@ -545,7 +539,7 @@ def test_nan_Luv_uv_to_xy(self): Luv_uv_to_xy(cases) -class TestXy_to_Luv_uv(unittest.TestCase): +class TestXy_to_Luv_uv: """ Define :func:`colour.models.cie_luv.xy_to_Luv_uv` definition unit tests methods. @@ -583,15 +577,11 @@ def test_n_dimensional_xy_to_Luv_uv(self): xy = np.tile(xy, (6, 1)) uv = np.tile(uv, (6, 1)) - np.testing.assert_allclose( - xy_to_Luv_uv(xy), uv, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_to_Luv_uv(xy), uv, atol=TOLERANCE_ABSOLUTE_TESTS) xy = np.reshape(xy, (2, 3, 2)) uv = np.reshape(uv, (2, 3, 2)) - np.testing.assert_allclose( - xy_to_Luv_uv(xy), uv, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_to_Luv_uv(xy), uv, atol=TOLERANCE_ABSOLUTE_TESTS) @ignore_numpy_errors def test_nan_xy_to_Luv_uv(self): @@ -605,169 +595,227 @@ def test_nan_xy_to_Luv_uv(self): xy_to_Luv_uv(cases) -class TestLuv_to_LCHuv(unittest.TestCase): +class TestXYZ_to_CIE1976UCS: """ - Define :func:`colour.models.cie_luv.Luv_to_LCHuv` definition unit tests + Define :func:`colour.models.cie_luv.XYZ_to_CIE1976UCS` definition unit tests methods. """ - def test_Luv_to_LCHuv(self): - """Test :func:`colour.models.cie_luv.Luv_to_LCHuv` definition.""" + def test_XYZ_to_CIE1976UCS(self): + """Test :func:`colour.models.cie_luv.XYZ_to_CIE1976UCS` definition.""" + + np.testing.assert_allclose( + XYZ_to_CIE1976UCS(np.array([0.20654008, 0.12197225, 0.05136952])), + np.array([0.37720213, 0.50120264, 41.52787529]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + XYZ_to_CIE1976UCS(np.array([0.14222010, 0.23042768, 0.10495772])), + np.array([0.14536327, 0.52992069, 55.11636304]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + XYZ_to_CIE1976UCS(np.array([0.07818780, 0.06157201, 0.28099326])), + np.array([0.16953603, 0.30039234, 29.80565520]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) np.testing.assert_allclose( - Luv_to_LCHuv(np.array([41.52787529, 96.83626054, 17.75210149])), - np.array([41.52787529, 98.44997950, 10.38816348]), + XYZ_to_CIE1976UCS( + np.array([0.20654008, 0.12197225, 0.05136952]), + np.array([0.44757, 0.40745]), + ), + np.array([0.37720213, 0.50120264, 41.52787529]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - Luv_to_LCHuv(np.array([55.11636304, -37.59308176, 44.13768458])), - np.array([55.11636304, 57.97736624, 130.42180076]), + XYZ_to_CIE1976UCS( + np.array([0.20654008, 0.12197225, 0.05136952]), + np.array([0.34570, 0.35850]), + ), + np.array([0.37720213, 0.50120264, 41.52787529]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - Luv_to_LCHuv(np.array([29.80565520, -10.96316802, -65.06751860])), - np.array([29.80565520, 65.98464238, 260.43611196]), + XYZ_to_CIE1976UCS( + np.array([0.20654008, 0.12197225, 0.05136952]), + np.array([0.34570, 0.35850, 1.00000]), + ), + np.array([0.37720213, 0.50120264, 41.52787529]), atol=TOLERANCE_ABSOLUTE_TESTS, ) - def test_n_dimensional_Luv_to_LCHuv(self): + def test_n_dimensional_XYZ_to_CIE1976UCS(self): """ - Test :func:`colour.models.cie_luv.Luv_to_LCHuv` definition - n-dimensional arrays support. + Test :func:`colour.models.cie_luv.XYZ_to_CIE1976UCS` definition n-dimensional + support. """ - Luv = np.array([41.52787529, 96.83626054, 17.75210149]) - LCHuv = Luv_to_LCHuv(Luv) + XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) + illuminant = np.array([0.31270, 0.32900]) + Luv = XYZ_to_CIE1976UCS(XYZ, illuminant) + XYZ = np.tile(XYZ, (6, 1)) Luv = np.tile(Luv, (6, 1)) - LCHuv = np.tile(LCHuv, (6, 1)) np.testing.assert_allclose( - Luv_to_LCHuv(Luv), LCHuv, atol=TOLERANCE_ABSOLUTE_TESTS + XYZ_to_CIE1976UCS(XYZ, illuminant), Luv, atol=TOLERANCE_ABSOLUTE_TESTS + ) + + illuminant = np.tile(illuminant, (6, 1)) + np.testing.assert_allclose( + XYZ_to_CIE1976UCS(XYZ, illuminant), Luv, atol=TOLERANCE_ABSOLUTE_TESTS ) + XYZ = np.reshape(XYZ, (2, 3, 3)) + illuminant = np.reshape(illuminant, (2, 3, 2)) Luv = np.reshape(Luv, (2, 3, 3)) - LCHuv = np.reshape(LCHuv, (2, 3, 3)) np.testing.assert_allclose( - Luv_to_LCHuv(Luv), LCHuv, atol=TOLERANCE_ABSOLUTE_TESTS + XYZ_to_CIE1976UCS(XYZ, illuminant), Luv, atol=TOLERANCE_ABSOLUTE_TESTS ) - def test_domain_range_scale_Luv_to_LCHuv(self): + def test_domain_range_scale_XYZ_to_CIE1976UCS(self): """ - Test :func:`colour.models.cie_luv.Luv_to_LCHuv` definition domain and - range scale support. + Test :func:`colour.models.cie_luv.XYZ_to_CIE1976UCS` definition + domain and range scale support. """ - Luv = np.array([41.52787529, 96.83626054, 17.75210149]) - LCHuv = Luv_to_LCHuv(Luv) + XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) + illuminant = np.array([0.31270, 0.32900]) + uvL = XYZ_to_CIE1976UCS(XYZ, illuminant) - d_r = ( - ("reference", 1, 1), - ("1", 0.01, np.array([0.01, 0.01, 1 / 360])), - ("100", 1, np.array([1, 1, 1 / 3.6])), - ) + d_r = (("reference", 1, 1), ("1", 1, np.array([1, 1, 0.01])), ("100", 100, 1)) for scale, factor_a, factor_b in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - Luv_to_LCHuv(Luv * factor_a), - LCHuv * factor_b, + XYZ_to_CIE1976UCS(XYZ * factor_a, illuminant), + uvL * factor_b, atol=TOLERANCE_ABSOLUTE_TESTS, ) @ignore_numpy_errors - def test_nan_Luv_to_LCHuv(self): + def test_nan_XYZ_to_CIE1976UCS(self): """ - Test :func:`colour.models.cie_luv.Luv_to_LCHuv` definition nan + Test :func:`colour.models.cie_luv.XYZ_to_CIE1976UCS` definition nan support. """ cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - Luv_to_LCHuv(cases) + XYZ_to_CIE1976UCS(cases, cases[..., 0:2]) -class TestLCHuv_to_Luv(unittest.TestCase): +class TestCIE1976UCS_to_XYZ: """ - Define :func:`colour.models.cie_luv.LCHuv_to_Luv` definition unit tests + Define :func:`colour.models.cie_luv.CIE1976UCS_to_XYZ` definition unit tests methods. """ - def test_LCHuv_to_Luv(self): - """Test :func:`colour.models.cie_luv.LCHuv_to_Luv` definition.""" + def test_CIE1976UCS_to_XYZ(self): + """Test :func:`colour.models.cie_luv.CIE1976UCS_to_XYZ` definition.""" np.testing.assert_allclose( - LCHuv_to_Luv(np.array([41.52787529, 98.44997950, 10.38816348])), - np.array([41.52787529, 96.83626054, 17.75210149]), + CIE1976UCS_to_XYZ(np.array([0.37720213, 0.50120264, 41.52787529])), + np.array([0.20654008, 0.12197225, 0.05136952]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - LCHuv_to_Luv(np.array([55.11636304, 57.97736624, 130.42180076])), - np.array([55.11636304, -37.59308176, 44.13768458]), + CIE1976UCS_to_XYZ(np.array([0.14536327, 0.52992069, 55.11636304])), + np.array([0.14222010, 0.23042768, 0.10495772]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - LCHuv_to_Luv(np.array([29.80565520, 65.98464238, 260.43611196])), - np.array([29.80565520, -10.96316802, -65.06751860]), + CIE1976UCS_to_XYZ(np.array([0.16953603, 0.30039234, 29.80565520])), + np.array([0.07818780, 0.06157201, 0.28099326]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + CIE1976UCS_to_XYZ( + np.array([0.37720213, 0.50120264, 41.52787529]), + np.array([0.44757, 0.40745]), + ), + np.array([0.20654008, 0.12197225, 0.05136952]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + CIE1976UCS_to_XYZ( + np.array([0.37720213, 0.50120264, 41.52787529]), + np.array([0.34570, 0.35850]), + ), + np.array([0.20654008, 0.12197225, 0.05136952]), atol=TOLERANCE_ABSOLUTE_TESTS, ) - def test_n_dimensional_LCHuv_to_Luv(self): + np.testing.assert_allclose( + CIE1976UCS_to_XYZ( + np.array([0.37720213, 0.50120264, 41.52787529]), + np.array([0.34570, 0.35850, 1.00000]), + ), + np.array([0.20654008, 0.12197225, 0.05136952]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + def test_n_dimensional_CIE1976UCS_to_XYZ(self): """ - Test :func:`colour.models.cie_luv.LCHuv_to_Luv` definition - n-dimensional arrays support. + Test :func:`colour.models.cie_luv.CIE1976UCS_to_XYZ` definition n-dimensional + support. """ - LCHuv = np.array([41.52787529, 98.44997950, 10.38816348]) - Luv = LCHuv_to_Luv(LCHuv) + Luv = np.array([0.37720213, 0.50120264, 41.52787529]) + illuminant = np.array([0.31270, 0.32900]) + XYZ = CIE1976UCS_to_XYZ(Luv, illuminant) Luv = np.tile(Luv, (6, 1)) - LCHuv = np.tile(LCHuv, (6, 1)) + XYZ = np.tile(XYZ, (6, 1)) + np.testing.assert_allclose( + CIE1976UCS_to_XYZ(Luv, illuminant), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS + ) + + illuminant = np.tile(illuminant, (6, 1)) np.testing.assert_allclose( - LCHuv_to_Luv(LCHuv), Luv, atol=TOLERANCE_ABSOLUTE_TESTS + CIE1976UCS_to_XYZ(Luv, illuminant), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS ) Luv = np.reshape(Luv, (2, 3, 3)) - LCHuv = np.reshape(LCHuv, (2, 3, 3)) + illuminant = np.reshape(illuminant, (2, 3, 2)) + XYZ = np.reshape(XYZ, (2, 3, 3)) np.testing.assert_allclose( - LCHuv_to_Luv(LCHuv), Luv, atol=TOLERANCE_ABSOLUTE_TESTS + CIE1976UCS_to_XYZ(Luv, illuminant), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS ) - def test_domain_range_scale_LCHuv_to_Lab(self): + def test_domain_range_scale_CIE1976UCS_to_XYZ(self): """ - Test :func:`colour.models.cie_luv.LCHuv_to_Luv` definition domain and - range scale support. + Test :func:`colour.models.cie_luv.CIE1976UCS_to_XYZ` definition + domain and range scale support. """ - LCHuv = np.array([41.52787529, 98.44997950, 10.38816348]) - Luv = LCHuv_to_Luv(LCHuv) + uvL = np.array([0.37720213, 0.50120264, 41.52787529]) + illuminant = np.array([0.31270, 0.32900]) + XYZ = CIE1976UCS_to_XYZ(uvL, illuminant) - d_r = ( - ("reference", 1, 1), - ("1", np.array([0.01, 0.01, 1 / 360]), 0.01), - ("100", np.array([1, 1, 1 / 3.6]), 1), - ) + d_r = (("reference", 1, 1), ("1", np.array([1, 1, 0.01]), 1), ("100", 1, 100)) for scale, factor_a, factor_b in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - LCHuv_to_Luv(LCHuv * factor_a), - Luv * factor_b, + CIE1976UCS_to_XYZ(uvL * factor_a, illuminant), + XYZ * factor_b, atol=TOLERANCE_ABSOLUTE_TESTS, ) @ignore_numpy_errors - def test_nan_LCHuv_to_Luv(self): + def test_nan_CIE1976UCS_to_XYZ(self): """ - Test :func:`colour.models.cie_luv.LCHuv_to_Luv` definition nan + Test :func:`colour.models.cie_luv.CIE1976UCS_to_XYZ` definition nan support. """ cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - LCHuv_to_Luv(cases) - - -if __name__ == "__main__": - unittest.main() + CIE1976UCS_to_XYZ(cases, cases[..., 0:2]) diff --git a/colour/models/tests/test_cie_ucs.py b/colour/models/tests/test_cie_ucs.py index 57c63fd74a..969a141959 100644 --- a/colour/models/tests/test_cie_ucs.py +++ b/colour/models/tests/test_cie_ucs.py @@ -1,16 +1,16 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.cie_ucs` module.""" -import unittest from itertools import product import numpy as np from colour.constants import TOLERANCE_ABSOLUTE_TESTS from colour.models import ( + CIE1960UCS_to_XYZ, UCS_to_uv, UCS_to_XYZ, UCS_uv_to_xy, + XYZ_to_CIE1960UCS, XYZ_to_UCS, uv_to_UCS, xy_to_UCS_uv, @@ -31,10 +31,12 @@ "Testuv_to_UCS", "TestUCS_uv_to_xy", "TestXy_to_UCS_uv", + "TestXYZ_to_CIE1960UCS", + "TestCIE1960UCS_to_XYZ", ] -class TestXYZ_to_UCS(unittest.TestCase): +class TestXYZ_to_UCS: """ Define :func:`colour.models.cie_ucs.XYZ_to_UCS` definition unit tests methods. @@ -72,15 +74,11 @@ def test_n_dimensional_XYZ_to_UCS(self): UCS = np.tile(UCS, (6, 1)) XYZ = np.tile(XYZ, (6, 1)) - np.testing.assert_allclose( - XYZ_to_UCS(XYZ), UCS, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(XYZ_to_UCS(XYZ), UCS, atol=TOLERANCE_ABSOLUTE_TESTS) UCS = np.reshape(UCS, (2, 3, 3)) XYZ = np.reshape(XYZ, (2, 3, 3)) - np.testing.assert_allclose( - XYZ_to_UCS(XYZ), UCS, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(XYZ_to_UCS(XYZ), UCS, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_XYZ_to_UCS(self): """ @@ -109,7 +107,7 @@ def test_nan_XYZ_to_UCS(self): XYZ_to_UCS(cases) -class TestUCS_to_XYZ(unittest.TestCase): +class TestUCS_to_XYZ: """ Define :func:`colour.models.cie_ucs.UCS_to_XYZ` definition unit tests methods. @@ -147,15 +145,11 @@ def test_n_dimensional_UCS_to_XYZ(self): UCS = np.tile(UCS, (6, 1)) XYZ = np.tile(XYZ, (6, 1)) - np.testing.assert_allclose( - UCS_to_XYZ(UCS), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(UCS_to_XYZ(UCS), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) UCS = np.reshape(UCS, (2, 3, 3)) XYZ = np.reshape(XYZ, (2, 3, 3)) - np.testing.assert_allclose( - UCS_to_XYZ(UCS), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(UCS_to_XYZ(UCS), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_UCS_to_XYZ(self): """ @@ -184,7 +178,7 @@ def test_nan_UCS_to_XYZ(self): UCS_to_XYZ(cases) -class TestUCS_to_uv(unittest.TestCase): +class TestUCS_to_uv: """ Define :func:`colour.models.cie_ucs.UCS_to_uv` definition unit tests methods. @@ -222,15 +216,11 @@ def test_n_dimensional_UCS_to_uv(self): UCS = np.tile(UCS, (6, 1)) uv = np.tile(uv, (6, 1)) - np.testing.assert_allclose( - UCS_to_uv(UCS), uv, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(UCS_to_uv(UCS), uv, atol=TOLERANCE_ABSOLUTE_TESTS) UCS = np.reshape(UCS, (2, 3, 3)) uv = np.reshape(uv, (2, 3, 2)) - np.testing.assert_allclose( - UCS_to_uv(UCS), uv, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(UCS_to_uv(UCS), uv, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_UCS_to_uv(self): """ @@ -257,7 +247,7 @@ def test_nan_UCS_to_uv(self): UCS_to_uv(cases) -class Testuv_to_UCS(unittest.TestCase): +class Testuv_to_UCS: """ Define :func:`colour.models.cie_ucs.uv_to_UCS` definition unit tests methods. @@ -301,15 +291,11 @@ def test_n_dimensional_uv_to_UCS(self): uv = np.tile(uv, (6, 1)) UCS = np.tile(UCS, (6, 1)) - np.testing.assert_allclose( - uv_to_UCS(uv), UCS, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(uv_to_UCS(uv), UCS, atol=TOLERANCE_ABSOLUTE_TESTS) uv = np.reshape(uv, (2, 3, 2)) UCS = np.reshape(UCS, (2, 3, 3)) - np.testing.assert_allclose( - uv_to_UCS(uv), UCS, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(uv_to_UCS(uv), UCS, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_uv_to_UCS(self): """ @@ -339,7 +325,7 @@ def test_nan_uv_to_UCS(self): uv_to_UCS(cases) -class TestUCS_uv_to_xy(unittest.TestCase): +class TestUCS_uv_to_xy: """ Define :func:`colour.models.cie_ucs.UCS_uv_to_xy` definition unit tests methods. @@ -377,15 +363,11 @@ def test_n_dimensional_UCS_uv_to_xy(self): uv = np.tile(uv, (6, 1)) xy = np.tile(xy, (6, 1)) - np.testing.assert_allclose( - UCS_uv_to_xy(uv), xy, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(UCS_uv_to_xy(uv), xy, atol=TOLERANCE_ABSOLUTE_TESTS) uv = np.reshape(uv, (2, 3, 2)) xy = np.reshape(xy, (2, 3, 2)) - np.testing.assert_allclose( - UCS_uv_to_xy(uv), xy, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(UCS_uv_to_xy(uv), xy, atol=TOLERANCE_ABSOLUTE_TESTS) @ignore_numpy_errors def test_nan_UCS_uv_to_xy(self): @@ -399,7 +381,7 @@ def test_nan_UCS_uv_to_xy(self): UCS_uv_to_xy(cases) -class TestXy_to_UCS_uv(unittest.TestCase): +class TestXy_to_UCS_uv: """ Define :func:`colour.models.cie_ucs.xy_to_UCS_uv` definition unit tests methods. @@ -437,15 +419,11 @@ def test_n_dimensional_xy_to_UCS_uv(self): xy = np.tile(xy, (6, 1)) uv = np.tile(uv, (6, 1)) - np.testing.assert_allclose( - xy_to_UCS_uv(xy), uv, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_to_UCS_uv(xy), uv, atol=TOLERANCE_ABSOLUTE_TESTS) xy = np.reshape(xy, (2, 3, 2)) uv = np.reshape(uv, (2, 3, 2)) - np.testing.assert_allclose( - xy_to_UCS_uv(xy), uv, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_to_UCS_uv(xy), uv, atol=TOLERANCE_ABSOLUTE_TESTS) @ignore_numpy_errors def test_nan_xy_to_UCS_uv(self): @@ -459,5 +437,157 @@ def test_nan_xy_to_UCS_uv(self): xy_to_UCS_uv(cases) -if __name__ == "__main__": - unittest.main() +class TestXYZ_to_CIE1960UCS: + """ + Define :func:`colour.models.cie_ucs.XYZ_to_CIE1960UCS` definition unit tests + methods. + """ + + def test_XYZ_to_CIE1960UCS(self): + """Test :func:`colour.models.cie_ucs.XYZ_to_CIE1960UCS` definition.""" + + np.testing.assert_allclose( + XYZ_to_CIE1960UCS(np.array([0.20654008, 0.12197225, 0.05136952])), + np.array([0.37720213, 0.33413509, 0.12197225]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + XYZ_to_CIE1960UCS(np.array([0.14222010, 0.23042768, 0.10495772])), + np.array([0.14536327, 0.35328046, 0.23042768]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + XYZ_to_CIE1960UCS(np.array([0.07818780, 0.06157201, 0.28099326])), + np.array([0.16953603, 0.20026156, 0.06157201]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + def test_n_dimensional_XYZ_to_CIE1960UCS(self): + """ + Test :func:`colour.models.cie_ucs.XYZ_to_CIE1960UCS` definition n-dimensional + support. + """ + + XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) + uvV = XYZ_to_CIE1960UCS(XYZ) + + uvV = np.tile(uvV, (6, 1)) + XYZ = np.tile(XYZ, (6, 1)) + np.testing.assert_allclose( + XYZ_to_CIE1960UCS(XYZ), uvV, atol=TOLERANCE_ABSOLUTE_TESTS + ) + + uvV = np.reshape(uvV, (2, 3, 3)) + XYZ = np.reshape(XYZ, (2, 3, 3)) + np.testing.assert_allclose( + XYZ_to_CIE1960UCS(XYZ), uvV, atol=TOLERANCE_ABSOLUTE_TESTS + ) + + def test_domain_range_scale_XYZ_to_CIE1960UCS(self): + """ + Test :func:`colour.models.cie_ucs.XYZ_to_CIE1960UCS` definition domain and + range scale support. + """ + + XYZ = np.array([0.0704953400, 0.1008000000, 0.0955831300]) + uvV = XYZ_to_CIE1960UCS(XYZ) + + d_r = (("reference", 1, 1), ("1", 1, 1), ("100", 100, np.array([1, 1, 100]))) + for scale, factor_a, factor_b in d_r: + with domain_range_scale(scale): + np.testing.assert_allclose( + XYZ_to_CIE1960UCS(XYZ * factor_a), + uvV * factor_b, + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + @ignore_numpy_errors + def test_nan_XYZ_to_CIE1960UCS(self): + """ + Test :func:`colour.models.cie_ucs.XYZ_to_CIE1960UCS` definition nan + support. + """ + + cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] + cases = np.array(list(set(product(cases, repeat=3)))) + XYZ_to_CIE1960UCS(cases) + + +class TestCIE1960UCS_to_XYZ: + """ + Define :func:`colour.models.cie_ucs.CIE1960UCS_to_XYZ` definition unit tests + methods. + """ + + def test_CIE1960UCS_to_XYZ(self): + """Test :func:`colour.models.cie_ucs.CIE1960UCS_to_XYZ` definition.""" + + np.testing.assert_allclose( + CIE1960UCS_to_XYZ(np.array([0.37720213, 0.33413509, 0.12197225])), + np.array([0.20654008, 0.12197225, 0.05136952]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + CIE1960UCS_to_XYZ(np.array([0.14536327, 0.35328046, 0.23042768])), + np.array([0.14222010, 0.23042768, 0.10495772]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + np.testing.assert_allclose( + CIE1960UCS_to_XYZ(np.array([0.16953603, 0.20026156, 0.06157201])), + np.array([0.07818780, 0.06157201, 0.28099326]), + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + def test_n_dimensional_CIE1960UCS_to_XYZ(self): + """ + Test :func:`colour.models.cie_ucs.CIE1960UCS_to_XYZ` definition n-dimensional + support. + """ + + uvV = np.array([0.37720213, 0.33413509, 0.12197225]) + XYZ = CIE1960UCS_to_XYZ(uvV) + + uvV = np.tile(uvV, (6, 1)) + XYZ = np.tile(XYZ, (6, 1)) + np.testing.assert_allclose( + CIE1960UCS_to_XYZ(uvV), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS + ) + + uvV = np.reshape(uvV, (2, 3, 3)) + XYZ = np.reshape(XYZ, (2, 3, 3)) + np.testing.assert_allclose( + CIE1960UCS_to_XYZ(uvV), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS + ) + + def test_domain_range_scale_CIE1960UCS_to_XYZ(self): + """ + Test :func:`colour.models.cie_ucs.CIE1960UCS_to_XYZ` definition domain and + range scale support. + """ + + uvV = np.array([0.0469968933, 0.1008000000, 0.1637438950]) + XYZ = CIE1960UCS_to_XYZ(uvV) + + d_r = (("reference", 1, 1), ("1", 1, 1), ("100", np.array([1, 1, 100]), 100)) + for scale, factor_a, factor_b in d_r: + with domain_range_scale(scale): + np.testing.assert_allclose( + CIE1960UCS_to_XYZ(uvV * factor_a), + XYZ * factor_b, + atol=TOLERANCE_ABSOLUTE_TESTS, + ) + + @ignore_numpy_errors + def test_nan_CIE1960UCS_to_XYZ(self): + """ + Test :func:`colour.models.cie_ucs.CIE1960UCS_to_XYZ` definition nan + support. + """ + + cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] + cases = np.array(list(set(product(cases, repeat=3)))) + CIE1960UCS_to_XYZ(cases) diff --git a/colour/models/tests/test_cie_uvw.py b/colour/models/tests/test_cie_uvw.py index 60cf4142b6..1b73318622 100644 --- a/colour/models/tests/test_cie_uvw.py +++ b/colour/models/tests/test_cie_uvw.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.cie_uvw` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class TestXYZ_to_UVW(unittest.TestCase): +class TestXYZ_to_UVW: """ Define :func:`colour.models.cie_uvw.XYZ_to_UVW` definition unit tests methods. @@ -133,7 +131,7 @@ def test_nan_XYZ_to_UVW(self): XYZ_to_UVW(cases, cases[..., 0:2]) -class TestUVW_to_XYZ(unittest.TestCase): +class TestUVW_to_XYZ: """ Define :func:`colour.models.cie_uvw.UVW_to_XYZ` definition unit tests methods. @@ -241,7 +239,3 @@ def test_nan_UVW_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) UVW_to_XYZ(cases, cases[..., 0:2]) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_cie_xyy.py b/colour/models/tests/test_cie_xyy.py index 5f418a4383..d9f5ffc195 100644 --- a/colour/models/tests/test_cie_xyy.py +++ b/colour/models/tests/test_cie_xyy.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.cie_xyy` module.""" -import unittest from itertools import product import numpy as np @@ -34,7 +32,7 @@ ] -class TestXYZ_to_xyY(unittest.TestCase): +class TestXYZ_to_xyY: """ Define :func:`colour.models.cie_xyy.XYZ_to_xyY` definition unit tests methods. @@ -98,15 +96,11 @@ def test_n_dimensional_XYZ_to_xyY(self): XYZ = np.tile(XYZ, (6, 1)) xyY = np.tile(xyY, (6, 1)) - np.testing.assert_allclose( - XYZ_to_xyY(XYZ), xyY, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(XYZ_to_xyY(XYZ), xyY, atol=TOLERANCE_ABSOLUTE_TESTS) XYZ = np.reshape(XYZ, (2, 3, 3)) xyY = np.reshape(xyY, (2, 3, 3)) - np.testing.assert_allclose( - XYZ_to_xyY(XYZ), xyY, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(XYZ_to_xyY(XYZ), xyY, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_XYZ_to_xyY(self): """ @@ -141,7 +135,7 @@ def test_nan_XYZ_to_xyY(self): XYZ_to_xyY(cases) -class TestxyY_to_XYZ(unittest.TestCase): +class TestxyY_to_XYZ: """ Define :func:`colour.models.cie_xyy.xyY_to_XYZ` definition unit tests methods. @@ -205,15 +199,11 @@ def test_n_dimensional_xyY_to_XYZ(self): xyY = np.tile(xyY, (6, 1)) XYZ = np.tile(XYZ, (6, 1)) - np.testing.assert_allclose( - xyY_to_XYZ(xyY), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xyY_to_XYZ(xyY), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) xyY = np.reshape(xyY, (2, 3, 3)) XYZ = np.reshape(XYZ, (2, 3, 3)) - np.testing.assert_allclose( - xyY_to_XYZ(xyY), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xyY_to_XYZ(xyY), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_xyY_to_XYZ(self): """ @@ -248,7 +238,7 @@ def test_nan_xyY_to_XYZ(self): xyY_to_XYZ(cases) -class TestxyY_to_xy(unittest.TestCase): +class TestxyY_to_xy: """ Define :func:`colour.models.cie_xyy.xyY_to_xy` definition unit tests methods. @@ -292,15 +282,11 @@ def test_n_dimensional_xyY_to_xy(self): xyY = np.tile(xyY, (6, 1)) xy = np.tile(xy, (6, 1)) - np.testing.assert_allclose( - xyY_to_xy(xyY), xy, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xyY_to_xy(xyY), xy, atol=TOLERANCE_ABSOLUTE_TESTS) xyY = np.reshape(xyY, (2, 3, 3)) xy = np.reshape(xy, (2, 3, 2)) - np.testing.assert_allclose( - xyY_to_xy(xyY), xy, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xyY_to_xy(xyY), xy, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_xyY_to_xy(self): """ @@ -335,7 +321,7 @@ def test_nan_xyY_to_xy(self): xyY_to_xy(cases) -class Testxy_to_xyY(unittest.TestCase): +class Testxy_to_xyY: """ Define :func:`colour.models.cie_xyy.xy_to_xyY` definition unit tests methods. @@ -385,15 +371,11 @@ def test_n_dimensional_xy_to_xyY(self): xy = np.tile(xy, (6, 1)) xyY = np.tile(xyY, (6, 1)) - np.testing.assert_allclose( - xy_to_xyY(xy), xyY, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_to_xyY(xy), xyY, atol=TOLERANCE_ABSOLUTE_TESTS) xy = np.reshape(xy, (2, 3, 2)) xyY = np.reshape(xyY, (2, 3, 3)) - np.testing.assert_allclose( - xy_to_xyY(xy), xyY, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_to_xyY(xy), xyY, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_xy_to_xyY(self): """ @@ -432,7 +414,7 @@ def test_nan_xy_to_xyY(self): xy_to_xyY(cases) -class TestXYZ_to_xy(unittest.TestCase): +class TestXYZ_to_xy: """ Define :func:`colour.models.cie_xyy.XYZ_to_xy` definition unit tests methods. @@ -476,15 +458,11 @@ def test_n_dimensional_XYZ_to_xy(self): XYZ = np.tile(XYZ, (6, 1)) xy = np.tile(xy, (6, 1)) - np.testing.assert_allclose( - XYZ_to_xy(XYZ), xy, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(XYZ_to_xy(XYZ), xy, atol=TOLERANCE_ABSOLUTE_TESTS) XYZ = np.reshape(XYZ, (2, 3, 3)) xy = np.reshape(xy, (2, 3, 2)) - np.testing.assert_allclose( - XYZ_to_xy(XYZ), xy, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(XYZ_to_xy(XYZ), xy, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_XYZ_to_xy(self): """ @@ -513,7 +491,7 @@ def test_nan_XYZ_to_xy(self): XYZ_to_xy(cases) -class Testxy_to_XYZ(unittest.TestCase): +class Testxy_to_XYZ: """ Define :func:`colour.models.cie_xyy.xy_to_XYZ` definition unit tests methods. @@ -557,15 +535,11 @@ def test_n_dimensional_xy_to_XYZ(self): xy = np.tile(xy, (6, 1)) XYZ = np.tile(XYZ, (6, 1)) - np.testing.assert_allclose( - xy_to_XYZ(xy), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_to_XYZ(xy), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) xy = np.reshape(xy, (2, 3, 2)) XYZ = np.reshape(XYZ, (2, 3, 3)) - np.testing.assert_allclose( - xy_to_XYZ(xy), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(xy_to_XYZ(xy), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_xy_to_XYZ(self): """ @@ -598,7 +572,3 @@ def test_nan_xy_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=2)))) xy_to_XYZ(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_common.py b/colour/models/tests/test_common.py index 696dec0e52..d3ced869cd 100644 --- a/colour/models/tests/test_common.py +++ b/colour/models/tests/test_common.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.common` module.""" -import unittest from itertools import product import numpy as np @@ -25,7 +23,7 @@ ] -class TestJab_to_JCh(unittest.TestCase): +class TestJab_to_JCh: """ Define :func:`colour.models.common.Jab_to_JCh` definition unit tests methods. @@ -104,7 +102,7 @@ def test_nan_Jab_to_JCh(self): Jab_to_JCh(cases) -class TestJCh_to_Jab(unittest.TestCase): +class TestJCh_to_Jab: """ Define :func:`colour.models.common.JCh_to_Jab` definition unit tests methods. @@ -183,10 +181,10 @@ def test_nan_JCh_to_Jab(self): JCh_to_Jab(cases) -class TestXYZ_to_Iab(unittest.TestCase): +class TestXYZ_to_Iab: """Define :func:`colour.models.common.XYZ_to_Iab` definition unit tests methods.""" - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self.LMS_to_LMS_p = lambda x: x**0.43 @@ -248,16 +246,12 @@ def test_n_dimensional_XYZ_to_Iab(self): """ XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) - Iab = XYZ_to_Iab( - XYZ, self.LMS_to_LMS_p, self.M_XYZ_to_LMS, self.M_LMS_p_to_Iab - ) + Iab = XYZ_to_Iab(XYZ, self.LMS_to_LMS_p, self.M_XYZ_to_LMS, self.M_LMS_p_to_Iab) XYZ = np.tile(XYZ, (6, 1)) Iab = np.tile(Iab, (6, 1)) np.testing.assert_allclose( - XYZ_to_Iab( - XYZ, self.LMS_to_LMS_p, self.M_XYZ_to_LMS, self.M_LMS_p_to_Iab - ), + XYZ_to_Iab(XYZ, self.LMS_to_LMS_p, self.M_XYZ_to_LMS, self.M_LMS_p_to_Iab), Iab, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -265,9 +259,7 @@ def test_n_dimensional_XYZ_to_Iab(self): XYZ = np.reshape(XYZ, (2, 3, 3)) Iab = np.reshape(Iab, (2, 3, 3)) np.testing.assert_allclose( - XYZ_to_Iab( - XYZ, self.LMS_to_LMS_p, self.M_XYZ_to_LMS, self.M_LMS_p_to_Iab - ), + XYZ_to_Iab(XYZ, self.LMS_to_LMS_p, self.M_XYZ_to_LMS, self.M_LMS_p_to_Iab), Iab, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -279,9 +271,7 @@ def test_domain_range_scale_XYZ_to_Iab(self): """ XYZ = np.array([0.20654008, 0.12197225, 0.05136952]) - Iab = XYZ_to_Iab( - XYZ, self.LMS_to_LMS_p, self.M_XYZ_to_LMS, self.M_LMS_p_to_Iab - ) + Iab = XYZ_to_Iab(XYZ, self.LMS_to_LMS_p, self.M_XYZ_to_LMS, self.M_LMS_p_to_Iab) d_r = (("reference", 1), ("1", 1), ("100", 100)) for scale, factor in d_r: @@ -303,18 +293,16 @@ def test_nan_XYZ_to_Iab(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - XYZ_to_Iab( - cases, self.LMS_to_LMS_p, self.M_XYZ_to_LMS, self.M_LMS_p_to_Iab - ) + XYZ_to_Iab(cases, self.LMS_to_LMS_p, self.M_XYZ_to_LMS, self.M_LMS_p_to_Iab) -class TestIab_to_XYZ(unittest.TestCase): +class TestIab_to_XYZ: """ Define :func:`colour.models.common.Iab_to_XYZ` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self.LMS_p_to_LMS = lambda x: x ** (1 / 0.43) @@ -380,16 +368,12 @@ def test_n_dimensional_Iab_to_XYZ(self): """ Iab = np.array([0.38426191, 0.38487306, 0.18886838]) - XYZ = Iab_to_XYZ( - Iab, self.LMS_p_to_LMS, self.M_Iab_to_LMS_p, self.M_LMS_to_XYZ - ) + XYZ = Iab_to_XYZ(Iab, self.LMS_p_to_LMS, self.M_Iab_to_LMS_p, self.M_LMS_to_XYZ) Iab = np.tile(Iab, (6, 1)) XYZ = np.tile(XYZ, (6, 1)) np.testing.assert_allclose( - Iab_to_XYZ( - Iab, self.LMS_p_to_LMS, self.M_Iab_to_LMS_p, self.M_LMS_to_XYZ - ), + Iab_to_XYZ(Iab, self.LMS_p_to_LMS, self.M_Iab_to_LMS_p, self.M_LMS_to_XYZ), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -397,9 +381,7 @@ def test_n_dimensional_Iab_to_XYZ(self): Iab = np.reshape(Iab, (2, 3, 3)) XYZ = np.reshape(XYZ, (2, 3, 3)) np.testing.assert_allclose( - Iab_to_XYZ( - Iab, self.LMS_p_to_LMS, self.M_Iab_to_LMS_p, self.M_LMS_to_XYZ - ), + Iab_to_XYZ(Iab, self.LMS_p_to_LMS, self.M_Iab_to_LMS_p, self.M_LMS_to_XYZ), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -411,9 +393,7 @@ def test_domain_range_scale_Iab_to_XYZ(self): """ Iab = np.array([0.38426191, 0.38487306, 0.18886838]) - XYZ = Iab_to_XYZ( - Iab, self.LMS_p_to_LMS, self.M_Iab_to_LMS_p, self.M_LMS_to_XYZ - ) + XYZ = Iab_to_XYZ(Iab, self.LMS_p_to_LMS, self.M_Iab_to_LMS_p, self.M_LMS_to_XYZ) d_r = (("reference", 1), ("1", 1), ("100", 100)) for scale, factor in d_r: @@ -435,10 +415,4 @@ def test_nan_Iab_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) - Iab_to_XYZ( - cases, self.LMS_p_to_LMS, self.M_Iab_to_LMS_p, self.M_LMS_to_XYZ - ) - - -if __name__ == "__main__": - unittest.main() + Iab_to_XYZ(cases, self.LMS_p_to_LMS, self.M_Iab_to_LMS_p, self.M_LMS_to_XYZ) diff --git a/colour/models/tests/test_din99.py b/colour/models/tests/test_din99.py index 9a8147cb35..b9039cbf24 100644 --- a/colour/models/tests/test_din99.py +++ b/colour/models/tests/test_din99.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.din99` module.""" -import unittest from itertools import product import numpy as np @@ -30,7 +28,7 @@ ] -class TestLab_to_DIN99(unittest.TestCase): +class TestLab_to_DIN99: """ Define :func:`colour.models.din99.Lab_to_DIN99` definition unit tests methods. @@ -153,7 +151,7 @@ def test_nan_Lab_to_DIN99(self): Lab_to_DIN99(cases, method="DIN99d") -class TestDIN99_to_Lab(unittest.TestCase): +class TestDIN99_to_Lab: """ Define :func:`colour.models.din99.DIN99_to_Lab` definition unit tests methods. @@ -276,7 +274,7 @@ def test_nan_DIN99_to_Lab(self): DIN99_to_Lab(cases, method="DIN99d") -class TestXYZ_to_DIN99(unittest.TestCase): +class TestXYZ_to_DIN99: """ Define :func:`colour.models.din99.XYZ_to_DIN99` definition unit tests methods. @@ -359,7 +357,7 @@ def test_nan_XYZ_to_DIN99(self): XYZ_to_DIN99(cases) -class TestDIN99_to_XYZ(unittest.TestCase): +class TestDIN99_to_XYZ: """ Define :func:`colour.models.din99.DIN99_to_XYZ` definition unit tests methods. @@ -441,7 +439,3 @@ def test_nan_DIN99_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) DIN99_to_XYZ(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_hdr_cie_lab.py b/colour/models/tests/test_hdr_cie_lab.py index c5a6979f22..fab0e55cc8 100644 --- a/colour/models/tests/test_hdr_cie_lab.py +++ b/colour/models/tests/test_hdr_cie_lab.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.hdr_cie_lab` module.""" -import unittest from itertools import product import numpy as np @@ -25,7 +23,7 @@ ] -class TestExponent_hdr_CIELab(unittest.TestCase): +class TestExponent_hdr_CIELab: """ Define :func:`colour.models.hdr_cie_lab.exponent_hdr_CIELab` definition unit tests methods. @@ -128,7 +126,7 @@ def test_nan_exponent_hdr_CIELab(self): exponent_hdr_CIELab(cases, cases) -class TestXYZ_to_hdr_CIELab(unittest.TestCase): +class TestXYZ_to_hdr_CIELab: """ Define :func:`colour.models.hdr_cie_lab.XYZ_to_hdr_CIELab` definition unit tests methods. @@ -163,9 +161,7 @@ def test_XYZ_to_hdr_CIELab(self): ) np.testing.assert_allclose( - XYZ_to_hdr_CIELab( - np.array([0.20654008, 0.12197225, 0.05136952]), Y_s=0.5 - ), + XYZ_to_hdr_CIELab(np.array([0.20654008, 0.12197225, 0.05136952]), Y_s=0.5), np.array([23.10388654, 59.31425004, 23.69960142]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -253,7 +249,7 @@ def test_nan_XYZ_to_hdr_CIELab(self): XYZ_to_hdr_CIELab(cases, cases[..., 0:2], cases[..., 0], cases[..., 0]) -class TestHdr_CIELab_to_XYZ(unittest.TestCase): +class TestHdr_CIELab_to_XYZ: """ Define :func:`colour.models.hdr_cie_lab.hdr_CIELab_to_XYZ` definition unit tests methods. @@ -263,9 +259,7 @@ def test_hdr_CIELab_to_XYZ(self): """Test :func:`colour.models.hdr_cie_lab.hdr_CIELab_to_XYZ` definition.""" np.testing.assert_allclose( - hdr_CIELab_to_XYZ( - np.array([51.87002062, 60.47633850, 32.14551912]) - ), + hdr_CIELab_to_XYZ(np.array([51.87002062, 60.47633850, 32.14551912])), np.array([0.20654008, 0.12197225, 0.05136952]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -378,7 +372,3 @@ def test_nan_hdr_CIELab_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) hdr_CIELab_to_XYZ(cases, cases[..., 0:2], cases[..., 0], cases[..., 0]) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_hdr_ipt.py b/colour/models/tests/test_hdr_ipt.py index e187462b48..777d21f795 100644 --- a/colour/models/tests/test_hdr_ipt.py +++ b/colour/models/tests/test_hdr_ipt.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.hdr_ipt` module.""" -import unittest from itertools import product import numpy as np @@ -25,7 +23,7 @@ ] -class TestExponent_hdr_IPT(unittest.TestCase): +class TestExponent_hdr_IPT: """ Define :func:`colour.models.hdr_ipt.exponent_hdr_IPT` definition unit tests methods. @@ -125,7 +123,7 @@ def test_nan_exponent_hdr_IPT(self): exponent_hdr_IPT(cases, cases) -class TestXYZ_to_hdr_IPT(unittest.TestCase): +class TestXYZ_to_hdr_IPT: """ Define :func:`colour.models.hdr_ipt.XYZ_to_hdr_IPT` definition unit tests methods. @@ -150,17 +148,13 @@ def test_XYZ_to_hdr_IPT(self): ) np.testing.assert_allclose( - XYZ_to_hdr_IPT( - np.array([0.20654008, 0.12197225, 0.05136952]), Y_s=0.5 - ), + XYZ_to_hdr_IPT(np.array([0.20654008, 0.12197225, 0.05136952]), Y_s=0.5), np.array([20.75088680, 37.98300971, 16.66974299]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - XYZ_to_hdr_IPT( - np.array([0.07818780, 0.06157201, 0.28099326]), Y_abs=1000 - ), + XYZ_to_hdr_IPT(np.array([0.07818780, 0.06157201, 0.28099326]), Y_abs=1000), np.array([23.83205010, -5.98739209, -32.74311745]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -234,7 +228,7 @@ def test_nan_XYZ_to_hdr_IPT(self): XYZ_to_hdr_IPT(cases, cases[..., 0], cases[..., 0]) -class TestHdr_IPT_to_XYZ(unittest.TestCase): +class TestHdr_IPT_to_XYZ: """ Define :func:`colour.models.hdr_ipt.hdr_IPT_to_XYZ` definition unit tests methods. @@ -259,9 +253,7 @@ def test_hdr_IPT_to_XYZ(self): ) np.testing.assert_allclose( - hdr_IPT_to_XYZ( - np.array([20.75088680, 37.98300971, 16.66974299]), Y_s=0.5 - ), + hdr_IPT_to_XYZ(np.array([20.75088680, 37.98300971, 16.66974299]), Y_s=0.5), np.array([0.20654008, 0.12197225, 0.05136952]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -341,7 +333,3 @@ def test_nan_hdr_IPT_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) hdr_IPT_to_XYZ(cases, cases[..., 0], cases[..., 0]) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_hunter_lab.py b/colour/models/tests/test_hunter_lab.py index d57f2c3b95..869566e12e 100644 --- a/colour/models/tests/test_hunter_lab.py +++ b/colour/models/tests/test_hunter_lab.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.hunter_lab` module.""" -import unittest from itertools import product import numpy as np @@ -29,7 +27,7 @@ ] -class TestXYZ_to_K_ab_HunterLab1966(unittest.TestCase): +class TestXYZ_to_K_ab_HunterLab1966: """ Define :func:`colour.models.hunter_lab.XYZ_to_K_ab_HunterLab1966` definition unit tests methods. @@ -98,7 +96,7 @@ def test_nan_XYZ_to_K_ab_HunterLab1966(self): XYZ_to_K_ab_HunterLab1966(cases) -class TestXYZ_to_Hunter_Lab(unittest.TestCase): +class TestXYZ_to_Hunter_Lab: """ Define :func:`colour.models.hunter_lab.XYZ_to_Hunter_Lab` definition unit tests methods. @@ -108,25 +106,19 @@ def test_XYZ_to_Hunter_Lab(self): """Test :func:`colour.models.hunter_lab.XYZ_to_Hunter_Lab` definition.""" np.testing.assert_allclose( - XYZ_to_Hunter_Lab( - np.array([0.20654008, 0.12197225, 0.05136952]) * 100 - ), + XYZ_to_Hunter_Lab(np.array([0.20654008, 0.12197225, 0.05136952]) * 100), np.array([34.92452577, 47.06189858, 14.38615107]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - XYZ_to_Hunter_Lab( - np.array([0.14222010, 0.23042768, 0.10495772]) * 100 - ), + XYZ_to_Hunter_Lab(np.array([0.14222010, 0.23042768, 0.10495772]) * 100), np.array([48.00288325, -28.98551622, 18.75564181]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - XYZ_to_Hunter_Lab( - np.array([0.07818780, 0.06157201, 0.28099326]) * 100 - ), + XYZ_to_Hunter_Lab(np.array([0.07818780, 0.06157201, 0.28099326]) * 100), np.array([24.81370791, 14.38300039, -53.25539126]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -239,7 +231,7 @@ def test_nan_XYZ_to_Hunter_Lab(self): XYZ_to_Hunter_Lab(cases, cases, cases[..., 0:2]) -class TestHunter_Lab_to_XYZ(unittest.TestCase): +class TestHunter_Lab_to_XYZ: """ Define :func:`colour.models.hunter_lab.Hunter_Lab_to_XYZ` definition unit tests methods. @@ -249,25 +241,19 @@ def test_Hunter_Lab_to_XYZ(self): """Test :func:`colour.models.hunter_lab.Hunter_Lab_to_XYZ` definition.""" np.testing.assert_allclose( - Hunter_Lab_to_XYZ( - np.array([34.92452577, 47.06189858, 14.38615107]) - ), + Hunter_Lab_to_XYZ(np.array([34.92452577, 47.06189858, 14.38615107])), np.array([20.65400800, 12.19722500, 5.13695200]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - Hunter_Lab_to_XYZ( - np.array([48.00288325, -28.98551622, 18.75564181]) - ), + Hunter_Lab_to_XYZ(np.array([48.00288325, -28.98551622, 18.75564181])), np.array([14.22201000, 23.04276800, 10.49577200]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - Hunter_Lab_to_XYZ( - np.array([24.81370791, 14.38300039, -53.25539126]) - ), + Hunter_Lab_to_XYZ(np.array([24.81370791, 14.38300039, -53.25539126])), np.array([7.81878000, 6.15720100, 28.09932601]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -378,7 +364,3 @@ def test_nan_Hunter_Lab_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) Hunter_Lab_to_XYZ(cases, cases, cases[..., 0:2]) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_hunter_rdab.py b/colour/models/tests/test_hunter_rdab.py index 9532a61246..76c348e2ab 100644 --- a/colour/models/tests/test_hunter_rdab.py +++ b/colour/models/tests/test_hunter_rdab.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.hunter_rdab` module.""" -import unittest from itertools import product import numpy as np @@ -24,7 +22,7 @@ ] -class TestXYZ_to_Hunter_Rdab(unittest.TestCase): +class TestXYZ_to_Hunter_Rdab: """ Define :func:`colour.models.hunter_rdab.XYZ_to_Hunter_Rdab` definition unit tests methods. @@ -34,25 +32,19 @@ def test_XYZ_to_Hunter_Rdab(self): """Test :func:`colour.models.hunter_rdab.XYZ_to_Hunter_Rdab` definition.""" np.testing.assert_allclose( - XYZ_to_Hunter_Rdab( - np.array([0.20654008, 0.12197225, 0.05136952]) * 100 - ), + XYZ_to_Hunter_Rdab(np.array([0.20654008, 0.12197225, 0.05136952]) * 100), np.array([12.19722500, 57.12537874, 17.46241341]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - XYZ_to_Hunter_Rdab( - np.array([0.14222010, 0.23042768, 0.10495772]) * 100 - ), + XYZ_to_Hunter_Rdab(np.array([0.14222010, 0.23042768, 0.10495772]) * 100), np.array([23.04276800, -32.40057474, 20.96542183]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - XYZ_to_Hunter_Rdab( - np.array([0.07818780, 0.06157201, 0.28099326]) * 100 - ), + XYZ_to_Hunter_Rdab(np.array([0.07818780, 0.06157201, 0.28099326]) * 100), np.array([6.15720100, 18.13400284, -67.14408607]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -165,7 +157,7 @@ def test_nan_XYZ_to_Hunter_Rdab(self): XYZ_to_Hunter_Rdab(cases, cases, cases[..., 0:2]) -class TestHunter_Rdab_to_XYZ(unittest.TestCase): +class TestHunter_Rdab_to_XYZ: """ Define :func:`colour.models.hunter_rdab.Hunter_Rdab_to_XYZ` definition unit tests methods. @@ -175,25 +167,19 @@ def test_Hunter_Rdab_to_XYZ(self): """Test :func:`colour.models.hunter_rdab.Hunter_Rdab_to_XYZ` definition.""" np.testing.assert_allclose( - Hunter_Rdab_to_XYZ( - np.array([12.19722500, 57.12537874, 17.46241341]) - ), + Hunter_Rdab_to_XYZ(np.array([12.19722500, 57.12537874, 17.46241341])), np.array([0.20654008, 0.12197225, 0.05136952]) * 100, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - Hunter_Rdab_to_XYZ( - np.array([23.04276800, -32.40057474, 20.96542183]) - ), + Hunter_Rdab_to_XYZ(np.array([23.04276800, -32.40057474, 20.96542183])), np.array([0.14222010, 0.23042768, 0.10495772]) * 100, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - Hunter_Rdab_to_XYZ( - np.array([6.15720100, 18.13400284, -67.14408607]) - ), + Hunter_Rdab_to_XYZ(np.array([6.15720100, 18.13400284, -67.14408607])), np.array([0.07818780, 0.06157201, 0.28099326]) * 100, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -304,7 +290,3 @@ def test_nan_Hunter_Rdab_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) Hunter_Rdab_to_XYZ(cases, cases, cases[..., 0:2]) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_icacb.py b/colour/models/tests/test_icacb.py index 7f4860f56c..263f981a86 100644 --- a/colour/models/tests/test_icacb.py +++ b/colour/models/tests/test_icacb.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.hunter_rdab` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class TestXYZ_to_ICaCb(unittest.TestCase): +class TestXYZ_to_ICaCb: """ Define :func:`colour.models.icacb.XYZ_to_ICaCb` definition unit tests methods. @@ -104,7 +102,7 @@ def test_nan_XYZ_to_ICaCb(self): XYZ_to_ICaCb(cases) -class TestICaCb_to_XYZ(unittest.TestCase): +class TestICaCb_to_XYZ: """Test :func:`colour.models.icacb.ICaCb_to_XYZ` definition.""" def test_XYZ_to_ICaCb(self): @@ -129,9 +127,7 @@ def test_XYZ_to_ICaCb(self): ) np.testing.assert_allclose( - ICaCb_to_XYZ( - np.array([1702.0656419, 14738.00583456, 1239.66837927]) - ), + ICaCb_to_XYZ(np.array([1702.0656419, 14738.00583456, 1239.66837927])), np.array([0.00000000, 0.00000000, 1.00000000]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -182,7 +178,3 @@ def test_nan_ICaCb_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) ICaCb_to_XYZ(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_igpgtg.py b/colour/models/tests/test_igpgtg.py index df131f10e6..fd7ff49e20 100644 --- a/colour/models/tests/test_igpgtg.py +++ b/colour/models/tests/test_igpgtg.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.igpgtg` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class TestXYZ_to_IgPgTg(unittest.TestCase): +class TestXYZ_to_IgPgTg: """ Define :func:`colour.models.igpgtg.XYZ_to_IgPgTg` definition unit tests methods. @@ -101,7 +99,7 @@ def test_nan_XYZ_to_IgPgTg(self): XYZ_to_IgPgTg(cases) -class TestIgPgTg_to_XYZ(unittest.TestCase): +class TestIgPgTg_to_XYZ: """ Define :func:`colour.models.igpgtg.IgPgTg_to_XYZ` definition unit tests methods. @@ -177,7 +175,3 @@ def test_nan_IgPgTg_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) IgPgTg_to_XYZ(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_ipt.py b/colour/models/tests/test_ipt.py index 54efb6b252..c8e29bfe5a 100644 --- a/colour/models/tests/test_ipt.py +++ b/colour/models/tests/test_ipt.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.ipt` module.""" -import unittest from itertools import product import numpy as np @@ -24,7 +22,7 @@ ] -class TestXYZ_to_IPT(unittest.TestCase): +class TestXYZ_to_IPT: """Define :func:`colour.models.ipt.XYZ_to_IPT` definition unit tests methods.""" def test_XYZ_to_IPT(self): @@ -59,15 +57,11 @@ def test_n_dimensional_XYZ_to_IPT(self): XYZ = np.tile(XYZ, (6, 1)) IPT = np.tile(IPT, (6, 1)) - np.testing.assert_allclose( - XYZ_to_IPT(XYZ), IPT, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(XYZ_to_IPT(XYZ), IPT, atol=TOLERANCE_ABSOLUTE_TESTS) XYZ = np.reshape(XYZ, (2, 3, 3)) IPT = np.reshape(IPT, (2, 3, 3)) - np.testing.assert_allclose( - XYZ_to_IPT(XYZ), IPT, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(XYZ_to_IPT(XYZ), IPT, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_XYZ_to_IPT(self): """ @@ -96,7 +90,7 @@ def test_nan_XYZ_to_IPT(self): XYZ_to_IPT(cases) -class TestIPT_to_XYZ(unittest.TestCase): +class TestIPT_to_XYZ: """ Define :func:`colour.models.ipt.IPT_to_XYZ` definition unit tests methods. @@ -134,15 +128,11 @@ def test_n_dimensional_IPT_to_XYZ(self): IPT = np.tile(IPT, (6, 1)) XYZ = np.tile(XYZ, (6, 1)) - np.testing.assert_allclose( - IPT_to_XYZ(IPT), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(IPT_to_XYZ(IPT), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) IPT = np.reshape(IPT, (2, 3, 3)) XYZ = np.reshape(XYZ, (2, 3, 3)) - np.testing.assert_allclose( - IPT_to_XYZ(IPT), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(IPT_to_XYZ(IPT), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_IPT_to_XYZ(self): """ @@ -171,7 +161,7 @@ def test_nan_IPT_to_XYZ(self): IPT_to_XYZ(cases) -class TestIPTHueAngle(unittest.TestCase): +class TestIPTHueAngle: """ Define :func:`colour.models.ipt.IPT_hue_angle` definition unit tests methods. @@ -244,7 +234,3 @@ def test_nan_IPT_hue_angle(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) IPT_hue_angle(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_jzazbz.py b/colour/models/tests/test_jzazbz.py index b67374c84b..72ec17603b 100644 --- a/colour/models/tests/test_jzazbz.py +++ b/colour/models/tests/test_jzazbz.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.jzazbz` module.""" -import unittest from itertools import product import numpy as np @@ -30,7 +28,7 @@ ] -class TestXYZ_to_Izazbz(unittest.TestCase): +class TestXYZ_to_Izazbz: """ Define :func:`colour.models.jzazbz.TestXYZ_to_Izazbz` definition unit tests methods. @@ -127,7 +125,7 @@ def test_nan_XYZ_to_Izazbz(self): XYZ_to_Izazbz(cases) -class TestIzazbz_to_XYZ(unittest.TestCase): +class TestIzazbz_to_XYZ: """ Define :func:`colour.models.jzazbz.Izazbz_to_XYZ` definition unit tests methods. @@ -230,7 +228,7 @@ def test_nan_Izazbz_to_XYZ(self): Izazbz_to_XYZ(cases) -class TestXYZ_to_Jzazbz(unittest.TestCase): +class TestXYZ_to_Jzazbz: """ Define :func:`colour.models.jzazbz.TestXYZ_to_Jzazbz` definition unit tests methods. @@ -306,7 +304,7 @@ def test_nan_XYZ_to_Jzazbz(self): XYZ_to_Jzazbz(cases) -class TestJzazbz_to_XYZ(unittest.TestCase): +class TestJzazbz_to_XYZ: """ Define :func:`colour.models.jzazbz.Jzazbz_to_XYZ` definition unit tests methods. @@ -382,7 +380,3 @@ def test_nan_Jzazbz_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) Jzazbz_to_XYZ(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_oklab.py b/colour/models/tests/test_oklab.py index eef65a7d2e..9c0edef2ff 100644 --- a/colour/models/tests/test_oklab.py +++ b/colour/models/tests/test_oklab.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.oklab` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class TestXYZ_to_Oklab(unittest.TestCase): +class TestXYZ_to_Oklab: """ Define :func:`colour.models.oklab.TestXYZ_to_Oklab` definition unit tests methods. @@ -101,7 +99,7 @@ def test_nan_XYZ_to_Oklab(self): XYZ_to_Oklab(cases) -class TestOklab_to_XYZ(unittest.TestCase): +class TestOklab_to_XYZ: """ Define :func:`colour.models.oklab.Oklab_to_XYZ` definition unit tests methods. @@ -176,7 +174,3 @@ def test_nan_Oklab_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) Oklab_to_XYZ(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_osa_ucs.py b/colour/models/tests/test_osa_ucs.py index 2b58d40391..589a0f1dca 100644 --- a/colour/models/tests/test_osa_ucs.py +++ b/colour/models/tests/test_osa_ucs.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.osa_ucs` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class TestXYZ_to_OSA_UCS(unittest.TestCase): +class TestXYZ_to_OSA_UCS: """ Define :func:`colour.models.osa_ucs.XYZ_to_OSA_UCS` definition unit tests methods. @@ -33,25 +31,19 @@ def test_XYZ_to_OSA_UCS(self): """Test :func:`colour.models.osa_ucs.XYZ_to_OSA_UCS` definition.""" np.testing.assert_allclose( - XYZ_to_OSA_UCS( - np.array([0.20654008, 0.12197225, 0.05136952]) * 100 - ), + XYZ_to_OSA_UCS(np.array([0.20654008, 0.12197225, 0.05136952]) * 100), np.array([-3.00499790, 2.99713697, -9.66784231]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - XYZ_to_OSA_UCS( - np.array([0.14222010, 0.23042768, 0.10495772]) * 100 - ), + XYZ_to_OSA_UCS(np.array([0.14222010, 0.23042768, 0.10495772]) * 100), np.array([-1.64657491, 4.59201565, 5.31738757]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - XYZ_to_OSA_UCS( - np.array([0.07818780, 0.06157201, 0.28099326]) * 100 - ), + XYZ_to_OSA_UCS(np.array([0.07818780, 0.06157201, 0.28099326]) * 100), np.array([-5.08589672, -7.91062749, 0.98107575]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -107,7 +99,7 @@ def test_nan_XYZ_to_OSA_UCS(self): XYZ_to_OSA_UCS(cases) -class TestOSA_UCS_to_XYZ(unittest.TestCase): +class TestOSA_UCS_to_XYZ: """ Define :func:`colour.models.osa_ucs.OSA_UCS_to_XYZ` definition unit tests methods. @@ -190,7 +182,3 @@ def test_nan_OSA_UCS_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) OSA_UCS_to_XYZ(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_prolab.py b/colour/models/tests/test_prolab.py index fc39c93435..70f934ba0e 100644 --- a/colour/models/tests/test_prolab.py +++ b/colour/models/tests/test_prolab.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.prolab` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class TestXYZ_to_ProLab(unittest.TestCase): +class TestXYZ_to_ProLab: """ Define :func:`colour.models.ProLab.TestXYZ_to_ProLab` definition unit tests methods. @@ -101,7 +99,7 @@ def test_nan_XYZ_to_ProLab(self): XYZ_to_ProLab(cases) -class TestProLab_to_XYZ(unittest.TestCase): +class TestProLab_to_XYZ: """ Define :func:`colour.models.ProLab.ProLab_to_XYZ` definition unit tests methods. @@ -177,7 +175,3 @@ def test_nan_ProLab_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) ProLab_to_XYZ(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_ragoo2021.py b/colour/models/tests/test_ragoo2021.py index e4bfb3be8c..8f7ccb92d9 100644 --- a/colour/models/tests/test_ragoo2021.py +++ b/colour/models/tests/test_ragoo2021.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.ragoo2021` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class TestXYZ_to_IPT_Ragoo2021(unittest.TestCase): +class TestXYZ_to_IPT_Ragoo2021: """ Define :func:`colour.models.ragoo2021.XYZ_to_IPT_Ragoo2021` definition unit tests methods. @@ -35,25 +33,19 @@ def test_XYZ_to_IPT_Ragoo2021(self): """ np.testing.assert_allclose( - XYZ_to_IPT_Ragoo2021( - np.array([0.20654008, 0.12197225, 0.05136952]) - ), + XYZ_to_IPT_Ragoo2021(np.array([0.20654008, 0.12197225, 0.05136952])), np.array([0.42248243, 0.29105140, 0.20410663]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - XYZ_to_IPT_Ragoo2021( - np.array([0.14222010, 0.23042768, 0.10495772]) - ), + XYZ_to_IPT_Ragoo2021(np.array([0.14222010, 0.23042768, 0.10495772])), np.array([0.54745257, -0.22795249, 0.10109646]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - XYZ_to_IPT_Ragoo2021( - np.array([0.07818780, 0.06157201, 0.28099326]) - ), + XYZ_to_IPT_Ragoo2021(np.array([0.07818780, 0.06157201, 0.28099326])), np.array([0.32151337, 0.06071424, -0.27388774]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -109,7 +101,7 @@ def test_nan_XYZ_to_IPT_Ragoo2021(self): XYZ_to_IPT_Ragoo2021(cases) -class TestIPT_Ragoo2021_to_XYZ(unittest.TestCase): +class TestIPT_Ragoo2021_to_XYZ: """ Define :func:`colour.models.ragoo2021.IPT_Ragoo2021_to_XYZ` definition unit tests methods. @@ -121,25 +113,19 @@ def test_IPT_Ragoo2021_to_XYZ(self): """ np.testing.assert_allclose( - IPT_Ragoo2021_to_XYZ( - np.array([0.42248243, 0.29105140, 0.20410663]) - ), + IPT_Ragoo2021_to_XYZ(np.array([0.42248243, 0.29105140, 0.20410663])), np.array([0.20654008, 0.12197225, 0.05136952]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - IPT_Ragoo2021_to_XYZ( - np.array([0.54745257, -0.22795249, 0.10109646]) - ), + IPT_Ragoo2021_to_XYZ(np.array([0.54745257, -0.22795249, 0.10109646])), np.array([0.14222010, 0.23042768, 0.10495772]), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - IPT_Ragoo2021_to_XYZ( - np.array([0.32151337, 0.06071424, -0.27388774]) - ), + IPT_Ragoo2021_to_XYZ(np.array([0.32151337, 0.06071424, -0.27388774])), np.array([0.07818780, 0.06157201, 0.28099326]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -193,7 +179,3 @@ def test_nan_IPT_Ragoo2021_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) IPT_Ragoo2021_to_XYZ(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/tests/test_yrg.py b/colour/models/tests/test_yrg.py index 9666fc80cd..c8d069b60b 100644 --- a/colour/models/tests/test_yrg.py +++ b/colour/models/tests/test_yrg.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.models.yrg` module.""" -import unittest from itertools import product import numpy as np @@ -30,7 +28,7 @@ ] -class TestLMS_to_Yrg(unittest.TestCase): +class TestLMS_to_Yrg: """ Define :func:`colour.models.yrg.TestLMS_to_Yrg` definition unit tests methods. @@ -68,15 +66,11 @@ def test_n_dimensional_LMS_to_Yrg(self): LMS = np.tile(LMS, (6, 1)) Yrg = np.tile(Yrg, (6, 1)) - np.testing.assert_allclose( - LMS_to_Yrg(LMS), Yrg, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(LMS_to_Yrg(LMS), Yrg, atol=TOLERANCE_ABSOLUTE_TESTS) LMS = np.reshape(LMS, (2, 3, 3)) Yrg = np.reshape(Yrg, (2, 3, 3)) - np.testing.assert_allclose( - LMS_to_Yrg(LMS), Yrg, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(LMS_to_Yrg(LMS), Yrg, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_LMS_to_Yrg(self): """ @@ -105,7 +99,7 @@ def test_nan_LMS_to_Yrg(self): LMS_to_Yrg(cases) -class TestYrg_to_LMS(unittest.TestCase): +class TestYrg_to_LMS: """ Define :func:`colour.models.yrg.Yrg_to_LMS` definition unit tests methods. """ @@ -142,15 +136,11 @@ def test_n_dimensional_Yrg_to_LMS(self): Yrg = np.tile(Yrg, (6, 1)) LMS = np.tile(LMS, (6, 1)) - np.testing.assert_allclose( - Yrg_to_LMS(Yrg), LMS, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(Yrg_to_LMS(Yrg), LMS, atol=TOLERANCE_ABSOLUTE_TESTS) Yrg = np.reshape(Yrg, (2, 3, 3)) LMS = np.reshape(LMS, (2, 3, 3)) - np.testing.assert_allclose( - Yrg_to_LMS(Yrg), LMS, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(Yrg_to_LMS(Yrg), LMS, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_Yrg_to_LMS(self): """ @@ -179,7 +169,7 @@ def test_nan_Yrg_to_LMS(self): Yrg_to_LMS(cases) -class TestXYZ_to_Yrg(unittest.TestCase): +class TestXYZ_to_Yrg: """ Define :func:`colour.models.yrg.TestXYZ_to_Yrg` definition unit tests methods. @@ -217,15 +207,11 @@ def test_n_dimensional_XYZ_to_Yrg(self): XYZ = np.tile(XYZ, (6, 1)) Yrg = np.tile(Yrg, (6, 1)) - np.testing.assert_allclose( - XYZ_to_Yrg(XYZ), Yrg, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(XYZ_to_Yrg(XYZ), Yrg, atol=TOLERANCE_ABSOLUTE_TESTS) XYZ = np.reshape(XYZ, (2, 3, 3)) Yrg = np.reshape(Yrg, (2, 3, 3)) - np.testing.assert_allclose( - XYZ_to_Yrg(XYZ), Yrg, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(XYZ_to_Yrg(XYZ), Yrg, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_XYZ_to_Yrg(self): """ @@ -239,8 +225,10 @@ def test_domain_range_scale_XYZ_to_Yrg(self): d_r = (("reference", 1), ("1", 1), ("100", 100)) for scale, factor in d_r: with domain_range_scale(scale): - np.testing.assert_array_equal( - XYZ_to_Yrg(XYZ * factor), Yrg * factor + np.testing.assert_allclose( + XYZ_to_Yrg(XYZ * factor), + Yrg * factor, + atol=TOLERANCE_ABSOLUTE_TESTS, ) @ignore_numpy_errors @@ -252,7 +240,7 @@ def test_nan_XYZ_to_Yrg(self): XYZ_to_Yrg(cases) -class TestYrg_to_XYZ(unittest.TestCase): +class TestYrg_to_XYZ: """ Define :func:`colour.models.yrg.Yrg_to_XYZ` definition unit tests methods. """ @@ -289,15 +277,11 @@ def test_n_dimensional_Yrg_to_XYZ(self): Yrg = np.tile(Yrg, (6, 1)) XYZ = np.tile(XYZ, (6, 1)) - np.testing.assert_allclose( - Yrg_to_XYZ(Yrg), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(Yrg_to_XYZ(Yrg), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) Yrg = np.reshape(Yrg, (2, 3, 3)) XYZ = np.reshape(XYZ, (2, 3, 3)) - np.testing.assert_allclose( - Yrg_to_XYZ(Yrg), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(Yrg_to_XYZ(Yrg), XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_Yrg_to_XYZ(self): """ @@ -324,7 +308,3 @@ def test_nan_Yrg_to_XYZ(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) Yrg_to_XYZ(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/models/yrg.py b/colour/models/yrg.py index c0dfe792b9..ac1cfbd96a 100644 --- a/colour/models/yrg.py +++ b/colour/models/yrg.py @@ -2,7 +2,7 @@ Yrg Colourspace - Kirk (2019) ============================= -Defines the *Kirk (2019)* *Yrg* colourspace: +Define the *Kirk (2019)* *Yrg* colourspace: - :func:`colour.models.LMS_to_Yrg` - :func:`colour.models.Yrg_to_LMS` @@ -20,7 +20,7 @@ import numpy as np -from colour.algebra import sdiv, sdiv_mode, vector_dot +from colour.algebra import sdiv, sdiv_mode, vecmul from colour.hints import ArrayLike, NDArrayFloat from colour.utilities import ( from_range_1, @@ -55,9 +55,7 @@ colourspace. """ -MATRIX_LMS_TO_XYZ_KIRK2019: NDArrayFloat = np.linalg.inv( - MATRIX_XYZ_TO_LMS_KIRK2019 -) +MATRIX_LMS_TO_XYZ_KIRK2019: NDArrayFloat = np.linalg.inv(MATRIX_XYZ_TO_LMS_KIRK2019) """ *Kirk (2019)* matrix converting from *LMS* colourspace to *CIE XYZ* tristimulus values. @@ -229,7 +227,7 @@ def XYZ_to_Yrg(XYZ: ArrayLike) -> NDArrayFloat: array([ 0.1313780..., 0.4903764..., 0.3777738...]) """ - return LMS_to_Yrg(vector_dot(MATRIX_XYZ_TO_LMS_KIRK2019, XYZ)) + return LMS_to_Yrg(vecmul(MATRIX_XYZ_TO_LMS_KIRK2019, XYZ)) def Yrg_to_XYZ(Yrg: ArrayLike) -> NDArrayFloat: @@ -276,4 +274,4 @@ def Yrg_to_XYZ(Yrg: ArrayLike) -> NDArrayFloat: array([ 0.2065468..., 0.1219717..., 0.0513819...]) """ - return vector_dot(MATRIX_LMS_TO_XYZ_KIRK2019, Yrg_to_LMS(Yrg)) + return vecmul(MATRIX_LMS_TO_XYZ_KIRK2019, Yrg_to_LMS(Yrg)) diff --git a/colour/notation/css_color_3.py b/colour/notation/css_color_3.py index 5e4686972b..5575c35908 100644 --- a/colour/notation/css_color_3.py +++ b/colour/notation/css_color_3.py @@ -2,7 +2,7 @@ CSS Color Module Level 3 - Web Colours ====================================== -Defines the conversion of colour keywords to *RGB* colourspace: +Define the conversion of colour keywords to *RGB* colourspace: - :attr:`colour.notation.keyword_to_RGB_CSSColor3` @@ -60,8 +60,6 @@ def keyword_to_RGB_CSSColor3(keyword: str) -> NDArrayFloat: array([ 0.9411764..., 0.9725490..., 1. ]) """ - attest( - keyword in CSS_COLOR_3, f'{keyword} is not defined in "CSS Color 3"!' - ) + attest(keyword in CSS_COLOR_3, f'{keyword} is not defined in "CSS Color 3"!') return HEX_to_RGB(CSS_COLOR_3[keyword]) diff --git a/colour/notation/datasets/css_color_3.py b/colour/notation/datasets/css_color_3.py index 81f250f756..da3e782a7f 100644 --- a/colour/notation/datasets/css_color_3.py +++ b/colour/notation/datasets/css_color_3.py @@ -2,7 +2,7 @@ CSS Color Module Level 3 - Web Colours ====================================== -Defines the lists of colour keywords as given by *CSS Color Module Level 3* +Define the lists of colour keywords as given by *CSS Color Module Level 3* *W3C Recommendation*. - :attr:`colour.notation.CSS_COLOR_3_BASIC` diff --git a/colour/notation/datasets/munsell/__init__.py b/colour/notation/datasets/munsell/__init__.py index 16c136a005..a50c3df392 100644 --- a/colour/notation/datasets/munsell/__init__.py +++ b/colour/notation/datasets/munsell/__init__.py @@ -38,7 +38,7 @@ *experimental.dat* and *real.dat* files features *CIE xyY* colourspace values that are scaled by a :math:`1 / 0.975 \\simeq 1.02568` factor. If you are performing conversions using *Munsell* *Colorlab* specification, - e.g. *2.5R 9/2*, according to *ASTM D1535-08e1* method, you should not + e.g., *2.5R 9/2*, according to *ASTM D1535-08e1* method, you should not scale the output :math:`Y` Luminance. However, if you use directly the *CIE xyY* colourspace values from the Munsell Renotation data, you should scale the :math:`Y` Luminance before conversions by a :math:`0.975` factor. diff --git a/colour/notation/datasets/munsell/all.py b/colour/notation/datasets/munsell/all.py index a324161c4e..408c0352a3 100644 --- a/colour/notation/datasets/munsell/all.py +++ b/colour/notation/datasets/munsell/all.py @@ -2,7 +2,7 @@ Munsell Renotation System Dataset - All Munsell Colours ======================================================= -Defines the *Munsell Renotation System* *All* datasets. Those are *all* +Define the *Munsell Renotation System* *All* datasets. Those are *all* published *Munsell* colours, including the extrapolated colors. Notes @@ -11,7 +11,7 @@ *experimental.dat* and *real.dat* files features *CIE xyY* colourspace values that are scaled by a :math:`1 / 0.975 \\simeq 1.02568` factor. If you are performing conversions using *Munsell* *Colorlab* specification, - e.g. *2.5R 9/2*, according to *ASTM D1535-08e1* method, you should not + e.g., *2.5R 9/2*, according to *ASTM D1535-08e1* method, you should not scale the output :math:`Y` Luminance. However, if you use directly the *CIE xyY* colourspace values from the Munsell Renotation data, you should scale the :math:`Y` Luminance before conversions by a :math:`0.975` factor. diff --git a/colour/notation/datasets/munsell/experimental.py b/colour/notation/datasets/munsell/experimental.py index 035751e3c9..4a70d1324f 100644 --- a/colour/notation/datasets/munsell/experimental.py +++ b/colour/notation/datasets/munsell/experimental.py @@ -2,7 +2,7 @@ Munsell Renotation System Dataset - 1929 Munsell Colours ======================================================== -Defines the *Munsell Renotation System* *1929* datasets. Those are the colours +Define the *Munsell Renotation System* *1929* datasets. Those are the colours appearing in the 1929 *Munsell Book of Color*. These data has been used in the scaling experiments leading to the 1943 renotation. @@ -12,7 +12,7 @@ *experimental.dat* and *real.dat* files features *CIE xyY* colourspace values that are scaled by a :math:`1 / 0.975 \\simeq 1.02568` factor. If you are performing conversions using *Munsell* *Colorlab* specification, - e.g. *2.5R 9/2*, according to *ASTM D1535-08e1* method, you should not + e.g., *2.5R 9/2*, according to *ASTM D1535-08e1* method, you should not scale the output :math:`Y` Luminance. However, if you use directly the *CIE xyY* colourspace values from the Munsell Renotation data, you should scale the :math:`Y` Luminance before conversions by a :math:`0.975` factor. diff --git a/colour/notation/datasets/munsell/real.py b/colour/notation/datasets/munsell/real.py index c72ea41662..675b1c337e 100644 --- a/colour/notation/datasets/munsell/real.py +++ b/colour/notation/datasets/munsell/real.py @@ -2,7 +2,7 @@ Munsell Renotation System Dataset - Real Munsell Colours ======================================================== -Defines the *Munsell Renotation System* *Real* datasets. Those are *real*, +Define the *Munsell Renotation System* *Real* datasets. Those are *real*, within MacAdam limits *Munsell* colours only. They are the colours listed in the original 1943 renotation article *(Newhall, Nickerson, & Judd, 1943)*. @@ -12,7 +12,7 @@ *experimental.dat* and *real.dat* files features *CIE xyY* colourspace values that are scaled by a :math:`1 / 0.975 \\simeq 1.02568` factor. If you are performing conversions using *Munsell* *Colorlab* specification, - e.g. *2.5R 9/2*, according to *ASTM D1535-08e1* method, you should not + e.g., *2.5R 9/2*, according to *ASTM D1535-08e1* method, you should not scale the output :math:`Y` Luminance. However, if you use directly the *CIE xyY* colourspace values from the Munsell Renotation data, you should scale the :math:`Y` Luminance before conversions by a :math:`0.975` factor. diff --git a/colour/notation/hexadecimal.py b/colour/notation/hexadecimal.py index 9ab2b13276..0a17d4cdbf 100644 --- a/colour/notation/hexadecimal.py +++ b/colour/notation/hexadecimal.py @@ -2,7 +2,7 @@ Hexadecimal Notation ==================== -Defines the objects for hexadecimal notation: +Define the objects for hexadecimal notation: - :func:`colour.notation.RGB_to_HEX` - :func:`colour.notation.HEX_to_RGB` @@ -120,7 +120,7 @@ def HEX_to_RGB(HEX: ArrayLike) -> NDArrayFloat: array([ 0.6666666..., 0.8666666..., 1. ]) """ - HEX = np.core.defchararray.lstrip(HEX, "#") # pyright: ignore + HEX = np.char.lstrip(HEX, "#") # pyright: ignore def to_RGB(x: list) -> list: """Convert given hexadecimal representation to *RGB*.""" diff --git a/colour/notation/munsell.py b/colour/notation/munsell.py index 292172ba02..860b8b4b3f 100644 --- a/colour/notation/munsell.py +++ b/colour/notation/munsell.py @@ -2,7 +2,7 @@ Munsell Renotation System ========================= -Defines various objects for *Munsell Renotation System* computations: +Define various objects for *Munsell Renotation System* computations: - :func:`colour.notation.munsell_value_Priest1920`: *Munsell* value :math:`V` computation of given *luminance* :math:`Y` using @@ -37,7 +37,7 @@ *experimental.dat* and *real.dat* files features *CIE xyY* colourspace values that are scaled by a :math:`1 / 0.975 \\simeq 1.02568` factor. If you are performing conversions using *Munsell* *Colorlab* specification, - e.g. *2.5R 9/2*, according to *ASTM D1535-08e1* method, you should not + e.g., *2.5R 9/2*, according to *ASTM D1535-08e1* method, you should not scale the output :math:`Y` Luminance. However, if you use directly the *CIE xyY* colourspace values from the Munsell Renotation data, you should scale the :math:`Y` Luminance before conversions by a :math:`0.975` factor. @@ -130,8 +130,8 @@ ) from colour.colorimetry import CCS_ILLUMINANTS, luminance_ASTMD1535 from colour.constants import ( - FLOATING_POINT_NUMBER_PATTERN, - INTEGER_THRESHOLD, + PATTERN_FLOATING_POINT_NUMBER, + THRESHOLD_INTEGER, TOLERANCE_ABSOLUTE_DEFAULT, TOLERANCE_RELATIVE_DEFAULT, ) @@ -144,7 +144,12 @@ Tuple, cast, ) -from colour.models import Lab_to_LCHab, XYZ_to_Lab, XYZ_to_xy, xyY_to_XYZ +from colour.models import Lab_to_LCHab # pyright: ignore +from colour.models import ( + XYZ_to_Lab, + XYZ_to_xy, + xyY_to_XYZ, +) from colour.notation import MUNSELL_COLOURS_ALL from colour.utilities import ( CACHE_REGISTRY, @@ -225,12 +230,12 @@ "munsell_specification_to_xy", ] -MUNSELL_GRAY_PATTERN: str = f"N(?P{FLOATING_POINT_NUMBER_PATTERN})" +MUNSELL_GRAY_PATTERN: str = f"N(?P{PATTERN_FLOATING_POINT_NUMBER})" MUNSELL_COLOUR_PATTERN: str = ( - f"(?P{FLOATING_POINT_NUMBER_PATTERN})\\s*" + f"(?P{PATTERN_FLOATING_POINT_NUMBER})\\s*" f"(?PBG|GY|YR|RP|PB|B|G|Y|R|P)\\s*" - f"(?P{FLOATING_POINT_NUMBER_PATTERN})\\s*\\/\\s*" - f"(?P[-+]?{FLOATING_POINT_NUMBER_PATTERN})" + f"(?P{PATTERN_FLOATING_POINT_NUMBER})\\s*\\/\\s*" + f"(?P[-+]?{PATTERN_FLOATING_POINT_NUMBER})" ) MUNSELL_GRAY_FORMAT: str = "N{0}" @@ -261,15 +266,11 @@ _CACHE_MUNSELL_SPECIFICATIONS: dict = CACHE_REGISTRY.register_cache( f"{__name__}._CACHE_MUNSELL_SPECIFICATIONS" ) -_CACHE_MUNSELL_VALUE_ASTM_D1535_08_INTERPOLATOR: dict = ( - CACHE_REGISTRY.register_cache( - f"{__name__}._CACHE_MUNSELL_VALUE_ASTM_D1535_08_INTERPOLATOR" - ) +_CACHE_MUNSELL_VALUE_ASTM_D1535_08_INTERPOLATOR: dict = CACHE_REGISTRY.register_cache( + f"{__name__}._CACHE_MUNSELL_VALUE_ASTM_D1535_08_INTERPOLATOR" ) -_CACHE_MUNSELL_MAXIMUM_CHROMAS_FROM_RENOTATION: dict = ( - CACHE_REGISTRY.register_cache( - f"{__name__}._CACHE_MUNSELL_MAXIMUM_CHROMAS_FROM_RENOTATION" - ) +_CACHE_MUNSELL_MAXIMUM_CHROMAS_FROM_RENOTATION: dict = CACHE_REGISTRY.register_cache( + f"{__name__}._CACHE_MUNSELL_MAXIMUM_CHROMAS_FROM_RENOTATION" ) @@ -282,10 +283,10 @@ def _munsell_specifications() -> NDArrayFloat: :attr:`colour.notation.MUNSELL_COLOURS` attribute in a 2 columns form:: ( - (('2.5GY', 0.2, 2.0), (0.713, 1.414, 0.237)), - (('5GY', 0.2, 2.0), (0.449, 1.145, 0.237)), + (("2.5GY", 0.2, 2.0), (0.713, 1.414, 0.237)), + (("5GY", 0.2, 2.0), (0.449, 1.145, 0.237)), ..., - (('7.5GY', 0.2, 2.0), (0.262, 0.837, 0.237)), + (("7.5GY", 0.2, 2.0), (0.262, 0.837, 0.237)), ) The first column is converted from *Munsell* colour to specification using @@ -387,9 +388,7 @@ def _munsell_maximum_chromas_from_renotation() -> ( chromas[index] = cast(float, chroma) - maximum_chromas_from_renotation = tuple( - zip(chromas.keys(), chromas.values()) - ) + maximum_chromas_from_renotation = tuple(zip(chromas.keys(), chromas.values())) _CACHE_MUNSELL_MAXIMUM_CHROMAS_FROM_RENOTATION[ "Maximum Chromas From Renotation" @@ -762,16 +761,18 @@ def munsell_value_ASTMD1535(Y: ArrayLike) -> NDArrayFloat: def munsell_value( Y: ArrayLike, - method: Literal[ - "ASTM D1535", - "Ladd 1955", - "McCamy 1987", - "Moon 1943", - "Munsell 1933", - "Priest 1920", - "Saunderson 1944", - ] - | str = "ASTM D1535", + method: ( + Literal[ + "ASTM D1535", + "Ladd 1955", + "McCamy 1987", + "Moon 1943", + "Munsell 1933", + "Priest 1920", + "Saunderson 1944", + ] + | str + ) = "ASTM D1535", ) -> NDArrayFloat: """ Return the *Munsell* value :math:`V` of given *luminance* :math:`Y` using @@ -975,10 +976,7 @@ def munsell_specification_to_xyY(specification: ArrayLike) -> NDArrayFloat: specification = as_float_array(specification) shape = list(specification.shape) - xyY = [ - _munsell_specification_to_xyY(a) - for a in specification.reshape([-1, 4]) - ] + xyY = [_munsell_specification_to_xyY(a) for a in np.reshape(specification, (-1, 4))] shape[-1] = 3 @@ -1023,16 +1021,11 @@ def munsell_colour_to_xyY(munsell_colour: ArrayLike) -> NDArrayFloat: shape = list(munsell_colour.shape) specification = np.array( - [ - munsell_colour_to_munsell_specification(a) - for a in np.ravel(munsell_colour) - ] + [munsell_colour_to_munsell_specification(a) for a in np.ravel(munsell_colour)] ) return munsell_specification_to_xyY( - from_range_10( - specification.reshape([*shape, 4]), _munsell_scale_factor() - ) + from_range_10(np.reshape(specification, (*shape, 4)), _munsell_scale_factor()) ) @@ -1078,16 +1071,14 @@ def _xyY_to_munsell_specification(xyY: ArrayLike) -> NDArrayFloat: value = np.around(value) with domain_range_scale("ignore"): - x_center, y_center, Y_center = tsplit( - _munsell_specification_to_xyY(value) - ) + x_center, y_center, Y_center = tsplit(_munsell_specification_to_xyY(value)) rho_input, phi_input, _z_input = tsplit( cartesian_to_cylindrical([x - x_center, y - y_center, Y_center]) ) phi_input = np.degrees(phi_input) - grey_threshold = 1e-7 + grey_threshold = THRESHOLD_INTEGER if rho_input < grey_threshold: return from_range_10(normalise_munsell_specification(value)) @@ -1112,7 +1103,7 @@ def _xyY_to_munsell_specification(xyY: ArrayLike) -> NDArrayFloat: code_initial, ] - convergence_threshold = 1e-7 + convergence_threshold = THRESHOLD_INTEGER / 1e4 iterations_maximum = 64 iterations = 0 @@ -1169,13 +1160,11 @@ def _xyY_to_munsell_specification(xyY: ArrayLike) -> NDArrayFloat: # path, it is kept for consistency with the reference # implementation. raise RuntimeError( # pragma: no cover - "Maximum inner iterations count reached without " - "convergence!" + "Maximum inner iterations count reached without convergence!" ) hue_angle_inner = ( - hue_angle_current - + iterations_inner * (phi_input - phi_current) + hue_angle_current + iterations_inner * (phi_input - phi_current) ) % 360 hue_angle_difference_inner = ( iterations_inner * (phi_input - phi_current) % 360 @@ -1217,14 +1206,10 @@ def _xyY_to_munsell_specification(xyY: ArrayLike) -> NDArrayFloat: phi_differences_indexes = phi_differences.argsort() phi_differences = phi_differences[phi_differences_indexes] - hue_angles_differences = hue_angles_differences[ - phi_differences_indexes - ] + hue_angles_differences = hue_angles_differences[phi_differences_indexes] hue_angle_difference_new = ( - Extrapolator( - LinearInterpolator(phi_differences, hue_angles_differences) - )(0) + Extrapolator(LinearInterpolator(phi_differences, hue_angles_differences))(0) % 360 ) hue_angle_new = cast( @@ -1280,15 +1265,12 @@ def _xyY_to_munsell_specification(xyY: ArrayLike) -> NDArrayFloat: iterations_maximum_inner = 16 iterations_inner = 0 - while not ( - np.min(rho_bounds_data) < rho_input < np.max(rho_bounds_data) - ): + while not (np.min(rho_bounds_data) < rho_input < np.max(rho_bounds_data)): iterations_inner += 1 if iterations_inner > iterations_maximum_inner: raise RuntimeError( - "Maximum inner iterations count reached " - "without convergence!" + "Maximum inner iterations count reached without convergence!" ) with sdiv_mode(): @@ -1406,9 +1388,7 @@ def xyY_to_munsell_specification(xyY: ArrayLike) -> NDArrayFloat: xyY = as_float_array(xyY) shape = list(xyY.shape) - specification = [ - _xyY_to_munsell_specification(a) for a in xyY.reshape([-1, 3]) - ] + specification = [_xyY_to_munsell_specification(a) for a in np.reshape(xyY, (-1, 3))] shape[-1] = 4 @@ -1469,7 +1449,7 @@ def xyY_to_munsell_colour( np.array( [ munsell_specification_to_munsell_colour(a, *decimals) - for a in specification.reshape([-1, 4]) + for a in np.reshape(specification, (-1, 4)) ] ), shape[:-1], @@ -1518,9 +1498,7 @@ def parse_munsell_colour(munsell_colour: str) -> NDArrayFloat: ] ) - match = re.match( - MUNSELL_COLOUR_PATTERN, munsell_colour, flags=re.IGNORECASE - ) + match = re.match(MUNSELL_COLOUR_PATTERN, munsell_colour, flags=re.IGNORECASE) if match: return tstack( [ @@ -1584,18 +1562,14 @@ def normalise_munsell_specification(specification: ArrayLike) -> NDArrayFloat: -------- >>> normalise_munsell_specification(np.array([0.0, 2.0, 4.0, 6])) array([ 10., 2., 4., 7.]) - >>> normalise_munsell_specification( - ... np.array([np.nan, 0.5, np.nan, np.nan]) - ... ) + >>> normalise_munsell_specification(np.array([np.nan, 0.5, np.nan, np.nan])) array([ nan, 0.5, nan, nan]) """ specification = as_float_array(specification) if is_grey_munsell_colour(specification): - return specification * np.array( - [np.nan, 1, np.nan, np.nan] - ) # pyright: ignore + return specification * np.array([np.nan, 1, np.nan, np.nan]) # pyright: ignore else: hue, value, chroma, code = specification @@ -1634,9 +1608,7 @@ def munsell_colour_to_munsell_specification( array([ 10., 2., 4., 7.]) """ - return normalise_munsell_specification( - parse_munsell_colour(munsell_colour) - ) + return normalise_munsell_specification(parse_munsell_colour(munsell_colour)) def munsell_specification_to_munsell_colour( @@ -1666,17 +1638,13 @@ def munsell_specification_to_munsell_colour( Examples -------- - >>> munsell_specification_to_munsell_colour( - ... np.array([np.nan, 5.2, np.nan, np.nan]) - ... ) + >>> munsell_specification_to_munsell_colour(np.array([np.nan, 5.2, np.nan, np.nan])) 'N5.2' >>> munsell_specification_to_munsell_colour(np.array([10, 2.0, 4.0, 7])) '10.0R 2.0/4.0' """ - hue, value, chroma, code = tsplit( - normalise_munsell_specification(specification) - ) + hue, value, chroma, code = tsplit(normalise_munsell_specification(specification)) if is_grey_munsell_colour(specification): return MUNSELL_GRAY_EXTENDED_FORMAT.format(value, value_decimals) @@ -1706,8 +1674,7 @@ def munsell_specification_to_munsell_colour( code = round(code, 1) attest( code in code_values, - f'"{specification!r}" specification code must one of ' - f'"{code_values}"!', + f'"{specification!r}" specification code must one of "{code_values}"!', ) if value == 0: @@ -2078,7 +2045,7 @@ def interpolation_method_from_renotation_ovoid( ) attest( - abs(2 * (chroma / 2 - round(chroma / 2))) <= INTEGER_THRESHOLD, + abs(2 * (chroma / 2 - round(chroma / 2))) <= THRESHOLD_INTEGER, f'"{specification}" specification chroma must be an int and ' f"multiple of 2!", ) @@ -2243,11 +2210,7 @@ def interpolation_method_from_renotation_ovoid( else: interpolation_method = 1 elif chroma == 10: - if ( - 30 < ASTM_hue < 42.5 - or 5 < ASTM_hue < 25 - or 60 < ASTM_hue < 82.5 - ): + if 30 < ASTM_hue < 42.5 or 5 < ASTM_hue < 25 or 60 < ASTM_hue < 82.5: interpolation_method = 2 else: interpolation_method = 1 @@ -2261,11 +2224,7 @@ def interpolation_method_from_renotation_ovoid( else: interpolation_method = 1 elif chroma >= 14: - if ( - 32.5 < ASTM_hue < 40 - or 7.5 < ASTM_hue < 15 - or 80 < ASTM_hue < 82.5 - ): + if 32.5 < ASTM_hue < 40 or 7.5 < ASTM_hue < 15 or 80 < ASTM_hue < 82.5: interpolation_method = 2 else: interpolation_method = 1 @@ -2278,11 +2237,7 @@ def interpolation_method_from_renotation_ovoid( else: interpolation_method = 1 elif chroma >= 14: - if ( - 32.5 < ASTM_hue < 40 - or 5 < ASTM_hue < 15 - or 60 < ASTM_hue < 85 - ): + if 32.5 < ASTM_hue < 40 or 5 < ASTM_hue < 15 or 60 < ASTM_hue < 85: interpolation_method = 2 else: interpolation_method = 1 @@ -2372,7 +2327,7 @@ def xy_from_renotation_ovoid(specification: ArrayLike) -> NDArrayFloat: ) attest( - abs(2 * (chroma / 2 - round(chroma / 2))) <= INTEGER_THRESHOLD, + abs(2 * (chroma / 2 - round(chroma / 2))) <= THRESHOLD_INTEGER, f'"{specification}" specification chroma must be an int and ' f"multiple of 2!", ) @@ -2381,13 +2336,12 @@ def xy_from_renotation_ovoid(specification: ArrayLike) -> NDArrayFloat: # Checking if renotation data is available without interpolation using # given threshold. - threshold = 1e-7 if ( - abs(hue) < threshold - or abs(hue - 2.5) < threshold - or abs(hue - 5) < threshold - or abs(hue - 7.5) < threshold - or abs(hue - 10) < threshold + abs(hue) < THRESHOLD_INTEGER + or abs(hue - 2.5) < THRESHOLD_INTEGER + or abs(hue - 5) < THRESHOLD_INTEGER + or abs(hue - 7.5) < THRESHOLD_INTEGER + or abs(hue - 10) < THRESHOLD_INTEGER ): hue = 2.5 * round(hue / 2.5) @@ -2432,9 +2386,7 @@ def xy_from_renotation_ovoid(specification: ArrayLike) -> NDArrayFloat: hue_angle_lower -= 360 hue_angle -= 360 - interpolation_method = interpolation_method_from_renotation_ovoid( - specification - ) + interpolation_method = interpolation_method_from_renotation_ovoid(specification) attest( interpolation_method is not None, @@ -2448,31 +2400,21 @@ def xy_from_renotation_ovoid(specification: ArrayLike) -> NDArrayFloat: x_minus_plus = np.squeeze([x_minus, x_plus]) y_minus_plus = np.squeeze([y_minus, y_plus]) - x = LinearInterpolator(hue_angle_lower_upper, x_minus_plus)( - hue_angle - ) - y = LinearInterpolator(hue_angle_lower_upper, y_minus_plus)( - hue_angle - ) + x = LinearInterpolator(hue_angle_lower_upper, x_minus_plus)(hue_angle) + y = LinearInterpolator(hue_angle_lower_upper, y_minus_plus)(hue_angle) elif interpolation_method == "Radial": rho_minus_plus = np.squeeze([rho_minus, rho_plus]) phi_minus_plus = np.squeeze([phi_minus, phi_plus]) rho = as_float_array( - LinearInterpolator(hue_angle_lower_upper, rho_minus_plus)( - hue_angle - ) + LinearInterpolator(hue_angle_lower_upper, rho_minus_plus)(hue_angle) ) phi = as_float_array( - LinearInterpolator(hue_angle_lower_upper, phi_minus_plus)( - hue_angle - ) + LinearInterpolator(hue_angle_lower_upper, phi_minus_plus)(hue_angle) ) rho_phi = np.squeeze([rho, np.radians(phi)]) - x, y = tsplit( - polar_to_cartesian(rho_phi) + tstack([x_grey, y_grey]) - ) + x, y = tsplit(polar_to_cartesian(rho_phi) + tstack([x_grey, y_grey])) return tstack([x, y]) @@ -2612,9 +2554,7 @@ def maximum_chroma_from_renotation(hue_and_value_and_code: ArrayLike) -> float: (hue_ccw, value_plus, code_ccw) # pyright: ignore ) ][1] - max_chroma = np.min( - [ma_limit_mcw, ma_limit_mccw, ma_limit_pcw, ma_limit_pccw] - ) + max_chroma = np.min([ma_limit_mcw, ma_limit_mccw, ma_limit_pcw, ma_limit_pccw]) else: L = as_float_scalar(luminance_ASTMD1535(value)) L9 = as_float_scalar(luminance_ASTMD1535(9)) @@ -2694,9 +2634,7 @@ def munsell_specification_to_xy(specification: ArrayLike) -> NDArrayFloat: [hue, value, chroma_minus, code] ) - x_plus, y_plus = xy_from_renotation_ovoid( - [hue, value, chroma_plus, code] - ) + x_plus, y_plus = xy_from_renotation_ovoid([hue, value, chroma_plus, code]) if chroma_minus == chroma_plus: x = x_minus diff --git a/colour/notation/tests/test_css_color_3.py b/colour/notation/tests/test_css_color_3.py index f67e6cd43e..cdf898b185 100644 --- a/colour/notation/tests/test_css_color_3.py +++ b/colour/notation/tests/test_css_color_3.py @@ -1,10 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.notation.css_color_3` module.""" from __future__ import annotations -import unittest - import numpy as np from colour.constants import TOLERANCE_ABSOLUTE_TESTS @@ -22,7 +19,7 @@ ] -class TestKeywordToRGBCSSColor3(unittest.TestCase): +class TestKeywordToRGBCSSColor3: """ Define :func:`colour.notation.css_color_3.keyword_to_RGB_CSSColor3` definition unit tests methods. @@ -47,7 +44,3 @@ def test_keyword_to_RGB_CSSColor3(self): np.array([0.94117647, 0.97254902, 1.00000000]), atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/notation/tests/test_hexadecimal.py b/colour/notation/tests/test_hexadecimal.py index 7a1259a657..46c0719a00 100644 --- a/colour/notation/tests/test_hexadecimal.py +++ b/colour/notation/tests/test_hexadecimal.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.notation.hexadecimal` module.""" -import unittest from itertools import product import numpy as np @@ -26,7 +24,7 @@ ] -class TestRGB_to_HEX(unittest.TestCase): +class TestRGB_to_HEX: """ Define :func:`colour.notation.hexadecimal.RGB_to_HEX` definition unit tests methods. @@ -35,20 +33,11 @@ class TestRGB_to_HEX(unittest.TestCase): def test_RGB_to_HEX(self): """Test :func:`colour.notation.hexadecimal.RGB_to_HEX` definition.""" - self.assertEqual( - RGB_to_HEX(np.array([0.45620519, 0.03081071, 0.04091952])), - "#74070a", - ) + assert RGB_to_HEX(np.array([0.45620519, 0.03081071, 0.04091952])) == "#74070a" - self.assertEqual( - RGB_to_HEX(np.array([0.00000000, 0.00000000, 0.00000000])), - "#000000", - ) + assert RGB_to_HEX(np.array([0.00000000, 0.00000000, 0.00000000])) == "#000000" - self.assertEqual( - RGB_to_HEX(np.array([1.00000000, 1.00000000, 1.00000000])), - "#ffffff", - ) + assert RGB_to_HEX(np.array([1.00000000, 1.00000000, 1.00000000])) == "#ffffff" np.testing.assert_equal( RGB_to_HEX( @@ -74,11 +63,11 @@ def test_n_dimensional_RGB_to_HEX(self): RGB = np.tile(RGB, (6, 1)) HEX = np.tile(HEX, 6) - self.assertListEqual(RGB_to_HEX(RGB).tolist(), HEX.tolist()) + assert RGB_to_HEX(RGB).tolist() == HEX.tolist() RGB = np.reshape(RGB, (2, 3, 3)) HEX = np.reshape(HEX, (2, 3)) - self.assertListEqual(RGB_to_HEX(RGB).tolist(), HEX.tolist()) + assert RGB_to_HEX(RGB).tolist() == HEX.tolist() def test_domain_range_scale_RGB_to_HEX(self): """ @@ -92,7 +81,7 @@ def test_domain_range_scale_RGB_to_HEX(self): d_r = (("reference", 1), ("1", 1), ("100", 100)) for scale, factor in d_r: with domain_range_scale(scale): - self.assertEqual(RGB_to_HEX(RGB * factor), HEX) + assert RGB_to_HEX(RGB * factor) == HEX @ignore_numpy_errors def test_nan_RGB_to_HEX(self): @@ -106,7 +95,7 @@ def test_nan_RGB_to_HEX(self): RGB_to_HEX(cases) -class TestHEX_to_RGB(unittest.TestCase): +class TestHEX_to_RGB: """ Define :func:`colour.notation.hexadecimal.HEX_to_RGB` definition unit tests methods. @@ -144,15 +133,11 @@ def test_n_dimensional_HEX_to_RGB(self): HEX = np.tile(HEX, 6) RGB = np.tile(RGB, (6, 1)) - np.testing.assert_allclose( - HEX_to_RGB(HEX), RGB, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(HEX_to_RGB(HEX), RGB, atol=TOLERANCE_ABSOLUTE_TESTS) HEX = np.reshape(HEX, (2, 3)) RGB = np.reshape(RGB, (2, 3, 3)) - np.testing.assert_allclose( - HEX_to_RGB(HEX), RGB, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(HEX_to_RGB(HEX), RGB, atol=TOLERANCE_ABSOLUTE_TESTS) def test_domain_range_scale_HEX_to_RGB(self): """ @@ -167,7 +152,3 @@ def test_domain_range_scale_HEX_to_RGB(self): for scale, factor in d_r: with domain_range_scale(scale): np.testing.assert_array_equal(HEX_to_RGB(HEX), RGB * factor) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/notation/tests/test_munsell.py b/colour/notation/tests/test_munsell.py index 827be3aa19..c5af0a8cfb 100644 --- a/colour/notation/tests/test_munsell.py +++ b/colour/notation/tests/test_munsell.py @@ -1,13 +1,12 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.notation.munsell` module.""" from __future__ import annotations import contextlib -import unittest from itertools import product import numpy as np +import pytest from colour.constants import TOLERANCE_ABSOLUTE_TESTS from colour.hints import NDArrayFloat @@ -122,9 +121,7 @@ def _generate_unit_tests_specifications() -> tuple: # pragma: no cover munsell_colour = "{} {}/{}".format(*MUNSELL_COLOURS["real"][i][0]) try: - specification = munsell_colour_to_munsell_specification( - munsell_colour - ) + specification = munsell_colour_to_munsell_specification(munsell_colour) specification_r = specification + np.hstack( [np.random.uniform(-1, 1, 3), [0]] ) @@ -1103,7 +1100,7 @@ def _generate_unit_tests_specifications() -> tuple: # pragma: no cover ] -class TestMunsellValuePriest1920(unittest.TestCase): +class TestMunsellValuePriest1920: """ Define :func:`colour.notation.munsell.munsell_value_Priest1920` definition unit tests methods. @@ -1185,12 +1182,10 @@ def test_nan_munsell_value_Priest1920(self): definition nan support. """ - munsell_value_Priest1920( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + munsell_value_Priest1920(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestMunsellValueMunsell1933(unittest.TestCase): +class TestMunsellValueMunsell1933: """ Define :func:`colour.notation.munsell.munsell_value_Munsell1933` definition unit tests methods. @@ -1272,12 +1267,10 @@ def test_nan_munsell_value_Munsell1933(self): definition nan support. """ - munsell_value_Munsell1933( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + munsell_value_Munsell1933(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestMunsellValueMoon1943(unittest.TestCase): +class TestMunsellValueMoon1943: """ Define :func:`colour.notation.munsell.munsell_value_Moon1943` definition unit tests methods. @@ -1359,12 +1352,10 @@ def test_nan_munsell_value_Moon1943(self): definition nan support. """ - munsell_value_Moon1943( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + munsell_value_Moon1943(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestMunsellValueSaunderson1944(unittest.TestCase): +class TestMunsellValueSaunderson1944: """ Define :func:`colour.notation.munsell.munsell_value_Saunderson1944` definition unit tests methods. @@ -1451,7 +1442,7 @@ def test_nan_munsell_value_Saunderson1944(self): ) -class TestMunsellValueLadd1955(unittest.TestCase): +class TestMunsellValueLadd1955: """ Define :func:`colour.notation.munsell.munsell_value_Ladd1955` definition unit tests methods. @@ -1533,12 +1524,10 @@ def test_nan_munsell_value_Ladd1955(self): definition nan support. """ - munsell_value_Ladd1955( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + munsell_value_Ladd1955(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestMunsellValueMcCamy1992(unittest.TestCase): +class TestMunsellValueMcCamy1992: """ Define :func:`colour.notation.munsell.munsell_value_McCamy1987` definition unit tests methods. @@ -1620,12 +1609,10 @@ def test_nan_munsell_value_McCamy1987(self): definition nan support. """ - munsell_value_McCamy1987( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + munsell_value_McCamy1987(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestMunsellValueASTMD1535(unittest.TestCase): +class TestMunsellValueASTMD1535: """ Define :func:`colour.notation.munsell.munsell_value_ASTMD1535` definition unit tests methods. @@ -1707,12 +1694,10 @@ def test_nan_munsell_value_ASTMD1535(self): definition nan support. """ - munsell_value_ASTMD1535( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + munsell_value_ASTMD1535(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestMunsellSpecification_to_xyY(unittest.TestCase): +class TestMunsellSpecification_to_xyY: """ Define :func:`colour.notation.munsell.munsell_specification_to_xyY` definition unit tests methods. @@ -1740,9 +1725,7 @@ def test_munsell_specification_to_xyY(self): ) specification = np.squeeze(specification) nan_array = np.full(specification.shape, np.nan) - specification = tstack( - [nan_array, specification, nan_array, nan_array] - ) + specification = tstack([nan_array, specification, nan_array, nan_array]) np.testing.assert_allclose( munsell_specification_to_xyY(specification), @@ -1756,9 +1739,7 @@ def test_n_dimensional_munsell_specification_to_xyY(self): definition n-dimensional arrays support. """ - specification = np.array( - [7.18927191, 5.34025196, 16.05861170, 3.00000000] - ) + specification = np.array([7.18927191, 5.34025196, 16.05861170, 3.00000000]) xyY = munsell_specification_to_xyY(specification) specification = np.tile(specification, (6, 1)) @@ -1802,9 +1783,7 @@ def test_domain_range_scale_munsell_specification_to_xyY(self): definition domain and range scale support. """ - specification = np.array( - [7.18927191, 5.34025196, 16.05861170, 3.00000000] - ) + specification = np.array([7.18927191, 5.34025196, 16.05861170, 3.00000000]) xyY = munsell_specification_to_xyY(specification) d_r = ( @@ -1834,7 +1813,7 @@ def test_nan_munsell_specification_to_xyY(self): munsell_specification_to_xyY(case) -class TestMunsellColour_to_xyY(unittest.TestCase): +class TestMunsellColour_to_xyY: """ Define :func:`colour.notation.munsell.munsell_colour_to_xyY` definition unit tests methods. @@ -1907,7 +1886,7 @@ def test_n_dimensional_munsell_colour_to_xyY(self): ) -class TestxyY_to_munsell_specification(unittest.TestCase): +class TestxyY_to_munsell_specification: """ Define :func:`colour.notation.munsell.xyY_to_munsell_specification` definition unit tests methods. @@ -1936,9 +1915,7 @@ def test_xyY_to_munsell_specification(self): ) specification = np.squeeze(specification) nan_array = np.full(specification.shape, np.nan) - specification = tstack( - [nan_array, specification, nan_array, nan_array] - ) + specification = tstack([nan_array, specification, nan_array, nan_array]) np.testing.assert_allclose( xyY_to_munsell_specification(xyY), @@ -1977,7 +1954,7 @@ def test_raise_exception_xyY_to_munsell_specification(self): definition raised exception. """ - self.assertRaises( + pytest.raises( RuntimeError, xyY_to_munsell_specification, np.array([0.90615118, 0.57945103, 0.91984064]), @@ -2019,7 +1996,7 @@ def test_nan_xyY_to_munsell_specification(self): xyY_to_munsell_specification(case) -class TestxyY_to_munsell_colour(unittest.TestCase): +class TestxyY_to_munsell_colour: """ Define :func:`colour.notation.munsell.xyY_to_munsell_colour` definition unit tests methods. @@ -2041,9 +2018,7 @@ def test_domain_range_scale_xyY_to_munsell_colour(self): ) for scale, factor in d_r: with domain_range_scale(scale): - self.assertEqual( - xyY_to_munsell_colour(xyY * factor), munsell_colour - ) + assert xyY_to_munsell_colour(xyY * factor) == munsell_colour def test_n_dimensional_xyY_to_munsell_colour(self): """ @@ -2074,7 +2049,7 @@ def test_n_dimensional_xyY_to_munsell_colour(self): np.testing.assert_equal(xyY_to_munsell_colour(xyY), munsell_colour) -class TestParseMunsellColour(unittest.TestCase): +class TestParseMunsellColour: """ Define :func:`colour.notation.munsell.parse_munsell_colour` definition unit tests methods. @@ -2110,10 +2085,10 @@ def test_raise_exception_parse_munsell_colour(self): definition raised exception. """ - self.assertRaises(ValueError, parse_munsell_colour, "4.2YQ 8.1/5.3") + pytest.raises(ValueError, parse_munsell_colour, "4.2YQ 8.1/5.3") -class TestIsGreyMunsellColour(unittest.TestCase): +class TestIsGreyMunsellColour: """ Define :func:`colour.notation.munsell.is_grey_munsell_colour` definition unit tests methods. @@ -2125,18 +2100,16 @@ def test_is_grey_munsell_colour(self): definition. """ - self.assertTrue(is_grey_munsell_colour(5.2)) + assert is_grey_munsell_colour(5.2) - self.assertFalse(is_grey_munsell_colour(np.array([0.0, 2.0, 4.0, 6]))) + assert not is_grey_munsell_colour(np.array([0.0, 2.0, 4.0, 6])) - self.assertFalse(is_grey_munsell_colour(np.array([4.2, 8.1, 5.3, 6]))) + assert not is_grey_munsell_colour(np.array([4.2, 8.1, 5.3, 6])) - self.assertTrue( - is_grey_munsell_colour(np.array([np.nan, 0.5, np.nan, np.nan])) - ) + assert is_grey_munsell_colour(np.array([np.nan, 0.5, np.nan, np.nan])) -class TestNormaliseMunsellSpecification(unittest.TestCase): +class TestNormaliseMunsellSpecification: """ Define :func:`colour.notation.munsell.normalise_munsell_specification` definition unit tests methods. @@ -2173,7 +2146,7 @@ def test_normalise_munsell_specification(self): ) -class TestMunsellColourToMunsellSpecification(unittest.TestCase): +class TestMunsellColourToMunsellSpecification: """ Define :func:`colour.notation.munsell.\ munsell_colour_to_munsell_specification` definition unit tests methods. @@ -2216,7 +2189,7 @@ def test_munsell_colour_to_munsell_specification(self): ) -class TestMunsellSpecificationToMunsellColour(unittest.TestCase): +class TestMunsellSpecificationToMunsellColour: """ Define :func:`colour.notation.munsell.\ munsell_specification_to_munsell_colour` definition unit tests methods. @@ -2228,50 +2201,40 @@ def test_munsell_specification_to_munsell_colour(self): munsell_specification_to_munsell_colour` definition. """ - self.assertEqual( - munsell_specification_to_munsell_colour( - np.array([10.0, 2.0, 4.0, 7]) - ), - "10.0R 2.0/4.0", + assert ( + munsell_specification_to_munsell_colour(np.array([10.0, 2.0, 4.0, 7])) + == "10.0R 2.0/4.0" ) - self.assertEqual( - munsell_specification_to_munsell_colour( - np.array([10.0, 2.0, 4.0, 9]) - ), - "10.0P 2.0/4.0", + assert ( + munsell_specification_to_munsell_colour(np.array([10.0, 2.0, 4.0, 9])) + == "10.0P 2.0/4.0" ) - self.assertEqual( - munsell_specification_to_munsell_colour( - np.array([10.0, 2.0, 4.0, 1]) - ), - "10.0B 2.0/4.0", + assert ( + munsell_specification_to_munsell_colour(np.array([10.0, 2.0, 4.0, 1])) + == "10.0B 2.0/4.0" ) - self.assertEqual( + assert ( munsell_specification_to_munsell_colour( np.array([np.nan, 5.2, np.nan, np.nan]) - ), - "N5.2", + ) + == "N5.2" ) - self.assertEqual( - munsell_specification_to_munsell_colour( - np.array([0.0, 2.0, 4.0, 7]) - ), - "10.0RP 2.0/4.0", + assert ( + munsell_specification_to_munsell_colour(np.array([0.0, 2.0, 4.0, 7])) + == "10.0RP 2.0/4.0" ) - self.assertEqual( - munsell_specification_to_munsell_colour( - np.array([10.0, 0.0, 4.0, 7]) - ), - "N0.0", + assert ( + munsell_specification_to_munsell_colour(np.array([10.0, 0.0, 4.0, 7])) + == "N0.0" ) -class Test_xyY_fromRenotation(unittest.TestCase): +class Test_xyY_fromRenotation: """ Define :func:`colour.notation.munsell.xyY_from_renotation` definition unit tests methods. @@ -2299,7 +2262,7 @@ def test_xyY_from_renotation(self): ) -class TestIsSpecificationInRenotation(unittest.TestCase): +class TestIsSpecificationInRenotation: """ Define :func:`colour.notation.munsell.is_specification_in_renotation` definition unit tests methods. @@ -2311,20 +2274,14 @@ def test_is_specification_in_renotation(self): definition. """ - self.assertTrue( - is_specification_in_renotation(np.array([2.5, 0.2, 2.0, 4])) - ) + assert is_specification_in_renotation(np.array([2.5, 0.2, 2.0, 4])) - self.assertTrue( - is_specification_in_renotation(np.array([5.0, 0.2, 2.0, 4])) - ) + assert is_specification_in_renotation(np.array([5.0, 0.2, 2.0, 4])) - self.assertFalse( - is_specification_in_renotation(np.array([25.0, 0.2, 2.0, 4])) - ) + assert not is_specification_in_renotation(np.array([25.0, 0.2, 2.0, 4])) -class TestBoundingHuesFromRenotation(unittest.TestCase): +class TestBoundingHuesFromRenotation: """ Define :func:`colour.notation.munsell.bounding_hues_from_renotation` definition unit tests methods. @@ -2344,7 +2301,7 @@ def test_bounding_hues_from_renotation(self): ) -class TestHueToHueAngle(unittest.TestCase): +class TestHueToHueAngle: """ Define :func:`colour.notation.munsell.hue_to_hue_angle` definition unit tests methods. @@ -2354,10 +2311,10 @@ def test_hue_to_hue_angle(self): """Test :func:`colour.notation.munsell.hue_to_hue_angle` definition.""" for hue, code, angle in MUNSELL_HUE_TO_ANGLE: - self.assertEqual(hue_to_hue_angle([hue, code]), angle) + assert hue_to_hue_angle([hue, code]) == angle -class TestHueAngleToHue(unittest.TestCase): +class TestHueAngleToHue: """ Define :func:`colour.notation.munsell.hue_angle_to_hue` definition unit tests methods. @@ -2370,7 +2327,7 @@ def test_hue_angle_to_hue(self): np.testing.assert_array_equal(hue_angle_to_hue(angle), (hue, code)) -class TestHueTo_ASTM_hue(unittest.TestCase): +class TestHueTo_ASTM_hue: """ Define :func:`colour.notation.munsell.hue_to_ASTM_hue` definition unit tests methods. @@ -2380,10 +2337,10 @@ def test_hue_to_ASTM_hue(self): """Test :func:`colour.notation.munsell.hue_to_ASTM_hue` definition.""" for hue, code, angle in MUNSELL_HUE_TO_ASTM_HUE: - self.assertEqual(hue_to_ASTM_hue([hue, code]), angle) + assert hue_to_ASTM_hue([hue, code]) == angle -class TestInterpolationMethodFromRenotationOvoid(unittest.TestCase): +class TestInterpolationMethodFromRenotationOvoid: """ Define :func:`colour.notation.munsell.\ interpolation_method_from_renotation_ovoid` definition unit tests methods. @@ -2396,25 +2353,25 @@ def test_interpolation_method_from_renotation_ovoid(self): """ for i, (specification, _xyY) in enumerate(MUNSELL_EVEN_SPECIFICATIONS): - self.assertEqual( - interpolation_method_from_renotation_ovoid(specification), - MUNSELL_INTERPOLATION_METHODS[i], + assert ( + interpolation_method_from_renotation_ovoid(specification) + == MUNSELL_INTERPOLATION_METHODS[i] ) - self.assertIsNone( + assert ( interpolation_method_from_renotation_ovoid( np.array([np.nan, 5.2, np.nan, np.nan]) ) + is None ) - self.assertIsNone( - interpolation_method_from_renotation_ovoid( - np.array([2.5, 10.0, 2.0, 4]) - ) + assert ( + interpolation_method_from_renotation_ovoid(np.array([2.5, 10.0, 2.0, 4])) + is None ) -class Test_xy_fromRenotationOvoid(unittest.TestCase): +class Test_xy_fromRenotationOvoid: """ Define :func:`colour.notation.munsell.xy_from_renotation_ovoid` definition unit tests methods. @@ -2435,7 +2392,7 @@ def test_xy_from_renotation_ovoid(self): ) -class TestLCHabToMunsellSpecification(unittest.TestCase): +class TestLCHabToMunsellSpecification: """ Define :func:`colour.notation.munsell.LCHab_to_munsell_specification` definition unit tests methods. @@ -2488,7 +2445,7 @@ def test_LCHab_to_munsell_specification(self): ) -class TestMaximumChromaFromRenotation(unittest.TestCase): +class TestMaximumChromaFromRenotation: """ Define :func:`colour.notation.munsell.maximum_chroma_from_renotation` definition unit tests methods. @@ -2500,18 +2457,14 @@ def test_maximum_chroma_from_renotation(self): definition. """ - self.assertEqual(maximum_chroma_from_renotation([2.5, 5, 5]), 14.0) + assert maximum_chroma_from_renotation([2.5, 5, 5]) == 14.0 - self.assertEqual( - maximum_chroma_from_renotation([8.675, 1.225, 10]), 48.0 - ) + assert maximum_chroma_from_renotation([8.675, 1.225, 10]) == 48.0 - self.assertEqual( - maximum_chroma_from_renotation([6.875, 3.425, 1]), 16.0 - ) + assert maximum_chroma_from_renotation([6.875, 3.425, 1]) == 16.0 -class TestMunsellSpecification_to_xy(unittest.TestCase): +class TestMunsellSpecification_to_xy: """ Define :func:`colour.notation.munsell.munsell_specification_to_xy` definition unit tests methods. @@ -2536,7 +2489,3 @@ def test_munsell_specification_to_xy(self): xyY[0:2], atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/phenomena/rayleigh.py b/colour/phenomena/rayleigh.py index 082ffe5f3d..e885b36d33 100644 --- a/colour/phenomena/rayleigh.py +++ b/colour/phenomena/rayleigh.py @@ -2,7 +2,7 @@ Rayleigh Optical Depth - Scattering in the Atmosphere ===================================================== -Implements *Rayleigh* scattering / optical depth in the atmosphere computation: +Implement *Rayleigh* scattering / optical depth in the atmosphere computation: - :func:`colour.scattering_cross_section` - :func:`colour.phenomena.rayleigh_optical_depth` @@ -172,11 +172,7 @@ def air_refraction_index_Peck1972( wl = as_float_array(wavelength) - n = ( - 8060.51 - + 2480990 / (132.274 - wl ** (-2)) - + 17455.7 / (39.32957 - wl ** (-2)) - ) + n = 8060.51 + 2480990 / (132.274 - wl ** (-2)) + 17455.7 / (39.32957 - wl ** (-2)) n /= 1.0e8 n += +1 @@ -216,9 +212,7 @@ def air_refraction_index_Bodhaine1999( # Converting from parts per million (ppm) to parts per volume (ppv). CO2_c = CO2_c * 1e-6 - n = (1 + 0.54 * (CO2_c - 300e-6)) * ( - air_refraction_index_Peck1972(wl) - 1 - ) + 1 + n = (1 + 0.54 * (CO2_c - 300e-6)) * (air_refraction_index_Peck1972(wl) - 1) + 1 return as_float(n) @@ -274,9 +268,7 @@ def O2_depolarisation(wavelength: ArrayLike) -> NDArrayFloat: wl = as_float_array(wavelength) - O2 = ( - 1.096 + 1.385 * 1.0e-3 * (1 / wl**2) + 1.448 * 1.0e-4 * (1 / wl**4) - ) + O2 = 1.096 + 1.385 * 1.0e-3 * (1 / wl**2) + 1.448 * 1.0e-4 * (1 / wl**4) return O2 @@ -372,9 +364,7 @@ def F_air_Bates1984(wavelength: ArrayLike) -> NDArrayFloat: Ar = 1.00 CO2 = 1.15 - F_air = (78.084 * N2 + 20.946 * O2 + CO2 + Ar) / ( - 78.084 + 20.946 + Ar + CO2 - ) + F_air = (78.084 * N2 + 20.946 * O2 + CO2 + Ar) / (78.084 + 20.946 + Ar + CO2) return F_air @@ -615,12 +605,7 @@ def scattering_cross_section( ) ) - sigma = ( - 24 - * np.pi**3 - * (n_s**2 - 1) ** 2 - / (wl**4 * N_s**2 * (n_s**2 + 2) ** 2) - ) + sigma = 24 * np.pi**3 * (n_s**2 - 1) ** 2 / (wl**4 * N_s**2 * (n_s**2 + 2) ** 2) sigma *= F_air return sigma @@ -764,7 +749,6 @@ def sd_rayleigh_scattering( >>> from colour.utilities import numpy_print_options >>> with numpy_print_options(suppress=True): ... sd_rayleigh_scattering() # doctest: +ELLIPSIS - ... SpectralDistribution([[ 360. , 0.5602465...], [ 361. , 0.5537481...], [ 362. , 0.5473446...], diff --git a/colour/phenomena/tests/test_rayleigh.py b/colour/phenomena/tests/test_rayleigh.py index b160d25cd3..7680c311a3 100644 --- a/colour/phenomena/tests/test_rayleigh.py +++ b/colour/phenomena/tests/test_rayleigh.py @@ -1,10 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.phenomena.rayleigh` module.""" from __future__ import annotations -import unittest - import numpy as np from colour.constants import TOLERANCE_ABSOLUTE_TESTS @@ -482,7 +479,7 @@ ) -class TestAirRefractionIndexPenndorf1957(unittest.TestCase): +class TestAirRefractionIndexPenndorf1957: """ Define :func:`colour.phenomena.rayleigh.\ air_refraction_index_Penndorf1957` definition unit tests methods. @@ -557,7 +554,7 @@ def test_nan_air_refraction_index_Penndorf1957(self): ) -class TestAirRefractionIndexEdlen1966(unittest.TestCase): +class TestAirRefractionIndexEdlen1966: """ Define :func:`colour.phenomena.rayleigh.air_refraction_index_Edlen1966` definition unit tests methods. @@ -632,7 +629,7 @@ def test_nan_air_refraction_index_Edlen1966(self): ) -class TestAirRefractionIndexPeck1972(unittest.TestCase): +class TestAirRefractionIndexPeck1972: """ Define :func:`colour.phenomena.rayleigh.air_refraction_index_Peck1972` definition unit tests methods. @@ -701,7 +698,7 @@ def test_nan_air_refraction_index_Peck1972(self): ) -class TestAirRefractionIndexBodhaine1999(unittest.TestCase): +class TestAirRefractionIndexBodhaine1999: """ Define :func:`colour.phenomena.rayleigh.\ air_refraction_index_Bodhaine1999` definition unit tests methods. @@ -793,7 +790,7 @@ def test_nan_air_refraction_index_Bodhaine1999(self): air_refraction_index_Bodhaine1999(cases, cases) -class TestN2Depolarisation(unittest.TestCase): +class TestN2Depolarisation: """ Define :func:`colour.phenomena.rayleigh.N2_depolarisation` definition unit tests methods. @@ -857,7 +854,7 @@ def test_nan_N2_depolarisation(self): N2_depolarisation(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestO2Depolarisation(unittest.TestCase): +class TestO2Depolarisation: """ Define :func:`colour.phenomena.rayleigh.O2_depolarisation` definition unit tests methods. @@ -921,7 +918,7 @@ def test_nan_O2_depolarisation(self): O2_depolarisation(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestF_airPenndorf1957(unittest.TestCase): +class TestF_airPenndorf1957: """ Define :func:`colour.phenomena.rayleigh.F_air_Penndorf1957` definition unit tests methods. @@ -933,7 +930,7 @@ def test_F_air_Penndorf1957(self): definition. """ - self.assertEqual(F_air_Penndorf1957(0.360), 1.0608) + assert F_air_Penndorf1957(0.360) == 1.0608 def test_n_dimensional_F_air_Penndorf1957(self): """ @@ -972,7 +969,7 @@ def test_nan_F_air_Penndorf1957(self): F_air_Penndorf1957(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestF_airYoung1981(unittest.TestCase): +class TestF_airYoung1981: """ Define :func:`colour.phenomena.rayleigh.F_air_Young1981` definition unit tests methods. @@ -981,7 +978,7 @@ class TestF_airYoung1981(unittest.TestCase): def test_F_air_Young1981(self): """Test :func:`colour.phenomena.rayleigh.F_air_Young1981` definition.""" - self.assertEqual(F_air_Young1981(0.360), 1.0480) + assert F_air_Young1981(0.360) == 1.0480 def test_n_dimensional_F_air_Young1981(self): """ @@ -1020,7 +1017,7 @@ def test_nan_F_air_Young1981(self): F_air_Young1981(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestF_airBates1984(unittest.TestCase): +class TestF_airBates1984: """ Define :func:`colour.phenomena.rayleigh.F_air_Bates1984` definition unit tests methods. @@ -1084,7 +1081,7 @@ def test_nan_F_air_Bates1984(self): F_air_Bates1984(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestF_airBodhaine1999(unittest.TestCase): +class TestF_airBodhaine1999: """ Define :func:`colour.phenomena.rayleigh.F_air_Bodhaine1999` definition unit tests methods. @@ -1170,7 +1167,7 @@ def test_nan_F_air_Bodhaine1999(self): F_air_Bodhaine1999(cases, cases) -class TestMolecularDensity(unittest.TestCase): +class TestMolecularDensity: """ Define :func:`colour.phenomena.rayleigh.molecular_density` definition unit tests methods. @@ -1228,7 +1225,7 @@ def test_nan_molecular_density(self): molecular_density(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestMeanMolecularWeights(unittest.TestCase): +class TestMeanMolecularWeights: """ Define :func:`colour.phenomena.rayleigh.mean_molecular_weights` definition unit tests methods. @@ -1290,12 +1287,10 @@ def test_nan_mean_molecular_weights(self): definition nan support. """ - mean_molecular_weights( - np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan]) - ) + mean_molecular_weights(np.array([-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan])) -class TestGravityList1968(unittest.TestCase): +class TestGravityList1968: """ Define :func:`colour.phenomena.rayleigh.gravity_List1968` definition unit tests methods. @@ -1329,24 +1324,16 @@ def test_n_dimensional_gravity_List1968(self): """ g = 978.03560706 - np.testing.assert_allclose( - gravity_List1968(), g, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(gravity_List1968(), g, atol=TOLERANCE_ABSOLUTE_TESTS) g = np.tile(g, 6) - np.testing.assert_allclose( - gravity_List1968(), g, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(gravity_List1968(), g, atol=TOLERANCE_ABSOLUTE_TESTS) g = np.reshape(g, (2, 3)) - np.testing.assert_allclose( - gravity_List1968(), g, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(gravity_List1968(), g, atol=TOLERANCE_ABSOLUTE_TESTS) g = np.reshape(g, (2, 3, 1)) - np.testing.assert_allclose( - gravity_List1968(), g, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(gravity_List1968(), g, atol=TOLERANCE_ABSOLUTE_TESTS) @ignore_numpy_errors def test_nan_gravity_List1968(self): @@ -1359,7 +1346,7 @@ def test_nan_gravity_List1968(self): gravity_List1968(cases, cases) -class TestScatteringCrossSection(unittest.TestCase): +class TestScatteringCrossSection: """ Define :func:`colour.phenomena.rayleigh.scattering_cross_section` definition unit tests methods. @@ -1460,7 +1447,7 @@ def test_nan_scattering_cross_section(self): scattering_cross_section(cases, cases, cases) -class TestRayleighOpticalDepth(unittest.TestCase): +class TestRayleighOpticalDepth: """ Define :func:`colour.phenomena.rayleigh.rayleigh_optical_depth` definition unit tests methods. @@ -1597,7 +1584,7 @@ def test_nan_rayleigh_optical_depth(self): rayleigh_optical_depth(cases, cases, cases, cases, cases) -class TestSdRayleighScattering(unittest.TestCase): +class TestSdRayleighScattering: """ Define :func:`colour.phenomena.rayleigh.sd_rayleigh_scattering` definition unit tests methods. @@ -1614,7 +1601,3 @@ def test_sd_rayleigh_scattering(self): DATA_SD_RAYLEIGH_SCATTERING, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/plotting/__init__.py b/colour/plotting/__init__.py index b85a54df21..7f5c514495 100644 --- a/colour/plotting/__init__.py +++ b/colour/plotting/__init__.py @@ -1,6 +1,6 @@ from colour.utilities import is_matplotlib_installed -if not is_matplotlib_installed(): +if not is_matplotlib_installed(): # pragma: no cover import sys from unittest.mock import MagicMock from colour.utilities import usage_warning diff --git a/colour/plotting/blindness.py b/colour/plotting/blindness.py index a39adbb3ea..93d4ee77a5 100644 --- a/colour/plotting/blindness.py +++ b/colour/plotting/blindness.py @@ -2,7 +2,7 @@ Colour Blindness Plotting ========================= -Defines the colour blindness plotting objects: +Define the colour blindness plotting objects: - :func:`colour.plotting.plot_cvd_simulation_Machado2009` """ @@ -12,7 +12,7 @@ from matplotlib.axes import Axes from matplotlib.figure import Figure -from colour.algebra import vector_dot +from colour.algebra import vecmul from colour.blindness import matrix_cvd_Machado2009 from colour.hints import ( Any, @@ -39,8 +39,9 @@ @override_style() def plot_cvd_simulation_Machado2009( RGB: ArrayLike, - deficiency: Literal["Deuteranomaly", "Protanomaly", "Tritanomaly"] - | str = "Protanomaly", + deficiency: ( + Literal["Deuteranomaly", "Protanomaly", "Tritanomaly"] | str + ) = "Protanomaly", severity: float = 0.5, M_a: ArrayLike | None = None, **kwargs: Any, @@ -92,15 +93,11 @@ def plot_cvd_simulation_Machado2009( M_a = optional(M_a, matrix_cvd_Machado2009(deficiency, severity)) settings: Dict[str, Any] = { - "text_kwargs": { - "text": f"Deficiency: {deficiency} - Severity: {severity}" - } + "text_kwargs": {"text": f"Deficiency: {deficiency} - Severity: {severity}"} } settings.update(kwargs) return plot_image( - CONSTANTS_COLOUR_STYLE.colour.colourspace.cctf_encoding( - vector_dot(M_a, RGB) - ), + CONSTANTS_COLOUR_STYLE.colour.colourspace.cctf_encoding(vecmul(M_a, RGB)), **settings, ) diff --git a/colour/plotting/characterisation.py b/colour/plotting/characterisation.py index 1f6f67ce28..88103e685b 100644 --- a/colour/plotting/characterisation.py +++ b/colour/plotting/characterisation.py @@ -2,7 +2,7 @@ Characterisation Plotting ========================= -Defines the characterisation plotting objects: +Define the characterisation plotting objects: - :func:`colour.plotting.plot_single_colour_checker` - :func:`colour.plotting.plot_multi_colour_checkers` @@ -52,8 +52,7 @@ } ) def plot_single_colour_checker( - colour_checker: ColourChecker - | str = "ColorChecker24 - After November 2014", + colour_checker: (ColourChecker | str) = "ColorChecker24 - After November 2014", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -139,9 +138,7 @@ def plot_multi_colour_checkers( :alt: plot_multi_colour_checkers """ - filtered_colour_checkers = list( - filter_colour_checkers(colour_checkers).values() - ) + filtered_colour_checkers = list(filter_colour_checkers(colour_checkers).values()) attest( len(filtered_colour_checkers) <= 2, diff --git a/colour/plotting/colorimetry.py b/colour/plotting/colorimetry.py index 801536fb30..105a5d65e4 100644 --- a/colour/plotting/colorimetry.py +++ b/colour/plotting/colorimetry.py @@ -2,7 +2,7 @@ Colorimetry Plotting ==================== -Defines the colorimetry plotting objects: +Define the colorimetry plotting objects: - :func:`colour.plotting.plot_single_sd` - :func:`colour.plotting.plot_multi_sds` @@ -111,11 +111,9 @@ @override_style() def plot_single_sd( sd: SpectralDistribution, - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", out_of_gamut_clipping: bool = True, modulate_colours_with_sd_amplitude: bool = False, equalize_sd_amplitude: bool = False, @@ -183,18 +181,14 @@ def plot_single_sd( _figure, axes = artist(**kwargs) - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) sd = sd.copy() sd.interpolator = LinearInterpolator wavelengths = cmfs.wavelengths[ np.logical_and( - cmfs.wavelengths - >= max(min(cmfs.wavelengths), min(sd.wavelengths)), - cmfs.wavelengths - <= min(max(cmfs.wavelengths), max(sd.wavelengths)), + cmfs.wavelengths >= max(min(cmfs.wavelengths), min(sd.wavelengths)), + cmfs.wavelengths <= min(max(cmfs.wavelengths), max(sd.wavelengths)), ) ] values = sd[wavelengths] @@ -270,9 +264,11 @@ def plot_single_sd( @override_style() def plot_multi_sds( - sds: Sequence[SpectralDistribution | MultiSpectralDistributions] - | SpectralDistribution - | MultiSpectralDistributions, + sds: ( + Sequence[SpectralDistribution | MultiSpectralDistributions] + | SpectralDistribution + | MultiSpectralDistributions + ), plot_kwargs: dict | List[dict] | None = None, **kwargs: Any, ) -> Tuple[Figure, Axes]: @@ -391,9 +387,7 @@ def plot_multi_sds( ) illuminant = cast( SpectralDistribution, - first_item( - filter_illuminants(plot_settings.pop("illuminant")).values() - ), + first_item(filter_illuminants(plot_settings.pop("illuminant")).values()), ) normalise_sd_colours = plot_settings.pop("normalise_sd_colours") use_sd_colours = plot_settings.pop("use_sd_colours") @@ -413,9 +407,7 @@ def plot_multi_sds( if normalise_sd_colours: XYZ /= XYZ[..., 1] - plot_settings["color"] = np.clip( - XYZ_to_plotting_colourspace(XYZ), 0, 1 - ) + plot_settings["color"] = np.clip(XYZ_to_plotting_colourspace(XYZ), 0, 1) axes.plot(wavelengths, values, **plot_settings) @@ -439,11 +431,9 @@ def plot_multi_sds( @override_style() def plot_single_cmfs( - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -479,9 +469,7 @@ def plot_single_cmfs( :alt: plot_single_cmfs """ - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) settings: Dict[str, Any] = { "title": f"{cmfs.display_name} - Colour Matching Functions" @@ -493,9 +481,9 @@ def plot_single_cmfs( @override_style() def plot_multi_cmfs( - cmfs: MultiSpectralDistributions - | str - | Sequence[MultiSpectralDistributions | str], + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ), **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -533,9 +521,7 @@ def plot_multi_cmfs( :alt: plot_multi_cmfs """ - cmfs = cast( - List[MultiSpectralDistributions], list(filter_cmfs(cmfs).values()) - ) # pyright: ignore + cmfs = cast(List[MultiSpectralDistributions], list(filter_cmfs(cmfs).values())) # pyright: ignore _figure, axes = artist(**kwargs) @@ -547,9 +533,7 @@ def plot_multi_cmfs( x_limit_min, x_limit_max, y_limit_min, y_limit_max = [], [], [], [] for i, cmfs_i in enumerate(cmfs): - for j, RGB in enumerate( - as_float_array([[1, 0, 0], [0, 1, 0], [0, 0, 1]]) - ): + for j, RGB in enumerate(as_float_array([[1, 0, 0], [0, 1, 0], [0, 0, 1]])): RGB = [ # noqa: PLW2901 reduce(lambda y, _: y * 0.5, range(i), x) for x in RGB ] @@ -594,11 +578,9 @@ def plot_multi_cmfs( @override_style() def plot_single_illuminant_sd( illuminant: SpectralDistribution | str, - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -641,9 +623,7 @@ def plot_single_illuminant_sd( :alt: plot_single_illuminant_sd """ - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) title = f"Illuminant {illuminant} - {cmfs.display_name}" @@ -660,9 +640,7 @@ def plot_single_illuminant_sd( @override_style() def plot_multi_illuminant_sds( - illuminants: SpectralDistribution - | str - | Sequence[SpectralDistribution | str], + illuminants: (SpectralDistribution | str | Sequence[SpectralDistribution | str]), **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -731,11 +709,9 @@ def plot_multi_illuminant_sds( } ) def plot_visible_spectrum( - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", out_of_gamut_clipping: bool = True, **kwargs: Any, ) -> Tuple[Figure, Axes]: @@ -781,9 +757,7 @@ def plot_visible_spectrum( :alt: plot_visible_spectrum """ - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) bounding_box = (min(cmfs.wavelengths), max(cmfs.wavelengths), 0, 1) @@ -1006,11 +980,9 @@ def plot_multi_luminance_functions( @override_style() def plot_blackbody_spectral_radiance( temperature: float = 3500, - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", blackbody: str = "VY Canis Major", **kwargs: Any, ) -> Tuple[Figure, Axes]: @@ -1056,9 +1028,7 @@ def plot_blackbody_spectral_radiance( figure.subplots_adjust(hspace=CONSTANTS_COLOUR_STYLE.geometry.short / 2) - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) sd = sd_blackbody(temperature, cmfs.shape) @@ -1108,11 +1078,9 @@ def plot_blackbody_spectral_radiance( ) def plot_blackbody_colours( shape: SpectralShape = SpectralShape(150, 12500, 50), - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -1151,9 +1119,7 @@ def plot_blackbody_colours( _figure, axes = artist(**kwargs) - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) RGB = [] temperatures = [] diff --git a/colour/plotting/common.py b/colour/plotting/common.py index f5131b18c2..8324fb3d4c 100644 --- a/colour/plotting/common.py +++ b/colour/plotting/common.py @@ -2,7 +2,7 @@ Common Plotting =============== -Defines the common plotting objects: +Define the common plotting objects: - :func:`colour.plotting.colour_style` - :func:`colour.plotting.override_style` @@ -33,6 +33,7 @@ from contextlib import contextmanager from dataclasses import dataclass, field from functools import partial +from pathlib import Path import matplotlib.cm import matplotlib.font_manager @@ -82,7 +83,6 @@ filter_mapping, first_item, is_sibling, - is_string, optional, runtime_warning, validate_method, @@ -346,7 +346,6 @@ def override_style(**kwargs: Any) -> Callable: ... def f(*args, **kwargs): ... plt.text(0.5, 0.5, "This is a text!") ... plt.show() - ... >>> f() # doctest: +SKIP """ @@ -362,9 +361,7 @@ def wrapped(*args: Any, **kwargs: Any) -> Any: keywords.update(kwargs) style_overrides = { - key: value - for key, value in keywords.items() - if key in plt.rcParams + key: value for key, value in keywords.items() if key in plt.rcParams } with plt.style.context(style_overrides): @@ -394,10 +391,7 @@ def font_scaling(scaling: LiteralFontScaling, value: float) -> Generator: Examples -------- >>> with font_scaling("medium-colour-science", 2): - ... print( - ... matplotlib.font_manager.font_scalings["medium-colour-science"] - ... ) - ... + ... print(matplotlib.font_manager.font_scalings["medium-colour-science"]) 2 >>> print(matplotlib.font_manager.font_scalings["medium-colour-science"]) 1 @@ -415,9 +409,9 @@ def font_scaling(scaling: LiteralFontScaling, value: float) -> Generator: def XYZ_to_plotting_colourspace( XYZ: ArrayLike, illuminant: ArrayLike = RGB_COLOURSPACES["sRGB"].whitepoint, - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", apply_cctf_encoding: bool = True, ) -> NDArrayFloat: """ @@ -636,7 +630,14 @@ class KwargsRender(TypedDict): Whether to show the figure and call :func:`matplotlib.pyplot.show` definition. block - Whether to block on `show`ing the plot. + Whether to wait for all figures to be closed before returning. + If `True` block and run the GUI main loop until all figure windows + are closed. + If `False` ensure that all figure windows are displayed and return + immediately. In this case, you are responsible for ensuring + that the event loop is running to have responsive figures. + Defaults to True in non-interactive mode and to False in interactive + mode. aspect Matplotlib axes aspect. axes_visible @@ -669,7 +670,7 @@ class KwargsRender(TypedDict): figure: Figure axes: Axes - filename: str + filename: str | Path show: bool block: bool aspect: Literal["auto", "equal"] | float @@ -766,7 +767,7 @@ def render( figure.patch.set_alpha(0) if settings.filename is not None: - figure.savefig(settings.filename) + figure.savefig(str(settings.filename)) if settings.show: plt.show(block=settings.block) @@ -877,9 +878,7 @@ def uniform_axes3d(**kwargs: Any) -> Tuple[Figure, Axes]: extent = np.max(np.abs(extents[..., 1] - extents[..., 0])) for center, axis in zip(centers, "xyz"): - getattr(axes, f"set_{axis}lim")( - center - extent / 2, center + extent / 2 - ) + getattr(axes, f"set_{axis}lim")(center - extent / 2, center + extent / 2) return figure, axes @@ -957,11 +956,11 @@ class instance, then the lower, slugified and canonical keys are also used for matching. """ - if is_string(filterers) or not isinstance(filterers, (list, tuple)): + if isinstance(filterers, str) or not isinstance(filterers, (list, tuple)): filterers = [filterers] string_filterers: List[str] = [ - cast(str, filterer) for filterer in filterers if is_string(filterer) + filterer for filterer in filterers if isinstance(filterer, str) ] object_filterers: List[Any] = [ @@ -972,8 +971,7 @@ class instance, then the lower, slugified and canonical keys are also non_siblings = [ filterer for filterer in filterers - if filterer not in string_filterers - and filterer not in object_filterers + if filterer not in string_filterers and filterer not in object_filterers ] if non_siblings: @@ -1005,10 +1003,12 @@ class instance, then the lower, slugified and canonical keys are also def filter_RGB_colourspaces( - filterers: RGB_Colourspace - | LiteralRGBColourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str], + filterers: ( + RGB_Colourspace + | LiteralRGBColourspace + | str + | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + ), allow_non_siblings: bool = True, ) -> Dict[str, RGB_Colourspace]: """ @@ -1035,9 +1035,9 @@ def filter_RGB_colourspaces( def filter_cmfs( - filterers: MultiSpectralDistributions - | str - | Sequence[MultiSpectralDistributions | str], + filterers: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ), allow_non_siblings: bool = True, ) -> Dict[str, MultiSpectralDistributions]: """ @@ -1066,9 +1066,7 @@ def filter_cmfs( def filter_illuminants( - filterers: SpectralDistribution - | str - | Sequence[SpectralDistribution | str], + filterers: SpectralDistribution | str | Sequence[SpectralDistribution | str], allow_non_siblings: bool = True, ) -> Dict[str, SpectralDistribution]: """ @@ -1128,9 +1126,7 @@ def filter_colour_checkers( Filtered colour checkers. """ - return filter_passthrough( - CCS_COLOURCHECKERS, filterers, allow_non_siblings - ) + return filter_passthrough(CCS_COLOURCHECKERS, filterers, allow_non_siblings) def update_settings_collection( @@ -1326,7 +1322,9 @@ def plot_multi_colour_swatches( colour_swatches_converted = [] if not isinstance(first_item(colour_swatches), ColourSwatch): for _i, colour_swatch in enumerate( - as_float_array(cast(ArrayLike, colour_swatches)).reshape([-1, 3]) + np.reshape( + as_float_array(cast(ArrayLike, colour_swatches))[..., :3], (-1, 3) + ) ): colour_swatches_converted.append(ColourSwatch(colour_swatch)) else: @@ -1613,20 +1611,10 @@ def plot_multi_functions( samples = optional(samples, np.linspace(0, 1, 1000)) for i, (_name, function) in enumerate(functions.items()): - plotting_function( - samples, function(samples), **plot_settings_collection[i] - ) + plotting_function(samples, function(samples), **plot_settings_collection[i]) - x_label = ( - f"x - Log Base {log_x} Scale" - if log_x is not None - else "x - Linear Scale" - ) - y_label = ( - f"y - Log Base {log_y} Scale" - if log_y is not None - else "y - Linear Scale" - ) + x_label = f"x - Log Base {log_x} Scale" if log_x is not None else "x - Linear Scale" + y_label = f"y - Log Base {log_y} Scale" if log_y is not None else "y - Linear Scale" settings = { "axes": axes, "legend": True, diff --git a/colour/plotting/conftest.py b/colour/plotting/conftest.py index 62a1d63f22..bc9c901bac 100644 --- a/colour/plotting/conftest.py +++ b/colour/plotting/conftest.py @@ -2,7 +2,7 @@ Plotting - Pytest Configuration =============================== -Configures *pytest* to use the *Matplotlib* *AGG* headless backend. This allows +Configure *pytest* to use the *Matplotlib* *AGG* headless backend. This allows the plotting unittests to run without creating windows in IDEs such as *VSCode*. """ diff --git a/colour/plotting/corresponding.py b/colour/plotting/corresponding.py index 531f68de7f..2cf8675dff 100644 --- a/colour/plotting/corresponding.py +++ b/colour/plotting/corresponding.py @@ -2,7 +2,7 @@ Corresponding Chromaticities Prediction Plotting ================================================ -Defines the corresponding chromaticities prediction plotting objects: +Define the corresponding chromaticities prediction plotting objects: - :func:`colour.plotting.plot_corresponding_chromaticities_prediction` """ @@ -40,12 +40,17 @@ @override_style() def plot_corresponding_chromaticities_prediction( - experiment: Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] - | CorrespondingColourDataset = 1, - model: Literal[ - "CIE 1994", "CMCCAT2000", "Fairchild 1990", "Von Kries", "Zhai 2018" - ] - | str = "Von Kries", + experiment: (Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] | CorrespondingColourDataset) = 1, + model: ( + Literal[ + "CIE 1994", + "CMCCAT2000", + "Fairchild 1990", + "Von Kries", + "Zhai 2018", + ] + | str + ) = "Von Kries", corresponding_chromaticities_prediction_kwargs: dict | None = None, **kwargs: Any, ) -> Tuple[Figure, Axes]: diff --git a/colour/plotting/datasets/astm_g_173.py b/colour/plotting/datasets/astm_g_173.py index d31c9355f3..608bcfdf33 100644 --- a/colour/plotting/datasets/astm_g_173.py +++ b/colour/plotting/datasets/astm_g_173.py @@ -2,7 +2,7 @@ ASTM G-173 Solar Spectral Irradiance ==================================== -Defines the solar spectral irradiance spectral distribution used in various +Define the solar spectral irradiance spectral distribution used in various plotting objects. References diff --git a/colour/plotting/diagrams.py b/colour/plotting/diagrams.py index 7c0ffab3ad..bfe10c4e36 100644 --- a/colour/plotting/diagrams.py +++ b/colour/plotting/diagrams.py @@ -2,7 +2,7 @@ CIE Chromaticity Diagrams Plotting ================================== -Defines the *CIE* chromaticity diagrams plotting objects: +Define the *CIE* chromaticity diagrams plotting objects: - :func:`colour.plotting.lines_spectral_locus` - :func:`colour.plotting.plot_chromaticity_diagram_CIE1931` @@ -122,9 +122,7 @@ "uv_to_ij": lambda a, *args: a, # noqa: ARG005 }, "CIE 1976 UCS": { - "XYZ_to_ij": lambda a, *args: Luv_to_uv( - XYZ_to_Luv(a, *args), *args - ), + "XYZ_to_ij": lambda a, *args: Luv_to_uv(XYZ_to_Luv(a, *args), *args), "ij_to_XYZ": lambda a, *args: xy_to_XYZ( # noqa: ARG005 Luv_uv_to_xy(a) ), @@ -211,17 +209,14 @@ def lines_spectral_locus( - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", labels: Sequence | None = None, - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931", + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", ) -> Tuple[NDArray, NDArray]: """ - Return the *Spectral Locus* line vertices, i.e. positions, normals and + Return the *Spectral Locus* line vertices, i.e., positions, normals and colours, according to given method. Parameters @@ -255,9 +250,7 @@ def lines_spectral_locus( ('colour', '= 0 else wavelengths[index] - right = ( - wavelengths[index] if index < len(wavelengths) else wavelengths[-1] - ) + right = wavelengths[index] if index < len(wavelengths) else wavelengths[-1] dx = wl_ij_cmfs[right][0] - wl_ij_cmfs[left][0] dy = wl_ij_cmfs[right][1] - wl_ij_cmfs[left][1] @@ -340,9 +329,9 @@ def lines_spectral_locus( normal_l.append([normal, normal]) colour_l.append([ij_l, ij_l]) - ij_w = as_float_array(ij_n).reshape([-1, 2]) - normal_w = as_float_array(normal_l).reshape([-1, 2]) - colours_w = as_float_array(colour_l).reshape([-1, 2]) + ij_w = np.reshape(as_float_array(ij_n), (-1, 2)) + normal_w = np.reshape(as_float_array(normal_l), (-1, 2)) + colours_w = np.reshape(as_float_array(colour_l), (-1, 2)) colour_w = normalise_maximum( XYZ_to_plotting_colourspace( @@ -369,16 +358,13 @@ def lines_spectral_locus( @override_style() def plot_spectral_locus( - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", spectral_locus_colours: ArrayLike | str | None = None, spectral_locus_opacity: float = 1, spectral_locus_labels: Sequence | None = None, - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931", + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -441,41 +427,36 @@ def plot_spectral_locus( _figure, axes = artist(**settings) - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) - lines_sl, lines_w = lines_spectral_locus( - cmfs, spectral_locus_labels, method - ) + lines_sl, lines_w = lines_spectral_locus(cmfs, spectral_locus_labels, method) axes.add_collection( LineCollection( - np.concatenate( - [lines_sl["position"][:-1], lines_sl["position"][1:]], - axis=1, # pyright: ignore - ).reshape([-1, 2, 2]), - colors=lines_sl["colour"] - if use_RGB_colours - else spectral_locus_colours, + np.reshape( + np.concatenate( + [lines_sl["position"][:-1], lines_sl["position"][1:]], + axis=1, # pyright: ignore + ), + (-1, 2, 2), + ), + colors=(lines_sl["colour"] if use_RGB_colours else spectral_locus_colours), alpha=spectral_locus_opacity, zorder=CONSTANTS_COLOUR_STYLE.zorder.background_line, ) ) axes.add_collection( LineCollection( - lines_w["position"].reshape([-1, 2, 2]), # pyright: ignore - colors=lines_w["colour"][::2] - if use_RGB_colours - else spectral_locus_colours, + np.reshape(lines_w["position"], (-1, 2, 2)), # pyright: ignore + colors=( + lines_w["colour"][::2] if use_RGB_colours else spectral_locus_colours + ), alpha=spectral_locus_opacity, zorder=CONSTANTS_COLOUR_STYLE.zorder.background_line, ) ) - for i, label in enumerate( - [label for label in labels if label in cmfs.wavelengths] - ): + for i, label in enumerate([label for label in labels if label in cmfs.wavelengths]): positions = lines_w["position"][::2] normals = lines_w["normal"][::2] colours = lines_w["colour"][::2] @@ -512,13 +493,10 @@ def plot_chromaticity_diagram_colours( diagram_colours: ArrayLike | str | None = None, diagram_opacity: float = 1, diagram_clipping_path: ArrayLike | None = None, - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -527,7 +505,7 @@ def plot_chromaticity_diagram_colours( Parameters ---------- samples - Samples count on one axis when computing the *Chromaticity Diagram* + Sample count on one axis when computing the *Chromaticity Diagram* colours. diagram_colours Colours of the *Chromaticity Diagram*, if ``diagram_colours`` is set @@ -566,9 +544,7 @@ def plot_chromaticity_diagram_colours( :alt: plot_chromaticity_diagram_colours """ - method = validate_method( - method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS") - ) + method = validate_method(method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS")) settings: Dict[str, Any] = {"uniform": True} settings.update(kwargs) @@ -579,9 +555,7 @@ def plot_chromaticity_diagram_colours( diagram_colours, HEX_to_RGB(CONSTANTS_COLOUR_STYLE.colour.average) ) - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) illuminant = CONSTANTS_COLOUR_STYLE.colour.colourspace.whitepoint @@ -591,9 +565,7 @@ def plot_chromaticity_diagram_colours( use_RGB_diagram_colours = str(diagram_colours).upper() == "RGB" if use_RGB_diagram_colours: - ii, jj = np.meshgrid( - np.linspace(0, 1, samples), np.linspace(1, 0, samples) - ) + ii, jj = np.meshgrid(np.linspace(0, 1, samples), np.linspace(1, 0, samples)) ij = tstack([ii, jj]) ij_to_XYZ = METHODS_CHROMATICITY_DIAGRAM[method]["ij_to_XYZ"] @@ -603,15 +575,17 @@ def plot_chromaticity_diagram_colours( ) polygon = Polygon( - spectral_locus - if diagram_clipping_path is None - else diagram_clipping_path, - facecolor="none" - if use_RGB_diagram_colours - else np.hstack([diagram_colours, diagram_opacity]), - edgecolor="none" - if use_RGB_diagram_colours - else np.hstack([diagram_colours, diagram_opacity]), + (spectral_locus if diagram_clipping_path is None else diagram_clipping_path), + facecolor=( + "none" + if use_RGB_diagram_colours + else np.hstack([diagram_colours, diagram_opacity]) + ), + edgecolor=( + "none" + if use_RGB_diagram_colours + else np.hstack([diagram_colours, diagram_opacity]) + ), zorder=CONSTANTS_COLOUR_STYLE.zorder.background_polygon, ) axes.add_patch(polygon) @@ -637,15 +611,12 @@ def plot_chromaticity_diagram_colours( @override_style() def plot_chromaticity_diagram( - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", show_diagram_colours: bool = True, show_spectral_locus: bool = True, - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931", + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -688,18 +659,14 @@ def plot_chromaticity_diagram( :alt: plot_chromaticity_diagram """ - method = validate_method( - method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS") - ) + method = validate_method(method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS")) settings: Dict[str, Any] = {"uniform": True} settings.update(kwargs) _figure, axes = artist(**settings) - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) if show_diagram_colours: settings = {"axes": axes, "method": method, "diagram_colours": "RGB"} @@ -748,11 +715,9 @@ def plot_chromaticity_diagram( @override_style() def plot_chromaticity_diagram_CIE1931( - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", show_diagram_colours: bool = True, show_spectral_locus: bool = True, **kwargs: Any, @@ -804,11 +769,9 @@ def plot_chromaticity_diagram_CIE1931( @override_style() def plot_chromaticity_diagram_CIE1960UCS( - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", show_diagram_colours: bool = True, show_spectral_locus: bool = True, **kwargs: Any, @@ -860,11 +823,9 @@ def plot_chromaticity_diagram_CIE1960UCS( @override_style() def plot_chromaticity_diagram_CIE1976UCS( - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", show_diagram_colours: bool = True, show_spectral_locus: bool = True, **kwargs: Any, @@ -916,17 +877,16 @@ def plot_chromaticity_diagram_CIE1976UCS( @override_style() def plot_sds_in_chromaticity_diagram( - sds: Sequence[SpectralDistribution | MultiSpectralDistributions] - | SpectralDistribution - | MultiSpectralDistributions, - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + sds: ( + Sequence[SpectralDistribution | MultiSpectralDistributions] + | SpectralDistribution + | MultiSpectralDistributions + ), + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", chromaticity_diagram_callable: Callable = plot_chromaticity_diagram, - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931", + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", annotate_kwargs: dict | List[dict] | None = None, plot_kwargs: dict | List[dict] | None = None, **kwargs: Any, @@ -1028,9 +988,7 @@ def plot_sds_in_chromaticity_diagram( :alt: plot_sds_in_chromaticity_diagram """ - method = validate_method( - method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS") - ) + method = validate_method(method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS")) sds_converted = sds_and_msds_to_sds(sds) @@ -1111,9 +1069,7 @@ def plot_sds_in_chromaticity_diagram( ) illuminant = cast( SpectralDistribution, - first_item( - filter_illuminants(plot_settings.pop("illuminant")).values() - ), + first_item(filter_illuminants(plot_settings.pop("illuminant")).values()), ) normalise_sd_colours = plot_settings.pop("normalise_sd_colours") use_sd_colours = plot_settings.pop("use_sd_colours") @@ -1125,9 +1081,7 @@ def plot_sds_in_chromaticity_diagram( if normalise_sd_colours: XYZ /= XYZ[..., 1] - plot_settings["color"] = np.clip( - XYZ_to_plotting_colourspace(XYZ), 0, 1 - ) + plot_settings["color"] = np.clip(XYZ_to_plotting_colourspace(XYZ), 0, 1) ij = cast(tuple[float, float], XYZ_to_ij(XYZ)) @@ -1147,13 +1101,13 @@ def plot_sds_in_chromaticity_diagram( @override_style() def plot_sds_in_chromaticity_diagram_CIE1931( - sds: Sequence[SpectralDistribution | MultiSpectralDistributions] - | MultiSpectralDistributions, - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + sds: ( + Sequence[SpectralDistribution | MultiSpectralDistributions] + | MultiSpectralDistributions + ), + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", chromaticity_diagram_callable_CIE1931: Callable = ( plot_chromaticity_diagram_CIE1931 ), @@ -1257,13 +1211,13 @@ class instances or a list of :class:`colour.SpectralDistribution` class @override_style() def plot_sds_in_chromaticity_diagram_CIE1960UCS( - sds: Sequence[SpectralDistribution | MultiSpectralDistributions] - | MultiSpectralDistributions, - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + sds: ( + Sequence[SpectralDistribution | MultiSpectralDistributions] + | MultiSpectralDistributions + ), + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", chromaticity_diagram_callable_CIE1960UCS: Callable = ( plot_chromaticity_diagram_CIE1960UCS ), @@ -1368,13 +1322,13 @@ class instances or a list of :class:`colour.SpectralDistribution` class @override_style() def plot_sds_in_chromaticity_diagram_CIE1976UCS( - sds: Sequence[SpectralDistribution | MultiSpectralDistributions] - | MultiSpectralDistributions, - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + sds: ( + Sequence[SpectralDistribution | MultiSpectralDistributions] + | MultiSpectralDistributions + ), + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", chromaticity_diagram_callable_CIE1976UCS: Callable = ( plot_chromaticity_diagram_CIE1976UCS ), diff --git a/colour/plotting/graph.py b/colour/plotting/graph.py index b4b24f3f7f..cef68605e5 100644 --- a/colour/plotting/graph.py +++ b/colour/plotting/graph.py @@ -2,13 +2,15 @@ Automatic Colour Conversion Graph Plotting ========================================== -Defines the automatic colour conversion graph plotting objects: +Define the automatic colour conversion graph plotting objects: - :func:`colour.plotting.plot_automatic_colour_conversion_graph` """ from __future__ import annotations +import os + import colour from colour.graph import ( CONVERSION_GRAPH_NODE_LABELS, @@ -29,14 +31,12 @@ ] -@required("Graphviz") +@required("Pydot") @required("NetworkX") def plot_automatic_colour_conversion_graph( filename: str, - prog: Literal["circo", "dot", "fdp", "neato", "nop", "twopi"] - | str = "fdp", - args: str = "", -) -> AGraph: # pyright: ignore # noqa: F821 + prog: Literal["circo", "dot", "fdp", "neato", "nop", "twopi"] | str = "fdp", +) -> Dot: # pyright: ignore # noqa: F821 # pragma: no cover """ Plot *Colour* automatic colour conversion graph using `Graphviz `__ and @@ -48,13 +48,11 @@ def plot_automatic_colour_conversion_graph( Filename to use to save the image. prog *Graphviz* layout method. - args - Additional arguments for *Graphviz*. Returns ------- - :class:`AGraph` - *Pyraphviz* graph. + :class:`pydot.Dot` + *Pydot* graph. Notes ----- @@ -88,30 +86,31 @@ def plot_automatic_colour_conversion_graph( # TODO: Investigate API to trigger the conversion graph build. describe_conversion_path("RGB", "RGB", print_callable=lambda x: x) - agraph = nx.nx_agraph.to_agraph( - cast(nx.DiGraph, colour.graph.CONVERSION_GRAPH) - ) + dot = nx.drawing.nx_pydot.to_pydot(cast(nx.DiGraph, colour.graph.CONVERSION_GRAPH)) - for node in agraph.nodes(): - node.attr.update(label=CONVERSION_GRAPH_NODE_LABELS[node.name]) + for node in dot.get_nodes(): + label = CONVERSION_GRAPH_NODE_LABELS.get(node.get_name()) - agraph.node_attr.update( - style="filled", - shape="circle", - color="#2196F3FF", - fillcolor="#2196F370", - fontname="Helvetica", - fontcolor="#263238", - ) - agraph.edge_attr.update(color="#26323870") - for node in ("CIE XYZ", "RGB", "Spectral Distribution"): - agraph.get_node(node.lower()).attr.update( - shape="doublecircle", - color="#673AB7FF", - fillcolor="#673AB770", - fontsize=30, - ) - for node in ( + if label is None: + continue + + node.set_label(label) + node.set_style("filled") + node.set_shape("circle") + node.set_color("#2196F3FF") + node.set_fillcolor("#2196F370") + node.set_fontname("Helvetica") + node.set_fontcolor("#263238") + + for name in ("CIE XYZ", "RGB", "Spectral Distribution"): + node = next(iter(dot.get_node(name.lower()))) + + node.set_shape("doublecircle") + node.set_color("#673AB7FF") + node.set_fillcolor("#673AB770") + node.set_fontsize(30) + + for name in ( "ATD95", "CAM16", "CIECAM02", @@ -123,10 +122,16 @@ def plot_automatic_colour_conversion_graph( "RLAB", "ZCAM", ): - agraph.get_node(node.lower()).attr.update( - color="#00BCD4FF", fillcolor="#00BCD470" - ) + node = next(iter(dot.get_node(name.lower()))) + + node.set_color("#00BCD4FF") + node.set_fillcolor("#00BCD470") + + for edge in dot.get_edges(): + edge.set_color("#26323870") - agraph.draw(filename, prog=prog, args=args) + file_format = os.path.splitext(filename)[-1][1:] + write_method = getattr(dot, f"write_{file_format}") + write_method(filename, prog=prog, f=file_format) - return agraph + return dot diff --git a/colour/plotting/models.py b/colour/plotting/models.py index fa56ead1bc..3bc8d3147a 100644 --- a/colour/plotting/models.py +++ b/colour/plotting/models.py @@ -2,7 +2,7 @@ Colour Models Plotting ====================== -Defines the colour models plotting objects: +Define the colour models plotting objects: - :func:`colour.plotting.lines_pointer_gamut` - :func:`colour.plotting.\ @@ -75,6 +75,7 @@ Tuple, cast, ) +from colour.models import LCHab_to_Lab # pyright: ignore from colour.models import ( CCS_ILLUMINANT_POINTER_GAMUT, CCS_POINTER_GAMUT_BOUNDARY, @@ -85,7 +86,6 @@ DATA_MACADAM_1942_ELLIPSES, DATA_POINTER_GAMUT_VOLUME, Lab_to_XYZ, - LCHab_to_Lab, RGB_Colourspace, RGB_to_RGB, RGB_to_XYZ, @@ -163,6 +163,9 @@ "CAM16LCD": (1, 2, 0), "CAM16SCD": (1, 2, 0), "CAM16UCS": (1, 2, 0), + "CIE 1931": (0, 1, 2), + "CIE 1960 UCS": (0, 1, 2), + "CIE 1976 UCS": (0, 1, 2), "CIE LCHab": (1, 2, 0), "CIE LCHuv": (1, 2, 0), "CIE Lab": (1, 2, 0), @@ -260,11 +263,10 @@ def colourspace_model_axis_reorder( def lines_pointer_gamut( - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931" + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", ): """ - Return the *Pointer's Gamut* line vertices, i.e. positions, normals and + Return the *Pointer's Gamut* line vertices, i.e., positions, normals and colours, according to given method. Parameters @@ -290,9 +292,7 @@ def lines_pointer_gamut( ('colour', ' Tuple[Figure, Axes]: """ @@ -391,9 +390,7 @@ def plot_pointer_gamut( :alt: plot_pointer_gamut """ - method = validate_method( - method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS") - ) + method = validate_method(method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS")) pointer_gamut_colours = optional( pointer_gamut_colours, CONSTANTS_COLOUR_STYLE.colour.dark @@ -414,13 +411,14 @@ def plot_pointer_gamut( axes.add_collection( LineCollection( - np.concatenate( - [lines_b["position"][:-1], lines_b["position"][1:]], - axis=1, # pyright: ignore - ).reshape([-1, 2, 2]), - colors=lines_b["colour"] - if use_RGB_colours - else pointer_gamut_colours, + np.reshape( + np.concatenate( + [lines_b["position"][:-1], lines_b["position"][1:]], + axis=1, # pyright: ignore + ), + (-1, 2, 2), + ), + colors=(lines_b["colour"] if use_RGB_colours else pointer_gamut_colours), alpha=pointer_gamut_opacity, zorder=CONSTANTS_COLOUR_STYLE.zorder.foreground_line, ) @@ -446,18 +444,17 @@ def plot_pointer_gamut( @override_style() def plot_RGB_colourspaces_in_chromaticity_diagram( - colourspaces: RGB_Colourspace - | LiteralRGBColourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str], - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + colourspaces: ( + RGB_Colourspace + | LiteralRGBColourspace + | str + | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + ), + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", chromaticity_diagram_callable: Callable = plot_chromaticity_diagram, - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931", + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", show_whitepoints: bool = True, show_pointer_gamut: bool = False, chromatically_adapt: bool = False, @@ -530,9 +527,7 @@ def plot_RGB_colourspaces_in_chromaticity_diagram( :alt: plot_RGB_colourspaces_in_chromaticity_diagram """ - method = validate_method( - method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS") - ) + method = validate_method(method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS")) colourspaces = cast( List[RGB_Colourspace], @@ -544,9 +539,7 @@ def plot_RGB_colourspaces_in_chromaticity_diagram( _figure, axes = artist(**settings) - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) title = ( f"{', '.join([colourspace.name for colourspace in colourspaces])}\n" @@ -660,15 +653,15 @@ def plot_RGB_colourspaces_in_chromaticity_diagram( @override_style() def plot_RGB_colourspaces_in_chromaticity_diagram_CIE1931( - colourspaces: RGB_Colourspace - | LiteralRGBColourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str], - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + colourspaces: ( + RGB_Colourspace + | LiteralRGBColourspace + | str + | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + ), + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", chromaticity_diagram_callable_CIE1931: Callable = ( plot_chromaticity_diagram_CIE1931 ), @@ -755,15 +748,15 @@ def plot_RGB_colourspaces_in_chromaticity_diagram_CIE1931( @override_style() def plot_RGB_colourspaces_in_chromaticity_diagram_CIE1960UCS( - colourspaces: RGB_Colourspace - | LiteralRGBColourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str], - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + colourspaces: ( + RGB_Colourspace + | LiteralRGBColourspace + | str + | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + ), + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", chromaticity_diagram_callable_CIE1960UCS: Callable = ( plot_chromaticity_diagram_CIE1960UCS ), @@ -851,15 +844,15 @@ def plot_RGB_colourspaces_in_chromaticity_diagram_CIE1960UCS( @override_style() def plot_RGB_colourspaces_in_chromaticity_diagram_CIE1976UCS( - colourspaces: RGB_Colourspace - | LiteralRGBColourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str], - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + colourspaces: ( + RGB_Colourspace + | LiteralRGBColourspace + | str + | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + ), + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", chromaticity_diagram_callable_CIE1976UCS: Callable = ( plot_chromaticity_diagram_CIE1976UCS ), @@ -948,14 +941,13 @@ def plot_RGB_colourspaces_in_chromaticity_diagram_CIE1976UCS( @override_style() def plot_RGB_chromaticities_in_chromaticity_diagram( RGB: ArrayLike, - colourspace: RGB_Colourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] = "sRGB", + colourspace: ( + RGB_Colourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + ) = "sRGB", chromaticity_diagram_callable: Callable = ( plot_RGB_colourspaces_in_chromaticity_diagram ), - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931", + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", scatter_kwargs: dict | None = None, **kwargs: Any, ) -> Tuple[Figure, Axes]: @@ -1014,10 +1006,8 @@ def plot_RGB_chromaticities_in_chromaticity_diagram( :alt: plot_RGB_chromaticities_in_chromaticity_diagram """ - RGB = np.reshape(as_float_array(RGB), (-1, 3)) - method = validate_method( - method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS") - ) + RGB = np.reshape(as_float_array(RGB)[..., :3], (-1, 3)) + method = validate_method(method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS")) settings: Dict[str, Any] = {"uniform": True} settings.update(kwargs) @@ -1082,9 +1072,9 @@ def plot_RGB_chromaticities_in_chromaticity_diagram( @override_style() def plot_RGB_chromaticities_in_chromaticity_diagram_CIE1931( RGB: ArrayLike, - colourspace: RGB_Colourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] = "sRGB", + colourspace: ( + RGB_Colourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + ) = "sRGB", chromaticity_diagram_callable_CIE1931: Callable = ( plot_RGB_colourspaces_in_chromaticity_diagram_CIE1931 ), @@ -1160,9 +1150,9 @@ def plot_RGB_chromaticities_in_chromaticity_diagram_CIE1931( @override_style() def plot_RGB_chromaticities_in_chromaticity_diagram_CIE1960UCS( RGB: ArrayLike, - colourspace: RGB_Colourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] = "sRGB", + colourspace: ( + RGB_Colourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + ) = "sRGB", chromaticity_diagram_callable_CIE1960UCS: Callable = ( plot_RGB_colourspaces_in_chromaticity_diagram_CIE1960UCS ), @@ -1240,9 +1230,9 @@ def plot_RGB_chromaticities_in_chromaticity_diagram_CIE1960UCS( @override_style() def plot_RGB_chromaticities_in_chromaticity_diagram_CIE1976UCS( RGB: ArrayLike, - colourspace: RGB_Colourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] = "sRGB", + colourspace: ( + RGB_Colourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + ) = "sRGB", chromaticity_diagram_callable_CIE1976UCS: Callable = ( plot_RGB_colourspaces_in_chromaticity_diagram_CIE1976UCS ), @@ -1318,8 +1308,7 @@ def plot_RGB_chromaticities_in_chromaticity_diagram_CIE1976UCS( def ellipses_MacAdam1942( - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931" + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", ) -> List[NDArrayFloat]: """ Return *MacAdam (1942) Ellipses (Observer PGN)* coefficients according to @@ -1342,9 +1331,7 @@ def ellipses_MacAdam1942( 1.56666660e-02, -2.77000015e+01]) """ - method = validate_method( - method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS") - ) + method = validate_method(method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS")) xy_to_ij = METHODS_CHROMATICITY_DIAGRAM[method]["xy_to_ij"] @@ -1367,8 +1354,7 @@ def ellipses_MacAdam1942( @override_style() def plot_ellipses_MacAdam1942_in_chromaticity_diagram( chromaticity_diagram_callable: Callable = plot_chromaticity_diagram, - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931", + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", chromaticity_diagram_clipping: bool = False, ellipse_kwargs: dict | List[dict] | None = None, **kwargs: Any, @@ -1998,17 +1984,12 @@ def _linear_equation( ) if use_RGB_colours: - RGB_ct = XYZ_to_RGB( - XYZ_ct, colourspace, xy_r, apply_cctf_encoding=True - ) + RGB_ct = XYZ_to_RGB(XYZ_ct, colourspace, xy_r, apply_cctf_encoding=True) scatter_settings["c"] = np.clip(RGB_ct, 0, 1) - RGB_cr = XYZ_to_RGB( - XYZ_cr, colourspace, xy_r, apply_cctf_encoding=True - ) + RGB_cr = XYZ_to_RGB(XYZ_cr, colourspace, xy_r, apply_cctf_encoding=True) RGB_cr = np.clip(np.ravel(RGB_cr), 0, 1) else: - scatter_settings["c"] = CONSTANTS_COLOUR_STYLE.colour.dark - RGB_cr = CONSTANTS_COLOUR_STYLE.colour.dark + RGB_cr = scatter_settings["c"] axes.scatter(ijk_ct[..., 0], ijk_ct[..., 1], **scatter_settings) diff --git a/colour/plotting/notation.py b/colour/plotting/notation.py index cd6a8df8ea..337a7f0f9b 100644 --- a/colour/plotting/notation.py +++ b/colour/plotting/notation.py @@ -2,7 +2,7 @@ Colour Notation Systems Plotting ================================ -Defines the colour notation systems plotting objects: +Define the colour notation systems plotting objects: - :func:`colour.plotting.plot_single_munsell_value_function` - :func:`colour.plotting.plot_multi_munsell_value_functions` @@ -72,9 +72,7 @@ def plot_single_munsell_value_function( :alt: plot_single_munsell_value_function """ - settings: Dict[str, Any] = { - "title": f"{function} - Munsell Value Function" - } + settings: Dict[str, Any] = {"title": f"{function} - Munsell Value Function"} settings.update(kwargs) return plot_multi_munsell_value_functions((function,), **settings) diff --git a/colour/plotting/phenomena.py b/colour/plotting/phenomena.py index 790cb4839d..c7caf32883 100644 --- a/colour/plotting/phenomena.py +++ b/colour/plotting/phenomena.py @@ -2,7 +2,7 @@ Optical Phenomenon Plotting =========================== -Defines the optical phenomena plotting objects: +Define the optical phenomena plotting objects: - :func:`colour.plotting.plot_single_sd_rayleigh_scattering` - :func:`colour.plotting.plot_the_blue_sky` @@ -61,11 +61,9 @@ def plot_single_sd_rayleigh_scattering( pressure: ArrayLike = CONSTANT_AVERAGE_PRESSURE_MEAN_SEA_LEVEL, latitude: ArrayLike = CONSTANT_DEFAULT_LATITUDE, altitude: ArrayLike = CONSTANT_DEFAULT_ALTITUDE, - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -113,9 +111,7 @@ def plot_single_sd_rayleigh_scattering( title = "Rayleigh Scattering" - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) settings: Dict[str, Any] = {"title": title, "y_label": "Optical Depth"} settings.update(kwargs) @@ -134,11 +130,9 @@ def plot_single_sd_rayleigh_scattering( @override_style() def plot_the_blue_sky( - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -179,9 +173,7 @@ def plot_the_blue_sky( figure.subplots_adjust(hspace=CONSTANTS_COLOUR_STYLE.geometry.short / 2) - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) ASTMG173_sd = SD_ASTMG173_ETR.copy() rayleigh_sd = sd_rayleigh_scattering() diff --git a/colour/plotting/quality.py b/colour/plotting/quality.py index 7f61dd7402..5bbd3ac55c 100644 --- a/colour/plotting/quality.py +++ b/colour/plotting/quality.py @@ -2,7 +2,7 @@ Colour Quality Plotting ======================= -Defines the colour quality plotting objects: +Define the colour quality plotting objects: - :func:`colour.plotting.plot_single_sd_colour_rendering_index_bars` - :func:`colour.plotting.plot_multi_sds_colour_rendering_indexes_bars` @@ -158,8 +158,7 @@ def plot_colour_quality_bars( * bar_width ) y = as_float_array( - [Q_a] - + [s[1].Q_a for s in sorted(Q_as.items(), key=lambda s: s[0])] + [Q_a] + [s[1].Q_a for s in sorted(Q_as.items(), key=lambda s: s[0])] ) bars = axes.bar( @@ -285,9 +284,11 @@ def plot_single_sd_colour_rendering_index_bars( @override_style() def plot_multi_sds_colour_rendering_indexes_bars( - sds: Sequence[SpectralDistribution | MultiSpectralDistributions] - | SpectralDistribution - | MultiSpectralDistributions, + sds: ( + Sequence[SpectralDistribution | MultiSpectralDistributions] + | SpectralDistribution + | MultiSpectralDistributions + ), **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -339,10 +340,7 @@ def plot_multi_sds_colour_rendering_indexes_bars( specifications = cast( List[ColourRendering_Specification_CRI], - [ - colour_rendering_index(sd, additional_data=True) - for sd in sds_converted - ], + [colour_rendering_index(sd, additional_data=True) for sd in sds_converted], ) # *colour rendering index* colorimetry data tristimulus values are @@ -420,9 +418,11 @@ def plot_single_sd_colour_quality_scale_bars( @override_style() def plot_multi_sds_colour_quality_scales_bars( - sds: Sequence[SpectralDistribution | MultiSpectralDistributions] - | SpectralDistribution - | MultiSpectralDistributions, + sds: ( + Sequence[SpectralDistribution | MultiSpectralDistributions] + | SpectralDistribution + | MultiSpectralDistributions + ), method: Literal["NIST CQS 7.4", "NIST CQS 9.0"] | str = "NIST CQS 9.0", **kwargs: Any, ) -> Tuple[Figure, Axes]: diff --git a/colour/plotting/section.py b/colour/plotting/section.py index b93a3568dd..850529ab61 100644 --- a/colour/plotting/section.py +++ b/colour/plotting/section.py @@ -2,7 +2,7 @@ Gamut Section Plotting ====================== -Defines the gamut section plotting objects: +Define the gamut section plotting objects: - :func:`colour.plotting.section.plot_hull_section_colours` - :func:`colour.plotting.section.plot_hull_section_contour` @@ -130,7 +130,7 @@ def plot_hull_section_colours( convert_kwargs Keyword arguments for the :func:`colour.convert` definition. samples - Samples count on one axis when computing the hull section colours. + Sample count on one axis when computing the hull section colours. Other Parameters ---------------- @@ -149,16 +149,13 @@ def plot_hull_section_colours( >>> from colour.models import RGB_COLOURSPACE_sRGB >>> from colour.utilities import is_trimesh_installed >>> vertices, faces, _outline = primitive_cube(1, 1, 1, 64, 64, 64) - >>> XYZ_vertices = RGB_to_XYZ( - ... vertices["position"] + 0.5, RGB_COLOURSPACE_sRGB - ... ) + >>> XYZ_vertices = RGB_to_XYZ(vertices["position"] + 0.5, RGB_COLOURSPACE_sRGB) >>> if is_trimesh_installed: ... from trimesh import Trimesh ... ... hull = Trimesh(XYZ_vertices, faces, process=False) ... plot_hull_section_colours(hull, section_colours="RGB") ... # doctest: +ELLIPSIS - ... (
, <...Axes...>) .. image:: ../_static/Plotting_Plot_Hull_Section_Colours.png @@ -191,9 +188,7 @@ def plot_hull_section_colours( convert(hull.vertices, "CIE XYZ", model, **convert_kwargs), model ) ijk_vertices = np.nan_to_num(ijk_vertices) - ijk_vertices *= COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE[ - model - ] + ijk_vertices *= COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE[model] hull.vertices = ijk_vertices @@ -207,9 +202,7 @@ def plot_hull_section_colours( section = hull_section(hull, axis, origin, normalise) - padding = 0.1 * np.mean( - COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE[model] - ) + padding = 0.1 * np.mean(COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE[model]) min_x = np.min(ijk_vertices[..., plane[0]]) - padding max_x = np.max(ijk_vertices[..., plane[0]]) + padding min_y = np.min(ijk_vertices[..., plane[1]]) - padding @@ -228,9 +221,7 @@ def plot_hull_section_colours( cast(Real, np.median(section[..., index_origin])), ) ijk_section[..., plane] = ij - ijk_section /= COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE[ - model - ] + ijk_section /= COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE[model] XYZ_section = convert( colourspace_model_axis_reorder(ijk_section, model, "Inverse"), model, @@ -326,16 +317,13 @@ def plot_hull_section_contour( >>> from colour.models import RGB_COLOURSPACE_sRGB >>> from colour.utilities import is_trimesh_installed >>> vertices, faces, _outline = primitive_cube(1, 1, 1, 64, 64, 64) - >>> XYZ_vertices = RGB_to_XYZ( - ... vertices["position"] + 0.5, RGB_COLOURSPACE_sRGB - ... ) + >>> XYZ_vertices = RGB_to_XYZ(vertices["position"] + 0.5, RGB_COLOURSPACE_sRGB) >>> if is_trimesh_installed: ... from trimesh import Trimesh ... ... hull = Trimesh(XYZ_vertices, faces, process=False) ... plot_hull_section_contour(hull, contour_colours="RGB") ... # doctest: +ELLIPSIS - ... (
, <...Axes...>) .. image:: ../_static/Plotting_Plot_Hull_Section_Contour.png @@ -345,9 +333,7 @@ def plot_hull_section_contour( hull = hull.copy() - contour_colours = optional( - contour_colours, CONSTANTS_COLOUR_STYLE.colour.dark - ) + contour_colours = optional(contour_colours, CONSTANTS_COLOUR_STYLE.colour.dark) settings: Dict[str, Any] = {"uniform": True} settings.update(kwargs) @@ -362,17 +348,13 @@ def plot_hull_section_contour( convert(hull.vertices, "CIE XYZ", model, **convert_kwargs), model ) ijk_vertices = np.nan_to_num(ijk_vertices) - ijk_vertices *= COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE[ - model - ] + ijk_vertices *= COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE[model] hull.vertices = ijk_vertices plane = MAPPING_AXIS_TO_PLANE[axis] - padding = 0.1 * np.mean( - COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE[model] - ) + padding = 0.1 * np.mean(COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE[model]) min_x = np.min(ijk_vertices[..., plane[0]]) - padding max_x = np.max(ijk_vertices[..., plane[0]]) + padding min_y = np.min(ijk_vertices[..., plane[1]]) - padding @@ -382,8 +364,8 @@ def plot_hull_section_contour( use_RGB_contour_colours = str(contour_colours).upper() == "RGB" section = hull_section(hull, axis, origin, normalise) if use_RGB_contour_colours: - ijk_section = section / ( - COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE[model] + ijk_section = ( + section / (COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE[model]) ) XYZ_section = convert( colourspace_model_axis_reorder(ijk_section, model, "Inverse"), @@ -391,9 +373,7 @@ def plot_hull_section_contour( "CIE XYZ", **convert_kwargs, ) - contour_colours = np.clip( - XYZ_to_plotting_colourspace(XYZ_section), 0, 1 - ) + contour_colours = np.clip(XYZ_to_plotting_colourspace(XYZ_section), 0, 1) section = np.reshape(section[..., plane], (-1, 1, 2)) line_collection = LineCollection( @@ -416,11 +396,9 @@ def plot_hull_section_contour( @required("trimesh") @override_style() def plot_visible_spectrum_section( - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", illuminant: SpectralDistribution | str = "D65", model: LiteralColourspaceModel | str = "CIE xyY", axis: Literal["+z", "+x", "+y"] | str = "+z", @@ -431,7 +409,7 @@ def plot_visible_spectrum_section( **kwargs: Any, ) -> Tuple[Figure, Axes]: """ - Plot the visible spectrum volume, i.e. *Rösch-MacAdam* colour solid, + Plot the visible spectrum volume, i.e., *Rösch-MacAdam* colour solid, section colours along given axis and origin. Parameters @@ -477,11 +455,8 @@ def plot_visible_spectrum_section( -------- >>> from colour.utilities import is_trimesh_installed >>> if is_trimesh_installed: - ... plot_visible_spectrum_section( - ... section_colours="RGB", section_opacity=0.15 - ... ) + ... plot_visible_spectrum_section(section_colours="RGB", section_opacity=0.15) ... # doctest: +ELLIPSIS - ... (
, <...Axes...>) .. image:: ../_static/Plotting_Plot_Visible_Spectrum_Section.png @@ -524,18 +499,14 @@ def plot_visible_spectrum_section( settings.update(kwargs) settings["show"] = False - plot_hull_section_colours( - hull, model, axis, origin, normalise, **settings - ) + plot_hull_section_colours(hull, model, axis, origin, normalise, **settings) if show_section_contour: settings = {"axes": axes} settings.update(kwargs) settings["show"] = False - plot_hull_section_contour( - hull, model, axis, origin, normalise, **settings - ) + plot_hull_section_contour(hull, model, axis, origin, normalise, **settings) title = ( f"Visible Spectrum Section - " @@ -568,16 +539,20 @@ def plot_visible_spectrum_section( @required("trimesh") @override_style() def plot_RGB_colourspace_section( - colourspace: RGB_Colourspace - | LiteralRGBColourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str], + colourspace: ( + RGB_Colourspace + | LiteralRGBColourspace + | str + | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + ), model: LiteralColourspaceModel | str = "CIE xyY", axis: Literal["+z", "+x", "+y"] | str = "+z", origin: float = 0.5, normalise: bool = True, + size: float = 1.0, show_section_colours: bool = True, show_section_contour: bool = True, + segments: int = 64, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ @@ -598,10 +573,15 @@ def plot_RGB_colourspace_section( Coordinate along ``axis`` at which to plot the hull section. normalise Whether to normalise ``axis`` to the extent of the hull along it. + size: + Size of the underlying *RGB* colourspace cube; used for plotting HDR + related sections. show_section_colours Whether to show the hull section colours. show_section_contour Whether to show the hull section contour. + segments + Edge segments count for the *RGB* colourspace cube. Other Parameters ---------------- @@ -625,7 +605,6 @@ def plot_RGB_colourspace_section( ... "sRGB", section_colours="RGB", section_opacity=0.15 ... ) ... # doctest: +ELLIPSIS - ... (
, <...Axes...>) .. image:: ../_static/Plotting_Plot_RGB_Colourspace_Section.png @@ -645,8 +624,8 @@ def plot_RGB_colourspace_section( first_item(filter_RGB_colourspaces(colourspace).values()), ) - vertices, faces, _outline = primitive_cube(1, 1, 1, 64, 64, 64) - XYZ_vertices = RGB_to_XYZ(vertices["position"] + 0.5, colourspace) + vertices, faces, _outline = primitive_cube(1, 1, 1, segments, segments, segments) + XYZ_vertices = RGB_to_XYZ((vertices["position"] + 0.5) * size, colourspace) hull = Trimesh(XYZ_vertices, faces, process=False) if show_section_colours: @@ -654,18 +633,14 @@ def plot_RGB_colourspace_section( settings.update(kwargs) settings["show"] = False - plot_hull_section_colours( - hull, model, axis, origin, normalise, **settings - ) + plot_hull_section_colours(hull, model, axis, origin, normalise, **settings) if show_section_contour: settings = {"axes": axes} settings.update(kwargs) settings["show"] = False - plot_hull_section_contour( - hull, model, axis, origin, normalise, **settings - ) + plot_hull_section_contour(hull, model, axis, origin, normalise, **settings) title = ( f"{colourspace.name} Section - " diff --git a/colour/plotting/temperature.py b/colour/plotting/temperature.py index f44fb15073..aa5361f1d6 100644 --- a/colour/plotting/temperature.py +++ b/colour/plotting/temperature.py @@ -2,7 +2,7 @@ Colour Temperature & Correlated Colour Temperature Plotting =========================================================== -Defines the colour temperature and correlated colour temperature plotting +Define the colour temperature and correlated colour temperature plotting objects: - :func:`colour.plotting.lines_daylight_locus` @@ -91,11 +91,10 @@ def lines_daylight_locus( mireds: bool = False, - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931", + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", ) -> Tuple[NDArray]: """ - Return the *Daylight Locus* line vertices, i.e. positions, normals and + Return the *Daylight Locus* line vertices, i.e., positions, normals and colours, according to given method. Parameters @@ -120,9 +119,7 @@ def lines_daylight_locus( ('colour', ' Tuple[Figure, Axes]: """ @@ -207,13 +203,9 @@ def plot_daylight_locus( :alt: plot_daylight_locus """ - method = validate_method( - method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS") - ) + method = validate_method(method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS")) - use_RGB_daylight_locus_colours = ( - str(daylight_locus_colours).upper() == "RGB" - ) + use_RGB_daylight_locus_colours = str(daylight_locus_colours).upper() == "RGB" daylight_locus_colours = optional( daylight_locus_colours, CONSTANTS_COLOUR_STYLE.colour.dark @@ -227,14 +219,17 @@ def plot_daylight_locus( lines_sl, *_ = lines_daylight_locus(daylight_locus_mireds, method) line_collection = LineCollection( - np.concatenate( - [lines_sl["position"][:-1], lines_sl["position"][1:]], axis=1 - ).reshape( - [-1, 2, 2] + np.reshape( + np.concatenate( + [lines_sl["position"][:-1], lines_sl["position"][1:]], axis=1 + ), + (-1, 2, 2), ), # pyright: ignore - colors=lines_sl["colour"] - if use_RGB_daylight_locus_colours - else daylight_locus_colours, + colors=( + lines_sl["colour"] + if use_RGB_daylight_locus_colours + else daylight_locus_colours + ), alpha=daylight_locus_opacity, zorder=CONSTANTS_COLOUR_STYLE.zorder.foreground_line, ) @@ -259,11 +254,10 @@ def lines_planckian_locus( labels: Sequence | None = None, mireds: bool = False, iso_temperature_lines_D_uv: float = 0.05, - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931", + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", ) -> Tuple[NDArray, NDArray]: """ - Return the *Planckian Locus* line vertices, i.e. positions, normals and + Return the *Planckian Locus* line vertices, i.e., positions, normals and colours, according to given method. Parameters @@ -298,9 +292,7 @@ def lines_planckian_locus( ('colour', ' Tuple[Figure, Axes]: """ @@ -448,9 +437,7 @@ def plot_planckian_locus( planckian_locus_colours, CONSTANTS_COLOUR_STYLE.colour.dark ) - use_RGB_planckian_locus_colours = ( - str(planckian_locus_colours).upper() == "RGB" - ) + use_RGB_planckian_locus_colours = str(planckian_locus_colours).upper() == "RGB" labels = cast( tuple, @@ -476,31 +463,39 @@ def plot_planckian_locus( axes.add_collection( LineCollection( - np.concatenate( - [lines_pl["position"][:-1], lines_pl["position"][1:]], axis=1 - ).reshape( - [-1, 2, 2] + np.reshape( + np.concatenate( + [lines_pl["position"][:-1], lines_pl["position"][1:]], axis=1 + ), + (-1, 2, 2), ), # pyright: ignore - colors=lines_pl["colour"] - if use_RGB_planckian_locus_colours - else planckian_locus_colours, + colors=( + lines_pl["colour"] + if use_RGB_planckian_locus_colours + else planckian_locus_colours + ), alpha=planckian_locus_opacity, zorder=CONSTANTS_COLOUR_STYLE.zorder.foreground_line, ) ) - lines_itl = lines_l["position"].reshape([len(labels), 20, 2]) - colours_itl = lines_l["colour"].reshape([len(labels), 20, 3]) + lines_itl = np.reshape(lines_l["position"], (len(labels), 20, 2)) + colours_itl = np.reshape(lines_l["colour"], (len(labels), 20, 3)) for i, label in enumerate(labels): axes.add_collection( LineCollection( - np.concatenate( - [lines_itl[i][:-1], lines_itl[i][1:]], # pyright: ignore - axis=1, - ).reshape([-1, 2, 2]), - colors=colours_itl[i] - if use_RGB_planckian_locus_colours - else planckian_locus_colours, + np.reshape( + np.concatenate( + [lines_itl[i][:-1], lines_itl[i][1:]], # pyright: ignore + axis=1, + ), + (-1, 2, 2), + ), + colors=( + colours_itl[i] + if use_RGB_planckian_locus_colours + else planckian_locus_colours + ), alpha=planckian_locus_opacity, zorder=CONSTANTS_COLOUR_STYLE.zorder.foreground_line, ) @@ -525,10 +520,9 @@ def plot_planckian_locus( @override_style() def plot_planckian_locus_in_chromaticity_diagram( - illuminants: str | Sequence[str], + illuminants: str | Sequence[str] | None = None, chromaticity_diagram_callable: Callable = plot_chromaticity_diagram, - method: Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] - | str = "CIE 1931", + method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", annotate_kwargs: dict | List[dict] | None = None, plot_kwargs: dict | List[dict] | None = None, **kwargs: Any, @@ -605,15 +599,13 @@ def plot_planckian_locus_in_chromaticity_diagram( :alt: plot_planckian_locus_in_chromaticity_diagram """ - method = validate_method( - method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS") - ) + illuminants = optional(illuminants, []) + + method = validate_method(method, ("CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS")) cmfs = MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] - illuminants_filtered = filter_passthrough( - CCS_ILLUMINANTS[cmfs.name], illuminants - ) + illuminants_filtered = filter_passthrough(CCS_ILLUMINANTS[cmfs.name], illuminants) settings: Dict[str, Any] = {"uniform": True} settings.update(kwargs) @@ -721,7 +713,7 @@ def plot_planckian_locus_in_chromaticity_diagram( @override_style() def plot_planckian_locus_in_chromaticity_diagram_CIE1931( - illuminants: str | Sequence[str], + illuminants: str | Sequence[str] | None = None, chromaticity_diagram_callable_CIE1931: Callable = ( plot_chromaticity_diagram_CIE1931 ), @@ -800,7 +792,7 @@ def plot_planckian_locus_in_chromaticity_diagram_CIE1931( @override_style() def plot_planckian_locus_in_chromaticity_diagram_CIE1960UCS( - illuminants: str | Sequence[str], + illuminants: str | Sequence[str] | None = None, chromaticity_diagram_callable_CIE1960UCS: Callable = ( plot_chromaticity_diagram_CIE1960UCS ), @@ -881,7 +873,7 @@ def plot_planckian_locus_in_chromaticity_diagram_CIE1960UCS( @override_style() def plot_planckian_locus_in_chromaticity_diagram_CIE1976UCS( - illuminants: str | Sequence[str], + illuminants: str | Sequence[str] | None = None, chromaticity_diagram_callable_CIE1976UCS: Callable = ( plot_chromaticity_diagram_CIE1976UCS ), diff --git a/colour/plotting/tests/test_blindness.py b/colour/plotting/tests/test_blindness.py index 31d591c4e2..164dc0d49f 100644 --- a/colour/plotting/tests/test_blindness.py +++ b/colour/plotting/tests/test_blindness.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.blindness` module.""" -import unittest import numpy as np from matplotlib.axes import Axes @@ -21,7 +19,7 @@ ] -class TestPlotCvdSimulationMachado2009(unittest.TestCase): +class TestPlotCvdSimulationMachado2009: """ Define :func:`colour.plotting.blindness.plot_cvd_simulation_Machado2009` definition unit tests methods. @@ -33,13 +31,7 @@ def test_plot_cvd_simulation_Machado2009(self): definition. """ - figure, axes = plot_cvd_simulation_Machado2009( - np.random.rand(32, 32, 3) - ) + figure, axes = plot_cvd_simulation_Machado2009(np.random.rand(32, 32, 3)) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - - -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tests/test_characterisation.py b/colour/plotting/tests/test_characterisation.py index 87d606449b..342d6d30f4 100644 --- a/colour/plotting/tests/test_characterisation.py +++ b/colour/plotting/tests/test_characterisation.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.characterisation` module.""" -import unittest from matplotlib.axes import Axes from matplotlib.figure import Figure @@ -24,7 +22,7 @@ ] -class TestPlotSingleColourChecker(unittest.TestCase): +class TestPlotSingleColourChecker: """ Define :func:`colour.plotting.characterisation.plot_single_colour_checker` definition unit tests methods. @@ -38,11 +36,11 @@ def test_plot_single_colour_checker(self): figure, axes = plot_single_colour_checker() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotMultiColourCheckers(unittest.TestCase): +class TestPlotMultiColourCheckers: """ Define :func:`colour.plotting.characterisation.plot_multi_colour_checkers` definition unit tests methods. @@ -58,9 +56,5 @@ def test_plot_multi_colour_checkers(self): ["ColorChecker 1976", "ColorChecker 2005"] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - - -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tests/test_colorimetry.py b/colour/plotting/tests/test_colorimetry.py index e8eeefbbdc..990e70a0c5 100644 --- a/colour/plotting/tests/test_colorimetry.py +++ b/colour/plotting/tests/test_colorimetry.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.colorimetry` module.""" -import unittest from matplotlib.axes import Axes from matplotlib.figure import Figure @@ -47,7 +45,7 @@ ] -class TestPlotSingleSd(unittest.TestCase): +class TestPlotSingleSd: """ Define :func:`colour.plotting.colorimetry.plot_single_sd` definition unit tests methods. @@ -76,11 +74,11 @@ def test_plot_single_sd(self): equalize_sd_amplitude=True, ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotMultiSds(unittest.TestCase): +class TestPlotMultiSds: """ Define :func:`colour.plotting.colorimetry.plot_multi_sds` definition unit tests methods. @@ -119,22 +117,19 @@ def test_plot_multi_sds(self): plot_kwargs={"use_sd_colours": True, "normalise_sd_colours": True}, ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_multi_sds( [sd_1, sd_2], - plot_kwargs=[ - {"use_sd_colours": True, "normalise_sd_colours": True} - ] - * 2, + plot_kwargs=[{"use_sd_colours": True, "normalise_sd_colours": True}] * 2, ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSingleCmfs(unittest.TestCase): +class TestPlotSingleCmfs: """ Define :func:`colour.plotting.colorimetry.plot_single_cmfs` definition unit tests methods. @@ -145,11 +140,11 @@ def test_plot_single_cmfs(self): figure, axes = plot_single_cmfs() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotMultiCmfs(unittest.TestCase): +class TestPlotMultiCmfs: """ Define :func:`colour.plotting.colorimetry.plot_multi_cmfs` definition unit tests methods. @@ -165,11 +160,11 @@ def test_plot_multi_cmfs(self): ] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSingleIlluminantSd(unittest.TestCase): +class TestPlotSingleIlluminantSd: """ Define :func:`colour.plotting.colorimetry.plot_single_illuminant_sd` definition unit tests methods. @@ -183,11 +178,11 @@ def test_plot_single_illuminant_sd(self): figure, axes = plot_single_illuminant_sd("A") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotMultiIlluminantSds(unittest.TestCase): +class TestPlotMultiIlluminantSds: """ Define :func:`colour.plotting.colorimetry.plot_multi_illuminant_sds` definition unit tests methods. @@ -201,22 +196,19 @@ def test_plot_multi_illuminant_sds(self): figure, axes = plot_multi_illuminant_sds(["A", "B", "C"]) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_multi_illuminant_sds( ["A", "B", "C"], - plot_kwargs=[ - {"use_sd_colours": True, "normalise_sd_colours": True} - ] - * 3, + plot_kwargs=[{"use_sd_colours": True, "normalise_sd_colours": True}] * 3, ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotVisibleSpectrum(unittest.TestCase): +class TestPlotVisibleSpectrum: """ Define :func:`colour.plotting.colorimetry.plot_visible_spectrum` definition unit tests methods. @@ -230,11 +222,11 @@ def test_plot_visible_spectrum(self): figure, axes = plot_visible_spectrum() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSingleLightnessFunction(unittest.TestCase): +class TestPlotSingleLightnessFunction: """ Define :func:`colour.plotting.colorimetry.plot_single_lightness_function` definition unit tests methods. @@ -248,11 +240,11 @@ def test_plot_single_lightness_function(self): figure, axes = plot_single_lightness_function("CIE 1976") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotMultiLightnessFunctions(unittest.TestCase): +class TestPlotMultiLightnessFunctions: """ Define :func:`colour.plotting.colorimetry.plot_multi_lightness_functions` definition unit tests methods. @@ -264,15 +256,13 @@ def test_plot_multi_lightness_functions(self): plot_multi_lightness_functions` definition. """ - figure, axes = plot_multi_lightness_functions( - ["CIE 1976", "Wyszecki 1963"] - ) + figure, axes = plot_multi_lightness_functions(["CIE 1976", "Wyszecki 1963"]) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSingleLuminanceFunction(unittest.TestCase): +class TestPlotSingleLuminanceFunction: """ Define :func:`colour.plotting.colorimetry.plot_single_luminance_function` definition unit tests methods. @@ -286,11 +276,11 @@ def test_plot_single_luminance_function(self): figure, axes = plot_single_luminance_function("CIE 1976") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotMultiLuminanceFunctions(unittest.TestCase): +class TestPlotMultiLuminanceFunctions: """ Define :func:`colour.plotting.colorimetry.plot_multi_luminance_functions` definition unit tests methods. @@ -302,15 +292,13 @@ def test_plot_multi_luminance_functions(self): plot_multi_luminance_functions` definition. """ - figure, axes = plot_multi_luminance_functions( - ["CIE 1976", "Newhall 1943"] - ) + figure, axes = plot_multi_luminance_functions(["CIE 1976", "Newhall 1943"]) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotBlackbodySpectralRadiance(unittest.TestCase): +class TestPlotBlackbodySpectralRadiance: """ Define :func:`colour.plotting.colorimetry.\ plot_blackbody_spectral_radiance` definition unit tests methods. @@ -324,11 +312,11 @@ def test_plot_blackbody_spectral_radiance(self): figure, axes = plot_blackbody_spectral_radiance() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotBlackbodyColours(unittest.TestCase): +class TestPlotBlackbodyColours: """ Define :func:`colour.plotting.colorimetry.plot_blackbody_colours` definition unit tests methods. @@ -342,9 +330,5 @@ def test_plot_blackbody_colours(self): figure, axes = plot_blackbody_colours() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - - -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tests/test_common.py b/colour/plotting/tests/test_common.py index dc1b3ab0ef..350f3b54a7 100644 --- a/colour/plotting/tests/test_common.py +++ b/colour/plotting/tests/test_common.py @@ -1,10 +1,8 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.common` module.""" import os import shutil import tempfile -import unittest from functools import partial import matplotlib.font_manager @@ -76,7 +74,7 @@ ] -class TestColourStyle(unittest.TestCase): +class TestColourStyle: """ Define :func:`colour.plotting.common.colour_style` definition unit tests methods. @@ -85,10 +83,10 @@ class TestColourStyle(unittest.TestCase): def test_colour_style(self): """Test :func:`colour.plotting.common.colour_style` definition.""" - self.assertIsInstance(colour_style(use_style=False), dict) + assert isinstance(colour_style(use_style=False), dict) -class TestOverrideStyle(unittest.TestCase): +class TestOverrideStyle: """ Define :func:`colour.plotting.common.override_style` definition unit tests methods. @@ -111,7 +109,7 @@ def test_text_color_override(): plt.rcParams["text.color"] = text_color -class TestFontScaling(unittest.TestCase): +class TestFontScaling: """ Define :func:`colour.plotting.common.font_scaling` definition unit tests methods. @@ -121,17 +119,12 @@ def test_font_scaling(self): """Test :func:`colour.plotting.common.font_scaling` definition.""" with font_scaling("medium-colour-science", 2): - self.assertEqual( - matplotlib.font_manager.font_scalings["medium-colour-science"], - 2, - ) + assert matplotlib.font_manager.font_scalings["medium-colour-science"] == 2 - self.assertEqual( - matplotlib.font_manager.font_scalings["medium-colour-science"], 1 - ) + assert matplotlib.font_manager.font_scalings["medium-colour-science"] == 1 -class TestXYZToPlottingColourspace(unittest.TestCase): +class TestXYZToPlottingColourspace: """ Define :func:`colour.plotting.common.XYZ_to_plotting_colourspace` definition unit tests methods. @@ -151,7 +144,7 @@ def test_XYZ_to_plotting_colourspace(self): ) -class TestColourCycle(unittest.TestCase): +class TestColourCycle: """ Define :func:`colour.plotting.common.colour_cycle` definition unit tests methods. @@ -189,7 +182,7 @@ def test_colour_cycle(self): ) -class TestArtist(unittest.TestCase): +class TestArtist: """ Define :func:`colour.plotting.common.artist` definition unit tests methods. @@ -206,29 +199,29 @@ def test_axes_args(self): fig_result1, _ = artist(axes=ax1) - self.assertIs(fig1, fig_result1) + assert fig1 is fig_result1 _ = plt.figure() fig_result2, _ = artist(axes=ax1) - self.assertIs(fig1, fig_result2) + assert fig1 is fig_result2 def test_artist(self): """Test :func:`colour.plotting.common.artist` definition.""" figure_1, axes_1 = artist() - self.assertIsInstance(figure_1, Figure) - self.assertIsInstance(axes_1, Axes) + assert isinstance(figure_1, Figure) + assert isinstance(axes_1, Axes) _figure_2, axes_2 = artist(axes=axes_1, uniform=True) - self.assertIs(axes_1, axes_2) + assert axes_1 is axes_2 figure_3, _axes_3 = artist(uniform=True) - self.assertEqual(figure_3.get_figwidth(), figure_3.get_figheight()) + assert figure_3.get_figwidth() == figure_3.get_figheight() -class TestCamera(unittest.TestCase): +class TestCamera: """ Define :func:`colour.plotting.common.camera` definition unit tests methods. @@ -242,22 +235,22 @@ def test_camera(self): _figure, axes = camera(axes=axes, elevation=45, azimuth=90) - self.assertEqual(axes.elev, 45) - self.assertEqual(axes.azim, 90) + assert axes.elev == 45 + assert axes.azim == 90 -class TestRender(unittest.TestCase): +class TestRender: """ Define :func:`colour.plotting.common.render` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._temporary_directory = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -294,7 +287,7 @@ def test_render(self): ) -class TestLabelRectangles(unittest.TestCase): +class TestLabelRectangles: """ Define :func:`colour.plotting.common.label_rectangles` definition unit tests methods. @@ -311,10 +304,10 @@ def test_label_rectangles(self): samples, axes.bar(samples, 1), figure=figure, axes=axes ) - self.assertEqual(len(axes.texts), len(samples)) + assert len(axes.texts) == len(samples) -class TestUniformAxes3d(unittest.TestCase): +class TestUniformAxes3d: """ Define :func:`colour.plotting.common.uniform_axes3d` definition unit tests methods. @@ -328,11 +321,11 @@ def test_uniform_axes3d(self): uniform_axes3d(axes=axes) - self.assertEqual(axes.get_xlim(), axes.get_ylim()) - self.assertEqual(axes.get_xlim(), axes.get_zlim()) + assert axes.get_xlim() == axes.get_ylim() + assert axes.get_xlim() == axes.get_zlim() -class TestFilterPassthrough(unittest.TestCase): +class TestFilterPassthrough: """ Define :func:`colour.plotting.common.filter_passthrough` definition unit tests methods. @@ -341,58 +334,42 @@ class TestFilterPassthrough(unittest.TestCase): def test_filter_passthrough(self): """Test :func:`colour.plotting.common.filter_passthrough` definition.""" - self.assertListEqual( - sorted( - colourspace.name - for colourspace in filter_passthrough( - RGB_COLOURSPACES, ["ACES2065-1"] - ).values() - ), - ["ACES2065-1"], - ) + assert sorted( + colourspace.name + for colourspace in filter_passthrough( + RGB_COLOURSPACES, ["ACES2065-1"] + ).values() + ) == ["ACES2065-1"] - self.assertListEqual( - sorted( - filter_passthrough(RGB_COLOURSPACES, ["aces2065-1"]).keys() - ), - ["ACES2065-1"], - ) + assert sorted(filter_passthrough(RGB_COLOURSPACES, ["aces2065-1"]).keys()) == [ + "ACES2065-1" + ] - self.assertListEqual( - sorted(filter_passthrough(RGB_COLOURSPACES, ["aces20651"]).keys()), - ["ACES2065-1"], - ) + assert sorted(filter_passthrough(RGB_COLOURSPACES, ["aces20651"]).keys()) == [ + "ACES2065-1" + ] - self.assertDictEqual( - filter_passthrough( - SDS_ILLUMINANTS, - [SDS_ILLUMINANTS["D65"], {"Is": "Excluded"}], - allow_non_siblings=False, - ), - {"D65": SDS_ILLUMINANTS["D65"]}, - ) + assert filter_passthrough( + SDS_ILLUMINANTS, + [SDS_ILLUMINANTS["D65"], {"Is": "Excluded"}], + allow_non_siblings=False, + ) == {"D65": SDS_ILLUMINANTS["D65"]} - self.assertDictEqual( - filter_passthrough( - SDS_ILLUMINANTS, - [SDS_ILLUMINANTS["D65"], {"Is": "Included"}], - allow_non_siblings=True, - ), - {"D65": SDS_ILLUMINANTS["D65"], "Is": "Included"}, - ) + assert filter_passthrough( + SDS_ILLUMINANTS, + [SDS_ILLUMINANTS["D65"], {"Is": "Included"}], + allow_non_siblings=True, + ) == {"D65": SDS_ILLUMINANTS["D65"], "Is": "Included"} - self.assertListEqual( - sorted( - element - for element in filter_passthrough( - {"John": "Doe", "Luke": "Skywalker"}, ["John"] - ).values() - ), - ["Doe", "John"], - ) + assert sorted( + element + for element in filter_passthrough( + {"John": "Doe", "Luke": "Skywalker"}, ["John"] + ).values() + ) == ["Doe", "John"] -class TestFilterRgbColourspaces(unittest.TestCase): +class TestFilterRgbColourspaces: """ Define :func:`colour.plotting.common.filter_RGB_colourspaces` definition unit tests methods. @@ -404,18 +381,13 @@ def test_filter_RGB_colourspaces(self): definition. """ - self.assertListEqual( - sorted( - colourspace.name - for colourspace in filter_RGB_colourspaces( - ["ACES2065-1"] - ).values() - ), - ["ACES2065-1"], - ) + assert sorted( + colourspace.name + for colourspace in filter_RGB_colourspaces(["ACES2065-1"]).values() + ) == ["ACES2065-1"] -class TestFilterCmfs(unittest.TestCase): +class TestFilterCmfs: """ Define :func:`colour.plotting.common.filter_cmfs` definition unit tests methods. @@ -424,20 +396,15 @@ class TestFilterCmfs(unittest.TestCase): def test_filter_cmfs(self): """Test :func:`colour.plotting.common.filter_cmfs` definition.""" - self.assertListEqual( - sorted( - cmfs.name - for cmfs in filter_cmfs( - ["CIE 1931 2 Degree Standard Observer"] - ).values() - ), - [ - "CIE 1931 2 Degree Standard Observer", - ], - ) + assert sorted( + cmfs.name + for cmfs in filter_cmfs(["CIE 1931 2 Degree Standard Observer"]).values() + ) == [ + "CIE 1931 2 Degree Standard Observer", + ] -class TestFilterIlluminants(unittest.TestCase): +class TestFilterIlluminants: """ Define :func:`colour.plotting.common.filter_illuminants` definition unit tests methods. @@ -446,13 +413,10 @@ class TestFilterIlluminants(unittest.TestCase): def test_filter_illuminants(self): """Test :func:`colour.plotting.common.filter_illuminants` definition.""" - self.assertListEqual( - sorted(filter_illuminants(["D50"]).keys()), - ["D50"], - ) + assert sorted(filter_illuminants(["D50"]).keys()) == ["D50"] -class TestFilterColourCheckers(unittest.TestCase): +class TestFilterColourCheckers: """ Define :func:`colour.plotting.common.filter_colour_checkers` definition unit tests methods. @@ -461,20 +425,17 @@ class TestFilterColourCheckers(unittest.TestCase): def test_filter_colour_checkers(self): """Test :func:`colour.plotting.common.filter_colour_checkers` definition.""" - self.assertListEqual( - sorted( - colour_checker.name - for colour_checker in filter_colour_checkers( - ["ColorChecker24 - After November 2014"] - ).values() - ), - [ - "ColorChecker24 - After November 2014", - ], - ) + assert sorted( + colour_checker.name + for colour_checker in filter_colour_checkers( + ["ColorChecker24 - After November 2014"] + ).values() + ) == [ + "ColorChecker24 - After November 2014", + ] -class TestUpdateSettingsCollection(unittest.TestCase): +class TestUpdateSettingsCollection: """ Define :func:`colour.plotting.common.update_settings_collection` definition unit tests methods. @@ -489,15 +450,15 @@ def test_update_settings_collection(self): settings_collection = [{1: 2}, {3: 4}] keyword_arguments = {5: 6} update_settings_collection(settings_collection, keyword_arguments, 2) - self.assertListEqual(settings_collection, [{1: 2, 5: 6}, {3: 4, 5: 6}]) + assert settings_collection == [{1: 2, 5: 6}, {3: 4, 5: 6}] settings_collection = [{1: 2}, {3: 4}] keyword_arguments = [{5: 6}, {7: 8}] update_settings_collection(settings_collection, keyword_arguments, 2) - self.assertListEqual(settings_collection, [{1: 2, 5: 6}, {3: 4, 7: 8}]) + assert settings_collection == [{1: 2, 5: 6}, {3: 4, 7: 8}] -class TestPlotSingleColourSwatch(unittest.TestCase): +class TestPlotSingleColourSwatch: """ Define :func:`colour.plotting.common.plot_single_colour_swatch` definition unit tests methods. @@ -513,18 +474,18 @@ def test_plot_single_colour_swatch(self): ColourSwatch((0.45620519, 0.03081071, 0.04091952)) ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_single_colour_swatch( np.array([0.45620519, 0.03081071, 0.04091952]) ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotMultiColourSwatches(unittest.TestCase): +class TestPlotMultiColourSwatches: """ Define :func:`colour.plotting.common.plot_multi_colour_swatches` definition unit tests methods. @@ -543,8 +504,8 @@ def test_plot_multi_colour_swatches(self): ] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_multi_colour_swatches( np.array( @@ -556,11 +517,11 @@ def test_plot_multi_colour_swatches(self): direction="-y", ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSingleFunction(unittest.TestCase): +class TestPlotSingleFunction: """ Define :func:`colour.plotting.common.plot_single_function` definition unit tests methods. @@ -569,15 +530,13 @@ class TestPlotSingleFunction(unittest.TestCase): def test_plot_single_function(self): """Test :func:`colour.plotting.common.plot_single_function` definition.""" - figure, axes = plot_single_function( - partial(gamma_function, exponent=1 / 2.2) - ) + figure, axes = plot_single_function(partial(gamma_function, exponent=1 / 2.2)) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotMultiFunctions(unittest.TestCase): +class TestPlotMultiFunctions: """ Define :func:`colour.plotting.common.plot_multi_functions` definition unit tests methods. @@ -594,29 +553,29 @@ def test_plot_multi_functions(self): plot_kwargs = {"c": "r"} figure, axes = plot_multi_functions(functions, plot_kwargs=plot_kwargs) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) plot_kwargs = [{"c": "r"}, {"c": "g"}, {"c": "b"}] figure, axes = plot_multi_functions( functions, log_x=10, log_y=10, plot_kwargs=plot_kwargs ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_multi_functions(functions, log_x=10) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_multi_functions(functions, log_y=10) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotImage(unittest.TestCase): +class TestPlotImage: """ Define :func:`colour.plotting.common.plot_image` definition unit tests methods. @@ -636,9 +595,5 @@ def test_plot_image(self): figure, axes = plot_image(read_image(path)) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - - -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tests/test_corresponding.py b/colour/plotting/tests/test_corresponding.py index 5e44b0249c..402a579cd5 100644 --- a/colour/plotting/tests/test_corresponding.py +++ b/colour/plotting/tests/test_corresponding.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.corresponding` module.""" -import unittest from matplotlib.axes import Axes from matplotlib.figure import Figure @@ -20,7 +18,7 @@ ] -class TestPlotCorrespondingChromaticitiesPrediction(unittest.TestCase): +class TestPlotCorrespondingChromaticitiesPrediction: """ Define :func:`colour.plotting.corresponding.\ plot_corresponding_chromaticities_prediction` definition unit tests methods. @@ -34,9 +32,5 @@ def test_plot_corresponding_chromaticities_prediction(self): figure, axes = plot_corresponding_chromaticities_prediction() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - - -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tests/test_diagrams.py b/colour/plotting/tests/test_diagrams.py index ed98597000..fb81b6db00 100644 --- a/colour/plotting/tests/test_diagrams.py +++ b/colour/plotting/tests/test_diagrams.py @@ -1,8 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.diagrams` module.""" -import unittest +import pytest from matplotlib.axes import Axes from matplotlib.figure import Figure @@ -50,7 +49,7 @@ ] -class TestLinesSpectralLocus(unittest.TestCase): +class TestLinesSpectralLocus: """ Define :func:`colour.plotting.diagrams.lines_spectral_locus` definition unit tests methods. @@ -62,10 +61,10 @@ def test_lines_spectral_locus(self): definition. """ - self.assertEqual(len(lines_spectral_locus()), 2) + assert len(lines_spectral_locus()) == 2 -class TestPlotSpectralLocus(unittest.TestCase): +class TestPlotSpectralLocus: """ Define :func:`colour.plotting.diagrams.plot_spectral_locus` definition unit tests methods. @@ -78,27 +77,27 @@ def test_plot_spectral_locus(self): figure, axes = plot_spectral_locus() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_spectral_locus(spectral_locus_colours="RGB") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_spectral_locus( method="CIE 1960 UCS", spectral_locus_colours="RGB" ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_spectral_locus( method="CIE 1976 UCS", spectral_locus_colours="RGB" ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_spectral_locus( reshape_msds( @@ -107,15 +106,13 @@ def test_plot_spectral_locus(self): ) ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) - self.assertRaises( - ValueError, lambda: plot_spectral_locus(method="Undefined") - ) + pytest.raises(ValueError, lambda: plot_spectral_locus(method="Undefined")) -class TestPlotChromaticityDiagramColours(unittest.TestCase): +class TestPlotChromaticityDiagramColours: """ Define :func:`colour.plotting.diagrams.plot_chromaticity_diagram_colours` definition unit tests methods. @@ -129,21 +126,21 @@ def test_plot_chromaticity_diagram_colours(self): figure, axes = plot_chromaticity_diagram_colours() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) - self.assertRaises( + pytest.raises( ValueError, lambda: plot_chromaticity_diagram_colours(method="Undefined"), ) figure, axes = plot_chromaticity_diagram_colours(diagram_colours="RGB") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotChromaticityDiagram(unittest.TestCase): +class TestPlotChromaticityDiagram: """ Define :func:`colour.plotting.diagrams.plot_chromaticity_diagram` definition unit tests methods. @@ -157,20 +154,20 @@ def test_plot_chromaticity_diagram(self): figure, axes = plot_chromaticity_diagram() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_chromaticity_diagram(method="CIE 1960 UCS") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_chromaticity_diagram(method="CIE 1976 UCS") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) - self.assertRaises( + pytest.raises( ValueError, lambda: plot_chromaticity_diagram( method="Undefined", @@ -180,7 +177,7 @@ def test_plot_chromaticity_diagram(self): ) -class TestPlotChromaticityDiagramCIE1931(unittest.TestCase): +class TestPlotChromaticityDiagramCIE1931: """ Define :func:`colour.plotting.diagrams.plot_chromaticity_diagram_CIE1931` definition unit tests methods. @@ -194,11 +191,11 @@ def test_plot_chromaticity_diagram_CIE1931(self): figure, axes = plot_chromaticity_diagram_CIE1931() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotChromaticityDiagramCIE1960UCS(unittest.TestCase): +class TestPlotChromaticityDiagramCIE1960UCS: """ Define :func:`colour.plotting.diagrams.\ plot_chromaticity_diagram_CIE1960UCS` definition unit tests methods. @@ -212,11 +209,11 @@ def test_plot_chromaticity_diagram_CIE1960UCS(self): figure, axes = plot_chromaticity_diagram_CIE1960UCS() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotChromaticityDiagramCIE1976UCS(unittest.TestCase): +class TestPlotChromaticityDiagramCIE1976UCS: """ Define :func:`colour.plotting.diagrams.\ plot_chromaticity_diagram_CIE1976UCS` definition unit tests methods. @@ -230,11 +227,11 @@ def test_plot_chromaticity_diagram_CIE1976UCS(self): figure, axes = plot_chromaticity_diagram_CIE1976UCS() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSdsInChromaticityDiagram(unittest.TestCase): +class TestPlotSdsInChromaticityDiagram: """ Define :func:`colour.plotting.diagrams.\ plot_sds_in_chromaticity_diagram` definition unit tests methods. @@ -252,22 +249,19 @@ def test_plot_sds_in_chromaticity_diagram(self): plot_kwargs={"normalise_sd_colours": True, "use_sd_colours": True}, ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_sds_in_chromaticity_diagram( [SDS_ILLUMINANTS["A"], SDS_ILLUMINANTS["D65"]], annotate_kwargs=[{"arrowprops": {"width": 10}}] * 2, - plot_kwargs=[ - {"normalise_sd_colours": True, "use_sd_colours": True} - ] - * 2, + plot_kwargs=[{"normalise_sd_colours": True, "use_sd_colours": True}] * 2, ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) - self.assertRaises( + pytest.raises( ValueError, lambda: plot_sds_in_chromaticity_diagram( [SDS_ILLUMINANTS["A"], SDS_ILLUMINANTS["D65"]], @@ -277,7 +271,7 @@ def test_plot_sds_in_chromaticity_diagram(self): ) -class TestPlotSdsInChromaticityDiagramCIE1931(unittest.TestCase): +class TestPlotSdsInChromaticityDiagramCIE1931: """ Define :func:`colour.plotting.diagrams.\ plot_sds_in_chromaticity_diagram_CIE1931` definition unit tests methods. @@ -293,11 +287,11 @@ def test_plot_sds_in_chromaticity_diagram_CIE1931(self): [SDS_ILLUMINANTS["A"], SDS_ILLUMINANTS["D65"]] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSdsInChromaticityDiagramCIE1960UCS(unittest.TestCase): +class TestPlotSdsInChromaticityDiagramCIE1960UCS: """ Define :func:`colour.plotting.diagrams.\ plot_sds_in_chromaticity_diagram_CIE1960UCS` definition unit tests methods. @@ -313,11 +307,11 @@ def test_plot_sds_in_chromaticity_diagram_CIE1960UCS(self): [SDS_ILLUMINANTS["A"], SDS_ILLUMINANTS["D65"]] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSdsInChromaticityDiagramCIE1976UCS(unittest.TestCase): +class TestPlotSdsInChromaticityDiagramCIE1976UCS: """ Define :func:`colour.plotting.diagrams.\ plot_sds_in_chromaticity_diagram_CIE1976UCS` definition unit tests methods. @@ -333,9 +327,5 @@ def test_plot_sds_in_chromaticity_diagram_CIE1976UCS(self): [SDS_ILLUMINANTS["A"], SDS_ILLUMINANTS["D65"]] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - - -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tests/test_graph.py b/colour/plotting/tests/test_graph.py index 124bc6edf1..d1acfcad92 100644 --- a/colour/plotting/tests/test_graph.py +++ b/colour/plotting/tests/test_graph.py @@ -1,10 +1,8 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.graph` module.""" import tempfile -import unittest from colour.plotting import plot_automatic_colour_conversion_graph -from colour.utilities import is_graphviz_installed, is_networkx_installed +from colour.utilities import is_networkx_installed, is_pydot_installed __author__ = "Colour Developers" __copyright__ = "Copyright 2013 Colour Developers" @@ -18,7 +16,7 @@ ] -class TestPlotAutomaticColourConversionGraph(unittest.TestCase): +class TestPlotAutomaticColourConversionGraph: """ Define :func:`colour.plotting.graph.\ plot_automatic_colour_conversion_graph` definition unit tests methods. @@ -30,15 +28,9 @@ def test_plot_automatic_colour_conversion_graph(self): plot_automatic_colour_conversion_graph` definition. """ - if ( - not is_graphviz_installed() or not is_networkx_installed() - ): # pragma: no cover + if not is_pydot_installed() or not is_networkx_installed(): # pragma: no cover return plot_automatic_colour_conversion_graph( # pragma: no cover f"{tempfile.mkstemp()[-1]}.png" ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/plotting/tests/test_models.py b/colour/plotting/tests/test_models.py index fd6e6365df..15f2263115 100644 --- a/colour/plotting/tests/test_models.py +++ b/colour/plotting/tests/test_models.py @@ -1,9 +1,8 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.models` module.""" -import unittest import numpy as np +import pytest from matplotlib.axes import Axes from matplotlib.figure import Figure @@ -61,7 +60,7 @@ ] -class TestCommonColourspaceModelAxisReorder(unittest.TestCase): +class TestCommonColourspaceModelAxisReorder: """ Define :func:`colour.plotting.models.colourspace_model_axis_reorder` definition unit tests methods. @@ -104,7 +103,7 @@ def test_colourspace_model_axis_reorder(self): ) -class TestLinesPointerGamut(unittest.TestCase): +class TestLinesPointerGamut: """ Define :func:`colour.plotting.models.lines_pointer_gamut` definition unit tests methods. @@ -115,10 +114,10 @@ def test_lines_pointer_gamut(self): Test :func:`colour.plotting.models.lines_pointer_gamut` definition. """ - self.assertEqual(len(lines_pointer_gamut()), 2) + assert len(lines_pointer_gamut()) == 2 -class TestPlotPointerGamut(unittest.TestCase): +class TestPlotPointerGamut: """ Define :func:`colour.plotting.models.plot_pointer_gamut` definition unit tests methods. @@ -129,25 +128,23 @@ def test_plot_pointer_gamut(self): figure, axes = plot_pointer_gamut() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_pointer_gamut(method="CIE 1960 UCS") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_pointer_gamut(method="CIE 1976 UCS") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) - self.assertRaises( - ValueError, lambda: plot_pointer_gamut(method="Undefined") - ) + pytest.raises(ValueError, lambda: plot_pointer_gamut(method="Undefined")) -class TestPlotRGBColourspacesInChromaticityDiagram(unittest.TestCase): +class TestPlotRGBColourspacesInChromaticityDiagram: """ Define :func:`colour.plotting.models.\ plot_RGB_colourspaces_in_chromaticity_diagram` definition unit tests methods. @@ -166,18 +163,18 @@ def test_plot_RGB_colourspaces_in_chromaticity_diagram(self): plot_kwargs={"linestyle": "dashed"}, ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_RGB_colourspaces_in_chromaticity_diagram( ["ITU-R BT.709", "ACEScg", "S-Gamut"], plot_kwargs=[{"linestyle": "dashed"}] * 3, ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) - self.assertRaises( + pytest.raises( ValueError, lambda: plot_RGB_colourspaces_in_chromaticity_diagram( ["ITU-R BT.709", "ACEScg", "S-Gamut"], @@ -187,7 +184,7 @@ def test_plot_RGB_colourspaces_in_chromaticity_diagram(self): ) -class TestPlotRGBColourspacesInChromaticityDiagramCIE1931(unittest.TestCase): +class TestPlotRGBColourspacesInChromaticityDiagramCIE1931: """ Define :func:`colour.plotting.models.\ plot_RGB_colourspaces_in_chromaticity_diagram_CIE1931` definition unit tests @@ -204,13 +201,11 @@ def test_plot_RGB_colourspaces_in_chromaticity_diagram_CIE1931(self): ["ITU-R BT.709", "ACEScg", "S-Gamut"] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotRGBColourspacesInChromaticityDiagramCIE1960UCS( - unittest.TestCase -): +class TestPlotRGBColourspacesInChromaticityDiagramCIE1960UCS: """ Define :func:`colour.plotting.models.\ plot_RGB_colourspaces_in_chromaticity_diagram_CIE1960UCS` definition unit tests @@ -230,13 +225,11 @@ def test_plot_RGB_colourspaces_in_chromaticity_diagram_CIE1960UCS(self): ["ITU-R BT.709", "ACEScg", "S-Gamut"] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotRGBColourspacesInChromaticityDiagramCIE1976UCS( - unittest.TestCase -): +class TestPlotRGBColourspacesInChromaticityDiagramCIE1976UCS: """ Define :func:`colour.plotting.models.\ plot_RGB_colourspaces_in_chromaticity_diagram_CIE1976UCS` definition unit tests @@ -256,11 +249,11 @@ def test_plot_RGB_colourspaces_in_chromaticity_diagram_CIE1976UCS(self): ["ITU-R BT.709", "ACEScg", "S-Gamut"] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotRGBChromaticitiesInChromaticityDiagram(unittest.TestCase): +class TestPlotRGBChromaticitiesInChromaticityDiagram: """ Define :func:`colour.plotting.models.\ plot_RGB_chromaticities_in_chromaticity_diagram` definition unit tests methods. @@ -276,11 +269,11 @@ def test_plot_RGB_chromaticities_in_chromaticity_diagram(self): np.random.random((128, 128, 3)), scatter_kwargs={"marker": "v"} ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotRGBChromaticitiesInChromaticityDiagramCIE1931(unittest.TestCase): +class TestPlotRGBChromaticitiesInChromaticityDiagramCIE1931: """ Define :func:`colour.plotting.models.\ plot_RGB_chromaticities_in_chromaticity_diagram_CIE1931` definition unit tests @@ -297,13 +290,11 @@ def test_plot_RGB_chromaticities_in_chromaticity_diagram_CIE1931(self): np.random.random((128, 128, 3)) ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotRGBChromaticitiesInChromaticityDiagramCIE1960UCS( - unittest.TestCase -): +class TestPlotRGBChromaticitiesInChromaticityDiagramCIE1960UCS: """ Define :func:`colour.plotting.models.\ plot_RGB_chromaticities_in_chromaticity_diagram_CIE1960UCS` definition unit @@ -323,13 +314,11 @@ def test_plot_RGB_chromaticities_in_chromaticity_diagram_CIE1960UCS(self): np.random.random((128, 128, 3)) ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotRGBChromaticitiesInChromaticityDiagramCIE1976UCS( - unittest.TestCase -): +class TestPlotRGBChromaticitiesInChromaticityDiagramCIE1976UCS: """ Define :func:`colour.plotting.models.\ plot_RGB_chromaticities_in_chromaticity_diagram_CIE1976UCS` definition unit @@ -349,11 +338,11 @@ def test_plot_RGB_chromaticities_in_chromaticity_diagram_CIE1976UCS(self): np.random.random((128, 128, 3)) ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestEllipsesMacAdam1942(unittest.TestCase): +class TestEllipsesMacAdam1942: """ Define :func:`colour.plotting.models.ellipses_MacAdam1942` definition unit tests methods. @@ -362,14 +351,12 @@ class TestEllipsesMacAdam1942(unittest.TestCase): def test_ellipses_MacAdam1942(self): """Test :func:`colour.plotting.models.ellipses_MacAdam1942` definition.""" - self.assertEqual(len(ellipses_MacAdam1942()), 25) + assert len(ellipses_MacAdam1942()) == 25 - self.assertRaises( - ValueError, lambda: ellipses_MacAdam1942(method="Undefined") - ) + pytest.raises(ValueError, lambda: ellipses_MacAdam1942(method="Undefined")) -class TestPlotEllipsesMacAdam1942InChromaticityDiagram(unittest.TestCase): +class TestPlotEllipsesMacAdam1942InChromaticityDiagram: """ Define :func:`colour.plotting.models.\ plot_ellipses_MacAdam1942_in_chromaticity_diagram` definition unit tests @@ -386,21 +373,19 @@ def test_plot_ellipses_MacAdam1942_in_chromaticity_diagram(self): chromaticity_diagram_clipping=True, ellipse_kwargs={"color": "k"} ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_ellipses_MacAdam1942_in_chromaticity_diagram( chromaticity_diagram_clipping=True, ellipse_kwargs=[{"color": "k"}] * 25, ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotEllipsesMacAdam1942InChromaticityDiagramCIE1931( - unittest.TestCase -): +class TestPlotEllipsesMacAdam1942InChromaticityDiagramCIE1931: """ Define :func:`colour.plotting.models.\ plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1931` definition unit @@ -418,13 +403,11 @@ def test_plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1931(self): axes, ) = plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1931() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotEllipsesMacAdam1942InChromaticityDiagramCIE1960UCS( - unittest.TestCase -): +class TestPlotEllipsesMacAdam1942InChromaticityDiagramCIE1960UCS: """ Define :func:`colour.plotting.models.\ plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1960UCS` definition unit @@ -444,13 +427,11 @@ def test_plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1960UCS( axes, ) = plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1960UCS() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotEllipsesMacAdam1942InChromaticityDiagramCIE1976UCS( - unittest.TestCase -): +class TestPlotEllipsesMacAdam1942InChromaticityDiagramCIE1976UCS: """ Define :func:`colour.plotting.models.\ plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1976UCS` definition unit @@ -470,11 +451,11 @@ def test_plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1976UCS( axes, ) = plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1976UCS() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSingleCctf(unittest.TestCase): +class TestPlotSingleCctf: """ Define :func:`colour.plotting.models.plot_single_cctf` definition unit tests methods. @@ -485,11 +466,11 @@ def test_plot_single_cctf(self): figure, axes = plot_single_cctf("ITU-R BT.709") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotMultiCctfs(unittest.TestCase): +class TestPlotMultiCctfs: """ Define :func:`colour.plotting.models.plot_multi_cctfs` definition unit tests methods. @@ -500,11 +481,11 @@ def test_plot_multi_cctfs(self): figure, axes = plot_multi_cctfs(["ITU-R BT.709", "sRGB"]) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotConstantHueLoci(unittest.TestCase): +class TestPlotConstantHueLoci: """ Define :func:`colour.plotting.models.plot_constant_hue_loci` definition unit tests methods. @@ -591,9 +572,10 @@ def test_plot_constant_hue_loci(self): data, "IPT", scatter_kwargs={"marker": "v"} ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) + figure, axes = plot_constant_hue_loci(data, "IPT", scatter_kwargs={"c": "k"}) -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tests/test_notation.py b/colour/plotting/tests/test_notation.py index aa51a04dc7..62715b7983 100644 --- a/colour/plotting/tests/test_notation.py +++ b/colour/plotting/tests/test_notation.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.notation` module.""" -import unittest from matplotlib.axes import Axes from matplotlib.figure import Figure @@ -24,7 +22,7 @@ ] -class TestPlotSingleMunsellValueFunction(unittest.TestCase): +class TestPlotSingleMunsellValueFunction: """ Define :func:`colour.plotting.notation.plot_single_munsell_value_function` definition unit tests methods. @@ -38,11 +36,11 @@ def test_plot_single_munsell_value_function(self): figure, axes = plot_single_munsell_value_function("ASTM D1535") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotMultiMunsellValueFunctions(unittest.TestCase): +class TestPlotMultiMunsellValueFunctions: """ Define :func:`colour.plotting.notation.plot_multi_munsell_value_functions` definition unit tests methods. @@ -54,13 +52,7 @@ def test_plot_multi_munsell_value_functions(self): plot_multi_munsell_value_functions` definition. """ - figure, axes = plot_multi_munsell_value_functions( - ["ASTM D1535", "McCamy 1987"] - ) + figure, axes = plot_multi_munsell_value_functions(["ASTM D1535", "McCamy 1987"]) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - - -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tests/test_phenomena.py b/colour/plotting/tests/test_phenomena.py index 06d9777803..bfd8d7f4fe 100644 --- a/colour/plotting/tests/test_phenomena.py +++ b/colour/plotting/tests/test_phenomena.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.phenomena` module.""" -import unittest from matplotlib.axes import Axes from matplotlib.figure import Figure @@ -24,7 +22,7 @@ ] -class TestPlotSingleSdRayleighScattering(unittest.TestCase): +class TestPlotSingleSdRayleighScattering: """ Define :func:`colour.plotting.phenomena.\ plot_single_sd_rayleigh_scattering` definition unit tests methods. @@ -38,11 +36,11 @@ def test_plot_single_sd_rayleigh_scattering(self): figure, axes = plot_single_sd_rayleigh_scattering() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotTheBlueSky(unittest.TestCase): +class TestPlotTheBlueSky: """ Define :func:`colour.plotting.phenomena.plot_the_blue_sky` definition unit tests methods. @@ -53,9 +51,5 @@ def test_plot_the_blue_sky(self): figure, axes = plot_the_blue_sky() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - - -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tests/test_quality.py b/colour/plotting/tests/test_quality.py index 75076493b9..7097a8cf5a 100644 --- a/colour/plotting/tests/test_quality.py +++ b/colour/plotting/tests/test_quality.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.quality` module.""" -import unittest from matplotlib.axes import Axes from matplotlib.figure import Figure @@ -37,7 +35,7 @@ ] -class TestPlotColourQualityBars(unittest.TestCase): +class TestPlotColourQualityBars: """ Define :func:`colour.plotting.quality.plot_colour_quality_bars` definition unit tests methods. @@ -57,11 +55,11 @@ def test_plot_colour_quality_bars(self): figure, axes = plot_colour_quality_bars([cqs_i, cqs_l]) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSingleSdColourRenderingIndexBars(unittest.TestCase): +class TestPlotSingleSdColourRenderingIndexBars: """ Define :func:`colour.plotting.quality.\ plot_single_sd_colour_rendering_index_bars` definition unit tests methods. @@ -77,11 +75,11 @@ def test_plot_single_sd_colour_rendering_index_bars(self): SDS_ILLUMINANTS["FL2"] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotMultiSdsColourRenderingIndexesBars(unittest.TestCase): +class TestPlotMultiSdsColourRenderingIndexesBars: """ Define :func:`colour.plotting.quality.\ plot_multi_sds_colour_rendering_indexes_bars` definition unit tests methods. @@ -97,11 +95,11 @@ def test_plot_multi_sds_colour_rendering_indexes_bars(self): [SDS_ILLUMINANTS["FL2"], SDS_LIGHT_SOURCES["Kinoton 75P"]] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSingleSdColourQualityScaleBars(unittest.TestCase): +class TestPlotSingleSdColourQualityScaleBars: """ Define :func:`colour.plotting.quality.\ plot_single_sd_colour_quality_scale_bars` definition unit tests methods. @@ -113,15 +111,13 @@ def test_plot_single_sd_colour_quality_scale_bars(self): plot_single_sd_colour_quality_scale_bars` definition. """ - figure, axes = plot_single_sd_colour_quality_scale_bars( - SDS_ILLUMINANTS["FL2"] - ) + figure, axes = plot_single_sd_colour_quality_scale_bars(SDS_ILLUMINANTS["FL2"]) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotMultiSdsColourQualityScalesBars(unittest.TestCase): +class TestPlotMultiSdsColourQualityScalesBars: """ Define :func:`colour.plotting.quality.\ plot_multi_sds_colour_quality_scales_bars` definition unit tests methods. @@ -137,9 +133,5 @@ def test_plot_multi_sds_colour_quality_scales_bars(self): [SDS_ILLUMINANTS["FL2"], SDS_LIGHT_SOURCES["Kinoton 75P"]] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - - -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tests/test_section.py b/colour/plotting/tests/test_section.py index f7ac9c2093..d7fd6cb466 100644 --- a/colour/plotting/tests/test_section.py +++ b/colour/plotting/tests/test_section.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.section` module.""" -import unittest from matplotlib.axes import Axes from matplotlib.figure import Figure @@ -33,7 +31,7 @@ ] -class TestPlotHullSectionColours(unittest.TestCase): +class TestPlotHullSectionColours: """ Define :func:`colour.plotting.section.plot_hull_section_colours` definition unit tests methods. @@ -51,28 +49,26 @@ def test_plot_hull_section_colours(self): import trimesh vertices, faces, _outline = primitive_cube(1, 1, 1, 64, 64, 64) - XYZ_vertices = RGB_to_XYZ( - vertices["position"] + 0.5, RGB_COLOURSPACE_sRGB - ) + XYZ_vertices = RGB_to_XYZ(vertices["position"] + 0.5, RGB_COLOURSPACE_sRGB) hull = trimesh.Trimesh(XYZ_vertices, faces, process=False) figure, axes = plot_hull_section_colours(hull) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_hull_section_colours(hull, axis="+x") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_hull_section_colours(hull, axis="+y") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotHullSectionContour(unittest.TestCase): +class TestPlotHullSectionContour: """ Define :func:`colour.plotting.section.plot_hull_section_contour` definition unit tests methods. @@ -90,18 +86,16 @@ def test_plot_hull_section_contour(self): import trimesh vertices, faces, _outline = primitive_cube(1, 1, 1, 64, 64, 64) - XYZ_vertices = RGB_to_XYZ( - vertices["position"] + 0.5, RGB_COLOURSPACE_sRGB - ) + XYZ_vertices = RGB_to_XYZ(vertices["position"] + 0.5, RGB_COLOURSPACE_sRGB) hull = trimesh.Trimesh(XYZ_vertices, faces, process=False) figure, axes = plot_hull_section_contour(hull) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotVisibleSpectrumSection(unittest.TestCase): +class TestPlotVisibleSpectrumSection: """ Define :func:`colour.plotting.section.plot_visible_spectrum_section` definition unit tests methods. @@ -118,11 +112,11 @@ def test_plot_visible_spectrum_section(self): figure, axes = plot_visible_spectrum_section() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotRGBColourspaceSection(unittest.TestCase): +class TestPlotRGBColourspaceSection: """ Define :func:`colour.plotting.section.plot_RGB_colourspace_section` definition unit tests methods. @@ -139,9 +133,5 @@ def test_plot_RGB_colourspace_section(self): figure, axes = plot_RGB_colourspace_section("sRGB") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - - -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tests/test_temperature.py b/colour/plotting/tests/test_temperature.py index a2e29ddb08..4ec12ba068 100644 --- a/colour/plotting/tests/test_temperature.py +++ b/colour/plotting/tests/test_temperature.py @@ -1,8 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.temperature` module.""" -import unittest +import pytest from matplotlib.axes import Axes from matplotlib.figure import Figure @@ -36,7 +35,7 @@ ] -class TestLinesDaylightLocus(unittest.TestCase): +class TestLinesDaylightLocus: """ Define :func:`colour.plotting.diagrams.lines_daylight_locus` definition unit tests methods. @@ -47,10 +46,10 @@ def test_lines_daylight_locus(self): Test :func:`colour.plotting.diagrams.lines_daylight_locus` definition. """ - self.assertEqual(len(lines_daylight_locus()), 1) + assert len(lines_daylight_locus()) == 1 -class TestPlotDaylightLocus(unittest.TestCase): +class TestPlotDaylightLocus: """ Define :func:`colour.plotting.temperature.plot_daylight_locus` definition unit tests methods. @@ -64,25 +63,23 @@ def test_plot_daylight_locus(self): figure, axes = plot_daylight_locus() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) - self.assertRaises( - ValueError, lambda: plot_daylight_locus(method="Undefined") - ) + pytest.raises(ValueError, lambda: plot_daylight_locus(method="Undefined")) figure, axes = plot_daylight_locus(method="CIE 1976 UCS") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_daylight_locus(planckian_locus_colours="RGB") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestLinesPlanckianLocus(unittest.TestCase): +class TestLinesPlanckianLocus: """ Define :func:`colour.plotting.diagrams.lines_planckian_locus` definition unit tests methods. @@ -93,10 +90,10 @@ def test_lines_planckian_locus(self): Test :func:`colour.plotting.diagrams.lines_planckian_locus` definition. """ - self.assertEqual(len(lines_planckian_locus()), 2) + assert len(lines_planckian_locus()) == 2 -class TestPlotPlanckianLocus(unittest.TestCase): +class TestPlotPlanckianLocus: """ Define :func:`colour.plotting.temperature.plot_planckian_locus` definition unit tests methods. @@ -110,32 +107,28 @@ def test_plot_planckian_locus(self): figure, axes = plot_planckian_locus() - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) - self.assertRaises( - ValueError, lambda: plot_planckian_locus(method="Undefined") - ) + pytest.raises(ValueError, lambda: plot_planckian_locus(method="Undefined")) figure, axes = plot_planckian_locus(method="CIE 1976 UCS") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_planckian_locus(planckian_locus_colours="RGB") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) - figure, axes = plot_planckian_locus( - planckian_locus_labels=[5500, 6500] - ) + figure, axes = plot_planckian_locus(planckian_locus_labels=[5500, 6500]) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotPlanckianLocusInChromaticityDiagram(unittest.TestCase): +class TestPlotPlanckianLocusInChromaticityDiagram: """ Define :func:`colour.plotting.temperature.\ plot_planckian_locus_in_chromaticity_diagram` definition unit tests methods. @@ -155,8 +148,8 @@ def test_plot_planckian_locus_in_chromaticity_diagram(self): }, ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) figure, axes = plot_planckian_locus_in_chromaticity_diagram( ["A", "B", "C"], @@ -169,10 +162,10 @@ def test_plot_planckian_locus_in_chromaticity_diagram(self): * 3, ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) - self.assertRaises( + pytest.raises( ValueError, lambda: plot_planckian_locus_in_chromaticity_diagram( ["A", "B", "C"], @@ -183,7 +176,7 @@ def test_plot_planckian_locus_in_chromaticity_diagram(self): ) -class TestPlotPlanckianLocusInChromaticityDiagramCIE1931(unittest.TestCase): +class TestPlotPlanckianLocusInChromaticityDiagramCIE1931: """ Define :func:`colour.plotting.temperature.\ plot_planckian_locus_in_chromaticity_diagram_CIE1931` definition unit tests @@ -200,11 +193,11 @@ def test_plot_planckian_locus_in_chromaticity_diagram_CIE1931(self): ["A", "B", "C"] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotPlanckianLocusInChromaticityDiagramCIE1960UCS(unittest.TestCase): +class TestPlotPlanckianLocusInChromaticityDiagramCIE1960UCS: """ Define :func:`colour.plotting.temperature.\ plot_planckian_locus_in_chromaticity_diagram_CIE1960UCS` definition unit tests @@ -221,9 +214,5 @@ def test_plot_planckian_locus_in_chromaticity_diagram_CIE1960UCS(self): ["A", "B", "C"] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - - -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tests/test_volume.py b/colour/plotting/tests/test_volume.py index 0c914a01e5..bbc9a8059b 100644 --- a/colour/plotting/tests/test_volume.py +++ b/colour/plotting/tests/test_volume.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.volume` module.""" -import unittest import numpy as np from matplotlib.axes import Axes @@ -26,7 +24,7 @@ ] -class TestNadirGrid(unittest.TestCase): +class TestNadirGrid: """ Define :func:`colour.plotting.volume.nadir_grid` definition unit tests methods. @@ -121,7 +119,7 @@ def test_nadir_grid(self): ) -class TestRGBIdentityCube(unittest.TestCase): +class TestRGBIdentityCube: """ Define :func:`colour.plotting.volume.RGB_identity_cube` definition unit tests methods. @@ -193,7 +191,7 @@ def test_RGB_identity_cube(self): ) -class TestPlotRGBColourspacesGamuts(unittest.TestCase): +class TestPlotRGBColourspacesGamuts: """ Define :func:`colour.plotting.volume.plot_RGB_colourspaces_gamuts` definition unit tests methods. @@ -212,11 +210,11 @@ def test_plot_RGB_colourspaces_gamuts(self): chromatically_adapt=True, ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotRGBScatter(unittest.TestCase): +class TestPlotRGBScatter: """ Define :func:`colour.plotting.volume.plot_RGB_scatter` definition unit tests methods. @@ -225,13 +223,7 @@ class TestPlotRGBScatter(unittest.TestCase): def test_plot_RGB_scatter(self): """Test :func:`colour.plotting.volume.plot_RGB_scatter` definition.""" - figure, axes = plot_RGB_scatter( - np.random.random((128, 128, 3)), "ITU-R BT.709" - ) - - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - + figure, axes = plot_RGB_scatter(np.random.random((128, 128, 3)), "ITU-R BT.709") -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tm3018/components.py b/colour/plotting/tm3018/components.py index 6d0d388c3b..6aad47a8b6 100644 --- a/colour/plotting/tm3018/components.py +++ b/colour/plotting/tm3018/components.py @@ -2,7 +2,7 @@ ANSI/IES TM-30-18 Colour Rendition Report Components ==================================================== -Defines the *ANSI/IES TM-30-18 Colour Rendition Report* components plotting +Define the *ANSI/IES TM-30-18 Colour Rendition Report* components plotting objects: - :func:`colour.plotting.tm3018.components.plot_spectra_ANSIIESTM3018` @@ -55,9 +55,7 @@ "plot_colour_fidelity_indexes", ] -ROOT_RESOURCES_ANSIIESTM3018: str = os.path.join( - os.path.dirname(__file__), "resources" -) +ROOT_RESOURCES_ANSIIESTM3018: str = os.path.join(os.path.dirname(__file__), "resources") """Resources directory.""" _COLOURS_BIN_BAR: list = [ @@ -392,16 +390,12 @@ def plot_colour_vector_graphic( average_hues = np.radians( [ np.mean( - specification.colorimetry_data[1].JMh[ - specification.bins == j, 2 - ], + specification.colorimetry_data[1].JMh[specification.bins == j, 2], ) for j in range(16) ] ) - xy_reference = np.transpose( - np.vstack([np.cos(average_hues), np.sin(average_hues)]) - ) + xy_reference = np.transpose(np.vstack([np.cos(average_hues), np.sin(average_hues)])) # Arrow offsets as defined by the standard. offsets = ( @@ -466,12 +460,8 @@ def corner_label_and_text(label: str, text: str, ha: str, va: str): corner_label_and_text("$R_f$", f"{specification.R_f:.0f}", "left", "top") corner_label_and_text("$R_g$", f"{specification.R_g:.0f}", "right", "top") - corner_label_and_text( - "CCT", f"{specification.CCT:.0f} K", "left", "bottom" - ) - corner_label_and_text( - "$D_{uv}$", f"{specification.D_uv:.4f}", "right", "bottom" - ) + corner_label_and_text("CCT", f"{specification.CCT:.0f} K", "left", "bottom") + corner_label_and_text("$D_{uv}$", f"{specification.D_uv:.4f}", "right", "bottom") settings = {"show": True} settings.update(kwargs) @@ -521,9 +511,7 @@ def plot_16_bin_bars( values = as_float_array(values) - label_orientation = validate_method( - label_orientation, ("Horizontal", "Vertical") - ) + label_orientation = validate_method(label_orientation, ("Horizontal", "Vertical")) _figure, axes = artist(**kwargs) @@ -800,9 +788,7 @@ def plot_colour_fidelity_indexes( ticks = list(range(1, bar_count + 1, 1)) axes.set_xticks(ticks) - labels = [ - f"CES{i:02d}" if i % 3 == 1 else "" for i in range(1, bar_count + 1) - ] + labels = [f"CES{i:02d}" if i % 3 == 1 else "" for i in range(1, bar_count + 1)] axes.set_xticklabels(labels, rotation=90) return render(**kwargs) diff --git a/colour/plotting/tm3018/report.py b/colour/plotting/tm3018/report.py index 2d4fdb0b08..aa1ce4e506 100644 --- a/colour/plotting/tm3018/report.py +++ b/colour/plotting/tm3018/report.py @@ -2,7 +2,7 @@ ANSI/IES TM-30-18 Colour Rendition Report ========================================= -Defines the *ANSI/IES TM-30-18 Colour Rendition Report* plotting objects: +Define the *ANSI/IES TM-30-18 Colour Rendition Report* plotting objects: - :func:`colour.plotting.tm3018.plot_single_sd_colour_rendition_report_full` - :func:`colour.plotting. @@ -144,11 +144,10 @@ """Report style overrides.""" CONTENT_REPORT_HEADER: str = "IES TM-30-18 Colour Rendition Report" -"""Report header content, i.e. the report title.""" +"""Report header content, i.e., the report title.""" CONTENT_REPORT_FOOTER: str = ( - "Colours are for visual orientation purposes only. " - "Created with Colour{0}" + "Colours are for visual orientation purposes only. Created with Colour{0}" ) """Report footer content.""" @@ -157,7 +156,7 @@ def _plot_report_header(axes: Axes) -> Axes: """ - Plot the report header, i.e. the title, on given axes. + Plot the report header, i.e., the title, on given axes. Parameters ---------- @@ -297,9 +296,7 @@ def plot_single_sd_colour_rendition_report_full( :alt: plot_single_sd_colour_rendition_report_full """ # noqa: D405, D407, D410, D411 - report_box_padding = optional( - report_box_padding, CONSTANT_REPORT_PADDING_FULL - ) + report_box_padding = optional(report_box_padding, CONSTANT_REPORT_PADDING_FULL) specification: ColourQuality_Specification_ANSIIESTM3018 = cast( ColourQuality_Specification_ANSIIESTM3018, @@ -326,9 +323,7 @@ def plot_single_sd_colour_rendition_report_full( settings["show"] = False settings["tight_layout"] = False - gridspec_report = figure.add_gridspec( - 5, 1, height_ratios=report_row_height_ratios - ) + gridspec_report = figure.add_gridspec(5, 1, height_ratios=report_row_height_ratios) # Title Row gridspec_title = gridspec_report[0].subgridspec(1, 1) @@ -374,9 +369,7 @@ def plot_single_sd_colour_rendition_report_full( size="medium", weight="bold", ) - axes_manufacturer_model.text( - 0.25, 2 / 3, manufacturer, va="center", size="medium" - ) + axes_manufacturer_model.text(0.25, 2 / 3, manufacturer, va="center", size="medium") axes_manufacturer_model.text( 0.25, @@ -387,9 +380,7 @@ def plot_single_sd_colour_rendition_report_full( size="medium", weight="bold", ) - axes_manufacturer_model.text( - 0.25, 1 / 3, model, va="center", size="medium" - ) + axes_manufacturer_model.text(0.25, 1 / 3, model, va="center", size="medium") # Main Figures Rows & Columns gridspec_figures = gridspec_report[2].subgridspec( @@ -399,14 +390,10 @@ def plot_single_sd_colour_rendition_report_full( plot_spectra_ANSIIESTM3018(specification, axes=axes_spectra, **settings) axes_vector_graphics = figure.add_subplot(gridspec_figures[1:3, 0]) - plot_colour_vector_graphic( - specification, axes=axes_vector_graphics, **settings - ) + plot_colour_vector_graphic(specification, axes=axes_vector_graphics, **settings) axes_chroma_shifts = figure.add_subplot(gridspec_figures[0, 1]) - plot_local_chroma_shifts( - specification, axes=axes_chroma_shifts, **settings - ) + plot_local_chroma_shifts(specification, axes=axes_chroma_shifts, **settings) axes_hue_shifts = figure.add_subplot(gridspec_figures[1, 1]) plot_local_hue_shifts(specification, axes=axes_hue_shifts, **settings) @@ -436,9 +423,7 @@ def plot_single_sd_colour_rendition_report_full( weight="bold", ) axes_notes.text(0.25, 1, notes, va="center", size="medium") - gridspec_chromaticities_CRI = gridspec_notes_chromaticities_CRI[ - 1 - ].subgridspec(1, 2) + gridspec_chromaticities_CRI = gridspec_notes_chromaticities_CRI[1].subgridspec(1, 2) XYZ = sd_to_XYZ(specification.sd_test) xy = XYZ_to_xy(XYZ) @@ -554,9 +539,7 @@ def plot_single_sd_colour_rendition_report_full( def plot_single_sd_colour_rendition_report_intermediate( sd: SpectralDistribution, report_size: tuple[float, float] = CONSTANT_REPORT_SIZE_INTERMEDIATE, - report_row_height_ratios: tuple = ( - CONSTANT_REPORT_ROW_HEIGHT_RATIOS_INTERMEDIATE - ), + report_row_height_ratios: tuple = (CONSTANT_REPORT_ROW_HEIGHT_RATIOS_INTERMEDIATE), report_box_padding: dict | None = None, **kwargs: Any, ) -> Tuple[Figure, Axes]: @@ -617,9 +600,7 @@ def plot_single_sd_colour_rendition_report_intermediate( settings["show"] = False settings["tight_layout"] = False - gridspec_report = figure.add_gridspec( - 3, 1, height_ratios=report_row_height_ratios - ) + gridspec_report = figure.add_gridspec(3, 1, height_ratios=report_row_height_ratios) # Title Row gridspec_title = gridspec_report[0].subgridspec(1, 1) @@ -630,14 +611,10 @@ def plot_single_sd_colour_rendition_report_intermediate( gridspec_figures = gridspec_report[1].subgridspec(2, 2) axes_vector_graphics = figure.add_subplot(gridspec_figures[0:2, 0]) - plot_colour_vector_graphic( - specification, axes=axes_vector_graphics, **settings - ) + plot_colour_vector_graphic(specification, axes=axes_vector_graphics, **settings) axes_chroma_shifts = figure.add_subplot(gridspec_figures[0, 1]) - plot_local_chroma_shifts( - specification, axes=axes_chroma_shifts, **settings - ) + plot_local_chroma_shifts(specification, axes=axes_chroma_shifts, **settings) axes_hue_shifts = figure.add_subplot(gridspec_figures[1, 1]) plot_local_hue_shifts( @@ -705,9 +682,7 @@ def plot_single_sd_colour_rendition_report_simple( :alt: plot_single_sd_colour_rendition_report_simple """ - report_box_padding = optional( - report_box_padding, CONSTANT_REPORT_PADDING_SIMPLE - ) + report_box_padding = optional(report_box_padding, CONSTANT_REPORT_PADDING_SIMPLE) specification: ColourQuality_Specification_ANSIIESTM3018 = cast( ColourQuality_Specification_ANSIIESTM3018, @@ -720,9 +695,7 @@ def plot_single_sd_colour_rendition_report_simple( settings["show"] = False settings["tight_layout"] = False - gridspec_report = figure.add_gridspec( - 3, 1, height_ratios=report_row_height_ratios - ) + gridspec_report = figure.add_gridspec(3, 1, height_ratios=report_row_height_ratios) # Title Row gridspec_title = gridspec_report[0].subgridspec(1, 1) @@ -733,9 +706,7 @@ def plot_single_sd_colour_rendition_report_simple( gridspec_figures = gridspec_report[1].subgridspec(1, 1) axes_vector_graphics = figure.add_subplot(gridspec_figures[0, 0]) - plot_colour_vector_graphic( - specification, axes=axes_vector_graphics, **settings - ) + plot_colour_vector_graphic(specification, axes=axes_vector_graphics, **settings) gridspec_footer = gridspec_report[2].subgridspec(1, 1) axes_footer = figure.add_subplot(gridspec_footer[0]) @@ -818,8 +789,6 @@ def plot_single_sd_colour_rendition_report( if method == "full": return plot_single_sd_colour_rendition_report_full(sd, **kwargs) elif method == "intermediate": - return plot_single_sd_colour_rendition_report_intermediate( - sd, **kwargs - ) + return plot_single_sd_colour_rendition_report_intermediate(sd, **kwargs) else: # method == 'simple' return plot_single_sd_colour_rendition_report_simple(sd, **kwargs) diff --git a/colour/plotting/tm3018/tests/test_components.py b/colour/plotting/tm3018/tests/test_components.py index 9f53ca2955..c97c8072ba 100644 --- a/colour/plotting/tm3018/tests/test_components.py +++ b/colour/plotting/tm3018/tests/test_components.py @@ -1,10 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.tm3018.components` module.""" from __future__ import annotations -import unittest - from matplotlib.axes import Axes from matplotlib.figure import Figure @@ -47,7 +44,7 @@ ) -class TestPlotSpectraANSIIESTM3018(unittest.TestCase): +class TestPlotSpectraANSIIESTM3018: """ Define :func:`colour.plotting.tm3018.components. plot_spectra_ANSIIESTM3018` definition unit tests methods. @@ -61,11 +58,11 @@ def test_plot_spectra_ANSIIESTM3018(self): figure, axes = plot_spectra_ANSIIESTM3018(SPECIFICATION_ANSIIESTM3018) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotColourVectorGraphic(unittest.TestCase): +class TestPlotColourVectorGraphic: """ Define :func:`colour.plotting.tm3018.components.\ plot_colour_vector_graphic` definition unit tests methods. @@ -79,11 +76,11 @@ def test_plot_colour_vector_graphic(self): figure, axes = plot_colour_vector_graphic(SPECIFICATION_ANSIIESTM3018) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlot16BinBars(unittest.TestCase): +class TestPlot16BinBars: """ Define :func:`colour.plotting.tm3018.components.plot_16_bin_bars` definition unit tests methods. @@ -97,11 +94,11 @@ def test_plot_16_bin_bars(self): figure, axes = plot_16_bin_bars(range(16), "{0}") - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotLocalChromaShifts(unittest.TestCase): +class TestPlotLocalChromaShifts: """ Define :func:`colour.plotting.tm3018.components.plot_local_chroma_shifts` definition unit tests methods. @@ -115,11 +112,11 @@ def test_plot_local_chroma_shifts(self): figure, axes = plot_local_chroma_shifts(SPECIFICATION_ANSIIESTM3018) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotLocalHueShifts(unittest.TestCase): +class TestPlotLocalHueShifts: """ Define :func:`colour.plotting.tm3018.components.plot_local_hue_shifts` definition unit tests methods. @@ -133,11 +130,11 @@ def test_plot_local_hue_shifts(self): figure, axes = plot_local_hue_shifts(SPECIFICATION_ANSIIESTM3018) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotLocalColourFidelities(unittest.TestCase): +class TestPlotLocalColourFidelities: """ Define :func:`colour.plotting.tm3018.components. plot_local_colour_fidelities` definition unit tests methods. @@ -149,15 +146,13 @@ def test_plot_local_colour_fidelities(self): plot_local_colour_fidelities` definition. """ - figure, axes = plot_local_colour_fidelities( - SPECIFICATION_ANSIIESTM3018 - ) + figure, axes = plot_local_colour_fidelities(SPECIFICATION_ANSIIESTM3018) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotColourFidelityIndexes(unittest.TestCase): +class TestPlotColourFidelityIndexes: """ Define :func:`colour.plotting.tm3018.components.\ plot_colour_fidelity_indexes` definition unit tests methods. @@ -169,13 +164,7 @@ def test_plot_colour_fidelity_indexes(self): plot_colour_fidelity_indexes` definition. """ - figure, axes = plot_colour_fidelity_indexes( - SPECIFICATION_ANSIIESTM3018 - ) - - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - + figure, axes = plot_colour_fidelity_indexes(SPECIFICATION_ANSIIESTM3018) -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/tm3018/tests/test_report.py b/colour/plotting/tm3018/tests/test_report.py index 944490bdea..eeac2a24e2 100644 --- a/colour/plotting/tm3018/tests/test_report.py +++ b/colour/plotting/tm3018/tests/test_report.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.plotting.tm3018.report` module.""" -import unittest from matplotlib.axes import Axes from matplotlib.figure import Figure @@ -29,7 +27,7 @@ ] -class TestPlotSingleSdColourRenditionReportFull(unittest.TestCase): +class TestPlotSingleSdColourRenditionReportFull: """ Define :func:`colour.plotting.tm3018.report.\ plot_single_sd_colour_rendition_report_full` definition unit tests methods. @@ -45,11 +43,11 @@ def test_plot_single_sd_colour_rendition_report_full(self): SDS_ILLUMINANTS["FL2"] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSingleSdColourRenditionReportIntermediate(unittest.TestCase): +class TestPlotSingleSdColourRenditionReportIntermediate: """ Define :func:`colour.plotting.tm3018.report.\ plot_single_sd_colour_rendition_report_intermediate` definition unit tests @@ -66,11 +64,11 @@ def test_plot_single_sd_colour_rendition_report_intermediate(self): SDS_ILLUMINANTS["FL2"] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSingleSdColourRenditionReportSimple(unittest.TestCase): +class TestPlotSingleSdColourRenditionReportSimple: """ Define :func:`colour.plotting.tm3018.report.\ plot_single_sd_colour_rendition_report_simple` definition unit tests methods. @@ -86,11 +84,11 @@ def test_plot_color_vector_graphic(self): SDS_ILLUMINANTS["FL2"] ) - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) -class TestPlotSingleSdColourRenditionReport(unittest.TestCase): +class TestPlotSingleSdColourRenditionReport: """ Define :func:`colour.plotting.tm3018.report.\ plot_single_sd_colour_rendition_report` definition unit tests methods. @@ -102,13 +100,7 @@ def test_plot_single_sd_colour_rendition_report(self): plot_single_sd_colour_rendition_report` definition. """ - figure, axes = plot_single_sd_colour_rendition_report( - SDS_ILLUMINANTS["FL2"] - ) - - self.assertIsInstance(figure, Figure) - self.assertIsInstance(axes, Axes) - + figure, axes = plot_single_sd_colour_rendition_report(SDS_ILLUMINANTS["FL2"]) -if __name__ == "__main__": - unittest.main() + assert isinstance(figure, Figure) + assert isinstance(axes, Axes) diff --git a/colour/plotting/volume.py b/colour/plotting/volume.py index a74e8c3e80..253c0ed29f 100644 --- a/colour/plotting/volume.py +++ b/colour/plotting/volume.py @@ -2,7 +2,7 @@ Colour Models Volume Plotting ============================= -Defines the colour models volume and gamut plotting objects: +Define the colour models volume and gamut plotting objects: - :func:`colour.plotting.plot_RGB_colourspaces_gamuts` - :func:`colour.plotting.plot_RGB_scatter` @@ -218,13 +218,9 @@ def nadir_grid( RGB_g = ones((quads_g.shape[0], quads_g.shape[-1])) RGB_gf = RGB_g * settings.grid_face_colours - RGB_gf = np.hstack( - [RGB_gf, full((RGB_gf.shape[0], 1), settings.grid_face_alpha)] - ) + RGB_gf = np.hstack([RGB_gf, full((RGB_gf.shape[0], 1), settings.grid_face_alpha)]) RGB_ge = RGB_g * settings.grid_edge_colours - RGB_ge = np.hstack( - [RGB_ge, full((RGB_ge.shape[0], 1), settings.grid_edge_alpha)] - ) + RGB_ge = np.hstack([RGB_ge, full((RGB_ge.shape[0], 1), settings.grid_edge_alpha)]) # Inner grid. quads_gs = primitive_vertices_grid_mpl( @@ -268,16 +264,8 @@ def nadir_grid( ticks = sorted(set(quads_g[..., 0, i])) ticks += [ticks[-1] + ticks[-1] - ticks[-2]] for tick in ticks: - x = ( - limits[1, 1 if x_s == 1 else 0] + (x_s * extent / 25) - if i - else tick - ) - y = ( - tick - if i - else limits[0, 1 if y_s == 1 else 0] + (y_s * extent / 25) - ) + x = limits[1, 1 if x_s == 1 else 0] + (x_s * extent / 25) if i else tick + y = tick if i else limits[0, 1 if y_s == 1 else 0] + (y_s * extent / 25) tick = ( # noqa: PLW2901 as_int_scalar(tick) if is_integer(tick) else tick @@ -301,16 +289,8 @@ def nadir_grid( h_a = "center" if axis == "x" else "left" if x_s == 1 else "right" v_a = "center" - x = ( - limits[1, 1 if x_s == 1 else 0] + (x_s * extent / 10) - if i - else 0 - ) - y = ( - 0 - if i - else limits[0, 1 if y_s == 1 else 0] + (y_s * extent / 10) - ) + x = limits[1, 1 if x_s == 1 else 0] + (x_s * extent / 10) if i else 0 + y = 0 if i else limits[0, 1 if y_s == 1 else 0] + (y_s * extent / 10) c = settings[f"{axis}_label_colour"] @@ -338,10 +318,23 @@ def RGB_identity_cube( width_segments: int = 16, height_segments: int = 16, depth_segments: int = 16, - planes: Literal[ - "-x", "+x", "-y", "+y", "-z", "+z", "xy", "xz", "yz", "yx", "zx", "zy" - ] - | None = None, + planes: ( + Literal[ + "-x", + "+x", + "-y", + "+y", + "-z", + "+z", + "xy", + "xz", + "yz", + "yx", + "zx", + "zy", + ] + | None + ) = None, ) -> Tuple[NDArrayFloat, NDArrayFloat]: """ Return an *RGB* identity cube made of quad geometric elements and its @@ -421,21 +414,21 @@ def RGB_identity_cube( @override_style() def plot_RGB_colourspaces_gamuts( - colourspaces: RGB_Colourspace - | LiteralRGBColourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str], + colourspaces: ( + RGB_Colourspace + | LiteralRGBColourspace + | str + | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + ), model: LiteralColourspaceModel | str = "CIE xyY", segments: int = 8, show_grid: bool = True, grid_segments: int = 10, show_spectral_locus: bool = False, spectral_locus_colour: ArrayLike | str | None = None, - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", chromatically_adapt: bool = False, convert_kwargs: dict | None = None, **kwargs: Any, @@ -519,10 +512,7 @@ def plot_RGB_colourspaces_gamuts( count_c = len(colourspaces) - title = ( - f"{', '.join([colourspace.name for colourspace in colourspaces])} " - f"- {model}" - ) + title = f"{', '.join([colourspace.name for colourspace in colourspaces])} - {model}" illuminant = CONSTANTS_COLOUR_STYLE.colour.colourspace.whitepoint @@ -545,9 +535,7 @@ def plot_RGB_colourspaces_gamuts( points = zeros((4, 3)) if show_spectral_locus: - cmfs = cast( - MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values()) - ) + cmfs = cast(MultiSpectralDistributions, first_item(filter_cmfs(cmfs).values())) XYZ = cmfs.values points = colourspace_model_axis_reorder( @@ -616,16 +604,12 @@ def plot_RGB_colourspaces_gamuts( if settings.face_colours[i] is not None: RGB = ones(RGB.shape) * settings.face_colours[i] - RGB_cf.extend( - np.hstack([RGB, full((RGB.shape[0], 1), settings.face_alpha[i])]) - ) + RGB_cf.extend(np.hstack([RGB, full((RGB.shape[0], 1), settings.face_alpha[i])])) if settings.edge_colours[i] is not None: RGB = ones(RGB.shape) * settings.edge_colours[i] - RGB_ce.extend( - np.hstack([RGB, full((RGB.shape[0], 1), settings.edge_alpha[i])]) - ) + RGB_ce.extend(np.hstack([RGB, full((RGB.shape[0], 1), settings.edge_alpha[i])])) quads = as_float_array(quads_c) RGB_f = as_float_array(RGB_cf) @@ -661,9 +645,7 @@ def plot_RGB_colourspaces_gamuts( axes.add_collection3d(collection) - settings.update( - {"axes": axes, "axes_visible": False, "camera_aspect": "equal"} - ) + settings.update({"axes": axes, "axes_visible": False, "camera_aspect": "equal"}) settings.update(kwargs) return cast(Tuple[Figure, Axes3D], render(**settings)) @@ -672,25 +654,25 @@ def plot_RGB_colourspaces_gamuts( @override_style() def plot_RGB_scatter( RGB: ArrayLike, - colourspace: RGB_Colourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] = "sRGB", + colourspace: ( + RGB_Colourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + ) = "sRGB", model: LiteralColourspaceModel | str = "CIE xyY", - colourspaces: RGB_Colourspace - | str - | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] - | None = None, + colourspaces: ( + RGB_Colourspace + | str + | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] + | None + ) = None, segments: int = 8, show_grid: bool = True, grid_segments: int = 10, show_spectral_locus: bool = False, spectral_locus_colour: ArrayLike | str | None = None, points_size: float = 12, - cmfs: MultiSpectralDistributions - | str - | Sequence[ - MultiSpectralDistributions | str - ] = "CIE 1931 2 Degree Standard Observer", + cmfs: ( + MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] + ) = "CIE 1931 2 Degree Standard Observer", chromatically_adapt: bool = False, convert_kwargs: dict | None = None, **kwargs: Any, @@ -758,6 +740,8 @@ def plot_RGB_scatter( :alt: plot_RGB_scatter """ + RGB = np.reshape(as_float_array(RGB)[..., :3], (-1, 3)) + colourspace = cast( RGB_Colourspace, first_item(filter_RGB_colourspaces(colourspace).values()), diff --git a/colour/quality/cfi2017.py b/colour/quality/cfi2017.py index 60c47dbcdc..ab078ec498 100644 --- a/colour/quality/cfi2017.py +++ b/colour/quality/cfi2017.py @@ -2,7 +2,7 @@ CIE 2017 Colour Fidelity Index ============================== -Defines the *CIE 2017 Colour Fidelity Index* (CFI) computation objects: +Define the *CIE 2017 Colour Fidelity Index* (CFI) computation objects: - :class:`colour.quality.ColourRendering_Specification_CIE2017` - :func:`colour.quality.colour_fidelity_index_CIE2017` @@ -79,9 +79,7 @@ standard. """ -ROOT_RESOURCES_CIE2017: str = os.path.join( - os.path.dirname(__file__), "datasets" -) +ROOT_RESOURCES_CIE2017: str = os.path.join(os.path.dirname(__file__), "datasets") """*CIE 2017 Colour Fidelity Index* resources directory.""" _CACHE_TCS_CIE2017: dict = CACHE_REGISTRY.register_cache( @@ -132,9 +130,7 @@ class ColourRendering_Specification_CIE2017: R_s: NDArrayFloat CCT: float D_uv: float - colorimetry_data: Tuple[ - DataColorimetry_TCS_CIE2017, DataColorimetry_TCS_CIE2017 - ] + colorimetry_data: Tuple[DataColorimetry_TCS_CIE2017, DataColorimetry_TCS_CIE2017] delta_E_s: NDArrayFloat @@ -322,14 +318,10 @@ def CCT_reference_illuminant(sd: SpectralDistribution) -> NDArrayFloat: # NOTE: Use "CFI2017" and "TM30" recommended temperature range of 1,000K to # 25,000K for performance. - return uv_to_CCT_Ohno2013( - UCS_to_uv(XYZ_to_UCS(XYZ)), start=1000, end=25000 - ) + return uv_to_CCT_Ohno2013(UCS_to_uv(XYZ_to_UCS(XYZ)), start=1000, end=25000) -def sd_reference_illuminant( - CCT: float, shape: SpectralShape -) -> SpectralDistribution: +def sd_reference_illuminant(CCT: float, shape: SpectralShape) -> SpectralDistribution: """ Compute the reference illuminant for a given correlated colour temperature :math:`T_{cp}` for use in *CIE 2017 Colour Fidelity Index* (CFI) @@ -355,7 +347,6 @@ def sd_reference_illuminant( ... sd_reference_illuminant( # doctest: +ELLIPSIS ... 4224.469705295263300, SpectralShape(380, 780, 20) ... ) - ... SpectralDistribution([[ 380. , 0.0034089...], [ 400. , 0.0044208...], [ 420. , 0.0053260...], @@ -398,9 +389,9 @@ def sd_reference_illuminant( sd_planckian /= sd_to_XYZ( sd_planckian.values, shape=shape, method="Integration" )[1] - sd_daylight /= sd_to_XYZ( - sd_daylight.values, shape=shape, method="Integration" - )[1] + sd_daylight /= sd_to_XYZ(sd_daylight.values, shape=shape, method="Integration")[ + 1 + ] # Mixture: 4200K should be 80% Planckian, 20% CIE Illuminant D Series. m = (CCT - 4000) / 1000 @@ -410,9 +401,7 @@ def sd_reference_illuminant( f"Blackbody & CIE Illuminant D Series Mixture - " f"{as_float_scalar(100 * m):.1f}%" ) - sd_reference = SpectralDistribution( - values, shape.wavelengths, name=name - ) + sd_reference = SpectralDistribution(values, shape.wavelengths, name=name) elif CCT > 5000: sd_reference = sd_daylight @@ -432,7 +421,7 @@ def tcs_colorimetry_data( Parameters ---------- sd_irradiance - Test light source or reference illuminant spectral distribution, i.e. + Test light source or reference illuminant spectral distribution, i.e., the irradiance emitter. sds_tcs *Test colour samples* spectral reflectance distributions. @@ -447,8 +436,15 @@ def tcs_colorimetry_data( Examples -------- - >>> delta_E_to_R_f(4.4410383190) # doctest: +ELLIPSIS - 70.1208254... + >>> from colour.colorimetry import SDS_ILLUMINANTS + >>> sd = SDS_ILLUMINANTS["FL2"] + >>> shape = SpectralShape(380, 780, 5) + >>> cmfs = MSDS_CMFS["CIE 1964 10 Degree Standard Observer"].copy().align(shape) + >>> test_tcs_colorimetry_data = tcs_colorimetry_data( + ... sd, load_TCS_CIE2017(shape), cmfs + ... ) + >>> len(test_tcs_colorimetry_data) + 1 """ if isinstance(sd_irradiance, SpectralDistribution): @@ -471,12 +467,11 @@ def tcs_colorimetry_data( L_A = 100 surround = VIEWING_CONDITIONS_CIECAM02["Average"] - sds_tcs_t = np.tile( - np.transpose(sds_tcs.values), (len(sd_irradiance), 1, 1) + sds_tcs_t = np.tile(np.transpose(sds_tcs.values), (len(sd_irradiance), 1, 1)) + sds_tcs_t = sds_tcs_t * np.reshape( + as_float_array([sd.values for sd in sd_irradiance]), + (len(sd_irradiance), 1, len(sd_irradiance[0])), ) - sds_tcs_t = sds_tcs_t * as_float_array( - [sd.values for sd in sd_irradiance] - ).reshape(len(sd_irradiance), 1, len(sd_irradiance[0])) XYZ = msds_to_XYZ( sds_tcs_t, @@ -486,7 +481,7 @@ def tcs_colorimetry_data( ) specification = XYZ_to_CIECAM02( XYZ, - XYZ_w.reshape((len(sd_irradiance), 1, 3)), + np.reshape(XYZ_w, (len(sd_irradiance), 1, 3)), L_A, Y_b, surround, diff --git a/colour/quality/cqs.py b/colour/quality/cqs.py index dd6b5710d1..0c1177d217 100644 --- a/colour/quality/cqs.py +++ b/colour/quality/cqs.py @@ -2,7 +2,7 @@ Colour Quality Scale ==================== -Defines the *Colour Quality Scale* (CQS) computation objects: +Define the *Colour Quality Scale* (CQS) computation objects: - :class:`colour.quality.ColourRendering_Specification_CQS` - :func:`colour.colour_quality_scale` @@ -49,8 +49,8 @@ Tuple, cast, ) +from colour.models import Lab_to_LCHab # pyright: ignore from colour.models import ( - Lab_to_LCHab, UCS_to_uv, XYZ_to_Lab, XYZ_to_UCS, @@ -231,8 +231,7 @@ def colour_quality_scale( shape = cmfs.shape sd_test = reshape_sd(sd_test, shape, copy=False) vs_sds = { - sd.name: reshape_sd(sd, shape, copy=False) - for sd in SDS_VS[method].values() + sd.name: reshape_sd(sd, shape, copy=False) for sd in SDS_VS[method].values() } with domain_range_scale("1"): @@ -282,12 +281,8 @@ def colour_quality_scale( Q_f = scale_conversion(D_E_RMS, CCT_f, scaling_f) - G_t = gamut_area( - [vs_CQS_data.Lab for vs_CQS_data in test_vs_colorimetry_data] - ) - G_r = gamut_area( - [vs_CQS_data.Lab for vs_CQS_data in reference_vs_colorimetry_data] - ) + G_t = gamut_area([vs_CQS_data.Lab for vs_CQS_data in test_vs_colorimetry_data]) + G_r = gamut_area([vs_CQS_data.Lab for vs_CQS_data in reference_vs_colorimetry_data]) Q_g = G_t / GAMUT_AREA_D65 * 100 @@ -524,10 +519,7 @@ def delta_E_RMS( 1 / len(CQS_data) * np.sum( - [ - getattr(sample_data, attribute) ** 2 - for sample_data in CQS_data.values() - ] + [getattr(sample_data, attribute) ** 2 for sample_data in CQS_data.values()] ) ) @@ -565,9 +557,7 @@ def colour_quality_scales( D_E_ab = cast( float, euclidean_distance(test_data[i].Lab, reference_data[i].Lab) ) - D_Ep_ab = cast( - float, np.sqrt(D_E_ab**2 - D_C_ab**2) if D_C_ab > 0 else D_E_ab - ) + D_Ep_ab = cast(float, np.sqrt(D_E_ab**2 - D_C_ab**2) if D_C_ab > 0 else D_E_ab) Q_a = scale_conversion(D_Ep_ab, CCT_f, scaling_f) Q_as[i + 1] = DataColourQualityScale_VS( diff --git a/colour/quality/cri.py b/colour/quality/cri.py index b12f1904b2..f732a0c6b1 100644 --- a/colour/quality/cri.py +++ b/colour/quality/cri.py @@ -2,7 +2,7 @@ Colour Rendering Index ====================== -Defines the *Colour Rendering Index* (CRI) computation objects: +Define the *Colour Rendering Index* (CRI) computation objects: - :class:`colour.quality.ColourRendering_Specification_CRI` - :func:`colour.colour_rendering_index` @@ -145,9 +145,7 @@ def colour_rendering_index( shape = cmfs.shape sd_test = reshape_sd(sd_test, shape, copy=False) - tcs_sds = { - sd.name: reshape_sd(sd, shape, copy=False) for sd in SDS_TCS.values() - } + tcs_sds = {sd.name: reshape_sd(sd, shape, copy=False) for sd in SDS_TCS.values()} with domain_range_scale("1"): XYZ = sd_to_XYZ(sd_test, cmfs) @@ -176,9 +174,7 @@ def colour_rendering_index( Q_a = cast( float, - np.average( - [v.Q_a for k, v in Q_as.items() if k in (1, 2, 3, 4, 5, 6, 7, 8)] - ), + np.average([v.Q_a for k, v in Q_as.items() if k in (1, 2, 3, 4, 5, 6, 7, 8)]), ) if additional_data: @@ -259,9 +255,9 @@ def d(x: NDArrayFloat, y: NDArrayFloat) -> NDArrayFloat: c_r_c_t = sdiv(c_r, c_t) d_r_d_t = sdiv(d_r, d_t) - u_tcs = ( - 10.872 + 0.404 * c_r_c_t * tcs_c - 4 * d_r_d_t * tcs_d - ) / (16.518 + 1.481 * c_r_c_t * tcs_c - d_r_d_t * tcs_d) + u_tcs = (10.872 + 0.404 * c_r_c_t * tcs_c - 4 * d_r_d_t * tcs_d) / ( + 16.518 + 1.481 * c_r_c_t * tcs_c - d_r_d_t * tcs_d + ) v_tcs = 5.52 / (16.518 + 1.481 * c_r_c_t * tcs_c - d_r_d_t * tcs_d) W_tcs = 25 * spow(xyY_tcs[-1], 1 / 3) - 17 diff --git a/colour/quality/datasets/tcs.py b/colour/quality/datasets/tcs.py index 3842b0366a..e0f2e9fbf3 100644 --- a/colour/quality/datasets/tcs.py +++ b/colour/quality/datasets/tcs.py @@ -2,7 +2,7 @@ Test Colour Samples Spectral Distributions ========================================== -Defines the *CIE 1995* test colour samples spectral distributions. +Define the *CIE 1995* test colour samples spectral distributions. The *CIE 1995* test colour samples data is in the form of a *dict* of :class:`colour.SpectralDistribution` classes as follows:: @@ -1436,10 +1436,7 @@ } SDS_TCS: CanonicalMapping = CanonicalMapping( - { - key: SpectralDistribution(value, name=key) - for key, value in DATA_TCS.items() - } + {key: SpectralDistribution(value, name=key) for key, value in DATA_TCS.items()} ) """ Test colour samples spectral distributions. diff --git a/colour/quality/datasets/vs.py b/colour/quality/datasets/vs.py index c85faad27f..09b0eb6cdc 100644 --- a/colour/quality/datasets/vs.py +++ b/colour/quality/datasets/vs.py @@ -2,7 +2,7 @@ NIST CQS Test Colour Samples Spectral Distributions =================================================== -Defines the *NIST CQS (Color Quality Scale)* test colour samples spectral +Define the *NIST CQS (Color Quality Scale)* test colour samples spectral distributions. The *NIST CQS* test colour samples data is in the form of a *dict* of @@ -67,49 +67,45 @@ } """*NIST CQS* test colour samples indexes to names mapping.""" -APPROXIMATE_MUNSELL_NOTATIONS_VS_NISTCQS74: CanonicalMapping = ( - CanonicalMapping( - { - "VS1": "7.5P 4/10", - "VS2": "10PB 4/10", - "VS3": "5PB 4/2", - "VS4": "7.5B 5/10", - "VS5": "10B G6/8", - "VS6": "2.5BG 6/10", - "VS7": "2.5G 6/12", - "VS8": "7.5GY 7/10", - "VS9": "2.5GY 8/10", - "VS10": "5Y 8.5/12", - "VS11": "10YR 7/12", - "VS12": "5YR 7/12", - "VS13": "10R 6/12", - "VS14": "5R 4/14", - "VS15": "7.5RP 4/12", - } - ) +APPROXIMATE_MUNSELL_NOTATIONS_VS_NISTCQS74: CanonicalMapping = CanonicalMapping( + { + "VS1": "7.5P 4/10", + "VS2": "10PB 4/10", + "VS3": "5PB 4/2", + "VS4": "7.5B 5/10", + "VS5": "10B G6/8", + "VS6": "2.5BG 6/10", + "VS7": "2.5G 6/12", + "VS8": "7.5GY 7/10", + "VS9": "2.5GY 8/10", + "VS10": "5Y 8.5/12", + "VS11": "10YR 7/12", + "VS12": "5YR 7/12", + "VS13": "10R 6/12", + "VS14": "5R 4/14", + "VS15": "7.5RP 4/12", + } ) """*NIST CQS 7.4* test colour samples *Munsell* colour approximations.""" -APPROXIMATE_MUNSELL_NOTATIONS_VS_NISTCQS90: CanonicalMapping = ( - CanonicalMapping( - { - "VS1": "5R 4/14", - "VS2": "10R 6/12", - "VS3": "7.5YR 7/12", - "VS4": "5Y 8-12", - "VS5": "2.5GY 8/10", - "VS6": "7.5GY 7/10", - "VS7": "2.5G 6/12", - "VS8": "2.5BG 6/10", - "VS9": "10BG 6/8", - "VS10": "7.5B 5/10", - "VS11": "2.5PB 4/10", - "VS12": "7.5PB 4/12", - "VS13": "5P 5/10", - "VS14": "2.5RP 6/12", - "VS15": "7.5RP 5/12", - } - ) +APPROXIMATE_MUNSELL_NOTATIONS_VS_NISTCQS90: CanonicalMapping = CanonicalMapping( + { + "VS1": "5R 4/14", + "VS2": "10R 6/12", + "VS3": "7.5YR 7/12", + "VS4": "5Y 8-12", + "VS5": "2.5GY 8/10", + "VS6": "7.5GY 7/10", + "VS7": "2.5G 6/12", + "VS8": "2.5BG 6/10", + "VS9": "10BG 6/8", + "VS10": "7.5B 5/10", + "VS11": "2.5PB 4/10", + "VS12": "7.5PB 4/12", + "VS13": "5P 5/10", + "VS14": "2.5RP 6/12", + "VS15": "7.5RP 5/12", + } ) """*NIST CQS 9.0* test colour samples *Munsell* colour approximations.""" @@ -2973,8 +2969,7 @@ SDS_VS: CanonicalMapping = CanonicalMapping( { key: { - name: SpectralDistribution(data, name=name) - for name, data in value.items() + name: SpectralDistribution(data, name=name) for name, data in value.items() } for key, value in DATA_VS.items() } diff --git a/colour/quality/ssi.py b/colour/quality/ssi.py index 6974452af5..1a9b8f3edd 100644 --- a/colour/quality/ssi.py +++ b/colour/quality/ssi.py @@ -2,7 +2,7 @@ Academy Spectral Similarity Index (SSI) ======================================= -Defines the *Academy Spectral Similarity Index* (SSI) computation objects: +Define the *Academy Spectral Similarity Index* (SSI) computation objects: - :func:`colour.spectral_similarity_index` @@ -101,9 +101,7 @@ def spectral_similarity_index( "extrapolator_kwargs": {"left": 0, "right": 0}, } - sd_test = reshape_sd( - sd_test, SPECTRAL_SHAPE_SSI, "Align", copy=False, **settings - ) + sd_test = reshape_sd(sd_test, SPECTRAL_SHAPE_SSI, "Align", copy=False, **settings) sd_reference = reshape_sd( sd_reference, SPECTRAL_SHAPE_SSI, "Align", copy=False, **settings ) diff --git a/colour/quality/tests/test_cfi2017.py b/colour/quality/tests/test_cfi2017.py index 8f3fa9e9f2..187638990e 100644 --- a/colour/quality/tests/test_cfi2017.py +++ b/colour/quality/tests/test_cfi2017.py @@ -9,9 +9,8 @@ from __future__ import annotations -import unittest - import numpy as np +import pytest from colour.colorimetry import ( SDS_ILLUMINANTS, @@ -131,6 +130,16 @@ SD_SAMPLE_5NM: SpectralDistribution = SpectralDistribution(DATA_SD_SAMPLE_5NM) DATA_SD_SAMPLE_1NM: dict = { + 370: 0.000, + 371: 0.000, + 372: 0.000, + 373: 0.000, + 374: 0.000, + 375: 0.000, + 376: 0.000, + 377: 0.000, + 378: 0.000, + 379: 0.000, 380: 0.000, 381: 0.000, 382: 0.000, @@ -537,7 +546,7 @@ SD_SAMPLE_1NM: SpectralDistribution = SpectralDistribution(DATA_SD_SAMPLE_1NM) -class TestColourFidelityIndexCIE2017(unittest.TestCase): +class TestColourFidelityIndexCIE2017: """ Define :func:`colour.quality.CIE2017.colour_fidelity_index_CIE2017` definition unit tests methods. @@ -550,9 +559,7 @@ def test_colour_fidelity_index_CIE2017(self): """ for sd in [SD_SAMPLE_5NM, SD_SAMPLE_1NM]: - specification = colour_fidelity_index_CIE2017( - sd, additional_data=True - ) + specification = colour_fidelity_index_CIE2017(sd, additional_data=True) np.testing.assert_allclose(specification.R_f, 81.6, atol=0.1) np.testing.assert_allclose( specification.R_s, @@ -887,13 +894,13 @@ def test_raise_exception_colour_fidelity_index_CFI2017(self): """ sd = reshape_sd(SDS_ILLUMINANTS["FL2"], SpectralShape(400, 700, 5)) - self.assertWarns(ColourUsageWarning, colour_fidelity_index_CIE2017, sd) + pytest.warns(ColourUsageWarning, colour_fidelity_index_CIE2017, sd) sd = reshape_sd(SDS_ILLUMINANTS["FL2"], SpectralShape(380, 780, 10)) - self.assertRaises(ValueError, colour_fidelity_index_CIE2017, sd) + pytest.raises(ValueError, colour_fidelity_index_CIE2017, sd) -class TestCctReferenceIlluminant(unittest.TestCase): +class TestCctReferenceIlluminant: """ Define :func:`colour.quality.CIE2017.CCT_reference_illuminant` definition unit tests methods. @@ -911,7 +918,7 @@ def test_CCT_reference_illuminant(self): np.testing.assert_allclose(D_uv, -0.000300000000000, atol=0.0005) -class TestSdReferenceIlluminant(unittest.TestCase): +class TestSdReferenceIlluminant: """ Define :func:`colour.quality.CIE2017.sd_reference_illuminant` definition unit tests methods. @@ -935,7 +942,3 @@ def test_sd_reference_illuminant(self): sd_blackbody(3288, shape).values, atol=1.75, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/quality/tests/test_cqs.py b/colour/quality/tests/test_cqs.py index 8476d6ffd7..166a189f15 100644 --- a/colour/quality/tests/test_cqs.py +++ b/colour/quality/tests/test_cqs.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.quality.cqs` module.""" -import unittest import numpy as np @@ -25,7 +23,7 @@ ] -class TestColourQualityScale(unittest.TestCase): +class TestColourQualityScale: """ Define :func:`colour.quality.cqs.colour_quality_scale` definition unit tests methods. @@ -41,9 +39,7 @@ def test_colour_quality_scale(self): ) np.testing.assert_allclose( - colour_quality_scale( - SDS_ILLUMINANTS["FL1"], method="NIST CQS 7.4" - ), + colour_quality_scale(SDS_ILLUMINANTS["FL1"], method="NIST CQS 7.4"), 75.377089740493361, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -55,9 +51,7 @@ def test_colour_quality_scale(self): ) np.testing.assert_allclose( - colour_quality_scale( - SDS_ILLUMINANTS["FL2"], method="NIST CQS 7.4" - ), + colour_quality_scale(SDS_ILLUMINANTS["FL2"], method="NIST CQS 7.4"), 64.774586908581369, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -78,9 +72,7 @@ def test_colour_quality_scale(self): ) np.testing.assert_allclose( - colour_quality_scale( - SDS_LIGHT_SOURCES["F32T8/TL841 (Triphosphor)"] - ), + colour_quality_scale(SDS_LIGHT_SOURCES["F32T8/TL841 (Triphosphor)"]), 84.934928463428903, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -237,9 +229,7 @@ def test_colour_quality_scale(self): DataColorimetry_VS( name="VS5", XYZ=np.array([0.18662999, 0.24708620, 0.40043676]), - Lab=np.array( - [56.79040832, -23.15964295, -18.30798276] - ), + Lab=np.array([56.79040832, -23.15964295, -18.30798276]), C=29.522047597875542, ), DataColorimetry_VS( @@ -325,17 +315,13 @@ def test_colour_quality_scale(self): DataColorimetry_VS( name="VS4", XYZ=np.array([0.13144454, 0.16803553, 0.39315864]), - Lab=np.array( - [48.01155296, -17.36604069, -32.56734417] - ), + Lab=np.array([48.01155296, -17.36604069, -32.56734417]), C=36.908146466038922, ), DataColorimetry_VS( name="VS5", XYZ=np.array([0.18145723, 0.25845953, 0.41319313]), - Lab=np.array( - [57.89053983, -30.61152779, -17.92233237] - ), + Lab=np.array([57.89053983, -30.61152779, -17.92233237]), C=35.472181086008781, ), DataColorimetry_VS( @@ -407,14 +393,8 @@ def test_colour_quality_scale(self): ) np.testing.assert_allclose( - [ - data.Q_a - for _index, data in sorted(specification_r.Q_as.items()) - ], - [ - data.Q_a - for _index, data in sorted(specification_t.Q_as.items()) - ], + [data.Q_a for _index, data in sorted(specification_r.Q_as.items())], + [data.Q_a for _index, data in sorted(specification_t.Q_as.items())], atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -585,9 +565,7 @@ def test_colour_quality_scale(self): DataColorimetry_VS( name="VS9", XYZ=np.array([0.18662998, 0.24708620, 0.40043672]), - Lab=np.array( - [56.79040828, -23.15964795, -18.30797717] - ), + Lab=np.array([56.79040828, -23.15964795, -18.30797717]), C=29.522048055967336, ), DataColorimetry_VS( @@ -679,17 +657,13 @@ def test_colour_quality_scale(self): DataColorimetry_VS( name="VS9", XYZ=np.array([0.18145720, 0.25845953, 0.41319296]), - Lab=np.array( - [57.89053974, -30.61154597, -17.92231311] - ), + Lab=np.array([57.89053974, -30.61154597, -17.92231311]), C=35.472187042106164, ), DataColorimetry_VS( name="VS10", XYZ=np.array([0.13144449, 0.16803553, 0.39315843]), - Lab=np.array( - [48.01155280, -17.36606803, -32.56732004] - ), + Lab=np.array([48.01155280, -17.36606803, -32.56732004]), C=36.908138035180549, ), DataColorimetry_VS( @@ -731,17 +705,7 @@ def test_colour_quality_scale(self): ) np.testing.assert_allclose( - [ - data.Q_a - for _index, data in sorted(specification_r.Q_as.items()) - ], - [ - data.Q_a - for _index, data in sorted(specification_t.Q_as.items()) - ], + [data.Q_a for _index, data in sorted(specification_r.Q_as.items())], + [data.Q_a for _index, data in sorted(specification_t.Q_as.items())], atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/quality/tests/test_cri.py b/colour/quality/tests/test_cri.py index 66526a4f56..695962e84a 100644 --- a/colour/quality/tests/test_cri.py +++ b/colour/quality/tests/test_cri.py @@ -1,10 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.quality.cri` module.""" from __future__ import annotations -import unittest - import numpy as np from colour.colorimetry import SDS_ILLUMINANTS, SpectralDistribution @@ -111,7 +108,7 @@ } -class TestColourRenderingIndex(unittest.TestCase): +class TestColourRenderingIndex: """ Define :func:`colour.quality.cri.colour_rendering_index` definition unit tests methods. @@ -148,48 +145,20 @@ def test_colour_rendering_index(self): name="FL1", Q_a=75.852827992149358, Q_as={ - 1: DataColourQualityScale_TCS( - name="TCS01", Q_a=69.196992839933557 - ), - 2: DataColourQualityScale_TCS( - name="TCS02", Q_a=83.650754065677816 - ), - 3: DataColourQualityScale_TCS( - name="TCS03", Q_a=92.136090764490675 - ), - 4: DataColourQualityScale_TCS( - name="TCS04", Q_a=72.665649420972784 - ), - 5: DataColourQualityScale_TCS( - name="TCS05", Q_a=73.890734513517486 - ), - 6: DataColourQualityScale_TCS( - name="TCS06", Q_a=79.619188860052745 - ), - 7: DataColourQualityScale_TCS( - name="TCS07", Q_a=82.272569853644669 - ), - 8: DataColourQualityScale_TCS( - name="TCS08", Q_a=53.390643618905109 - ), - 9: DataColourQualityScale_TCS( - name="TCS09", Q_a=-47.284477750225903 - ), - 10: DataColourQualityScale_TCS( - name="TCS10", Q_a=61.568336431199967 - ), - 11: DataColourQualityScale_TCS( - name="TCS11", Q_a=67.522241168172485 - ), - 12: DataColourQualityScale_TCS( - name="TCS12", Q_a=74.890093866757994 - ), - 13: DataColourQualityScale_TCS( - name="TCS13", Q_a=72.771930354944615 - ), - 14: DataColourQualityScale_TCS( - name="TCS14", Q_a=94.884867470552663 - ), + 1: DataColourQualityScale_TCS(name="TCS01", Q_a=69.196992839933557), + 2: DataColourQualityScale_TCS(name="TCS02", Q_a=83.650754065677816), + 3: DataColourQualityScale_TCS(name="TCS03", Q_a=92.136090764490675), + 4: DataColourQualityScale_TCS(name="TCS04", Q_a=72.665649420972784), + 5: DataColourQualityScale_TCS(name="TCS05", Q_a=73.890734513517486), + 6: DataColourQualityScale_TCS(name="TCS06", Q_a=79.619188860052745), + 7: DataColourQualityScale_TCS(name="TCS07", Q_a=82.272569853644669), + 8: DataColourQualityScale_TCS(name="TCS08", Q_a=53.390643618905109), + 9: DataColourQualityScale_TCS(name="TCS09", Q_a=-47.284477750225903), + 10: DataColourQualityScale_TCS(name="TCS10", Q_a=61.568336431199967), + 11: DataColourQualityScale_TCS(name="TCS11", Q_a=67.522241168172485), + 12: DataColourQualityScale_TCS(name="TCS12", Q_a=74.890093866757994), + 13: DataColourQualityScale_TCS(name="TCS13", Q_a=72.771930354944615), + 14: DataColourQualityScale_TCS(name="TCS14", Q_a=94.884867470552663), }, colorimetry_data=( [ @@ -227,9 +196,7 @@ def test_colour_rendering_index(self): name="TCS06", XYZ=np.array([27.43598853, 28.84467787, 55.15209308]), uv=np.array([0.17543246, 0.27665994]), - UVW=np.array( - [-14.91500194, -30.51166823, 59.67054901] - ), + UVW=np.array([-14.91500194, -30.51166823, 59.67054901]), ), DataColorimetry_TCS( name="TCS07", @@ -265,9 +232,7 @@ def test_colour_rendering_index(self): name="TCS12", XYZ=np.array([5.77964943, 5.69096075, 24.73530409]), uv=np.array([0.13981616, 0.20650602]), - UVW=np.array( - [-19.30689974, -39.58762581, 27.63428055] - ), + UVW=np.array([-19.30689974, -39.58762581, 27.63428055]), ), DataColorimetry_TCS( name="TCS13", @@ -317,9 +282,7 @@ def test_colour_rendering_index(self): name="TCS06", XYZ=np.array([28.14601546, 29.75632189, 57.16886797]), uv=np.array([0.17427942, 0.27637560]), - UVW=np.array( - [-18.85053083, -28.64005452, 60.46991712] - ), + UVW=np.array([-18.85053083, -28.64005452, 60.46991712]), ), DataColorimetry_TCS( name="TCS07", @@ -355,9 +318,7 @@ def test_colour_rendering_index(self): name="TCS12", XYZ=np.array([6.18799870, 6.41132549, 27.28158667]), uv=np.array([0.13437372, 0.20883497]), - UVW=np.array( - [-24.45285903, -39.79705961, 29.44325151] - ), + UVW=np.array([-24.45285903, -39.79705961, 29.44325151]), ), DataColorimetry_TCS( name="TCS13", @@ -380,17 +341,7 @@ def test_colour_rendering_index(self): ) np.testing.assert_allclose( - [ - data.Q_a - for _index, data in sorted(specification_r.Q_as.items()) - ], - [ - data.Q_a - for _index, data in sorted(specification_t.Q_as.items()) - ], + [data.Q_a for _index, data in sorted(specification_r.Q_as.items())], + [data.Q_a for _index, data in sorted(specification_t.Q_as.items())], atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/quality/tests/test_ssi.py b/colour/quality/tests/test_ssi.py index b266fdcb81..415a0ad122 100644 --- a/colour/quality/tests/test_ssi.py +++ b/colour/quality/tests/test_ssi.py @@ -1,10 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.quality.ssi` module.""" from __future__ import annotations -import unittest - import numpy as np from colour.colorimetry import SDS_ILLUMINANTS, SpectralDistribution @@ -556,7 +553,7 @@ } -class TestSpectralSimilarityIndex(unittest.TestCase): +class TestSpectralSimilarityIndex: """ Define :func:`colour.quality.ssi.spectral_similarity_index` definition unit tests methods. @@ -565,17 +562,15 @@ class TestSpectralSimilarityIndex(unittest.TestCase): def test_spectral_similarity_index(self): """Test :func:`colour.quality.ssi.spectral_similarity_index` definition.""" - self.assertEqual( - spectral_similarity_index( - SDS_ILLUMINANTS["C"], SDS_ILLUMINANTS["D65"] - ), - 94.0, + assert ( + spectral_similarity_index(SDS_ILLUMINANTS["C"], SDS_ILLUMINANTS["D65"]) + == 94.0 ) - self.assertEqual( + assert ( spectral_similarity_index( SpectralDistribution(DATA_HMI), SDS_ILLUMINANTS["D50"] - ), - 72.0, + ) + == 72.0 ) def test_spectral_similarity_rounding(self): @@ -603,7 +598,3 @@ def test_spectral_similarity_rounding(self): 71.775, atol=0.01, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/quality/tests/test_tm3018.py b/colour/quality/tests/test_tm3018.py index 11b3510654..2242ce5ad7 100644 --- a/colour/quality/tests/test_tm3018.py +++ b/colour/quality/tests/test_tm3018.py @@ -8,7 +8,6 @@ http://media.ies.org/docs/errata/TM-30-18_tools_etc.zip. """ -import unittest import numpy as np @@ -32,7 +31,7 @@ ] -class TestColourFidelityIndexANSIIESTM3018(unittest.TestCase): +class TestColourFidelityIndexANSIIESTM3018: """ Define :func:`colour.quality.tm3018.colour_fidelity_index_ANSIIESTM3018` definition unit tests methods. @@ -193,7 +192,7 @@ def test_colour_fidelity_index_ANSIIESTM3018(self): ) -class TestAveragesArea(unittest.TestCase): +class TestAveragesArea: """ Define :func:`colour.quality.tm3018.averages_area` definition unit tests methods. @@ -209,7 +208,3 @@ def test_averages_area(self): # Concave polygon. poly = np.array([[1.0, -1], [1, 1], [3, 1], [3, 3], [-1, 3], [-1, -1]]) np.allclose(averages_area(poly), 12) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/quality/tm3018.py b/colour/quality/tm3018.py index b61f4fa098..5bb2de7e82 100644 --- a/colour/quality/tm3018.py +++ b/colour/quality/tm3018.py @@ -2,7 +2,7 @@ ANSI/IES TM-30-18 Colour Fidelity Index ======================================= -Defines the *ANSI/IES TM-30-18 Colour Fidelity Index* (CFI) computation +Define the *ANSI/IES TM-30-18 Colour Fidelity Index* (CFI) computation objects: - :class:`colour.quality.ColourQuality_Specification_ANSIIESTM3018` @@ -85,9 +85,7 @@ class ColourQuality_Specification_ANSIIESTM3018: R_s: NDArrayFloat CCT: float D_uv: float - colorimetry_data: Tuple[ - DataColorimetry_TCS_CIE2017, DataColorimetry_TCS_CIE2017 - ] + colorimetry_data: Tuple[DataColorimetry_TCS_CIE2017, DataColorimetry_TCS_CIE2017] R_g: float bins: NDArrayInt averages_test: NDArrayFloat @@ -143,11 +141,9 @@ def colour_fidelity_index_ANSIIESTM3018( ) # Setup bins based on where the reference a'b' points are located. - bins = as_int_array( - np.floor(specification.colorimetry_data[1].JMh[:, 2] / 22.5) - ) + bins = as_int_array(np.floor(specification.colorimetry_data[1].JMh[:, 2] / 22.5)) - bin_mask = bins == np.arange(16).reshape([-1, 1]) + bin_mask = bins == np.reshape(np.arange(16), (-1, 1)) # "bin_mask" is used later with Numpy broadcasting and "np.nanmean" # to skip a list comprehension and keep all the mean calculation vectorised @@ -166,27 +162,25 @@ def colour_fidelity_index_ANSIIESTM3018( # axis argument. averages_test = np.transpose( np.nanmean( - np.transpose(bin_mask).reshape((99, 1, 16)) - * test_apbp.reshape((*ref_apbp.shape, 1)), + np.reshape(np.transpose(bin_mask), (99, 1, 16)) + * np.reshape(test_apbp, (*ref_apbp.shape, 1)), axis=0, ) ) averages_reference = np.transpose( np.nanmean( - np.transpose(bin_mask).reshape((99, 1, 16)) - * ref_apbp.reshape((*ref_apbp.shape, 1)), + np.reshape(np.transpose(bin_mask), (99, 1, 16)) + * np.reshape(ref_apbp, (*ref_apbp.shape, 1)), axis=0, ) ) # Gamut Index. - R_g = 100 * ( - averages_area(averages_test) / averages_area(averages_reference) - ) + R_g = 100 * (averages_area(averages_test) / averages_area(averages_reference)) - # Local colour fidelity indexes, i.e. 16 CFIs for each bin. + # Local colour fidelity indexes, i.e., 16 CFIs for each bin. bin_delta_E_s = np.nanmean( - specification.delta_E_s.reshape([1, -1]) * bin_mask, axis=1 + np.reshape(specification.delta_E_s, (1, -1)) * bin_mask, axis=1 ) R_fs = as_float_array(delta_E_to_R_f(bin_delta_E_s)) diff --git a/colour/recovery/__init__.py b/colour/recovery/__init__.py index 6527468d89..26c68bd9a6 100644 --- a/colour/recovery/__init__.py +++ b/colour/recovery/__init__.py @@ -20,12 +20,9 @@ from __future__ import annotations -import sys from colour.colorimetry import SpectralDistribution from colour.hints import Any, ArrayLike, Literal -from colour.utilities.deprecation import ModuleAPI, build_API_changes -from colour.utilities.documentation import is_documentation_building from colour.utilities import ( CanonicalMapping, as_float_array, @@ -104,10 +101,16 @@ def XYZ_to_sd( XYZ: ArrayLike, - method: Literal[ - "Jakob 2019", "Mallett 2019", "Meng 2015", "Otsu 2018", "Smits 1999" - ] - | str = "Meng 2015", + method: ( + Literal[ + "Jakob 2019", + "Mallett 2019", + "Meng 2015", + "Otsu 2018", + "Smits 1999", + ] + | str + ) = "Meng 2015", **kwargs: Any, ) -> SpectralDistribution: """ @@ -130,7 +133,7 @@ def XYZ_to_sd( basis_functions {:func:`colour.recovery.RGB_to_sd_Mallett2019`}, Basis functions for the method. The default is to use the built-in - *sRGB* basis functions, i.e. + *sRGB* basis functions, i.e., :attr:`colour.recovery.MSDS_BASIS_FUNCTIONS_sRGB_MALLETT2019`. clip {:func:`colour.recovery.XYZ_to_sd_Otsu2018`}, @@ -189,7 +192,7 @@ def XYZ_to_sd( Examples -------- - *Jakob and Hanika (2009)* reflectance recovery: + *Jakob and Hanika (2019)* reflectance recovery: >>> import numpy as np >>> from colour import MSDS_CMFS, SDS_ILLUMINANTS, SpectralShape @@ -202,12 +205,9 @@ def XYZ_to_sd( ... .align(SpectralShape(360, 780, 10)) ... ) >>> illuminant = SDS_ILLUMINANTS["D65"].copy().align(cmfs.shape) - >>> sd = XYZ_to_sd( - ... XYZ, method="Jakob 2019", cmfs=cmfs, illuminant=illuminant - ... ) + >>> sd = XYZ_to_sd(XYZ, method="Jakob 2019", cmfs=cmfs, illuminant=illuminant) >>> with numpy_print_options(suppress=True): ... sd # doctest: +ELLIPSIS - ... SpectralDistribution([[ 360. , 0.4893773...], [ 370. , 0.3258214...], [ 380. , 0.2147792...], @@ -251,10 +251,10 @@ def XYZ_to_sd( [ 760. , 0.9955066...], [ 770. , 0.9962855...], [ 780. , 0.9968976...]], - interpolator=SpragueInterpolator, - interpolator_kwargs={}, - extrapolator=Extrapolator, - extrapolator_kwargs={...}) + SpragueInterpolator, + {}, + Extrapolator, + {'method': 'Constant', 'left': None, 'right': None}) >>> sd_to_XYZ_integration(sd, cmfs, illuminant) / 100 # doctest: +ELLIPSIS array([ 0.2066217..., 0.1220128..., 0.0513958...]) @@ -269,7 +269,6 @@ def XYZ_to_sd( >>> sd = XYZ_to_sd(XYZ, method="Mallett 2019") >>> with numpy_print_options(suppress=True): ... sd # doctest: +ELLIPSIS - ... SpectralDistribution([[ 380. , 0.1735531...], [ 385. , 0.1720357...], [ 390. , 0.1677721...], @@ -351,10 +350,10 @@ def XYZ_to_sd( [ 770. , 0.1761803...], [ 775. , 0.1761195...], [ 780. , 0.1760763...]], - interpolator=SpragueInterpolator, - interpolator_kwargs={}, - extrapolator=Extrapolator, - extrapolator_kwargs={...}) + SpragueInterpolator, + {}, + Extrapolator, + {'method': 'Constant', 'left': None, 'right': None}) >>> sd_to_XYZ_integration(sd, cmfs, illuminant) / 100 ... # doctest: +ELLIPSIS array([ 0.2065436..., 0.1219996..., 0.0513764...]) @@ -367,12 +366,9 @@ def XYZ_to_sd( ... .align(SpectralShape(360, 780, 10)) ... ) >>> illuminant = SDS_ILLUMINANTS["D65"].copy().align(cmfs.shape) - >>> sd = XYZ_to_sd( - ... XYZ, method="Meng 2015", cmfs=cmfs, illuminant=illuminant - ... ) + >>> sd = XYZ_to_sd(XYZ, method="Meng 2015", cmfs=cmfs, illuminant=illuminant) >>> with numpy_print_options(suppress=True): ... sd # doctest: +SKIP - ... SpectralDistribution([[ 360. , 0.0762005...], [ 370. , 0.0761792...], [ 380. , 0.0761363...], @@ -416,10 +412,10 @@ def XYZ_to_sd( [ 760. , 0.4484969...], [ 770. , 0.4484853...], [ 780. , 0.4485134...]], - interpolator=SpragueInterpolator, - interpolator_kwargs={}, - extrapolator=Extrapolator, - extrapolator_kwargs={...}) + SpragueInterpolator, + {}, + Extrapolator, + {'method': 'Constant', 'left': None, 'right': None}) >>> sd_to_XYZ_integration(sd, cmfs, illuminant) / 100 # doctest: +ELLIPSIS array([ 0.2065400..., 0.1219722..., 0.0513695...]) @@ -431,12 +427,9 @@ def XYZ_to_sd( ... .align(SPECTRAL_SHAPE_OTSU2018) ... ) >>> illuminant = SDS_ILLUMINANTS["D65"].copy().align(cmfs.shape) - >>> sd = XYZ_to_sd( - ... XYZ, method="Otsu 2018", cmfs=cmfs, illuminant=illuminant - ... ) + >>> sd = XYZ_to_sd(XYZ, method="Otsu 2018", cmfs=cmfs, illuminant=illuminant) >>> with numpy_print_options(suppress=True): ... sd # doctest: +ELLIPSIS - ... SpectralDistribution([[ 380. , 0.0601939...], [ 390. , 0.0568063...], [ 400. , 0.0517429...], @@ -473,10 +466,10 @@ def XYZ_to_sd( [ 710. , 0.7084128...], [ 720. , 0.7154674...], [ 730. , 0.7234334...]], - interpolator=SpragueInterpolator, - interpolator_kwargs={}, - extrapolator=Extrapolator, - extrapolator_kwargs={...}) + SpragueInterpolator, + {}, + Extrapolator, + {'method': 'Constant', 'left': None, 'right': None}) >>> sd_to_XYZ_integration(sd, cmfs, illuminant) / 100 # doctest: +ELLIPSIS array([ 0.2065494..., 0.1219712..., 0.0514002...]) @@ -491,7 +484,6 @@ def XYZ_to_sd( >>> sd = XYZ_to_sd(XYZ, method="Smits 1999") >>> with numpy_print_options(suppress=True): ... sd # doctest: +ELLIPSIS - ... SpectralDistribution([[ 380. , 0.0787830...], [ 417.7778 , 0.0622018...], [ 455.5556 , 0.0446206...], @@ -502,10 +494,10 @@ def XYZ_to_sd( [ 644.4444 , 0.3836164...], [ 682.2222 , 0.3836164...], [ 720. , 0.3835649...]], - interpolator=LinearInterpolator, - interpolator_kwargs={}, - extrapolator=Extrapolator, - extrapolator_kwargs={...}) + LinearInterpolator, + {}, + Extrapolator, + {'method': 'Constant', 'left': None, 'right': None}) >>> sd_to_XYZ_integration(sd, cmfs, illuminant) / 100 # doctest: +ELLIPSIS array([ 0.1894770..., 0.1126470..., 0.0474420...]) """ @@ -531,34 +523,3 @@ def XYZ_to_sd( "XYZ_TO_SD_METHODS", "XYZ_to_sd", ] - - -# ----------------------------------------------------------------------------# -# --- API Changes and Deprecation Management ---# -# ----------------------------------------------------------------------------# -class recovery(ModuleAPI): - """Define a class acting like the *recovery* module.""" - - def __getattr__(self, attribute) -> Any: - """Return the value from the attribute with given name.""" - - return super().__getattr__(attribute) - - -# v0.4.0 -API_CHANGES = { - "ObjectRenamed": [ - [ - "colour.recovery.NodeTree_Otsu2018", - "colour.recovery.Tree_Otsu2018", - ], - ] -} -"""Defines the *colour.recovery* sub-package API changes.""" - -if not is_documentation_building(): - sys.modules["colour.recovery"] = recovery( # pyright: ignore - sys.modules["colour.recovery"], build_API_changes(API_CHANGES) - ) - - del ModuleAPI, is_documentation_building, build_API_changes, sys diff --git a/colour/recovery/datasets/dyer2017.py b/colour/recovery/datasets/dyer2017.py index b814e2cfa7..2720bc1cb6 100644 --- a/colour/recovery/datasets/dyer2017.py +++ b/colour/recovery/datasets/dyer2017.py @@ -2,7 +2,7 @@ Dyer et al. (2017) - Camera Sensitivities Basis Functions ========================================================= -Defines the datasets for camera sensitivities recovery using +Define the datasets for camera sensitivities recovery using *Jiang, Liu, Gu and Süsstrunk (2013)* method. References @@ -31,9 +31,7 @@ ] -SPECTRAL_SHAPE_BASIS_FUNCTIONS_DYER2017: SpectralShape = SpectralShape( - 400, 700, 10 -) +SPECTRAL_SHAPE_BASIS_FUNCTIONS_DYER2017: SpectralShape = SpectralShape(400, 700, 10) """ Spectral shape of the *Dyer et al. (2017)* basis functions. """ diff --git a/colour/recovery/datasets/mallett2019.py b/colour/recovery/datasets/mallett2019.py index 7287af536d..9effc2a89d 100644 --- a/colour/recovery/datasets/mallett2019.py +++ b/colour/recovery/datasets/mallett2019.py @@ -2,7 +2,7 @@ Mallett and Yuksel (2019) - Reflectance Recovery ================================================ -Defines the datasets for reflectance recovery using *Mallett and Yuksel +Define the datasets for reflectance recovery using *Mallett and Yuksel (2019)* method. References diff --git a/colour/recovery/datasets/otsu2018.py b/colour/recovery/datasets/otsu2018.py index 791c16ab8a..e9dc0bce8a 100644 --- a/colour/recovery/datasets/otsu2018.py +++ b/colour/recovery/datasets/otsu2018.py @@ -2,7 +2,7 @@ Otsu et al. (2018) - Reflectance Recovery ========================================= -Defines the datasets for reflectance recovery using *Otsu et al. (2018)* +Define the datasets for reflectance recovery using *Otsu et al. (2018)* method. References diff --git a/colour/recovery/datasets/smits1999.py b/colour/recovery/datasets/smits1999.py index ce9d818c8e..9f866a17d7 100644 --- a/colour/recovery/datasets/smits1999.py +++ b/colour/recovery/datasets/smits1999.py @@ -2,7 +2,7 @@ Smits (1999) - Reflectance Recovery Dataset =========================================== -Defines the datasets for reflectance recovery using *Smits (1999)* method. +Define the datasets for reflectance recovery using *Smits (1999)* method. References ---------- @@ -120,12 +120,8 @@ { "white": SpectralDistribution(DATA_SMITS1999["white"], name="white"), "cyan": SpectralDistribution(DATA_SMITS1999["cyan"], name="cyan"), - "magenta": SpectralDistribution( - DATA_SMITS1999["magenta"], name="magenta" - ), - "yellow": SpectralDistribution( - DATA_SMITS1999["yellow"], name="yellow" - ), + "magenta": SpectralDistribution(DATA_SMITS1999["magenta"], name="magenta"), + "yellow": SpectralDistribution(DATA_SMITS1999["yellow"], name="yellow"), "red": SpectralDistribution(DATA_SMITS1999["red"], name="red"), "green": SpectralDistribution(DATA_SMITS1999["green"], name="green"), "blue": SpectralDistribution(DATA_SMITS1999["blue"], name="blue"), diff --git a/colour/recovery/jakob2019.py b/colour/recovery/jakob2019.py index 921133ea7a..01cfbed36d 100644 --- a/colour/recovery/jakob2019.py +++ b/colour/recovery/jakob2019.py @@ -2,7 +2,7 @@ Jakob and Hanika (2019) - Reflectance Recovery ============================================== -Defines the objects for reflectance recovery, i.e. spectral upsampling, using +Define the objects for reflectance recovery, i.e., spectral upsampling, using *Jakob and Hanika (2019)* method: - :func:`colour.recovery.sd_Jakob2019` @@ -20,6 +20,7 @@ from __future__ import annotations import struct +from pathlib import Path import numpy as np from scipy.interpolate import RegularGridInterpolator @@ -162,7 +163,6 @@ def sd_Jakob2019( >>> with numpy_print_options(suppress=True): ... sd_Jakob2019([-9e-05, 8.5e-02, -20], SpectralShape(400, 700, 20)) ... # doctest: +ELLIPSIS - ... SpectralDistribution([[ 400. , 0.3143046...], [ 420. , 0.4133320...], [ 440. , 0.4880034...], @@ -232,7 +232,7 @@ def error_function( ------- :class:`tuple` or :class:`tuple` Tuple of computed :math:`\\Delta E_{76}` error and gradient of error, - i.e. the first derivatives of error with respect to the input + i.e., the first derivatives of error with respect to the input coefficients or tuple of computed :math:`\\Delta E_{76}` error, gradient of error, computed spectral reflectance, *CIE XYZ* tristimulus values corresponding to ``R`` and *CIE L\\*a\\*b\\** colourspace array @@ -268,9 +268,7 @@ def error_function( XYZ_f = intermediate_lightness_function_CIE1976(XYZ, XYZ_n) dXYZ_f = np.where( XYZ_XYZ_n[..., None] > (24 / 116) ** 3, - 1 - / (3 * spow(XYZ_n[..., None], 1 / 3) * spow(XYZ[..., None], 2 / 3)) - * dXYZ, + 1 / (3 * spow(XYZ_n[..., None], 1 / 3) * spow(XYZ[..., None], 2 / 3)) * dXYZ, (841 / 108) * dXYZ / XYZ_n[..., None], ) @@ -297,9 +295,7 @@ def intermediate_XYZ_to_Lab( if max_error is not None and error <= max_error: raise StopMinimizationEarlyError(coefficients, error) - derror = ( - np.sum(dLab_i * (Lab_i[..., None] - target[..., None]), axis=0) / error - ) + derror = np.sum(dLab_i * (Lab_i[..., None] - target[..., None]), axis=0) / error if additional_data: return error, derror, R, XYZ, Lab_i @@ -339,9 +335,7 @@ def dimensionalise_coefficients( c_0 = cp_0 / span**2 c_1 = cp_1 / span - 2 * cp_0 * shape.start / span**2 - c_2 = ( - cp_0 * shape.start**2 / span**2 - cp_1 * shape.start / span + cp_2 - ) + c_2 = cp_0 * shape.start**2 / span**2 - cp_1 * shape.start / span + cp_2 return np.array([c_0, c_1, c_2]) @@ -549,7 +543,6 @@ def XYZ_to_sd_Jakob2019( >>> sd = XYZ_to_sd_Jakob2019(XYZ, cmfs, illuminant) >>> with numpy_print_options(suppress=True): ... sd # doctest: +ELLIPSIS - ... SpectralDistribution([[ 360. , 0.4893773...], [ 370. , 0.3258214...], [ 380. , 0.2147792...], @@ -684,7 +677,6 @@ class LUT3D_Jakob2019: >>> RGB = np.array([0.70573936, 0.19248266, 0.22354169]) >>> with numpy_print_options(suppress=True): ... LUT.RGB_to_sd(RGB, cmfs.shape) # doctest: +ELLIPSIS - ... SpectralDistribution([[ 360. , 0.7666803...], [ 370. , 0.6251547...], [ 380. , 0.4584310...], @@ -738,6 +730,7 @@ def __init__(self) -> None: self._interpolator: RegularGridInterpolator = RegularGridInterpolator( np.array([]), np.array([]) ) + self._size: int = 0 self._lightness_scale: NDArrayFloat = np.array([]) self._coefficients: NDArrayFloat = np.array([]) @@ -746,7 +739,7 @@ def __init__(self) -> None: def size(self) -> int: """ Getter property for the *Jakob and Hanika (2019)* interpolator - size, i.e. the samples count on one side of the 3D table. + size, i.e., the sample count on one side of the 3D table. Returns ------- @@ -1000,15 +993,13 @@ def RGB_to_coefficients(self, RGB: ArrayLike) -> NDArrayFloat: ... ) >>> illuminant = SDS_ILLUMINANTS["D65"].copy().align(cmfs.shape) >>> LUT = LUT3D_Jakob2019() - >>> LUT.generate( - ... RGB_COLOURSPACE_sRGB, cmfs, illuminant, 3, lambda x: x - ... ) + >>> LUT.generate(RGB_COLOURSPACE_sRGB, cmfs, illuminant, 3, lambda x: x) >>> RGB = np.array([0.70573936, 0.19248266, 0.22354169]) >>> LUT.RGB_to_coefficients(RGB) # doctest: +ELLIPSIS array([ 1.5013448...e-04, -1.4679754...e-01, 3.4020219...e+01]) """ - if self._interpolator is not None: + if len(self._interpolator.grid) != 0: RGB = as_float_array(RGB) value_max = np.max(RGB, axis=-1) @@ -1059,13 +1050,10 @@ def RGB_to_sd( ... ) >>> illuminant = SDS_ILLUMINANTS["D65"].copy().align(cmfs.shape) >>> LUT = LUT3D_Jakob2019() - >>> LUT.generate( - ... RGB_COLOURSPACE_sRGB, cmfs, illuminant, 3, lambda x: x - ... ) + >>> LUT.generate(RGB_COLOURSPACE_sRGB, cmfs, illuminant, 3, lambda x: x) >>> RGB = np.array([0.70573936, 0.19248266, 0.22354169]) >>> with numpy_print_options(suppress=True): ... LUT.RGB_to_sd(RGB, cmfs.shape) # doctest: +ELLIPSIS - ... SpectralDistribution([[ 360. , 0.7666803...], [ 370. , 0.6251547...], [ 380. , 0.4584310...], @@ -1120,7 +1108,7 @@ def RGB_to_sd( return sd - def read(self, path: str) -> LUT3D_Jakob2019: + def read(self, path: str | Path) -> LUT3D_Jakob2019: """ Load a lookup table from a *\\*.coeff* file. @@ -1148,9 +1136,7 @@ def read(self, path: str) -> LUT3D_Jakob2019: ... ) >>> illuminant = SDS_ILLUMINANTS["D65"].copy().align(cmfs.shape) >>> LUT = LUT3D_Jakob2019() - >>> LUT.generate( - ... RGB_COLOURSPACE_sRGB, cmfs, illuminant, 3, lambda x: x - ... ) + >>> LUT.generate(RGB_COLOURSPACE_sRGB, cmfs, illuminant, 3, lambda x: x) >>> path = os.path.join( ... colour.__path__[0], ... "recovery", @@ -1162,6 +1148,8 @@ def read(self, path: str) -> LUT3D_Jakob2019: >>> LUT.read(path) # doctest: +SKIP """ + path = str(path) + with open(path, "rb") as coeff_file: if coeff_file.read(4).decode("ISO-8859-1") != "SPEC": raise ValueError( @@ -1175,15 +1163,15 @@ def read(self, path: str) -> LUT3D_Jakob2019: self._coefficients = np.fromfile( coeff_file, count=3 * (self._size**3) * 3, dtype=np.float32 ) - self._coefficients = self._coefficients.reshape( - 3, self._size, self._size, self._size, 3 + self._coefficients = np.reshape( + self._coefficients, (3, self._size, self._size, self._size, 3) ) self._create_interpolator() return self - def write(self, path: str) -> bool: + def write(self, path: str | Path) -> bool: """ Write the lookup table to a *\\*.coeff* file. @@ -1211,9 +1199,7 @@ def write(self, path: str) -> bool: ... ) >>> illuminant = SDS_ILLUMINANTS["D65"].copy().align(cmfs.shape) >>> LUT = LUT3D_Jakob2019() - >>> LUT.generate( - ... RGB_COLOURSPACE_sRGB, cmfs, illuminant, 3, lambda x: x - ... ) + >>> LUT.generate(RGB_COLOURSPACE_sRGB, cmfs, illuminant, 3, lambda x: x) >>> path = os.path.join( ... colour.__path__[0], ... "recovery", @@ -1225,6 +1211,8 @@ def write(self, path: str) -> bool: >>> LUT.read(path) # doctest: +SKIP """ + path = str(path) + with open(path, "wb") as coeff_file: coeff_file.write(b"SPEC") coeff_file.write(struct.pack("i", self._coefficients.shape[1])) diff --git a/colour/recovery/jiang2013.py b/colour/recovery/jiang2013.py index 28339c841e..aa6bddd947 100644 --- a/colour/recovery/jiang2013.py +++ b/colour/recovery/jiang2013.py @@ -2,7 +2,7 @@ Jiang et al. (2013) - Camera RGB Sensitivities Recovery ======================================================= -Defines the objects for camera *RGB* sensitivities recovery using +Define the objects for camera *RGB* sensitivities recovery using *Jiang, Liu, Gu and Süsstrunk (2013)* method: - :func:`colour.recovery.PCA_Jiang2013` @@ -205,37 +205,37 @@ def RGB_to_sd_camera_sensitivity_Jiang2013( ... R_w, ... SPECTRAL_SHAPE_BASIS_FUNCTIONS_DYER2017, ... ) # doctest: +ELLIPSIS - SpectralDistribution([[ 4.00000000e+02, 7.3976716...e-04], - [ 4.10000000e+02, -8.7040243...e-04], - [ 4.20000000e+02, 4.6893657...e-03], - [ 4.30000000e+02, 7.7522012...e-03], - [ 4.40000000e+02, 6.9238417...e-03], - [ 4.50000000e+02, 5.3089422...e-03], - [ 4.60000000e+02, 4.4780109...e-03], - [ 4.70000000e+02, 4.6386816...e-03], - [ 4.80000000e+02, 5.1897663...e-03], - [ 4.90000000e+02, 4.3906620...e-03], - [ 5.00000000e+02, 4.2189259...e-03], - [ 5.10000000e+02, 5.4270976...e-03], - [ 5.20000000e+02, 9.6722601...e-03], - [ 5.30000000e+02, 1.4272520...e-02], - [ 5.40000000e+02, 7.9609053...e-03], - [ 5.50000000e+02, 4.5917460...e-03], - [ 5.60000000e+02, 5.2723695...e-03], - [ 5.70000000e+02, 1.0479224...e-02], - [ 5.80000000e+02, 5.3101298...e-02], - [ 5.90000000e+02, 9.8185490...e-02], - [ 6.00000000e+02, 9.9775094...e-02], - [ 6.10000000e+02, 8.3935824...e-02], - [ 6.20000000e+02, 6.9216733...e-02], - [ 6.30000000e+02, 5.6902763...e-02], - [ 6.40000000e+02, 4.2810635...e-02], - [ 6.50000000e+02, 3.0064003...e-02], - [ 6.60000000e+02, 2.3093789...e-02], - [ 6.70000000e+02, 1.3756855...e-02], - [ 6.80000000e+02, 4.1785101...e-03], - [ 6.90000000e+02, -3.8014848...e-04], - [ 7.00000000e+02, -5.7544253...e-04]], + SpectralDistribution([[ 4.00000000e+02, 7.2066502...e-04], + [ 4.10000000e+02, -8.9698693...e-04], + [ 4.20000000e+02, 4.6871961...e-03], + [ 4.30000000e+02, 7.7694971...e-03], + [ 4.40000000e+02, 6.9335511...e-03], + [ 4.50000000e+02, 5.3134947...e-03], + [ 4.60000000e+02, 4.4819958...e-03], + [ 4.70000000e+02, 4.6393791...e-03], + [ 4.80000000e+02, 5.1866668...e-03], + [ 4.90000000e+02, 4.3828317...e-03], + [ 5.00000000e+02, 4.2001231...e-03], + [ 5.10000000e+02, 5.4065544...e-03], + [ 5.20000000e+02, 9.6445141...e-03], + [ 5.30000000e+02, 1.4277112...e-02], + [ 5.40000000e+02, 7.9950718...e-03], + [ 5.50000000e+02, 4.6429813...e-03], + [ 5.60000000e+02, 5.3423840...e-03], + [ 5.70000000e+02, 1.0519383...e-02], + [ 5.80000000e+02, 5.2889443...e-02], + [ 5.90000000e+02, 9.7851167...e-02], + [ 6.00000000e+02, 9.9600382...e-02], + [ 6.10000000e+02, 8.3840892...e-02], + [ 6.20000000e+02, 6.9180858...e-02], + [ 6.30000000e+02, 5.6967854...e-02], + [ 6.40000000e+02, 4.2930308...e-02], + [ 6.50000000e+02, 3.0241267...e-02], + [ 6.60000000e+02, 2.3230047...e-02], + [ 6.70000000e+02, 1.3721943...e-02], + [ 6.80000000e+02, 4.0944885...e-03], + [ 6.90000000e+02, -4.4223475...e-04], + [ 7.00000000e+02, -6.1427769...e-04]], SpragueInterpolator, {}, Extrapolator, @@ -246,9 +246,7 @@ def RGB_to_sd_camera_sensitivity_Jiang2013( shape = optional(shape, illuminant.shape) if illuminant.shape != shape: - runtime_warning( - f'Aligning "{illuminant.name}" illuminant shape to "{shape}".' - ) + runtime_warning(f'Aligning "{illuminant.name}" illuminant shape to "{shape}".') illuminant = reshape_sd(illuminant, shape, copy=False) if reflectances.shape != shape: @@ -291,7 +289,7 @@ def RGB_to_msds_camera_sensitivities_Jiang2013( values. basis_functions Basis functions for the method. The default is to use the built-in - *sRGB* basis functions, i.e. + *sRGB* basis functions, i.e., :attr:`colour.recovery.BASIS_FUNCTIONS_DYER2017`. shape Spectral shape of the recovered camera *RGB* sensitivities, @@ -337,37 +335,37 @@ def RGB_to_msds_camera_sensitivities_Jiang2013( ... BASIS_FUNCTIONS_DYER2017, ... SPECTRAL_SHAPE_BASIS_FUNCTIONS_DYER2017, ... ).values # doctest: +ELLIPSIS - array([[ 7.2281577...e-03, 9.2250648...e-03, -9.8836897...e-03], - [ -8.5045760...e-03, 1.1277748...e-02, 3.8624865...e-03], - [ 4.5819113...e-02, 7.1552094...e-02, 4.0406829...e-01], - [ 7.5745635...e-02, 1.1530030...e-01, 7.1177452...e-01], - [ 6.7651854...e-02, 1.5311354...e-01, 8.5161378...e-01], - [ 5.1872905...e-02, 1.8828774...e-01, 9.3658053...e-01], - [ 4.3753995...e-02, 2.6093723...e-01, 9.7049828...e-01], - [ 4.5323885...e-02, 3.7531459...e-01, 9.5883525...e-01], - [ 5.0708454...e-02, 4.4750685...e-01, 8.8451412...e-01], - [ 4.2900523...e-02, 4.5047800...e-01, 7.5069924...e-01], - [ 4.1222513...e-02, 6.1672868...e-01, 5.5327277...e-01], - [ 5.3027385...e-02, 7.8015416...e-01, 3.8368507...e-01], - [ 9.4506252...e-02, 9.1751657...e-01, 2.4143664...e-01], - [ 1.3945472...e-01, 1.0000000...e+00, 1.5616071...e-01], - [ 7.7784852...e-02, 9.2719372...e-01, 1.0462050...e-01], - [ 4.4865285...e-02, 8.5627976...e-01, 6.5035086...e-02], - [ 5.1515558...e-02, 7.5193757...e-01, 3.3979292...e-02], - [ 1.0239098...e-01, 6.2562412...e-01, 2.0583993...e-02], - [ 5.1884509...e-01, 4.9264953...e-01, 1.4571020...e-02], - [ 9.5935619...e-01, 3.4322427...e-01, 1.0656116...e-02], - [ 9.7488799...e-01, 2.0857245...e-01, 6.8892462...e-03], - [ 8.2012477...e-01, 1.1178699...e-01, 4.3808407...e-03], - [ 6.7630666...e-01, 6.5977834...e-02, 4.0420907...e-03], - [ 5.5598866...e-01, 4.4719007...e-02, 4.2502316...e-03], - [ 4.1829651...e-01, 3.3471790...e-02, 4.6139542...e-03], - [ 2.9375101...e-01, 2.4044889...e-02, 4.7376860...e-03], - [ 2.2564606...e-01, 1.8870707...e-02, 4.6336440...e-03], - [ 1.3441624...e-01, 1.0702974...e-02, 3.4919622...e-03], - [ 4.0827617...e-02, 5.5529047...e-03, 1.3990786...e-03], - [ -3.7143757...e-03, 2.5093564...e-03, 3.9765262...e-04], - [ -5.6225656...e-03, 1.5643397...e-03, 5.8472693...e-04]]) + array([[ 7.0437846...e-03, 9.2126044...e-03, -7.6408087...e-03], + [ -8.7671560...e-03, 1.1272669...e-02, 6.3743419...e-03], + [ 4.5812685...e-02, 7.1800041...e-02, 4.0000169...e-01], + [ 7.5939115...e-02, 1.1562093...e-01, 7.1152155...e-01], + [ 6.7768573...e-02, 1.5340644...e-01, 8.5266831...e-01], + [ 5.1934131...e-02, 1.8857547...e-01, 9.3895784...e-01], + [ 4.3807056...e-02, 2.6108660...e-01, 9.7213072...e-01], + [ 4.5345321...e-02, 3.7544039...e-01, 9.6145068...e-01], + [ 5.0694514...e-02, 4.4765815...e-01, 8.8648114...e-01], + [ 4.2837825...e-02, 4.5071344...e-01, 7.5177077...e-01], + [ 4.1052030...e-02, 6.1657728...e-01, 5.5273073...e-01], + [ 5.2843697...e-02, 7.8019954...e-01, 3.8226917...e-01], + [ 9.4265543...e-02, 9.1767425...e-01, 2.4035461...e-01], + [ 1.3954459...e-01, 1.0000000...e+00, 1.5537481...e-01], + [ 7.8143883...e-02, 9.2772027...e-01, 1.0440935...e-01], + [ 4.5380529...e-02, 8.5670156...e-01, 6.5122285...e-02], + [ 5.2216496...e-02, 7.5232292...e-01, 3.4295447...e-02], + [ 1.0281652...e-01, 6.2580973...e-01, 2.0949510...e-02], + [ 5.1694176...e-01, 4.9274616...e-01, 1.4852461...e-02], + [ 9.5639793...e-01, 3.4336481...e-01, 1.0898318...e-02], + [ 9.7349477...e-01, 2.0858770...e-01, 7.0049439...e-03], + [ 8.1946141...e-01, 1.1178483...e-01, 4.4718000...e-03], + [ 6.7617415...e-01, 6.5907196...e-02, 4.1013538...e-03], + [ 5.5680417...e-01, 4.4626835...e-02, 4.1852898...e-03], + [ 4.1960111...e-01, 3.3367103...e-02, 4.4916588...e-03], + [ 2.9557834...e-01, 2.3948776...e-02, 4.4593273...e-03], + [ 2.2705062...e-01, 1.8778777...e-02, 4.3169731...e-03], + [ 1.3411835...e-01, 1.0695498...e-02, 3.4119265...e-03], + [ 4.0019556...e-02, 5.5551238...e-03, 1.3679492...e-03], + [ -4.3224053...e-03, 2.4973119...e-03, 3.8030327...e-04], + [ -6.0039541...e-03, 1.5467822...e-03, 5.4039435...e-04]]) """ R, G, B = tsplit(np.reshape(RGB, [-1, 3])) @@ -376,9 +374,7 @@ def RGB_to_msds_camera_sensitivities_Jiang2013( R_w, G_w, B_w = tsplit(np.moveaxis(basis_functions, 0, 1)) if illuminant.shape != shape: - runtime_warning( - f'Aligning "{illuminant.name}" illuminant shape to "{shape}".' - ) + runtime_warning(f'Aligning "{illuminant.name}" illuminant shape to "{shape}".') illuminant = reshape_sd(illuminant, shape, copy=False) if reflectances.shape != shape: diff --git a/colour/recovery/mallett2019.py b/colour/recovery/mallett2019.py index 34a3a849ef..78c359eec5 100644 --- a/colour/recovery/mallett2019.py +++ b/colour/recovery/mallett2019.py @@ -2,7 +2,7 @@ Mallett and Yuksel (2019) - Reflectance Recovery ================================================ -Defines the objects for reflectance recovery, i.e. spectral upsampling, using +Define the objects for reflectance recovery, i.e., spectral upsampling, using *Mallett and Yuksel (2019)* method: - :func:`colour.recovery.spectral_primary_decomposition_Mallett2019` @@ -67,7 +67,7 @@ def spectral_primary_decomposition_Mallett2019( Illuminant spectral distribution, default to *CIE Standard Illuminant D65*. metric - Function to be minimised, i.e. the objective function. + Function to be minimised, i.e., the objective function. ``metric(basis, *metric_args) -> float`` @@ -117,7 +117,6 @@ def spectral_primary_decomposition_Mallett2019( ... ) >>> with numpy_print_options(suppress=True): ... print(msds) # doctest: +SKIP - ... [[ 360. 0.3395134... 0.3400214... 0.3204650...] [ 370. 0.3355246... 0.3338028... 0.3306724...] [ 380. 0.3376707... 0.3185578... 0.3437715...] @@ -227,7 +226,7 @@ def RGB_to_sd_Mallett2019( *RGB* colourspace array. basis_functions Basis functions for the method. The default is to use the built-in - *sRGB* basis functions, i.e. + *sRGB* basis functions, i.e., :attr:`colour.recovery.MSDS_BASIS_FUNCTIONS_sRGB_MALLETT2019`. Returns @@ -267,7 +266,6 @@ def RGB_to_sd_Mallett2019( >>> sd = RGB_to_sd_Mallett2019(RGB) >>> with numpy_print_options(suppress=True): ... sd # doctest: +ELLIPSIS - ... SpectralDistribution([[ 380. , 0.1735531...], [ 385. , 0.1720357...], [ 390. , 0.1677721...], diff --git a/colour/recovery/meng2015.py b/colour/recovery/meng2015.py index 218242afd2..5cef14dcc8 100644 --- a/colour/recovery/meng2015.py +++ b/colour/recovery/meng2015.py @@ -2,7 +2,7 @@ Meng et al. (2015) - Reflectance Recovery ========================================= -Defines the objects for reflectance recovery using +Define the objects for reflectance recovery using *Meng, Simon and Hanika (2015)* method: - :func:`colour.recovery.XYZ_to_sd_Meng2015` @@ -112,7 +112,6 @@ def XYZ_to_sd_Meng2015( >>> sd = XYZ_to_sd_Meng2015(XYZ, cmfs, illuminant) >>> with numpy_print_options(suppress=True): ... sd # doctest: +SKIP - ... SpectralDistribution([[ 360. , 0.0762005...], [ 370. , 0.0761792...], [ 380. , 0.0761363...], @@ -181,9 +180,7 @@ def constraint_function(a: ArrayLike) -> NDArrayFloat: """Define the constraint function.""" sd[:] = a - return ( - sd_to_XYZ_integration(sd, cmfs=cmfs, illuminant=illuminant) - XYZ - ) + return sd_to_XYZ_integration(sd, cmfs=cmfs, illuminant=illuminant) - XYZ wavelengths = sd.wavelengths bins = wavelengths.size diff --git a/colour/recovery/otsu2018.py b/colour/recovery/otsu2018.py index f3acaa0992..bbe76fc6a6 100644 --- a/colour/recovery/otsu2018.py +++ b/colour/recovery/otsu2018.py @@ -2,7 +2,7 @@ Otsu, Yamamoto and Hachisuka (2018) - Reflectance Recovery ========================================================== -Defines the objects for reflectance recovery, i.e. spectral upsampling, using +Define the objects for reflectance recovery, i.e., spectral upsampling, using *Otsu et al. (2018)* method: - :class:`colour.recovery.Dataset_Otsu2018` @@ -19,6 +19,7 @@ from __future__ import annotations from dataclasses import dataclass +from pathlib import Path import numpy as np @@ -51,7 +52,7 @@ SPECTRAL_SHAPE_OTSU2018, ) from colour.utilities import ( - Node, + TreeNode, as_float_array, as_float_scalar, domain_range_scale, @@ -170,9 +171,7 @@ def __init__( means if means is None else as_float_array(means) ) self._selector_array: NDArrayFloat | None = ( - selector_array - if selector_array is None - else as_float_array(selector_array) + selector_array if selector_array is None else as_float_array(selector_array) ) @property @@ -316,7 +315,7 @@ def cluster(self, xy: ArrayLike) -> Tuple[NDArrayFloat, NDArrayFloat]: else: raise ValueError('The "basis functions" or "means" are undefined!') - def read(self, path: str): + def read(self, path: str | Path) -> None: """ Read and loads a dataset from an *.npz* file. @@ -349,6 +348,8 @@ def read(self, path: str): >>> dataset.read(path) # doctest: +SKIP """ + path = str(path) + data = np.load(path) start, end, interval = data["shape"] @@ -357,7 +358,7 @@ def read(self, path: str): self._means = data["means"] self._selector_array = data["selector_array"] - def write(self, path: str): + def write(self, path: str | Path) -> None: """ Write the dataset to an *.npz* file at given path. @@ -393,6 +394,8 @@ def write(self, path: str): >>> dataset.write(path) # doctest: +SKIP """ + path = str(path) + if self._shape is not None: np.savez( path, @@ -489,7 +492,6 @@ def XYZ_to_sd_Otsu2018( >>> sd = XYZ_to_sd_Otsu2018(XYZ, cmfs, illuminant) >>> with numpy_print_options(suppress=True): ... sd # doctest: +ELLIPSIS - ... SpectralDistribution([[ 380. , 0.0601939...], [ 390. , 0.0568063...], [ 400. , 0.0517429...], @@ -781,11 +783,7 @@ def __len__(self) -> int: Number of colours in the data. """ - return ( - self._reflectances.shape[0] - if self._reflectances is not None - else 0 - ) + return self._reflectances.shape[0] if self._reflectances is not None else 0 def origin(self, i: int, direction: int) -> float: """ @@ -815,9 +813,7 @@ def origin(self, i: int, direction: int) -> float: else: raise ValueError('The "chromaticity coordinates" are undefined!') - def partition( - self, axis: PartitionAxis - ) -> Tuple[Data_Otsu2018, Data_Otsu2018]: + def partition(self, axis: PartitionAxis) -> Tuple[Data_Otsu2018, Data_Otsu2018]: """ Partition the data using given partition axis. @@ -879,22 +875,19 @@ def PCA(self) -> None: self._mean = np.mean(self._reflectances, axis=0) self._XYZ_mu = ( - msds_to_XYZ_integration( - cast(NDArrayFloat, self._mean), **settings - ) + msds_to_XYZ_integration(cast(NDArrayFloat, self._mean), **settings) / 100 ) _w, w = eigen_decomposition( - self._reflectances - self._mean, + self._reflectances - self._mean, # pyright: ignore descending_order=False, covariance_matrix=True, ) self._basis_functions = np.transpose(w[:, -3:]) self._M = np.transpose( - msds_to_XYZ_integration(self._basis_functions, **settings) - / 100 + msds_to_XYZ_integration(self._basis_functions, **settings) / 100 ) def reconstruct(self, XYZ: ArrayLike) -> SpectralDistribution: @@ -981,7 +974,7 @@ def reconstruction_error(self) -> float: raise ValueError('The "tristimulus values" are undefined!') -class Node_Otsu2018(Node): +class Node_Otsu2018(TreeNode): """ Represent a node in a :meth:`colour.recovery.Tree_Otsu2018` class instance node tree. @@ -1018,9 +1011,9 @@ def __init__( super().__init__(parent=parent, children=children, data=data) self._partition_axis: PartitionAxis | None = None - self._best_partition: Tuple[ - Sequence[Node_Otsu2018], PartitionAxis, float - ] | None = None + self._best_partition: ( + Tuple[Sequence[Node_Otsu2018], PartitionAxis, float] | None + ) = None @property def partition_axis(self) -> PartitionAxis | None: @@ -1098,7 +1091,7 @@ def minimise( ------- :class:`tuple` Tuple of tuple of nodes created by splitting a node with a given - partition, partition axis, i.e. the horizontal or vertical line, + partition, partition axis, i.e., the horizontal or vertical line, partitioning the 2D space in two half-planes and partition error. """ @@ -1113,9 +1106,7 @@ def minimise( for i in range(len(self.data)): progress.update() - axis = PartitionAxis( - self.data.origin(i, direction), direction - ) + axis = PartitionAxis(self.data.origin(i, direction), direction) data_lesser, data_greater = self.data.partition(axis) if np.any( @@ -1175,7 +1166,7 @@ def leaf_reconstruction_error(self) -> float: def branch_reconstruction_error(self) -> float: """ Compute the reconstruction error for all the leaves data connected to - the node or its children, i.e. the reconstruction errors summation for + the node or its children, i.e., the reconstruction errors summation for all the leaves in the branch. Returns @@ -1189,12 +1180,7 @@ def branch_reconstruction_error(self) -> float: return self.leaf_reconstruction_error() else: return as_float_scalar( - np.sum( - [ - child.branch_reconstruction_error() - for child in self.children - ] - ) + np.sum([child.branch_reconstruction_error() for child in self.children]) ) @@ -1270,7 +1256,6 @@ class Tree_Otsu2018(Node_Otsu2018): >>> sd = XYZ_to_sd_Otsu2018(XYZ, cmfs, illuminant, dataset) >>> with numpy_print_options(suppress=True): ... sd # doctest: +ELLIPSIS - ... SpectralDistribution([[ 360. , 0.0651341...], [ 370. , 0.0651341...], [ 380. , 0.0651341...], @@ -1502,9 +1487,7 @@ def optimise( continue new_total_error = ( - total_error - - leaf.leaf_reconstruction_error() - + partition_error + total_error - leaf.leaf_reconstruction_error() + partition_error ) if ( @@ -1578,14 +1561,10 @@ def to_dataset(self) -> Dataset_Otsu2018: selector_array = zeros(4) else: - def add_rows( - node: Node_Otsu2018, data: dict | None = None - ) -> dict | None: + def add_rows(node: Node_Otsu2018, data: dict | None = None) -> dict | None: """Add rows for given node and its children.""" - data = optional( - data, {"rows": [], "node_to_leaf_id": {}, "leaf_id": 0} - ) + data = optional(data, {"rows": [], "node_to_leaf_id": {}, "leaf_id": 0}) if node.is_leaf(): data["node_to_leaf_id"][node] = data["leaf_id"] diff --git a/colour/recovery/smits1999.py b/colour/recovery/smits1999.py index 09f605ebea..4759d6dfc5 100644 --- a/colour/recovery/smits1999.py +++ b/colour/recovery/smits1999.py @@ -2,7 +2,7 @@ Smits (1999) - Reflectance Recovery =================================== -Defines the objects for reflectance recovery using *Smits (1999)* method. +Define the objects for reflectance recovery using *Smits (1999)* method. References ---------- @@ -135,7 +135,6 @@ def RGB_to_sd_Smits1999(RGB: ArrayLike) -> SpectralDistribution: >>> sd = RGB_to_sd_Smits1999(RGB) >>> with numpy_print_options(suppress=True): ... sd # doctest: +ELLIPSIS - ... SpectralDistribution([[ 380. , 0.0787830...], [ 417.7778 , 0.0622018...], [ 455.5556 , 0.0446206...], diff --git a/colour/recovery/tests/test__init__.py b/colour/recovery/tests/test__init__.py index c91d94cc93..bbdcf3575c 100644 --- a/colour/recovery/tests/test__init__.py +++ b/colour/recovery/tests/test__init__.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.recovery` module.""" -import unittest import numpy as np @@ -29,13 +27,13 @@ ] -class TestXYZ_to_sd(unittest.TestCase): +class TestXYZ_to_sd: """ Define :func:`colour.recovery.XYZ_to_sd` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._cmfs = reshape_msds( @@ -61,9 +59,7 @@ def test_domain_range_scale_XYZ_to_sd(self): ) v = [ sd_to_XYZ_integration( - XYZ_to_sd( - XYZ, method, cmfs=self._cmfs, illuminant=self._sd_D65 - ), + XYZ_to_sd(XYZ, method, cmfs=self._cmfs, illuminant=self._sd_D65), self._cmfs, self._sd_D65, ) @@ -88,7 +84,3 @@ def test_domain_range_scale_XYZ_to_sd(self): value * factor_b, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/recovery/tests/test_jakob2019.py b/colour/recovery/tests/test_jakob2019.py index ed59239628..6406ee4782 100644 --- a/colour/recovery/tests/test_jakob2019.py +++ b/colour/recovery/tests/test_jakob2019.py @@ -1,12 +1,11 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.recovery.jakob2019` module.""" import os import shutil import tempfile -import unittest import numpy as np +import pytest from colour.characterisation import SDS_COLOURCHECKERS from colour.colorimetry import handle_spectral_arguments, sd_to_XYZ @@ -42,19 +41,17 @@ ] -class TestErrorFunction(unittest.TestCase): +class TestErrorFunction: """ Define :func:`colour.recovery.jakob2019.error_function` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._shape = SPECTRAL_SHAPE_JAKOB2019 - self._cmfs, self._sd_D65 = handle_spectral_arguments( - shape_default=self._shape - ) + self._cmfs, self._sd_D65 = handle_spectral_arguments(shape_default=self._shape) self._XYZ_D65 = sd_to_XYZ(self._sd_D65) self._xy_D65 = XYZ_to_xy(self._XYZ_D65) @@ -101,15 +98,11 @@ def test_intermediates(self): sd_Lab = XYZ_to_Lab(XYZ, self._xy_D65) error_reference = delta_E_CIE1976(self._Lab_e, Lab) - np.testing.assert_allclose( - sd.values, R, atol=TOLERANCE_ABSOLUTE_TESTS - ) - np.testing.assert_allclose( - XYZ, sd_XYZ, atol=TOLERANCE_ABSOLUTE_TESTS - ) + np.testing.assert_allclose(sd.values, R, atol=TOLERANCE_ABSOLUTE_TESTS) + np.testing.assert_allclose(XYZ, sd_XYZ, atol=TOLERANCE_ABSOLUTE_TESTS) - self.assertLess(abs(error_reference - error), JND_CIE1976 / 100) - self.assertLess(delta_E_CIE1976(Lab, sd_Lab), JND_CIE1976 / 100) + assert abs(error_reference - error) < JND_CIE1976 / 100 + assert delta_E_CIE1976(Lab, sd_Lab) < JND_CIE1976 / 100 def test_derivatives(self): """ @@ -146,19 +139,17 @@ def test_derivatives(self): ) -class TestXYZ_to_sd_Jakob2019(unittest.TestCase): +class TestXYZ_to_sd_Jakob2019: """ Define :func:`colour.recovery.jakob2019.XYZ_to_sd_Jakob2019` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._shape = SPECTRAL_SHAPE_JAKOB2019 - self._cmfs, self._sd_D65 = handle_spectral_arguments( - shape_default=self._shape - ) + self._cmfs, self._sd_D65 = handle_spectral_arguments(shape_default=self._shape) def test_XYZ_to_sd_Jakob2019(self): """Test :func:`colour.recovery.jakob2019.XYZ_to_sd_Jakob2019` definition.""" @@ -172,7 +163,7 @@ def test_XYZ_to_sd_Jakob2019(self): ) if error > JND_CIE1976 / 100: # pragma: no cover - self.fail(f"Delta E for '{name}' is {error}!") + pytest.fail(f"Delta E for '{name}' is {error}!") def test_domain_range_scale_XYZ_to_sd_Jakob2019(self): """ @@ -192,9 +183,7 @@ def test_domain_range_scale_XYZ_to_sd_Jakob2019(self): with domain_range_scale(scale): np.testing.assert_allclose( sd_to_XYZ( - XYZ_to_sd_Jakob2019( - XYZ_i * factor_a, self._cmfs, self._sd_D65 - ), + XYZ_to_sd_Jakob2019(XYZ_i * factor_a, self._cmfs, self._sd_D65), self._cmfs, self._sd_D65, ), @@ -203,7 +192,7 @@ def test_domain_range_scale_XYZ_to_sd_Jakob2019(self): ) -class TestLUT3D_Jakob2019(unittest.TestCase): +class TestLUT3D_Jakob2019: """ Define :class:`colour.recovery.jakob2019.LUT3D_Jakob2019` definition unit tests methods. @@ -223,9 +212,7 @@ def generate_LUT(cls): if not hasattr(cls, "_LUT"): cls._shape = SPECTRAL_SHAPE_JAKOB2019 - cls._cmfs, cls._sd_D65 = handle_spectral_arguments( - shape_default=cls._shape - ) + cls._cmfs, cls._sd_D65 = handle_spectral_arguments(shape_default=cls._shape) cls._XYZ_D65 = sd_to_XYZ(cls._sd_D65) cls._xy_D65 = XYZ_to_xy(cls._XYZ_D65) @@ -247,7 +234,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(LUT3D_Jakob2019)) + assert attribute in dir(LUT3D_Jakob2019) def test_required_methods(self): """Test the presence of required methods.""" @@ -262,12 +249,12 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(LUT3D_Jakob2019)) + assert method in dir(LUT3D_Jakob2019) def test_size(self): """Test :attr:`colour.recovery.jakob2019.LUT3D_Jakob2019.size` property.""" - self.assertEqual(TestLUT3D_Jakob2019.generate_LUT().size, 5) + assert TestLUT3D_Jakob2019.generate_LUT().size == 5 def test_lightness_scale(self): """ @@ -277,9 +264,7 @@ def test_lightness_scale(self): np.testing.assert_allclose( TestLUT3D_Jakob2019.generate_LUT().lightness_scale, - np.array( - [0.00000000, 0.06561279, 0.50000000, 0.93438721, 1.00000000] - ), + np.array([0.00000000, 0.06561279, 0.50000000, 0.93438721, 1.00000000]), atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -289,10 +274,7 @@ def test_coefficients(self): property. """ - self.assertTupleEqual( - TestLUT3D_Jakob2019.generate_LUT().coefficients.shape, - (3, 5, 5, 5, 3), - ) + assert TestLUT3D_Jakob2019.generate_LUT().coefficients.shape == (3, 5, 5, 5, 3) def test_LUT3D_Jakob2019(self): """ @@ -334,15 +316,13 @@ def test_LUT3D_Jakob2019(self): Lab = XYZ_to_Lab(XYZ, self._xy_D65) recovered_sd = LUT.RGB_to_sd(RGB) - recovered_XYZ = ( - sd_to_XYZ(recovered_sd, self._cmfs, self._sd_D65) / 100 - ) + recovered_XYZ = sd_to_XYZ(recovered_sd, self._cmfs, self._sd_D65) / 100 recovered_Lab = XYZ_to_Lab(recovered_XYZ, self._xy_D65) error = delta_E_CIE1976(Lab, recovered_Lab) if error > 2 * JND_CIE1976 / 100: # pragma: no cover - self.fail( + pytest.fail( f"Delta E for RGB={RGB} in colourspace " f"{self._RGB_colourspace.name} is {error}!" ) @@ -355,7 +335,7 @@ def test_raise_exception_RGB_to_coefficients(self): LUT = LUT3D_Jakob2019() - self.assertRaises(ValueError, LUT.RGB_to_coefficients, np.array([])) + pytest.raises(RuntimeError, LUT.RGB_to_coefficients, np.array([1, 2, 3, 4])) def test_raise_exception_read(self): """ @@ -364,8 +344,4 @@ def test_raise_exception_read(self): """ LUT = LUT3D_Jakob2019() - self.assertRaises(ValueError, LUT.read, __file__) - - -if __name__ == "__main__": - unittest.main() + pytest.raises(ValueError, LUT.read, __file__) diff --git a/colour/recovery/tests/test_jiang2013.py b/colour/recovery/tests/test_jiang2013.py index 3589a62e93..3d33b3637d 100644 --- a/colour/recovery/tests/test_jiang2013.py +++ b/colour/recovery/tests/test_jiang2013.py @@ -1,9 +1,9 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.recovery.jiang2013` module.""" -import unittest +import platform import numpy as np +import pytest from colour.characterisation import ( MSDS_CAMERA_SENSITIVITIES, @@ -38,13 +38,13 @@ __all__ = [ "TestPCA_Jiang2013", - "TestMixinJiang2013", + "FixtureJiang2013", "TestRGB_to_sd_camera_sensitivity_Jiang2013", "TestRGB_to_msds_camera_sensitivities_Jiang2013", ] -class TestPCA_Jiang2013(unittest.TestCase): +class TestPCA_Jiang2013: """ Define :func:`colour.recovery.jiang2013.PCA_Jiang2013` definition unit tests methods. @@ -53,6 +53,9 @@ class TestPCA_Jiang2013(unittest.TestCase): def test_PCA_Jiang2013(self): """Test :func:`colour.recovery.jiang2013.PCA_Jiang2013` definition.""" + if platform.system() in ("Windows", "Microsoft", "Linux"): + return + shape = SpectralShape(400, 700, 10) camera_sensitivities = { camera: msds.copy().align(shape) @@ -67,106 +70,106 @@ def test_PCA_Jiang2013(self): np.array( [ [ - [-0.00137594, -0.00399416, -0.00060424], - [-0.00214835, -0.00184422, 0.32158985], - [-0.02757181, -0.00553587, 0.05403898], - [-0.02510621, 0.04216468, -0.02702351], - [-0.02011623, 0.03371162, -0.00568937], - [-0.01392282, 0.03297985, -0.01952216], - [-0.00944513, 0.03300938, -0.03045553], - [-0.02019958, 0.01289400, 0.02225622], - [-0.02394423, 0.00980934, -0.01011474], - [-0.04196326, -0.04987050, -0.00857578], - [-0.04988732, -0.06936603, 0.20547221], - [-0.06527141, -0.09378614, 0.03734956], - [-0.09412575, -0.12244081, 0.14001439], - [-0.10915913, -0.13119983, 0.08831632], - [-0.12314840, -0.24280936, 0.20130990], - [-0.11673941, -0.27700737, 0.18667656], - [-0.12534133, -0.29994127, 0.21783786], - [-0.14599255, -0.25586532, 0.22713199], - [-0.25249090, 0.11499750, -0.22053343], - [-0.35163407, 0.45286818, -0.13965255], - [-0.35805737, 0.40724252, 0.25882968], - [-0.36927899, 0.18120838, 0.51996857], - [-0.35374885, 0.03010008, -0.25565598], - [-0.35340909, -0.16847527, -0.28410654], - [-0.32696116, -0.29068981, -0.16331414], - [-0.29067354, -0.32862702, -0.24973353], - [-0.08964758, 0.09682656, -0.06974404], - [-0.01891664, 0.08221113, -0.00242073], - [-0.00521149, 0.01578907, -0.00004335], - [-0.00232366, 0.00137751, 0.00040639], - [-0.00153787, -0.00254398, -0.00038028], + [-0.00137594, 0.00399416], + [-0.00214835, 0.00184422], + [-0.02757181, 0.00553587], + [-0.02510621, -0.04216468], + [-0.02011623, -0.03371162], + [-0.01392282, -0.03297985], + [-0.00944513, -0.03300938], + [-0.02019958, -0.01289400], + [-0.02394423, -0.00980934], + [-0.04196326, 0.04987050], + [-0.04988732, 0.06936603], + [-0.06527141, 0.09378614], + [-0.09412575, 0.12244081], + [-0.10915913, 0.13119983], + [-0.12314840, 0.24280936], + [-0.11673941, 0.27700737], + [-0.12534133, 0.29994127], + [-0.14599255, 0.25586532], + [-0.25249090, -0.11499750], + [-0.35163407, -0.45286818], + [-0.35805737, -0.40724252], + [-0.36927899, -0.18120838], + [-0.35374885, -0.03010008], + [-0.35340909, 0.16847527], + [-0.32696116, 0.29068981], + [-0.29067354, 0.32862702], + [-0.08964758, -0.09682656], + [-0.01891664, -0.08221113], + [-0.00521149, -0.01578907], + [-0.00232366, -0.00137751], + [-0.00153787, 0.00254398], ], [ - [-0.00119598, -0.00267792, -0.00047163], - [-0.00200327, -0.00322983, 0.58674915], - [-0.01247816, 0.03313976, -0.03562970], - [-0.03207685, 0.05703294, -0.00969283], - [-0.04715050, 0.05296451, 0.07669022], - [-0.05794010, 0.05455737, -0.00031457], - [-0.10745571, -0.00158911, -0.07053271], - [-0.14178525, 0.03362764, -0.10570131], - [-0.16811402, 0.05569833, -0.12315365], - [-0.18463716, 0.04615404, 0.20069739], - [-0.21531623, 0.09745078, 0.18037692], - [-0.25442570, 0.18330481, -0.13661865], - [-0.28168018, 0.25193267, -0.07739509], - [-0.29237178, 0.28545428, 0.01460388], - [-0.29693117, 0.23909467, -0.24182353], - [-0.28631319, 0.19476441, -0.05441354], - [-0.27195968, 0.12087420, 0.40655125], - [-0.25988140, 0.01581316, 0.32470450], - [-0.24222660, -0.07912972, -0.27085507], - [-0.23069698, -0.18583667, -0.02532450], - [-0.20831983, -0.26745561, -0.23243075], - [-0.19437168, -0.32425009, 0.10237571], - [-0.18470894, -0.34768079, -0.01854361], - [-0.18056180, -0.35983221, -0.06301260], - [-0.17141337, -0.35067306, 0.19769116], - [-0.14712541, -0.30423172, -0.07278775], - [-0.02897026, -0.04573993, -0.01107455], - [-0.00190228, 0.00461591, 0.00033462], - [-0.00069122, 0.00118817, -0.00067360], - [-0.00045559, -0.00015286, -0.00003903], - [-0.00039509, -0.00049719, -0.00031217], + [-0.00119598, 0.00267792], + [-0.00200327, 0.00322983], + [-0.01247816, -0.03313976], + [-0.03207685, -0.05703294], + [-0.04715050, -0.05296451], + [-0.05794010, -0.05455737], + [-0.10745571, 0.00158911], + [-0.14178525, -0.03362764], + [-0.16811402, -0.05569833], + [-0.18463716, -0.04615404], + [-0.21531623, -0.09745078], + [-0.25442570, -0.18330481], + [-0.28168018, -0.25193267], + [-0.29237178, -0.28545428], + [-0.29693117, -0.23909467], + [-0.28631319, -0.19476441], + [-0.27195968, -0.12087420], + [-0.25988140, -0.01581316], + [-0.24222660, 0.07912972], + [-0.23069698, 0.18583667], + [-0.20831983, 0.26745561], + [-0.19437168, 0.32425009], + [-0.18470894, 0.34768079], + [-0.18056180, 0.35983221], + [-0.17141337, 0.35067306], + [-0.14712541, 0.30423172], + [-0.02897026, 0.04573993], + [-0.00190228, -0.00461591], + [-0.00069122, -0.00118817], + [-0.00045559, 0.00015286], + [-0.00039509, 0.00049719], ], [ - [-0.03283371, -0.04707162, 0.99800447], - [-0.05932690, -0.07529740, -0.02052607], - [-0.11947381, 0.07977219, 0.00630795], - [-0.18492233, 0.26127374, 0.00520247], - [-0.22091564, 0.29279976, 0.01193361], - [-0.25377875, 0.30677709, -0.00125936], - [-0.29969822, 0.26541777, 0.00701600], - [-0.30232755, 0.25378622, 0.00603327], - [-0.30031732, 0.19751184, -0.00689292], - [-0.28072276, 0.11804285, -0.00059888], - [-0.26005747, 0.01836333, -0.01245795], - [-0.23839367, -0.07182421, -0.01335875], - [-0.21721831, -0.14245410, -0.01256502], - [-0.19828405, -0.17684950, -0.02162238], - [-0.19018451, -0.20137781, -0.01456925], - [-0.18196762, -0.22086321, -0.00980506], - [-0.17168644, -0.22771873, -0.01723250], - [-0.16977073, -0.23504018, -0.02204447], - [-0.16277670, -0.22897797, -0.01554531], - [-0.15880423, -0.22583675, -0.02017303], - [-0.14966812, -0.21494312, -0.00986008], - [-0.13480155, -0.19511162, -0.01155616], - [-0.12541764, -0.18113238, -0.00597802], - [-0.12355731, -0.17835150, -0.01026176], - [-0.11175064, -0.15997651, -0.00814162], - [-0.09440304, -0.13423453, -0.00911544], - [-0.01670581, -0.02019670, -0.00109904], - [-0.00045002, 0.00147362, 0.00006449], - [-0.00102919, -0.00095904, -0.00008201], - [-0.00097397, -0.00123434, -0.00006730], - [-0.00097116, -0.00124835, -0.00008008], + [-0.03283371, 0.04707162], + [-0.05932690, 0.07529740], + [-0.11947381, -0.07977219], + [-0.18492233, -0.26127374], + [-0.22091564, -0.29279976], + [-0.25377875, -0.30677709], + [-0.29969822, -0.26541777], + [-0.30232755, -0.25378622], + [-0.30031732, -0.19751184], + [-0.28072276, -0.11804285], + [-0.26005747, -0.01836333], + [-0.23839367, 0.07182421], + [-0.21721831, 0.14245410], + [-0.19828405, 0.17684950], + [-0.19018451, 0.20137781], + [-0.18196762, 0.22086321], + [-0.17168644, 0.22771873], + [-0.16977073, 0.23504018], + [-0.16277670, 0.22897797], + [-0.15880423, 0.22583675], + [-0.14966812, 0.21494312], + [-0.13480155, 0.19511162], + [-0.12541764, 0.18113238], + [-0.12355731, 0.17835150], + [-0.11175064, 0.15997651], + [-0.09440304, 0.13423453], + [-0.01670581, 0.02019670], + [-0.00045002, -0.00147362], + [-0.00102919, 0.00095904], + [-0.00097397, 0.00123434], + [-0.00097116, 0.00124835], ], ] - )[..., 0:2], + ), atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( @@ -182,11 +185,12 @@ def test_PCA_Jiang2013(self): ) -class TestMixinJiang2013: - """A mixin for testing the :mod:`colour.recovery.jiang2013` module.""" +class FixtureJiang2013: + """A fixture for testing the :mod:`colour.recovery.jiang2013` module.""" - def __init__(self) -> None: - """Initialise common tests attributes for the mixin.""" + @pytest.fixture(autouse=True) + def setup_fixture_jiang_2013(self) -> None: + """Configure the class instance.""" self._sensitivities = reshape_msds( MSDS_CAMERA_SENSITIVITIES["Nikon 5100 (NPL)"], @@ -210,18 +214,16 @@ def __init__(self) -> None: ) -class TestRGB_to_sd_camera_sensitivity_Jiang2013( - unittest.TestCase, TestMixinJiang2013 -): +class TestRGB_to_sd_camera_sensitivity_Jiang2013(FixtureJiang2013): """ Define :func:`colour.recovery.jiang2013.RGB_to_sd_camera_sensitivity_Jiang2013` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" - TestMixinJiang2013.__init__(self) + FixtureJiang2013.__init__(self) def test_RGB_to_sd_camera_sensitivity_Jiang2013(self): """ @@ -278,18 +280,16 @@ def test_RGB_to_sd_camera_sensitivity_Jiang2013(self): ) -class TestRGB_to_msds_camera_sensitivities_Jiang2013( - unittest.TestCase, TestMixinJiang2013 -): +class TestRGB_to_msds_camera_sensitivities_Jiang2013(FixtureJiang2013): """ Define :func:`colour.recovery.jiang2013.\ RGB_to_msds_camera_sensitivities_Jiang2013` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" - TestMixinJiang2013.__init__(self) + FixtureJiang2013.__init__(self) def test_RGB_to_msds_camera_sensitivities_Jiang2013(self): """ @@ -342,7 +342,3 @@ def test_RGB_to_msds_camera_sensitivities_Jiang2013(self): ), atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/recovery/tests/test_mallett2019.py b/colour/recovery/tests/test_mallett2019.py index 79bcbe44cc..a14d57b3e6 100644 --- a/colour/recovery/tests/test_mallett2019.py +++ b/colour/recovery/tests/test_mallett2019.py @@ -1,9 +1,8 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.recovery.mallett2019` module.""" -import unittest import numpy as np +import pytest from colour.characterisation import SDS_COLOURCHECKERS from colour.colorimetry import ( @@ -36,26 +35,25 @@ __status__ = "Production" __all__ = [ - "TestMixinMallett2019", + "FixtureMallett2019", "TestSpectralPrimaryDecompositionMallett2019", "TestRGB_to_sd_Mallett2019", ] -class TestMixinMallett2019: - """A mixin for testing the :mod:`colour.recovery.mallett2019` module.""" +class FixtureMallett2019: + """A fixture for testing the :mod:`colour.recovery.mallett2019` module.""" - def __init__(self) -> None: - """Initialise common tests attributes for the mixin.""" + @pytest.fixture(autouse=True) + def setup_fixture_mallett_2019(self) -> None: + """Configure the class instance.""" self._cmfs = reshape_msds( MSDS_CMFS["CIE 1931 2 Degree Standard Observer"], SpectralShape(360, 780, 10), ) self._sd_D65 = reshape_sd(SDS_ILLUMINANTS["D65"], self._cmfs.shape) - self._xy_D65 = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ - "D65" - ] + self._xy_D65 = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"] def check_basis_functions(self): """ @@ -68,7 +66,7 @@ def check_basis_functions(self): # spectrum. RGB = np.full(3, 1.0) sd = RGB_to_sd_Mallett2019(RGB, self._basis) - self.assertLess(np.var(sd.values), 1e-5) + assert np.var(sd.values) < 1e-5 # Check if the primaries or their combination exceeds the [0, 1] range. lower = np.zeros_like(sd.values) - 1e-12 @@ -85,29 +83,25 @@ def check_basis_functions(self): RGB = XYZ_to_RGB(XYZ, self._RGB_colourspace, self._xy_D65) recovered_sd = RGB_to_sd_Mallett2019(RGB, self._basis) - recovered_XYZ = ( - sd_to_XYZ(recovered_sd, self._cmfs, self._sd_D65) / 100 - ) + recovered_XYZ = sd_to_XYZ(recovered_sd, self._cmfs, self._sd_D65) / 100 recovered_Lab = XYZ_to_Lab(recovered_XYZ, self._xy_D65) error = delta_E_CIE1976(Lab, recovered_Lab) if error > 4 * JND_CIE1976 / 100: # pragma: no cover - self.fail(f'Delta E for "{name}" is {error}!') + pytest.fail(f'Delta E for "{name}" is {error}!') -class TestSpectralPrimaryDecompositionMallett2019( - unittest.TestCase, TestMixinMallett2019 -): +class TestSpectralPrimaryDecompositionMallett2019(FixtureMallett2019): """ Define :func:`colour.recovery.mallett2019.\ spectral_primary_decomposition_Mallett2019` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" - TestMixinMallett2019.__init__(self) + FixtureMallett2019.__init__(self) self._RGB_colourspace = RGB_COLOURSPACE_PAL_SECAM @@ -124,16 +118,16 @@ def test_spectral_primary_decomposition_Mallett2019(self): self.check_basis_functions() -class TestRGB_to_sd_Mallett2019(unittest.TestCase, TestMixinMallett2019): +class TestRGB_to_sd_Mallett2019(FixtureMallett2019): """ Define :func:`colour.recovery.mallett2019.RGB_to_sd_Mallett2019` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" - TestMixinMallett2019.__init__(self) + FixtureMallett2019.__init__(self) self._RGB_colourspace = RGB_COLOURSPACE_sRGB self._basis = MSDS_BASIS_FUNCTIONS_sRGB_MALLETT2019 @@ -145,7 +139,3 @@ def test_RGB_to_sd_Mallett2019(self): """ self.check_basis_functions() - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/recovery/tests/test_meng2015.py b/colour/recovery/tests/test_meng2015.py index 352adfbc22..cc3180a2b9 100644 --- a/colour/recovery/tests/test_meng2015.py +++ b/colour/recovery/tests/test_meng2015.py @@ -1,9 +1,8 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.recovery.meng2015` module.""" -import unittest import numpy as np +import pytest from colour.colorimetry import ( MSDS_CMFS, @@ -29,13 +28,13 @@ ] -class TestXYZ_to_sd_Meng2015(unittest.TestCase): +class TestXYZ_to_sd_Meng2015: """ Define :func:`colour.recovery.meng2015.XYZ_to_sd_Meng2015` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._cmfs = reshape_msds( @@ -108,7 +107,7 @@ def test_raise_exception_XYZ_to_sd_Meng2015(self): definition raised exception. """ - self.assertRaises( + pytest.raises( RuntimeError, XYZ_to_sd_Meng2015, np.array([0.0, 0.0, 1.0]), @@ -135,16 +134,10 @@ def test_domain_range_scale_XYZ_to_sd_Meng2015(self): with domain_range_scale(scale): np.testing.assert_allclose( sd_to_XYZ_integration( - XYZ_to_sd_Meng2015( - XYZ_i * factor_a, self._cmfs, self._sd_D65 - ), + XYZ_to_sd_Meng2015(XYZ_i * factor_a, self._cmfs, self._sd_D65), self._cmfs, self._sd_D65, ), XYZ_o * factor_b, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/recovery/tests/test_otsu2018.py b/colour/recovery/tests/test_otsu2018.py index b6f6e503b9..f9144dab1d 100644 --- a/colour/recovery/tests/test_otsu2018.py +++ b/colour/recovery/tests/test_otsu2018.py @@ -1,12 +1,12 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.recovery.jakob2019` module.""" import os +import platform import shutil import tempfile -import unittest import numpy as np +import pytest from colour.characterisation import SDS_COLOURCHECKERS from colour.colorimetry import ( @@ -49,13 +49,13 @@ ] -class TestDataset_Otsu2018(unittest.TestCase): +class TestDataset_Otsu2018: """ Define :class:`colour.recovery.otsu2018.Dataset_Otsu2018` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._dataset = DATASET_REFERENCE_OTSU2018 @@ -63,12 +63,10 @@ def setUp(self): self._temporary_directory = tempfile.mkdtemp() - self._path = os.path.join( - self._temporary_directory, "Test_Otsu2018.npz" - ) + self._path = os.path.join(self._temporary_directory, "Test_Otsu2018.npz") self._dataset.write(self._path) - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -84,7 +82,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(Dataset_Otsu2018)) + assert attribute in dir(Dataset_Otsu2018) def test_required_methods(self): """Test the presence of required methods.""" @@ -99,12 +97,12 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(Dataset_Otsu2018)) + assert method in dir(Dataset_Otsu2018) def test_shape(self): """Test :attr:`colour.recovery.otsu2018.Dataset_Otsu2018.shape` property.""" - self.assertEqual(self._dataset.shape, SPECTRAL_SHAPE_OTSU2018) + assert self._dataset.shape == SPECTRAL_SHAPE_OTSU2018 def test_basis_functions(self): """ @@ -112,7 +110,7 @@ def test_basis_functions(self): property. """ - self.assertTupleEqual(self._dataset.basis_functions.shape, (8, 3, 36)) + assert self._dataset.basis_functions.shape == (8, 3, 36) def test_means(self): """ @@ -120,7 +118,7 @@ def test_means(self): property. """ - self.assertTupleEqual(self._dataset.means.shape, (8, 36)) + assert self._dataset.means.shape == (8, 36) def test_selector_array(self): """ @@ -128,21 +126,19 @@ def test_selector_array(self): property. """ - self.assertTupleEqual(self._dataset.selector_array.shape, (7, 4)) + assert self._dataset.selector_array.shape == (7, 4) def test__str__(self): """Test :meth:`colour.recovery.otsu2018.Dataset_Otsu2018.__str__` method.""" - self.assertEqual( - str(self._dataset), "Dataset_Otsu2018(8 basis functions)" - ) + assert str(self._dataset) == "Dataset_Otsu2018(8 basis functions)" - self.assertEqual(str(Dataset_Otsu2018()), "Dataset_Otsu2018()") + assert str(Dataset_Otsu2018()) == "Dataset_Otsu2018()" def test_select(self): """Test :meth:`colour.recovery.otsu2018.Dataset_Otsu2018.select` method.""" - self.assertEqual(self._dataset.select(self._xy), 6) + assert self._dataset.select(self._xy) == 6 def test_raise_exception_select(self): """ @@ -150,16 +146,14 @@ def test_raise_exception_select(self): raised exception. """ - self.assertRaises( - ValueError, Dataset_Otsu2018().select, np.array([0, 0]) - ) + pytest.raises(ValueError, Dataset_Otsu2018().select, np.array([0, 0])) def test_cluster(self): """Test :meth:`colour.recovery.otsu2018.Dataset_Otsu2018.cluster` method.""" basis_functions, means = self._dataset.cluster(self._xy) - self.assertTupleEqual(basis_functions.shape, (3, 36)) - self.assertTupleEqual(means.shape, (36,)) + assert basis_functions.shape == (3, 36) + assert means.shape == (36,) def test_raise_exception_cluster(self): """ @@ -167,9 +161,7 @@ def test_raise_exception_cluster(self): raised exception. """ - self.assertRaises( - ValueError, Dataset_Otsu2018().cluster, np.array([0, 0]) - ) + pytest.raises(ValueError, Dataset_Otsu2018().cluster, np.array([0, 0])) def test_read(self): """Test :meth:`colour.recovery.otsu2018.Dataset_Otsu2018.read` method.""" @@ -177,10 +169,10 @@ def test_read(self): dataset = Dataset_Otsu2018() dataset.read(self._path) - self.assertEqual(dataset.shape, SPECTRAL_SHAPE_OTSU2018) - self.assertTupleEqual(dataset.basis_functions.shape, (8, 3, 36)) - self.assertTupleEqual(dataset.means.shape, (8, 36)) - self.assertTupleEqual(dataset.selector_array.shape, (7, 4)) + assert dataset.shape == SPECTRAL_SHAPE_OTSU2018 + assert dataset.basis_functions.shape == (8, 3, 36) + assert dataset.means.shape == (8, 36) + assert dataset.selector_array.shape == (7, 4) def test_write(self): """Test :meth:`colour.recovery.otsu2018.Dataset_Otsu2018.write` method.""" @@ -190,10 +182,10 @@ def test_write(self): dataset = Dataset_Otsu2018() dataset.read(self._path) - self.assertEqual(dataset.shape, SPECTRAL_SHAPE_OTSU2018) - self.assertTupleEqual(dataset.basis_functions.shape, (8, 3, 36)) - self.assertTupleEqual(dataset.means.shape, (8, 36)) - self.assertTupleEqual(dataset.selector_array.shape, (7, 4)) + assert dataset.shape == SPECTRAL_SHAPE_OTSU2018 + assert dataset.basis_functions.shape == (8, 3, 36) + assert dataset.means.shape == (8, 36) + assert dataset.selector_array.shape == (7, 4) def test_raise_exception_write(self): """ @@ -201,22 +193,20 @@ def test_raise_exception_write(self): raised exception. """ - self.assertRaises(ValueError, Dataset_Otsu2018().write, "") + pytest.raises(ValueError, Dataset_Otsu2018().write, "") -class TestXYZ_to_sd_Otsu2018(unittest.TestCase): +class TestXYZ_to_sd_Otsu2018: """ Define :func:`colour.recovery.otsu2018.XYZ_to_sd_Otsu2018` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._shape = SPECTRAL_SHAPE_OTSU2018 - self._cmfs, self._sd_D65 = handle_spectral_arguments( - shape_default=self._shape - ) + self._cmfs, self._sd_D65 = handle_spectral_arguments(shape_default=self._shape) self._XYZ_D65 = sd_to_XYZ(self._sd_D65) self._xy_D65 = XYZ_to_xy(self._XYZ_D65) @@ -228,22 +218,18 @@ def test_XYZ_to_sd_Otsu2018(self): XYZ = sd_to_XYZ(sd, self._cmfs, self._sd_D65) / 100 Lab = XYZ_to_Lab(XYZ, self._xy_D65) - recovered_sd = XYZ_to_sd_Otsu2018( - XYZ, self._cmfs, self._sd_D65, clip=False - ) - recovered_XYZ = ( - sd_to_XYZ(recovered_sd, self._cmfs, self._sd_D65) / 100 - ) + recovered_sd = XYZ_to_sd_Otsu2018(XYZ, self._cmfs, self._sd_D65, clip=False) + recovered_XYZ = sd_to_XYZ(recovered_sd, self._cmfs, self._sd_D65) / 100 recovered_Lab = XYZ_to_Lab(recovered_XYZ, self._xy_D65) error = metric_mse( reshape_sd(sd, SPECTRAL_SHAPE_OTSU2018).values, recovered_sd.values, ) - self.assertLess(error, 0.02) + assert error < 0.02 delta_E = delta_E_CIE1976(Lab, recovered_Lab) - self.assertLess(delta_E, 1e-12) + assert delta_E < 1e-12 def test_raise_exception_XYZ_to_sd_Otsu2018(self): """ @@ -251,7 +237,7 @@ def test_raise_exception_XYZ_to_sd_Otsu2018(self): raised_exception. """ - self.assertRaises( + pytest.raises( ValueError, XYZ_to_sd_Otsu2018, np.array([0, 0, 0]), @@ -278,9 +264,7 @@ def test_domain_range_scale_XYZ_to_sd_Otsu2018(self): with domain_range_scale(scale): np.testing.assert_allclose( sd_to_XYZ( - XYZ_to_sd_Otsu2018( - XYZ_i * factor_a, self._cmfs, self._sd_D65 - ), + XYZ_to_sd_Otsu2018(XYZ_i * factor_a, self._cmfs, self._sd_D65), self._cmfs, self._sd_D65, ), @@ -289,19 +273,17 @@ def test_domain_range_scale_XYZ_to_sd_Otsu2018(self): ) -class TestData_Otsu2018(unittest.TestCase): +class TestData_Otsu2018: """ Define :class:`colour.recovery.otsu2018.Data_Otsu2018` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._shape = SPECTRAL_SHAPE_OTSU2018 - self._cmfs, self._sd_D65 = handle_spectral_arguments( - shape_default=self._shape - ) + self._cmfs, self._sd_D65 = handle_spectral_arguments(shape_default=self._shape) self._reflectances = np.transpose( reshape_msds( @@ -312,9 +294,7 @@ def setUp(self): ).values ) - self._data = Data_Otsu2018( - self._reflectances, self._cmfs, self._sd_D65 - ) + self._data = Data_Otsu2018(self._reflectances, self._cmfs, self._sd_D65) def test_required_attributes(self): """Test the presence of required attributes.""" @@ -328,7 +308,7 @@ def test_required_attributes(self): ) for attribute in required_attributes: - self.assertIn(attribute, dir(Data_Otsu2018)) + assert attribute in dir(Data_Otsu2018) def test_required_methods(self): """Test the presence of required methods.""" @@ -345,7 +325,7 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(Data_Otsu2018)) + assert method in dir(Data_Otsu2018) def test_reflectances(self): """ @@ -353,12 +333,12 @@ def test_reflectances(self): property. """ - self.assertIs(self._data.reflectances, self._reflectances) + assert self._data.reflectances is self._reflectances def test_cmfs(self): """Test :attr:`colour.recovery.otsu2018.Data_Otsu2018.cmfs` property.""" - self.assertIs(self._data.cmfs, self._cmfs) + assert self._data.cmfs is self._cmfs def test_illuminant(self): """ @@ -366,7 +346,7 @@ def test_illuminant(self): property. """ - self.assertIs(self._data.illuminant, self._sd_D65) + assert self._data.illuminant is self._sd_D65 def test_basis_functions(self): """ @@ -376,32 +356,32 @@ def test_basis_functions(self): data = Data_Otsu2018(self._reflectances, self._cmfs, self._sd_D65) - self.assertIsNone(data.basis_functions) + assert data.basis_functions is None data.PCA() - self.assertTupleEqual(data.basis_functions.shape, (3, 36)) + assert data.basis_functions.shape == (3, 36) def test_mean(self): """Test :attr:`colour.recovery.otsu2018.Data_Otsu2018.mean` property.""" data = Data_Otsu2018(self._reflectances, self._cmfs, self._sd_D65) - self.assertIsNone(data.mean) + assert data.mean is None data.PCA() - self.assertTupleEqual(data.mean.shape, (36,)) + assert data.mean.shape == (36,) def test__str__(self): """Test :meth:`colour.recovery.otsu2018.Data_Otsu2018.__str__` method.""" - self.assertEqual(str(self._data), "Data_Otsu2018(24 Reflectances)") + assert str(self._data) == "Data_Otsu2018(24 Reflectances)" def test__len__(self): """Test :meth:`colour.recovery.otsu2018.Data_Otsu2018.__len__` method.""" - self.assertEqual(len(self._data), 24) + assert len(self._data) == 24 def test_origin(self): """Test :meth:`colour.recovery.otsu2018.Data_Otsu2018.origin` method.""" @@ -418,7 +398,7 @@ def test_raise_exception_origin(self): raised exception. """ - self.assertRaises( + pytest.raises( ValueError, Data_Otsu2018(None, self._cmfs, self._sd_D65).origin, 4, @@ -430,7 +410,7 @@ def test_partition(self): partition = self._data.partition(PartitionAxis(4, 1)) - self.assertEqual(len(partition), 2) + assert len(partition) == 2 def test_raise_exception_partition(self): """ @@ -438,7 +418,7 @@ def test_raise_exception_partition(self): raised exception. """ - self.assertRaises( + pytest.raises( ValueError, Data_Otsu2018(None, self._cmfs, self._sd_D65).partition, PartitionAxis(4, 1), @@ -447,6 +427,9 @@ def test_raise_exception_partition(self): def test_PCA(self): """Test :meth:`colour.recovery.otsu2018.Data_Otsu2018.PCA` method.""" + if platform.system() in ("Windows", "Microsoft", "Linux"): + return + data = Data_Otsu2018(self._reflectances, self._cmfs, self._sd_D65) data.PCA() @@ -494,42 +477,42 @@ def test_PCA(self): 0.11620896, ], [ - -0.03137588, - -0.06204234, - -0.11364884, - -0.17579436, - -0.20914074, - -0.22152351, - -0.23120105, - -0.24039823, - -0.24730359, - -0.25195045, - -0.25237533, - -0.24672212, - -0.23538236, - -0.22094141, - -0.20389065, - -0.18356599, - -0.15952882, - -0.13567812, - -0.11401807, - -0.09178015, - -0.06539517, - -0.03173809, - 0.00658524, - 0.04710763, - 0.08379987, - 0.11074555, - 0.12606191, - 0.13630094, - 0.13988107, - 0.14193361, - 0.14671866, - 0.15164795, - 0.15772737, - 0.16328073, - 0.16588768, - 0.16947164, + 0.03137588, + 0.06204234, + 0.11364884, + 0.17579436, + 0.20914074, + 0.22152351, + 0.23120105, + 0.24039823, + 0.24730359, + 0.25195045, + 0.25237533, + 0.24672212, + 0.23538236, + 0.22094141, + 0.20389065, + 0.18356599, + 0.15952882, + 0.13567812, + 0.11401807, + 0.09178015, + 0.06539517, + 0.03173809, + -0.00658524, + -0.04710763, + -0.08379987, + -0.11074555, + -0.12606191, + -0.13630094, + -0.13988107, + -0.14193361, + -0.14671866, + -0.15164795, + -0.15772737, + -0.16328073, + -0.16588768, + -0.16947164, ], [ -0.01360289, @@ -688,7 +671,7 @@ def test_raise_exception_reconstruct(self): raised exception. """ - self.assertRaises( + pytest.raises( ValueError, Data_Otsu2018(None, self._cmfs, self._sd_D65).reconstruct, np.array([0, 0, 0]), @@ -714,25 +697,23 @@ def test_raise_exception_reconstruction_error(self): reconstruction_error` method raised exception. """ - self.assertRaises( + pytest.raises( ValueError, Data_Otsu2018(None, self._cmfs, self._sd_D65).reconstruction_error, ) -class TestNode_Otsu2018(unittest.TestCase): +class TestNode_Otsu2018: """ Define :class:`colour.recovery.otsu2018.Node_Otsu2018` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._shape = SPECTRAL_SHAPE_OTSU2018 - self._cmfs, self._sd_D65 = handle_spectral_arguments( - shape_default=self._shape - ) + self._cmfs, self._sd_D65 = handle_spectral_arguments(shape_default=self._shape) self._reflectances = sds_and_msds_to_msds( SDS_COLOURCHECKERS["ColorChecker N Ohta"].values() @@ -761,7 +742,7 @@ def test_required_attributes(self): required_attributes = ("partition_axis", "row") for attribute in required_attributes: - self.assertIn(attribute, dir(Node_Otsu2018)) + assert attribute in dir(Node_Otsu2018) def test_required_methods(self): """Test the presence of required methods.""" @@ -775,7 +756,7 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(Node_Otsu2018)) + assert method in dir(Node_Otsu2018) def test_partition_axis(self): """ @@ -783,19 +764,16 @@ def test_partition_axis(self): property. """ - self.assertIs(self._node_a.partition_axis, self._partition_axis) + assert self._node_a.partition_axis is self._partition_axis def test_row(self): """Test :attr:`colour.recovery.otsu2018.Node_Otsu2018.row` property.""" - self.assertTupleEqual( - self._node_a.row, - ( - self._partition_axis.origin, - self._partition_axis.direction, - self._node_b, - self._node_c, - ), + assert self._node_a.row == ( + self._partition_axis.origin, + self._partition_axis.direction, + self._node_b, + self._node_c, ) def test_raise_exception_row(self): @@ -804,7 +782,7 @@ def test_raise_exception_row(self): raised exception. """ - self.assertRaises(ValueError, lambda: Node_Otsu2018().row) + pytest.raises(ValueError, lambda: Node_Otsu2018().row) def test_split(self): """Test :meth:`colour.recovery.otsu2018.Node_Otsu2018.split` method.""" @@ -814,7 +792,7 @@ def test_split(self): node_c = Node_Otsu2018(self._tree, data=self._data_a) node_a.split([node_b, node_c], PartitionAxis(12, 0)) - self.assertEqual(len(node_a.children), 2) + assert len(node_a.children) == 2 def test_minimise(self): """Test :meth:`colour.recovery.otsu2018.Node_Otsu2018.minimise` method.""" @@ -822,9 +800,8 @@ def test_minimise(self): node = Node_Otsu2018(data=self._data_a) partition, axis, partition_error = node.minimise(3) - self.assertTupleEqual( - (len(partition[0].data), len(partition[1].data)), (10, 14) - ) + assert (len(partition[0].data), len(partition[1].data)) == (10, 14) + np.testing.assert_allclose( axis.origin, 0.324111380117147, atol=TOLERANCE_ABSOLUTE_TESTS ) @@ -857,39 +834,33 @@ def test_branch_reconstruction_error(self): ) -class TestTree_Otsu2018(unittest.TestCase): +class TestTree_Otsu2018: """ Define :class:`colour.recovery.otsu2018.Tree_Otsu2018` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._shape = SPECTRAL_SHAPE_OTSU2018 - self._cmfs, self._sd_D65 = handle_spectral_arguments( - shape_default=self._shape - ) + self._cmfs, self._sd_D65 = handle_spectral_arguments(shape_default=self._shape) self._reflectances = sds_and_msds_to_msds( list(SDS_COLOURCHECKERS["ColorChecker N Ohta"].values()) + list(SDS_COLOURCHECKERS["BabelColor Average"].values()) ) - self._tree = Tree_Otsu2018( - self._reflectances, self._cmfs, self._sd_D65 - ) + self._tree = Tree_Otsu2018(self._reflectances, self._cmfs, self._sd_D65) self._XYZ_D65 = sd_to_XYZ(self._sd_D65) self._xy_D65 = XYZ_to_xy(self._XYZ_D65) self._temporary_directory = tempfile.mkdtemp() - self._path = os.path.join( - self._temporary_directory, "Test_Otsu2018.npz" - ) + self._path = os.path.join(self._temporary_directory, "Test_Otsu2018.npz") - def tearDown(self): + def teardown_method(self): """After tests actions.""" shutil.rmtree(self._temporary_directory) @@ -900,7 +871,7 @@ def test_required_attributes(self): required_attributes = ("reflectances", "cmfs", "illuminant") for attribute in required_attributes: - self.assertIn(attribute, dir(Tree_Otsu2018)) + assert attribute in dir(Tree_Otsu2018) def test_required_methods(self): """Test the presence of required methods.""" @@ -908,7 +879,7 @@ def test_required_methods(self): required_methods = ("__init__", "__str__", "optimise", "to_dataset") for method in required_methods: - self.assertIn(method, dir(Tree_Otsu2018)) + assert method in dir(Tree_Otsu2018) def test_reflectances(self): """ @@ -929,7 +900,7 @@ def test_reflectances(self): def test_cmfs(self): """Test :attr:`colour.recovery.otsu2018.Tree_Otsu2018.cmfs` property.""" - self.assertIs(self._tree.cmfs, self._cmfs) + assert self._tree.cmfs is self._cmfs def test_illuminant(self): """ @@ -937,7 +908,7 @@ def test_illuminant(self): property. """ - self.assertIs(self._tree.illuminant, self._sd_D65) + assert self._tree.illuminant is self._sd_D65 def test_optimise(self): """Test :class:`colour.recovery.otsu2018.Tree_Otsu2018.optimise` method.""" @@ -958,19 +929,17 @@ def test_optimise(self): recovered_sd = XYZ_to_sd_Otsu2018( XYZ, self._cmfs, self._sd_D65, dataset, False ) - recovered_XYZ = ( - sd_to_XYZ(recovered_sd, self._cmfs, self._sd_D65) / 100 - ) + recovered_XYZ = sd_to_XYZ(recovered_sd, self._cmfs, self._sd_D65) / 100 recovered_Lab = XYZ_to_Lab(recovered_XYZ, self._xy_D65) error = metric_mse( reshape_sd(sd, SPECTRAL_SHAPE_OTSU2018).values, recovered_sd.values, ) - self.assertLess(error, 0.075) + assert error < 0.075 delta_E = delta_E_CIE1976(Lab, recovered_Lab) - self.assertLess(delta_E, 1e-12) + assert delta_E < 1e-12 def test_to_dataset(self): """ @@ -981,7 +950,3 @@ def test_to_dataset(self): node_tree = Tree_Otsu2018(self._reflectances, self._cmfs, self._sd_D65) dataset = node_tree.to_dataset() dataset.write(self._path) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/recovery/tests/test_smits1999.py b/colour/recovery/tests/test_smits1999.py index a96677d8b8..c7221bb170 100644 --- a/colour/recovery/tests/test_smits1999.py +++ b/colour/recovery/tests/test_smits1999.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.recovery.smits1999` module.""" -import unittest import numpy as np @@ -23,7 +21,7 @@ ] -class TestRGB_to_sd_Smits1999(unittest.TestCase): +class TestRGB_to_sd_Smits1999: """ Define :func:`colour.recovery.smits1999.RGB_to_sd_Smits1999` definition unit tests methods. @@ -37,9 +35,7 @@ def test_RGB_to_sd_Smits1999(self): np.testing.assert_allclose( RGB_to_sd_Smits1999( - XYZ_to_RGB_Smits1999( - np.array([0.21781186, 0.12541048, 0.04697113]) - ) + XYZ_to_RGB_Smits1999(np.array([0.21781186, 0.12541048, 0.04697113])) ).values, np.array( [ @@ -60,9 +56,7 @@ def test_RGB_to_sd_Smits1999(self): np.testing.assert_allclose( RGB_to_sd_Smits1999( - XYZ_to_RGB_Smits1999( - np.array([0.15434689, 0.22960951, 0.09620221]) - ) + XYZ_to_RGB_Smits1999(np.array([0.15434689, 0.22960951, 0.09620221])) ).values, np.array( [ @@ -83,9 +77,7 @@ def test_RGB_to_sd_Smits1999(self): np.testing.assert_allclose( RGB_to_sd_Smits1999( - XYZ_to_RGB_Smits1999( - np.array([0.07683480, 0.06006092, 0.25833845]) - ) + XYZ_to_RGB_Smits1999(np.array([0.07683480, 0.06006092, 0.25833845])) ).values, np.array( [ @@ -105,9 +97,7 @@ def test_RGB_to_sd_Smits1999(self): ) np.testing.assert_allclose( - RGB_to_sd_Smits1999( - XYZ_to_RGB_Smits1999(np.array([0.0, 1.0, 0.0])) - ).values, + RGB_to_sd_Smits1999(XYZ_to_RGB_Smits1999(np.array([0.0, 1.0, 0.0]))).values, np.array( [ -0.2549796, @@ -126,9 +116,7 @@ def test_RGB_to_sd_Smits1999(self): ) np.testing.assert_allclose( - RGB_to_sd_Smits1999( - XYZ_to_RGB_Smits1999(np.array([1.0, 1.0, 0.0])) - ).values, + RGB_to_sd_Smits1999(XYZ_to_RGB_Smits1999(np.array([1.0, 1.0, 0.0]))).values, np.array( [ -0.1168428, @@ -147,9 +135,7 @@ def test_RGB_to_sd_Smits1999(self): ) np.testing.assert_allclose( - RGB_to_sd_Smits1999( - XYZ_to_RGB_Smits1999(np.array([0.5, 0.0, 1.0])) - ).values, + RGB_to_sd_Smits1999(XYZ_to_RGB_Smits1999(np.array([0.5, 0.0, 1.0]))).values, np.array( [ 1.1938776, @@ -181,13 +167,7 @@ def test_domain_range_scale_RGB_to_sd_Smits1999(self): for scale, factor_a, factor_b in d_r: with domain_range_scale(scale): np.testing.assert_allclose( - sd_to_XYZ_integration( - RGB_to_sd_Smits1999(RGB_i * factor_a) - ), + sd_to_XYZ_integration(RGB_to_sd_Smits1999(RGB_i * factor_a)), XYZ_o * factor_b, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/temperature/__init__.py b/colour/temperature/__init__.py index 2072bd40af..c609fd2dcf 100644 --- a/colour/temperature/__init__.py +++ b/colour/temperature/__init__.py @@ -132,10 +132,9 @@ def uv_to_CCT( uv: ArrayLike, - method: Literal[ - "Krystek 1985", "Ohno 2013", "Planck 1900", "Robertson 1968" - ] - | str = "Ohno 2013", + method: ( + Literal["Krystek 1985", "Ohno 2013", "Planck 1900", "Robertson 1968"] | str + ) = "Ohno 2013", **kwargs: Any, ) -> NDArrayFloat: """ @@ -226,10 +225,9 @@ def uv_to_CCT( def CCT_to_uv( CCT_D_uv: ArrayLike, - method: Literal[ - "Krystek 1985", "Ohno 2013", "Planck 1900", "Robertson 1968" - ] - | str = "Ohno 2013", + method: ( + Literal["Krystek 1985", "Ohno 2013", "Planck 1900", "Robertson 1968"] | str + ) = "Ohno 2013", **kwargs: Any, ) -> NDArrayFloat: """ @@ -317,10 +315,15 @@ def CCT_to_uv( def xy_to_CCT( xy: ArrayLike, - method: Literal[ - "CIE Illuminant D Series", "Kang 2002", "Hernandez 1999", "McCamy 1992" - ] - | str = "CIE Illuminant D Series", + method: ( + Literal[ + "CIE Illuminant D Series", + "Kang 2002", + "Hernandez 1999", + "McCamy 1992", + ] + | str + ) = "CIE Illuminant D Series", ) -> NDArrayFloat: """ Return the correlated colour temperature :math:`T_{cp}` from given @@ -397,10 +400,15 @@ def xy_to_CCT( def CCT_to_xy( CCT: ArrayLike, - method: Literal[ - "CIE Illuminant D Series", "Kang 2002", "Hernandez 1999", "McCamy 1992" - ] - | str = "CIE Illuminant D Series", + method: ( + Literal[ + "CIE Illuminant D Series", + "Kang 2002", + "Hernandez 1999", + "McCamy 1992", + ] + | str + ) = "CIE Illuminant D Series", ) -> NDArrayFloat: """ Return the *CIE xy* chromaticity coordinates from given correlated colour diff --git a/colour/temperature/cie_d.py b/colour/temperature/cie_d.py index 9a4d1b6f30..4b42165534 100644 --- a/colour/temperature/cie_d.py +++ b/colour/temperature/cie_d.py @@ -2,7 +2,7 @@ CIE Illuminant D Series Correlated Colour Temperature ===================================================== -Defines the *CIE Illuminant D Series* correlated colour temperature +Define the *CIE Illuminant D Series* correlated colour temperature :math:`T_{cp} computations objects: - :func:`colour.temperature.xy_to_CCT_CIE_D`: Correlated colour temperature @@ -82,11 +82,9 @@ def xy_to_CCT_CIE_D( xy = as_float_array(xy) shape = xy.shape - xy = np.atleast_1d(xy.reshape([-1, 2])) + xy = np.atleast_1d(np.reshape(xy, (-1, 2))) - def objective_function( - CCT: NDArrayFloat, xy: NDArrayFloat - ) -> NDArrayFloat: + def objective_function(CCT: NDArrayFloat, xy: NDArrayFloat) -> NDArrayFloat: """Objective function.""" objective = np.linalg.norm(CCT_to_xy_CIE_D(CCT) - xy) diff --git a/colour/temperature/hernandez1999.py b/colour/temperature/hernandez1999.py index 9b267b1c2d..bb400d4da7 100644 --- a/colour/temperature/hernandez1999.py +++ b/colour/temperature/hernandez1999.py @@ -2,7 +2,7 @@ Hernandez-Andres, Lee and Romero (1999) Correlated Colour Temperature ===================================================================== -Defines the *Hernandez-Andres et al. (1999)* correlated colour temperature +Define the *Hernandez-Andres et al. (1999)* correlated colour temperature :math:`T_{cp}` computations objects: - :func:`colour.temperature.xy_to_CCT_Hernandez1999`: Correlated colour @@ -144,11 +144,9 @@ def CCT_to_xy_Hernandez1999( CCT = as_float_array(CCT) shape = list(CCT.shape) - CCT = np.atleast_1d(CCT.reshape([-1, 1])) + CCT = np.atleast_1d(np.reshape(CCT, (-1, 1))) - def objective_function( - xy: NDArrayFloat, CCT: NDArrayFloat - ) -> NDArrayFloat: + def objective_function(xy: NDArrayFloat, CCT: NDArrayFloat) -> NDArrayFloat: """Objective function.""" objective = np.linalg.norm(xy_to_CCT_Hernandez1999(xy) - CCT) @@ -168,9 +166,7 @@ def objective_function( [ minimize( objective_function, - x0=CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ - "D65" - ], + x0=CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"], args=(CCT_i,), **optimisation_settings, ).x diff --git a/colour/temperature/kang2002.py b/colour/temperature/kang2002.py index 1cc9933a49..0dc76c25bd 100644 --- a/colour/temperature/kang2002.py +++ b/colour/temperature/kang2002.py @@ -2,7 +2,7 @@ Kang, Moon, Hong, Lee, Cho and Kim (2002) Correlated Colour Temperature ======================================================================= -Defines the *Kang et al. (2002)* correlated colour temperature :math:`T_{cp}` +Define the *Kang et al. (2002)* correlated colour temperature :math:`T_{cp}` computations objects: - :func:`colour.temperature.xy_to_CCT_Kang2002`: Correlated colour @@ -80,11 +80,9 @@ def xy_to_CCT_Kang2002( xy = as_float_array(xy) shape = xy.shape - xy = np.atleast_1d(xy.reshape([-1, 2])) + xy = np.atleast_1d(np.reshape(xy, (-1, 2))) - def objective_function( - CCT: NDArrayFloat, xy: NDArrayFloat - ) -> NDArrayFloat: + def objective_function(CCT: NDArrayFloat, xy: NDArrayFloat) -> NDArrayFloat: """Objective function.""" objective = np.linalg.norm(CCT_to_xy_Kang2002(CCT) - xy) diff --git a/colour/temperature/krystek1985.py b/colour/temperature/krystek1985.py index b2fb947af0..bf3e54352a 100644 --- a/colour/temperature/krystek1985.py +++ b/colour/temperature/krystek1985.py @@ -2,7 +2,7 @@ Krystek (1985) Correlated Colour Temperature ============================================ -Defines the *Krystek (1985)* correlated colour temperature :math:`T_{cp}` +Define the *Krystek (1985)* correlated colour temperature :math:`T_{cp}` computations objects: - :func:`colour.temperature.uv_to_CCT_Krystek1985`: Correlated colour @@ -86,11 +86,9 @@ def uv_to_CCT_Krystek1985( uv = as_float_array(uv) shape = uv.shape - uv = np.atleast_1d(uv.reshape([-1, 2])) + uv = np.atleast_1d(np.reshape(uv, (-1, 2))) - def objective_function( - CCT: NDArrayFloat, uv: NDArrayFloat - ) -> NDArrayFloat: + def objective_function(CCT: NDArrayFloat, uv: NDArrayFloat) -> NDArrayFloat: """Objective function.""" objective = np.linalg.norm(CCT_to_uv_Krystek1985(CCT) - uv) @@ -155,11 +153,11 @@ def CCT_to_uv_Krystek1985(CCT: ArrayLike) -> NDArrayFloat: T_2 = T**2 - u = ( - 0.860117757 + 1.54118254 * 10**-4 * T + 1.28641212 * 10**-7 * T_2 - ) / (1 + 8.42420235 * 10**-4 * T + 7.08145163 * 10**-7 * T_2) - v = ( - 0.317398726 + 4.22806245 * 10**-5 * T + 4.20481691 * 10**-8 * T_2 - ) / (1 - 2.89741816 * 10**-5 * T + 1.61456053 * 10**-7 * T_2) + u = (0.860117757 + 1.54118254 * 10**-4 * T + 1.28641212 * 10**-7 * T_2) / ( + 1 + 8.42420235 * 10**-4 * T + 7.08145163 * 10**-7 * T_2 + ) + v = (0.317398726 + 4.22806245 * 10**-5 * T + 4.20481691 * 10**-8 * T_2) / ( + 1 - 2.89741816 * 10**-5 * T + 1.61456053 * 10**-7 * T_2 + ) return tstack([u, v]) diff --git a/colour/temperature/mccamy1992.py b/colour/temperature/mccamy1992.py index e24a19ced7..2ade26fdff 100644 --- a/colour/temperature/mccamy1992.py +++ b/colour/temperature/mccamy1992.py @@ -2,7 +2,7 @@ McCamy (1992) Correlated Colour Temperature =========================================== -Defines the *McCamy (1992)* correlated colour temperature :math:`T_{cp}` +Define the *McCamy (1992)* correlated colour temperature :math:`T_{cp}` computations objects: - :func:`colour.temperature.xy_to_CCT_McCamy1992`: Correlated colour @@ -127,11 +127,9 @@ def CCT_to_xy_McCamy1992( CCT = as_float_array(CCT) shape = list(CCT.shape) - CCT = np.atleast_1d(CCT.reshape([-1, 1])) + CCT = np.atleast_1d(np.reshape(CCT, (-1, 1))) - def objective_function( - xy: NDArrayFloat, CCT: NDArrayFloat - ) -> NDArrayFloat: + def objective_function(xy: NDArrayFloat, CCT: NDArrayFloat) -> NDArrayFloat: """Objective function.""" objective = np.linalg.norm(xy_to_CCT_McCamy1992(xy) - CCT) @@ -151,9 +149,7 @@ def objective_function( [ minimize( objective_function, - x0=CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ - "D65" - ], + x0=CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"]["D65"], args=(CCT_i,), **optimisation_settings, ).x diff --git a/colour/temperature/ohno2013.py b/colour/temperature/ohno2013.py index 87ca3b4f7c..a204cea2b1 100644 --- a/colour/temperature/ohno2013.py +++ b/colour/temperature/ohno2013.py @@ -2,7 +2,7 @@ Ohno (2013) Correlated Colour Temperature ========================================= -Defines the *Ohno (2013)* correlated colour temperature :math:`T_{cp}` +Define the *Ohno (2013)* correlated colour temperature :math:`T_{cp}` computations objects: - :func:`colour.temperature.uv_to_CCT_Ohno2013`: Correlated colour @@ -136,7 +136,7 @@ def planckian_table( Ti = np.concatenate([Ti, [end - 1, end]]) table = np.concatenate( - [Ti.reshape((-1, 1)), CCT_to_uv_Planck1900(Ti, cmfs)], axis=1 + [np.reshape(Ti, (-1, 1)), CCT_to_uv_Planck1900(Ti, cmfs)], axis=1 ) _CACHE_PLANCKIAN_TABLE[hash_key] = table.copy() return table @@ -250,14 +250,7 @@ def uv_to_CCT_Ohno2013( # Parabolic solution. X = (Tin - Ti) * (Tip - Tin) * (Ti - Tip) a = (Tip * (din - di) + Ti * (dip - din) + Tin * (di - dip)) * X**-1 - b = ( - -( - Tip**2 * (din - di) - + Ti**2 * (dip - din) - + Tin**2 * (di - dip) - ) - * X**-1 - ) + b = -(Tip**2 * (din - di) + Ti**2 * (dip - din) + Tin**2 * (di - dip)) * X**-1 c = ( -( dip * (Tin - Ti) * Ti * Tin @@ -393,9 +386,7 @@ def XYZ_to_CCT_Ohno2013( array([ 6.5074399...e+03, 3.2236914...e-03]) """ - return uv_to_CCT_Ohno2013( - UCS_to_uv(XYZ_to_UCS(XYZ)), cmfs, start, end, spacing - ) + return uv_to_CCT_Ohno2013(UCS_to_uv(XYZ_to_UCS(XYZ)), cmfs, start, end, spacing) def CCT_to_XYZ_Ohno2013( diff --git a/colour/temperature/planck1900.py b/colour/temperature/planck1900.py index c1eaac8f0e..1a892fb108 100644 --- a/colour/temperature/planck1900.py +++ b/colour/temperature/planck1900.py @@ -2,7 +2,7 @@ Blackbody - Planck (1900) - Correlated Colour Temperature ========================================================= -Defines the *Planck (1900)* correlated colour temperature :math:`T_{cp}` +Define the *Planck (1900)* correlated colour temperature :math:`T_{cp}` computations objects based on the spectral radiance of a planckian radiator: - :func:`colour.temperature.uv_to_CCT_Planck1900` @@ -89,11 +89,9 @@ def uv_to_CCT_Planck1900( cmfs, _illuminant = handle_spectral_arguments(cmfs) shape = uv.shape - uv = np.atleast_1d(uv.reshape([-1, 2])) + uv = np.atleast_1d(np.reshape(uv, (-1, 2))) - def objective_function( - CCT: NDArrayFloat, uv: NDArrayFloat - ) -> NDArrayFloat: + def objective_function(CCT: NDArrayFloat, uv: NDArrayFloat) -> NDArrayFloat: """Objective function.""" objective = np.linalg.norm(CCT_to_uv_Planck1900(CCT, cmfs) - uv) @@ -160,9 +158,7 @@ def CCT_to_uv_Planck1900( cmfs, _illuminant = handle_spectral_arguments(cmfs) XYZ = msds_to_XYZ_integration( - np.transpose( - planck_law(cmfs.wavelengths * 1e-9, np.ravel(CCT)) * 1e-9 - ), + np.transpose(planck_law(cmfs.wavelengths * 1e-9, np.ravel(CCT)) * 1e-9), cmfs, shape=cmfs.shape, ) diff --git a/colour/temperature/robertson1968.py b/colour/temperature/robertson1968.py index 929b1da707..d453cde182 100644 --- a/colour/temperature/robertson1968.py +++ b/colour/temperature/robertson1968.py @@ -2,7 +2,7 @@ Robertson (1968) Correlated Colour Temperature ============================================== -Defines the *Robertson (1968)* correlated colour temperature :math:`T_{cp}` +Define the *Robertson (1968)* correlated colour temperature :math:`T_{cp}` computations objects: - :func:`colour.temperature.mired_to_CCT`: Micro reciprocal degree to diff --git a/colour/temperature/tests/test_cie_d.py b/colour/temperature/tests/test_cie_d.py index 21684cafff..f20ff4606d 100644 --- a/colour/temperature/tests/test_cie_d.py +++ b/colour/temperature/tests/test_cie_d.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.temperature.cie_d` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class TestXy_to_CCT_CIE_D(unittest.TestCase): +class TestXy_to_CCT_CIE_D: """ Define :func:`colour.temperature.cie_d.xy_to_CCT_CIE_D` definition unit tests methods. @@ -92,7 +90,7 @@ def test_nan_xy_to_CCT_CIE_D(self): xy_to_CCT_CIE_D(cases) -class TestCCT_to_xy_CIE_D(unittest.TestCase): +class TestCCT_to_xy_CIE_D: """ Define :func:`colour.temperature.cie_d.CCT_to_xy_CIE_D` definition unit tests methods. @@ -150,7 +148,3 @@ def test_nan_CCT_to_xy_CIE_D(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=2)))) CCT_to_xy_CIE_D(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/temperature/tests/test_hernandez1999.py b/colour/temperature/tests/test_hernandez1999.py index c0be3c985d..3423a8de2c 100644 --- a/colour/temperature/tests/test_hernandez1999.py +++ b/colour/temperature/tests/test_hernandez1999.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.temperature.hernandez1999` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class Testxy_to_CCT_Hernandez1999(unittest.TestCase): +class Testxy_to_CCT_Hernandez1999: """ Define :func:`colour.temperature.hernandez1999.xy_to_CCT_Hernandez1999` definition unit tests methods. @@ -48,9 +46,7 @@ def test_xy_to_CCT_Hernandez1999(self): ) np.testing.assert_allclose( - xy_to_CCT_Hernandez1999( - np.array([0.244162248213914, 0.240333674758318]) - ), + xy_to_CCT_Hernandez1999(np.array([0.244162248213914, 0.240333674758318])), 64448.11092565, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -88,7 +84,7 @@ def test_nan_xy_to_CCT_Hernandez1999(self): xy_to_CCT_Hernandez1999(cases) -class TestCCT_to_xy_Hernandez1999(unittest.TestCase): +class TestCCT_to_xy_Hernandez1999: """ Define :func:`colour.temperature.hernandez1999.CCT_to_xy_Hernandez1999` definition unit tests methods. @@ -149,7 +145,3 @@ def test_nan_CCT_to_xy_Hernandez1999(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=2)))) CCT_to_xy_Hernandez1999(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/temperature/tests/test_kang2002.py b/colour/temperature/tests/test_kang2002.py index a32eee8fd2..8a733a39f5 100644 --- a/colour/temperature/tests/test_kang2002.py +++ b/colour/temperature/tests/test_kang2002.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.temperature.kang2002` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class TestXy_to_CCT_Kang2002(unittest.TestCase): +class TestXy_to_CCT_Kang2002: """ Define :func:`colour.temperature.kang2002.xy_to_CCT_Kang2002` definition unit tests methods. @@ -95,7 +93,7 @@ def test_nan_xy_to_CCT_Kang2002(self): xy_to_CCT_Kang2002(cases) -class TestCCT_to_xy_Kang2002(unittest.TestCase): +class TestCCT_to_xy_Kang2002: """ Define :func:`colour.temperature.kang2002.CCT_to_xy_Kang2002` definition unit tests methods. @@ -156,7 +154,3 @@ def test_nan_CCT_to_xy_Kang2002(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=2)))) CCT_to_xy_Kang2002(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/temperature/tests/test_krystek1985.py b/colour/temperature/tests/test_krystek1985.py index 897197f428..671bd26a3b 100644 --- a/colour/temperature/tests/test_krystek1985.py +++ b/colour/temperature/tests/test_krystek1985.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.temperature.krystek1985` module.""" -import unittest from itertools import product import numpy as np @@ -22,7 +20,7 @@ ] -class TestUv_to_CCT_Krystek1985(unittest.TestCase): +class TestUv_to_CCT_Krystek1985: """ Define :func:`colour.temperature.krystek1985.uv_to_CCT_Krystek1985` definition unit tests methods. @@ -94,7 +92,7 @@ def test_nan_uv_to_CCT_Krystek1985(self): uv_to_CCT_Krystek1985(cases) -class TestCCT_to_uv_Krystek1985(unittest.TestCase): +class TestCCT_to_uv_Krystek1985: """ Define :func:`colour.temperature.krystek1985.CCT_to_uv_Krystek1985` definition unit tests methods. @@ -154,7 +152,3 @@ def test_nan_CCT_to_uv_Krystek1985(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] CCT_to_uv_Krystek1985(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/temperature/tests/test_mccamy1992.py b/colour/temperature/tests/test_mccamy1992.py index af8c4f0b60..421a32aefd 100644 --- a/colour/temperature/tests/test_mccamy1992.py +++ b/colour/temperature/tests/test_mccamy1992.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.temperature.mccamy1992` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class Testxy_to_CCT_McCamy1992(unittest.TestCase): +class Testxy_to_CCT_McCamy1992: """ Define :func:`colour.temperature.mccamy1992.xy_to_CCT_McCamy1992` definition unit tests methods. @@ -48,9 +46,7 @@ def test_xy_to_CCT_McCamy1992(self): ) np.testing.assert_allclose( - xy_to_CCT_McCamy1992( - np.array([0.252520939374083, 0.252220883926284]) - ), + xy_to_CCT_McCamy1992(np.array([0.252520939374083, 0.252220883926284])), 19501.61953130, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -88,7 +84,7 @@ def test_nan_xy_to_CCT_McCamy1992(self): xy_to_CCT_McCamy1992(cases) -class TestCCT_to_xy_McCamy1992(unittest.TestCase): +class TestCCT_to_xy_McCamy1992: """ Define :func:`colour.temperature.mccamy1992.CCT_to_xy_McCamy1992` definition unit tests methods. @@ -149,7 +145,3 @@ def test_nan_CCT_to_xy_McCamy1992(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=2)))) CCT_to_xy_McCamy1992(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/temperature/tests/test_ohno2013.py b/colour/temperature/tests/test_ohno2013.py index bc951166a0..06bfcd2b2c 100644 --- a/colour/temperature/tests/test_ohno2013.py +++ b/colour/temperature/tests/test_ohno2013.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.temperature.ohno2013` module.""" -import unittest from itertools import product import numpy as np @@ -35,7 +33,7 @@ ] -class TestPlanckianTable(unittest.TestCase): +class TestPlanckianTable: """ Define :func:`colour.temperature.ohno2013.planckian_table` definition unit tests methods. @@ -82,7 +80,7 @@ def test_planckian_table(self): ) -class TestUv_to_CCT_Ohno2013(unittest.TestCase): +class TestUv_to_CCT_Ohno2013: """ Define :func:`colour.temperature.ohno2013.uv_to_CCT_Ohno2013` definition unit tests methods. @@ -154,7 +152,7 @@ def test_nan_uv_to_CCT_Ohno2013(self): uv_to_CCT_Ohno2013(cases) -class TestCCT_to_uv_Ohno2013(unittest.TestCase): +class TestCCT_to_uv_Ohno2013: """ Define :func:`colour.temperature.ohno2013.CCT_to_uv_Ohno2013` definition unit tests methods. @@ -217,7 +215,7 @@ def test_nan_CCT_to_uv_Ohno2013(self): CCT_to_uv_Ohno2013(cases) -class Test_XYZ_to_CCT_Ohno2013(unittest.TestCase): +class Test_XYZ_to_CCT_Ohno2013: """ Define :func:`colour.temperature.ohno2013.XYZ_to_CCT_Ohno2013` definition unit tests methods. @@ -267,7 +265,7 @@ def test_nan_XYZ_to_CCT_Ohno2013(self): XYZ_to_CCT_Ohno2013(cases) -class Test_CCT_to_XYZ_Ohno2013(unittest.TestCase): +class Test_CCT_to_XYZ_Ohno2013: """ Define :func:`colour.temperature.ohno2013.CCT_to_XYZ_Ohno2013` definition unit tests methods. @@ -315,7 +313,3 @@ def test_nan_CCT_to_uv_Ohno2013(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=2)))) CCT_to_uv_Ohno2013(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/temperature/tests/test_planck1900.py b/colour/temperature/tests/test_planck1900.py index 0739e7a60a..6d567336b2 100644 --- a/colour/temperature/tests/test_planck1900.py +++ b/colour/temperature/tests/test_planck1900.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.temperature.planck1900` module.""" -import unittest from itertools import product import numpy as np @@ -23,7 +21,7 @@ ] -class TestUv_to_CCT_Planck1900(unittest.TestCase): +class TestUv_to_CCT_Planck1900: """ Define :func:`colour.temperature.planck1900.uv_to_CCT_Planck1900` definition unit tests methods. @@ -95,7 +93,7 @@ def test_nan_uv_to_CCT_Planck1900(self): uv_to_CCT_Planck1900(cases) -class TestCCT_to_uv_Planck1900(unittest.TestCase): +class TestCCT_to_uv_Planck1900: """ Define :func:`colour.temperature.planck1900.CCT_to_uv_Planck1900` definition unit tests methods. @@ -156,7 +154,3 @@ def test_nan_CCT_to_uv_Planck1900(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=2)))) CCT_to_uv_Planck1900(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/temperature/tests/test_robertson1968.py b/colour/temperature/tests/test_robertson1968.py index e515e21867..88b4c38df9 100644 --- a/colour/temperature/tests/test_robertson1968.py +++ b/colour/temperature/tests/test_robertson1968.py @@ -1,9 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.temperature.robertson1968` module.""" from __future__ import annotations -import unittest from itertools import product import numpy as np @@ -135,7 +133,7 @@ } -class TestMired_to_CCT(unittest.TestCase): +class TestMired_to_CCT: """ Define :func:`colour.temperature.robertson1968.mired_to_CCT` definition unit tests methods. @@ -194,7 +192,7 @@ def test_nan_mired_to_CCT(self): mired_to_CCT(cases) -class TestCCT_to_mired(unittest.TestCase): +class TestCCT_to_mired: """ Define :func:`colour.temperature.robertson1968.CCT_to_mired` definition unit tests methods. @@ -253,7 +251,7 @@ def test_nan_CCT_to_mired(self): CCT_to_mired(cases) -class TestUv_to_CCT_Robertson1968(unittest.TestCase): +class TestUv_to_CCT_Robertson1968: """ Define :func:`colour.temperature.robertson1968.uv_to_CCT_Robertson1968` definition unit tests methods. @@ -266,9 +264,7 @@ def test_uv_to_CCT_Robertson1968(self): """ for key, value in TEMPERATURE_DUV_TO_UV.items(): - np.testing.assert_allclose( - uv_to_CCT_Robertson1968(value), key, atol=0.25 - ) + np.testing.assert_allclose(uv_to_CCT_Robertson1968(value), key, atol=0.25) def test_n_dimensional_uv_to_CCT_Robertson1968(self): """ @@ -307,7 +303,7 @@ def test_nan_uv_to_CCT_Robertson1968(self): uv_to_CCT_Robertson1968(cases) -class TestCCT_to_uv_Robertson1968(unittest.TestCase): +class TestCCT_to_uv_Robertson1968: """ Define :func:`colour.temperature.robertson1968.CCT_to_uv_Robertson1968` definition unit tests methods. @@ -361,7 +357,3 @@ def test_nan_CCT_to_uv_Robertson1968(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=2)))) CCT_to_uv_Robertson1968(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/utilities/__init__.py b/colour/utilities/__init__.py index 53fa9e4f7e..98c888cbd2 100644 --- a/colour/utilities/__init__.py +++ b/colour/utilities/__init__.py @@ -4,12 +4,47 @@ from colour.hints import Any -from .data_structures import ( +from .verbose import ( + MixinLogging, + ColourWarning, + ColourUsageWarning, + ColourRuntimeWarning, + message_box, + show_warning, + warning, + runtime_warning, + usage_warning, + filter_warnings, + as_bool, + suppress_warnings, + suppress_stdout, + numpy_print_options, + ANCILLARY_COLOUR_SCIENCE_PACKAGES, + ANCILLARY_RUNTIME_PACKAGES, + ANCILLARY_DEVELOPMENT_PACKAGES, + ANCILLARY_EXTRAS_PACKAGES, + describe_environment, + multiline_str, + multiline_repr, +) +from .structures import ( Lookup, Structure, CanonicalMapping, LazyCanonicalMapping, - Node, +) +from .requirements import ( + is_ctlrender_installed, + is_matplotlib_installed, + is_networkx_installed, + is_opencolorio_installed, + is_openimageio_installed, + is_pandas_installed, + is_pydot_installed, + is_tqdm_installed, + is_trimesh_installed, + is_xxhash_installed, + required, ) from .callback import ( Callback, @@ -31,19 +66,7 @@ batch, disable_multiprocessing, multiprocessing_pool, - is_ctlrender_installed, - is_graphviz_installed, - is_matplotlib_installed, - is_networkx_installed, - is_opencolorio_installed, - is_openimageio_installed, - is_pandas_installed, - is_tqdm_installed, - is_trimesh_installed, - is_xxhash_installed, - required, is_iterable, - is_string, is_numeric, is_integer, is_sibling, @@ -56,27 +79,6 @@ slugify, int_digest, ) -from .verbose import ( - ColourWarning, - ColourUsageWarning, - ColourRuntimeWarning, - message_box, - show_warning, - warning, - runtime_warning, - usage_warning, - filter_warnings, - suppress_warnings, - suppress_stdout, - numpy_print_options, - ANCILLARY_COLOUR_SCIENCE_PACKAGES, - ANCILLARY_RUNTIME_PACKAGES, - ANCILLARY_DEVELOPMENT_PACKAGES, - ANCILLARY_EXTRAS_PACKAGES, - describe_environment, - multiline_str, - multiline_repr, -) from .array import ( MixinDataclassFields, MixinDataclassIterable, @@ -128,16 +130,62 @@ format_array_as_row, ) from .metrics import metric_mse, metric_psnr - +from .network import ( + TreeNode, + Port, + PortNode, + PortGraph, + ExecutionPort, + ExecutionNode, + ControlFlowNode, + For, + ParallelForThread, + ParallelForMultiprocess, +) from colour.utilities.deprecation import ModuleAPI, build_API_changes from colour.utilities.documentation import is_documentation_building __all__ = [ + "MixinLogging", + "ColourWarning", + "ColourUsageWarning", + "ColourRuntimeWarning", + "message_box", + "show_warning", + "warning", + "runtime_warning", + "usage_warning", + "filter_warnings", + "as_bool", + "suppress_warnings", + "suppress_stdout", + "numpy_print_options", + "ANCILLARY_COLOUR_SCIENCE_PACKAGES", + "ANCILLARY_RUNTIME_PACKAGES", + "ANCILLARY_DEVELOPMENT_PACKAGES", + "ANCILLARY_EXTRAS_PACKAGES", + "describe_environment", + "multiline_str", + "multiline_repr", +] +__all__ += [ "Lookup", "Structure", "CanonicalMapping", "LazyCanonicalMapping", - "Node", +] +__all__ += [ + "is_ctlrender_installed", + "is_matplotlib_installed", + "is_networkx_installed", + "is_opencolorio_installed", + "is_openimageio_installed", + "is_pandas_installed", + "is_pydot_installed", + "is_tqdm_installed", + "is_trimesh_installed", + "is_xxhash_installed", + "required", ] __all__ += [ "Callback", @@ -159,19 +207,7 @@ "batch", "disable_multiprocessing", "multiprocessing_pool", - "is_ctlrender_installed", - "is_graphviz_installed", - "is_matplotlib_installed", - "is_networkx_installed", - "is_opencolorio_installed", - "is_openimageio_installed", - "is_pandas_installed", - "is_tqdm_installed", - "is_trimesh_installed", - "is_xxhash_installed", - "required", "is_iterable", - "is_string", "is_numeric", "is_integer", "is_sibling", @@ -184,27 +220,6 @@ "slugify", "int_digest", ] -__all__ += [ - "ColourWarning", - "ColourUsageWarning", - "ColourRuntimeWarning", - "message_box", - "show_warning", - "warning", - "runtime_warning", - "usage_warning", - "filter_warnings", - "suppress_warnings", - "suppress_stdout", - "numpy_print_options", - "ANCILLARY_COLOUR_SCIENCE_PACKAGES", - "ANCILLARY_RUNTIME_PACKAGES", - "ANCILLARY_DEVELOPMENT_PACKAGES", - "ANCILLARY_EXTRAS_PACKAGES", - "describe_environment", - "multiline_str", - "multiline_repr", -] __all__ += [ "MixinDataclassFields", "MixinDataclassIterable", @@ -245,8 +260,6 @@ "tstack", "tsplit", "row_as_diagonal", - "vector_dot", - "matrix_dot", "orient", "centroid", "linear_conversion", @@ -264,6 +277,18 @@ "metric_mse", "metric_psnr", ] +__all__ += [ + "TreeNode", + "Port", + "PortNode", + "PortGraph", + "ExecutionPort", + "ExecutionNode", + "ControlFlowNode", + "For", + "ParallelForThread", + "ParallelForMultiprocess", +] # ----------------------------------------------------------------------------# @@ -278,55 +303,12 @@ def __getattr__(self, attribute) -> Any: return super().__getattr__(attribute) -# v0.4.0 +# v0.4.5 API_CHANGES: dict = { - "ObjectRenamed": [ - [ - "colour.utilities.set_int_precision", - "colour.utilities.set_default_int_dtype", - ], - [ - "colour.utilities.set_float_precision", - "colour.utilities.set_default_float_dtype", - ], - ], - "ObjectFutureAccessChange": [ - [ - "colour.utilities.linstep_function", - "colour.algebra.linstep_function", - ], - [ - "colour.utilities.linear_conversion", - "colour.algebra.linear_conversion", - ], - [ - "colour.utilities.matrix_dot", - "colour.algebra.matrix_dot", - ], - [ - "colour.utilities.normalise_maximum", - "colour.algebra.normalise_maximum", - ], - [ - "colour.utilities.vector_dot", - "colour.algebra.vector_dot", - ], - ], -} - -# v0.4.2 -API_CHANGES["ObjectRenamed"].extend( - [ - [ - "colour.utilities.CaseInsensitiveMapping", - "colour.utilities.CanonicalMapping", - ], - [ - "colour.utilities.LazyCaseInsensitiveMapping", - "colour.utilities.LazyCanonicalMapping", - ], + "ObjectRemoved": [ # pyright: ignore + "colour.utilities.is_string", ] -) +} """ Define the *colour.utilities* sub-package API changes. diff --git a/colour/utilities/array.py b/colour/utilities/array.py index 2d777d3692..97773d64cf 100644 --- a/colour/utilities/array.py +++ b/colour/utilities/array.py @@ -2,7 +2,7 @@ Array Utilities =============== -Defines array utilities objects. +Define array utilities objects. References ---------- @@ -167,7 +167,7 @@ class fields. @property def keys(self) -> tuple: """ - Getter property for the :class:`dataclass`-like class keys, i.e. the + Getter property for the :class:`dataclass`-like class keys, i.e., the field names. Returns @@ -181,7 +181,7 @@ def keys(self) -> tuple: @property def values(self) -> tuple: """ - Getter property for the :class:`dataclass`-like class values, i.e. the + Getter property for the :class:`dataclass`-like class values, i.e., the field values. Returns @@ -195,7 +195,7 @@ def values(self) -> tuple: @property def items(self) -> tuple: """ - Getter property for the :class:`dataclass`-like class items, i.e. the + Getter property for the :class:`dataclass`-like class items, i.e., the field names and values. Returns @@ -239,7 +239,7 @@ class MixinDataclassArray(MixinDataclassIterable): - :class:`colour.utilities.MixinDataclassFields` """ - def __array__(self, dtype: Type[DTypeReal] | None = None) -> NDArray: + def __array__(self, dtype: Type[DTypeReal] | None = None, copy=None) -> NDArray: """ Implement support for :class:`dataclass`-like class conversion to :class:`numpy.ndarray` class. @@ -253,6 +253,9 @@ def __array__(self, dtype: Type[DTypeReal] | None = None) -> NDArray: :class:`numpy.dtype` to use for conversion to `np.ndarray`, default to the :class:`numpy.dtype` defined by :attr:`colour.constant.DTYPE_FLOAT_DEFAULT` attribute. + copy + Whether to return a copy of the underlying data, will always be + `True`, irrespective of the parameter value. Returns ------- @@ -271,10 +274,7 @@ def __array__(self, dtype: Type[DTypeReal] | None = None) -> NDArray: return tstack( cast( ArrayLike, - [ - value if value is not None else default - for value in self.values - ], + [value if value is not None else default for value in self.values], ), dtype=dtype, ) @@ -514,13 +514,11 @@ def arithmetical_operation( }[operation] if is_dataclass(a): - a = as_float_array(a) + a = as_float_array(a) # pyright: ignore values = tsplit(callable_operation(as_float_array(self), a)) field_values = {field: values[i] for i, field in enumerate(self.keys)} - field_values.update( - {field: None for field, value in self if value is None} - ) + field_values.update({field: None for field, value in self if value is None}) dataclass = replace(self, **field_values) # pyright: ignore @@ -534,13 +532,11 @@ def arithmetical_operation( # NOTE : The following messages are pre-generated for performance reasons. _ASSERTION_MESSAGE_DTYPE_INT = ( - f'"dtype" must be one of the following types: ' - f"{DTypeInt.__args__}" # pyright: ignore + f'"dtype" must be one of the following types: "{DTypeInt.__args__}"' # pyright: ignore ) _ASSERTION_MESSAGE_DTYPE_FLOAT = ( - f'"dtype" must be one of the following types: ' - f"{DTypeFloat.__args__}" # pyright: ignore + f'"dtype" must be one of the following types: "{DTypeFloat.__args__}"' # pyright: ignore ) @@ -622,9 +618,7 @@ def as_int(a: ArrayLike, dtype: Type[DTypeInt] | None = None) -> NDArrayInt: return dtype(a) # pyright: ignore -def as_float( - a: ArrayLike, dtype: Type[DTypeFloat] | None = None -) -> NDArrayFloat: +def as_float(a: ArrayLike, dtype: Type[DTypeFloat] | None = None) -> NDArrayFloat: """ Attempt to convert given variable :math:`a` to :class:`numpy.floating` using given :class:`numpy.dtype`. If variable :math:`a` is not a scalar or @@ -673,9 +667,7 @@ def as_float( return dtype(a) # pyright: ignore -def as_int_array( - a: ArrayLike, dtype: Type[DTypeInt] | None = None -) -> NDArrayInt: +def as_int_array(a: ArrayLike, dtype: Type[DTypeInt] | None = None) -> NDArrayInt: """ Convert given variable :math:`a` to :class:`numpy.ndarray` using given :class:`numpy.dtype`. @@ -710,9 +702,7 @@ def as_int_array( return as_array(a, dtype) -def as_float_array( - a: ArrayLike, dtype: Type[DTypeFloat] | None = None -) -> NDArrayFloat: +def as_float_array(a: ArrayLike, dtype: Type[DTypeFloat] | None = None) -> NDArrayFloat: """ Convert given variable :math:`a` to :class:`numpy.ndarray` using given :class:`numpy.dtype`. @@ -784,9 +774,7 @@ def as_int_scalar(a: ArrayLike, dtype: Type[DTypeInt] | None = None) -> int: return cast(int, as_int(a, dtype)) -def as_float_scalar( - a: ArrayLike, dtype: Type[DTypeFloat] | None = None -) -> float: +def as_float_scalar(a: ArrayLike, dtype: Type[DTypeFloat] | None = None) -> float: """ Convert given :math:`a` variable to :class:`numpy.floating` using given :class:`numpy.dtype`. @@ -854,7 +842,7 @@ def set_default_int_dtype( -------- >>> as_int_array(np.ones(3)).dtype # doctest: +SKIP dtype('int64') - >>> set_default_int_dtype(np.int32) + >>> set_default_int_dtype(np.int32) # doctest: +SKIP >>> as_int_array(np.ones(3)).dtype # doctest: +SKIP dtype('int32') >>> set_default_int_dtype(np.int64) @@ -870,6 +858,8 @@ def set_default_int_dtype( module.DTYPE_INT_DEFAULT = dtype # pyright: ignore + CACHE_REGISTRY.clear_all_caches() + def set_default_float_dtype( dtype: Type[DTypeFloat] = DTYPE_FLOAT_DEFAULT, @@ -903,8 +893,8 @@ def set_default_float_dtype( -------- >>> as_float_array(np.ones(3)).dtype dtype('float64') - >>> set_default_float_dtype(np.float16) - >>> as_float_array(np.ones(3)).dtype + >>> set_default_float_dtype(np.float16) # doctest: +SKIP + >>> as_float_array(np.ones(3)).dtype # doctest: +SKIP dtype('float16') >>> set_default_float_dtype(np.float64) >>> as_float_array(np.ones(3)).dtype @@ -918,6 +908,8 @@ def set_default_float_dtype( module.DTYPE_FLOAT_DEFAULT = dtype # pyright: ignore + CACHE_REGISTRY.clear_all_caches() + # TODO: Annotate with "Union[Literal['ignore', 'reference', '1', '100'], str]" # when Python 3.7 is dropped. @@ -929,15 +921,13 @@ def set_default_float_dtype( """ -def get_domain_range_scale() -> ( - Literal["ignore", "reference", "1", "100"] | str -): +def get_domain_range_scale() -> Literal["ignore", "reference", "1", "100"] | str: """ Return the current *Colour* domain-range scale. The following scales are available: - **'Reference'**, the default *Colour* domain-range scale which varies - depending on the referenced algorithm, e.g. [0, 1], [0, 10], [0, 100], + depending on the referenced algorithm, e.g., [0, 1], [0, 10], [0, 100], [0, 255], etc... - **'1'**, a domain-range scale normalised to [0, 1], it is important to acknowledge that this is a soft normalisation and it is possible to @@ -959,15 +949,16 @@ def get_domain_range_scale() -> ( def set_domain_range_scale( - scale: Literal["ignore", "reference", "Ignore", "Reference", "1", "100"] - | str = "reference" + scale: ( + Literal["ignore", "reference", "Ignore", "Reference", "1", "100"] | str + ) = "reference", ): """ Set the current *Colour* domain-range scale. The following scales are available: - **'Reference'**, the default *Colour* domain-range scale which varies - depending on the referenced algorithm, e.g. [0, 1], [0, 10], [0, 100], + depending on the referenced algorithm, e.g., [0, 1], [0, 10], [0, 100], [0, 255], etc... - **'1'**, a domain-range scale normalised to [0, 1], it is important to acknowledge that this is a soft normalisation and it is possible to @@ -1002,7 +993,7 @@ class domain_range_scale: The following scales are available: - **'Reference'**, the default *Colour* domain-range scale which varies - depending on the referenced algorithm, e.g. [0, 1], [0, 10], [0, 100], + depending on the referenced algorithm, e.g., [0, 1], [0, 10], [0, 100], [0, 255], etc... - **'1'**, a domain-range scale normalised to [0, 1], it is important to acknowledge that this is a soft normalisation and it is possible to @@ -1025,42 +1016,35 @@ class domain_range_scale: >>> with domain_range_scale("1"): ... to_domain_1(1) - ... array(1.0) >>> with domain_range_scale("Reference"): ... from_range_1(1) - ... array(1.0) With *Colour* domain-range scale set to **'1'**: >>> with domain_range_scale("1"): ... to_domain_1(1) - ... array(1.0) >>> with domain_range_scale("1"): ... from_range_1(1) - ... array(1.0) With *Colour* domain-range scale set to **'100'** (unsupported): >>> with domain_range_scale("100"): ... to_domain_1(1) - ... array(0.01) >>> with domain_range_scale("100"): ... from_range_1(1) - ... array(100.0) """ def __init__( self, - scale: Literal[ - "ignore", "reference", "Ignore", "Reference", "1", "100" - ] - | str, + scale: ( + Literal["ignore", "reference", "Ignore", "Reference", "1", "100"] | str + ), ) -> None: self._scale = scale self._previous_scale = get_domain_range_scale() @@ -1125,21 +1109,18 @@ def to_domain_1( >>> with domain_range_scale("Reference"): ... to_domain_1(1) - ... array(1.0) With *Colour* domain-range scale set to **'1'**: >>> with domain_range_scale("1"): ... to_domain_1(1) - ... array(1.0) With *Colour* domain-range scale set to **'100'** (unsupported): >>> with domain_range_scale("100"): ... to_domain_1(1) - ... array(0.01) """ @@ -1192,21 +1173,18 @@ def to_domain_10( >>> with domain_range_scale("Reference"): ... to_domain_10(1) - ... array(1.0) With *Colour* domain-range scale set to **'1'**: >>> with domain_range_scale("1"): ... to_domain_10(1) - ... array(10.0) With *Colour* domain-range scale set to **'100'** (unsupported): >>> with domain_range_scale("100"): ... to_domain_10(1) - ... array(0.1) """ @@ -1260,21 +1238,18 @@ def to_domain_100( >>> with domain_range_scale("Reference"): ... to_domain_100(1) - ... array(1.0) With *Colour* domain-range scale set to **'1'**: >>> with domain_range_scale("1"): ... to_domain_100(1) - ... array(100.0) With *Colour* domain-range scale set to **'100'** (unsupported): >>> with domain_range_scale("100"): ... to_domain_100(1) - ... array(1.0) """ @@ -1327,21 +1302,18 @@ def to_domain_degrees( >>> with domain_range_scale("Reference"): ... to_domain_degrees(1) - ... array(1.0) With *Colour* domain-range scale set to **'1'**: >>> with domain_range_scale("1"): ... to_domain_degrees(1) - ... array(360.0) With *Colour* domain-range scale set to **'100'** (unsupported): >>> with domain_range_scale("100"): ... to_domain_degrees(1) - ... array(3.6) """ @@ -1401,21 +1373,18 @@ def to_domain_int( >>> with domain_range_scale("Reference"): ... to_domain_int(1) - ... array(1.0) With *Colour* domain-range scale set to **'1'**: >>> with domain_range_scale("1"): ... to_domain_int(1) - ... array(255.0) With *Colour* domain-range scale set to **'100'** (unsupported): >>> with domain_range_scale("100"): ... to_domain_int(1) - ... array(2.55) """ @@ -1465,7 +1434,7 @@ def from_range_1( Warnings -------- - The scale conversion of variable :math:`a` happens in-place, i.e. :math:`a` + The scale conversion of variable :math:`a` happens in-place, i.e., :math:`a` will be mutated! Examples @@ -1474,21 +1443,18 @@ def from_range_1( >>> with domain_range_scale("Reference"): ... from_range_1(1) - ... array(1.0) With *Colour* domain-range scale set to **'1'**: >>> with domain_range_scale("1"): ... from_range_1(1) - ... array(1.0) With *Colour* domain-range scale set to **'100'** (unsupported): >>> with domain_range_scale("100"): ... from_range_1(1) - ... array(100.0) """ @@ -1536,7 +1502,7 @@ def from_range_10( Warnings -------- - The scale conversion of variable :math:`a` happens in-place, i.e. :math:`a` + The scale conversion of variable :math:`a` happens in-place, i.e., :math:`a` will be mutated! Examples @@ -1545,21 +1511,18 @@ def from_range_10( >>> with domain_range_scale("Reference"): ... from_range_10(1) - ... array(1.0) With *Colour* domain-range scale set to **'1'**: >>> with domain_range_scale("1"): ... from_range_10(1) - ... array(0.1) With *Colour* domain-range scale set to **'100'** (unsupported): >>> with domain_range_scale("100"): ... from_range_10(1) - ... array(10.0) """ @@ -1608,7 +1571,7 @@ def from_range_100( Warnings -------- - The scale conversion of variable :math:`a` happens in-place, i.e. :math:`a` + The scale conversion of variable :math:`a` happens in-place, i.e., :math:`a` will be mutated! Examples @@ -1617,21 +1580,18 @@ def from_range_100( >>> with domain_range_scale("Reference"): ... from_range_100(1) - ... array(1.0) With *Colour* domain-range scale set to **'1'**: >>> with domain_range_scale("1"): ... from_range_100(1) - ... array(0.01) With *Colour* domain-range scale set to **'100'** (unsupported): >>> with domain_range_scale("100"): ... from_range_100(1) - ... array(1.0) """ @@ -1679,7 +1639,7 @@ def from_range_degrees( Warnings -------- - The scale conversion of variable :math:`a` happens in-place, i.e. :math:`a` + The scale conversion of variable :math:`a` happens in-place, i.e., :math:`a` will be mutated! Examples @@ -1688,21 +1648,18 @@ def from_range_degrees( >>> with domain_range_scale("Reference"): ... from_range_degrees(1) - ... array(1.0) With *Colour* domain-range scale set to **'1'**: >>> with domain_range_scale("1"): ... from_range_degrees(1) # doctest: +ELLIPSIS - ... array(0.0027777...) With *Colour* domain-range scale set to **'100'** (unsupported): >>> with domain_range_scale("100"): ... from_range_degrees(1) # doctest: +ELLIPSIS - ... array(0.2777777...) """ @@ -1752,7 +1709,7 @@ def from_range_int( Warnings -------- - The scale conversion of variable :math:`a` happens in-place, i.e. :math:`a` + The scale conversion of variable :math:`a` happens in-place, i.e., :math:`a` will be mutated! Notes @@ -1766,21 +1723,18 @@ def from_range_int( >>> with domain_range_scale("Reference"): ... from_range_int(1) - ... array(1.0) With *Colour* domain-range scale set to **'1'**: >>> with domain_range_scale("1"): ... from_range_int(1) # doctest: +ELLIPSIS - ... array(0.0039215...) With *Colour* domain-range scale set to **'100'** (unsupported): >>> with domain_range_scale("100"): ... from_range_int(1) # doctest: +ELLIPSIS - ... array(0.3921568...) """ @@ -1820,11 +1774,9 @@ def is_ndarray_copy_enabled() -> bool: -------- >>> with ndarray_copy_enable(False): ... is_ndarray_copy_enabled() - ... False >>> with ndarray_copy_enable(True): ... is_ndarray_copy_enabled() - ... True """ @@ -1846,7 +1798,6 @@ def set_ndarray_copy_enable(enable: bool): ... print(is_ndarray_copy_enabled()) ... set_ndarray_copy_enable(False) ... print(is_ndarray_copy_enabled()) - ... True False """ @@ -1924,7 +1875,6 @@ def ndarray_copy(a: NDArray) -> NDArray: False >>> with ndarray_copy_enable(False): ... id(a) == id(ndarray_copy(a)) - ... True """ @@ -2143,7 +2093,7 @@ def in_array(a: ArrayLike, b: ArrayLike, tolerance: Real = EPSILON) -> NDArray: -------- >>> a = np.array([0.50, 0.60]) >>> b = np.linspace(0, 10, 101) - >>> np.in1d(a, b) + >>> np.isin(a, b) array([ True, False], dtype=bool) >>> in_array(a, b) array([ True, True], dtype=bool) @@ -2253,9 +2203,7 @@ def tsplit( >>> a = np.array([0, 0, 0]) >>> tsplit(a) array([ 0., 0., 0.]) - >>> a = np.array( - ... [[0, 0, 0], [1, 1, 1], [2, 2, 2], [3, 3, 3], [4, 4, 4], [5, 5, 5]] - ... ) + >>> a = np.array([[0, 0, 0], [1, 1, 1], [2, 2, 2], [3, 3, 3], [4, 4, 4], [5, 5, 5]]) >>> tsplit(a) array([[ 0., 1., 2., 3., 4., 5.], [ 0., 1., 2., 3., 4., 5.], @@ -2353,8 +2301,9 @@ def row_as_diagonal(a: ArrayLike) -> NDArray: def orient( a: ArrayLike, - orientation: Literal["Ignore", "Flip", "Flop", "90 CW", "90 CCW", "180"] - | str = "Ignore", + orientation: ( + Literal["Ignore", "Flip", "Flop", "90 CW", "90 CCW", "180"] | str + ) = "Ignore", ) -> NDArray: """ Orient given array :math:`a` according to given orientation. @@ -2495,9 +2444,7 @@ def fill_nan( mask = np.isnan(a) if method == "interpolation": - a[mask] = np.interp( - np.flatnonzero(mask), np.flatnonzero(~mask), a[~mask] - ) + a[mask] = np.interp(np.flatnonzero(mask), np.flatnonzero(~mask), a[~mask]) elif method == "constant": a[mask] = default @@ -2559,10 +2506,8 @@ def ndarray_write(a: ArrayLike) -> Generator: ... a += 1 ... except ValueError: ... pass - ... >>> with ndarray_write(a): ... a += 1 - ... """ a = as_float_array(a) @@ -2748,9 +2693,7 @@ def index_along_last_axis(a: ArrayLike, indexes: ArrayLike) -> NDArray: ... ], ... ] ... ) - >>> indexes = np.array( - ... [[2, 0, 1, 1], [2, 1, 1, 0], [0, 0, 1, 2], [0, 0, 1, 2]] - ... ) + >>> indexes = np.array([[2, 0, 1, 1], [2, 1, 1, 0], [0, 0, 1, 2], [0, 0, 1, 2]]) >>> index_along_last_axis(a, indexes) array([[ 6.9, 3.3, 7.5, 1.6], [ 2.8, 4.9, 9.7, 6.3], @@ -2786,9 +2729,7 @@ def index_along_last_axis(a: ArrayLike, indexes: ArrayLike) -> NDArray: return np.take_along_axis(a, indexes[..., None], axis=-1).squeeze(axis=-1) -def format_array_as_row( - a: ArrayLike, decimals: int = 7, separator: str = " " -) -> str: +def format_array_as_row(a: ArrayLike, decimals: int = 7, separator: str = " ") -> str: """ Format given array :math:`a` as a row. @@ -2819,5 +2760,6 @@ def format_array_as_row( a = np.ravel(a) return separator.join( - "{1:0.{0}f}".format(decimals, x) for x in a # noqa: PLE1300, RUF100 + "{1:0.{0}f}".format(decimals, x) + for x in a # noqa: PLE1300, RUF100 ) diff --git a/colour/utilities/callback.py b/colour/utilities/callback.py index 1891fedf9a..778344665b 100644 --- a/colour/utilities/callback.py +++ b/colour/utilities/callback.py @@ -2,7 +2,7 @@ Callback Management =================== -Defines the callback management objects. +Define the callback management objects. """ from __future__ import annotations @@ -66,7 +66,6 @@ class MixinCallback: ... def __init__(self): ... super().__init__() ... self.attribute_a = "a" - ... >>> with_callback = WithCallback() >>> def _on_attribute_a_changed(self, name: str, value: str) -> str: ... return value.upper() @@ -114,9 +113,7 @@ def __setattr__(self, name: str, value: Any) -> None: super().__setattr__(name, value) - def register_callback( - self, attribute: str, name: str, function: Callable - ) -> None: + def register_callback(self, attribute: str, name: str, function: Callable) -> None: """ Register the callback with given name for given attribute. @@ -177,7 +174,7 @@ def unregister_callback(self, attribute: str, name: str) -> None: defaultdict(, {}) """ - if self._callbacks.get(attribute) is None: + if self._callbacks.get(attribute) is None: # pragma: no cover return self._callbacks[attribute] = [ diff --git a/colour/utilities/common.py b/colour/utilities/common.py index 69148e3667..a4cc7c1321 100644 --- a/colour/utilities/common.py +++ b/colour/utilities/common.py @@ -2,7 +2,7 @@ Common Utilities ================ -Defines the common utilities objects that don't fall in any specific category. +Define the common utilities objects that don't fall in any specific category. References ---------- @@ -22,7 +22,6 @@ import inspect import os import re -import subprocess import types import unicodedata import warnings @@ -32,7 +31,7 @@ import numpy as np -from colour.constants import INTEGER_THRESHOLD +from colour.constants import THRESHOLD_INTEGER from colour.hints import ( Any, Callable, @@ -44,7 +43,7 @@ Sequence, TypeVar, ) -from colour.utilities import CanonicalMapping, Lookup +from colour.utilities import CanonicalMapping, Lookup, is_xxhash_installed __author__ = "Colour Developers" __copyright__ = "Copyright 2013 Colour Developers" @@ -69,19 +68,7 @@ "batch", "disable_multiprocessing", "multiprocessing_pool", - "is_ctlrender_installed", - "is_graphviz_installed", - "is_matplotlib_installed", - "is_networkx_installed", - "is_opencolorio_installed", - "is_openimageio_installed", - "is_pandas_installed", - "is_tqdm_installed", - "is_trimesh_installed", - "is_xxhash_installed", - "required", "is_iterable", - "is_string", "is_numeric", "is_integer", "is_sibling", @@ -95,9 +82,7 @@ "int_digest", ] -_CACHING_ENABLED: bool = not os.environ.get( - "COLOUR_SCIENCE__COLOUR__DISABLE_CACHING", False -) +_CACHING_ENABLED: bool = not os.environ.get("COLOUR_SCIENCE__DISABLE_CACHING", False) """ Global variable storing the current *Colour* caching enabled state. """ @@ -116,11 +101,9 @@ def is_caching_enabled() -> bool: -------- >>> with caching_enable(False): ... is_caching_enabled() - ... False >>> with caching_enable(True): ... is_caching_enabled() - ... True """ @@ -142,7 +125,6 @@ def set_caching_enable(enable: bool): ... print(is_caching_enabled()) ... set_caching_enable(False) ... print(is_caching_enabled()) - ... True False """ @@ -406,11 +388,10 @@ def handle_numpy_errors(**kwargs: Any) -> Callable: >>> @handle_numpy_errors(all="ignore") ... def f(): ... 1 / numpy.zeros(3) - ... >>> f() """ - context = np.errstate(**kwargs) + keyword_arguments = kwargs def wrapper(function: Callable) -> Callable: """Wrap given function wrapper.""" @@ -419,7 +400,7 @@ def wrapper(function: Callable) -> Callable: def wrapped(*args: Any, **kwargs: Any) -> Any: """Wrap given function.""" - with context: + with np.errstate(**keyword_arguments): return function(*args, **kwargs) return wrapped @@ -451,7 +432,6 @@ def ignore_python_warnings(function: Callable) -> Callable: >>> @ignore_python_warnings ... def f(): ... warnings.warn("This is an ignored warning!") - ... >>> f() """ @@ -609,11 +589,9 @@ def multiprocessing_pool(*args: Any, **kwargs: Any) -> Generator: >>> from functools import partial >>> def _add(a, b): ... return a + b - ... >>> with multiprocessing_pool() as pool: ... pool.map(partial(_add, b=2), range(10)) ... # doctest: +SKIP - ... [2, 3, 4, 5, 6, 7, 8, 9, 10, 11] """ @@ -635,7 +613,7 @@ class _DummyPool: def __init__(self, *args: Any, **kwargs: Any) -> None: pass - def map(self, func, iterable, chunksize=None): # noqa: A003, ARG002 + def map(self, func, iterable, chunksize=None): # noqa: ARG002 """Apply given function to each element of given iterable.""" return [func(a) for a in iterable] @@ -668,428 +646,6 @@ def terminate(self): pool.terminate() -def is_ctlrender_installed(raise_exception: bool = False) -> bool: - """ - Return whether *ctlrender* is installed and available. - - Parameters - ---------- - raise_exception - Whether to raise an exception if *ctlrender* is unavailable. - - Returns - ------- - :class:`bool` - Whether *ctlrender* is installed. - - Raises - ------ - :class:`ImportError` - If *ctlrender* is not installed. - """ - - try: # pragma: no cover - stdout = subprocess.run( - ["ctlrender", "-help"], # noqa: S603, S607 - capture_output=True, - check=False, - ).stdout.decode("utf-8") - - if "transforms an image using one or more CTL scripts" not in stdout: - raise FileNotFoundError # noqa: TRY301 - - return True - except FileNotFoundError as error: # pragma: no cover - if raise_exception: - raise FileNotFoundError( - '"ctlrender" related API features are not available: ' - f'"{error}".\nSee the installation guide for more information: ' - "https://www.colour-science.org/installation-guide/" - ) from error - - return False - - -def is_graphviz_installed(raise_exception: bool = False) -> bool: - """ - Return whether *Graphviz* is installed and available. - - Parameters - ---------- - raise_exception - Whether to raise an exception if *Graphviz* is unavailable. - - Returns - ------- - :class:`bool` - Whether *Graphviz* is installed. - - Raises - ------ - :class:`ImportError` - If *Graphviz* is not installed. - """ - - try: # pragma: no cover - import pygraphviz # noqa: F401 - - return True - except ImportError as error: # pragma: no cover - if raise_exception: - raise ImportError( - '"Graphviz" related API features are not available: ' - f'"{error}".\nSee the installation guide for more information: ' - "https://www.colour-science.org/installation-guide/" - ) from error - - return False - - -def is_matplotlib_installed(raise_exception: bool = False) -> bool: - """ - Return whether *Matplotlib* is installed and available. - - Parameters - ---------- - raise_exception - Whether to raise an exception if *Matplotlib* is unavailable. - - Returns - ------- - :class:`bool` - Whether *Matplotlib* is installed. - - Raises - ------ - :class:`ImportError` - If *Matplotlib* is not installed. - """ - - try: # pragma: no cover - import matplotlib as mpl # noqa: F401 - - return True - except ImportError as error: # pragma: no cover - if raise_exception: - raise ImportError( - '"Matplotlib" related API features are not available: ' - f'"{error}".\nSee the installation guide for more information: ' - "https://www.colour-science.org/installation-guide/" - ) from error - - return False - - -def is_networkx_installed(raise_exception: bool = False) -> bool: - """ - Return whether *NetworkX* is installed and available. - - Parameters - ---------- - raise_exception - Whether to raise an exception if *NetworkX* is unavailable. - - Returns - ------- - :class:`bool` - Whether *NetworkX* is installed. - - Raises - ------ - :class:`ImportError` - If *NetworkX* is not installed. - """ - - try: # pragma: no cover - import networkx as nx # noqa: F401 - - return True - except ImportError as error: # pragma: no cover - if raise_exception: - raise ImportError( - '"NetworkX" related API features, e.g. the automatic colour ' - f'conversion graph, are not available: "{error}".\nPlease refer ' - "to the installation guide for more information: " - "https://www.colour-science.org/installation-guide/" - ) from error - - return False - - -def is_opencolorio_installed(raise_exception: bool = False) -> bool: - """ - Return whether *OpenColorIO* is installed and available. - - Parameters - ---------- - raise_exception - Whether to raise an exception if *OpenColorIO* is unavailable. - - Returns - ------- - :class:`bool` - Whether *OpenColorIO* is installed. - - Raises - ------ - :class:`ImportError` - If *OpenColorIO* is not installed. - """ - - try: # pragma: no cover - import PyOpenColorIO # noqa: F401 - - return True - except ImportError as error: # pragma: no cover - if raise_exception: - raise ImportError( - '"OpenColorIO" related API features are not available: ' - f'"{error}".\nSee the installation guide for more information: ' - "https://www.colour-science.org/installation-guide/" - ) from error - - return False - - -def is_openimageio_installed(raise_exception: bool = False) -> bool: - """ - Return whether *OpenImageIO* is installed and available. - - Parameters - ---------- - raise_exception - Whether to raise an exception if *OpenImageIO* is unavailable. - - Returns - ------- - :class:`bool` - Whether *OpenImageIO* is installed. - - Raises - ------ - :class:`ImportError` - If *OpenImageIO* is not installed. - """ - - try: # pragma: no cover - import OpenImageIO # noqa: F401 - - return True - except ImportError as error: # pragma: no cover - if raise_exception: - raise ImportError( - '"OpenImageIO" related API features are not available: ' - f'"{error}".\nSee the installation guide for more information: ' - "https://www.colour-science.org/installation-guide/" - ) from error - - return False - - -def is_pandas_installed(raise_exception: bool = False) -> bool: - """ - Return whether *Pandas* is installed and available. - - Parameters - ---------- - raise_exception - Whether to raise an exception if *Pandas* is unavailable. - - Returns - ------- - :class:`bool` - Whether *Pandas* is installed. - - Raises - ------ - :class:`ImportError` - If *Pandas* is not installed. - """ - - try: # pragma: no cover - import pandas # noqa: F401, ICN001 - - return True - except ImportError as error: # pragma: no cover - if raise_exception: - raise ImportError( - f'"Pandas" related API features are not available: "{error}".\n' - "See the installation guide for more information: " - "https://www.colour-science.org/installation-guide/" - ) from error - - return False - - -def is_tqdm_installed(raise_exception: bool = False) -> bool: - """ - Return whether *tqdm* is installed and available. - - Parameters - ---------- - raise_exception - Whether to raise an exception if *tqdm* is unavailable. - - Returns - ------- - :class:`bool` - Whether *tqdm* is installed. - - Raises - ------ - :class:`ImportError` - If *tqdm* is not installed. - """ - - try: # pragma: no cover - import tqdm # noqa: F401 - - return True - except ImportError as error: # pragma: no cover - if raise_exception: - raise ImportError( - f'"tqdm" related API features are not available: "{error}".\n' - "See the installation guide for more information: " - "https://www.colour-science.org/installation-guide/" - ) from error - - return False - - -def is_trimesh_installed(raise_exception: bool = False) -> bool: - """ - Return whether *Trimesh* is installed and available. - - Parameters - ---------- - raise_exception - Whether to raise an exception if *Trimesh* is unavailable. - - Returns - ------- - :class:`bool` - Whether *Trimesh* is installed. - - Raises - ------ - :class:`ImportError` - If *Trimesh* is not installed. - """ - - try: # pragma: no cover - import trimesh # noqa: F401 - - return True - except ImportError as error: # pragma: no cover - if raise_exception: - raise ImportError( - '"Trimesh" related API features are not available: ' - f'"{error}".\nSee the installation guide for more information: ' - "https://www.colour-science.org/installation-guide/" - ) from error - - return False - - -def is_xxhash_installed(raise_exception: bool = False) -> bool: - """ - Return whether *xxhash* is installed and available. - - Parameters - ---------- - raise_exception - Whether to raise an exception if *xxhash* is unavailable. - - Returns - ------- - :class:`bool` - Whether *xxhash* is installed. - - Raises - ------ - :class:`ImportError` - If *xxhash* is not installed. - """ - - try: # pragma: no cover - import xxhash # noqa: F401 - - return True - except ImportError as error: # pragma: no cover - if raise_exception: - raise ImportError( - '"xxhash" related API features are not available: ' - f'"{error}".\nSee the installation guide for more information: ' - "https://www.colour-science.org/installation-guide/" - ) from error - - return False - - -_REQUIREMENTS_TO_CALLABLE: CanonicalMapping = CanonicalMapping( - { - "ctlrender": is_ctlrender_installed, - "Graphviz": is_graphviz_installed, - "Matplotlib": is_matplotlib_installed, - "NetworkX": is_networkx_installed, - "OpenColorIO": is_opencolorio_installed, - "OpenImageIO": is_openimageio_installed, - "Pandas": is_pandas_installed, - "tqdm": is_tqdm_installed, - "trimesh": is_trimesh_installed, - "xxhash": is_xxhash_installed, - } -) -""" -Mapping of requirements to their respective callables. -""" - - -def required( - *requirements: Literal[ - "ctlrender", - "Graphviz", - "Matplotlib", - "NetworkX", - "OpenColorIO", - "OpenImageIO", - "Pandas", - "tqdm", - "trimesh", - "xxhash", - ] -) -> Callable: - """ - Decorate a function to check whether various ancillary package requirements - are satisfied. - - Other Parameters - ---------------- - requirements - Requirements to check whether they are satisfied. - - Returns - ------- - Callable - """ - - def wrapper(function: Callable) -> Callable: - """Wrap given function wrapper.""" - - @functools.wraps(function) - def wrapped(*args: Any, **kwargs: Any) -> Any: - """Wrap given function.""" - - for requirement in requirements: - _REQUIREMENTS_TO_CALLABLE[requirement](raise_exception=True) - - return function(*args, **kwargs) - - return wrapped - - return wrapper - - def is_iterable(a: Any) -> bool: """ Return whether given variable :math:`a` is iterable. @@ -1112,32 +668,7 @@ def is_iterable(a: Any) -> bool: False """ - return is_string(a) or (bool(getattr(a, "__iter__", False))) - - -def is_string(a: Any) -> bool: - """ - Return whether given variable :math:`a` is a :class:`str`-like variable. - - Parameters - ---------- - a - Variable :math:`a` to test. - - Returns - ------- - :class:`bool` - Whether variable :math:`a` is a :class:`str`-like variable. - - Examples - -------- - >>> is_string("I'm a string!") - True - >>> is_string(["I'm a string!"]) - False - """ - - return bool(isinstance(a, str)) + return isinstance(a, str) or (bool(getattr(a, "__iter__", False))) def is_numeric(a: Any) -> bool: @@ -1207,7 +738,7 @@ def is_integer(a: Any) -> bool: Notes ----- - The determination threshold is defined by the - :attr:`colour.algebra.common.INTEGER_THRESHOLD` attribute. + :attr:`colour.algebra.common.THRESHOLD_INTEGER` attribute. Examples -------- @@ -1217,7 +748,7 @@ def is_integer(a: Any) -> bool: False """ - return abs(a - np.around(a)) <= INTEGER_THRESHOLD + return abs(a - np.around(a)) <= THRESHOLD_INTEGER def is_sibling(element: Any, mapping: Mapping) -> bool: @@ -1237,9 +768,7 @@ def is_sibling(element: Any, mapping: Mapping) -> bool: Whether given element type is present in given mapping types. """ - return isinstance( - element, tuple({type(element) for element in mapping.values()}) - ) + return isinstance(element, tuple({type(element) for element in mapping.values()})) def filter_kwargs(function: Callable, **kwargs: Any) -> dict: @@ -1265,13 +794,10 @@ def filter_kwargs(function: Callable, **kwargs: Any) -> dict: -------- >>> def fn_a(a): ... return a - ... >>> def fn_b(a, b=0): ... return a, b - ... >>> def fn_c(a, b=0, c=0): ... return a, b, c - ... >>> fn_a(1, **filter_kwargs(fn_a, b=2, c=3)) 1 >>> fn_b(1, **filter_kwargs(fn_b, b=2, c=3)) @@ -1321,7 +847,6 @@ class instance. -------- >>> class Element: ... pass - ... >>> mapping = { ... "Element A": Element(), ... "Element B": Element(), @@ -1360,12 +885,9 @@ def filter_mapping_with_name(mapping: Mapping, name: str) -> dict: lookup = Lookup(mapping) - return { - lookup.first_key_from_value(element): element - for element in elements - } + return {lookup.first_key_from_value(element): element for element in elements} - names = [str(names)] if is_string(names) else names + names = [str(names)] if isinstance(names, str) else names filtered_mapping = {} @@ -1438,10 +960,11 @@ def validate_method( method: str, valid_methods: tuple, message: str = '"{0}" method is invalid, it must be one of {1}!', + as_lowercase: bool = True, ) -> str: """ Validate whether given method exists in the given valid methods and - returns the method lower cased. + optionally returns the method lower cased. Parameters ---------- @@ -1451,11 +974,13 @@ def validate_method( Valid methods. message Message for the exception. + as_lowercase + Whether to convert the given method to lower case or not. Returns ------- :class:`str` - Method lower cased. + Method optionally lower cased. Raises ------ @@ -1466,19 +991,17 @@ def validate_method( -------- >>> validate_method("Valid", ("Valid", "Yes", "Ok")) 'valid' + >>> validate_method("Valid", ("Valid", "Yes", "Ok"), as_lowercase=False) + 'Valid' """ - valid_methods = tuple( - [str(valid_method) for valid_method in valid_methods] - ) + valid_methods = tuple([str(valid_method) for valid_method in valid_methods]) method_lower = method.lower() - if method_lower not in [ - valid_method.lower() for valid_method in valid_methods - ]: + if method_lower not in [valid_method.lower() for valid_method in valid_methods]: raise ValueError(message.format(method, valid_methods)) - return method_lower + return method_lower if as_lowercase else method T = TypeVar("T") @@ -1541,9 +1064,7 @@ def slugify(object_: Any, allow_unicode: bool = False) -> str: Examples -------- - >>> slugify( - ... " Jack & Jill like numbers 1,2,3 and 4 and silly characters ?%.$!/" - ... ) + >>> slugify(" Jack & Jill like numbers 1,2,3 and 4 and silly characters ?%.$!/") 'jack-jill-like-numbers-123-and-4-and-silly-characters' """ @@ -1574,11 +1095,9 @@ def slugify(object_: Any, allow_unicode: bool = False) -> str: import array def int_digest( - args: str # noqa: ARG001 - | bytes - | bytearray - | memoryview - | array.ArrayType[int], + args: ( # noqa: ARG001 + str | bytes | bytearray | memoryview | array.ArrayType[int] + ), seed: int = 0, # noqa: ARG001 ) -> int: """ @@ -1601,4 +1120,4 @@ def int_digest( return -1 else: - int_digest = hash # pyright: ignore + int_digest = hash # pyright: ignore # pragma: no cover diff --git a/colour/utilities/deprecation.py b/colour/utilities/deprecation.py index a7169b7e1e..8ea2d84e45 100644 --- a/colour/utilities/deprecation.py +++ b/colour/utilities/deprecation.py @@ -2,7 +2,7 @@ Deprecation Utilities ===================== -Defines various deprecation management related objects. +Define various deprecation management related objects. """ from __future__ import annotations @@ -88,11 +88,9 @@ def __str__(self) -> str: return f'"{self.name}" object has been removed from the API.' -class ObjectFutureRename( - namedtuple("ObjectFutureRename", ("name", "new_name")) -): +class ObjectFutureRename(namedtuple("ObjectFutureRename", ("name", "new_name"))): """ - A class used for future object name deprecation, i.e. object name will + A class used for future object name deprecation, i.e., object name will change in a future release. Parameters @@ -149,7 +147,7 @@ class ObjectFutureAccessChange( namedtuple("ObjectFutureAccessChange", ("access", "new_access")) ): """ - A class used for future object access deprecation, i.e. object access will + A class used for future object access deprecation, i.e., object access will change in a future release. Parameters @@ -176,11 +174,9 @@ def __str__(self) -> str: ) -class ObjectFutureAccessRemove( - namedtuple("ObjectFutureAccessRemove", ("name",)) -): +class ObjectFutureAccessRemove(namedtuple("ObjectFutureAccessRemove", ("name",))): """ - A class used for future object access removal, i.e. object access will + A class used for future object access removal, i.e., object access will be removed in a future release. Parameters @@ -199,9 +195,7 @@ def __str__(self) -> str: Formatted string representation. """ - return ( - f'"{self.name}" object access will be removed in a future release.' - ) + return f'"{self.name}" object access will be removed in a future release.' class ArgumentRenamed(namedtuple("ArgumentRenamed", ("name", "new_name"))): @@ -252,11 +246,9 @@ def __str__(self) -> str: return f'"{self.name}" argument has been removed from the API.' -class ArgumentFutureRename( - namedtuple("ArgumentFutureRename", ("name", "new_name")) -): +class ArgumentFutureRename(namedtuple("ArgumentFutureRename", ("name", "new_name"))): """ - A class used for future argument name deprecation, i.e. argument name will + A class used for future argument name deprecation, i.e., argument name will change in a future release. Parameters @@ -332,9 +324,7 @@ class ModuleAPI: ... # doctest: +SKIP """ - def __init__( - self, module: ModuleType, changes: dict | None = None - ) -> None: + def __init__(self, module: ModuleType, changes: dict | None = None) -> None: self._module = module self._changes = optional(changes, {}) @@ -401,7 +391,7 @@ def get_attribute(attribute: str) -> Any: Parameters ---------- attribute - Attribute to retrieve, ``attribute`` must have a namespace module, e.g. + Attribute to retrieve, ``attribute`` must have a namespace module, e.g., *colour.models.oetf_inverse_BT2020*. Returns @@ -411,9 +401,7 @@ def get_attribute(attribute: str) -> Any: Examples -------- - >>> get_attribute( - ... "colour.models.oetf_inverse_BT2020" - ... ) # doctest: +ELLIPSIS + >>> get_attribute("colour.models.oetf_inverse_BT2020") # doctest: +ELLIPSIS """ diff --git a/colour/utilities/documentation.py b/colour/utilities/documentation.py index ab39a3d29f..3ded90fa4d 100644 --- a/colour/utilities/documentation.py +++ b/colour/utilities/documentation.py @@ -2,7 +2,7 @@ Documentation ============= -Defines the documentation related objects. +Define the documentation related objects. """ from __future__ import annotations diff --git a/colour/utilities/metrics.py b/colour/utilities/metrics.py index 801167f427..357b08e816 100644 --- a/colour/utilities/metrics.py +++ b/colour/utilities/metrics.py @@ -2,7 +2,7 @@ Metrics ======= -Defines various metrics: +Define various metrics: - :func:`colour.utilities.metric_mse` - :func:`colour.utilities.metric_psnr` @@ -80,9 +80,7 @@ def metric_mse( 0.0012714... """ - return as_float( - np.mean((as_float_array(a) - as_float_array(b)) ** 2, axis=axis) - ) + return as_float(np.mean((as_float_array(a) - as_float_array(b)) ** 2, axis=axis)) def metric_psnr( diff --git a/colour/utilities/network.py b/colour/utilities/network.py new file mode 100644 index 0000000000..c0f55e0db7 --- /dev/null +++ b/colour/utilities/network.py @@ -0,0 +1,2332 @@ +""" +Network +======= + +Define various node-graph / network related classes: + +- :class:`colour.utilities.TreeNode`: A basic node object supporting creation + of basic node trees. +- :class:`colour.utilities.Port`: An object that can be added either as an + input or output port. +- :class:`colour.utilities.PortMode`: A node with support for input and + output ports. +- :class:`colour.utilities.PortGraph`: A graph for nodes with input and + output ports. +- :class:`colour.utilities.ExecutionPort`: An object for nodes + supporting execution input and output ports. +- :class:`colour.utilities.ExecutionNode`: A node with builtin input and + output execution ports. +- :class:`colour.utilities.ControlFlowNode`: A node inherited by control flow + nodes. +- :class:`colour.utilities.For`: A node performing for loops in the + node-graph. +- :class:`colour.utilities.ParallelForThread`: A node performing for loops in + parallel in the node-graph using threads. +- :class:`colour.utilities.ParallelForMultiprocess`: A node performing for + loops in parallel in the node-graph using multiprocessing. +""" + +from __future__ import annotations + +import concurrent.futures +import os +import threading + +from colour.hints import ( + Any, + Dict, + Generator, + List, + Self, + Tuple, + Type, +) +from colour.utilities import MixinLogging, attest, optional, required + +__author__ = "Colour Developers" +__copyright__ = "Copyright 2013 Colour Developers" +__license__ = "BSD-3-Clause - https://opensource.org/licenses/BSD-3-Clause" +__maintainer__ = "Colour Developers" +__email__ = "colour-developers@colour-science.org" +__status__ = "Production" + +__all__ = [ + "TreeNode", + "Port", + "PortNode", + "ControlFlowNode", + "PortGraph", + "ExecutionPort", + "ExecutionNode", + "ControlFlowNode", + "For", + "ParallelForThread", + "ParallelForMultiprocess", +] + + +class TreeNode: + """ + Represent a basic node supporting the creation of basic node trees. + + Parameters + ---------- + name + Node name. + parent + Parent of the node. + children + Children of the node. + data + The data belonging to this node. + + Attributes + ---------- + - :attr:`~colour.utilities.TreeNode.id` + - :attr:`~colour.utilities.TreeNode.name` + - :attr:`~colour.utilities.TreeNode.parent` + - :attr:`~colour.utilities.TreeNode.children` + - :attr:`~colour.utilities.TreeNode.root` + - :attr:`~colour.utilities.TreeNode.leaves` + - :attr:`~colour.utilities.TreeNode.siblings` + - :attr:`~colour.utilities.TreeNode.data` + + Methods + ------- + - :meth:`~colour.utilities.TreeNode.__new__` + - :meth:`~colour.utilities.TreeNode.__init__` + - :meth:`~colour.utilities.TreeNode.__str__` + - :meth:`~colour.utilities.TreeNode.__len__` + - :meth:`~colour.utilities.TreeNode.is_root` + - :meth:`~colour.utilities.TreeNode.is_inner` + - :meth:`~colour.utilities.TreeNode.is_leaf` + - :meth:`~colour.utilities.TreeNode.walk_hierarchy` + - :meth:`~colour.utilities.TreeNode.render` + + Examples + -------- + >>> node_a = TreeNode("Node A") + >>> node_b = TreeNode("Node B", node_a) + >>> node_c = TreeNode("Node C", node_a) + >>> node_d = TreeNode("Node D", node_b) + >>> node_e = TreeNode("Node E", node_b) + >>> node_f = TreeNode("Node F", node_d) + >>> node_g = TreeNode("Node G", node_f) + >>> node_h = TreeNode("Node H", node_g) + >>> [node.name for node in node_a.leaves] + ['Node H', 'Node E', 'Node C'] + >>> print(node_h.root.name) + Node A + >>> len(node_a) + 7 + """ + + _INSTANCE_ID: int = 1 + """ + Node id counter. + + _INSTANCE_ID + """ + + def __new__(cls, *args: Any, **kwargs: Any) -> Self: # noqa: ARG003 + """ + Return a new instance of the :class:`colour.utilities.Node` class. + + Other Parameters + ---------------- + args + Arguments. + kwargs + Keywords arguments. + """ + + instance = super().__new__(cls) + + instance._id = TreeNode._INSTANCE_ID # pyright: ignore + TreeNode._INSTANCE_ID += 1 + + return instance + + def __init__( + self, + name: str | None = None, + parent: Self | None = None, + children: List[Self] | None = None, + data: Any | None = None, + ) -> None: + self._name: str = f"{self.__class__.__name__}#{self.id}" + self.name = optional(name, self._name) + self._parent: Self | None = None + self.parent = parent + self._children: List[Self] = [] + self.children = optional(children, self._children) + self._data: Any | None = data + + @property + def id(self) -> int: + """ + Getter property for the node id. + + Returns + ------- + :class:`int` + Node id. + """ + + return self._id # pyright: ignore + + @property + def name(self) -> str: + """ + Getter and setter property for the name. + + Parameters + ---------- + value + Value to set the name with. + + Returns + ------- + :class:`str` + Node name. + """ + + return self._name + + @name.setter + def name(self, value: str): + """Setter for the **self.name** property.""" + + attest( + isinstance(value, str), + f'"name" property: "{value}" type is not "str"!', + ) + + self._name = value + + @property + def parent(self) -> Self | None: + """ + Getter and setter property for the node parent. + + Parameters + ---------- + value + Parent to set the node with. + + Returns + ------- + :class:`Node` or :py:data:`None` + Node parent. + """ + + return self._parent + + @parent.setter + def parent(self, value: Self | None): + """Setter for the **self.parent** property.""" + + from colour.utilities import attest + + if value is not None: + attest( + issubclass(value.__class__, TreeNode), + f'"parent" property: "{value}" is not a ' + f'"{self.__class__.__name__}" subclass!', + ) + + value.children.append(self) + + self._parent = value + + @property + def children(self) -> List[Self]: + """ + Getter and setter property for the node children. + + Parameters + ---------- + value + Children to set the node with. + + Returns + ------- + :class:`list` + Node children. + """ + + return self._children + + @children.setter + def children(self, value: List[Self]): + """Setter for the **self.children** property.""" + + from colour.utilities import attest + + attest( + isinstance(value, list), + f'"children" property: "{value}" type is not a "list" instance!', + ) + + for element in value: + attest( + issubclass(element.__class__, TreeNode), + f'"children" property: A "{element}" element is not a ' + f'"{self.__class__.__name__}" subclass!', + ) + + for node in value: + node.parent = self + + self._children = value + + @property + def root(self) -> Self: + """ + Getter property for the node tree. + + Returns + ------- + :class:`TreeNode` + Node root. + """ + + if self.is_root(): + return self + else: + return list(self.walk_hierarchy(ascendants=True))[-1] + + @property + def leaves(self) -> Generator: + """ + Getter property for the node leaves. + + Yields + ------ + Generator + Node leaves. + """ + + if self.is_leaf(): + return (node for node in (self,)) + else: + return (node for node in self.walk_hierarchy() if node.is_leaf()) + + @property + def siblings(self) -> Generator: + """ + Getter property for the node siblings. + + Returns + ------- + Generator + Node siblings. + """ + + if self.parent is None: + return (sibling for sibling in ()) + else: + return (sibling for sibling in self.parent.children if sibling is not self) + + @property + def data(self) -> Any: + """ + Getter property for the node data. + + Returns + ------- + :class:`object` + Node data. + """ + + return self._data + + @data.setter + def data(self, value: Any): + """Setter for the **self.data** property.""" + + self._data = value + + def __str__(self) -> str: + """ + Return a formatted string representation of the node. + + Returns + ------- + :class`str` + Formatted string representation. + """ + + return f"{self.__class__.__name__}#{self.id}({self._data})" + + def __len__(self) -> int: + """ + Return the number of children of the node. + + Returns + ------- + :class:`int` + Number of children of the node. + """ + + return len(list(self.walk_hierarchy())) + + def is_root(self) -> bool: + """ + Return whether the node is a root node. + + Returns + ------- + :class:`bool` + Whether the node is a root node. + + Examples + -------- + >>> node_a = TreeNode("Node A") + >>> node_b = TreeNode("Node B", node_a) + >>> node_c = TreeNode("Node C", node_b) + >>> node_a.is_root() + True + >>> node_b.is_root() + False + """ + + return self.parent is None + + def is_inner(self) -> bool: + """ + Return whether the node is an inner node. + + Returns + ------- + :class:`bool` + Whether the node is an inner node. + + Examples + -------- + >>> node_a = TreeNode("Node A") + >>> node_b = TreeNode("Node B", node_a) + >>> node_c = TreeNode("Node C", node_b) + >>> node_a.is_inner() + False + >>> node_b.is_inner() + True + """ + + return all([not self.is_root(), not self.is_leaf()]) + + def is_leaf(self) -> bool: + """ + Return whether the node is a leaf node. + + Returns + ------- + :class:`bool` + Whether the node is a leaf node. + + Examples + -------- + >>> node_a = TreeNode("Node A") + >>> node_b = TreeNode("Node B", node_a) + >>> node_c = TreeNode("Node C", node_b) + >>> node_a.is_leaf() + False + >>> node_c.is_leaf() + True + """ + + return len(self._children) == 0 + + def walk_hierarchy(self, ascendants: bool = False) -> Generator: + """ + Return a generator used to walk into :class:`colour.utilities.Node` + tree. + + Parameters + ---------- + ascendants + Whether to walk up the node tree. + + Yields + ------ + Generator + Node tree walker. + + Examples + -------- + >>> node_a = TreeNode("Node A") + >>> node_b = TreeNode("Node B", node_a) + >>> node_c = TreeNode("Node C", node_a) + >>> node_d = TreeNode("Node D", node_b) + >>> node_e = TreeNode("Node E", node_b) + >>> node_f = TreeNode("Node F", node_d) + >>> node_g = TreeNode("Node G", node_f) + >>> node_h = TreeNode("Node H", node_g) + >>> for node in node_a.walk_hierarchy(): + ... print(node.name) + Node B + Node D + Node F + Node G + Node H + Node E + Node C + """ + + attribute = "children" if not ascendants else "parent" + + nodes = getattr(self, attribute) + nodes = nodes if isinstance(nodes, list) else [nodes] + + for node in nodes: + yield node + + if not getattr(node, attribute): + continue + + yield from node.walk_hierarchy(ascendants=ascendants) + + def render(self, tab_level: int = 0): + """ + Render the current node and its children as a string. + + Parameters + ---------- + tab_level + Initial indentation level + + Returns + ------- + :class:`str` + Rendered node tree. + + Examples + -------- + >>> node_a = TreeNode("Node A") + >>> node_b = TreeNode("Node B", node_a) + >>> node_c = TreeNode("Node C", node_a) + >>> print(node_a.render()) + |----"Node A" + |----"Node B" + |----"Node C" + + """ + + output = "" + + for _i in range(tab_level): + output += " " + + tab_level += 1 + + output += f'|----"{self.name}"\n' + + for child in self._children: + output += child.render(tab_level) + + tab_level -= 1 + + return output + + +class Port(MixinLogging): + """ + Define an object that can be added either as an input or output port, + i.e., a pin, to a :class:`colour.utilities.PortNode` class and connected to + another input or output port. + + Parameters + ---------- + name + Port name. + value + Initial value to set the port with. + description + Port description + node + Node to add the port to. + + Attributes + ---------- + - :attr:`~colour.utilities.Port.name` + - :attr:`~colour.utilities.Port.value` + - :attr:`~colour.utilities.Port.description` + - :attr:`~colour.utilities.Port.node` + - :attr:`~colour.utilities.Port.connections` + + Methods + ------- + - :meth:`~colour.utilities.Port.__init__` + - :meth:`~colour.utilities.Port.__str__` + - :meth:`~colour.utilities.Port.is_input_port` + - :meth:`~colour.utilities.Port.is_output_port` + - :meth:`~colour.utilities.Port.connect` + - :meth:`~colour.utilities.Port.disconnect` + - :meth:`~colour.utilities.Port.to_graphviz` + + Examples + -------- + >>> port = Port("a", 1, "Port A Description") + >>> port.name + 'a' + >>> port.value + 1 + >>> port.description + 'Port A Description' + """ + + def __init__( + self, + name: str | None = None, + value: Any = None, + description: str | None = None, + node: PortNode | None = None, + ) -> None: + super().__init__() + + # TODO: Consider using an ordered set instead of a dict. + self._connections: Dict[Port, None] = {} + + self._node: PortNode | None = None + self.node = optional(node, self._node) + self._name: str = self.__class__.__name__ + self.name = optional(name, self._name) + self._value = None + self.value = optional(value, self._value) + self._description = description + self.description = optional(description, self._description) + + @property + def name(self) -> str: + """ + Getter and setter property for the port name. + + Parameters + ---------- + value + Value to set the port name with. + + Returns + ------- + :class:`str` + Port name. + """ + + return self._name + + @name.setter + def name(self, value: str): + """Setter for the **self.name** property.""" + + attest( + isinstance(value, str), + f'"name" property: "{value}" type is not "str"!', + ) + + self._name = value + + @property + def value(self) -> Any: + """ + Getter and setter property for the port value. + + Parameters + ---------- + value + Value to set the port value with. + + Returns + ------- + :class:`object` + Port value. + """ + + # NOTE: Assumption is that if the public API is used to set values, the + # actual port value is coming from the connected port. Any connected + # port is valid as they should all carry the same value, thus the first + # connected port is returned. + for connection in self._connections: + return connection._value + + return self._value + + @value.setter + def value(self, value: Any): + """Setter for the **self.value** property.""" + + self._value = value + + if self._node is not None: + self.log(f'Dirtying "{self._node}".', "debug") + self._node.dirty = True + + # NOTE: Setting the port value implies that all the connected ports + # should be also set to the same given value. + for direct_connection in self._connections: + self.log(f'Setting "{direct_connection.node}" value to {value}.', "debug") + direct_connection._value = value + + if direct_connection.node is not None: + self.log(f'Dirtying "{direct_connection.node}".', "debug") + direct_connection.node.dirty = True + + for indirect_connection in direct_connection.connections: + if indirect_connection == self: + continue + + self.log( + f'Setting "{indirect_connection.node}" value to {value}.', "debug" + ) + indirect_connection._value = value + + if indirect_connection.node is not None: + self.log(f'Dirtying "{indirect_connection.node}".', "debug") + indirect_connection.node.dirty = True + + self._value = value + + @property + def description(self) -> str | None: + """ + Getter and setter property for the port description. + + Parameters + ---------- + value + Value to set the port description with. + + Returns + ------- + :class:`str` or None + Port description. + """ + + return self._description + + @description.setter + def description(self, value: str | None): + """Setter for the **self.description** property.""" + + attest( + value is None or isinstance(value, str), + f'"description" property: "{value}" is not "None" or ' + f'its type is not "str"!', + ) + + self._description = value + + @property + def node(self) -> PortNode | None: + """ + Getter property for the port node. + + Returns + ------- + :class:`PortNode` or None + Port node. + """ + + return self._node + + @node.setter + def node(self, value: PortNode | None): + """Setter for the **self.node** property.""" + + attest( + value is None or isinstance(value, PortNode), + f'"node" property: "{value}" is not "None" or ' + f'its type is not "PortNode"!', + ) + + self._node = value + + @property + def connections(self) -> Dict[Port, None]: + """ + Getter property for the port connections. + + Returns + ------- + :class:`dict` + Port connections. + """ + + return self._connections + + def __str__(self) -> str: + """ + Return a formatted string representation of the port. + + Returns + ------- + :class:`str` + Formatted string representation of the port. + + Examples + -------- + >>> print(Port("a")) + None.a (-> []) + >>> print(Port("a", node=PortNode("Port Node"))) + Port Node.a (-> []) + """ + + connections = [ + ( + f"{connection.node.name}.{connection.name}" + if connection.node is not None + else "None.{connection.name}" + ) + for connection in self._connections + ] + + direction = "<-" if self.is_input_port() else "->" + + node_name = self._node.name if self._node is not None else "None" + + return f"{node_name}.{self._name} ({direction} {connections})" + + def is_input_port(self) -> bool: + """ + Return whether the port is an input port. + + Returns + ------- + :class:`bool` + Whether the port is an input port. + + Examples + -------- + >>> Port().is_input_port() + False + >>> node = PortNode() + >>> node.add_input_port("a").is_input_port() + True + """ + + if self._node is not None: + return self._name in self._node.input_ports + + return False + + def is_output_port(self) -> bool: + """ + Return whether the port is an output port. + + Returns + ------- + :class:`bool` + Whether the port is an output port. + + Examples + -------- + >>> Port().is_output_port() + False + >>> node = PortNode() + >>> node.add_output_port("output").is_output_port() + True + """ + + if self._node is not None: + return self._name in self._node.output_ports + + return False + + def connect(self, port: Port) -> None: + """ + Connect the port to the other given port. + + Parameters + ---------- + port + Port to connect to. + + Raises + ------ + ValueError + if an attempt is made to connect an input port to multiple output + ports. + + Examples + -------- + >>> port_a = Port() + >>> port_b = Port() + >>> port_a.connections + {} + >>> port_b.connections + {} + >>> port_a.connect(port_b) + >>> port_a.connections # doctest: +ELLIPSIS + {<...Port object at 0x...>: None} + >>> port_b.connections # doctest: +ELLIPSIS + {<...Port object at 0x...>: None} + """ + + attest(isinstance(port, Port), f'"{port}" is not a "Port" instance!') + + self.log(f'Connecting "{self.name}" to "{port.name}".', "debug") + + self.connections[port] = None + port.connections[self] = None + + def disconnect(self, port: Port) -> None: + """ + Disconnect the port from the other given port. + + Parameters + ---------- + port + Port to disconnect from. + + Examples + -------- + >>> port_a = Port() + >>> port_b = Port() + >>> port_a.connect(port_b) + >>> port_a.connections # doctest: +ELLIPSIS + {<...Port object at 0x...>: None} + >>> port_b.connections # doctest: +ELLIPSIS + {<...Port object at 0x...>: None} + >>> port_a.disconnect(port_b) + >>> port_a.connections + {} + >>> port_b.connections + {} + """ + + attest(isinstance(port, Port), f'"{port}" is not a "Port" instance!') + + self.log(f'Disconnecting "{self.name}" from "{port.name}".', "debug") + + self.connections.pop(port) + port.connections.pop(self) + + def to_graphviz(self) -> str: + """ + Return a string representation for visualisation of the port with + *Graphviz*. + + Returns + ------- + :class:`str` + String representation for visualisation of the port with *Graphviz*. + + Examples + -------- + >>> Port("a").to_graphviz() + ' a' + """ + + return f"<{self._name}> {self.name}" + + +class PortNode(TreeNode, MixinLogging): + """ + Define a node with support for input and output ports. + + Other Parameters + ---------------- + name + Node name. + + Attributes + ---------- + - :attr:`~colour.utilities.PortNode.input_ports` + - :attr:`~colour.utilities.PortNode.output_ports` + - :attr:`~colour.utilities.PortNode.dirty` + - :attr:`~colour.utilities.PortNode.edges` + - :attr:`~colour.utilities.PortNode.description` + + Methods + ------- + - :meth:`~colour.utilities.PortNode.__init__` + - :meth:`~colour.utilities.PortNode.add_input_port` + - :meth:`~colour.utilities.PortNode.remove_input_port` + - :meth:`~colour.utilities.PortNode.add_output_port` + - :meth:`~colour.utilities.PortNode.remove_output_port` + - :meth:`~colour.utilities.PortNode.get_input` + - :meth:`~colour.utilities.PortNode.set_input` + - :meth:`~colour.utilities.PortNode.get_output` + - :meth:`~colour.utilities.PortNode.set_output` + - :meth:`~colour.utilities.PortNode.connect` + - :meth:`~colour.utilities.PortNode.disconnect` + - :meth:`~colour.utilities.PortNode.process` + - :meth:`~colour.utilities.PortNode.to_graphviz` + + Examples + -------- + >>> class NodeAdd(PortNode): + ... def __init__(self, *args, **kwargs): + ... super().__init__(*args, **kwargs) + ... + ... self.description = "Perform the addition of the two input port values." + ... + ... self.add_input_port("a") + ... self.add_input_port("b") + ... self.add_output_port("output") + ... + ... def process(self): + ... a = self.get_input("a") + ... b = self.get_input("b") + ... + ... if a is None or b is None: + ... return + ... + ... self._output_ports["output"].value = a + b + ... + ... self.dirty = False + >>> node = NodeAdd() + >>> node.set_input("a", 1) + >>> node.set_input("b", 1) + >>> node.process() + >>> node.get_output("output") + 2 + """ + + def __init__(self, name: str | None = None, description: str | None = None): + super().__init__(name) + self._description = description + self.description = optional(description, self._description) + + self._input_ports = {} + self._output_ports = {} + self._dirty = True + + @property + def input_ports(self) -> Dict[str, Port]: + """ + Getter property for the input ports. + + Returns + ------- + :class:`dict` + Input ports. + """ + + return self._input_ports + + @property + def output_ports(self) -> Dict[str, Port]: + """ + Getter property for the output ports. + + Returns + ------- + :class:`dict` + Output ports. + """ + + return self._output_ports + + @property + def dirty(self) -> bool: + """ + Getter and setter property for the node dirty state. + + Parameters + ---------- + value + Value to set the node dirty state. + + Returns + ------- + :class:`bool` + Whether the node is dirty. + """ + + return self._dirty + + @dirty.setter + def dirty(self, value: bool): + """Setter for the **self.dirty** property.""" + + attest( + isinstance(value, bool), + f'"dirty" property: "{value}" type is not "bool"!', + ) + + self._dirty = value + + @property + def edges( + self, + ) -> Tuple[Dict[Tuple[Port, Port], None], Dict[Tuple[Port, Port], None]]: + """ + Return the edges of the node. + + Each edge represent a port and one of its connections. + + Returns + ------- + :class:`tuple` + Edges of the node as a tuple of input and output edge dictionaries. + """ + + # TODO: Consider using ordered set. + input_edges = {} + for port in self.input_ports.values(): + for connection in port.connections: + input_edges[(port, connection)] = None + + # TODO: Consider using ordered set. + output_edges = {} + for port in self.output_ports.values(): + for connection in port.connections: + output_edges[(port, connection)] = None + + return input_edges, output_edges + + @property + def description(self) -> str | None: + """ + Getter and setter property for the node description. + + Parameters + ---------- + value + Value to set the node description with. + + Returns + ------- + :class:`str` or None + Node description. + """ + + return self._description + + @description.setter + def description(self, value: str | None): + """Setter for the **self.description** property.""" + + attest( + value is None or isinstance(value, str), + f'"description" property: "{value}" is not "None" or ' + f'its type is not "str"!', + ) + + self._description = value + + def add_input_port( + self, + name: str, + value: Any = None, + description: str | None = None, + port_type: Type[Port] = Port, + ) -> Port: + """ + Add an input port with given name and value to the node. + + Parameters + ---------- + name + Name of the input port. + value + Value of the input port + description + Description of the input port. + port_type + Type of the input port. + + Returns + ------- + :class:`colour.utilities.Port` + Input port. + + Examples + -------- + >>> node = PortNode() + >>> node.add_input_port("a") # doctest: +ELLIPSIS + <...Port object at 0x...> + """ + + self._input_ports[name] = port_type(name, value, description, self) + + return self._input_ports[name] + + def remove_input_port( + self, + name: str, + ) -> Port: + """ + Remove the input port with given name from the node. + + Parameters + ---------- + name + Name of the input port. + + Returns + ------- + :class:`colour.utilities.Port` + Input port. + + Examples + -------- + >>> node = PortNode() + >>> port = node.add_input_port("a") + >>> node.remove_input_port("a") # doctest: +ELLIPSIS + <...Port object at 0x...> + """ + + attest( + name in self._input_ports, + f'"{name}" port is not a member of {self} input ports!', + ) + + port = self._input_ports.pop(name) + + for connection in port.connections: + port.disconnect(connection) + + return port + + def add_output_port( + self, + name: str, + value: Any = None, + description: str | None = None, + port_type: Type[Port] = Port, + ) -> None: + """ + Add an output port with given name and value to the node. + + Parameters + ---------- + name + Name of the output port. + value + Value of the output port + description + Description of the output port. + port_type + Type of the output port. + + Returns + ------- + :class:`colour.utilities.Port` + Output port. + + Examples + -------- + >>> node = PortNode() + >>> node.add_output_port("output") # doctest: +ELLIPSIS + <...Port object at 0x...> + """ + + self._output_ports[name] = port_type(name, value, description, self) + + return self._output_ports[name] + + def remove_output_port( + self, + name: str, + ) -> Port: + """ + Remove the output port with given name from the node. + + Parameters + ---------- + name + Name of the output port. + + Returns + ------- + :class:`colour.utilities.Port` + Output port. + + Examples + -------- + >>> node = PortNode() + >>> port = node.add_output_port("a") + >>> node.remove_output_port("a") # doctest: +ELLIPSIS + <...Port object at 0x...> + """ + + attest( + name in self._output_ports, + f'"{name}" port is not a member of {self} output ports!', + ) + + port = self._output_ports.pop(name) + + for connection in port.connections: + port.disconnect(connection) + + return port + + def get_input(self, name: str) -> Any: + """ + Return the value of the input port with given name. + + Parameters + ---------- + name + Name of the input port. + + Returns + ------- + :class:`object`: + Value of the input port. + + Raises + ------ + AssertionError + If the input port is not a member of the node input ports. + + Examples + -------- + >>> node = PortNode() + >>> port = node.add_input_port("a", 1) # doctest: +ELLIPSIS + >>> node.get_input("a") + 1 + """ + + attest( + name in self._input_ports, + f'"{name}" is not a member of "{self._name}" input ports!', + ) + + return self._input_ports[name].value + + def set_input(self, name: str, value: Any) -> None: + """ + Set the value of the input port with given name. + + Parameters + ---------- + name + Name of the input port. + value + Value of the input port + + Raises + ------ + AssertionError + If the input port is not a member of the node input ports. + + Examples + -------- + >>> node = PortNode() + >>> port = node.add_input_port("a") # doctest: +ELLIPSIS + >>> port.value + >>> node.set_input("a", 1) + >>> port.value + 1 + """ + + attest( + name in self._input_ports, + f'"{name}" is not a member of "{self._name}" input ports!', + ) + + self._input_ports[name].value = value + + def get_output(self, name: str) -> None: + """ + Return the value of the output port with given name. + + Parameters + ---------- + name + Name of the output port. + + Returns + ------- + :class:`object`: + Value of the output port. + + Raises + ------ + AssertionError + If the output port is not a member of the node output ports. + + Examples + -------- + >>> node = PortNode() + >>> port = node.add_output_port("output", 1) # doctest: +ELLIPSIS + >>> node.get_output("output") + 1 + """ + + attest( + name in self._output_ports, + f'"{name}" is not a member of "{self._name}" output ports!', + ) + + return self._output_ports[name].value + + def set_output(self, name: str, value: Any) -> None: + """ + Set the value of the output port with given name. + + Parameters + ---------- + name + Name of the output port. + value + Value of the output port + + Raises + ------ + AssertionError + If the output port is not a member of the node output ports. + + Examples + -------- + >>> node = PortNode() + >>> port = node.add_output_port("output") # doctest: +ELLIPSIS + >>> port.value + >>> node.set_output("output", 1) + >>> port.value + 1 + """ + + attest( + name in self._output_ports, + f'"{name}" is not a member of "{self._name}" input ports!', + ) + + self._output_ports[name].value = value + + def connect( + self, + source_port: str, + target_node: PortNode, + target_port: str, + ) -> None: + """ + Connect the given source port to given node target port. + + The source port can be an input port but the target port must be + an output port and conversely, if the source port is an output port, the + target port must be an input port. + + Parameters + ---------- + source_port + Source port of the node to connect to the other node target port. + target_node + Target node that the target port is the member of. + target_port + Target port from the target node to connect the source port to. + + Examples + -------- + >>> node_1 = PortNode() + >>> port = node_1.add_output_port("output") + >>> node_2 = PortNode() + >>> port = node_2.add_input_port("a") + >>> node_1.connect("output", node_2, "a") + >>> node_1.edges # doctest: +ELLIPSIS + ({}, {(<...Port object at 0x...>, <...Port object at 0x...>): None}) + """ + + port_source = self._output_ports.get( + source_port, self.input_ports.get(source_port) + ) + port_target = target_node.input_ports.get( + target_port, target_node.output_ports.get(target_port) + ) + + port_source.connect(port_target) + + def disconnect( + self, + source_port: str, + target_node: PortNode, + target_port: str, + ) -> None: + """ + Disconnect the given source port from given node target port. + + The source port can be an input port but the target port must be + an output port and conversely, if the source port is an output port, the + target port must be an input port. + + Parameters + ---------- + source_port + Source port of the node to disconnect from the other node target port. + target_node + Target node that the target port is the member of. + target_port + Target port from the target node to disconnect the source port from. + + Examples + -------- + >>> node_1 = PortNode() + >>> port = node_1.add_output_port("output") + >>> node_2 = PortNode() + >>> port = node_2.add_input_port("a") + >>> node_1.connect("output", node_2, "a") + >>> node_1.edges # doctest: +ELLIPSIS + ({}, {(<...Port object at 0x...>, <...Port object at 0x...>): None}) + >>> node_1.disconnect("output", node_2, "a") + >>> node_1.edges + ({}, {}) + """ + + port_source = self._output_ports.get( + source_port, self.input_ports.get(source_port) + ) + port_target = target_node.input_ports.get( + target_port, target_node.output_ports.get(target_port) + ) + + port_source.disconnect(port_target) + + def process(self) -> None: + """ + Process the node, must be reimplemented by sub-classes. + + This definition is responsible to set the dirty state of the node + according to processing outcome. + + Examples + -------- + >>> class NodeAdd(PortNode): + ... def __init__(self, *args, **kwargs): + ... super().__init__(*args, **kwargs) + ... + ... self.description = ( + ... "Perform the addition of the two input port values." + ... ) + ... + ... self.add_input_port("a") + ... self.add_input_port("b") + ... self.add_output_port("output") + ... + ... def process(self): + ... a = self.get_input("a") + ... b = self.get_input("b") + ... + ... if a is None or b is None: + ... return + ... + ... self._output_ports["output"].value = a + b + ... + ... self.dirty = False + >>> node = NodeAdd() + >>> node.set_input("a", 1) + >>> node.set_input("b", 1) + >>> node.process() + >>> node.get_output("output") + 2 + """ + + self._dirty = False + + def to_graphviz(self) -> str: + """ + Return a string representation for visualisation of the node with + *Graphviz*. + + Returns + ------- + :class:`str` + String representation for visualisation of the node with *Graphviz*. + + Examples + -------- + >>> node_1 = PortNode("PortNode") + >>> port = node_1.add_input_port("a") + >>> port = node_1.add_input_port("b") + >>> port = node_1.add_output_port("output") + >>> node_1.to_graphviz() # doctest: +ELLIPSIS + 'PortNode (#...) | {{ a| b} | { output}}' + """ + + input_ports = "|".join( + [port.to_graphviz() for port in self._input_ports.values()] + ) + output_ports = "|".join( + [port.to_graphviz() for port in self._output_ports.values()] + ) + + return f"{self.name} (#{self.id}) | {{{{{input_ports}}} | {{{output_ports}}}}}" + + +class PortGraph(PortNode): + """ + Define a node-graph for :class:`colour.utilities.PortNode` class instances. + + Parameters + ---------- + name + Name of the node-graph. + description + Port description + + Attributes + ---------- + - :attr:`~colour.utilities.PortGraph.nodes` + + Methods + ------- + - :meth:`~colour.utilities.PortGraph.__str__` + - :meth:`~colour.utilities.PortGraph.add_node` + - :meth:`~colour.utilities.PortGraph.remove_node` + - :meth:`~colour.utilities.PortGraph.walk_ports` + - :meth:`~colour.utilities.PortGraph.process` + - :meth:`~colour.utilities.PortGraph.to_graphviz` + + Examples + -------- + >>> class NodeAdd(PortNode): + ... def __init__(self, *args, **kwargs): + ... super().__init__(*args, **kwargs) + ... + ... self.description = "Perform the addition of the two input port values." + ... + ... self.add_input_port("a") + ... self.add_input_port("b") + ... self.add_output_port("output") + ... + ... def process(self): + ... a = self.get_input("a") + ... b = self.get_input("b") + ... + ... if a is None or b is None: + ... return + ... + ... self._output_ports["output"].value = a + b + ... + ... self.dirty = False + >>> node_1 = NodeAdd() + >>> node_1.set_input("a", 1) + >>> node_1.set_input("b", 1) + >>> node_2 = NodeAdd() + >>> node_1.connect("output", node_2, "a") + >>> node_2.set_input("b", 1) + >>> graph = PortGraph() + >>> graph.add_node(node_1) + >>> graph.add_node(node_2) + >>> graph.nodes # doctest: +ELLIPSIS + {'NodeAdd#...': <...NodeAdd object at 0x...>, \ +'NodeAdd#...': <...NodeAdd object at 0x...>} + >>> graph.process() + >>> node_2.get_output("output") + 3 + """ + + def __init__(self, name: str | None = None, description: str | None = None): + super().__init__(name, description) + + self._name: str = self.__class__.__name__ + self.name = optional(name, self._name) + self._description = description + self.description = optional(description, self._description) + + self._nodes = {} + + @property + def nodes(self) -> Dict[str, PortNode]: + """ + Getter property for the node-graph nodes. + + Returns + ------- + :class:`dict` + Node-graph nodes. + """ + + return self._nodes + + def __str__(self) -> str: + """ + Return a formatted string representation of the node-graph. + + Returns + ------- + :class`str` + Formatted string representation. + """ + + return f"{self.__class__.__name__}({len(self._nodes)})" + + def add_node(self, node: PortNode) -> None: + """ + Add given node to the node-graph. + + Parameters + ---------- + node + Node to add to the node-graph. + + Raises + ------ + AsssertionError + If the node is not a :class:`colour.utilities.PortNode` class + instance. + + Examples + -------- + >>> node_1 = PortNode() + >>> node_2 = PortNode() + >>> graph = PortGraph() + >>> graph.nodes + {} + >>> graph.add_node(node_1) + >>> graph.nodes # doctest: +ELLIPSIS + {'PortNode#...': <...PortNode object at 0x...>} + >>> graph.add_node(node_2) + >>> graph.nodes # doctest: +ELLIPSIS + {'PortNode#...': <...PortNode object at 0x...>, 'PortNode#...': \ +<...PortNode object at 0x...>} + """ + + attest(isinstance(node, PortNode), f'"{node}" is not a "Node" instance!') + + attest( + node.name not in self._nodes, f'"{node}" is already a member of the graph!' + ) + + self._nodes[node.name] = node + self._children.append(node) # pyright: ignore + node._parent = self + + def remove_node(self, node: PortNode) -> None: + """ + Remove given node from the node-graph. + + The node input and output ports will be disconnected from all their + connections. + + Parameters + ---------- + node + Node to remove from the node-graph. + + Raises + ------ + AsssertionError + If the node is not a member of the node-graph. + + Examples + -------- + >>> node_1 = PortNode() + >>> node_2 = PortNode() + >>> graph = PortGraph() + >>> graph.add_node(node_1) + >>> graph.add_node(node_2) + >>> graph.nodes # doctest: +ELLIPSIS + {'PortNode#...': <...PortNode object at 0x...>, \ +'PortNode#...': <...PortNode object at 0x...>} + >>> graph.remove_node(node_2) + >>> graph.nodes # doctest: +ELLIPSIS + {'PortNode#...': <...PortNode object at 0x...>} + >>> graph.remove_node(node_1) + >>> graph.nodes + {} + """ + + attest(isinstance(node, PortNode), f'"{node}" is not a "Node" instance!') + + attest( + node.name in self._nodes, + f'"{node}" is not a member of "{self._name}" node-graph!', + ) + + for port in node.input_ports.values(): + for connection in port.connections.copy(): + port.disconnect(connection) + + for port in node.output_ports.values(): + for connection in port.connections.copy(): + port.disconnect(connection) + + self._nodes.pop(node.name) + self._children.remove(node) # pyright: ignore + node._parent = None + + @required("NetworkX") + def walk_ports(self) -> Generator: + """ + Return a generator used to walk into the node-graph. + + The node is walked according to a topological sorted order. A + topological sort is a non-unique permutation of the nodes of a directed + graph such that an edge from :math:`u` to :math:`v` implies that + :math:`u` appears before :math:`v` in the topological sort order. + This ordering is valid only if the graph has no directed cycles. + + To walk the node-graph, an *NetworkX* graph is constructed by + connecting the ports together and in turn connecting them to the nodes. + + Yields + ------ + Generator + Node-graph walker. + + Examples + -------- + >>> node_1 = PortNode() + >>> port = node_1.add_output_port("output") + >>> node_2 = PortNode() + >>> port = node_2.add_input_port("a") + >>> graph = PortGraph() + >>> graph.add_node(node_1) + >>> graph.add_node(node_2) + >>> node_1.connect("output", node_2, "a") + >>> list(graph.walk_ports()) # doctest: +ELLIPSIS + [<...PortNode object at 0x...>, <...PortNode object at 0x...>] + """ + + import networkx as nx + + graph = nx.DiGraph() + + for node in self._children: + input_edges, output_edges = node.edges + + graph.add_node(node.name, node=node) + + if len(node.children) != 0: + continue + + for edge in input_edges: + # PortGraph is used a container, it is common to connect its + # input ports to other node input ports and other node output + # ports to its output ports. The graph generated is thus not + # acyclic. + if self in (edge[0].node, edge[1].node): + continue + + # Node -> Port -> Port -> Node + # Connected Node Output Port Node -> Connected Node Output Port + graph.add_edge( + edge[1].node.name, # pyright: ignore + str(edge[1]), + edge=edge, + ) + # Connected Node Output Port -> Node Input Port + graph.add_edge(str(edge[1]), str(edge[0]), edge=edge) + # Input Port - Input Port Node + graph.add_edge( + str(edge[0]), + edge[0].node.name, # pyright: ignore + edge=edge, + ) + + for edge in output_edges: + if self in (edge[0].node, edge[1].node): + continue + + # Node -> Port -> Port -> Node + # Output Port Node -> Output Port + graph.add_edge( + edge[0].node.name, # pyright: ignore + str(edge[0]), + edge=edge, + ) + # Node Output Port -> Connected Node Input Port + graph.add_edge(str(edge[0]), str(edge[1]), edge=edge) + # Connected Node Input Port -> Connected Node Input Port Node + graph.add_edge( + str(edge[1]), + edge[1].node.name, # pyright: ignore + edge=edge, + ) + + try: + for name in nx.topological_sort(graph): + node = graph.nodes[name].get("node") + if node is not None: + yield node + except nx.NetworkXUnfeasible as error: + filename = "AGraph.png" + self.log( + f'A "NetworkX" error occurred, debug graph image has been ' + f'saved to "{os.path.join(os.getcwd(), filename)}"!' + ) + agraph = nx.nx_agraph.to_agraph(graph) + agraph.draw(filename, prog="dot") + + raise error # noqa: TRY201 + + def process(self, **kwargs: Dict) -> None: + """ + Process the node-graph by walking it and calling the + :func:`colour.utilities.PortNode.process` method. + + Other Parameters + ---------------- + kwargs + Keyword arguments. + + Examples + -------- + >>> class NodeAdd(PortNode): + ... def __init__(self, *args, **kwargs): + ... super().__init__(*args, **kwargs) + ... + ... self.description = ( + ... "Perform the addition of the two input port values." + ... ) + ... + ... self.add_input_port("a") + ... self.add_input_port("b") + ... self.add_output_port("output") + ... + ... def process(self): + ... a = self.get_input("a") + ... b = self.get_input("b") + ... + ... if a is None or b is None: + ... return + ... + ... self._output_ports["output"].value = a + b + ... + ... self.dirty = False + >>> node_1 = NodeAdd() + >>> node_1.set_input("a", 1) + >>> node_1.set_input("b", 1) + >>> node_2 = NodeAdd() + >>> node_1.connect("output", node_2, "a") + >>> node_2.set_input("b", 1) + >>> graph = PortGraph() + >>> graph.add_node(node_1) + >>> graph.add_node(node_2) + >>> graph.nodes # doctest: +ELLIPSIS + {'NodeAdd#...': <...NodeAdd object at 0x...>, \ +'NodeAdd#...': <...NodeAdd object at 0x...>} + >>> graph.process() + >>> node_2.get_output("output") + 3 + >>> node_2.dirty + False + """ + + dry_run = kwargs.get("dry_run", False) + + for_node_reached = False + for node in self.walk_ports(): + if for_node_reached: + break + + # Processing currently stops once a control flow node is reached. + # TODO: Implement solid control flow based processing using a stack. + if isinstance(node, ControlFlowNode): + for_node_reached = True + + if not node.dirty: + self.log(f'Skipping "{node}" computed node.') + continue + + self.log(f'Processing "{node}" node...') + + if dry_run: + continue + + node.process() + + @required("Pydot") + def to_graphviz(self) -> Dot: # noqa: F821 # pyright: ignore + """ + Return a visualisation node-graph for *Graphviz*. + + Returns + ------- + :class:`pydot.Dot` + *Pydot* graph. + + Examples + -------- + >>> node_1 = PortNode() + >>> port = node_1.add_output_port("output") + >>> node_2 = PortNode() + >>> port = node_2.add_input_port("a") + >>> graph = PortGraph() + >>> graph.add_node(node_1) + >>> graph.add_node(node_2) + >>> node_1.connect("output", node_2, "a") + >>> graph.to_graphviz() # doctest: +SKIP + + """ + + if self._parent is not None: + return PortNode.to_graphviz(self) + + import pydot + + dot = pydot.Dot( + "digraph", graph_type="digraph", rankdir="LR", splines="polyline" + ) + + graphs = [node for node in self.walk_ports() if isinstance(node, PortGraph)] + + def is_graph_member(node: PortNode) -> bool: + """Return whether the given node is member of a graph.""" + + return any(node in graph.nodes.values() for graph in graphs) + + for node in self.walk_ports(): + dot.add_node( + pydot.Node( + f"{node.name} (#{node.id})", + label=node.to_graphviz(), + shape="record", + ) + ) + input_edges, output_edges = node.edges + + for edge in input_edges: + # Not drawing node edges that involve a node member of graph. + if is_graph_member(edge[0].node) or is_graph_member(edge[1].node): + continue + + dot.add_edge( + pydot.Edge( + f"{edge[1].node.name} (#{edge[1].node.id})", + f"{edge[0].node.name} (#{edge[0].node.id})", + tailport=edge[1].name, + headport=edge[0].name, + key=f"{edge[1]} => {edge[0]}", + dir="forward", + ) + ) + + return dot + + +class ExecutionPort(Port): + """ + Define a special port for nodes supporting execution input and output + ports. + """ + + @property + def value(self) -> Any: + """ + Getter and setter property for the port value. + + Parameters + ---------- + value + Value to set the port value with. + + Returns + ------- + :class:`object` + Port value. + """ + + @value.setter + def value(self, value: Any): + """Setter for the **self.value** property.""" + + +class ExecutionNode(PortNode): + """ + Define a special node with execution input and output ports. + """ + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.add_input_port( + "execution_input", None, "Port for input execution", ExecutionPort + ) + self.add_output_port( + "execution_output", None, "Port for output execution", ExecutionPort + ) + + +class ControlFlowNode(ExecutionNode): + """Define a class inherited by control flow nodes.""" + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + +class For(ControlFlowNode): + """ + Define a ``for`` loop node. + + The node loops over the input port ``array``, sets the ``index`` and + ``element`` output ports at each iteration and call the + :meth:`colour.utilities.ExecutionNode.process` method of the object + connected to the ``loop_output`` output port. + + Upon completion, the :meth:`colour.utilities.ExecutionNode.process` method + of the object connected to the ``execution_output`` output port is called. + + Notes + ----- + - The :class:`colour.utilities.For` loop node does not currently call + more than the two aforementioned + :meth:`colour.utilities.ExecutionNode.process` methods, if a series of + nodes is attached to the `loop_output`` or ``execution_output`` output + ports, only the left-most node will be processed. To circumvent this + limitation, it is recommended to use a + :class:`colour.utilities.PortGraph` class instance. + """ + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.add_input_port("array", [], "Array to loop onto") + self.add_output_port("index", None, "Index of the current element of the array") + self.add_output_port("element", None, "Current element of the array") + self.add_output_port("loop_output", None, "Port for loop Output", ExecutionPort) + + def process(self) -> None: + """ + Process the ``for`` loop node. + """ + + connection = next(iter(self.output_ports["loop_output"].connections), None) + if connection is None: + return + + node = connection.node + + if node is None: + return + + self.log(f'Processing "{node}" node...') + + for i, element in enumerate(self.get_input("array")): + self.log(f"Index {i}, Element {element}", "debug") + self.set_output("index", i) + self.set_output("element", element) + + node.process() + + execution_output_connection = next( + iter(self.output_ports["execution_output"].connections), None + ) + if execution_output_connection is None: + return + + execution_output_node = execution_output_connection.node + + if execution_output_node is None: + return + + execution_output_node.process() + + self.dirty = False + + +_THREADING_LOCK = threading.Lock() + + +def _task_thread(args): + """ + Define the default task for the + :class:`colour.utilities.ParallelForThread` loop node + + Parameters + ---------- + args + Processing arguments. + """ + + i, element, sub_graph, node = args + + node.log(f"Index {i}, Element {element}", "info") + + with _THREADING_LOCK: + node.set_output("index", i) + node.set_output("element", element) + + sub_graph.process() + + return i, sub_graph.get_output("output") + + +class ParallelForThread(ControlFlowNode): + """ + Define an advanced ``for`` loop node distributing the work across multiple + threads. + + Each generated task receives one ``index`` and ``element`` output ports + value. The tasks are then executed by a + :class:`concurrent.futures.ThreadPoolExecutor` class instance, the futures + result are then collected, sorted and the ``results`` output port value is + set with them. + + Upon completion, the :meth:`colour.utilities.ExecutionNode.process` method + of the object connected to the ``execution_output`` output port is called. + + Notes + ----- + - The :class:`colour.utilities.ParallelForThread` loop node does not + currently call more than the two aforementioned + :meth:`colour.utilities.ExecutionNode.process` methods, if a series of + nodes is attached to the `loop_output`` or ``execution_output`` output + ports, only the left-most node will be processed. To circumvent this + limitation, it is recommended to use a + :class:`colour.utilities.PortGraph` class instance. + - As the graph being processed is shared across the threads, a lock must + be taken in the task callable. This might nullify any speed gains for + heavy processing tasks, in such eventuality, it is recommended to use + the :class:`colour.utilities.ParallelForMultiprocess` loop node + instead. + """ + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.add_input_port("array", [], "Array to loop onto") + self.add_input_port("task", _task_thread, "Task to execute") + self.add_input_port("workers", 16, "Maximum number of workers") + self.add_output_port("index", None, "Index of the current element of the array") + self.add_output_port("element", None, "Current element of the array") + self.add_output_port("results", [], "Results from the parallel loop") + self.add_output_port("loop_output", None, "Port for loop output", ExecutionPort) + + def process(self) -> None: + """ + Process the ``for`` loop node. + """ + + connection = next(iter(self.output_ports["loop_output"].connections), None) + if connection is None: + return + + node = connection.node + + if node is None: + return + + self.log(f'Processing "{node}" node...') + + results = {} + with concurrent.futures.ThreadPoolExecutor( + max_workers=self.get_input("workers") + ) as executor: + futures = [ + executor.submit(self.get_input("task"), (i, element, node, self)) + for i, element in enumerate(self.get_input("array")) + ] + + for future in concurrent.futures.as_completed(futures): + index, element = future.result() + self.log(f'Processed "{element}" element with index "{index}".') + results[index] = element + + results = dict(sorted(results.items())) + self.set_output("results", list(results.values())) + + execution_output_connection = next( + iter(self.output_ports["execution_output"].connections), None + ) + if execution_output_connection is None: + return + + execution_output_node = execution_output_connection.node + + if execution_output_node is None: + return + + execution_output_node.process() + + self.dirty = False + + +def _task_multiprocess(args): + """ + Define the default task for the + :class:`colour.utilities.ParallelForMultiprocess` loop node + + Parameters + ---------- + args + Processing arguments. + """ + + i, element, sub_graph, node = args + + node.log(f"Index {i}, Element {element}", "info") + + node.set_output("index", i) + node.set_output("element", element) + + sub_graph.process() + + return i, sub_graph.get_output("output") + + +class ParallelForMultiprocess(ControlFlowNode): + """ + Define an advanced ``for`` loop node distributing the work across multiple + processes. + + Each generated task receives one ``index`` and ``element`` output ports + value. The tasks are then executed by a + :class:`multiprocessing.Pool` class instance, the results are then + collected, sorted and the ``results`` output port value is set with them. + + Upon completion, the :meth:`colour.utilities.ExecutionNode.process` method + of the object connected to the ``execution_output`` output port is called. + + Notes + ----- + - The :class:`colour.utilities.ParallelForMultiprocess` loop node does + not currently call more than the two aforementioned + :meth:`colour.utilities.ExecutionNode.process` methods, if a series of + nodes is attached to the `loop_output`` or ``execution_output`` + output ports, only the left-most node will be processed. To circumvent + this limitation, it is recommended to use a + :class:`colour.utilities.PortGraph` class instance. + """ + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.add_input_port("array", [], "Array to loop onto") + self.add_input_port("task", _task_multiprocess, "Task to execute") + self.add_input_port("processes", 4, "Number of processes") + self.add_output_port("index", None, "Index of the current element of the array") + self.add_output_port("element", None, "Current element of the array") + self.add_output_port("results", [], "Results from the parallel loop") + self.add_output_port("loop_output", None, "Port for loop output", ExecutionPort) + + def process(self) -> None: + """ + Process the ``for`` loop node. + """ + + connection = next(iter(self.output_ports["loop_output"].connections), None) + if connection is None: + return + + node = connection.node + + if node is None: + return + + self.log(f'Processing "{node}" node...') + + results = {} + with concurrent.futures.ProcessPoolExecutor( + max_workers=self.get_input("processes") + ) as executor: + futures = [ + executor.submit(self.get_input("task"), (i, element, node, self)) + for i, element in enumerate(self.get_input("array")) + ] + + for future in concurrent.futures.as_completed(futures): + index, element = future.result() + self.log(f'Processed "{element}" element with index "{index}".') + results[index] = element + + results = dict(sorted(results.items())) + self.set_output("results", list(results.values())) + + execution_output_connection = next( + iter(self.output_ports["execution_output"].connections), None + ) + if execution_output_connection is None: + return + + execution_output_node = execution_output_connection.node + + if execution_output_node is None: + return + + execution_output_node.process() + + self.dirty = False diff --git a/colour/utilities/requirements.py b/colour/utilities/requirements.py new file mode 100644 index 0000000000..b98e6fdce9 --- /dev/null +++ b/colour/utilities/requirements.py @@ -0,0 +1,474 @@ +""" +Requirements Utilities +====================== + +Define the requirements utilities objects. +""" + +from __future__ import annotations + +import functools +import shutil +import subprocess + +from colour.hints import ( + Any, + Callable, + Literal, +) +from colour.utilities import CanonicalMapping + +__author__ = "Colour Developers" +__copyright__ = "Copyright 2013 Colour Developers" +__license__ = "BSD-3-Clause - https://opensource.org/licenses/BSD-3-Clause" +__maintainer__ = "Colour Developers" +__email__ = "colour-developers@colour-science.org" +__status__ = "Production" + +__all__ = [ + "is_ctlrender_installed", + "is_matplotlib_installed", + "is_networkx_installed", + "is_opencolorio_installed", + "is_openimageio_installed", + "is_pandas_installed", + "is_pydot_installed", + "is_tqdm_installed", + "is_trimesh_installed", + "is_xxhash_installed", + "REQUIREMENTS_TO_CALLABLE", + "required", +] + + +def is_ctlrender_installed(raise_exception: bool = False) -> bool: + """ + Return whether *ctlrender* is installed and available. + + Parameters + ---------- + raise_exception + Whether to raise an exception if *ctlrender* is unavailable. + + Returns + ------- + :class:`bool` + Whether *ctlrender* is installed. + + Raises + ------ + :class:`ImportError` + If *ctlrender* is not installed. + """ + + try: # pragma: no cover + stdout = subprocess.run( + ["ctlrender", "-help"], # noqa: S603, S607 + capture_output=True, + check=False, + ).stdout.decode("utf-8") + + if "transforms an image using one or more CTL scripts" not in stdout: + raise FileNotFoundError # noqa: TRY301 + + return True + except FileNotFoundError as error: # pragma: no cover + if raise_exception: + raise FileNotFoundError( + '"ctlrender" related API features are not available: ' + f'"{error}".\nSee the installation guide for more information: ' + "https://www.colour-science.org/installation-guide/" + ) from error + + return False + + +def is_matplotlib_installed(raise_exception: bool = False) -> bool: + """ + Return whether *Matplotlib* is installed and available. + + Parameters + ---------- + raise_exception + Whether to raise an exception if *Matplotlib* is unavailable. + + Returns + ------- + :class:`bool` + Whether *Matplotlib* is installed. + + Raises + ------ + :class:`ImportError` + If *Matplotlib* is not installed. + """ + + try: # pragma: no cover + import matplotlib as mpl # noqa: F401 + + return True + except ImportError as error: # pragma: no cover + if raise_exception: + raise ImportError( + '"Matplotlib" related API features are not available: ' + f'"{error}".\nSee the installation guide for more information: ' + "https://www.colour-science.org/installation-guide/" + ) from error + + return False + + +def is_networkx_installed(raise_exception: bool = False) -> bool: + """ + Return whether *NetworkX* is installed and available. + + Parameters + ---------- + raise_exception + Whether to raise an exception if *NetworkX* is unavailable. + + Returns + ------- + :class:`bool` + Whether *NetworkX* is installed. + + Raises + ------ + :class:`ImportError` + If *NetworkX* is not installed. + """ + + try: # pragma: no cover + import networkx as nx # noqa: F401 + + return True + except ImportError as error: # pragma: no cover + if raise_exception: + raise ImportError( + '"NetworkX" related API features, e.g., the automatic colour ' + f'conversion graph, are not available: "{error}".\nPlease refer ' + "to the installation guide for more information: " + "https://www.colour-science.org/installation-guide/" + ) from error + + return False + + +def is_opencolorio_installed(raise_exception: bool = False) -> bool: + """ + Return whether *OpenColorIO* is installed and available. + + Parameters + ---------- + raise_exception + Whether to raise an exception if *OpenColorIO* is unavailable. + + Returns + ------- + :class:`bool` + Whether *OpenColorIO* is installed. + + Raises + ------ + :class:`ImportError` + If *OpenColorIO* is not installed. + """ + + try: # pragma: no cover + import PyOpenColorIO # noqa: F401 + + return True + except ImportError as error: # pragma: no cover + if raise_exception: + raise ImportError( + '"OpenColorIO" related API features are not available: ' + f'"{error}".\nSee the installation guide for more information: ' + "https://www.colour-science.org/installation-guide/" + ) from error + + return False + + +def is_openimageio_installed(raise_exception: bool = False) -> bool: + """ + Return whether *OpenImageIO* is installed and available. + + Parameters + ---------- + raise_exception + Whether to raise an exception if *OpenImageIO* is unavailable. + + Returns + ------- + :class:`bool` + Whether *OpenImageIO* is installed. + + Raises + ------ + :class:`ImportError` + If *OpenImageIO* is not installed. + """ + + try: # pragma: no cover + import OpenImageIO # noqa: F401 + + return True + except ImportError as error: # pragma: no cover + if raise_exception: + raise ImportError( + '"OpenImageIO" related API features are not available: ' + f'"{error}".\nSee the installation guide for more information: ' + "https://www.colour-science.org/installation-guide/" + ) from error + + return False + + +def is_pandas_installed(raise_exception: bool = False) -> bool: + """ + Return whether *Pandas* is installed and available. + + Parameters + ---------- + raise_exception + Whether to raise an exception if *Pandas* is unavailable. + + Returns + ------- + :class:`bool` + Whether *Pandas* is installed. + + Raises + ------ + :class:`ImportError` + If *Pandas* is not installed. + """ + + try: # pragma: no cover + import pandas # noqa: F401, ICN001 + + return True + except ImportError as error: # pragma: no cover + if raise_exception: + raise ImportError( + f'"Pandas" related API features are not available: "{error}".\n' + "See the installation guide for more information: " + "https://www.colour-science.org/installation-guide/" + ) from error + + return False + + +def is_pydot_installed(raise_exception: bool = False) -> bool: + """ + Return whether *Pydot* is installed and available. The presence of + *Graphviz* will also be tested. + + Parameters + ---------- + raise_exception + Whether to raise an exception if *Pydot* is unavailable. + + Returns + ------- + :class:`bool` + Whether *Pydot* is installed. + + Raises + ------ + :class:`ImportError` + If *Pydot* is not installed. + """ + + try: # pragma: no cover + import pydot # noqa: F401 + + except ImportError as error: # pragma: no cover + if raise_exception: + raise ImportError( + '"Pydot" related API features are not available: ' + f'"{error}".\nSee the installation guide for more information: ' + "https://www.colour-science.org/installation-guide/" + ) from error + + if shutil.which("fdp") is not None: + return True + else: + if raise_exception: + raise RuntimeError( + '"Graphviz" is not installed, "Pydot" related API features ' + "are not available!" + "\nSee the installation guide for more information: " + "https://www.colour-science.org/installation-guide/" + ) + + return False + + +def is_tqdm_installed(raise_exception: bool = False) -> bool: + """ + Return whether *tqdm* is installed and available. + + Parameters + ---------- + raise_exception + Whether to raise an exception if *tqdm* is unavailable. + + Returns + ------- + :class:`bool` + Whether *tqdm* is installed. + + Raises + ------ + :class:`ImportError` + If *tqdm* is not installed. + """ + + try: # pragma: no cover + import tqdm # noqa: F401 + + return True + except ImportError as error: # pragma: no cover + if raise_exception: + raise ImportError( + f'"tqdm" related API features are not available: "{error}".\n' + "See the installation guide for more information: " + "https://www.colour-science.org/installation-guide/" + ) from error + + return False + + +def is_trimesh_installed(raise_exception: bool = False) -> bool: + """ + Return whether *Trimesh* is installed and available. + + Parameters + ---------- + raise_exception + Whether to raise an exception if *Trimesh* is unavailable. + + Returns + ------- + :class:`bool` + Whether *Trimesh* is installed. + + Raises + ------ + :class:`ImportError` + If *Trimesh* is not installed. + """ + + try: # pragma: no cover + import trimesh # noqa: F401 + + return True + except ImportError as error: # pragma: no cover + if raise_exception: + raise ImportError( + '"Trimesh" related API features are not available: ' + f'"{error}".\nSee the installation guide for more information: ' + "https://www.colour-science.org/installation-guide/" + ) from error + + return False + + +def is_xxhash_installed(raise_exception: bool = False) -> bool: + """ + Return whether *xxhash* is installed and available. + + Parameters + ---------- + raise_exception + Whether to raise an exception if *xxhash* is unavailable. + + Returns + ------- + :class:`bool` + Whether *xxhash* is installed. + + Raises + ------ + :class:`ImportError` + If *xxhash* is not installed. + """ + + try: # pragma: no cover + import xxhash # noqa: F401 + + return True + except ImportError as error: # pragma: no cover + if raise_exception: + raise ImportError( + '"xxhash" related API features are not available: ' + f'"{error}".\nSee the installation guide for more information: ' + "https://www.colour-science.org/installation-guide/" + ) from error + + return False + + +REQUIREMENTS_TO_CALLABLE: CanonicalMapping = CanonicalMapping( + { + "ctlrender": is_ctlrender_installed, + "Matplotlib": is_matplotlib_installed, + "NetworkX": is_networkx_installed, + "OpenColorIO": is_opencolorio_installed, + "OpenImageIO": is_openimageio_installed, + "Pandas": is_pandas_installed, + "Pydot": is_pydot_installed, + "tqdm": is_tqdm_installed, + "trimesh": is_trimesh_installed, + "xxhash": is_xxhash_installed, + } +) +""" +Mapping of requirements to their respective callables. +""" + + +def required( + *requirements: Literal[ + "ctlrender", + "Matplotlib", + "NetworkX", + "OpenColorIO", + "OpenImageIO", + "Pandas", + "Pydot", + "tqdm", + "trimesh", + "xxhash", + ], +) -> Callable: + """ + Decorate a function to check whether various ancillary package requirements + are satisfied. + + Other Parameters + ---------------- + requirements + Requirements to check whether they are satisfied. + + Returns + ------- + Callable + """ + + def wrapper(function: Callable) -> Callable: + """Wrap given function wrapper.""" + + @functools.wraps(function) + def wrapped(*args: Any, **kwargs: Any) -> Any: + """Wrap given function.""" + + for requirement in requirements: + REQUIREMENTS_TO_CALLABLE[requirement](raise_exception=True) + + return function(*args, **kwargs) + + return wrapped + + return wrapper diff --git a/colour/utilities/data_structures.py b/colour/utilities/structures.py similarity index 61% rename from colour/utilities/data_structures.py rename to colour/utilities/structures.py index 9bd4b7d9a9..5c11ddd27d 100644 --- a/colour/utilities/data_structures.py +++ b/colour/utilities/structures.py @@ -2,7 +2,7 @@ Data Structures =============== -Defines various data structures classes: +Define various data structures classes: - :class:`colour.utilities.Structure`: An object similar to C/C++ structured type. @@ -14,14 +14,12 @@ - :class:`colour.utilities.LazyCanonicalMapping`: Another delimiter and case-insensitive mapping allowing lazy values retrieving from keys while ignoring the key case. -- :class:`colour.utilities.Node`: A basic node object supporting creation of - basic node trees. References ---------- - :cite:`Mansencalc` : Mansencal, T. (n.d.). Lookup. https://github.com/KelSolaar/Foundations/blob/develop/foundations/\ -data_structures.py +structures.py - :cite:`Rakotoarison2017` : Rakotoarison, H. (2017). Bunch. https://github.com/scikit-learn/scikit-learn/blob/\ fb5a498d0bd00fc2b42fbd19b6ef18e1dfeee47e/sklearn/utils/__init__.py#L65 @@ -37,9 +35,7 @@ Any, Generator, Iterable, - List, Mapping, - Self, ) from colour.utilities.documentation import is_documentation_building @@ -55,7 +51,6 @@ "Lookup", "CanonicalMapping", "LazyCanonicalMapping", - "Node", ] @@ -239,8 +234,8 @@ def first_key_from_value(self, value: Any) -> Any: class CanonicalMapping(MutableMapping): """ Implement a delimiter and case-insensitive :class:`dict`-like object with - support for slugs, i.e. *SEO* friendly and human-readable version of the - keys but also canonical keys, i.e. slugified keys without delimiters. + support for slugs, i.e., *SEO* friendly and human-readable version of the + keys but also canonical keys, i.e., slugified keys without delimiters. The item keys are expected to be :class:`str`-like objects thus supporting the :meth:`str.lower` method. Setting items is done by using the given @@ -307,9 +302,7 @@ class CanonicalMapping(MutableMapping): 1 """ - def __init__( - self, data: Generator | Mapping | None = None, **kwargs: Any - ) -> None: + def __init__(self, data: Generator | Mapping | None = None, **kwargs: Any) -> None: self._data: dict = {} self.update({} if data is None else data, **kwargs) @@ -340,9 +333,9 @@ def __repr__(self) -> str: """ if is_documentation_building(): # pragma: no cover - representation = repr( - dict(zip(self.keys(), ["..."] * len(self))) - ).replace("'...'", "...") + representation = repr(dict(zip(self.keys(), ["..."] * len(self)))).replace( + "'...'", "..." + ) return f"{self.__class__.__name__}({representation})" else: return f"{self.__class__.__name__}({dict(self.items())})" @@ -392,9 +385,7 @@ def __getitem__(self, item: str | Any) -> Any: pass try: - return self[ - dict(zip(self.lower_keys(), self.keys()))[str(item).lower()] - ] + return self[dict(zip(self.lower_keys(), self.keys()))[str(item).lower()]] except KeyError: pass @@ -429,9 +420,7 @@ def __delitem__(self, item: str | Any): pass try: - del self._data[ - dict(zip(self.lower_keys(), self.keys()))[str(item).lower()] - ] + del self._data[dict(zip(self.lower_keys(), self.keys()))[str(item).lower()]] return except KeyError: pass @@ -567,9 +556,7 @@ def _collision_warning(keys: list): from colour.utilities import usage_warning - collisions = [ - key for (key, value) in Counter(keys).items() if value > 1 - ] + collisions = [key for (key, value) in Counter(keys).items() if value > 1] if collisions: usage_warning(f"{list(set(keys))} key(s) collide(s)!") @@ -620,9 +607,7 @@ def lower_items(self) -> Generator: Item generator. """ - yield from ( - (str(key).lower(), value) for (key, value) in self._data.items() - ) + yield from ((str(key).lower(), value) for (key, value) in self._data.items()) def slugified_keys(self) -> Generator: """ @@ -667,9 +652,7 @@ def canonical_keys(self) -> Generator: Item generator. """ - canonical_keys = [ - re.sub("-|_", "", key) for key in self.slugified_keys() - ] + canonical_keys = [re.sub("-|_", "", key) for key in self.slugified_keys()] self._collision_warning(canonical_keys) @@ -718,7 +701,6 @@ class LazyCanonicalMapping(CanonicalMapping): >>> def callable_a(): ... print(2) ... return 2 - ... >>> methods = LazyCanonicalMapping({"McCamy": 1, "Hernandez": callable_a}) >>> methods["mccamy"] 1 @@ -753,476 +735,3 @@ def __getitem__(self, item: str | Any) -> Any: super().__setitem__(item, value) return value - - -class Node: - """ - Represent a basic node supporting the creation of basic node trees. - - Parameters - ---------- - name - Node name. - parent - Parent of the node. - children - Children of the node. - data - The data belonging to this node. - - Attributes - ---------- - - :attr:`~colour.utilities.Node.name` - - :attr:`~colour.utilities.Node.parent` - - :attr:`~colour.utilities.Node.children` - - :attr:`~colour.utilities.Node.id` - - :attr:`~colour.utilities.Node.root` - - :attr:`~colour.utilities.Node.leaves` - - :attr:`~colour.utilities.Node.siblings` - - :attr:`~colour.utilities.Node.data` - - Methods - ------- - - :meth:`~colour.utilities.Node.__new__` - - :meth:`~colour.utilities.Node.__init__` - - :meth:`~colour.utilities.Node.__str__` - - :meth:`~colour.utilities.Node.__len__` - - :meth:`~colour.utilities.Node.is_root` - - :meth:`~colour.utilities.Node.is_inner` - - :meth:`~colour.utilities.Node.is_leaf` - - :meth:`~colour.utilities.Node.walk` - - :meth:`~colour.utilities.Node.render` - - Examples - -------- - >>> node_a = Node("Node A") - >>> node_b = Node("Node B", node_a) - >>> node_c = Node("Node C", node_a) - >>> node_d = Node("Node D", node_b) - >>> node_e = Node("Node E", node_b) - >>> node_f = Node("Node F", node_d) - >>> node_g = Node("Node G", node_f) - >>> node_h = Node("Node H", node_g) - >>> [node.name for node in node_a.leaves] - ['Node H', 'Node E', 'Node C'] - >>> print(node_h.root.name) - Node A - >>> len(node_a) - 7 - """ - - _INSTANCE_ID: int = 1 - """ - Node id counter. - - _INSTANCE_ID - """ - - def __new__(cls, *args: Any, **kwargs: Any) -> Self: # noqa: ARG003 - """ - Return a new instance of the :class:`colour.utilities.Node` class. - - Other Parameters - ---------------- - args - Arguments. - kwargs - Keywords arguments. - """ - - instance = super().__new__(cls) - - instance._id = Node._INSTANCE_ID # pyright: ignore - Node._INSTANCE_ID += 1 - - return instance - - def __init__( - self, - name: str | None = None, - parent: Self | None = None, - children: List[Self] | None = None, - data: Any | None = None, - ) -> None: - self._name: str = f"{self.__class__.__name__}#{self.id}" - self.name = self._name if name is None else name - self._parent: Self | None = None - self.parent = parent - self._children: List[Self] = [] - self.children = ( # pyright: ignore - self._children if children is None else children - ) - self._data: Any | None = data - - @property - def name(self) -> str: - """ - Getter and setter property for the name. - - Parameters - ---------- - value - Value to set the name with. - - Returns - ------- - :class:`str` - Node name. - """ - - return self._name - - @name.setter - def name(self, value: str): - """Setter for the **self.name** property.""" - - from colour.utilities import attest - - attest( - isinstance(value, str), - f'"name" property: "{value}" type is not "str"!', - ) - - self._name = value - - @property - def parent(self) -> Self | None: - """ - Getter and setter property for the node parent. - - Parameters - ---------- - value - Parent to set the node with. - - Returns - ------- - :class:`Node` or :py:data:`None` - Node parent. - """ - - return self._parent - - @parent.setter - def parent(self, value: Self | None): - """Setter for the **self.parent** property.""" - - from colour.utilities import attest - - if value is not None: - attest( - issubclass(value.__class__, Node), - f'"parent" property: "{value}" is not a ' - f'"{self.__class__.__name__}" subclass!', - ) - - value.children.append(self) - - self._parent = value - - @property - def children(self) -> List[Self]: - """ - Getter and setter property for the node children. - - Parameters - ---------- - value - Children to set the node with. - - Returns - ------- - :class:`list` - Node children. - """ - - return self._children - - @children.setter - def children(self, value: List[Self]): - """Setter for the **self.children** property.""" - - from colour.utilities import attest - - attest( - isinstance(value, list), - f'"children" property: "{value}" type is not a "list" instance!', - ) - - for element in value: - attest( - issubclass(element.__class__, Node), - f'"children" property: A "{element}" element is not a ' - f'"{self.__class__.__name__}" subclass!', - ) - - for node in value: - node.parent = self - - self._children = value - - @property - def id(self) -> int: # noqa: A003 - """ - Getter property for the node id. - - Returns - ------- - :class:`int` - Node id. - """ - - return self._id # pyright: ignore - - @property - def root(self) -> Self: - """ - Getter property for the node tree. - - Returns - ------- - :class:`Node` - Node root. - """ - - if self.is_root(): - return self - else: - return list(self.walk(ascendants=True))[-1] - - @property - def leaves(self) -> Generator: - """ - Getter property for the node leaves. - - Yields - ------ - Generator - Node leaves. - """ - - if self.is_leaf(): - return (node for node in (self,)) - else: - return (node for node in self.walk() if node.is_leaf()) - - @property - def siblings(self) -> Generator: - """ - Getter property for the node siblings. - - Returns - ------- - Generator - Node siblings. - """ - - if self.parent is None: - return (sibling for sibling in ()) - else: - return ( - sibling - for sibling in self.parent.children - if sibling is not self - ) - - @property - def data(self) -> Any: - """ - Getter property for the node data. - - Returns - ------- - :class:`object` - Node data. - """ - - return self._data - - @data.setter - def data(self, value: Any): - """Setter for the **self.data** property.""" - - self._data = value - - def __str__(self) -> str: - """ - Return a formatted string representation of the node. - - Returns - ------- - :class`str` - Formatted string representation. - """ - - return f"{self.__class__.__name__}#{self.id}({self._data})" - - def __len__(self) -> int: - """ - Return the number of children of the node. - - Returns - ------- - :class:`int` - Number of children of the node. - """ - - return len(list(self.walk())) - - def is_root(self) -> bool: - """ - Return whether the node is a root node. - - Returns - ------- - :class:`bool` - Whether the node is a root node. - - Examples - -------- - >>> node_a = Node("Node A") - >>> node_b = Node("Node B", node_a) - >>> node_c = Node("Node C", node_b) - >>> node_a.is_root() - True - >>> node_b.is_root() - False - """ - - return self.parent is None - - def is_inner(self) -> bool: - """ - Return whether the node is an inner node. - - Returns - ------- - :class:`bool` - Whether the node is an inner node. - - Examples - -------- - >>> node_a = Node("Node A") - >>> node_b = Node("Node B", node_a) - >>> node_c = Node("Node C", node_b) - >>> node_a.is_inner() - False - >>> node_b.is_inner() - True - """ - - return all([not self.is_root(), not self.is_leaf()]) - - def is_leaf(self) -> bool: - """ - Return whether the node is a leaf node. - - Returns - ------- - :class:`bool` - Whether the node is a leaf node. - - Examples - -------- - >>> node_a = Node("Node A") - >>> node_b = Node("Node B", node_a) - >>> node_c = Node("Node C", node_b) - >>> node_a.is_leaf() - False - >>> node_c.is_leaf() - True - """ - - return len(self._children) == 0 - - def walk(self, ascendants: bool = False) -> Generator: - """ - Return a generator used to walk into :class:`colour.utilities.Node` - trees. - - Parameters - ---------- - ascendants - Whether to walk up the node tree. - - Yields - ------ - Generator - Node tree walker. - - Examples - -------- - >>> node_a = Node("Node A") - >>> node_b = Node("Node B", node_a) - >>> node_c = Node("Node C", node_a) - >>> node_d = Node("Node D", node_b) - >>> node_e = Node("Node E", node_b) - >>> node_f = Node("Node F", node_d) - >>> node_g = Node("Node G", node_f) - >>> node_h = Node("Node H", node_g) - >>> for node in node_a.walk(): - ... print(node.name) - ... - Node B - Node D - Node F - Node G - Node H - Node E - Node C - """ - - attribute = "children" if not ascendants else "parent" - - nodes = getattr(self, attribute) - nodes = nodes if isinstance(nodes, list) else [nodes] - - for node in nodes: - yield node - - if not getattr(node, attribute): - continue - - yield from node.walk(ascendants=ascendants) - - def render(self, tab_level: int = 0): - """ - Render the current node and its children as a string. - - Parameters - ---------- - tab_level - Initial indentation level - - Returns - ------- - :class:`str` - Rendered node tree. - - Examples - -------- - >>> node_a = Node("Node A") - >>> node_b = Node("Node B", node_a) - >>> node_c = Node("Node C", node_a) - >>> print(node_a.render()) - |----"Node A" - |----"Node B" - |----"Node C" - - """ - - output = "" - - for _i in range(tab_level): - output += " " - - tab_level += 1 - - output += f'|----"{self.name}"\n' - - for child in self._children: - output += child.render(tab_level) - - tab_level -= 1 - - return output diff --git a/colour/utilities/tests/test_array.py b/colour/utilities/tests/test_array.py index 170ab5b275..80d6f42edc 100644 --- a/colour/utilities/tests/test_array.py +++ b/colour/utilities/tests/test_array.py @@ -1,4 +1,3 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.utilities.array` module.""" import unittest @@ -6,6 +5,7 @@ from dataclasses import dataclass, field, fields import numpy as np +import pytest from colour.constants import ( DTYPE_FLOAT_DEFAULT, @@ -146,7 +146,7 @@ def test_required_attributes(self): required_attributes = ("fields",) for method in required_attributes: - self.assertIn(method, dir(MixinDataclassFields)) + assert method in dir(MixinDataclassFields) def test_fields(self): """ @@ -154,10 +154,7 @@ def test_fields(self): method. """ - self.assertTupleEqual( - self._data.fields, - fields(self._data), - ) + assert self._data.fields == fields(self._data) class TestMixinDataclassIterable(unittest.TestCase): @@ -187,7 +184,7 @@ def test_required_attributes(self): ) for method in required_attributes: - self.assertIn(method, dir(MixinDataclassIterable)) + assert method in dir(MixinDataclassIterable) def test_required_methods(self): """Test the presence of required methods.""" @@ -195,7 +192,7 @@ def test_required_methods(self): required_methods = ("__iter__",) for method in required_methods: - self.assertIn(method, dir(MixinDataclassIterable)) + assert method in dir(MixinDataclassIterable) def test__iter__(self): """ @@ -203,9 +200,8 @@ def test__iter__(self): method. """ - self.assertDictEqual( - {key: value for key, value in self._data}, # noqa: C416 - {"a": "Foo", "b": "Bar", "c": "Baz"}, + assert {key: value for key, value in self._data} == ( # noqa: C416 + {"a": "Foo", "b": "Bar", "c": "Baz"} ) def test_keys(self): @@ -214,10 +210,7 @@ def test_keys(self): method. """ - self.assertTupleEqual( - tuple(self._data.keys), - ("a", "b", "c"), - ) + assert tuple(self._data.keys) == ("a", "b", "c") def test_values(self): """ @@ -225,10 +218,7 @@ def test_values(self): method. """ - self.assertTupleEqual( - tuple(self._data.values), - ("Foo", "Bar", "Baz"), - ) + assert tuple(self._data.values) == ("Foo", "Bar", "Baz") def test_items(self): """ @@ -236,10 +226,7 @@ def test_items(self): method. """ - self.assertTupleEqual( - tuple(self._data.items), - (("a", "Foo"), ("b", "Bar"), ("c", "Baz")), - ) + assert tuple(self._data.items) == (("a", "Foo"), ("b", "Bar"), ("c", "Baz")) class TestMixinDataclassArray(unittest.TestCase): @@ -282,7 +269,7 @@ def test_required_methods(self): required_methods = ("__array__",) for method in required_methods: - self.assertIn(method, dir(MixinDataclassArray)) + assert method in dir(MixinDataclassArray) def test__array__(self): """ @@ -290,12 +277,9 @@ def test__array__(self): method. """ - np.testing.assert_array_equal(np.array(self._data), self._array) + np.testing.assert_array_equal(self._data, self._array) - self.assertEqual( - np.array(self._data, dtype=DTYPE_INT_DEFAULT).dtype, - DTYPE_INT_DEFAULT, - ) + assert np.array(self._data, dtype=DTYPE_INT_DEFAULT).dtype == DTYPE_INT_DEFAULT class TestMixinDataclassArithmetic(unittest.TestCase): @@ -351,7 +335,7 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(MixinDataclassArithmetic)) + assert method in dir(MixinDataclassArithmetic) def test_arithmetical_operation(self): """ @@ -360,61 +344,61 @@ def test_arithmetical_operation(self): """ np.testing.assert_allclose( - np.array(self._data.arithmetical_operation(10, "+", False)), + self._data.arithmetical_operation(10, "+", False), self._array + 10, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(self._data.arithmetical_operation(10, "-", False)), + self._data.arithmetical_operation(10, "-", False), self._array - 10, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(self._data.arithmetical_operation(10, "*", False)), + self._data.arithmetical_operation(10, "*", False), self._array * 10, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(self._data.arithmetical_operation(10, "/", False)), + self._data.arithmetical_operation(10, "/", False), self._array / 10, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(self._data.arithmetical_operation(10, "**", False)), + self._data.arithmetical_operation(10, "**", False), self._array**10, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(self._data + 10), + self._data + 10, self._array + 10, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(self._data - 10), + self._data - 10, self._array - 10, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(self._data * 10), + self._data * 10, self._array * 10, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(self._data / 10), + self._data / 10, self._array / 10, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(self._data**10), + self._data**10, self._array**10, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -422,31 +406,31 @@ def test_arithmetical_operation(self): data = deepcopy(self._data) np.testing.assert_allclose( - np.array(data.arithmetical_operation(10, "+", True)), + data.arithmetical_operation(10, "+", True), self._array + 10, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(data.arithmetical_operation(10, "-", True)), + data.arithmetical_operation(10, "-", True), self._array, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(data.arithmetical_operation(10, "*", True)), + data.arithmetical_operation(10, "*", True), self._array * 10, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(data.arithmetical_operation(10, "/", True)), + data.arithmetical_operation(10, "/", True), self._array, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(data.arithmetical_operation(10, "**", True)), + data.arithmetical_operation(10, "**", True), self._array**10, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -454,13 +438,13 @@ def test_arithmetical_operation(self): data = deepcopy(self._data) np.testing.assert_allclose( - np.array(data.arithmetical_operation(self._array, "+", False)), + data.arithmetical_operation(self._array, "+", False), data + self._array, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( - np.array(data.arithmetical_operation(data, "+", False)), + data.arithmetical_operation(data, "+", False), data + data, atol=TOLERANCE_ABSOLUTE_TESTS, ) @@ -468,19 +452,19 @@ def test_arithmetical_operation(self): data = self._factory(1, 2, 3) data += 1 - self.assertEqual(data.a, 2) + assert data.a == 2 data -= 1 - self.assertEqual(data.a, 1) + assert data.a == 1 data *= 2 - self.assertEqual(data.a, 2) + assert data.a == 2 data /= 2 - self.assertEqual(data.a, 1) + assert data.a == 1 data **= 0.5 - self.assertEqual(data.a, 1) + assert data.a == 1 class TestAsArray(unittest.TestCase): @@ -494,13 +478,9 @@ def test_as_array(self): np.testing.assert_equal(as_array([1, 2, 3]), np.array([1, 2, 3])) - self.assertEqual( - as_array([1, 2, 3], DTYPE_FLOAT_DEFAULT).dtype, DTYPE_FLOAT_DEFAULT - ) + assert as_array([1, 2, 3], DTYPE_FLOAT_DEFAULT).dtype == DTYPE_FLOAT_DEFAULT - self.assertEqual( - as_array([1, 2, 3], DTYPE_INT_DEFAULT).dtype, DTYPE_INT_DEFAULT - ) + assert as_array([1, 2, 3], DTYPE_INT_DEFAULT).dtype == DTYPE_INT_DEFAULT np.testing.assert_equal( as_array(dict(zip("abc", [1, 2, 3])).values()), np.array([1, 2, 3]) @@ -516,21 +496,19 @@ class TestAsInt(unittest.TestCase): def test_as_int(self): """Test :func:`colour.utilities.array.as_int` definition.""" - self.assertEqual(as_int(1), 1) + assert as_int(1) == 1 - self.assertEqual(as_int(np.array([1])).ndim, 1) + assert as_int(np.array([1])).ndim == 1 - self.assertEqual(as_int(np.array([[1]])).ndim, 2) + assert as_int(np.array([[1]])).ndim == 2 np.testing.assert_array_equal( as_int(np.array([1.0, 2.0, 3.0])), np.array([1, 2, 3]) ) - self.assertEqual( - as_int(np.array([1.0, 2.0, 3.0])).dtype, DTYPE_INT_DEFAULT - ) + assert as_int(np.array([1.0, 2.0, 3.0])).dtype == DTYPE_INT_DEFAULT - self.assertIsInstance(as_int(1), DTYPE_INT_DEFAULT) + assert isinstance(as_int(1), DTYPE_INT_DEFAULT) class TestAsFloat(unittest.TestCase): @@ -542,11 +520,11 @@ class TestAsFloat(unittest.TestCase): def test_as_float(self): """Test :func:`colour.utilities.array.as_float` definition.""" - self.assertEqual(as_float(1), 1.0) + assert as_float(1) == 1.0 - self.assertEqual(as_float(np.array([1])).ndim, 1) + assert as_float(np.array([1])).ndim == 1 - self.assertEqual(as_float(np.array([[1]])).ndim, 2) + assert as_float(np.array([[1]])).ndim == 2 np.testing.assert_allclose( as_float(np.array([1, 2, 3])), @@ -554,11 +532,9 @@ def test_as_float(self): atol=TOLERANCE_ABSOLUTE_TESTS, ) - self.assertEqual( - as_float(np.array([1, 2, 3])).dtype, DTYPE_FLOAT_DEFAULT - ) + assert as_float(np.array([1, 2, 3])).dtype == DTYPE_FLOAT_DEFAULT - self.assertIsInstance(as_float(1), DTYPE_FLOAT_DEFAULT) + assert isinstance(as_float(1), DTYPE_FLOAT_DEFAULT) class TestAsIntArray(unittest.TestCase): @@ -570,11 +546,9 @@ class TestAsIntArray(unittest.TestCase): def test_as_int_array(self): """Test :func:`colour.utilities.array.as_int_array` definition.""" - np.testing.assert_equal( - as_int_array([1.0, 2.0, 3.0]), np.array([1, 2, 3]) - ) + np.testing.assert_equal(as_int_array([1.0, 2.0, 3.0]), np.array([1, 2, 3])) - self.assertEqual(as_int_array([1, 2, 3]).dtype, DTYPE_INT_DEFAULT) + assert as_int_array([1, 2, 3]).dtype == DTYPE_INT_DEFAULT class TestAsFloatArray(unittest.TestCase): @@ -588,7 +562,7 @@ def test_as_float_array(self): np.testing.assert_equal(as_float_array([1, 2, 3]), np.array([1, 2, 3])) - self.assertEqual(as_float_array([1, 2, 3]).dtype, DTYPE_FLOAT_DEFAULT) + assert as_float_array([1, 2, 3]).dtype == DTYPE_FLOAT_DEFAULT class TestAsIntScalar(unittest.TestCase): @@ -600,9 +574,9 @@ class TestAsIntScalar(unittest.TestCase): def test_as_int_scalar(self): """Test :func:`colour.utilities.array.as_int_scalar` definition.""" - self.assertEqual(as_int_scalar(1.0), 1) + assert as_int_scalar(1.0) == 1 - self.assertEqual(as_int_scalar(1.0).dtype, DTYPE_INT_DEFAULT) + assert as_int_scalar(1.0).dtype == DTYPE_INT_DEFAULT class TestAsFloatScalar(unittest.TestCase): @@ -614,9 +588,9 @@ class TestAsFloatScalar(unittest.TestCase): def test_as_float_scalar(self): """Test :func:`colour.utilities.array.as_float_scalar` definition.""" - self.assertEqual(as_float_scalar(1), 1.0) + assert as_float_scalar(1) == 1.0 - self.assertEqual(as_float_scalar(1).dtype, DTYPE_FLOAT_DEFAULT) + assert as_float_scalar(1).dtype == DTYPE_FLOAT_DEFAULT class TestSetDefaultIntegerDtype(unittest.TestCase): @@ -630,15 +604,15 @@ def test_set_default_int_dtype(self): Test :func:`colour.utilities.array.set_default_int_dtype` definition. """ - self.assertEqual(as_int_array(np.ones(3)).dtype, np.int64) + assert as_int_array(np.ones(3)).dtype == np.int64 set_default_int_dtype(np.int32) - self.assertEqual(as_int_array(np.ones(3)).dtype, np.int32) + assert as_int_array(np.ones(3)).dtype == np.int32 set_default_int_dtype(np.int64) - self.assertEqual(as_int_array(np.ones(3)).dtype, np.int64) + assert as_int_array(np.ones(3)).dtype == np.int64 def tearDown(self): """After tests actions.""" @@ -658,15 +632,18 @@ def test_set_default_float_dtype(self): definition. """ - self.assertEqual(as_float_array(np.ones(3)).dtype, np.float64) + try: + assert as_float_array(np.ones(3)).dtype == np.float64 - set_default_float_dtype(np.float16) + set_default_float_dtype(np.float16) - self.assertEqual(as_float_array(np.ones(3)).dtype, np.float16) + assert as_float_array(np.ones(3)).dtype == np.float16 - set_default_float_dtype(np.float64) + set_default_float_dtype(np.float64) - self.assertEqual(as_float_array(np.ones(3)).dtype, np.float64) + assert as_float_array(np.ones(3)).dtype == np.float64 + finally: + set_default_float_dtype(np.float64) def test_set_default_float_dtype_enforcement(self): """ @@ -690,90 +667,88 @@ def test_set_default_float_dtype_enforcement(self): convert, ) - dtype = np.float32 - set_default_float_dtype(dtype) - - for source, target, _callable in CONVERSION_SPECIFICATIONS_DATA: - if target in ("Hexadecimal", "Munsell Colour"): - continue + try: + dtype = np.float32 + set_default_float_dtype(dtype) - # Spectral distributions are instantiated with float64 data and - # spectral up-sampling optimization fails. - if ( - "Spectral Distribution" in (source, target) - or target == "Complementary Wavelength" - or target == "Dominant Wavelength" - ): - continue + for source, target, _callable in CONVERSION_SPECIFICATIONS_DATA: + if target in ("Hexadecimal", "Munsell Colour"): + continue - a = np.array([(0.25, 0.5, 0.25), (0.25, 0.5, 0.25)]) - - if source == "CAM16": - a = CAM_Specification_CAM16(J=0.25, M=0.5, h=0.25) + # Spectral distributions are instantiated with float64 data and + # spectral up-sampling optimization fails. + if ( + "Spectral Distribution" in (source, target) + or target == "Complementary Wavelength" + or target == "Dominant Wavelength" + ): + continue - if source == "CIECAM02": - a = CAM_Specification_CIECAM02(J=0.25, M=0.5, h=0.25) + a = np.array([(0.25, 0.5, 0.25), (0.25, 0.5, 0.25)]) - if source == "CIECAM16": - a = CAM_Specification_CIECAM16(J=0.25, M=0.5, h=0.25) + if source == "CAM16": + a = CAM_Specification_CAM16(J=0.25, M=0.5, h=0.25) - if source == "Hellwig 2022": - a = CAM_Specification_Hellwig2022(J=0.25, M=0.5, h=0.25) + if source == "CIECAM02": + a = CAM_Specification_CIECAM02(J=0.25, M=0.5, h=0.25) - if source == "Kim 2009": - a = CAM_Specification_Kim2009(J=0.25, M=0.5, h=0.25) + if source == "CIECAM16": + a = CAM_Specification_CIECAM16(J=0.25, M=0.5, h=0.25) - if source == "ZCAM": - a = CAM_Specification_ZCAM(J=0.25, M=0.5, h=0.25) + if source == "Hellwig 2022": + a = CAM_Specification_Hellwig2022(J=0.25, M=0.5, h=0.25) - if source == "CMYK": - a = np.array([(0.25, 0.5, 0.25, 0.5), (0.25, 0.5, 0.25, 0.5)]) + if source == "Kim 2009": + a = CAM_Specification_Kim2009(J=0.25, M=0.5, h=0.25) - if source == "Hexadecimal": - a = np.array(["#FFFFFF", "#FFFFFF"]) + if source == "ZCAM": + a = CAM_Specification_ZCAM(J=0.25, M=0.5, h=0.25) - if source == "CSS Color 3": - a = "aliceblue" + if source == "CMYK": + a = np.array([(0.25, 0.5, 0.25, 0.5), (0.25, 0.5, 0.25, 0.5)]) - if source == "Munsell Colour": - a = ["4.2YR 8.1/5.3", "4.2YR 8.1/5.3"] + if source == "Hexadecimal": + a = np.array(["#FFFFFF", "#FFFFFF"]) - if source == "Wavelength": - a = 555 + if source == "CSS Color 3": + a = "aliceblue" - if ( - source.startswith("CCT") # noqa: PIE810 - or source.endswith(" xy") - or source.endswith(" uv") - ): - a = np.array([(0.25, 0.5), (0.25, 0.5)]) + if source == "Munsell Colour": + a = ["4.2YR 8.1/5.3", "4.2YR 8.1/5.3"] - def dtype_getter(x): - """Dtype getter callable.""" + if source == "Wavelength": + a = 555 - for specification in ( - "ATD95", - "CIECAM02", - "CAM16", - "Hellwig 2022", - "Hunt", - "Kim 2009", - "LLAB", - "Nayatani95", - "RLAB", - "ZCAM", + if ( + source.startswith("CCT") # noqa: PIE810 + or source.endswith(" xy") + or source.endswith(" uv") ): - if target.endswith(specification): # noqa: B023 - return getattr(x, fields(x)[0].name).dtype + a = np.array([(0.25, 0.5), (0.25, 0.5)]) - return x.dtype + def dtype_getter(x): + """Dtype getter callable.""" - self.assertEqual(dtype_getter(convert(a, source, target)), dtype) + for specification in ( + "ATD95", + "CIECAM02", + "CAM16", + "Hellwig 2022", + "Hunt", + "Kim 2009", + "LLAB", + "Nayatani95", + "RLAB", + "ZCAM", + ): + if target.endswith(specification): # noqa: B023 + return getattr(x, fields(x)[0].name).dtype - def tearDown(self): - """After tests actions.""" + return x.dtype - set_default_float_dtype(np.float64) + assert dtype_getter(convert(a, source, target)) == dtype + finally: + set_default_float_dtype(np.float64) class TestGetDomainRangeScale(unittest.TestCase): @@ -789,13 +764,13 @@ def test_get_domain_range_scale(self): """ with domain_range_scale("Reference"): - self.assertEqual(get_domain_range_scale(), "reference") + assert get_domain_range_scale() == "reference" with domain_range_scale("1"): - self.assertEqual(get_domain_range_scale(), "1") + assert get_domain_range_scale() == "1" with domain_range_scale("100"): - self.assertEqual(get_domain_range_scale(), "100") + assert get_domain_range_scale() == "100" class TestSetDomainRangeScale(unittest.TestCase): @@ -812,19 +787,18 @@ def test_set_domain_range_scale(self): with domain_range_scale("Reference"): set_domain_range_scale("1") - self.assertEqual(get_domain_range_scale(), "1") + assert get_domain_range_scale() == "1" with domain_range_scale("Reference"): set_domain_range_scale("100") - self.assertEqual(get_domain_range_scale(), "100") + assert get_domain_range_scale() == "100" with domain_range_scale("1"): set_domain_range_scale("Reference") - self.assertEqual(get_domain_range_scale(), "reference") + assert get_domain_range_scale() == "reference" - self.assertRaises( - ValueError, lambda: set_domain_range_scale("Invalid") - ) + with pytest.raises(ValueError): + set_domain_range_scale("Invalid") class TestDomainRangeScale(unittest.TestCase): @@ -839,22 +813,22 @@ def test_domain_range_scale(self): definition. """ - self.assertEqual(get_domain_range_scale(), "reference") + assert get_domain_range_scale() == "reference" with domain_range_scale("Reference"): - self.assertEqual(get_domain_range_scale(), "reference") + assert get_domain_range_scale() == "reference" - self.assertEqual(get_domain_range_scale(), "reference") + assert get_domain_range_scale() == "reference" with domain_range_scale("1"): - self.assertEqual(get_domain_range_scale(), "1") + assert get_domain_range_scale() == "1" - self.assertEqual(get_domain_range_scale(), "reference") + assert get_domain_range_scale() == "reference" with domain_range_scale("100"): - self.assertEqual(get_domain_range_scale(), "100") + assert get_domain_range_scale() == "100" - self.assertEqual(get_domain_range_scale(), "reference") + assert get_domain_range_scale() == "reference" def fn_a(a): """Change the domain-range scale for unit testing.""" @@ -869,19 +843,19 @@ def fn_a(a): with domain_range_scale("1"): with domain_range_scale("100"): with domain_range_scale("Ignore"): - self.assertEqual(get_domain_range_scale(), "ignore") - self.assertEqual(fn_a(4), 8) + assert get_domain_range_scale() == "ignore" + assert fn_a(4) == 8 - self.assertEqual(get_domain_range_scale(), "100") - self.assertEqual(fn_a(40), 8) + assert get_domain_range_scale() == "100" + assert fn_a(40) == 8 - self.assertEqual(get_domain_range_scale(), "1") - self.assertEqual(fn_a(0.4), 0.08) + assert get_domain_range_scale() == "1" + assert fn_a(0.4) == 0.08 - self.assertEqual(get_domain_range_scale(), "reference") - self.assertEqual(fn_a(4), 8) + assert get_domain_range_scale() == "reference" + assert fn_a(4) == 8 - self.assertEqual(get_domain_range_scale(), "reference") + assert get_domain_range_scale() == "reference" @domain_range_scale("1") def fn_b(a): @@ -893,7 +867,7 @@ def fn_b(a): return from_range_100(b) - self.assertEqual(fn_b(10), 2.0) + assert fn_b(10) == 2.0 class TestToDomain1(unittest.TestCase): @@ -906,21 +880,19 @@ def test_to_domain_1(self): """Test :func:`colour.utilities.common.to_domain_1` definition.""" with domain_range_scale("Reference"): - self.assertEqual(to_domain_1(1), 1) + assert to_domain_1(1) == 1 with domain_range_scale("1"): - self.assertEqual(to_domain_1(1), 1) + assert to_domain_1(1) == 1 with domain_range_scale("100"): - self.assertEqual(to_domain_1(1), 0.01) + assert to_domain_1(1) == 0.01 with domain_range_scale("100"): - self.assertEqual(to_domain_1(1, np.pi), 1 / np.pi) + assert to_domain_1(1, np.pi) == 1 / np.pi with domain_range_scale("100"): - self.assertEqual( - to_domain_1(1, dtype=np.float16).dtype, np.float16 - ) + assert to_domain_1(1, dtype=np.float16).dtype == np.float16 class TestToDomain10(unittest.TestCase): @@ -933,21 +905,19 @@ def test_to_domain_10(self): """Test :func:`colour.utilities.common.to_domain_10` definition.""" with domain_range_scale("Reference"): - self.assertEqual(to_domain_10(1), 1) + assert to_domain_10(1) == 1 with domain_range_scale("1"): - self.assertEqual(to_domain_10(1), 10) + assert to_domain_10(1) == 10 with domain_range_scale("100"): - self.assertEqual(to_domain_10(1), 0.1) + assert to_domain_10(1) == 0.1 with domain_range_scale("100"): - self.assertEqual(to_domain_10(1, np.pi), 1 / np.pi) + assert to_domain_10(1, np.pi) == 1 / np.pi with domain_range_scale("100"): - self.assertEqual( - to_domain_10(1, dtype=np.float16).dtype, np.float16 - ) + assert to_domain_10(1, dtype=np.float16).dtype == np.float16 class TestToDomain100(unittest.TestCase): @@ -960,21 +930,19 @@ def test_to_domain_100(self): """Test :func:`colour.utilities.common.to_domain_100` definition.""" with domain_range_scale("Reference"): - self.assertEqual(to_domain_100(1), 1) + assert to_domain_100(1) == 1 with domain_range_scale("1"): - self.assertEqual(to_domain_100(1), 100) + assert to_domain_100(1) == 100 with domain_range_scale("100"): - self.assertEqual(to_domain_100(1), 1) + assert to_domain_100(1) == 1 with domain_range_scale("1"): - self.assertEqual(to_domain_100(1, np.pi), np.pi) + assert to_domain_100(1, np.pi) == np.pi with domain_range_scale("100"): - self.assertEqual( - to_domain_100(1, dtype=np.float16).dtype, np.float16 - ) + assert to_domain_100(1, dtype=np.float16).dtype == np.float16 class TestToDomainDegrees(unittest.TestCase): @@ -987,21 +955,19 @@ def test_to_domain_degrees(self): """Test :func:`colour.utilities.common.to_domain_degrees` definition.""" with domain_range_scale("Reference"): - self.assertEqual(to_domain_degrees(1), 1) + assert to_domain_degrees(1) == 1 with domain_range_scale("1"): - self.assertEqual(to_domain_degrees(1), 360) + assert to_domain_degrees(1) == 360 with domain_range_scale("100"): - self.assertEqual(to_domain_degrees(1), 3.6) + assert to_domain_degrees(1) == 3.6 with domain_range_scale("100"): - self.assertEqual(to_domain_degrees(1, np.pi), np.pi / 100) + assert to_domain_degrees(1, np.pi) == np.pi / 100 with domain_range_scale("100"): - self.assertEqual( - to_domain_degrees(1, dtype=np.float16).dtype, np.float16 - ) + assert to_domain_degrees(1, dtype=np.float16).dtype == np.float16 class TestToDomainInt(unittest.TestCase): @@ -1014,21 +980,19 @@ def test_to_domain_int(self): """Test :func:`colour.utilities.common.to_domain_int` definition.""" with domain_range_scale("Reference"): - self.assertEqual(to_domain_int(1), 1) + assert to_domain_int(1) == 1 with domain_range_scale("1"): - self.assertEqual(to_domain_int(1), 255) + assert to_domain_int(1) == 255 with domain_range_scale("100"): - self.assertEqual(to_domain_int(1), 2.55) + assert to_domain_int(1) == 2.55 with domain_range_scale("100"): - self.assertEqual(to_domain_int(1, 10), 10.23) + assert to_domain_int(1, 10) == 10.23 with domain_range_scale("100"): - self.assertEqual( - to_domain_int(1, dtype=np.float16).dtype, np.float16 - ) + assert to_domain_int(1, dtype=np.float16).dtype == np.float16 class TestFromRange1(unittest.TestCase): @@ -1041,16 +1005,16 @@ def test_from_range_1(self): """Test :func:`colour.utilities.common.from_range_1` definition.""" with domain_range_scale("Reference"): - self.assertEqual(from_range_1(1), 1) + assert from_range_1(1) == 1 with domain_range_scale("1"): - self.assertEqual(from_range_1(1), 1) + assert from_range_1(1) == 1 with domain_range_scale("100"): - self.assertEqual(from_range_1(1), 100) + assert from_range_1(1) == 100 with domain_range_scale("100"): - self.assertEqual(from_range_1(1, np.pi), 1 * np.pi) + assert from_range_1(1, np.pi) == 1 * np.pi class TestFromRange10(unittest.TestCase): @@ -1063,16 +1027,16 @@ def test_from_range_10(self): """Test :func:`colour.utilities.common.from_range_10` definition.""" with domain_range_scale("Reference"): - self.assertEqual(from_range_10(1), 1) + assert from_range_10(1) == 1 with domain_range_scale("1"): - self.assertEqual(from_range_10(1), 0.1) + assert from_range_10(1) == 0.1 with domain_range_scale("100"): - self.assertEqual(from_range_10(1), 10) + assert from_range_10(1) == 10 with domain_range_scale("100"): - self.assertEqual(from_range_10(1, np.pi), 1 * np.pi) + assert from_range_10(1, np.pi) == 1 * np.pi class TestFromRange100(unittest.TestCase): @@ -1085,16 +1049,16 @@ def test_from_range_100(self): """Test :func:`colour.utilities.common.from_range_100` definition.""" with domain_range_scale("Reference"): - self.assertEqual(from_range_100(1), 1) + assert from_range_100(1) == 1 with domain_range_scale("1"): - self.assertEqual(from_range_100(1), 0.01) + assert from_range_100(1) == 0.01 with domain_range_scale("100"): - self.assertEqual(from_range_100(1), 1) + assert from_range_100(1) == 1 with domain_range_scale("1"): - self.assertEqual(from_range_100(1, np.pi), 1 / np.pi) + assert from_range_100(1, np.pi) == 1 / np.pi class TestFromRangeDegrees(unittest.TestCase): @@ -1107,16 +1071,16 @@ def test_from_range_degrees(self): """Test :func:`colour.utilities.common.from_range_degrees` definition.""" with domain_range_scale("Reference"): - self.assertEqual(from_range_degrees(1), 1) + assert from_range_degrees(1) == 1 with domain_range_scale("1"): - self.assertEqual(from_range_degrees(1), 1 / 360) + assert from_range_degrees(1) == 1 / 360 with domain_range_scale("100"): - self.assertEqual(from_range_degrees(1), 1 / 3.6) + assert from_range_degrees(1) == 1 / 3.6 with domain_range_scale("100"): - self.assertEqual(from_range_degrees(1, np.pi), 1 / (np.pi / 100)) + assert from_range_degrees(1, np.pi) == 1 / (np.pi / 100) class TestFromRangeInt(unittest.TestCase): @@ -1129,21 +1093,19 @@ def test_from_range_int(self): """Test :func:`colour.utilities.common.from_range_int` definition.""" with domain_range_scale("Reference"): - self.assertEqual(from_range_int(1), 1) + assert from_range_int(1) == 1 with domain_range_scale("1"): - self.assertEqual(from_range_int(1), 1 / 255) + assert from_range_int(1) == 1 / 255 with domain_range_scale("100"): - self.assertEqual(from_range_int(1), 1 / 2.55) + assert from_range_int(1) == 1 / 2.55 with domain_range_scale("100"): - self.assertEqual(from_range_int(1, 10), 1 / (1023 / 100)) + assert from_range_int(1, 10) == 1 / (1023 / 100) with domain_range_scale("100"): - self.assertEqual( - from_range_int(1, dtype=np.float16).dtype, np.float16 - ) + assert from_range_int(1, dtype=np.float16).dtype == np.float16 class TestIsNdarrayCopyEnabled(unittest.TestCase): @@ -1158,10 +1120,10 @@ def test_is_ndarray_copy_enabled(self): """ with ndarray_copy_enable(True): - self.assertTrue(is_ndarray_copy_enabled()) + assert is_ndarray_copy_enabled() with ndarray_copy_enable(False): - self.assertFalse(is_ndarray_copy_enabled()) + assert not is_ndarray_copy_enabled() class TestSetNdarrayCopyEnabled(unittest.TestCase): @@ -1177,11 +1139,11 @@ def test_set_ndarray_copy_enable(self): with ndarray_copy_enable(is_ndarray_copy_enabled()): set_ndarray_copy_enable(True) - self.assertTrue(is_ndarray_copy_enabled()) + assert is_ndarray_copy_enabled() with ndarray_copy_enable(is_ndarray_copy_enabled()): set_ndarray_copy_enable(False) - self.assertFalse(is_ndarray_copy_enabled()) + assert not is_ndarray_copy_enabled() class TestNdarrayCopyEnable(unittest.TestCase): @@ -1196,16 +1158,16 @@ def test_ndarray_copy_enable(self): """ with ndarray_copy_enable(True): - self.assertTrue(is_ndarray_copy_enabled()) + assert is_ndarray_copy_enabled() with ndarray_copy_enable(False): - self.assertFalse(is_ndarray_copy_enabled()) + assert not is_ndarray_copy_enabled() @ndarray_copy_enable(True) def fn_a(): """:func:`ndarray_copy_enable` unit tests :func:`fn_a` definition.""" - self.assertTrue(is_ndarray_copy_enabled()) + assert is_ndarray_copy_enabled() fn_a() @@ -1213,7 +1175,7 @@ def fn_a(): def fn_b(): """:func:`ndarray_copy_enable` unit tests :func:`fn_b` definition.""" - self.assertFalse(is_ndarray_copy_enabled()) + assert not is_ndarray_copy_enabled() fn_b() @@ -1229,10 +1191,10 @@ def test_ndarray_copy(self): a = np.linspace(0, 1, 10) with ndarray_copy_enable(True): - self.assertNotEqual(id(ndarray_copy(a)), id(a)) + assert id(ndarray_copy(a)) != id(a) with ndarray_copy_enable(False): - self.assertEqual(id(ndarray_copy(a)), id(a)) + assert id(ndarray_copy(a)) == id(a) class TestClosestIndexes(unittest.TestCase): @@ -1255,11 +1217,11 @@ def test_closest_indexes(self): ] ) - self.assertEqual(closest_indexes(a, 63.05), 3) + assert closest_indexes(a, 63.05) == 3 - self.assertEqual(closest_indexes(a, 51.15), 4) + assert closest_indexes(a, 51.15) == 4 - self.assertEqual(closest_indexes(a, 24.90), 5) + assert closest_indexes(a, 24.90) == 5 np.testing.assert_array_equal( closest_indexes(a, np.array([63.05, 51.15, 24.90])), @@ -1287,11 +1249,11 @@ def test_closest(self): ] ) - self.assertEqual(closest(a, 63.05), 62.70988028) + assert closest(a, 63.05) == 62.70988028 - self.assertEqual(closest(a, 51.15), 46.84480573) + assert closest(a, 51.15) == 46.84480573 - self.assertEqual(closest(a, 24.90), 25.40026416) + assert closest(a, 24.90) == 25.40026416 np.testing.assert_allclose( closest(a, np.array([63.05, 51.15, 24.90])), @@ -1337,9 +1299,9 @@ class TestIsUniform(unittest.TestCase): def test_is_uniform(self): """Test :func:`colour.utilities.array.is_uniform` definition.""" - self.assertTrue(is_uniform(range(0, 10, 2))) + assert is_uniform(range(0, 10, 2)) - self.assertFalse(is_uniform([1, 2, 3, 4, 6])) + assert not is_uniform([1, 2, 3, 4, 6]) class TestInArray(unittest.TestCase): @@ -1351,25 +1313,19 @@ class TestInArray(unittest.TestCase): def test_in_array(self): """Test :func:`colour.utilities.array.in_array` definition.""" - self.assertTrue( - np.array_equal( - in_array(np.array([0.50, 0.60]), np.linspace(0, 10, 101)), - np.array([True, True]), - ) + assert np.array_equal( + in_array(np.array([0.50, 0.60]), np.linspace(0, 10, 101)), + np.array([True, True]), ) - self.assertFalse( - np.array_equal( - in_array(np.array([0.50, 0.61]), np.linspace(0, 10, 101)), - np.array([True, True]), - ) + assert not np.array_equal( + in_array(np.array([0.50, 0.61]), np.linspace(0, 10, 101)), + np.array([True, True]), ) - self.assertTrue( - np.array_equal( - in_array(np.array([[0.50], [0.60]]), np.linspace(0, 10, 101)), - np.array([[True], [True]]), - ) + assert np.array_equal( + in_array(np.array([[0.50], [0.60]]), np.linspace(0, 10, 101)), + np.array([[True], [True]]), ) def test_n_dimensional_in_array(self): @@ -1389,9 +1345,7 @@ def test_n_dimensional_in_array(self): ) np.testing.assert_array_equal( - in_array( - np.array([[0.50], [0.60]]), np.linspace(0, 10, 101) - ).shape, + in_array(np.array([[0.50], [0.60]]), np.linspace(0, 10, 101)).shape, np.array([2, 1]), ) @@ -1716,13 +1670,13 @@ class TestHasNanOnly(unittest.TestCase): def test_has_only_nan(self): """Test :func:`colour.utilities.array.has_only_nan` definition.""" - self.assertTrue(has_only_nan(None)) + assert has_only_nan(None) - self.assertTrue(has_only_nan([None, None])) + assert has_only_nan([None, None]) - self.assertFalse(has_only_nan([True, None])) + assert not has_only_nan([True, None]) - self.assertFalse(has_only_nan([0.1, np.nan, 0.3])) + assert not has_only_nan([0.1, np.nan, 0.3]) class TestNdarrayWrite(unittest.TestCase): @@ -1737,7 +1691,7 @@ def test_ndarray_write(self): a = np.linspace(0, 1, 10) a.setflags(write=False) - with self.assertRaises(ValueError): + with pytest.raises(ValueError): a += 1 with ndarray_write(a): @@ -1823,9 +1777,7 @@ def test_index_along_last_axis(self): ] ) - indexes = np.array( - [[[0, 1], [0, 1]], [[2, 1], [2, 1]], [[2, 1], [2, 0]]] - ) + indexes = np.array([[[0, 1], [0, 1]], [[2, 1], [2, 1]], [[2, 1], [2, 0]]]) np.testing.assert_equal( index_along_last_axis(a, indexes), @@ -1863,17 +1815,17 @@ def test_exceptions(self): a = as_float_array([[11, 12], [21, 22]]) # Bad shape - with self.assertRaises(ValueError): + with pytest.raises(ValueError): indexes = np.array([0]) index_along_last_axis(a, indexes) # Indexes out of range - with self.assertRaises(IndexError): + with pytest.raises(IndexError): indexes = np.array([123, 456]) index_along_last_axis(a, indexes) # Non-int indexes - with self.assertRaises(IndexError): + with pytest.raises(IndexError): indexes = np.array([0.0, 0.0]) index_along_last_axis(a, indexes) @@ -1887,21 +1839,8 @@ class TestFormatArrayAsRow(unittest.TestCase): def test_format_array_as_row(self): """Test :func:`colour.utilities.array.format_array_as_row` definition.""" - self.assertEqual( - format_array_as_row([1.25, 2.5, 3.75]), - "1.2500000 2.5000000 3.7500000", - ) - - self.assertEqual( - format_array_as_row([1.25, 2.5, 3.75], 3), - "1.250 2.500 3.750", - ) - - self.assertEqual( - format_array_as_row([1.25, 2.5, 3.75], 3, ", "), - "1.250, 2.500, 3.750", - ) + assert format_array_as_row([1.25, 2.5, 3.75]) == "1.2500000 2.5000000 3.7500000" + assert format_array_as_row([1.25, 2.5, 3.75], 3) == "1.250 2.500 3.750" -if __name__ == "__main__": - unittest.main() + assert format_array_as_row([1.25, 2.5, 3.75], 3, ", ") == "1.250, 2.500, 3.750" diff --git a/colour/utilities/tests/test_callback.py b/colour/utilities/tests/test_callback.py index 2269d841f7..9fde9a0ad2 100644 --- a/colour/utilities/tests/test_callback.py +++ b/colour/utilities/tests/test_callback.py @@ -1,10 +1,7 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.utilities.callback` module.""" from __future__ import annotations -import unittest - from colour.utilities import MixinCallback __author__ = "Colour Developers" @@ -19,13 +16,13 @@ ] -class TestMixinCallback(unittest.TestCase): +class TestMixinCallback: """ Define :class:`colour.utilities.callback.MixinCallback` class unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" class WithCallback(MixinCallback): @@ -44,7 +41,7 @@ def _on_attribute_a_changed(self, name: str, value: str) -> str: value = value.upper() if getattr(self, name) != "a": - raise RuntimeError( + raise RuntimeError( # pragma: no cover '"self" was not able to retrieve class instance value!' ) @@ -58,7 +55,7 @@ def test_required_attributes(self): required_attributes = ("callbacks",) for attribute in required_attributes: - self.assertIn(attribute, dir(MixinCallback)) + assert attribute in dir(MixinCallback) def test_required_methods(self): """Test the presence of required methods.""" @@ -70,7 +67,7 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(MixinCallback)) + assert method in dir(MixinCallback) def test_register_callback(self): """ @@ -85,8 +82,8 @@ def test_register_callback(self): ) self._with_callback.attribute_a = "a" - self.assertEqual(self._with_callback.attribute_a, "A") - self.assertEqual(len(self._with_callback.callbacks), 1) + assert self._with_callback.attribute_a == "A" + assert len(self._with_callback.callbacks) == 1 def test_unregister_callback(self): """ @@ -101,14 +98,8 @@ def test_unregister_callback(self): self._on_attribute_a_changed, ) - self.assertEqual(len(self._with_callback.callbacks), 1) - self._with_callback.unregister_callback( - "attribute_a", "on_attribute_a_changed" - ) - self.assertEqual(len(self._with_callback.callbacks), 0) + assert len(self._with_callback.callbacks) == 1 + self._with_callback.unregister_callback("attribute_a", "on_attribute_a_changed") + assert len(self._with_callback.callbacks) == 0 self._with_callback.attribute_a = "a" - self.assertEqual(self._with_callback.attribute_a, "a") - - -if __name__ == "__main__": - unittest.main() + assert self._with_callback.attribute_a == "a" diff --git a/colour/utilities/tests/test_common.py b/colour/utilities/tests/test_common.py index 83d72ea6d8..04038ffb6e 100644 --- a/colour/utilities/tests/test_common.py +++ b/colour/utilities/tests/test_common.py @@ -1,14 +1,12 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.utilities.common` module.""" from __future__ import annotations -import platform import unicodedata -import unittest from functools import partial import numpy as np +import pytest from colour.hints import Any, Real, Tuple from colour.utilities import ( @@ -26,7 +24,6 @@ is_iterable, is_numeric, is_sibling, - is_string, multiprocessing_pool, optional, set_caching_enable, @@ -50,7 +47,6 @@ "TestBatch", "TestMultiprocessingPool", "TestIsIterable", - "TestIsString", "TestIsNumeric", "TestIsInteger", "TestIsSibling", @@ -63,7 +59,7 @@ ] -class TestIsCachingEnabled(unittest.TestCase): +class TestIsCachingEnabled: """ Define :func:`colour.utilities.common.is_caching_enabled` definition unit tests methods. @@ -73,13 +69,13 @@ def test_is_caching_enabled(self): """Test :func:`colour.utilities.common.is_caching_enabled` definition.""" with caching_enable(True): - self.assertTrue(is_caching_enabled()) + assert is_caching_enabled() with caching_enable(False): - self.assertFalse(is_caching_enabled()) + assert not is_caching_enabled() -class TestSetCachingEnabled(unittest.TestCase): +class TestSetCachingEnabled: """ Define :func:`colour.utilities.common.set_caching_enable` definition unit tests methods. @@ -90,14 +86,14 @@ def test_set_caching_enable(self): with caching_enable(is_caching_enabled()): set_caching_enable(True) - self.assertTrue(is_caching_enabled()) + assert is_caching_enabled() with caching_enable(is_caching_enabled()): set_caching_enable(False) - self.assertFalse(is_caching_enabled()) + assert not is_caching_enabled() -class TestCachingEnable(unittest.TestCase): +class TestCachingEnable: """ Define :func:`colour.utilities.common.caching_enable` definition unit tests methods. @@ -107,16 +103,16 @@ def test_caching_enable(self): """Test :func:`colour.utilities.common.caching_enable` definition.""" with caching_enable(True): - self.assertTrue(is_caching_enabled()) + assert is_caching_enabled() with caching_enable(False): - self.assertFalse(is_caching_enabled()) + assert not is_caching_enabled() @caching_enable(True) def fn_a(): """:func:`caching_enable` unit tests :func:`fn_a` definition.""" - self.assertTrue(is_caching_enabled()) + assert is_caching_enabled() fn_a() @@ -124,12 +120,12 @@ def fn_a(): def fn_b(): """:func:`caching_enable` unit tests :func:`fn_b` definition.""" - self.assertFalse(is_caching_enabled()) + assert not is_caching_enabled() fn_b() -class TestCacheRegistry(unittest.TestCase): +class TestCacheRegistry: """ Define :class:`colour.utilities.common.CacheRegistry` class unit tests methods. @@ -154,7 +150,7 @@ def test_required_attributes(self): required_attributes = ("registry",) for attribute in required_attributes: - self.assertIn(attribute, dir(CacheRegistry)) + assert attribute in dir(CacheRegistry) def test_required_methods(self): """Test the presence of required methods.""" @@ -169,16 +165,13 @@ def test_required_methods(self): ) for method in required_methods: - self.assertIn(method, dir(CacheRegistry)) + assert method in dir(CacheRegistry) def test__str__(self): """Test :class:`colour.utilities.common.CacheRegistry.__str__` method.""" cache_registry = self._default_test_cache_registry() - self.assertEqual( - str(cache_registry), - "{'Cache A': '1 item(s)', 'Cache B': '2 item(s)'}", - ) + assert str(cache_registry) == "{'Cache A': '1 item(s)', 'Cache B': '2 item(s)'}" def test_register_cache(self): """ @@ -188,11 +181,9 @@ def test_register_cache(self): cache_registry = CacheRegistry() cache_a = cache_registry.register_cache("Cache A") - self.assertDictEqual(cache_registry.registry, {"Cache A": cache_a}) + assert cache_registry.registry == {"Cache A": cache_a} cache_b = cache_registry.register_cache("Cache B") - self.assertDictEqual( - cache_registry.registry, {"Cache A": cache_a, "Cache B": cache_b} - ) + assert cache_registry.registry == {"Cache A": cache_a, "Cache B": cache_b} def test_unregister_cache(self): """ @@ -202,8 +193,8 @@ def test_unregister_cache(self): cache_registry = self._default_test_cache_registry() cache_registry.unregister_cache("Cache A") - self.assertNotIn("Cache A", cache_registry.registry) - self.assertIn("Cache B", cache_registry.registry) + assert "Cache A" not in cache_registry.registry + assert "Cache B" in cache_registry.registry def test_clear_cache(self): """ @@ -213,10 +204,10 @@ def test_clear_cache(self): cache_registry = self._default_test_cache_registry() cache_registry.clear_cache("Cache A") - self.assertDictEqual( - cache_registry.registry, - {"Cache A": {}, "Cache B": {"John": "Doe", "Luke": "Skywalker"}}, - ) + assert cache_registry.registry == { + "Cache A": {}, + "Cache B": {"John": "Doe", "Luke": "Skywalker"}, + } def test_clear_all_caches(self): """ @@ -226,12 +217,10 @@ def test_clear_all_caches(self): cache_registry = self._default_test_cache_registry() cache_registry.clear_all_caches() - self.assertDictEqual( - cache_registry.registry, {"Cache A": {}, "Cache B": {}} - ) + assert cache_registry.registry == {"Cache A": {}, "Cache B": {}} -class TestAttest(unittest.TestCase): +class TestAttest: """ Define :func:`colour.utilities.common.attest` definition unit tests methods. @@ -240,12 +229,12 @@ class TestAttest(unittest.TestCase): def test_attest(self): """Test :func:`colour.utilities.common.attest` definition.""" - self.assertIsNone(attest(True, "")) + assert attest(True, "") is None - self.assertRaises(AssertionError, attest, False) + pytest.raises(AssertionError, attest, False) -class TestBatch(unittest.TestCase): +class TestBatch: """ Define :func:`colour.utilities.common.batch` definition unit tests methods. @@ -254,20 +243,27 @@ class TestBatch(unittest.TestCase): def test_batch(self): """Test :func:`colour.utilities.common.batch` definition.""" - self.assertListEqual( - list(batch(tuple(range(10)), 3)), - [(0, 1, 2), (3, 4, 5), (6, 7, 8), (9,)], - ) - - self.assertListEqual( - list(batch(tuple(range(10)), 5)), - [(0, 1, 2, 3, 4), (5, 6, 7, 8, 9)], - ) - - self.assertListEqual( - list(batch(tuple(range(10)), 1)), - [(0,), (1,), (2,), (3,), (4,), (5,), (6,), (7,), (8,), (9,)], - ) + assert list(batch(tuple(range(10)), 3)) == [ + (0, 1, 2), + (3, 4, 5), + (6, 7, 8), + (9,), + ] + + assert list(batch(tuple(range(10)), 5)) == [(0, 1, 2, 3, 4), (5, 6, 7, 8, 9)] + + assert list(batch(tuple(range(10)), 1)) == [ + (0,), + (1,), + (2,), + (3,), + (4,), + (5,), + (6,), + (7,), + (8,), + (9,), + ] def _add(a: Real, b: Real): @@ -295,7 +291,7 @@ def _add(a: Real, b: Real): return a + b # pragma: no cover -class TestMultiprocessingPool(unittest.TestCase): +class TestMultiprocessingPool: """ Define :func:`colour.utilities.common.multiprocessing_pool` definition unit tests methods. @@ -305,13 +301,21 @@ def test_multiprocessing_pool(self): """Test :func:`colour.utilities.common.multiprocessing_pool` definition.""" with multiprocessing_pool() as pool: - self.assertListEqual( - pool.map(partial(_add, b=2), range(10)), - [2, 3, 4, 5, 6, 7, 8, 9, 10, 11], - ) - - -class TestIsIterable(unittest.TestCase): + assert pool.map(partial(_add, b=2), range(10)) == [ + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + ] + + +class TestIsIterable: """ Define :func:`colour.utilities.common.is_iterable` definition unit tests methods. @@ -320,50 +324,28 @@ class TestIsIterable(unittest.TestCase): def test_is_iterable(self): """Test :func:`colour.utilities.common.is_iterable` definition.""" - self.assertTrue(is_iterable("")) + assert is_iterable("") - self.assertTrue(is_iterable(())) + assert is_iterable(()) - self.assertTrue(is_iterable([])) + assert is_iterable([]) - self.assertTrue(is_iterable({})) + assert is_iterable({}) - self.assertTrue(is_iterable(set())) + assert is_iterable(set()) - self.assertTrue(is_iterable(np.array([]))) + assert is_iterable(np.array([])) - self.assertFalse(is_iterable(1)) + assert not is_iterable(1) - self.assertFalse(is_iterable(2)) + assert not is_iterable(2) generator = (a for a in range(10)) - self.assertTrue(is_iterable(generator)) - self.assertEqual(len(list(generator)), 10) - - -class TestIsString(unittest.TestCase): - """ - Define :func:`colour.utilities.common.is_string` definition unit tests - methods. - """ + assert is_iterable(generator) + assert len(list(generator)) == 10 - def test_is_string(self): - """Test :func:`colour.utilities.common.is_string` definition.""" - self.assertTrue(is_string("Hello World!")) - - self.assertTrue(is_string("Hello World!")) - - self.assertTrue(is_string(r"Hello World!")) - - self.assertFalse(is_string(1)) - - self.assertFalse(is_string([1])) - - self.assertFalse(is_string({1: None})) - - -class TestIsNumeric(unittest.TestCase): +class TestIsNumeric: """ Define :func:`colour.utilities.common.is_numeric` definition unit tests methods. @@ -372,18 +354,18 @@ class TestIsNumeric(unittest.TestCase): def test_is_numeric(self): """Test :func:`colour.utilities.common.is_numeric` definition.""" - self.assertTrue(is_numeric(1)) + assert is_numeric(1) - self.assertTrue(is_numeric(1)) + assert is_numeric(1) - self.assertFalse(is_numeric((1,))) + assert not is_numeric((1,)) - self.assertFalse(is_numeric([1])) + assert not is_numeric([1]) - self.assertFalse(is_numeric("1")) + assert not is_numeric("1") -class TestIsInteger(unittest.TestCase): +class TestIsInteger: """ Define :func:`colour.utilities.common.is_integer` definition unit tests methods. @@ -392,14 +374,14 @@ class TestIsInteger(unittest.TestCase): def test_is_integer(self): """Test :func:`colour.utilities.common.is_integer` definition.""" - self.assertTrue(is_integer(1)) + assert is_integer(1) - self.assertTrue(is_integer(1.001)) + assert is_integer(1.001) - self.assertFalse(is_integer(1.01)) + assert not is_integer(1.01) -class TestIsSibling(unittest.TestCase): +class TestIsSibling: """ Define :func:`colour.utilities.common.is_sibling` definition unit tests methods. @@ -426,12 +408,12 @@ def __init__(self, name: str) -> None: "Element C": Element("C"), } - self.assertTrue(is_sibling(Element("D"), mapping)) + assert is_sibling(Element("D"), mapping) - self.assertFalse(is_sibling(NotElement("Not D"), mapping)) + assert not is_sibling(NotElement("Not D"), mapping) -class TestFilterKwargs(unittest.TestCase): +class TestFilterKwargs: """ Define :func:`colour.utilities.common.filter_kwargs` definition unit tests methods. @@ -450,25 +432,21 @@ def fn_b(a: Any, b: float = 0) -> Tuple[Any, float]: return a, b - def fn_c( - a: Any, b: float = 0, c: float = 0 - ) -> Tuple[float, float, float]: + def fn_c(a: Any, b: float = 0, c: float = 0) -> Tuple[float, float, float]: """:func:`filter_kwargs` unit tests :func:`fn_c` definition.""" return a, b, c - self.assertEqual(1, fn_a(1, **filter_kwargs(fn_a, b=2, c=3))) + assert fn_a(1, **filter_kwargs(fn_a, b=2, c=3)) == 1 - self.assertTupleEqual((1, 2), fn_b(1, **filter_kwargs(fn_b, b=2, c=3))) + assert fn_b(1, **filter_kwargs(fn_b, b=2, c=3)) == (1, 2) - self.assertTupleEqual( - (1, 2, 3), fn_c(1, **filter_kwargs(fn_c, b=2, c=3)) - ) + assert fn_c(1, **filter_kwargs(fn_c, b=2, c=3)) == (1, 2, 3) - self.assertDictEqual(filter_kwargs(partial(fn_c, b=1), b=1), {"b": 1}) + assert filter_kwargs(partial(fn_c, b=1), b=1) == {"b": 1} -class TestFilterMapping(unittest.TestCase): +class TestFilterMapping: """ Define :func:`colour.utilities.common.filter_mapping` definition unit tests methods. @@ -490,11 +468,9 @@ def __init__(self, name: str) -> None: "Not Element C": Element("Not C"), } - self.assertListEqual( - sorted(filter_mapping(mapping, "Element A")), ["Element A"] - ) + assert sorted(filter_mapping(mapping, "Element A")) == ["Element A"] - self.assertDictEqual(filter_mapping(mapping, "Element"), {}) + assert filter_mapping(mapping, "Element") == {} mapping = CanonicalMapping( { @@ -505,20 +481,14 @@ def __init__(self, name: str) -> None: } ) - self.assertListEqual( - sorted(filter_mapping(mapping, "element a")), ["Element A"] - ) + assert sorted(filter_mapping(mapping, "element a")) == ["Element A"] - self.assertListEqual( - sorted(filter_mapping(mapping, "element-a")), ["Element A"] - ) + assert sorted(filter_mapping(mapping, "element-a")) == ["Element A"] - self.assertListEqual( - sorted(filter_mapping(mapping, "elementa")), ["Element A"] - ) + assert sorted(filter_mapping(mapping, "elementa")) == ["Element A"] -class TestFirstItem(unittest.TestCase): +class TestFirstItem: """ Define :func:`colour.utilities.common.first_item` definition unit tests methods. @@ -527,15 +497,15 @@ class TestFirstItem(unittest.TestCase): def test_first_item(self): """Test :func:`colour.utilities.common.first_item` definition.""" - self.assertEqual(first_item(range(10)), 0) + assert first_item(range(10)) == 0 dictionary = {0: "a", 1: "b", 2: "c"} - self.assertEqual(first_item(dictionary.items()), (0, "a")) + assert first_item(dictionary.items()) == (0, "a") - self.assertEqual(first_item(dictionary.values()), "a") + assert first_item(dictionary.values()) == "a" -class TestValidateMethod(unittest.TestCase): +class TestValidateMethod: """ Define :func:`colour.utilities.common.validate_method` definition unit tests methods. @@ -544,8 +514,10 @@ class TestValidateMethod(unittest.TestCase): def test_validate_method(self): """Test :func:`colour.utilities.common.validate_method` definition.""" - self.assertEqual( - validate_method("Valid", ("Valid", "Yes", "Ok")), "valid" + assert validate_method("Valid", ("Valid", "Yes", "Ok")) == "valid" + assert ( + validate_method("Valid", ("Valid", "Yes", "Ok"), as_lowercase=False) + == "Valid" ) def test_raise_exception_validate_method(self): @@ -554,12 +526,10 @@ def test_raise_exception_validate_method(self): exception. """ - self.assertRaises( - ValueError, validate_method, "Invalid", ("Valid", "Yes", "Ok") - ) + pytest.raises(ValueError, validate_method, "Invalid", ("Valid", "Yes", "Ok")) -class TestOptional(unittest.TestCase): +class TestOptional: """ Define :func:`colour.utilities.common.optional` definition unit tests methods. @@ -568,12 +538,12 @@ class TestOptional(unittest.TestCase): def test_optional(self): """Test :func:`colour.utilities.common.optional` definition.""" - self.assertEqual(optional("Foo", "Bar"), "Foo") + assert optional("Foo", "Bar") == "Foo" - self.assertEqual(optional(None, "Bar"), "Bar") + assert optional(None, "Bar") == "Bar" -class TestSlugify(unittest.TestCase): +class TestSlugify: """ Define :func:`colour.utilities.common.slugify` definition unit tests methods. @@ -582,36 +552,33 @@ class TestSlugify(unittest.TestCase): def test_slugify(self): """Test :func:`colour.utilities.common.slugify` definition.""" - self.assertEqual( - slugify( - " Jack & Jill like numbers 1,2,3 and 4 and " - "silly characters ?%.$!/" - ), - "jack-jill-like-numbers-123-and-4-and-silly-characters", + assert ( + slugify(" Jack & Jill like numbers 1,2,3 and 4 and silly characters ?%.$!/") + == "jack-jill-like-numbers-123-and-4-and-silly-characters" ) - self.assertEqual( - slugify("Un \xe9l\xe9phant \xe0 l'or\xe9e du bois"), - "un-elephant-a-loree-du-bois", + assert ( + slugify("Un \xe9l\xe9phant \xe0 l'or\xe9e du bois") + == "un-elephant-a-loree-du-bois" ) # NOTE: Our "utilities/unicode_to_ascii.py" utility script normalises # the reference string. - self.assertEqual( + assert ( unicodedata.normalize( "NFD", slugify( "Un \xe9l\xe9phant \xe0 l'or\xe9e du bois", allow_unicode=True, ), - ), - "un-éléphant-à-lorée-du-bois", + ) + == "un-éléphant-à-lorée-du-bois" ) - self.assertEqual(slugify(123), "123") + assert slugify(123) == "123" -class TestIntDigest(unittest.TestCase): +class TestIntDigest: """ Define :func:`colour.utilities.common.int_digest` definition unit tests methods. @@ -620,19 +587,8 @@ class TestIntDigest(unittest.TestCase): def test_int_digest(self): """Test :func:`colour.utilities.common.int_digest` definition.""" - self.assertEqual(int_digest("Foo"), 7467386374397815550) - - if platform.system() in ("Windows", "Microsoft"): # pragma: no cover - self.assertEqual( - int_digest(np.array([1, 2, 3]).tobytes()), 7764052002911021640 - ) - else: - self.assertEqual( - int_digest(np.array([1, 2, 3]).tobytes()), 8964613590703056768 - ) - - self.assertEqual(int_digest(repr((1, 2, 3))), 5069958125469218295) + assert int_digest("Foo") == 7467386374397815550 + assert int_digest(np.array([1, 2, 3]).tobytes()) == 8964613590703056768 -if __name__ == "__main__": - unittest.main() + assert int_digest(repr((1, 2, 3))) == 5069958125469218295 diff --git a/colour/utilities/tests/test_data_structures.py b/colour/utilities/tests/test_data_structures.py deleted file mode 100644 index 6d29934929..0000000000 --- a/colour/utilities/tests/test_data_structures.py +++ /dev/null @@ -1,709 +0,0 @@ -# !/usr/bin/env python -"""Define the unit tests for the :mod:`colour.utilities.data_structures` module.""" - -import operator -import pickle -import unittest - -import numpy as np - -from colour.utilities import ( - CanonicalMapping, - ColourUsageWarning, - LazyCanonicalMapping, - Lookup, - Node, - Structure, -) - -__author__ = "Colour Developers" -__copyright__ = "Copyright 2013 Colour Developers" -__license__ = "BSD-3-Clause - https://opensource.org/licenses/BSD-3-Clause" -__maintainer__ = "Colour Developers" -__email__ = "colour-developers@colour-science.org" -__status__ = "Production" - -__all__ = [ - "TestStructure", - "TestLookup", - "TestCanonicalMapping", - "TestLazyCanonicalMapping", - "TestNode", -] - - -class TestStructure(unittest.TestCase): - """ - Define :class:`colour.utilities.data_structures.Structure` class unit - tests methods. - """ - - def test_Structure(self): - """Test :class:`colour.utilities.data_structures.Structure` class.""" - - structure = Structure(John="Doe", Jane="Doe") - self.assertIn("John", structure) - self.assertTrue(hasattr(structure, "John")) - - structure.John = "Nemo" - self.assertEqual(structure["John"], "Nemo") - - structure["John"] = "Vador" - self.assertEqual(structure["John"], "Vador") - - del structure["John"] - self.assertNotIn("John", structure) - self.assertFalse(hasattr(structure, "John")) - - structure.John = "Doe" - self.assertIn("John", structure) - self.assertTrue(hasattr(structure, "John")) - - del structure.John - self.assertNotIn("John", structure) - self.assertFalse(hasattr(structure, "John")) - - structure = Structure(John=None, Jane=None) - self.assertIsNone(structure.John) - self.assertIsNone(structure["John"]) - - structure.update(**{"John": "Doe", "Jane": "Doe"}) - self.assertEqual(structure.John, "Doe") - self.assertEqual(structure["John"], "Doe") - - def test_pickling(self): - """ - Test whether :class:`colour.utilities.data_structures.Structure` class - can be pickled. - """ - - structure = Structure(John="Doe", Jane="Doe") - - data = pickle.dumps(structure) - data = pickle.loads(data) # noqa: S301 - self.assertEqual(structure, data) - - data = pickle.dumps(structure, pickle.HIGHEST_PROTOCOL) - data = pickle.loads(data) # noqa: S301 - self.assertEqual(structure, data) - - self.assertEqual(sorted(dir(data)), ["Jane", "John"]) - - -class TestLookup(unittest.TestCase): - """ - Define :class:`colour.utilities.data_structures.Lookup` class unit tests - methods. - """ - - def test_required_methods(self): - """Test the presence of required methods.""" - - required_methods = ("keys_from_value", "first_key_from_value") - - for method in required_methods: - self.assertIn(method, dir(Lookup)) - - def test_keys_from_value(self): - """ - Test :meth:`colour.utilities.data_structures.Lookup.keys_from_value` - method. - """ - - lookup = Lookup(John="Doe", Jane="Doe", Luke="Skywalker") - self.assertListEqual( - ["Jane", "John"], sorted(lookup.keys_from_value("Doe")) - ) - - lookup = Lookup( - A=np.array([0, 1, 2]), B=np.array([0, 1, 2]), C=np.array([1, 2, 3]) - ) - self.assertListEqual( - ["A", "B"], sorted(lookup.keys_from_value(np.array([0, 1, 2]))) - ) - - def test_first_key_from_value(self): - """ - Test :meth:`colour.utilities.data_structures.\ -Lookup.first_key_from_value` method. - """ - - lookup = Lookup(first_name="John", last_name="Doe", gender="male") - self.assertEqual("first_name", lookup.first_key_from_value("John")) - - lookup = Lookup( - A=np.array([0, 1, 2]), B=np.array([1, 2, 3]), C=np.array([2, 3, 4]) - ) - self.assertEqual("A", lookup.first_key_from_value(np.array([0, 1, 2]))) - - def test_raise_exception_first_key_from_value(self): - """ - Test :meth:`colour.utilities.data_structures.\ -Lookup.first_key_from_value` method raised exception. - """ - - self.assertRaises(IndexError, Lookup().first_key_from_value, "John") - - -class TestCanonicalMapping(unittest.TestCase): - """ - Define :class:`colour.utilities.data_structures.CanonicalMapping` class - unit tests methods. - """ - - def test_required_attributes(self): - """Test the presence of required attributes.""" - - required_attributes = ("data",) - - for attribute in required_attributes: - self.assertIn(attribute, dir(CanonicalMapping)) - - def test_required_methods(self): - """Test the presence of required methods.""" - - required_methods = ( - "__init__", - "__repr__", - "__setitem__", - "__getitem__", - "__delitem__", - "__contains__", - "__iter__", - "__len__", - "__eq__", - "__ne__", - "copy", - "lower_keys", - "lower_items", - "slugified_keys", - "slugified_items", - "canonical_keys", - "canonical_items", - ) - - for method in required_methods: - self.assertIn(method, dir(CanonicalMapping)) - - def test_data(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.data` - property. - """ - - self.assertDictEqual( - CanonicalMapping({"John": "Doe", "Jane": "Doe"}).data, - {"John": "Doe", "Jane": "Doe"}, - ) - - def test__repr__(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.__repr__` - method. - """ - - mapping = CanonicalMapping() - - mapping["John"] = "Doe" - self.assertEqual(repr(mapping), "CanonicalMapping({'John': 'Doe'})") - - def test__setitem__(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.\ -__setitem__` method. - """ - - mapping = CanonicalMapping() - - mapping["John"] = "Doe" - self.assertEqual(mapping["John"], "Doe") - self.assertEqual(mapping["john"], "Doe") - - def test__getitem__(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.\ -__getitem__` method. - """ - - mapping = CanonicalMapping(John="Doe", Jane="Doe") - - self.assertEqual(mapping["John"], "Doe") - self.assertEqual(mapping["john"], "Doe") - self.assertEqual(mapping["JOHN"], "Doe") - self.assertEqual(mapping["Jane"], "Doe") - self.assertEqual(mapping["jane"], "Doe") - self.assertEqual(mapping["JANE"], "Doe") - - mapping = CanonicalMapping({1: "Foo", 2: "Bar"}) - - self.assertEqual(mapping[1], "Foo") - - mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) - - self.assertEqual(mapping["mccamy-1992"], 1) - self.assertEqual(mapping["hernandez-1999"], 2) - self.assertEqual(mapping["mccamy1992"], 1) - self.assertEqual(mapping["hernandez1999"], 2) - - def test__delitem__(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.\ -__delitem__` method. - """ - - mapping = CanonicalMapping(John="Doe", Jane="Doe") - - del mapping["john"] - self.assertNotIn("John", mapping) - - del mapping["Jane"] - self.assertNotIn("jane", mapping) - self.assertEqual(len(mapping), 0) - - mapping = CanonicalMapping(John="Doe", Jane="Doe") - del mapping["JOHN"] - self.assertNotIn("John", mapping) - - del mapping["jane"] - self.assertNotIn("jane", mapping) - self.assertEqual(len(mapping), 0) - - mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) - - del mapping["mccamy-1992"] - self.assertNotIn("McCamy 1992", mapping) - - del mapping["hernandez-1999"] - self.assertNotIn("Hernandez 1999", mapping) - - self.assertEqual(len(mapping), 0) - - mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) - - del mapping["mccamy1992"] - self.assertNotIn("McCamy 1992", mapping) - - del mapping["hernandez1999"] - self.assertNotIn("Hernandez 1999", mapping) - - self.assertEqual(len(mapping), 0) - - def test__contains__(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.\ -__contains__` method. - """ - - mapping = CanonicalMapping(John="Doe", Jane="Doe") - - self.assertIn("John", mapping) - self.assertIn("john", mapping) - self.assertIn("JOHN", mapping) - self.assertIn("Jane", mapping) - self.assertIn("jane", mapping) - self.assertIn("JANE", mapping) - - mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) - - self.assertIn("mccamy-1992", mapping) - self.assertIn("hernandez-1999", mapping) - self.assertIn("mccamy1992", mapping) - self.assertIn("hernandez1999", mapping) - - def test__iter__(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.__iter__` - method. - """ - - mapping = CanonicalMapping(John="Doe", Jane="Doe") - self.assertListEqual( - sorted(item for item in mapping), ["Jane", "John"] - ) - - def test__len__(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.__len__` - method. - """ - - self.assertEqual(len(CanonicalMapping()), 0) - - self.assertEqual(len(CanonicalMapping(John="Doe", Jane="Doe")), 2) - - def test__eq__(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.__eq__` - method. - """ - - mapping1 = CanonicalMapping(John="Doe", Jane="Doe") - mapping2 = CanonicalMapping(John="Doe", Jane="Doe") - mapping3 = CanonicalMapping(john="Doe", jane="Doe") - - self.assertEqual(mapping1, mapping2) - - self.assertNotEqual(mapping2, mapping3) - - def test_raise_exception__eq__(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.__eq__` - method raised exception. - """ - - self.assertRaises( - TypeError, - operator.eq, - CanonicalMapping(John="Doe", Jane="Doe"), - ["John", "Doe", "Jane", "Doe"], - ) - - def test__ne__(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.__ne__` - method. - """ - - mapping1 = CanonicalMapping(John="Doe", Jane="Doe") - mapping2 = CanonicalMapping(Gi="Doe", Jane="Doe") - - self.assertNotEqual(mapping1, mapping2) - - def test_raise_exception__ne__(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.__ne__` - method raised exception. - """ - - self.assertRaises( - TypeError, - operator.ne, - CanonicalMapping(John="Doe", Jane="Doe"), - ["John", "Doe", "Jane", "Doe"], - ) - - def test_copy(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.copy` - method. - """ - - mapping1 = CanonicalMapping(John="Doe", Jane="Doe") - mapping2 = mapping1.copy() - - self.assertEqual(mapping1, mapping2) - - self.assertNotEqual(id(mapping1), id(mapping2)) - - def test_lower_keys(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.\ -lower_keys` method. - """ - - mapping = CanonicalMapping(John="Doe", Jane="Doe") - - self.assertListEqual( - sorted(item for item in mapping.lower_keys()), - ["jane", "john"], - ) - - mapping = CanonicalMapping(John="Doe", john="Doe") - - self.assertWarns( - ColourUsageWarning, lambda: list(mapping.lower_keys()) - ) - - def test_lower_items(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.\ -lower_items` method. - """ - - mapping = CanonicalMapping(John="Doe", Jane="Doe") - - self.assertListEqual( - sorted(item for item in mapping.lower_items()), - [("jane", "Doe"), ("john", "Doe")], - ) - - def test_slugified_keys(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.\ -slugified_keys` method. - """ - - mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) - - self.assertListEqual( - sorted(item for item in mapping.slugified_keys()), - ["hernandez-1999", "mccamy-1992"], - ) - - mapping = CanonicalMapping({"McCamy 1992": 1, "McCamy-1992": 2}) - - self.assertWarns( - ColourUsageWarning, lambda: list(mapping.slugified_keys()) - ) - - def test_slugified_items(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.\ -slugified_items` method. - """ - - mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) - self.assertListEqual( - sorted(item for item in mapping.slugified_items()), - [("hernandez-1999", 2), ("mccamy-1992", 1)], - ) - - def test_canonical_keys(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.\ -canonical_keys` method. - """ - - mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) - - self.assertListEqual( - sorted(item for item in mapping.canonical_keys()), - ["hernandez1999", "mccamy1992"], - ) - - mapping = CanonicalMapping({"McCamy_1992": 1, "McCamy-1992": 2}) - - self.assertWarns( - ColourUsageWarning, lambda: list(mapping.canonical_keys()) - ) - - def test_canonical_items(self): - """ - Test :meth:`colour.utilities.data_structures.CanonicalMapping.\ -canonical_items` method. - """ - - mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) - self.assertListEqual( - sorted(item for item in mapping.canonical_items()), - [("hernandez1999", 2), ("mccamy1992", 1)], - ) - - -class TestLazyCanonicalMapping(unittest.TestCase): - """ - Define :class:`colour.utilities.data_structures.LazyCanonicalMapping` class - unit tests methods. - """ - - def test_required_attributes(self): - """Test the presence of required attributes.""" - - required_attributes = () - - for attribute in required_attributes: # pragma: no cover - self.assertIn(attribute, dir(LazyCanonicalMapping)) - - def test_required_methods(self): - """Test the presence of required methods.""" - - required_methods = ("__getitem__",) - - for method in required_methods: - self.assertIn(method, dir(LazyCanonicalMapping)) - - def test__getitem__(self): - """ - Test :meth:`colour.utilities.data_structures.LazyCanonicalMapping.\ -__getitem__` method. - """ - - mapping = LazyCanonicalMapping(John="Doe", Jane=lambda: "Doe") - - self.assertEqual(mapping["John"], "Doe") - self.assertEqual(mapping["john"], "Doe") - self.assertEqual(mapping["Jane"], "Doe") - self.assertEqual(mapping["jane"], "Doe") - - -class TestNode(unittest.TestCase): - """ - Define :class:`colour.utilities.data_structures.Node` class unit tests - methods. - """ - - def setUp(self): - """Initialise the common tests attributes.""" - - self._data = {"John": "Doe"} - - self._node_a = Node("Node A", data=self._data) - self._node_b = Node("Node B", self._node_a) - self._node_c = Node("Node C", self._node_a) - self._node_d = Node("Node D", self._node_b) - self._node_e = Node("Node E", self._node_b) - self._node_f = Node("Node F", self._node_d) - self._node_g = Node("Node G", self._node_f) - self._node_h = Node("Node H", self._node_g) - - self._tree = self._node_a - - def test_required_attributes(self): - """Test the presence of required attributes.""" - - required_attributes = ( - "name", - "parent", - "children", - "id", - "root", - "leaves", - "siblings", - "data", - ) - - for attribute in required_attributes: - self.assertIn(attribute, dir(Node)) - - def test_required_methods(self): - """Test the presence of required methods.""" - - required_methods = ( - "__new__", - "__init__", - "__str__", - "__len__", - "is_root", - "is_inner", - "is_leaf", - "walk", - "render", - ) - - for method in required_methods: - self.assertIn(method, dir(Node)) - - def test_name(self): - """Test :attr:`colour.utilities.data_structures.Node.name` property.""" - - self.assertEqual(self._tree.name, "Node A") - self.assertIn("Node#", Node().name) - - def test_parent(self): - """Test :attr:`colour.utilities.data_structures.Node.parent` property.""" - - self.assertIs(self._node_b.parent, self._node_a) - self.assertIs(self._node_h.parent, self._node_g) - - def test_children(self): - """Test :attr:`colour.utilities.data_structures.Node.children` property.""" - - self.assertListEqual( - self._node_a.children, [self._node_b, self._node_c] - ) - - def test_id(self): - """Test :attr:`colour.utilities.data_structures.Node.id` property.""" - - self.assertIsInstance(self._node_a.id, int) - - def test_root(self): - """Test :attr:`colour.utilities.data_structures.Node.root` property.""" - - self.assertIs(self._node_a.root, self._node_a) - self.assertIs(self._node_f.root, self._node_a) - self.assertIs(self._node_g.root, self._node_a) - self.assertIs(self._node_h.root, self._node_a) - - def test_leaves(self): - """Test :attr:`colour.utilities.data_structures.Node.leaves` property.""" - - self.assertListEqual(list(self._node_h.leaves), [self._node_h]) - - self.assertListEqual( - list(self._node_a.leaves), - [self._node_h, self._node_e, self._node_c], - ) - - def test_siblings(self): - """Test :attr:`colour.utilities.data_structures.Node.siblings` property.""" - - self.assertListEqual(list(self._node_a.siblings), []) - - self.assertListEqual(list(self._node_b.siblings), [self._node_c]) - - def test_data(self): - """Test :attr:`colour.utilities.data_structures.Node.data` property.""" - - self.assertIs(self._node_a.data, self._data) - - def test__str__(self): - """Test :attr:`colour.utilities.data_structures.Node.__str__` method.""" - - self.assertIn("Node#", str(self._node_a)) - self.assertIn("{'John': 'Doe'})", str(self._node_a)) - - def test__len__(self): - """Test :attr:`colour.utilities.data_structures.Node.__len__` method.""" - - self.assertEqual(len(self._node_a), 7) - - def test_is_root(self): - """Test :attr:`colour.utilities.data_structures.Node.is_root` method.""" - - self.assertTrue(self._node_a.is_root()) - self.assertFalse(self._node_b.is_root()) - self.assertFalse(self._node_c.is_root()) - self.assertFalse(self._node_h.is_root()) - - def test_is_inner(self): - """Test :attr:`colour.utilities.data_structures.Node.is_inner` method.""" - - self.assertFalse(self._node_a.is_inner()) - self.assertTrue(self._node_b.is_inner()) - self.assertFalse(self._node_c.is_inner()) - self.assertFalse(self._node_h.is_inner()) - - def test_is_leaf(self): - """Test :attr:`colour.utilities.data_structures.Node.is_leaf` method.""" - - self.assertFalse(self._node_a.is_leaf()) - self.assertFalse(self._node_b.is_leaf()) - self.assertTrue(self._node_c.is_leaf()) - self.assertTrue(self._node_h.is_leaf()) - - def test_walk(self): - """Test :attr:`colour.utilities.data_structures.Node.walk` method.""" - - self.assertListEqual( - list(self._node_a.walk()), - [ - self._node_b, - self._node_d, - self._node_f, - self._node_g, - self._node_h, - self._node_e, - self._node_c, - ], - ) - - self.assertListEqual( - list(self._node_h.walk(ascendants=True)), - [ - self._node_g, - self._node_f, - self._node_d, - self._node_b, - self._node_a, - ], - ) - - def test_render(self): - """Test :attr:`colour.utilities.data_structures.Node.render` method.""" - - self.assertIsInstance(self._node_a.render(), str) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/utilities/tests/test_deprecated.py b/colour/utilities/tests/test_deprecated.py index 898031f6a0..88c1b48192 100644 --- a/colour/utilities/tests/test_deprecated.py +++ b/colour/utilities/tests/test_deprecated.py @@ -27,9 +27,7 @@ def __getattr__(self, attribute) -> Any: """A module attribute with a new name.""" with contextlib.suppress(KeyError): - sys.modules[ - "colour.utilities.tests.test_deprecated" - ] = deprecated( # pyright: ignore + sys.modules["colour.utilities.tests.test_deprecated"] = deprecated( # pyright: ignore sys.modules["colour.utilities.tests.test_deprecated"], { "OLD_NAME": ObjectRenamed( diff --git a/colour/utilities/tests/test_deprecation.py b/colour/utilities/tests/test_deprecation.py index 22c95744df..4e88eca407 100644 --- a/colour/utilities/tests/test_deprecation.py +++ b/colour/utilities/tests/test_deprecation.py @@ -1,8 +1,8 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.utilities.deprecation` module.""" import sys -import unittest + +import pytest from colour.utilities import ColourUsageWarning from colour.utilities.deprecation import ( @@ -47,7 +47,7 @@ ] -class TestObjectRenamed(unittest.TestCase): +class TestObjectRenamed: """ Define :class:`colour.utilities.deprecation.ObjectRenamed` class unit tests methods. @@ -59,7 +59,7 @@ def test_required_methods(self): required_methods = ("__str__",) for method in required_methods: - self.assertIn(method, dir(ObjectRenamed)) + assert method in dir(ObjectRenamed) def test__str__(self): """ @@ -67,11 +67,11 @@ def test__str__(self): method. """ - self.assertIn("name", str(ObjectRenamed("name", "new_name"))) - self.assertIn("new_name", str(ObjectRenamed("name", "new_name"))) + assert "name" in str(ObjectRenamed("name", "new_name")) + assert "new_name" in str(ObjectRenamed("name", "new_name")) -class TestObjectRemoved(unittest.TestCase): +class TestObjectRemoved: """ Define :class:`colour.utilities.deprecation.ObjectRemoved` class unit tests methods. @@ -83,7 +83,7 @@ def test_required_methods(self): required_methods = ("__str__",) for method in required_methods: - self.assertIn(method, dir(ObjectRemoved)) + assert method in dir(ObjectRemoved) def test__str__(self): """ @@ -91,10 +91,10 @@ def test__str__(self): method. """ - self.assertIn("name", str(ObjectRemoved("name"))) + assert "name" in str(ObjectRemoved("name")) -class TestObjectFutureRename(unittest.TestCase): +class TestObjectFutureRename: """ Define :class:`colour.utilities.deprecation.ObjectFutureRename` class unit tests methods. @@ -106,7 +106,7 @@ def test_required_methods(self): required_methods = ("__str__",) for method in required_methods: - self.assertIn(method, dir(ObjectFutureRename)) + assert method in dir(ObjectFutureRename) def test__str__(self): """ @@ -114,11 +114,11 @@ def test__str__(self): method. """ - self.assertIn("name", str(ObjectFutureRename("name", "new_name"))) - self.assertIn("new_name", str(ObjectFutureRename("name", "new_name"))) + assert "name" in str(ObjectFutureRename("name", "new_name")) + assert "new_name" in str(ObjectFutureRename("name", "new_name")) -class TestObjectFutureRemove(unittest.TestCase): +class TestObjectFutureRemove: """ Define :class:`colour.utilities.deprecation.ObjectFutureRemove` class unit tests methods. @@ -130,7 +130,7 @@ def test_required_methods(self): required_methods = ("__str__",) for method in required_methods: - self.assertIn(method, dir(ObjectFutureRemove)) + assert method in dir(ObjectFutureRemove) def test__str__(self): """ @@ -138,17 +138,14 @@ def test__str__(self): method. """ - self.assertIn( - "name", - str( - ObjectFutureRemove( - "name", - ) - ), + assert "name" in str( + ObjectFutureRemove( + "name", + ) ) -class TestObjectFutureAccessChange(unittest.TestCase): +class TestObjectFutureAccessChange: """ Define :class:`colour.utilities.deprecation.ObjectFutureAccessChange` class unit tests methods. @@ -160,7 +157,7 @@ def test_required_methods(self): required_methods = ("__str__",) for method in required_methods: - self.assertIn(method, dir(ObjectFutureAccessChange)) + assert method in dir(ObjectFutureAccessChange) def test__str__(self): """ @@ -168,15 +165,11 @@ def test__str__(self): ObjectFutureAccessChange.__str__` method. """ - self.assertIn( - "name", str(ObjectFutureAccessChange("name", "new_access")) - ) - self.assertIn( - "new_access", str(ObjectFutureAccessChange("name", "new_access")) - ) + assert "name" in str(ObjectFutureAccessChange("name", "new_access")) + assert "new_access" in str(ObjectFutureAccessChange("name", "new_access")) -class TestObjectFutureAccessRemove(unittest.TestCase): +class TestObjectFutureAccessRemove: """ Define :class:`colour.utilities.deprecation.ObjectFutureAccessRemove` class unit tests methods. @@ -188,7 +181,7 @@ def test_required_methods(self): required_methods = ("__str__",) for method in required_methods: - self.assertIn(method, dir(ObjectFutureAccessRemove)) + assert method in dir(ObjectFutureAccessRemove) def test__str__(self): """ @@ -196,17 +189,14 @@ def test__str__(self): ObjectFutureAccessRemove.__str__` method. """ - self.assertIn( - "name", - str( - ObjectFutureAccessRemove( - "name", - ) - ), + assert "name" in str( + ObjectFutureAccessRemove( + "name", + ) ) -class TestArgumentRenamed(unittest.TestCase): +class TestArgumentRenamed: """ Define :class:`colour.utilities.deprecation.ArgumentRenamed` class unit tests methods. @@ -218,7 +208,7 @@ def test_required_methods(self): required_methods = ("__str__",) for method in required_methods: - self.assertIn(method, dir(ArgumentRenamed)) + assert method in dir(ArgumentRenamed) def test__str__(self): """ @@ -226,11 +216,11 @@ def test__str__(self): method. """ - self.assertIn("name", str(ArgumentRenamed("name", "new_name"))) - self.assertIn("new_name", str(ArgumentRenamed("name", "new_name"))) + assert "name" in str(ArgumentRenamed("name", "new_name")) + assert "new_name" in str(ArgumentRenamed("name", "new_name")) -class TestArgumentRemoved(unittest.TestCase): +class TestArgumentRemoved: """ Define :class:`colour.utilities.deprecation.ArgumentRemoved` class unit tests methods. @@ -242,7 +232,7 @@ def test_required_methods(self): required_methods = ("__str__",) for method in required_methods: - self.assertIn(method, dir(ArgumentRemoved)) + assert method in dir(ArgumentRemoved) def test__str__(self): """ @@ -250,10 +240,10 @@ def test__str__(self): method. """ - self.assertIn("name", str(ArgumentRemoved("name"))) + assert "name" in str(ArgumentRemoved("name")) -class TestArgumentFutureRename(unittest.TestCase): +class TestArgumentFutureRename: """ Define :class:`colour.utilities.deprecation.ArgumentFutureRename` class unit tests methods. @@ -265,7 +255,7 @@ def test_required_methods(self): required_methods = ("__str__",) for method in required_methods: - self.assertIn(method, dir(ArgumentFutureRename)) + assert method in dir(ArgumentFutureRename) def test__str__(self): """ @@ -273,13 +263,11 @@ def test__str__(self): ArgumentFutureRename.__str__` method. """ - self.assertIn("name", str(ArgumentFutureRename("name", "new_name"))) - self.assertIn( - "new_name", str(ArgumentFutureRename("name", "new_name")) - ) + assert "name" in str(ArgumentFutureRename("name", "new_name")) + assert "new_name" in str(ArgumentFutureRename("name", "new_name")) -class TestArgumentFutureRemove(unittest.TestCase): +class TestArgumentFutureRemove: """ Define :class:`colour.utilities.deprecation.ArgumentFutureRemove` class unit tests methods. @@ -291,7 +279,7 @@ def test_required_methods(self): required_methods = ("__str__",) for method in required_methods: - self.assertIn(method, dir(ArgumentFutureRemove)) + assert method in dir(ArgumentFutureRemove) def test__str__(self): """ @@ -299,17 +287,14 @@ def test__str__(self): ArgumentFutureRemove.__str__` method. """ - self.assertIn( - "name", - str( - ArgumentFutureRemove( - "name", - ) - ), + assert "name" in str( + ArgumentFutureRemove( + "name", + ) ) -class TestModuleAPI(unittest.TestCase): +class TestModuleAPI: """ Define :class:`colour.utilities.deprecation.ModuleAPI` class unit tests methods. @@ -321,7 +306,7 @@ def test_required_methods(self): required_methods = ("__init__", "__getattr__", "__dir__") for method in required_methods: - self.assertIn(method, dir(ModuleAPI)) + assert method in dir(ModuleAPI) def test__getattr__(self): """ @@ -331,14 +316,14 @@ def test__getattr__(self): import colour.utilities.tests.test_deprecated - self.assertIsNone(colour.utilities.tests.test_deprecated.NAME) + assert colour.utilities.tests.test_deprecated.NAME is None def assert_warns(): """Help to test the runtime warning.""" colour.utilities.tests.test_deprecated.OLD_NAME # noqa: B018 - self.assertWarns(ColourUsageWarning, assert_warns) + pytest.warns(ColourUsageWarning, assert_warns) del sys.modules["colour.utilities.tests.test_deprecated"] @@ -350,7 +335,7 @@ def test_raise_exception__getattr__(self): import colour.utilities.tests.test_deprecated - self.assertRaises( + pytest.raises( AttributeError, getattr, colour.utilities.tests.test_deprecated, @@ -360,7 +345,7 @@ def test_raise_exception__getattr__(self): del sys.modules["colour.utilities.tests.test_deprecated"] -class TestGetAttribute(unittest.TestCase): +class TestGetAttribute: """ Define :func:`colour.utilities.deprecation.get_attribute` definition unit tests methods. @@ -371,38 +356,28 @@ def test_get_attribute(self): from colour import adaptation - self.assertIs(get_attribute("colour.adaptation"), adaptation) + assert get_attribute("colour.adaptation") is adaptation from colour.models import eotf_inverse_sRGB - self.assertIs( - get_attribute("colour.models.eotf_inverse_sRGB"), eotf_inverse_sRGB - ) + assert get_attribute("colour.models.eotf_inverse_sRGB") is eotf_inverse_sRGB from colour.utilities.array import as_float - self.assertIs( - get_attribute("colour.utilities.array.as_float"), as_float - ) + assert get_attribute("colour.utilities.array.as_float") is as_float - if ( - "colour.utilities.tests.test_deprecated" in sys.modules - ): # pragma: no cover + if "colour.utilities.tests.test_deprecated" in sys.modules: # pragma: no cover del sys.modules["colour.utilities.tests.test_deprecated"] - attribute = get_attribute( - "colour.utilities.tests.test_deprecated.NEW_NAME" - ) + attribute = get_attribute("colour.utilities.tests.test_deprecated.NEW_NAME") import colour.utilities.tests.test_deprecated - self.assertIs( - attribute, colour.utilities.tests.test_deprecated.NEW_NAME - ) + assert attribute is colour.utilities.tests.test_deprecated.NEW_NAME del sys.modules["colour.utilities.tests.test_deprecated"] -class TestBuildAPIChanges(unittest.TestCase): +class TestBuildAPIChanges: """ Define :func:`colour.utilities.deprecation.build_API_changes` definition unit tests methods. @@ -465,10 +440,10 @@ def test_build_API_changes(self): ("argument_3_name", ArgumentRemoved), ("argument_4_name", ArgumentFutureRemove), ): - self.assertIsInstance(changes[name], change_type) + assert isinstance(changes[name], change_type) -class TestHandleArgumentsDeprecation(unittest.TestCase): +class TestHandleArgumentsDeprecation: """ Define :func:`colour.utilities.deprecation.handle_arguments_deprecation` definition unit tests methods. @@ -497,23 +472,16 @@ def test_handle_arguments_deprecation(self): "ArgumentFutureRemove": ["argument_4_name"], } - self.assertDictEqual( - handle_arguments_deprecation( - changes, - argument_1_name=True, - argument_2_name=True, - argument_3_name=True, - argument_4_name=True, - argument_5_name=True, - ), - { - "argument_1_new_name": True, - "argument_2_new_name": True, - "argument_4_name": True, - "argument_5_name": True, - }, - ) - - -if __name__ == "__main__": - unittest.main() + assert handle_arguments_deprecation( + changes, + argument_1_name=True, + argument_2_name=True, + argument_3_name=True, + argument_4_name=True, + argument_5_name=True, + ) == { + "argument_1_new_name": True, + "argument_2_new_name": True, + "argument_4_name": True, + "argument_5_name": True, + } diff --git a/colour/utilities/tests/test_documentation.py b/colour/utilities/tests/test_documentation.py index e72b4b33f0..ca0e08c2ab 100644 --- a/colour/utilities/tests/test_documentation.py +++ b/colour/utilities/tests/test_documentation.py @@ -1,8 +1,6 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.utilities.documentation` module.""" import os -import unittest from colour.utilities.documentation import is_documentation_building @@ -18,7 +16,7 @@ ] -class TestIsDocumentationBuilding(unittest.TestCase): +class TestIsDocumentationBuilding: """ Define :func:`colour.utilities.documentation.is_documentation_building` definition unit tests methods. @@ -31,25 +29,25 @@ def test_is_documentation_building(self): """ try: - self.assertFalse(is_documentation_building()) + assert not is_documentation_building() os.environ["READTHEDOCS"] = "True" - self.assertTrue(is_documentation_building()) + assert is_documentation_building() os.environ["READTHEDOCS"] = "False" - self.assertTrue(is_documentation_building()) + assert is_documentation_building() del os.environ["READTHEDOCS"] - self.assertFalse(is_documentation_building()) + assert not is_documentation_building() os.environ["COLOUR_SCIENCE__DOCUMENTATION_BUILD"] = "True" - self.assertTrue(is_documentation_building()) + assert is_documentation_building() os.environ["COLOUR_SCIENCE__DOCUMENTATION_BUILD"] = "False" - self.assertTrue(is_documentation_building()) + assert is_documentation_building() del os.environ["COLOUR_SCIENCE__DOCUMENTATION_BUILD"] - self.assertFalse(is_documentation_building()) + assert not is_documentation_building() finally: # pragma: no cover if os.environ.get("READTHEDOCS"): @@ -57,7 +55,3 @@ def test_is_documentation_building(self): if os.environ.get("COLOUR_SCIENCE__DOCUMENTATION_BUILD"): del os.environ["COLOUR_SCIENCE__DOCUMENTATION_BUILD"] - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/utilities/tests/test_metrics.py b/colour/utilities/tests/test_metrics.py index 3d6e0ec47b..48fe7e62fc 100644 --- a/colour/utilities/tests/test_metrics.py +++ b/colour/utilities/tests/test_metrics.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.utilities.metrics` module.""" -import unittest import numpy as np @@ -21,7 +19,7 @@ ] -class TestMetricMse(unittest.TestCase): +class TestMetricMse: """ Define :func:`colour.utilities.metrics.metric_mse` definition unit tests methods. @@ -31,7 +29,7 @@ def test_metric_mse(self): """Test :func:`colour.utilities.metrics.metric_mse` definition.""" a = np.array([0.48222001, 0.31654775, 0.22070353]) - self.assertEqual(metric_mse(a, a), 0) + assert metric_mse(a, a) == 0 b = a * 0.9 np.testing.assert_allclose( @@ -48,7 +46,7 @@ def test_metric_mse(self): ) -class TestMetricPsnr(unittest.TestCase): +class TestMetricPsnr: """ Define :func:`colour.utilities.metrics.metric_psnr` definition unit tests methods. @@ -58,7 +56,7 @@ def test_metric_psnr(self): """Test :func:`colour.utilities.metrics.metric_psnr` definition.""" a = np.array([0.48222001, 0.31654775, 0.22070353]) - self.assertEqual(metric_psnr(a, a), 0) + assert metric_psnr(a, a) == 0 b = a * 0.9 np.testing.assert_allclose( @@ -73,7 +71,3 @@ def test_metric_psnr(self): 28.956851563141296, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/utilities/tests/test_network.py b/colour/utilities/tests/test_network.py new file mode 100644 index 0000000000..8dde364872 --- /dev/null +++ b/colour/utilities/tests/test_network.py @@ -0,0 +1,1119 @@ +"""Define the unit tests for the :mod:`colour.utilities.network` module.""" + +import re + +import numpy as np + +from colour.utilities import ( + ExecutionNode, + For, + ParallelForMultiprocess, + ParallelForThread, + Port, + PortGraph, + PortNode, + TreeNode, + is_pydot_installed, +) + +__author__ = "Colour Developers" +__copyright__ = "Copyright 2013 Colour Developers" +__license__ = "BSD-3-Clause - https://opensource.org/licenses/BSD-3-Clause" +__maintainer__ = "Colour Developers" +__email__ = "colour-developers@colour-science.org" +__status__ = "Production" + +__all__ = [ + "TestTreeNode", + "TestPort", + "TestPortNode", + "TestPortGraph", + "TestFor", + "TestParallelForThread", + "TestParallelForMultiProcess", +] + + +class TestTreeNode: + """ + Define :class:`colour.utilities.network.TreeNode` class unit tests + methods. + """ + + def setup_method(self): + """Initialise the common tests attributes.""" + + self._data = {"John": "Doe"} + + self._node_a = TreeNode("Node A", data=self._data) + self._node_b = TreeNode("Node B", self._node_a) + self._node_c = TreeNode("Node C", self._node_a) + self._node_d = TreeNode("Node D", self._node_b) + self._node_e = TreeNode("Node E", self._node_b) + self._node_f = TreeNode("Node F", self._node_d) + self._node_g = TreeNode("Node G", self._node_f) + self._node_h = TreeNode("Node H", self._node_g) + + self._tree = self._node_a + + def test_required_attributes(self): + """Test the presence of required attributes.""" + + required_attributes = ( + "id", + "name", + "parent", + "children", + "root", + "leaves", + "siblings", + "data", + ) + + for attribute in required_attributes: + assert attribute in dir(TreeNode) + + def test_required_methods(self): + """Test the presence of required methods.""" + + required_methods = ( + "__new__", + "__init__", + "__str__", + "__len__", + "is_root", + "is_inner", + "is_leaf", + "walk_hierarchy", + "render", + ) + + for method in required_methods: + assert method in dir(TreeNode) + + def test_name(self): + """Test :attr:`colour.utilities.network.TreeNode.name` property.""" + + assert self._tree.name == "Node A" + assert "Node#" in TreeNode().name + + def test_parent(self): + """Test :attr:`colour.utilities.network.TreeNode.parent` property.""" + + assert self._node_b.parent is self._node_a + assert self._node_h.parent is self._node_g + + def test_children(self): + """Test :attr:`colour.utilities.network.TreeNode.children` property.""" + + assert self._node_a.children == [self._node_b, self._node_c] + + def test_id(self): + """Test :attr:`colour.utilities.network.TreeNode.id` property.""" + + assert isinstance(self._node_a.id, int) + + def test_root(self): + """Test :attr:`colour.utilities.network.TreeNode.root` property.""" + + assert self._node_a.root is self._node_a + assert self._node_f.root is self._node_a + assert self._node_g.root is self._node_a + assert self._node_h.root is self._node_a + + def test_leaves(self): + """Test :attr:`colour.utilities.network.TreeNode.leaves` property.""" + + assert list(self._node_h.leaves) == [self._node_h] + + assert list(self._node_a.leaves) == [self._node_h, self._node_e, self._node_c] + + def test_siblings(self): + """Test :attr:`colour.utilities.network.TreeNode.siblings` property.""" + + assert list(self._node_a.siblings) == [] + + assert list(self._node_b.siblings) == [self._node_c] + + def test_data(self): + """Test :attr:`colour.utilities.network.TreeNode.data` property.""" + + assert self._node_a.data is self._data + + def test__str__(self): + """Test :attr:`colour.utilities.network.TreeNode.__str__` method.""" + + assert "TreeNode#" in str(self._node_a) + assert "{'John': 'Doe'})" in str(self._node_a) + + def test__len__(self): + """Test :attr:`colour.utilities.network.TreeNode.__len__` method.""" + + assert len(self._node_a) == 7 + + def test_is_root(self): + """Test :attr:`colour.utilities.network.TreeNode.is_root` method.""" + + assert self._node_a.is_root() + assert not self._node_b.is_root() + assert not self._node_c.is_root() + assert not self._node_h.is_root() + + def test_is_inner(self): + """Test :attr:`colour.utilities.network.TreeNode.is_inner` method.""" + + assert not self._node_a.is_inner() + assert self._node_b.is_inner() + assert not self._node_c.is_inner() + assert not self._node_h.is_inner() + + def test_is_leaf(self): + """Test :attr:`colour.utilities.network.TreeNode.is_leaf` method.""" + + assert not self._node_a.is_leaf() + assert not self._node_b.is_leaf() + assert self._node_c.is_leaf() + assert self._node_h.is_leaf() + + def test_walk_hierarchy(self): + """Test :attr:`colour.utilities.network.TreeNode.walk_hierarchy` method.""" + + assert list(self._node_a.walk_hierarchy()) == [ + self._node_b, + self._node_d, + self._node_f, + self._node_g, + self._node_h, + self._node_e, + self._node_c, + ] + + assert list(self._node_h.walk_hierarchy(ascendants=True)) == [ + self._node_g, + self._node_f, + self._node_d, + self._node_b, + self._node_a, + ] + + def test_render(self): + """Test :attr:`colour.utilities.network.TreeNode.render` method.""" + + assert isinstance(self._node_a.render(), str) + + +class TestPort: + """ + Define :class:`colour.utilities.network.Port` class unit tests methods. + """ + + def setup_method(self): + """Initialise the common tests attributes.""" + + class Node(PortNode): + ... + + self._node_a = Node("Node A") + self._port_a_node_a = self._node_a.add_input_port("a", 1, "Port A") + self._port_b_node_a = self._node_a.add_input_port("b") + self._port_output_node_a = self._node_a.add_output_port( + "output", description="Output" + ) + + self._node_b = Node("Node B") + self._port_a_node_b = self._node_b.add_input_port("a", 1, "Port A") + self._port_b_node_b = self._node_b.add_input_port("b") + self._port_output_node_b = self._node_b.add_output_port( + "output", description="Output" + ) + + self._ports = [ + self._port_a_node_a, + self._port_b_node_a, + self._port_output_node_a, + self._port_a_node_b, + self._port_b_node_b, + self._port_output_node_b, + ] + + def test_required_attributes(self): + """Test the presence of required attributes.""" + + required_attributes = ( + "name", + "value", + "description", + "node", + "connections", + ) + + for attribute in required_attributes: + assert attribute in dir(Port) + + def test_required_methods(self): + """Test the presence of required methods.""" + + required_methods = ( + "__init__", + "__str__", + "is_input_port", + "is_output_port", + "connect", + "disconnect", + "to_graphviz", + ) + + for method in required_methods: + assert method in dir(Port) + + def test_name(self): + """Test :attr:`colour.utilities.network.Port.name` property.""" + + assert self._port_a_node_a.name == "a" + assert self._port_b_node_a.name == "b" + assert self._port_output_node_a.name == "output" + assert self._port_a_node_b.name == "a" + assert self._port_b_node_b.name == "b" + assert self._port_output_node_b.name == "output" + + def test_value(self): + """Test :attr:`colour.utilities.network.Port.value` property.""" + + assert self._port_a_node_a.value == 1 + assert self._port_b_node_a.value is None + assert self._port_output_node_a.value is None + assert self._port_a_node_b.value == 1 + assert self._port_b_node_b.value is None + assert self._port_output_node_b.value is None + + self._port_output_node_a.connect(self._port_a_node_b) + self._port_output_node_a.connect(self._port_b_node_b) + + self._port_output_node_a.value = 2 + assert self._port_output_node_a.node.dirty is True + assert self._port_a_node_b.node.dirty is True + assert self._port_a_node_b.value == 2 + assert self._port_b_node_b.value == 2 + + self._port_a_node_b.value = 3 + assert self._port_a_node_b.node.dirty is True + assert self._port_output_node_a.node.dirty is True + assert self._port_output_node_a.value == 3 + assert self._port_b_node_b.value == 3 + + self._port_output_node_a.disconnect(self._port_a_node_b) + + self._port_output_node_a.value = 2 + self._port_output_node_a.node.process() + assert self._port_output_node_a.node.dirty is False + assert self._port_a_node_b.node.dirty is True + assert self._port_a_node_b.value == 3 + assert self._port_b_node_b.value == 2 + + self._port_output_node_a.disconnect(self._port_b_node_b) + + def test_description(self): + """Test :attr:`colour.utilities.network.Port.description` property.""" + + assert self._port_a_node_a.description == "Port A" + assert self._port_b_node_a.description is None + assert self._port_output_node_a.description == "Output" + assert self._port_a_node_b.description == "Port A" + assert self._port_b_node_b.description is None + assert self._port_output_node_b.description == "Output" + + def test_node(self): + """Test :attr:`colour.utilities.network.Port.node` property.""" + + assert self._port_a_node_a.node is self._node_a + assert self._port_a_node_b.node is self._node_b + + port = Port("a", 1, "Port A Description") + + assert port.node is None + + def test_connections(self): + """Test :attr:`colour.utilities.network.Port.connections` property.""" + + for port in self._ports: + assert len(port.connections) == 0 + + self._port_output_node_a.connect(self._port_a_node_b) + self._port_output_node_a.connect(self._port_b_node_b) + + assert len(self._port_output_node_a.connections) == 2 + assert len(self._port_a_node_b.connections) == 1 + assert len(self._port_b_node_b.connections) == 1 + + self._port_output_node_a.disconnect(self._port_a_node_b) + self._port_output_node_a.disconnect(self._port_b_node_b) + + for port in self._ports: + assert len(port.connections) == 0 + + def test___str__(self): + """Test :meth:`colour.utilities.network.Port.__str__` method.""" + + assert str(self._port_a_node_a) == "Node A.a (<- [])" + assert str(self._port_b_node_a) == "Node A.b (<- [])" + assert str(self._port_output_node_a) == "Node A.output (-> [])" + + assert str(self._port_a_node_b) == "Node B.a (<- [])" + assert str(self._port_b_node_b) == "Node B.b (<- [])" + assert str(self._port_output_node_b) == "Node B.output (-> [])" + + self._port_output_node_a.connect(self._port_a_node_b) + self._port_output_node_a.connect(self._port_b_node_b) + + assert str(self._port_a_node_a) == "Node A.a (<- [])" + assert str(self._port_b_node_a) == "Node A.b (<- [])" + assert ( + str(self._port_output_node_a) + == "Node A.output (-> ['Node B.a', 'Node B.b'])" + ) + + assert str(self._port_a_node_b) == "Node B.a (<- ['Node A.output'])" + assert str(self._port_b_node_b) == "Node B.b (<- ['Node A.output'])" + assert str(self._port_output_node_b) == "Node B.output (-> [])" + + self._port_output_node_a.disconnect(self._port_a_node_b) + self._port_output_node_a.disconnect(self._port_b_node_b) + + def test_is_input_port(self): + """Test :meth:`colour.utilities.network.Port.is_input_port` method.""" + + assert self._port_a_node_a.is_input_port() is True + assert self._port_b_node_a.is_input_port() is True + assert self._port_output_node_a.is_input_port() is False + + assert self._port_a_node_b.is_input_port() is True + assert self._port_b_node_b.is_input_port() is True + assert self._port_output_node_b.is_input_port() is False + + def test_is_output_port(self): + """Test :meth:`colour.utilities.network.Port.is_output_port` method.""" + + assert self._port_a_node_a.is_output_port() is False + assert self._port_b_node_a.is_output_port() is False + assert self._port_output_node_a.is_output_port() is True + + assert self._port_a_node_b.is_output_port() is False + assert self._port_b_node_b.is_output_port() is False + assert self._port_output_node_b.is_output_port() is True + + def test_connect(self): + """Test :meth:`colour.utilities.network.Port.connect` method.""" + + self.test_connections() + + def test_disconnect(self): + """Test :meth:`colour.utilities.network.Port.disconnect` method.""" + + self.test_connections() + + def test_to_graphviz(self): + """Test :meth:`colour.utilities.network.Port.test_to_graphviz` method.""" + + assert self._port_a_node_a.to_graphviz() == " a" + assert self._port_b_node_a.to_graphviz() == " b" + assert self._port_output_node_a.to_graphviz() == " output" + + assert self._port_a_node_b.to_graphviz() == " a" + assert self._port_b_node_b.to_graphviz() == " b" + assert self._port_output_node_b.to_graphviz() == " output" + + +class _NodeAdd(ExecutionNode): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.description = "Perform the addition of the two input port values." + + self.add_input_port("a") + self.add_input_port("b") + self.add_output_port("output") + + def process(self): + a = self.get_input("a") + b = self.get_input("b") + + if a is None or b is None: + return + + self.set_output("output", a + b) + + self.dirty = False + + +class _NodeMultiply(ExecutionNode): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.description = "Perform the multiplication of the two input port values." + + self.add_input_port("a") + self.add_input_port("b") + self.add_output_port("output") + + def process(self): + a = self.get_input("a") + b = self.get_input("b") + + if a is None or b is None: + return + + self.set_output("output", a * b) + + self.dirty = False + + +class TestPortNode: + """ + Define :class:`colour.utilities.network.PortNode` class unit tests methods. + """ + + def setup_method(self): + """Initialise the common tests attributes.""" + + self._add_node_1 = _NodeAdd("Node Add 1") + self._multiply_node_1 = _NodeMultiply("Node Multiply 1") + self._add_node_2 = _NodeAdd("Node Add 2") + + self._nodes = [self._add_node_1, self._multiply_node_1, self._add_node_2] + + def test_required_attributes(self): + """Test the presence of required attributes.""" + + required_attributes = ( + "input_ports", + "output_ports", + "dirty", + "edges", + "description", + ) + + for attribute in required_attributes: + assert attribute in dir(PortNode) + + def test_required_methods(self): + """Test the presence of required methods.""" + + required_methods = ( + "__init__", + "add_input_port", + "remove_input_port", + "add_output_port", + "remove_output_port", + "get_input", + "set_input", + "get_output", + "set_output", + "connect", + "disconnect", + "process", + "to_graphviz", + ) + + for method in required_methods: + assert method in dir(PortNode) + + def test_input_ports(self): + """Test :attr:`colour.utilities.network.PortNode.input_ports` property.""" + + for name in ("a", "b"): + assert name in self._add_node_1.input_ports + assert name in self._multiply_node_1.input_ports + assert name in self._add_node_2.input_ports + + def test_output_ports(self): + """Test :attr:`colour.utilities.network.PortNode.output_ports` property.""" + + for name in ("output",): + assert name in self._add_node_1.output_ports + assert name in self._multiply_node_1.output_ports + assert name in self._add_node_2.output_ports + + def test_dirty(self): + """Test :attr:`colour.utilities.network.PortNode.dirty` property.""" + + assert self._add_node_1.dirty is True + assert self._multiply_node_1.dirty is True + assert self._add_node_2.dirty is True + + self._add_node_1.process() + self._multiply_node_1.process() + self._add_node_2.process() + + assert self._add_node_1.dirty is True + assert self._multiply_node_1.dirty is True + assert self._add_node_2.dirty is True + + self._add_node_1.set_input("a", 1) + self._add_node_1.set_input("b", 1) + self._multiply_node_1.set_input("a", 1) + self._multiply_node_1.set_input("b", 1) + self._add_node_2.set_input("a", 1) + self._add_node_2.set_input("b", 1) + + self._add_node_1.process() + self._multiply_node_1.process() + self._add_node_2.process() + + assert self._add_node_1.dirty is False + assert self._multiply_node_1.dirty is False + assert self._add_node_2.dirty is False + + self._add_node_1.set_input("a", None) + self._add_node_1.set_input("b", None) + self._multiply_node_1.set_input("a", None) + self._multiply_node_1.set_input("b", None) + self._add_node_2.set_input("a", None) + self._add_node_2.set_input("b", None) + + assert self._add_node_1.dirty is True + assert self._multiply_node_1.dirty is True + assert self._add_node_2.dirty is True + + def test_edges(self): + """Test :attr:`colour.utilities.network.PortNode.edges` property.""" + + assert self._add_node_1.edges == ({}, {}) + assert self._multiply_node_1.edges == ({}, {}) + assert self._add_node_2.edges == ({}, {}) + + self._add_node_1.connect("output", self._multiply_node_1, "a") + self._multiply_node_1.connect("output", self._add_node_2, "a") + + assert self._add_node_1.edges == ( + {}, + { + ( + self._add_node_1.output_ports["output"], + self._multiply_node_1.input_ports["a"], + ): None, + }, + ) + assert self._multiply_node_1.edges == ( + { + ( + self._multiply_node_1.input_ports["a"], + self._add_node_1.output_ports["output"], + ): None, + }, + { + ( + self._multiply_node_1.output_ports["output"], + self._add_node_2.input_ports["a"], + ): None, + }, + ) + assert self._add_node_2.edges == ( + { + ( + self._add_node_2.input_ports["a"], + self._multiply_node_1.output_ports["output"], + ): None, + }, + {}, + ) + + self._add_node_1.disconnect("output", self._multiply_node_1, "a") + self._multiply_node_1.disconnect("output", self._add_node_2, "a") + + assert self._add_node_1.edges == ({}, {}) + assert self._multiply_node_1.edges == ({}, {}) + assert self._add_node_2.edges == ({}, {}) + + def test_description(self): + """Test :attr:`colour.utilities.network.PortNode.description` property.""" + + assert ( + self._add_node_1.description + == "Perform the addition of the two input port values." + ) + assert ( + self._multiply_node_1.description + == "Perform the multiplication of the two input port values." + ) + assert ( + self._add_node_2.description + == "Perform the addition of the two input port values." + ) + + def test_add_input_port(self): + """Test :meth:`colour.utilities.network.PortNode.add_input_port` method.""" + + node = PortNode() + node.add_input_port("a", 1, 'Input Port "a"') + + assert node.input_ports["a"].value == 1 + assert node.input_ports["a"].description == 'Input Port "a"' + + def test_remove_input_port(self): + """Test :meth:`colour.utilities.network.PortNode.remove_input_port` method.""" + + node = PortNode() + node.add_input_port("a", 1, 'Input Port "a"') + node.remove_input_port("a") + + assert len(node.input_ports) == 0 + + def test_add_output_port(self): + """Test :meth:`colour.utilities.network.PortNode.add_output_port` method.""" + + node = PortNode() + node.add_output_port("output", 1, 'Output Port "output"') + + assert node.output_ports["output"].value == 1 + assert node.output_ports["output"].description == 'Output Port "output"' + + def test_remove_output_port(self): + """Test :meth:`colour.utilities.network.PortNode.remove_output_port` method.""" + + node = PortNode() + node.add_output_port("output", 1, 'Output Port "output"') + node.remove_output_port("output") + + assert len(node.input_ports) == 0 + + def test_get_input(self): + """Test :meth:`colour.utilities.network.PortNode.get_input` method.""" + + node = PortNode() + node.add_input_port("a", 1, 'Input Port "a"') + + assert node.get_input("a") == 1 + + def test_set_input(self): + """Test :meth:`colour.utilities.network.PortNode.set_input` method.""" + + node = PortNode() + node.add_input_port("a", 1, 'Input Port "a"') + + assert node.input_ports["a"].value == 1 + + node.set_input("a", 2) + + assert node.input_ports["a"].value == 2 + + def test_get_output(self): + """Test :meth:`colour.utilities.network.PortNode.get_output` method.""" + + node = PortNode() + node.add_output_port("output", 1, 'Output Port "output"') + + assert node.get_output("output") == 1 + + def test_set_output(self): + """Test :meth:`colour.utilities.network.PortNode.set_output` method.""" + + node = PortNode() + node.add_output_port("output", 1, 'Output Port "output"') + + assert node.output_ports["output"].value == 1 + + node.set_output("output", 2) + + assert node.output_ports["output"].value == 2 + + def test_connect(self): + """Test :meth:`colour.utilities.network.PortNode.connect` method.""" + + self.test_edges() + + def test_disconnect(self): + """Test :meth:`colour.utilities.network.PortNode.disconnect` method.""" + + self.test_edges() + + def test_process(self): + """Test :meth:`colour.utilities.network.PortNode.process` method.""" + + self._add_node_1.connect("output", self._multiply_node_1, "a") + self._multiply_node_1.connect("output", self._add_node_2, "a") + + self._add_node_1.set_input("a", 1) + self._add_node_1.set_input("b", 1) + self._multiply_node_1.set_input("b", 2) + self._add_node_2.set_input("b", 1) + + assert self._add_node_2.get_output("output") is None + + self._add_node_1.process() + self._multiply_node_1.process() + self._add_node_2.process() + + assert self._add_node_2.get_output("output") == 5 + + self._add_node_1.disconnect("output", self._multiply_node_1, "a") + self._multiply_node_1.disconnect("output", self._add_node_2, "a") + + def test_to_graphviz(self): + """Test :meth:`colour.utilities.network.PortNode.to_graphviz` method.""" + + assert ( + re.sub(r"\(#\d+\)", "(#)", self._add_node_1.to_graphviz()) + == "Node Add 1 (#) | {{ execution_input| " + "a| b} | { execution_output| output}}" + ) + assert ( + re.sub(r"\(#\d+\)", "(#)", self._multiply_node_1.to_graphviz()) + == "Node Multiply 1 (#) | {{ execution_input| " + "a| b} | { execution_output| output}}" + ) + assert ( + re.sub(r"\(#\d+\)", "(#)", self._add_node_2.to_graphviz()) + == "Node Add 2 (#) | {{ execution_input| " + "a| b} | { execution_output| output}}" + ) + + +class TestPortGraph: + """ + Define :class:`colour.utilities.network.PortGraph` class unit tests methods. + """ + + def setup_method(self): + """Initialise the common tests attributes.""" + + self._add_node_1 = _NodeAdd("Node Add 1") + self._multiply_node_1 = _NodeMultiply("Node Multiply 1") + self._add_node_2 = _NodeAdd("Node Add 2") + + self._add_node_1.connect("output", self._multiply_node_1, "a") + self._multiply_node_1.connect("output", self._add_node_2, "a") + + self._add_node_1.set_input("a", 1) + self._add_node_1.set_input("b", 1) + self._multiply_node_1.set_input("b", 2) + self._add_node_2.set_input("b", 1) + + self._nodes = { + self._add_node_1.name: self._add_node_1, + self._multiply_node_1.name: self._multiply_node_1, + self._add_node_2.name: self._add_node_2, + } + + self._graph = PortGraph("Port Graph") + + for node in self._nodes.values(): + self._graph.add_node(node) + + def test_required_attributes(self): + """Test the presence of required attributes.""" + + required_attributes = ("nodes",) + + for attribute in required_attributes: + assert attribute in dir(PortGraph) + + def test_required_methods(self): + """Test the presence of required methods.""" + + required_methods = ( + "__init__", + "__str__", + "add_node", + "remove_node", + "walk_ports", + "process", + "to_graphviz", + ) + + for method in required_methods: + assert method in dir(PortGraph) + + def test_nodes(self): + """Test :attr:`colour.utilities.network.PortGraph.nodes` property.""" + + assert self._graph.nodes == self._nodes + + def test___str__(self): + """Test :meth:`colour.utilities.network.PortGraph.__str__` method.""" + + assert str(self._graph) == "PortGraph(3)" + + def test_add_node(self): + """Test :meth:`colour.utilities.network.PortGraph.add_node` method.""" + + for node in self._nodes.values(): + self._graph.remove_node(node) + + assert len(self._graph.nodes) == 0 + + for node in self._nodes.values(): + self._graph.add_node(node) + + assert len(self._graph.nodes) == 3 + + def test_remove_node(self): + """Test :meth:`colour.utilities.network.PortGraph.remove_node` method.""" + + self.test_add_node() + + def test_walk_ports(self): + """Test :meth:`colour.utilities.network.PortGraph.walk_ports` method.""" + + assert list(self._graph.walk_ports()) == list(self._nodes.values()) + + def test_process(self): + """Test :meth:`colour.utilities.network.PortGraph.process` method.""" + + self._graph.process() + + assert self._add_node_2.get_output("output") == 5 + + def test_to_graphviz(self): + """Test :meth:`colour.utilities.network.PortGraph.to_graphviz` method.""" + + if not is_pydot_installed(): + return + + import pydot + + assert isinstance(self._graph.to_graphviz(), pydot.Dot) + + +class _AddItem(ExecutionNode): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.description = "Add the item with input key and value to the input mapping." + + self.add_input_port("key") + self.add_input_port("value") + self.add_input_port("mapping", {}) + + def process(self): + """ + Process the node. + """ + + key = self.get_input("key") + value = self.get_input("value") + + if key is None or value is None: + return + + self.get_input("mapping")[key] = value + + self.dirty = False + + +class _NodeSumMappingValues(ExecutionNode): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.description = "Sum the input mapping values." + + self.add_input_port("mapping", {}) + self.add_output_port("summation") + + def process(self): + mapping = self.get_input("mapping") + if len(mapping) == 0: + return + + self.set_output("summation", np.sum(list(mapping.values()))) + + self.dirty = False + + +class _SubGraph1(ExecutionNode, PortGraph): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.add_input_port("input") + self.add_output_port("output", {}) + + for node in [ + _NodeAdd("Add 1"), + _NodeMultiply("Multiply 1"), + _NodeAdd("Add 2"), + _AddItem("Add Item"), + ]: + self.add_node(node) + + for connection in [ + ( + ("Add 1", "output"), + ("Multiply 1", "a"), + ), + ( + ("Add 1", "execution_output"), + ("Multiply 1", "execution_input"), + ), + ( + ("Multiply 1", "output"), + ("Add 2", "a"), + ), + ( + ("Multiply 1", "execution_output"), + ("Add 2", "execution_input"), + ), + ( + ("Add 2", "execution_output"), + ("Add Item", "execution_input"), + ), + ( + ("Add 2", "output"), + ("Add Item", "value"), + ), + ]: + (input_node, input_port), (output_node, output_port) = connection + self.nodes[input_node].connect( + input_port, + self.nodes[output_node], + output_port, + ) + + self.connect("input", self.nodes["Add 1"], "b") + self.connect("input", self.nodes["Add Item"], "key") + self.nodes["Add Item"].connect("mapping", self, "output") + + def process(self, **kwargs) -> None: + self.nodes["Add 1"].set_input("a", 1) + self.nodes["Multiply 1"].set_input("b", 2) + self.nodes["Add 2"].set_input("b", 3) + + super().process(**kwargs) + + +class TestFor: + """ + Define :class:`colour.utilities.network.For` class unit tests methods. + """ + + def test_For(self): + """Test :class:`colour.utilities.network.For` class.""" + + sum_mapping_values = _NodeSumMappingValues() + + sub_graph = _SubGraph1() + sub_graph.connect("output", sum_mapping_values, "mapping") + + loop = For() + loop.connect("loop_output", sub_graph, "execution_input") + loop.connect("index", sub_graph, "input") + loop.connect("execution_output", sum_mapping_values, "execution_input") + loop.set_input("array", [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]) + loop.process() + + assert sum_mapping_values.get_output("summation") == 140 + + +class _NodeSumArray(ExecutionNode): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.description = "Sum the input array." + + self.add_input_port("array", []) + self.add_output_port("summation") + + def process(self): + array = self.get_input("array") + if len(array) == 0: + return + + self.set_output("summation", np.sum(array)) + + self.dirty = False + + +class _SubGraph2(ExecutionNode, PortGraph): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.add_input_port("input") + self.add_output_port("output") + + for node in [ + _NodeAdd("Add 1"), + _NodeMultiply("Multiply 1"), + _NodeAdd("Add 2"), + ]: + self.add_node(node) + + for connection in [ + ( + ("Add 1", "output"), + ("Multiply 1", "a"), + ), + ( + ("Add 1", "execution_output"), + ("Multiply 1", "execution_input"), + ), + ( + ("Multiply 1", "output"), + ("Add 2", "a"), + ), + ( + ("Multiply 1", "execution_output"), + ("Add 2", "execution_input"), + ), + ]: + (input_node, input_port), (output_node, output_port) = connection + self.nodes[input_node].connect( + input_port, + self.nodes[output_node], + output_port, + ) + + self.connect("input", self.nodes["Add 1"], "b") + self.nodes["Add 2"].connect("output", self, "output") + + def process(self, **kwargs) -> None: + self.nodes["Add 1"].set_input("a", 1) + self.nodes["Multiply 1"].set_input("b", 2) + self.nodes["Add 2"].set_input("b", 3) + + super().process(**kwargs) + + +class TestParallelForThread: + """ + Define :class:`colour.utilities.network.ParallelForThread` class unit tests + methods. + """ + + def test_ParallelForThread(self): + """Test :class:`colour.utilities.network.ParallelForThread` class.""" + + sum_array = _NodeSumArray() + + sub_graph = _SubGraph2() + + loop = ParallelForThread() + loop.connect("loop_output", sub_graph, "execution_input") + loop.connect("index", sub_graph, "input") + loop.connect("execution_output", sum_array, "execution_input") + loop.set_input("array", [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]) + loop.connect("results", sum_array, "array") + loop.process() + + assert sum_array.get_output("summation") == 140 + + +class TestParallelForMultiProcess: + """ + Define :class:`colour.utilities.network.ParallelForMultiProcess` class unit + tests methods. + """ + + def test_ParallelForMultiProcess(self): + """Test :class:`colour.utilities.network.ParallelForMultiProcess` class.""" + + sum_array = _NodeSumArray() + + sub_graph = _SubGraph2() + + loop = ParallelForMultiprocess() + loop.connect("loop_output", sub_graph, "execution_input") + loop.connect("index", sub_graph, "input") + loop.connect("execution_output", sum_array, "execution_input") + loop.set_input("array", [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]) + loop.connect("results", sum_array, "array") + loop.process() + + assert sum_array.get_output("summation") == 140 diff --git a/colour/utilities/tests/test_structures.py b/colour/utilities/tests/test_structures.py new file mode 100644 index 0000000000..463c559be8 --- /dev/null +++ b/colour/utilities/tests/test_structures.py @@ -0,0 +1,508 @@ +"""Define the unit tests for the :mod:`colour.utilities.structures` module.""" + +import operator +import pickle + +import numpy as np +import pytest + +from colour.utilities import ( + CanonicalMapping, + ColourUsageWarning, + LazyCanonicalMapping, + Lookup, + Structure, +) + +__author__ = "Colour Developers" +__copyright__ = "Copyright 2013 Colour Developers" +__license__ = "BSD-3-Clause - https://opensource.org/licenses/BSD-3-Clause" +__maintainer__ = "Colour Developers" +__email__ = "colour-developers@colour-science.org" +__status__ = "Production" + +__all__ = [ + "TestStructure", + "TestLookup", + "TestCanonicalMapping", + "TestLazyCanonicalMapping", +] + + +class TestStructure: + """ + Define :class:`colour.utilities.structures.Structure` class unit + tests methods. + """ + + def test_Structure(self): + """Test :class:`colour.utilities.structures.Structure` class.""" + + structure = Structure(John="Doe", Jane="Doe") + assert "John" in structure + assert hasattr(structure, "John") + + structure.John = "Nemo" + assert structure["John"] == "Nemo" + + structure["John"] = "Vador" + assert structure["John"] == "Vador" + + del structure["John"] + assert "John" not in structure + assert not hasattr(structure, "John") + + structure.John = "Doe" + assert "John" in structure + assert hasattr(structure, "John") + + del structure.John + assert "John" not in structure + assert not hasattr(structure, "John") + + structure = Structure(John=None, Jane=None) + assert structure.John is None + assert structure["John"] is None + + structure.update(**{"John": "Doe", "Jane": "Doe"}) + assert structure.John == "Doe" + assert structure["John"] == "Doe" + + def test_pickling(self): + """ + Test whether :class:`colour.utilities.structures.Structure` class + can be pickled. + """ + + structure = Structure(John="Doe", Jane="Doe") + + data = pickle.dumps(structure) + data = pickle.loads(data) # noqa: S301 + assert structure == data + + data = pickle.dumps(structure, pickle.HIGHEST_PROTOCOL) + data = pickle.loads(data) # noqa: S301 + assert structure == data + + assert sorted(dir(data)) == ["Jane", "John"] + + +class TestLookup: + """ + Define :class:`colour.utilities.structures.Lookup` class unit tests + methods. + """ + + def test_required_methods(self): + """Test the presence of required methods.""" + + required_methods = ("keys_from_value", "first_key_from_value") + + for method in required_methods: + assert method in dir(Lookup) + + def test_keys_from_value(self): + """ + Test :meth:`colour.utilities.structures.Lookup.keys_from_value` + method. + """ + + lookup = Lookup(John="Doe", Jane="Doe", Luke="Skywalker") + assert ["Jane", "John"] == sorted(lookup.keys_from_value("Doe")) + + lookup = Lookup( + A=np.array([0, 1, 2]), B=np.array([0, 1, 2]), C=np.array([1, 2, 3]) + ) + assert ["A", "B"] == sorted(lookup.keys_from_value(np.array([0, 1, 2]))) + + def test_first_key_from_value(self): + """ + Test :meth:`colour.utilities.structures.\ +Lookup.first_key_from_value` method. + """ + + lookup = Lookup(first_name="John", last_name="Doe", gender="male") + assert lookup.first_key_from_value("John") == "first_name" + + lookup = Lookup( + A=np.array([0, 1, 2]), B=np.array([1, 2, 3]), C=np.array([2, 3, 4]) + ) + assert lookup.first_key_from_value(np.array([0, 1, 2])) == "A" + + def test_raise_exception_first_key_from_value(self): + """ + Test :meth:`colour.utilities.structures.\ +Lookup.first_key_from_value` method raised exception. + """ + + pytest.raises(IndexError, Lookup().first_key_from_value, "John") + + +class TestCanonicalMapping: + """ + Define :class:`colour.utilities.structures.CanonicalMapping` class + unit tests methods. + """ + + def test_required_attributes(self): + """Test the presence of required attributes.""" + + required_attributes = ("data",) + + for attribute in required_attributes: + assert attribute in dir(CanonicalMapping) + + def test_required_methods(self): + """Test the presence of required methods.""" + + required_methods = ( + "__init__", + "__repr__", + "__setitem__", + "__getitem__", + "__delitem__", + "__contains__", + "__iter__", + "__len__", + "__eq__", + "__ne__", + "copy", + "lower_keys", + "lower_items", + "slugified_keys", + "slugified_items", + "canonical_keys", + "canonical_items", + ) + + for method in required_methods: + assert method in dir(CanonicalMapping) + + def test_data(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.data` + property. + """ + + assert CanonicalMapping({"John": "Doe", "Jane": "Doe"}).data == { + "John": "Doe", + "Jane": "Doe", + } + + def test__repr__(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.__repr__` + method. + """ + + mapping = CanonicalMapping() + + mapping["John"] = "Doe" + assert repr(mapping) == "CanonicalMapping({'John': 'Doe'})" + + def test__setitem__(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.\ +__setitem__` method. + """ + + mapping = CanonicalMapping() + + mapping["John"] = "Doe" + assert mapping["John"] == "Doe" + assert mapping["john"] == "Doe" + + def test__getitem__(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.\ +__getitem__` method. + """ + + mapping = CanonicalMapping(John="Doe", Jane="Doe") + + assert mapping["John"] == "Doe" + assert mapping["john"] == "Doe" + assert mapping["JOHN"] == "Doe" + assert mapping["Jane"] == "Doe" + assert mapping["jane"] == "Doe" + assert mapping["JANE"] == "Doe" + + mapping = CanonicalMapping({1: "Foo", 2: "Bar"}) + + assert mapping[1] == "Foo" + + mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) + + assert mapping["mccamy-1992"] == 1 + assert mapping["hernandez-1999"] == 2 + assert mapping["mccamy1992"] == 1 + assert mapping["hernandez1999"] == 2 + + def test__delitem__(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.\ +__delitem__` method. + """ + + mapping = CanonicalMapping(John="Doe", Jane="Doe") + + del mapping["john"] + assert "John" not in mapping + + del mapping["Jane"] + assert "jane" not in mapping + assert len(mapping) == 0 + + mapping = CanonicalMapping(John="Doe", Jane="Doe") + del mapping["JOHN"] + assert "John" not in mapping + + del mapping["jane"] + assert "jane" not in mapping + assert len(mapping) == 0 + + mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) + + del mapping["mccamy-1992"] + assert "McCamy 1992" not in mapping + + del mapping["hernandez-1999"] + assert "Hernandez 1999" not in mapping + + assert len(mapping) == 0 + + mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) + + del mapping["mccamy1992"] + assert "McCamy 1992" not in mapping + + del mapping["hernandez1999"] + assert "Hernandez 1999" not in mapping + + assert len(mapping) == 0 + + def test__contains__(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.\ +__contains__` method. + """ + + mapping = CanonicalMapping(John="Doe", Jane="Doe") + + assert "John" in mapping + assert "john" in mapping + assert "JOHN" in mapping + assert "Jane" in mapping + assert "jane" in mapping + assert "JANE" in mapping + + mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) + + assert "mccamy-1992" in mapping + assert "hernandez-1999" in mapping + assert "mccamy1992" in mapping + assert "hernandez1999" in mapping + + def test__iter__(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.__iter__` + method. + """ + + mapping = CanonicalMapping(John="Doe", Jane="Doe") + assert sorted(item for item in mapping) == ["Jane", "John"] + + def test__len__(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.__len__` + method. + """ + + assert len(CanonicalMapping()) == 0 + + assert len(CanonicalMapping(John="Doe", Jane="Doe")) == 2 + + def test__eq__(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.__eq__` + method. + """ + + mapping1 = CanonicalMapping(John="Doe", Jane="Doe") + mapping2 = CanonicalMapping(John="Doe", Jane="Doe") + mapping3 = CanonicalMapping(john="Doe", jane="Doe") + + assert mapping1 == mapping2 + + assert mapping2 != mapping3 + + def test_raise_exception__eq__(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.__eq__` + method raised exception. + """ + + pytest.raises( + TypeError, + operator.eq, + CanonicalMapping(John="Doe", Jane="Doe"), + ["John", "Doe", "Jane", "Doe"], + ) + + def test__ne__(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.__ne__` + method. + """ + + mapping1 = CanonicalMapping(John="Doe", Jane="Doe") + mapping2 = CanonicalMapping(Gi="Doe", Jane="Doe") + + assert mapping1 != mapping2 + + def test_raise_exception__ne__(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.__ne__` + method raised exception. + """ + + pytest.raises( + TypeError, + operator.ne, + CanonicalMapping(John="Doe", Jane="Doe"), + ["John", "Doe", "Jane", "Doe"], + ) + + def test_copy(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.copy` + method. + """ + + mapping1 = CanonicalMapping(John="Doe", Jane="Doe") + mapping2 = mapping1.copy() + + assert mapping1 == mapping2 + + assert id(mapping1) != id(mapping2) + + def test_lower_keys(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.\ +lower_keys` method. + """ + + mapping = CanonicalMapping(John="Doe", Jane="Doe") + + assert sorted(item for item in mapping.lower_keys()) == ["jane", "john"] + + mapping = CanonicalMapping(John="Doe", john="Doe") + + pytest.warns(ColourUsageWarning, lambda: list(mapping.lower_keys())) + + def test_lower_items(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.\ +lower_items` method. + """ + + mapping = CanonicalMapping(John="Doe", Jane="Doe") + + assert sorted(item for item in mapping.lower_items()) == [ + ("jane", "Doe"), + ("john", "Doe"), + ] + + def test_slugified_keys(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.\ +slugified_keys` method. + """ + + mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) + + assert sorted(item for item in mapping.slugified_keys()) == [ + "hernandez-1999", + "mccamy-1992", + ] + + mapping = CanonicalMapping({"McCamy 1992": 1, "McCamy-1992": 2}) + + pytest.warns(ColourUsageWarning, lambda: list(mapping.slugified_keys())) + + def test_slugified_items(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.\ +slugified_items` method. + """ + + mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) + assert sorted(item for item in mapping.slugified_items()) == [ + ("hernandez-1999", 2), + ("mccamy-1992", 1), + ] + + def test_canonical_keys(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.\ +canonical_keys` method. + """ + + mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) + + assert sorted(item for item in mapping.canonical_keys()) == [ + "hernandez1999", + "mccamy1992", + ] + + mapping = CanonicalMapping({"McCamy_1992": 1, "McCamy-1992": 2}) + + pytest.warns(ColourUsageWarning, lambda: list(mapping.canonical_keys())) + + def test_canonical_items(self): + """ + Test :meth:`colour.utilities.structures.CanonicalMapping.\ +canonical_items` method. + """ + + mapping = CanonicalMapping({"McCamy 1992": 1, "Hernandez 1999": 2}) + assert sorted(item for item in mapping.canonical_items()) == [ + ("hernandez1999", 2), + ("mccamy1992", 1), + ] + + +class TestLazyCanonicalMapping: + """ + Define :class:`colour.utilities.structures.LazyCanonicalMapping` class + unit tests methods. + """ + + def test_required_attributes(self): + """Test the presence of required attributes.""" + + required_attributes = () + + for attribute in required_attributes: # pragma: no cover + assert attribute in dir(LazyCanonicalMapping) + + def test_required_methods(self): + """Test the presence of required methods.""" + + required_methods = ("__getitem__",) + + for method in required_methods: + assert method in dir(LazyCanonicalMapping) + + def test__getitem__(self): + """ + Test :meth:`colour.utilities.structures.LazyCanonicalMapping.\ +__getitem__` method. + """ + + mapping = LazyCanonicalMapping(John="Doe", Jane=lambda: "Doe") + + assert mapping["John"] == "Doe" + assert mapping["john"] == "Doe" + assert mapping["Jane"] == "Doe" + assert mapping["jane"] == "Doe" diff --git a/colour/utilities/tests/test_verbose.py b/colour/utilities/tests/test_verbose.py index 3c39d5ed51..c3df4269e8 100644 --- a/colour/utilities/tests/test_verbose.py +++ b/colour/utilities/tests/test_verbose.py @@ -1,13 +1,13 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.utilities.verbose` module.""" import os import sys import textwrap -import unittest from colour.hints import Optional from colour.utilities import ( + MixinLogging, + as_bool, describe_environment, multiline_repr, multiline_str, @@ -25,7 +25,9 @@ __status__ = "Production" __all__ = [ + "TestMixinLogging", "TestShowWarning", + "TestAsBool", "TestSuppressWarnings", "TestSuppressStdout", "TestDescribeEnvironment", @@ -34,7 +36,22 @@ ] -class TestShowWarning(unittest.TestCase): +class TestMixinLogging: + """ + Define :class:`colour.utilities.verbose.MixinLogging` class unit tests + methods. + """ + + def test_required_methods(self): + """Test the presence of required methods.""" + + required_methods = ("log",) + + for method in required_methods: + assert method in dir(MixinLogging) + + +class TestShowWarning: """ Define :func:`colour.utilities.verbose.show_warning` definition unit tests methods. @@ -46,9 +63,7 @@ def test_show_warning(self): show_warning("This is a unit test warning!", Warning, None, None) with open(os.devnull) as dev_null: - show_warning( - "This is a unit test warning!", Warning, None, None, dev_null - ) + show_warning("This is a unit test warning!", Warning, None, None, dev_null) stderr = sys.stderr try: @@ -58,7 +73,31 @@ def test_show_warning(self): sys.stderr = stderr -class TestSuppressWarnings(unittest.TestCase): +class TestAsBool: + """ + Define :func:`colour.utilities.common.as_bool` definition unit tests + methods. + """ + + def test_as_bool(self): + """Test :func:`colour.utilities.common.as_bool` definition.""" + + assert as_bool("1") + + assert as_bool("On") + + assert as_bool("True") + + assert not as_bool("0") + + assert not as_bool("Off") + + assert not as_bool("False") + + assert not as_bool("") + + +class TestSuppressWarnings: """ Define :func:`colour.utilities.verbose.suppress_warnings` definition unit tests methods. @@ -71,7 +110,7 @@ def test_suppress_warnings(self): warning("This is a suppressed unit test warning!") -class TestSuppressStdout(unittest.TestCase): +class TestSuppressStdout: """ Define :func:`colour.utilities.verbose.suppress_stdout` definition unit tests methods. @@ -84,7 +123,7 @@ def test_suppress_stdout(self): print("This is a suppressed message!") # noqa: T201 -class TestDescribeEnvironment(unittest.TestCase): +class TestDescribeEnvironment: """ Define :func:`colour.utilities.verbose.describe_environment` definition unit tests methods. @@ -94,34 +133,34 @@ def test_describe_environment(self): """Test :func:`colour.utilities.verbose.describe_environment` definition.""" environment = describe_environment() - self.assertIsInstance(environment, dict) - self.assertListEqual( - sorted(environment.keys()), - ["Interpreter", "Runtime", "colour-science.org"], - ) + assert isinstance(environment, dict) + assert sorted(environment.keys()) == [ + "Interpreter", + "Runtime", + "colour-science.org", + ] environment = describe_environment(development_packages=True) - self.assertListEqual( - sorted(environment.keys()), - ["Development", "Interpreter", "Runtime", "colour-science.org"], - ) + assert sorted(environment.keys()) == [ + "Development", + "Interpreter", + "Runtime", + "colour-science.org", + ] environment = describe_environment( development_packages=True, extras_packages=True ) - self.assertListEqual( - sorted(environment.keys()), - [ - "Development", - "Extras", - "Interpreter", - "Runtime", - "colour-science.org", - ], - ) + assert sorted(environment.keys()) == [ + "Development", + "Extras", + "Interpreter", + "Runtime", + "colour-science.org", + ] -class TestMultilineStr(unittest.TestCase): +class TestMultilineStr: """ Define :func:`colour.utilities.verbose.multiline_str` definition unit tests methods. @@ -164,8 +203,7 @@ def __str__(self) -> str: ], ) - self.assertEqual( - str(Data("Foo", 1, ["John", "Doe"])), + assert str(Data("Foo", 1, ["John", "Doe"])) == ( textwrap.dedent( """ Object - Data @@ -186,11 +224,11 @@ def __str__(self) -> str: ---- List "c" : John; Doe """ - ).strip(), + ).strip() ) -class TestMultilineRepr(unittest.TestCase): +class TestMultilineRepr: """ Define :func:`colour.utilities.verbose.multiline_repr` definition unit tests methods. @@ -227,8 +265,7 @@ def __repr__(self) -> str: ], ) - self.assertEqual( - repr(Data("Foo", 1, ["John", "Doe"])), + assert repr(Data("Foo", 1, ["John", "Doe"])) == ( textwrap.dedent( """ Data('Foo', @@ -236,9 +273,5 @@ def __repr__(self) -> str: ('John', 'Doe'), None) """ - ).strip(), + ).strip() ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/utilities/verbose.py b/colour/utilities/verbose.py index ce1eff1d10..e518d14a5d 100644 --- a/colour/utilities/verbose.py +++ b/colour/utilities/verbose.py @@ -2,12 +2,13 @@ Verbose ======= -Defines the verbose related objects. +Define the verbose related objects. """ from __future__ import annotations import functools +import logging import os import sys import traceback @@ -23,16 +24,17 @@ from colour.hints import ( Any, Callable, + ClassVar, Dict, Generator, List, + Literal, LiteralWarning, Mapping, TextIO, Type, cast, ) -from colour.utilities import is_string, optional __author__ = "Colour Developers" __copyright__ = "Copyright 2013 Colour Developers" @@ -42,6 +44,8 @@ __status__ = "Production" __all__ = [ + "LOGGER", + "MixinLogging", "ColourWarning", "ColourUsageWarning", "ColourRuntimeWarning", @@ -51,6 +55,7 @@ "runtime_warning", "usage_warning", "filter_warnings", + "as_bool", "suppress_warnings", "suppress_stdout", "numpy_print_options", @@ -63,6 +68,58 @@ "multiline_repr", ] +LOGGER = logging.getLogger(__name__) + + +class MixinLogging: + """ + A mixin providing a convenient logging method. + + Attributes + ---------- + - :func:`~colour.utilities.MixinLogging.MAPPING_LOGGING_LEVEL_TO_CALLABLE` + + Methods + ------- + - :func:`~colour.utilities.MixinLogging.log` + """ + + MAPPING_LOGGING_LEVEL_TO_CALLABLE: ClassVar = { # pyright: ignore + "critical": LOGGER.critical, + "error": LOGGER.error, + "warning": LOGGER.warning, + "info": LOGGER.info, + "debug": LOGGER.debug, + } + + def log( + self, + message: str, + verbosity: Literal[ + "critical", + "error", + "warning", + "info", + "debug", + ] = "info", + ) -> None: + """ + Log given message using given verbosity level. + + Parameters + ---------- + message + Message to log. + verbosity + Verbosity level. + """ + + self.MAPPING_LOGGING_LEVEL_TO_CALLABLE[verbosity]( # pyright: ignore + "%s: %s", + self.name, # pyright: ignore + message, + ) + class ColourWarning(Warning): """ @@ -210,7 +267,7 @@ def show_warning( frame_range = (1, None) - file = optional(file, sys.stderr) + file = file if file is None else sys.stderr if file is None: return @@ -316,7 +373,7 @@ def filter_warnings( """ Filter *Colour* and also optionally overall Python warnings. - The possible values for all the actions, i.e. each argument, are as + The possible values for all the actions, i.e., each argument, are as follows: - *None* (No action is taken) @@ -341,7 +398,7 @@ def filter_warnings( Whether to filter *Colour* warnings, this also filters *Colour* usage and runtime warnings according to the action value. python_warnings - Whether to filter *Python* warnings according to the action value. + Whether to filter *Python* warnings according to the action value. Examples -------- @@ -383,7 +440,7 @@ def filter_warnings( if action is None: continue - if is_string(action): + if isinstance(action, str): action = cast(LiteralWarning, str(action)) # noqa: PLW2901 else: action = "ignore" if action else "default" # noqa: PLW2901 @@ -391,8 +448,74 @@ def filter_warnings( filterwarnings(action, category=category) +def as_bool(a: str) -> bool: + """ + Convert given string to bool. + + The following string values evaluate to *True*: "1", "On", and "True". + + Parameters + ---------- + a + String to convert to bool. + + Returns + ------- + :class:`bool` + Whether the given string is *True*. + + Examples + -------- + >>> as_bool("1") + True + >>> as_bool("On") + True + >>> as_bool("True") + True + >>> as_bool("0") + False + >>> as_bool("Off") + False + >>> as_bool("False") + False + """ + + return a.lower() in ["1", "on", "true"] + + # Defaulting to filter *Colour* runtime warnings. -filter_warnings(colour_runtime_warnings=True) +filter_warnings( + colour_runtime_warnings=as_bool( + os.environ.get("COLOUR_SCIENCE__FILTER_RUNTIME_WARNINGS", "True") + ) +) + +if ( + os.environ.get("COLOUR_SCIENCE__FILTER_USAGE_WARNINGS") is not None +): # pragma: no cover + filter_warnings( + colour_usage_warnings=as_bool( + os.environ["COLOUR_SCIENCE__FILTER_USAGE_WARNINGS"] + ) + ) + +if ( + os.environ.get("COLOUR_SCIENCE__FILTER_COLOUR_WARNINGS") is not None +): # pragma: no cover + filter_warnings( + colour_usage_warnings=as_bool( + os.environ["COLOUR_SCIENCE__FILTER_WARNINGS"], + ) + ) + +if ( + os.environ.get("COLOUR_SCIENCE__FILTER_PYTHON_WARNINGS") is not None +): # pragma: no cover + filter_warnings( + colour_usage_warnings=as_bool( + os.environ["COLOUR_SCIENCE__FILTER_PYTHON_WARNINGS"] + ) + ) @contextmanager @@ -406,7 +529,7 @@ def suppress_warnings( Define a context manager filtering *Colour* and also optionally overall Python warnings. - The possible values for all the actions, i.e. each argument, are as + The possible values for all the actions, i.e., each argument, are as follows: - *None* (No action is taken) @@ -460,7 +583,6 @@ class suppress_stdout: -------- >>> with suppress_stdout(): ... print("Hello World!") - ... >>> print("Hello World!") Hello World! """ @@ -479,7 +601,7 @@ def __exit__(self, *args: Any): sys.stdout.close() sys.stdout = self._stdout - def __call__(self, function: Callable) -> Callable: + def __call__(self, function: Callable) -> Callable: # pragma: no cover """Call the wrapped definition.""" @functools.wraps(function) @@ -557,7 +679,7 @@ def describe_environment( **kwargs: Any, ) -> defaultdict: """ - Describe *Colour* running environment, i.e. interpreter, runtime and + Describe *Colour* running environment, i.e., interpreter, runtime and development packages. Parameters @@ -594,21 +716,25 @@ def describe_environment( =========================================================================== * * * Interpreter : * - * python : 3.8.6 (default, Nov 20 2020, 18:29:40) * - * [Clang 12.0.0 (clang-1200.0.32.27)] * + * python : 3.12.4 (main, Jun 6 2024, 18:26:44) [Clang 15.0.0 * + * (clang-1500.3.9.4)] * * * * colour-science.org : * - * colour : v0.3.16-3-gd8bac475 * + * colour : v0.4.3-282-gcb450ff50 * * * * Runtime : * - * imageio : 2.9.0 * - * matplotlib : 3.3.3 * - * networkx : 2.5 * - * numpy : 1.19.4 * - * pandas : 0.25.3 * - * pygraphviz : 1.6 * - * scipy : 1.5.4 * - * tqdm : 4.54.0 * + * imageio : 2.35.1 * + * matplotlib : 3.9.2 * + * networkx : 3.3 * + * numpy : 2.1.1 * + * pandas : 2.2.3 * + * pydot : 3.0.2 * + * PyOpenColorIO : 2.3.2 * + * scipy : 1.14.1 * + * tqdm : 4.66.5 * + * trimesh : 4.4.9 * + * OpenImageIO : 2.5.14.0 * + * xxhash : 3.5.0 * * * =========================================================================== >>> environment = describe_environment(True, True, True, width=75) @@ -616,44 +742,44 @@ def describe_environment( =========================================================================== * * * Interpreter : * - * python : 3.8.6 (default, Nov 20 2020, 18:29:40) * - * [Clang 12.0.0 (clang-1200.0.32.27)] * + * python : 3.12.4 (main, Jun 6 2024, 18:26:44) [Clang 15.0.0 * + * (clang-1500.3.9.4)] * * * * colour-science.org : * - * colour : v0.3.16-3-gd8bac475 * + * colour : v0.4.3-282-gcb450ff50 * * * * Runtime : * - * imageio : 2.9.0 * - * matplotlib : 3.3.3 * - * networkx : 2.5 * - * numpy : 1.19.4 * - * pandas : 0.25.3 * - * pygraphviz : 1.6 * - * scipy : 1.5.4 * - * tqdm : 4.54.0 * + * imageio : 2.35.1 * + * matplotlib : 3.9.2 * + * networkx : 3.3 * + * numpy : 2.1.1 * + * pandas : 2.2.3 * + * pydot : 3.0.2 * + * PyOpenColorIO : 2.3.2 * + * scipy : 1.14.1 * + * tqdm : 4.66.5 * + * trimesh : 4.4.9 * + * OpenImageIO : 2.5.14.0 * + * xxhash : 3.5.0 * * * * Development : * - * biblib-simple : 0.1.1 * - * coverage : 5.3 * - * coveralls : 2.2.0 * - * flake8 : 3.8.4 * - * invoke : 1.4.1 * - * jupyter : 1.0.0 * - * mock : 4.0.2 * - * nose : 1.3.7 * - * pre-commit : 2.1.1 * - * pytest : 6.1.2 * - * restructuredtext-lint : 1.3.2 * - * sphinx : 3.1.2 * - * sphinx_rtd_theme : 0.5.0 * - * sphinxcontrib-bibtex : 1.0.0 * + * biblib-simple : 0.1.2 * + * coverage : 6.5.0 * + * coveralls : 4.0.1 * + * invoke : 2.2.0 * + * pre-commit : 3.8.0 * + * pydata-sphinx-theme : 0.15.4 * + * pyright : 1.1.382.post1 * + * pytest : 8.3.3 * + * pytest-cov : 5.0.0 * + * restructuredtext-lint : 1.4.0 * + * sphinxcontrib-bibtex : 2.6.3 * * toml : 0.10.2 * - * twine : 3.2.0 * - * yapf : 0.23.0 * + * twine : 5.1.1 * * * * Extras : * - * ipywidgets : 7.5.1 * - * notebook : 6.1.5 * + * ipywidgets : 8.1.5 * + * notebook : 7.2.2 * * * =========================================================================== """ @@ -690,7 +816,7 @@ def describe_environment( "networkx", "numpy", "pandas", - "pygraphviz", + "pydot", "PyOpenColorIO", "scipy", "tqdm", @@ -732,6 +858,9 @@ def _get_package_version(package: str, mapping: Mapping) -> str: mapping = { "biblib.bib": "biblib-simple", "pre_commit": "pre-commit", + "pydata_sphinx_theme": "pydata-sphinx-theme", + "pytest_cov": "pytest-cov", + "pytest_xdist": "pytest-xdist", "restructuredtext_lint": "restructuredtext-lint", "sphinxcontrib.bibtex": "sphinxcontrib-bibtex", } @@ -739,20 +868,18 @@ def _get_package_version(package: str, mapping: Mapping) -> str: "biblib.bib", "coverage", "coveralls", - "flake8", "invoke", "jupyter", - "mock", - "nose", "pre_commit", + "pydata_sphinx_theme", + "pyright", "pytest", + "pytest_cov", + "pytest_xdist", "restructuredtext_lint", - "sphinx", - "sphinx_rtd_theme", "sphinxcontrib.bibtex", "toml", "twine", - "yapf", ]: try: version = _get_package_version(package, mapping) @@ -795,7 +922,7 @@ def _get_package_version(package: str, mapping: Mapping) -> str: lines = value.split("\n") message += f" {key} : {lines.pop(0)}\n" indentation = len(f" {key} : ") - for line in lines: + for line in lines: # pragma: no cover message += f"{' ' * indentation}{line}\n" message += "\n" @@ -868,7 +995,6 @@ def multiline_str( ... }, ... ], ... ) - ... >>> print(Data("Foo", 1, ["John", "Doe"])) Object - Data ============= @@ -908,7 +1034,7 @@ def multiline_str( and not attribute.get("section") ) ) - except ValueError: + except ValueError: # pragma: no cover justify = 0 representation = [] @@ -917,9 +1043,7 @@ def multiline_str( if not attribute["line_break"]: if attribute["name"] is not None: - formatted = attribute["formatter"]( - getattr(object_, attribute["name"]) - ) + formatted = attribute["formatter"](getattr(object_, attribute["name"])) else: formatted = attribute["formatter"](None) @@ -931,9 +1055,7 @@ def multiline_str( lines = formatted.splitlines() if len(lines) > 1: for i, line in enumerate(lines[1:]): - lines[ - i + 1 - ] = f"{'':{justify}}{' ' * len(separator)}{line}" + lines[i + 1] = f"{'':{justify}}{' ' * len(separator)}{line}" formatted = "\n".join(lines) representation.append( @@ -947,14 +1069,10 @@ def multiline_str( representation.append(f"{formatted}") if attribute["header"]: - representation.append( - header_underline * len(representation[-1]) - ) + representation.append(header_underline * len(representation[-1])) if attribute["section"]: - representation.append( - section_underline * len(representation[-1]) - ) + representation.append(section_underline * len(representation[-1])) else: representation.append("") @@ -1005,7 +1123,6 @@ def multiline_repr( ... }, ... ], ... ) - ... >>> Data("Foo", 1, ["John", "Doe"]) Data('Foo', 1, diff --git a/colour/volume/datasets/optimal_colour_stimuli.py b/colour/volume/datasets/optimal_colour_stimuli.py index c44c84a3e1..2ad48c063a 100644 --- a/colour/volume/datasets/optimal_colour_stimuli.py +++ b/colour/volume/datasets/optimal_colour_stimuli.py @@ -2,7 +2,7 @@ Optimal Colour Stimuli ====================== -Defines the *MacAdam Optimal Colour Stimuli* for various illuminants in +Define the *MacAdam Optimal Colour Stimuli* for various illuminants in *CIE xyY* colourspace. The *Optimal Colour Stimuli* data is in the form of a *dict* of diff --git a/colour/volume/macadam_limits.py b/colour/volume/macadam_limits.py index e081ac5918..14dbd2652b 100644 --- a/colour/volume/macadam_limits.py +++ b/colour/volume/macadam_limits.py @@ -2,7 +2,7 @@ Optimal Colour Stimuli - MacAdam Limits ======================================= -Defines the objects related to *Optimal Colour Stimuli* computations. +Define the objects related to *Optimal Colour Stimuli* computations. """ from __future__ import annotations @@ -35,15 +35,13 @@ f"{__name__}._CACHE_OPTIMAL_COLOUR_STIMULI_XYZ" ) -_CACHE_OPTIMAL_COLOUR_STIMULI_XYZ_TRIANGULATIONS: dict = ( - CACHE_REGISTRY.register_cache( - f"{__name__}._CACHE_OPTIMAL_COLOUR_STIMULI_XYZ_TRIANGULATIONS" - ) +_CACHE_OPTIMAL_COLOUR_STIMULI_XYZ_TRIANGULATIONS: dict = CACHE_REGISTRY.register_cache( + f"{__name__}._CACHE_OPTIMAL_COLOUR_STIMULI_XYZ_TRIANGULATIONS" ) def _XYZ_optimal_colour_stimuli( - illuminant: Literal["A", "C", "D65"] | str = "D65" + illuminant: Literal["A", "C", "D65"] | str = "D65", ) -> NDArrayFloat: """ Return given illuminant *Optimal Colour Stimuli* in *CIE XYZ* tristimulus @@ -121,14 +119,12 @@ def is_within_macadam_limits( """ optimal_colour_stimuli = _XYZ_optimal_colour_stimuli(illuminant) - triangulation = _CACHE_OPTIMAL_COLOUR_STIMULI_XYZ_TRIANGULATIONS.get( - illuminant - ) + triangulation = _CACHE_OPTIMAL_COLOUR_STIMULI_XYZ_TRIANGULATIONS.get(illuminant) if triangulation is None: - _CACHE_OPTIMAL_COLOUR_STIMULI_XYZ_TRIANGULATIONS[ - illuminant - ] = triangulation = Delaunay(optimal_colour_stimuli) + _CACHE_OPTIMAL_COLOUR_STIMULI_XYZ_TRIANGULATIONS[illuminant] = ( + triangulation + ) = Delaunay(optimal_colour_stimuli) simplex = triangulation.find_simplex(xyY_to_XYZ(xyY), tol=tolerance) simplex = np.where(simplex >= 0, True, False) diff --git a/colour/volume/mesh.py b/colour/volume/mesh.py index 9eed2f0b92..cec91bb723 100644 --- a/colour/volume/mesh.py +++ b/colour/volume/mesh.py @@ -2,7 +2,7 @@ Mesh Volume Computation Helpers =============================== -Defines the helpers objects related to volume computations. +Define the helpers objects related to volume computations. """ from __future__ import annotations diff --git a/colour/volume/pointer_gamut.py b/colour/volume/pointer_gamut.py index b0216f615b..504168ce11 100644 --- a/colour/volume/pointer_gamut.py +++ b/colour/volume/pointer_gamut.py @@ -2,18 +2,18 @@ Pointer's Gamut Volume Computations =================================== -Defines the objects related to *Pointer's Gamut* volume computations. +Define the objects related to *Pointer's Gamut* volume computations. """ from __future__ import annotations from colour.constants import EPSILON from colour.hints import ArrayLike, NDArrayFloat +from colour.models import LCHab_to_Lab # pyright: ignore from colour.models import ( CCS_ILLUMINANT_POINTER_GAMUT, DATA_POINTER_GAMUT_VOLUME, Lab_to_XYZ, - LCHab_to_Lab, ) from colour.volume import is_within_mesh_volume diff --git a/colour/volume/rgb.py b/colour/volume/rgb.py index 68e70e635c..59a01f718b 100644 --- a/colour/volume/rgb.py +++ b/colour/volume/rgb.py @@ -2,7 +2,7 @@ RGB Colourspace Volume Computation ================================== -Defines various RGB colourspace volume computation objects: +Define various RGB colourspace volume computation objects: - :func:`colour.RGB_colourspace_limits` - :func:`colour.RGB_colourspace_volume_MonteCarlo` @@ -66,7 +66,7 @@ def _wrapper_RGB_colourspace_volume_MonteCarlo(arguments: tuple) -> int: Returns ------- :class:`int` - Inside *RGB* colourspace volume samples count. + Inside *RGB* colourspace volume sample count. """ return sample_RGB_colourspace_volume_MonteCarlo(*arguments) @@ -76,12 +76,12 @@ def sample_RGB_colourspace_volume_MonteCarlo( colourspace: RGB_Colourspace, samples: int = 1000000, limits: ArrayLike = np.array([[0, 100], [-150, 150], [-150, 150]]), - illuminant_Lab: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", + illuminant_Lab: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", random_generator: Callable = random_triplet_generator, random_state: np.random.RandomState | None = None, ) -> int: @@ -94,7 +94,7 @@ def sample_RGB_colourspace_volume_MonteCarlo( colourspace *RGB* colourspace to compute the volume of. samples - Samples count. + Sample count. limits *CIE L\\*a\\*b\\** colourspace volume. illuminant_Lab @@ -111,7 +111,7 @@ def sample_RGB_colourspace_volume_MonteCarlo( Returns ------- :class:`int` - Within *RGB* colourspace volume samples count. + Within *RGB* colourspace volume sample count. Notes ----- @@ -133,9 +133,7 @@ def sample_RGB_colourspace_volume_MonteCarlo( 9... """ - random_state = ( - random_state if random_state is not None else np.random.RandomState() - ) + random_state = random_state if random_state is not None else np.random.RandomState() Lab = random_generator(DTYPE_INT_DEFAULT(samples), limits, random_state) RGB = XYZ_to_RGB( @@ -144,9 +142,7 @@ def sample_RGB_colourspace_volume_MonteCarlo( illuminant_Lab, chromatic_adaptation_transform, ) - RGB_w = RGB[ - np.logical_and(np.min(RGB, axis=-1) >= 0, np.max(RGB, axis=-1) <= 1) - ] + RGB_w = RGB[np.logical_and(np.min(RGB, axis=-1) >= 0, np.max(RGB, axis=-1) <= 1)] return len(RGB_w) @@ -204,12 +200,12 @@ def RGB_colourspace_volume_MonteCarlo( colourspace: RGB_Colourspace, samples: int = 1000000, limits: ArrayLike = np.array([[0, 100], [-150, 150], [-150, 150]]), - illuminant_Lab: ArrayLike = CCS_ILLUMINANTS[ - "CIE 1931 2 Degree Standard Observer" - ]["D65"], - chromatic_adaptation_transform: LiteralChromaticAdaptationTransform - | str - | None = "CAT02", + illuminant_Lab: ArrayLike = CCS_ILLUMINANTS["CIE 1931 2 Degree Standard Observer"][ + "D65" + ], + chromatic_adaptation_transform: ( + LiteralChromaticAdaptationTransform | str | None + ) = "CAT02", random_generator: Callable = random_triplet_generator, random_state: np.random.RandomState | None = None, ) -> float: @@ -222,7 +218,7 @@ def RGB_colourspace_volume_MonteCarlo( colourspace\ *RGB* colourspace to compute the volume of. samples\ - Samples count. + Sample count. limits\ *CIE L\\*a\\*b\\** colourspace volume. illuminant_Lab\ @@ -307,7 +303,7 @@ def RGB_colourspace_volume_coverage_MonteCarlo( coverage_sampler Python object responsible for checking the volume coverage. samples - Samples count. + Sample count. random_generator Random triplet generator providing the random samples. random_state @@ -330,20 +326,14 @@ def RGB_colourspace_volume_coverage_MonteCarlo( 81... """ - random_state = ( - random_state if random_state is not None else np.random.RandomState() - ) + random_state = random_state if random_state is not None else np.random.RandomState() - XYZ = random_generator( - DTYPE_INT_DEFAULT(samples), random_state=random_state - ) + XYZ = random_generator(DTYPE_INT_DEFAULT(samples), random_state=random_state) XYZ_vs = XYZ[coverage_sampler(XYZ)] RGB = XYZ_to_RGB(XYZ_vs, colourspace) - RGB_c = RGB[ - np.logical_and(np.min(RGB, axis=-1) >= 0, np.max(RGB, axis=-1) <= 1) - ] + RGB_c = RGB[np.logical_and(np.min(RGB, axis=-1) >= 0, np.max(RGB, axis=-1) <= 1)] return 100 * RGB_c.size / XYZ_vs.size @@ -363,7 +353,7 @@ def RGB_colourspace_pointer_gamut_coverage_MonteCarlo( colourspace *RGB* colourspace to compute the *Pointer's Gamut* coverage percentage. samples - Samples count. + Sample count. random_generator Random triplet generator providing the random samples. random_state @@ -409,7 +399,7 @@ def RGB_colourspace_visible_spectrum_coverage_MonteCarlo( colourspace *RGB* colourspace to compute the visible spectrum coverage percentage. samples - Samples count. + Sample count. random_generator Random triplet generator providing the random samples. random_state diff --git a/colour/volume/spectrum.py b/colour/volume/spectrum.py index 2e4ac4cd06..d02420f609 100644 --- a/colour/volume/spectrum.py +++ b/colour/volume/spectrum.py @@ -2,7 +2,7 @@ Rösch-MacAdam colour solid - Visible Spectrum Volume Computations ================================================================= -Defines the objects related to *Rösch-MacAdam* colour solid, visible spectrum +Define the objects related to *Rösch-MacAdam* colour solid, visible spectrum volume computations. References @@ -218,9 +218,9 @@ def generate_pulse_waves( ) square_waves = [] - square_waves_basis = np.tril( - np.ones((bins, bins), dtype=DTYPE_FLOAT_DEFAULT) - )[0:-1, :] + square_waves_basis = np.tril(np.ones((bins, bins), dtype=DTYPE_FLOAT_DEFAULT))[ + 0:-1, : + ] if pulse_order.lower() == "bins": for square_wave_basis in square_waves_basis: @@ -251,7 +251,7 @@ def XYZ_outer_surface( **kwargs: Any, ) -> NDArrayFloat: """ - Generate the *Rösch-MacAdam* colour solid, i.e. *CIE XYZ* colourspace + Generate the *Rösch-MacAdam* colour solid, i.e., *CIE XYZ* colourspace outer surface, for given colour matching functions using multi-spectral conversion of pulse waves to *CIE XYZ* tristimulus values. @@ -364,16 +364,14 @@ def XYZ_outer_surface( ) XYZ = _CACHE_OUTER_SURFACE_XYZ.get(key) - if is_caching_enabled() and XYZ is not None: + if is_caching_enabled() and XYZ is not None: # pragma: no cover return XYZ pulse_waves = generate_pulse_waves( len(cmfs.wavelengths), point_order, filter_jagged_points ) XYZ = ( - msds_to_XYZ( - pulse_waves, cmfs, illuminant, method="Integration", **settings - ) + msds_to_XYZ(pulse_waves, cmfs, illuminant, method="Integration", **settings) / 100 ) @@ -394,7 +392,7 @@ def is_within_visible_spectrum( ) -> NDArrayFloat: """ Return whether given *CIE XYZ* tristimulus values are within the visible - spectrum volume, i.e. *Rösch-MacAdam* colour solid, for given colour + spectrum volume, i.e., *Rösch-MacAdam* colour solid, for given colour matching functions and illuminant. Parameters @@ -419,7 +417,7 @@ def is_within_visible_spectrum( ------- :class:`numpy.ndarray` Are *CIE XYZ* tristimulus values within the visible spectrum volume, - i.e. *Rösch-MacAdam* colour solid. + i.e., *Rösch-MacAdam* colour solid. Notes ----- diff --git a/colour/volume/tests/test_macadam_limits.py b/colour/volume/tests/test_macadam_limits.py index 346beff718..eb4fbefcf5 100644 --- a/colour/volume/tests/test_macadam_limits.py +++ b/colour/volume/tests/test_macadam_limits.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.volume.macadam_limits` module.""" -import unittest from itertools import product import numpy as np @@ -21,7 +19,7 @@ ] -class TestIsWithinMacadamLimits(unittest.TestCase): +class TestIsWithinMacadamLimits: """ Define :func:`colour.volume.macadam_limits.is_within_macadam_limits` definition unit tests methods. @@ -33,21 +31,13 @@ def test_is_within_macadam_limits(self): definition. """ - self.assertTrue( - is_within_macadam_limits(np.array([0.3205, 0.4131, 0.5100]), "A") - ) + assert is_within_macadam_limits(np.array([0.3205, 0.4131, 0.5100]), "A") - self.assertFalse( - is_within_macadam_limits(np.array([0.0005, 0.0031, 0.0010]), "A") - ) + assert not is_within_macadam_limits(np.array([0.0005, 0.0031, 0.0010]), "A") - self.assertTrue( - is_within_macadam_limits(np.array([0.4325, 0.3788, 0.1034]), "C") - ) + assert is_within_macadam_limits(np.array([0.4325, 0.3788, 0.1034]), "C") - self.assertFalse( - is_within_macadam_limits(np.array([0.0025, 0.0088, 0.0340]), "C") - ) + assert not is_within_macadam_limits(np.array([0.0025, 0.0088, 0.0340]), "C") def test_n_dimensional_is_within_macadam_limits(self): """ @@ -76,7 +66,3 @@ def test_nan_is_within_macadam_limits(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) is_within_macadam_limits(cases, "A") - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/volume/tests/test_mesh.py b/colour/volume/tests/test_mesh.py index 8f9a45a422..c28c900554 100644 --- a/colour/volume/tests/test_mesh.py +++ b/colour/volume/tests/test_mesh.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.volume.mesh` module.""" -import unittest from itertools import product import numpy as np @@ -22,13 +20,13 @@ ] -class TestIsWithinMeshVolume(unittest.TestCase): +class TestIsWithinMeshVolume: """ Define :func:`colour.volume.mesh.is_within_mesh_volume` definition unit tests methods. """ - def setUp(self): + def setup_method(self): """Initialise the common tests attributes.""" self._mesh = np.array( @@ -44,29 +42,13 @@ def setUp(self): def test_is_within_mesh_volume(self): """Test :func:`colour.volume.mesh.is_within_mesh_volume` definition.""" - self.assertTrue( - is_within_mesh_volume( - np.array([0.0005, 0.0031, 0.0010]), self._mesh - ) - ) + assert is_within_mesh_volume(np.array([0.0005, 0.0031, 0.0010]), self._mesh) - self.assertFalse( - is_within_mesh_volume( - np.array([0.3205, 0.4131, 0.5100]), self._mesh - ) - ) + assert not is_within_mesh_volume(np.array([0.3205, 0.4131, 0.5100]), self._mesh) - self.assertTrue( - is_within_mesh_volume( - np.array([0.0025, 0.0088, 0.0340]), self._mesh - ) - ) + assert is_within_mesh_volume(np.array([0.0025, 0.0088, 0.0340]), self._mesh) - self.assertFalse( - is_within_mesh_volume( - np.array([0.4325, 0.3788, 0.1034]), self._mesh - ) - ) + assert not is_within_mesh_volume(np.array([0.4325, 0.3788, 0.1034]), self._mesh) def test_n_dimensional_is_within_mesh_volume(self): """ @@ -103,7 +85,3 @@ def test_nan_is_within_mesh_volume(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) is_within_mesh_volume(cases, self._mesh) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/volume/tests/test_pointer_gamut.py b/colour/volume/tests/test_pointer_gamut.py index 01fd3d3c50..f9e4be108b 100644 --- a/colour/volume/tests/test_pointer_gamut.py +++ b/colour/volume/tests/test_pointer_gamut.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.volume.pointer_gamut` module.""" -import unittest from itertools import product import numpy as np @@ -21,7 +19,7 @@ ] -class TestIsWithinPointerGamut(unittest.TestCase): +class TestIsWithinPointerGamut: """ Define :func:`colour.volume.pointer_gamut.is_within_pointer_gamut` definition unit tests methods. @@ -33,21 +31,13 @@ def test_is_within_pointer_gamut(self): definition. """ - self.assertTrue( - is_within_pointer_gamut(np.array([0.3205, 0.4131, 0.5100])) - ) + assert is_within_pointer_gamut(np.array([0.3205, 0.4131, 0.5100])) - self.assertFalse( - is_within_pointer_gamut(np.array([0.0005, 0.0031, 0.0010])) - ) + assert not is_within_pointer_gamut(np.array([0.0005, 0.0031, 0.0010])) - self.assertTrue( - is_within_pointer_gamut(np.array([0.4325, 0.3788, 0.1034])) - ) + assert is_within_pointer_gamut(np.array([0.4325, 0.3788, 0.1034])) - self.assertFalse( - is_within_pointer_gamut(np.array([0.0025, 0.0088, 0.0340])) - ) + assert not is_within_pointer_gamut(np.array([0.0025, 0.0088, 0.0340])) def test_n_dimensional_is_within_pointer_gamut(self): """ @@ -76,7 +66,3 @@ def test_nan_is_within_pointer_gamut(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) is_within_pointer_gamut(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/volume/tests/test_rgb.py b/colour/volume/tests/test_rgb.py index bac97a1923..d92949b544 100644 --- a/colour/volume/tests/test_rgb.py +++ b/colour/volume/tests/test_rgb.py @@ -18,7 +18,6 @@ reproducibility-of-python-pseudo-random-numbers-across-systems-and-versions """ -import unittest import numpy as np @@ -54,7 +53,7 @@ ] -class TestRGB_colourspaceLimits(unittest.TestCase): +class TestRGB_colourspaceLimits: """ Define :func:`colour.volume.rgb.RGB_colourspace_limits` definition unit tests methods. @@ -100,7 +99,7 @@ def test_RGB_colourspace_limits(self): ) -class TestRGB_colourspaceVolumeMonteCarlo(unittest.TestCase): +class TestRGB_colourspaceVolumeMonteCarlo: """ Define :func:`colour.volume.rgb.RGB_colourspace_volume_MonteCarlo` definition unit tests methods. @@ -129,7 +128,7 @@ def test_RGB_colourspace_volume_MonteCarlo(self): ) -class TestRGB_colourspace_volume_coverage_MonteCarlo(unittest.TestCase): +class TestRGB_colourspace_volume_coverage_MonteCarlo: """ Define :func:`colour.volume.rgb.\ RGB_colourspace_volume_coverage_MonteCarlo` definition unit tests methods. @@ -157,7 +156,7 @@ def test_RGB_colourspace_volume_coverage_MonteCarlo(self): ) -class TestRGB_colourspacePointerGamutCoverageMonteCarlo(unittest.TestCase): +class TestRGB_colourspacePointerGamutCoverageMonteCarlo: """ Define :func:`colour.volume.rgb.\ RGB_colourspace_pointer_gamut_coverage_MonteCarlo` definition unit tests @@ -185,7 +184,7 @@ def test_RGB_colourspace_pointer_gamut_coverage_MonteCarlo(self): ) -class TestRGB_colourspaceVisibleSpectrumCoverageMonteCarlo(unittest.TestCase): +class TestRGB_colourspaceVisibleSpectrumCoverageMonteCarlo: """ Define :func:`colour.volume.rgb.\ RGB_colourspace_visible_spectrum_coverage_MonteCarlo` definition unit tests @@ -211,7 +210,3 @@ def test_RGB_colourspace_visible_spectrum_coverage_MonteCarlo(self): 46.931407942238266, atol=TOLERANCE_ABSOLUTE_TESTS, ) - - -if __name__ == "__main__": - unittest.main() diff --git a/colour/volume/tests/test_spectrum.py b/colour/volume/tests/test_spectrum.py index fa6db65298..ad967148a2 100644 --- a/colour/volume/tests/test_spectrum.py +++ b/colour/volume/tests/test_spectrum.py @@ -1,7 +1,5 @@ -# !/usr/bin/env python """Define the unit tests for the :mod:`colour.volume.spectrum` module.""" -import unittest from itertools import product import numpy as np @@ -34,7 +32,7 @@ ] -class TestGeneratePulseWaves(unittest.TestCase): +class TestGeneratePulseWaves: """ Define :func:`colour.volume.spectrum.generate_pulse_waves` definition unit tests methods. @@ -132,7 +130,7 @@ def test_generate_pulse_waves(self): ) -class TestXYZOuterSurface(unittest.TestCase): +class TestXYZOuterSurface: """ Define :func:`colour.volume.spectrum.XYZ_outer_surface` definition unit tests methods. @@ -191,7 +189,7 @@ def test_XYZ_outer_surface(self): ) -class TestIsWithinVisibleSpectrum(unittest.TestCase): +class TestIsWithinVisibleSpectrum: """ Define :func:`colour.volume.spectrum.is_within_visible_spectrum` definition unit tests methods. @@ -203,21 +201,13 @@ def test_is_within_visible_spectrum(self): definition. """ - self.assertTrue( - is_within_visible_spectrum(np.array([0.3205, 0.4131, 0.5100])) - ) + assert is_within_visible_spectrum(np.array([0.3205, 0.4131, 0.5100])) - self.assertFalse( - is_within_visible_spectrum(np.array([-0.0005, 0.0031, 0.0010])) - ) + assert not is_within_visible_spectrum(np.array([-0.0005, 0.0031, 0.0010])) - self.assertTrue( - is_within_visible_spectrum(np.array([0.4325, 0.3788, 0.1034])) - ) + assert is_within_visible_spectrum(np.array([0.4325, 0.3788, 0.1034])) - self.assertFalse( - is_within_visible_spectrum(np.array([0.0025, 0.0088, 0.0340])) - ) + assert not is_within_visible_spectrum(np.array([0.0025, 0.0088, 0.0340])) def test_n_dimensional_is_within_visible_spectrum(self): """ @@ -246,7 +236,3 @@ def test_nan_is_within_visible_spectrum(self): cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] cases = np.array(list(set(product(cases, repeat=3)))) is_within_visible_spectrum(cases) - - -if __name__ == "__main__": - unittest.main() diff --git a/docs/advanced.rst b/docs/advanced.rst index 597d686a7a..d4f3e59f01 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -1,5 +1,5 @@ -Advanced Concepts -================= +Advanced Usage +============== This page describes some advanced usage scenarios of **Colour**. @@ -18,8 +18,8 @@ runtime: `float64` (default). Changing the float dtype might result in various **Colour** `functionality breaking entirely `__. *With great power comes great responsibility*. -- ``COLOUR_SCIENCE__COLOUR__DISABLE_CACHING``: Disable the caches that can - be disabled, useful for debugging purposes. +- ``COLOUR_SCIENCE__DISABLE_CACHING``: Disable the caches that can be + disabled, useful for debugging purposes. - ``COLOUR_SCIENCE__COLOUR__IMPORT_VAAB_COLOUR``: Import `vaab/colour `__ injection into **Colour** namespace. This solves the clash with @@ -29,6 +29,25 @@ runtime: :func:`warnings.showwarning` definition to be replaced with the :func:`colour.utilities.show_warning` definition and thus providing complete traceback from the point where the warning occurred. +- ``COLOUR_SCIENCE__FILTER_RUNTIME_WARNINGS``: Filter *Colour* runtime + warnings. +- ``COLOUR_SCIENCE__FILTER_USAGE_WARNINGS``: Filter *Colour* usage warnings. +- ``COLOUR_SCIENCE__FILTER_COLOUR_WARNINGS``: Filter *Colour* warnings, this + also filters *Colour* usage and runtime warnings. +- ``COLOUR_SCIENCE__FILTER_PYTHON_WARNINGS``: Filter *Python* warnings. + +JEnv File +--------- + +**Colour** will also read the ``~/.colour-science/colour-science.jenv`` JSON +file if it exists. The syntax is that of a mapping of environment variable and +values as follows: + +.. code-block:: json + + { + "COLOUR_SCIENCE__COLOUR__SHOW_WARNINGS_WITH_TRACEBACK": "True" + } Caching ------- diff --git a/docs/basics.rst b/docs/basics.rst index 99d936f4b3..f398088e33 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -1,5 +1,5 @@ -Basic Concepts -============== +Basic Usage +=========== This page puts an emphasis on basic concepts of **Colour**, those are important to understand. @@ -300,10 +300,10 @@ setting the values of the data. Getting the value(s) for a single (or multiple wavelengths) is done by indexing the :class:`colour.SpectralDistribution` (or :class:`colour.MultiSpectralDistributions`) class with the a single numeric -or array of numeric wavelengths, e.g. ``sd[555.5]`` or +or array of numeric wavelengths, e.g., ``sd[555.5]`` or ``sd[555.25, 555.25, 555.75]``. -However, if getting the values using a :class:`slice` class instance, e.g. +However, if getting the values using a :class:`slice` class instance, e.g., ``sd[0:3]``, the underlying discrete values for the indexes represented by the :class:`slice` class instance are returned instead. @@ -360,7 +360,7 @@ However, slices will return the values for the corresponding wavelength Indexing a multi-spectral distribution is achieved similarly, it can however be sliced along multiple axes because the data is2-dimensional, - e.g. `msds[0:3, 0:2]`. + e.g., `msds[0:3, 0:2]`. A *copy* of the underlying :class:`colour.SpectralDistribution` and :class:`colour.MultiSpectralDistributions` classes discretized data can be @@ -443,11 +443,11 @@ Scale - Reference ~~~~~~~~~~~~~~~~~ **'Reference'** is the default domain-range scale of **Colour**, objects adopt -the implemented reference, i.e. paper, publication, etc.., domain-range scale. +the implemented reference, i.e., paper, publication, etc.., domain-range scale. -The **'Reference'** domain-range scale is inconsistent, e.g. colour appearance +The **'Reference'** domain-range scale is inconsistent, e.g., colour appearance models, spectral conversions are typically in domain-range ``[0, 100]`` while RGB -models will operate in domain-range ``[0, 1]``. Some objects, e.g. +models will operate in domain-range ``[0, 1]``. Some objects, e.g., :func:``colour.colorimetry.lightness_Fairchild2011`` definition have mismatched domain-range: input domain ``[0, 1]`` and output range ``[0, 100]``. @@ -470,8 +470,8 @@ Scale - 1 The conversion to **'1'** domain-range scale is a *soft* normalisation and similarly to the **'Reference'** domain-range scale it is normal to - encounter values exceeding *1*, e.g. High Dynamic Range Imagery (HDRI) or - negative values, e.g. out-of-gamut RGB colourspace values. Some definitions + encounter values exceeding *1*, e.g., High Dynamic Range Imagery (HDRI) or + negative values, e.g., out-of-gamut RGB colourspace values. Some definitions such as :func:`colour.models.eotf_ST2084` which decodes absolute luminance values are not affected by any domain-range scales and are indicated with `UN`. @@ -574,7 +574,7 @@ Setting the **'1'** domain-range scale has the following effect on the :func:`colour.adaptation.chromatic_adaptation_CIE1994` definition: As it expects values in domain ``[0, 100]``, scaling occurs and the -relevant input values, i.e. the values listed in the domain table, ``XYZ_1`` +relevant input values, i.e., the values listed in the domain table, ``XYZ_1`` and ``Y_o`` are converted from domain ``[0, 1]`` to domain ``[0, 100]`` by :func:`colour.utilities.to_domain_100` definition and conversely return value ``XYZ_2`` is converted from range ``[0, 100]`` to range ``[0, 1]`` diff --git a/docs/colour.adaptation.rst b/docs/colour.adaptation.rst index 03a7b093d8..7f73a5a05a 100644 --- a/docs/colour.adaptation.rst +++ b/docs/colour.adaptation.rst @@ -36,6 +36,20 @@ Fairchild (1990) chromatic_adaptation_Fairchild1990 +Fairchild (2020) +---------------- + +``colour.adaptation`` + +.. currentmodule:: colour.adaptation + +.. autosummary:: + :toctree: generated/ + + CONDITIONS_DEGREE_OF_ADAPTATION_VK20 + matrix_chromatic_adaptation_vk20 + chromatic_adaptation_vK20 + CIE 1994 -------- diff --git a/docs/colour.algebra.rst b/docs/colour.algebra.rst index efb949f413..85a9d5e9f3 100644 --- a/docs/colour.algebra.rst +++ b/docs/colour.algebra.rst @@ -125,8 +125,7 @@ Common spow normalise_vector normalise_maximum - vector_dot - matrix_dot + vecmul euclidean_distance manhattan_distance linear_conversion diff --git a/docs/colour.constants.rst b/docs/colour.constants.rst index 83cc16df06..6f09a5127d 100644 --- a/docs/colour.constants.rst +++ b/docs/colour.constants.rst @@ -39,8 +39,8 @@ Common .. autosummary:: :toctree: generated/ - FLOATING_POINT_NUMBER_PATTERN - INTEGER_THRESHOLD + PATTERN_FLOATING_POINT_NUMBER + THRESHOLD_INTEGER EPSILON DTYPE_INT_DEFAULT DTYPE_FLOAT_DEFAULT diff --git a/docs/colour.hints.rst b/docs/colour.hints.rst index deed025bf8..500b8f5072 100644 --- a/docs/colour.hints.rst +++ b/docs/colour.hints.rst @@ -25,6 +25,7 @@ Annotation Type Hints Optional Protocol Sequence + Set SupportsIndex TYPE_CHECKING TextIO diff --git a/docs/colour.io.rst b/docs/colour.io.rst index 333c7dd1d1..85eb3edfb8 100644 --- a/docs/colour.io.rst +++ b/docs/colour.io.rst @@ -1,8 +1,8 @@ -Input and Output -================ +Input and Output (IO) +===================== -Image Data ----------- +Image IO +-------- ``colour`` @@ -25,7 +25,9 @@ Image Data .. autosummary:: :toctree: generated/ - ImageAttribute_Specification + Image_Specification_Attribute + MAPPING_BIT_DEPTH + image_specification_OpenImageIO convert_bit_depth read_image_OpenImageIO write_image_OpenImageIO @@ -33,6 +35,33 @@ Image Data write_image_Imageio as_3_channels_image +Spectral Image - Fichet et al. (2021) +===================================== + +``colour`` + +.. currentmodule:: colour + +.. autosummary:: + :toctree: generated/ + + Specification_Fichet2021 + read_spectral_image_Fichet2021 + write_spectral_image_Fichet2021 + +**Ancillary Objects** + +``colour.io`` + +.. currentmodule:: colour.io + +.. autosummary:: + :toctree: generated/ + + ComponentsFichet2021 + sd_to_spectrum_attribute_Fichet2021 + spectrum_attribute_to_sd_Fichet2021 + OpenColorIO Processing ---------------------- diff --git a/docs/colour.models.rst b/docs/colour.models.rst index f6374fe47a..5d8437a43e 100644 --- a/docs/colour.models.rst +++ b/docs/colour.models.rst @@ -54,8 +54,6 @@ CIE L*a*b* Colourspace XYZ_to_Lab Lab_to_XYZ - Lab_to_LCHab - LCHab_to_Lab CIE L*u*v* Colourspace ---------------------- @@ -69,12 +67,12 @@ CIE L*u*v* Colourspace XYZ_to_Luv Luv_to_XYZ - Luv_to_LCHuv - LCHuv_to_Luv Luv_to_uv uv_to_Luv Luv_uv_to_xy xy_to_Luv_uv + XYZ_to_CIE1976UCS + CIE1976UCS_to_XYZ CIE 1960 UCS Colourspace ------------------------ @@ -92,6 +90,8 @@ CIE 1960 UCS Colourspace uv_to_UCS UCS_uv_to_xy xy_to_UCS_uv + XYZ_to_CIE1960UCS + CIE1960UCS_to_XYZ CIE 1964 U*V*W* Colourspace --------------------------- @@ -363,6 +363,48 @@ Yrg Colourspace - Kirk (2019) XYZ_to_Izazbz Izazbz_to_XYZ +Polar Conversions +----------------- + +``colour`` + +.. currentmodule:: colour + +.. autosummary:: + :toctree: generated/ + + COLOURSPACE_MODELS_POLAR_CONVERSIONS + Lab_to_LCHab + LCHab_to_Lab + Luv_to_LCHuv + LCHuv_to_Luv + hdr_CIELab_to_hdr_CIELCHab + hdr_CIELCHab_to_hdr_CIELab + Hunter_Lab_to_Hunter_LCHab + Hunter_LCHab_to_Hunter_Lab + Hunter_Rdab_to_Hunter_RdCHab + Hunter_RdCHab_to_Hunter_Rdab + ICaCb_to_ICHab + ICHab_to_ICaCb + ICtCp_to_ICHtp + ICHtp_to_ICtCp + IgPgTg_to_IgCHpt + IgCHpt_to_IgPgTg + IPT_to_ICH + ICH_to_IPT + Izazbz_to_IzCHab + IzCHab_to_Izazbz + Jzazbz_to_JzCHab + JzCHab_to_Jzazbz + hdr_IPT_to_hdr_ICH + hdr_ICH_to_hdr_IPT + Oklab_to_Oklch + Oklch_to_Oklab + ProLab_to_ProLCHab + ProLCHab_to_ProLab + IPT_Ragoo2021_to_ICH_Ragoo2021 + ICH_Ragoo2021_to_IPT_Ragoo2021 + RGB Colourspace and Transformations ----------------------------------- diff --git a/docs/colour.utilities.rst b/docs/colour.utilities.rst index 5a4134826f..065dfa9b0d 100644 --- a/docs/colour.utilities.rst +++ b/docs/colour.utilities.rst @@ -62,19 +62,7 @@ Common batch disable_multiprocessing multiprocessing_pool - is_ctlrender_installed - is_graphviz_installed - is_matplotlib_installed - is_networkx_installed - is_opencolorio_installed - is_openimageio_installed - is_pandas_installed - is_tqdm_installed - is_trimesh_installed - is_xxhash_installed - required is_iterable - is_string is_numeric is_integer is_sibling @@ -148,6 +136,38 @@ Array index_along_last_axis format_array_as_row +Data Structures +--------------- + +``colour.utilities`` + +.. currentmodule:: colour.utilities + +.. autosummary:: + :toctree: generated/ + :template: class.rst + + CanonicalMapping + LazyCanonicalMapping + Lookup + Structure + +Network +------- + +``colour.utilities`` + +.. currentmodule:: colour.utilities + +.. autosummary:: + :toctree: generated/ + :template: class.rst + + TreeNode + Port + PortNode + PortGraph + Metrics ------- @@ -161,8 +181,8 @@ Metrics metric_mse metric_psnr -Data Structures ---------------- +Requirements +------------ ``colour.utilities`` @@ -170,13 +190,18 @@ Data Structures .. autosummary:: :toctree: generated/ - :template: class.rst - CanonicalMapping - LazyCanonicalMapping - Lookup - Node - Structure + is_ctlrender_installed + is_matplotlib_installed + is_networkx_installed + is_opencolorio_installed + is_openimageio_installed + is_pandas_installed + is_pydot_installed + is_tqdm_installed + is_trimesh_installed + is_xxhash_installed + required Verbose ------- @@ -192,6 +217,7 @@ Verbose show_warning warning filter_warnings + as_bool suppress_warnings suppress_stdout numpy_print_options @@ -209,6 +235,7 @@ Verbose :toctree: generated/ :template: class.rst + MixinLogging ColourWarning ColourUsageWarning ColourRuntimeWarning diff --git a/docs/conf.py b/docs/conf.py index ce4b09afd3..f49cb6e061 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,9 +16,7 @@ import colour as package # noqa: E402 -basename = re.sub( - "_(\\w)", lambda x: x.group(1).upper(), package.__name__.title() -) +basename = re.sub("_(\\w)", lambda x: x.group(1).upper(), package.__name__.title()) if os.environ.get("READTHEDOCS") == "True": archive = "colour-plots.zip" diff --git a/docs/index.rst b/docs/index.rst index 4b8feaf643..9d5449a900 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -97,13 +97,15 @@ Chromatic Adaptation - ``colour.adaptation`` array([ 0.2533053 , 0.13765138, 0.01543307]) + .. code-block:: python sorted(colour.CHROMATIC_ADAPTATION_METHODS) .. code-block:: text - ['CIE 1994', 'CMCCAT2000', 'Fairchild 1990', 'Von Kries', 'Zhai 2018'] + ['CIE 1994', 'CMCCAT2000', 'Fairchild 1990', 'Von Kries', 'Zhai 2018', 'vK20'] + Algebra - ``colour.algebra`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -651,6 +653,18 @@ Images (276, 281, 3) +Spectral Images - Fichet et al. (2021) +************************************** + +.. code-block:: python + + components = colour.read_spectral_image_Fichet2021("Polarised.exr") + list(components.keys()) + +.. code-block:: text + + ['S0', 'S1', 'S2', 'S3'] + Look Up Table (LUT) Data ************************ @@ -1874,6 +1888,7 @@ Software **Python** +- `ColorAide `__ by Muse, I. - `ColorPy `__ by Kness, M. - `Colorspacious `__ by Smith, N. J., et al. - `python-colormath `__ by Taylor, G., et al. diff --git a/docs/requirements.txt b/docs/requirements.txt index ecee497807..f1d24effde 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,57 +1,59 @@ -accessible-pygments==0.0.4 ; python_version >= "3.9" and python_version < "3.13" -alabaster==0.7.13 ; python_version >= "3.9" and python_version < "3.13" -babel==2.14.0 ; python_version >= "3.9" and python_version < "3.13" -beautifulsoup4==4.12.2 ; python_version >= "3.9" and python_version < "3.13" -biblib-simple==0.1.2 ; python_version >= "3.9" and python_version < "3.13" -certifi==2023.11.17 ; python_version >= "3.9" and python_version < "3.13" -charset-normalizer==3.3.2 ; python_version >= "3.9" and python_version < "3.13" -colorama==0.4.6 ; python_version >= "3.9" and python_version < "3.13" and (platform_system == "Windows" or sys_platform == "win32") -contourpy==1.2.0 ; python_version >= "3.9" and python_version < "3.13" -cycler==0.12.1 ; python_version >= "3.9" and python_version < "3.13" -docutils==0.20.1 ; python_version >= "3.9" and python_version < "3.13" -fonttools==4.46.0 ; python_version >= "3.9" and python_version < "3.13" -idna==3.6 ; python_version >= "3.9" and python_version < "3.13" -imageio==2.33.1 ; python_version >= "3.9" and python_version < "3.13" -imagesize==1.4.1 ; python_version >= "3.9" and python_version < "3.13" -importlib-metadata==7.0.0 ; python_version >= "3.9" and python_version < "3.10" -importlib-resources==6.1.1 ; python_version >= "3.9" and python_version < "3.10" -jinja2==3.1.2 ; python_version >= "3.9" and python_version < "3.13" -kiwisolver==1.4.5 ; python_version >= "3.9" and python_version < "3.13" -latexcodec==2.0.1 ; python_version >= "3.9" and python_version < "3.13" -markupsafe==2.1.3 ; python_version >= "3.9" and python_version < "3.13" -matplotlib==3.8.2 ; python_version >= "3.9" and python_version < "3.13" -networkx==2.8.8 ; python_version >= "3.9" and python_version < "3.13" -numpy==1.26.2 ; python_version >= "3.9" and python_version < "3.13" -opencolorio==2.3.1 ; python_version >= "3.9" and python_version < "3.13" -packaging==23.2 ; python_version >= "3.9" and python_version < "3.13" -pandas==1.5.3 ; python_version >= "3.9" and python_version < "3.13" -pillow==10.1.0 ; python_version >= "3.9" and python_version < "3.13" -pybtex==0.24.0 ; python_version >= "3.9" and python_version < "3.13" -pybtex-docutils==1.0.3 ; python_version >= "3.9" and python_version < "3.13" -pydata-sphinx-theme==0.14.4 ; python_version >= "3.9" and python_version < "3.13" -pygments==2.17.2 ; python_version >= "3.9" and python_version < "3.13" -pygraphviz==1.11 ; python_version >= "3.9" and python_version < "3.12" -pyparsing==3.1.1 ; python_version >= "3.9" and python_version < "3.13" -python-dateutil==2.8.2 ; python_version >= "3.9" and python_version < "3.13" -pytz==2023.3.post1 ; python_version >= "3.9" and python_version < "3.13" -pyyaml==6.0.1 ; python_version >= "3.9" and python_version < "3.13" -requests==2.31.0 ; python_version >= "3.9" and python_version < "3.13" -restructuredtext-lint==1.4.0 ; python_version >= "3.9" and python_version < "3.13" -scipy==1.11.4 ; python_version >= "3.9" and python_version < "3.13" -six==1.16.0 ; python_version >= "3.9" and python_version < "3.13" -snowballstemmer==2.2.0 ; python_version >= "3.9" and python_version < "3.13" -soupsieve==2.5 ; python_version >= "3.9" and python_version < "3.13" -sphinx==7.2.6 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-applehelp==1.0.7 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-bibtex==2.6.1 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-devhelp==1.0.5 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-htmlhelp==2.0.4 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-qthelp==1.0.6 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-serializinghtml==1.1.9 ; python_version >= "3.9" and python_version < "3.13" -tqdm==4.66.1 ; python_version >= "3.9" and python_version < "3.13" -trimesh==3.23.5 ; python_version >= "3.9" and python_version < "3.13" -typing-extensions==4.9.0 ; python_version >= "3.9" and python_version < "3.13" -urllib3==2.1.0 ; python_version >= "3.9" and python_version < "3.13" -xxhash==3.4.1 ; python_version >= "3.9" and python_version < "3.13" -zipp==3.17.0 ; python_version >= "3.9" and python_version < "3.10" +# This file was autogenerated by uv via the following command: +# uv export --no-hashes --all-extras --no-dev +accessible-pygments==0.0.5 +alabaster==1.0.0 +babel==2.16.0 +beautifulsoup4==4.12.3 +biblib-simple==0.1.2 +certifi==2024.8.30 +charset-normalizer==3.4.0 +colorama==0.4.6 ; sys_platform == 'win32' or platform_system == 'Windows' +contourpy==1.3.0 +cycler==0.12.1 +docutils==0.21.2 +fonttools==4.54.1 +idna==3.10 +imageio==2.35.1 +imagesize==1.4.1 +jinja2==3.1.4 +kiwisolver==1.4.7 +latexcodec==3.0.0 +markupsafe==3.0.1 +matplotlib==3.9.2 +networkx==3.3 +numpy==2.1.2 +opencolorio==2.4.0 +packaging==24.1 +pandas==2.2.3 +pillow==10.4.0 +pybtex==0.24.0 +pybtex-docutils==1.0.3 +pydata-sphinx-theme==0.15.4 +pydot==3.0.2 +pygments==2.18.0 +pyparsing==3.1.4 +python-dateutil==2.9.0.post0 +pytz==2024.2 +pyyaml==6.0.2 +requests==2.32.3 +restructuredtext-lint==1.4.0 +scipy==1.14.1 +setuptools==75.1.0 ; python_full_version >= '3.12' +six==1.16.0 +snowballstemmer==2.2.0 +soupsieve==2.6 +sphinx==8.0.2 +sphinxcontrib-applehelp==2.0.0 +sphinxcontrib-bibtex==2.6.3 +sphinxcontrib-devhelp==2.0.0 +sphinxcontrib-htmlhelp==2.1.0 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-qthelp==2.0.0 +sphinxcontrib-serializinghtml==2.0.0 +tomli==2.0.2 ; python_full_version < '3.11' +tqdm==4.66.5 +trimesh==4.4.9 +typing-extensions==4.12.2 +tzdata==2024.2 +urllib3==2.2.3 +xxhash==3.5.0 diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 9fb7363c23..a4b351b607 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -251,11 +251,11 @@ The various sub-packages also expose their public API: Models - ['COLOURSPACE_MODELS', - 'COLOURSPACE_MODELS_AXIS_LABELS', - 'COLOURSPACE_MODELS_DOMAIN_RANGE_SCALE_1_TO_REFERENCE', - 'Jab_to_JCh', - 'JCh_to_Jab', + ['Lab_to_LCHab', + 'LCHab_to_Lab', + 'Luv_to_LCHuv', + 'LCHuv_to_Luv', + 'hdr_CIELab_to_hdr_CIELCHab', '...'] @@ -313,11 +313,11 @@ The various sub-packages also expose their public API: Utilities - ['Lookup', - 'Structure', - 'CanonicalMapping', - 'LazyCanonicalMapping', - 'Node', + ['MixinLogging', + 'ColourWarning', + 'ColourUsageWarning', + 'ColourRuntimeWarning', + 'message_box', '...'] @@ -360,14 +360,14 @@ The codebase is documented and most docstrings have usage examples: Examples -------- - from colour import MSDS_CMFS, SPECTRAL_SHAPE_DEFAULT - cmfs = ( - MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] - .copy() - .align(SPECTRAL_SHAPE_DEFAULT) - ) - CCT_D_uv = np.array([6507.4342201047066, 0.003223690901513]) - CCT_to_uv_Ohno2013(CCT_D_uv, cmfs) # doctest: +ELLIPSIS + >>> from colour import MSDS_CMFS, SPECTRAL_SHAPE_DEFAULT + >>> cmfs = ( + ... MSDS_CMFS["CIE 1931 2 Degree Standard Observer"] + ... .copy() + ... .align(SPECTRAL_SHAPE_DEFAULT) + ... ) + >>> CCT_D_uv = np.array([6507.4342201047066, 0.003223690901513]) + >>> CCT_to_uv_Ohno2013(CCT_D_uv, cmfs) # doctest: +ELLIPSIS array([ 0.1977999..., 0.3122004...]) At the core of **Colour** is the ``colour.colorimetry`` sub-package, it defines @@ -1167,26 +1167,36 @@ computations are available, expanding to even more computations: 'CAM16LCD', 'CAM16SCD', 'CAM16UCS', - 'CIE XYZ', - 'CIE xyY', + 'CIE 1931', + 'CIE 1960 UCS', + 'CIE 1976 UCS', 'CIE Lab', 'CIE Luv', 'CIE UCS', 'CIE UVW', + 'CIE XYZ', + 'CIE xyY', 'DIN99', + 'HCL', + 'HSL', + 'HSV', 'Hunter Lab', 'Hunter Rdab', 'ICaCb', 'ICtCp', - 'IPT', + 'IHLS', 'IPT Ragoo 2021', + 'IPT', 'IgPgTg', 'Jzazbz', 'OSA UCS', 'Oklab', + 'RGB', + 'YCbCr', + 'YCoCg', + 'Yrg', 'hdr-CIELAB', - 'hdr-IPT', - 'Yrg') + 'hdr-IPT') Convert to Display Colours -------------------------- @@ -1237,8 +1247,8 @@ various colour rendition charts: .. code-block:: text - ['BabelColor Average', 'ColorChecker 1976', 'ColorChecker 2005', 'ColorChecker24 - After November 2014', 'ColorChecker24 - Before November 2014', 'TE226 V2', 'babel_average', 'cc2005', 'cca2014', 'ccb2014'] - ['BabelColor Average', 'ColorChecker N Ohta', 'ISO 17321-1', 'babel_average', 'cc_ohta'] + ['BabelColor Average', 'ColorChecker 1976', 'ColorChecker 2005', 'ColorChecker24 - After November 2014', 'ColorChecker24 - Before November 2014', 'ColorCheckerSG - After November 2014', 'ColorCheckerSG - Before November 2014', 'TE226 V2', 'babel_average', 'cc2005', 'cca2014', 'ccb2014'] + ['BabelColor Average', 'ColorChecker N Ohta', 'ISO 17321-1', 'PMC', 'babel_average', 'cc_ohta'] .. note:: diff --git a/pyproject.toml b/pyproject.toml index 0568faf2a3..68933a668f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,14 +1,16 @@ -[tool.poetry] +[project] name = "colour-science" -packages = [{ include = "colour" }] -version = "0.4.4" +version = "0.4.5" description = "Colour Science for Python" -license = "BSD-3-Clause" -authors = ["Colour Developers "] -maintainers = ["Colour Developers "] -readme = 'README.rst' -repository = "https://github.com/colour-science/colour" -homepage = "https://www.colour-science.org/" +readme = "README.rst" +requires-python = ">=3.10,<3.14" +authors = [ + { name = "Colour Developers", email = "colour-developers@colour-science.org" }, +] +maintainers = [ + { name = "Colour Developers", email = "colour-developers@colour-science.org" } +] +license = { text = "BSD-3-Clause" } keywords = [ "color", "color-science", @@ -42,55 +44,69 @@ classifiers = [ "Topic :: Scientific/Engineering", "Topic :: Software Development", ] +dependencies = [ + "imageio>=2,<3", + "numpy>=1.24,<3", + "scipy>=1.10,<2", + "trimesh>=4", + "typing-extensions>=4,<5", +] -[tool.poetry.dependencies] -python = ">= 3.9, < 3.13" -imageio = ">= 2, < 3" -numpy = ">= 1.22, < 2" -scipy = ">= 1.8, < 2" -typing-extensions = ">= 4, < 5" - -[tool.poetry.group.optional.dependencies] -matplotlib = ">= 3.5, != 3.5.0, != 3.5.1" -networkx = ">= 2.7, < 3" -opencolorio = ">= 2, < 3" -pandas = ">= 1.4, < 2" -tqdm = ">= 4, < 5" -xxhash = ">= 3.2, < 4" - -[tool.poetry.group.graphviz.dependencies] -pygraphviz = { version = ">= 1, < 2", python = "< 3.12" } - -[tool.poetry.group.meshing.dependencies] -trimesh = ">= 3, < 4" +[project.optional-dependencies] +optional = [ + "matplotlib>=3.7", + "networkx>=3,<4", + "opencolorio>=2,<3", + "pandas>=2,<3", + "pydot>=3,<4", + "tqdm>=4,<5", + "xxhash>=3,<4", +] +docs = [ + "biblib-simple", + "pydata-sphinx-theme", + "restructuredtext-lint", + "sphinx", + "sphinxcontrib-bibtex", +] +meshing = [ + "trimesh>=4,<5", +] -[tool.poetry.group.dev.dependencies] -coverage = "!= 6.3" -coveralls = "*" -invoke = "*" -jupyter = "*" -pre-commit = ">= 3.5" -pyright = "*" -pytest = "*" -pytest-cov = "*" -pytest-xdist = "*" -toml = "*" -twine = "*" +[project.urls] +Homepage = "https://www.colour-science.org" +Documentation = "https://readthedocs.org" +Repository = "https://github.com/colour-science/colour" +Issues = "https://github.com/colour-science/colour/issues" +Changelog = "https://github.com/colour-science/colour/releases" + +[tool.uv] +package = true +dev-dependencies = [ + "coverage", + "coveralls", + "hatch", + "invoke", + "jupyter", + "pre-commit", + "pyright", + "pytest", + "pytest-cov", + "pytest-xdist", + "toml", + "twine", +] -[tool.poetry.group.docs.dependencies] -biblib-simple = "*" -pydata-sphinx-theme = "*" -restructuredtext-lint = "*" -sphinx = "*" -sphinxcontrib-bibtex = "*" +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" -[tool.black] -line-length = 79 -exclude = '''/(\.git|build|dist)/''' +[tool.hatch.build.targets.wheel] +packages = [ "colour" ] [tool.codespell] -ignore-words-list = 'co-ordinates,exitance,hart,ist' -skip = 'BIBLIOGRAPHY.bib,CONTRIBUTORS.rst' +ignore-words-list = "co-ordinates,exitance,hart,ist" +skip = "BIBLIOGRAPHY.bib,CONTRIBUTORS.rst" [tool.flynt] line_length = 999 @@ -138,7 +154,7 @@ filterwarnings = [ target-version = "py39" line-length = 88 select = [ - "A", # flake8-builtins + "A", # flake8-builtins "ARG", # flake8-unused-arguments # "ANN", # flake8-annotations "B", # flake8-bugbear @@ -147,36 +163,37 @@ select = [ # "C90", # mccabe # "COM", # flake8-commas "DTZ", # flake8-datetimez - "D", # pydocstyle - "E", # pydocstyle + "D", # pydocstyle + "E", # pydocstyle # "ERA", # eradicate # "EM", # flake8-errmsg "EXE", # flake8-executable - "F", # flake8 + "F", # flake8 # "FBT", # flake8-boolean-trap - "G", # flake8-logging-format - "I", # isort + "G", # flake8-logging-format + "I", # isort "ICN", # flake8-import-conventions "INP", # flake8-no-pep420 "ISC", # flake8-implicit-str-concat - "N", # pep8-naming + "N", # pep8-naming # "PD", # pandas-vet "PIE", # flake8-pie "PGH", # pygrep-hooks - "PL", # pylint + "PL", # pylint # "PT", # flake8-pytest-style - # "PTH", # flake8-use-pathlib [Enable] "Q", # flake8-quotes + # "PTH", # flake8-use-pathlib [Enable] + "Q", # flake8-quotes "RET", # flake8-return "RUF", # Ruff - "S", # flake8-bandit + "S", # flake8-bandit "SIM", # flake8-simplify "T10", # flake8-debugger "T20", # flake8-print # "TCH", # flake8-type-checking "TID", # flake8-tidy-imports "TRY", # tryceratops - "UP", # pyupgrade - "W", # pydocstyle + "UP", # pyupgrade + "W", # pydocstyle "YTT", # flake8-2020 ] ignore = [ @@ -222,9 +239,9 @@ convention = "numpy" "colour/examples/*" = ["INP", "T201", "T203"] "docs/*" = ["INP"] "tasks.py" = ["INP"] +"test_*" = ["S101"] "utilities/*" = ["EXE001", "INP"] "utilities/unicode_to_ascii.py" = ["RUF001"] -[build-system] -requires = ["poetry_core>=1.0.0"] -build-backend = "poetry.core.masonry.api" +[tool.ruff.format] +docstring-code-format = true diff --git a/requirements.txt b/requirements.txt index 976085b2fb..b800214e68 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,178 +1,194 @@ -accessible-pygments==0.0.4 ; python_version >= "3.9" and python_version < "3.13" -alabaster==0.7.13 ; python_version >= "3.9" and python_version < "3.13" -anyio==4.2.0 ; python_version >= "3.9" and python_version < "3.13" -appnope==0.1.3 ; python_version >= "3.9" and python_version < "3.13" and platform_system == "Darwin" -argon2-cffi==23.1.0 ; python_version >= "3.9" and python_version < "3.13" -argon2-cffi-bindings==21.2.0 ; python_version >= "3.9" and python_version < "3.13" -arrow==1.3.0 ; python_version >= "3.9" and python_version < "3.13" -asttokens==2.4.1 ; python_version >= "3.9" and python_version < "3.13" -async-lru==2.0.4 ; python_version >= "3.9" and python_version < "3.13" -attrs==23.1.0 ; python_version >= "3.9" and python_version < "3.13" -babel==2.14.0 ; python_version >= "3.9" and python_version < "3.13" -beautifulsoup4==4.12.2 ; python_version >= "3.9" and python_version < "3.13" -biblib-simple==0.1.2 ; python_version >= "3.9" and python_version < "3.13" -bleach==6.1.0 ; python_version >= "3.9" and python_version < "3.13" -certifi==2023.11.17 ; python_version >= "3.9" and python_version < "3.13" -cffi==1.16.0 ; python_version >= "3.9" and python_version < "3.13" -cfgv==3.4.0 ; python_version >= "3.9" and python_version < "3.13" -charset-normalizer==3.3.2 ; python_version >= "3.9" and python_version < "3.13" -colorama==0.4.6 ; python_version >= "3.9" and python_version < "3.13" and (platform_system == "Windows" or sys_platform == "win32") -comm==0.2.0 ; python_version >= "3.9" and python_version < "3.13" -contourpy==1.2.0 ; python_version >= "3.9" and python_version < "3.13" -coverage==7.3.3 ; python_version >= "3.9" and python_version < "3.13" -coverage[toml]==7.3.3 ; python_version >= "3.9" and python_version < "3.13" -coveralls==1.8.0 ; python_version >= "3.9" and python_version < "3.13" -cryptography==41.0.7 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "linux" -cycler==0.12.1 ; python_version >= "3.9" and python_version < "3.13" -debugpy==1.8.0 ; python_version >= "3.9" and python_version < "3.13" -decorator==5.1.1 ; python_version >= "3.9" and python_version < "3.13" -defusedxml==0.7.1 ; python_version >= "3.9" and python_version < "3.13" -distlib==0.3.8 ; python_version >= "3.9" and python_version < "3.13" -docopt==0.6.2 ; python_version >= "3.9" and python_version < "3.13" -docutils==0.20.1 ; python_version >= "3.9" and python_version < "3.13" -exceptiongroup==1.2.0 ; python_version >= "3.9" and python_version < "3.11" -execnet==2.0.2 ; python_version >= "3.9" and python_version < "3.13" -executing==2.0.1 ; python_version >= "3.9" and python_version < "3.13" -fastjsonschema==2.19.0 ; python_version >= "3.9" and python_version < "3.13" -filelock==3.13.1 ; python_version >= "3.9" and python_version < "3.13" -fonttools==4.46.0 ; python_version >= "3.9" and python_version < "3.13" -fqdn==1.5.1 ; python_version >= "3.9" and python_version < "3.13" -identify==2.5.33 ; python_version >= "3.9" and python_version < "3.13" -idna==3.6 ; python_version >= "3.9" and python_version < "3.13" -imageio==2.33.1 ; python_version >= "3.9" and python_version < "3.13" -imagesize==1.4.1 ; python_version >= "3.9" and python_version < "3.13" -importlib-metadata==7.0.0 ; python_version >= "3.9" and python_version < "3.13" -importlib-resources==6.1.1 ; python_version >= "3.9" and python_version < "3.10" -iniconfig==2.0.0 ; python_version >= "3.9" and python_version < "3.13" -invoke==2.2.0 ; python_version >= "3.9" and python_version < "3.13" -ipykernel==6.27.1 ; python_version >= "3.9" and python_version < "3.13" -ipython==8.18.1 ; python_version >= "3.9" and python_version < "3.13" -ipywidgets==8.1.1 ; python_version >= "3.9" and python_version < "3.13" -isoduration==20.11.0 ; python_version >= "3.9" and python_version < "3.13" -jaraco-classes==3.3.0 ; python_version >= "3.9" and python_version < "3.13" -jedi==0.19.1 ; python_version >= "3.9" and python_version < "3.13" -jeepney==0.8.0 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "linux" -jinja2==3.1.2 ; python_version >= "3.9" and python_version < "3.13" -json5==0.9.14 ; python_version >= "3.9" and python_version < "3.13" -jsonpointer==2.4 ; python_version >= "3.9" and python_version < "3.13" -jsonschema==4.20.0 ; python_version >= "3.9" and python_version < "3.13" -jsonschema-specifications==2023.11.2 ; python_version >= "3.9" and python_version < "3.13" -jsonschema[format-nongpl]==4.20.0 ; python_version >= "3.9" and python_version < "3.13" -jupyter==1.0.0 ; python_version >= "3.9" and python_version < "3.13" -jupyter-client==8.6.0 ; python_version >= "3.9" and python_version < "3.13" -jupyter-console==6.6.3 ; python_version >= "3.9" and python_version < "3.13" -jupyter-core==5.5.0 ; python_version >= "3.9" and python_version < "3.13" -jupyter-events==0.9.0 ; python_version >= "3.9" and python_version < "3.13" -jupyter-lsp==2.2.1 ; python_version >= "3.9" and python_version < "3.13" -jupyter-server==2.12.1 ; python_version >= "3.9" and python_version < "3.13" -jupyter-server-terminals==0.5.0 ; python_version >= "3.9" and python_version < "3.13" -jupyterlab==4.0.9 ; python_version >= "3.9" and python_version < "3.13" -jupyterlab-pygments==0.3.0 ; python_version >= "3.9" and python_version < "3.13" -jupyterlab-server==2.25.2 ; python_version >= "3.9" and python_version < "3.13" -jupyterlab-widgets==3.0.9 ; python_version >= "3.9" and python_version < "3.13" -keyring==24.3.0 ; python_version >= "3.9" and python_version < "3.13" -kiwisolver==1.4.5 ; python_version >= "3.9" and python_version < "3.13" -latexcodec==2.0.1 ; python_version >= "3.9" and python_version < "3.13" -markdown-it-py==3.0.0 ; python_version >= "3.9" and python_version < "3.13" -markupsafe==2.1.3 ; python_version >= "3.9" and python_version < "3.13" -matplotlib==3.8.2 ; python_version >= "3.9" and python_version < "3.13" -matplotlib-inline==0.1.6 ; python_version >= "3.9" and python_version < "3.13" -mdurl==0.1.2 ; python_version >= "3.9" and python_version < "3.13" -mistune==3.0.2 ; python_version >= "3.9" and python_version < "3.13" -more-itertools==10.1.0 ; python_version >= "3.9" and python_version < "3.13" -nbclient==0.9.0 ; python_version >= "3.9" and python_version < "3.13" -nbconvert==7.12.0 ; python_version >= "3.9" and python_version < "3.13" -nbformat==5.9.2 ; python_version >= "3.9" and python_version < "3.13" -nest-asyncio==1.5.8 ; python_version >= "3.9" and python_version < "3.13" -networkx==2.8.8 ; python_version >= "3.9" and python_version < "3.13" -nh3==0.2.15 ; python_version >= "3.9" and python_version < "3.13" -nodeenv==1.8.0 ; python_version >= "3.9" and python_version < "3.13" -notebook==7.0.6 ; python_version >= "3.9" and python_version < "3.13" -notebook-shim==0.2.3 ; python_version >= "3.9" and python_version < "3.13" -numpy==1.26.2 ; python_version >= "3.9" and python_version < "3.13" -opencolorio==2.3.1 ; python_version >= "3.9" and python_version < "3.13" -overrides==7.4.0 ; python_version >= "3.9" and python_version < "3.13" -packaging==23.2 ; python_version >= "3.9" and python_version < "3.13" -pandas==1.5.3 ; python_version >= "3.9" and python_version < "3.13" -pandocfilters==1.5.0 ; python_version >= "3.9" and python_version < "3.13" -parso==0.8.3 ; python_version >= "3.9" and python_version < "3.13" -pexpect==4.9.0 ; python_version >= "3.9" and python_version < "3.13" and sys_platform != "win32" -pillow==10.1.0 ; python_version >= "3.9" and python_version < "3.13" -pkginfo==1.9.6 ; python_version >= "3.9" and python_version < "3.13" -platformdirs==4.1.0 ; python_version >= "3.9" and python_version < "3.13" -pluggy==1.3.0 ; python_version >= "3.9" and python_version < "3.13" -pre-commit==3.6.0 ; python_version >= "3.9" and python_version < "3.13" -prometheus-client==0.19.0 ; python_version >= "3.9" and python_version < "3.13" -prompt-toolkit==3.0.43 ; python_version >= "3.9" and python_version < "3.13" -psutil==5.9.6 ; python_version >= "3.9" and python_version < "3.13" -ptyprocess==0.7.0 ; python_version >= "3.9" and python_version < "3.13" and (sys_platform != "win32" or os_name != "nt") -pure-eval==0.2.2 ; python_version >= "3.9" and python_version < "3.13" -pybtex==0.24.0 ; python_version >= "3.9" and python_version < "3.13" -pybtex-docutils==1.0.3 ; python_version >= "3.9" and python_version < "3.13" -pycparser==2.21 ; python_version >= "3.9" and python_version < "3.13" -pydata-sphinx-theme==0.14.4 ; python_version >= "3.9" and python_version < "3.13" -pygments==2.17.2 ; python_version >= "3.9" and python_version < "3.13" -pygraphviz==1.11 ; python_version >= "3.9" and python_version < "3.12" -pyparsing==3.1.1 ; python_version >= "3.9" and python_version < "3.13" -pyright==1.1.341 ; python_version >= "3.9" and python_version < "3.13" -pytest==7.4.3 ; python_version >= "3.9" and python_version < "3.13" -pytest-cov==4.1.0 ; python_version >= "3.9" and python_version < "3.13" -pytest-xdist==3.5.0 ; python_version >= "3.9" and python_version < "3.13" -python-dateutil==2.8.2 ; python_version >= "3.9" and python_version < "3.13" -python-json-logger==2.0.7 ; python_version >= "3.9" and python_version < "3.13" -pytz==2023.3.post1 ; python_version >= "3.9" and python_version < "3.13" -pywin32==306 ; sys_platform == "win32" and platform_python_implementation != "PyPy" and python_version >= "3.9" and python_version < "3.13" -pywin32-ctypes==0.2.2 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "win32" -pywinpty==2.0.12 ; python_version >= "3.9" and python_version < "3.13" and os_name == "nt" -pyyaml==6.0.1 ; python_version >= "3.9" and python_version < "3.13" -pyzmq==25.1.2 ; python_version >= "3.9" and python_version < "3.13" -qtconsole==5.5.1 ; python_version >= "3.9" and python_version < "3.13" -qtpy==2.4.1 ; python_version >= "3.9" and python_version < "3.13" -readme-renderer==42.0 ; python_version >= "3.9" and python_version < "3.13" -referencing==0.32.0 ; python_version >= "3.9" and python_version < "3.13" -requests==2.31.0 ; python_version >= "3.9" and python_version < "3.13" -requests-toolbelt==1.0.0 ; python_version >= "3.9" and python_version < "3.13" -restructuredtext-lint==1.4.0 ; python_version >= "3.9" and python_version < "3.13" -rfc3339-validator==0.1.4 ; python_version >= "3.9" and python_version < "3.13" -rfc3986==2.0.0 ; python_version >= "3.9" and python_version < "3.13" -rfc3986-validator==0.1.1 ; python_version >= "3.9" and python_version < "3.13" -rich==13.7.0 ; python_version >= "3.9" and python_version < "3.13" -rpds-py==0.14.1 ; python_version >= "3.9" and python_version < "3.13" -scipy==1.11.4 ; python_version >= "3.9" and python_version < "3.13" -secretstorage==3.3.3 ; python_version >= "3.9" and python_version < "3.13" and sys_platform == "linux" -send2trash==1.8.2 ; python_version >= "3.9" and python_version < "3.13" -setuptools==69.0.2 ; python_version >= "3.9" and python_version < "3.13" -six==1.16.0 ; python_version >= "3.9" and python_version < "3.13" -sniffio==1.3.0 ; python_version >= "3.9" and python_version < "3.13" -snowballstemmer==2.2.0 ; python_version >= "3.9" and python_version < "3.13" -soupsieve==2.5 ; python_version >= "3.9" and python_version < "3.13" -sphinx==7.2.6 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-applehelp==1.0.7 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-bibtex==2.6.1 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-devhelp==1.0.5 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-htmlhelp==2.0.4 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-qthelp==1.0.6 ; python_version >= "3.9" and python_version < "3.13" -sphinxcontrib-serializinghtml==1.1.9 ; python_version >= "3.9" and python_version < "3.13" -stack-data==0.6.3 ; python_version >= "3.9" and python_version < "3.13" -terminado==0.18.0 ; python_version >= "3.9" and python_version < "3.13" -tinycss2==1.2.1 ; python_version >= "3.9" and python_version < "3.13" -toml==0.10.2 ; python_version >= "3.9" and python_version < "3.13" -tomli==2.0.1 ; python_version >= "3.9" and python_full_version <= "3.11.0a6" -tornado==6.4 ; python_version >= "3.9" and python_version < "3.13" -tqdm==4.66.1 ; python_version >= "3.9" and python_version < "3.13" -traitlets==5.14.0 ; python_version >= "3.9" and python_version < "3.13" -trimesh==3.23.5 ; python_version >= "3.9" and python_version < "3.13" -twine==4.0.2 ; python_version >= "3.9" and python_version < "3.13" -types-python-dateutil==2.8.19.14 ; python_version >= "3.9" and python_version < "3.13" -typing-extensions==4.9.0 ; python_version >= "3.9" and python_version < "3.13" -uri-template==1.3.0 ; python_version >= "3.9" and python_version < "3.13" -urllib3==2.1.0 ; python_version >= "3.9" and python_version < "3.13" -virtualenv==20.25.0 ; python_version >= "3.9" and python_version < "3.13" -wcwidth==0.2.12 ; python_version >= "3.9" and python_version < "3.13" -webcolors==1.13 ; python_version >= "3.9" and python_version < "3.13" -webencodings==0.5.1 ; python_version >= "3.9" and python_version < "3.13" -websocket-client==1.7.0 ; python_version >= "3.9" and python_version < "3.13" -widgetsnbextension==4.0.9 ; python_version >= "3.9" and python_version < "3.13" -xxhash==3.4.1 ; python_version >= "3.9" and python_version < "3.13" -zipp==3.17.0 ; python_version >= "3.9" and python_version < "3.13" +# This file was autogenerated by uv via the following command: +# uv export --no-hashes --all-extras +accessible-pygments==0.0.5 +alabaster==1.0.0 +anyio==4.6.0 +appnope==0.1.4 ; platform_system == 'Darwin' +argon2-cffi==23.1.0 +argon2-cffi-bindings==21.2.0 +arrow==1.3.0 +asttokens==2.4.1 +async-lru==2.0.4 +attrs==24.2.0 +babel==2.16.0 +backports-tarfile==1.2.0 ; python_full_version < '3.12' +beautifulsoup4==4.12.3 +biblib-simple==0.1.2 +bleach==6.1.0 +certifi==2024.8.30 +cffi==1.17.1 +cfgv==3.4.0 +charset-normalizer==3.4.0 +click==8.1.7 +colorama==0.4.6 ; sys_platform == 'win32' or platform_system == 'Windows' +comm==0.2.2 +contourpy==1.3.0 +coverage==7.6.2 +coveralls==4.0.1 +cryptography==43.0.1 ; sys_platform == 'linux' +cycler==0.12.1 +debugpy==1.8.6 +decorator==5.1.1 +defusedxml==0.7.1 +distlib==0.3.9 +docopt==0.6.2 +docutils==0.21.2 +exceptiongroup==1.2.2 ; python_full_version < '3.11' +execnet==2.1.1 +executing==2.1.0 +fastjsonschema==2.20.0 +filelock==3.16.1 +fonttools==4.54.1 +fqdn==1.5.1 +h11==0.14.0 +hatch==1.12.0 +hatchling==1.25.0 +httpcore==1.0.6 +httpx==0.27.2 +hyperlink==21.0.0 +identify==2.6.1 +idna==3.10 +imageio==2.35.1 +imagesize==1.4.1 +importlib-metadata==8.5.0 +iniconfig==2.0.0 +invoke==2.2.0 +ipykernel==6.29.5 +ipython==8.28.0 +ipywidgets==8.1.5 +isoduration==20.11.0 +jaraco-classes==3.4.0 +jaraco-context==6.0.1 +jaraco-functools==4.1.0 +jedi==0.19.1 +jeepney==0.8.0 ; sys_platform == 'linux' +jinja2==3.1.4 +json5==0.9.25 +jsonpointer==3.0.0 +jsonschema==4.23.0 +jsonschema-specifications==2024.10.1 +jupyter==1.1.1 +jupyter-client==8.6.3 +jupyter-console==6.6.3 +jupyter-core==5.7.2 +jupyter-events==0.10.0 +jupyter-lsp==2.2.5 +jupyter-server==2.14.2 +jupyter-server-terminals==0.5.3 +jupyterlab==4.2.5 +jupyterlab-pygments==0.3.0 +jupyterlab-server==2.27.3 +jupyterlab-widgets==3.0.13 +keyring==25.4.1 +kiwisolver==1.4.7 +latexcodec==3.0.0 +markdown-it-py==3.0.0 +markupsafe==3.0.1 +matplotlib==3.9.2 +matplotlib-inline==0.1.7 +mdurl==0.1.2 +mistune==3.0.2 +more-itertools==10.5.0 +nbclient==0.10.0 +nbconvert==7.16.4 +nbformat==5.10.4 +nest-asyncio==1.6.0 +networkx==3.3 +nh3==0.2.18 +nodeenv==1.9.1 +notebook==7.2.2 +notebook-shim==0.2.4 +numpy==2.1.2 +opencolorio==2.4.0 +overrides==7.7.0 +packaging==24.1 +pandas==2.2.3 +pandocfilters==1.5.1 +parso==0.8.4 +pathspec==0.12.1 +pexpect==4.9.0 +pillow==10.4.0 +pkginfo==1.10.0 +platformdirs==4.3.6 +pluggy==1.5.0 +pre-commit==4.0.1 +prometheus-client==0.21.0 +prompt-toolkit==3.0.48 +psutil==6.0.0 +ptyprocess==0.7.0 +pure-eval==0.2.3 +pybtex==0.24.0 +pybtex-docutils==1.0.3 +pycparser==2.22 +pydata-sphinx-theme==0.15.4 +pydot==3.0.2 +pygments==2.18.0 +pyparsing==3.1.4 +pyright==1.1.384 +pytest==8.3.3 +pytest-cov==5.0.0 +pytest-xdist==3.6.1 +python-dateutil==2.9.0.post0 +python-json-logger==2.0.7 +pytz==2024.2 +pywin32==307 ; platform_python_implementation != 'PyPy' and sys_platform == 'win32' +pywin32-ctypes==0.2.3 ; sys_platform == 'win32' +pywinpty==2.0.13 ; os_name == 'nt' +pyyaml==6.0.2 +pyzmq==26.2.0 +readme-renderer==44.0 +referencing==0.35.1 +requests==2.32.3 +requests-toolbelt==1.0.0 +restructuredtext-lint==1.4.0 +rfc3339-validator==0.1.4 +rfc3986==2.0.0 +rfc3986-validator==0.1.1 +rich==13.9.2 +rpds-py==0.20.0 +scipy==1.14.1 +secretstorage==3.3.3 ; sys_platform == 'linux' +send2trash==1.8.3 +setuptools==75.1.0 +shellingham==1.5.4 +six==1.16.0 +sniffio==1.3.1 +snowballstemmer==2.2.0 +soupsieve==2.6 +sphinx==8.0.2 +sphinxcontrib-applehelp==2.0.0 +sphinxcontrib-bibtex==2.6.3 +sphinxcontrib-devhelp==2.0.0 +sphinxcontrib-htmlhelp==2.1.0 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-qthelp==2.0.0 +sphinxcontrib-serializinghtml==2.0.0 +stack-data==0.6.3 +terminado==0.18.1 +tinycss2==1.3.0 +toml==0.10.2 +tomli==2.0.2 ; python_full_version <= '3.11' +tomli-w==1.1.0 +tomlkit==0.13.2 +tornado==6.4.1 +tqdm==4.66.5 +traitlets==5.14.3 +trimesh==4.4.9 +trove-classifiers==2024.9.12 +twine==5.1.1 +types-python-dateutil==2.9.0.20241003 +typing-extensions==4.12.2 +tzdata==2024.2 +uri-template==1.3.0 +urllib3==2.2.3 +userpath==1.9.2 +uv==0.4.20 +virtualenv==20.26.6 +wcwidth==0.2.13 +webcolors==24.8.0 +webencodings==0.5.1 +websocket-client==1.8.0 +widgetsnbextension==4.0.13 +xxhash==3.5.0 +zipp==3.20.2 +zstandard==0.23.0 diff --git a/tasks.py b/tasks.py index 45c67d649b..868a83db71 100644 --- a/tasks.py +++ b/tasks.py @@ -102,7 +102,7 @@ def clean( docs Whether to clean the *docs* directory. bytecode - Whether to clean the bytecode files, e.g. *.pyc* files. + Whether to clean the bytecode files, e.g., *.pyc* files. pytest Whether to clean the *Pytest* cache directory. """ @@ -154,9 +154,7 @@ def formatting( message_box('Cleaning up "BibTeX" file...') bibtex_path = BIBLIOGRAPHY_NAME with open(bibtex_path) as bibtex_file: - entries = ( - biblib.bib.Parser().parse(bibtex_file.read()).get_entries() - ) + entries = biblib.bib.Parser().parse(bibtex_file.read()).get_entries() for entry in sorted(entries.values(), key=lambda x: x.key): with contextlib.suppress(KeyError): @@ -193,7 +191,7 @@ def quality( if pyright: message_box('Checking codebase with "Pyright"...') - ctx.run("pyright --skipunannotated --level warning") + ctx.run("pyright --threads --skipunannotated --level warning") if rstlint: message_box('Linting "README.rst" file...') @@ -270,7 +268,7 @@ def examples(ctx: Context, plots: bool = False): @task(formatting, quality, precommit, tests, examples) def preflight(ctx: Context): # noqa: ARG001 """ - Perform the preflight tasks, i.e. *formatting*, *tests*, *quality*, and + Perform the preflight tasks, i.e., *formatting*, *tests*, *quality*, and *examples*. Parameters @@ -309,9 +307,7 @@ def docs( message_box("Generating plots...") ctx.run("./generate_plots.py") - with ctx.prefix("export COLOUR_SCIENCE__DOCUMENTATION_BUILD=True"), ctx.cd( - "docs" - ): + with ctx.prefix("export COLOUR_SCIENCE__DOCUMENTATION_BUILD=True"), ctx.cd("docs"): if html: message_box('Building "HTML" documentation...') ctx.run("make html") @@ -350,26 +346,19 @@ def requirements(ctx: Context): """ message_box('Exporting "requirements.txt" file...') - ctx.run( - "poetry export -f requirements.txt " - "--without-hashes " - "--with dev,docs,graphviz,meshing,optional " - "--output requirements.txt" - ) + ctx.run('uv export --no-hashes --all-extras | grep -v "-e \\." > requirements.txt') message_box('Exporting "docs/requirements.txt" file...') ctx.run( - "poetry export -f requirements.txt " - "--without-hashes " - "--with docs,graphviz,meshing,optional " - "--output docs/requirements.txt" + 'uv export --no-hashes --all-extras --no-dev | grep -v "-e \\." > ' + "docs/requirements.txt" ) @task(literalise, clean, preflight, docs, todo, requirements) def build(ctx: Context): """ - Build the project and runs dependency tasks, i.e. *docs*, *todo*, and + Build the project and runs dependency tasks, i.e., *docs*, *todo*, and *preflight*. Parameters @@ -379,13 +368,8 @@ def build(ctx: Context): """ message_box("Building...") - if ( - "modified: README.rst" - in ctx.run("git status").stdout # pyright: ignore - ): - raise RuntimeError( - 'Please commit your changes to the "README.rst" file!' - ) + if "modified: README.rst" in ctx.run("git status").stdout: # pyright: ignore + raise RuntimeError('Please commit your changes to the "README.rst" file!') with open("README.rst") as readme_file: readme_content = readme_file.read() @@ -395,8 +379,7 @@ def build(ctx: Context): # directive to support light and dark theme is later trimmed. readme_content = ( ".. image:: https://raw.githubusercontent.com/colour-science/" - "colour-branding/master/images/Colour_Logo_001.png\n" - + readme_content + "colour-branding/master/images/Colour_Logo_001.png\n" + readme_content ) readme_file.write( re.sub( @@ -410,7 +393,7 @@ def build(ctx: Context): ) ) - ctx.run("poetry build") + ctx.run("uv build") ctx.run("git checkout -- README.rst") ctx.run("twine check dist/*") @@ -433,15 +416,14 @@ def virtualise(ctx: Context, tests: bool = True): ctx.run(f"tar -xvf {PYPI_ARCHIVE_NAME}-{APPLICATION_VERSION}.tar.gz") ctx.run(f"mv {PYPI_ARCHIVE_NAME}-{APPLICATION_VERSION} {unique_name}") with ctx.cd(unique_name): - ctx.run("poetry install") - ctx.run("source $(poetry env info -p)/bin/activate") + ctx.run("uv sync --all-extras --no-dev") ctx.run( - 'python -c "import imageio;' - 'imageio.plugins.freeimage.download()"' + 'uv run python -c "import imageio;imageio.plugins.freeimage.download()"' ) if tests: ctx.run( - "poetry run pytest " + "source .venv/bin/activate && " + "uv run pytest " "--doctest-modules " f"--ignore={PYTHON_PACKAGE_NAME}/examples " f"{PYTHON_PACKAGE_NAME}", @@ -490,9 +472,7 @@ def tag(ctx: Context): remote_tags = result.stdout.strip().split("\n") # pyright: ignore tags = set() for remote_tag in remote_tags: - tags.add( - remote_tag.split("refs/tags/")[1].replace("refs/tags/", "^{}") - ) + tags.add(remote_tag.split("refs/tags/")[1].replace("refs/tags/", "^{}")) version_tags = sorted(tags) if f"v{version}" in version_tags: raise RuntimeError( diff --git a/utilities/export_todo.py b/utilities/export_todo.py index fdd7e1928b..8d18eb9156 100755 --- a/utilities/export_todo.py +++ b/utilities/export_todo.py @@ -40,9 +40,7 @@ https://opensource.org/licenses/BSD-3-Clause | `https://github.com/colour-science/colour \ `__ -"""[ - 1: -] +"""[1:] def extract_todo_items(root_directory: str) -> dict: diff --git a/utilities/generate_plots.py b/utilities/generate_plots.py index 13ae747ca9..20467ecc7f 100755 --- a/utilities/generate_plots.py +++ b/utilities/generate_plots.py @@ -10,15 +10,15 @@ mpl.use("AGG") -import os # noqa: E402 +import os -import matplotlib.pyplot as plt # noqa: E402 -import numpy as np # noqa: E402 -import trimesh # noqa: E402 +import matplotlib.pyplot as plt +import numpy as np +import trimesh -import colour # noqa: E402 -from colour.characterisation import SDS_COLOURCHECKERS # noqa: E402 -from colour.colorimetry import ( # noqa: E402 +import colour +from colour.characterisation import SDS_COLOURCHECKERS +from colour.colorimetry import ( MSDS_CMFS_STANDARD_OBSERVER, SDS_ILLUMINANTS, SDS_LEFS_PHOTOPIC, @@ -30,17 +30,17 @@ sd_mesopic_luminous_efficiency_function, sd_to_XYZ, ) -from colour.geometry import primitive_cube # noqa: E402 -from colour.hints import cast # noqa: E402 -from colour.io import read_image # noqa: E402 -from colour.models import ( # noqa: E402 +from colour.geometry import primitive_cube +from colour.hints import cast +from colour.io import read_image +from colour.models import ( RGB_COLOURSPACE_sRGB, RGB_to_XYZ, XYZ_to_sRGB, XYZ_to_xy, sRGB_to_XYZ, ) -from colour.plotting import ( # noqa: E402 +from colour.plotting import ( ColourSwatch, colour_style, plot_automatic_colour_conversion_graph, @@ -103,29 +103,29 @@ plot_visible_spectrum_section, render, ) -from colour.plotting.diagrams import ( # noqa: E402 +from colour.plotting.diagrams import ( plot_chromaticity_diagram, plot_chromaticity_diagram_colours, plot_sds_in_chromaticity_diagram, plot_spectral_locus, ) -from colour.plotting.models import ( # noqa: E402 +from colour.plotting.models import ( plot_ellipses_MacAdam1942_in_chromaticity_diagram, plot_RGB_chromaticities_in_chromaticity_diagram, plot_RGB_colourspaces_in_chromaticity_diagram, ) -from colour.plotting.quality import plot_colour_quality_bars # noqa: E402 -from colour.plotting.section import ( # noqa: E402 +from colour.plotting.quality import plot_colour_quality_bars +from colour.plotting.section import ( plot_hull_section_colours, plot_hull_section_contour, ) -from colour.plotting.temperature import ( # noqa: E402 +from colour.plotting.temperature import ( plot_daylight_locus, plot_planckian_locus, plot_planckian_locus_in_chromaticity_diagram, ) -from colour.quality import colour_quality_scale # noqa: E402 -from colour.utilities import ( # noqa: E402; noqa: RUF100 +from colour.quality import colour_quality_scale +from colour.utilities import ( # ; noqa: RUF100 domain_range_scale, filter_warnings, ) @@ -173,9 +173,7 @@ def generate_documentation_plots(output_directory: str): ), } plt.close( - plot_visible_spectrum( - "CIE 1931 2 Degree Standard Observer", **arguments - )[0] + plot_visible_spectrum("CIE 1931 2 Degree Standard Observer", **arguments)[0] ) arguments["filename"] = os.path.join( @@ -187,8 +185,7 @@ def generate_documentation_plots(output_directory: str): output_directory, "Examples_Plotting_Blackbodies.png" ) blackbody_sds = [ - sd_blackbody(i, SpectralShape(1, 10001, 10)) - for i in range(1000, 15000, 1000) + sd_blackbody(i, SpectralShape(1, 10001, 10)) for i in range(1000, 15000, 1000) ] plt.close( plot_multi_sds( @@ -256,9 +253,7 @@ def generate_documentation_plots(output_directory: str): output_directory, "Examples_Plotting_Chromaticities_Prediction.png" ) plt.close( - plot_corresponding_chromaticities_prediction( - 2, "Von Kries", **arguments - )[0] + plot_corresponding_chromaticities_prediction(2, "Von Kries", **arguments)[0] ) arguments["filename"] = os.path.join( @@ -276,22 +271,18 @@ def generate_documentation_plots(output_directory: str): )[0] ) - arguments["filename"] = os.path.join( - output_directory, "Examples_Plotting_CRI.png" - ) + arguments["filename"] = os.path.join(output_directory, "Examples_Plotting_CRI.png") plt.close( - plot_single_sd_colour_rendering_index_bars( - SDS_ILLUMINANTS["FL2"], **arguments - )[0] + plot_single_sd_colour_rendering_index_bars(SDS_ILLUMINANTS["FL2"], **arguments)[ + 0 + ] ) arguments["filename"] = os.path.join( output_directory, "Examples_Plotting_Colour_Rendition_Report.png" ) plt.close( - plot_single_sd_colour_rendition_report( - SDS_ILLUMINANTS["FL2"], **arguments - )[0] + plot_single_sd_colour_rendition_report(SDS_ILLUMINANTS["FL2"], **arguments)[0] ) arguments["filename"] = os.path.join( @@ -385,16 +376,12 @@ def generate_documentation_plots(output_directory: str): {"use_sd_colours": True}, {"use_sd_colours": True, "linestyle": "dashed"}, ] - plt.close( - plot_multi_sds([spd1, spd2], plot_kwargs=plot_kwargs, **arguments)[0] - ) + plt.close(plot_multi_sds([spd1, spd2], plot_kwargs=plot_kwargs, **arguments)[0]) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Single_CMFS.png" ) - plt.close( - plot_single_cmfs("CIE 1931 2 Degree Standard Observer", **arguments)[0] - ) + plt.close(plot_single_cmfs("CIE 1931 2 Degree Standard Observer", **arguments)[0]) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Multi_CMFS.png" @@ -429,9 +416,7 @@ def generate_documentation_plots(output_directory: str): output_directory, "Plotting_Plot_Multi_Lightness_Functions.png" ) plt.close( - plot_multi_lightness_functions( - ["CIE 1976", "Wyszecki 1963"], **arguments - )[0] + plot_multi_lightness_functions(["CIE 1976", "Wyszecki 1963"], **arguments)[0] ) arguments["filename"] = os.path.join( @@ -443,26 +428,22 @@ def generate_documentation_plots(output_directory: str): output_directory, "Plotting_Plot_Multi_Luminance_Functions.png" ) plt.close( - plot_multi_luminance_functions( - ["CIE 1976", "Newhall 1943"], **arguments - )[0] + plot_multi_luminance_functions(["CIE 1976", "Newhall 1943"], **arguments)[0] ) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Blackbody_Spectral_Radiance.png" ) plt.close( - plot_blackbody_spectral_radiance( - 3500, blackbody="VY Canis Major", **arguments - )[0] + plot_blackbody_spectral_radiance(3500, blackbody="VY Canis Major", **arguments)[ + 0 + ] ) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Blackbody_Colours.png" ) - plt.close( - plot_blackbody_colours(SpectralShape(150, 12500, 50), **arguments)[0] - ) + plt.close(plot_blackbody_colours(SpectralShape(150, 12500, 50), **arguments)[0]) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Single_Colour_Swatch.png" @@ -492,9 +473,7 @@ def generate_documentation_plots(output_directory: str): } plt.close(plot_multi_functions(functions, **arguments)[0]) - arguments["filename"] = os.path.join( - output_directory, "Plotting_Plot_Image.png" - ) + arguments["filename"] = os.path.join(output_directory, "Plotting_Plot_Image.png") path = os.path.join( colour.__path__[0], # pyright: ignore "examples", @@ -509,26 +488,18 @@ def generate_documentation_plots(output_directory: str): "Plotting_Plot_Corresponding_Chromaticities_Prediction.png", ) plt.close( - plot_corresponding_chromaticities_prediction( - 1, "Von Kries", **arguments - )[0] + plot_corresponding_chromaticities_prediction(1, "Von Kries", **arguments)[0] ) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Spectral_Locus.png" ) - plt.close( - plot_spectral_locus(spectral_locus_colours="RGB", **arguments)[0] - ) + plt.close(plot_spectral_locus(spectral_locus_colours="RGB", **arguments)[0]) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Chromaticity_Diagram_Colours.png" ) - plt.close( - plot_chromaticity_diagram_colours(diagram_colours="RGB", **arguments)[ - 0 - ] - ) + plt.close(plot_chromaticity_diagram_colours(diagram_colours="RGB", **arguments)[0]) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Chromaticity_Diagram.png" @@ -581,25 +552,19 @@ def generate_documentation_plots(output_directory: str): output_directory, "Plotting_Plot_SDS_In_Chromaticity_Diagram_CIE1931.png", ) - plt.close( - plot_sds_in_chromaticity_diagram_CIE1931([A, D65], **arguments)[0] - ) + plt.close(plot_sds_in_chromaticity_diagram_CIE1931([A, D65], **arguments)[0]) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_SDS_In_Chromaticity_Diagram_CIE1960UCS.png", ) - plt.close( - plot_sds_in_chromaticity_diagram_CIE1960UCS([A, D65], **arguments)[0] - ) + plt.close(plot_sds_in_chromaticity_diagram_CIE1960UCS([A, D65], **arguments)[0]) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_SDS_In_Chromaticity_Diagram_CIE1976UCS.png", ) - plt.close( - plot_sds_in_chromaticity_diagram_CIE1976UCS([A, D65], **arguments)[0] - ) + plt.close(plot_sds_in_chromaticity_diagram_CIE1976UCS([A, D65], **arguments)[0]) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Pointer_Gamut.png" @@ -635,8 +600,7 @@ def generate_documentation_plots(output_directory: str): arguments["filename"] = os.path.join( output_directory, - "Plotting_Plot_RGB_Colourspaces_In_" - "Chromaticity_Diagram_CIE1960UCS.png", + "Plotting_Plot_RGB_Colourspaces_In_Chromaticity_Diagram_CIE1960UCS.png", ) plt.close( plot_RGB_colourspaces_in_chromaticity_diagram_CIE1960UCS( @@ -646,8 +610,7 @@ def generate_documentation_plots(output_directory: str): arguments["filename"] = os.path.join( output_directory, - "Plotting_Plot_RGB_Colourspaces_In_" - "Chromaticity_Diagram_CIE1976UCS.png", + "Plotting_Plot_RGB_Colourspaces_In_Chromaticity_Diagram_CIE1976UCS.png", ) plt.close( plot_RGB_colourspaces_in_chromaticity_diagram_CIE1976UCS( @@ -668,8 +631,7 @@ def generate_documentation_plots(output_directory: str): arguments["filename"] = os.path.join( output_directory, - "Plotting_Plot_RGB_Chromaticities_In_" - "Chromaticity_Diagram_CIE1931.png", + "Plotting_Plot_RGB_Chromaticities_In_Chromaticity_Diagram_CIE1931.png", ) plt.close( plot_RGB_chromaticities_in_chromaticity_diagram_CIE1931( @@ -679,8 +641,7 @@ def generate_documentation_plots(output_directory: str): arguments["filename"] = os.path.join( output_directory, - "Plotting_Plot_RGB_Chromaticities_In_" - "Chromaticity_Diagram_CIE1960UCS.png", + "Plotting_Plot_RGB_Chromaticities_In_Chromaticity_Diagram_CIE1960UCS.png", ) plt.close( plot_RGB_chromaticities_in_chromaticity_diagram_CIE1960UCS( @@ -690,8 +651,7 @@ def generate_documentation_plots(output_directory: str): arguments["filename"] = os.path.join( output_directory, - "Plotting_Plot_RGB_Chromaticities_In_" - "Chromaticity_Diagram_CIE1976UCS.png", + "Plotting_Plot_RGB_Chromaticities_In_Chromaticity_Diagram_CIE1976UCS.png", ) plt.close( plot_RGB_chromaticities_in_chromaticity_diagram_CIE1976UCS( @@ -703,41 +663,28 @@ def generate_documentation_plots(output_directory: str): output_directory, "Plotting_Plot_Ellipses_MacAdam1942_In_Chromaticity_Diagram.png", ) - plt.close( - plot_ellipses_MacAdam1942_in_chromaticity_diagram(**arguments)[0] - ) + plt.close(plot_ellipses_MacAdam1942_in_chromaticity_diagram(**arguments)[0]) arguments["filename"] = os.path.join( output_directory, - "Plotting_Plot_Ellipses_MacAdam1942_In_" - "Chromaticity_Diagram_CIE1931.png", - ) - plt.close( - plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1931(**arguments)[ - 0 - ] + "Plotting_Plot_Ellipses_MacAdam1942_In_Chromaticity_Diagram_CIE1931.png", ) + plt.close(plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1931(**arguments)[0]) arguments["filename"] = os.path.join( output_directory, - "Plotting_Plot_Ellipses_MacAdam1942_In_" - "Chromaticity_Diagram_CIE1960UCS.png", + "Plotting_Plot_Ellipses_MacAdam1942_In_Chromaticity_Diagram_CIE1960UCS.png", ) plt.close( - plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1960UCS( - **arguments - )[0] + plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1960UCS(**arguments)[0] ) arguments["filename"] = os.path.join( output_directory, - "Plotting_Plot_Ellipses_MacAdam1942_In_" - "Chromaticity_Diagram_CIE1976UCS.png", + "Plotting_Plot_Ellipses_MacAdam1942_In_Chromaticity_Diagram_CIE1976UCS.png", ) plt.close( - plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1976UCS( - **arguments - )[0] + plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1976UCS(**arguments)[0] ) arguments["filename"] = os.path.join( @@ -837,9 +784,9 @@ def generate_documentation_plots(output_directory: str): output_directory, "Plotting_Plot_Multi_Munsell_Value_Functions.png" ) plt.close( - plot_multi_munsell_value_functions( - ["ASTM D1535", "McCamy 1987"], **arguments - )[0] + plot_multi_munsell_value_functions(["ASTM D1535", "McCamy 1987"], **arguments)[ + 0 + ] ) arguments["filename"] = os.path.join( @@ -862,7 +809,8 @@ def generate_documentation_plots(output_directory: str): cqs_l = colour_quality_scale(light_source, additional_data=True) plt.close( plot_colour_quality_bars( - [cqs_i, cqs_l], **arguments # pyright: ignore + [cqs_i, cqs_l], # pyright: ignore + **arguments, # pyright: ignore )[0] ) @@ -871,9 +819,7 @@ def generate_documentation_plots(output_directory: str): "Plotting_Plot_Single_SD_Colour_Rendering_Index_Bars.png", ) illuminant = SDS_ILLUMINANTS["FL2"] - plt.close( - plot_single_sd_colour_rendering_index_bars(illuminant, **arguments)[0] - ) + plt.close(plot_single_sd_colour_rendering_index_bars(illuminant, **arguments)[0]) arguments["filename"] = os.path.join( output_directory, @@ -891,9 +837,7 @@ def generate_documentation_plots(output_directory: str): "Plotting_Plot_Single_SD_Colour_Quality_Scale_Bars.png", ) illuminant = SDS_ILLUMINANTS["FL2"] - plt.close( - plot_single_sd_colour_quality_scale_bars(illuminant, **arguments)[0] - ) + plt.close(plot_single_sd_colour_quality_scale_bars(illuminant, **arguments)[0]) arguments["filename"] = os.path.join( output_directory, @@ -912,16 +856,12 @@ def generate_documentation_plots(output_directory: str): vertices, faces, _outline = primitive_cube(1, 1, 1, 64, 64, 64) XYZ_vertices = RGB_to_XYZ(vertices["position"] + 0.5, RGB_COLOURSPACE_sRGB) hull = trimesh.Trimesh(XYZ_vertices, faces, process=False) - plt.close( - plot_hull_section_colours(hull, section_colours="RGB", **arguments)[0] - ) + plt.close(plot_hull_section_colours(hull, section_colours="RGB", **arguments)[0]) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Hull_Section_Contour.png" ) - plt.close( - plot_hull_section_contour(hull, section_colours="RGB", **arguments)[0] - ) + plt.close(plot_hull_section_contour(hull, section_colours="RGB", **arguments)[0]) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Visible_Spectrum_Section.png" @@ -944,16 +884,12 @@ def generate_documentation_plots(output_directory: str): arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Daylight_Locus.png" ) - plt.close( - plot_daylight_locus(daylight_locus_colours="RGB", **arguments)[0] - ) + plt.close(plot_daylight_locus(daylight_locus_colours="RGB", **arguments)[0]) arguments["filename"] = os.path.join( output_directory, "Plotting_Plot_Planckian_Locus.png" ) - plt.close( - plot_planckian_locus(planckian_locus_colours="RGB", **arguments)[0] - ) + plt.close(plot_planckian_locus(planckian_locus_colours="RGB", **arguments)[0]) arguments["filename"] = os.path.join( output_directory, @@ -1015,9 +951,7 @@ def generate_documentation_plots(output_directory: str): "Plotting_Plot_Single_SD_Colour_Rendition_Report_Full.png", ) plt.close( - plot_single_sd_colour_rendition_report( - SDS_ILLUMINANTS["FL2"], **arguments - )[0] + plot_single_sd_colour_rendition_report(SDS_ILLUMINANTS["FL2"], **arguments)[0] ) arguments["filename"] = os.path.join( @@ -1076,9 +1010,7 @@ def generate_documentation_plots(output_directory: str): ) plt.close(plot_visible_spectrum(**arguments)[0]) - arguments["filename"] = os.path.join( - output_directory, "Tutorial_Sample_SD.png" - ) + arguments["filename"] = os.path.join(output_directory, "Tutorial_Sample_SD.png") sample_sd_data = { 380: 0.048, 385: 0.051, @@ -1172,14 +1104,12 @@ def generate_documentation_plots(output_directory: str): sd_copy = sd.copy() sd_copy.interpolate(SpectralShape(400, 770, 1)) plt.close( - plot_multi_sds( - [sd, sd_copy], bounding_box=[730, 780, 0.25, 0.5], **arguments - )[0] + plot_multi_sds([sd, sd_copy], bounding_box=[730, 780, 0.25, 0.5], **arguments)[ + 0 + ] ) - arguments["filename"] = os.path.join( - output_directory, "Tutorial_Sample_Swatch.png" - ) + arguments["filename"] = os.path.join(output_directory, "Tutorial_Sample_Swatch.png") sd = SpectralDistribution(sample_sd_data) cmfs = MSDS_CMFS_STANDARD_OBSERVER["CIE 1931 2 Degree Standard Observer"] illuminant = SDS_ILLUMINANTS["D65"] @@ -1194,9 +1124,7 @@ def generate_documentation_plots(output_directory: str): )[0] ) - arguments["filename"] = os.path.join( - output_directory, "Tutorial_Neutral5.png" - ) + arguments["filename"] = os.path.join(output_directory, "Tutorial_Neutral5.png") patch_name = "neutral 5 (.70 D)" patch_sd = SDS_COLOURCHECKERS["ColorChecker N Ohta"][patch_name] with domain_range_scale("1"): @@ -1251,13 +1179,9 @@ def generate_documentation_plots(output_directory: str): arguments["filename"] = os.path.join( output_directory, "Basics_Logo_Small_001_CIE_XYZ.png" ) - RGB = read_image(os.path.join(output_directory, "Logo_Small_001.png"))[ - ..., 0:3 - ] + RGB = read_image(os.path.join(output_directory, "Logo_Small_001.png"))[..., 0:3] XYZ = sRGB_to_XYZ(RGB) - plt.close( - plot_image(XYZ, text_kwargs={"text": "sRGB to XYZ"}, **arguments)[0] - ) + plt.close(plot_image(XYZ, text_kwargs={"text": "sRGB to XYZ"}, **arguments)[0]) if __name__ == "__main__": diff --git a/utilities/mock_for_colour.py b/utilities/mock_for_colour.py index ccdffe27f7..cd744a6313 100644 --- a/utilities/mock_for_colour.py +++ b/utilities/mock_for_colour.py @@ -2,7 +2,7 @@ Mock for Colour =============== -Defines various mock objects to use with +Define various mock objects to use with `Colour `__. """