OptimizedPropagationRelative#

class ansys.speos.core.simulation.SimulationInverse.OptimizedPropagationRelative(propagation_relative, default_parameters=None, stable_ctr=False)#

Optimized propagation using a relative pixel standard deviation 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. As a result, the signal-to-noise ratio is adequate in areas where pixels need more rays, thus giving a balanced image.

Parameters:
propagation_relativeansys.api.speos.job.v2.job_pb2.Job.InverseMCSimulationProperties.OptimizedPropagationRelative

Protobuf message filled by this class.

default_parametersansys.speos.core.generic.parameters.OptimizedPropagationRelativeParameters, optional

If defined, the protobuf message is initialized with the values of the data class. By default, None, means that the message is left untouched.

stable_ctrbool

Internal safety flag. It must be set to True by the parent class. By default, False.

Parameters:

Notes

Do not instantiate this class directly. Use SimulationInverse.set_optimized_propagation_relative() instead.

Overview#

min_pass_number

Minimum number of passes computed without pass optimization.

relative_value

Relative pixel standard deviation threshold, in percent.

Import detail#

from ansys.speos.core.simulation.SimulationInverse import OptimizedPropagationRelative

Property detail#

property OptimizedPropagationRelative.min_pass_number: int#

Minimum number of passes computed without pass optimization.

Returns:
int

Minimum number of passes.

property OptimizedPropagationRelative.relative_value: int#

Relative pixel standard deviation threshold, in percent.

Returns:
int

Relative threshold, expressed in percent, between 0 and 100.