The open_result.py module#

Summary#

open_result_image

Retrieve an image from a specific simulation result.

open_result_in_viewer

Open a specific simulation result in the suitable viewer.

export_xmp_to_image

Export an XMP result into a PNG file.

Description#

Open one of the possible results generated out of the simulation.

Module detail#

open_result.open_result_image(simulation_feature, result_name)#

Retrieve an image from a specific simulation result.

Parameters:
simulation_featureansys.speos.core.simulation.Simulation

The simulation feature.

result_namestr

The result name to open as an image.

Returns:
Path

The path of the image file.

open_result.open_result_in_viewer(simulation_feature, result_name)#

Open a specific simulation result in the suitable viewer.

Parameters:
simulation_featureansys.speos.core.simulation.Simulation

The simulation feature.

result_namestr

The result name to open in a viewer.

open_result.export_xmp_to_image(simulation_feature, result_name)#

Export an XMP result into a PNG file.

Parameters:
simulation_featureansys.speos.core.simulation.Simulation

The simulation feature.

result_namestr

The result name to export as an image.

Returns:
ansys.api.speos.job.v2.job_pb2.Result

The exported image file.