colour.SpectralShape¶
-
class
colour.
SpectralShape
(start=None, end=None, interval=None)[source]¶ Bases:
object
Defines the base object for spectral distribution shape.
- Parameters
start (numeric, optional) – Wavelength \(\lambda_{i}\) range start in nm.
end (numeric, optional) – Wavelength \(\lambda_{i}\) range end in nm.
interval (numeric, optional) – Wavelength \(\lambda_{i}\) range interval.
-
start
¶
-
end
¶
-
interval
¶
-
boundaries
¶
Examples
>>> SpectralShape(360, 830, 1) SpectralShape(360, 830, 1)
-
property
boundaries
Getter and setter property for the spectral shape boundaries.
- Parameters
value (array_like) – Value to set the spectral shape boundaries with.
- Returns
Spectral shape boundaries.
- Return type
-
property
end
Getter and setter property for the spectral shape end.
- Parameters
value (numeric) – Value to set the spectral shape end with.
- Returns
Spectral shape end.
- Return type
numeric
-
property
interval
Getter and setter property for the spectral shape interval.
- Parameters
value (numeric) – Value to set the spectral shape interval with.
- Returns
Spectral shape interval.
- Return type
numeric
-
range
(dtype=<class 'numpy.float64'>)[source] Returns an iterable range for the spectral shape.
- Parameters
dtype (type) – Data type used to generate the range.
- Returns
Iterable range for the spectral distribution shape
- Return type
ndarray
- Raises
RuntimeError – If one of spectral shape start, end or interval attributes is not defined.
Examples
>>> SpectralShape(0, 10, 0.1).range() array([ 0. , 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1. , 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 2. , 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 3. , 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 4. , 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 4.9, 5. , 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6. , 6.1, 6.2, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 6.9, 7. , 7.1, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9, 8. , 8.1, 8.2, 8.3, 8.4, 8.5, 8.6, 8.7, 8.8, 8.9, 9. , 9.1, 9.2, 9.3, 9.4, 9.5, 9.6, 9.7, 9.8, 9.9, 10. ])
-
property
start
Getter and setter property for the spectral shape start.
- Parameters
value (numeric) – Value to set the spectral shape start with.
- Returns
Spectral shape start.
- Return type
numeric