SourceAmbientCieStandardOvercastSky

class ansys.speos.core.source.SourceAmbientCieStandardOvercastSky(project, name, description='', metadata=None, source_instance=None, default_parameters=None)

Bases: BaseSourceAmbient

CIE overcast ambient source.

This source uses the dedicated CieOvercast protobuf template structure.

By default, luminance is set to 1000 cd/m^2 and [0, 0, 1] is used as the zenith direction.

Parameters:

projectansys.speos.core.project.Project

Project that will own the feature.

namestr

Name of the feature.

descriptionstr

Description of the feature. By default, "".

metadataOptional[Mapping[str, str]]

Metadata of the feature. By default, {}.

default_parametersOptional[ ansys.speos.core.generic.parameters.AmbientCieStandardOvercastSkyParameters]

If defined the values in the SourceAmbientCieStandardOvercastSky instance will be overwritten by the values of the data class.

Parameters:

• project (SourceAmbientCieStandardOvercastSky.__init__.project)

• name (str)

• description (str)

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

• source_instance (Optional[ansys.speos.core.kernel.scene.ProtoScene.SourceInstance])

• default_parameters (Optional[ansys.speos.core.generic.parameters.AmbientCieStandardOvercastSkyParameters])

Overview

Properties

luminance	Luminance of the CIE overcast ambient source.
zenith_direction	Zenith direction of the CIE overcast ambient source.
reverse_zenith_direction	Reverse zenith direction of the CIE overcast ambient source.
spectrum	Spectrum of the CIE overcast ambient source.

Import detail

from ansys.speos.core.source import SourceAmbientCieStandardOvercastSky

Property detail

property SourceAmbientCieStandardOvercastSky.luminance: float

Luminance of the CIE overcast ambient source.

Returns:

float

Luminance value in cd/m^2.

property SourceAmbientCieStandardOvercastSky.zenith_direction: List[float]

Zenith direction of the CIE overcast ambient source.

Returns:

List[float]

Direction defining the zenith of the ambient source.

property SourceAmbientCieStandardOvercastSky.reverse_zenith_direction: bool

Reverse zenith direction of the CIE overcast ambient source.

Returns:

bool

True to reverse zenith direction, False otherwise.

property SourceAmbientCieStandardOvercastSky.spectrum: ansys.speos.core.spectrum.Spectrum

Spectrum of the CIE overcast ambient source.

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum associated with this source.