colour.colorimetry.trim_signal

colour.colorimetry.trim_signal(signal: SpectralDistribution | MultiSpectralDistributions, shape: SpectralShape) → SpectralDistribution | MultiSpectralDistributions

Trim the specified spectral distribution or multi-spectral distributions wavelengths in-place to the specified spectral shape.

This is the shared implementation backing the colour.SpectralDistribution.trim() and colour.MultiSpectralDistributions.trim() methods.

Parameters:

• signal (SpectralDistribution | MultiSpectralDistributions) – Spectral distribution or multi-spectral distributions to trim.

• shape (SpectralShape) – Spectral shape used for trimming.

Returns:

Trimmed spectral distribution or multi-spectral distributions.

Return type:

colour.SpectralDistribution or colour.MultiSpectralDistributions

Examples

>>> data = {
...     500: 0.0651,
...     520: 0.0705,
...     540: 0.0772,
...     560: 0.0870,
...     580: 0.1128,
...     600: 0.1360,
... }
>>> sd = SpectralDistribution(data)
>>> trim_signal(sd, SpectralShape(520, 580, 20)).shape
SpectralShape(520.0, 580.0, 20.0)