SourceLuminaire

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

Bases: BaseSource

LuminaireSource.

By default, a flux from intensity file is chosen, with an incandescent spectrum.

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.LuminaireSourceParameters] = None

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

Parameters:

• project (SourceLuminaire.__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.LuminaireSourceParameters])

Overview

Methods

set_flux_from_intensity_file

Take flux from intensity file provided.

Properties

visual_data	Property containing Luminaire source visualization data.
flux	Flux definition of the luminaire source.
intensity_file_uri	Property of intensity file.
spectrum	Spectrum property.
axis_system	Property of the position of the source.

Import detail

from ansys.speos.core.source import SourceLuminaire

Property detail

property SourceLuminaire.visual_data: ansys.speos.core.generic.visualization_methods._VisualData

Property containing Luminaire source visualization data.

Returns:

ansys.speos.core.generic.visualization_methods._VisualData

Instance of VisualData Class for pyvista.PolyData of feature rays, coordinate_systems.

property SourceLuminaire.flux: BaseSource

Flux definition of the luminaire source.

Returns:

ansys.speos.core.source.BaseSource.Flux

flux object of the source

property SourceLuminaire.intensity_file_uri: str

Property of intensity file.

Parameters:

uriUnion[str, pathlib.Path]

IES or EULUMDAT format file uri.

Returns:

str

Intensity file uri.

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

Spectrum property.

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum.

property SourceLuminaire.axis_system: List[float]

Property of the position of the source.

Parameters:

axis_systemList[float]

Position of the source [Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz]. By default, [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1].

Returns:

List[float]

Position of the source [Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz]. By default, [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1].

Method detail

SourceLuminaire.set_flux_from_intensity_file()

Take flux from intensity file provided.

Returns:

ansys.speos.core.source.SourceLuminaire

Luminaire source.