code
stringlengths
66
870k
docstring
stringlengths
19
26.7k
func_name
stringlengths
1
138
language
stringclasses
1 value
repo
stringlengths
7
68
path
stringlengths
5
324
url
stringlengths
46
389
license
stringclasses
7 values
def test_n_dimensional_F_air_Penndorf1957(self) -> None: """ Test :func:`colour.phenomena.rayleigh.F_air_Penndorf1957` definition n-dimensional arrays support. """ wl = 0.360 n = F_air_Penndorf1957(wl) wl = np.tile(wl, 6) n = np.tile(n, 6) np.tes...
Test :func:`colour.phenomena.rayleigh.F_air_Penndorf1957` definition n-dimensional arrays support.
test_n_dimensional_F_air_Penndorf1957
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_n_dimensional_F_air_Young1981(self) -> None: """ Test :func:`colour.phenomena.rayleigh.F_air_Young1981` definition n-dimensional arrays support. """ wl = 0.360 n = F_air_Young1981(wl) wl = np.tile(wl, 6) n = np.tile(n, 6) np.testing.asse...
Test :func:`colour.phenomena.rayleigh.F_air_Young1981` definition n-dimensional arrays support.
test_n_dimensional_F_air_Young1981
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_F_air_Bates1984(self) -> None: """Test :func:`colour.phenomena.rayleigh.F_air_Bates1984` definition.""" np.testing.assert_allclose( F_air_Bates1984(0.360), 1.051997277711708, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( ...
Test :func:`colour.phenomena.rayleigh.F_air_Bates1984` definition.
test_F_air_Bates1984
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_n_dimensional_F_air_Bates1984(self) -> None: """ Test :func:`colour.phenomena.rayleigh.F_air_Bates1984` definition n-dimensional arrays support. """ wl = 0.360 n = F_air_Bates1984(wl) wl = np.tile(wl, 6) n = np.tile(n, 6) np.testing.asse...
Test :func:`colour.phenomena.rayleigh.F_air_Bates1984` definition n-dimensional arrays support.
test_n_dimensional_F_air_Bates1984
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_F_air_Bodhaine1999(self) -> None: """ Test :func:`colour.phenomena.rayleigh.F_air_Bodhaine1999` definition. """ np.testing.assert_allclose( F_air_Bodhaine1999(0.360), 1.052659005129014, atol=TOLERANCE_ABSOLUTE_TESTS, ) ...
Test :func:`colour.phenomena.rayleigh.F_air_Bodhaine1999` definition.
test_F_air_Bodhaine1999
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_n_dimensional_F_air_Bodhaine1999(self) -> None: """ Test :func:`colour.phenomena.rayleigh.F_air_Bodhaine1999` definition n-dimensional arrays support. """ wl = 0.360 n = F_air_Bodhaine1999(wl) wl = np.tile(wl, 6) n = np.tile(n, 6) np.tes...
Test :func:`colour.phenomena.rayleigh.F_air_Bodhaine1999` definition n-dimensional arrays support.
test_n_dimensional_F_air_Bodhaine1999
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_molecular_density(self) -> None: """Test :func:`colour.phenomena.rayleigh.molecular_density` definition.""" np.testing.assert_allclose( molecular_density(200), 3.669449208173649e19, atol=10000 ) np.testing.assert_allclose( molecular_density(300), 2.4462...
Test :func:`colour.phenomena.rayleigh.molecular_density` definition.
test_molecular_density
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_n_dimensional_molecular_density(self) -> None: """ Test :func:`colour.phenomena.rayleigh.molecular_density` definition n-dimensional arrays support. """ temperature = 200 N_s = molecular_density(temperature) temperature = np.tile(temperature, 6) ...
Test :func:`colour.phenomena.rayleigh.molecular_density` definition n-dimensional arrays support.
test_n_dimensional_molecular_density
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_mean_molecular_weights(self) -> None: """ Test :func:`colour.phenomena.rayleigh.mean_molecular_weights` definition. """ np.testing.assert_allclose( mean_molecular_weights(0), 28.9595, atol=TOLERANCE_ABSOLUTE_TESTS ) np.testing.assert_allclos...
Test :func:`colour.phenomena.rayleigh.mean_molecular_weights` definition.
test_mean_molecular_weights
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_n_dimensional_mean_molecular_weights(self) -> None: """ Test :func:`colour.phenomena.rayleigh.mean_molecular_weights` definition n-dimensional arrays support. """ CO2_c = 300 m_a = mean_molecular_weights(CO2_c) CO2_c = np.tile(CO2_c, 6) m_a = np...
Test :func:`colour.phenomena.rayleigh.mean_molecular_weights` definition n-dimensional arrays support.
test_n_dimensional_mean_molecular_weights
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_gravity_List1968(self) -> None: """Test :func:`colour.phenomena.rayleigh.gravity_List1968` definition.""" np.testing.assert_allclose( gravity_List1968(0.0, 0.0), 978.03560706, atol=TOLERANCE_ABSOLUTE_TESTS, ) np.testing.assert_allclose( ...
Test :func:`colour.phenomena.rayleigh.gravity_List1968` definition.
test_gravity_List1968
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_n_dimensional_gravity_List1968(self) -> None: """ Test :func:`colour.phenomena.rayleigh.gravity_List1968` definition n-dimensional arrays support. """ g = 978.03560706 np.testing.assert_allclose(gravity_List1968(), g, atol=TOLERANCE_ABSOLUTE_TESTS) g = ...
Test :func:`colour.phenomena.rayleigh.gravity_List1968` definition n-dimensional arrays support.
test_n_dimensional_gravity_List1968
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_scattering_cross_section(self) -> None: """ Test :func:`colour.phenomena.rayleigh.scattering_cross_section` definition. """ np.testing.assert_allclose( scattering_cross_section(360 * 10e-8), 2.600908533851937e-26, atol=1e-30, ...
Test :func:`colour.phenomena.rayleigh.scattering_cross_section` definition.
test_scattering_cross_section
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_n_dimensional_scattering_cross_section(self) -> None: """ Test :func:`colour.phenomena.rayleigh.scattering_cross_section` definition n-dimensional arrays support. """ wl = 360 * 10e-8 sigma = scattering_cross_section(wl) sigma = np.tile(sigma, 6) ...
Test :func:`colour.phenomena.rayleigh.scattering_cross_section` definition n-dimensional arrays support.
test_n_dimensional_scattering_cross_section
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_nan_scattering_cross_section(self) -> None: """ Test :func:`colour.phenomena.rayleigh.scattering_cross_section` definition nan support. """ cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] scattering_cross_section(cases, cases, cases)
Test :func:`colour.phenomena.rayleigh.scattering_cross_section` definition nan support.
test_nan_scattering_cross_section
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_rayleigh_optical_depth(self) -> None: """ Test :func:`colour.phenomena.rayleigh.rayleigh_optical_depth` definition. """ np.testing.assert_allclose( rayleigh_optical_depth(360 * 10e-8), 0.560246579231107, atol=TOLERANCE_ABSOLUTE_TESTS,...
Test :func:`colour.phenomena.rayleigh.rayleigh_optical_depth` definition.
test_rayleigh_optical_depth
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_n_dimensional_rayleigh_optical_depth(self) -> None: """ Test :func:`colour.phenomena.rayleigh.rayleigh_optical_depth` definition n-dimensional arrays support. """ wl = 360 * 10e-8 T_R = rayleigh_optical_depth(wl) T_R = np.tile(T_R, 6) np.testing...
Test :func:`colour.phenomena.rayleigh.rayleigh_optical_depth` definition n-dimensional arrays support.
test_n_dimensional_rayleigh_optical_depth
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_nan_rayleigh_optical_depth(self) -> None: """ Test :func:`colour.phenomena.rayleigh.rayleigh_optical_depth` definition nan support. """ cases = [-1.0, 0.0, 1.0, -np.inf, np.inf, np.nan] rayleigh_optical_depth(cases, cases, cases, cases, cases)
Test :func:`colour.phenomena.rayleigh.rayleigh_optical_depth` definition nan support.
test_nan_rayleigh_optical_depth
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def test_sd_rayleigh_scattering(self) -> None: """ Test :func:`colour.phenomena.rayleigh.sd_rayleigh_scattering` definition. """ np.testing.assert_allclose( sd_rayleigh_scattering().values, DATA_SD_RAYLEIGH_SCATTERING, atol=TOLERANCE_ABSOLUTE_...
Test :func:`colour.phenomena.rayleigh.sd_rayleigh_scattering` definition.
test_sd_rayleigh_scattering
python
colour-science/colour
colour/phenomena/tests/test_rayleigh.py
https://github.com/colour-science/colour/blob/master/colour/phenomena/tests/test_rayleigh.py
BSD-3-Clause
def plot_cvd_simulation_Machado2009( RGB: ArrayLike, deficiency: ( Literal["Deuteranomaly", "Protanomaly", "Tritanomaly"] | str ) = "Protanomaly", severity: float = 0.5, M_a: ArrayLike | None = None, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Perform colour vision deficiency si...
Perform colour vision deficiency simulation on specified *RGB* colourspace array using *Machado et al. (2009)* model. Parameters ---------- RGB *RGB* colourspace array. deficiency Colour blindness / vision deficiency type. severity Severity of the colour vision defi...
plot_cvd_simulation_Machado2009
python
colour-science/colour
colour/plotting/blindness.py
https://github.com/colour-science/colour/blob/master/colour/plotting/blindness.py
BSD-3-Clause
def plot_single_colour_checker( colour_checker: (ColourChecker | str) = "ColorChecker24 - After November 2014", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified colour checker. Parameters ---------- colour_checker Color checker to plot. ``colour_checker`` can be of any ty...
Plot specified colour checker. Parameters ---------- colour_checker Color checker to plot. ``colour_checker`` can be of any type or form supported by the :func:`colour.plotting.common.filter_colour_checkers` definition. Other Parameters ---------------- kwargs ...
plot_single_colour_checker
python
colour-science/colour
colour/plotting/characterisation.py
https://github.com/colour-science/colour/blob/master/colour/plotting/characterisation.py
BSD-3-Clause
def plot_multi_colour_checkers( colour_checkers: ColourChecker | str | Sequence[ColourChecker | str], **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot and compares specified colour checkers. Parameters ---------- colour_checkers Color checker to plot, count must be less than or equ...
Plot and compares specified colour checkers. Parameters ---------- colour_checkers Color checker to plot, count must be less than or equal to 2. ``colour_checkers`` elements can be of any type or form supported by the :func:`colour.plotting.common.filter_colour_checkers` defini...
plot_multi_colour_checkers
python
colour-science/colour
colour/plotting/characterisation.py
https://github.com/colour-science/colour/blob/master/colour/plotting/characterisation.py
BSD-3-Clause
def plot_multi_sds( sds: ( Sequence[SpectralDistribution | MultiSpectralDistributions] | SpectralDistribution | MultiSpectralDistributions | ValuesView ), plot_kwargs: dict | List[dict] | None = None, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified spe...
Plot specified spectral distributions. Parameters ---------- sds Spectral distributions or multi-spectral distributions to plot. `sds` can be a single :class:`colour.MultiSpectralDistributions` class instance, a list of :class:`colour.MultiSpectralDistributions` class i...
plot_multi_sds
python
colour-science/colour
colour/plotting/colorimetry.py
https://github.com/colour-science/colour/blob/master/colour/plotting/colorimetry.py
BSD-3-Clause
def plot_single_cmfs( cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ) = "CIE 1931 2 Degree Standard Observer", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified colour matching functions. Parameters ---------- cmfs Colour...
Plot specified colour matching functions. Parameters ---------- cmfs Colour matching functions to plot. ``cmfs`` can be of any type or form supported by the :func:`colour.plotting.common.filter_cmfs` definition. Other Parameters ---------------- kwargs {:func:`colo...
plot_single_cmfs
python
colour-science/colour
colour/plotting/colorimetry.py
https://github.com/colour-science/colour/blob/master/colour/plotting/colorimetry.py
BSD-3-Clause
def plot_multi_cmfs( cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ), **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified colour matching functions. Parameters ---------- cmfs Colour matching functions to plot. ``cmfs`` ele...
Plot specified colour matching functions. Parameters ---------- cmfs Colour matching functions to plot. ``cmfs`` elements can be of any type or form supported by the :func:`colour.plotting.common.filter_cmfs` definition. Other Parameters ---------------- kwargs ...
plot_multi_cmfs
python
colour-science/colour
colour/plotting/colorimetry.py
https://github.com/colour-science/colour/blob/master/colour/plotting/colorimetry.py
BSD-3-Clause
def plot_single_illuminant_sd( illuminant: SpectralDistribution | str, cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ) = "CIE 1931 2 Degree Standard Observer", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified single illuminant spectral d...
Plot specified single illuminant spectral distribution. Parameters ---------- illuminant Illuminant to plot. ``illuminant`` can be of any type or form supported by the :func:`colour.plotting.common.filter_illuminants` definition. cmfs Standard observer colour matching funct...
plot_single_illuminant_sd
python
colour-science/colour
colour/plotting/colorimetry.py
https://github.com/colour-science/colour/blob/master/colour/plotting/colorimetry.py
BSD-3-Clause
def plot_multi_illuminant_sds( illuminants: (SpectralDistribution | str | Sequence[SpectralDistribution | str]), **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified illuminants spectral distributions. Parameters ---------- illuminants Illuminants to plot. ``illuminants`` ele...
Plot specified illuminants spectral distributions. Parameters ---------- illuminants Illuminants to plot. ``illuminants`` elements can be of any type or form supported by the :func:`colour.plotting.common.filter_illuminants` definition. Other Parameters ---------------...
plot_multi_illuminant_sds
python
colour-science/colour
colour/plotting/colorimetry.py
https://github.com/colour-science/colour/blob/master/colour/plotting/colorimetry.py
BSD-3-Clause
def plot_visible_spectrum( cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ) = "CIE 1931 2 Degree Standard Observer", out_of_gamut_clipping: bool = True, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot the visible colours spectrum using specified s...
Plot the visible colours spectrum using specified standard observer *CIE XYZ* colour matching functions. Parameters ---------- cmfs Standard observer colour matching functions used for computing the spectrum domain and colours. ``cmfs`` can be of any type or form supported ...
plot_visible_spectrum
python
colour-science/colour
colour/plotting/colorimetry.py
https://github.com/colour-science/colour/blob/master/colour/plotting/colorimetry.py
BSD-3-Clause
def plot_single_lightness_function( function: Callable | str, **kwargs: Any ) -> Tuple[Figure, Axes]: """ Plot specified *Lightness* function. Parameters ---------- function *Lightness* function to plot. ``function`` can be of any type or form supported by the :func:`colour.plot...
Plot specified *Lightness* function. Parameters ---------- function *Lightness* function to plot. ``function`` can be of any type or form supported by the :func:`colour.plotting.common.filter_passthrough` definition. Other Parameters ---------------- kwargs {:func:...
plot_single_lightness_function
python
colour-science/colour
colour/plotting/colorimetry.py
https://github.com/colour-science/colour/blob/master/colour/plotting/colorimetry.py
BSD-3-Clause
def plot_multi_lightness_functions( functions: Callable | str | Sequence[Callable | str], **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified *Lightness* functions. Parameters ---------- functions *Lightness* functions to plot. ``functions`` elements can be of any ty...
Plot specified *Lightness* functions. Parameters ---------- functions *Lightness* functions to plot. ``functions`` elements can be of any type or form supported by the :func:`colour.plotting.common.filter_passthrough` definition. Other Parameters ---------------- k...
plot_multi_lightness_functions
python
colour-science/colour
colour/plotting/colorimetry.py
https://github.com/colour-science/colour/blob/master/colour/plotting/colorimetry.py
BSD-3-Clause
def plot_single_luminance_function( function: Callable | str, **kwargs: Any ) -> Tuple[Figure, Axes]: """ Plot specified *Luminance* function. Parameters ---------- function *Luminance* function to plot. Other Parameters ---------------- kwargs {:func:`colour.plotti...
Plot specified *Luminance* function. Parameters ---------- function *Luminance* function to plot. Other Parameters ---------------- kwargs {:func:`colour.plotting.artist`, :func:`colour.plotting.plot_multi_functions`, :func:`colour.plotting.render`}, ...
plot_single_luminance_function
python
colour-science/colour
colour/plotting/colorimetry.py
https://github.com/colour-science/colour/blob/master/colour/plotting/colorimetry.py
BSD-3-Clause
def plot_multi_luminance_functions( functions: Callable | str | Sequence[Callable | str], **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified *Luminance* functions. Parameters ---------- functions *Luminance* functions to plot. ``functions`` elements can be of any ty...
Plot specified *Luminance* functions. Parameters ---------- functions *Luminance* functions to plot. ``functions`` elements can be of any type or form supported by the :func:`colour.plotting.common.filter_passthrough` definition. Other Parameters ---------------- k...
plot_multi_luminance_functions
python
colour-science/colour
colour/plotting/colorimetry.py
https://github.com/colour-science/colour/blob/master/colour/plotting/colorimetry.py
BSD-3-Clause
def plot_blackbody_spectral_radiance( temperature: float = 3500, cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ) = "CIE 1931 2 Degree Standard Observer", blackbody: str = "VY Canis Major", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot speci...
Plot specified blackbody spectral radiance. Parameters ---------- temperature Blackbody temperature. cmfs Standard observer colour matching functions used for computing the spectrum domain and colours. ``cmfs`` can be of any type or form supported by the :func:`colo...
plot_blackbody_spectral_radiance
python
colour-science/colour
colour/plotting/colorimetry.py
https://github.com/colour-science/colour/blob/master/colour/plotting/colorimetry.py
BSD-3-Clause
def plot_blackbody_colours( shape: SpectralShape | None = None, cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ) = "CIE 1931 2 Degree Standard Observer", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot blackbody colours. Parameters ------...
Plot blackbody colours. Parameters ---------- shape Spectral shape to use as plot boundaries. cmfs Standard observer colour matching functions used for computing the blackbody colours. ``cmfs`` can be of any type or form supported by the :func:`colour.plotting.commo...
plot_blackbody_colours
python
colour-science/colour
colour/plotting/colorimetry.py
https://github.com/colour-science/colour/blob/master/colour/plotting/colorimetry.py
BSD-3-Clause
def colour_style(use_style: bool = True) -> dict: """ Get *Colour* plotting style. Parameters ---------- use_style Whether to use the style and load it into *Matplotlib*. Returns ------- :class:`dict` *Colour* style. """ constants = CONSTANTS_COLOUR_STYLE s...
Get *Colour* plotting style. Parameters ---------- use_style Whether to use the style and load it into *Matplotlib*. Returns ------- :class:`dict` *Colour* style.
colour_style
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def override_style(**kwargs: Any) -> Callable: """ Decorate a function to override *Matplotlib* style. Other Parameters ---------------- kwargs Keywords arguments. Returns ------- Callable Examples -------- >>> @override_style(**{"text.color": "red"}) ... def f...
Decorate a function to override *Matplotlib* style. Other Parameters ---------------- kwargs Keywords arguments. Returns ------- Callable Examples -------- >>> @override_style(**{"text.color": "red"}) ... def f(*args, **kwargs): ... plt.text(0.5, 0.5, "Thi...
override_style
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def font_scaling(scaling: LiteralFontScaling, value: float) -> Generator: """ Define a context manager setting temporarily a *Matplotlib* font scaling. Parameters ---------- scaling Font scaling to temporarily set. value Value to temporarily set the font scaling with. Yield...
Define a context manager setting temporarily a *Matplotlib* font scaling. Parameters ---------- scaling Font scaling to temporarily set. value Value to temporarily set the font scaling with. Yields ------ Generator. Examples -------- >>> with font_scaling(...
font_scaling
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def XYZ_to_plotting_colourspace( XYZ: ArrayLike, illuminant: ArrayLike = RGB_COLOURSPACES["sRGB"].whitepoint, chromatic_adaptation_transform: ( LiteralChromaticAdaptationTransform | str | None ) = "CAT02", apply_cctf_encoding: bool = True, ) -> NDArrayFloat: """ Convert from *CIE XYZ...
Convert from *CIE XYZ* tristimulus values to the default plotting colourspace. Parameters ---------- XYZ *CIE XYZ* tristimulus values. illuminant Source illuminant chromaticity coordinates. chromatic_adaptation_transform *Chromatic adaptation* transform. apply_c...
XYZ_to_plotting_colourspace
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def colour_cycle(**kwargs: Any) -> itertools.cycle: """ Create a colour cycle iterator using specified colour map. Other Parameters ---------------- colour_cycle_map Matplotlib colourmap name. colour_cycle_count Colours count to pick in the colourmap. Returns ------- ...
Create a colour cycle iterator using specified colour map. Other Parameters ---------------- colour_cycle_map Matplotlib colourmap name. colour_cycle_count Colours count to pick in the colourmap. Returns ------- :class:`itertools.cycle` Colour cycle iterator. ...
colour_cycle
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def artist(**kwargs: KwargsArtist | Any) -> Tuple[Figure, Axes]: """ Get the current figure and its axes or create a new one. Other Parameters ---------------- kwargs {:func:`colour.plotting.common.KwargsArtist`}, See the documentation of the previously listed class. Returns ...
Get the current figure and its axes or create a new one. Other Parameters ---------------- kwargs {:func:`colour.plotting.common.KwargsArtist`}, See the documentation of the previously listed class. Returns ------- :class:`tuple` Current figure and axes.
artist
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def camera(**kwargs: KwargsCamera | Any) -> Tuple[Figure, Axes3D]: """ Set the camera settings. Other Parameters ---------------- kwargs {:func:`colour.plotting.common.KwargsCamera`}, See the documentation of the previously listed class. Returns ------- :class:`tuple` ...
Set the camera settings. Other Parameters ---------------- kwargs {:func:`colour.plotting.common.KwargsCamera`}, See the documentation of the previously listed class. Returns ------- :class:`tuple` Current figure and axes.
camera
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def render( **kwargs: KwargsRender | Any, ) -> Tuple[Figure, Axes] | Tuple[Figure, Axes3D]: """ Render the current figure while adjusting various settings such as the bounding box, the title or background transparency. Other Parameters ---------------- kwargs {:func:`colour.plotting...
Render the current figure while adjusting various settings such as the bounding box, the title or background transparency. Other Parameters ---------------- kwargs {:func:`colour.plotting.common.KwargsRender`}, See the documentation of the previously listed class. Returns ...
render
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def label_rectangles( labels: Sequence[str | Real], rectangles: Sequence[Patch], rotation: Literal["horizontal", "vertical"] | str = "vertical", text_size: float = CONSTANTS_COLOUR_STYLE.font.scaling.medium, offset: ArrayLike | None = None, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Ad...
Add labels above specified rectangles. Parameters ---------- labels Labels to display. rectangles Rectangles to used to set the labels value and position. rotation Labels orientation. text_size Labels text size. offset Labels offset as percentage...
label_rectangles
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def uniform_axes3d(**kwargs: Any) -> Tuple[Figure, Axes3D]: """ Set equal aspect ratio to specified 3d axes. Other Parameters ---------------- figure Figure to apply the render elements onto. axes Axes to apply the render elements onto. Returns ------- :class:`tuple...
Set equal aspect ratio to specified 3d axes. Other Parameters ---------------- figure Figure to apply the render elements onto. axes Axes to apply the render elements onto. Returns ------- :class:`tuple` Current figure and axes.
uniform_axes3d
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def filter_passthrough( mapping: Mapping, filterers: Any | str | Sequence[Any | str], allow_non_siblings: bool = True, ) -> dict: """ Filter mapping objects matching specified filterers while passing through class instances whose type is one of the mapping element types. This definition all...
Filter mapping objects matching specified filterers while passing through class instances whose type is one of the mapping element types. This definition allows passing custom but compatible objects to the various plotting definitions that by default expect the key from a dataset element. For exa...
filter_passthrough
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def filter_RGB_colourspaces( filterers: ( RGB_Colourspace | LiteralRGBColourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] ), allow_non_siblings: bool = True, ) -> Dict[str, RGB_Colourspace]: """ Filter the *RGB* colourspaces matching specified ...
Filter the *RGB* colourspaces matching specified filterers. Parameters ---------- filterers Filterer or :class:`colour.RGB_Colourspace` class instance (which is passed through directly if its type is one of the mapping element types) or list of filterers. ``filterers`` elements...
filter_RGB_colourspaces
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def filter_cmfs( filterers: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ), allow_non_siblings: bool = True, ) -> Dict[str, MultiSpectralDistributions]: """ Filter the colour matching functions matching specified filterers. Parameters ---------- ...
Filter the colour matching functions matching specified filterers. Parameters ---------- filterers Filterer or :class:`colour.LMS_ConeFundamentals`, :class:`colour.RGB_ColourMatchingFunctions` or :class:`colour.XYZ_ColourMatchingFunctions` class instance (which is passe...
filter_cmfs
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def filter_illuminants( filterers: SpectralDistribution | str | Sequence[SpectralDistribution | str], allow_non_siblings: bool = True, ) -> Dict[str, SpectralDistribution]: """ Filter the illuminants matching specified filterers. Parameters ---------- filterers Filterer or :class:`c...
Filter the illuminants matching specified filterers. Parameters ---------- filterers Filterer or :class:`colour.SpectralDistribution` class instance (which is passed through directly if its type is one of the mapping element types) or list of filterers. ``filterers`` elements c...
filter_illuminants
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def filter_colour_checkers( filterers: ColourChecker | str | Sequence[ColourChecker | str], allow_non_siblings: bool = True, ) -> Dict[str, ColourChecker]: """ Filter the colour checkers matching specified filterers. Parameters ---------- filterers Filterer or :class:`colour.charact...
Filter the colour checkers matching specified filterers. Parameters ---------- filterers Filterer or :class:`colour.characterisation.ColourChecker` class instance (which is passed through directly if its type is one of the mapping element types) or list of filterers. ``filterer...
filter_colour_checkers
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def update_settings_collection( settings_collection: dict | List[dict], keyword_arguments: dict | List[dict], expected_count: int, ) -> None: """ Update specified settings collection, *in-place*, with specified keyword arguments and expected count of settings collection elements. Parameters...
Update specified settings collection, *in-place*, with specified keyword arguments and expected count of settings collection elements. Parameters ---------- settings_collection Settings collection to update. keyword_arguments Keyword arguments to update the settings collection....
update_settings_collection
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def plot_single_colour_swatch( colour_swatch: ArrayLike | ColourSwatch, **kwargs: Any ) -> Tuple[Figure, Axes]: """ Plot specified colour swatch. Parameters ---------- colour_swatch Colour swatch, either a regular `ArrayLike` or a :class:`colour.plotting.ColourSwatch` class inst...
Plot specified colour swatch. Parameters ---------- colour_swatch Colour swatch, either a regular `ArrayLike` or a :class:`colour.plotting.ColourSwatch` class instance. Other Parameters ---------------- kwargs {:func:`colour.plotting.artist`, :func:`colour....
plot_single_colour_swatch
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def plot_multi_colour_swatches( colour_swatches: ArrayLike | Sequence[ArrayLike | ColourSwatch], width: float = 1, height: float = 1, spacing: float = 0, columns: int | None = None, direction: Literal["+y", "-y"] | str = "+y", text_kwargs: dict | None = None, background_colour: ArrayLike...
Plot specified colours swatches. Parameters ---------- colour_swatches Colour swatch sequence, either a regular `ArrayLike` or a sequence of :class:`colour.plotting.ColourSwatch` class instances. width Colour swatch width. height Colour swatch height. spacin...
plot_multi_colour_swatches
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def plot_single_function( function: Callable, samples: ArrayLike | None = None, log_x: int | None = None, log_y: int | None = None, plot_kwargs: dict | List[dict] | None = None, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified function. Parameters ---------- funct...
Plot specified function. Parameters ---------- function Function to plot. samples Samples to evaluate the functions with. log_x Log base to use for the *x* axis scale, if *None*, the *x* axis scale will be linear. log_y Log base to use for the *y* ax...
plot_single_function
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def plot_multi_functions( functions: Dict[str, Callable], samples: ArrayLike | None = None, log_x: int | None = None, log_y: int | None = None, plot_kwargs: dict | List[dict] | None = None, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified functions. Parameters -------...
Plot specified functions. Parameters ---------- functions Functions to plot. samples Samples to evaluate the functions with. log_x Log base to use for the *x* axis scale, if *None*, the *x* axis scale will be linear. log_y Log base to use for the *y*...
plot_multi_functions
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def plot_image( image: ArrayLike, imshow_kwargs: dict | None = None, text_kwargs: dict | None = None, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified image. Parameters ---------- image Image to plot. imshow_kwargs Keyword arguments for the :func:`matp...
Plot specified image. Parameters ---------- image Image to plot. imshow_kwargs Keyword arguments for the :func:`matplotlib.pyplot.imshow` definition. text_kwargs Keyword arguments for the :func:`matplotlib.pyplot.text` definition. The following special keyword a...
plot_image
python
colour-science/colour
colour/plotting/common.py
https://github.com/colour-science/colour/blob/master/colour/plotting/common.py
BSD-3-Clause
def mpl_headless_backend() -> Generator[None, None, None]: """ Configure *Matplotlib* for headless testing. This pytest fixture is automatically applied to any tests in this package or any subpackages at the beginning of the pytest session. Yields ------ Generator *Matplotlib* unit...
Configure *Matplotlib* for headless testing. This pytest fixture is automatically applied to any tests in this package or any subpackages at the beginning of the pytest session. Yields ------ Generator *Matplotlib* unit tests.
mpl_headless_backend
python
colour-science/colour
colour/plotting/conftest.py
https://github.com/colour-science/colour/blob/master/colour/plotting/conftest.py
BSD-3-Clause
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", ] | s...
Plot specified chromatic adaptation model corresponding chromaticities prediction. Parameters ---------- experiment *Breneman (1987)* experiment number or :class:`colour.CorrespondingColourDataset` class instance. model Corresponding chromaticities prediction model name...
plot_corresponding_chromaticities_prediction
python
colour-science/colour
colour/plotting/corresponding.py
https://github.com/colour-science/colour/blob/master/colour/plotting/corresponding.py
BSD-3-Clause
def lines_spectral_locus( 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", ) -> Tuple[NDArray, NDArray...
Return the *Spectral Locus* line vertices, i.e., positions, normals and colours, according to specified method. Parameters ---------- cmfs Standard observer colour matching functions used for computing the spectral locus boundaries. ``cmfs`` can be of any type or form suppo...
lines_spectral_locus
python
colour-science/colour
colour/plotting/diagrams.py
https://github.com/colour-science/colour/blob/master/colour/plotting/diagrams.py
BSD-3-Clause
def plot_spectral_locus( 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, ...
Plot the *Spectral Locus* according to specified method. Parameters ---------- cmfs Standard observer colour matching functions used for computing the spectral locus boundaries. ``cmfs`` can be of any type or form supported by the :func:`colour.plotting.common.filter_cmfs` defi...
plot_spectral_locus
python
colour-science/colour
colour/plotting/diagrams.py
https://github.com/colour-science/colour/blob/master/colour/plotting/diagrams.py
BSD-3-Clause
def plot_chromaticity_diagram_colours( samples: int = 256, 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 Deg...
Plot the *Chromaticity Diagram* colours according to specified method. Parameters ---------- samples Sample count on one axis when computing the *Chromaticity Diagram* colours. diagram_colours Colours of the *Chromaticity Diagram*, if ``diagram_colours`` is set to *...
plot_chromaticity_diagram_colours
python
colour-science/colour
colour/plotting/diagrams.py
https://github.com/colour-science/colour/blob/master/colour/plotting/diagrams.py
BSD-3-Clause
def plot_chromaticity_diagram( 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"] | ...
Plot the *Chromaticity Diagram* according to specified method. Parameters ---------- cmfs Standard observer colour matching functions used for computing the spectral locus boundaries. ``cmfs`` can be of any type or form supported by the :func:`colour.plotting.common.filter_cmfs...
plot_chromaticity_diagram
python
colour-science/colour
colour/plotting/diagrams.py
https://github.com/colour-science/colour/blob/master/colour/plotting/diagrams.py
BSD-3-Clause
def plot_chromaticity_diagram_CIE1931( cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ) = "CIE 1931 2 Degree Standard Observer", show_diagram_colours: bool = True, show_spectral_locus: bool = True, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Pl...
Plot the *CIE 1931 Chromaticity Diagram*. Parameters ---------- cmfs Standard observer colour matching functions used for computing the spectral locus boundaries. ``cmfs`` can be of any type or form supported by the :func:`colour.plotting.common.filter_cmfs` definition. sho...
plot_chromaticity_diagram_CIE1931
python
colour-science/colour
colour/plotting/diagrams.py
https://github.com/colour-science/colour/blob/master/colour/plotting/diagrams.py
BSD-3-Clause
def plot_chromaticity_diagram_CIE1960UCS( cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ) = "CIE 1931 2 Degree Standard Observer", show_diagram_colours: bool = True, show_spectral_locus: bool = True, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ ...
Plot the *CIE 1960 UCS Chromaticity Diagram*. Parameters ---------- cmfs Standard observer colour matching functions used for computing the spectral locus boundaries. ``cmfs`` can be of any type or form supported by the :func:`colour.plotting.common.filter_cmfs` definition. ...
plot_chromaticity_diagram_CIE1960UCS
python
colour-science/colour
colour/plotting/diagrams.py
https://github.com/colour-science/colour/blob/master/colour/plotting/diagrams.py
BSD-3-Clause
def plot_chromaticity_diagram_CIE1976UCS( cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ) = "CIE 1931 2 Degree Standard Observer", show_diagram_colours: bool = True, show_spectral_locus: bool = True, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ ...
Plot the *CIE 1976 UCS Chromaticity Diagram*. Parameters ---------- cmfs Standard observer colour matching functions used for computing the spectral locus boundaries. ``cmfs`` can be of any type or form supported by the :func:`colour.plotting.common.filter_cmfs` definition. ...
plot_chromaticity_diagram_CIE1976UCS
python
colour-science/colour
colour/plotting/diagrams.py
https://github.com/colour-science/colour/blob/master/colour/plotting/diagrams.py
BSD-3-Clause
def plot_sds_in_chromaticity_diagram( sds: ( Sequence[SpectralDistribution | MultiSpectralDistributions] | SpectralDistribution | MultiSpectralDistributions | ValuesView ), cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ) = "...
Plot specified spectral distribution chromaticity coordinates into the *Chromaticity Diagram* using specified method. Parameters ---------- sds Spectral distributions or multi-spectral distributions to plot. `sds` can be a single :class:`colour.MultiSpectralDistributions` c...
plot_sds_in_chromaticity_diagram
python
colour-science/colour
colour/plotting/diagrams.py
https://github.com/colour-science/colour/blob/master/colour/plotting/diagrams.py
BSD-3-Clause
def plot_sds_in_chromaticity_diagram_CIE1931( sds: ( Sequence[SpectralDistribution | MultiSpectralDistributions] | SpectralDistribution | MultiSpectralDistributions | ValuesView ), cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ...
Plot specified spectral distribution chromaticity coordinates into the *CIE 1931 Chromaticity Diagram*. Parameters ---------- sds Spectral distributions or multi-spectral distributions to plot. `sds` can be a single :class:`colour.MultiSpectralDistributions` class instance,...
plot_sds_in_chromaticity_diagram_CIE1931
python
colour-science/colour
colour/plotting/diagrams.py
https://github.com/colour-science/colour/blob/master/colour/plotting/diagrams.py
BSD-3-Clause
def plot_sds_in_chromaticity_diagram_CIE1960UCS( sds: ( Sequence[SpectralDistribution | MultiSpectralDistributions] | SpectralDistribution | MultiSpectralDistributions | ValuesView ), cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str...
Plot specified spectral distribution chromaticity coordinates into the *CIE 1960 UCS Chromaticity Diagram*. Parameters ---------- sds Spectral distributions or multi-spectral distributions to plot. `sds` can be a single :class:`colour.MultiSpectralDistributions` class insta...
plot_sds_in_chromaticity_diagram_CIE1960UCS
python
colour-science/colour
colour/plotting/diagrams.py
https://github.com/colour-science/colour/blob/master/colour/plotting/diagrams.py
BSD-3-Clause
def plot_sds_in_chromaticity_diagram_CIE1976UCS( sds: ( Sequence[SpectralDistribution | MultiSpectralDistributions] | SpectralDistribution | MultiSpectralDistributions | ValuesView ), cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str...
Plot specified spectral distribution chromaticity coordinates into the *CIE 1976 UCS Chromaticity Diagram*. Parameters ---------- sds Spectral distributions or multi-spectral distributions to plot. `sds` can be a single :class:`colour.MultiSpectralDistributions` class insta...
plot_sds_in_chromaticity_diagram_CIE1976UCS
python
colour-science/colour
colour/plotting/diagrams.py
https://github.com/colour-science/colour/blob/master/colour/plotting/diagrams.py
BSD-3-Clause
def plot_automatic_colour_conversion_graph( filename: str, 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 <https://www.graphviz.org>`__ and...
Plot *Colour* automatic colour conversion graph using `Graphviz <https://www.graphviz.org>`__ and `pyraphviz <https://pygraphviz.github.io>`__. Parameters ---------- filename Filename to use to save the image. prog *Graphviz* layout method. Returns ------- :cla...
plot_automatic_colour_conversion_graph
python
colour-science/colour
colour/plotting/graph.py
https://github.com/colour-science/colour/blob/master/colour/plotting/graph.py
BSD-3-Clause
def colourspace_model_axis_reorder( a: ArrayLike, model: LiteralColourspaceModel | str, direction: Literal["Forward", "Inverse"] | str = "Forward", ) -> NDArrayFloat: """ Reorder the axes of specified colourspace model :math:`a` array according to the most common volume plotting axes order. ...
Reorder the axes of specified colourspace model :math:`a` array according to the most common volume plotting axes order. Parameters ---------- a Colourspace model :math:`a` array. model Colourspace model, see :attr:`colour.COLOURSPACE_MODELS` attribute for the list of s...
colourspace_model_axis_reorder
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def lines_pointer_gamut( method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", ) -> tuple[NDArray, NDArray]: """ Return the *Pointer's Gamut* line vertices, i.e., positions, normals and colours, according to specified method. Parameters ---------- method ...
Return the *Pointer's Gamut* line vertices, i.e., positions, normals and colours, according to specified method. Parameters ---------- method *Chromaticity Diagram* method. Returns ------- :class:`tuple` Tuple of *Pointer's Gamut* boundary and volume vertices. Exa...
lines_pointer_gamut
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_pointer_gamut( pointer_gamut_colours: ArrayLike | str | None = None, pointer_gamut_opacity: float = 1, method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot *Pointer's Gamut* according to specified method. ...
Plot *Pointer's Gamut* according to specified method. Parameters ---------- pointer_gamut_colours Colours of the *Pointer's Gamut*. pointer_gamut_opacity Opacity of the *Pointer's Gamut*. method Plotting method. Other Parameters ---------------- kwargs ...
plot_pointer_gamut
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_RGB_colourspaces_in_chromaticity_diagram( colourspaces: ( RGB_Colourspace | LiteralRGBColourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] ), cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ) = ...
Plot specified *RGB* colourspaces in the *Chromaticity Diagram* according to specified method. Parameters ---------- colourspaces *RGB* colourspaces to plot. ``colourspaces`` elements can be of any type or form supported by the :func:`colour.plotting.common.filter_RGB_colou...
plot_RGB_colourspaces_in_chromaticity_diagram
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_RGB_colourspaces_in_chromaticity_diagram_CIE1931( colourspaces: ( RGB_Colourspace | LiteralRGBColourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] ), cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ...
Plot specified *RGB* colourspaces in the *CIE 1931 Chromaticity Diagram*. Parameters ---------- colourspaces *RGB* colourspaces to plot. ``colourspaces`` elements can be of any type or form supported by the :func:`colour.plotting.common.filter_RGB_colourspaces` definition. ...
plot_RGB_colourspaces_in_chromaticity_diagram_CIE1931
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_RGB_colourspaces_in_chromaticity_diagram_CIE1960UCS( colourspaces: ( RGB_Colourspace | LiteralRGBColourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] ), cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | st...
Plot specified *RGB* colourspaces in the *CIE 1960 UCS Chromaticity Diagram*. Parameters ---------- colourspaces *RGB* colourspaces to plot. ``colourspaces`` elements can be of any type or form supported by the :func:`colour.plotting.common.filter_RGB_colourspaces` definition. ...
plot_RGB_colourspaces_in_chromaticity_diagram_CIE1960UCS
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_RGB_colourspaces_in_chromaticity_diagram_CIE1976UCS( colourspaces: ( RGB_Colourspace | LiteralRGBColourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] ), cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | st...
Plot specified *RGB* colourspaces in the *CIE 1976 UCS Chromaticity Diagram*. Parameters ---------- colourspaces *RGB* colourspaces to plot. ``colourspaces`` elements can be of any type or form supported by the :func:`colour.plotting.common.filter_RGB_colourspaces` definition. ...
plot_RGB_colourspaces_in_chromaticity_diagram_CIE1976UCS
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_RGB_chromaticities_in_chromaticity_diagram( RGB: ArrayLike, colourspace: ( RGB_Colourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] ) = "sRGB", chromaticity_diagram_callable: Callable = ( plot_RGB_colourspaces_in_chromaticity_diagram ), method: (Li...
Plot specified *RGB* colourspace array in the *Chromaticity Diagram* according to specified method. Parameters ---------- RGB *RGB* colourspace array. colourspace *RGB* colourspace of the *RGB* array. ``colourspace`` can be of any type or form supported by the :...
plot_RGB_chromaticities_in_chromaticity_diagram
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_RGB_chromaticities_in_chromaticity_diagram_CIE1931( RGB: ArrayLike, colourspace: ( RGB_Colourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] ) = "sRGB", chromaticity_diagram_callable_CIE1931: Callable = ( plot_RGB_colourspaces_in_chromaticity_diagram_CIE193...
Plot specified *RGB* colourspace array in the *CIE 1931 Chromaticity Diagram*. Parameters ---------- RGB *RGB* colourspace array. colourspace *RGB* colourspace of the *RGB* array. ``colourspace`` can be of any type or form supported by the :func:`colour.plotting.com...
plot_RGB_chromaticities_in_chromaticity_diagram_CIE1931
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_RGB_chromaticities_in_chromaticity_diagram_CIE1960UCS( RGB: ArrayLike, colourspace: ( RGB_Colourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] ) = "sRGB", chromaticity_diagram_callable_CIE1960UCS: Callable = ( plot_RGB_colourspaces_in_chromaticity_diagram_...
Plot specified *RGB* colourspace array in the *CIE 1960 UCS Chromaticity Diagram*. Parameters ---------- RGB *RGB* colourspace array. colourspace *RGB* colourspace of the *RGB* array. ``colourspace`` can be of any type or form supported by the :func:`colour.plot...
plot_RGB_chromaticities_in_chromaticity_diagram_CIE1960UCS
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_RGB_chromaticities_in_chromaticity_diagram_CIE1976UCS( RGB: ArrayLike, colourspace: ( RGB_Colourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] ) = "sRGB", chromaticity_diagram_callable_CIE1976UCS: Callable = ( plot_RGB_colourspaces_in_chromaticity_diagram_...
Plot specified *RGB* colourspace array in the *CIE 1976 UCS Chromaticity Diagram*. Parameters ---------- RGB *RGB* colourspace array. colourspace *RGB* colourspace of the *RGB* array. ``colourspace`` can be of any type or form supported by the :func:`colour.plot...
plot_RGB_chromaticities_in_chromaticity_diagram_CIE1976UCS
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def ellipses_MacAdam1942( method: (Literal["CIE 1931", "CIE 1960 UCS", "CIE 1976 UCS"] | str) = "CIE 1931", ) -> List[NDArrayFloat]: """ Return *MacAdam (1942) Ellipses (Observer PGN)* coefficients according to specified method. Parameters ---------- method Computation method. ...
Return *MacAdam (1942) Ellipses (Observer PGN)* coefficients according to specified method. Parameters ---------- method Computation method. Returns ------- :class:`list` *MacAdam (1942) Ellipses (Observer PGN)* coefficients. Examples -------- >>> ellipses...
ellipses_MacAdam1942
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
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", chromaticity_diagram_clipping: bool = False, ellipse_kwargs: dict | List[dict] | None = None, ...
Plot *MacAdam (1942) Ellipses (Observer PGN)* in the *Chromaticity Diagram* according to specified method. Parameters ---------- chromaticity_diagram_callable Callable responsible for drawing the *Chromaticity Diagram*. method *Chromaticity Diagram* method. chromaticity_dia...
plot_ellipses_MacAdam1942_in_chromaticity_diagram
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1931( chromaticity_diagram_callable_CIE1931: Callable = ( plot_chromaticity_diagram_CIE1931 ), chromaticity_diagram_clipping: bool = False, ellipse_kwargs: dict | List[dict] | None = None, **kwargs: Any, ) -> Tuple[Figure, Axes]: "...
Plot *MacAdam (1942) Ellipses (Observer PGN)* in the *CIE 1931 Chromaticity Diagram*. Parameters ---------- chromaticity_diagram_callable_CIE1931 Callable responsible for drawing the *CIE 1931 Chromaticity Diagram*. chromaticity_diagram_clipping Whether to clip the *CIE 1931 Ch...
plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1931
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1960UCS( chromaticity_diagram_callable_CIE1960UCS: Callable = ( plot_chromaticity_diagram_CIE1960UCS ), chromaticity_diagram_clipping: bool = False, ellipse_kwargs: dict | List[dict] | None = None, **kwargs: Any, ) -> Tuple[Figure, Axe...
Plot *MacAdam (1942) Ellipses (Observer PGN)* in the *CIE 1960 UCS Chromaticity Diagram*. Parameters ---------- chromaticity_diagram_callable_CIE1960UCS Callable responsible for drawing the *CIE 1960 UCS Chromaticity Diagram*. chromaticity_diagram_clipping Whether to cl...
plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1960UCS
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1976UCS( chromaticity_diagram_callable_CIE1976UCS: Callable = ( plot_chromaticity_diagram_CIE1976UCS ), chromaticity_diagram_clipping: bool = False, ellipse_kwargs: dict | List[dict] | None = None, **kwargs: Any, ) -> Tuple[Figure, Axe...
Plot *MacAdam (1942) Ellipses (Observer PGN)* in the *CIE 1976 UCS Chromaticity Diagram*. Parameters ---------- chromaticity_diagram_callable_CIE1976UCS Callable responsible for drawing the *CIE 1976 UCS Chromaticity Diagram*. chromaticity_diagram_clipping Whether to cl...
plot_ellipses_MacAdam1942_in_chromaticity_diagram_CIE1976UCS
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_single_cctf( cctf: Callable | str, cctf_decoding: bool = False, **kwargs: Any ) -> Tuple[Figure, Axes]: """ Plot specified colourspace colour component transfer function. Parameters ---------- cctf Colour component transfer function to plot. ``function`` can be of any t...
Plot specified colourspace colour component transfer function. Parameters ---------- cctf Colour component transfer function to plot. ``function`` can be of any type or form supported by the :func:`colour.plotting.common.filter_passthrough` definition. cctf_decoding ...
plot_single_cctf
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_multi_cctfs( cctfs: Callable | str | Sequence[Callable | str], cctf_decoding: bool = False, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified colour component transfer functions. Parameters ---------- cctfs Colour component transfer function to plot. ``cctfs``...
Plot specified colour component transfer functions. Parameters ---------- cctfs Colour component transfer function to plot. ``cctfs`` elements can be of any type or form supported by the :func:`colour.plotting.common.filter_passthrough` definition. cctf_decoding Plo...
plot_multi_cctfs
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_constant_hue_loci( data: ArrayLike, model: LiteralColourspaceModel | str = "CIE Lab", scatter_kwargs: dict | None = None, convert_kwargs: dict | None = None, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified constant hue loci colour matches data such as that from :cite...
Plot specified constant hue loci colour matches data such as that from :cite:`Hung1995` or :cite:`Ebner1998` that are easily loaded with `Colour - Datasets <https://github.com/colour-science/colour-datasets>`__. Parameters ---------- data Constant hue loci colour matches data expected ...
plot_constant_hue_loci
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def _linear_equation( x: NDArrayFloat, a: NDArrayFloat, b: NDArrayFloat ) -> NDArrayFloat: """Define the canonical linear equation for a line.""" return a * x + b
Define the canonical linear equation for a line.
_linear_equation
python
colour-science/colour
colour/plotting/models.py
https://github.com/colour-science/colour/blob/master/colour/plotting/models.py
BSD-3-Clause
def plot_single_munsell_value_function( function: Callable | str, **kwargs: Any ) -> Tuple[Figure, Axes]: """ Plot specified *Lightness* function. Parameters ---------- function *Munsell* value function to plot. ``function`` can be of any type or form supported by the :func:`col...
Plot specified *Lightness* function. Parameters ---------- function *Munsell* value function to plot. ``function`` can be of any type or form supported by the :func:`colour.plotting.common.filter_passthrough` definition. Other Parameters ---------------- kwargs ...
plot_single_munsell_value_function
python
colour-science/colour
colour/plotting/notation.py
https://github.com/colour-science/colour/blob/master/colour/plotting/notation.py
BSD-3-Clause
def plot_multi_munsell_value_functions( functions: Callable | str | Sequence[Callable | str], **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot specified *Munsell* value functions. Parameters ---------- functions *Munsell* value functions to plot. ``functions`` elements can be of an...
Plot specified *Munsell* value functions. Parameters ---------- functions *Munsell* value functions to plot. ``functions`` elements can be of any type or form supported by the :func:`colour.plotting.common.filter_passthrough` definition. Other Parameters --------------...
plot_multi_munsell_value_functions
python
colour-science/colour
colour/plotting/notation.py
https://github.com/colour-science/colour/blob/master/colour/plotting/notation.py
BSD-3-Clause
def plot_single_sd_rayleigh_scattering( CO2_concentration: ArrayLike = CONSTANT_STANDARD_CO2_CONCENTRATION, temperature: ArrayLike = CONSTANT_STANDARD_AIR_TEMPERATURE, pressure: ArrayLike = CONSTANT_AVERAGE_PRESSURE_MEAN_SEA_LEVEL, latitude: ArrayLike = CONSTANT_DEFAULT_LATITUDE, altitude: ArrayLike...
Plot a single *Rayleigh* scattering spectral distribution. Parameters ---------- CO2_concentration :math:`CO_2` concentration in parts per million (ppm). temperature Air temperature :math:`T[K]` in kelvin degrees. pressure Surface pressure :math:`P` of the measurement s...
plot_single_sd_rayleigh_scattering
python
colour-science/colour
colour/plotting/phenomena.py
https://github.com/colour-science/colour/blob/master/colour/plotting/phenomena.py
BSD-3-Clause
def plot_the_blue_sky( cmfs: ( MultiSpectralDistributions | str | Sequence[MultiSpectralDistributions | str] ) = "CIE 1931 2 Degree Standard Observer", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot the blue sky. Parameters ---------- cmfs Standard observer colour mat...
Plot the blue sky. Parameters ---------- cmfs Standard observer colour matching functions used for computing the spectrum domain and colours. ``cmfs`` can be of any type or form supported by the :func:`colour.plotting.common.filter_cmfs` definition. Other Parameters --...
plot_the_blue_sky
python
colour-science/colour
colour/plotting/phenomena.py
https://github.com/colour-science/colour/blob/master/colour/plotting/phenomena.py
BSD-3-Clause
def plot_colour_quality_bars( specifications: Sequence[ ColourRendering_Specification_CQS | ColourRendering_Specification_CRI ], labels: bool = True, hatching: bool | None = None, hatching_repeat: int = 2, **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot the colour quality data ...
Plot the colour quality data of specified illuminants or light sources colour quality specifications. Parameters ---------- specifications Array of illuminants or light sources colour quality specifications. labels Add labels above bars. hatching Use hatching for th...
plot_colour_quality_bars
python
colour-science/colour
colour/plotting/quality.py
https://github.com/colour-science/colour/blob/master/colour/plotting/quality.py
BSD-3-Clause
def plot_single_sd_colour_rendering_index_bars( sd: SpectralDistribution, **kwargs: Any ) -> Tuple[Figure, Axes]: """ Plot the *Colour Rendering Index* (CRI) of specified illuminant or light source spectral distribution. Parameters ---------- sd Illuminant or light source spectral d...
Plot the *Colour Rendering Index* (CRI) of specified illuminant or light source spectral distribution. Parameters ---------- sd Illuminant or light source spectral distribution to plot the *Colour Rendering Index* (CRI). Other Parameters ---------------- kwargs ...
plot_single_sd_colour_rendering_index_bars
python
colour-science/colour
colour/plotting/quality.py
https://github.com/colour-science/colour/blob/master/colour/plotting/quality.py
BSD-3-Clause
def plot_multi_sds_colour_rendering_indexes_bars( sds: ( Sequence[SpectralDistribution | MultiSpectralDistributions] | SpectralDistribution | MultiSpectralDistributions | ValuesView ), **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot the *Colour Rendering Index* (CRI...
Plot the *Colour Rendering Index* (CRI) of specified illuminants or light sources spectral distributions. Parameters ---------- sds Spectral distributions or multi-spectral distributions to plot. `sds` can be a single :class:`colour.MultiSpectralDistributions` class instanc...
plot_multi_sds_colour_rendering_indexes_bars
python
colour-science/colour
colour/plotting/quality.py
https://github.com/colour-science/colour/blob/master/colour/plotting/quality.py
BSD-3-Clause
def plot_single_sd_colour_quality_scale_bars( sd: SpectralDistribution, method: Literal["NIST CQS 7.4", "NIST CQS 9.0"] | str = "NIST CQS 9.0", **kwargs: Any, ) -> Tuple[Figure, Axes]: """ Plot the *Colour Quality Scale* (CQS) of specified illuminant or light source spectral distribution. P...
Plot the *Colour Quality Scale* (CQS) of specified illuminant or light source spectral distribution. Parameters ---------- sd Illuminant or light source spectral distribution to plot the *Colour Quality Scale* (CQS). method *Colour Quality Scale* (CQS) computation metho...
plot_single_sd_colour_quality_scale_bars
python
colour-science/colour
colour/plotting/quality.py
https://github.com/colour-science/colour/blob/master/colour/plotting/quality.py
BSD-3-Clause
def plot_multi_sds_colour_quality_scales_bars( sds: ( Sequence[SpectralDistribution | MultiSpectralDistributions] | SpectralDistribution | MultiSpectralDistributions | ValuesView ), method: Literal["NIST CQS 7.4", "NIST CQS 9.0"] | str = "NIST CQS 9.0", **kwargs: Any, ) -...
Plot the *Colour Quality Scale* (CQS) of specified illuminants or light sources spectral distributions. Parameters ---------- sds Spectral distributions or multi-spectral distributions to plot. `sds` can be a single :class:`colour.MultiSpectralDistributions` class instance,...
plot_multi_sds_colour_quality_scales_bars
python
colour-science/colour
colour/plotting/quality.py
https://github.com/colour-science/colour/blob/master/colour/plotting/quality.py
BSD-3-Clause
def plot_RGB_colourspace_section( colourspace: ( RGB_Colourspace | LiteralRGBColourspace | str | Sequence[RGB_Colourspace | LiteralRGBColourspace | str] ), model: LiteralColourspaceModel | str = "CIE xyY", axis: Literal["+z", "+x", "+y"] | str = "+z", origin: float = ...
Plot specified *RGB* colourspace section colours along specified axis and origin. Parameters ---------- colourspace *RGB* colourspace of the *RGB* array. ``colourspace`` can be of any type or form supported by the :func:`colour.plotting.common.filter_RGB_colourspaces` definitio...
plot_RGB_colourspace_section
python
colour-science/colour
colour/plotting/section.py
https://github.com/colour-science/colour/blob/master/colour/plotting/section.py
BSD-3-Clause
def lines_daylight_locus( mireds: bool = False, 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 colours, according to specified method. Parameters ---------- ...
Return the *Daylight Locus* line vertices, i.e., positions, normals and colours, according to specified method. Parameters ---------- mireds Whether to use micro reciprocal degrees for the iso-temperature lines. method *Daylight Locus* method. Returns ------- :clas...
lines_daylight_locus
python
colour-science/colour
colour/plotting/temperature.py
https://github.com/colour-science/colour/blob/master/colour/plotting/temperature.py
BSD-3-Clause