:class:`SimulationInverse` ========================== .. toctree:: :hidden: SourceSampling OptimizedPropagationRelative OptimizedPropagationAbsolute .. py:class:: ansys.speos.core.simulation.SimulationInverse(project, name, description = '', metadata = None, simulation_instance = None, default_parameters = None) Bases: :py:obj:`BaseSimulation` Type of simulation : Inverse. By default, geometry distance tolerance is set to 0.01, maximum number of impacts is set to 100, colorimetric standard is set to CIE 1931, dispersion is set to False, splitting is set to False, number of gathering rays per source is set to 1, maximum gathering error is set to 0, fast transmission gathering is set to False, ambient material URI is empty, and weight's minimum energy percentage is set to 0.005. By default, the simulation will stop after 5 passes, with an automatic save frequency of 1800s. :Parameters: **project** : :obj:`ansys.speos.core.project.Project` Project in which simulation shall be created. **name** : :class:`python:str` Name of the simulation. **description** : :class:`python:str` Description of the Simulation. By default, ``""``. **metadata** : :obj:`Optional`\[:obj:`Mapping`\[:class:`python:str`, :class:`python:str`]] Metadata of the feature. By default, ``{}``. **simulation_instance** : :obj:`ansys.api.speos.scene.v2.scene_pb2.Scene.SimulationInstance`, :obj:`optional` Simulation instance to provide if the feature does not have to be created from scratch By default, ``None``, means that the feature is created from scratch by default. **default_parameters** : :obj:`ansys.speos.core.generic.parameters.InverseSimulationParameters`, :obj:`optional` If defined the values in the inverse simulation instance will be overwritten by the values of the data class. .. rubric:: Notes Three exclusive optimized propagation modes are available. The relative and absolute optimized propagation modes require Speos 2025 R1 SP1 or higher and are only compatible with radiance sensors. .. !! processed by numpydoc !! .. py:currentmodule:: SimulationInverse Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~set_weight` - Activate weight. Highly recommended to fill. * - :py:attr:`~set_weight_none` - Deactivate weight. * - :py:attr:`~set_colorimetric_standard_CIE_1931` - Set the colorimetric standard to CIE 1931. * - :py:attr:`~set_colorimetric_standard_CIE_1964` - Set the colorimetric standard to CIE 1964. * - :py:attr:`~set_optimized_propagation_relative` - Set the optimized propagation relative stop condition. * - :py:attr:`~set_optimized_propagation_absolute` - Set the optimized propagation absolute stop condition. * - :py:attr:`~commit` - Save feature: send the local data to the speos server database. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~timeline` - Switch to enable/disable the simulation timeline. * - :py:attr:`~start_time` - Timeline start time (s). * - :py:attr:`~dispersion` - Activate/Deactivate the dispersion calculation. * - :py:attr:`~splitting` - Activate/Deactivate the splitting. * - :py:attr:`~number_of_gathering_rays_per_source` - The number of gathering rays per source. * - :py:attr:`~maximum_gathering_error` - The maximum gathering error. * - :py:attr:`~ambient_material_file_uri` - The ambient material file URI. * - :py:attr:`~stop_condition_passes_number` - To stop the simulation after a certain number of passes. * - :py:attr:`~stop_condition_duration` - The duration to stop the simulation. * - :py:attr:`~automatic_save_frequency` - The automatic save frequency. * - :py:attr:`~light_expert` - Whether light expert is enabled. Import detail ------------- .. code-block:: python from ansys.speos.core.simulation import SimulationInverse Property detail --------------- .. py:property:: timeline :type: bool Switch to enable/disable the simulation timeline. :Returns: :ref:`bool ` State of timeline activation. .. !! processed by numpydoc !! .. py:property:: start_time :type: Optional[float] Timeline start time (s). :Returns: :obj:`Optional`\[:class:`python:float`] the start time (s) of the simulation timeline, or None to disable timeline .. !! processed by numpydoc !! .. py:property:: dispersion :type: bool Activate/Deactivate the dispersion calculation. :Returns: :ref:`bool ` True if dispersion is activated. .. !! processed by numpydoc !! .. py:property:: splitting :type: bool Activate/Deactivate the splitting. To split each propagated ray into several paths at their first impact after leaving the observer point. :Parameters: **value** : :ref:`bool ` Activate/Deactivate. By default, ``False``, means deactivate. :Returns: :obj:`ansys.speos.core.simulation.SimulationInverse` Inverse simulation .. !! processed by numpydoc !! .. py:property:: number_of_gathering_rays_per_source :type: int The number of gathering rays per source. :Returns: :class:`python:int` The number of gathering rays per source. .. !! processed by numpydoc !! .. py:property:: maximum_gathering_error :type: int The maximum gathering error. :Returns: :class:`python:int` The maximum gathering error. .. !! processed by numpydoc !! .. py:property:: ambient_material_file_uri :type: str The ambient material file URI. :Returns: :class:`python:str` The ambient material file URI. .. !! processed by numpydoc !! .. py:property:: stop_condition_passes_number :type: Optional[int] To stop the simulation after a certain number of passes. Set None as value to have no condition about passes. :Parameters: **value** : :class:`python:int`, :obj:`optional` The number of passes requested. Or None if no condition about passes. By default, ``5``. :Returns: :class:`python:int` .. .. !! processed by numpydoc !! .. py:property:: stop_condition_duration :type: Optional[int] The duration to stop the simulation. :Returns: :obj:`Optional`\[:class:`python:int`] The duration in seconds, or None if no condition. .. !! processed by numpydoc !! .. py:property:: automatic_save_frequency :type: int The automatic save frequency. This option is useful when computing long simulations. But a reduced number of save operations naturally increases the simulation performance. :Returns: :class:`python:int` The save frequency in seconds. .. !! processed by numpydoc !! .. py:property:: light_expert :type: bool Whether light expert is enabled. :Returns: :ref:`bool ` True if light expert is enabled. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: set_weight() Activate weight. Highly recommended to fill. :Returns: :obj:`ansys.speos.core.simulation.BaseSimulation.Weight` Weight .. !! processed by numpydoc !! .. py:method:: set_weight_none() Deactivate weight. :Returns: :obj:`ansys.speos.core.simulation.SimulationInverse` Inverse simulation .. !! processed by numpydoc !! .. py:method:: set_colorimetric_standard_CIE_1931() Set the colorimetric standard to CIE 1931. 2 degrees CIE Standard Colorimetric Observer Data. :Returns: :obj:`ansys.speos.core.simulation.SimulationInverse` Inverse simulation .. !! processed by numpydoc !! .. py:method:: set_colorimetric_standard_CIE_1964() Set the colorimetric standard to CIE 1964. 10 degrees CIE Standard Colorimetric Observer Data. :Returns: :obj:`ansys.speos.core.simulation.SimulationInverse` Inverse simulation .. !! processed by numpydoc !! .. py:method:: set_optimized_propagation_relative() Set the optimized propagation relative stop condition. The algorithm adapts the number of passes per pixel to send the optimal number of rays according to the signal each pixel needs. :Returns: :obj:`ansys.speos.core.simulation.SimulationInverse.OptimizedPropagationRelative` Optimized propagation relative stop condition. .. rubric:: Notes Selecting this mode discards any other optimized propagation mode previously set, including :attr:`stop_condition_passes_number`. Default values are applied only the first time this mode is selected, subsequent calls return the stop condition with its current values. Starting from 271, the job information used by optimized propagation is kept in the job template. .. !! processed by numpydoc !! .. py:method:: set_optimized_propagation_absolute() Set the optimized propagation absolute stop condition. The algorithm adapts the number of passes per pixel to send the optimal number of rays according to the signal each pixel needs. :Returns: :obj:`ansys.speos.core.simulation.SimulationInverse.OptimizedPropagationAbsolute` Optimized propagation absolute stop condition. .. rubric:: Notes Selecting this mode discards any other optimized propagation mode previously set, including :attr:`stop_condition_passes_number`. Default values are applied only the first time this mode is selected, subsequent calls return the stop condition with its current values. Starting from 271, the job information used by optimized propagation is kept in the job template. .. !! processed by numpydoc !! .. py:method:: commit() Save feature: send the local data to the speos server database. :Returns: :obj:`ansys.speos.core.simulation.SimulationInverse` Simulation feature. .. !! processed by numpydoc !! Classes ------- .. autoapisummary:: ansys.speos.core.simulation.SimulationInverse.SourceSampling ansys.speos.core.simulation.SimulationInverse.OptimizedPropagationRelative ansys.speos.core.simulation.SimulationInverse.OptimizedPropagationAbsolute