:class:`SourceSurface` ====================== .. toctree:: :hidden: Flux ExitanceConstant ExitanceVariable .. py:class:: ansys.speos.core.source.SourceSurface(project, name, description = '', metadata = None, source_instance = None, default_parameters = None) Bases: :py:obj:`BaseSource` Type of Source : Surface. By default, a luminous flux and existence constant are chosen. With a monochromatic spectrum, and lambertian intensity (cos with N = 1). :Parameters: **project** : :obj:`ansys.speos.core.project.Project` Project that will own the feature. **name** : :class:`python:str` Name of the source 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 SourceSurface from source instance information. **default_parameters** : :obj:`Optional`\[ :obj:`ansys.speos.core.generic.parameters.SurfaceSourceParameters`] = :data:`python:None` If defined the values in the SourceSurface instance will be overwritten by the values of the data class. .. !! processed by numpydoc !! .. py:currentmodule:: SourceSurface 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. * - :py:attr:`~set_exitance_constant` - Set existence constant. * - :py:attr:`~set_exitance_variable` - Set existence variable, taken from XMP map. * - :py:attr:`~set_spectrum_from_xmp_file` - Take spectrum from xmp file provided. * - :py:attr:`~commit` - Save feature: send the local data to the speos server database. * - :py:attr:`~reset` - Reset feature: override local data by the one from the speos server database. * - :py:attr:`~delete` - Delete feature: delete data from the speos server database. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~visual_data` - Property containing Surface source visualization data. * - :py:attr:`~flux` - Flux property of the Surface source. * - :py:attr:`~intensity` - Intensity property. * - :py:attr:`~flux_variation_file_uri` - Location of the flux variation file. * - :py:attr:`~relative_lag` - Relative lag. * - :py:attr:`~spectrum` - Spectrum property of the Source. Import detail ------------- .. code-block:: python from ansys.speos.core.source import SourceSurface Property detail --------------- .. py:property:: visual_data :type: ansys.speos.core.generic.visualization_methods._VisualData Property containing Surface 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: SourceSurface Flux property of the Surface source. :Returns: :obj:`ansys.speos.core.source.SourceSurface.Flux` flux object of the source .. !! processed by numpydoc !! .. py:property:: intensity :type: ansys.speos.core.intensity.Intensity Intensity property. :Returns: :obj:`ansys.speos.core.intensity.Intensity` Intensity. .. !! processed by numpydoc !! .. py:property:: flux_variation_file_uri :type: str Location of the flux variation file. This property gets or sets the flux variation file applied to the surface source. If the file uri is empty, no flux variation is applied. :Parameters: **uri** : :obj:`Union`\[:class:`python:str`, :obj:`pathlib.Path`] Flux variation file uri. :Returns: :class:`python:str` Flux variation file uri. .. !! processed by numpydoc !! .. py:property:: relative_lag :type: float Relative lag. This property gets or sets the relative lag applied to the surface source. If the flux_variation_file_uri is not set, setting the relative lag will raise an error. :Parameters: **relative_lag** : :class:`python:float` Relative lag value to apply to the surface source. :Returns: :class:`python:float` Relative lag. .. !! 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 !! Method detail ------------- .. py:method:: set_flux_from_intensity_file() Take flux from intensity file provided. :Returns: :obj:`ansys.speos.core.source.SourceSurface` Surface source. .. !! processed by numpydoc !! .. py:method:: set_exitance_constant() Set existence constant. :Returns: :obj:`ansys.speos.core.source.SourceSurface.ExitanceConstant` ExitanceConstant of surface source. .. !! processed by numpydoc !! .. py:method:: set_exitance_variable() Set existence variable, taken from XMP map. :Returns: :obj:`ansys.speos.core.source.SourceSurface.ExitanceVariable` ExitanceVariable of surface source. .. !! processed by numpydoc !! .. py:method:: set_spectrum_from_xmp_file() Take spectrum from xmp file provided. :Returns: :obj:`ansys.speos.core.source.SourceSurface` Surface source. .. !! processed by numpydoc !! .. py:method:: commit() Save feature: send the local data to the speos server database. :Returns: :obj:`ansys.speos.core.source.SourceSurface` Source feature. .. !! processed by numpydoc !! .. py:method:: reset() Reset feature: override local data by the one from the speos server database. :Returns: :obj:`ansys.speos.core.source.SourceSurface` Source feature. .. !! processed by numpydoc !! .. py:method:: delete() Delete feature: delete data from the speos server database. The local data are still available :Returns: :obj:`ansys.speos.core.source.SourceSurface` Source feature. .. !! processed by numpydoc !! Classes ------- .. autoapisummary:: ansys.speos.core.source.SourceSurface.Flux ansys.speos.core.source.SourceSurface.ExitanceConstant ansys.speos.core.source.SourceSurface.ExitanceVariable