SourceLuminaire

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

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_valuesbool

Uses default values when True.

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_values (bool)

Overview

Methods

set_flux_from_intensity_file	Take flux from intensity file provided.
set_flux_luminous	Set luminous flux.
set_flux_radiant	Set radiant flux.
set_intensity_file_uri	Set intensity file.
set_spectrum	Set spectrum.
set_axis_system	Set the position of the source.

Properties

visual_data

Property containing Luminaire source visualization data.

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:

_VisualData

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

Method detail

SourceLuminaire.set_flux_from_intensity_file()

Take flux from intensity file provided.

Returns:

ansys.speos.core.source.SourceLuminaire

Luminaire source.

SourceLuminaire.set_flux_luminous(value=683)

Set luminous flux.

Parameters:

valuefloat

Luminous flux in lumens. By default, 683.0.

Returns:

ansys.speos.core.source.SourceLuminaire

Luminaire source.

SourceLuminaire.set_flux_radiant(value=1)

Set radiant flux.

Parameters:

valuefloat

Radiant flux in watts. By default, 1.0.

Returns:

ansys.speos.core.source.SourceLuminaire

Luminaire source.

SourceLuminaire.set_intensity_file_uri(uri)

Set intensity file.

Parameters:

uristr

IES or EULUMDAT format file uri.

Returns:

ansys.speos.core.source.SourceLuminaire

Luminaire source.

SourceLuminaire.set_spectrum()

Set spectrum.

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum.

SourceLuminaire.set_axis_system(axis_system=None)

Set the position of the source.

Parameters:

axis_systemOptional[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].

Returns:

ansys.speos.core.source.SourceLuminaire

Luminaire source.