Spectrum

class ansys.speos.core.spectrum.Spectrum(speos_client, name, description='', metadata=None, key='')

Speos feature : Spectrum.

By default, a monochromatic spectrum is created.

Parameters:

speos_clientansys.speos.core.kernel.client.SpeosClient

The Speos instance client.

namestr

Name of the feature.

descriptionstr

Description of the feature. By default, "".

metadataOptional[Mapping[str, str]]

Metadata of the feature. By default, {}.

keystr

Creation from an SpectrumLink key

Attributes:

spectrum_linkansys.speos.core.kernel.spectrum.SpectrumLink

Link object for the spectrum in database.

Parameters:

• speos_client (ansys.speos.core.kernel.client.SpeosClient)

• name (str)

• description (str)

• metadata (Optional[Mapping[str, str]])

• key (str)

Overview

Methods

set_monochromatic	Set the spectrum as monochromatic.
set_blackbody	Set the spectrum as blackbody.
set_sampled	Set the spectrum as sampled.
set_library	Set the spectrum as library.
set_incandescent	Set the spectrum as incandescent (predefined spectrum).
set_warmwhitefluorescent	Set the spectrum as warmwhitefluorescent (predefined spectrum).
set_daylightfluorescent	Set the spectrum as daylightfluorescent (predefined spectrum).
set_whiteLED	Set the spectrum as white led (predefined spectrum).
set_white_led	Set the spectrum as white led (predefined spectrum).
set_halogen	Set the spectrum as halogen (predefined spectrum).
set_metalhalide	Set the spectrum as metalhalide (predefined spectrum).
set_highpressuresodium	Set the spectrum as highpressuresodium (predefined spectrum).
commit	Save feature: send the local data to the speos server database.
reset	Reset feature: override local data by the one from the speos server database.
delete	Delete feature: delete data from the speos server database.

Attributes

spectrum_link

Link object for the spectrum in database.

Special methods

__str__

Return the string representation of the spectrum.

Import detail

from ansys.speos.core.spectrum import Spectrum

Attribute detail

Spectrum.spectrum_link = None

Link object for the spectrum in database.

Method detail

Spectrum.set_monochromatic(wavelength=555.0)

Set the spectrum as monochromatic.

Parameters:

wavelengthfloat

Wavelength of the spectrum, in nm. By default, 555.0.

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.set_blackbody(temperature=2856)

Set the spectrum as blackbody.

Parameters:

temperaturefloat

Temperature of the blackbody, in K. By default, 2856.

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.set_sampled(wavelengths, values)

Set the spectrum as sampled.

Parameters:

wavelengthsList[float]

List of wavelengths, in nm

valuesList[float]

List of values, expected from 0. to 100. in %

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.set_library(file_uri)

Set the spectrum as library.

Parameters:

file_uristr

uri of the spectrum file.

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.set_incandescent()

Set the spectrum as incandescent (predefined spectrum).

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.set_warmwhitefluorescent()

Set the spectrum as warmwhitefluorescent (predefined spectrum).

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.set_daylightfluorescent()

Set the spectrum as daylightfluorescent (predefined spectrum).

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.set_whiteLED()

Set the spectrum as white led (predefined spectrum).

Deprecated since version 0.2.2: set_whiteLed will be removed with 0.3.0 set_white_led shall be used to comply with PEP8 naming convention

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.set_white_led()

Set the spectrum as white led (predefined spectrum).

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.set_halogen()

Set the spectrum as halogen (predefined spectrum).

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.set_metalhalide()

Set the spectrum as metalhalide (predefined spectrum).

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.set_highpressuresodium()

Set the spectrum as highpressuresodium (predefined spectrum).

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.__str__()

Return the string representation of the spectrum.

Spectrum.commit()

Save feature: send the local data to the speos server database.

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.reset()

Reset feature: override local data by the one from the speos server database.

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.

Spectrum.delete()

Delete feature: delete data from the speos server database.

The local data are still available

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum feature.