Moving car example by using speos files combination#
This tutorial demonstrates how to run moving car workflow use case.
[1]:
import os
from pathlib import Path
from ansys.speos.core import Part, Speos
from ansys.speos.core.sensor import SensorCamera
from ansys.speos.core.simulation import SimulationInverse
from ansys.speos.core.source import SourceLuminaire
from ansys.speos.core.workflow.combine_speos import (
SpeosFileInstance,
combine_speos,
)
# If using docker container
assets_data_path = Path("/app") / "assets"
# If using local server
# assets_data_path = Path().resolve().parent.parent / "tests" / "assets"
# If using a different path
# assets_data_path = Path("path/to/downloaded/example/assets")
Create connection with speos rpc server#
[2]:
speos = Speos(host="localhost", port=50098)
Combine several speos files into one project#
Here we are building a project with:
An environment which is a road
A blue car
A red car
[3]:
p = combine_speos(
speos=speos,
speos_to_combine=[
SpeosFileInstance(
speos_file=str(assets_data_path / "Env_Simplified.speos" / "Env_Simplified.speos"),
axis_system=[0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1],
),
SpeosFileInstance(
speos_file=str(assets_data_path / "BlueCar.speos" / "BlueCar.speos"),
axis_system=[
2000,
0,
35000,
0.0,
0.0,
-1.0,
-1.0,
0.0,
0.0,
0.0,
1.0,
0.0,
],
),
SpeosFileInstance(
speos_file=str(assets_data_path / "RedCar.speos" / "RedCar.speos"),
axis_system=[
-4000,
0,
48000,
1.0,
0.0,
0.0,
0.0,
0.0,
-1.0,
0.0,
1.0,
0.0,
],
),
],
)
print(p)
{
"part_guid": "9a146d7b-924d-4828-8012-1ad96e0af8d8",
"materials": [
{
"name": "Env_Simplified.Material.1",
"metadata": {
"UniqueId": "fbf39463-9a33-41ec-b909-c38b6de1a62c"
},
"vop_guid": "9531003f-574a-461f-bbc4-b2d8a44db2c1",
"sop_guids": [
"4ca7bf1d-efaf-4844-a447-b2167c738edc"
],
"geometries": {
"geo_paths": [
"Env_Simplified/Sidewalk:530980414"
]
},
"description": "",
"vop": {
"opaque": {},
"name": "",
"description": "",
"metadata": {}
},
"sops": [
{
"library": {
"sop_file_uri": "/app/assets/Env_Simplified.speos/Side Walk_33b4-3fff-6c8d-7671..scattering"
},
"name": "",
"description": "",
"metadata": {}
}
]
},
{
"name": "Env_Simplified.Material.2",
"metadata": {
"UniqueId": "97c7498a-b962-4c23-ad34-7474d0acc4d7"
},
"vop_guid": "9531003f-574a-461f-bbc4-b2d8a44db2c1",
"sop_guids": [
"c8932554-e813-40e9-b10c-23bb4d2c7b27"
],
"geometries": {
"geo_paths": [
"Env_Simplified/Solid:1195288205"
]
},
"description": "",
"vop": {
"opaque": {},
"name": "",
"description": "",
"metadata": {}
},
"sops": [
{
"library": {
"sop_file_uri": "/app/assets/Env_Simplified.speos/RL_Road_107_6c27-753a-e5eb-38d0..anisotropicbsdf"
},
"name": "",
"description": "",
"metadata": {}
}
]
},
{
"name": "Env_Simplified.Material.3",
"metadata": {
"UniqueId": "643f2dab-3ccb-4350-a1f5-2b466995fe82"
},
"vop_guid": "9531003f-574a-461f-bbc4-b2d8a44db2c1",
"sop_guids": [
"4ca7bf1d-efaf-4844-a447-b2167c738edc"
],
"geometries": {
"geo_paths": [
"Env_Simplified/Sidewalk:895709635"
]
},
"description": "",
"vop": {
"opaque": {},
"name": "",
"description": "",
"metadata": {}
},
"sops": [
{
"library": {
"sop_file_uri": "/app/assets/Env_Simplified.speos/Side Walk_33b4-3fff-6c8d-7671..scattering"
},
"name": "",
"description": "",
"metadata": {}
}
]
},
{
"name": "Env_Simplified.Material.4",
"metadata": {
"UniqueId": "750248f2-155e-4a42-abfc-f08be51cda7e"
},
"sop_guids": [
"51d7788a-c07c-4f92-9eac-1226cf316fa6"
],
"geometries": {
"geo_paths": [
"Env_Simplified/Sidewalk:895709635/face.1:316406917",
"Env_Simplified/Sidewalk:895709635/face.1:1112941297"
]
},
"description": "",
"sops": [
{
"library": {
"sop_file_uri": "/app/assets/Env_Simplified.speos/Grey Diffuse Paint_3635-3935-3d63-16d6..scattering"
},
"name": "",
"description": "",
"metadata": {}
}
]
},
{
"name": "Env_Simplified.Material.5",
"metadata": {
"UniqueId": "c83c9536-6453-42e6-b658-1376475c3421"
},
"vop_guid": "9531003f-574a-461f-bbc4-b2d8a44db2c1",
"sop_guids": [
"4ca7bf1d-efaf-4844-a447-b2167c738edc"
],
"geometries": {
"geo_paths": [
"Env_Simplified/Sidewalk:4000640054"
]
},
"description": "",
"vop": {
"opaque": {},
"name": "",
"description": "",
"metadata": {}
},
"sops": [
{
"library": {
"sop_file_uri": "/app/assets/Env_Simplified.speos/Side Walk_33b4-3fff-6c8d-7671..scattering"
},
"name": "",
"description": "",
"metadata": {}
}
]
},
{
"name": "Env_Simplified.Material.6",
"metadata": {
"UniqueId": "706a7c8a-00c5-4cff-b145-f2853d33eefc"
},
"sop_guids": [
"51d7788a-c07c-4f92-9eac-1226cf316fa6"
],
"geometries": {
"geo_paths": [
"Env_Simplified/Sidewalk:4000640054/face.1:4194215934",
"Env_Simplified/Sidewalk:4000640054/face.1:1230904683"
]
},
"description": "",
"sops": [
{
"library": {
"sop_file_uri": "/app/assets/Env_Simplified.speos/Grey Diffuse Paint_3635-3935-3d63-16d6..scattering"
},
"name": "",
"description": "",
"metadata": {}
}
]
},
{
"name": "BlueCar.Material.1",
"metadata": {
"UniqueId": "f4ea418f-f8c0-4ad4-b25b-18e078708276"
},
"sop_guids": [
"45383de0-ece4-4323-812d-a725f4926606"
],
"geometries": {
"geo_paths": [
"BlueCar/Solid:3252217597/face.1:1645799713",
"BlueCar/Solid:3252217597/face.1:3709259256",
"BlueCar/Solid:3252217597/face.1:3245061952",
"BlueCar/Solid:3252217597/face.1:1740077551",
"BlueCar/Solid:516754967/face.1:1903508963",
"BlueCar/Solid:516754967/face.1:3464173882",
"BlueCar/Solid:516754967/face.1:3523634050",
"BlueCar/Solid:516754967/face.1:1960488237",
"BlueCar/Solid:2263335813/face.1:4106343688",
"BlueCar/Solid:2263335813/face.1:1271919057",
"BlueCar/Solid:2263335813/face.1:1471318889",
"BlueCar/Solid:2263335813/face.1:4050535878",
"BlueCar/Solid:1920065013/face.1:2151688549",
"BlueCar/Solid:1920065013/face.1:1062079932",
"BlueCar/Solid:1920065013/face.1:590575364",
"BlueCar/Solid:1920065013/face.1:2247080363"
]
},
"description": "",
"sops": [
{
"library": {
"sop_file_uri": "/app/assets/BlueCar.speos/TireDiffusor_06ab-e65b-b541-c3ab..simplescattering"
},
"name": "",
"description": "",
"metadata": {}
}
]
},
{
"name": "BlueCar.Material.2",
"metadata": {
"UniqueId": "9cc7ad56-934c-48ff-bc72-bd25b6ab5746"
},
"sop_guids": [
"0d372aec-e019-46fd-bc78-9a5b3886b390"
],
"geometries": {
"geo_paths": [
"BlueCar/Solid1:1003010499/face.1:3959360578",
"BlueCar/Solid1:1003010499/face.1:198338723",
"BlueCar/Solid1:1003010499/face.1:58624004",
"BlueCar/Solid1:1003010499/face.1:494376775",
"BlueCar/Solid1:1003010499/face.1:80289655",
"BlueCar/Solid1:1003010499/face.1:2640544264",
"BlueCar/Solid1:1003010499/face.1:979555788",
"BlueCar/Solid1:1003010499/face.1:1422834106",
"BlueCar/Solid1:1003010499/face.1:1333055594",
"BlueCar/Solid1:1003010499/face.1:3576083206",
"BlueCar/Solid1:1003010499/face.1:71526350",
"BlueCar/Solid1:1003010499/face.1:2202450522",
"BlueCar/Solid1:1003010499/face.1:2799526280",
"BlueCar/Solid1:1003010499/face.1:1190135145",
"BlueCar/Solid1:1003010499/face.1:3553322030",
"BlueCar/Solid1:1003010499/face.1:870711503",
"BlueCar/Solid1:1003010499/face.1:377346845",
"BlueCar/Solid1:1003010499/face.1:2109332205",
"BlueCar/Solid1:1003010499/face.1:3890985345",
"BlueCar/Solid1:1003010499/face.1:915303753",
"BlueCar/Solid1:1003010499/face.1:2466102311",
"BlueCar/Solid1:1003010499/face.1:3076941813",
"BlueCar/Solid1:1003010499/face.1:1464533780",
"BlueCar/Solid1:1003010499/face.1:2588835825",
"BlueCar/Solid1:1003010499/face.1:2053315344",
"BlueCar/Solid:2710379468/face.1:1829196173",
"BlueCar/Solid:2710379468/face.1:3160573253",
"BlueCar/Solid:2710379468/face.1:996628689",
"BlueCar/Solid:2710379468/face.1:577740154",
"BlueCar/Solid:2710379468/face.1:3259169179",
"BlueCar/Solid:2710379468/face.1:3889766985",
"BlueCar/Solid:2710379468/face.1:2306166335",
"BlueCar/Solid:2710379468/face.1:2463049711",
"BlueCar/Solid:2710379468/face.1:144524419",
"BlueCar/Solid:2710379468/face.1:3656945739",
"BlueCar/Solid:2169288061/face.1:3296663008",
"BlueCar/Solid:2169288061/face.1:354074920",
"BlueCar/Solid:2169288061/face.1:2451512508",
"BlueCar/Solid:2169288061/face.1:2333595927",
"BlueCar/Solid:2169288061/face.1:1799011830",
"BlueCar/Solid:2169288061/face.1:1319200292",
"BlueCar/Solid:2169288061/face.1:537725522",
"BlueCar/Solid:2169288061/face.1:1001874306",
"BlueCar/Solid:2169288061/face.1:2716139758",
"BlueCar/Solid:2169288061/face.1:1887491110"
]
},
"description": "",
"sops": [
{
"library": {
"sop_file_uri": "/app/assets/BlueCar.speos/Grey Diffuse Paint_5d78-9f5b-6612-4c7a..scattering"
},
"name": "",
"description": "",
"metadata": {}
}
]
},
{
"name": "BlueCar.Material.3",
"metadata": {
"UniqueId": "c9814c06-7246-48b8-ae5b-a8019d14e700"
},
"sop_guids": [
"b3d2b802-46a0-4721-b569-5a7746fc38d2"
],
"geometries": {
"geo_paths": [
"BlueCar/Solid:401601473/face.1:864256700",
"BlueCar/Solid:401601473/face.1:674884460",
"BlueCar/Solid:401601473/face.1:3652159984",
"BlueCar/Solid:401601473/face.1:4231287330",
"BlueCar/Solid:401601473/face.1:471414467",
"BlueCar/Solid:401601473/face.1:2300729220",
"BlueCar/Solid:401601473/face.1:574129345",
"BlueCar/Solid:401601473/face.1:452256235",
"BlueCar/Solid:401601473/face.1:302409131",
"BlueCar/Solid:401601473/face.1:2287208135",
"BlueCar/Solid:401601473/face.1:1496437263",
"BlueCar/Solid:401601473/face.1:1811732616",
"BlueCar/Solid:401601473/face.1:3482257894",
"BlueCar/Solid:401601473/face.1:3927233076",
"BlueCar/Solid:401601473/face.1:171554517",
"BlueCar/Solid:401601473/face.1:3342649904",
"BlueCar/Solid:401601473/face.1:1923399684",
"BlueCar/Solid:401601473/face.1:965965728",
"BlueCar/Solid:401601473/face.1:498577886",
"BlueCar/Solid:401601473/face.1:2290929817",
"BlueCar/Solid:401601473/face.1:1755427960",
"BlueCar/Solid:401601473/face.1:597033948",
"BlueCar/Solid:401601473/face.1:2378553484",
"BlueCar/Solid:401601473/face.1:395820000",
"BlueCar/Solid:401601473/face.1:3337776936",
"BlueCar/Solid:401601473/face.1:3915963223",
"BlueCar/Solid:401601473/face.1:2277816097",
"BlueCar/Solid:401601473/face.1:2625560305",
"BlueCar/Solid:401601473/face.1:103595421",
"BlueCar/Solid:401601473/face.1:3611912533",
"BlueCar/Solid:401601473/face.1:1347204289",
"BlueCar/Solid:401601473/face.1:2931020918",
"BlueCar/Solid:401601473/face.1:887207706",
"BlueCar/Solid:401601473/face.1:3850658770",
"BlueCar/Solid:401601473/face.1:4157302709",
"BlueCar/Solid:401601473/face.1:2618254917",
"BlueCar/Solid:401601473/face.1:2855086790",
"BlueCar/Solid:401601473/face.1:2772707565",
"BlueCar/Solid:401601473/face.1:2304452156",
"BlueCar/Solid:401601473/face.1:2745827269",
"BlueCar/Solid:401601473/face.1:2987588024",
"BlueCar/Solid:401601473/face.1:45237037",
"BlueCar/Solid:401601473/face.1:1887340406",
"BlueCar/Solid:401601473/face.1:994652370",
"BlueCar/Solid:401601473/face.1:552818946",
"BlueCar/Solid:401601473/face.1:1808068262",
"BlueCar/Solid:401601473/face.1:3774898119",
"BlueCar/Solid:401601473/face.1:3421668926",
"BlueCar/Solid:401601473/face.1:3662250051",
"BlueCar/Solid:401601473/face.1:3575677544",
"BlueCar/Solid:401601473/face.1:4181691577"
]
},
"description": "",
"sops": [
{
"library": {
"sop_file_uri": "/app/assets/BlueCar.speos/Car_Paint_Material_Blue_365b-9ed1-1e57-eedd..brdf"
},
"name": "",
"description": "",
"metadata": {}
}
]
},
{
"name": "RedCar.Material.1",
"metadata": {
"UniqueId": "e539259f-c062-4f09-84f4-310825a7f85d"
},
"sop_guids": [
"aab77205-c9d3-417f-85ff-99d05ab60bfe"
],
"geometries": {
"geo_paths": [
"RedCar/Solid:3635120264/face.1:1613122768",
"RedCar/Solid:3635120264/face.1:3094519244",
"RedCar/Solid:3635120264/face.1:3580074009",
"RedCar/Solid:3635120264/face.1:927409569",
"RedCar/Solid:2051257771/face.1:210648018",
"RedCar/Solid:2051257771/face.1:1637826055",
"RedCar/Solid:2051257771/face.1:66842235",
"RedCar/Solid:2051257771/face.1:2878201919",
"RedCar/Solid:739836401/face.1:3889611434",
"RedCar/Solid:739836401/face.1:1581167125",
"RedCar/Solid:739836401/face.1:4131961937",
"RedCar/Solid:739836401/face.1:3950733020",
"RedCar/Solid:635282113/face.1:3094435495",
"RedCar/Solid:635282113/face.1:268916963",
"RedCar/Solid:635282113/face.1:221545070",
"RedCar/Solid:635282113/face.1:3346128909"
]
},
"description": "",
"sops": [
{
"library": {
"sop_file_uri": "/app/assets/RedCar.speos/TireDiffusor_a5c2-fa68-db22-4ccb..simplescattering"
},
"name": "",
"description": "",
"metadata": {}
}
]
},
{
"name": "RedCar.Material.2",
"metadata": {
"UniqueId": "65148451-dec8-415e-a5ec-bd0421598351"
},
"sop_guids": [
"b39b9789-1e61-4a0d-862d-54872eb45f5f"
],
"geometries": {
"geo_paths": [
"RedCar/Solid:39455731/face.1:1896962477",
"RedCar/Solid:39455731/face.1:3993234924",
"RedCar/Solid:39455731/face.1:669232533",
"RedCar/Solid:39455731/face.1:1809034615",
"RedCar/Solid:39455731/face.1:3571969486",
"RedCar/Solid:39455731/face.1:1185658288",
"RedCar/Solid:39455731/face.1:3291192008",
"RedCar/Solid:39455731/face.1:1891688472",
"RedCar/Solid:39455731/face.1:3563865060",
"RedCar/Solid:39455731/face.1:205034232",
"RedCar/Solid:39455731/face.1:1630115629"
]
},
"description": "",
"sops": [
{
"library": {
"sop_file_uri": "/app/assets/RedCar.speos/Red Diffuse Paint_c594-8c92-c39c-e0b0..scattering"
},
"name": "",
"description": "",
"metadata": {}
}
]
}
],
"name": "",
"description": "",
"metadata": {},
"sources": [],
"sensors": [],
"simulations": [],
"scenes": []
}
Preview the project#
User can review the created/loaded project using preview method.
[4]:
p.preview()
Complete the project with sensor/source/simulation#
We are adding a camera sensor to have output results, a luminaire to have a light source.
And, we gather the source and the sensor into a simulation (we will compute it just after).
Create a sensor#
[5]:
ssr = p.create_sensor(name="Camera.1", feature_type=SensorCamera)
ssr.set_distortion_file_uri(
uri=str(assets_data_path / "CameraInputFiles" / "CameraDistortion_190deg.OPTDistortion")
).set_mode_photometric().set_transmittance_file_uri(
uri=str(assets_data_path / "CameraInputFiles" / "CameraTransmittance.spectrum")
).set_mode_color().set_red_spectrum_file_uri(
uri=str(assets_data_path / "CameraInputFiles" / "CameraSensitivityRed.spectrum")
).set_blue_spectrum_file_uri(
uri=str(assets_data_path / "CameraInputFiles" / "CameraSensitivityBlue.spectrum")
).set_green_spectrum_file_uri(
uri=str(assets_data_path / "CameraInputFiles" / "CameraSensitivityGreen.spectrum")
)
ssr.set_axis_system([-2000, 1500, 11000, -1, 0, 0, 0, 1, 0, 0, 0, -1])
ssr.commit()
[5]:
<ansys.speos.core.sensor.SensorCamera at 0x7fc25c5b8700>
Create a source#
In this example, a luminaire source is created with an IES file.
More details on creating/editing source examples can be found in core examples.
[6]:
src = p.create_source(name="Luminaire.1", feature_type=SourceLuminaire)
src.set_intensity_file_uri(
uri=str(assets_data_path / "IES_C_DETECTOR.ies")
).set_spectrum().set_daylightfluorescent()
src.set_axis_system([0, 10000, 50000, 1, 0, 0, 0, 1, 0, 0, 0, 1])
src.commit()
[6]:
<ansys.speos.core.source.SourceLuminaire at 0x7fc25c5ba560>
Create a simulation#
More details on creating/editing simulation examples can be found in core examples.
[7]:
sim = p.create_simulation(name="Inverse.1", feature_type=SimulationInverse)
sim.set_sensor_paths(["Camera.1"]).set_source_paths(["Luminaire.1"])
sim.commit()
[7]:
<ansys.speos.core.simulation.SimulationInverse at 0x7fc25c5bb220>
Run the simulation#
Simulation can be run using CPU via compute_CPU method or using GPU via compute_GPU method.
[8]:
sim.compute_CPU() # run simulation in CPU
# sim.compute_GPU() # run simulation in GPU
[8]:
[upload_response {
info {
uri: "3aae8918-1393-443d-a436-cff0b38b7c6b"
file_name: "Camera.1.Irradiance.xmp"
file_size: 10645308
}
upload_duration {
nanos: 12833095
}
}
, upload_response {
info {
uri: "23f6319a-7e2f-4527-8ec7-8607d4036a8a"
file_name: "Camera.1.hdr"
file_size: 518875
}
upload_duration {
nanos: 943345
}
}
, upload_response {
info {
uri: "faf728ba-8326-4d05-89c4-1ec945d31568"
file_name: "Camera.1.xmp"
file_size: 1805098
}
upload_duration {
nanos: 2133312
}
}
, upload_response {
info {
uri: "4a42dda3-bdb8-41b9-8471-7897ca6d5fc9"
file_name: "Camera.1.png"
file_size: 741878
}
upload_duration {
nanos: 969434
}
}
, upload_response {
info {
uri: "a192310b-55bf-411b-b2d7-bf301ff335cb"
file_name: "Inverse.1.html"
file_size: 998791
}
upload_duration {
nanos: 1197771
}
}
]
Check and review result#
Open result (only windows)
[9]:
if os.name == "nt":
from ansys.speos.core.workflow.open_result import open_result_image
open_result_image(simulation_feature=sim, result_name="Camera.1.png")
Modify part#
Move the part via changing the axis_system of a part.
axis_system is a list of 12 float values: x, y, z, x_vect_x, x_vect_y, x_vect_z, y_vect_x, y_vect_y, y_vect_z, z_vect_x, z_vect_y, z_vect_z.
[10]:
blue_car_sub_part = p.find(name="BlueCar", feature_type=Part.SubPart)[0]
blue_car_sub_part.set_axis_system([2000, 0.0, 20000, 0.0, 0.0, -1.0, -1.0, 0.0, 0.0, 0.0, 1.0, 0.0])
blue_car_sub_part.commit()
[10]:
<ansys.speos.core.part.Part.SubPart at 0x7fc27317add0>
Re-run simulation with the modified part position
[11]:
sim.compute_CPU()
[11]:
[upload_response {
info {
uri: "1166444c-d223-4f5a-aee0-9a5fa7f7a93e"
file_name: "Camera.1.Irradiance.xmp"
file_size: 10395961
}
upload_duration {
nanos: 10643875
}
}
, upload_response {
info {
uri: "da1d5edb-eaf2-41bf-a8b4-9e36e3a538eb"
file_name: "Camera.1.hdr"
file_size: 519951
}
upload_duration {
nanos: 778387
}
}
, upload_response {
info {
uri: "cc9eac3d-58ca-4192-bfdb-16f02e080327"
file_name: "Camera.1.xmp"
file_size: 1763696
}
upload_duration {
nanos: 2251956
}
}
, upload_response {
info {
uri: "a4c0c7f0-20b5-424b-beef-1a90b7a0e3ff"
file_name: "Camera.1.png"
file_size: 728294
}
upload_duration {
nanos: 986186
}
}
, upload_response {
info {
uri: "186eb410-3f5f-4b64-822a-a53682e14969"
file_name: "Inverse.1.html"
file_size: 981557
}
upload_duration {
nanos: 1237907
}
}
]
Review result:
[12]:
if os.name == "nt":
open_result_image(simulation_feature=sim, result_name="Camera.1.png")
Modify camera property#
Modify the camera, e.g. focal length to 10
[13]:
cam1 = p.find(name="Camera.1", feature_type=SensorCamera)[0]
cam1.set_focal_length(value=10)
cam1.commit()
[13]:
<ansys.speos.core.sensor.SensorCamera at 0x7fc25c5b8700>
Re-run the simulation and review result
[14]:
sim.compute_CPU()
if os.name == "nt":
open_result_image(simulation_feature=sim, result_name="Camera.1.png")