:class:`SourceRayFile`
======================

.. toctree::
   :hidden:

    ExitGeometries</api/ansys/speos/core/source/SourceRayFile.ExitGeometries>


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

   Bases: :py:obj:`BaseSource`


   
   RayFile Source.

   By default, flux and spectrum from ray file are selected.

   :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 SourceRayFile from source instance information.

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














   ..
       !! processed by numpydoc !!


.. py:currentmodule:: SourceRayFile

Overview
--------

.. tab-set::



   .. tab-item:: Methods

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

          * - :py:attr:`~set_flux_from_ray_file`
            - Take flux from ray file provided.
          * - :py:attr:`~set_spectrum_from_ray_file`
            - Take spectrum from ray file provided.
          * - :py:attr:`~set_exit_geometries`
            - Set exit geometries.


   .. tab-item:: Properties

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

          * - :py:attr:`~visual_data`
            - Property containing Rayfile source visualization data.
          * - :py:attr:`~ray_file_uri`
            - Ray file URI.
          * - :py:attr:`~flux`
            - Flux definition of the Rayfile source.
          * - :py:attr:`~spectrum`
            - Spectrum property of the Source.
          * - :py:attr:`~axis_system`
            - Axis system of the Source.







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

.. code-block:: python

    from ansys.speos.core.source import SourceRayFile

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

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


   
   Property containing Rayfile 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:: ray_file_uri
   :type: str


   
   Ray file URI.

   This property retrieve and defines the file uri of ray file used.

   :Parameters:

       **uri** : :obj:`Union`\[:obj:`pathlib.Path`, :class:`python:str`]
           Ray file URI.



   :Returns:

       :class:`python:str`
           Ray file URI.











   ..
       !! processed by numpydoc !!

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


   
   Flux definition of the Rayfile source.





   :Returns:

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











   ..
       !! processed by numpydoc !!

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


   
   Spectrum property of the Source.





   :Returns:

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











   ..
       !! processed by numpydoc !!

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


   
   Axis system of the Source.

   This property retrieve and defines the axis system of the source.

   :Parameters:

       **axis_system** : :obj:`List`\[:class:`python:float`]
           Position of the rayfile 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 rayfile 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_ray_file()

   
   Take flux from ray file provided.





   :Returns:

       :obj:`ansys.speos.core.source.SourceRayFile`
           RayFile source.











   ..
       !! processed by numpydoc !!

.. py:method:: set_spectrum_from_ray_file()

   
   Take spectrum from ray file provided.





   :Returns:

       :obj:`ansys.speos.core.source.SourceRayFile`
           RayFile source.











   ..
       !! processed by numpydoc !!

.. py:method:: set_exit_geometries()

   
   Set exit geometries.





   :Returns:

       :obj:`ansys.speos.core.source.SourceRayFile.ExitGeometries`
           ExitGeometries settings of rayfile source.











   ..
       !! processed by numpydoc !!






Classes
-------

.. autoapisummary::

    ansys.speos.core.source.SourceRayFile.ExitGeometries