diff --git a/2026R1.2/speos_rpc-26-r1.2/GenDocu-template.tmpl b/2026R1.2/speos_rpc-26-r1.2/GenDocu-template.tmpl new file mode 100644 index 000000000..a7ea4f177 --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/GenDocu-template.tmpl @@ -0,0 +1,82 @@ +# Reference documentation + + +{{range .Files}} +{{$short_name := .Name | replace "ansys/api/speos/" ""}} + + + +## {{$short_name}} +{{.Description}} + +{{range .Messages}} + + +### {{.LongName}} +{{.Description}} + +{{if .HasFields}} +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +{{range .Fields -}} + | {{.Name}} | [{{.LongType | replace "ansys.api.speos." ""}}](#{{.FullType | anchor}}) | {{.Label}} | {{if (index .Options "deprecated"|default false)}}**Deprecated.** {{end}}{{.Description | replace "\n" "
" | nobr}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} | +{{end}} +{{end}} + +{{if .HasExtensions}} +| Extension | Type | Base | Number | Description | +| --------- | ---- | ---- | ------ | ----------- | +{{range .Extensions -}} + | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} | +{{end}} +{{end}} + +{{end}} + +{{range .Enums}} + + +### {{.LongName}} +{{.Description}} + +| Name | Number | Description | +| ---- | ------ | ----------- | +{{range .Values -}} + | {{.Name}} | {{.Number}} | {{nobr .Description}} | +{{end}} + +{{end}} + +{{if .HasExtensions}} + + +### File-level Extensions +| Extension | Type | Base | Number | Description | +| --------- | ---- | ---- | ------ | ----------- | +{{range .Extensions -}} + | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} | +{{end}} +{{end}} + +{{range .Services}} + + +### {{.Name}} +{{.Description}} + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +{{range .Methods -}} + | {{.Name}} | [{{.RequestLongType | replace ".ansys.api.speos." "" | replace "ansys.api.speos." ""}}](#{{.RequestFullType | anchor}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType | replace ".ansys.api.speos." "" | replace "ansys.api.speos." ""}}](#{{.ResponseFullType | anchor}}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} | +{{end}} +{{end}} + +{{end}} + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +{{range .Scalars -}} + | {{.ProtoType}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | {{.PythonType}} | {{.GoType}} | {{.CSharp}} | {{.PhpType}} | {{.RubyType}} | +{{end}} \ No newline at end of file diff --git a/2026R1.2/speos_rpc-26-r1.2/TOC.yml b/2026R1.2/speos_rpc-26-r1.2/TOC.yml new file mode 100644 index 000000000..451f748cf --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/TOC.yml @@ -0,0 +1,23 @@ +- name: Introduction + href: index.md +- name: Unsupported features and limitations + href: unsupported-features-limitations.md +- name: Reference documentation + href: api-reference.md +- name: Changelog + href: changelogs\speos_changelogs_rpc.md + items: + - name: Speos RPC Changelog 2026 R1 SP02 + href: changelogs\speos_changelogs_rpc_2612.md + - name: Speos RPC Changelog 2026 R1 SP01 + href: changelogs\speos_changelogs_rpc_2611.md + - name: Speos RPC Changelog 2026 R1 + href: changelogs\speos_changelogs_rpc_261.md + - name: Speos RPC Changelog 2025 R2 SP03 + href: changelogs\speos_changelogs_rpc_2523.md + - name: Speos RPC Changelog 2025 R2 SP01 + href: changelogs\speos_changelogs_rpc_2521.md + - name: Speos RPC Changelog 2025 R2 + href: changelogs\speos_changelogs_rpc_252.md + - name: Speos RPC Changelog 2025 R1 SP04 + href: changelogs\speos_changelogs_rpc_2514.md diff --git a/2026R1.2/speos_rpc-26-r1.2/api-reference.md b/2026R1.2/speos_rpc-26-r1.2/api-reference.md new file mode 100644 index 000000000..a195f8d26 --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/api-reference.md @@ -0,0 +1,6773 @@ +# Reference documentation + + + + +## LTF/v1/LTF.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Filename + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| filename | [string](#string) | | | + + + +### LightTransferData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| object_direction | [Vector3d](#ansys-api-speos-LTF-v1-Vector3d) | | | +| start_point | [Point3d](#ansys-api-speos-LTF-v1-Point3d) | | | +| emissivity | [double](#double) | | | +| focus_distance | [double](#double) | | | +| divergence_X | [double](#double) | | | +| divergence_Y | [double](#double) | | | +| pupil_surface | [LightTransferData.PupilSurface](#ansys-api-speos-LTF-v1-LightTransferData-PupilSurface) | | | + + + +### LightTransferData.PupilSurface + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| disk | [PupilSurfaceDisk](#ansys-api-speos-LTF-v1-PupilSurfaceDisk) | | | +| ellipse | [PupilSurfaceEllipse](#ansys-api-speos-LTF-v1-PupilSurfaceEllipse) | | | +| polygon | [PupilSurfacePolygon](#ansys-api-speos-LTF-v1-PupilSurfacePolygon) | | | + + + +### LightTransferDataDistribution + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [LightTransferData](#ansys-api-speos-LTF-v1-LightTransferData) | repeated | | + + + +### Point2d + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x | [double](#double) | | | +| y | [double](#double) | | | + + + +### Point3d + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x | [double](#double) | | | +| y | [double](#double) | | | +| z | [double](#double) | | | + + + +### PupilSurfaceDisk + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| radius | [double](#double) | | | + + + +### PupilSurfaceEllipse + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| alpha | [double](#double) | | | +| semi_major_axis | [double](#double) | | | +| semi_minor_axis | [double](#double) | | | + + + +### PupilSurfacePolygon + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| nb_points | [int32](#int32) | | | +| points | [Point2d](#ansys-api-speos-LTF-v1-Point2d) | repeated | | + + + +### SpectralLightTransferDataDistribution + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wavelength_samples | [double](#double) | repeated | | +| sensor_sampling_type | [SensorSamplingType](#ansys-api-speos-LTF-v1-SensorSamplingType) | | | +| sensor_samples_X | [double](#double) | repeated | | +| sensor_samples_Y | [double](#double) | repeated | | +| pupil_surface_type | [PupilSurfaceType](#ansys-api-speos-LTF-v1-PupilSurfaceType) | | | +| ltf_samples | [LightTransferDataDistribution](#ansys-api-speos-LTF-v1-LightTransferDataDistribution) | repeated | | + + + +### Vector3d + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x | [double](#double) | | | +| y | [double](#double) | | | +| z | [double](#double) | | | + + + + + +### PupilSurfaceType + +| Name | Number | Description | +| ---- | ------ | ----------- | +| POINT | 0 | | +| DISK | 1 | | +| ELLIPSE | 2 | | +| POLYGON | 3 | | + + + +### SensorSamplingType +the sensor sampling type : +symmetric = polar coordinates +asymmetric = cartesian coordinates + +| Name | Number | Description | +| ---- | ------ | ----------- | +| SYMMETRIC | 0 | | +| ASYMMETRIC | 1 | | + + + + + + + +### LightTransferFunctionService + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Load | [Filename](#ansys-api-speos-LTF-v1-Filename) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | Serialization for *.OPTDistortion files | +| Save | [Filename](#ansys-api-speos-LTF-v1-Filename) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | | +| Import | [SpectralLightTransferDataDistribution](#ansys-api-speos-LTF-v1-SpectralLightTransferDataDistribution) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | Import/Export of LightTransferDataDistribution | +| Export | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | [SpectralLightTransferDataDistribution](#ansys-api-speos-LTF-v1-SpectralLightTransferDataDistribution) | | + + + + + + +## bsdf/v1/anisotropic_bsdf.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### AnisotropicBsdfData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| description | [string](#string) | | | +| anisotropy_vector | [AnisotropicBsdfData.Double3](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-AnisotropicBsdfData-Double3) | | | +| reflection | [AnisotropicBsdfData.Bsdf](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-AnisotropicBsdfData-Bsdf) | | | +| transmission | [AnisotropicBsdfData.Bsdf](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-AnisotropicBsdfData-Bsdf) | | | + + + +### AnisotropicBsdfData.Bsdf + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| spectrum_incidence | [double](#double) | | spectrum information

radians in [0, pi/2] | +| spectrum_anisotropy | [double](#double) | | radians in [0, 2*pi] | +| spectrum | [AnisotropicBsdfData.Bsdf.WavelengthCoefficientPair](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-AnisotropicBsdfData-Bsdf-WavelengthCoefficientPair) | repeated | | +| anisotropic_samples | [AnisotropicBsdfData.Bsdf.AnisotropicSample](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-AnisotropicBsdfData-Bsdf-AnisotropicSample) | repeated | | + + + +### AnisotropicBsdfData.Bsdf.AnisotropicSample + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| anisotropic_sample | [double](#double) | | radians in [0, pi/2] or [0, pi] or [0, 2*pi] | +| incidence_samples | [AnisotropicBsdfData.Bsdf.AnisotropicSample.IncidenceSample](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-AnisotropicBsdfData-Bsdf-AnisotropicSample-IncidenceSample) | repeated | | + + + +### AnisotropicBsdfData.Bsdf.AnisotropicSample.IncidenceSample + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| incidence_sample | [double](#double) | | radians in [0, pi/2] | +| theta_samples | [double](#double) | repeated | intensity diagram

radians in [0, pi/2] for reflection // radians in [pi/2, pi] for transmission | +| phi_samples | [double](#double) | repeated | radians in [0, 2*pi] | +| bsdf_cos_theta | [double](#double) | repeated | 1/steradians | +| integral | [double](#double) | | reflection/transmission coefficient | + + + +### AnisotropicBsdfData.Bsdf.WavelengthCoefficientPair + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wavelength | [double](#double) | | nanometers | +| coefficient | [double](#double) | | in [0, 1] interval | + + + +### AnisotropicBsdfData.Double3 + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x | [double](#double) | | | +| y | [double](#double) | | | +| z | [double](#double) | | | + + + +### ConoscopicMap + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| output_file_name | [string](#string) | | .xmp | +| wavelength | [double](#double) | | nanometers | +| anisotropic_angle | [double](#double) | | radians in [0, 2*pi] | +| side | [ConoscopicMap.BsdfSide](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-ConoscopicMap-BsdfSide) | | | +| resolution | [int32](#int32) | | | + + + +### FileName + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_name | [string](#string) | | | + + + +### InterpolationEnhancementData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| anisotropic_samples | [InterpolationEnhancementData.AnisotropicSample](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-InterpolationEnhancementData-AnisotropicSample) | repeated | | + + + +### InterpolationEnhancementData.AnisotropicSample + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| incidence_samples | [InterpolationEnhancementData.AnisotropicSample.ConeData](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-InterpolationEnhancementData-AnisotropicSample-ConeData) | repeated | | + + + +### InterpolationEnhancementData.AnisotropicSample.ConeData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cone_half_angle | [double](#double) | | radians in [0, pi/2] | +| cone_height | [double](#double) | | value >= 0 | + + + +### RefractiveIndices + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| refractive_index_1 | [double](#double) | | | +| refractive_index_2 | [double](#double) | | | + + + +### SpectrumImport + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| incidence_angle | [double](#double) | | radians in [0, pi/2] | +| anisotropy_angle | [double](#double) | | radians in [0, 2*pi] | +| file_name | [string](#string) | | .spectrum | + + + +### SpecularInterpolationEnhancementData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| reflection | [InterpolationEnhancementData](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-InterpolationEnhancementData) | | | +| transmission | [InterpolationEnhancementData](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-InterpolationEnhancementData) | | | +| refractive_index_1 | [double](#double) | | | +| refractive_index_2 | [double](#double) | | | + + + +### Wavelength + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wavelength | [double](#double) | | in nanometers | + + + + + +### ConoscopicMap.BsdfSide + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | | +| REFLECTION | 1 | | +| TRANSMISSION | 2 | | + + + + + + + +### AnisotropicBsdfService + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Load | [FileName](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-FileName) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | serialization for native *.anisotropicbsdf files | +| Save | [FileName](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-FileName) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | | +| Import | [AnisotropicBsdfData](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-AnisotropicBsdfData) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | to and from AnisoptropicSpeosBsdf.AnisotropicBsdfData | +| Export | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | [AnisotropicBsdfData](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-AnisotropicBsdfData) | | +| ImportFile | [FileName](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-FileName) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | to and from serialized AnisoptropicSpeosBsdf.AnisotropicBsdfData | +| ExportFile | [FileName](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-FileName) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | | +| GenerateSpecularInterpolationEnhancementData | [RefractiveIndices](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-RefractiveIndices) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | interpolation enhancement for specular | +| GetSpecularInterpolationEnhancementData | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | [SpecularInterpolationEnhancementData](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-SpecularInterpolationEnhancementData) | | +| SetSpecularInterpolationEnhancementData | [SpecularInterpolationEnhancementData](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-SpecularInterpolationEnhancementData) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | | +| GenerateRetroReflectionInterpolationEnhancementData | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | interpolation enhancement for retro reflection | +| GetRetroReflectionInterpolationEnhancementData | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | [InterpolationEnhancementData](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-InterpolationEnhancementData) | | +| SetRetroReflectionInterpolationEnhancementData | [InterpolationEnhancementData](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-InterpolationEnhancementData) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | | +| EnableWhiteSpecular | [Wavelength](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-Wavelength) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | white specular | +| DisableWhiteSpecular | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | | +| ImportReflectionSpectrum | [SpectrumImport](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-SpectrumImport) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | spectrum import | +| ImportTransmissionSpectrum | [SpectrumImport](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-SpectrumImport) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | | +| FreezeAbsorptionReflectionTransmissionCoefficients | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | constant absorption | +| ExportToConoscopicMap | [ConoscopicMap](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-ConoscopicMap) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | export to conoscopic map | + + + + + + +## bsdf/v1/bsdf_creation.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### AnisotropicBsdfInputData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| input_anisotropic_bsdf_samples | [AnisotropicBsdfInputData.Sample](#ansys-api-speos-bsdf-v1-SpeosBsdfCreation-AnisotropicBsdfInputData-Sample) | repeated | | +| fix_disparity | [bool](#bool) | | | +| output_file_name | [string](#string) | | .anisotropicbsdf | + + + +### AnisotropicBsdfInputData.Sample + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| anisotropic_angle | [double](#double) | | radians in [0, 2*pi] | +| file_name | [string](#string) | | .anisotropicbsdf | + + + +### Bsdf180InputData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| input_front_bsdf_file_name | [string](#string) | | .coated *.brdf *.anisotropicbsdf *.scattering | +| input_opposite_bsdf_file_name | [string](#string) | | .coated *.brdf *.anisotropicbsdf *.scattering | +| output_file_name | [string](#string) | | .bsdf180 | + + + +### SpectralBsdfInputData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| input_anisotropic_samples | [SpectralBsdfInputData.Sample](#ansys-api-speos-bsdf-v1-SpeosBsdfCreation-SpectralBsdfInputData-Sample) | repeated | | +| output_file_name | [string](#string) | | .brdf | + + + +### SpectralBsdfInputData.Sample + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wavelength | [double](#double) | | nanometers | +| file_name | [string](#string) | | .anisotropicbsdf | + + + + + + + + + +### BsdfCreationService + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| BuildBsdf180 | [Bsdf180InputData](#ansys-api-speos-bsdf-v1-SpeosBsdfCreation-Bsdf180InputData) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | create a bsdf180 file | +| BuildSpectralBsdf | [SpectralBsdfInputData](#ansys-api-speos-bsdf-v1-SpeosBsdfCreation-SpectralBsdfInputData) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | create spectral bsdf file | +| BuildAnisotropicBsdf | [AnisotropicBsdfInputData](#ansys-api-speos-bsdf-v1-SpeosBsdfCreation-AnisotropicBsdfInputData) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | build anisotropic bsdf file | + + + + + + +## bsdf/v1/spectral_bsdf.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### ConoscopicMap + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| output_file_name | [string](#string) | | .xmp | +| wavelength | [double](#double) | | nanometers | +| side | [ConoscopicMap.BsdfSide](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-ConoscopicMap-BsdfSide) | | | +| resolution | [int32](#int32) | | | + + + +### FileName + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_name | [string](#string) | | | + + + +### RefractiveIndices + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| refractive_index_1 | [double](#double) | | | +| refractive_index_2 | [double](#double) | | | + + + +### SpectralBsdfData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| description | [string](#string) | | | +| incidence_samples | [double](#double) | repeated | radians in [0, pi/2] | +| wavelength_samples | [double](#double) | repeated | nanometers | +| wavelength_incidence_samples | [SpectralBsdfData.WavelengthIncidence](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-SpectralBsdfData-WavelengthIncidence) | repeated | | + + + +### SpectralBsdfData.WavelengthIncidence + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| reflection | [SpectralBsdfData.WavelengthIncidence.Diagram](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-SpectralBsdfData-WavelengthIncidence-Diagram) | | | +| transmission | [SpectralBsdfData.WavelengthIncidence.Diagram](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-SpectralBsdfData-WavelengthIncidence-Diagram) | | | + + + +### SpectralBsdfData.WavelengthIncidence.Diagram + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| theta_samples | [double](#double) | repeated | radians in [0, pi/2] | +| phi_samples | [double](#double) | repeated | radians in [0, 2*pi] | +| bsdf_cos_theta | [double](#double) | repeated | 1/steradians | +| integral | [double](#double) | | reflection/transmission coefficient in [0, 1] interval | + + + +### SpecularInterpolationEnhancementData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| incidence_nb | [int32](#int32) | | | +| wavelength_nb | [int32](#int32) | | | +| refractive_index_1 | [double](#double) | | | +| refractive_index_2 | [double](#double) | | | +| wavelength_incidence_samples | [SpecularInterpolationEnhancementData.WavelengthIncidence](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-SpecularInterpolationEnhancementData-WavelengthIncidence) | repeated | | + + + +### SpecularInterpolationEnhancementData.WavelengthIncidence + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| reflection | [SpecularInterpolationEnhancementData.WavelengthIncidence.ConeData](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-SpecularInterpolationEnhancementData-WavelengthIncidence-ConeData) | | | +| transmission | [SpecularInterpolationEnhancementData.WavelengthIncidence.ConeData](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-SpecularInterpolationEnhancementData-WavelengthIncidence-ConeData) | | | + + + +### SpecularInterpolationEnhancementData.WavelengthIncidence.ConeData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cone_half_angle | [double](#double) | | radians in [0, pi/2] | +| cone_height | [double](#double) | | value >= 0 | + + + + + +### ConoscopicMap.BsdfSide + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | | +| REFLECTION | 1 | | +| TRANSMISSION | 2 | | + + + + + + + +### SpectralBsdfService + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Load | [FileName](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-FileName) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | serialization for native *.brdf files | +| Save | [FileName](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-FileName) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | | +| Import | [SpectralBsdfData](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-SpectralBsdfData) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | to and from SpectralSpeosBsdf.SpectralBsdfData | +| Export | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | [SpectralBsdfData](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-SpectralBsdfData) | | +| ImportFile | [FileName](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-FileName) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | to and from serialized SpectralSpeosBsdf.SpectralBsdfData | +| ExportFile | [FileName](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-FileName) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | | +| GenerateSpecularInterpolationEnhancementData | [RefractiveIndices](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-RefractiveIndices) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | interpolation enhancement for specular | +| GetSpecularInterpolationEnhancementData | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | [SpecularInterpolationEnhancementData](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-SpecularInterpolationEnhancementData) | | +| SetSpecularInterpolationEnhancementData | [SpecularInterpolationEnhancementData](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-SpecularInterpolationEnhancementData) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | | +| ExportToConoscopicMap | [ConoscopicMap](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-ConoscopicMap) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | export to conoscopic map | + + + + + + +## common/v1/data.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### DataBytes +raw buffer in bytes, to send any kind of data + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [bytes](#bytes) | | raw values | +| magnitude_size | [uint64](#uint64) | | number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...) | +| dimensions | [uint64](#uint64) | repeated | size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size | +| magnitude | [Magnitude](#ansys-api-speos-common-v1-Magnitude) | | magnitude of the value of what we have received | +| unit | [Unit](#ansys-api-speos-common-v1-Unit) | | units of the values | + + + +### DataDoubles +arrays values of doubles + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [double](#double) | repeated | raw values | +| magnitude_size | [uint64](#uint64) | | number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...) | +| dimensions | [uint64](#uint64) | repeated | size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size | +| magnitude | [Magnitude](#ansys-api-speos-common-v1-Magnitude) | | magnitude of the value of what we have received | +| unit | [Unit](#ansys-api-speos-common-v1-Unit) | | units of the values | + + + +### DataFloats +arrays values of floats + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [float](#float) | repeated | raw values | +| magnitude_size | [uint64](#uint64) | | number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...) | +| dimensions | [uint64](#uint64) | repeated | size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size | +| magnitude | [Magnitude](#ansys-api-speos-common-v1-Magnitude) | | magnitude of the value of what we have received | +| unit | [Unit](#ansys-api-speos-common-v1-Unit) | | units of the values | + + + +### DataIntegers32 +arrays values of integers + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [int32](#int32) | repeated | raw values | +| magnitude_size | [uint64](#uint64) | | number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...) | +| dimensions | [uint64](#uint64) | repeated | size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size | +| magnitude | [Magnitude](#ansys-api-speos-common-v1-Magnitude) | | magnitude of the value of what we have received | +| unit | [Unit](#ansys-api-speos-common-v1-Unit) | | units of the values | + + + +### DataIntegers64 +arrays values of integers + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [int64](#int64) | repeated | raw values | +| magnitude_size | [uint64](#uint64) | | number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...) | +| dimensions | [uint64](#uint64) | repeated | size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size | +| magnitude | [Magnitude](#ansys-api-speos-common-v1-Magnitude) | | magnitude of the value of what we have received | +| unit | [Unit](#ansys-api-speos-common-v1-Unit) | | units of the values | + + + +### DataUIntegers32 +arrays values of integers + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [uint32](#uint32) | repeated | raw values | +| magnitude_size | [uint64](#uint64) | | number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...) | +| dimensions | [uint64](#uint64) | repeated | size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size | +| magnitude | [Magnitude](#ansys-api-speos-common-v1-Magnitude) | | magnitude of the value of what we have received | +| unit | [Unit](#ansys-api-speos-common-v1-Unit) | | units of the values | + + + +### DataUIntegers64 +arrays values of integers + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [uint64](#uint64) | repeated | raw values | +| magnitude_size | [uint64](#uint64) | | number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...) | +| dimensions | [uint64](#uint64) | repeated | size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size | +| magnitude | [Magnitude](#ansys-api-speos-common-v1-Magnitude) | | magnitude of the value of what we have received | +| unit | [Unit](#ansys-api-speos-common-v1-Unit) | | units of the values | + + + + + +### Magnitude +Magnitude represent a physical quantity + +| Name | Number | Description | +| ---- | ------ | ----------- | +| irradiance | 0 | radiometric irradiance | +| illuminance | 1 | photometric irradiance | +| spectral_irradiance | 2 | spectral radiometric irradiance | +| spectral_illuminance | 3 | spectral photometric irradiance | +| radiance | 4 | radiometric radiance | +| luminance | 5 | photometric radiance | +| spectral_radiance | 6 | spectral radiometric radiance | +| spectral_luminance | 7 | spectral photometric radiance | +| radiant_intensity | 8 | radiometric intensity | +| luminous_intensity | 9 | photometric intensity | +| spectral_radiant_intensity | 10 | spectral radiometric intensity | +| spectral_luminous_intensity | 11 | spectral photometric intensity | +| exposure | 12 | radiometric exposure | +| luminous_exposure | 13 | photometric exposure | +| spectral_exposure | 14 | spectral radiometric exposure | +| spectral_luminous_exposure | 15 | spectral photometric exposure | +| radiant_flux | 16 | radiometric flux | +| luminous_flux | 17 | photometric flux | +| wavelength | 26 | wavelength | +| ratio | 27 | magnitude ratio | +| color | 37 | color | +| ray_sampling | 38 | rays sampling | +| distance | 48 | distance | +| dimension | 49 | dimension | +| plane_angle | 50 | plane angle | +| curvature | 51 | curvature | +| curvature_product | 52 | curvature product | +| photometric_power_density | 62 | photometric power density | +| radiometric_power_density | 63 | radiometric power density | +| spherical_probability_density | 64 | spherical probability density | +| temperature_elevation | 74 | temperature elevation | +| colorimetric_error | 84 | colorimetric error | +| signal_to_noise_ratio | 85 | SNR | +| precision | 86 | precision | +| relative_standard_error | 87 | relative standard error | +| refractive_power | 97 | refractive power | +| refractive_index | 98 | refractive index | +| absorption | 99 | absorption | +| x_color | 109 | xyY color space | +| y_color | 110 | xyY color space | +| u_color | 111 | uvY color space | +| v_color | 112 | uvY color space | +| u_prime_color | 113 | u'v'Y color space | +| v_prime_color | 114 | u'v'Y color space | +| u_star_color | 115 | L*u*v* color space | +| v_star_color | 116 | L*u*v* color space | +| a_star_color | 117 | L*a*b* color space | +| b_star_color | 118 | L*a*b* color space | +| uppercase_c_star_color | 119 | L*C*h color space | +| h_color | 120 | L*C*h color space | +| uppercase_x_color | 121 | XYZ color space | +| uppercase_y_color | 122 | XYZ color space | +| uppercase_z_color | 123 | XYZ color space | +| uppercase_l_star_color | 124 | L*u*v* color space | +| glare | 134 | glare | + + + +### Unit +Units used in Speos data + +| Name | Number | Description | +| ---- | ------ | ----------- | +| watts | 0 | W | +| watts_per_square_meters | 1 | W/(m2) | +| watts_per_steradians | 2 | W/(sr) | +| watts_per_nanometers | 3 | W/(nm) | +| watts_per_square_meters_steradians | 4 | W/(m2.sr) | +| watts_per_steradians_nanometers | 5 | W/(sr.nm) | +| watts_per_square_meters_nanometers | 6 | W/(m2.nm) | +| watts_per_square_foot | 7 | W/ft2 | +| watts_per_square_foot_nanometer | 8 | W/(ft2.nm) | +| watts_per_square_centimeter | 9 | W/cm2 | +| watts_per_square_foot_steradian | 10 | W/(ft2.sr) | +| watts_per_square_meter_steradian_nanometer | 11 | W/(m2.sr.nm) | +| watts_per_square_foot_steradian_nanometer | 12 | W/(ft2.sr.nm) | +| watts_per_cubic_meter | 13 | W/m3 | +| watts_per_cubic_centimeter | 14 | W/cm3 | +| joules | 16 | J | +| joules_per_nanometers | 17 | J/(nm) | +| joules_per_square_meters | 18 | J/(m2) | +| joules_per_square_meters_nanometers | 19 | J/(m2.nm) | +| joules_per_square_centimeter | 20 | J/cm2 | +| joules_per_square_foot | 21 | J/ft2 | +| joules_per_square_foot_nanometer | 22 | J/(ft2.nm) | +| luxes | 29 | lx | +| luxes_seconds | 30 | lx.s | +| luxes_per_nanometers | 31 | lx.s/(nm) | +| luxes_seconds_per_nanometers | 32 | lx.s/(nm) | +| candelas | 42 | cd | +| candelas_per_square_meters | 43 | cd/(m2) | +| candelas_per_nanometers | 44 | cd/(m2) | +| candelas_per_squaremeters_nanometers | 45 | cd/(m2.nm) | +| candelas_per_square_centimeter | 46 | cd/cm2 | +| candelas_per_square_foot | 47 | cd/ft2 | +| candelas_per_square_foot_nanometer | 48 | cd/(ft2.nm) | +| lumens_per_square_meters_nanometers | 49 | lm/(m2.nm) | +| lumens | 55 | lm | +| lumens_seconds | 56 | lm.s | +| lumens_per_nanometers | 57 | lm/(nm) | +| lumens_per_square_centimeter | 59 | lm/cm2 | +| percent | 60 | % | +| lumens_per_cubic_meter | 61 | lm/m3 | +| lumens_seconds_per_square_centimeter | 62 | lm.s/cm2 | +| color_XYZ | 70 | XYZ CIE | +| color_xyY | 71 | xy CIE | +| color_uvY | 72 | uvY 1960 UCS CIE | +| color_uvY_prime | 73 | u'v'Y' 1976 UCS CIE | +| color_Luv | 74 | L*u*v CIELUV | +| color_Lab | 75 | L*a*b CIELAB | +| color_LCh | 76 | L*C*h CIELAB | +| color_rgb | 77 | rgb | +| color_rgba | 79 | rgba | +| foot_candles | 90 | fc | +| foot_candles_per_nanometer | 91 | fc/nm | +| foot_candles_seconds | 92 | fc.s | +| foot_candles_seconds_per_nanometer | 93 | fc.s/nm | +| foot_lamberts | 94 | fL | +| foot_lamberts_per_nanometer | 95 | fL/nm | +| nanometers | 120 | nm | +| micrometers | 121 | um | +| millimeters | 122 | mm | +| meters | 123 | m | +| radians | 124 | rad | +| degrees | 125 | deg | +| steradians | 126 | sr | +| ray_per_pixel | 127 | rays/pixel | +| feet | 128 | ft | +| inches | 129 | in | +| milliradians | 130 | mrad | +| arcminutes | 131 | ' | +| arcseconds | 132 | '' | +| kelvin | 133 | K | +| diopters | 134 | D | +| millidiopters | 135 | mD | +| unit_precision | 136 | % | +| square_meters | 140 | m2 | +| square_centimeters | 141 | cm2 | +| square_millimeters | 142 | mm2 | +| square_micrometers | 143 | micron2 | +| square_nanometers | 144 | nm2 | +| square_feet | 145 | ft2 | +| square_inches | 146 | inch2 | +| invert_meter | 150 | m-1 | +| invert_millimeter | 151 | mm-1 | +| invert_foot | 152 | ft-1 | +| invert_inch | 153 | in-1 | +| invert_steradian | 154 | sr-1 | +| no_unit | 160 | | + + + + + + + + + + +## file/v1/file_transfer.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### AddDependencies_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uri | [string](#string) | | uri of the FileSystemItem to be completed with dependencies | +| dependency_uris | [string](#string) | repeated | FileSystemItem uris to be added as dependencies | + + + +### AddDependencies_Response + + + +### Chunk + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| binary | [bytes](#bytes) | | | +| size | [int64](#int64) | | | +| file_name | [string](#string) | | file name. Mandatory in the first chunk exchanged. | + + + +### Delete_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uri | [string](#string) | | uri of the FileSystemItem to be deleted | + + + +### Delete_Response + + + +### Download_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uri | [string](#string) | | uri of the FileSystemItem to be downloaded | + + + +### Download_Response +Used in File Transfer helpers + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| info | [FileSystemItemInformation](#ansys-api-speos-file-v1-FileSystemItemInformation) | | Information about the FileSystemItem downloaded | +| download_duration | [google.protobuf.Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration) | | | + + + +### FileSystemItemInformation + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uri | [string](#string) | | FileSystemItem uri | +| file_name | [string](#string) | | | +| file_size | [uint64](#uint64) | | | + + + +### ListDependencies_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uri | [string](#string) | | uri of the FileSystemItem | + + + +### ListDependencies_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| dependency_infos | [FileSystemItemInformation](#ansys-api-speos-file-v1-FileSystemItemInformation) | repeated | Information about the FileSystemItems noticed as dependencies | + + + +### Reserve_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_name | [string](#string) | | FileSystemItem's name | + + + +### Reserve_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uri | [string](#string) | | uri of the FileSystemItem reserved | + + + +### Upload_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| info | [FileSystemItemInformation](#ansys-api-speos-file-v1-FileSystemItemInformation) | | Information about the FileSystemItem created | +| upload_duration | [google.protobuf.Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration) | | | + + + + + + + + + +### FileTransferService + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Reserve | [Reserve_Request](#ansys-api-speos-file-v1-Reserve_Request) | [Reserve_Response](#ansys-api-speos-file-v1-Reserve_Response) | Reserve a FileSystemItem | +| Upload | [Chunk](#ansys-api-speos-file-v1-Chunk) stream | [Upload_Response](#ansys-api-speos-file-v1-Upload_Response) | Upload a file Mandatory Client's Metadata: key: "file-size" - value: size of the file in bytes Optional Client's Metadata: key: "reserved-file-uri" - value: FileSystemItem reserved uri | +| Download | [Download_Request](#ansys-api-speos-file-v1-Download_Request) | [Chunk](#ansys-api-speos-file-v1-Chunk) stream | Download a FileSystemItem Server's' Initial Metadata: key: "file-size" - value: size of the file in bytes | +| Delete | [Delete_Request](#ansys-api-speos-file-v1-Delete_Request) | [Delete_Response](#ansys-api-speos-file-v1-Delete_Response) | Delete a FileSystemItem | +| AddDependencies | [AddDependencies_Request](#ansys-api-speos-file-v1-AddDependencies_Request) | [AddDependencies_Response](#ansys-api-speos-file-v1-AddDependencies_Response) | Add dependencies to a FileSystemItem | +| ListDependencies | [ListDependencies_Request](#ansys-api-speos-file-v1-ListDependencies_Request) | [ListDependencies_Response](#ansys-api-speos-file-v1-ListDependencies_Response) | List all dependencies of a FileSystemItem | + + + + + + +## intensity/v1/intensity.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Create_Request +Request to create a Intensity in IntensityTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| intensity_template | [IntensityTemplate](#ansys-api-speos-intensity-v1-IntensityTemplate) | | Intensity containing its basic characteristics | +| guid | [string](#string) | optional | Optional field to specify the guid used in the database. If not set, a unique guid will be generated for that entry and sent back in the Create_Response. | + + + +### Create_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Intensity created in IntensityTemplatesManager | + + + +### Delete_Request +Request to delete a Intensity in IntensityTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Intensity to be deleted | + + + +### Delete_Response + + + +### GetLibraryTypeInfo_Request +Request of GetLibraryTypeInfo + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the IntensityTemplate to get information about intensity file (example: flux). Only for IntensityTemplate of type Library. | + + + +### GetLibraryTypeInfo_Response +Response of GetLibraryTypeInfo + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| flux | [common.v1.DataDoubles](#ansys-api-speos-common-v1-DataDoubles) | | Flux of the intensity file | + + + +### IntensityTemplate +Intensity with its basic characteristics + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Intensity name | +| description | [string](#string) | | Intensity descrition | +| metadata | [IntensityTemplate.MetadataEntry](#ansys-api-speos-intensity-v1-IntensityTemplate-MetadataEntry) | repeated | User defined metadatas | +| library | [IntensityTemplate.Library](#ansys-api-speos-intensity-v1-IntensityTemplate-Library) | | From file | +| lambertian | [IntensityTemplate.Lambertian](#ansys-api-speos-intensity-v1-IntensityTemplate-Lambertian) | | Deprecated (use cos instead) - Lambertian distribution | +| cos | [IntensityTemplate.Cos](#ansys-api-speos-intensity-v1-IntensityTemplate-Cos) | | Lambert cosine law distribution | +| symmetric_gaussian | [IntensityTemplate.SymmetricGaussian](#ansys-api-speos-intensity-v1-IntensityTemplate-SymmetricGaussian) | | Deprecated (use gaussian instead) - Symmetric gaussian distribution | +| asymmetric_gaussian | [IntensityTemplate.AsymmetricGaussian](#ansys-api-speos-intensity-v1-IntensityTemplate-AsymmetricGaussian) | | Deprecated (use gaussian instead) - Asymmetric gaussian distribution | +| gaussian | [IntensityTemplate.Gaussian](#ansys-api-speos-intensity-v1-IntensityTemplate-Gaussian) | | Gaussian distribution | + + + +### IntensityTemplate.AsymmetricGaussian + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| FWHM_angle_x | [double](#double) | | Full Width in degrees following x at Half Maximum | +| FWHM_angle_y | [double](#double) | | Full Width in degrees following y at Half Maximum | +| total_angle | [double](#double) | | total angle in degrees of the emission of the light source | + + + +### IntensityTemplate.Cos + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| N | [double](#double) | | Order of cos law | +| total_angle | [double](#double) | | total angle in degrees of the emission of the light source | + + + +### IntensityTemplate.Gaussian + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| FWHM_angle_x | [double](#double) | | Full Width in degrees following x at Half Maximum | +| FWHM_angle_y | [double](#double) | | Full Width in degrees following y at Half Maximum | +| total_angle | [double](#double) | | total angle in degrees of the emission of the light source | + + + +### IntensityTemplate.Lambertian + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| total_angle | [double](#double) | | total angle in degrees of the emission of the light source | + + + +### IntensityTemplate.Library + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| intensity_file_uri | [string](#string) | | uri of the intensity file IES (.ies), Eulumdat (.ldt), speos intensities (.xmp) | + + + +### IntensityTemplate.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### IntensityTemplate.SymmetricGaussian + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| FWHM_angle | [double](#double) | | Full Width in degrees at Half Maximum | +| total_angle | [double](#double) | | total angle in degrees of the emission of the light source | + + + +### List_Request + + + +### List_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of the Intensities in IntensityTemplatesManager | + + + +### Read_Request +Request to read a Intensity in IntensityTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Intensity to be read | + + + +### Read_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| intensity_template | [IntensityTemplate](#ansys-api-speos-intensity-v1-IntensityTemplate) | | Intensity corresponding to the guid given in Read_Request | + + + +### Update_Request +Request to update a Intensity in IntensityTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Intensity to be updated | +| intensity_template | [IntensityTemplate](#ansys-api-speos-intensity-v1-IntensityTemplate) | | Intensity that will be used for the update | + + + +### Update_Response + + + + + + + + + +### IntensityTemplateActions +Actions available on a IntensityTemplate + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetLibraryTypeInfo | [GetLibraryTypeInfo_Request](#ansys-api-speos-intensity-v1-GetLibraryTypeInfo_Request) | [GetLibraryTypeInfo_Response](#ansys-api-speos-intensity-v1-GetLibraryTypeInfo_Response) | Get information about intensity library template | + + + +### IntensityTemplatesManager + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-intensity-v1-Create_Request) | [Create_Response](#ansys-api-speos-intensity-v1-Create_Response) | Create a Intensity | +| Read | [Read_Request](#ansys-api-speos-intensity-v1-Read_Request) | [Read_Response](#ansys-api-speos-intensity-v1-Read_Response) | Read a Intensity | +| Update | [Update_Request](#ansys-api-speos-intensity-v1-Update_Request) | [Update_Response](#ansys-api-speos-intensity-v1-Update_Response) | Update a Intensity | +| Delete | [Delete_Request](#ansys-api-speos-intensity-v1-Delete_Request) | [Delete_Response](#ansys-api-speos-intensity-v1-Delete_Response) | Delete a Intensity | +| List | [List_Request](#ansys-api-speos-intensity-v1-List_Request) | [List_Response](#ansys-api-speos-intensity-v1-List_Response) | List all Intensities in manager | + + + + + + +## intensity_distributions/v1/base_map_template.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### LayerData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| layer_name | [string](#string) | | | +| initial_source_power | [double](#double) | | | +| initial_source_power_watt | [double](#double) | | | +| initial_source_power_lumen | [double](#double) | | | +| wavelength | [double](#double) | repeated | | +| value | [double](#double) | repeated | | + + + +### Map + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x_nb | [int32](#int32) | | number of x samples | +| y_nb | [int32](#int32) | | number of y samples | +| layer_nb | [int32](#int32) | | number of layers | +| x_min | [double](#double) | | | +| x_max | [double](#double) | | | +| y_min | [double](#double) | | | +| y_max | [double](#double) | | | +| precision | [double](#double) | | | +| value_type | [ValueTypes](#ansys-api-speos-intensity_distributions-v1-xmp-ValueTypes) | | | +| intensity_type | [IntensityTypes](#ansys-api-speos-intensity_distributions-v1-xmp-IntensityTypes) | | | +| unit_type | [UnitTypes](#ansys-api-speos-intensity_distributions-v1-xmp-UnitTypes) | | | +| colorimetric_standard | [CIEStandard](#ansys-api-speos-intensity_distributions-v1-xmp-CIEStandard) | | | +| coordinate_unit | [CoordinateUnits](#ansys-api-speos-intensity_distributions-v1-xmp-CoordinateUnits) | | | +| map_type | [MapTypes](#ansys-api-speos-intensity_distributions-v1-xmp-MapTypes) | | | +| layer_type | [LayerTypes](#ansys-api-speos-intensity_distributions-v1-xmp-LayerTypes) | | | +| layer | [LayerData](#ansys-api-speos-intensity_distributions-v1-xmp-LayerData) | repeated | | +| is_finite_distance | [bool](#bool) | | | +| finite_difference_sensor_radius | [double](#double) | | | +| detector_extent | [bool](#bool) | | | +| rad_angular_resolution_radius | [double](#double) | | | + + + + + +### CIEStandard + +| Name | Number | Description | +| ---- | ------ | ----------- | +| CIE_STANDARD_UNKNOWN | 0 | | +| CIE_STANDARD_1931 | 1 | | +| CIE_STANDARD_1964 | 2 | | + + + +### CoordinateUnits + +| Name | Number | Description | +| ---- | ------ | ----------- | +| OptisUnitDefault | 0 | | +| OptisUnitMillimetre | 1 | | +| OptisUnitDegree | 2 | | +| OptisUnitRadian | 3 | | +| OptisUnitFeet | 4 | | +| OptisUnitMicrometre | 5 | | +| OptisUnitNanometre | 6 | | +| OptisUnitMetre | 7 | | +| OptisUnitPercent | 8 | | +| OptisUnitdB | 9 | | +| OptisUnitInvertMillimetre | 10 | | +| OptisUnitNoUnit | 11 | | +| OptisUnitWave | 12 | | + + + +### IntensityTypes + +| Name | Number | Description | +| ---- | ------ | ----------- | +| OptisIntensityOptis | 0 | Unsupported | +| OptisIntensitySAETypeA | 1 | | +| OptisIntensitySAETypeB | 2 | | +| OptisIntensityConoscopic | 3 | | + + + +### LayerTypes + +| Name | Number | Description | +| ---- | ------ | ----------- | +| OptisMapLayerTypeNone | 0 | | +| OptisMapLayerTypeSource | 1 | | +| OptisMapLayerTypeSurface | 2 | | +| OptisMapLayerTypeError | 3 | Unsupported | +| OptisMapLayerTypeSequence | 4 | | +| OptisMapLayerTypePolarization | 5 | | +| OptisMapLayerTypeIncidenceAngle | 6 | | + + + +### MapTypes + +| Name | Number | Description | +| ---- | ------ | ----------- | +| OptisMapTypeBasic | 0 | Unsupported | +| OptisMapTypeLaser | 1 | Unsupported | +| OptisMapTypeSpectral | 2 | | +| OptisMapTypeExtended | 3 | | +| OptisMapTypeUnknown | 4 | | +| OptisMapTypeGainMatrix | 5 | | +| OptisMapTypeRays | 6 | | +| OptisMapTypeFTM | 7 | | +| OptisMapTypeOptisVR | 8 | | +| OptisMapType3D | 9 | | + + + +### UnitTypes + +| Name | Number | Description | +| ---- | ------ | ----------- | +| OptisUnitTypeRadiometric | 0 | | +| OptisUnitTypePhotometric | 1 | | +| OptisUnitTypeTemperature | 2 | | +| OptisUnitTypeUnknown | 3 | | +| OptisUnitTypeFTM | 4 | Unsupported | +| OptisUnitTypeDegree | 5 | | +| OptisUnitTypeInverseMeter | 6 | | +| OptisUnitTypeInverseSquareMeter | 7 | | +| OptisUnitTypePercent | 8 | | +| OptisUnitTypeDiopter | 9 | | +| OptisUnitTypeMeter | 10 | | +| OptisUnitTypeInverseSteradian | 11 | | + + + +### ValueTypes + +| Name | Number | Description | +| ---- | ------ | ----------- | +| OptisValueTypeIrradiance | 0 | | +| OptisValueTypeIntensity | 1 | | +| OptisValueTypeRadiance | 2 | | +| OptisValueTypeVisual | 3 | | +| OptisValueTypeSel | 4 | Unsupported | +| OptisValueTypeLaserPhase | 5 | Unsupported | +| OptisValueTypeLaserPhasePlane | 6 | Unsupported | +| OptisValueTypeDirectionalIrradiance | 7 | | +| OptisValueTypeGain | 8 | Unsupported | +| OptisValueTypeWaveFront | 9 | Unsupported | +| OptisValueTypeFTM | 10 | Unsupported | +| OptisValueTypeRP | 11 | Unsupported | +| OptisValueTypePowerDensity | 12 | | +| OptisValueTypePopulation | 13 | | +| OptisValueTypeTemperature | 14 | | +| OptisValueTypeAngle | 15 | | +| OptisValueTypeCurvature | 16 | | +| OptisValueTypeCurvatureProduct | 17 | | +| OptisValueTypePercentage | 18 | | +| OptisValueTypeUnknown | 19 | | +| OptisValueTypeRefractivePower | 20 | | +| OptisValueTypeFlyThrough | 21 | | +| OptisValueTypeColorimetricError | 22 | | +| OptisValueTypeConoscopicRadiance | 23 | | +| OptisValueTypeSNR | 24 | | +| OptisValueTypeSNRIntensity | 25 | | +| OptisValueTypeSNRDirectionalIrradiance | 26 | | +| OptisValueTypePrecision | 27 | | +| OptisValueTypePrecisionIntensity | 28 | | +| OptisValueTypePrecisionDirectionalIrradiance | 29 | | +| OptisValueTypeDistance | 30 | | +| OptisValueTypeEyeSensorRadiance | 31 | | +| OptisValueTypeSphericalProbabilityDensity | 32 | | +| OptisValueTypeRSE | 33 | | +| OptisValueTypeRSEIntensity | 34 | | +| OptisValueTypeExposure | 35 | | + + + + + + + + + + +## intensity_distributions/v1/eulumdat.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### EulumdatFileInformation + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| company_identification | [string](#string) | | | +| measurement_report_number | [string](#string) | | | +| luminaire_name | [string](#string) | | | +| luminaire_number | [string](#string) | | | +| file_name | [string](#string) | | | +| date | [string](#string) | | | + + + +### EulumdatIntensityData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| number_lamps | [int32](#int32) | | integer > 0 | +| type_lamps | [string](#string) | | | +| total_luminous_flux | [double](#double) | | double > 0 | +| color_temperature | [string](#string) | | | +| color_rendering_index | [string](#string) | | | +| wattage_including_ballast | [double](#double) | | | + + + +### EulumdatIntensityDistribution + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| description | [string](#string) | | | +| file_info | [EulumdatFileInformation](#ansys-api-speos-intensity_distributions-v1-eulumdat-EulumdatFileInformation) | | | +| type_indicator | [int32](#int32) | | | +| symmetry_indicator | [int32](#int32) | | | +| c_plane_number | [int32](#int32) | | | +| distance_c_planes | [double](#double) | | | +| g_angle_number | [int32](#int32) | | | +| distance_g_angle | [double](#double) | | | +| diameter_luminaire | [double](#double) | | (mm) | +| width_luminaire | [double](#double) | | (mm) | +| height_luminaire | [double](#double) | | (mm) | +| diameter_luminous_area | [double](#double) | | (mm) | +| width_luminous_area | [double](#double) | | (mm) | +| height_luminous_area_c0 | [double](#double) | | (mm) | +| height_luminous_area_c90 | [double](#double) | | (mm) | +| height_luminous_area_c180 | [double](#double) | | (mm) | +| height_luminous_area_c270 | [double](#double) | | (mm) | +| downward_flux_fraction | [double](#double) | | Percentage between 0% and 100% | +| light_ouput_ratio | [double](#double) | | Percentage between 0% and 100% | +| conversion_factor | [double](#double) | | | +| measurement_tilt | [double](#double) | | | +| number_standard_set_lamps | [int32](#int32) | | | +| lamp_distribution | [EulumdatIntensityData](#ansys-api-speos-intensity_distributions-v1-eulumdat-EulumdatIntensityData) | repeated | | +| direct_ratio | [double](#double) | repeated | | +| c_plane | [double](#double) | repeated | | +| g_angle | [double](#double) | repeated | | +| luminous_intensity_per_klm | [double](#double) | repeated | (cd/klm) | + + + +### Export_Request + + + +### Import_Response + + + +### Load_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_uri | [string](#string) | | | + + + +### Load_Response + + + +### Save_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_uri | [string](#string) | | | + + + +### Save_Response + + + + + + + + + +### EulumdatIntensityService +service to manage eulumdat file + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Load | [Load_Request](#ansys-api-speos-intensity_distributions-v1-eulumdat-Load_Request) | [Load_Response](#ansys-api-speos-intensity_distributions-v1-eulumdat-Load_Response) | Load CEulumdat from filename | +| Save | [Save_Request](#ansys-api-speos-intensity_distributions-v1-eulumdat-Save_Request) | [Save_Response](#ansys-api-speos-intensity_distributions-v1-eulumdat-Save_Response) | Save CEulumdat to filename | +| Import | [EulumdatIntensityDistribution](#ansys-api-speos-intensity_distributions-v1-eulumdat-EulumdatIntensityDistribution) | [Import_Response](#ansys-api-speos-intensity_distributions-v1-eulumdat-Import_Response) | import EulumdatIntensityDistribution to CEulumdat | +| Export | [Export_Request](#ansys-api-speos-intensity_distributions-v1-eulumdat-Export_Request) | [EulumdatIntensityDistribution](#ansys-api-speos-intensity_distributions-v1-eulumdat-EulumdatIntensityDistribution) | export CEulumdat to EulumdatIntensityDistribution | + + + + + + +## intensity_distributions/v1/extended_map_template.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### ExtendedMap + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| base_data | [Map](#ansys-api-speos-intensity_distributions-v1-xmp-Map) | | | +| value | [Values](#ansys-api-speos-intensity_distributions-v1-xmp-Values) | | | + + + +### Values + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| layer | [Values.Layers](#ansys-api-speos-intensity_distributions-v1-xmp-Values-Layers) | repeated | map layers | + + + +### Values.Layers + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| y | [Values.Layers.ys](#ansys-api-speos-intensity_distributions-v1-xmp-Values-Layers-ys) | repeated | y samples of the map | + + + +### Values.Layers.ys + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x | [double](#double) | repeated | x samples of the map | + + + + + + + + + + + + +## intensity_distributions/v1/ies.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Export_Request + + + +### IesIntensityDistribution + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| norme_version | [int32](#int32) | | | +| key_words | [string](#string) | repeated | | +| unit | [int32](#int32) | | feet or meters | +| nb_vertical_angle | [int32](#int32) | | | +| nb_horizontal_angle | [int32](#int32) | | | +| tilt_type | [int32](#int32) | | tilt_type set to 1 means None. | +| tilt_geometry | [int32](#int32) | | | +| nb_lamp | [int32](#int32) | | integer > 0 | +| photo_type | [int32](#int32) | | | +| lumen_lamp | [double](#double) | | | +| multiplier | [double](#double) | | | +| width | [double](#double) | | (feet) or (meters) according to 'int32' unit type. | +| length | [double](#double) | | (feet) | +| height | [double](#double) | | (feet) | +| ballast | [double](#double) | | float > 0 | +| future_use | [double](#double) | | float > 0 | +| input_watt | [double](#double) | | float > 0 | +| vertical_angle | [double](#double) | repeated | | +| horizontal_angle | [double](#double) | repeated | | +| candela_value | [double](#double) | repeated | | +| tilt_angle | [double](#double) | repeated | | +| tilt_mult_factor | [double](#double) | repeated | | +| local_vert | [double](#double) | | | +| tilt_nb_pair_angle | [int32](#int32) | | | + + + +### Import_Response + + + +### Load_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_uri | [string](#string) | | | + + + +### Load_Response + + + +### Save_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_uri | [string](#string) | | | + + + +### Save_Response + + + + + + + + + +### IesIntensityService +service to manage IES files + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Load | [Load_Request](#ansys-api-speos-intensity_distributions-v1-ies-Load_Request) | [Load_Response](#ansys-api-speos-intensity_distributions-v1-ies-Load_Response) | serialization for native files | +| Save | [Save_Request](#ansys-api-speos-intensity_distributions-v1-ies-Save_Request) | [Save_Response](#ansys-api-speos-intensity_distributions-v1-ies-Save_Response) | | +| Import | [IesIntensityDistribution](#ansys-api-speos-intensity_distributions-v1-ies-IesIntensityDistribution) | [Import_Response](#ansys-api-speos-intensity_distributions-v1-ies-Import_Response) | import export of IesIntensityDistribution to CIES | +| Export | [Export_Request](#ansys-api-speos-intensity_distributions-v1-ies-Export_Request) | [IesIntensityDistribution](#ansys-api-speos-intensity_distributions-v1-ies-IesIntensityDistribution) | | + + + + + + +## intensity_distributions/v1/spectral_map_template.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### ColorValues + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| layer | [ColorValues.Layers](#ansys-api-speos-intensity_distributions-v1-xmp-ColorValues-Layers) | repeated | map layers | + + + +### ColorValues.Layers + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| y | [ColorValues.Layers.ys](#ansys-api-speos-intensity_distributions-v1-xmp-ColorValues-Layers-ys) | repeated | y samples of the map | + + + +### ColorValues.Layers.ys + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x | [ColorValues.Layers.ys.xs](#ansys-api-speos-intensity_distributions-v1-xmp-ColorValues-Layers-ys-xs) | repeated | x samples of the map | + + + +### ColorValues.Layers.ys.xs + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| color_x | [float](#float) | | | +| color_y | [float](#float) | | | +| color_z | [float](#float) | | | +| radio | [float](#float) | | | + + + +### Depth + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| y | [Depth.ys](#ansys-api-speos-intensity_distributions-v1-xmp-Depth-ys) | repeated | y samples of the map | + + + +### Depth.ys + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x | [float](#float) | repeated | x samples of the map | + + + +### SpectralMap + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| base_data | [Map](#ansys-api-speos-intensity_distributions-v1-xmp-Map) | | | +| wavelength_nb | [int32](#int32) | | Integer >= 3 | +| wavelength_min | [double](#double) | | Range is between 100nm and 100000nm | +| wavelength_max | [double](#double) | | Range is between 100nm and 100000nm | +| spectral_value | [SpectralValues](#ansys-api-speos-intensity_distributions-v1-xmp-SpectralValues) | | spectral values | +| color_value | [ColorValues](#ansys-api-speos-intensity_distributions-v1-xmp-ColorValues) | | colorimetric and radiometric data | +| depth_value | [Depth](#ansys-api-speos-intensity_distributions-v1-xmp-Depth) | | | +| spectral_data_loaded | [bool](#bool) | | spectral data is not always loaded unless explicitly specified | +| depth_data_loaded | [bool](#bool) | | depth data not always filled out | + + + +### SpectralValues + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| layer | [SpectralValues.Layers](#ansys-api-speos-intensity_distributions-v1-xmp-SpectralValues-Layers) | repeated | map layers | + + + +### SpectralValues.Layers + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wavelength | [SpectralValues.Layers.Wavelengths](#ansys-api-speos-intensity_distributions-v1-xmp-SpectralValues-Layers-Wavelengths) | repeated | wavelength | + + + +### SpectralValues.Layers.Wavelengths + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| y | [SpectralValues.Layers.Wavelengths.ys](#ansys-api-speos-intensity_distributions-v1-xmp-SpectralValues-Layers-Wavelengths-ys) | repeated | y samples of the map | + + + +### SpectralValues.Layers.Wavelengths.ys + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x | [float](#float) | repeated | x samples of the map | + + + + + + + + + + + + +## intensity_distributions/v1/xmp.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Export_Request + + + +### Import_Response + + + +### Load_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_uri | [string](#string) | | | + + + +### Load_Response + + + +### Save_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_uri | [string](#string) | | | + + + +### Save_Response + + + +### XmpDistribution +xmp map definition + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| extended_map | [ExtendedMap](#ansys-api-speos-intensity_distributions-v1-xmp-ExtendedMap) | | | +| spectral_map | [SpectralMap](#ansys-api-speos-intensity_distributions-v1-xmp-SpectralMap) | | | + + + + + + + + + +### XmpIntensityService +service to manage XMP files + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Load | [Load_Request](#ansys-api-speos-intensity_distributions-v1-xmp-Load_Request) | [Load_Response](#ansys-api-speos-intensity_distributions-v1-xmp-Load_Response) | Load XMP intensity distributions from file | +| Save | [Save_Request](#ansys-api-speos-intensity_distributions-v1-xmp-Save_Request) | [Save_Response](#ansys-api-speos-intensity_distributions-v1-xmp-Save_Response) | Save XMP intensity distributions to file | +| Import | [XmpDistribution](#ansys-api-speos-intensity_distributions-v1-xmp-XmpDistribution) | [Import_Response](#ansys-api-speos-intensity_distributions-v1-xmp-Import_Response) | import XmpDistribution to COptisMap | +| Export | [Export_Request](#ansys-api-speos-intensity_distributions-v1-xmp-Export_Request) | [XmpDistribution](#ansys-api-speos-intensity_distributions-v1-xmp-XmpDistribution) | export COPtisMap to XmpDistribution | + + + + + + +## job/v2/job.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Create_Request +Request to create a Job in JobsManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| job | [Job](#ansys-api-speos-job-v2-Job) | | Job characteristics | +| guid | [string](#string) | optional | Optional field to specify the guid used in the database. If not set, a unique guid will be generated for that entry and sent back in the Create_Response. | + + + +### Create_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job created in JobsManager | + + + +### Delete_Request +Request to delete a Job in JobsManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job to be deleted | + + + +### Delete_Response + + + +### GetError_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job in JobsManager. | + + + +### GetError_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| category | [string](#string) | | | +| severity | [int32](#int32) | | | +| request | [string](#string) | | | +| diagnostic | [string](#string) | | | +| advice | [string](#string) | | | +| error_file | [string](#string) | | | +| error_line | [int32](#int32) | | | + + + +### GetInformation_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job in JobsManager. | + + + +### GetInformation_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| title | [string](#string) | | | +| name | [string](#string) | | | +| infos | [string](#string) | | | +| progress | [double](#double) | | value between 0.0 and 1.0 | +| elapsed_time | [google.protobuf.Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration) | | | +| remaining_time | [google.protobuf.Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration) | | | +| process_unit_models | [string](#string) | repeated | Depending on the Job::Type, list of the CPU or GPU models | +| rays_number | [uint64](#uint64) | | Number of rays emitted since the (re)start of the simulation | +| rays_number_per_second | [uint64](#uint64) | | Number of rays emitted in the last second | + + + +### GetProgressStatus_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job in JobsManager. | + + + +### GetProgressStatus_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| title | [string](#string) | | | +| name | [string](#string) | | | +| infos | [string](#string) | | | +| progress | [double](#double) | | value between 0.0 and 1.0 | +| elapsed_time | [google.protobuf.Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration) | | | +| remaining_time | [google.protobuf.Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration) | | | +| process_unit_models | [string](#string) | repeated | Depending on the Job::Type, list of the CPU or GPU models | +| rays_number | [uint64](#uint64) | | Number of rays emitted since the (re)start of the simulation | +| rays_number_per_second | [uint64](#uint64) | | Number of rays emitted in the last second | + + + +### GetRayPaths_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job in JobsManager. | +| raw_data | [bool](#bool) | optional | Boolean to get the wavelengths in response stream | +| display_data | [bool](#bool) | optional | Boolean to get the colors (RGB24 format) in response stream | + + + +### GetResults_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job in JobsManager. | + + + +### GetResults_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| results | [Result](#ansys-api-speos-job-v2-Result) | repeated | List of the Job results | + + + +### GetState_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job in JobsManager. | + + + +### GetState_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| state | [Job.State](#ansys-api-speos-job-v2-Job-State) | | | + + + +### Job + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Job name | +| description | [string](#string) | | Job descrition | +| metadata | [Job.MetadataEntry](#ansys-api-speos-job-v2-Job-MetadataEntry) | repeated | User defined metadatas | +| scene_guid | [string](#string) | | Guid of the Scene in ScenesManager | +| simulation_path | [string](#string) | | Simulation path in the scene that will be used by the job | +| job_type | [Job.Type](#ansys-api-speos-job-v2-Job-Type) | | Type of the job : CPU, GPU | +| direct_mc_simulation_properties | [Job.DirectMCSimulationProperties](#ansys-api-speos-job-v2-Job-DirectMCSimulationProperties) | | Properties to be filled for simulation based on DirectMCSimulationTemplate | +| inverse_mc_simulation_properties | [Job.InverseMCSimulationProperties](#ansys-api-speos-job-v2-Job-InverseMCSimulationProperties) | | Properties to be filled for simulation based on InverseMCSimulationTemplate | +| interactive_simulation_properties | [Job.InteractiveSimulationProperties](#ansys-api-speos-job-v2-Job-InteractiveSimulationProperties) | | Properties to be filled for simulation based on Interactive | +| virtualbsdfbench_simulation_properties | [Job.VirtualBSDFBenchSimulationProperties](#ansys-api-speos-job-v2-Job-VirtualBSDFBenchSimulationProperties) | | Properties to be filled for simulation based on VirtualBSDFBench | + + + +### Job.DirectMCSimulationProperties +If several stop conditions are set, the first condition reached ends the simulation. +If no stop condition is set, the simulation ends when you stop the process. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| stop_condition_rays_number | [int64](#int64) | optional | To stop the simulation after a certain number of rays were sent | +| stop_condition_duration | [int64](#int64) | optional | To stop the simulation after a certain duration | +| automatic_save_frequency | [int32](#int32) | | Define a backup interval (s). This option is useful when computing long simulations. Note: A reduced number of save operations naturally increases the simulation performance. 0 disables intermediary backup saves. | + + + +### Job.InteractiveSimulationProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| rays_number_per_sources | [Job.InteractiveSimulationProperties.RaysNumberPerSource](#ansys-api-speos-job-v2-Job-InteractiveSimulationProperties-RaysNumberPerSource) | repeated | If a source present in Scene::SimulationInstance is not mentioned here, its rays_nb is defaulted to 100. | +| light_expert | [bool](#bool) | | To generate a light expert file. | +| impact_report | [bool](#bool) | | To integrate details like number of impacts, position and surface state to the HTML simulation report. | + + + +### Job.InteractiveSimulationProperties.RaysNumberPerSource + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| source_path | [string](#string) | | Path to the source. Hint: same path that was given in Scene::SimulationInstance | +| rays_nb | [uint32](#uint32) | optional | Number of rays sent by the source referenced via its source_path. Default 100 | + + + +### Job.InverseMCSimulationProperties +If several stop conditions are set, the first condition reached ends the simulation. +If no stop condition is set, the simulation ends when you stop the process. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| optimized_propagation_none | [Job.InverseMCSimulationProperties.OptimizedPropagationNone](#ansys-api-speos-job-v2-Job-InverseMCSimulationProperties-OptimizedPropagationNone) | | No optimization. Do not forget to fill stop conditions if needed. | +| optimized_propagation_relative | [Job.InverseMCSimulationProperties.OptimizedPropagationRelative](#ansys-api-speos-job-v2-Job-InverseMCSimulationProperties-OptimizedPropagationRelative) | | | +| optimized_propagation_absolute | [Job.InverseMCSimulationProperties.OptimizedPropagationAbsolute](#ansys-api-speos-job-v2-Job-InverseMCSimulationProperties-OptimizedPropagationAbsolute) | | | +| stop_condition_duration | [int64](#int64) | optional | To stop the simulation after a certain duration | +| automatic_save_frequency | [int32](#int32) | | Define a backup interval (s). This option is useful when computing long simulations. Note: A reduced number of save operations naturally increases the simulation performance. 0 disables intermediary backup saves. | +| timeline | [Job.Timeline](#ansys-api-speos-job-v2-Job-Timeline) | | Timeline activation. This parameter is linked to trajectory_file_uri of scene's CameraProperties, flux_variation_file_uri of SourceTemplate (type Surface), and trajectory_file_uri of Scene's SceneInstance. | + + + +### Job.InverseMCSimulationProperties.OptimizedPropagationAbsolute +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 SNR is adequate in areas where pixels need more rays, thus giving a balanced image. +The Optimized propagation algorithm is only compatible with the Radiance sensors. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| min_pass_number | [uint32](#uint32) | | Minimum number of passes without pass optimization. | +| stop_condition_absolute_value | [uint32](#uint32) | | Absolute photometric value of pixel standard deviation threshold | + + + +### Job.InverseMCSimulationProperties.OptimizedPropagationNone +No optimization : the same number of passes is used for each pixel of the image + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| stop_condition_passes_number | [uint32](#uint32) | optional | To stop the simulation after a certain number of passes | + + + +### Job.InverseMCSimulationProperties.OptimizedPropagationRelative +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 SNR is adequate in areas where pixels need more rays, thus giving a balanced image. +The Optimized propagation algorithm is only compatible with the Radiance sensors. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| min_pass_number | [uint32](#uint32) | | Minimum number of passes without pass optimization. | +| stop_condition_relative_value | [uint32](#uint32) | | Relative pixel standard deviation threshold, in percent. Value expected from 0 to 100. | + + + +### Job.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Job.Timeline +If timeline is applied to the job, fill Timeline message. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| start_time | [double](#double) | | Define the start time (s). | + + + +### Job.VirtualBSDFBenchSimulationProperties +If no stop condition is set, the simulation ends when you stop the process. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| stop_condition_rays_number | [int64](#int64) | | Number of rays sent per configuration, meaning number of rays per angle incident (and wavelength in iridescence case) | + + + +### List_Request + + + +### List_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of the Jobs in JobsManager | + + + +### Read_Request +Request to read a Job in JobsManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job to be read | + + + +### Read_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| job | [Job](#ansys-api-speos-job-v2-Job) | | Job corresponding to the guid given in Read_Request | + + + +### Result + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| path | [string](#string) | | Result path on the server | +| upload_response | [file.v1.Upload_Response](#ansys-api-speos-file-v1-Upload_Response) | | Result uploaded to server's file system (via FileTransferService) -> returns Upload_Response | + + + +### SaveFile_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job in JobsManager. | +| file_uri | [string](#string) | | URI of the *.speos file to save. (Local path or guid from FileTransferService). | + + + +### SaveFile_Response + + + +### Start_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job in JobsManager. | + + + +### Start_Response + + + +### Stop_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job in JobsManager. | + + + +### Stop_Response + + + +### Update_Request +Request to update a Job in JobsManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Job to be updated | +| job | [Job](#ansys-api-speos-job-v2-Job) | | Job that will be used for the update | + + + +### Update_Response + + + + + +### Job.State + +| Name | Number | Description | +| ---- | ------ | ----------- | +| QUEUED | 0 | | +| RUNNING | 1 | | +| PAUSED | 2 | | +| STOPPED | 3 | | +| FINISHED | 4 | | +| IN_ERROR | 5 | | + + + +### Job.Type + +| Name | Number | Description | +| ---- | ------ | ----------- | +| CPU | 0 | | +| GPU | 1 | | + + + + + + + +### JobActions +Service to handle a job + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetState | [GetState_Request](#ansys-api-speos-job-v2-GetState_Request) | [GetState_Response](#ansys-api-speos-job-v2-GetState_Response) | Get the state of a Job | +| Start | [Start_Request](#ansys-api-speos-job-v2-Start_Request) | [Start_Response](#ansys-api-speos-job-v2-Start_Response) | Start a Job | +| Stop | [Stop_Request](#ansys-api-speos-job-v2-Stop_Request) | [Stop_Response](#ansys-api-speos-job-v2-Stop_Response) | Stop a Job | +| GetError | [GetError_Request](#ansys-api-speos-job-v2-GetError_Request) | [GetError_Response](#ansys-api-speos-job-v2-GetError_Response) | Get error of a Job | +| GetResults | [GetResults_Request](#ansys-api-speos-job-v2-GetResults_Request) | [GetResults_Response](#ansys-api-speos-job-v2-GetResults_Response) | Get the results of a Job | +| GetInformation | [GetInformation_Request](#ansys-api-speos-job-v2-GetInformation_Request) | [GetInformation_Response](#ansys-api-speos-job-v2-GetInformation_Response) | Get Information about a Job | +| GetRayPaths | [GetRayPaths_Request](#ansys-api-speos-job-v2-GetRayPaths_Request) | [results.v1.RayPath](#ansys-api-speos-results-v1-RayPath) stream | Get RayPaths generated by a Job based on an interactive simulation | +| GetProgressStatus | [GetProgressStatus_Request](#ansys-api-speos-job-v2-GetProgressStatus_Request) | [GetProgressStatus_Response](#ansys-api-speos-job-v2-GetProgressStatus_Response) | Get progress status about a Job | +| SaveFile | [SaveFile_Request](#ansys-api-speos-job-v2-SaveFile_Request) | [SaveFile_Response](#ansys-api-speos-job-v2-SaveFile_Response) | Save a Job into .speos file | + + + +### JobsManager + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-job-v2-Create_Request) | [Create_Response](#ansys-api-speos-job-v2-Create_Response) | Create a Job | +| Read | [Read_Request](#ansys-api-speos-job-v2-Read_Request) | [Read_Response](#ansys-api-speos-job-v2-Read_Response) | Read a Job | +| Update | [Update_Request](#ansys-api-speos-job-v2-Update_Request) | [Update_Response](#ansys-api-speos-job-v2-Update_Response) | Update a Job | +| Delete | [Delete_Request](#ansys-api-speos-job-v2-Delete_Request) | [Delete_Response](#ansys-api-speos-job-v2-Delete_Response) | Delete a Job | +| List | [List_Request](#ansys-api-speos-job-v2-List_Request) | [List_Response](#ansys-api-speos-job-v2-List_Response) | List all Jobs in manager | + + + + + + +## lpf/v2/lpf_file_reader.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### CloseLpfFileName_Request_Mono + + + +### CloseLpfFileName_Request_Multi + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| lpf_reader_guid | [string](#string) | | | + + + +### CloseLpfFileName_Response + + + +### ComputeUniqueFaceId_Request_Mono + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| body_context_id | [uint32](#uint32) | | | +| face_id | [uint32](#uint32) | | | + + + +### ComputeUniqueFaceId_Request_Multi + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| lpf_reader_guid | [string](#string) | | | +| body_context_id | [uint32](#uint32) | | | +| face_id | [uint32](#uint32) | | | + + + +### ComputeUniqueFaceId_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| unique_face_id | [uint32](#uint32) | | | + + + +### Create_Request_Multi + + + +### Create_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| lpf_reader_guid | [string](#string) | | | + + + +### Delete_Request_Multi + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| lpf_reader_guid | [string](#string) | | | + + + +### Delete_Response + + + +### DoubletDouble + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x | [double](#double) | | | +| y | [double](#double) | | | + + + +### GetInformation_Request_Mono + + + +### GetInformation_Request_Multi + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| lpf_reader_guid | [string](#string) | | | + + + +### GetInformation_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| nb_of_traces | [int64](#int64) | | | +| nb_of_xmps | [uint32](#uint32) | | | +| has_sensor_contributions | [bool](#bool) | | | +| sensor_names | [string](#string) | repeated | The sensor position in the repeated field sensor_names gives the sensor_id | + + + +### InitLpfFileName_Request_Mono + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| lpf_file_uri | [string](#string) | | This can be uri returned by the server when uploading the file, or a local path (in this case the file has to be accessible by the server) | + + + +### InitLpfFileName_Request_Multi + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| lpf_reader_guid | [string](#string) | | | +| lpf_file_uri | [string](#string) | | This can be uri returned by the server when uploading the file, or a local path (in this case the file has to be accessible by the server) | + + + +### InitLpfFileName_Response + + + +### RayPath + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| impacts | [TripletFloat](#ansys-api-speos-lpf-v2-TripletFloat) | repeated | | +| wavelengths | [double](#double) | repeated | | +| body_context_ids | [uint32](#uint32) | repeated | | +| unique_face_ids | [uint32](#uint32) | repeated | | +| interaction_statuses | [RayPath.PhotonStatus](#ansys-api-speos-lpf-v2-RayPath-PhotonStatus) | repeated | | +| lastDirection | [TripletFloat](#ansys-api-speos-lpf-v2-TripletFloat) | | | +| sensor_contributions | [RayPath.SensorContribution](#ansys-api-speos-lpf-v2-RayPath-SensorContribution) | repeated | | + + + +### RayPath.SensorContribution + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sensor_id | [uint32](#uint32) | | The sensor_id corresponds to the position of the sensor in the repeated field GetInformation_Response::sensor_names | +| coordinates | [DoubletDouble](#ansys-api-speos-lpf-v2-DoubletDouble) | | | + + + +### Read_Request_Mono + + + +### Read_Request_Multi + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| lpf_reader_guid | [string](#string) | | | + + + +### TripletFloat + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x | [float](#float) | | | +| y | [float](#float) | | | +| z | [float](#float) | | | + + + + + +### RayPath.PhotonStatus + +| Name | Number | Description | +| ---- | ------ | ----------- | +| StatusAbsorbed | 0 | | +| StatusSpecularTransmitted | 1 | | +| StatusGaussianTransmitted | 2 | | +| StatusLambertianTransmitted | 3 | | +| StatusVolumicDiffused | 4 | | +| StatusJustEmitted | 5 | | +| StatusDiracTransmitted | 6 | | +| StatusError | 7 | | +| StatusErrorVolumicBodyNotClosed | 8 | | +| StatusErrorVolumeConflict | 9 | | +| StatusError2DTangency | 10 | | +| StatusError2DIntersect3DWarning | 11 | | +| StatusErrorNonOpticalMaterial | 12 | | +| StatusErrorIntersection | 13 | | +| StatusErrorNonOpticalMaterialAtEmission | 14 | | +| StatusError3DTextureSupportTangency | 15 | | +| StatusLast | 16 | | +| StatusFirst | -7 | | +| StatusDiracReflected | -6 | | +| StatusReserved | -5 | | +| StatusGrinStep | -4 | | +| StatusLambertianReflected | -3 | | +| StatusGaussianReflected | -2 | | +| StatusSpecularReflected | -1 | | + + + + + + + +### LpfFileReader_Mono +service to read lpf file - server can handle one reading - call CloseLpfFileName then InitLpfFileName to start another reading. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| InitLpfFileName | [InitLpfFileName_Request_Mono](#ansys-api-speos-lpf-v2-InitLpfFileName_Request_Mono) | [InitLpfFileName_Response](#ansys-api-speos-lpf-v2-InitLpfFileName_Response) | Init the lpf file with its path - returns nothing | +| GetInformation | [GetInformation_Request_Mono](#ansys-api-speos-lpf-v2-GetInformation_Request_Mono) | [GetInformation_Response](#ansys-api-speos-lpf-v2-GetInformation_Response) | Get information about the lpf file, for example number of traces, number of xmps... | +| CloseLpfFileName | [CloseLpfFileName_Request_Mono](#ansys-api-speos-lpf-v2-CloseLpfFileName_Request_Mono) | [CloseLpfFileName_Response](#ansys-api-speos-lpf-v2-CloseLpfFileName_Response) | Close the lpf file - returns nothing | +| Read | [Read_Request_Mono](#ansys-api-speos-lpf-v2-Read_Request_Mono) | [RayPath](#ansys-api-speos-lpf-v2-RayPath) stream | Read lpf file and get all the ray paths | +| ComputeUniqueFaceId | [ComputeUniqueFaceId_Request_Mono](#ansys-api-speos-lpf-v2-ComputeUniqueFaceId_Request_Mono) | [ComputeUniqueFaceId_Response](#ansys-api-speos-lpf-v2-ComputeUniqueFaceId_Response) | Compute a unique face id from bodyContextId and faceId | + + + +### LpfFileReader_Multi +service to read lpf file - server can handle several reading. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request_Multi](#ansys-api-speos-lpf-v2-Create_Request_Multi) | [Create_Response](#ansys-api-speos-lpf-v2-Create_Response) | Create a lpf file reader - returns its guid | +| InitLpfFileName | [InitLpfFileName_Request_Multi](#ansys-api-speos-lpf-v2-InitLpfFileName_Request_Multi) | [InitLpfFileName_Response](#ansys-api-speos-lpf-v2-InitLpfFileName_Response) | Init the lpf file with its path - returns nothing | +| GetInformation | [GetInformation_Request_Multi](#ansys-api-speos-lpf-v2-GetInformation_Request_Multi) | [GetInformation_Response](#ansys-api-speos-lpf-v2-GetInformation_Response) | Get information about the lpf file, for example number of traces, number of xmps... | +| CloseLpfFileName | [CloseLpfFileName_Request_Multi](#ansys-api-speos-lpf-v2-CloseLpfFileName_Request_Multi) | [CloseLpfFileName_Response](#ansys-api-speos-lpf-v2-CloseLpfFileName_Response) | Close the lpf file - returns nothing | +| Read | [Read_Request_Multi](#ansys-api-speos-lpf-v2-Read_Request_Multi) | [RayPath](#ansys-api-speos-lpf-v2-RayPath) stream | Read lpf file and get all the ray paths | +| ComputeUniqueFaceId | [ComputeUniqueFaceId_Request_Multi](#ansys-api-speos-lpf-v2-ComputeUniqueFaceId_Request_Multi) | [ComputeUniqueFaceId_Response](#ansys-api-speos-lpf-v2-ComputeUniqueFaceId_Response) | Compute a unique face id from bodyContextId and faceId | +| Delete | [Delete_Request_Multi](#ansys-api-speos-lpf-v2-Delete_Request_Multi) | [Delete_Response](#ansys-api-speos-lpf-v2-Delete_Response) | Delete a lpf file reader - returns nothing | + + + + + + +## part/v1/body.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Body +Body definition made of faces + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Unique identifier in its Part | +| display_name | [string](#string) | | User name to be displayed | +| description | [string](#string) | | | +| metadata | [Body.MetadataEntry](#ansys-api-speos-body-v1-Body-MetadataEntry) | repeated | User defined metadata | +| face_guids | [string](#string) | repeated | List of faces constituting the body | + + + +### Body.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Create_Request +Request to create a body + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| body | [Body](#ansys-api-speos-body-v1-Body) | | body to create | +| guid | [string](#string) | optional | Optional field to specify the guid used in the database. If not set, a unique guid will be generated for that entry and sent back in the Create_Response. | + + + +### Create_Response +Response to create a body + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the created body | + + + +### Delete_Request +Request to delete a body + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the body to be deleted | + + + +### Delete_Response +Response to delete a body + + + +### List_Request +Request to list all bodies + + + +### List_Response +Response to list all bodies + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of all bodies | + + + +### ReadAll_Request +Request to read all bodies + + + +### ReadAll_Response +Response to read all bodies + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| bodies | [ReadAll_Response.BodiesEntry](#ansys-api-speos-body-v1-ReadAll_Response-BodiesEntry) | repeated | Read bodies with their Guids | + + + +### ReadAll_Response.BodiesEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [Body](#ansys-api-speos-body-v1-Body) | | | + + + +### Read_Request +Request to read a body + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the body to be read | + + + +### Read_Response +Response to read a body + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| body | [Body](#ansys-api-speos-body-v1-Body) | | body corresponding to the guid given in Read_Request | + + + +### Update_Request +Request to update a body + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the body to be updated | +| body | [Body](#ansys-api-speos-body-v1-Body) | | New body that will be used for the update | + + + +### Update_Response +Response to update a body + + + + + + + + + +### BodiesManager + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-body-v1-Create_Request) | [Create_Response](#ansys-api-speos-body-v1-Create_Response) | Create a new body | +| Read | [Read_Request](#ansys-api-speos-body-v1-Read_Request) | [Read_Response](#ansys-api-speos-body-v1-Read_Response) | Read a body | +| Update | [Update_Request](#ansys-api-speos-body-v1-Update_Request) | [Update_Response](#ansys-api-speos-body-v1-Update_Response) | Update a body | +| Delete | [Delete_Request](#ansys-api-speos-body-v1-Delete_Request) | [Delete_Response](#ansys-api-speos-body-v1-Delete_Response) | Delete a body | +| List | [List_Request](#ansys-api-speos-body-v1-List_Request) | [List_Response](#ansys-api-speos-body-v1-List_Response) | List all bodies in manager | +| ReadAll | [ReadAll_Request](#ansys-api-speos-body-v1-ReadAll_Request) | [ReadAll_Response](#ansys-api-speos-body-v1-ReadAll_Response) | Read the whole database, use a field mask in message grpc request metadata (key = read_masks) to only get needed fields. i.e.: bodies.*.name -> would only return the names of the bodies in the message | + + + +### BodyActions +Actions available on a body + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| + + + + + + +## part/v1/face.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Chunk +Chunk of a Face + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| face_header | [Chunk.FaceHeader](#ansys-api-speos-face-v1-Chunk-FaceHeader) | | Common face data - Field used only in first Chunk (to take advantage of vectors sizes) - If several faces are uploaded/downloaded, then this message determines the start of a new face streaming. | +| vertices | [Chunk.Vertices](#ansys-api-speos-face-v1-Chunk-Vertices) | | coordinates of all points (p1x p1y p1z p2x p2y p2z ...) | +| facets | [Chunk.Facets](#ansys-api-speos-face-v1-Chunk-Facets) | | indexes of points for all triangles (t1_1 t1_2 t1_3 t2_1 t2_2 t2_3 ...) | +| normals | [Chunk.Normals](#ansys-api-speos-face-v1-Chunk-Normals) | | normal vector for all points (n1x n1y n1z n2x n2y n2z ...) | +| vertices_data | [Chunk.VerticesData](#ansys-api-speos-face-v1-Chunk-VerticesData) | | List of data applied to vertices (like texture coordinates uv) | +| facets_data | [Chunk.FacetsData](#ansys-api-speos-face-v1-Chunk-FacetsData) | | List of data applied to facets (like temperature) | + + + +### Chunk.FaceHeader + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of a FacesManager element - Used for FaceActions.Upload rpc | +| name | [string](#string) | | | +| display_name | [string](#string) | | | +| description | [string](#string) | | | +| metadata | [Chunk.FaceHeader.MetadataEntry](#ansys-api-speos-face-v1-Chunk-FaceHeader-MetadataEntry) | repeated | | +| sizes | [int32](#int32) | repeated | vectors sizes in Face: (vertices_normals_size, facets_size, vertices_data_size, facets_data_size) - vertices and normals vectors have same size, therefore they are grouped in vertices_normals_size | + + + +### Chunk.FaceHeader.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Chunk.Facets + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [uint32](#uint32) | repeated | | + + + +### Chunk.FacetsData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_layer | [bool](#bool) | | Boolean to express a new layer (MeshData) for facets_data. | +| name | [string](#string) | | Identifier name (uv, temperature...) | +| size | [int32](#int32) | | Total size for vector in MeshData: data_size | +| data | [float](#float) | repeated | Raw data for each facet | + + + +### Chunk.Normals + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [float](#float) | repeated | | + + + +### Chunk.Vertices + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [float](#float) | repeated | | + + + +### Chunk.VerticesData + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| new_layer | [bool](#bool) | | Boolean to express a new layer (MeshData) for vertices_data. | +| name | [string](#string) | | Identifier name (uv, temperature...) | +| size | [int32](#int32) | | Total size for vector in MeshData: data_size | +| data | [float](#float) | repeated | Raw data for each vertice | + + + +### Create_Request +Request to create a face + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| face | [Face](#ansys-api-speos-face-v1-Face) | | face to create | +| guid | [string](#string) | optional | Optional field to specify the guid used in the database. If not set, a unique guid will be generated for that entry and sent back in the Create_Response. | + + + +### Create_Response +Response to create a face + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the created face | + + + +### Delete_Request +Request to delete a face + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the face to be deleted | + + + +### Delete_Response +Response to delete a face + + + +### Download_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of a FacesManager element | +| guids | [string](#string) | repeated | Guids of FacesManager elements to download. | +| only_face_header | [bool](#bool) | optional | If this optional boolean is set to true, only the FaceHeader will be returned in answer stream. | + + + +### Face +Face definition with meshing information + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Unique identifier in its Body | +| display_name | [string](#string) | | User name to be displayed | +| description | [string](#string) | | | +| metadata | [Face.MetadataEntry](#ansys-api-speos-face-v1-Face-MetadataEntry) | repeated | user defined metadata | +| vertices | [float](#float) | repeated | coordinates of all points (p1x p1y p1z p2x p2y p2z ...) | +| facets | [uint32](#uint32) | repeated | indexes of points for all triangles (t1_1 t1_2 t1_3 t2_1 t2_2 t2_3 ...) | +| normals | [float](#float) | repeated | normal vector for all points (n1x n1y n1z n2x n2y n2z ...) | +| vertices_data | [Face.MeshData](#ansys-api-speos-face-v1-Face-MeshData) | repeated | List of data applied to vertices (like texture coordinates uv) | +| facets_data | [Face.MeshData](#ansys-api-speos-face-v1-Face-MeshData) | repeated | List of data applied to facets (like temperature) | + + + +### Face.MeshData +Store named data on meshed + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Identifier name (uv, temperature...) | +| data | [float](#float) | repeated | Raw data for each mesh | + + + +### Face.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### List_Request +Request to list all faces + + + +### List_Response +Response to list all faces + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of all faces | + + + +### Read_Request +Request to read a face + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the face to be read | + + + +### Read_Response +Response to read a face + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| face | [Face](#ansys-api-speos-face-v1-Face) | | face corresponding to the guid given in Read_Request | + + + +### ReserveFace_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| faces | [Face](#ansys-api-speos-face-v1-Face) | repeated | repeated face headers | + + + +### ReserveFace_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | guids of the created faces, in the order sent | + + + +### Update_Request +Request to update a face + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the face to be updated | +| face | [Face](#ansys-api-speos-face-v1-Face) | | New face that will be used for the update | + + + +### Update_Response +Response to update a face + + + +### Upload_Response + + + + + + + + + +### FaceActions +Actions available on a face + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| ReserveFaces | [ReserveFace_Request](#ansys-api-speos-face-v1-ReserveFace_Request) stream | [ReserveFace_Response](#ansys-api-speos-face-v1-ReserveFace_Response) stream | allocate faces before uploading them. to have maximum benefit, only the name, description and metadata should be filled | +| Upload | [Chunk](#ansys-api-speos-face-v1-Chunk) stream | [Upload_Response](#ansys-api-speos-face-v1-Upload_Response) | Update a face via streaming | +| Download | [Download_Request](#ansys-api-speos-face-v1-Download_Request) | [Chunk](#ansys-api-speos-face-v1-Chunk) stream | Read a face via streaming | + + + +### FacesManager + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-face-v1-Create_Request) | [Create_Response](#ansys-api-speos-face-v1-Create_Response) | Create a new face | +| Read | [Read_Request](#ansys-api-speos-face-v1-Read_Request) | [Read_Response](#ansys-api-speos-face-v1-Read_Response) | Read a face | +| Update | [Update_Request](#ansys-api-speos-face-v1-Update_Request) | [Update_Response](#ansys-api-speos-face-v1-Update_Response) | Update a face | +| Delete | [Delete_Request](#ansys-api-speos-face-v1-Delete_Request) | [Delete_Response](#ansys-api-speos-face-v1-Delete_Response) | Delete a face | +| List | [List_Request](#ansys-api-speos-face-v1-List_Request) | [List_Response](#ansys-api-speos-face-v1-List_Response) | List all faces in manager | + + + + + + +## part/v1/part.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Create_Request +Request to create an element + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| part | [Part](#ansys-api-speos-part-v1-Part) | | Element to create | +| guid | [string](#string) | optional | Optional field to specify the guid used in the database. If not set, a unique guid will be generated for that entry and sent back in the Create_Response. | + + + +### Create_Response +Response to create an element + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the created element | + + + +### Delete_Request +Request to delete an element + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the element to be deleted | + + + +### Delete_Response +Response to delete an element + + + +### List_Request +Request to list all elements + + + +### List_Response +Response to list all elements + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of all Parts | + + + +### Part +Part definition, a Part is related to a CAD part file (scdocx, prt, ...) made of meshed bodies and faces + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| description | [string](#string) | | | +| metadata | [Part.MetadataEntry](#ansys-api-speos-part-v1-Part-MetadataEntry) | repeated | User defined metadata | +| body_guids | [string](#string) | repeated | List of bodies constituting the part | +| parts | [Part.PartInstance](#ansys-api-speos-part-v1-Part-PartInstance) | repeated | List of sub parts | + + + +### Part.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Part.PartInstance +Instance of Part in parent coordinates system + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Unique identifier in its Part | +| display_name | [string](#string) | | User name to be displayed | +| description | [string](#string) | | | +| metadata | [Part.PartInstance.MetadataEntry](#ansys-api-speos-part-v1-Part-PartInstance-MetadataEntry) | repeated | User defined metadata | +| part_guid | [string](#string) | | Guid of Part in PartsManager | +| axis_system | [double](#double) | repeated | Part position relative to parent reference (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | + + + +### Part.PartInstance.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### ReadAll_Request +Request to read all parts + + + +### ReadAll_Response +Response to read all parts + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| parts | [ReadAll_Response.PartsEntry](#ansys-api-speos-part-v1-ReadAll_Response-PartsEntry) | repeated | Read parts with their Guids | + + + +### ReadAll_Response.PartsEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [Part](#ansys-api-speos-part-v1-Part) | | | + + + +### Read_Request +Request to read an element + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the element to be read | + + + +### Read_Response +Response to read an element + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| part | [Part](#ansys-api-speos-part-v1-Part) | | Element corresponding to the guid given in Read_Request | + + + +### Update_Request +Request to update an element + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the PartTemplate to be updated | +| part | [Part](#ansys-api-speos-part-v1-Part) | | New element that will be used for the update | + + + +### Update_Response +Response to update an element + + + + + + + + + +### PartActions +Actions available on a Part + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| + + + +### PartsManager +Service to manage geometrical objects + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-part-v1-Create_Request) | [Create_Response](#ansys-api-speos-part-v1-Create_Response) | Create a new part | +| Read | [Read_Request](#ansys-api-speos-part-v1-Read_Request) | [Read_Response](#ansys-api-speos-part-v1-Read_Response) | Read a part | +| Update | [Update_Request](#ansys-api-speos-part-v1-Update_Request) | [Update_Response](#ansys-api-speos-part-v1-Update_Response) | Update a part | +| Delete | [Delete_Request](#ansys-api-speos-part-v1-Delete_Request) | [Delete_Response](#ansys-api-speos-part-v1-Delete_Response) | Delete a part | +| List | [List_Request](#ansys-api-speos-part-v1-List_Request) | [List_Response](#ansys-api-speos-part-v1-List_Response) | List all parts in manager | +| ReadAll | [ReadAll_Request](#ansys-api-speos-part-v1-ReadAll_Request) | [ReadAll_Response](#ansys-api-speos-part-v1-ReadAll_Response) | Read the whole database, use a field mask in message grpc request metadata (key = read_masks) to only get needed fields. i.e.: parts.*.name -> would only return the names of the bodies in the message | + + + + + + +## results/v1/map.proto + + + +### ExportXMPToImage_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| xmp_file_uri | [string](#string) | | Uri of the XMP file to export to PNG image. (Local path or guid from FileTransferService). | +| image_file_uri | [string](#string) | | Uri of the image exported. (Local path or guid from FileTransferService). If pointing to folder or empty filename reserved from FileTransferService, filename will be the one of the XMP file and the guid provided will point to the generated file. If extension is not PNG, ".png" will be added at the end of filename. | + + + +### ExportXMPToImage_Response + + + +### MergeSpeos360ToStereoSpeos360_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| map_left_to_merge_uri | [string](#string) | | Absolute path to left Speos360 file to merge. | +| map_right_to_merge_uri | [string](#string) | | Absolute path to right Speos360 file to merge. | +| map_merged_uri | [string](#string) | | Absolute path to merged stereoscopic Speos360 file. | + + + +### MergeSpeos360ToStereoSpeos360_Response + + + +### MergeXMPsToXMPOrSpeos360_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| map_to_merge_uri | [string](#string) | repeated | List of absolute path to XMP files to merge. | +| map_merged_uri | [string](#string) | | Absolute path to merged XMP or Speos360 file. | +| axis_system | [double](#double) | repeated | Optional axis system to force orientation in merged Speos360 file. | + + + +### MergeXMPsToXMPOrSpeos360_Response + + + +### SplitSpeos360IntoXMPs_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_uri | [string](#string) | | Uri of the speos360 file to split. | + + + +### SplitSpeos360IntoXMPs_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| splitted_map_uri | [string](#string) | repeated | List of uris to XMP files. | + + + + + + + + + +### MapActions +Actions available with XMP and Speos360 result file. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| MergeXMPsToXMPOrSpeos360 | [MergeXMPsToXMPOrSpeos360_Request](#ansys-api-speos-results-v1-MergeXMPsToXMPOrSpeos360_Request) | [MergeXMPsToXMPOrSpeos360_Response](#ansys-api-speos-results-v1-MergeXMPsToXMPOrSpeos360_Response) | Merge list of XMP files into a XMP or Speos360 file. [Unsupported] | +| MergeSpeos360ToStereoSpeos360 | [MergeSpeos360ToStereoSpeos360_Request](#ansys-api-speos-results-v1-MergeSpeos360ToStereoSpeos360_Request) | [MergeSpeos360ToStereoSpeos360_Response](#ansys-api-speos-results-v1-MergeSpeos360ToStereoSpeos360_Response) | Merge left and right speos360 files into a stereoscopic Speos360 file. [Unsupported] | +| SplitSpeos360IntoXMPs | [SplitSpeos360IntoXMPs_Request](#ansys-api-speos-results-v1-SplitSpeos360IntoXMPs_Request) | [SplitSpeos360IntoXMPs_Response](#ansys-api-speos-results-v1-SplitSpeos360IntoXMPs_Response) | Split a Speos360 file into a list of XMP files. [Unsupported] | +| ExportXMPToImage | [ExportXMPToImage_Request](#ansys-api-speos-results-v1-ExportXMPToImage_Request) | [ExportXMPToImage_Response](#ansys-api-speos-results-v1-ExportXMPToImage_Response) | Export XMP to PNG | + + + + + + +## results/v1/ray_path.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### RayPath + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| impacts_coordinates | [float](#float) | repeated | Impacts coordinates of this RayPath. (i0x, i0y, i0z, i1x, i1y, i1z, ..., iNx, iNy, iNz) with N+1 impacts | +| wavelengths | [double](#double) | repeated | Wavelength at each impact. | +| body_context_ids | [uint32](#uint32) | repeated | ID of the body impacted at each impact. | +| unique_face_ids | [uint32](#uint32) | repeated | ID of the face impacted at each impact. | +| interaction_statuses | [RayPath.PhotonStatus](#ansys-api-speos-results-v1-RayPath-PhotonStatus) | repeated | Interaction type at each impact with the elements encountered. | +| last_direction | [float](#float) | repeated | Direction after the last impact. (x, y, z) | +| colors | [common.v1.DataBytes](#ansys-api-speos-common-v1-DataBytes) | | The color in RGB24 format at each impact | + + + + + +### RayPath.PhotonStatus + +| Name | Number | Description | +| ---- | ------ | ----------- | +| StatusAbsorbed | 0 | | +| StatusSpecularTransmitted | 1 | | +| StatusGaussianTransmitted | 2 | | +| StatusLambertianTransmitted | 3 | | +| StatusVolumicDiffused | 4 | | +| StatusJustEmitted | 5 | | +| StatusDiracTransmitted | 6 | | +| StatusError | 7 | | +| StatusErrorVolumicBodyNotClosed | 8 | | +| StatusErrorVolumeConflict | 9 | | +| StatusError2DTangency | 10 | | +| StatusError2DIntersect3DWarning | 11 | | +| StatusErrorNonOpticalMaterial | 12 | | +| StatusErrorIntersection | 13 | | +| StatusErrorNonOpticalMaterialAtEmission | 14 | | +| StatusError3DTextureSupportTangency | 15 | | +| StatusLast | 16 | | +| StatusFirst | -7 | | +| StatusDiracReflected | -6 | | +| StatusReserved | -5 | | +| StatusGrinStep | -4 | | +| StatusLambertianReflected | -3 | | +| StatusGaussianReflected | -2 | | +| StatusSpecularReflected | -1 | | + + + + + + + + + + +## scene/v1/scene.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Create_Request +Request to create a Scene in ScenesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| scene | [Scene](#ansys-api-speos-scene-v1-Scene) | | | + + + +### Create_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Scene created in ScenesManager | + + + +### Delete_Request +Request to delete a Scene in ScenesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Scene to be deleted | + + + +### Delete_Response + + + +### GetSourceRayPaths_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of a ScenesManager element | +| source_path | [string](#string) | | path to the source in the Scene : "" for a specific source in the current scene, or "/" for a specific source in a specific sub scene | +| rays_nb | [uint32](#uint32) | optional | Number of rays sent by the source. Default 100 | +| raw_data | [bool](#bool) | optional | Boolean to get the wavelengths in response stream | +| display_data | [bool](#bool) | optional | Boolean to get the colors (RGB24 format) in response stream | + + + +### List_Request + + + +### List_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of the Scenes in ScenesManager | + + + +### LoadFile_Request +Request to LoadFile service + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of a ScenesManager element to update | +| file_uri | [string](#string) | | File uri (path or guid from FileTransferService) | + + + +### LoadFile_Response +Response to LoadFile service + + + +### Read_Request +Request to read a Scene in ScenesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Scene to be read | + + + +### Read_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| scene | [Scene](#ansys-api-speos-scene-v1-Scene) | | Scene corresponding to the guid given in Read_Request | + + + +### SaveFile_Request +Request to SaveFile service. Warning: SaveFile is not supported. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of a ScenesManager element to save | +| file_uri | [string](#string) | | File uri (path or guid from FileTransferService) | + + + +### SaveFile_Response +Response to SaveFile service. Warning: SaveFile is not supported. + + + +### Scene +Optical scene definition made of parts, optical properties, sources, sensors and simulations + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| description | [string](#string) | | | +| metadata | [Scene.MetadataEntry](#ansys-api-speos-scene-v1-Scene-MetadataEntry) | repeated | User defined metadata | +| part_guid | [string](#string) | | Guid from PartsManager of the geometrical part included inside the scene | +| vops | [Scene.VOPInstance](#ansys-api-speos-scene-v1-Scene-VOPInstance) | repeated | The volume materials applied on geometries | +| sops | [Scene.SOPInstance](#ansys-api-speos-scene-v1-Scene-SOPInstance) | repeated | The surface materials applied on geometries | +| sources | [Scene.SourceInstance](#ansys-api-speos-scene-v1-Scene-SourceInstance) | repeated | The sources added in the scene | +| sensors | [Scene.SensorInstance](#ansys-api-speos-scene-v1-Scene-SensorInstance) | repeated | The sensors added in the scene | +| simulations | [Scene.SimulationInstance](#ansys-api-speos-scene-v1-Scene-SimulationInstance) | repeated | The simulations added in the scene | +| scenes | [Scene.SceneInstance](#ansys-api-speos-scene-v1-Scene-SceneInstance) | repeated | Sub scenes | + + + +### Scene.GeoPaths +Geometry path of object that will include the specific property (can be sub-scene/part/body/face). +Empty or "" for all geometries, or in the format : /// (no name by default for root scene and root part). +"part1" -> part1 of the root part in the root scene +"part1/body1/face1" -> face1 in body1 in part1 of the root part in the root scene +"subScene1" -> root part in the sub scene subScene1 +"subScene1/part2" -> part2 of the sub scene subScene1 + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| geo_paths | [string](#string) | repeated | list of geo paths | + + + +### Scene.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Scene.SOPInstance +Instance of a SOP to apply on geometries of the scene + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| description | [string](#string) | | | +| metadata | [Scene.SOPInstance.MetadataEntry](#ansys-api-speos-scene-v1-Scene-SOPInstance-MetadataEntry) | repeated | User defined metadata | +| sop_guid | [string](#string) | | Guid of the element to instantiate | +| geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v1-Scene-GeoPaths) | | Geometries that will use this material | + + + +### Scene.SOPInstance.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Scene.SceneInstance + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| description | [string](#string) | | | +| metadata | [Scene.SceneInstance.MetadataEntry](#ansys-api-speos-scene-v1-Scene-SceneInstance-MetadataEntry) | repeated | User defined metadata | +| scene_guid | [string](#string) | | Guid of the element to instantiate | +| axis_system | [double](#double) | repeated | Scene position relative to parent PartTemplate reference (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) | + + + +### Scene.SceneInstance.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Scene.SensorInstance +Instance of a sensor to add in the scene + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| description | [string](#string) | | | +| metadata | [Scene.SensorInstance.MetadataEntry](#ansys-api-speos-scene-v1-Scene-SensorInstance-MetadataEntry) | repeated | User defined metadata | +| sensor_guid | [string](#string) | | Guid of the SensorTemplate in SensorTemplatesManager to instantiate | +| result_file_name | [string](#string) | | Result file name without extention. Result files of the sensor will be based on this name. | +| camera_sensor_properties | [Scene.SensorInstance.CameraSensorProperties](#ansys-api-speos-scene-v1-Scene-SensorInstance-CameraSensorProperties) | | To be filled if the sensor_guid corresponds to a SensorTemplate of type CameraSensorTemplate | +| irradiance_sensor_properties | [Scene.SensorInstance.IrradianceSensorProperties](#ansys-api-speos-scene-v1-Scene-SensorInstance-IrradianceSensorProperties) | | To be filled if the sensor_guid corresponds to a SensorTemplate of type IrradianceSensorTemplate | +| radiance_sensor_properties | [Scene.SensorInstance.RadianceSensorProperties](#ansys-api-speos-scene-v1-Scene-SensorInstance-RadianceSensorProperties) | | To be filled if the sensor_guid corresponds to a SensorTemplate of type SensorTemplate::Radiance | + + + +### Scene.SensorInstance.CameraSensorProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) | +| trajectory_file_uri | [string](#string) | | Trajectory file, used to define the positions and orientations of the Camera sensor in time. | +| layer_type_none | [Scene.SensorInstance.LayerTypeNone](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeNone) | | Layer type : None | +| layer_type_source | [Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeSource) | | Layer type : Source | + + + +### Scene.SensorInstance.IrradianceSensorProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) | +| ray_file_type | [Scene.SensorInstance.EnumRayFileType](#ansys-api-speos-scene-v1-Scene-SensorInstance-EnumRayFileType) | | Choose type of ray file generated after the simulation. | +| layer_type_none | [Scene.SensorInstance.LayerTypeNone](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeNone) | | Layer type : None | +| layer_type_source | [Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeSource) | | Layer type : Source | +| layer_type_face | [Scene.SensorInstance.LayerTypeFace](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeFace) | | Layer type : Face | +| layer_type_sequence | [Scene.SensorInstance.LayerTypeSequence](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeSequence) | | Layer type : Sequence | +| layer_type_polarization | [Scene.SensorInstance.LayerTypePolarization](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypePolarization) | | Layer type : Polarization | +| layer_type_incidence_angle | [Scene.SensorInstance.LayerTypeIncidenceAngle](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeIncidenceAngle) | | Layer type : Incidence angle | +| integration_direction | [double](#double) | repeated | Sensor global integration direction [x,y,z], optional (default direction is normal to sensor plane (anti-normal of the sensor)) and only settable for sensor template with IlluminanceTypePlanar or IlluminanceTypeSemiCylindrical as illuminance_type | +| output_face_geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v1-Scene-GeoPaths) | | List of output faces for inverse simulation optimization | + + + +### Scene.SensorInstance.LayerTypeFace +Includes one layer per surface selected in the result. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sca_filtering_mode | [Scene.SensorInstance.LayerTypeFace.EnumSCAFilteringType](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeFace-EnumSCAFilteringType) | | | +| layers | [Scene.SensorInstance.LayerTypeFace.Layer](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeFace-Layer) | repeated | Layers that will be taken into account in the result. | + + + +### Scene.SensorInstance.LayerTypeFace.Layer + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Name of the layer | +| geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v1-Scene-GeoPaths) | | Surface selected. | + + + +### Scene.SensorInstance.LayerTypeIncidenceAngle +Includes one layer per range of incident angles. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sampling | [uint32](#uint32) | | | + + + +### Scene.SensorInstance.LayerTypeNone +Includes the simulation's results in one layer. + + + +### Scene.SensorInstance.LayerTypePolarization +Includes one layer per Stokes parameter using the polarization parameter. + + + +### Scene.SensorInstance.LayerTypeSequence +Includes one layer per sequence in the result. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| maximum_nb_of_sequence | [uint32](#uint32) | | | +| define_sequence_per | [Scene.SensorInstance.LayerTypeSequence.EnumSequenceType](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeSequence-EnumSequenceType) | | | + + + +### Scene.SensorInstance.LayerTypeSource +Includes one layer per active source in the result. + + + +### Scene.SensorInstance.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Scene.SensorInstance.RadianceSensorProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) | +| observer_point | [double](#double) | repeated | Position of the observer point (Ox Oy Oz), optional (default: focal length is used) | +| layer_type_none | [Scene.SensorInstance.LayerTypeNone](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeNone) | | Layer type : None | +| layer_type_source | [Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeSource) | | Layer type : Source | +| layer_type_face | [Scene.SensorInstance.LayerTypeFace](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeFace) | | Layer type : Face | +| layer_type_sequence | [Scene.SensorInstance.LayerTypeSequence](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeSequence) | | Layer type : Sequence | + + + +### Scene.SimulationInstance +Instance of a simulation to add in the scene + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| description | [string](#string) | | | +| metadata | [Scene.SimulationInstance.MetadataEntry](#ansys-api-speos-scene-v1-Scene-SimulationInstance-MetadataEntry) | repeated | User defined metadata | +| simulation_guid | [string](#string) | | Guid of the element to instantiate | +| sensor_paths | [string](#string) | repeated | Sensors that this simulation will include (empty or "" for all sensors, "" for a specific sensor in the current scene, or "/" for a specific sensor in a specific sub scene) | +| source_paths | [string](#string) | repeated | Sources that this simulation will include (empty or "" for all sources, "" for a specific source in the current scene, or "/" for a specific source in a specific sub scene) | +| geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v1-Scene-GeoPaths) | | Geometries that this simulation will include (empty to select the root part and all the subscenes) | + + + +### Scene.SimulationInstance.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Scene.SourceInstance +Instance of a source to add in the scene + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| description | [string](#string) | | | +| metadata | [Scene.SourceInstance.MetadataEntry](#ansys-api-speos-scene-v1-Scene-SourceInstance-MetadataEntry) | repeated | User defined metadata | +| source_guid | [string](#string) | | Guid of the SourceTemplate in SourceTemplatesManager to instantiate | +| luminaire_properties | [Scene.SourceInstance.LuminaireProperties](#ansys-api-speos-scene-v1-Scene-SourceInstance-LuminaireProperties) | | To be filled if the source_guid corresponds to a SourceTemplate of type Luminaire | +| surface_properties | [Scene.SourceInstance.SurfaceProperties](#ansys-api-speos-scene-v1-Scene-SourceInstance-SurfaceProperties) | | To be filled if the source_guid corresponds to a SourceTemplate of type Surface | +| rayfile_properties | [Scene.SourceInstance.RayFileProperties](#ansys-api-speos-scene-v1-Scene-SourceInstance-RayFileProperties) | | To be filled if the source_guid corresponds to a SourceTemplate of type RayFile | + + + +### Scene.SourceInstance.IntensityProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| library_properties | [Scene.SourceInstance.IntensityProperties.LibraryProperties](#ansys-api-speos-scene-v1-Scene-SourceInstance-IntensityProperties-LibraryProperties) | | To be filled if the intensity_guid of the source template corresponds to an IntensityTemplate of type Library | +| asymmetric_gaussian_properties | [Scene.SourceInstance.IntensityProperties.AsymmetricGaussianProperties](#ansys-api-speos-scene-v1-Scene-SourceInstance-IntensityProperties-AsymmetricGaussianProperties) | | Deprecated (use gaussian_properties instead) - To be filled if the intensity_guid of the source template corresponds to an IntensityTemplate of type AsymmetricGaussian | +| gaussian_properties | [Scene.SourceInstance.IntensityProperties.GaussianProperties](#ansys-api-speos-scene-v1-Scene-SourceInstance-IntensityProperties-GaussianProperties) | | To be filled if the intensity_guid of the source template corresponds to an IntensityTemplate of type Gaussian | + + + +### Scene.SourceInstance.IntensityProperties.AsymmetricGaussianProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | orientation (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) | + + + +### Scene.SourceInstance.IntensityProperties.GaussianProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | optional - orientation of the intensity distribution (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) - if not filled : normal to surface map. | + + + +### Scene.SourceInstance.IntensityProperties.LibraryProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| exit_geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v1-Scene-GeoPaths) | | Exit Geometries that will use this surface source | +| axis_system | [Scene.SourceInstance.IntensityProperties.LibraryProperties.AxisSystem](#ansys-api-speos-scene-v1-Scene-SourceInstance-IntensityProperties-LibraryProperties-AxisSystem) | | orientation (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) | +| normal_to_surface | [Scene.SourceInstance.IntensityProperties.LibraryProperties.NormalToSurface](#ansys-api-speos-scene-v1-Scene-SourceInstance-IntensityProperties-LibraryProperties-NormalToSurface) | | Define the intensity distribution as normal to the selected surface. | +| normal_to_uv_map | [Scene.SourceInstance.IntensityProperties.LibraryProperties.NormalToUVMap](#ansys-api-speos-scene-v1-Scene-SourceInstance-IntensityProperties-LibraryProperties-NormalToUVMap) | | Define the intensity distribution as normal to the selected emissive surface and its orientation on the emissive surface. | + + + +### Scene.SourceInstance.IntensityProperties.LibraryProperties.AxisSystem + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [double](#double) | repeated | orientation (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) | + + + +### Scene.SourceInstance.IntensityProperties.LibraryProperties.NormalToSurface +Define the intensity distribution as normal to the selected surface. + + + +### Scene.SourceInstance.IntensityProperties.LibraryProperties.NormalToUVMap +Define the intensity distribution as normal to the selected emissive surface and its orientation on the emissive surface. + + + +### Scene.SourceInstance.LuminaireProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the source (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) | + + + +### Scene.SourceInstance.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Scene.SourceInstance.RayFileProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the source (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) | +| exit_geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v1-Scene-GeoPaths) | | Exit Geometries that will use this rayfile source | + + + +### Scene.SourceInstance.SurfaceProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| exitance_constant_properties | [Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties](#ansys-api-speos-scene-v1-Scene-SourceInstance-SurfaceProperties-ExitanceConstantProperties) | | To be filled if the Surface SourceTemplate has ExitanceConstant | +| exitance_variable_properties | [Scene.SourceInstance.SurfaceProperties.ExitanceVariableProperties](#ansys-api-speos-scene-v1-Scene-SourceInstance-SurfaceProperties-ExitanceVariableProperties) | | To be filled if the Surface SourceTemplate has ExitanceVariable | +| intensity_properties | [Scene.SourceInstance.IntensityProperties](#ansys-api-speos-scene-v1-Scene-SourceInstance-IntensityProperties) | | | + + + +### Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| geo_paths | [Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties.GeoPath](#ansys-api-speos-scene-v1-Scene-SourceInstance-SurfaceProperties-ExitanceConstantProperties-GeoPath) | repeated | | + + + +### Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties.GeoPath + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| geo_path | [string](#string) | | Geometry that will use this surface source ("" for a whole body, or "/" for a specific face) | +| reverse_normal | [bool](#bool) | optional | optional - if not set or false : normal is not reversed. | + + + +### Scene.SourceInstance.SurfaceProperties.ExitanceVariableProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_plane | [double](#double) | repeated | Position of the exitance map (Ox Oy Oz Xx Xy Xz Yx Yy Yz) | + + + +### Scene.VOPInstance +Instance of a VOP to apply on geometries of the scene + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| description | [string](#string) | | | +| metadata | [Scene.VOPInstance.MetadataEntry](#ansys-api-speos-scene-v1-Scene-VOPInstance-MetadataEntry) | repeated | User defined metadata | +| vop_guid | [string](#string) | | Guid of the element to instantiate | +| geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v1-Scene-GeoPaths) | | Geometries that will use this material | + + + +### Scene.VOPInstance.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Update_Request +Request to update a Scene in ScenesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Scene to be updated | +| scene | [Scene](#ansys-api-speos-scene-v1-Scene) | | Scene that will be used for the update | + + + +### Update_Response + + + + + +### Scene.SensorInstance.EnumRayFileType +Ray file types available + +| Name | Number | Description | +| ---- | ------ | ----------- | +| RayFileNone | 0 | Generates no ray file. | +| RayFileClassic | 1 | Generates a ray file without polarization data. | +| RayFilePolarization | 2 | Generates a ray file with the polarization data for each ray. | +| RayFileTM25 | 3 | Generates a .tm25ray file with polarization data for each ray. | +| RayFileTM25NoPolarization | 4 | Generates a .tm25ray file without polarization data. | + + + +### Scene.SensorInstance.LayerTypeFace.EnumSCAFilteringType + +| Name | Number | Description | +| ---- | ------ | ----------- | +| LastImpact | 0 | | +| IntersectedOneTime | 1 | | + + + +### Scene.SensorInstance.LayerTypeSequence.EnumSequenceType + +| Name | Number | Description | +| ---- | ------ | ----------- | +| Geometries | 0 | | +| Faces | 1 | | + + + + + + + +### SceneActions +Actions available on a Scene + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| LoadFile | [LoadFile_Request](#ansys-api-speos-scene-v1-LoadFile_Request) | [LoadFile_Response](#ansys-api-speos-scene-v1-LoadFile_Response) | Load .speos file | +| SaveFile | [SaveFile_Request](#ansys-api-speos-scene-v1-SaveFile_Request) | [SaveFile_Response](#ansys-api-speos-scene-v1-SaveFile_Response) | Save .speos file. Warning: SaveFile is not supported. | +| GetSourceRayPaths | [GetSourceRayPaths_Request](#ansys-api-speos-scene-v1-GetSourceRayPaths_Request) | [results.v1.RayPath](#ansys-api-speos-results-v1-RayPath) stream | Get RayPaths generated by a source | + + + +### ScenesManager +Manager for Scenes + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-scene-v1-Create_Request) | [Create_Response](#ansys-api-speos-scene-v1-Create_Response) | Create a Scene | +| Read | [Read_Request](#ansys-api-speos-scene-v1-Read_Request) | [Read_Response](#ansys-api-speos-scene-v1-Read_Response) | Read a Scene | +| Update | [Update_Request](#ansys-api-speos-scene-v1-Update_Request) | [Update_Response](#ansys-api-speos-scene-v1-Update_Response) | Update a Scene | +| Delete | [Delete_Request](#ansys-api-speos-scene-v1-Delete_Request) | [Delete_Response](#ansys-api-speos-scene-v1-Delete_Response) | Delete a Scene | +| List | [List_Request](#ansys-api-speos-scene-v1-List_Request) | [List_Response](#ansys-api-speos-scene-v1-List_Response) | List all Scenes in manager | + + + + + + +## scene/v2/scene.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Create_Request +Request to create a Scene in ScenesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| scene | [Scene](#ansys-api-speos-scene-v2-Scene) | | | +| guid | [string](#string) | optional | Optional field to specify the guid used in the database. If not set, a unique guid will be generated for that entry and sent back in the Create_Response. | + + + +### Create_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Scene created in ScenesManager | + + + +### Delete_Request +Request to delete a Scene in ScenesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Scene to be deleted | + + + +### Delete_Response + + + +### GetSourceRayPaths_Request + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of a ScenesManager element | +| source_path | [string](#string) | | path to the source in the Scene : "" for a specific source in the current scene, or "/" for a specific source in a specific sub scene | +| rays_nb | [uint32](#uint32) | optional | Number of rays sent by the source. Default 100 | +| raw_data | [bool](#bool) | optional | Boolean to get the wavelengths in response stream | +| display_data | [bool](#bool) | optional | Boolean to get the colors (RGB24 format) in response stream | + + + +### List_Request + + + +### List_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of the Scenes in ScenesManager | + + + +### LoadFile_Request +Request to LoadFile service + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of a ScenesManager element to update | +| file_uri | [string](#string) | | File uri (path or guid from FileTransferService) | +| password | [string](#string) | | Password needed to open the speos lightbox file (only necessary if user protects the speos light box with a password) | + + + +### LoadFile_Response +Response to LoadFile service + + + +### Read_Request +Request to read a Scene in ScenesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Scene to be read | + + + +### Read_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| scene | [Scene](#ansys-api-speos-scene-v2-Scene) | | Scene corresponding to the guid given in Read_Request | + + + +### SaveFile_Request +Request to SaveFile service. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of a ScenesManager element to save | +| file_uri | [string](#string) | | File uri (path or guid from FileTransferService) | +| password | [string](#string) | | Password to be defined if the user wants to protect a Speos Lightbox file. If not, then keep this field empty. | +| is_black_boxed | [bool](#bool) | | Flag to save the scene into a black-boxed Speos Lightbox. If the scene is already tagged as black-boxed, this flag is ignored. | + + + +### SaveFile_Response +Response to SaveFile service. + + + +### Scene +Optical scene definition made of parts, optical properties, sources, sensors and simulations + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| description | [string](#string) | | | +| metadata | [Scene.MetadataEntry](#ansys-api-speos-scene-v2-Scene-MetadataEntry) | repeated | User defined metadata | +| part_guid | [string](#string) | | Guid from PartsManager of the geometrical part included inside the scene | +| sub_scene_anchor_axis_system | [double](#double) | repeated | Only used for sub-scene - Represents the axis system to be attached to the one describing the scene instance. If the coordinate system is not orthonormal, it will be automatically orthonormalized | +| sources | [Scene.SourceInstance](#ansys-api-speos-scene-v2-Scene-SourceInstance) | repeated | The sources added in the scene | +| sensors | [Scene.SensorInstance](#ansys-api-speos-scene-v2-Scene-SensorInstance) | repeated | The sensors added in the scene | +| simulations | [Scene.SimulationInstance](#ansys-api-speos-scene-v2-Scene-SimulationInstance) | repeated | The simulations added in the scene | +| materials | [Scene.MaterialInstance](#ansys-api-speos-scene-v2-Scene-MaterialInstance) | repeated | The materials (volume + surface) applied on geometries | +| scenes | [Scene.SceneInstance](#ansys-api-speos-scene-v2-Scene-SceneInstance) | repeated | Sub scenes | +| ground | [Scene.GroundPlane](#ansys-api-speos-scene-v2-Scene-GroundPlane) | | Optional - Only usable when there is at least one Ambient Environment Source Template that has selected a HDR image file. | + + + +### Scene.GeoPath + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| geo_path | [string](#string) | | Geometry that will be used ("" for a whole body, or "/" for a specific face) | +| reverse_normal | [bool](#bool) | optional | optional - if not set or false : normal is not reversed. | + + + +### Scene.GeoPaths +Geometry path of object that will include the specific property (can be sub-scene/part/body/face). +geo_path in the format : "///" (no name by default for root scene and root part). +"body0" -> body0 of the root part in the root scene +"body0/face0" -> face0 in body0 of the root part in the root scene +"part1" -> part1 of the root part in the root scene +"part1/body1/face1" -> face1 in body1 in part1 of the root part in the root scene +"subScene1" -> root part in the sub scene subScene1 +"subScene1/part2" -> part2 of the sub scene subScene1 +Particularities: +If the object GeoPaths is defined and geo_paths left empty, this means "All geometry selected". +If the object GeoPaths is NOT defined, this means "No geometry selected". + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| geo_paths | [string](#string) | repeated | list of geo paths | + + + +### Scene.GroundPlane + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ground_origin | [double](#double) | repeated | 3D point in the geometry. HDR image is displayed on the ground plane | +| zenith_direction | [double](#double) | repeated | line normal to the ground or Z direction | +| ground_height | [double](#double) | | height of the environment shooting (unit mm) | + + + +### Scene.MaterialInstance +Instance of a material to apply on geometries of the scene + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Unique identifier in the scene | +| display_name | [string](#string) | | User name to be displayed | +| description | [string](#string) | | | +| metadata | [Scene.MaterialInstance.MetadataEntry](#ansys-api-speos-scene-v2-Scene-MaterialInstance-MetadataEntry) | repeated | User defined metadata | +| vop_guid | [string](#string) | optional | optional - Guid of the volume optical property to instantiate | +| non_homogeneous_properties | [Scene.MaterialInstance.NonHomogeneousProperties](#ansys-api-speos-scene-v2-Scene-MaterialInstance-NonHomogeneousProperties) | | To be filled if the vop_guid corresponds to a VOPTemplate of type NonHomogeneous | +| sop_guids | [string](#string) | repeated | Deprecated - Better use sop oneof field (either sop_guid or texture) | +| sop_guid | [string](#string) | | Guid of the surface optical property to instantiate | +| texture | [Scene.MaterialInstance.Texture](#ansys-api-speos-scene-v2-Scene-MaterialInstance-Texture) | | Surface optical property to instantiate using texture (can be composed of several layers) | +| geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v2-Scene-GeoPaths) | | Geometries that will use this material | + + + +### Scene.MaterialInstance.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Scene.MaterialInstance.NonHomogeneousProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the non homogeneous vop (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | + + + +### Scene.MaterialInstance.Texture + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| layers | [Scene.MaterialInstance.Texture.Layer](#ansys-api-speos-scene-v2-Scene-MaterialInstance-Texture-Layer) | repeated | List of texture layers (also called multi texture in case of several layers) | + + + +### Scene.MaterialInstance.Texture.Layer + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sop_guid | [string](#string) | | Guid of the surface optical property to bind to geometry | +| image_properties | [Scene.MaterialInstance.Texture.Layer.TextureMappingInfo](#ansys-api-speos-scene-v2-Scene-MaterialInstance-Texture-Layer-TextureMappingInfo) | | To be filled if the SOPTemplate/Texture contains image field | +| normal_map_properties | [Scene.MaterialInstance.Texture.Layer.TextureMappingInfo](#ansys-api-speos-scene-v2-Scene-MaterialInstance-Texture-Layer-TextureMappingInfo) | | To be filled if the SOPTemplate/Texture contains normal_map field | +| anisotropy_map_properties | [Scene.MaterialInstance.Texture.Layer.TextureMappingInfo](#ansys-api-speos-scene-v2-Scene-MaterialInstance-Texture-Layer-TextureMappingInfo) | | To be filled if the SOPTemplate is anisotropic (for example an anisotropicbsdf as Library file uri) | + + + +### Scene.MaterialInstance.Texture.Layer.TextureMappingInfo + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| mapping_operator | [Scene.MaterialInstance.Texture.MappingOperator](#ansys-api-speos-scene-v2-Scene-MaterialInstance-Texture-MappingOperator) | | Mapping operator to create UV mapping in corresponding face | +| vertices_data_index | [uint32](#uint32) | | Index in face's vertices_data where UV mapping is stored | + + + +### Scene.MaterialInstance.Texture.MappingOperator + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| planar | [Scene.MaterialInstance.Texture.MappingOperator.Planar](#ansys-api-speos-scene-v2-Scene-MaterialInstance-Texture-MappingOperator-Planar) | | | +| cubic | [Scene.MaterialInstance.Texture.MappingOperator.Cubic](#ansys-api-speos-scene-v2-Scene-MaterialInstance-Texture-MappingOperator-Cubic) | | | +| spherical | [Scene.MaterialInstance.Texture.MappingOperator.Spherical](#ansys-api-speos-scene-v2-Scene-MaterialInstance-Texture-MappingOperator-Spherical) | | | +| cylindrical | [Scene.MaterialInstance.Texture.MappingOperator.Cylindrical](#ansys-api-speos-scene-v2-Scene-MaterialInstance-Texture-MappingOperator-Cylindrical) | | | +| axis_system | [double](#double) | repeated | Reference for the mapping operator (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) | +| u_offset | [double](#double) | | Shift on U direction (mm) | +| v_offset | [double](#double) | | Shift on V direction (mm) | +| u_scale_factor | [double](#double) | | Scale factor on U dimension | +| v_scale_factor | [double](#double) | | Scale factor on V dimension | +| u_length | [double](#double) | | Dimension on U direction (mm) | +| v_length | [double](#double) | optional | Optional - Dimension on V direction (mm). If not filled, then the image ratio is used to define v_length from u_length. | +| rotation | [double](#double) | | Rotation of UVs (degree) ]-360, 360[ | + + + +### Scene.MaterialInstance.Texture.MappingOperator.Cubic + + + +### Scene.MaterialInstance.Texture.MappingOperator.Cylindrical + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| base_perimeter | [double](#double) | | | + + + +### Scene.MaterialInstance.Texture.MappingOperator.Planar + + + +### Scene.MaterialInstance.Texture.MappingOperator.Spherical + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sphere_perimeter | [double](#double) | | | + + + +### Scene.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Scene.SceneInstance + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Unique identifier in the scene | +| display_name | [string](#string) | | User name to be displayed | +| description | [string](#string) | | | +| metadata | [Scene.SceneInstance.MetadataEntry](#ansys-api-speos-scene-v2-Scene-SceneInstance-MetadataEntry) | repeated | User defined metadata | +| scene_guid | [string](#string) | | Guid of the element to instantiate | +| axis_system | [double](#double) | repeated | Scene position relative to parent PartTemplate reference (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | +| trajectory_file_uri | [string](#string) | | Trajectory file, used to define the positions and orientations of the Scene instance in time. | + + + +### Scene.SceneInstance.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Scene.SensorInstance +Instance of a sensor to add in the scene + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Unique identifier in the scene | +| display_name | [string](#string) | | User name to be displayed | +| description | [string](#string) | | | +| metadata | [Scene.SensorInstance.MetadataEntry](#ansys-api-speos-scene-v2-Scene-SensorInstance-MetadataEntry) | repeated | User defined metadata | +| sensor_guid | [string](#string) | | Guid of the SensorTemplate in SensorTemplatesManager to instantiate | +| result_file_name | [string](#string) | | Result file name without extention. Result files of the sensor will be based on this name. | +| camera_properties | [Scene.SensorInstance.CameraProperties](#ansys-api-speos-scene-v2-Scene-SensorInstance-CameraProperties) | | To be filled if the sensor_guid corresponds to a SensorTemplate of type CameraSensorTemplate | +| irradiance_properties | [Scene.SensorInstance.IrradianceProperties](#ansys-api-speos-scene-v2-Scene-SensorInstance-IrradianceProperties) | | To be filled if the sensor_guid corresponds to a SensorTemplate of type IrradianceSensorTemplate | +| radiance_properties | [Scene.SensorInstance.RadianceProperties](#ansys-api-speos-scene-v2-Scene-SensorInstance-RadianceProperties) | | To be filled if the sensor_guid corresponds to a SensorTemplate of type SensorTemplate::Radiance | +| intensity_properties | [Scene.SensorInstance.IntensityProperties](#ansys-api-speos-scene-v2-Scene-SensorInstance-IntensityProperties) | | To be filled if the sensor_guid corresponds to a SensorTemplate of type IntensitySensorTemplate | +| polar_intensity_properties | [Scene.SensorInstance.PolarIntensityProperties](#ansys-api-speos-scene-v2-Scene-SensorInstance-PolarIntensityProperties) | | To be filled if the sensor_guid corresponds to a SensorTemplate of type PolarIntensitySensorTemplate | +| irradiance_3d_properties | [Scene.SensorInstance.Irradiance3DProperties](#ansys-api-speos-scene-v2-Scene-SensorInstance-Irradiance3DProperties) | | To be filled if the sensor_guid corresponds to a SensorTemplate of type SensorTemplate::Irradiance3D | +| observer_properties | [Scene.SensorInstance.ObserverProperties](#ansys-api-speos-scene-v2-Scene-SensorInstance-ObserverProperties) | | To be filled if the sensor_guid corresponds to a SensorTemplate of type SensorTemplate::Observer | +| immersive_properties | [Scene.SensorInstance.ImmersiveProperties](#ansys-api-speos-scene-v2-Scene-SensorInstance-ImmersiveProperties) | | To be filled if the sensor_guid corresponds to a SensorTemplate of type SensorTemplate::Immersive | +| lxp_properties | [Scene.SensorInstance.LXPProperties](#ansys-api-speos-scene-v2-Scene-SensorInstance-LXPProperties) | | To activate lxp feature, we must fill this field | + + + +### Scene.SensorInstance.CameraProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | +| trajectory_file_uri | [string](#string) | | Trajectory file, used to define the positions and orientations of the Camera sensor in time. | +| layer_type_none | [Scene.SensorInstance.LayerTypeNone](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeNone) | | Layer type : None | +| layer_type_source | [Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSource) | | Layer type : Source | + + + +### Scene.SensorInstance.ImmersiveProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). X corresponds to Front direction. Y corresponds to Top direction. Z corresponds to Right direction. | +| layer_type_none | [Scene.SensorInstance.LayerTypeNone](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeNone) | | Layer type : None. | +| layer_type_source | [Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSource) | | Layer type : Source. | + + + +### Scene.SensorInstance.IntensityProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | +| layer_type_none | [Scene.SensorInstance.LayerTypeNone](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeNone) | | Layer type: None | +| layer_type_source | [Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSource) | | Layer type: Source | +| layer_type_face | [Scene.SensorInstance.LayerTypeFace](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeFace) | | Layer type: Face | +| layer_type_sequence | [Scene.SensorInstance.LayerTypeSequence](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSequence) | | Layer type: Sequence | + + + +### Scene.SensorInstance.Irradiance3DProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ray_file_type | [Scene.SensorInstance.EnumRayFileType](#ansys-api-speos-scene-v2-Scene-SensorInstance-EnumRayFileType) | | Choose type of ray file generated after the simulation. | +| layer_type_none | [Scene.SensorInstance.LayerTypeNone](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeNone) | | Layer type : None | +| layer_type_source | [Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSource) | | Layer type : Source | +| geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v2-Scene-GeoPaths) | | Geometries that will use this sensor | + + + +### Scene.SensorInstance.IrradianceProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | +| ray_file_type | [Scene.SensorInstance.EnumRayFileType](#ansys-api-speos-scene-v2-Scene-SensorInstance-EnumRayFileType) | | Choose type of ray file generated after the simulation. | +| layer_type_none | [Scene.SensorInstance.LayerTypeNone](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeNone) | | Layer type : None | +| layer_type_source | [Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSource) | | Layer type : Source | +| layer_type_face | [Scene.SensorInstance.LayerTypeFace](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeFace) | | Layer type : Face | +| layer_type_sequence | [Scene.SensorInstance.LayerTypeSequence](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSequence) | | Layer type : Sequence | +| layer_type_polarization | [Scene.SensorInstance.LayerTypePolarization](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypePolarization) | | Layer type : Polarization | +| layer_type_incidence_angle | [Scene.SensorInstance.LayerTypeIncidenceAngle](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeIncidenceAngle) | | Layer type : Incidence angle | +| integration_direction | [double](#double) | repeated | Sensor global integration direction [x,y,z], optional (default direction is Z axis of axis_system). Note: Contrary to any visualization of integration directions within Speos Software or its documentation the integration direction must be set in the anti-rays direction to integrate their signal. Integration direction is only settable for sensor template with IlluminanceTypePlanar or IlluminanceTypeSemiCylindrical as illuminance_type. | +| output_face_geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v2-Scene-GeoPaths) | | List of output faces for inverse simulation optimization | + + + +### Scene.SensorInstance.LXPProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| nb_max_paths | [uint32](#uint32) | | The Maximum paths corresponds to the maximum number of rays the Light Expert file (*.lpf or *.lp3) can contain. | + + + +### Scene.SensorInstance.LayerTypeFace +Includes one layer per surface selected in the result. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sca_filtering_mode | [Scene.SensorInstance.LayerTypeFace.EnumSCAFilteringType](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeFace-EnumSCAFilteringType) | | | +| layers | [Scene.SensorInstance.LayerTypeFace.Layer](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeFace-Layer) | repeated | Layers that will be taken into account in the result. | + + + +### Scene.SensorInstance.LayerTypeFace.Layer + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Name of the layer | +| geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v2-Scene-GeoPaths) | | Surface selected. | + + + +### Scene.SensorInstance.LayerTypeIncidenceAngle +Includes one layer per range of incident angles. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sampling | [uint32](#uint32) | | | + + + +### Scene.SensorInstance.LayerTypeNone +Includes the simulation's results in one layer. + + + +### Scene.SensorInstance.LayerTypePolarization +Includes one layer per Stokes parameter using the polarization parameter. + + + +### Scene.SensorInstance.LayerTypeSequence +Includes one layer per sequence in the result. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| maximum_nb_of_sequence | [uint32](#uint32) | | | +| define_sequence_per | [Scene.SensorInstance.LayerTypeSequence.EnumSequenceType](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSequence-EnumSequenceType) | | | + + + +### Scene.SensorInstance.LayerTypeSource +Includes one layer per active source in the result. + + + +### Scene.SensorInstance.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Scene.SensorInstance.ObserverProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the observed object/scene. (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). X corresponds to Horizontal direction. Y corresponds to Vertical direction. | +| layer_type_none | [Scene.SensorInstance.LayerTypeNone](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeNone) | | Layer type : None. | +| layer_type_source | [Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSource) | | Layer type : Source. | + + + +### Scene.SensorInstance.PolarIntensityProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | + + + +### Scene.SensorInstance.RadianceProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | +| observer_point | [double](#double) | repeated | Position of the observer point (Ox Oy Oz), optional (default: focal length is used) | +| layer_type_none | [Scene.SensorInstance.LayerTypeNone](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeNone) | | Layer type : None | +| layer_type_source | [Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSource) | | Layer type : Source | +| layer_type_face | [Scene.SensorInstance.LayerTypeFace](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeFace) | | Layer type : Face | +| layer_type_sequence | [Scene.SensorInstance.LayerTypeSequence](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSequence) | | Layer type : Sequence | + + + +### Scene.SimulationInstance +Instance of a simulation to add in the scene + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Unique identifier in the scene | +| display_name | [string](#string) | | User name to be displayed | +| description | [string](#string) | | | +| metadata | [Scene.SimulationInstance.MetadataEntry](#ansys-api-speos-scene-v2-Scene-SimulationInstance-MetadataEntry) | repeated | User defined metadata | +| simulation_guid | [string](#string) | | Guid of the element to instantiate | +| sensor_paths | [string](#string) | repeated | Sensors that this simulation will include (empty for no sensor, [""] for all sensors, "" for a specific sensor in the current scene, or "/" for a specific sensor in a specific sub scene) | +| source_paths | [string](#string) | repeated | Sources that this simulation will include (empty for no source, [""] for all sources, "" for a specific source in the current scene, or "/" for a specific source in a specific sub scene) | +| source_groups | [Scene.SimulationInstance.SourceGroup](#ansys-api-speos-scene-v2-Scene-SimulationInstance-SourceGroup) | repeated | Source groups that this simulation will include, only sources which are in source_path can be added to a source group. All sources with in one source group will be grouped in one layer in the result, when sensor layering is LayerTypeSource. | +| geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v2-Scene-GeoPaths) | | Geometries that this simulation will include - Not yet functional (All geometries are included by default in each simulation) | +| vbb_properties | [Scene.SimulationInstance.VirtualBSDFBenchProperties](#ansys-api-speos-scene-v2-Scene-SimulationInstance-VirtualBSDFBenchProperties) | | To be filled if the simulation_guid corresponds to a SimulationTemplate of type VirtualBSDFBench | + + + +### Scene.SimulationInstance.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Scene.SimulationInstance.SourceGroup + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Group name for the source | +| source_paths | [string](#string) | repeated | Sources that belong to this group, selection can be done by "" for a specific source in the current scene, or "/" for a specific source in a specific sub scene | + + + +### Scene.SimulationInstance.VirtualBSDFBenchProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Axis system of measurement (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz), O will be the measurement position, Z will be the normal axis (theta angle reference) and X the orientation on the surface (phi angle reference) | +| analysis_x_ratio | [double](#double) | | Ratio to reduce the analysis area following x, must be in range ]0., 100.] | +| analysis_y_ratio | [double](#double) | | Ratio to reduce the analysis area following y, must be in range ]0., 100.] | + + + +### Scene.SourceInstance +Instance of a source to add in the scene + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Unique identifier in the scene | +| display_name | [string](#string) | | User name to be displayed | +| description | [string](#string) | | | +| metadata | [Scene.SourceInstance.MetadataEntry](#ansys-api-speos-scene-v2-Scene-SourceInstance-MetadataEntry) | repeated | User defined metadata | +| source_guid | [string](#string) | | Guid of the SourceTemplate in SourceTemplatesManager to instantiate | +| luminaire_properties | [Scene.SourceInstance.LuminaireProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-LuminaireProperties) | | To be filled if the source_guid corresponds to a SourceTemplate of type Luminaire | +| surface_properties | [Scene.SourceInstance.SurfaceProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-SurfaceProperties) | | To be filled if the source_guid corresponds to a SourceTemplate of type Surface | +| rayfile_properties | [Scene.SourceInstance.RayFileProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-RayFileProperties) | | To be filled if the source_guid corresponds to a SourceTemplate of type RayFile | +| thermic_properties | [Scene.SourceInstance.ThermicProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-ThermicProperties) | | To be filled if the source_guid corresponds to a SourceTemplate of type Thermic Source | +| display_properties | [Scene.SourceInstance.DisplayProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-DisplayProperties) | | To be filled if the source_guid corresponds to a SourceTemplate of type Display | +| ambient_properties | [Scene.SourceInstance.AmbientProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties) | | To be filled if the source_guid corresponds to a SourceTemplate of type Ambient | + + + +### Scene.SourceInstance.AmbientProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| zenith_direction | [double](#double) | repeated | line normal to the ground or Z direction | +| reverse_zenith | [bool](#bool) | | optional - if not set or false : normal is not reversed | +| uniform_ambient_properties | [Scene.SourceInstance.AmbientProperties.UniformAmbientProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-UniformAmbientProperties) | | | +| cie_overcast_properties | [Scene.SourceInstance.AmbientProperties.CieOvercastProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-CieOvercastProperties) | | | +| cie_general_properties | [Scene.SourceInstance.AmbientProperties.CieGeneralProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-CieGeneralProperties) | | | +| natural_light_properties | [Scene.SourceInstance.AmbientProperties.NaturalLightProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-NaturalLightProperties) | | | +| us_standard_properties | [Scene.SourceInstance.AmbientProperties.UsStandardProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-UsStandardProperties) | | | +| environment_map_properties | [Scene.SourceInstance.AmbientProperties.EnvironmentMapProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-EnvironmentMapProperties) | | | + + + +### Scene.SourceInstance.AmbientProperties.CieGeneralProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| north_direction | [double](#double) | repeated | (X Y Z) Direction to the North | +| reverse_north | [bool](#bool) | | optional - if not set or false : normal is not reversed | +| sun_axis_system | [Scene.SourceInstance.AmbientProperties.SunAxisSystem](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-SunAxisSystem) | | Set the Sun direction | + + + +### Scene.SourceInstance.AmbientProperties.CieOvercastProperties + + + +### Scene.SourceInstance.AmbientProperties.EnvironmentMapProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| north_direction | [double](#double) | repeated | (X Y Z) Direction to the North | +| reverse_north | [bool](#bool) | | optional - if not set or false : normal is not reversed | + + + +### Scene.SourceInstance.AmbientProperties.ManualSun + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sun_direction | [double](#double) | repeated | (X Y Z) direction to the sun | +| reverse_sun | [bool](#bool) | | optional - if not set or false : normal is not reversed | + + + +### Scene.SourceInstance.AmbientProperties.NaturalLightProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| north_direction | [double](#double) | repeated | (X Y Z) Direction to the North | +| reverse_north | [bool](#bool) | | optional - if not set or false : normal is not reversed | +| sun_axis_system | [Scene.SourceInstance.AmbientProperties.SunAxisSystem](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-SunAxisSystem) | | Set the Sun direction | + + + +### Scene.SourceInstance.AmbientProperties.SunAxisSystem + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| automatic_sun | [Scene.SourceInstance.AmbientProperties.SunAxisSystem.AutomaticSun](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-SunAxisSystem-AutomaticSun) | | calculates the sun position according to the north direction and time zone location set | +| manual_sun | [Scene.SourceInstance.AmbientProperties.ManualSun](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-ManualSun) | | sets the sun position and direction from scene | + + + +### Scene.SourceInstance.AmbientProperties.SunAxisSystem.AutomaticSun + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| time_zone_uri | [string](#string) | | | +| year | [int32](#int32) | | | +| month | [int32](#int32) | | | +| day | [int32](#int32) | | | +| hour | [int32](#int32) | | | +| minute | [int32](#int32) | | | +| longitude | [float](#float) | | | +| latitude | [float](#float) | | | + + + +### Scene.SourceInstance.AmbientProperties.UniformAmbientProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| manual_sun | [Scene.SourceInstance.AmbientProperties.ManualSun](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-ManualSun) | | sets the sun position and direction from scene | + + + +### Scene.SourceInstance.AmbientProperties.UsStandardProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| north_direction | [double](#double) | repeated | (X Y Z) Direction to the North | +| reverse_north | [bool](#bool) | | optional - if not set or false : normal is not reversed | +| sun_axis_system | [Scene.SourceInstance.AmbientProperties.SunAxisSystem](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-SunAxisSystem) | | Set the Sun direction | + + + +### Scene.SourceInstance.DisplayProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the source (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | +| intensity_properties | [Scene.SourceInstance.IntensityProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-IntensityProperties) | | | + + + +### Scene.SourceInstance.IntensityProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| library_properties | [Scene.SourceInstance.IntensityProperties.LibraryProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-IntensityProperties-LibraryProperties) | | To be filled if the intensity_guid of the source template corresponds to an IntensityTemplate of type Library | +| gaussian_properties | [Scene.SourceInstance.IntensityProperties.GaussianProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-IntensityProperties-GaussianProperties) | | To be filled if the intensity_guid of the source template corresponds to an IntensityTemplate of type Gaussian | + + + +### Scene.SourceInstance.IntensityProperties.GaussianProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | optional - orientation of the intensity distribution (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) - if not filled : normal to surface map. If the coordinate system is not orthonormal, it will be automatically orthonormalized | + + + +### Scene.SourceInstance.IntensityProperties.LibraryProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| exit_geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v2-Scene-GeoPaths) | | Exit Geometries that will use this surface source | +| axis_system | [Scene.SourceInstance.IntensityProperties.LibraryProperties.AxisSystem](#ansys-api-speos-scene-v2-Scene-SourceInstance-IntensityProperties-LibraryProperties-AxisSystem) | | orientation (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | +| normal_to_surface | [Scene.SourceInstance.IntensityProperties.LibraryProperties.NormalToSurface](#ansys-api-speos-scene-v2-Scene-SourceInstance-IntensityProperties-LibraryProperties-NormalToSurface) | | Define the intensity distribution as normal to the selected surface. | +| normal_to_uv_map | [Scene.SourceInstance.IntensityProperties.LibraryProperties.NormalToUVMap](#ansys-api-speos-scene-v2-Scene-SourceInstance-IntensityProperties-LibraryProperties-NormalToUVMap) | | Define the intensity distribution as normal to the selected emissive surface and its orientation on the emissive surface. | + + + +### Scene.SourceInstance.IntensityProperties.LibraryProperties.AxisSystem + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [double](#double) | repeated | orientation (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) | + + + +### Scene.SourceInstance.IntensityProperties.LibraryProperties.NormalToSurface +Define the intensity distribution as normal to the selected surface. + + + +### Scene.SourceInstance.IntensityProperties.LibraryProperties.NormalToUVMap +Define the intensity distribution as normal to the selected emissive surface and its orientation on the emissive surface. + + + +### Scene.SourceInstance.LuminaireProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the source (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | + + + +### Scene.SourceInstance.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Scene.SourceInstance.RayFileProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_system | [double](#double) | repeated | Position of the source (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) | +| exit_geometries | [Scene.GeoPaths](#ansys-api-speos-scene-v2-Scene-GeoPaths) | | Exit Geometries that will use this rayfile source | + + + +### Scene.SourceInstance.SurfaceProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| exitance_constant_properties | [Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-SurfaceProperties-ExitanceConstantProperties) | | To be filled if the Surface SourceTemplate has ExitanceConstant | +| exitance_variable_properties | [Scene.SourceInstance.SurfaceProperties.ExitanceVariableProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-SurfaceProperties-ExitanceVariableProperties) | | To be filled if the Surface SourceTemplate has ExitanceVariable | +| intensity_properties | [Scene.SourceInstance.IntensityProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-IntensityProperties) | | | + + + +### Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| geo_paths | [Scene.GeoPath](#ansys-api-speos-scene-v2-Scene-GeoPath) | repeated | | + + + +### Scene.SourceInstance.SurfaceProperties.ExitanceVariableProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_plane | [double](#double) | repeated | Position of the exitance map (Ox Oy Oz Xx Xy Xz Yx Yy Yz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | + + + +### Scene.SourceInstance.ThermicProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| emissive_faces_properties | [Scene.SourceInstance.ThermicProperties.EmissiveFacesProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-ThermicProperties-EmissiveFacesProperties) | | source emits from faces | +| temperature_field_properties | [Scene.SourceInstance.ThermicProperties.TemperatureFieldProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-ThermicProperties-TemperatureFieldProperties) | | a specific OPTTemperature file is required (mesh + triangle temperature in Kelvin) | + + + +### Scene.SourceInstance.ThermicProperties.EmissiveFacesProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| geo_paths | [Scene.GeoPath](#ansys-api-speos-scene-v2-Scene-GeoPath) | repeated | the list of emitting faces of the source | + + + +### Scene.SourceInstance.ThermicProperties.TemperatureFieldProperties + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| axis_plane | [double](#double) | repeated | Position of the exitance map (Ox Oy Oz Xx Xy Xz Yx Yy Yz). If the coordinate system is not orthonormal, it will be automatically orthonormalized | + + + +### Update_Request +Request to update a Scene in ScenesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Scene to be updated | +| scene | [Scene](#ansys-api-speos-scene-v2-Scene) | | Scene that will be used for the update | + + + +### Update_Response + + + + + +### Scene.SensorInstance.EnumRayFileType +Ray file types available + +| Name | Number | Description | +| ---- | ------ | ----------- | +| RayFileNone | 0 | Generates no ray file. | +| RayFileClassic | 1 | Generates a ray file without polarization data. | +| RayFilePolarization | 2 | Generates a ray file with the polarization data for each ray. | +| RayFileTM25 | 3 | Generates a .tm25ray file with polarization data for each ray. | +| RayFileTM25NoPolarization | 4 | Generates a .tm25ray file without polarization data. | + + + +### Scene.SensorInstance.LayerTypeFace.EnumSCAFilteringType + +| Name | Number | Description | +| ---- | ------ | ----------- | +| LastImpact | 0 | | +| IntersectedOneTime | 1 | | + + + +### Scene.SensorInstance.LayerTypeSequence.EnumSequenceType + +| Name | Number | Description | +| ---- | ------ | ----------- | +| Geometries | 0 | | +| Faces | 1 | | + + + + + + + +### SceneActions +Actions available on a Scene + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| LoadFile | [LoadFile_Request](#ansys-api-speos-scene-v2-LoadFile_Request) | [LoadFile_Response](#ansys-api-speos-scene-v2-LoadFile_Response) | Load .speos, .SPEOSLightBox file | +| SaveFile | [SaveFile_Request](#ansys-api-speos-scene-v2-SaveFile_Request) | [SaveFile_Response](#ansys-api-speos-scene-v2-SaveFile_Response) | Save .SPEOSLightBox file. | +| GetSourceRayPaths | [GetSourceRayPaths_Request](#ansys-api-speos-scene-v2-GetSourceRayPaths_Request) | [results.v1.RayPath](#ansys-api-speos-results-v1-RayPath) stream | Get RayPaths generated by a source | + + + +### ScenesManager +Manager for Scenes + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-scene-v2-Create_Request) | [Create_Response](#ansys-api-speos-scene-v2-Create_Response) | Create a Scene | +| Read | [Read_Request](#ansys-api-speos-scene-v2-Read_Request) | [Read_Response](#ansys-api-speos-scene-v2-Read_Response) | Read a Scene | +| Update | [Update_Request](#ansys-api-speos-scene-v2-Update_Request) | [Update_Response](#ansys-api-speos-scene-v2-Update_Response) | Update a Scene | +| Delete | [Delete_Request](#ansys-api-speos-scene-v2-Delete_Request) | [Delete_Response](#ansys-api-speos-scene-v2-Delete_Response) | Delete a Scene | +| List | [List_Request](#ansys-api-speos-scene-v2-List_Request) | [List_Response](#ansys-api-speos-scene-v2-List_Response) | List all Scenes in manager | + + + + + + +## sensor/v1/camera_sensor.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### CameraSensorTemplate + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sensor_mode_geometric | [SensorCameraModeGeometric](#ansys-api-speos-sensor-v1-SensorCameraModeGeometric) | | Sensor mode : Geometric | +| sensor_mode_photometric | [SensorCameraModePhotometric](#ansys-api-speos-sensor-v1-SensorCameraModePhotometric) | | Sensor mode : Photometric | +| focal_length | [double](#double) | | Distance between the center of the optical system and the focus. (mm) | +| imager_distance | [double](#double) | | Imager distance in mm, the imager is located at the focal point. The Imager distance has no impact on the result. | +| f_number | [double](#double) | | F-number represents the aperture of the front lens. F number has no impact on the result. | +| distorsion_file_uri | [string](#string) | | Will be deprecated soon due to typo error - better use distortion_file_uri | +| distortion_file_uri | [string](#string) | | Optical aberration that deforms and bends straight lines. The distortion is expressed in a .OPTDistortion file. | +| horz_pixel | [uint32](#uint32) | | Defines the horizontal pixels number corresponding to the camera resolution. | +| vert_pixel | [uint32](#uint32) | | Defines the vertical pixels number corresponding to the camera resolution. | +| width | [double](#double) | | Defines the sensor's width in mm. | +| height | [double](#double) | | Defines the sensor's height in mm. | + + + +### SensorCameraBalanceModeDisplay +Spectral results are converted in a three-channel result. Then a post-treatment is realized to take the distortion induced by the display devices into account. With this method, displayed results are similar to what the camera really gets. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| red_display_file_uri | [string](#string) | | | +| green_display_file_uri | [string](#string) | | | +| blue_display_file_uri | [string](#string) | | | + + + +### SensorCameraBalanceModeGreyworld +The grey world assumption states that the content of the image is grey on average. This method converts spectral results in a three-channel result with the basic conversion. Then it computes and applies coefficients to the red, green and blue images to make sure their averages are equal. + + + +### SensorCameraBalanceModeNone +The spectral transmittance of the optical system and the spectral sensitivity for each channel are applied to the detected spectral image before the conversion in a three-channel result. This method is referred to as the basic conversion. + + + +### SensorCameraBalanceModeUserwhite +In addition to the basic treatment, it allows you to apply your own coefficients to the red, green, blue images. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| red_gain | [double](#double) | | | +| green_gain | [double](#double) | | | +| blue_gain | [double](#double) | | | + + + +### SensorCameraColorModeColor +Simulation results are available in color according to the White Balance mode. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| red_spectrum_file_uri | [string](#string) | | | +| green_spectrum_file_uri | [string](#string) | | | +| blue_spectrum_file_uri | [string](#string) | | | +| balance_mode_none | [SensorCameraBalanceModeNone](#ansys-api-speos-sensor-v1-SensorCameraBalanceModeNone) | | Balance mode : None | +| balance_mode_greyworld | [SensorCameraBalanceModeGreyworld](#ansys-api-speos-sensor-v1-SensorCameraBalanceModeGreyworld) | | Balance mode : Greyworld | +| balance_mode_userwhite | [SensorCameraBalanceModeUserwhite](#ansys-api-speos-sensor-v1-SensorCameraBalanceModeUserwhite) | | Balance mode : Userwhite | +| balance_mode_display | [SensorCameraBalanceModeDisplay](#ansys-api-speos-sensor-v1-SensorCameraBalanceModeDisplay) | | Balance mode : Display | + + + +### SensorCameraColorModeMonochromatic +Simulation results are available in grey scale. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| spectrum_file_uri | [string](#string) | | | + + + +### SensorCameraModeGeometric +Simplified version of the Camera Sensor definition parameters + + + +### SensorCameraModePhotometric +Allows to set every Camera Sensor parameters, including the photometric definition parameters + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| acquisition_integration | [double](#double) | | Acquisition integration in s | +| acquisition_lag_time | [double](#double) | | Acquisition lag time in s | +| transmittance_file_uri | [string](#string) | | Amount of light of the source that passes through the lens and reaches the sensor. The transmittance is expressed in a .spectrum file. | +| gamma_correction | [float](#float) | | Compensation of the curve before the display on the screen. | +| png_bits | [EnumSensorCameraPNGBits](#ansys-api-speos-sensor-v1-EnumSensorCameraPNGBits) | | Choose between 8, 10, 12 and 16-bit. | +| color_mode_color | [SensorCameraColorModeColor](#ansys-api-speos-sensor-v1-SensorCameraColorModeColor) | | Color mode : Color | +| color_mode_monochromatic | [SensorCameraColorModeMonochromatic](#ansys-api-speos-sensor-v1-SensorCameraColorModeMonochromatic) | | Color mode : Monochromatic | +| wavelengths_range | [WavelengthsRange](#ansys-api-speos-sensor-v1-WavelengthsRange) | | Spectral range to use for simulation. | + + + + + +### EnumSensorCameraPNGBits + +| Name | Number | Description | +| ---- | ------ | ----------- | +| PNG_08 | 0 | | +| PNG_10 | 1 | | +| PNG_12 | 2 | | +| PNG_16 | 3 | | + + + + + + + + + + +## sensor/v1/common.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### AngularRange +Angular range and sampling along two directions. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x_start | [double](#double) | | Start angle along X direction (deg). | +| x_end | [double](#double) | | End angle along X direction (deg). | +| x_sampling | [uint32](#uint32) | | Sampling along X direction. | +| y_start | [double](#double) | | Start angle along Y direction (deg). | +| y_end | [double](#double) | | End angle along Y direction (deg). | +| y_sampling | [uint32](#uint32) | | Sampling along Y direction. | + + + +### ConoscopicIntensityDimensions +Dimensions of the conoscopic intensity sensor + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| theta_max | [double](#double) | | Maximum theta angle (deg). | +| sampling | [uint32](#uint32) | | Number of pixels along Theta. | + + + +### FromSensorLookingAtSource + + + +### FromSourceLookingAtSensor +Intensity result viewing direction + + + +### IlluminanceTypeCylindrical +Illuminance sensor with cylindrical integration type. + + + +### IlluminanceTypeHemispherical +Illuminance sensor with hemispherical integration type. + + + +### IlluminanceTypePlanar +Integration made orthogonally with the sensor plane. + + + +### IlluminanceTypeRadial +Illuminance sensor with radial integration type. + + + +### IlluminanceTypeSemiCylindrical +Illuminance sensor with semi cylindrical integration type. + + + +### IntensityDimensions +Dimensions of the non conoscopic intensity sensor + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x_start | [double](#double) | | Start angle along X direction (deg). | +| x_end | [double](#double) | | End angle along X direction (deg). | +| x_sampling | [uint32](#uint32) | | Number of pixels along X direction. | +| y_start | [double](#double) | | Start angle along Y direction (deg). | +| y_end | [double](#double) | | End angle along Y direction (deg). | +| y_sampling | [uint32](#uint32) | | Number of pixels along Y direction. | + + + +### IntensityOrientationConoscopic +The sensor considers conoscopic orientation. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| conoscopic_intensity_dimensions | [ConoscopicIntensityDimensions](#ansys-api-speos-sensor-v1-ConoscopicIntensityDimensions) | | Dimensions for non conoscopic sensor | + + + +### IntensityOrientationXAsMeridian +The sensor considers X direction as meridian and Y direction as parallel. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| intensity_dimensions | [IntensityDimensions](#ansys-api-speos-sensor-v1-IntensityDimensions) | | Dimensions for non conoscopic sensor | + + + +### IntensityOrientationXAsParallel +The sensor considers X direction as parallel and Y direction as meridian. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| intensity_dimensions | [IntensityDimensions](#ansys-api-speos-sensor-v1-IntensityDimensions) | | Dimensions for non conoscopic sensor | + + + +### PolarIntensityDimensions +Dimensions of the conoscopic intensity sensor + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| horizontal_sampling | [int32](#int32) | | Number of horizontal samples of the intensity file (IESNA or EULUMDAT). | +| vertical_sampling | [int32](#int32) | | Number of vertical samples of the intensity file (IESNA or EULUMDAT). | + + + +### PolarIntensityEulumdat +The polar intensity sensor generates an Eulumdat file. + + + +### PolarIntensityIesnaA +The polar intensity sensor generates an Iesna A type file. + + + +### PolarIntensityIesnaB +The polar intensity sensor generates an Iesna B type file. + + + +### PolarIntensityIesnaC +The polar intensity sensor generates an Iesna C type file. + + + +### SensorDimensions +Dimensions of the sensor + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x_start | [double](#double) | | Start distance from center along X direction (mm). | +| x_end | [double](#double) | | End distance from center along X direction (mm). | +| x_sampling | [uint32](#uint32) | | Number of pixels along X direction. | +| y_start | [double](#double) | | Start distance from center along Y direction (mm). | +| y_end | [double](#double) | | End distance from center along Y direction (mm). | +| y_sampling | [uint32](#uint32) | | Number of pixels along Y direction. | + + + +### SensorNearField +Near field intensity or polar intensity sensor + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cell_distance | [double](#double) | | Distance of the cell from the center of the intensity sensor (mm). | +| cell_integration_angle | [double](#double) | | Integration angle of the cell (deg). Used with cell_distance to calculate the cell diameter. | + + + +### SensorTypeColorimetric +Color results without any spectral data or layer separation. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wavelengths_range | [WavelengthsRange](#ansys-api-speos-sensor-v1-WavelengthsRange) | | Spectral range to use for simulation. | + + + +### SensorTypePhotometric +The sensor considers the visible spectrum and gets the results. + + + +### SensorTypeRadiometric +The sensor considers the entire spectrum and gets the results. + + + +### SensorTypeSpectral +Color results and spectral data separated by wavelength. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wavelengths_range | [WavelengthsRange](#ansys-api-speos-sensor-v1-WavelengthsRange) | | Spectral range to use for simulation. | + + + +### WavelengthsRange +Spectral range to use for simulation. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| w_start | [double](#double) | | Defines the minimum wavelength. (nm) | +| w_end | [double](#double) | | Defines the maximum wavelength. (nm) | +| w_sampling | [uint32](#uint32) | | Defines the number of wavelengths to be taken into account between the minimum and maximum wavelengths set. | + + + + + + + + + + + + +## sensor/v1/irradiance_sensor.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### IrradianceSensorTemplate + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sensor_type_photometric | [SensorTypePhotometric](#ansys-api-speos-sensor-v1-SensorTypePhotometric) | | Sensor type : Photometric | +| sensor_type_colorimetric | [SensorTypeColorimetric](#ansys-api-speos-sensor-v1-SensorTypeColorimetric) | | Sensor type : Colorimetric | +| sensor_type_radiometric | [SensorTypeRadiometric](#ansys-api-speos-sensor-v1-SensorTypeRadiometric) | | Sensor type : Radiometric | +| sensor_type_spectral | [SensorTypeSpectral](#ansys-api-speos-sensor-v1-SensorTypeSpectral) | | Sensor type : Spectral | +| illuminance_type_planar | [IlluminanceTypePlanar](#ansys-api-speos-sensor-v1-IlluminanceTypePlanar) | | Illuminance type : Planar | +| illuminance_type_radial | [IlluminanceTypeRadial](#ansys-api-speos-sensor-v1-IlluminanceTypeRadial) | | Illuminance type : Radial | +| illuminance_type_hemispherical | [IlluminanceTypeHemispherical](#ansys-api-speos-sensor-v1-IlluminanceTypeHemispherical) | | Illuminance type : Hemispherical | +| illuminance_type_cylindrical | [IlluminanceTypeCylindrical](#ansys-api-speos-sensor-v1-IlluminanceTypeCylindrical) | | Illuminance type : Cylindrical | +| illuminance_type_semi_cylindrical | [IlluminanceTypeSemiCylindrical](#ansys-api-speos-sensor-v1-IlluminanceTypeSemiCylindrical) | | Illuminance type : SemiCylindrical | +| dimensions | [SensorDimensions](#ansys-api-speos-sensor-v1-SensorDimensions) | | Dimensions of the sensor | + + + + + + + + + + + + +## sensor/v1/sensor.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Create_Request +Request to create a SensorTemplate in SensorTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sensor_template | [SensorTemplate](#ansys-api-speos-sensor-v1-SensorTemplate) | | SensorTemplate containing its basic characteristics | +| guid | [string](#string) | optional | Optional field to specify the guid used in the database. If not set, a unique guid will be generated for that entry and sent back in the Create_Response. | + + + +### Create_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SensorTemplate created in SensorTemplatesManager | + + + +### Delete_Request +Request to delete a SensorTemplate in SensorTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SensorTemplate to be deleted | + + + +### Delete_Response + + + +### List_Request + + + +### List_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of the SensorTemplates in SensorTemplatesManager | + + + +### Read_Request +Request to read a SensorTemplate in SensorTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SensorTemplate to be read | + + + +### Read_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sensor_template | [SensorTemplate](#ansys-api-speos-sensor-v1-SensorTemplate) | | SensorTemplate corresponding to the guid given in Read_Request | + + + +### SensorTemplate +Sensor template with its basic characteristics + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | SensorTemplate name | +| description | [string](#string) | | SensorTemplate description | +| metadata | [SensorTemplate.MetadataEntry](#ansys-api-speos-sensor-v1-SensorTemplate-MetadataEntry) | repeated | User defined metadata | +| camera_sensor_template | [CameraSensorTemplate](#ansys-api-speos-sensor-v1-CameraSensorTemplate) | | | +| irradiance_sensor_template | [IrradianceSensorTemplate](#ansys-api-speos-sensor-v1-IrradianceSensorTemplate) | | | +| radiance_sensor_template | [SensorTemplate.Radiance](#ansys-api-speos-sensor-v1-SensorTemplate-Radiance) | | | +| intensity_sensor_template | [SensorTemplate.Intensity](#ansys-api-speos-sensor-v1-SensorTemplate-Intensity) | | | +| polar_intensity_sensor_template | [SensorTemplate.PolarIntensity](#ansys-api-speos-sensor-v1-SensorTemplate-PolarIntensity) | | | +| irradiance_3d | [SensorTemplate.Irradiance3D](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D) | | | +| observer_sensor_template | [SensorTemplate.Observer](#ansys-api-speos-sensor-v1-SensorTemplate-Observer) | | | +| immersive_sensor_template | [SensorTemplate.Immersive](#ansys-api-speos-sensor-v1-SensorTemplate-Immersive) | | | + + + +### SensorTemplate.Immersive + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sampling | [uint32](#uint32) | | Sampling (horizontal and vertical number of pixels) for a face. | +| stereo | [SensorTemplate.Stereo](#ansys-api-speos-sensor-v1-SensorTemplate-Stereo) | | Activates stereo. When not set, stereo is disabled for the sensor. | +| integration_angle | [double](#double) | | Integration angle in degrees for direct simulations. | +| wavelengths_range | [WavelengthsRange](#ansys-api-speos-sensor-v1-WavelengthsRange) | | Spectral range to use for simulation. | +| exclude_faces | [SensorTemplate.Immersive.ExcludeFaces](#ansys-api-speos-sensor-v1-SensorTemplate-Immersive-ExcludeFaces) | | Possibility to exclude some faces. | + + + +### SensorTemplate.Immersive.ExcludeFaces + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| front | [bool](#bool) | | Exclude front face if true. | +| back | [bool](#bool) | | Exclude back face if true. | +| left | [bool](#bool) | | Exclude left face if true. | +| right | [bool](#bool) | | Exclude right face if true. | +| top | [bool](#bool) | | Exclude top face if true. | +| bottom | [bool](#bool) | | Exclude bottom face if true. | + + + +### SensorTemplate.Intensity +Carthesian intensity sensor, generating a XMP result + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sensor_type_photometric | [SensorTypePhotometric](#ansys-api-speos-sensor-v1-SensorTypePhotometric) | | Sensor type: Photometric | +| sensor_type_colorimetric | [SensorTypeColorimetric](#ansys-api-speos-sensor-v1-SensorTypeColorimetric) | | Sensor type: Colorimetric | +| sensor_type_radiometric | [SensorTypeRadiometric](#ansys-api-speos-sensor-v1-SensorTypeRadiometric) | | Sensor type: Radiometric | +| sensor_type_spectral | [SensorTypeSpectral](#ansys-api-speos-sensor-v1-SensorTypeSpectral) | | Sensor type: Spectral | +| intensity_orientation_x_as_meridian | [IntensityOrientationXAsMeridian](#ansys-api-speos-sensor-v1-IntensityOrientationXAsMeridian) | | Orientation type: X As Meridian, Y as Parallel | +| intensity_orientation_x_as_parallel | [IntensityOrientationXAsParallel](#ansys-api-speos-sensor-v1-IntensityOrientationXAsParallel) | | Orientation type: X As Parallel, Y as Meridian | +| intensity_orientation_conoscopic | [IntensityOrientationConoscopic](#ansys-api-speos-sensor-v1-IntensityOrientationConoscopic) | | Orientation type: Conoscopic | +| near_field | [SensorNearField](#ansys-api-speos-sensor-v1-SensorNearField) | | Activates Near field. When not set, near field is disabled for the sensor | +| from_source_looking_at_sensor | [FromSourceLookingAtSensor](#ansys-api-speos-sensor-v1-FromSourceLookingAtSensor) | | Viewing direction from source looking at sensor | +| from_sensor_looking_at_source | [FromSensorLookingAtSource](#ansys-api-speos-sensor-v1-FromSensorLookingAtSource) | | Viewing direction from sensor looking at source | + + + +### SensorTemplate.Irradiance3D + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type_photometric | [SensorTemplate.Irradiance3D.TypePhotometric](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-TypePhotometric) | | Sensor type : Photometric | +| type_colorimetric | [SensorTemplate.Irradiance3D.TypeColorimetric](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-TypeColorimetric) | | Sensor type : Colorimetric | +| type_radiometric | [SensorTemplate.Irradiance3D.TypeRadiometric](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-TypeRadiometric) | | Sensor type : Radiometric | + + + +### SensorTemplate.Irradiance3D.IntegrationTypePlanar +Integration made orthogonally with the sensor plane. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| reflection | [bool](#bool) | | Reflection is taking into account for the integrating faces of the sensor. | +| transmission | [bool](#bool) | | Transmission is taking into account for the integrating faces of the sensor. | +| absorption | [bool](#bool) | | Absorption is taking into account for the integrating faces of the sensor. | + + + +### SensorTemplate.Irradiance3D.IntegrationTypeRadial + + + +### SensorTemplate.Irradiance3D.TypeColorimetric +Color results without any spectral data or layer separation (in lx or W//m2). + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wavelength_start | [double](#double) | | (nm) | +| wavelength_end | [double](#double) | | (nm) | +| integration_type | [SensorTemplate.Irradiance3D.TypeColorimetric.IntegrationType](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-TypeColorimetric-IntegrationType) | | will determine the integration type of the sensor between radial and planar | + + + +### SensorTemplate.Irradiance3D.TypePhotometric +The sensor considers the visible spectrum and gets the results in lm/m2 or lx. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| integration_type_radial | [SensorTemplate.Irradiance3D.IntegrationTypeRadial](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-IntegrationTypeRadial) | | Integration type : Radial | +| integration_type_planar | [SensorTemplate.Irradiance3D.IntegrationTypePlanar](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-IntegrationTypePlanar) | | Integration type : Planar | + + + +### SensorTemplate.Irradiance3D.TypeRadiometric +The sensor considers the entire spectrum and gets the results in W/m2. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| integration_type_radial | [SensorTemplate.Irradiance3D.IntegrationTypeRadial](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-IntegrationTypeRadial) | | Integration type : Radial | +| integration_type_planar | [SensorTemplate.Irradiance3D.IntegrationTypePlanar](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-IntegrationTypePlanar) | | Integration type : Planar | + + + +### SensorTemplate.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### SensorTemplate.Observer + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| focal | [double](#double) | | Distance between the sensor radiance plan and the observer point. The larger the focal, the closer to the object. (mm) | +| integration_angle | [double](#double) | | Integration angle in degrees for direct simulations. | +| wavelengths_range | [WavelengthsRange](#ansys-api-speos-sensor-v1-WavelengthsRange) | | Spectral range to use for simulation. | +| dimensions | [SensorDimensions](#ansys-api-speos-sensor-v1-SensorDimensions) | | Dimensions of the sensor. | +| stereo | [SensorTemplate.Stereo](#ansys-api-speos-sensor-v1-SensorTemplate-Stereo) | | Activates stereo. When not set, stereo is disabled for the sensor. | +| distance | [double](#double) | | Radius of the sphere on which the sensors will be placed. (mm) | +| sensors_locations | [AngularRange](#ansys-api-speos-sensor-v1-AngularRange) | | Locations of the sensors on the sphere. X corresponds to Horizontal direction. Y corresponds to Vertical direction. | + + + +### SensorTemplate.PolarIntensity + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| iesna_a | [PolarIntensityIesnaA](#ansys-api-speos-sensor-v1-PolarIntensityIesnaA) | | Sensor format: Iesna A type | +| iesna_b | [PolarIntensityIesnaB](#ansys-api-speos-sensor-v1-PolarIntensityIesnaB) | | Sensor format: Iesna B type | +| iesna_c | [PolarIntensityIesnaC](#ansys-api-speos-sensor-v1-PolarIntensityIesnaC) | | Sensor format: Iesna C type | +| eulumdat | [PolarIntensityEulumdat](#ansys-api-speos-sensor-v1-PolarIntensityEulumdat) | | Sensor format: Eulumdat | +| dimensions | [PolarIntensityDimensions](#ansys-api-speos-sensor-v1-PolarIntensityDimensions) | | Horizontal and vertical samplings. Dimensions are fixed by the format or the adaptive sampling file | +| adaptive_sampling_uri | [string](#string) | | Path to the adaptive sampling file | +| far_field | [SensorTemplate.PolarIntensity.SensorFarField](#ansys-api-speos-sensor-v1-SensorTemplate-PolarIntensity-SensorFarField) | | Far field, only used when near field is disabled for the sensor. It permits to set the integration angle. | +| near_field | [SensorNearField](#ansys-api-speos-sensor-v1-SensorNearField) | | Near field parameters: cell distance and diameter. Integration angle needs to be calculated from these parameters. | + + + +### SensorTemplate.PolarIntensity.SensorFarField + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| integration_angle | [double](#double) | | Integration angle (deg) | + + + +### SensorTemplate.Radiance + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sensor_type_photometric | [SensorTypePhotometric](#ansys-api-speos-sensor-v1-SensorTypePhotometric) | | Sensor type : Photometric | +| sensor_type_colorimetric | [SensorTypeColorimetric](#ansys-api-speos-sensor-v1-SensorTypeColorimetric) | | Sensor type : Colorimetric | +| sensor_type_radiometric | [SensorTypeRadiometric](#ansys-api-speos-sensor-v1-SensorTypeRadiometric) | | Sensor type : Radiometric | +| sensor_type_spectral | [SensorTypeSpectral](#ansys-api-speos-sensor-v1-SensorTypeSpectral) | | Sensor type : Spectral | +| focal | [double](#double) | | Observer type : focal (mm) | +| integration_angle | [double](#double) | | Integration angle, in degree | +| dimensions | [SensorDimensions](#ansys-api-speos-sensor-v1-SensorDimensions) | | Dimensions of the sensor | + + + +### SensorTemplate.Stereo + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| interocular_distance | [double](#double) | | distance between viewpoints in mm. To use, make sure that front direction is horizontal and top vertical | + + + +### Update_Request +Request to update a SensorTemplate in SensorTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SensorTemplate to be updated | +| sensor_template | [SensorTemplate](#ansys-api-speos-sensor-v1-SensorTemplate) | | SensorTemplate that will be used for the update | + + + +### Update_Response + + + + + +### SensorTemplate.Irradiance3D.TypeColorimetric.IntegrationType +Defines how the illuminance is integrated in the sensor + +| Name | Number | Description | +| ---- | ------ | ----------- | +| Radial | 0 | Integration type : Radial | +| Planar | 1 | Integration type : Planar | + + + + + + + +### SensorTemplatesManager + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-sensor-v1-Create_Request) | [Create_Response](#ansys-api-speos-sensor-v1-Create_Response) | Create a SensorTemplate | +| Read | [Read_Request](#ansys-api-speos-sensor-v1-Read_Request) | [Read_Response](#ansys-api-speos-sensor-v1-Read_Response) | Read a SensorTemplate | +| Update | [Update_Request](#ansys-api-speos-sensor-v1-Update_Request) | [Update_Response](#ansys-api-speos-sensor-v1-Update_Response) | Update a SensorTemplate | +| Delete | [Delete_Request](#ansys-api-speos-sensor-v1-Delete_Request) | [Delete_Response](#ansys-api-speos-sensor-v1-Delete_Response) | Delete a SensorTemplate | +| List | [List_Request](#ansys-api-speos-sensor-v1-List_Request) | [List_Response](#ansys-api-speos-sensor-v1-List_Response) | List all SensorTemplates in manager | + + + + + + +## server_info/v1/server_info.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### GetVersion_Request + + + +### GetVersion_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| version | [string](#string) | | Version of the server. Format: "major.minor.patch.build". Example "2025.2.1.31394". | + + + + + + + + + +### ServerInfo + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetVersion | [GetVersion_Request](#ansys-api-speos-server_info-v1-GetVersion_Request) | [GetVersion_Response](#ansys-api-speos-server_info-v1-GetVersion_Response) | Get the server version | + + + + + + +## simulation/v1/simulation_template.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Create_Request +Request to create a SimulationTemplate in SimulationTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| simulation_template | [SimulationTemplate](#ansys-api-speos-simulation-v1-templates-SimulationTemplate) | | SimulationTemplate containing its basic characteristics | +| guid | [string](#string) | optional | Optional field to specify the guid used in the database. If not set, a unique guid will be generated for that entry and sent back in the Create_Response. | + + + +### Create_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SimulationTemplate created in SimulationTemplatesManager | + + + +### Delete_Request +Request to delete a SimulationTemplate in SimulationTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SimulationTemplate to be deleted | + + + +### Delete_Response + + + +### DirectMCSimulationTemplate + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| geom_distance_tolerance | [double](#double) | | Maximum distance in mm to consider two faces as tangent | +| max_impact | [int32](#int32) | | To define a value to determine the maximum number of ray impacts during propagation. When a ray has interacted N times with the geometry, the propagation of the ray stops. | +| weight | [Weight](#ansys-api-speos-simulation-v1-templates-Weight) | | To activate Weight. The Weight represents the ray energy. In real life, a ray looses some energy (power) when it interacts with an object. | +| colorimetric_standard | [EnumColorimetricStandard](#ansys-api-speos-simulation-v1-templates-EnumColorimetricStandard) | | To define the Colorimetric Standard | +| dispersion | [bool](#bool) | | To activate the dispersion calculation. | +| fast_transmission_gathering | [bool](#bool) | | To accelerate the simulation by neglecting the light refraction that occurs when the light is being transmitted through a transparent surface. | +| ambient_material_uri | [string](#string) | | To select an ambient material *.material | +| texture | [Texture](#ansys-api-speos-simulation-v1-templates-Texture) | | To activate texture. | + + + +### InverseMCSimulationTemplate + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| geom_distance_tolerance | [double](#double) | | Maximum distance in mm to consider two faces as tangent. | +| max_impact | [int32](#int32) | | To define a value to determine the maximum number of ray impacts during propagation. When a ray has interacted N times with the geometry, the propagation of the ray stops. | +| weight | [Weight](#ansys-api-speos-simulation-v1-templates-Weight) | | To activate Weight. The Weight represents the ray energy. In real life, a ray looses some energy (power) when it interacts with an object. | +| colorimetric_standard | [EnumColorimetricStandard](#ansys-api-speos-simulation-v1-templates-EnumColorimetricStandard) | | To define the Colorimetric Standard | +| dispersion | [bool](#bool) | | To activate the dispersion calculation. | +| splitting | [bool](#bool) | | To split each propagated ray into several paths at their first impact after leaving the observer point. | +| number_of_gathering_rays_per_source | [uint32](#uint32) | | This number pilots the number of shadow rays to target at each source. | +| maximum_gathering_error | [uint32](#uint32) | | Deprecated - Better use maximum_gathering_error_percentage. | +| maximum_gathering_error_percentage | [double](#double) | | This value defines the level below which a source can be neglected. 0, the default value means that no approximation will be done. | +| fast_transmission_gathering | [bool](#bool) | | To accelerate the simulation by neglecting the light refraction that occurs when the light is being transmitted through a transparent surface. | +| ambient_material_uri | [string](#string) | | To select an ambient material *.material | +| texture | [Texture](#ansys-api-speos-simulation-v1-templates-Texture) | | To activate texture. | + + + +### List_Request + + + +### List_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of the SimulationTemplates in SimulationTemplatesManager | + + + +### Read_Request +Request to read a SimulationTemplate in SimulationTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SimulationTemplate to be read | + + + +### Read_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| simulation_template | [SimulationTemplate](#ansys-api-speos-simulation-v1-templates-SimulationTemplate) | | SimulationTemplate corresponding to the guid given in Read_Request | + + + +### SimulationTemplate +Simulation template with its basic characteristics + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Simulation name | +| description | [string](#string) | | Simulation description | +| metadata | [SimulationTemplate.MetadataEntry](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-MetadataEntry) | repeated | User defined metadata | +| direct_mc_simulation_template | [DirectMCSimulationTemplate](#ansys-api-speos-simulation-v1-templates-DirectMCSimulationTemplate) | | | +| inverse_mc_simulation_template | [InverseMCSimulationTemplate](#ansys-api-speos-simulation-v1-templates-InverseMCSimulationTemplate) | | | +| interactive_simulation_template | [SimulationTemplate.Interactive](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-Interactive) | | | +| virtual_bsdf_bench_simulation_template | [SimulationTemplate.VirtualBSDFBench](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench) | | | + + + +### SimulationTemplate.Interactive + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| geom_distance_tolerance | [double](#double) | | Maximum distance in mm to consider two faces as tangent. | +| max_impact | [int32](#int32) | | Defines a value to determine the maximum number of ray impacts during propagation. When a ray has interacted N times with the geometry, the propagation of the ray stops. | +| weight | [Weight](#ansys-api-speos-simulation-v1-templates-Weight) | | Activates Weight. Highly recommended to fill | +| colorimetric_standard | [EnumColorimetricStandard](#ansys-api-speos-simulation-v1-templates-EnumColorimetricStandard) | | Default Colorimetric Standard | +| ambient_material_uri | [string](#string) | | To define the environment in which the light will propagate (water, fog, smoke etc.). It is expressed in a .material file | +| texture | [Texture](#ansys-api-speos-simulation-v1-templates-Texture) | | To activate texture. | + + + +### SimulationTemplate.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### SimulationTemplate.VirtualBSDFBench +Virtual BSDF Bench + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| geom_distance_tolerance | [double](#double) | | Maximum distance in mm to consider two faces as tangent. | +| max_impact | [int32](#int32) | | Defines a value to determine the maximum number of ray impacts during propagation. When a ray has interacted N times with the geometry, the propagation of the ray stops. | +| weight | [Weight](#ansys-api-speos-simulation-v1-templates-Weight) | | Activates Weight. It is highly recommended to activate. | +| colorimetric_standard | [EnumColorimetricStandard](#ansys-api-speos-simulation-v1-templates-EnumColorimetricStandard) | | Default Colorimetric Standard | +| texture | [Texture](#ansys-api-speos-simulation-v1-templates-Texture) | | Activates texture. | +| roughness_only | [SimulationTemplate.VirtualBSDFBench.RoughnessOnly](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-RoughnessOnly) | | BSDF depends on surface roughness only | +| all_characteristics | [SimulationTemplate.VirtualBSDFBench.AllCharacteristics](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-AllCharacteristics) | | BSDF depends on all properties | +| wavelengths_range | [sensor.v1.WavelengthsRange](#ansys-api-speos-sensor-v1-WavelengthsRange) | | | +| sensor | [SimulationTemplate.VirtualBSDFBench.Sensor](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-Sensor) | | Sensor definition | + + + +### SimulationTemplate.VirtualBSDFBench.AllCharacteristics + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| is_bsdf180 | [bool](#bool) | | Corresponds to the parameter "BSDF depends on light incidence side". When set to true, the Theta sampling for the source is defined on [0,180] instead of [0,90]. | +| iridescence | [SimulationTemplate.VirtualBSDFBench.AllCharacteristics.Iridescence](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-AllCharacteristics-Iridescence) | | Color depends on viewing direction | +| no_iridescence | [SimulationTemplate.VirtualBSDFBench.AllCharacteristics.NoIridescence](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-AllCharacteristics-NoIridescence) | | Color does not depend on viewing direction | +| sensor_reflection_and_transmission | [bool](#bool) | | When set to true, it measures the reflection and transmission (theta in [0,180]). When set to false, it measures the reflection only (theta in [0,90]). | + + + +### SimulationTemplate.VirtualBSDFBench.AllCharacteristics.Iridescence + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uniform_isotropic | [SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformIsotropic](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-SourceSamplingUniformIsotropic) | | | +| adaptive | [SimulationTemplate.VirtualBSDFBench.SourceSamplingAdaptive](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-SourceSamplingAdaptive) | | | + + + +### SimulationTemplate.VirtualBSDFBench.AllCharacteristics.NoIridescence + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| isotropic | [SimulationTemplate.VirtualBSDFBench.AllCharacteristics.NoIridescence.Isotropic](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-AllCharacteristics-NoIridescence-Isotropic) | | | +| anisotropic | [SimulationTemplate.VirtualBSDFBench.AllCharacteristics.NoIridescence.Anisotropic](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-AllCharacteristics-NoIridescence-Anisotropic) | | | + + + +### SimulationTemplate.VirtualBSDFBench.AllCharacteristics.NoIridescence.Anisotropic + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uniform_anisotropic | [SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformAnisotropic](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-SourceSamplingUniformAnisotropic) | | | +| adaptive | [SimulationTemplate.VirtualBSDFBench.SourceSamplingAdaptive](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-SourceSamplingAdaptive) | | | + + + +### SimulationTemplate.VirtualBSDFBench.AllCharacteristics.NoIridescence.Isotropic + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uniform_isotropic | [SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformIsotropic](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-SourceSamplingUniformIsotropic) | | | +| adaptive | [SimulationTemplate.VirtualBSDFBench.SourceSamplingAdaptive](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-SourceSamplingAdaptive) | | | + + + +### SimulationTemplate.VirtualBSDFBench.RoughnessOnly + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uniform_isotropic | [SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformIsotropic](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-SourceSamplingUniformIsotropic) | | oneof with adaptive | +| adaptive | [SimulationTemplate.VirtualBSDFBench.SourceSamplingAdaptive](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-SourceSamplingAdaptive) | | | + + + +### SimulationTemplate.VirtualBSDFBench.Sensor + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| integration_angle | [double](#double) | | | +| uniform | [SimulationTemplate.VirtualBSDFBench.Sensor.SensorSamplingUniform](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-Sensor-SensorSamplingUniform) | | | +| automatic | [SimulationTemplate.VirtualBSDFBench.Sensor.SensorSamplingAutomatic](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-Sensor-SensorSamplingAutomatic) | | | + + + +### SimulationTemplate.VirtualBSDFBench.Sensor.SensorSamplingAutomatic + + + +### SimulationTemplate.VirtualBSDFBench.Sensor.SensorSamplingUniform + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| theta_sampling | [uint32](#uint32) | | Number of samples created along the polar angle Theta (around the normal Z-axis) in the range [0,90] degrees. Each sample represents the position of the sensor on Theta. | +| phi_sampling | [uint32](#uint32) | | Number of samples created along the azimuthal angle Phi (around the X-axis). Each sample represents the position of the sensor on Phi. | + + + +### SimulationTemplate.VirtualBSDFBench.SourceSamplingAdaptive + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_uri | [string](#string) | | uri of incident sampling file | + + + +### SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformAnisotropic + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| theta_sampling | [uint32](#uint32) | | Number of samples created along the polar angle Theta (around the normal Z-axis) in the range [0,90] degrees, with a minimum value of 2 degrees. Each sample represents the position of the source on Theta. | +| phi_sampling | [uint32](#uint32) | | Number of samples created along the azimuthal angle Phi (around the X-axis). Each sample represents the position of the source on Phi. | +| symmetry_type | [SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformAnisotropic.PhiSymmetry](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-SourceSamplingUniformAnisotropic-PhiSymmetry) | | Define symmetry type. Not needed if there is no symmetry in measure. | + + + +### SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformIsotropic + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| theta_sampling | [uint32](#uint32) | | Number of samples created along the polar angle Theta (around the normal Z-axis) in the range [0,90] degrees, with a minimum value of 2 degrees. Each sample represents the position of the source on Theta. | + + + +### Texture +If texture has been applied in the scene, fill Texture message. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| texture_normalization | [Texture.TextureNormalization](#ansys-api-speos-simulation-v1-templates-Texture-TextureNormalization) | | Rendering of the texture. | +| normal_map | [bool](#bool) | | To activate normal map. | + + + +### Update_Request +Request to update a SimulationTemplate in SimulationTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SimulationTemplate to be updated | +| simulation_template | [SimulationTemplate](#ansys-api-speos-simulation-v1-templates-SimulationTemplate) | | SimulationTemplate that will be used for the update | + + + +### Update_Response + + + +### Weight +The Weight represents the ray energy. In real life, a ray looses some energy (power) when it interacts with an object. +Activating weight means that the Weight message is present. +When weight is not activated, rays' energy stays constant and probability laws dictate if rays continue or stop propagating. +When weight is activated, rays' energy evolves with interactions until rays reach the sensors. +It is highly recommended to activate Weight, except in Interactive simulation. +Not activating Weight is useful to understand certain phenomena as absorption. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| minimum_energy_percentage | [double](#double) | | The Minimum energy percentage parameter defines the minimum energy ratio to continue to propagate a ray with weight. 1 = 100%. | + + + + + +### EnumColorimetricStandard +Default Colorimetric Standard + +| Name | Number | Description | +| ---- | ------ | ----------- | +| CIE_1931 | 0 | 2 degrees CIE Standard Colorimetric Observer Data. | +| CIE_1964 | 1 | 10 degrees CIE Standard Colorimetric Observer Data. | + + + +### SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformAnisotropic.PhiSymmetry + +| Name | Number | Description | +| ---- | ------ | ----------- | +| PHI_SYMMETRY_UNSPECIFIED | 0 | | +| PHI_SYMMETRY_NONE | 1 | | +| PHI_SYMMETRY_1_PLANE | 2 | Symmetry to plane 0 - 180 | +| PHI_SYMMETRY_2_PLANES | 3 | Symmetry to planes 0 - 180 and 90 - 270 | + + + +### Texture.TextureNormalization + +| Name | Number | Description | +| ---- | ------ | ----------- | +| TEXTURE_NORMALIZATION_UNSPECIFIED | 0 | | +| TEXTURE_NORMALIZATION_NONE | 1 | The simulation result uses both the image texture and the texture mapping optical properties. | +| TEXTURE_NORMALIZATION_COLOR_FROM_TEXTURE | 2 | The simulation result uses the color and the color lightness of the image texture. | +| TEXTURE_NORMALIZATION_COLOR_FROM_BSDF | 3 | The simulation result uses the BSDF information of the texture mapping optical properties. | + + + + + + + +### SimulationTemplatesManager + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-simulation-v1-templates-Create_Request) | [Create_Response](#ansys-api-speos-simulation-v1-templates-Create_Response) | Create a SimulationTemplate | +| Read | [Read_Request](#ansys-api-speos-simulation-v1-templates-Read_Request) | [Read_Response](#ansys-api-speos-simulation-v1-templates-Read_Response) | Read a SimulationTemplate | +| Update | [Update_Request](#ansys-api-speos-simulation-v1-templates-Update_Request) | [Update_Response](#ansys-api-speos-simulation-v1-templates-Update_Response) | Update a SimulationTemplate | +| Delete | [Delete_Request](#ansys-api-speos-simulation-v1-templates-Delete_Request) | [Delete_Response](#ansys-api-speos-simulation-v1-templates-Delete_Response) | Delete a SimulationTemplate | +| List | [List_Request](#ansys-api-speos-simulation-v1-templates-List_Request) | [List_Response](#ansys-api-speos-simulation-v1-templates-List_Response) | List all SimulationTemplates in manager | + + + + + + +## sop/v1/sop.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Create_Request +Request to create a SOPTemplate in SOPTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sop_template | [SOPTemplate](#ansys-api-speos-sop-v1-SOPTemplate) | | SOPTemplate containing its basic characteristics | +| guid | [string](#string) | optional | Optional field to specify the guid used in the database. If not set, a unique guid will be generated for that entry and sent back in the Create_Response. | + + + +### Create_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SOPTemplate created in SOPTemplatesManager | + + + +### Delete_Request +Request to delete a SOPTemplate in SOPTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SOPTemplate to be deleted | + + + +### Delete_Response + + + +### List_Request + + + +### List_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of the SOPTemplates in SOPTemplatesManager | + + + +### Read_Request +Request to read a SOPTemplate in SOPTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SOPTemplate to be read | + + + +### Read_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sop_template | [SOPTemplate](#ansys-api-speos-sop-v1-SOPTemplate) | | SOPTemplate corresponding to the guid given in Read_Request | + + + +### SOPTemplate +SOP: Surface Optical Properties +Defines the behavior of light rays when they hit the surface of a body. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | SOPTemplate name | +| description | [string](#string) | | SOPTemplate description | +| metadata | [SOPTemplate.MetadataEntry](#ansys-api-speos-sop-v1-SOPTemplate-MetadataEntry) | repeated | User defined metadata | +| mirror | [SOPTemplate.Mirror](#ansys-api-speos-sop-v1-SOPTemplate-Mirror) | | Perfect specular surface | +| optical_polished | [SOPTemplate.OpticalPolished](#ansys-api-speos-sop-v1-SOPTemplate-OpticalPolished) | | Transparent or perfectly polished material (glass, plastic) | +| library | [SOPTemplate.Library](#ansys-api-speos-sop-v1-SOPTemplate-Library) | | Based on surface optical properties file | +| plugin | [SOPTemplate.Plugin](#ansys-api-speos-sop-v1-SOPTemplate-Plugin) | | Custom made plug-in | +| texture | [SOPTemplate.Texture](#ansys-api-speos-sop-v1-SOPTemplate-Texture) | | Define to activate texture - optional | + + + +### SOPTemplate.Library + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sop_file_uri | [string](#string) | | Surface optical properties file, *.scattering, *.bsdf, *.brdf, *.coated, ... | + + + +### SOPTemplate.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### SOPTemplate.Mirror +Perfect specular surface + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| reflectance | [double](#double) | | Reflectance, expected from 0. to 100. in % | + + + +### SOPTemplate.OpticalPolished +Transparent or perfectly polished material (glass, plastic) + + + +### SOPTemplate.Plugin +Custom made plug-in + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| plugin_sop_file_uri | [string](#string) | | .sop plug-in | +| parameters_file_uri | [string](#string) | | parameters file needed for the plug-in | + + + +### SOPTemplate.Texture +Activate texture + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| image | [SOPTemplate.Texture.Image](#ansys-api-speos-sop-v1-SOPTemplate-Texture-Image) | | | +| normal_map | [SOPTemplate.Texture.NormalMap](#ansys-api-speos-sop-v1-SOPTemplate-Texture-NormalMap) | | | + + + +### SOPTemplate.Texture.Image + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| bitmap_file_uri | [string](#string) | | Bitmap | +| repeat_along_u | [bool](#bool) | | Activate/deactivate the repeatability of the texture image on U axe. | +| repeat_along_v | [bool](#bool) | | Activate/deactivate the repeatability of the texture image on V axe. | + + + +### SOPTemplate.Texture.NormalMap + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| from_image | [SOPTemplate.Texture.NormalMap.FromImage](#ansys-api-speos-sop-v1-SOPTemplate-Texture-NormalMap-FromImage) | | | +| from_normal_map | [SOPTemplate.Texture.NormalMap.FromNormalMap](#ansys-api-speos-sop-v1-SOPTemplate-Texture-NormalMap-FromNormalMap) | | | +| roughness | [float](#float) | | | +| repeat_along_u | [bool](#bool) | | Activate/deactivate the repeatability of the texture normal map on U axe. | +| repeat_along_v | [bool](#bool) | | Activate/deactivate the repeatability of the texture normal map on V axe. | + + + +### SOPTemplate.Texture.NormalMap.FromImage + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| bitmap_file_uri | [string](#string) | | Bitmap used to build normal map. | + + + +### SOPTemplate.Texture.NormalMap.FromNormalMap + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| normal_map_file_uri | [string](#string) | | Normal map file. | + + + +### Update_Request +Request to update a SOPTemplate in SOPTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SOPTemplate to be updated | +| sop_template | [SOPTemplate](#ansys-api-speos-sop-v1-SOPTemplate) | | SOPTemplate that will be used for the update | + + + +### Update_Response + + + + + + + + + +### SOPTemplateActions +Actions available on a SOPTemplate + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| + + + +### SOPTemplatesManager +Manager for SOPTemplates (SOP: Surface Optical Properties) + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-sop-v1-Create_Request) | [Create_Response](#ansys-api-speos-sop-v1-Create_Response) | Create a SOPTemplate | +| Read | [Read_Request](#ansys-api-speos-sop-v1-Read_Request) | [Read_Response](#ansys-api-speos-sop-v1-Read_Response) | Read a SOPTemplate | +| Update | [Update_Request](#ansys-api-speos-sop-v1-Update_Request) | [Update_Response](#ansys-api-speos-sop-v1-Update_Response) | Update a SOPTemplate | +| Delete | [Delete_Request](#ansys-api-speos-sop-v1-Delete_Request) | [Delete_Response](#ansys-api-speos-sop-v1-Delete_Response) | Delete a SOPTemplate | +| List | [List_Request](#ansys-api-speos-sop-v1-List_Request) | [List_Response](#ansys-api-speos-sop-v1-List_Response) | List all SOPTemplates in manager | + + + + + + +## source/v1/source.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Create_Request +Request to create a SourceTemplate in SourceTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| source_template | [SourceTemplate](#ansys-api-speos-source-v1-SourceTemplate) | | SourceTemplate containing its basic characteristics | +| guid | [string](#string) | optional | Optional field to specify the guid used in the database. If not set, a unique guid will be generated for that entry and sent back in the Create_Response. | + + + +### Create_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SourceTemplate created in SourceTemplatesManager | + + + +### Delete_Request +Request to delete a SourceTemplate in SourceTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SourceTemplate to be deleted | + + + +### Delete_Response + + + +### GetRayFileInfo_Request +Request of GetRayFileInfo + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SourceTemplate to get information about ray file (example: flux). Only for SourceTemplate of type RayFile. | + + + +### GetRayFileInfo_Response +Response of GetRayFileInfo + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| flux | [common.v1.DataDoubles](#ansys-api-speos-common-v1-DataDoubles) | | Flux of the ray file | +| has_spectral_data | [bool](#bool) | | The ray file contains Spectrum information | + + + +### List_Request + + + +### List_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of the SourceTemplates in SourceTemplatesManager | + + + +### Read_Request +Request to read a SourceTemplate in SourceTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SourceTemplate to be read | + + + +### Read_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| source_template | [SourceTemplate](#ansys-api-speos-source-v1-SourceTemplate) | | SourceTemplate corresponding to the guid given in Read_Request | + + + +### SourceTemplate +Source template with its basic characteristics + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | SourceTemplate name | +| description | [string](#string) | | SourceTemplate description | +| metadata | [SourceTemplate.MetadataEntry](#ansys-api-speos-source-v1-SourceTemplate-MetadataEntry) | repeated | User defined metadata | +| luminaire | [SourceTemplate.Luminaire](#ansys-api-speos-source-v1-SourceTemplate-Luminaire) | | | +| surface | [SourceTemplate.Surface](#ansys-api-speos-source-v1-SourceTemplate-Surface) | | | +| rayfile | [SourceTemplate.RayFile](#ansys-api-speos-source-v1-SourceTemplate-RayFile) | | | +| thermic | [SourceTemplate.Thermic](#ansys-api-speos-source-v1-SourceTemplate-Thermic) | | | +| display | [SourceTemplate.Display](#ansys-api-speos-source-v1-SourceTemplate-Display) | | | +| ambient | [SourceTemplate.Ambient](#ansys-api-speos-source-v1-SourceTemplate-Ambient) | | | + + + +### SourceTemplate.Ambient + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uniform_ambient | [SourceTemplate.Ambient.UniformAmbient](#ansys-api-speos-source-v1-SourceTemplate-Ambient-UniformAmbient) | | sets a specific and common luminance for the entire sky without any contribution of the sun. The sun has a specific value calculated according to its position | +| cie_overcast | [SourceTemplate.Ambient.CieOvercast](#ansys-api-speos-source-v1-SourceTemplate-Ambient-CieOvercast) | | generates a specific distribution for the sky according to a luminance value and CIE standard overcast model | +| cie_general | [SourceTemplate.Ambient.CieGeneral](#ansys-api-speos-source-v1-SourceTemplate-Ambient-CieGeneral) | | generates a specific distribution for the sky according to a luminance value and sky model | +| natural_light | [SourceTemplate.Ambient.NaturalLight](#ansys-api-speos-source-v1-SourceTemplate-Ambient-NaturalLight) | | generates natural lighting based on a day time or night time model | +| us_standard | [SourceTemplate.Ambient.UsStandard](#ansys-api-speos-source-v1-SourceTemplate-Ambient-UsStandard) | | The U.S. Standard Atmosphere Ambient Source follows a specific atmospheric model to simulate a sky radiation ranging from 280nm into ultraviolet to 4μm into infrared. | +| environment_map | [SourceTemplate.Ambient.EnvironmentMap](#ansys-api-speos-source-v1-SourceTemplate-Ambient-EnvironmentMap) | | creates a background using an image file | + + + +### SourceTemplate.Ambient.CieGeneral + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| luminance | [double](#double) | | Luminance in cd per squared meter | +| cie_type | [SourceTemplate.Ambient.CieGeneral.CieType](#ansys-api-speos-source-v1-SourceTemplate-Ambient-CieGeneral-CieType) | | sky model | + + + +### SourceTemplate.Ambient.CieOvercast + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| luminance | [double](#double) | | Luminance in cd per squared meter | +| spectrum_guid | [string](#string) | | blackbody or library spectra only | + + + +### SourceTemplate.Ambient.EnvironmentMap + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| luminance | [double](#double) | | Luminance in cd per squared meter | +| image_uri | [string](#string) | | image file or HDRI. HDRIs have relative luminance values, so the lumiance value will be applied to the (1,1,1) pixels and all other colors will be defined relatively | +| predefined_color_space | [SourceTemplate.PredefinedColorSpace](#ansys-api-speos-source-v1-SourceTemplate-PredefinedColorSpace) | | pre-defined color space | +| user_defined_rgb_space | [SourceTemplate.UserDefinedRGBSpace](#ansys-api-speos-source-v1-SourceTemplate-UserDefinedRGBSpace) | | custom RGB space with either pre-defined or custom white point | + + + +### SourceTemplate.Ambient.NaturalLight + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| turbidity | [double](#double) | | cloudiness of the environment. The lower the value the clearer the environment. Varies between 1.9 and 9.9 | +| with_sky | [bool](#bool) | | if false, only the sun is used in the simulation. If true, both ambient sky model and sun are used in the simulation | + + + +### SourceTemplate.Ambient.UniformAmbient + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| luminance | [double](#double) | | Luminance in cd per squared meter | +| mirrored_extent | [bool](#bool) | | if true then the ambient light covers all space, if false only covers the upper half space | +| spectrum_guid | [string](#string) | | blackbody or library spectra only | + + + +### SourceTemplate.Ambient.UsStandard + + + +### SourceTemplate.Display + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| image_file_uri | [string](#string) | | png,jpeg,bmp,tiff or rgb format file uri | +| source_dimensions | [SourceTemplate.SourceDimensions](#ansys-api-speos-source-v1-SourceTemplate-SourceDimensions) | | horizontal and vertical dimensions (mm) | +| luminous_flux | [double](#double) | | luminace in cd/m2 | +| contrast_ratio | [int32](#int32) | optional | Contrast ratio, infitine if not defined | +| intensity_guid | [string](#string) | | Intensity guid in intensity manager | +| pre_defined_color_space | [SourceTemplate.PredefinedColorSpace](#ansys-api-speos-source-v1-SourceTemplate-PredefinedColorSpace) | | pre-defined color space | +| user_defined_rbg_space | [SourceTemplate.UserDefinedRGBSpace](#ansys-api-speos-source-v1-SourceTemplate-UserDefinedRGBSpace) | | custom rgb color space with pre-defined or custom withe point | + + + +### SourceTemplate.FromIntensityFile +Take flux from intensity file provided + + + +### SourceTemplate.FromRayFile + + + +### SourceTemplate.Luminaire + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| flux_from_intensity_file | [SourceTemplate.FromIntensityFile](#ansys-api-speos-source-v1-SourceTemplate-FromIntensityFile) | | Take flux from intensity file provided | +| luminous_flux | [SourceTemplate.Luminous](#ansys-api-speos-source-v1-SourceTemplate-Luminous) | | Luminous flux in lumens, value >=0 | +| radiant_flux | [SourceTemplate.Radiant](#ansys-api-speos-source-v1-SourceTemplate-Radiant) | | Radiant flux in watts, value >=0 | +| intensity_file_uri | [string](#string) | | IES or EULUMDAT format file uri | +| spectrum_guid | [string](#string) | | Spectrum guid in spectrum manager | + + + +### SourceTemplate.Luminous + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| luminous_value | [double](#double) | | Luminous flux in lumens | + + + +### SourceTemplate.LuminousIntensity + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| luminous_intensity_value | [double](#double) | | Luminous intensity in candelas | + + + +### SourceTemplate.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### SourceTemplate.PredefinedColorSpace + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| color_space_type | [SourceTemplate.PredefinedColorSpace.ColorSpaceType](#ansys-api-speos-source-v1-SourceTemplate-PredefinedColorSpace-ColorSpaceType) | | pre-defined color space type | + + + +### SourceTemplate.PredefinedWhitePoint +color space can be used for both ambient sources and display sources + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| white_point_type | [SourceTemplate.PredefinedWhitePoint.WhitePointType](#ansys-api-speos-source-v1-SourceTemplate-PredefinedWhitePoint-WhitePointType) | | pre-defined white point type | + + + +### SourceTemplate.Radiant + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| radiant_value | [double](#double) | | Radiant flux in watts | + + + +### SourceTemplate.RayFile + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ray_file_uri | [string](#string) | | Rayfile format file uri (.ray or .tm25ray files expected) | +| flux_from_ray_file | [SourceTemplate.FromRayFile](#ansys-api-speos-source-v1-SourceTemplate-FromRayFile) | | Take flux from ray file provided | +| luminous_flux | [SourceTemplate.Luminous](#ansys-api-speos-source-v1-SourceTemplate-Luminous) | | Luminous flux in lumens, value >=0 | +| radiant_flux | [SourceTemplate.Radiant](#ansys-api-speos-source-v1-SourceTemplate-Radiant) | | Radiant flux in watts, value >=0 | +| spectrum_from_ray_file | [SourceTemplate.RayFile.SpectrumFromRayFile](#ansys-api-speos-source-v1-SourceTemplate-RayFile-SpectrumFromRayFile) | | Take spectrum from ray file provided | +| spectrum_guid | [string](#string) | | Spectrum guid in spectrum manager | + + + +### SourceTemplate.RayFile.SpectrumFromRayFile +Spectrum messages + + + +### SourceTemplate.SourceDimensions +source dimensions + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x_start | [double](#double) | | (mm) | +| x_end | [double](#double) | | (mm) | +| y_start | [double](#double) | | (mm) | +| y_end | [double](#double) | | (mm) | + + + +### SourceTemplate.Surface + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| flux_from_intensity_file | [SourceTemplate.FromIntensityFile](#ansys-api-speos-source-v1-SourceTemplate-FromIntensityFile) | | Take flux from intensity file provided | +| luminous_flux | [SourceTemplate.Luminous](#ansys-api-speos-source-v1-SourceTemplate-Luminous) | | Luminous flux in lumens | +| radiant_flux | [SourceTemplate.Radiant](#ansys-api-speos-source-v1-SourceTemplate-Radiant) | | Radiant flux in watts | +| luminous_intensity_flux | [SourceTemplate.LuminousIntensity](#ansys-api-speos-source-v1-SourceTemplate-LuminousIntensity) | | Luminous intensity in candelas | +| intensity_guid | [string](#string) | | Intensity guid in intensity manager | +| exitance_constant | [SourceTemplate.Surface.ExitanceConstant](#ansys-api-speos-source-v1-SourceTemplate-Surface-ExitanceConstant) | | Constant | +| exitance_variable | [SourceTemplate.Surface.ExitanceVariable](#ansys-api-speos-source-v1-SourceTemplate-Surface-ExitanceVariable) | | Taken from XMP map | +| spectrum_from_xmp_file | [SourceTemplate.Surface.SpectrumFromXMPFile](#ansys-api-speos-source-v1-SourceTemplate-Surface-SpectrumFromXMPFile) | | Take spectrum from xmp file provided | +| spectrum_guid | [string](#string) | | Spectrum guid in spectrum manager | +| timeline | [SourceTemplate.Surface.Timeline](#ansys-api-speos-source-v1-SourceTemplate-Surface-Timeline) | | Define timeline parameters | + + + +### SourceTemplate.Surface.ExitanceConstant + + + +### SourceTemplate.Surface.ExitanceVariable +Exitance messages + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| exitance_xmp_file_uri | [string](#string) | | XMP file describing exitance, if spectral, spectrum is not needed in source definition | + + + +### SourceTemplate.Surface.SpectrumFromXMPFile +Take spectrum from xmp file provided + + + +### SourceTemplate.Surface.Timeline +Define the variation of the source's power in time and represent flickering Surface source + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| flux_variation_file_uri | [string](#string) | | Flux variation file, used to define the samples for one period representing the variation of the relative flux of the source with time. | +| relative_lag | [double](#double) | | Relative lag (percentage, default value of 0%) represents the relative time along the period when the source starts to emit light. That means the relative lag includes a temporal shift of the time period. | + + + +### SourceTemplate.Thermic + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| emissives_faces | [SourceTemplate.Thermic.EmissiveFaces](#ansys-api-speos-source-v1-SourceTemplate-Thermic-EmissiveFaces) | | black body with temperature on each face | +| temperature_field | [SourceTemplate.Thermic.TemperatureField](#ansys-api-speos-source-v1-SourceTemplate-Thermic-TemperatureField) | | file with meshed data and triangle temperature | +| intensity_guid | [string](#string) | | Intensity guid in intensity manager Lambertian or cos only | + + + +### SourceTemplate.Thermic.EmissiveFaces + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| temperature | [double](#double) | | the temperature in Kelvin of the blackbody (Kirchhoff's law) for every face | + + + +### SourceTemplate.Thermic.TemperatureField + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| temperature_field_uri | [string](#string) | | file with meshed data and temperature for each triangle | +| sop_guid | [string](#string) | | SOP for geometry, must have absorption, required with temperature field | + + + +### SourceTemplate.UserDefinedRGBSpace + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| pre_defined_white_point | [SourceTemplate.PredefinedWhitePoint](#ansys-api-speos-source-v1-SourceTemplate-PredefinedWhitePoint) | | pre-defined white point | +| user_defined_white_point | [SourceTemplate.UserDefinedWhitePoint](#ansys-api-speos-source-v1-SourceTemplate-UserDefinedWhitePoint) | | custom Y and X white point coordinates | +| red_spectrum_guid | [string](#string) | | red Spectrum guid in spectrum manager | +| green_spectrum_guid | [string](#string) | | green Spectrum guid in spectrum manager | +| blue_spectrum_guid | [string](#string) | | blue Spectrum guid in spectrum manager | + + + +### SourceTemplate.UserDefinedWhitePoint + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| white_point | [double](#double) | repeated | X and Y coordinates of the white point. | + + + +### Update_Request +Request to update a SourceTemplate in SourceTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the SourceTemplate to be updated | +| source_template | [SourceTemplate](#ansys-api-speos-source-v1-SourceTemplate) | | SourceTemplate that will be used for the update | + + + +### Update_Response + + + + + +### SourceTemplate.Ambient.CieGeneral.CieType + +| Name | Number | Description | +| ---- | ------ | ----------- | +| standard_overcast | 0 | | +| overcast_steep_gradation | 1 | | +| overcast_azimuthal_uniformity | 2 | | +| overcast_slight_brightening | 3 | | +| uniform_luminance | 4 | | +| cloudy_slight_brightening | 5 | | +| cloudy_nogradation_circumsolar | 6 | | +| cloudy_solar_corona | 7 | | +| cloudy_obscured_sun | 8 | | +| cloudy_circumsolar_region | 9 | | +| white_blue_distinct | 10 | | +| standard_low_luminance | 11 | | +| standard_polluted_atmosphere | 12 | | +| cloudless_turbid_corona | 13 | | +| white_blue_broad | 14 | | + + + +### SourceTemplate.PredefinedColorSpace.ColorSpaceType + +| Name | Number | Description | +| ---- | ------ | ----------- | +| sRGB | 0 | standard and most commonly used model | +| AdobeRGB | 1 | larger gamut | + + + +### SourceTemplate.PredefinedWhitePoint.WhitePointType + +| Name | Number | Description | +| ---- | ------ | ----------- | +| C | 0 | average daylight illuminant | +| D50 | 1 | natural horizon light | +| D65 | 2 | standard daylight illuminant | +| E | 3 | illuminant that gives equal weight to all wavelengths | + + + + + + + +### SourceTemplateActions +Actions available on a SourceTemplate + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetRayFileInfo | [GetRayFileInfo_Request](#ansys-api-speos-source-v1-GetRayFileInfo_Request) | [GetRayFileInfo_Response](#ansys-api-speos-source-v1-GetRayFileInfo_Response) | Get Flux from ray file | + + + +### SourceTemplatesManager +Manager for SourceTemplates + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-source-v1-Create_Request) | [Create_Response](#ansys-api-speos-source-v1-Create_Response) | Create a SourceTemplate | +| Read | [Read_Request](#ansys-api-speos-source-v1-Read_Request) | [Read_Response](#ansys-api-speos-source-v1-Read_Response) | Read a SourceTemplate | +| Update | [Update_Request](#ansys-api-speos-source-v1-Update_Request) | [Update_Response](#ansys-api-speos-source-v1-Update_Response) | Update a SourceTemplate | +| Delete | [Delete_Request](#ansys-api-speos-source-v1-Delete_Request) | [Delete_Response](#ansys-api-speos-source-v1-Delete_Response) | Delete a SourceTemplate | +| List | [List_Request](#ansys-api-speos-source-v1-List_Request) | [List_Response](#ansys-api-speos-source-v1-List_Response) | List all SourceTemplates in manager | + + + + + + +## spectrum/v1/spectrum.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Create_Request +Request to create a Spectrum in SpectrumsManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| spectrum | [Spectrum](#ansys-api-speos-spectrum-v1-Spectrum) | | Spectrum containing its basic characteristics | +| guid | [string](#string) | optional | Optional field to specify the guid used in the database. If not set, a unique guid will be generated for that entry and sent back in the Create_Response. | + + + +### Create_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Spectrum created in SpectrumsManager | + + + +### Delete_Request +Request to delete a Spectrum in SpectrumsManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Spectrum to be deleted | + + + +### Delete_Response + + + +### List_Request + + + +### List_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of the Spectrums in SpectrumsManager | + + + +### Read_Request +Request to read a Spectrum in SpectrumsManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Spectrum to be read | + + + +### Read_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| spectrum | [Spectrum](#ansys-api-speos-spectrum-v1-Spectrum) | | Spectrum corresponding to the guid given in Read_Request | + + + +### Spectrum +Spectrum with its basic characteristics + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Spectrum name | +| description | [string](#string) | | Spectrum description | +| metadata | [Spectrum.MetadataEntry](#ansys-api-speos-spectrum-v1-Spectrum-MetadataEntry) | repeated | User defined metadata | +| monochromatic | [Spectrum.Monochromatic](#ansys-api-speos-spectrum-v1-Spectrum-Monochromatic) | | | +| blackbody | [Spectrum.BlackBody](#ansys-api-speos-spectrum-v1-Spectrum-BlackBody) | | | +| sampled | [Spectrum.Sampled](#ansys-api-speos-spectrum-v1-Spectrum-Sampled) | | | +| library | [Spectrum.Library](#ansys-api-speos-spectrum-v1-Spectrum-Library) | | | +| predefined | [Spectrum.Predefined](#ansys-api-speos-spectrum-v1-Spectrum-Predefined) | | | + + + +### Spectrum.BlackBody + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| temperature | [double](#double) | | Temperature of the blackbody, in K | + + + +### Spectrum.DaylightFluorescent + + + +### Spectrum.Halogen + + + +### Spectrum.HighPressureSodium + + + +### Spectrum.Incandescent + + + +### Spectrum.Library + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_uri | [string](#string) | | uri of the spectrum file | + + + +### Spectrum.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### Spectrum.MetalHalide + + + +### Spectrum.Monochromatic + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wavelength | [double](#double) | | Wavelength of the monochromatic spectrum, in nm | + + + +### Spectrum.Predefined +Predefined sampled spectrums + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| incandescent | [Spectrum.Incandescent](#ansys-api-speos-spectrum-v1-Spectrum-Incandescent) | | | +| warmwhitefluorescent | [Spectrum.WarmWhiteFluorescent](#ansys-api-speos-spectrum-v1-Spectrum-WarmWhiteFluorescent) | | | +| daylightfluorescent | [Spectrum.DaylightFluorescent](#ansys-api-speos-spectrum-v1-Spectrum-DaylightFluorescent) | | | +| whiteLED | [Spectrum.WhiteLED](#ansys-api-speos-spectrum-v1-Spectrum-WhiteLED) | | | +| halogen | [Spectrum.Halogen](#ansys-api-speos-spectrum-v1-Spectrum-Halogen) | | | +| metalhalide | [Spectrum.MetalHalide](#ansys-api-speos-spectrum-v1-Spectrum-MetalHalide) | | | +| highpressuresodium | [Spectrum.HighPressureSodium](#ansys-api-speos-spectrum-v1-Spectrum-HighPressureSodium) | | | + + + +### Spectrum.Sampled + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wavelengths | [double](#double) | repeated | List of wavelengths, in nm | +| values | [double](#double) | repeated | List of values, expected from 0. to 100. in % | + + + +### Spectrum.WarmWhiteFluorescent + + + +### Spectrum.WhiteLED + + + +### Update_Request +Request to update a Spectrum in SpectrumsManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the Spectrum to be updated | +| spectrum | [Spectrum](#ansys-api-speos-spectrum-v1-Spectrum) | | Spectrum that will be used for the update | + + + +### Update_Response + + + + + + + + + +### SpectrumsManager + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-spectrum-v1-Create_Request) | [Create_Response](#ansys-api-speos-spectrum-v1-Create_Response) | Create a Spectrum | +| Read | [Read_Request](#ansys-api-speos-spectrum-v1-Read_Request) | [Read_Response](#ansys-api-speos-spectrum-v1-Read_Response) | Read a Spectrum | +| Update | [Update_Request](#ansys-api-speos-spectrum-v1-Update_Request) | [Update_Response](#ansys-api-speos-spectrum-v1-Update_Response) | Update a Spectrum | +| Delete | [Delete_Request](#ansys-api-speos-spectrum-v1-Delete_Request) | [Delete_Response](#ansys-api-speos-spectrum-v1-Delete_Response) | Delete a Spectrum | +| List | [List_Request](#ansys-api-speos-spectrum-v1-List_Request) | [List_Response](#ansys-api-speos-spectrum-v1-List_Response) | List all Spectrums in manager | + + + + + + +## vop/v1/vop.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Create_Request +Request to create a VOPTemplate in VOPTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| vop_template | [VOPTemplate](#ansys-api-speos-vop-v1-VOPTemplate) | | VOPTemplate containing its basic characteristics | +| guid | [string](#string) | optional | Optional field to specify the guid used in the database. If not set, a unique guid will be generated for that entry and sent back in the Create_Response. | + + + +### Create_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the VOPTemplate created in VOPTemplatesManager | + + + +### Delete_Request +Request to delete a VOPTemplate in VOPTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the VOPTemplate to be deleted | + + + +### Delete_Response + + + +### List_Request + + + +### List_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guids | [string](#string) | repeated | Guids of the VOPTemplates in VOPTemplatesManager | + + + +### Read_Request +Request to read a VOPTemplate in VOPTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the VOPTemplate to be read | + + + +### Read_Response + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| vop_template | [VOPTemplate](#ansys-api-speos-vop-v1-VOPTemplate) | | VOPTemplate corresponding to the guid given in Read_Request | + + + +### Update_Request +Request to update a VOPTemplate in VOPTemplatesManager + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | Guid of the VOPTemplate to be updated | +| vop_template | [VOPTemplate](#ansys-api-speos-vop-v1-VOPTemplate) | | VOPTemplate that will be used for the update | + + + +### Update_Response + + + +### VOPTemplate +VOP: Volume Optical Properties +Defines the behavior of light rays when they are propagated in a body. + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | VOPTemplate name | +| description | [string](#string) | | VOPTemplate description | +| metadata | [VOPTemplate.MetadataEntry](#ansys-api-speos-vop-v1-VOPTemplate-MetadataEntry) | repeated | User defined metadatas | +| opaque | [VOPTemplate.Opaque](#ansys-api-speos-vop-v1-VOPTemplate-Opaque) | | Non-transparent material | +| optic | [VOPTemplate.Optic](#ansys-api-speos-vop-v1-VOPTemplate-Optic) | | Transparent colorless material without bulk scattering | +| library | [VOPTemplate.Library](#ansys-api-speos-vop-v1-VOPTemplate-Library) | | Based on *.material file | +| non_homogeneous | [VOPTemplate.NonHomogeneous](#ansys-api-speos-vop-v1-VOPTemplate-NonHomogeneous) | | Material with non-homogeneous refractive index | + + + +### VOPTemplate.Library + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| material_file_uri | [string](#string) | | .material file | + + + +### VOPTemplate.MetadataEntry + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + +### VOPTemplate.NonHomogeneous +Material with non-homogeneous refractive index + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| gradedmaterial_file_uri | [string](#string) | | .gradedmaterial file that describes the spectral variations of refractive index and absorption with respect to position in space | + + + +### VOPTemplate.Opaque +Non-transparent material + + + +### VOPTemplate.Optic +Transparent colorless material without bulk scattering + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [double](#double) | | Refractive index | +| absorption | [double](#double) | | | +| constringence | [double](#double) | optional | Abbe number | + + + + + + + + + +### VOPTemplateActions +Actions available on a VOPTemplate + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| + + + +### VOPTemplatesManager +Manager for VOPTemplates (VOP: Volume Optical Properties) + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [Create_Request](#ansys-api-speos-vop-v1-Create_Request) | [Create_Response](#ansys-api-speos-vop-v1-Create_Response) | Create a VOPTemplate | +| Read | [Read_Request](#ansys-api-speos-vop-v1-Read_Request) | [Read_Response](#ansys-api-speos-vop-v1-Read_Response) | Read a VOPTemplate | +| Update | [Update_Request](#ansys-api-speos-vop-v1-Update_Request) | [Update_Response](#ansys-api-speos-vop-v1-Update_Response) | Update a VOPTemplate | +| Delete | [Delete_Request](#ansys-api-speos-vop-v1-Delete_Request) | [Delete_Response](#ansys-api-speos-vop-v1-Delete_Response) | Delete a VOPTemplate | +| List | [List_Request](#ansys-api-speos-vop-v1-List_Request) | [List_Response](#ansys-api-speos-vop-v1-List_Response) | List all VOPTemplates in manager | + + + + + + +## xmp/v1/xmp_file.proto +(c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. + + + +### Coordinate2d + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| pixel_x | [uint32](#uint32) | | | +| pixel_y | [uint32](#uint32) | | | + + + +### FileName + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| file_name | [string](#string) | | .xmp | + + + +### Pixel + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| nb_pixel | [uint32](#uint32) | | | + + + +### Value + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| value | [float](#float) | | | + + + + + + + + + +### XmpFileService_Mono +service to manage xmp file + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| CreateXMPFileInfo | [FileName](#ansys-api-speos-xmp-v1-FileName) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | Create Xmp file Info @param[in] FileName The Path to the Xmp file. | +| BuildMapRelativeStandardError | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | Build Relative Standard Error accessor Xmp file | +| GetValueRelativeStandardError | [Coordinate2d](#ansys-api-speos-xmp-v1-Coordinate2d) | [Value](#ansys-api-speos-xmp-v1-Value) | Get Value Relative Standard Error file | +| GetNbPixelXRelativeStandardError | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | [Pixel](#ansys-api-speos-xmp-v1-Pixel) | Get Nb pixel X Relative Standard Error file | +| GetNbPixelYRelativeStandardError | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | [Pixel](#ansys-api-speos-xmp-v1-Pixel) | Get Nb pixel Y Relative Standard Error file | +| ExportXmpFileRelativeStandardError | [FileName](#ansys-api-speos-xmp-v1-FileName) | [.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty) | Export Xmp File Relative Standard Error | + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | diff --git a/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc.md b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc.md new file mode 100644 index 000000000..720334f30 --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc.md @@ -0,0 +1,11 @@ +# Speos RPC Changelogs + +This section list the changelogs of the Speos RPC versions. + +- [Speos RPC changelog 2026 R1 SP02](speos_changelogs_rpc_2612.md) +- [Speos RPC changelog 2026 R1 SP01](speos_changelogs_rpc_2611.md) +- [Speos RPC changelog 2026 R1](speos_changelogs_rpc_261.md) +- [Speos RPC changelog 2025 R2 SP03](speos_changelogs_rpc_2523.md) +- [Speos RPC changelog 2025 R2 SP01](speos_changelogs_rpc_2521.md) +- [Speos RPC changelog 2025 R2](speos_changelogs_rpc_252.md) +- [Speos RPC changelog 2025 R1 SP04](speos_changelogs_rpc_2514.md) diff --git a/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2514.md b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2514.md new file mode 100644 index 000000000..7a40ac759 --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2514.md @@ -0,0 +1,5 @@ +# Speos RPC Changelog 2025 R1 SP04 + +## Secure Transport Protocols support + +SpeosRPC_Server has been improved to support different secure transport protocols (mutual TLS, Unix Domain Socket, Windows Named User Authentication). Besides SpeosRPC version 2025 R1 SP04, this improvement applies to the 2025 R2 SP03 version of SpeosRPC. For more information on how to run SpeosRPC_Server, see [How to launch SpeosRPC Server?](../index.md#how-to-launch-speosrpc-server) diff --git a/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_252.md b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_252.md new file mode 100644 index 000000000..a5a38792d --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_252.md @@ -0,0 +1,176 @@ +# Speos RPC Changelog 2025 R2 + +## Data + +- Added [ray_sampling](../api-reference.md#magnitude) magnitude +- Added [ray_per_pixel](../api-reference.md#unit) unit + +## Material + +### Non-homogeneous properties + +- Added [non_homogeneous_properties](../api-reference.md#scenematerialinstance) as new field of the **Scene.MaterialInstance** object +- Added [Scene.MaterialInstance.NonHomogeneousProperties](../api-reference.md#scenematerialinstancenonhomogeneousproperties) as new object of the **Scene.MaterialInstance** object + +## Source + +### Ray File source + +- Added [has_spectral_data](../api-reference.md#getrayfileinfo_response) as new field of the **GetRayFileInfo_Response** object + +### Thermic source + +- Added [thermic_properties](../api-reference.md#scenesourceinstance) as new field of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.ThermicProperties](../api-reference.md#scenesourceinstancethermicproperties) as new object of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.ThermicProperties.EmissiveFacesProperties](../api-reference.md#scenesourceinstancethermicpropertiesemissivefacesproperties) as new object of the **Scene.SourceInstance.ThermicProperties** object +- Added [Scene.SourceInstance.ThermicProperties.TemperatureFieldProperties](../api-reference.md#scenesourceinstancethermicpropertiestemperaturefieldproperties) as new object of the **Scene.SourceInstance.ThermicProperties** object +- Added [thermic](../api-reference.md#sourcetemplate) as new field of the **SourceTemplate** object +- Added [SourceTemplate.Thermic](../api-reference.md#sourcetemplatethermic) as new object of the **SourceTemplate** object +- Added [SourceTemplate.Thermic.EmissiveFaces](../api-reference.md#sourcetemplatethermicemissivefaces) as new object of the **SourceTemplate.Thermic** object +- Added [SourceTemplate.Thermic.TemperatureField](../api-reference.md#sourcetemplatethermictemperaturefield) as new object of the **SourceTemplate.Thermic** object + +### Display source + +- Added [display_properties](../api-reference.md#scenesourceinstance) as new field of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.DisplayProperties](../api-reference.md#scenesourceinstancedisplayproperties) as new object of the **Scene.SourceInstance** object +- Added [display](../api-reference.md#sourcetemplate) as new field of the **SourceTemplate** object +- Added [SourceTemplate.Display](../api-reference.md#sourcetemplatedisplay) as new object of the **SourceTemplate** object +- Added [SourceTemplate.PredefinedColorSpace](../api-reference.md#sourcetemplatepredefinedcolorspace) as new object of the **SourceTemplate** object +- Added [SourceTemplate.PredefinedColorSpace.ColorSpaceType](../api-reference.md#sourcetemplatepredefinedcolorspacecolorspacetype) as new object of the **SourceTemplate.PredefinedColorSpace** object +- Added [SourceTemplate.UserDefinedRGBSpace](../api-reference.md#sourcetemplateuserdefinedrgbspace) as new object of the **SourceTemplate** object +- Added [SourceTemplate.PredefinedWhitePoint](../api-reference.md#sourcetemplatepredefinedwhitepoint) as new object of the **SourceTemplate** object +- Added [SourceTemplate.PredefinedWhitePoint.WhitePointType](../api-reference.md#sourcetemplatepredefinedwhitepointwhitepointtype) as new object of the **SourceTemplate.PredefinedWhitePoint** object +- Added [SourceTemplate.UserDefinedWhitePoint](../api-reference.md#sourcetemplateuserdefinedwhitepoint) as new object of the **SourceTemplate** object +- Added [SourceTemplate.SourceDimensions](../api-reference.md#sourcetemplatesourcedimensions) as new object of the **SourceTemplate** object + +### Ambient source: CIE General + +- Added [ambient_properties](../api-reference.md#scenesourceinstance) as new field of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.AmbientProperties](../api-reference.md#scenesourceinstanceambientproperties) as new object of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.AmbientProperties.CieGeneralProperties](../api-reference.md#scenesourceinstanceambientpropertiesciegeneralproperties) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [Scene.SourceInstance.AmbientProperties.ManualSun](../api-reference.md#scenesourceinstanceambientpropertiesmanualsun) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [Scene.SourceInstance.AmbientProperties.SunAxisSystem](../api-reference.md#scenesourceinstanceambientpropertiessunaxissystem) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [Scene.SourceInstance.AmbientProperties.SunAxisSystem.AutomaticSun](../api-reference.md#scenesourceinstanceambientpropertiessunaxissystemautomaticsun) as new object of the **Scene.SourceInstance.AmbientProperties.SunAxisSystem** object +- Added [ambient](../api-reference.md#sourcetemplate) as new field of the **SourceTemplate** object +- Added [SourceTemplate.Ambient](../api-reference.md#sourcetemplateambient) as new object of the **SourceTemplate** object +- Added [SourceTemplate.Ambient.CieGeneral](../api-reference.md#sourcetemplateambientciegeneral) as new object of the **SourceTemplate.Ambient** object +- Added [SourceTemplate.Ambient.CieGeneral.CieType](../api-reference.md#sourcetemplateambientciegeneralcietype) as new object of the **SourceTemplate.Ambient.CieGeneral** object +- Added [ground](../api-reference.md#scene) as new field of the **Scene** +- Added [Scene.GroundPlane](../api-reference.md#scenegroundplane) as new **Scene** object + +### Ambient source: CIE Overcast + +- Added [ambient_properties](../api-reference.md#scenesourceinstance) as new field of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.AmbientProperties](../api-reference.md#scenesourceinstanceambientproperties) as new object of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.AmbientProperties.CieOvercastProperties](../api-reference.md#scenesourceinstanceambientpropertiescieovercastproperties) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [ambient](../api-reference.md#sourcetemplate) as new field of the **SourceTemplate** object +- Added [SourceTemplate.Ambient](../api-reference.md#sourcetemplateambient) as new object of the **SourceTemplate** object +- Added [SourceTemplate.Ambient.CieOvercast](../api-reference.md#sourcetemplateambientcieovercast) as new object of the **SourceTemplate.Ambient** object +- Added [ground](../api-reference.md#scene) as new field of the **Scene** +- Added [Scene.GroundPlane](../api-reference.md#scenegroundplane) as new **Scene** object + +### Ambient source: Environment + +- Added [ambient_properties](../api-reference.md#scenesourceinstance) as new field of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.AmbientProperties](../api-reference.md#scenesourceinstanceambientproperties) as new object of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.AmbientProperties.EnvironmentMapProperties](../api-reference.md#scenesourceinstanceambientpropertiesenvironmentmapproperties) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [ambient](../api-reference.md#sourcetemplate) as new field of the **SourceTemplate** object +- Added [SourceTemplate.Ambient](../api-reference.md#sourcetemplateambient) as new object of the **SourceTemplate** object +- Added [SourceTemplate.Ambient.EnvironmentMap](../api-reference.md#sourcetemplateambientenvironmentmap) as new object of the **SourceTemplate.Ambient** object +- Added [SourceTemplate.PredefinedColorSpace](../api-reference.md#sourcetemplatepredefinedcolorspace) as new object of the **SourceTemplate** object +- Added [SourceTemplate.PredefinedColorSpace.ColorSpaceType](../api-reference.md#sourcetemplatepredefinedcolorspacecolorspacetype) as new object of the **SourceTemplate.PredefinedColorSpace** object +- Added [SourceTemplate.UserDefinedRGBSpace](../api-reference.md#sourcetemplateuserdefinedrgbspace) as new object of the **SourceTemplate** object +- Added [SourceTemplate.PredefinedWhitePoint](../api-reference.md#sourcetemplatepredefinedwhitepoint) as new object of the **SourceTemplate** object +- Added [SourceTemplate.PredefinedWhitePoint.WhitePointType](../api-reference.md#sourcetemplatepredefinedwhitepointwhitepointtype) as new object of the **SourceTemplate.PredefinedWhitePoint** object +- Added [SourceTemplate.UserDefinedWhitePoint](../api-reference.md#sourcetemplateuserdefinedwhitepoint) as new object of the **SourceTemplate** object +- Added [ground](../api-reference.md#scene) as new field of the **Scene** +- Added [Scene.GroundPlane](../api-reference.md#scenegroundplane) as new **Scene** object + +### Ambient source: Natural Light + +- Added [ambient_properties](../api-reference.md#scenesourceinstance) as new field of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.AmbientProperties](../api-reference.md#scenesourceinstanceambientproperties) as new object of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.AmbientProperties.NaturalLightProperties](../api-reference.md#scenesourceinstanceambientpropertiesnaturallightproperties) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [Scene.SourceInstance.AmbientProperties.ManualSun](../api-reference.md#scenesourceinstanceambientpropertiesmanualsun) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [Scene.SourceInstance.AmbientProperties.SunAxisSystem](../api-reference.md#scenesourceinstanceambientpropertiessunaxissystem) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [Scene.SourceInstance.AmbientProperties.SunAxisSystem.AutomaticSun](../api-reference.md#scenesourceinstanceambientpropertiessunaxissystemautomaticsun) as new object of the **Scene.SourceInstance.AmbientProperties.SunAxisSystem** object +- Added [ambient](../api-reference.md#sourcetemplate) as new field of the **SourceTemplate** object +- Added [SourceTemplate.Ambient](../api-reference.md#sourcetemplateambient) as new object of the **SourceTemplate** object +- Added [SourceTemplate.Ambient.NaturalLight](../api-reference.md#sourcetemplateambientnaturallight) as new object of the **SourceTemplate.Ambient** object +- Added [ground](../api-reference.md#scene) as new field of the **Scene** +- Added [Scene.GroundPlane](../api-reference.md#scenegroundplane) as new **Scene** object + +### Ambient source: Uniform + +- Added [ambient_properties](../api-reference.md#scenesourceinstance) as new field of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.AmbientProperties](../api-reference.md#scenesourceinstanceambientproperties) as new object of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.AmbientProperties.UniformAmbientProperties](../api-reference.md#scenesourceinstanceambientpropertiesuniformambientproperties) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [Scene.SourceInstance.AmbientProperties.ManualSun](../api-reference.md#scenesourceinstanceambientpropertiesmanualsun) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [Scene.SourceInstance.AmbientProperties.SunAxisSystem](../api-reference.md#scenesourceinstanceambientpropertiessunaxissystem) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [Scene.SourceInstance.AmbientProperties.SunAxisSystem.AutomaticSun](../api-reference.md#scenesourceinstanceambientpropertiessunaxissystemautomaticsun) as new object of the **Scene.SourceInstance.AmbientProperties.SunAxisSystem** object +- Added [ambient](../api-reference.md#sourcetemplate) as new field of the **SourceTemplate** object +- Added [SourceTemplate.Ambient](../api-reference.md#sourcetemplateambient) as new object of the **SourceTemplate** object +- Added [SourceTemplate.Ambient.UniformAmbient](../api-reference.md#sourcetemplateambientuniformambient) as new object of the **SourceTemplate.Ambient** object +- Added [ground](../api-reference.md#scene) as new field of the **Scene** +- Added [Scene.GroundPlane](../api-reference.md#scenegroundplane) as new **Scene** object + +### Ambient source: US Standard Atmosphere 1976 + +- Added [ambient_properties](../api-reference.md#scenesourceinstance) as new field of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.AmbientProperties](../api-reference.md#scenesourceinstanceambientproperties) as new object of the **Scene.SourceInstance** object +- Added [Scene.SourceInstance.AmbientProperties.UsStandardProperties](../api-reference.md#scenesourceinstanceambientpropertiesusstandardproperties) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [Scene.SourceInstance.AmbientProperties.ManualSun](../api-reference.md#scenesourceinstanceambientpropertiesmanualsun) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [Scene.SourceInstance.AmbientProperties.SunAxisSystem](../api-reference.md#scenesourceinstanceambientpropertiessunaxissystem) as new object of the **Scene.SourceInstance.AmbientProperties** object +- Added [Scene.SourceInstance.AmbientProperties.SunAxisSystem.AutomaticSun](../api-reference.md#scenesourceinstanceambientpropertiessunaxissystemautomaticsun) as new object of the **Scene.SourceInstance.AmbientProperties.SunAxisSystem** object +- Added [ambient](../api-reference.md#sourcetemplate) as new field of the **SourceTemplate** object +- Added [SourceTemplate.Ambient](../api-reference.md#sourcetemplateambient) as new object of the **SourceTemplate** object +- Added [SourceTemplate.Ambient.UsStandard](../api-reference.md#sourcetemplateambientusstandard) as new object of the **SourceTemplate.Ambient** object +- Added [ground](../api-reference.md#scene) as new field of the **Scene** +- Added [Scene.GroundPlane](../api-reference.md#scenegroundplane) as new **Scene** object + +## Sensor + +### Intensity sensor + +- Added [intensity_properties](../api-reference.md#scenesensorinstance) as new field of the **Scene.SensorInstance** object +- Added [Scene.SensorInstance.IntensityProperties](../api-reference.md#scenesensorinstanceintensityproperties) as new object of the **Scene.SensorInstance** object +- Added [intensity_sensor_template](../api-reference.md#sensortemplate) as new field of the **SensorTemplate** object +- Added [SensorTemplate.Intensity](../api-reference.md#sensortemplateintensity) as new object of the **SensorTemplate** object +- Added [ConoscopicIntensityDimensions](../api-reference.md#conoscopicintensitydimensions) as new object +- Added [IntensityDimensions](../api-reference.md#intensitydimensions) as new object +- Added [IntensityOrientationConoscopic](../api-reference.md#intensityorientationconoscopic) as new object +- Added [IntensityOrientationXAsMeridian](../api-reference.md#intensityorientationxasmeridian) as new object +- Added [IntensityOrientationXAsParallel](../api-reference.md#intensityorientationxasparallel) as new object +- Added [SensorNearField](../api-reference.md#sensornearfield) as new object + +### Polar Intensity sensor + +- Added [polar_intensity_properties](../api-reference.md#scenesensorinstance) as new field of the **Scene.SensorInstance** object +- Added [Scene.SensorInstance.PolarIntensityProperties](../api-reference.md#scenesensorinstancepolarintensityproperties) as new object of the **Scene.SensorInstance** object +- Added [polar_intensity_sensor_template](../api-reference.md#sensortemplate) as new field of the **SensorTemplate** object +- Added [SensorTemplate.PolarIntensity](../api-reference.md#sensortemplatepolarintensity) as new object of the **SensorTemplate** object +- Added [SensorTemplate.PolarIntensity.SensorFarField](../api-reference.md#sensortemplatepolarintensitysensorfarfield) as new object of the **SensorTemplate.PolarIntensity** object +- Added [PolarIntensityDimensions](../api-reference.md#polarintensitydimensions) as new object +- Added [PolarIntensityEulumdat](../api-reference.md#polarintensityeulumdat) as new object +- Added [PolarIntensityIesnaA](../api-reference.md#polarintensityiesnaa) as new object +- Added [PolarIntensityIesnaB](../api-reference.md#polarintensityiesnab) as new object +- Added [PolarIntensityIesnaC](../api-reference.md#polarintensityiesnac) as new object +- Added [SensorNearField](../api-reference.md#sensornearfield) as new object + +### 3D Irradiance sensor + +- Added [irradiance_3d_properties](../api-reference.md#scenesensorinstance) as new field of the **Scene.SensorInstance** object +- Added [Scene.SensorInstance.Irradiance3DProperties](../api-reference.md#scenesensorinstanceirradiance3dproperties) as new object of the **Scene.SensorInstance** object +- Added [irradiance_3d](../api-reference.md#sensortemplate) as new field of the **SensorTemplate** object +- Added [SensorTemplate.Irradiance3D](../api-reference.md#sensortemplateirradiance3d) as new object of the **SensorTemplate** object +- Added [SensorTemplate.Irradiance3D.IntegrationTypePlanar](../api-reference.md#sensortemplateirradiance3dintegrationtypeplanar) as new object of the **SensorTemplate.Irradiance3D** object +- Added [SensorTemplate.Irradiance3D.IntegrationTypeRadial](../api-reference.md#sensortemplateirradiance3dintegrationtyperadial) as new object of the **SensorTemplate.Irradiance3D** object +- Added [SensorTemplate.Irradiance3D.TypeColorimetric](../api-reference.md#sensortemplateirradiance3dtypecolorimetric) as new object of the **SensorTemplate.Irradiance3D** object +- Added [SensorTemplate.Irradiance3D.TypeColorimetric.IntegrationType](../api-reference.md#sensortemplateirradiance3dtypecolorimetricintegrationtype) as new object of the **SensorTemplate.Irradiance3D.TypeColorimetric** object +- Added [SensorTemplate.Irradiance3D.TypePhotometric](../api-reference.md#sensortemplateirradiance3dtypephotometric) as new object of the **SensorTemplate.Irradiance3D** object +- Added [SensorTemplate.Irradiance3D.TypeRadiometric](../api-reference.md#sensortemplateirradiance3dtyperadiometric) as new object of the **SensorTemplate.Irradiance3D** object + +### Light Expert + +- Added [lxp_properties](../api-reference.md#scenesensorinstance) as new field of the **Scene.SensorInstance** object +- Added [Scene.SensorInstance.LXPProperties](../api-reference.md#scenesensorinstancelxpproperties) as new object of the **Scene.SensorInstance** object diff --git a/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2521.md b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2521.md new file mode 100644 index 000000000..57ff65a65 --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2521.md @@ -0,0 +1,63 @@ +# Speos RPC Changelog 2025 R2 SP01 + +## Simulation + +### Virtual BSDF bench + +- Added [virtual_bsdf_bench_simulation_template](../api-reference.md#simulationtemplate) as new field of the **SimulationTemplate** object +- Added [SimulationTemplate.VirtualBSDFBench](../api-reference.md#simulationtemplatevirtualbsdfbench) as new object of the **SimulationTemplate** object, coming with the following created objects: + - [SimulationTemplate.VirtualBSDFBench.AllCharacteristics](../api-reference.md#simulationtemplatevirtualbsdfbenchallcharacteristics) + - [SimulationTemplate.VirtualBSDFBench.AllCharacteristics.Iridescence](../api-reference.md#simulationtemplatevirtualbsdfbenchallcharacteristicsiridescence) + - [SimulationTemplate.VirtualBSDFBench.AllCharacteristics.NoIridescence](../api-reference.md#simulationtemplatevirtualbsdfbenchallcharacteristicsnoiridescence) + - [SimulationTemplate.VirtualBSDFBench.AllCharacteristics.NoIridescence.Anisotropic](../api-reference.md#simulationtemplatevirtualbsdfbenchallcharacteristicsnoiridescenceanisotropic) + - [SimulationTemplate.VirtualBSDFBench.AllCharacteristics.NoIridescence.Isotropic](../api-reference.md#simulationtemplatevirtualbsdfbenchallcharacteristicsnoiridescenceisotropic) + - [SimulationTemplate.VirtualBSDFBench.RoughnessOnly](../api-reference.md#simulationtemplatevirtualbsdfbenchroughnessonly) + - [SimulationTemplate.VirtualBSDFBench.Sensor](../api-reference.md#simulationtemplatevirtualbsdfbenchsensor) + - [SimulationTemplate.VirtualBSDFBench.Sensor.SensorSamplingAutomatic](../api-reference.md#simulationtemplatevirtualbsdfbenchsensorsensorsamplingautomatic) + - [SimulationTemplate.VirtualBSDFBench.Sensor.SensorSamplingUniform](../api-reference.md#simulationtemplatevirtualbsdfbenchsensorsensorsamplinguniform) + - [SimulationTemplate.VirtualBSDFBench.SourceSamplingAdaptive](../api-reference.md#simulationtemplatevirtualbsdfbenchsourcesamplingadaptive) + - [SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformAnisotropic](../api-reference.md#simulationtemplatevirtualbsdfbenchsourcesamplinguniformanisotropic) + - [SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformIsotropic](../api-reference.md#simulationtemplatevirtualbsdfbenchsourcesamplinguniformisotropic) + - [SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformAnisotropic.PhiSymmetry](../api-reference.md#simulationtemplatevirtualbsdfbenchsourcesamplinguniformisotropicphisymmetry) +- Added [vbb_properties](../api-reference.md#scenesimulationinstance) as new field of the **Scene.SimulationInstance** object +- Added [Scene.SimulationInstance.VirtualBSDFBenchProperties](../api-reference.md#scenesimulationinstancevirtualbsdfbenchproperties) as new object of the **Scene.SimulationInstance** object +- Added [virtualbsdfbench_simulation_properties](../api-reference.md#job) as new field of the **Job** object +- Added [Job.VirtualBSDFBenchSimulationProperties](../api-reference.md#jobvirtualbsdfbenchsimulationproperties) as new oject of the **Job** object + +## Texture + +### Material + +- Added [Texture] as new object, coming with the [Texture.TextureNormalization](../api-reference.md#texturetexturenormalization) object +- Added [texture](../api-reference.md#soptemplate) as new field of the **SOPTemplate** object +- Added [SOPTemplate.Texture](../api-reference.md#soptemplatetexture) as new object of the **SOPTemplate** object, coming with the following created objects: + - [SOPTemplate.Texture.Image](../api-reference.md#soptemplatetextureimage) + - [SOPTemplate.Texture.NormalMap](../api-reference.md#soptemplatetexturenormalmap) + - [SOPTemplate.Texture.NormalMap.FromImage](../api-reference.md#soptemplatetexturenormalmapfromimage) + - [SOPTemplate.Texture.NormalMap.FromNormalMap](../api-reference.md#soptemplatetexturenormalmapfromnormalmap) +- Deprecated [sop_guids](../api-reference.md#scenematerialinstance) field from the **Scene.MaterialInstance** object +- Added [sop_guid](../api-reference.md#scenematerialinstance) as new field of the **Scene.MaterialInstance** object +- Added [texture](../api-reference.md#scenematerialinstance) as new field of the **Scene.MaterialInstance** object +- Added [SceneMaterialInstance.Texture](../api-reference.md#scenematerialinstancetexture) as new object of the **Scene.MaterialInstance** object, coming with the following created objects: + - [Scene.MaterialInstance.Texture.Layer](../api-reference.md#scenematerialinstancetexturelayer) + - [Scene.MaterialInstance.Texture.Layer.TextureMappingInfo](../api-reference.md#scenematerialinstancetexturelayertexturemappinginfo) + - [Scene.MaterialInstance.Texture.MappingOperator](../api-reference.md#scenematerialinstancetexturemappingoperator) + - [Scene.MaterialInstance.Texture.MappingOperator.Planar](../api-reference.md#scenematerialinstancetexturemappingoperatorplanar) + - [Scene.MaterialInstance.Texture.MappingOperator.Spherical](../api-reference.md#scenematerialinstancetexturemappingoperatorspherical) +- Added [texture](../api-reference.md#directmcsimulationtemplate) as new field of the **DirectMCSimulationTemplate** object +- Added [texture](../api-reference.md#inversemcsimulationtemplate) as new field of the **InverseMCSimulationTemplate** object +- Added [texture](../api-reference.md#simulationtemplateinteractive) as new field of the **SimulationTemplate.Interactive** object + +### Face + +- Added [vertices_data](../api-reference.md#chunk) as new field of the **Chunk** object +- Added [Chunk.VerticesData](../api-reference.md#chunkverticesdata) as new object of the **Chunk** object +- Added [vertices_data](../api-reference.md#face) as new field of the **Face** object +- Added [facets_data](../api-reference.md#chunk) as new field of the **Chunk** object +- Added [Chunk.FacetsData](../api-reference.md#chunkfacetsdata) as new object of the **Chunk** object +- Added [facets_data](../api-reference.md#face) as new field of the **Face** object +- Added [Face.MeshData](../api-reference.md#facemeshdata) as new object of the **Face** object +- Removed [texture_coordinates_channels](../api-reference.md#chunk) field from the **Chunk** object +- Removed [Chunk.TextureCoordinatesChannels](../api-reference.md#chunk) object from the **Chunk** object +- Removed [texture_coordinates_channels](../api-reference.md#face) field from the **Face** object +- Removed [Face.TextureCoordinates](../api-reference.md#face) object from the **Face** object diff --git a/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2523.md b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2523.md new file mode 100644 index 000000000..80d828a09 --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2523.md @@ -0,0 +1,5 @@ +# Speos RPC Changelog 2025 R2 SP03 + +## Secure Transport Protocols support + +SpeosRPC_Server has been improved to support different secure transport protocols (mutual TLS, Unix Domain Socket, Windows Named User Authentication). Besides SpeosRPC version 2025 R2 SP03, this improvement applies to the 2025 R1 SP04 version of SpeosRPC. For more information on how to run SpeosRPC_Server, see [How to launch SpeosRPC Server?](../index.md#how-to-launch-speosrpc-server) diff --git a/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_261.md b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_261.md new file mode 100644 index 000000000..afd37733a --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_261.md @@ -0,0 +1,165 @@ +# Speos RPC Changelog 2026 R1 + +## Sensor - VR Immersive sensor + +- Added [immersive_properties](../api-reference.md#scenesensorinstance-1) as new field of **Scene.SensorInstance** object in **scene v2** proto (scene/v2/scene.proto) +- Added [Scene.SensorInstance.ImmersiveProperties](../api-reference.md#scenesensorinstanceimmersiveproperties) as new object of **Scene.SensorInstance** object in **scene v2** proto (scene/v2/scene.proto) +- Added [immersive_sensor_template](../api-reference.md#sensortemplate-1) as new field of **SensorTemplate** object in **sensor** proto (sensor/v1/sensor.proto) +- Added [SensorTemplate.Immersive](../api-reference.md#sensortemplateimmersive) as new object of **SensorTemplate** object in **sensor** proto (sensor/v1/sensor.proto) +- Added [SensorTemplate.Immersive.ExcludeFaces](../api-reference.md#sensortemplateimmersiveexcludefaces) as new object of **SensorTemplate** object in **sensor** proto (sensor/v1/sensor.proto) +- Added [SensorTemplate.Stereo](../api-reference.md#sensortemplatestereo) as new object of **SensorTemplate** object in **sensor** proto (sensor/v1/sensor.proto) +- Added [SplitSpeos360IntoXMPs_Request](../api-reference.md#splitspeos360intoxmps_request) as new object of **map** proto (results/v1/map.proto) +- Added [SplitSpeos360IntoXMPs_Response](../api-reference.md#splitspeos360intoxmps_response) as new object of **map** proto (results/v1/map.proto) +- Added [SplitSpeos360IntoXMPs](../api-reference.md#mapactions) as new field of **MapActions** object in **map** proto (results/v1/map.proto) + +## Sensor - VR Observer sensor + +- Added [observer_properties](../api-reference.md#scenesensorinstance-1) as new field of **Scene.SensorInstance** object +- Added [Scene.SensorInstance.ObserverProperties](../api-reference.md#scenesensorinstanceobserverproperties) as new object of **Scene.SensorInstance** object in **scene v2** proto (scene/v2/scene.proto) +- Added [AngularRange](../api-reference.md#angularrange) as new object of **common** proto for sensors (sensor/v1/common.proto) +- Added [observer_sensor_template](../api-reference.md#sensortemplate) as new field of **SensorTemplate** object in **sensor** proto (sensor/v1/sensor.proto) +- Added [SensorTemplate.Observer](../api-reference.md#sensortemplateobserver) as new object of **SensorTemplate** object in **sensor** proto (sensor/v1/sensor.proto) +- Added [SensorTemplate.Stereo](../api-reference.md#sensortemplatestereo) as new object of **SensorTemplate** object in **sensor** proto (sensor/v1/sensor.proto) +- Added [SplitSpeos360IntoXMPs_Request](../api-reference.md#splitspeos360intoxmps_request) as new object of **map** proto (results/v1/map.proto) +- Added [SplitSpeos360IntoXMPs_Response](../api-reference.md#splitspeos360intoxmps_response) as new object of **map** proto (results/v1/map.proto) +- Added [SplitSpeos360IntoXMPs](../api-reference.md#mapactions) as new field of **MapActions** object in **map** proto (results/v1/map.proto) + +## Light Box: Scene (scene/v2/scene.proto) + +- Added [password](../api-reference.md#loadfile_request-1) as new field of **LoadFile_Request** object in **scene v2** proto (scene/v2/scene.proto) +- Added [sub_scene_anchor_axis_system](../api-reference.md#scene-1) as new field of **scene** object in **scene v2** proto (scene/v2/scene.proto) +- [LoadFile](../api-reference.md#sceneactions-1) field of **SceneActions** object can now load *.SPEOSLightBox files + +## Special character management: File Transfer (file/v1/file_transfer.proto) + +- Added [file_name](../api-reference.md#chunk) as new field of **Chunk** object +- Added [file_name](../api-reference.md#reserve_request) as new field of **Reserve_Request** object + +## Export job to *.speos: Job (job/v2/job.proto) + +The following new objects and field replace **SaveFile_Request**, **SaveFile_Response**, **SaveFile** of **scene v1** and **scene v2** which are now unsupported (see [Unsupported objects and fields](speos_changelogs_rpc_261.md#unsupported-objects-and-fields) section below) + +- Added [SaveFile_Request](../api-reference.md#savefile_request) as new object of **job v2** proto +- Added [SaveFile_Response](../api-reference.md#savefile_response) as new object of **job v2** proto +- Added [SaveFile](../api-reference.md#jobactions) as new field of **JobActions** object + +## Get running server version: Server_Info (server_info/v1/server_info.proto) + +- Added [server_info](../api-reference.md#server_infov1server_infoproto) as new proto containing the following objects: + - [GetVersion_Request](../api-reference.md#getversion_request) + - [GetVersion_Response](../api-reference.md#getversion_response) + - [ServerInfo](../api-reference.md#serverinfo) + +## Part (part/v1/part.proto) + +- Added [metadata](../api-reference.md#partpartinstance) as new field of **Part.PartInstance** object +- Added [Part.PartInstance.MetadataEntry](../api-reference.md#partpartinstancemetadataentry) as new object of **Part** object + +## Data (common/v1/data.proto) + +- Added [wavelength](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [distance](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [dimension](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [plane_angle](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [curvature](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [curvature_product](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [photometric_power_density](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [radiometric_power_density](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [spherical_probability_density](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [temperature_elevation](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [colorimetric_error](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [signal_to_noise_ratio](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [precision](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [relative_standard_error](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [refractive_power](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [refractive_index](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [absorption](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [x_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [y_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [u_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [v_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [u_prime_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [v_prime_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [u_star_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [v_star_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [a_star_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [b_star_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [uppercase_c_star_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [h_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [uppercase_x_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [uppercase_y_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [uppercase_z_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [uppercase_l_star_color](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [glare](../api-reference.md#magnitude) as new field of **Magnitude** object +- Added [watts_per_square_foot](../api-reference.md#unit) as new field of **Unit** object +- Added [watts_per_square_foot_nanometer](../api-reference.md#unit) as new field of **Unit** object +- Added [lumens_per_square_centimeter](../api-reference.md#unit) as new field of **Unit** object +- Added [foot_candles](../api-reference.md#unit) as new field of **Unit** object +- Added [foot_candles_per_nanometer](../api-reference.md#unit) as new field of **Unit** object +- Added [square_meters](../api-reference.md#unit) as new field of **Unit** object +- Added [square_centimeters](../api-reference.md#unit) as new field of **Unit** object +- Added [square_millimeters](../api-reference.md#unit) as new field of **Unit** object +- Added [square_micrometers](../api-reference.md#unit) as new field of **Unit** object +- Added [square_nanometers](../api-reference.md#unit) as new field of **Unit** object +- Added [square_feet](../api-reference.md#unit) as new field of **Unit** object +- Added [square_inches](../api-reference.md#unit) as new field of **Unit** object +- Added [no_unit](../api-reference.md#unit) as new field of **Unit** object + +## Object name displayed in report + +- Added [display_name](../api-reference.md#body) as new field of **Body** object in **body** proto (part/v1/body.proto) +- Added [display_name](../api-reference.md#chunkfaceheader) as new field of **Chunk.FaceHeader** object in **face** proto (part/v1/face.proto) +- Added [display_name](../api-reference.md#face) as new field of **Face** object in **face** proto (part/v1/face.proto) +- Added [display_name](../api-reference.md#partpartinstance) as new field of **Part.PartInstance** object in **part** proto (part/v1/part.proto) +- Added [display_name](../api-reference.md#scenematerialinstance) as new field of **Scene.MaterialInstance** object in **scene v2** proto (scene/v2/scene.proto) +- Added [display_name](../api-reference.md#scenesceneinstance-1) as new field of **Scene.SceneInstance** object in **scene v2** proto (scene/v2/scene.proto) +- Added [display_name](../api-reference.md#scenesensorinstance-1) as new field of **Scene.SensorInstance** object in **scene v2** proto (scene/v2/scene.proto) +- Added [display_name](../api-reference.md#scenesimulationinstance-1) as new field of **Scene.SimulationInstance** object in **scene v2** proto (scene/v2/scene.proto) +- Added [display_name](../api-reference.md#scenesourceinstance-1) as new field of **Scene.SourceInstance** object in **scene v2** proto (scene/v2/scene.proto) + +## Guid management of object + +- Added [guid](../api-reference.md#create_request) as new field of **Create_Request** object in **intensity** proto (intensity/v1/intensity.proto) +- Added [guid](../api-reference.md#create_request-1) as new field of **Create_Request** object in **job v2** proto (job/v2/job.proto) +- Added [guid](../api-reference.md#create_request-2) as new field of **Create_Request** object in **body** proto (part/v1/body.proto) +- Added [guid](../api-reference.md#create_request-3) as new field of **Create_Request** object in **face** proto (part/v1/face.proto) +- Added [guid](../api-reference.md#create_request-4) as new field of **Create_Request** object in **part** proto (part/v1/part.proto) +- Added [guid](../api-reference.md#create_request-6) as new field of **Create_Request** object in **scene v2** proto (scene/v2/scene.proto) +- Added [guid](../api-reference.md#create_request-7) as new field of **Create_Request** object in **sensor** proto (sensor/v1/sensor.proto) +- Added [guid](../api-reference.md#create_request-8) as new field of **Create_Request** object in **simulation_template** proto (simulation/v1/simulation_template.proto) +- Added [guid](../api-reference.md#create_request-9) as new field of **Create_Request** object in **sop** proto (sop/v1/sop.proto) +- Added [guid](../api-reference.md#create_request-10) as new field of **Create_Request** object in **source** proto (source/v1/source.proto) +- Added [guid](../api-reference.md#create_request-11) as new field of **Create_Request** object in **spectrum** proto (spectrum/v1/spectrum.proto) +- Added [guid](../api-reference.md#create_request-12) as new field of **Create_Request** object in **vop** proto (vop/v1/vop.proto) + +## Unsupported objects and fields + +- [OptisIntensityOptis](../api-reference.md#intensitytypes) field of **IntensityType** object in **base_map_template** proto (intensity_distributions/v1/base_map_template.proto) is now unsupported +- [OptisMapLayerTypeError](../api-reference.md#layertypes) field of **LayerTypes** object in **base_map_template** proto (intensity_distributions/v1/base_map_template.proto) is now unsupported +- [OptisMapTypeBasic](../api-reference.md#maptypes) field of **MapTypes** object in **base_map_template** proto (intensity_distributions/v1/base_map_template.proto) is now unsupported +- [OptisMapTypeLaser](../api-reference.md#maptypes) field of **MapTypes** object in **base_map_template** proto (intensity_distributions/v1/base_map_template.proto) is now unsupported +- [OptisUnitTypeFTM](../api-reference.md#unittypes) field of **UnitTypes** object in **base_map_template** proto (intensity_distributions/v1/base_map_template.proto) is now unsupported +- [OptisValueTypeSel](../api-reference.md#valuetypes) field of **ValueTypes** object in **base_map_template** proto (intensity_distributions/v1/base_map_template.proto) is now unsupported +- [OptisValueTypeLaserPhase](../api-reference.md#valuetypes) field of **ValueTypes** object in **base_map_template** proto (intensity_distributions/v1/base_map_template.proto) is now unsupported +- [OptisValueTypeLaserPhasePlane](../api-reference.md#valuetypes) field of **ValueTypes** object in **base_map_template** proto (intensity_distributions/v1/base_map_template.proto) is now unsupported +- [OptisValueTypeGain](../api-reference.md#valuetypes) field of **ValueTypes** object in **base_map_template** proto (intensity_distributions/v1/base_map_template.proto) is now unsupported +- [OptisValueTypeWaveFront](../api-reference.md#valuetypes) field of **ValueTypes** object in **base_map_template** proto (intensity_distributions/v1/base_map_template.proto) is now unsupported +- [OptisValueTypeFTM](../api-reference.md#valuetypes) field of **ValueTypes** object in **base_map_template** proto (intensity_distributions/v1/base_map_template.proto) is now unsupported +- [OptisValueTypeRP](../api-reference.md#valuetypes) field of **ValueTypes** object in **base_map_template** proto (intensity_distributions/v1/base_map_template.proto) is now unsupported +- [SaveFile_Request](../api-reference.md#savefile_request-1) object of **scene v1** proto (scene/v1/scene.proto) is now unsupported +- [SaveFile_Response](../api-reference.md#savefile_response-1) object of **scene v1** proto (scene/v1/scene.proto) is now unsupported +- [SaveFile](../api-reference.md#sceneactions) field of **SceneActions** object in **scene v1** proto (scene/v1/scene.proto) is now unsupported +- [SaveFile_Request](../api-reference.md#savefile_request-2) object of **Scene v2** proto (scene/v2/scene.proto) is now unsupported +- [SaveFile_Response](../api-reference.md#savefile_response-2) object of **Scene v2** proto (scene/v2/scene.proto) is now unsupported +- [SaveFile](../api-reference.md#sceneactions-1) field of **SceneActions** object in **Scene v2** proto (scene/v2/scene.proto) is now unsupported + +## Resolved Issues + +- Speos RPC has been optimized to provide better management of textures and multi-textures. (1301931 - 1303354) +- Speos RPC has been improved to better manage the Environment sources. (1367209) +- Speos RPC has been improved to better manage the axis systems. Non-orthonormal axis systems are no longer permitted. (1267988) +- Speos RPC has been improved to better manage UV Mappings from imported *.speos files. Now one material is created for each UV Map. (1273221) +- **Before**: Speos RPC was always setting the Flux from the intensity file for a Luminaire source when running a GPU simulation, even if the user did set a custom flux value. (1298194) +**Now**: Speos RPC correctly use the custom flux value when set by the user, and no longer defaults to the Flux from the intensity file. +- **Before**: when several *.polarizer files where used as input in a *.speos file, only one *.polarizer file was taken into account. (1301780) +**Now**: all *.polarizer files are correctly taken into account. diff --git a/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2611.md b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2611.md new file mode 100644 index 000000000..02648d63b --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2611.md @@ -0,0 +1,53 @@ +# Speos RPC Changelog 2026 R1 SP01 + +## Common (common/v1/data.proto) + +- Added [arcminutes](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [arcseconds](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [candelas_per_square_centimeter](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [candelas_per_square_foot](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [candelas_per_square_foot_nanometer](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [diopters](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [feet](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [foot_candles_seconds](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [foot_candles_seconds_per_nanometer](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [foot_lamberts](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [foot_lamberts_per_nanometer](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [inches](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [invert_foot](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [invert_inch](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [invert_meter](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [invert_millimeter](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [invert_steradian](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [joules_per_square_centimeter](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [joules_per_square_foot](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [joules_per_square_foot_nanometer](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [kelvin](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [lumens_per_cubic_meter](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [lumens_seconds_per_square_centimeter](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [millidiopters](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [milliradians](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [unit_precision](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [watts_per_cubic_centimeter](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [watts_per_cubic_meter](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [watts_per_square_centimeter](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [watts_per_square_foot_steradian](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [watts_per_square_foot_steradian_nanometer](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) +- Added [watts_per_square_meter_steradian_nanometer](../api-reference.md#unit) as new value of **Unit** enum in **common v1** (common/v1/data.proto) + +## Lightbox + +- Added [password](../api-reference.md#savefile_request-2) as new field of **SaveFile_Request** object in **scene v2** (scene/v2/scene.proto) +- Added [is_black_boxed](../api-reference.md#savefile_request-2) as new field of **SaveFile_Request** object in **scene v2** (scene/v2/scene.proto) + +## Service updates + +- [SaveFile](../api-reference.md#savefile_request-2) service in **scene v2** (scene/v2/scene.proto) is now fully supported (previously marked as unsupported) + +## Timeline - Animated simulation + +- Added [timeline](../api-reference.md#jobinversemcsimulationproperties) as new field of **Job.InverseMCSimulationProperties** object in **job v2** (job/v2/job.proto) +- Added [Job.Timeline](../api-reference.md#jobtimeline) as new object of **Job** object in **job v2** (job/v2/job.proto) +- Added [timeline](../api-reference.md#sourcetemplatesurface) as new field of **SourceTemplate.Surface** object in **source v1** (source/v1/source.proto) +- Added [SourceTemplate.Surface.Timeline](../api-reference.md#sourcetemplatesurfacetimeline) as new object of **SourceTemplate.Surface** object in **source v1** (source/v1/source.proto) +- Added [trajectory_file_uri](../api-reference.md#scenesceneinstance-1) as new field of **Scene.SceneInstance** object in **scene v2** (scene/v2/scene.proto) \ No newline at end of file diff --git a/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2612.md b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2612.md new file mode 100644 index 000000000..1feb9b894 --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/changelogs/speos_changelogs_rpc_2612.md @@ -0,0 +1,11 @@ +# Speos RPC Changelog + +## Results (results/v1/map.proto) + +- Added [ExportXMPToImage_Request](../api-reference.md#exportxmptoimage_request) as new object of **ExportXMPToImage_Request** object in **results v1** (results/v1/map.proto) +- Added [ExportXMPToImage_Response](../api-reference.md#exportxmptoimage_response) as new object of **ExportXMPToImage_Response** object in **results v1** (results/v1/map.proto) + +## Scene (scene/v2/scene.proto) + +- Added [Scene.SimulationInstance.SourceGroup](../api-reference.md#scenesimulationinstancesourcegroup) as new object of **Scene.SimulationInstance** object in **scene v2** (scene/v2/scene.proto) +- Added [source_groups](../api-reference.md#scenesimulationinstance) as new field of **Scene.SimulationInstance** object in **scene v2** (scene/v2/scene.proto) diff --git a/2026R1.2/speos_rpc-26-r1.2/classDiagram.png b/2026R1.2/speos_rpc-26-r1.2/classDiagram.png new file mode 100644 index 000000000..9ee406392 Binary files /dev/null and b/2026R1.2/speos_rpc-26-r1.2/classDiagram.png differ diff --git a/2026R1.2/speos_rpc-26-r1.2/classDiagram.svg b/2026R1.2/speos_rpc-26-r1.2/classDiagram.svg new file mode 100644 index 000000000..524a5dfe1 --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/classDiagram.svg @@ -0,0 +1,3 @@ + + +

compose

guid

compose

guid

compose

compose

guid

guid

compose

guid

compose

guid

compose

compose

compose

compose

compose

compose

guid

SensorTemplatesManager

+Create

+Read

+Update

+Delete

+List

SensorTemplate

string name

string description

map<string, string> metadata

OneOfUnsupported markdown: del sensor_template

SensorInstance

string name

string description

map<string, string> metadata

string sensor_guid - SensorTemplate guid coming from manager

OneOfUnsupported markdown: del properties

SourceTemplatesManager

+Create

+Read

+Update

+Delete

+List

SourceTemplate

string name

string description

map<string, string> metadata

OneOfUnsupported markdown: del source

SourceInstance

string name

string description

map<string, string> metadata

string source_guid - SourceTemplate guid coming from manager

OneOfUnsupported markdown: del properties

VOPTemplatesManager

+Create

+Read

+Update

+Delete

+List

VOPTemplate

string name

string description

map<string, string> metadata

OneOfUnsupported markdown: del type

SOPTemplatesManager

+Create

+Read

+Update

+Delete

+List

SOPTemplate

string name

string description

map<string, string> metadata

OneOfUnsupported markdown: del type

MaterialInstance

string name

string description

map<string, string> metadata

string vop_guid - VOPTemplate guid coming from manager

Vector<string> sop_guids - SOPTemplate guids coming from manager

GeoPaths geometries

SimulationTemplatesManager

+Create

+Read

+Update

+Delete

+List

SimulationTemplate

string name

string description

map<string, string> metadata

OneOfUnsupported markdown: del simulation_template

SimulationInstance

string name

string description

map<string, string> metadata

string simulation_guid - SimulationTemplate guid coming from manager

Vector<string> sensor_paths

Vector<string> source_paths

PartsManager

+Create

+Read

+Update

+Delete

+List

Part

string name

string description

map<string, string> metadata

Vector<string> body_guids

Vector<PartInstance> parts - sub parts

Scene

string part_guid - Part guid coming from manager

Vector<MaterialInstance> materials

Vector<SensorInstance> sensors

Vector<SourceInstance> sources

Vector<SimulationInstance> simulations

ScenesManager

+Create

+Read

+Update

+Delete

+List

JobsManager

+Create

+Read

+Update

+Delete

+List

Job

string name

string description

map<string, string> metadata

string scene_guid - Scene guid coming from manager

string simulation_path - Simulation path in the scene

Type job_type - CPU, GPU

OneOfUnsupported markdown: del simu_properties

 \ No newline at end of file diff --git a/2026R1.2/speos_rpc-26-r1.2/classDiagram.webp b/2026R1.2/speos_rpc-26-r1.2/classDiagram.webp new file mode 100644 index 000000000..cb18c4194 Binary files /dev/null and b/2026R1.2/speos_rpc-26-r1.2/classDiagram.webp differ diff --git a/2026R1.2/speos_rpc-26-r1.2/docfx.json b/2026R1.2/speos_rpc-26-r1.2/docfx.json new file mode 100644 index 000000000..84525e6d8 --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/docfx.json @@ -0,0 +1,13 @@ +{ + "build": { + "globalMetadata": { + "title": "Speos RPC 2026 R1 SP02", + "summary": "", + "version": "2026 R1 SP02", + "product": "Speos", + "programming language": "IronPython", + "product collection": "Optics", + "physics": "Optics" + } + } + } diff --git a/2026R1.2/speos_rpc-26-r1.2/flowchart.png b/2026R1.2/speos_rpc-26-r1.2/flowchart.png new file mode 100644 index 000000000..59b4733ec Binary files /dev/null and b/2026R1.2/speos_rpc-26-r1.2/flowchart.png differ diff --git a/2026R1.2/speos_rpc-26-r1.2/flowchart.svg b/2026R1.2/speos_rpc-26-r1.2/flowchart.svg new file mode 100644 index 000000000..2f3f5ce44 --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/flowchart.svg @@ -0,0 +1,3 @@ + + +

uses

uses

calls APIs from

calls python APIs from

uses UI

uses

Speos Solver

SpeosRPC Server

CADs / Labs / Viewers

User

PySpeos

 \ No newline at end of file diff --git a/2026R1.2/speos_rpc-26-r1.2/index.html b/2026R1.2/speos_rpc-26-r1.2/index.html new file mode 100644 index 000000000..925509e61 --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/index.html @@ -0,0 +1,20190 @@ + + + + + Protocol Documentation + + + + + + + + + + +

Protocol Documentation

+ +

Table of Contents

+ +
+ +
+ + + +
+

ansys/api/speos/LTF/v1/LTF.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

Filename

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
filenamestring

+ + + + + +

LightTransferData

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
object_directionVector3d

start_pointPoint3d

emissivitydouble

focus_distancedouble

divergence_Xdouble

divergence_Ydouble

pupil_surfaceLightTransferData.PupilSurface

+ + + + + +

LightTransferData.PupilSurface

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
diskPupilSurfaceDisk

ellipsePupilSurfaceEllipse

polygonPupilSurfacePolygon

+ + + + + +

LightTransferDataDistribution

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
dataLightTransferDatarepeated

+ + + + + +

Point2d

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
xdouble

ydouble

+ + + + + +

Point3d

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
xdouble

ydouble

zdouble

+ + + + + +

PupilSurfaceDisk

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
radiusdouble

+ + + + + +

PupilSurfaceEllipse

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
alphadouble

semi_major_axisdouble

semi_minor_axisdouble

+ + + + + +

PupilSurfacePolygon

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
nb_pointsint32

pointsPoint2drepeated

+ + + + + +

SpectralLightTransferDataDistribution

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
wavelength_samplesdoublerepeated

sensor_sampling_typeSensorSamplingType

sensor_samples_Xdoublerepeated

sensor_samples_Ydoublerepeated

pupil_surface_typePupilSurfaceType

ltf_samplesLightTransferDataDistributionrepeated

+ + + + + +

Vector3d

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
xdouble

ydouble

zdouble

+ + + + + + + +

PupilSurfaceType

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
POINT0

DISK1

ELLIPSE2

POLYGON3

+ +

SensorSamplingType

+

the sensor sampling type :

symmetric = polar coordinates

asymmetric = cartesian coordinates

+ + + + + + + + + + + + + + + + + + + +
NameNumberDescription
SYMMETRIC0

ASYMMETRIC1

+ + + + + +

LightTransferFunctionService

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
LoadFilename.google.protobuf.Empty

Serialization for *.OPTDistortion files

SaveFilename.google.protobuf.Empty

ImportSpectralLightTransferDataDistribution.google.protobuf.Empty

Import/Export of LightTransferDataDistribution

Export.google.protobuf.EmptySpectralLightTransferDataDistribution

+ + + + +
+

ansys/api/speos/bsdf/v1/anisotropic_bsdf.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

AnisotropicBsdfData

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
descriptionstring

anisotropy_vectorAnisotropicBsdfData.Double3

reflectionAnisotropicBsdfData.Bsdf

transmissionAnisotropicBsdfData.Bsdf

+ + + + + +

AnisotropicBsdfData.Bsdf

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
spectrum_incidencedouble

spectrum information + +radians in [0, pi/2]

spectrum_anisotropydouble

radians in [0, 2*pi]

spectrumAnisotropicBsdfData.Bsdf.WavelengthCoefficientPairrepeated

anisotropic_samplesAnisotropicBsdfData.Bsdf.AnisotropicSamplerepeated

+ + + + + +

AnisotropicBsdfData.Bsdf.AnisotropicSample

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
anisotropic_sampledouble

radians in [0, pi/2] or [0, pi] or [0, 2*pi]

incidence_samplesAnisotropicBsdfData.Bsdf.AnisotropicSample.IncidenceSamplerepeated

+ + + + + +

AnisotropicBsdfData.Bsdf.AnisotropicSample.IncidenceSample

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
incidence_sampledouble

radians in [0, pi/2]

theta_samplesdoublerepeated

intensity diagram + +radians in [0, pi/2] for reflection // radians in [pi/2, pi] for transmission

phi_samplesdoublerepeated

radians in [0, 2*pi]

bsdf_cos_thetadoublerepeated

1/steradians

integraldouble

reflection/transmission coefficient

+ + + + + +

AnisotropicBsdfData.Bsdf.WavelengthCoefficientPair

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
wavelengthdouble

nanometers

coefficientdouble

in [0, 1] interval

+ + + + + +

AnisotropicBsdfData.Double3

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
xdouble

direction cosines:

ydouble

zdouble

+ + + + + +

ConoscopicMap

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
output_file_namestring

.xmp

wavelengthdouble

nanometers

anisotropic_angledouble

radians in [0, 2*pi]

sideConoscopicMap.BsdfSide

resolutionint32

+ + + + + +

FileName

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
file_namestring

+ + + + + +

InterpolationEnhancementData

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
anisotropic_samplesInterpolationEnhancementData.AnisotropicSamplerepeated

+ + + + + +

InterpolationEnhancementData.AnisotropicSample

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
incidence_samplesInterpolationEnhancementData.AnisotropicSample.ConeDatarepeated

+ + + + + +

InterpolationEnhancementData.AnisotropicSample.ConeData

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
cone_half_angledouble

radians in [0, pi/2]

cone_heightdouble

value >= 0

+ + + + + +

RefractiveIndices

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
refractive_index_1double

refractive_index_2double

+ + + + + +

SpectrumImport

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
incidence_angledouble

radians in [0, pi/2]

anisotropy_angledouble

radians in [0, 2*pi]

file_namestring

+ + + + + +

SpecularInterpolationEnhancementData

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
reflectionInterpolationEnhancementData

transmissionInterpolationEnhancementData

refractive_index_1double

refractive_index_2double

+ + + + + +

Wavelength

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
wavelengthdouble

in nanometers

+ + + + + + + +

ConoscopicMap.BsdfSide

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
UNKNOWN0

REFLECTION1

TRANSMISSION2

+ + + + + +

AnisotropicBsdfService

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
LoadFileName.google.protobuf.Empty

serialization for native *.anisotropicbsdf files

SaveFileName.google.protobuf.Empty

ImportAnisotropicBsdfData.google.protobuf.Empty

to and from AnisoptropicSpeosBsdf.AnisotropicBsdfData

Export.google.protobuf.EmptyAnisotropicBsdfData

ImportFileFileName.google.protobuf.Empty

to and from serialized AnisoptropicSpeosBsdf.AnisotropicBsdfData

ExportFileFileName.google.protobuf.Empty

GenerateSpecularInterpolationEnhancementDataRefractiveIndices.google.protobuf.Empty

interpolation enhancement for specular

GetSpecularInterpolationEnhancementData.google.protobuf.EmptySpecularInterpolationEnhancementData

SetSpecularInterpolationEnhancementDataSpecularInterpolationEnhancementData.google.protobuf.Empty

GenerateRetroReflectionInterpolationEnhancementData.google.protobuf.Empty.google.protobuf.Empty

interpolation enhancement for retro reflection

GetRetroReflectionInterpolationEnhancementData.google.protobuf.EmptyInterpolationEnhancementData

SetRetroReflectionInterpolationEnhancementDataInterpolationEnhancementData.google.protobuf.Empty

EnableWhiteSpecularWavelength.google.protobuf.Empty

white specular

DisableWhiteSpecular.google.protobuf.Empty.google.protobuf.Empty

ImportReflectionSpectrumSpectrumImport.google.protobuf.Empty

spectrum import

ImportTransmissionSpectrumSpectrumImport.google.protobuf.Empty

FreezeAbsorptionReflectionTransmissionCoefficients.google.protobuf.Empty.google.protobuf.Empty

constant absorption

ExportToConoscopicMapConoscopicMap.google.protobuf.Empty

export to conoscopic map

+ + + + +
+

ansys/api/speos/bsdf/v1/bsdf_creation.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

AnisotropicBsdfInputData

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
input_anisotropic_bsdf_samplesAnisotropicBsdfInputData.Samplerepeated

fix_disparitybool

output_file_namestring

.anisotropicbsdf

+ + + + + +

AnisotropicBsdfInputData.Sample

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
anisotropic_angledouble

radians in [0, 2*pi]

file_namestring

.anisotropicbsdf

+ + + + + +

Bsdf180InputData

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
input_front_bsdf_file_namestring

.coated *.brdf *.anisotropicbsdf *.scattering

input_opposite_bsdf_file_namestring

.coated *.brdf *.anisotropicbsdf *.scattering

output_file_namestring

.bsdf180

+ + + + + +

SpectralBsdfInputData

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
input_anisotropic_samplesSpectralBsdfInputData.Samplerepeated

output_file_namestring

.brdf

+ + + + + +

SpectralBsdfInputData.Sample

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
wavelengthdouble

nanometers

file_namestring

.anisotropicbsdf

+ + + + + + + + + + + +

BsdfCreationService

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
BuildBsdf180Bsdf180InputData.google.protobuf.Empty

create a bsdf180 file

BuildSpectralBsdfSpectralBsdfInputData.google.protobuf.Empty

create spectral bsdf file

BuildAnisotropicBsdfAnisotropicBsdfInputData.google.protobuf.Empty

build anisotropic bsdf file

+ + + + +
+

ansys/api/speos/bsdf/v1/spectral_bsdf.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

ConoscopicMap

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
output_file_namestring

.xmp

wavelengthdouble

nanometers

sideConoscopicMap.BsdfSide

resolutionint32

+ + + + + +

FileName

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
file_namestring

+ + + + + +

RefractiveIndices

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
refractive_index_1double

refractive_index_2double

+ + + + + +

SpectralBsdfData

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
descriptionstring

incidence_samplesdoublerepeated

radians in [0, pi/2]

wavelength_samplesdoublerepeated

nanometers

wavelength_incidence_samplesSpectralBsdfData.WavelengthIncidencerepeated

+ + + + + +

SpectralBsdfData.WavelengthIncidence

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
reflectionSpectralBsdfData.WavelengthIncidence.Diagram

transmissionSpectralBsdfData.WavelengthIncidence.Diagram

+ + + + + +

SpectralBsdfData.WavelengthIncidence.Diagram

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
theta_samplesdoublerepeated

radians in [0, pi/2]

phi_samplesdoublerepeated

radians in [0, 2*pi]

bsdf_cos_thetadoublerepeated

1/steradians

integraldouble

reflection/transmission coefficient in [0, 1] interval

+ + + + + +

SpecularInterpolationEnhancementData

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
incidence_nbint32

wavelength_nbint32

refractive_index_1double

refractive_index_2double

wavelength_incidence_samplesSpecularInterpolationEnhancementData.WavelengthIncidencerepeated

+ + + + + +

SpecularInterpolationEnhancementData.WavelengthIncidence

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
reflectionSpecularInterpolationEnhancementData.WavelengthIncidence.ConeData

transmissionSpecularInterpolationEnhancementData.WavelengthIncidence.ConeData

+ + + + + +

SpecularInterpolationEnhancementData.WavelengthIncidence.ConeData

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
cone_half_angledouble

radians in [0, pi/2]

cone_heightdouble

value >= 0

+ + + + + + + +

ConoscopicMap.BsdfSide

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
UNKNOWN0

REFLECTION1

TRANSMISSION2

+ + + + + +

SpectralBsdfService

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
LoadFileName.google.protobuf.Empty

serialization for native *.brdf files

SaveFileName.google.protobuf.Empty

ImportSpectralBsdfData.google.protobuf.Empty

to and from SpectralSpeosBsdf.SpectralBsdfData

Export.google.protobuf.EmptySpectralBsdfData

ImportFileFileName.google.protobuf.Empty

to and from serialized SpectralSpeosBsdf.SpectralBsdfData

ExportFileFileName.google.protobuf.Empty

GenerateSpecularInterpolationEnhancementDataRefractiveIndices.google.protobuf.Empty

interpolation enhancement for specular

GetSpecularInterpolationEnhancementData.google.protobuf.EmptySpecularInterpolationEnhancementData

SetSpecularInterpolationEnhancementDataSpecularInterpolationEnhancementData.google.protobuf.Empty

ExportToConoscopicMapConoscopicMap.google.protobuf.Empty

export to conoscopic map

+ + + + +
+

ansys/api/speos/common/v1/data.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ANSYS Confidential Information

+ + +

DataBytes

+

raw buffer in bytes, to send any kind of data

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
valuesbytes

raw values

magnitude_sizeuint64

number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...)

dimensionsuint64repeated

size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size

magnitudeMagnitude

magnitude of the value cf what we have received

unitUnit

units of the values

+ + + + + +

DataDoubles

+

arrays values of doubles

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
valuesdoublerepeated

raw values

magnitude_sizeuint64

number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...)

dimensionsuint64repeated

size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size

magnitudeMagnitude

magnitude of the value cf what we have received

unitUnit

units of the values

+ + + + + +

DataFloats

+

arrays values of floats

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
valuesfloatrepeated

raw values

magnitude_sizeuint64

number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...)

dimensionsuint64repeated

size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size

magnitudeMagnitude

magnitude of the value cf what we have received

unitUnit

units of the values

+ + + + + +

DataIntegers32

+

arrays values of integers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
valuesint32repeated

raw values

magnitude_sizeuint64

number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...)

dimensionsuint64repeated

size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size

magnitudeMagnitude

magnitude of the value cf what we have received

unitUnit

units of the values

+ + + + + +

DataIntegers64

+

arrays values of integers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
valuesint64repeated

raw values

magnitude_sizeuint64

number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...)

dimensionsuint64repeated

size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size

magnitudeMagnitude

magnitude of the value cf what we have received

unitUnit

units of the values

+ + + + + +

DataUIntegers32

+

arrays values of integers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
valuesuint32repeated

raw values

magnitude_sizeuint64

number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...)

dimensionsuint64repeated

size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size

magnitudeMagnitude

magnitude of the value cf what we have received

unitUnit

units of the values

+ + + + + +

DataUIntegers64

+

arrays values of integers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
valuesuint64repeated

raw values

magnitude_sizeuint64

number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color_rgb=3 ...)

dimensionsuint64repeated

size of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension size

magnitudeMagnitude

magnitude of the value cf what we have received

unitUnit

units of the values

+ + + + + + + +

Magnitude

+

magnitudes in Speos data

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
irradiance0

radiometric irradiance

illuminance1

photometric irradiance

spectral_irradiance2

spectral irradiance

spectral_illuminance3

spectral photometric irradiance

radiance4

radiometric radiance

luminance5

photometric radiance

spectral_radiance6

spectral radiometric radiance

spectral_luminance7

spectral photometric radiance

radiant_intensity8

radiometric intensity

luminous_intensity9

photometric intensity

spectral_radiant_intensity10

spectral radiometric intensity

spectral_luminous_intensity11

spectral photometric intensity

exposure12

radiometric exposure

luminous_exposure13

photometric exposure

spectral_exposure14

spectral radiometric exposure

spectral_luminous_exposure15

spectral photometric exposure

radiant_flux16

radiometric flux

luminous_flux17

photometric flux

ratio27

magnitude ratio

color37

color

+ +

Unit

+

Units used in Speos data

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
watts0

W

watts_per_square_meters1

W/(m2)

watts_per_steradians2

W/(sr)

watts_per_nanometers3

W/(nm)

watts_per_square_meters_steradians4

W/(m2.sr)

watts_per_steradians_nanometers5

W/(sr.nm)

watts_per_square_meters_nanometers6

W/(m2.nm)

joules16

J

joules_per_nanometers17

J/(nm)

joules_per_square_meters18

J/(m2)

joules_per_square_meters_nanometers19

J/(m2.nm)

luxes29

lx

luxes_seconds30

lx.s

luxes_per_nanometers31

lx.s/(nm)

luxes_seconds_per_nanometers32

lx.s/(nm)

candelas42

cd

candelas_per_square_meters43

cd/(m2)

candelas_per_nanometers44

cd/(m2)

candelas_per_squaremeters_nanometers45

cd/(m2.nm)

lumens55

lm

lumens_seconds56

lm.s

lumens_per_nanometers57

lm/(nm)

lumens_per_square_meters_nanometers49

lm/(m2.nm)

percent60

%

color_XYZ70

XYZ CIE

color_xyY71

xy CIE

color_uvY72

uvY 1960 UCS CIE

color_uvY_prime73

u'v'Y' 1976 UCS CIE

color_Luv74

L*u*v CIELUV

color_Lab75

L*a*b CIELAB

color_LCh76

L*C*h CIELAB

color_rgb77

rgb

color_rgba79

rgba

nanometers120

nm

micrometers121

um

millimeters122

mm

meters123

m

radians124

rad

degrees125

deg

steradians126

sr

+ + + + + + + +
+

ansys/api/speos/file/v1/file_transfer.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

AddDependencies_Request

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
uristring

uri of the FileSystemItem to be completed with dependencies

dependency_urisstringrepeated

FileSystemItem uris to be added as dependencies

+ + + + + +

AddDependencies_Response

+

+ + + + + +

Chunk

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
binarybytes

sizeint64

+ + + + + +

Delete_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
uristring

uri of the FileSystemItem to be deleted

+ + + + + +

Delete_Response

+

+ + + + + +

Download_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
uristring

uri of the FileSystemItem to be downloaded

+ + + + + +

Download_Response

+

Used in File Transfer helpers

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
infoFileSystemItemInformation

Information about the FileSystemItem downloaded

download_durationgoogle.protobuf.Duration

+ + + + + +

FileSystemItemInformation

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
uristring

FileSystemItem uri

file_namestring

file_sizeuint64

+ + + + + +

ListDependencies_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
uristring

uri of the FileSystemItem

+ + + + + +

ListDependencies_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
dependency_infosFileSystemItemInformationrepeated

Information about the FileSystemItems noticed as dependencies

+ + + + + +

Reserve_Request

+

+ + + + + +

Reserve_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
uristring

uri of the FileSystemItem reserved

+ + + + + +

Upload_Response

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
infoFileSystemItemInformation

Information about the FileSystemItem created

upload_durationgoogle.protobuf.Duration

+ + + + + + + + + + + +

FileTransferService

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
ReserveReserve_RequestReserve_Response

Reserve a FileSystemItem

UploadChunk streamUpload_Response

Upload a file +Mandatory Client's Metadata: +key: "file-name" - value: file name +key: "file-size" - value: size of the file in bytes

DownloadDownload_RequestChunk stream

Download a FileSystemItem +Server's' Initial Metadata: +key: "file-name" - value: file name +key: "file-size" - value: size of the file in bytes

DeleteDelete_RequestDelete_Response

Delete a FileSystemItem

AddDependenciesAddDependencies_RequestAddDependencies_Response

Add dependencies to a FileSystemItem

ListDependenciesListDependencies_RequestListDependencies_Response

List all dependencies of a FileSystemItem

+ + + + +
+

ansys/api/speos/intensity/v1/intensity.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ANSYS Confidential Information

+ + +

Create_Request

+

Request to create a Intensity in IntensityTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
intensity_templateIntensityTemplate

Intensity containing its basic characteristics

+ + + + + +

Create_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Intensity created in IntensityTemplatesManager

+ + + + + +

Delete_Request

+

Request to delete a Intensity in IntensityTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Intensity to be deleted

+ + + + + +

Delete_Response

+

+ + + + + +

GetLibraryTypeInfo_Request

+

Request of GetLibraryTypeInfo

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the IntensityTemplate to get information about intensity file (example: flux). Only for IntensityTemplate of type Library.

+ + + + + +

GetLibraryTypeInfo_Response

+

Response of GetLibraryTypeInfo

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
fluxansys.api.speos.common.v1.DataDoubles

Flux of the intensity file

+ + + + + +

IntensityTemplate

+

Intensity with its basic characteristics

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

Intensity name

descriptionstring

Intensity descrition

metadataIntensityTemplate.MetadataEntryrepeated

User defined metadatas

libraryIntensityTemplate.Library

From file

lambertianIntensityTemplate.Lambertian

Lambertian distribution

cosIntensityTemplate.Cos

Lambert cosine law distribution

symmetric_gaussianIntensityTemplate.SymmetricGaussian

Deprecated (use gaussian instead) - Symmetric gaussian distribution

asymmetric_gaussianIntensityTemplate.AsymmetricGaussian

Deprecated (use gaussian instead) - Asymmetric gaussian distribution

gaussianIntensityTemplate.Gaussian

Gaussian distribution

+ + + + + +

IntensityTemplate.AsymmetricGaussian

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
FWHM_angle_xdouble

Full Width in degrees following x at Half Maximum

FWHM_angle_ydouble

Full Width in degrees following y at Half Maximum

total_angledouble

total angle in degrees of the emission of the light source

+ + + + + +

IntensityTemplate.Cos

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
Ndouble

Order of cos law

total_angledouble

total angle in degrees of the emission of the light source

+ + + + + +

IntensityTemplate.Gaussian

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
FWHM_angle_xdouble

Full Width in degrees following x at Half Maximum

FWHM_angle_ydouble

Full Width in degrees following y at Half Maximum

total_angledouble

total angle in degrees of the emission of the light source

+ + + + + +

IntensityTemplate.Lambertian

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
total_angledouble

total angle in degrees of the emission of the light source

+ + + + + +

IntensityTemplate.Library

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
intensity_file_uristring

uri of the intensity file IES (.ies), Eulumdat (.ldt), speos intensities (.xmp)

+ + + + + +

IntensityTemplate.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

IntensityTemplate.SymmetricGaussian

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
FWHM_angledouble

Full Width in degrees at Half Maximum

total_angledouble

total angle in degrees of the emission of the light source

+ + + + + +

List_Request

+

+ + + + + +

List_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of the Intensitys in IntensityTemplatesManager

+ + + + + +

Read_Request

+

Request to read a Intensity in IntensityTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Intensity to be read

+ + + + + +

Read_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
intensity_templateIntensityTemplate

Intensity corresponding to the guid given in Read_Request

+ + + + + +

Update_Request

+

Request to update a Intensity in IntensityTemplatesManager

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Intensity to be updated

intensity_templateIntensityTemplate

Intensity that will be used for the update

+ + + + + +

Update_Response

+

+ + + + + + + + + + + +

IntensityTemplateActions

+

Actions available on a IntensityTemplate

+ + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
GetLibraryTypeInfoGetLibraryTypeInfo_RequestGetLibraryTypeInfo_Response

Get information about intensity library template

+ + +

IntensityTemplatesManager

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a Intensity

ReadRead_RequestRead_Response

Read a Intensity

UpdateUpdate_RequestUpdate_Response

Update a Intensity

DeleteDelete_RequestDelete_Response

Delete a Intensity

ListList_RequestList_Response

List all Intensities in manager

+ + + + +
+

ansys/api/speos/intensity_distributions/v1/base_map_template.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

LayerData

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
layer_namestring

initial_source_powerdouble

initial_source_power_wattdouble

initial_source_power_lumendouble

wavelengthdoublerepeated

valuedoublerepeated

+ + + + + +

Map

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
x_nbint32

number of x samples

y_nbint32

number of y samples

layer_nbint32

number of layers

x_mindouble

x_maxdouble

y_mindouble

y_maxdouble

precisiondouble

value_typeValueTypes

intensity_typeIntensityTypes

unit_typeUnitTypes

colorimetric_standardCIEStandard

coordinate_unitCoordinateUnits

map_typeMapTypes

layer_typeLayerTypes

layerLayerDatarepeated

is_finite_distancebool

finite_difference_sensor_radiusdouble

detector_extentbool

rad_angular_resolution_radiusdouble

+ + + + + + + +

CIEStandard

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
CIE_STANDARD_UNKNOWN0

CIE_STANDARD_19311

CIE_STANDARD_19642

+ +

CoordinateUnits

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
OptisUnitDefault0

OptisUnitMillimetre1

OptisUnitDegree2

OptisUnitRadian3

OptisUnitFeet4

OptisUnitMicrometre5

OptisUnitNanometre6

OptisUnitMetre7

OptisUnitPercent8

OptisUnitdB9

OptisUnitInvertMillimetre10

OptisUnitNoUnit11

OptisUnitWave12

+ +

IntensityTypes

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
OptisIntensityOptis0

OptisIntensitySAETypeA1

OptisIntensitySAETypeB2

OptisIntensityConoscopic3

+ +

LayerTypes

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
OptisMapLayerTypeNone0

OptisMapLayerTypeSource1

OptisMapLayerTypeSurface2

OptisMapLayerTypeError3

OptisMapLayerTypeSequence4

OptisMapLayerTypePolarization5

OptisMapLayerTypeIncidenceAngle6

+ +

MapTypes

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
OptisMapTypeBasic0

OptisMapTypeLaser1

OptisMapTypeSpectral2

OptisMapTypeExtended3

OptisMapTypeUnknown4

OptisMapTypeGainMatrix5

OptisMapTypeRays6

OptisMapTypeFTM7

OptisMapTypeOptisVR8

OptisMapType3D9

+ +

UnitTypes

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
OptisUnitTypeRadiometric0

OptisUnitTypePhotometric1

OptisUnitTypeTemperature2

OptisUnitTypeUnknown3

OptisUnitTypeFTM4

OptisUnitTypeDegree5

OptisUnitTypeInverseMeter6

OptisUnitTypeInverseSquareMeter7

OptisUnitTypePercent8

OptisUnitTypeDiopter9

OptisUnitTypeMeter10

OptisUnitTypeInverseSteradian11

+ +

ValueTypes

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
OptisValueTypeIrradiance0

OptisValueTypeIntensity1

OptisValueTypeRadiance2

OptisValueTypeVisual3

OptisValueTypeSel4

OptisValueTypeLaserPhase5

OptisValueTypeLaserPhasePlane6

OptisValueTypeDirectionalIrradiance7

OptisValueTypeGain8

OptisValueTypeWaveFront9

OptisValueTypeFTM10

OptisValueTypeRP11

OptisValueTypePowerDensity12

OptisValueTypePopulation13

OptisValueTypeTemperature14

OptisValueTypeAngle15

OptisValueTypeCurvature16

OptisValueTypeCurvatureProduct17

OptisValueTypePercentage18

OptisValueTypeUnknown19

OptisValueTypeRefractivePower20

OptisValueTypeFlyThrough21

OptisValueTypeColorimetricError22

OptisValueTypeConoscopicRadiance23

OptisValueTypeSNR24

OptisValueTypeSNRIntensity25

OptisValueTypeSNRDirectionalIrradiance26

OptisValueTypePrecision27

OptisValueTypePrecisionIntensity28

OptisValueTypePrecisionDirectionalIrradiance29

OptisValueTypeDistance30

OptisValueTypeEyeSensorRadiance31

OptisValueTypeSphericalProbabilityDensity32

OptisValueTypeRSE33

OptisValueTypeRSEIntensity34

OptisValueTypeExposure35

+ + + + + + + +
+

ansys/api/speos/intensity_distributions/v1/eulumdat.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

EulumdatFileInformation

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
company_identificationstring

measurement_report_numberstring

luminaire_namestring

luminaire_numberstring

file_namestring

datestring

+ + + + + +

EulumdatIntensityData

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
number_lampsint32

type_lampsstring

total_luminous_fluxdouble

color_temperaturestring

color_rendering_indexstring

wattage_including_ballastdouble

+ + + + + +

EulumdatIntensityDistribution

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
descriptionstring

file_infoEulumdatFileInformation

type_indicatorint32

symmetry_indicatorint32

c_plane_numberint32

distance_c_planesdouble

g_angle_numberint32

distance_g_angledouble

diameter_luminairedouble

width_luminairedouble

height_luminairedouble

diameter_luminous_areadouble

width_luminous_areadouble

height_luminous_area_c0double

height_luminous_area_c90double

height_luminous_area_c180double

height_luminous_area_c270double

downward_flux_fractiondouble

light_ouput_ratiodouble

conversion_factordouble

measurement_tiltdouble

number_standard_set_lampsint32

lamp_distributionEulumdatIntensityDatarepeated

direct_ratiodoublerepeated

c_planedoublerepeated

g_angledoublerepeated

luminous_intensity_per_klmdoublerepeated

+ + + + + +

Export_Request

+

+ + + + + +

Import_Response

+

+ + + + + +

Load_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
file_uristring

+ + + + + +

Load_Response

+

+ + + + + +

Save_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
file_uristring

+ + + + + +

Save_Response

+

+ + + + + + + + + + + +

EulumdatIntensityService

+

service to manage eulumdat file

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
LoadLoad_RequestLoad_Response

Load CEulumdat from filename

SaveSave_RequestSave_Response

Save CEulumdat to filename

ImportEulumdatIntensityDistributionImport_Response

import EulumdatIntensityDistribution to CEulumdat

ExportExport_RequestEulumdatIntensityDistribution

export CEulumdat to EulumdatIntensityDistribution

+ + + + +
+

ansys/api/speos/intensity_distributions/v1/extended_map_template.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

ExtendedMap

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
base_dataMap

valueValues

+ + + + + +

Values

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
layerValues.Layersrepeated

map layers

+ + + + + +

Values.Layers

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
yValues.Layers.ysrepeated

y samples of the map

+ + + + + +

Values.Layers.ys

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
xdoublerepeated

x samples of the map

+ + + + + + + + + + + + + +
+

ansys/api/speos/intensity_distributions/v1/ies.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

Export_Request

+

+ + + + + +

IesIntensityDistribution

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
norme_versionint32

key_wordsstringrepeated

unitint32

nb_vertical_angleint32

nb_horizontal_angleint32

tilt_typeint32

tilt_geometryint32

nb_lampint32

photo_typeint32

lumen_lampdouble

multiplierdouble

widthdouble

lengthdouble

heightdouble

ballastdouble

future_usedouble

input_wattdouble

vertical_angledoublerepeated

horizontal_angledoublerepeated

candela_valuedoublerepeated

tilt_angledoublerepeated

tilt_mult_factordoublerepeated

local_vertdouble

tilt_nb_pair_angleint32

+ + + + + +

Import_Response

+

+ + + + + +

Load_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
file_uristring

+ + + + + +

Load_Response

+

+ + + + + +

Save_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
file_uristring

+ + + + + +

Save_Response

+

+ + + + + + + + + + + +

IesIntensityService

+

service to manage IES files

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
LoadLoad_RequestLoad_Response

serialization for native files

SaveSave_RequestSave_Response

ImportIesIntensityDistributionImport_Response

import export of IesIntensityDistribution to CIES

ExportExport_RequestIesIntensityDistribution

+ + + + +
+

ansys/api/speos/intensity_distributions/v1/spectral_map_template.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

ColorValues

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
layerColorValues.Layersrepeated

map layer

+ + + + + +

ColorValues.Layers

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
yColorValues.Layers.ysrepeated

y samples of the map

+ + + + + +

ColorValues.Layers.ys

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
xColorValues.Layers.ys.xsrepeated

x samples of the map

+ + + + + +

ColorValues.Layers.ys.xs

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
color_xfloat

color_yfloat

color_zfloat

radiofloat

+ + + + + +

Depth

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
yDepth.ysrepeated

y samples of the map

+ + + + + +

Depth.ys

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
xfloatrepeated

x samples of the map

+ + + + + +

SpectralMap

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
base_dataMap

wavelength_nbint32

wavelength_mindouble

wavelength_maxdouble

spectral_valueSpectralValues

spectral values

color_valueColorValues

colorimetric and radiometric data

depth_valueDepth

spectral_data_loadedbool

spectral data is not always loaded unless explicitly specified

depth_data_loadedbool

depth data not always filled out

+ + + + + +

SpectralValues

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
layerSpectralValues.Layersrepeated

map layer

+ + + + + +

SpectralValues.Layers

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
wavelengthSpectralValues.Layers.Wavelengthsrepeated

wavelength

+ + + + + +

SpectralValues.Layers.Wavelengths

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
ySpectralValues.Layers.Wavelengths.ysrepeated

y samples of the map

+ + + + + +

SpectralValues.Layers.Wavelengths.ys

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
xfloatrepeated

x samples of the map

+ + + + + + + + + + + + + +
+

ansys/api/speos/intensity_distributions/v1/xmp.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

Export_Request

+

+ + + + + +

Import_Response

+

+ + + + + +

Load_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
file_uristring

+ + + + + +

Load_Response

+

+ + + + + +

Save_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
file_uristring

+ + + + + +

Save_Response

+

+ + + + + +

XmpDistribution

+

xmp map definition

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
extended_mapExtendedMap

spectral_mapSpectralMap

+ + + + + + + + + + + +

XmpIntensityService

+

service to manage XMP files

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
LoadLoad_RequestLoad_Response

Load XMP intensity distributions from file

SaveSave_RequestSave_Response

Save XMP intensity distributions to file

ImportXmpDistributionImport_Response

import XmpDistribution to COptisMap

ExportExport_RequestXmpDistribution

export COPtisMap to XmpDistribution

+ + + + +
+

ansys/api/speos/job/v2/job.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ANSYS Confidential Information

+ + +

Create_Request

+

Request to create a Job in JobsManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
jobJob

Job characteristics

+ + + + + +

Create_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Job created in JobsManager

+ + + + + +

Delete_Request

+

Request to delete a Job in JobsManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Job to be deleted

+ + + + + +

Delete_Response

+

+ + + + + +

GetError_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Job in JobsManager.

+ + + + + +

GetError_Response

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

categorystring

severityint32

requeststring

diagnosticstring

advicestring

error_filestring

error_lineint32

+ + + + + +

GetInformation_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Job in JobsManager.

+ + + + + +

GetInformation_Response

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
titlestring

namestring

infosstring

progressdouble

value between 0.0 and 1.0

elapsed_timegoogle.protobuf.Duration

remaining_timegoogle.protobuf.Duration

process_unit_modelsstringrepeated

Depending on the Job::Type, list of the CPU or GPU models

rays_numberuint64

Number of rays emitted since the (re)start of the simulation

rays_number_per_seconduint64

Number of rays emitted in the last second

+ + + + + +

GetProgressStatus_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Job in JobsManager.

+ + + + + +

GetProgressStatus_Response

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
titlestring

namestring

infosstring

progressdouble

value between 0.0 and 1.0

elapsed_timegoogle.protobuf.Duration

remaining_timegoogle.protobuf.Duration

process_unit_modelsstringrepeated

Depending on the Job::Type, list of the CPU or GPU models

rays_numberuint64

Number of rays emitted since the (re)start of the simulation

rays_number_per_seconduint64

Number of rays emitted in the last second

+ + + + + +

GetRayPaths_Request

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Job in JobsManager.

raw_databooloptional

Boolean to get the wavelengths in response stream

display_databooloptional

Boolean to get the colors (RGB24 format) in response stream

+ + + + + +

GetResults_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Job in JobsManager.

+ + + + + +

GetResults_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
resultsResultrepeated

list of the Job results

+ + + + + +

GetState_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Job in JobsManager.

+ + + + + +

GetState_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
stateJob.State

+ + + + + +

Job

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

Job name

descriptionstring

Job descrition

metadataJob.MetadataEntryrepeated

User defined metadatas

scene_guidstring

Guid of the Scene in ScenesManager

simulation_pathstring

simulation path in the scene that will be used by the job

job_typeJob.Type

Type of the job : CPU, GPU, ...

direct_mc_simulation_propertiesJob.DirectMCSimulationProperties

Properties to be filled for simulation based on DirectMCSimulationTemplate

inverse_mc_simulation_propertiesJob.InverseMCSimulationProperties

Properties to be filled for simulation based on InverseMCSimulationTemplate

interactive_simulation_propertiesJob.InteractiveSimulationProperties

Properties to be filled for simulation based on Interactive

+ + + + + +

Job.DirectMCSimulationProperties

+

If several stop conditions are set, the first condition reached ends the simulation.

If no stop condition is set, the simulation ends when you stop the process.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
stop_condition_rays_numberint64optional

To stop the simulation after a certain number of rays were sent

stop_condition_durationint64optional

To stop the simulation after a certain duration

automatic_save_frequencyint32

Define a backup interval (s). This option is useful when computing long simulations. But a reduced number of save operations naturally increases the simulation performance

+ + + + + +

Job.InteractiveSimulationProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
rays_number_per_sourcesJob.InteractiveSimulationProperties.RaysNumberPerSourcerepeated

If a source present in Scene::SimulationInstance is not mentionned here, its rays_nb is defaulted to 100.

light_expertbool

To generate a light expert file.

impact_reportbool

To integrate details like number of impacts, position and surface state to the HTML simulation report.

+ + + + + +

Job.InteractiveSimulationProperties.RaysNumberPerSource

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
source_pathstring

path to the source. Hint: same path that was given in Scene::SimulationInstance

rays_nbuint32optional

Number of rays sent by the source referenced via its source_path. Default 100

+ + + + + +

Job.InverseMCSimulationProperties

+

If several stop conditions are set, the first condition reached ends the simulation.

If no stop condition is set, the simulation ends when you stop the process.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
optimized_propagation_noneJob.InverseMCSimulationProperties.OptimizedPropagationNone

No optimization. Don't forget to fill stop conditions if needed.

optimized_propagation_relativeJob.InverseMCSimulationProperties.OptimizedPropagationRelative

optimized_propagation_absoluteJob.InverseMCSimulationProperties.OptimizedPropagationAbsolute

stop_condition_durationint64optional

To stop the simulation after a certain duration

automatic_save_frequencyint32

Define a backup interval (s). This option is useful when computing long simulations. But a reduced number of save operations naturally increases the simulation performance

+ + + + + +

Job.InverseMCSimulationProperties.OptimizedPropagationAbsolute

+

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 SNR is adequate in areas where pixels need more rays thus giving a balanced image.

The Optimized propagation algorithm is only compatible with the Radiance sensors.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
min_pass_numberuint32

Minimum number of passes without pass optimization.

stop_condition_absolute_valueuint32

Absolute photometric value of pixel standard deviation threshold

+ + + + + +

Job.InverseMCSimulationProperties.OptimizedPropagationNone

+

No optimization : the same number of passes is used for each pixel of the image

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
stop_condition_passes_numberuint32optional

To stop the simulation after a certain number of passes

+ + + + + +

Job.InverseMCSimulationProperties.OptimizedPropagationRelative

+

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 SNR is adequate in areas where pixels need more rays thus giving a balanced image.

The Optimized propagation algorithm is only compatible with the Radiance sensors.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
min_pass_numberuint32

Minimum number of passes without pass optimization.

stop_condition_relative_valueuint32

Relative pixel standard deviation threshold, in percent. Value expected from 0 to 100.

+ + + + + +

Job.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

List_Request

+

+ + + + + +

List_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of the Jobs in JobsManager

+ + + + + +

Read_Request

+

Request to read a Job in JobsManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Job to be read

+ + + + + +

Read_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
jobJob

Job corresponding to the guid given in Read_Request

+ + + + + +

Result

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
pathstring

result path on the server

upload_responseansys.api.speos.file.v1.Upload_Response

result uploaded to server's file system (via FileTransferService) -> returns Upload_Response

+ + + + + +

Start_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Job in JobsManager.

+ + + + + +

Start_Response

+

+ + + + + +

Stop_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Job in JobsManager.

+ + + + + +

Stop_Response

+

+ + + + + +

Update_Request

+

Request to update a Job in JobsManager

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Job to be updated

jobJob

Job that will be used for the update

+ + + + + +

Update_Response

+

+ + + + + + + +

Job.State

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
QUEUED0

RUNNING1

PAUSED2

STOPPED3

FINISHED4

IN_ERROR5

+ +

Job.Type

+

+ + + + + + + + + + + + + + + + + + + +
NameNumberDescription
CPU0

GPU1

+ + + + + +

JobActions

+

Service to handle a job

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
GetStateGetState_RequestGetState_Response

Get the state of a Job

StartStart_RequestStart_Response

Start a Job

StopStop_RequestStop_Response

Stop a Job

GetErrorGetError_RequestGetError_Response

Get error of a Job

GetResultsGetResults_RequestGetResults_Response

Get the results of a Job

GetInformationGetInformation_RequestGetInformation_Response

Get Information about a Job

GetRayPathsGetRayPaths_Request.ansys.api.speos.results.v1.RayPath stream

Get RayPaths generated by a Job based on an interactive simulation

GetProgressStatusGetProgressStatus_RequestGetProgressStatus_Response

Get progress status about a Job

+ + + + +

Methods with deprecated option

+ + + + + + + + + + + + + + + +
Method NameOption
GetInformation

true

+ + +

JobsManager

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a Job

ReadRead_RequestRead_Response

Read a Job

UpdateUpdate_RequestUpdate_Response

Update a Job

DeleteDelete_RequestDelete_Response

Delete a Job

ListList_RequestList_Response

List all Jobs in manager

+ + + + +
+

ansys/api/speos/lpf/v2/lpf_file_reader.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

CloseLpfFileName_Request_Mono

+

+ + + + + +

CloseLpfFileName_Request_Multi

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
lpf_reader_guidstring

+ + + + + +

CloseLpfFileName_Response

+

+ + + + + +

ComputeUniqueFaceId_Request_Mono

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
body_context_iduint32

face_iduint32

+ + + + + +

ComputeUniqueFaceId_Request_Multi

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
lpf_reader_guidstring

body_context_iduint32

face_iduint32

+ + + + + +

ComputeUniqueFaceId_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
unique_face_iduint32

+ + + + + +

Create_Request_Multi

+

+ + + + + +

Create_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
lpf_reader_guidstring

+ + + + + +

Delete_Request_Multi

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
lpf_reader_guidstring

+ + + + + +

Delete_Response

+

+ + + + + +

DoubletDouble

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
xdouble

ydouble

+ + + + + +

GetInformation_Request_Mono

+

+ + + + + +

GetInformation_Request_Multi

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
lpf_reader_guidstring

+ + + + + +

GetInformation_Response

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
nb_of_tracesint64

nb_of_xmpsuint32

has_sensor_contributionsbool

sensor_namesstringrepeated

The sensor position in the repeated field sensor_names gives the sensor_id

+ + + + + +

InitLpfFileName_Request_Mono

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
lpf_file_uristring

This can be uri returned by the server when uploading the file, or a local path (in this case the file has to be accessible by the server)

+ + + + + +

InitLpfFileName_Request_Multi

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
lpf_reader_guidstring

lpf_file_uristring

This can be uri returned by the server when uploading the file, or a local path (in this case the file has to be accessible by the server)

+ + + + + +

InitLpfFileName_Response

+

+ + + + + +

RayPath

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
impactsTripletFloatrepeated

wavelengthsdoublerepeated

body_context_idsuint32repeated

unique_face_idsuint32repeated

interaction_statusesRayPath.PhotonStatusrepeated

lastDirectionTripletFloat

sensor_contributionsRayPath.SensorContributionrepeated

+ + + + + +

RayPath.SensorContribution

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sensor_iduint32

The sensor_id corresponds to the position of the sensor in the repeated field GetInformation_Response::sensor_names

coordinatesDoubletDouble

+ + + + + +

Read_Request_Mono

+

+ + + + + +

Read_Request_Multi

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
lpf_reader_guidstring

+ + + + + +

TripletFloat

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
xfloat

yfloat

zfloat

+ + + + + + + +

RayPath.PhotonStatus

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
StatusAbsorbed0

StatusSpecularTransmitted1

StatusGaussianTransmitted2

StatusLambertianTransmitted3

StatusVolumicDiffused4

StatusJustEmitted5

StatusDiracTransmitted6

StatusError7

StatusErrorVolumicBodyNotClosed8

StatusErrorVolumeConflict9

StatusError2DTangency10

StatusError2DIntersect3DWarning11

StatusErrorNonOpticalMaterial12

StatusErrorIntersection13

StatusErrorNonOpticalMaterialAtEmission14

StatusError3DTextureSupportTangency15

StatusLast16

StatusFirst-7

StatusDiracReflected-6

StatusReserved-5

StatusGrinStep-4

StatusLambertianReflected-3

StatusGaussianReflected-2

StatusSpecularReflected-1

+ + + + + +

LpfFileReader_Mono

+

service to read lpf file - server can handle one reading - call CloseLpfFileName then InitLpfFileName to start another reading.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
InitLpfFileNameInitLpfFileName_Request_MonoInitLpfFileName_Response

Init the lpf file with its path - returns nothing

GetInformationGetInformation_Request_MonoGetInformation_Response

Get information about the lpf file, for example number of traces, number of xmps...

CloseLpfFileNameCloseLpfFileName_Request_MonoCloseLpfFileName_Response

Close the lpf file - returns nothing

ReadRead_Request_MonoRayPath stream

Read lpf file and get all the ray paths

ComputeUniqueFaceIdComputeUniqueFaceId_Request_MonoComputeUniqueFaceId_Response

Compute a unique face id from bodyContextId and faceId

+ + +

LpfFileReader_Multi

+

service to read lpf file - server can handle several reading.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_Request_MultiCreate_Response

Create a lpf file reader - returns its guid

InitLpfFileNameInitLpfFileName_Request_MultiInitLpfFileName_Response

Init the lpf file with its path - returns nothing

GetInformationGetInformation_Request_MultiGetInformation_Response

Get information about the lpf file, for example number of traces, number of xmps...

CloseLpfFileNameCloseLpfFileName_Request_MultiCloseLpfFileName_Response

Close the lpf file - returns nothing

ReadRead_Request_MultiRayPath stream

Read lpf file and get all the ray paths

ComputeUniqueFaceIdComputeUniqueFaceId_Request_MultiComputeUniqueFaceId_Response

Compute a unique face id from bodyContextId and faceId

DeleteDelete_Request_MultiDelete_Response

Delete a lpf file reader - returns nothing

+ + + + +
+

ansys/api/speos/part/v1/body.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ANSYS Confidential Information

+ + +

Body

+

CRUD //

////////

Body definition made of faces

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataBody.MetadataEntryrepeated

User defined metadatas

face_guidsstringrepeated

List of faces constituting the body

+ + + + + +

Body.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Create_Request

+

Request to create a body

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
bodyBody

body to create

+ + + + + +

Create_Response

+

Response to create a body

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the created body

+ + + + + +

Delete_Request

+

Request to delete a body

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the body to be deleted

+ + + + + +

Delete_Response

+

Response to delete a body

+ + + + + +

List_Request

+

Request to list all bodies

+ + + + + +

List_Response

+

Response to list all bodies

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of all bodies

+ + + + + +

Read_Request

+

Request to read a body

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the body to be read

+ + + + + +

Read_Response

+

Response to read a body

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
bodyBody

body corresponding to the guid given in Read_Request

+ + + + + +

Update_Request

+

Request to update a body

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the body to be updated

bodyBody

New body that will be used for the update

+ + + + + +

Update_Response

+

Response to update a body

+ + + + + + + + + + + +

BodiesManager

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a new body

ReadRead_RequestRead_Response

Read a body

UpdateUpdate_RequestUpdate_Response

Update a body

DeleteDelete_RequestDelete_Response

Delete a body

ListList_RequestList_Response

List all body in manager

+ + +

BodyActions

+

ACTIONS //

///////////

Actions available on a body

+ + + + + + + +
Method NameRequest TypeResponse TypeDescription
+ + + + +
+

ansys/api/speos/part/v1/face.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ANSYS Confidential Information

+ + +

Chunk

+

ACTIONS //

///////////

Chunk of a Face

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
face_headerChunk.FaceHeader

Common face data - Field used only in first Chunk (to take advantage of vectors sizes)

verticesChunk.Vertices

coordinates of all points (p1x p1y p1z p2x p2y p2z ...)

facetsChunk.Facets

indexes of points for all triangles (t1_1 t1_2 t1_3 t2_1 t2_2 t2_3 ...)

normalsChunk.Normals

normal vector for all points (n1x n1y n1z n2x n2y n2z ...)

texture_coordinates_channelsChunk.TextureCoordinatesChannels

+ + + + + +

Chunk.FaceHeader

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of a FacesManager element - Used for FaceActions.Upload rpc

namestring

descriptionstring

metadataChunk.FaceHeader.MetadataEntryrepeated

sizesint32repeated

total sizes for vectors: (vertices_normals_size, facets_size, texture_coordinates_channels_size) - vertices and normals vectors have same size, that's why it is gathered in vertices_normals_size

+ + + + + +

Chunk.FaceHeader.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Chunk.Facets

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
datauint32repeated

+ + + + + +

Chunk.Normals

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
datafloatrepeated

+ + + + + +

Chunk.TextureCoordinatesChannels

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
dataFace.TextureCoordinatesrepeated

+ + + + + +

Chunk.Vertices

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
datafloatrepeated

+ + + + + +

Create_Request

+

Request to create a face

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
faceFace

face to create

+ + + + + +

Create_Response

+

Response to create a face

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the created face

+ + + + + +

Delete_Request

+

Request to delete a face

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the face to be deleted

+ + + + + +

Delete_Response

+

Response to delete a face

+ + + + + +

Download_Request

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of a FacesManager element

+ + + + + +

Face

+

Face definition with meshing information

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataFace.MetadataEntryrepeated

user defined metadatas

verticesfloatrepeated

coordinates of all points (p1x p1y p1z p2x p2y p2z ...)

facetsuint32repeated

indexes of points for all triangles (t1_1 t1_2 t1_3 t2_1 t2_2 t2_3 ...)

normalsfloatrepeated

normal vector for all points (n1x n1y n1z n2x n2y n2z ...)

texture_coordinates_channelsFace.TextureCoordinatesrepeated

if we want apply textures on this face, we have to set a TextureCoordinates per texture

+ + + + + +

Face.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Face.TextureCoordinates

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
uvfloatrepeated

coordinates (u_1 v_1 ... u_NbPoints v_NbPoints) representating bridge between vertices and point on texture

+ + + + + +

List_Request

+

Request to list all faces

+ + + + + +

List_Response

+

Response to list all faces

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of all faces

+ + + + + +

Read_Request

+

Request to read a face

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the face to be read

+ + + + + +

Read_Response

+

Response to read a face

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
faceFace

face corresponding to the guid given in Read_Request

+ + + + + +

Update_Request

+

Request to update a face

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the face to be updated

faceFace

New face that will be used for the update

+ + + + + +

Update_Response

+

Response to update a face

+ + + + + +

Upload_Response

+

+ + + + + + + + + + + +

FaceActions

+

Actions available on a face

+ + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
UploadChunk streamUpload_Response

Update a face via streaming

DownloadDownload_RequestChunk stream

Read a face via streaming

+ + +

FacesManager

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a new face

ReadRead_RequestRead_Response

Read a face

UpdateUpdate_RequestUpdate_Response

Update a face

DeleteDelete_RequestDelete_Response

Delete a face

ListList_RequestList_Response

List all face in manager

+ + + + +
+

ansys/api/speos/part/v1/part.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ANSYS Confidential Information

+ + +

Create_Request

+

Request to create an element

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
partPart

Element to create

+ + + + + +

Create_Response

+

Response to create an element

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the created element

+ + + + + +

Delete_Request

+

Request to delete an element

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the element to be deleted

+ + + + + +

Delete_Response

+

Response to delete an element

+ + + + + +

List_Request

+

Request to list all elements

+ + + + + +

List_Response

+

Response to list all elements

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of all Parts

+ + + + + +

Part

+

Part definition, a Part is related to a CAD part file (scdocx, prt, ...) made of meshed bodies and faces

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataPart.MetadataEntryrepeated

User defined metadatas

body_guidsstringrepeated

List of bodies constituting the part

partsPart.PartInstancerepeated

List of sub parts

+ + + + + +

Part.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Part.PartInstance

+

Instance of Part in parent coordinates system

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

part_guidstring

Guid of Part in PartsManager

axis_systemdoublerepeated

Part position relative to parent reference (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

+ + + + + +

Read_Request

+

Request to read an element

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the element to be read

+ + + + + +

Read_Response

+

Response to read an element

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
partPart

Element corresponding to the guid given in Read_Request

+ + + + + +

Update_Request

+

Request to update an element

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the PartTemplate to be updated

partPart

New element that will be used for the update

+ + + + + +

Update_Response

+

Response to update an element

+ + + + + + + + + + + +

PartActions

+

Actions available on a Part

+ + + + + + + +
Method NameRequest TypeResponse TypeDescription
+ + +

PartsManager

+

Service to manage geometrical objects

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a new part

ReadRead_RequestRead_Response

Read a part

UpdateUpdate_RequestUpdate_Response

Update a part

DeleteDelete_RequestDelete_Response

Delete a part

ListList_RequestList_Response

List all part in manager

+ + + + +
+

ansys/api/speos/results/v1/ray_path.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ANSYS Confidential Information

+ + +

RayPath

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
impacts_coordinatesfloatrepeated

Impacts coordinates of this RayPath. (i0x, i0y, i0z, i1x, i1y, i1z, ..., iNx, iNy, iNz) with N+1 impacts

wavelengthsdoublerepeated

Wavelength at each impact.

body_context_idsuint32repeated

ID of the body impacted at each impact.

unique_face_idsuint32repeated

ID of the face impacted at each impact.

interaction_statusesRayPath.PhotonStatusrepeated

Interaction type at each impact with the elements encountered.

last_directionfloatrepeated

Direction after the last impact. (x, y, z)

colorsansys.api.speos.common.v1.DataBytes

The color in RGB24 format at each impact

+ + + + + + + +

RayPath.PhotonStatus

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
StatusAbsorbed0

StatusSpecularTransmitted1

StatusGaussianTransmitted2

StatusLambertianTransmitted3

StatusVolumicDiffused4

StatusJustEmitted5

StatusDiracTransmitted6

StatusError7

StatusErrorVolumicBodyNotClosed8

StatusErrorVolumeConflict9

StatusError2DTangency10

StatusError2DIntersect3DWarning11

StatusErrorNonOpticalMaterial12

StatusErrorIntersection13

StatusErrorNonOpticalMaterialAtEmission14

StatusError3DTextureSupportTangency15

StatusLast16

StatusFirst-7

StatusDiracReflected-6

StatusReserved-5

StatusGrinStep-4

StatusLambertianReflected-3

StatusGaussianReflected-2

StatusSpecularReflected-1

+ + + + + + + +
+

ansys/api/speos/scene/v1/scene.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ANSYS Confidential Information

+ + +

Create_Request

+

Request to create a Scene in ScenesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sceneScene

+ + + + + +

Create_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Scene created in ScenesManager

+ + + + + +

Delete_Request

+

Request to delete a Scene in ScenesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Scene to be deleted

+ + + + + +

Delete_Response

+

+ + + + + +

GetSourceRayPaths_Request

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of a ScenesManager element

source_pathstring

path to the source in the Scene : "<source name>" for a specific source in the current scene, or "<scene name>/<source name>" for a specific source in a specific sub scene

rays_nbuint32optional

Number of rays sent by the source. Default 100

raw_databooloptional

Boolean to get the wavelengths in response stream

display_databooloptional

Boolean to get the colors (RGB24 format) in response stream

+ + + + + +

List_Request

+

+ + + + + +

List_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of the Scenes in ScenesManager

+ + + + + +

LoadFile_Request

+

Request to LoadFile service

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of a ScenesManager element to update

file_uristring

File uri (path or guid from FileTransferService)

+ + + + + +

LoadFile_Response

+

Response to LoadFile service

+ + + + + +

Read_Request

+

Request to read a Scene in ScenesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Scene to be read

+ + + + + +

Read_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sceneScene

Scene corresponding to the guid given in Read_Request

+ + + + + +

SaveFile_Request

+

Request to SaveFile service

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of a ScenesManager element to save

file_uristring

File uri (path or guid from FileTransferService)

+ + + + + +

SaveFile_Response

+

Response to SaveFile service

+ + + + + +

Scene

+

Optical scene definition made of parts, optical properties, sources, sensors and simulations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.MetadataEntryrepeated

User defined metadatas

part_guidstring

Guid from PartsManager of the geometrical part included inside the scene

vopsScene.VOPInstancerepeated

The volume materials applied on geometries

sopsScene.SOPInstancerepeated

The surface materials applied on geometries

sourcesScene.SourceInstancerepeated

The sources added in the scene

sensorsScene.SensorInstancerepeated

The sensors added in the scene

simulationsScene.SimulationInstancerepeated

The simulations added in the scene

scenesScene.SceneInstancerepeated

Sub scenes

+ + + + + +

Scene.GeoPaths

+

Geometry path of object that will include the specific property (can be sub-scene/part/body/face).

Empty or "" for all geometries, or in the format : /// (no name by default for root scene and root part).

"part1" -> part1 of the root part in the root scene

"part1/body1/face1" -> face1 in body1 in part1 of the root part in the root scene

"subScene1" -> root part in the sub scene subScene1

"subScene1/part2" -> part2 of the sub scene subScene1

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
geo_pathsstringrepeated

list of geo paths

+ + + + + +

Scene.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Scene.SOPInstance

+

Instance of a SOP to apply on geometries of the scene

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.SOPInstance.MetadataEntryrepeated

User defined metadatas

sop_guidstring

Guid of the element to instanciate

geometriesScene.GeoPaths

Geometries that will use this material

+ + + + + +

Scene.SOPInstance.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Scene.SceneInstance

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.SceneInstance.MetadataEntryrepeated

User defined metadatas

scene_guidstring

Guid of the element to instantiate

axis_systemdoublerepeated

Scene position relative to parent PartTemplate reference (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

+ + + + + +

Scene.SceneInstance.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Scene.SensorInstance

+

Instance of a sensor to add in the scene

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.SensorInstance.MetadataEntryrepeated

User defined metadatas

sensor_guidstring

Guid of the SensorTemplate in SensorTemplatesManager to instantiate

result_file_namestring

Result file name without extention. Result files of the sensor will be based on this name.

camera_sensor_propertiesScene.SensorInstance.CameraSensorProperties

To be filled if the sensor_guid corresponds to a SensorTemplate of type CameraSensorTemplate

irradiance_sensor_propertiesScene.SensorInstance.IrradianceSensorProperties

To be filled if the sensor_guid corresponds to a SensorTemplate of type IrradianceSensorTemplate

radiance_sensor_propertiesScene.SensorInstance.RadianceSensorProperties

To be filled if the sensor_guid corresponds to a SensorTemplate of type SensorTemplate::Radiance

+ + + + + +

Scene.SensorInstance.CameraSensorProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

trajectory_file_uristring

Trajectory file, used to define the position and orientations of the Camera sensor in time.

layer_type_noneScene.SensorInstance.LayerTypeNone

Layer type : None

layer_type_sourceScene.SensorInstance.LayerTypeSource

Layer type : Source

+ + + + + +

Scene.SensorInstance.IrradianceSensorProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

ray_file_typeScene.SensorInstance.EnumRayFileType

Choose type of ray file generated after the simulation.

layer_type_noneScene.SensorInstance.LayerTypeNone

Layer type : None

layer_type_sourceScene.SensorInstance.LayerTypeSource

Layer type : Source

layer_type_faceScene.SensorInstance.LayerTypeFace

Layer type : Face

layer_type_sequenceScene.SensorInstance.LayerTypeSequence

Layer type : Sequence

layer_type_polarizationScene.SensorInstance.LayerTypePolarization

Layer type : Polarization

layer_type_incidence_angleScene.SensorInstance.LayerTypeIncidenceAngle

Layer type : Incidence angle

integration_directiondoublerepeated

Sensor global integration direction [x,y,z], optional (default direction is normal to sensor plane (anti-normal of the sensor)) and only settable for sensor template with IlluminanceTypePlanar or IlluminanceTypeSemiCylindrical as illuminance_type

output_face_geometriesScene.GeoPaths

List of output faces for inverse simulation optimization

+ + + + + +

Scene.SensorInstance.LayerTypeFace

+

Includes one layer per surface selected in the result.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sca_filtering_modeScene.SensorInstance.LayerTypeFace.EnumSCAFilteringType

layersScene.SensorInstance.LayerTypeFace.Layerrepeated

Layers that will be taken into account in the result.

+ + + + + +

Scene.SensorInstance.LayerTypeFace.Layer

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

Name of the layer (will appear for example in Virtual Photometric Lab)

geometriesScene.GeoPaths

Surface selected.

+ + + + + +

Scene.SensorInstance.LayerTypeIncidenceAngle

+

Include one layer per range of incident angles.

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
samplinguint32

+ + + + + +

Scene.SensorInstance.LayerTypeNone

+

Includes the simulation's results in one layer.

+ + + + + +

Scene.SensorInstance.LayerTypePolarization

+

Includes one layer per Stokes parameter using the polarization parameter.

+ + + + + +

Scene.SensorInstance.LayerTypeSequence

+

Includes one layer per sequence in the result.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
maximum_nb_of_sequenceuint32

define_sequence_perScene.SensorInstance.LayerTypeSequence.EnumSequenceType

+ + + + + +

Scene.SensorInstance.LayerTypeSource

+

Includes one layer per active source in the result.

+ + + + + +

Scene.SensorInstance.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Scene.SensorInstance.RadianceSensorProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

observer_pointdoublerepeated

Position of the observer point (Ox Oy Oz), optional (default: focal length is used)

layer_type_noneScene.SensorInstance.LayerTypeNone

Layer type : None

layer_type_sourceScene.SensorInstance.LayerTypeSource

Layer type : Source

layer_type_faceScene.SensorInstance.LayerTypeFace

Layer type : Face

layer_type_sequenceScene.SensorInstance.LayerTypeSequence

Layer type : Sequence

+ + + + + +

Scene.SimulationInstance

+

Instance of a simulation to add in the scene

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.SimulationInstance.MetadataEntryrepeated

User defined metadatas

simulation_guidstring

Guid of the element to instantiate

sensor_pathsstringrepeated

Sensors that this simulation will include (empty or "" for all sensors, "<sensor name>" for a specific sensor in the current scene, or "<scene name>/<sensor name>" for a specific sensor in a specific sub scene)

source_pathsstringrepeated

Sources that this simulation will include (empty or "" for all sources, "<source name>" for a specific source in the current scene, or "<scene name>/<source name>" for a specific source in a specific sub scene)

geometriesScene.GeoPaths

Geometries that this simulation will include (empty to select the root part and all the subscenes)

+ + + + + +

Scene.SimulationInstance.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Scene.SourceInstance

+

Instance of a source to add in the scene

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.SourceInstance.MetadataEntryrepeated

User defined metadatas

source_guidstring

Guid of the SourceTemplate in SourceTemplatesManager to instantiate

luminaire_propertiesScene.SourceInstance.LuminaireProperties

To be filled if the source_guid corresponds to a SourceTemplate of type Luminaire

surface_propertiesScene.SourceInstance.SurfaceProperties

To be filled if the source_guid corresponds to a SourceTemplate of type Surface

rayfile_propertiesScene.SourceInstance.RayFileProperties

To be filled if the source_guid corresponds to a SourceTemplate of type RayFile

+ + + + + +

Scene.SourceInstance.IntensityProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
library_propertiesScene.SourceInstance.IntensityProperties.LibraryProperties

To be filled if the intensity_guid of the source template corresponds to an IntensityTemplate of type Library

asymmetric_gaussian_propertiesScene.SourceInstance.IntensityProperties.AsymmetricGaussianProperties

Deprecated (use gaussian_properties instead) - To be filled if the intensity_guid of the source template corresponds to an IntensityTemplate of type AsymmetricGaussian

gaussian_propertiesScene.SourceInstance.IntensityProperties.GaussianProperties

To be filled if the intensity_guid of the source template corresponds to an IntensityTemplate of type Gaussian

+ + + + + +

Scene.SourceInstance.IntensityProperties.AsymmetricGaussianProperties

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

orientation (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

+ + + + + +

Scene.SourceInstance.IntensityProperties.GaussianProperties

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

optional - orientation of the intensity distribution (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) - if not filled : normal to surface map.

+ + + + + +

Scene.SourceInstance.IntensityProperties.LibraryProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
exit_geometriesScene.GeoPaths

Exit Geometries that will use this surface source

axis_systemScene.SourceInstance.IntensityProperties.LibraryProperties.AxisSystem

orientation (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

normal_to_surfaceScene.SourceInstance.IntensityProperties.LibraryProperties.NormalToSurface

Define the intensity distribution as normal to the selected surface.

normal_to_uv_mapScene.SourceInstance.IntensityProperties.LibraryProperties.NormalToUVMap

Define the intensity distribution as normal to the selected emissive surface and its orientation on the emissive surface.

+ + + + + +

Scene.SourceInstance.IntensityProperties.LibraryProperties.AxisSystem

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
valuesdoublerepeated

orientation (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

+ + + + + +

Scene.SourceInstance.IntensityProperties.LibraryProperties.NormalToSurface

+

Define the intensity distribution as normal to the selected surface.

+ + + + + +

Scene.SourceInstance.IntensityProperties.LibraryProperties.NormalToUVMap

+

Define the intensity distribution as normal to the selected emissive surface and its orientation on the emissive surface.

+ + + + + +

Scene.SourceInstance.LuminaireProperties

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

Position of the source (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

+ + + + + +

Scene.SourceInstance.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Scene.SourceInstance.RayFileProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

Position of the source (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

exit_geometriesScene.GeoPaths

Exit Geometries that will use this rayfile source

+ + + + + +

Scene.SourceInstance.SurfaceProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
exitance_constant_propertiesScene.SourceInstance.SurfaceProperties.ExitanceConstantProperties

To be filled if the Surface SourceTemplate has ExitanceConstant

exitance_variable_propertiesScene.SourceInstance.SurfaceProperties.ExitanceVariableProperties

To be filled if the Surface SourceTemplate has ExitanceVariable

intensity_propertiesScene.SourceInstance.IntensityProperties

+ + + + + +

Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
geo_pathsScene.SourceInstance.SurfaceProperties.ExitanceConstantProperties.GeoPathrepeated

+ + + + + +

Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties.GeoPath

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
geo_pathstring

Geometry that will use this surface source ("<body name>" for a whole body, or "<body name>/<face name>" for a specific face)

reverse_normalbooloptional

optional - if not set or false : normal is not reversed.

+ + + + + +

Scene.SourceInstance.SurfaceProperties.ExitanceVariableProperties

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_planedoublerepeated

Position of the exitance map (Ox Oy Oz Xx Xy Xz Yx Yy Yz)

+ + + + + +

Scene.VOPInstance

+

Instance of a VOP to apply on geometries of the scene

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.VOPInstance.MetadataEntryrepeated

User defined metadatas

vop_guidstring

Guid of the element to instanciate

geometriesScene.GeoPaths

Geometries that will use this material

+ + + + + +

Scene.VOPInstance.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Update_Request

+

Request to update a Scene in ScenesManager

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Scene to be updated

sceneScene

Scene that will be used for the update

+ + + + + +

Update_Response

+

+ + + + + + + +

Scene.SensorInstance.EnumRayFileType

+

Ray file types available

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
RayFileNone0

Generates no ray file.

RayFileClassic1

Generates a ray file without polarization data.

RayFilePolarization2

Generates a ray file with the polarization data for each ray.

RayFileTM253

Generates a .tm25ray file with polarization data for each ray.

RayFileTM25NoPolarization4

Generates a .tm25ray file without polarization data.

+ +

Scene.SensorInstance.LayerTypeFace.EnumSCAFilteringType

+

+ + + + + + + + + + + + + + + + + + + +
NameNumberDescription
LastImpact0

IntersectedOneTime1

+ +

Scene.SensorInstance.LayerTypeSequence.EnumSequenceType

+

+ + + + + + + + + + + + + + + + + + + +
NameNumberDescription
Geometries0

Faces1

+ + + + + +

SceneActions

+

Actions available on a Scene

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
LoadFileLoadFile_RequestLoadFile_Response

Load .speos file

SaveFileSaveFile_RequestSaveFile_Response

Save .speos file

GetSourceRayPathsGetSourceRayPaths_Request.ansys.api.speos.results.v1.RayPath stream

Get RayPaths generated by a source

+ + +

ScenesManager

+

Manager for Scenes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a Scene

ReadRead_RequestRead_Response

Read a Scene

UpdateUpdate_RequestUpdate_Response

Update a Scene

DeleteDelete_RequestDelete_Response

Delete a Scene

ListList_RequestList_Response

List all Scenes in manager

+ + + + +
+

ansys/api/speos/scene/v2/scene.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ANSYS Confidential Information

+ + +

Create_Request

+

Request to create a Scene in ScenesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sceneScene

+ + + + + +

Create_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Scene created in ScenesManager

+ + + + + +

Delete_Request

+

Request to delete a Scene in ScenesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Scene to be deleted

+ + + + + +

Delete_Response

+

+ + + + + +

GetSourceRayPaths_Request

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of a ScenesManager element

source_pathstring

path to the source in the Scene : "<source name>" for a specific source in the current scene, or "<scene name>/<source name>" for a specific source in a specific sub scene

rays_nbuint32optional

Number of rays sent by the source. Default 100

raw_databooloptional

Boolean to get the wavelengths in response stream

display_databooloptional

Boolean to get the colors (RGB24 format) in response stream

+ + + + + +

List_Request

+

+ + + + + +

List_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of the Scenes in ScenesManager

+ + + + + +

LoadFile_Request

+

Request to LoadFile service

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of a ScenesManager element to update

file_uristring

File uri (path or guid from FileTransferService)

+ + + + + +

LoadFile_Response

+

Response to LoadFile service

+ + + + + +

Read_Request

+

Request to read a Scene in ScenesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Scene to be read

+ + + + + +

Read_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sceneScene

Scene corresponding to the guid given in Read_Request

+ + + + + +

SaveFile_Request

+

Request to SaveFile service

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of a ScenesManager element to save

file_uristring

File uri (path or guid from FileTransferService)

+ + + + + +

SaveFile_Response

+

Response to SaveFile service

+ + + + + +

Scene

+

Optical scene definition made of parts, optical properties, sources, sensors and simulations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.MetadataEntryrepeated

User defined metadatas

part_guidstring

Guid from PartsManager of the geometrical part included inside the scene

sourcesScene.SourceInstancerepeated

The sources added in the scene

sensorsScene.SensorInstancerepeated

The sensors added in the scene

simulationsScene.SimulationInstancerepeated

The simulations added in the scene

materialsScene.MaterialInstancerepeated

The materials (volume + surface) applied on geometries

scenesScene.SceneInstancerepeated

Sub scenes

+ + + + + +

Scene.GeoPath

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
geo_pathstring

Geometry that will be used ("<body name>" for a whole body, or "<body name>/<face name>" for a specific face)

reverse_normalbooloptional

optional - if not set or false : normal is not reversed.

+ + + + + +

Scene.GeoPaths

+

Geometry path of object that will include the specific property (can be sub-scene/part/body/face).

geo_path in the format : "///" (no name by default for root scene and root part).

"body0" -> body0 of the root part in the root scene

"body0/face0" -> face0 in body0 of the root part in the root scene

"part1" -> part1 of the root part in the root scene

"part1/body1/face1" -> face1 in body1 in part1 of the root part in the root scene

"subScene1" -> root part in the sub scene subScene1

"subScene1/part2" -> part2 of the sub scene subScene1

Particularities:

If the object GeoPaths is defined and geo_paths left empty, this means "All geometry selected".

If the object GeoPaths is NOT defined, this means "No geometry selected".

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
geo_pathsstringrepeated

list of geo paths

+ + + + + +

Scene.MaterialInstance

+

Instance of a Material to apply on geometries of the scene

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.MaterialInstance.MetadataEntryrepeated

User defined metadatas

vop_guidstringoptional

optional - Guid of the volume optical property to instanciate

sop_guidsstringrepeated

Guid(s) of the surface optical property(ies) to instanciate

geometriesScene.GeoPaths

Geometries that will use this material

+ + + + + +

Scene.MaterialInstance.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Scene.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Scene.SceneInstance

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.SceneInstance.MetadataEntryrepeated

User defined metadatas

scene_guidstring

Guid of the element to instantiate

axis_systemdoublerepeated

Scene position relative to parent PartTemplate reference (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

+ + + + + +

Scene.SceneInstance.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Scene.SensorInstance

+

Instance of a sensor to add in the scene

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.SensorInstance.MetadataEntryrepeated

User defined metadatas

sensor_guidstring

Guid of the SensorTemplate in SensorTemplatesManager to instantiate

result_file_namestring

Result file name without extention. Result files of the sensor will be based on this name.

camera_propertiesScene.SensorInstance.CameraProperties

To be filled if the sensor_guid corresponds to a SensorTemplate of type CameraSensorTemplate

irradiance_propertiesScene.SensorInstance.IrradianceProperties

To be filled if the sensor_guid corresponds to a SensorTemplate of type IrradianceSensorTemplate

radiance_propertiesScene.SensorInstance.RadianceProperties

To be filled if the sensor_guid corresponds to a SensorTemplate of type SensorTemplate::Radiance

+ + + + + +

Scene.SensorInstance.CameraProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

trajectory_file_uristring

Trajectory file, used to define the position and orientations of the Camera sensor in time.

layer_type_noneScene.SensorInstance.LayerTypeNone

Layer type : None

layer_type_sourceScene.SensorInstance.LayerTypeSource

Layer type : Source

+ + + + + +

Scene.SensorInstance.IrradianceProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

ray_file_typeScene.SensorInstance.EnumRayFileType

Choose type of ray file generated after the simulation.

layer_type_noneScene.SensorInstance.LayerTypeNone

Layer type : None

layer_type_sourceScene.SensorInstance.LayerTypeSource

Layer type : Source

layer_type_faceScene.SensorInstance.LayerTypeFace

Layer type : Face

layer_type_sequenceScene.SensorInstance.LayerTypeSequence

Layer type : Sequence

layer_type_polarizationScene.SensorInstance.LayerTypePolarization

Layer type : Polarization

layer_type_incidence_angleScene.SensorInstance.LayerTypeIncidenceAngle

Layer type : Incidence angle

integration_directiondoublerepeated

Sensor global integration direction [x,y,z], optional (default direction is normal to sensor plane (anti-normal of the sensor)) and only settable for sensor template with IlluminanceTypePlanar or IlluminanceTypeSemiCylindrical as illuminance_type

output_face_geometriesScene.GeoPaths

List of output faces for inverse simulation optimization

+ + + + + +

Scene.SensorInstance.LayerTypeFace

+

Includes one layer per surface selected in the result.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sca_filtering_modeScene.SensorInstance.LayerTypeFace.EnumSCAFilteringType

layersScene.SensorInstance.LayerTypeFace.Layerrepeated

Layers that will be taken into account in the result.

+ + + + + +

Scene.SensorInstance.LayerTypeFace.Layer

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

Name of the layer (will appear for example in Virtual Photometric Lab)

geometriesScene.GeoPaths

Surface selected.

+ + + + + +

Scene.SensorInstance.LayerTypeIncidenceAngle

+

Include one layer per range of incident angles.

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
samplinguint32

+ + + + + +

Scene.SensorInstance.LayerTypeNone

+

Includes the simulation's results in one layer.

+ + + + + +

Scene.SensorInstance.LayerTypePolarization

+

Includes one layer per Stokes parameter using the polarization parameter.

+ + + + + +

Scene.SensorInstance.LayerTypeSequence

+

Includes one layer per sequence in the result.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
maximum_nb_of_sequenceuint32

define_sequence_perScene.SensorInstance.LayerTypeSequence.EnumSequenceType

+ + + + + +

Scene.SensorInstance.LayerTypeSource

+

Includes one layer per active source in the result.

+ + + + + +

Scene.SensorInstance.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Scene.SensorInstance.RadianceProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

observer_pointdoublerepeated

Position of the observer point (Ox Oy Oz), optional (default: focal length is used)

layer_type_noneScene.SensorInstance.LayerTypeNone

Layer type : None

layer_type_sourceScene.SensorInstance.LayerTypeSource

Layer type : Source

layer_type_faceScene.SensorInstance.LayerTypeFace

Layer type : Face

layer_type_sequenceScene.SensorInstance.LayerTypeSequence

Layer type : Sequence

+ + + + + +

Scene.SimulationInstance

+

Instance of a simulation to add in the scene

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.SimulationInstance.MetadataEntryrepeated

User defined metadatas

simulation_guidstring

Guid of the element to instantiate

sensor_pathsstringrepeated

Sensors that this simulation will include (empty for no sensor, [""] for all sensors, "<sensor name>" for a specific sensor in the current scene, or "<scene name>/<sensor name>" for a specific sensor in a specific sub scene)

source_pathsstringrepeated

Sources that this simulation will include (empty for no source, [""] for all sources, "<source name>" for a specific source in the current scene, or "<scene name>/<source name>" for a specific source in a specific sub scene)

geometriesScene.GeoPaths

Geometries that this simulation will include - Not yet functional (All geometry is included by default to each simulation)

+ + + + + +

Scene.SimulationInstance.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Scene.SourceInstance

+

Instance of a source to add in the scene

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

descriptionstring

metadataScene.SourceInstance.MetadataEntryrepeated

User defined metadatas

source_guidstring

Guid of the SourceTemplate in SourceTemplatesManager to instantiate

luminaire_propertiesScene.SourceInstance.LuminaireProperties

To be filled if the source_guid corresponds to a SourceTemplate of type Luminaire

surface_propertiesScene.SourceInstance.SurfaceProperties

To be filled if the source_guid corresponds to a SourceTemplate of type Surface

rayfile_propertiesScene.SourceInstance.RayFileProperties

To be filled if the source_guid corresponds to a SourceTemplate of type RayFile

+ + + + + +

Scene.SourceInstance.IntensityProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
library_propertiesScene.SourceInstance.IntensityProperties.LibraryProperties

To be filled if the intensity_guid of the source template corresponds to an IntensityTemplate of type Library

gaussian_propertiesScene.SourceInstance.IntensityProperties.GaussianProperties

To be filled if the intensity_guid of the source template corresponds to an IntensityTemplate of type Gaussian

+ + + + + +

Scene.SourceInstance.IntensityProperties.GaussianProperties

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

optional - orientation of the intensity distribution (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) - if not filled : normal to surface map.

+ + + + + +

Scene.SourceInstance.IntensityProperties.LibraryProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
exit_geometriesScene.GeoPaths

Exit Geometries that will use this surface source

axis_systemScene.SourceInstance.IntensityProperties.LibraryProperties.AxisSystem

orientation (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

normal_to_surfaceScene.SourceInstance.IntensityProperties.LibraryProperties.NormalToSurface

Define the intensity distribution as normal to the selected surface.

normal_to_uv_mapScene.SourceInstance.IntensityProperties.LibraryProperties.NormalToUVMap

Define the intensity distribution as normal to the selected emissive surface and its orientation on the emissive surface.

+ + + + + +

Scene.SourceInstance.IntensityProperties.LibraryProperties.AxisSystem

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
valuesdoublerepeated

orientation (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

+ + + + + +

Scene.SourceInstance.IntensityProperties.LibraryProperties.NormalToSurface

+

Define the intensity distribution as normal to the selected surface.

+ + + + + +

Scene.SourceInstance.IntensityProperties.LibraryProperties.NormalToUVMap

+

Define the intensity distribution as normal to the selected emissive surface and its orientation on the emissive surface.

+ + + + + +

Scene.SourceInstance.LuminaireProperties

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

Position of the source (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

+ + + + + +

Scene.SourceInstance.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Scene.SourceInstance.RayFileProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_systemdoublerepeated

Position of the source (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)

exit_geometriesScene.GeoPaths

Exit Geometries that will use this rayfile source

+ + + + + +

Scene.SourceInstance.SurfaceProperties

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
exitance_constant_propertiesScene.SourceInstance.SurfaceProperties.ExitanceConstantProperties

To be filled if the Surface SourceTemplate has ExitanceConstant

exitance_variable_propertiesScene.SourceInstance.SurfaceProperties.ExitanceVariableProperties

To be filled if the Surface SourceTemplate has ExitanceVariable

intensity_propertiesScene.SourceInstance.IntensityProperties

+ + + + + +

Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
geo_pathsScene.GeoPathrepeated

+ + + + + +

Scene.SourceInstance.SurfaceProperties.ExitanceVariableProperties

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
axis_planedoublerepeated

Position of the exitance map (Ox Oy Oz Xx Xy Xz Yx Yy Yz)

+ + + + + +

Update_Request

+

Request to update a Scene in ScenesManager

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Scene to be updated

sceneScene

Scene that will be used for the update

+ + + + + +

Update_Response

+

+ + + + + + + +

Scene.SensorInstance.EnumRayFileType

+

Ray file types available

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
RayFileNone0

Generates no ray file.

RayFileClassic1

Generates a ray file without polarization data.

RayFilePolarization2

Generates a ray file with the polarization data for each ray.

RayFileTM253

Generates a .tm25ray file with polarization data for each ray.

RayFileTM25NoPolarization4

Generates a .tm25ray file without polarization data.

+ +

Scene.SensorInstance.LayerTypeFace.EnumSCAFilteringType

+

+ + + + + + + + + + + + + + + + + + + +
NameNumberDescription
LastImpact0

IntersectedOneTime1

+ +

Scene.SensorInstance.LayerTypeSequence.EnumSequenceType

+

+ + + + + + + + + + + + + + + + + + + +
NameNumberDescription
Geometries0

Faces1

+ + + + + +

SceneActions

+

Actions available on a Scene

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
LoadFileLoadFile_RequestLoadFile_Response

Load .speos file

SaveFileSaveFile_RequestSaveFile_Response

Save .speos file

GetSourceRayPathsGetSourceRayPaths_Request.ansys.api.speos.results.v1.RayPath stream

Get RayPaths generated by a source

+ + +

ScenesManager

+

Manager for Scenes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a Scene

ReadRead_RequestRead_Response

Read a Scene

UpdateUpdate_RequestUpdate_Response

Update a Scene

DeleteDelete_RequestDelete_Response

Delete a Scene

ListList_RequestList_Response

List all Scenes in manager

+ + + + +
+

ansys/api/speos/sensor/v1/camera_sensor.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

CameraSensorTemplate

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sensor_mode_geometricSensorCameraModeGeometric

Sensor mode : Geometric

sensor_mode_photometricSensorCameraModePhotometric

Sensor mode : Photometric

focal_lengthdouble

Distance between the center of the optical system and the focus. (mm)

imager_distancedouble

Imager distance in mm, the imager is located at the focal point. The Imager distance has no impact on the result.

f_numberdouble

F-number represent the aperture of the front lens. F number has no impact on the result.

distorsion_file_uristring

Will be deprecated soon due to typo error - better use distortion_file_uri

distortion_file_uristring

Optical aberration that deforms and bend straight lines. The distortion is expressed in a .OPTDistortion file.

horz_pixeluint32

Defines the horizontal pixels number corresponding to the camera resolution.

vert_pixeluint32

Defines the vertical pixels number corresponding to the camera resolution.

widthdouble

Defines the sensor's width in mm.

heightdouble

Defines the sensor's height in mm.

+ + + + + +

SensorCameraBalanceModeDisplay

+

Spectral results are converted in a three channels result. Then a post-treatment is realized to take the distortion induced by the display devices into account. With this method, displayed results are similar to what the camera really gets.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
red_display_file_uristring

green_display_file_uristring

blue_display_file_uristring

+ + + + + +

SensorCameraBalanceModeGreyworld

+

The grey world assumption states that the content of the image is grey on average. This method converts spectral results in a three channel results with the basic conversion. Then it computes and applies coefficients to the red, green and blue images to make sure their averages are equal.

+ + + + + +

SensorCameraBalanceModeNone

+

The spectral transmittance of the optical system and the spectral sensitivity for each channel are applied to the detected spectral image before the conversion in a three channel results. This method is referred to as the basic conversion.

+ + + + + +

SensorCameraBalanceModeUserwhite

+

In addition to the basic treatment, it allows you to apply your own coefficients to the red, green, blue images.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
red_gaindouble

green_gaindouble

blue_gaindouble

+ + + + + +

SensorCameraColorModeColor

+

Simulation results are available in color according to the White Balance mode.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
red_spectrum_file_uristring

green_spectrum_file_uristring

blue_spectrum_file_uristring

balance_mode_noneSensorCameraBalanceModeNone

Balance mode : None

balance_mode_greyworldSensorCameraBalanceModeGreyworld

Balance mode : Greyworld

balance_mode_userwhiteSensorCameraBalanceModeUserwhite

Balance mode : Userwhite

balance_mode_displaySensorCameraBalanceModeDisplay

Balance mode : Display

+ + + + + +

SensorCameraColorModeMonochromatic

+

Simulation results are available in grey scale.

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
spectrum_file_uristring

+ + + + + +

SensorCameraModeGeometric

+

Simplified version of the Camera Sensor definition parameters

+ + + + + +

SensorCameraModePhotometric

+

Allows to set every Camera Sensor parameters, including the photometric definition parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
acquisition_integrationdouble

Acquisition integration in s

acquisition_lag_timedouble

Acquisition lag time in s

transmittance_file_uristring

Amount of light of the source that passes through the lens and reaches the sensor. The transmittance is expressed in a .spectrum file.

gamma_correctionfloat

Compensation of the curve before the display on the screen.

png_bitsEnumSensorCameraPNGBits

Choose between 8, 10, 12 and 16-bit.

color_mode_colorSensorCameraColorModeColor

Color mode : Color

color_mode_monochromaticSensorCameraColorModeMonochromatic

Color mode : Monochromatic

wavelengths_rangeWavelengthsRange

Spectral excursion to use for simulation

+ + + + + + + +

EnumSensorCameraPNGBits

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameNumberDescription
PNG_080

PNG_101

PNG_122

PNG_163

+ + + + + + + +
+

ansys/api/speos/sensor/v1/common.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

IlluminanceTypeCylindrical

+

+ + + + + +

IlluminanceTypeHemispherical

+

+ + + + + +

IlluminanceTypePlanar

+

Integration made orthogonally with the sensor plan.

+ + + + + +

IlluminanceTypeRadial

+

+ + + + + +

IlluminanceTypeSemiCylindrical

+

+ + + + + +

SensorDimensions

+

Dimensions of the sensor

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
x_startdouble

(mm)

x_enddouble

(mm)

x_samplinguint32

Corresponds to the number of pixels of the XMP map.

y_startdouble

(mm)

y_enddouble

(mm)

y_samplinguint32

Corresponds to the number of pixels of the XMP map.

+ + + + + +

SensorTypeColorimetric

+

Color results without any spectral data or layer separation (in lx or W//m2).

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
wavelengths_rangeWavelengthsRange

Spectral excursion to use for simulation

+ + + + + +

SensorTypePhotometric

+

The sensor considers the visible spectrum and gets the results in lm/m2 or lx.

+ + + + + +

SensorTypeRadiometric

+

The sensor considers the entire spectrum and gets the results in W/m2.

+ + + + + +

SensorTypeSpectral

+

Color results and spectral data separated by wavelength (in lx or W/m2).

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
wavelengths_rangeWavelengthsRange

Spectral excursion to use for simulation

+ + + + + +

WavelengthsRange

+

Spectral excursion to use for simulation

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
w_startdouble

Defines the minimum wavelength. (nm)

w_enddouble

Defines the maximum wavelength. (nm)

w_samplinguint32

Defines the number of wavelength to be taken into account between the minimum and minimum wavelengths set.

+ + + + + + + + + + + + + +
+

ansys/api/speos/sensor/v1/irradiance_sensor.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

IrradianceSensorTemplate

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sensor_type_photometricSensorTypePhotometric

Sensor type : Photometric

sensor_type_colorimetricSensorTypeColorimetric

Sensor type : Colorimetric

sensor_type_radiometricSensorTypeRadiometric

Sensor type : Radiometric

sensor_type_spectralSensorTypeSpectral

Sensor type : Spectral

illuminance_type_planarIlluminanceTypePlanar

Illuminance type : Planar

illuminance_type_radialIlluminanceTypeRadial

Illuminance type : Radial

illuminance_type_hemisphericalIlluminanceTypeHemispherical

Illuminance type : Hemispherical

illuminance_type_cylindricalIlluminanceTypeCylindrical

Illuminance type : Cylindrical

illuminance_type_semi_cylindricalIlluminanceTypeSemiCylindrical

Illuminance type : SemiCylindrical

dimensionsSensorDimensions

Dimensions of the sensor

+ + + + + + + + + + + + + +
+

ansys/api/speos/sensor/v1/sensor.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

Create_Request

+

Request to create a SensorTemplate in SensorTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sensor_templateSensorTemplate

SensorTemplate containing its basic characteristics

+ + + + + +

Create_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SensorTemplate created in SensorTemplatesManager

+ + + + + +

Delete_Request

+

Request to delete a SensorTemplate in SensorTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SensorTemplate to be deleted

+ + + + + +

Delete_Response

+

+ + + + + +

List_Request

+

+ + + + + +

List_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of the SensorTemplates in SensorTemplatesManager

+ + + + + +

Read_Request

+

Request to read a SensorTemplate in SensorTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SensorTemplate to be read

+ + + + + +

Read_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sensor_templateSensorTemplate

SensorTemplate corresponding to the guid given in Read_Request

+ + + + + +

SensorTemplate

+

Sensor template with its basic characteristics

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

SensorTemplate name

descriptionstring

SensorTemplate description

metadataSensorTemplate.MetadataEntryrepeated

User defined metadatas

camera_sensor_templateCameraSensorTemplate

irradiance_sensor_templateIrradianceSensorTemplate

radiance_sensor_templateSensorTemplate.Radiance

+ + + + + +

SensorTemplate.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

SensorTemplate.Radiance

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sensor_type_photometricSensorTypePhotometric

Sensor type : Photometric

sensor_type_colorimetricSensorTypeColorimetric

Sensor type : Colorimetric

sensor_type_radiometricSensorTypeRadiometric

Sensor type : Radiometric

sensor_type_spectralSensorTypeSpectral

Sensor type : Spectral

focaldouble

Observer type : focal (mm)

integration_angledouble

Integration angle, in degree

dimensionsSensorDimensions

Dimensions of the sensor

+ + + + + +

Update_Request

+

Request to update a SensorTemplate in SensorTemplatesManager

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SensorTemplate to be updated

sensor_templateSensorTemplate

SensorTemplate that will be used for the update

+ + + + + +

Update_Response

+

+ + + + + + + + + + + +

SensorTemplatesManager

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a SensorTemplate

ReadRead_RequestRead_Response

Read a SensorTemplate

UpdateUpdate_RequestUpdate_Response

Update a SensorTemplate

DeleteDelete_RequestDelete_Response

Delete a SensorTemplate

ListList_RequestList_Response

List all SensorTemplates in manager

+ + + + +
+

ansys/api/speos/simulation/v1/simulation_template.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

Create_Request

+

Request to create a SimulationTemplate in SimulationTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
simulation_templateSimulationTemplate

SimulationTemplate containing its basic characteristics

+ + + + + +

Create_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SimulationTemplate created in SimulationTemplatesManager

+ + + + + +

Delete_Request

+

Request to delete a SimulationTemplate in SimulationTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SimulationTemplate to be deleted

+ + + + + +

Delete_Response

+

+ + + + + +

DirectMCSimulationTemplate

+

The Direct Simulation is commonly used to analyze standard optical systems.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
geom_distance_tolerancedouble

Maximum distance in mm to consider two faces as tangent.

max_impactint32

Define a value to determine the maximum number of ray impacts during propagation. When a ray has interacted N times with the geometry, the propagation of the ray stops.

weightWeight

Activates Weight. Highly recommended to fill

colorimetric_standardEnumColorimetricStandard

Default Colorimetric Standard

dispersionbool

To activate the dispersion calculation.

fast_transmission_gatheringbool

To accelerate the simulation by neglecting the light refraction that occurs when the light is being transmitted though a transparent surface.

ambient_material_uristring

To define the environment in which the light will propagate (water, fog, smoke etc.). It is expressed in a .material file

+ + + + + +

InverseMCSimulationTemplate

+

The Inverse Simulation allows to reverse the light trajectory direction.

The propagation is done from the sensors to the sources. It is useful when needing to analyze optical systems where the sensors are small and the sources are diffuse.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
geom_distance_tolerancedouble

Maximum distance in mm to consider two faces as tangent.

max_impactint32

Define a value to determine the maximum number of ray impacts during propagation. When a ray has interacted N times with the geometry, the propagation of the ray stops.

weightWeight

Activates Weight. Highly recommended to fill

colorimetric_standardEnumColorimetricStandard

Default Colorimetric Standard

dispersionbool

To activate the dispersion calculation.

splittingbool

To split each propagated ray into several paths at their first impact after leaving the observer point.

number_of_gathering_rays_per_sourceuint32

This number pilots the number of shadow rays to target at each source.

maximum_gathering_erroruint32

This value defines the level below which a source can be neglected. 0, the default value means that no approximation will be done.

fast_transmission_gatheringbool

To accelerate the simulation by neglecting the light refraction that occurs when the light is being transmitted though a transparent surface.

ambient_material_uristring

To define the environment in which the light will propagate (water, fog, smoke etc.). It is expressed in a .material file

+ + + + + +

List_Request

+

+ + + + + +

List_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of the SimulationTemplates in SimulationTemplatesManager

+ + + + + +

Read_Request

+

Request to read a SimulationTemplate in SimulationTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SimulationTemplate to be read

+ + + + + +

Read_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
simulation_templateSimulationTemplate

SimulationTemplate corresponding to the guid given in Read_Request

+ + + + + +

SimulationTemplate

+

Simulation template with its basic characteristics

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

Simulation name

descriptionstring

Simulation description

metadataSimulationTemplate.MetadataEntryrepeated

User defined metadatas

direct_mc_simulation_templateDirectMCSimulationTemplate

inverse_mc_simulation_templateInverseMCSimulationTemplate

interactive_simulation_templateSimulationTemplate.Interactive

+ + + + + +

SimulationTemplate.Interactive

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
geom_distance_tolerancedouble

Maximum distance in mm to consider two faces as tangent.

max_impactint32

Define a value to determine the maximum number of ray impacts during propagation. When a ray has interacted N times with the geometry, the propagation of the ray stops.

weightWeight

Activates Weight. Highly recommended to fill

colorimetric_standardEnumColorimetricStandard

Default Colorimetric Standard

ambient_material_uristring

To define the environment in which the light will propagate (water, fog, smoke etc.). It is expressed in a .material file

+ + + + + +

SimulationTemplate.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Update_Request

+

Request to update a SimulationTemplate in SimulationTemplatesManager

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SimulationTemplate to be updated

simulation_templateSimulationTemplate

SimulationTemplate that will be use for the update

+ + + + + +

Update_Response

+

+ + + + + +

Weight

+

The Weight represents the ray energy. In real life, a ray looses some energy (power) when it interacts with an object.

Activating weight means that the Weight message is present.

When weight is not activated, rays' energy stay constant and probability laws dictate if they continue or stop propagating.

When weight is activated, the ray's energy evolves with interactions until they reach the sensors.

It is highly recommended to fill this parameter excepted in interactive simulation.

Not fill this parameter is useful to understand certain phenomena as absorption.

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
minimum_energy_percentagedouble

The Minimum energy percentage parameter defines the minimum energy ratio to continue to propagate a ray with weight.

+ + + + + + + +

EnumColorimetricStandard

+

Default Colorimetric Standard

+ + + + + + + + + + + + + + + + + + + +
NameNumberDescription
CIE_19310

2 degrees CIE Standard Colorimetric Observer Data.

CIE_19641

10 degrees CIE Standard Colorimetric Observer Data.

+ + + + + +

SimulationTemplatesManager

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a SimulationTemplate

ReadRead_RequestRead_Response

Read a SimulationTemplate

UpdateUpdate_RequestUpdate_Response

Update a SimulationTemplate

DeleteDelete_RequestDelete_Response

Delete a SimulationTemplate

ListList_RequestList_Response

List all SimulationTemplates in manager

+ + + + +
+

ansys/api/speos/sop/v1/sop.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ANSYS Confidential Information

+ + +

Create_Request

+

Request to create a SOPTemplate in SOPTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sop_templateSOPTemplate

SOPTemplate containing its basic characteristics

+ + + + + +

Create_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SOPTemplate created in SOPTemplatesManager

+ + + + + +

Delete_Request

+

Request to delete a SOPTemplate in SOPTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SOPTemplate to be deleted

+ + + + + +

Delete_Response

+

+ + + + + +

List_Request

+

+ + + + + +

List_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of the SOPTemplates in SOPTemplatesManager

+ + + + + +

Read_Request

+

Request to read a SOPTemplate in SOPTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SOPTemplate to be read

+ + + + + +

Read_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sop_templateSOPTemplate

SOPTemplate corresponding to the guid given in Read_Request

+ + + + + +

SOPTemplate

+

SOP: Surface Optical Properties

Defines the behavior of light rays when they hit the surface of a body.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

SOPTemplate name

descriptionstring

SOPTemplate description

metadataSOPTemplate.MetadataEntryrepeated

User defined metadatas

mirrorSOPTemplate.Mirror

Perfect specular surface

optical_polishedSOPTemplate.OpticalPolished

Transparent or perfectly polished material (glass, plastic)

librarySOPTemplate.Library

Based on surface optical properties file

pluginSOPTemplate.Plugin

Custom made plug-in

+ + + + + +

SOPTemplate.Library

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
sop_file_uristring

Surface optical properties file, *.scattering, *.bsdf, *.brdf, *.coated, ...

+ + + + + +

SOPTemplate.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

SOPTemplate.Mirror

+

Perfect specular surface

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
reflectancedouble

Reflectance, expected from 0. to 100. in %

+ + + + + +

SOPTemplate.OpticalPolished

+

Transparent or perfectly polished material (glass, plastic)

+ + + + + +

SOPTemplate.Plugin

+

Custom made plug-in

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
plugin_sop_file_uristring

.sop plug-in

parameters_file_uristring

parameters file needed for the plug-in

+ + + + + +

Update_Request

+

Request to update a SOPTemplate in SOPTemplatesManager

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SOPTemplate to be updated

sop_templateSOPTemplate

SOPTemplate that will be used for the update

+ + + + + +

Update_Response

+

+ + + + + + + + + + + +

SOPTemplateActions

+

Actions available on a SOPTemplate

+ + + + + + + +
Method NameRequest TypeResponse TypeDescription
+ + +

SOPTemplatesManager

+

Manager for SOPTemplates (SOP: Surface Optical Properties)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a SOPTemplate

ReadRead_RequestRead_Response

Read a SOPTemplate

UpdateUpdate_RequestUpdate_Response

Update a SOPTemplate

DeleteDelete_RequestDelete_Response

Delete a SOPTemplate

ListList_RequestList_Response

List all SOPTemplates in manager

+ + + + +
+

ansys/api/speos/source/v1/source.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ANSYS Confidential Information

+ + +

Create_Request

+

Request to create a SourceTemplate in SourceTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
source_templateSourceTemplate

SourceTemplate containing its basic characteristics

+ + + + + +

Create_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SourceTemplate created in SourceTemplatesManager

+ + + + + +

Delete_Request

+

Request to delete a SourceTemplate in SourceTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SourceTemplate to be deleted

+ + + + + +

Delete_Response

+

+ + + + + +

GetRayFileInfo_Request

+

Request of GetRayFileInfo

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SourceTemplate to get information about ray file (example: flux). Only for SourceTemplate of type RayFile.

+ + + + + +

GetRayFileInfo_Response

+

Response of GetRayFileInfo

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
fluxansys.api.speos.common.v1.DataDoubles

Flux of the ray file

+ + + + + +

List_Request

+

+ + + + + +

List_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of the SourceTemplates in SourceTemplatesManager

+ + + + + +

Read_Request

+

Request to read a SourceTemplate in SourceTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SourceTemplate to be read

+ + + + + +

Read_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
source_templateSourceTemplate

SourceTemplate corresponding to the guid given in Read_Request

+ + + + + +

SourceTemplate

+

Source template with its basic characteristics

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

SourceTemplate name

descriptionstring

SourceTemplate description

metadataSourceTemplate.MetadataEntryrepeated

User defined metadatas

luminaireSourceTemplate.Luminaire

surfaceSourceTemplate.Surface

rayfileSourceTemplate.RayFile

+ + + + + +

SourceTemplate.FromIntensityFile

+

Flux messages

+ + + + + +

SourceTemplate.FromRayFile

+

+ + + + + +

SourceTemplate.Luminaire

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
flux_from_intensity_fileSourceTemplate.FromIntensityFile

Take flux from intensity file provided

luminous_fluxSourceTemplate.Luminous

Luminous flux in lumens, must be positive

radiant_fluxSourceTemplate.Radiant

Radiant flux in watts, must be positive

intensity_file_uristring

IES or EULUMDAT format file uri

spectrum_guidstring

Spectrum guid in spectrum manager

+ + + + + +

SourceTemplate.Luminous

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
luminous_valuedouble

Luminous flux in lumens

+ + + + + +

SourceTemplate.LuminousIntensity

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
luminous_intensity_valuedouble

Luminous intensity in candelas

+ + + + + +

SourceTemplate.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

SourceTemplate.Radiant

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
radiant_valuedouble

Radiant flux in watts

+ + + + + +

SourceTemplate.RayFile

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
ray_file_uristring

Rayfile format file uri (.ray or .tm25ray files expected)

flux_from_ray_fileSourceTemplate.FromRayFile

Take flux from ray file provided

luminous_fluxSourceTemplate.Luminous

Luminous flux in lumens, must be positive

radiant_fluxSourceTemplate.Radiant

Radiant flux in watts, must be positive

spectrum_from_ray_fileSourceTemplate.RayFile.SpectrumFromRayFile

Take spectrum from ray file provided

spectrum_guidstring

Spectrum guid in spectrum manager

+ + + + + +

SourceTemplate.RayFile.SpectrumFromRayFile

+

Spectrum messages

+ + + + + +

SourceTemplate.Surface

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
flux_from_intensity_fileSourceTemplate.FromIntensityFile

Take flux from intensity file provided

luminous_fluxSourceTemplate.Luminous

Luminous flux in lumens

radiant_fluxSourceTemplate.Radiant

Radiant flux in watts

luminous_intensity_fluxSourceTemplate.LuminousIntensity

Luminous intensity in candelas

intensity_guidstring

Intensity guid in intensity manager

exitance_constantSourceTemplate.Surface.ExitanceConstant

Constant

exitance_variableSourceTemplate.Surface.ExitanceVariable

Taken from XMP map

spectrum_from_xmp_fileSourceTemplate.Surface.SpectrumFromXMPFile

Take spectrum from xmp file provided

spectrum_guidstring

Spectrum guid in spectrum manager

+ + + + + +

SourceTemplate.Surface.ExitanceConstant

+

+ + + + + +

SourceTemplate.Surface.ExitanceVariable

+

Exitance messages

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
exitance_xmp_file_uristring

XMP file describing exitance, if spectral, spectrum is not needed in source definition

+ + + + + +

SourceTemplate.Surface.SpectrumFromXMPFile

+

Spectrum messages

+ + + + + +

Update_Request

+

Request to update a SourceTemplate in SourceTemplatesManager

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the SourceTemplate to be updated

source_templateSourceTemplate

SourceTemplate that will be used for the update

+ + + + + +

Update_Response

+

+ + + + + + + + + + + +

SourceTemplateActions

+

Actions available on a SourceTemplate

+ + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
GetRayFileInfoGetRayFileInfo_RequestGetRayFileInfo_Response

Get Flux from ray file

+ + +

SourceTemplatesManager

+

Manager for SourceTemplates

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a SourceTemplate

ReadRead_RequestRead_Response

Read a SourceTemplate

UpdateUpdate_RequestUpdate_Response

Update a SourceTemplate

DeleteDelete_RequestDelete_Response

Delete a SourceTemplate

ListList_RequestList_Response

List all SourceTemplates in manager

+ + + + +
+

ansys/api/speos/spectrum/v1/spectrum.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

Create_Request

+

Request to create a Spectrum in SpectrumsManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
spectrumSpectrum

Spectrum containing its basic characteristics

+ + + + + +

Create_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Spectrum created in SpectrumsManager

+ + + + + +

Delete_Request

+

Request to delete a Spectrum in SpectrumsManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Spectrum to be deleted

+ + + + + +

Delete_Response

+

+ + + + + +

List_Request

+

+ + + + + +

List_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of the Spectrums in SpectrumsManager

+ + + + + +

Read_Request

+

Request to read a Spectrum in SpectrumsManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Spectrum to be read

+ + + + + +

Read_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
spectrumSpectrum

Spectrum corresponding to the guid given in Read_Request

+ + + + + +

Spectrum

+

Spectrum with its basic characteristics

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

Spectrum name

descriptionstring

Spectrum descrition

metadataSpectrum.MetadataEntryrepeated

User defined metadatas

monochromaticSpectrum.Monochromatic

blackbodySpectrum.BlackBody

sampledSpectrum.Sampled

librarySpectrum.Library

predefinedSpectrum.Predefined

+ + + + + +

Spectrum.BlackBody

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
temperaturedouble

Temperature of the blackbody, in K

+ + + + + +

Spectrum.DaylightFluorescent

+

+ + + + + +

Spectrum.Halogen

+

+ + + + + +

Spectrum.HighPressureSodium

+

+ + + + + +

Spectrum.Incandescent

+

+ + + + + +

Spectrum.Library

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
file_uristring

uri of the spectrum file

+ + + + + +

Spectrum.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

Spectrum.MetalHalide

+

+ + + + + +

Spectrum.Monochromatic

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
wavelengthdouble

Wavelength of the monochromatic spectrum, in nm

+ + + + + +

Spectrum.Predefined

+

Predefined sampled spectrums

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
incandescentSpectrum.Incandescent

warmwhitefluorescentSpectrum.WarmWhiteFluorescent

daylightfluorescentSpectrum.DaylightFluorescent

whiteLEDSpectrum.WhiteLED

halogenSpectrum.Halogen

metalhalideSpectrum.MetalHalide

highpressuresodiumSpectrum.HighPressureSodium

+ + + + + +

Spectrum.Sampled

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
wavelengthsdoublerepeated

List of wavelengths, in nm

valuesdoublerepeated

List of values, expected from 0. to 100. in %

+ + + + + +

Spectrum.WarmWhiteFluorescent

+

+ + + + + +

Spectrum.WhiteLED

+

+ + + + + +

Update_Request

+

Request to update a Spectrum in SpectrumsManager

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the Spectrum to be updated

spectrumSpectrum

Spectrum that will be used for the update

+ + + + + +

Update_Response

+

+ + + + + + + + + + + +

SpectrumsManager

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a Spectrum

ReadRead_RequestRead_Response

Read a Spectrum

UpdateUpdate_RequestUpdate_Response

Update a Spectrum

DeleteDelete_RequestDelete_Response

Delete a Spectrum

ListList_RequestList_Response

List all Spectrums in manager

+ + + + +
+

ansys/api/speos/vop/v1/vop.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ANSYS Confidential Information

+ + +

Create_Request

+

Request to create a VOPTemplate in VOPTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
vop_templateVOPTemplate

VOPTemplate containing its basic characteristics

+ + + + + +

Create_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the VOPTemplate created in VOPTemplatesManager

+ + + + + +

Delete_Request

+

Request to delete a VOPTemplate in VOPTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the VOPTemplate to be deleted

+ + + + + +

Delete_Response

+

+ + + + + +

List_Request

+

+ + + + + +

List_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidsstringrepeated

Guids of the VOPTemplates in VOPTemplatesManager

+ + + + + +

Read_Request

+

Request to read a VOPTemplate in VOPTemplatesManager

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the VOPTemplate to be read

+ + + + + +

Read_Response

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
vop_templateVOPTemplate

VOPTemplate corresponding to the guid given in Read_Request

+ + + + + +

Update_Request

+

Request to update a VOPTemplate in VOPTemplatesManager

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
guidstring

Guid of the VOPTemplate to be updated

vop_templateVOPTemplate

VOPTemplate that will be used for the update

+ + + + + +

Update_Response

+

+ + + + + +

VOPTemplate

+

VOP: Volume Optical Properties

Defines the behavior of light rays when they are propagated in a body.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
namestring

VOPTemplate name

descriptionstring

VOPTemplate description

metadataVOPTemplate.MetadataEntryrepeated

User defined metadatas

opaqueVOPTemplate.Opaque

Non transparent material

opticVOPTemplate.Optic

Transparent colorless material without bulk scattering

libraryVOPTemplate.Library

Based on *.material file

non_homogeneousVOPTemplate.NonHomogeneous

Material with non-homogeneous refractive index

+ + + + + +

VOPTemplate.Library

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
material_file_uristring

.material file

+ + + + + +

VOPTemplate.MetadataEntry

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
keystring

valuestring

+ + + + + +

VOPTemplate.NonHomogeneous

+

Material with non-homogeneous refractive index

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
gradedmaterial_file_uristring

.gradedmaterial file that describes the spectral variations of refractive index and absorption with the respect to position in space

+ + + + + +

VOPTemplate.Opaque

+

Non transparent material

+ + + + + +

VOPTemplate.Optic

+

Transparent colorless material without bulk scattering

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
indexdouble

Refractive index

absorptiondouble

constringencedoubleoptional

Abbe number

+ + + + + + + + + + + +

VOPTemplateActions

+

Actions available on a VOPTemplate

+ + + + + + + +
Method NameRequest TypeResponse TypeDescription
+ + +

VOPTemplatesManager

+

Manager for VOPTemplates (VOP: Volume Optical Properties)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateCreate_RequestCreate_Response

Create a VOPTemplate

ReadRead_RequestRead_Response

Read a VOPTemplate

UpdateUpdate_RequestUpdate_Response

Update a VOPTemplate

DeleteDelete_RequestDelete_Response

Delete a VOPTemplate

ListList_RequestList_Response

List all VOPTemplates in manager

+ + + + +
+

ansys/api/speos/xmp/v1/xmp_file.proto

Top +
+

(c) 2025 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

+ + +

Coordinate2d

+

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
pixel_xuint32

pixel_yuint32

+ + + + + +

FileName

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
file_namestring

+ + + + + +

Pixel

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
nb_pixeluint32

+ + + + + +

Value

+

+ + + + + + + + + + + + + + + + +
FieldTypeLabelDescription
valuefloat

+ + + + + + + + + + + +

XmpFileService_Mono

+

service to manage xmp file

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method NameRequest TypeResponse TypeDescription
CreateXMPFileInfoFileName.google.protobuf.Empty

! @brief Create Xmp file Info +@param[in] FileName The Path to the Xmp file.

BuildMapRelativeStandardError.google.protobuf.Empty.google.protobuf.Empty

! @brief Build Relative Standard Error accessor Xmp file

GetValueRelativeStandardErrorCoordinate2dValue

! @brief Get Value Relative Standard Error file

GetNbPixelXRelativeStandardError.google.protobuf.EmptyPixel

! @brief Get Nb pixel X Relative Standard Error file

GetNbPixelYRelativeStandardError.google.protobuf.EmptyPixel

! @brief Get Nb pixel Y Relative Standard Error file

ExportXmpFileRelativeStandardErrorFileName.google.protobuf.Empty

! @brief Export Xmp File Relative Standard Error

+ + + + +

Scalar Value Types

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)
+ + + diff --git a/2026R1.2/speos_rpc-26-r1.2/index.md b/2026R1.2/speos_rpc-26-r1.2/index.md new file mode 100644 index 000000000..73d55a699 --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/index.md @@ -0,0 +1,338 @@ +# Introduction + +The SpeosRPC Server is based on gRPC and provides APIs to interact with Speos Solver. + +Please be aware that the server is intended to work with a single user. +The server is under development, so all Speos features are not available yet. + +## Why SpeosRPC Server? + +This allows the user to use the Speos capabilities without starting any CAD. +This offers the possibility to manage Speos capabilities with more liberty: + +- Data preparation +- Running jobs +- Result post processing + +## gRPC usage advantages + +There are several advantages of using gRPC + +- Language independency between client and server. +This means that the user has a large choice of languages to write the API calls. +The user does not have to write the same language as the server. +- OS independency between client and server. +The client does not have to run on the same OS as the server. +The SpeosRPC server is provided for Linux and Windows. +- The client and server can run on different machines. + +## Schema + +The schema shows different ways to use Speos capabilities: + +- via CADs / Labs / Viewers GUIs +- via SpeosRPC Server APIs + +![Flowchart](./flowchart.png) + +### Speos Solver + +The Speos Solver represents the intelligence that is used to handle the light simulation. + +### SpeosRPC Server + +The SpeosRPC Server allows to translate the provided gRPC API calls into features understood by the Speos Solver. + +## Workflow + +Step 1 : Download the SpeosRPC Server +Step 2 : Set up the client +Step 3 : Create your scripts +Step 4 : Launch the server +Step 5 : Run your scripts (that will call the server) + +### Where to find the SpeosRPC Server? + +When you install Speos using the unified installer, you can add the SpeosRPC Server to be downloaded. +By default, it will be stored in `C:/Program Files/ANSYS Inc//Optical Products/SPEOS_RPC` + +### How to set up my client? + +Setting up a client is a mandatory step in the process. +The goal of setting up the client is to translate the proto files into the language in which you have chosen to write your scripts. +The proto files contain all the definitions of the Speos features to be translated. +By default, the proto files will be stored in `C:/Program Files/ANSYS Inc//Optical Products/SPEOS_RPC/APIGrammar`. + +A documentation can be found [here](https://grpc.io/docs/) to help you generate in your chosen language the client interface of the services implemented by the server. +Once the code is autogenerated, you will have access to all Speos features available in your chosen language. + +Thanks to the autogenerated code you will be able to write scripts. + +Note: +For your information, a Python client exists and can be used. +The Python client, named PySpeos, allows you to use a client without needing to auto-generate code from the proto files. +PySpeos documentation (package ansys-speos-core) can be found [here](https://speos.docs.pyansys.com/). + +### How to launch SpeosRPC Server? + +An executable called SpeosRPC_Server is present in the current folder. +The option --help is available to know more about possible arguments, and also to know how to properly shut down the server. + +```bash +./SpeosRPC_Server.exe --help +``` + +SpeosRPC_Server supports several secure transport protocols. Here are examples to start the server: + +- mutual TLS transport protocol + +```bash +./SpeosRPC_Server.exe --transport_tls ,, # Start server with TLS transport +``` + +- Unix Domain Socket transport protocol + +```bash +./SpeosRPC_Server.exe --transport_uds # Start server with Unix Domain Socket transport +``` + +- Windows Named User Authentication transport protocol + +```bash +./SpeosRPC_Server.exe --transport_wnua # Start server with Windows user-based authentication transport +``` + +- Insecure transport protocol (not recommended) + +```bash +./SpeosRPC_Server.exe --transport_insecure # Start server with insecure transport (not recommended) +``` + +Example of how to properly shutdown a server started on port 50053: + +```bash +./SpeosRPC_Server.exe --stop 50053 +``` + +## Information about ansys-api-speos API + +### Proto files + +The APIs are defined in proto files. +Those proto files can be found in the folder `APIGrammar/ansys/api/speos//v/.proto`. +An example of `` can be `sop` (surface optical property). +`v` represents the version of the feature, example `v1` for the first version. + +### Documentation + +A documentation is automatically generated and stored in the folder `APIGrammar/doc`. +This documentation is based on the comments that are present in the .proto files. + +### Key principles + +Some key principles will be described here. +It is important to read them before writing the first calls to the server. + +#### XXXsManager vs XXXActions + +Many proto files that represent basic Speos features are composed of two different services: +XXXsManager and XXXActions. + +##### XXXsManager + +The manager allows the client to handle the features it is in charge of. +Example: a SpectrumsManager allows to create/read/update/delete a spectrum, and list all spectrums present. +The managers allow to create a kind of library of objects. +Here is an imaginary example of a manager that would handle the feature Object (which contains only a name and a description). + +```txt +// Manager for Objects +service ObjectsManager { + // Create an Object + rpc Create(Create_Request) returns (Create_Response) {} + // Read an Object + rpc Read(Read_Request) returns (Read_Response) {} + // Update an Object + rpc Update(Update_Request) returns (Update_Response) {} + // Delete an Object + rpc Delete(Delete_Request) returns (Delete_Response) {} + // List all Objects in manager + rpc List(List_Request) returns (List_Response) {} +} + +message Object { + string name = 1; // Object name + string description = 2; // Object description +} +``` + +Every XXXsManager service is composed of five methods. + +- Create +Takes the Object message in the request and gives back its corresponding guid once created in the manager. + +```txt +// Request to create an Object in ObjectsManager +message Create_Request { + Object object = 1; +} +message Create_Response { + string guid = 1; // Guid of the Object created in ObjectsManager +} +``` + +- Read +From the guid received in request, gives back its corresponding Object message in the manager. + +```txt +// Request to read an Object in ObjectsManager +message Read_Request { + string guid = 1; // Guid of the Object to be read +} +message Read_Response { + Object object = 1; // Object corresponding to the guid given in Read_Request +} +``` + +- Update +Replace the object corresponding to the guid received by the Object message present in the request + +```txt +// Request to update an Object in ObjectsManager +message Update_Request { + string guid = 1; // Guid of the Object to be updated + Object object = 2; // Object that will be used for the update +} +message Update_Response {} +``` + +- Delete +Delete the object corresponding to the guid received in the request + +```txt +// Request to delete an Object in ObjectsManager +message Delete_Request { + string guid = 1; // Guid of the Object to be deleted +} +message Delete_Response {} +``` + +- List +List all objects present in the manager. Return their guids. +Tip: Can be combined with Read method to retrieve all Object messages and not only guids. + +```txt +message List_Request {} +message List_Response { + repeated string guids = 1; // Guids of the Objects in ObjectsManager +} +``` + +##### XXXActions + +Sometimes some other methods are needed to interact with a feature. But those methods do not fit in the CRUD framework. +In this case we enter the service XXXActions. +This gathers all actions that can be done on a specific feature. +Specific feature means a feature that has been created in its manager, so that its guid is known. +The first field of an action request is always the guid of the feature concerned. + +Example of an action on a scene: load a .speos file to fill it. + +```txt +service SceneActions { + rpc LoadFile(LoadFile_Request) returns (LoadFile_Response) {} +} + +message LoadFile_Request { + string guid = 1; // Guid of a ScenesManager element to update + string file_uri = 2; // File uri (path or guid from FileTransferService) +} + +message LoadFile_Response {} +``` + +#### Template vs Instance + +When applicable, the features are separated in two different notions: template and instance. +The template represents the feature with its inherent caracteristics. +The instance represents the completion of a template by adding properties such as spatial position, link to geometry, etc. + +##### Template + +The template objects are handled by a manager that was described in the section above `XXXsManager`. +The interesting thing about the template notion is that the same template can be used several times with different properties. +Currently, all the Speos features are not yet available. The user can find the available ones in the template objects protofiles. + +##### Instance + +The template objects are instantiated in the Scene object, with properties needed to place them at the wanted position, or attached to the wanted geometry. +The Scene object will gather all features that you need to run a job (compute a simulation). +For example, it is possible to: + +- Create a SourceTemplate::Luminaire with its inherent characteristics -> get its guid in SourceTemplatesManager +- Create a Scene::SourceInstance using the luminaire's guid as source_guid and position it via the LuminaireProperties using an axis_system +- Create another Scene::SourceInstance using the luminaire's guid as source_guid and position it somewhere else via the LuminaireProperties using an axis_system + +The Scene object will be described in the following section. + +#### Scene + +The Scene is the main Speos feature. +It is a way to gather all features that are needed to have an optical scene. +Just below can be found the SpeosRPC data preparation big picture: + +![ClassDiagram](./classDiagram.webp) + +#### Job + +The job feature appears in the graph just above. +The job is responsible for computing a simulation. +It is a way to link to a specific SimulationInstance of a specific Scene, and choose some properties (job type, properties specific to the SimulationTemplate type like stop conditions). +Then the `JobActions` can be called on a specific job to: + +- Start +- Stop +- GetProgressStatus +- GetResults +- ... + +#### Geo path and xxx_path + +Some objects in the Scene need to refer to a geometry, in this case a GeoPath is needed. +There is a GeoPath explanation in the auto generated documentation. +A GeoPath is a string that allows the user to target a geometry, by using geometry names separated by "/". +That can be the whole geometry, a whole sub part, a whole body, a face. +"" -> the whole root part of the scene +"body0" -> the whole body named body0 contained in the root part +"body0/face0" -> the face named face0 contained in the body named body0 contained in the root part +"part1" -> the whole part named part1 contained in the root part +"part1/body1" -> the whole body named body1 contained in the part named part1 contained in the root part + +Some objects in the Scene need to refer to some Instance, in this case a xxx_path is needed. +Those objects are refered thanks to their name. +Example for the SimulationInstance that needs to refer to some SensorInstances via the field sensor_paths. +An explanation is also given in the auto generated documentation of the concerned fields. +"" -> all sensors instantiated in the scene +"sensor1" -> the sensor instance named sensor1 contained in the scene + +#### File transfer + +If the client is in the situation where the server is not on the same machine, it is then important not to give the local path when a file is expected in a message. +Example: + +```txt +message LoadFile_Request { + string guid = 1; // Guid of a ScenesManager element to update + string file_uri = 2; // File uri (path or guid from FileTransferService) +} +``` + +The field `file_uri` is expecting + +- either a local path (this works only if the server is on the same machine as the client) +- or a guid retrieved after uploading the file via the FileTransferService + +The FileTransferService (present in `ansys/api/speos/file/v1/file_transfer.proto`) allows to upload/download files to/from the server. +A python helper is also present (in `ansys/api/speos/file/v1/file_transfer.py`), to ease the usage of the FileTransferService in case of python client. +When a file is uploaded to the server, the uri representing the file is returned in the message FileSystemItemInformation. +This uri can then be used instead of a local path in the fields xxx_file_uri. diff --git a/2026R1.2/speos_rpc-26-r1.2/unsupported-features-limitations.md b/2026R1.2/speos_rpc-26-r1.2/unsupported-features-limitations.md new file mode 100644 index 000000000..b69e42c9d --- /dev/null +++ b/2026R1.2/speos_rpc-26-r1.2/unsupported-features-limitations.md @@ -0,0 +1,52 @@ +# Unsupported features and limitations + +## Unsupported features + +### Import + +- glTF import + +### Materials + +- Load of scene using unsupported file as rdr file +- Polarizer file + +### Sources + +- Ambient source MODTRAN +- Source group + +### Sensors + +- 3D energy density sensor +- LiDAR sensor +- Camera sensor on specific mode (Geometric/Balance None/Balance Grey world) +- Timeline parameters in sensor +- Thermic unit of FLIR thermal camera sensor + +### Components + +- Timeline parameters in Speos Lightbox +- Speos pattern from Speos Lightbox + +### Simulations + +- Simulation with Timeline +- Light Expert +- Texture option in simulation +- Output faces in Irradiance sensor & IN/Out sources in simulation (only available with exported simulation, not natively) +- RayTracer selection for simulation +- Multi-GPU compute +- Fast Transmission Gathering (FTG) usage +- Percentage of error during the simulation run + +## Limitations + +### Layer separation by source + +Let's consider that you load, in the scene, a *.speos file that contains: +- supported sources by Speos RPC +- unsupported sources by Speos RPC (see list above) +- a sensor using the layer separation by source. +The order of sources in the layer list of the XMP generated out of Speos RPC job, and the order of source in the layer list of the XMP generated out of the *.speos are different. +Why does the order change? This is due to the unsupported sources by Speos RPC. The Speos RPC job reorders the sources, placing the unsupported sources first, then the supported sources in the layer list. As a consequence, the potential XML template generated out of the XMP (from the *.speos file) cannot be applied to the XMP (from the Speos RPC job).