## On this page # SimulationInverseBuilder Class Reference Last update: 17.07.2025 Represents an Inverse Simulation Builder. [More...](#details) Inheritance diagram for SimulationInverseBuilder: ![](/sites/default/files/migrate-content/speos_nx_2025_r1_1/class_speos_n_x_1_1_simulation_inverse_builder.png) ## Public Member Functions 'None' [AddSourceFaceFilteringReferences](#a053588683e97295e7450f0801c876eec) (self, tags) Adds sources faces filtering into the simulation. 'None' [DeleteSourceFaceFilteringReferences](#a1f2eebc9ec162ea073fb198b19096657) (self, tags) Deletes sources faces filtering from the simulation. ![-](/sites/default/files/migrate-content/speos_nx_2025_r1_1/closed.png) Public Member Functions inherited from [SimulationCommonBuilder](class_speos_n_x_1_1_simulation_common_builder.xhtml) 'None' [AddSources](class_speos_n_x_1_1_simulation_common_builder.xhtml#a7131b0a2a313b3c379c6a7c6ef1662c9) (self, sources) Adds sources into the simulation. 'None' [RemoveSources](class_speos_n_x_1_1_simulation_common_builder.xhtml#a22c55e6f209f7acea541afa58c1bc868) (self, sources) Deletes sources from the simulation. 'None' [AddGeometries](class_speos_n_x_1_1_simulation_common_builder.xhtml#aa10491a90fb89595e1eddd012de455ef) (self, tags) Adds geometries into the simulation. 'None' [RemoveGeometries](class_speos_n_x_1_1_simulation_common_builder.xhtml#a72a0f1aff0152618207092c4f7c72121) (self, tags) Deletes geometries from the simulation. 'None' [AddSensors](class_speos_n_x_1_1_simulation_common_builder.xhtml#a55b5c4032c272c682127e349cd797a79) (self, sensors) Adds sensors into the simulation. 'None' [RemoveSensors](class_speos_n_x_1_1_simulation_common_builder.xhtml#af39872183312cd1cf9335f80b8b066e6) (self, sensors) Deletes sensors from the simulation. ![-](/sites/default/files/migrate-content/speos_nx_2025_r1_1/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml) 'None' [Commit](class_speos_n_x_1_1_feature_builder.xhtml#a77581800008ea3179049e650e9d1787b) (self) Commits any edits that have been applied to the builder. 'None' **ShowResult** (self) Updates the feature to reflect the result of an edit to the feature for all builders that support showing results. ## Static Public Attributes str [Duration](#a1da73287097d30314be752eeede32906) = property(fget=\_\_GetDuration, fset=\_\_SetDuration) toto str [FamilySelection](#ae406927f206a41ada838eeb5257796d7) = property(fget=\_\_GetFamilySelection, fset=\_\_SetFamilySelection) Gets or sets the family selection list. str [MaximumNumberOfPaths](#a3a9caa2a37ad1c9aa66a09162e1a2b5e) = property(fget=\_\_GetMaximumNumberOfPaths, fset=\_\_SetMaximumNumberOfPaths) Gets or sets the maximum number of paths. str [PassNumber](#a6f40066f965c87cef610ac5607380ed3) = property(fget=\_\_GetPassNumber, fset=\_\_SetPassNumber) Gets or sets the pass number. str [SourcesFacesFilteringReferences](#a29aa6a805684b0d49c9832d0d3fd0c22) = property(fget=\_\_GetSourcesFacesFilteringReferences) Gets the sources faces filtering. str [StopOnDuration](#a456bcb3ea925f2b09b2dd37857be906f) = property(fget=\_\_GetStopOnDuration, fset=\_\_SetStopOnDuration) Gets or sets the duration. str [StopOnPassNumber](#a14ae005c00fa7f576824aef3b860b4e2) = property(fget=\_\_GetStopOnPassNumber, fset=\_\_SetStopOnPassNumber) Gets or sets the property to enable stop on pass number. ![-](/sites/default/files/migrate-content/speos_nx_2025_r1_1/closed.png) Static Public Attributes inherited from [SimulationCommonBuilder](class_speos_n_x_1_1_simulation_common_builder.xhtml)str [AllPreset](class_speos_n_x_1_1_simulation_common_builder.xhtml#a89fef427057d4dc7c4ac43f3211c8f2e) = property(fget=\_\_GetAllPreset) Gets all Preset. str [AmbientMaterial](class_speos_n_x_1_1_simulation_common_builder.xhtml#a704f99fc2b04c38dc6ed09e5943da97d) = property(fget=\_\_GetAmbientMaterial, fset=\_\_SetAmbientMaterial) Gets or sets the property to enable ambient material. str [EstimatedRam](class_speos_n_x_1_1_simulation_common_builder.xhtml#ad318175507e61ca7bf3ca4ed1ff4728a) = property(fget=\_\_GetEstimatedRam) Gets the estimated RAM usage. str [FeatureSimulation](class_speos_n_x_1_1_simulation_common_builder.xhtml#ab1e1007fe6aaa65c5c69bfd06d66d8ce) = property(fget=\_\_GetFeatureSimulation) Gets the simulation feature object. str [Geometries](class_speos_n_x_1_1_simulation_common_builder.xhtml#aad591c452737d164b58956acd8acb541) = property(fget=\_\_GetGeometries) Gets geometries tag. str [LightExpert](class_speos_n_x_1_1_simulation_common_builder.xhtml#a3280319fc34416f6978a71b821d18ea8) = property(fget=\_\_GetLightExpert, fset=\_\_SetLightExpert) Gets or sets the property to enable Light Expert. str [Preset](class_speos_n_x_1_1_simulation_common_builder.xhtml#a0eedc950d27d340531fe23319f224453) = property(fget=\_\_GetPreset, fset=\_\_SetPreset) Gets or sets the Preset object. str [SelectAmbientMaterial](class_speos_n_x_1_1_simulation_common_builder.xhtml#a28a85beb811f032f31fc99820cc182be) = property(fget=\_\_GetSelectAmbientMaterial, fset=\_\_SetSelectAmbientMaterial) Gets or set the ambient material. str [Sensors](class_speos_n_x_1_1_simulation_common_builder.xhtml#a13ed2a3dc5b127adf10029594165665d) = property(fget=\_\_GetSensors) Gets sensor features. str [Settings](class_speos_n_x_1_1_simulation_common_builder.xhtml#a825c6a61975c36859ea0ca4566743e9d) = property(fget=\_\_GetSettings, fset=\_\_SetSettings) Gets or sets the simulation settings. str [Sources](class_speos_n_x_1_1_simulation_common_builder.xhtml#ab92ca9039d7a8b5a994638c850715e8a) = property(fget=\_\_GetSources) Gets source features. str **StandardDeviation** = property(fget=\_\_GetStandardDeviation, fset=\_\_SetStandardDeviation) ![-](/sites/default/files/migrate-content/speos_nx_2025_r1_1/closed.png) Static Public Attributes inherited from [FeatureBuilder](class_speos_n_x_1_1_feature_builder.xhtml)str [Feature](class_speos_n_x_1_1_feature_builder.xhtml#af5dac7005c95ef44c2b66d7270709d0b) = property(fget=\_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode. str [FullName](class_speos_n_x_1_1_feature_builder.xhtml#a6aac8aea55e1f962045d07a12b6569ea) = property(fget=\_\_GetFullName) Gets the full name of the feature being edited. str [Name](class_speos_n_x_1_1_feature_builder.xhtml#a19218d0239b929ca8aecfa629d0185d0) = property(fget=\_\_GetName, fset=\_\_SetName) Gets or sets the name of the feature being edited. str [NameWithContext](class_speos_n_x_1_1_feature_builder.xhtml#a89ee075a30b71ff6e3192d6bd6dd5515) = property(fget=\_\_GetNameWithContext) Gets the name with context of the feature being edited. ## Detailed Description Represents an Inverse Simulation Builder. The Inverse Simulation Builder is used to create and edit Inverse Simulation features. To create a new instance of this class, use FeatureCollection::CreateSimulationInverseBuilder ## Member Function Documentation ## [◆ ](#a053588683e97295e7450f0801c876eec)AddSourceFaceFilteringReferences() 'None' AddSourceFaceFilteringReferences ( *self*, *tags* ) Adds sources faces filtering into the simulation. The AddSourceFaceFilteringRefs function takes a list of feature tag as parameter. Parameters \[in\]tags: List of integer. Returnsvoid. ## [◆ ](#a1f2eebc9ec162ea073fb198b19096657)DeleteSourceFaceFilteringReferences() 'None' DeleteSourceFaceFilteringReferences ( *self*, *tags* ) Deletes sources faces filtering from the simulation. The DeleteSourceFaceFilteringRefs function takes a list of feature tag as parameter. Parameters \[in\]tags: List of integer. Returnsvoid. ## Member Data Documentation ## [◆ ](#a1da73287097d30314be752eeede32906)Duration str Duration = property(fget=\_\_GetDuration, fset=\_\_SetDuration) static toto toto Returnstoto ## [◆ ](#ae406927f206a41ada838eeb5257796d7)FamilySelection str FamilySelection = property(fget=\_\_GetFamilySelection, fset=\_\_SetFamilySelection) static Gets or sets the family selection list. **Prerequisite**: The UseFamilyTables property must be True. Selects the configurations to run with the simulation. **Value type**: List of string. The default value is an empty list. ## [◆ ](#a3a9caa2a37ad1c9aa66a09162e1a2b5e)MaximumNumberOfPaths str MaximumNumberOfPaths = property(fget=\_\_GetMaximumNumberOfPaths, fset=\_\_SetMaximumNumberOfPaths) static Gets or sets the maximum number of paths. **Prerequisite**: The EnableLightExpert property must be True. The Maximum paths corresponds to the maximum number of rays the Light Path Finder file (\*.lpf or \*.lp3) can contain. **Value type**: Integer. **Range**: The value must be superior to 0. The default value is 100,000. ## [◆ ](#a6f40066f965c87cef610ac5607380ed3)PassNumber str PassNumber = property(fget=\_\_GetPassNumber, fset=\_\_SetPassNumber) static Gets or sets the pass number. **Prerequisite**: The StopOnPassNumber property must be True. **Value type**: Integer. **Range**: the value must be superior to 0. The default value is 5. ## [◆ ](#a29aa6a805684b0d49c9832d0d3fd0c22)SourcesFacesFilteringReferences str SourcesFacesFilteringReferences = property(fget=\_\_GetSourcesFacesFilteringReferences) static Gets the sources faces filtering. The SourcesFacesFilteringRef property returns a list of feature tag. **Value type**: List of integer. ## [◆ ](#a456bcb3ea925f2b09b2dd37857be906f)StopOnDuration str StopOnDuration = property(fget=\_\_GetStopOnDuration, fset=\_\_SetStopOnDuration) static Gets or sets the duration. **Prerequisite**: The StopOnDuration property must be True. Time necessary to reach for the simulation to end. **Value type**: Double (in second). **Range**: The value must be superior to 0.0. The default value is 1800.0 s. ## [◆ ](#a14ae005c00fa7f576824aef3b860b4e2)StopOnPassNumber str StopOnPassNumber = property(fget=\_\_GetStopOnPassNumber, fset=\_\_SetStopOnPassNumber) static Gets or sets the property to enable stop on pass number. True: Enables stop on PassNumber property False: Disables stop on PassNumber property **Value type**: Boolean. The default value is True. --- The documentation for this class was generated from the following file:- **SpeosNX.py**