<commit_before>Basics
======


This page puts an emphasis on basic but important to understand concepts of
**Colour**.

.. contents:: Table of Contents
    :local:
    :depth: 3

Abbreviations
-------------

The following abbreviations are in use in `Colour <https://github.com/colour-science/Colour/>`__:

- **CAM** : Colour Appearance Model
- **CCS** : Chromaticity Coordinates
- **CCTF** : Colour Component Transfer Function
- **CCT** : Correlated Colour Temperature
- **CMY** : Cyan, Magenta, Yellow
- **CMYK** : Cyan, Magenta, Yellow, Black
- **CVD** : Colour Vision Deficiency
- **CV** : Code Value
- **EOTF** : Electro-Optical Transfer Function
- **IDT** : Input Device Transform
- **MSDS** : Multi-Spectral Distributions
- **OETF** : Optical-Electrical Transfer Function
- **OOTF** : Optical-Optical Transfer Function
- **SD** : Spectral Distribution
- **TVS** : Tristimulus Values

N-Dimensional Arrays Support
----------------------------<commit_msg>Add "Object Name Categorisation" section to documentation.<commit_after>Basics
======


This page puts an emphasis on basic but important to understand concepts of
**Colour**.

.. contents:: Table of Contents
    :local:
    :depth: 3

Object Name Categorisation
--------------------------

The API tries to bundle the objects by categories by naming them with common
prefixes which makes introspection and auto-completion easier.

For example, in `IPython <https://ipython.org/>`__ or `Jupyter Notebook <https://jupyter.org/>`__,
most of the definitions pertaining to the spectral distribution handling can
be found as follows:

.. code:: python

    In [1]: import colour

    In [2]: colour.sd_
     sd_blackbody()                            sd_gaussian()                             sd_rayleigh_scattering()                  sd_zeros
     sd_CIE_illuminant_D_series()              sd_mesopic_luminous_efficiency_function() sd_single_led()
     sd_CIE_standard_illuminant_A()            sd_multi_leds()                           sd_to_aces_relative_exposure_values()
     sd_constant()                             sd_ones()                                 sd_to_XYZ

Likewise, for the spectral distribution handling related attributes:

.. code:: python

    In [2]: colour.SD
                      SD_GAUSSIAN_METHODS   SD_TO_XYZ_METHODS     SDS_ILLUMINANTS       SDS_LIGHT_SOURCES
                      SD_MULTI_LEDS_METHODS SDS_COLOURCHECKERS    SDS_LEFS
                      SD_SINGLE_LED_METHODS SDS_FILTERS           SDS_LENSES

Similarly, all the RGB colourspaces can be individually accessed from the
``colour.models`` namespace:

.. code:: python

    In [2]: colour.models.RGB_COLOURSPACE
                             RGB_COLOURSPACE_ACES2065_1           RGB_COLOURSPACE_ACESPROXY            RGB_COLOURSPACE_APPLE_RGB            RGB_COLOURSPACE_BT470_525
                             RGB_COLOURSPACE_ACESCC               RGB_COLOURSPACE_ADOBE_RGB1998        RGB_COLOURSPACE_BEST_RGB             RGB_COLOURSPACE_BT470_625
                             RGB_COLOURSPACE_ACESCCT              RGB_COLOURSPACE_ADOBE_WIDE_GAMUT_RGB RGB_COLOURSPACE_BETA_RGB             RGB_COLOURSPACE_BT709                >
                             RGB_COLOURSPACE_ACESCG               RGB_COLOURSPACE_ALEXA_WIDE_GAMUT     RGB_COLOURSPACE_BT2020               RGB_COLOURSPACE_CIE_RGB

Abbreviations
-------------

The following abbreviations are in use in `Colour <https://github.com/colour-science/Colour/>`__:

- **CAM** : Colour Appearance Model
- **CCS** : Chromaticity Coordinates
- **CCTF** : Colour Component Transfer Function
- **CCT** : Correlated Colour Temperature
- **CMY** : Cyan, Magenta, Yellow
- **CMYK** : Cyan, Magenta, Yellow, Black
- **CVD** : Colour Vision Deficiency
- **CV** : Code Value
- **EOTF** : Electro-Optical Transfer Function
- **IDT** : Input Device Transform
- **MSDS** : Multi-Spectral Distributions
- **OETF** : Optical-Electrical Transfer Function
- **OOTF** : Optical-Optical Transfer Function
- **SD** : Spectral Distribution
- **TVS** : Tristimulus Values

N-Dimensional Arrays Support
----------------------------
{'fraction_non_alphanumeric': 0.11295034079844206, 'fraction_numerical': 0.008276533592989289, 'mean_word_length': 2.473372781065089, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 8, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3548645', 'n_tokens_mistral': 1293, 'n_tokens_neox': 1188, 'n_words': 317}