Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR: Add colour.SpectralShape.from_array class method (constructor). #1322

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions colour/colorimetry/spectrum.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,29 @@ def __init__(self, start: Real, end: Real, interval: Real) -> None:
self.end = end
self.interval = interval

@classmethod
def from_array(cls, data: ArrayLike) -> SpectralShape:
"""Alternate constructor, create a SpectralShape from an ArrayLike list
of values. Values must be evenly spaced.
Parameters
----------
data : ArrayLike
The wavelength list
Returns
-------
SpectralShape
"""
data = np.asarray(data)

spacing = (diff_intermediate := np.diff(data))[0]
if ~np.all(diff_intermediate == spacing):
error = "data values must have equal spacing"
raise RuntimeError(error)

return SpectralShape(data[0], data[-1], spacing)

@property
def start(self) -> Real:
"""
Expand Down
15 changes: 15 additions & 0 deletions colour/colorimetry/tests/test_spectrum.py
Original file line number Diff line number Diff line change
Expand Up @@ -1417,6 +1417,21 @@ def test_range(self) -> None:
np.arange(0, 10 + 0.1, 0.1),
)

def test_from_data(self) -> None:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Major

test_from_data --> test_from_array/test_from_wavelengths

"""Test :func:`colour.colorimetry.spectrum.SpectralShape.from_array`"""
data = np.arange(400, 700 + 1, 10) # arange generates [start, stop)
shape = SpectralShape.from_array(data)

assert shape.start == 400
assert shape.end == 700
assert shape.interval == 10

assert shape == SpectralShape(400, 700, 10)

with pytest.raises(RuntimeError):
data = [400, 450, 500, 555, 600, 650, 700]
SpectralShape.from_array(data)


class TestSpectralDistribution:
"""
Expand Down
Loading