:class:`SourceLuminaire`
========================


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

   Bases: :py:obj:`BaseSource`


   
   LuminaireSource.

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

   :Parameters:

       **project** : :obj:`ansys.speos.core.project.Project`
           Project that will own the feature.

       **name** : :class:`python:str`
           Name of the feature.

       **description** : :class:`python:str`
           Description of the feature.
           By default, ``""``.

       **metadata** : :obj:`Optional`\[:obj:`Mapping`\[:class:`python:str`, :class:`python:str`]]
           Metadata of the feature.
           By default, ``{}``.

       **source_instance: Optional[ansys.api.speos.scene.v2.scene_pb2.Scene.SourceInstance] = None**
           if provided, creating the SourceLuminaire from source instance information.

       **default_parameters** : :obj:`Optional`\[    :obj:`ansys.speos.core.generic.parameters.LuminaireSourceParameters`] = :data:`python:None`
           If defined the values in the SourceLuminaire instance will be overwritten
           by the values of the data class.














   ..
       !! processed by numpydoc !!


.. py:currentmodule:: SourceLuminaire

Overview
--------

.. tab-set::



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~set_flux_from_intensity_file`
            - Take flux from intensity file provided.


   .. tab-item:: Properties

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~visual_data`
            - Property containing Luminaire source visualization data.
          * - :py:attr:`~flux`
            - Flux definition of the luminaire source.
          * - :py:attr:`~intensity_file_uri`
            - Property of intensity file.
          * - :py:attr:`~spectrum`
            - Spectrum property.
          * - :py:attr:`~axis_system`
            - Property of the position of the source.







Import detail
-------------

.. code-block:: python

    from ansys.speos.core.source import SourceLuminaire

Property detail
---------------

.. py:property:: visual_data
   :type: ansys.speos.core.generic.visualization_methods._VisualData


   
   Property containing Luminaire source visualization data.





   :Returns:

       :obj:`ansys.speos.core.generic.visualization_methods._VisualData`
           Instance of VisualData Class for pyvista.PolyData of
           feature rays, coordinate_systems.











   ..
       !! processed by numpydoc !!

.. py:property:: flux
   :type: BaseSource


   
   Flux definition of the luminaire source.





   :Returns:

       :obj:`ansys.speos.core.source.BaseSource.Flux`
           flux object of the source











   ..
       !! processed by numpydoc !!

.. py:property:: intensity_file_uri
   :type: str


   
   Property of intensity file.


   :Parameters:

       **uri** : :obj:`Union`\[:class:`python:str`, :obj:`pathlib.Path`]
           IES or EULUMDAT format file uri.



   :Returns:

       :class:`python:str`
           Intensity file uri.











   ..
       !! processed by numpydoc !!

.. py:property:: spectrum
   :type: ansys.speos.core.spectrum.Spectrum


   
   Spectrum property.





   :Returns:

       :obj:`ansys.speos.core.spectrum.Spectrum`
           Spectrum.











   ..
       !! processed by numpydoc !!

.. py:property:: axis_system
   :type: List[float]


   
   Property of the position of the source.


   :Parameters:

       **axis_system** : :obj:`List`\[:class:`python: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:

       :obj:`List`\[:class:`python: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]``.











   ..
       !! processed by numpydoc !!




Method detail
-------------

.. py:method:: set_flux_from_intensity_file()

   
   Take flux from intensity file provided.





   :Returns:

       :obj:`ansys.speos.core.source.SourceLuminaire`
           Luminaire source.











   ..
       !! processed by numpydoc !!