## On this page # Reference documentation Last update: 12.06.2026 ## LTF/v1/LTF.proto (c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ### Filename FieldTypeLabelDescriptionfilename[string](#string) ### LightTransferData FieldTypeLabelDescriptionobject\_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 FieldTypeLabelDescriptiondisk[PupilSurfaceDisk](#ansys-api-speos-LTF-v1-PupilSurfaceDisk)ellipse[PupilSurfaceEllipse](#ansys-api-speos-LTF-v1-PupilSurfaceEllipse)polygon[PupilSurfacePolygon](#ansys-api-speos-LTF-v1-PupilSurfacePolygon) ### LightTransferDataDistribution FieldTypeLabelDescriptiondata[LightTransferData](#ansys-api-speos-LTF-v1-LightTransferData)repeated ### Point2d FieldTypeLabelDescriptionx[double](#double)y[double](#double) ### Point3d FieldTypeLabelDescriptionx[double](#double)y[double](#double)z[double](#double) ### PupilSurfaceDisk FieldTypeLabelDescriptionradius[double](#double) ### PupilSurfaceEllipse FieldTypeLabelDescriptionalpha[double](#double)semi\_major\_axis[double](#double)semi\_minor\_axis[double](#double) ### PupilSurfacePolygon FieldTypeLabelDescriptionnb\_points[int32](#int32)points[Point2d](#ansys-api-speos-LTF-v1-Point2d)repeated ### SpectralLightTransferDataDistribution FieldTypeLabelDescriptionwavelength\_samples[double](#double)repeatedsensor\_sampling\_type[SensorSamplingType](#ansys-api-speos-LTF-v1-SensorSamplingType)sensor\_samples\_X[double](#double)repeatedsensor\_samples\_Y[double](#double)repeatedpupil\_surface\_type[PupilSurfaceType](#ansys-api-speos-LTF-v1-PupilSurfaceType)ltf\_samples[LightTransferDataDistribution](#ansys-api-speos-LTF-v1-LightTransferDataDistribution)repeated ### Vector3d FieldTypeLabelDescriptionx[double](#double)y[double](#double)z[double](#double) ### PupilSurfaceType NameNumberDescriptionPOINT0DISK1ELLIPSE2POLYGON3 ### SensorSamplingType the sensor sampling type : symmetric = polar coordinates asymmetric = cartesian coordinates NameNumberDescriptionSYMMETRIC0ASYMMETRIC1 ### LightTransferFunctionService Method NameRequest TypeResponse TypeDescriptionLoad[Filename](#ansys-api-speos-LTF-v1-Filename)[.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty)Serialization for \*.OPTDistortion filesSave[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 LightTransferDataDistributionExport[.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 FieldTypeLabelDescriptiondescription[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 FieldTypeLabelDescriptionspectrum\_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)repeatedanisotropic\_samples[AnisotropicBsdfData.Bsdf.AnisotropicSample](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-AnisotropicBsdfData-Bsdf-AnisotropicSample)repeated ### AnisotropicBsdfData.Bsdf.AnisotropicSample FieldTypeLabelDescriptionanisotropic\_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 FieldTypeLabelDescriptionincidence\_sample[double](#double)radians in \[0, pi/2\]theta\_samples[double](#double)repeatedintensity diagram radians in \[0, pi/2\] for reflection // radians in \[pi/2, pi\] for transmissionphi\_samples[double](#double)repeatedradians in \[0, 2\*pi\]bsdf\_cos\_theta[double](#double)repeated1/steradiansintegral[double](#double)reflection/transmission coefficient ### AnisotropicBsdfData.Bsdf.WavelengthCoefficientPair FieldTypeLabelDescriptionwavelength[double](#double)nanometerscoefficient[double](#double)in \[0, 1\] interval ### AnisotropicBsdfData.Double3 FieldTypeLabelDescriptionx[double](#double)y[double](#double)z[double](#double) ### ConoscopicMap FieldTypeLabelDescriptionoutput\_file\_name[string](#string).xmpwavelength[double](#double)nanometersanisotropic\_angle[double](#double)radians in \[0, 2\*pi\]side[ConoscopicMap.BsdfSide](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-ConoscopicMap-BsdfSide)resolution[int32](#int32) ### FileName FieldTypeLabelDescriptionfile\_name[string](#string) ### InterpolationEnhancementData FieldTypeLabelDescriptionanisotropic\_samples[InterpolationEnhancementData.AnisotropicSample](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-InterpolationEnhancementData-AnisotropicSample)repeated ### InterpolationEnhancementData.AnisotropicSample FieldTypeLabelDescriptionincidence\_samples[InterpolationEnhancementData.AnisotropicSample.ConeData](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-InterpolationEnhancementData-AnisotropicSample-ConeData)repeated ### InterpolationEnhancementData.AnisotropicSample.ConeData FieldTypeLabelDescriptioncone\_half\_angle[double](#double)radians in \[0, pi/2\]cone\_height[double](#double)value >= 0 ### RefractiveIndices FieldTypeLabelDescriptionrefractive\_index\_1[double](#double)refractive\_index\_2[double](#double) ### SpectrumImport FieldTypeLabelDescriptionincidence\_angle[double](#double)radians in \[0, pi/2\]anisotropy\_angle[double](#double)radians in \[0, 2\*pi\]file\_name[string](#string).spectrum ### SpecularInterpolationEnhancementData FieldTypeLabelDescriptionreflection[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 FieldTypeLabelDescriptionwavelength[double](#double)in nanometers ### ConoscopicMap.BsdfSide NameNumberDescriptionUNKNOWN0REFLECTION1TRANSMISSION2 ### AnisotropicBsdfService Method NameRequest TypeResponse TypeDescriptionLoad[FileName](#ansys-api-speos-bsdf-v1-AnisotropicSpeosBsdf-FileName)[.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty)serialization for native \*.anisotropicbsdf filesSave[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.AnisotropicBsdfDataExport[.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.AnisotropicBsdfDataExportFile[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 specularGetSpecularInterpolationEnhancementData[.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 reflectionGetRetroReflectionInterpolationEnhancementData[.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 specularDisableWhiteSpecular[.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 importImportTransmissionSpectrum[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 absorptionExportToConoscopicMap[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 FieldTypeLabelDescriptioninput\_anisotropic\_bsdf\_samples[AnisotropicBsdfInputData.Sample](#ansys-api-speos-bsdf-v1-SpeosBsdfCreation-AnisotropicBsdfInputData-Sample)repeatedfix\_disparity[bool](#bool)output\_file\_name[string](#string).anisotropicbsdf ### AnisotropicBsdfInputData.Sample FieldTypeLabelDescriptionanisotropic\_angle[double](#double)radians in \[0, 2\*pi\]file\_name[string](#string).anisotropicbsdf ### Bsdf180InputData FieldTypeLabelDescriptioninput\_front\_bsdf\_file\_name[string](#string).coated \*.brdf \*.anisotropicbsdf \*.scatteringinput\_opposite\_bsdf\_file\_name[string](#string).coated \*.brdf \*.anisotropicbsdf \*.scatteringoutput\_file\_name[string](#string).bsdf180 ### SpectralBsdfInputData FieldTypeLabelDescriptioninput\_anisotropic\_samples[SpectralBsdfInputData.Sample](#ansys-api-speos-bsdf-v1-SpeosBsdfCreation-SpectralBsdfInputData-Sample)repeatedoutput\_file\_name[string](#string).brdf ### SpectralBsdfInputData.Sample FieldTypeLabelDescriptionwavelength[double](#double)nanometersfile\_name[string](#string).anisotropicbsdf ### BsdfCreationService Method NameRequest TypeResponse TypeDescriptionBuildBsdf180[Bsdf180InputData](#ansys-api-speos-bsdf-v1-SpeosBsdfCreation-Bsdf180InputData)[.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty)create a bsdf180 fileBuildSpectralBsdf[SpectralBsdfInputData](#ansys-api-speos-bsdf-v1-SpeosBsdfCreation-SpectralBsdfInputData)[.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty)create spectral bsdf fileBuildAnisotropicBsdf[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 FieldTypeLabelDescriptionoutput\_file\_name[string](#string).xmpwavelength[double](#double)nanometersside[ConoscopicMap.BsdfSide](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-ConoscopicMap-BsdfSide)resolution[int32](#int32) ### FileName FieldTypeLabelDescriptionfile\_name[string](#string) ### RefractiveIndices FieldTypeLabelDescriptionrefractive\_index\_1[double](#double)refractive\_index\_2[double](#double) ### SpectralBsdfData FieldTypeLabelDescriptiondescription[string](#string)incidence\_samples[double](#double)repeatedradians in \[0, pi/2\]wavelength\_samples[double](#double)repeatednanometerswavelength\_incidence\_samples[SpectralBsdfData.WavelengthIncidence](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-SpectralBsdfData-WavelengthIncidence)repeated ### SpectralBsdfData.WavelengthIncidence FieldTypeLabelDescriptionreflection[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 FieldTypeLabelDescriptiontheta\_samples[double](#double)repeatedradians in \[0, pi/2\]phi\_samples[double](#double)repeatedradians in \[0, 2\*pi\]bsdf\_cos\_theta[double](#double)repeated1/steradiansintegral[double](#double)reflection/transmission coefficient in \[0, 1\] interval ### SpecularInterpolationEnhancementData FieldTypeLabelDescriptionincidence\_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 FieldTypeLabelDescriptionreflection[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 FieldTypeLabelDescriptioncone\_half\_angle[double](#double)radians in \[0, pi/2\]cone\_height[double](#double)value >= 0 ### ConoscopicMap.BsdfSide NameNumberDescriptionUNKNOWN0REFLECTION1TRANSMISSION2 ### SpectralBsdfService Method NameRequest TypeResponse TypeDescriptionLoad[FileName](#ansys-api-speos-bsdf-v1-SpectralSpeosBsdf-FileName)[.google.protobuf.Empty](https://protobuf.dev/reference/protobuf/google.protobuf/#empty)serialization for native \*.brdf filesSave[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.SpectralBsdfDataExport[.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.SpectralBsdfDataExportFile[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 specularGetSpecularInterpolationEnhancementData[.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 FieldTypeLabelDescriptionvalues[bytes](#bytes)raw valuesmagnitude\_size[uint64](#uint64)number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color\_rgb=3 ...)dimensions[uint64](#uint64)repeatedsize of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension sizemagnitude[Magnitude](#ansys-api-speos-common-v1-Magnitude)magnitude of the value of what we have receivedunit[Unit](#ansys-api-speos-common-v1-Unit)units of the values ### DataDoubles arrays values of doubles FieldTypeLabelDescriptionvalues[double](#double)repeatedraw valuesmagnitude\_size[uint64](#uint64)number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color\_rgb=3 ...)dimensions[uint64](#uint64)repeatedsize of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension sizemagnitude[Magnitude](#ansys-api-speos-common-v1-Magnitude)magnitude of the value of what we have receivedunit[Unit](#ansys-api-speos-common-v1-Unit)units of the values ### DataFloats arrays values of floats FieldTypeLabelDescriptionvalues[float](#float)repeatedraw valuesmagnitude\_size[uint64](#uint64)number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color\_rgb=3 ...)dimensions[uint64](#uint64)repeatedsize of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension sizemagnitude[Magnitude](#ansys-api-speos-common-v1-Magnitude)magnitude of the value of what we have receivedunit[Unit](#ansys-api-speos-common-v1-Unit)units of the values ### DataIntegers32 arrays values of integers FieldTypeLabelDescriptionvalues[int32](#int32)repeatedraw valuesmagnitude\_size[uint64](#uint64)number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color\_rgb=3 ...)dimensions[uint64](#uint64)repeatedsize of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension sizemagnitude[Magnitude](#ansys-api-speos-common-v1-Magnitude)magnitude of the value of what we have receivedunit[Unit](#ansys-api-speos-common-v1-Unit)units of the values ### DataIntegers64 arrays values of integers FieldTypeLabelDescriptionvalues[int64](#int64)repeatedraw valuesmagnitude\_size[uint64](#uint64)number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color\_rgb=3 ...)dimensions[uint64](#uint64)repeatedsize of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension sizemagnitude[Magnitude](#ansys-api-speos-common-v1-Magnitude)magnitude of the value of what we have receivedunit[Unit](#ansys-api-speos-common-v1-Unit)units of the values ### DataUIntegers32 arrays values of integers FieldTypeLabelDescriptionvalues[uint32](#uint32)repeatedraw valuesmagnitude\_size[uint64](#uint64)number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color\_rgb=3 ...)dimensions[uint64](#uint64)repeatedsize of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension sizemagnitude[Magnitude](#ansys-api-speos-common-v1-Magnitude)magnitude of the value of what we have receivedunit[Unit](#ansys-api-speos-common-v1-Unit)units of the values ### DataUIntegers64 arrays values of integers FieldTypeLabelDescriptionvalues[uint64](#uint64)repeatedraw valuesmagnitude\_size[uint64](#uint64)number of values needed to describe the magnitude (ex : simple value=1 / vector=3 / color\_rgb=3 ...)dimensions[uint64](#uint64)repeatedsize of dimensions where the magnitudes are applied = total number of dimension representation of the data, each value representing its dimension sizemagnitude[Magnitude](#ansys-api-speos-common-v1-Magnitude)magnitude of the value of what we have receivedunit[Unit](#ansys-api-speos-common-v1-Unit)units of the values ### Magnitude Magnitude represent a physical quantity NameNumberDescriptionirradiance0radiometric irradianceilluminance1photometric irradiancespectral\_irradiance2spectral radiometric irradiancespectral\_illuminance3spectral photometric irradianceradiance4radiometric radianceluminance5photometric radiancespectral\_radiance6spectral radiometric radiancespectral\_luminance7spectral photometric radianceradiant\_intensity8radiometric intensityluminous\_intensity9photometric intensityspectral\_radiant\_intensity10spectral radiometric intensityspectral\_luminous\_intensity11spectral photometric intensityexposure12radiometric exposureluminous\_exposure13photometric exposurespectral\_exposure14spectral radiometric exposurespectral\_luminous\_exposure15spectral photometric exposureradiant\_flux16radiometric fluxluminous\_flux17photometric fluxwavelength26wavelengthratio27magnitude ratiocolor37colorray\_sampling38rays samplingdistance48distancedimension49dimensionplane\_angle50plane anglecurvature51curvaturecurvature\_product52curvature productphotometric\_power\_density62photometric power densityradiometric\_power\_density63radiometric power densityspherical\_probability\_density64spherical probability densitytemperature\_elevation74temperature elevationcolorimetric\_error84colorimetric errorsignal\_to\_noise\_ratio85SNRprecision86precisionrelative\_standard\_error87relative standard errorrefractive\_power97refractive powerrefractive\_index98refractive indexabsorption99absorptionx\_color109xyY color spacey\_color110xyY color spaceu\_color111uvY color spacev\_color112uvY color spaceu\_prime\_color113u'v'Y color spacev\_prime\_color114u'v'Y color spaceu\_star\_color115L*u*v\* color spacev\_star\_color116L*u*v\* color spacea\_star\_color117L*a*b\* color spaceb\_star\_color118L*a*b\* color spaceuppercase\_c\_star\_color119L*C*h color spaceh\_color120L*C*h color spaceuppercase\_x\_color121XYZ color spaceuppercase\_y\_color122XYZ color spaceuppercase\_z\_color123XYZ color spaceuppercase\_l\_star\_color124L*u*v\* color spaceglare134glare ### Unit Units used in Speos data NameNumberDescriptionwatts0Wwatts\_per\_square\_meters1W/(m2)watts\_per\_steradians2W/(sr)watts\_per\_nanometers3W/(nm)watts\_per\_square\_meters\_steradians4W/(m2.sr)watts\_per\_steradians\_nanometers5W/(sr.nm)watts\_per\_square\_meters\_nanometers6W/(m2.nm)watts\_per\_square\_foot7W/ft2watts\_per\_square\_foot\_nanometer8W/(ft2.nm)watts\_per\_square\_centimeter9W/cm2watts\_per\_square\_foot\_steradian10W/(ft2.sr)watts\_per\_square\_meter\_steradian\_nanometer11W/(m2.sr.nm)watts\_per\_square\_foot\_steradian\_nanometer12W/(ft2.sr.nm)watts\_per\_cubic\_meter13W/m3watts\_per\_cubic\_centimeter14W/cm3joules16Jjoules\_per\_nanometers17J/(nm)joules\_per\_square\_meters18J/(m2)joules\_per\_square\_meters\_nanometers19J/(m2.nm)joules\_per\_square\_centimeter20J/cm2joules\_per\_square\_foot21J/ft2joules\_per\_square\_foot\_nanometer22J/(ft2.nm)luxes29lxluxes\_seconds30lx.sluxes\_per\_nanometers31lx.s/(nm)luxes\_seconds\_per\_nanometers32lx.s/(nm)candelas42cdcandelas\_per\_square\_meters43cd/(m2)candelas\_per\_nanometers44cd/(m2)candelas\_per\_squaremeters\_nanometers45cd/(m2.nm)candelas\_per\_square\_centimeter46cd/cm2candelas\_per\_square\_foot47cd/ft2candelas\_per\_square\_foot\_nanometer48cd/(ft2.nm)lumens\_per\_square\_meters\_nanometers49lm/(m2.nm)lumens55lmlumens\_seconds56lm.slumens\_per\_nanometers57lm/(nm)lumens\_per\_square\_centimeter59lm/cm2percent60%lumens\_per\_cubic\_meter61lm/m3lumens\_seconds\_per\_square\_centimeter62lm.s/cm2color\_XYZ70XYZ CIEcolor\_xyY71xy CIEcolor\_uvY72uvY 1960 UCS CIEcolor\_uvY\_prime73u'v'Y' 1976 UCS CIEcolor\_Luv74L*u*v CIELUVcolor\_Lab75L*a*b CIELABcolor\_LCh76L*C*h CIELABcolor\_rgb77rgbcolor\_rgba79rgbafoot\_candles90fcfoot\_candles\_per\_nanometer91fc/nmfoot\_candles\_seconds92fc.sfoot\_candles\_seconds\_per\_nanometer93fc.s/nmfoot\_lamberts94fLfoot\_lamberts\_per\_nanometer95fL/nmnanometers120nmmicrometers121ummillimeters122mmmeters123mradians124raddegrees125degsteradians126srray\_per\_pixel127rays/pixelfeet128ftinches129inmilliradians130mradarcminutes131'arcseconds132''kelvin133Kdiopters134Dmillidiopters135mDunit\_precision136%square\_meters140m2square\_centimeters141cm2square\_millimeters142mm2square\_micrometers143micron2square\_nanometers144nm2square\_feet145ft2square\_inches146inch2invert\_meter150m-1invert\_millimeter151mm-1invert\_foot152ft-1invert\_inch153in-1invert\_steradian154sr-1no\_unit160 ## file/v1/file\_transfer.proto (c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ### AddDependencies\_Request FieldTypeLabelDescriptionuri[string](#string)uri of the FileSystemItem to be completed with dependenciesdependency\_uris[string](#string)repeatedFileSystemItem uris to be added as dependencies ### AddDependencies\_Response ### Chunk FieldTypeLabelDescriptionbinary[bytes](#bytes)size[int64](#int64)file\_name[string](#string)file name. Mandatory in the first chunk exchanged. ### Delete\_Request FieldTypeLabelDescriptionuri[string](#string)uri of the FileSystemItem to be deleted ### Delete\_Response ### Download\_Request FieldTypeLabelDescriptionuri[string](#string)uri of the FileSystemItem to be downloaded ### Download\_Response Used in File Transfer helpers FieldTypeLabelDescriptioninfo[FileSystemItemInformation](#ansys-api-speos-file-v1-FileSystemItemInformation)Information about the FileSystemItem downloadeddownload\_duration[google.protobuf.Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration) ### FileSystemItemInformation FieldTypeLabelDescriptionuri[string](#string)FileSystemItem urifile\_name[string](#string)file\_size[uint64](#uint64) ### ListDependencies\_Request FieldTypeLabelDescriptionuri[string](#string)uri of the FileSystemItem ### ListDependencies\_Response FieldTypeLabelDescriptiondependency\_infos[FileSystemItemInformation](#ansys-api-speos-file-v1-FileSystemItemInformation)repeatedInformation about the FileSystemItems noticed as dependencies ### Reserve\_Request FieldTypeLabelDescriptionfile\_name[string](#string)FileSystemItem's name ### Reserve\_Response FieldTypeLabelDescriptionuri[string](#string)uri of the FileSystemItem reserved ### Upload\_Response FieldTypeLabelDescriptioninfo[FileSystemItemInformation](#ansys-api-speos-file-v1-FileSystemItemInformation)Information about the FileSystemItem createdupload\_duration[google.protobuf.Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration) ### FileTransferService Method NameRequest TypeResponse TypeDescriptionReserve[Reserve\_Request](#ansys-api-speos-file-v1-Reserve_Request)[Reserve\_Response](#ansys-api-speos-file-v1-Reserve_Response)Reserve a FileSystemItemUpload[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 uriDownload[Download\_Request](#ansys-api-speos-file-v1-Download_Request)[Chunk](#ansys-api-speos-file-v1-Chunk) streamDownload a FileSystemItem Server's' Initial Metadata: key: "file-size" - value: size of the file in bytesDelete[Delete\_Request](#ansys-api-speos-file-v1-Delete_Request)[Delete\_Response](#ansys-api-speos-file-v1-Delete_Response)Delete a FileSystemItemAddDependencies[AddDependencies\_Request](#ansys-api-speos-file-v1-AddDependencies_Request)[AddDependencies\_Response](#ansys-api-speos-file-v1-AddDependencies_Response)Add dependencies to a FileSystemItemListDependencies[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 FieldTypeLabelDescriptionintensity\_template[IntensityTemplate](#ansys-api-speos-intensity-v1-IntensityTemplate)Intensity containing its basic characteristicsguid[string](#string)optionalOptional 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the Intensity created in IntensityTemplatesManager ### Delete\_Request Request to delete a Intensity in IntensityTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the Intensity to be deleted ### Delete\_Response ### GetLibraryTypeInfo\_Request Request of GetLibraryTypeInfo FieldTypeLabelDescriptionguid[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 FieldTypeLabelDescriptionflux[common.v1.DataDoubles](#ansys-api-speos-common-v1-DataDoubles)Flux of the intensity file ### IntensityTemplate Intensity with its basic characteristics FieldTypeLabelDescriptionname[string](#string)Intensity namedescription[string](#string)Intensity descritionmetadata[IntensityTemplate.MetadataEntry](#ansys-api-speos-intensity-v1-IntensityTemplate-MetadataEntry)repeatedUser defined metadataslibrary[IntensityTemplate.Library](#ansys-api-speos-intensity-v1-IntensityTemplate-Library)From filelambertian[IntensityTemplate.Lambertian](#ansys-api-speos-intensity-v1-IntensityTemplate-Lambertian)Deprecated (use cos instead) - Lambertian distributioncos[IntensityTemplate.Cos](#ansys-api-speos-intensity-v1-IntensityTemplate-Cos)Lambert cosine law distributionsymmetric\_gaussian[IntensityTemplate.SymmetricGaussian](#ansys-api-speos-intensity-v1-IntensityTemplate-SymmetricGaussian)Deprecated (use gaussian instead) - Symmetric gaussian distributionasymmetric\_gaussian[IntensityTemplate.AsymmetricGaussian](#ansys-api-speos-intensity-v1-IntensityTemplate-AsymmetricGaussian)Deprecated (use gaussian instead) - Asymmetric gaussian distributiongaussian[IntensityTemplate.Gaussian](#ansys-api-speos-intensity-v1-IntensityTemplate-Gaussian)Gaussian distribution ### IntensityTemplate.AsymmetricGaussian FieldTypeLabelDescriptionFWHM\_angle\_x[double](#double)Full Width in degrees following x at Half MaximumFWHM\_angle\_y[double](#double)Full Width in degrees following y at Half Maximumtotal\_angle[double](#double)total angle in degrees of the emission of the light source ### IntensityTemplate.Cos FieldTypeLabelDescriptionN[double](#double)Order of cos lawtotal\_angle[double](#double)total angle in degrees of the emission of the light source ### IntensityTemplate.Gaussian FieldTypeLabelDescriptionFWHM\_angle\_x[double](#double)Full Width in degrees following x at Half MaximumFWHM\_angle\_y[double](#double)Full Width in degrees following y at Half Maximumtotal\_angle[double](#double)total angle in degrees of the emission of the light source ### IntensityTemplate.Lambertian FieldTypeLabelDescriptiontotal\_angle[double](#double)total angle in degrees of the emission of the light source ### IntensityTemplate.Library FieldTypeLabelDescriptionintensity\_file\_uri[string](#string)uri of the intensity file IES (.ies), Eulumdat (.ldt), speos intensities (.xmp) ### IntensityTemplate.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### IntensityTemplate.SymmetricGaussian FieldTypeLabelDescriptionFWHM\_angle[double](#double)Full Width in degrees at Half Maximumtotal\_angle[double](#double)total angle in degrees of the emission of the light source ### List\_Request ### List\_Response FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of the Intensities in IntensityTemplatesManager ### Read\_Request Request to read a Intensity in IntensityTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the Intensity to be read ### Read\_Response FieldTypeLabelDescriptionintensity\_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 FieldTypeLabelDescriptionguid[string](#string)Guid of the Intensity to be updatedintensity\_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 NameRequest TypeResponse TypeDescriptionGetLibraryTypeInfo[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 NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-intensity-v1-Create_Request)[Create\_Response](#ansys-api-speos-intensity-v1-Create_Response)Create a IntensityRead[Read\_Request](#ansys-api-speos-intensity-v1-Read_Request)[Read\_Response](#ansys-api-speos-intensity-v1-Read_Response)Read a IntensityUpdate[Update\_Request](#ansys-api-speos-intensity-v1-Update_Request)[Update\_Response](#ansys-api-speos-intensity-v1-Update_Response)Update a IntensityDelete[Delete\_Request](#ansys-api-speos-intensity-v1-Delete_Request)[Delete\_Response](#ansys-api-speos-intensity-v1-Delete_Response)Delete a IntensityList[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 FieldTypeLabelDescriptionlayer\_name[string](#string)initial\_source\_power[double](#double)initial\_source\_power\_watt[double](#double)initial\_source\_power\_lumen[double](#double)wavelength[double](#double)repeatedvalue[double](#double)repeated ### Map FieldTypeLabelDescriptionx\_nb[int32](#int32)number of x samplesy\_nb[int32](#int32)number of y sampleslayer\_nb[int32](#int32)number of layersx\_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)repeatedis\_finite\_distance[bool](#bool)finite\_difference\_sensor\_radius[double](#double)detector\_extent[bool](#bool)rad\_angular\_resolution\_radius[double](#double) ### CIEStandard NameNumberDescriptionCIE\_STANDARD\_UNKNOWN0CIE\_STANDARD\_19311CIE\_STANDARD\_19642 ### CoordinateUnits NameNumberDescriptionOptisUnitDefault0OptisUnitMillimetre1OptisUnitDegree2OptisUnitRadian3OptisUnitFeet4OptisUnitMicrometre5OptisUnitNanometre6OptisUnitMetre7OptisUnitPercent8OptisUnitdB9OptisUnitInvertMillimetre10OptisUnitNoUnit11OptisUnitWave12 ### IntensityTypes NameNumberDescriptionOptisIntensityOptis0UnsupportedOptisIntensitySAETypeA1OptisIntensitySAETypeB2OptisIntensityConoscopic3 ### LayerTypes NameNumberDescriptionOptisMapLayerTypeNone0OptisMapLayerTypeSource1OptisMapLayerTypeSurface2OptisMapLayerTypeError3UnsupportedOptisMapLayerTypeSequence4OptisMapLayerTypePolarization5OptisMapLayerTypeIncidenceAngle6 ### MapTypes NameNumberDescriptionOptisMapTypeBasic0UnsupportedOptisMapTypeLaser1UnsupportedOptisMapTypeSpectral2OptisMapTypeExtended3OptisMapTypeUnknown4OptisMapTypeGainMatrix5OptisMapTypeRays6OptisMapTypeFTM7OptisMapTypeOptisVR8OptisMapType3D9 ### UnitTypes NameNumberDescriptionOptisUnitTypeRadiometric0OptisUnitTypePhotometric1OptisUnitTypeTemperature2OptisUnitTypeUnknown3OptisUnitTypeFTM4UnsupportedOptisUnitTypeDegree5OptisUnitTypeInverseMeter6OptisUnitTypeInverseSquareMeter7OptisUnitTypePercent8OptisUnitTypeDiopter9OptisUnitTypeMeter10OptisUnitTypeInverseSteradian11 ### ValueTypes NameNumberDescriptionOptisValueTypeIrradiance0OptisValueTypeIntensity1OptisValueTypeRadiance2OptisValueTypeVisual3OptisValueTypeSel4UnsupportedOptisValueTypeLaserPhase5UnsupportedOptisValueTypeLaserPhasePlane6UnsupportedOptisValueTypeDirectionalIrradiance7OptisValueTypeGain8UnsupportedOptisValueTypeWaveFront9UnsupportedOptisValueTypeFTM10UnsupportedOptisValueTypeRP11UnsupportedOptisValueTypePowerDensity12OptisValueTypePopulation13OptisValueTypeTemperature14OptisValueTypeAngle15OptisValueTypeCurvature16OptisValueTypeCurvatureProduct17OptisValueTypePercentage18OptisValueTypeUnknown19OptisValueTypeRefractivePower20OptisValueTypeFlyThrough21OptisValueTypeColorimetricError22OptisValueTypeConoscopicRadiance23OptisValueTypeSNR24OptisValueTypeSNRIntensity25OptisValueTypeSNRDirectionalIrradiance26OptisValueTypePrecision27OptisValueTypePrecisionIntensity28OptisValueTypePrecisionDirectionalIrradiance29OptisValueTypeDistance30OptisValueTypeEyeSensorRadiance31OptisValueTypeSphericalProbabilityDensity32OptisValueTypeRSE33OptisValueTypeRSEIntensity34OptisValueTypeExposure35 ## intensity\_distributions/v1/eulumdat.proto (c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ### EulumdatFileInformation FieldTypeLabelDescriptioncompany\_identification[string](#string)measurement\_report\_number[string](#string)luminaire\_name[string](#string)luminaire\_number[string](#string)file\_name[string](#string)date[string](#string) ### EulumdatIntensityData FieldTypeLabelDescriptionnumber\_lamps[int32](#int32)integer > 0type\_lamps[string](#string)total\_luminous\_flux[double](#double)double > 0color\_temperature[string](#string)color\_rendering\_index[string](#string)wattage\_including\_ballast[double](#double) ### EulumdatIntensityDistribution FieldTypeLabelDescriptiondescription[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)repeateddirect\_ratio[double](#double)repeatedc\_plane[double](#double)repeatedg\_angle[double](#double)repeatedluminous\_intensity\_per\_klm[double](#double)repeated(cd/klm) ### Export\_Request ### Import\_Response ### Load\_Request FieldTypeLabelDescriptionfile\_uri[string](#string) ### Load\_Response ### Save\_Request FieldTypeLabelDescriptionfile\_uri[string](#string) ### Save\_Response ### EulumdatIntensityService service to manage eulumdat file Method NameRequest TypeResponse TypeDescriptionLoad[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 filenameSave[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 filenameImport[EulumdatIntensityDistribution](#ansys-api-speos-intensity_distributions-v1-eulumdat-EulumdatIntensityDistribution)[Import\_Response](#ansys-api-speos-intensity_distributions-v1-eulumdat-Import_Response)import EulumdatIntensityDistribution to CEulumdatExport[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 FieldTypeLabelDescriptionbase\_data[Map](#ansys-api-speos-intensity_distributions-v1-xmp-Map)value[Values](#ansys-api-speos-intensity_distributions-v1-xmp-Values) ### Values FieldTypeLabelDescriptionlayer[Values.Layers](#ansys-api-speos-intensity_distributions-v1-xmp-Values-Layers)repeatedmap layers ### Values.Layers FieldTypeLabelDescriptiony[Values.Layers.ys](#ansys-api-speos-intensity_distributions-v1-xmp-Values-Layers-ys)repeatedy samples of the map ### Values.Layers.ys FieldTypeLabelDescriptionx[double](#double)repeatedx samples of the map ## intensity\_distributions/v1/ies.proto (c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ### Export\_Request ### IesIntensityDistribution FieldTypeLabelDescriptionnorme\_version[int32](#int32)key\_words[string](#string)repeatedunit[int32](#int32)feet or metersnb\_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 > 0photo\_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 > 0future\_use[double](#double)float > 0input\_watt[double](#double)float > 0vertical\_angle[double](#double)repeatedhorizontal\_angle[double](#double)repeatedcandela\_value[double](#double)repeatedtilt\_angle[double](#double)repeatedtilt\_mult\_factor[double](#double)repeatedlocal\_vert[double](#double)tilt\_nb\_pair\_angle[int32](#int32) ### Import\_Response ### Load\_Request FieldTypeLabelDescriptionfile\_uri[string](#string) ### Load\_Response ### Save\_Request FieldTypeLabelDescriptionfile\_uri[string](#string) ### Save\_Response ### IesIntensityService service to manage IES files Method NameRequest TypeResponse TypeDescriptionLoad[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 filesSave[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 CIESExport[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 FieldTypeLabelDescriptionlayer[ColorValues.Layers](#ansys-api-speos-intensity_distributions-v1-xmp-ColorValues-Layers)repeatedmap layers ### ColorValues.Layers FieldTypeLabelDescriptiony[ColorValues.Layers.ys](#ansys-api-speos-intensity_distributions-v1-xmp-ColorValues-Layers-ys)repeatedy samples of the map ### ColorValues.Layers.ys FieldTypeLabelDescriptionx[ColorValues.Layers.ys.xs](#ansys-api-speos-intensity_distributions-v1-xmp-ColorValues-Layers-ys-xs)repeatedx samples of the map ### ColorValues.Layers.ys.xs FieldTypeLabelDescriptioncolor\_x[float](#float)color\_y[float](#float)color\_z[float](#float)radio[float](#float) ### Depth FieldTypeLabelDescriptiony[Depth.ys](#ansys-api-speos-intensity_distributions-v1-xmp-Depth-ys)repeatedy samples of the map ### Depth.ys FieldTypeLabelDescriptionx[float](#float)repeatedx samples of the map ### SpectralMap FieldTypeLabelDescriptionbase\_data[Map](#ansys-api-speos-intensity_distributions-v1-xmp-Map)wavelength\_nb[int32](#int32)Integer >= 3wavelength\_min[double](#double)Range is between 100nm and 100000nmwavelength\_max[double](#double)Range is between 100nm and 100000nmspectral\_value[SpectralValues](#ansys-api-speos-intensity_distributions-v1-xmp-SpectralValues)spectral valuescolor\_value[ColorValues](#ansys-api-speos-intensity_distributions-v1-xmp-ColorValues)colorimetric and radiometric datadepth\_value[Depth](#ansys-api-speos-intensity_distributions-v1-xmp-Depth)spectral\_data\_loaded[bool](#bool)spectral data is not always loaded unless explicitly specifieddepth\_data\_loaded[bool](#bool)depth data not always filled out ### SpectralValues FieldTypeLabelDescriptionlayer[SpectralValues.Layers](#ansys-api-speos-intensity_distributions-v1-xmp-SpectralValues-Layers)repeatedmap layers ### SpectralValues.Layers FieldTypeLabelDescriptionwavelength[SpectralValues.Layers.Wavelengths](#ansys-api-speos-intensity_distributions-v1-xmp-SpectralValues-Layers-Wavelengths)repeatedwavelength ### SpectralValues.Layers.Wavelengths FieldTypeLabelDescriptiony[SpectralValues.Layers.Wavelengths.ys](#ansys-api-speos-intensity_distributions-v1-xmp-SpectralValues-Layers-Wavelengths-ys)repeatedy samples of the map ### SpectralValues.Layers.Wavelengths.ys FieldTypeLabelDescriptionx[float](#float)repeatedx 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 FieldTypeLabelDescriptionfile\_uri[string](#string) ### Load\_Response ### Save\_Request FieldTypeLabelDescriptionfile\_uri[string](#string) ### Save\_Response ### XmpDistribution xmp map definition FieldTypeLabelDescriptionextended\_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 NameRequest TypeResponse TypeDescriptionLoad[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 fileSave[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 fileImport[XmpDistribution](#ansys-api-speos-intensity_distributions-v1-xmp-XmpDistribution)[Import\_Response](#ansys-api-speos-intensity_distributions-v1-xmp-Import_Response)import XmpDistribution to COptisMapExport[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 FieldTypeLabelDescriptionjob[Job](#ansys-api-speos-job-v2-Job)Job characteristicsguid[string](#string)optionalOptional 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the Job created in JobsManager ### Delete\_Request Request to delete a Job in JobsManager FieldTypeLabelDescriptionguid[string](#string)Guid of the Job to be deleted ### Delete\_Response ### GetError\_Request FieldTypeLabelDescriptionguid[string](#string)Guid of the Job in JobsManager. ### GetError\_Response FieldTypeLabelDescriptionname[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 FieldTypeLabelDescriptionguid[string](#string)Guid of the Job in JobsManager. ### GetInformation\_Response FieldTypeLabelDescriptiontitle[string](#string)name[string](#string)infos[string](#string)progress[double](#double)value between 0.0 and 1.0elapsed\_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)repeatedDepending on the Job::Type, list of the CPU or GPU modelsrays\_number[uint64](#uint64)Number of rays emitted since the (re)start of the simulationrays\_number\_per\_second[uint64](#uint64)Number of rays emitted in the last second ### GetProgressStatus\_Request FieldTypeLabelDescriptionguid[string](#string)Guid of the Job in JobsManager. ### GetProgressStatus\_Response FieldTypeLabelDescriptiontitle[string](#string)name[string](#string)infos[string](#string)progress[double](#double)value between 0.0 and 1.0elapsed\_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)repeatedDepending on the Job::Type, list of the CPU or GPU modelsrays\_number[uint64](#uint64)Number of rays emitted since the (re)start of the simulationrays\_number\_per\_second[uint64](#uint64)Number of rays emitted in the last second ### GetRayPaths\_Request FieldTypeLabelDescriptionguid[string](#string)Guid of the Job in JobsManager.raw\_data[bool](#bool)optionalBoolean to get the wavelengths in response streamdisplay\_data[bool](#bool)optionalBoolean to get the colors (RGB24 format) in response stream ### GetResults\_Request FieldTypeLabelDescriptionguid[string](#string)Guid of the Job in JobsManager. ### GetResults\_Response FieldTypeLabelDescriptionresults[Result](#ansys-api-speos-job-v2-Result)repeatedList of the Job results ### GetState\_Request FieldTypeLabelDescriptionguid[string](#string)Guid of the Job in JobsManager. ### GetState\_Response FieldTypeLabelDescriptionstate[Job.State](#ansys-api-speos-job-v2-Job-State) ### Job FieldTypeLabelDescriptionname[string](#string)Job namedescription[string](#string)Job descritionmetadata[Job.MetadataEntry](#ansys-api-speos-job-v2-Job-MetadataEntry)repeatedUser defined metadatasscene\_guid[string](#string)Guid of the Scene in ScenesManagersimulation\_path[string](#string)Simulation path in the scene that will be used by the jobjob\_type[Job.Type](#ansys-api-speos-job-v2-Job-Type)Type of the job : CPU, GPUdirect\_mc\_simulation\_properties[Job.DirectMCSimulationProperties](#ansys-api-speos-job-v2-Job-DirectMCSimulationProperties)Properties to be filled for simulation based on DirectMCSimulationTemplateinverse\_mc\_simulation\_properties[Job.InverseMCSimulationProperties](#ansys-api-speos-job-v2-Job-InverseMCSimulationProperties)Properties to be filled for simulation based on InverseMCSimulationTemplateinteractive\_simulation\_properties[Job.InteractiveSimulationProperties](#ansys-api-speos-job-v2-Job-InteractiveSimulationProperties)Properties to be filled for simulation based on Interactivevirtualbsdfbench\_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. FieldTypeLabelDescriptionstop\_condition\_rays\_number[int64](#int64)optionalTo stop the simulation after a certain number of rays were sentstop\_condition\_duration[int64](#int64)optionalTo stop the simulation after a certain durationautomatic\_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 FieldTypeLabelDescriptionrays\_number\_per\_sources[Job.InteractiveSimulationProperties.RaysNumberPerSource](#ansys-api-speos-job-v2-Job-InteractiveSimulationProperties-RaysNumberPerSource)repeatedIf 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 FieldTypeLabelDescriptionsource\_path[string](#string)Path to the source. Hint: same path that was given in Scene::SimulationInstancerays\_nb[uint32](#uint32)optionalNumber 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. FieldTypeLabelDescriptionoptimized\_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)optionalTo stop the simulation after a certain durationautomatic\_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. FieldTypeLabelDescriptionmin\_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 FieldTypeLabelDescriptionstop\_condition\_passes\_number[uint32](#uint32)optionalTo 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. FieldTypeLabelDescriptionmin\_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 FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Job.Timeline If timeline is applied to the job, fill Timeline message. FieldTypeLabelDescriptionstart\_time[double](#double)Define the start time (s). ### Job.VirtualBSDFBenchSimulationProperties If no stop condition is set, the simulation ends when you stop the process. FieldTypeLabelDescriptionstop\_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 FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of the Jobs in JobsManager ### Read\_Request Request to read a Job in JobsManager FieldTypeLabelDescriptionguid[string](#string)Guid of the Job to be read ### Read\_Response FieldTypeLabelDescriptionjob[Job](#ansys-api-speos-job-v2-Job)Job corresponding to the guid given in Read\_Request ### Result FieldTypeLabelDescriptionpath[string](#string)Result path on the serverupload\_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 FieldTypeLabelDescriptionguid[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 FieldTypeLabelDescriptionguid[string](#string)Guid of the Job in JobsManager. ### Start\_Response ### Stop\_Request FieldTypeLabelDescriptionguid[string](#string)Guid of the Job in JobsManager. ### Stop\_Response ### Update\_Request Request to update a Job in JobsManager FieldTypeLabelDescriptionguid[string](#string)Guid of the Job to be updatedjob[Job](#ansys-api-speos-job-v2-Job)Job that will be used for the update ### Update\_Response ### Job.State NameNumberDescriptionQUEUED0RUNNING1PAUSED2STOPPED3FINISHED4IN\_ERROR5 ### Job.Type NameNumberDescriptionCPU0GPU1 ### JobActions Service to handle a job Method NameRequest TypeResponse TypeDescriptionGetState[GetState\_Request](#ansys-api-speos-job-v2-GetState_Request)[GetState\_Response](#ansys-api-speos-job-v2-GetState_Response)Get the state of a JobStart[Start\_Request](#ansys-api-speos-job-v2-Start_Request)[Start\_Response](#ansys-api-speos-job-v2-Start_Response)Start a JobStop[Stop\_Request](#ansys-api-speos-job-v2-Stop_Request)[Stop\_Response](#ansys-api-speos-job-v2-Stop_Response)Stop a JobGetError[GetError\_Request](#ansys-api-speos-job-v2-GetError_Request)[GetError\_Response](#ansys-api-speos-job-v2-GetError_Response)Get error of a JobGetResults[GetResults\_Request](#ansys-api-speos-job-v2-GetResults_Request)[GetResults\_Response](#ansys-api-speos-job-v2-GetResults_Response)Get the results of a JobGetInformation[GetInformation\_Request](#ansys-api-speos-job-v2-GetInformation_Request)[GetInformation\_Response](#ansys-api-speos-job-v2-GetInformation_Response)Get Information about a JobGetRayPaths[GetRayPaths\_Request](#ansys-api-speos-job-v2-GetRayPaths_Request)[results.v1.RayPath](#ansys-api-speos-results-v1-RayPath) streamGet RayPaths generated by a Job based on an interactive simulationGetProgressStatus[GetProgressStatus\_Request](#ansys-api-speos-job-v2-GetProgressStatus_Request)[GetProgressStatus\_Response](#ansys-api-speos-job-v2-GetProgressStatus_Response)Get progress status about a JobSaveFile[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 NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-job-v2-Create_Request)[Create\_Response](#ansys-api-speos-job-v2-Create_Response)Create a JobRead[Read\_Request](#ansys-api-speos-job-v2-Read_Request)[Read\_Response](#ansys-api-speos-job-v2-Read_Response)Read a JobUpdate[Update\_Request](#ansys-api-speos-job-v2-Update_Request)[Update\_Response](#ansys-api-speos-job-v2-Update_Response)Update a JobDelete[Delete\_Request](#ansys-api-speos-job-v2-Delete_Request)[Delete\_Response](#ansys-api-speos-job-v2-Delete_Response)Delete a JobList[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 FieldTypeLabelDescriptionlpf\_reader\_guid[string](#string) ### CloseLpfFileName\_Response ### ComputeUniqueFaceId\_Request\_Mono FieldTypeLabelDescriptionbody\_context\_id[uint32](#uint32)face\_id[uint32](#uint32) ### ComputeUniqueFaceId\_Request\_Multi FieldTypeLabelDescriptionlpf\_reader\_guid[string](#string)body\_context\_id[uint32](#uint32)face\_id[uint32](#uint32) ### ComputeUniqueFaceId\_Response FieldTypeLabelDescriptionunique\_face\_id[uint32](#uint32) ### Create\_Request\_Multi ### Create\_Response FieldTypeLabelDescriptionlpf\_reader\_guid[string](#string) ### Delete\_Request\_Multi FieldTypeLabelDescriptionlpf\_reader\_guid[string](#string) ### Delete\_Response ### DoubletDouble FieldTypeLabelDescriptionx[double](#double)y[double](#double) ### GetInformation\_Request\_Mono ### GetInformation\_Request\_Multi FieldTypeLabelDescriptionlpf\_reader\_guid[string](#string) ### GetInformation\_Response FieldTypeLabelDescriptionnb\_of\_traces[int64](#int64)nb\_of\_xmps[uint32](#uint32)has\_sensor\_contributions[bool](#bool)sensor\_names[string](#string)repeatedThe sensor position in the repeated field sensor\_names gives the sensor\_id ### InitLpfFileName\_Request\_Mono FieldTypeLabelDescriptionlpf\_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 FieldTypeLabelDescriptionlpf\_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 FieldTypeLabelDescriptionimpacts[TripletFloat](#ansys-api-speos-lpf-v2-TripletFloat)repeatedwavelengths[double](#double)repeatedbody\_context\_ids[uint32](#uint32)repeatedunique\_face\_ids[uint32](#uint32)repeatedinteraction\_statuses[RayPath.PhotonStatus](#ansys-api-speos-lpf-v2-RayPath-PhotonStatus)repeatedlastDirection[TripletFloat](#ansys-api-speos-lpf-v2-TripletFloat)sensor\_contributions[RayPath.SensorContribution](#ansys-api-speos-lpf-v2-RayPath-SensorContribution)repeated ### RayPath.SensorContribution FieldTypeLabelDescriptionsensor\_id[uint32](#uint32)The sensor\_id corresponds to the position of the sensor in the repeated field GetInformation\_Response::sensor\_namescoordinates[DoubletDouble](#ansys-api-speos-lpf-v2-DoubletDouble) ### Read\_Request\_Mono ### Read\_Request\_Multi FieldTypeLabelDescriptionlpf\_reader\_guid[string](#string) ### TripletFloat FieldTypeLabelDescriptionx[float](#float)y[float](#float)z[float](#float) ### RayPath.PhotonStatus NameNumberDescriptionStatusAbsorbed0StatusSpecularTransmitted1StatusGaussianTransmitted2StatusLambertianTransmitted3StatusVolumicDiffused4StatusJustEmitted5StatusDiracTransmitted6StatusError7StatusErrorVolumicBodyNotClosed8StatusErrorVolumeConflict9StatusError2DTangency10StatusError2DIntersect3DWarning11StatusErrorNonOpticalMaterial12StatusErrorIntersection13StatusErrorNonOpticalMaterialAtEmission14StatusError3DTextureSupportTangency15StatusLast16StatusFirst-7StatusDiracReflected-6StatusReserved-5StatusGrinStep-4StatusLambertianReflected-3StatusGaussianReflected-2StatusSpecularReflected-1 ### LpfFileReader\_Mono service to read lpf file - server can handle one reading - call CloseLpfFileName then InitLpfFileName to start another reading. Method NameRequest TypeResponse TypeDescriptionInitLpfFileName[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 nothingGetInformation[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 nothingRead[Read\_Request\_Mono](#ansys-api-speos-lpf-v2-Read_Request_Mono)[RayPath](#ansys-api-speos-lpf-v2-RayPath) streamRead lpf file and get all the ray pathsComputeUniqueFaceId[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 NameRequest TypeResponse TypeDescriptionCreate[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 guidInitLpfFileName[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 nothingGetInformation[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 nothingRead[Read\_Request\_Multi](#ansys-api-speos-lpf-v2-Read_Request_Multi)[RayPath](#ansys-api-speos-lpf-v2-RayPath) streamRead lpf file and get all the ray pathsComputeUniqueFaceId[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 faceIdDelete[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 FieldTypeLabelDescriptionname[string](#string)Unique identifier in its Partdisplay\_name[string](#string)User name to be displayeddescription[string](#string)metadata[Body.MetadataEntry](#ansys-api-speos-body-v1-Body-MetadataEntry)repeatedUser defined metadataface\_guids[string](#string)repeatedList of faces constituting the body ### Body.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Create\_Request Request to create a body FieldTypeLabelDescriptionbody[Body](#ansys-api-speos-body-v1-Body)body to createguid[string](#string)optionalOptional 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the created body ### Delete\_Request Request to delete a body FieldTypeLabelDescriptionguid[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 FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of all bodies ### ReadAll\_Request Request to read all bodies ### ReadAll\_Response Response to read all bodies FieldTypeLabelDescriptionbodies[ReadAll\_Response.BodiesEntry](#ansys-api-speos-body-v1-ReadAll_Response-BodiesEntry)repeatedRead bodies with their Guids ### ReadAll\_Response.BodiesEntry FieldTypeLabelDescriptionkey[string](#string)value[Body](#ansys-api-speos-body-v1-Body) ### Read\_Request Request to read a body FieldTypeLabelDescriptionguid[string](#string)Guid of the body to be read ### Read\_Response Response to read a body FieldTypeLabelDescriptionbody[Body](#ansys-api-speos-body-v1-Body)body corresponding to the guid given in Read\_Request ### Update\_Request Request to update a body FieldTypeLabelDescriptionguid[string](#string)Guid of the body to be updatedbody[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 NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-body-v1-Create_Request)[Create\_Response](#ansys-api-speos-body-v1-Create_Response)Create a new bodyRead[Read\_Request](#ansys-api-speos-body-v1-Read_Request)[Read\_Response](#ansys-api-speos-body-v1-Read_Response)Read a bodyUpdate[Update\_Request](#ansys-api-speos-body-v1-Update_Request)[Update\_Response](#ansys-api-speos-body-v1-Update_Response)Update a bodyDelete[Delete\_Request](#ansys-api-speos-body-v1-Delete_Request)[Delete\_Response](#ansys-api-speos-body-v1-Delete_Response)Delete a bodyList[List\_Request](#ansys-api-speos-body-v1-List_Request)[List\_Response](#ansys-api-speos-body-v1-List_Response)List all bodies in managerReadAll[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 NameRequest TypeResponse TypeDescription ## part/v1/face.proto (c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ### Chunk Chunk of a Face FieldTypeLabelDescriptionface\_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 FieldTypeLabelDescriptionguid[string](#string)Guid of a FacesManager element - Used for FaceActions.Upload rpcname[string](#string)display\_name[string](#string)description[string](#string)metadata[Chunk.FaceHeader.MetadataEntry](#ansys-api-speos-face-v1-Chunk-FaceHeader-MetadataEntry)repeatedsizes[int32](#int32)repeatedvectors 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 FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Chunk.Facets FieldTypeLabelDescriptiondata[uint32](#uint32)repeated ### Chunk.FacetsData FieldTypeLabelDescriptionnew\_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\_sizedata[float](#float)repeatedRaw data for each facet ### Chunk.Normals FieldTypeLabelDescriptiondata[float](#float)repeated ### Chunk.Vertices FieldTypeLabelDescriptiondata[float](#float)repeated ### Chunk.VerticesData FieldTypeLabelDescriptionnew\_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\_sizedata[float](#float)repeatedRaw data for each vertice ### Create\_Request Request to create a face FieldTypeLabelDescriptionface[Face](#ansys-api-speos-face-v1-Face)face to createguid[string](#string)optionalOptional 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the created face ### Delete\_Request Request to delete a face FieldTypeLabelDescriptionguid[string](#string)Guid of the face to be deleted ### Delete\_Response Response to delete a face ### Download\_Request FieldTypeLabelDescriptionguid[string](#string)Guid of a FacesManager elementguids[string](#string)repeatedGuids of FacesManager elements to download.only\_face\_header[bool](#bool)optionalIf this optional boolean is set to true, only the FaceHeader will be returned in answer stream. ### Face Face definition with meshing information FieldTypeLabelDescriptionname[string](#string)Unique identifier in its Bodydisplay\_name[string](#string)User name to be displayeddescription[string](#string)metadata[Face.MetadataEntry](#ansys-api-speos-face-v1-Face-MetadataEntry)repeateduser defined metadatavertices[float](#float)repeatedcoordinates of all points (p1x p1y p1z p2x p2y p2z ...)facets[uint32](#uint32)repeatedindexes of points for all triangles (t1\_1 t1\_2 t1\_3 t2\_1 t2\_2 t2\_3 ...)normals[float](#float)repeatednormal vector for all points (n1x n1y n1z n2x n2y n2z ...)vertices\_data[Face.MeshData](#ansys-api-speos-face-v1-Face-MeshData)repeatedList of data applied to vertices (like texture coordinates uv)facets\_data[Face.MeshData](#ansys-api-speos-face-v1-Face-MeshData)repeatedList of data applied to facets (like temperature) ### Face.MeshData Store named data on meshed FieldTypeLabelDescriptionname[string](#string)Identifier name (uv, temperature...)data[float](#float)repeatedRaw data for each mesh ### Face.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### List\_Request Request to list all faces ### List\_Response Response to list all faces FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of all faces ### Read\_Request Request to read a face FieldTypeLabelDescriptionguid[string](#string)Guid of the face to be read ### Read\_Response Response to read a face FieldTypeLabelDescriptionface[Face](#ansys-api-speos-face-v1-Face)face corresponding to the guid given in Read\_Request ### ReserveFace\_Request FieldTypeLabelDescriptionfaces[Face](#ansys-api-speos-face-v1-Face)repeatedrepeated face headers ### ReserveFace\_Response FieldTypeLabelDescriptionguids[string](#string)repeatedguids of the created faces, in the order sent ### Update\_Request Request to update a face FieldTypeLabelDescriptionguid[string](#string)Guid of the face to be updatedface[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 NameRequest TypeResponse TypeDescriptionReserveFaces[ReserveFace\_Request](#ansys-api-speos-face-v1-ReserveFace_Request) stream[ReserveFace\_Response](#ansys-api-speos-face-v1-ReserveFace_Response) streamallocate faces before uploading them. to have maximum benefit, only the name, description and metadata should be filledUpload[Chunk](#ansys-api-speos-face-v1-Chunk) stream[Upload\_Response](#ansys-api-speos-face-v1-Upload_Response)Update a face via streamingDownload[Download\_Request](#ansys-api-speos-face-v1-Download_Request)[Chunk](#ansys-api-speos-face-v1-Chunk) streamRead a face via streaming ### FacesManager Method NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-face-v1-Create_Request)[Create\_Response](#ansys-api-speos-face-v1-Create_Response)Create a new faceRead[Read\_Request](#ansys-api-speos-face-v1-Read_Request)[Read\_Response](#ansys-api-speos-face-v1-Read_Response)Read a faceUpdate[Update\_Request](#ansys-api-speos-face-v1-Update_Request)[Update\_Response](#ansys-api-speos-face-v1-Update_Response)Update a faceDelete[Delete\_Request](#ansys-api-speos-face-v1-Delete_Request)[Delete\_Response](#ansys-api-speos-face-v1-Delete_Response)Delete a faceList[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 FieldTypeLabelDescriptionpart[Part](#ansys-api-speos-part-v1-Part)Element to createguid[string](#string)optionalOptional 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the created element ### Delete\_Request Request to delete an element FieldTypeLabelDescriptionguid[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 FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of all Parts ### Part Part definition, a Part is related to a CAD part file (scdocx, prt, ...) made of meshed bodies and faces FieldTypeLabelDescriptionname[string](#string)description[string](#string)metadata[Part.MetadataEntry](#ansys-api-speos-part-v1-Part-MetadataEntry)repeatedUser defined metadatabody\_guids[string](#string)repeatedList of bodies constituting the partparts[Part.PartInstance](#ansys-api-speos-part-v1-Part-PartInstance)repeatedList of sub parts ### Part.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Part.PartInstance Instance of Part in parent coordinates system FieldTypeLabelDescriptionname[string](#string)Unique identifier in its Partdisplay\_name[string](#string)User name to be displayeddescription[string](#string)metadata[Part.PartInstance.MetadataEntry](#ansys-api-speos-part-v1-Part-PartInstance-MetadataEntry)repeatedUser defined metadatapart\_guid[string](#string)Guid of Part in PartsManageraxis\_system[double](#double)repeatedPart 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 FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### ReadAll\_Request Request to read all parts ### ReadAll\_Response Response to read all parts FieldTypeLabelDescriptionparts[ReadAll\_Response.PartsEntry](#ansys-api-speos-part-v1-ReadAll_Response-PartsEntry)repeatedRead parts with their Guids ### ReadAll\_Response.PartsEntry FieldTypeLabelDescriptionkey[string](#string)value[Part](#ansys-api-speos-part-v1-Part) ### Read\_Request Request to read an element FieldTypeLabelDescriptionguid[string](#string)Guid of the element to be read ### Read\_Response Response to read an element FieldTypeLabelDescriptionpart[Part](#ansys-api-speos-part-v1-Part)Element corresponding to the guid given in Read\_Request ### Update\_Request Request to update an element FieldTypeLabelDescriptionguid[string](#string)Guid of the PartTemplate to be updatedpart[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 NameRequest TypeResponse TypeDescription ### PartsManager Service to manage geometrical objects Method NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-part-v1-Create_Request)[Create\_Response](#ansys-api-speos-part-v1-Create_Response)Create a new partRead[Read\_Request](#ansys-api-speos-part-v1-Read_Request)[Read\_Response](#ansys-api-speos-part-v1-Read_Response)Read a partUpdate[Update\_Request](#ansys-api-speos-part-v1-Update_Request)[Update\_Response](#ansys-api-speos-part-v1-Update_Response)Update a partDelete[Delete\_Request](#ansys-api-speos-part-v1-Delete_Request)[Delete\_Response](#ansys-api-speos-part-v1-Delete_Response)Delete a partList[List\_Request](#ansys-api-speos-part-v1-List_Request)[List\_Response](#ansys-api-speos-part-v1-List_Response)List all parts in managerReadAll[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 FieldTypeLabelDescriptionxmp\_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 FieldTypeLabelDescriptionmap\_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 FieldTypeLabelDescriptionmap\_to\_merge\_uri[string](#string)repeatedList 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)repeatedOptional axis system to force orientation in merged Speos360 file. ### MergeXMPsToXMPOrSpeos360\_Response ### SplitSpeos360IntoXMPs\_Request FieldTypeLabelDescriptionfile\_uri[string](#string)Uri of the speos360 file to split. ### SplitSpeos360IntoXMPs\_Response FieldTypeLabelDescriptionsplitted\_map\_uri[string](#string)repeatedList of uris to XMP files. ### MapActions Actions available with XMP and Speos360 result file. Method NameRequest TypeResponse TypeDescriptionMergeXMPsToXMPOrSpeos360[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 FieldTypeLabelDescriptionimpacts\_coordinates[float](#float)repeatedImpacts coordinates of this RayPath. (i0x, i0y, i0z, i1x, i1y, i1z, ..., iNx, iNy, iNz) with N+1 impactswavelengths[double](#double)repeatedWavelength at each impact.body\_context\_ids[uint32](#uint32)repeatedID of the body impacted at each impact.unique\_face\_ids[uint32](#uint32)repeatedID of the face impacted at each impact.interaction\_statuses[RayPath.PhotonStatus](#ansys-api-speos-results-v1-RayPath-PhotonStatus)repeatedInteraction type at each impact with the elements encountered.last\_direction[float](#float)repeatedDirection 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 NameNumberDescriptionStatusAbsorbed0StatusSpecularTransmitted1StatusGaussianTransmitted2StatusLambertianTransmitted3StatusVolumicDiffused4StatusJustEmitted5StatusDiracTransmitted6StatusError7StatusErrorVolumicBodyNotClosed8StatusErrorVolumeConflict9StatusError2DTangency10StatusError2DIntersect3DWarning11StatusErrorNonOpticalMaterial12StatusErrorIntersection13StatusErrorNonOpticalMaterialAtEmission14StatusError3DTextureSupportTangency15StatusLast16StatusFirst-7StatusDiracReflected-6StatusReserved-5StatusGrinStep-4StatusLambertianReflected-3StatusGaussianReflected-2StatusSpecularReflected-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 FieldTypeLabelDescriptionscene[Scene](#ansys-api-speos-scene-v1-Scene) ### Create\_Response FieldTypeLabelDescriptionguid[string](#string)Guid of the Scene created in ScenesManager ### Delete\_Request Request to delete a Scene in ScenesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the Scene to be deleted ### Delete\_Response ### GetSourceRayPaths\_Request FieldTypeLabelDescriptionguid[string](#string)Guid of a ScenesManager elementsource\_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 scenerays\_nb[uint32](#uint32)optionalNumber of rays sent by the source. Default 100raw\_data[bool](#bool)optionalBoolean to get the wavelengths in response streamdisplay\_data[bool](#bool)optionalBoolean to get the colors (RGB24 format) in response stream ### List\_Request ### List\_Response FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of the Scenes in ScenesManager ### LoadFile\_Request Request to LoadFile service FieldTypeLabelDescriptionguid[string](#string)Guid of a ScenesManager element to updatefile\_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 FieldTypeLabelDescriptionguid[string](#string)Guid of the Scene to be read ### Read\_Response FieldTypeLabelDescriptionscene[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. FieldTypeLabelDescriptionguid[string](#string)Guid of a ScenesManager element to savefile\_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 FieldTypeLabelDescriptionname[string](#string)description[string](#string)metadata[Scene.MetadataEntry](#ansys-api-speos-scene-v1-Scene-MetadataEntry)repeatedUser defined metadatapart\_guid[string](#string)Guid from PartsManager of the geometrical part included inside the scenevops[Scene.VOPInstance](#ansys-api-speos-scene-v1-Scene-VOPInstance)repeatedThe volume materials applied on geometriessops[Scene.SOPInstance](#ansys-api-speos-scene-v1-Scene-SOPInstance)repeatedThe surface materials applied on geometriessources[Scene.SourceInstance](#ansys-api-speos-scene-v1-Scene-SourceInstance)repeatedThe sources added in the scenesensors[Scene.SensorInstance](#ansys-api-speos-scene-v1-Scene-SensorInstance)repeatedThe sensors added in the scenesimulations[Scene.SimulationInstance](#ansys-api-speos-scene-v1-Scene-SimulationInstance)repeatedThe simulations added in the scenescenes[Scene.SceneInstance](#ansys-api-speos-scene-v1-Scene-SceneInstance)repeatedSub 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 FieldTypeLabelDescriptiongeo\_paths[string](#string)repeatedlist of geo paths ### Scene.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Scene.SOPInstance Instance of a SOP to apply on geometries of the scene FieldTypeLabelDescriptionname[string](#string)description[string](#string)metadata[Scene.SOPInstance.MetadataEntry](#ansys-api-speos-scene-v1-Scene-SOPInstance-MetadataEntry)repeatedUser defined metadatasop\_guid[string](#string)Guid of the element to instantiategeometries[Scene.GeoPaths](#ansys-api-speos-scene-v1-Scene-GeoPaths)Geometries that will use this material ### Scene.SOPInstance.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Scene.SceneInstance FieldTypeLabelDescriptionname[string](#string)description[string](#string)metadata[Scene.SceneInstance.MetadataEntry](#ansys-api-speos-scene-v1-Scene-SceneInstance-MetadataEntry)repeatedUser defined metadatascene\_guid[string](#string)Guid of the element to instantiateaxis\_system[double](#double)repeatedScene position relative to parent PartTemplate reference (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) ### Scene.SceneInstance.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Scene.SensorInstance Instance of a sensor to add in the scene FieldTypeLabelDescriptionname[string](#string)description[string](#string)metadata[Scene.SensorInstance.MetadataEntry](#ansys-api-speos-scene-v1-Scene-SensorInstance-MetadataEntry)repeatedUser defined metadatasensor\_guid[string](#string)Guid of the SensorTemplate in SensorTemplatesManager to instantiateresult\_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 CameraSensorTemplateirradiance\_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 IrradianceSensorTemplateradiance\_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 FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 : Nonelayer\_type\_source[Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeSource)Layer type : Source ### Scene.SensorInstance.IrradianceSensorProperties FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 : Nonelayer\_type\_source[Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeSource)Layer type : Sourcelayer\_type\_face[Scene.SensorInstance.LayerTypeFace](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeFace)Layer type : Facelayer\_type\_sequence[Scene.SensorInstance.LayerTypeSequence](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeSequence)Layer type : Sequencelayer\_type\_polarization[Scene.SensorInstance.LayerTypePolarization](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypePolarization)Layer type : Polarizationlayer\_type\_incidence\_angle[Scene.SensorInstance.LayerTypeIncidenceAngle](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeIncidenceAngle)Layer type : Incidence angleintegration\_direction[double](#double)repeatedSensor 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\_typeoutput\_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. FieldTypeLabelDescriptionsca\_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)repeatedLayers that will be taken into account in the result. ### Scene.SensorInstance.LayerTypeFace.Layer FieldTypeLabelDescriptionname[string](#string)Name of the layergeometries[Scene.GeoPaths](#ansys-api-speos-scene-v1-Scene-GeoPaths)Surface selected. ### Scene.SensorInstance.LayerTypeIncidenceAngle Includes one layer per range of incident angles. FieldTypeLabelDescriptionsampling[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. FieldTypeLabelDescriptionmaximum\_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 FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Scene.SensorInstance.RadianceSensorProperties FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz)observer\_point[double](#double)repeatedPosition 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 : Nonelayer\_type\_source[Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeSource)Layer type : Sourcelayer\_type\_face[Scene.SensorInstance.LayerTypeFace](#ansys-api-speos-scene-v1-Scene-SensorInstance-LayerTypeFace)Layer type : Facelayer\_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 FieldTypeLabelDescriptionname[string](#string)description[string](#string)metadata[Scene.SimulationInstance.MetadataEntry](#ansys-api-speos-scene-v1-Scene-SimulationInstance-MetadataEntry)repeatedUser defined metadatasimulation\_guid[string](#string)Guid of the element to instantiatesensor\_paths[string](#string)repeatedSensors 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)repeatedSources 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 FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Scene.SourceInstance Instance of a source to add in the scene FieldTypeLabelDescriptionname[string](#string)description[string](#string)metadata[Scene.SourceInstance.MetadataEntry](#ansys-api-speos-scene-v1-Scene-SourceInstance-MetadataEntry)repeatedUser defined metadatasource\_guid[string](#string)Guid of the SourceTemplate in SourceTemplatesManager to instantiateluminaire\_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 Luminairesurface\_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 Surfacerayfile\_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 FieldTypeLabelDescriptionlibrary\_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 Libraryasymmetric\_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 AsymmetricGaussiangaussian\_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 FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedorientation (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) ### Scene.SourceInstance.IntensityProperties.GaussianProperties FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedoptional - 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 FieldTypeLabelDescriptionexit\_geometries[Scene.GeoPaths](#ansys-api-speos-scene-v1-Scene-GeoPaths)Exit Geometries that will use this surface sourceaxis\_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 FieldTypeLabelDescriptionvalues[double](#double)repeatedorientation (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 FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition of the source (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz) ### Scene.SourceInstance.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Scene.SourceInstance.RayFileProperties FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 FieldTypeLabelDescriptionexitance\_constant\_properties[Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties](#ansys-api-speos-scene-v1-Scene-SourceInstance-SurfaceProperties-ExitanceConstantProperties)To be filled if the Surface SourceTemplate has ExitanceConstantexitance\_variable\_properties[Scene.SourceInstance.SurfaceProperties.ExitanceVariableProperties](#ansys-api-speos-scene-v1-Scene-SourceInstance-SurfaceProperties-ExitanceVariableProperties)To be filled if the Surface SourceTemplate has ExitanceVariableintensity\_properties[Scene.SourceInstance.IntensityProperties](#ansys-api-speos-scene-v1-Scene-SourceInstance-IntensityProperties) ### Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties FieldTypeLabelDescriptiongeo\_paths[Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties.GeoPath](#ansys-api-speos-scene-v1-Scene-SourceInstance-SurfaceProperties-ExitanceConstantProperties-GeoPath)repeated ### Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties.GeoPath FieldTypeLabelDescriptiongeo\_path[string](#string)Geometry that will use this surface source ("" for a whole body, or "/" for a specific face)reverse\_normal[bool](#bool)optionaloptional - if not set or false : normal is not reversed. ### Scene.SourceInstance.SurfaceProperties.ExitanceVariableProperties FieldTypeLabelDescriptionaxis\_plane[double](#double)repeatedPosition 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 FieldTypeLabelDescriptionname[string](#string)description[string](#string)metadata[Scene.VOPInstance.MetadataEntry](#ansys-api-speos-scene-v1-Scene-VOPInstance-MetadataEntry)repeatedUser defined metadatavop\_guid[string](#string)Guid of the element to instantiategeometries[Scene.GeoPaths](#ansys-api-speos-scene-v1-Scene-GeoPaths)Geometries that will use this material ### Scene.VOPInstance.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Update\_Request Request to update a Scene in ScenesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the Scene to be updatedscene[Scene](#ansys-api-speos-scene-v1-Scene)Scene that will be used for the update ### Update\_Response ### Scene.SensorInstance.EnumRayFileType Ray file types available NameNumberDescriptionRayFileNone0Generates no ray file.RayFileClassic1Generates a ray file without polarization data.RayFilePolarization2Generates a ray file with the polarization data for each ray.RayFileTM253Generates a .tm25ray file with polarization data for each ray.RayFileTM25NoPolarization4Generates a .tm25ray file without polarization data. ### Scene.SensorInstance.LayerTypeFace.EnumSCAFilteringType NameNumberDescriptionLastImpact0IntersectedOneTime1 ### Scene.SensorInstance.LayerTypeSequence.EnumSequenceType NameNumberDescriptionGeometries0Faces1 ### SceneActions Actions available on a Scene Method NameRequest TypeResponse TypeDescriptionLoadFile[LoadFile\_Request](#ansys-api-speos-scene-v1-LoadFile_Request)[LoadFile\_Response](#ansys-api-speos-scene-v1-LoadFile_Response)Load .speos fileSaveFile[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) streamGet RayPaths generated by a source ### ScenesManager Manager for Scenes Method NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-scene-v1-Create_Request)[Create\_Response](#ansys-api-speos-scene-v1-Create_Response)Create a SceneRead[Read\_Request](#ansys-api-speos-scene-v1-Read_Request)[Read\_Response](#ansys-api-speos-scene-v1-Read_Response)Read a SceneUpdate[Update\_Request](#ansys-api-speos-scene-v1-Update_Request)[Update\_Response](#ansys-api-speos-scene-v1-Update_Response)Update a SceneDelete[Delete\_Request](#ansys-api-speos-scene-v1-Delete_Request)[Delete\_Response](#ansys-api-speos-scene-v1-Delete_Response)Delete a SceneList[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 FieldTypeLabelDescriptionscene[Scene](#ansys-api-speos-scene-v2-Scene)guid[string](#string)optionalOptional 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the Scene created in ScenesManager ### Delete\_Request Request to delete a Scene in ScenesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the Scene to be deleted ### Delete\_Response ### GetSourceRayPaths\_Request FieldTypeLabelDescriptionguid[string](#string)Guid of a ScenesManager elementsource\_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 scenerays\_nb[uint32](#uint32)optionalNumber of rays sent by the source. Default 100raw\_data[bool](#bool)optionalBoolean to get the wavelengths in response streamdisplay\_data[bool](#bool)optionalBoolean to get the colors (RGB24 format) in response stream ### List\_Request ### List\_Response FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of the Scenes in ScenesManager ### LoadFile\_Request Request to LoadFile service FieldTypeLabelDescriptionguid[string](#string)Guid of a ScenesManager element to updatefile\_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 FieldTypeLabelDescriptionguid[string](#string)Guid of the Scene to be read ### Read\_Response FieldTypeLabelDescriptionscene[Scene](#ansys-api-speos-scene-v2-Scene)Scene corresponding to the guid given in Read\_Request ### SaveFile\_Request Request to SaveFile service. FieldTypeLabelDescriptionguid[string](#string)Guid of a ScenesManager element to savefile\_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 FieldTypeLabelDescriptionname[string](#string)description[string](#string)metadata[Scene.MetadataEntry](#ansys-api-speos-scene-v2-Scene-MetadataEntry)repeatedUser defined metadatapart\_guid[string](#string)Guid from PartsManager of the geometrical part included inside the scenesub\_scene\_anchor\_axis\_system[double](#double)repeatedOnly 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 orthonormalizedsources[Scene.SourceInstance](#ansys-api-speos-scene-v2-Scene-SourceInstance)repeatedThe sources added in the scenesensors[Scene.SensorInstance](#ansys-api-speos-scene-v2-Scene-SensorInstance)repeatedThe sensors added in the scenesimulations[Scene.SimulationInstance](#ansys-api-speos-scene-v2-Scene-SimulationInstance)repeatedThe simulations added in the scenematerials[Scene.MaterialInstance](#ansys-api-speos-scene-v2-Scene-MaterialInstance)repeatedThe materials (volume + surface) applied on geometriesscenes[Scene.SceneInstance](#ansys-api-speos-scene-v2-Scene-SceneInstance)repeatedSub scenesground[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 FieldTypeLabelDescriptiongeo\_path[string](#string)Geometry that will be used ("" for a whole body, or "/" for a specific face)reverse\_normal[bool](#bool)optionaloptional - 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". FieldTypeLabelDescriptiongeo\_paths[string](#string)repeatedlist of geo paths ### Scene.GroundPlane FieldTypeLabelDescriptionground\_origin[double](#double)repeated3D point in the geometry. HDR image is displayed on the ground planezenith\_direction[double](#double)repeatedline normal to the ground or Z directionground\_height[double](#double)height of the environment shooting (unit mm) ### Scene.MaterialInstance Instance of a material to apply on geometries of the scene FieldTypeLabelDescriptionname[string](#string)Unique identifier in the scenedisplay\_name[string](#string)User name to be displayeddescription[string](#string)metadata[Scene.MaterialInstance.MetadataEntry](#ansys-api-speos-scene-v2-Scene-MaterialInstance-MetadataEntry)repeatedUser defined metadatavop\_guid[string](#string)optionaloptional - Guid of the volume optical property to instantiatenon\_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 NonHomogeneoussop\_guids[string](#string)repeatedDeprecated - Better use sop oneof field (either sop\_guid or texture)sop\_guid[string](#string)Guid of the surface optical property to instantiatetexture[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 FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Scene.MaterialInstance.NonHomogeneousProperties FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 FieldTypeLabelDescriptionlayers[Scene.MaterialInstance.Texture.Layer](#ansys-api-speos-scene-v2-Scene-MaterialInstance-Texture-Layer)repeatedList of texture layers (also called multi texture in case of several layers) ### Scene.MaterialInstance.Texture.Layer FieldTypeLabelDescriptionsop\_guid[string](#string)Guid of the surface optical property to bind to geometryimage\_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 fieldnormal\_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 fieldanisotropy\_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 FieldTypeLabelDescriptionmapping\_operator[Scene.MaterialInstance.Texture.MappingOperator](#ansys-api-speos-scene-v2-Scene-MaterialInstance-Texture-MappingOperator)Mapping operator to create UV mapping in corresponding facevertices\_data\_index[uint32](#uint32)Index in face's vertices\_data where UV mapping is stored ### Scene.MaterialInstance.Texture.MappingOperator FieldTypeLabelDescriptionplanar[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)repeatedReference 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 dimensionv\_scale\_factor[double](#double)Scale factor on V dimensionu\_length[double](#double)Dimension on U direction (mm)v\_length[double](#double)optionalOptional - 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 FieldTypeLabelDescriptionbase\_perimeter[double](#double) ### Scene.MaterialInstance.Texture.MappingOperator.Planar ### Scene.MaterialInstance.Texture.MappingOperator.Spherical FieldTypeLabelDescriptionsphere\_perimeter[double](#double) ### Scene.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Scene.SceneInstance FieldTypeLabelDescriptionname[string](#string)Unique identifier in the scenedisplay\_name[string](#string)User name to be displayeddescription[string](#string)metadata[Scene.SceneInstance.MetadataEntry](#ansys-api-speos-scene-v2-Scene-SceneInstance-MetadataEntry)repeatedUser defined metadatascene\_guid[string](#string)Guid of the element to instantiateaxis\_system[double](#double)repeatedScene 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 orthonormalizedtrajectory\_file\_uri[string](#string)Trajectory file, used to define the positions and orientations of the Scene instance in time. ### Scene.SceneInstance.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Scene.SensorInstance Instance of a sensor to add in the scene FieldTypeLabelDescriptionname[string](#string)Unique identifier in the scenedisplay\_name[string](#string)User name to be displayeddescription[string](#string)metadata[Scene.SensorInstance.MetadataEntry](#ansys-api-speos-scene-v2-Scene-SensorInstance-MetadataEntry)repeatedUser defined metadatasensor\_guid[string](#string)Guid of the SensorTemplate in SensorTemplatesManager to instantiateresult\_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 CameraSensorTemplateirradiance\_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 IrradianceSensorTemplateradiance\_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::Radianceintensity\_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 IntensitySensorTemplatepolar\_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 PolarIntensitySensorTemplateirradiance\_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::Irradiance3Dobserver\_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::Observerimmersive\_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::Immersivelxp\_properties[Scene.SensorInstance.LXPProperties](#ansys-api-speos-scene-v2-Scene-SensorInstance-LXPProperties)To activate lxp feature, we must fill this field ### Scene.SensorInstance.CameraProperties FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 orthonormalizedtrajectory\_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 : Nonelayer\_type\_source[Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSource)Layer type : Source ### Scene.SensorInstance.ImmersiveProperties FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 orthonormalizedlayer\_type\_none[Scene.SensorInstance.LayerTypeNone](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeNone)Layer type: Nonelayer\_type\_source[Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSource)Layer type: Sourcelayer\_type\_face[Scene.SensorInstance.LayerTypeFace](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeFace)Layer type: Facelayer\_type\_sequence[Scene.SensorInstance.LayerTypeSequence](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSequence)Layer type: Sequence ### Scene.SensorInstance.Irradiance3DProperties FieldTypeLabelDescriptionray\_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 : Nonelayer\_type\_source[Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSource)Layer type : Sourcegeometries[Scene.GeoPaths](#ansys-api-speos-scene-v2-Scene-GeoPaths)Geometries that will use this sensor ### Scene.SensorInstance.IrradianceProperties FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 orthonormalizedray\_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 : Nonelayer\_type\_source[Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSource)Layer type : Sourcelayer\_type\_face[Scene.SensorInstance.LayerTypeFace](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeFace)Layer type : Facelayer\_type\_sequence[Scene.SensorInstance.LayerTypeSequence](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSequence)Layer type : Sequencelayer\_type\_polarization[Scene.SensorInstance.LayerTypePolarization](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypePolarization)Layer type : Polarizationlayer\_type\_incidence\_angle[Scene.SensorInstance.LayerTypeIncidenceAngle](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeIncidenceAngle)Layer type : Incidence angleintegration\_direction[double](#double)repeatedSensor 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 FieldTypeLabelDescriptionnb\_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. FieldTypeLabelDescriptionsca\_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)repeatedLayers that will be taken into account in the result. ### Scene.SensorInstance.LayerTypeFace.Layer FieldTypeLabelDescriptionname[string](#string)Name of the layergeometries[Scene.GeoPaths](#ansys-api-speos-scene-v2-Scene-GeoPaths)Surface selected. ### Scene.SensorInstance.LayerTypeIncidenceAngle Includes one layer per range of incident angles. FieldTypeLabelDescriptionsampling[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. FieldTypeLabelDescriptionmaximum\_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 FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Scene.SensorInstance.ObserverProperties FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 orthonormalizedobserver\_point[double](#double)repeatedPosition 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 : Nonelayer\_type\_source[Scene.SensorInstance.LayerTypeSource](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeSource)Layer type : Sourcelayer\_type\_face[Scene.SensorInstance.LayerTypeFace](#ansys-api-speos-scene-v2-Scene-SensorInstance-LayerTypeFace)Layer type : Facelayer\_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 FieldTypeLabelDescriptionname[string](#string)Unique identifier in the scenedisplay\_name[string](#string)User name to be displayeddescription[string](#string)metadata[Scene.SimulationInstance.MetadataEntry](#ansys-api-speos-scene-v2-Scene-SimulationInstance-MetadataEntry)repeatedUser defined metadatasimulation\_guid[string](#string)Guid of the element to instantiatesensor\_paths[string](#string)repeatedSensors 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)repeatedSources 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)repeatedSource 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 FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Scene.SimulationInstance.SourceGroup FieldTypeLabelDescriptionname[string](#string)Group name for the sourcesource\_paths[string](#string)repeatedSources 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 FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedAxis 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 FieldTypeLabelDescriptionname[string](#string)Unique identifier in the scenedisplay\_name[string](#string)User name to be displayeddescription[string](#string)metadata[Scene.SourceInstance.MetadataEntry](#ansys-api-speos-scene-v2-Scene-SourceInstance-MetadataEntry)repeatedUser defined metadatasource\_guid[string](#string)Guid of the SourceTemplate in SourceTemplatesManager to instantiateluminaire\_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 Luminairesurface\_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 Surfacerayfile\_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 RayFilethermic\_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 Sourcedisplay\_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 Displayambient\_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 FieldTypeLabelDescriptionzenith\_direction[double](#double)repeatedline normal to the ground or Z directionreverse\_zenith[bool](#bool)optional - if not set or false : normal is not reverseduniform\_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 FieldTypeLabelDescriptionnorth\_direction[double](#double)repeated(X Y Z) Direction to the Northreverse\_north[bool](#bool)optional - if not set or false : normal is not reversedsun\_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 FieldTypeLabelDescriptionnorth\_direction[double](#double)repeated(X Y Z) Direction to the Northreverse\_north[bool](#bool)optional - if not set or false : normal is not reversed ### Scene.SourceInstance.AmbientProperties.ManualSun FieldTypeLabelDescriptionsun\_direction[double](#double)repeated(X Y Z) direction to the sunreverse\_sun[bool](#bool)optional - if not set or false : normal is not reversed ### Scene.SourceInstance.AmbientProperties.NaturalLightProperties FieldTypeLabelDescriptionnorth\_direction[double](#double)repeated(X Y Z) Direction to the Northreverse\_north[bool](#bool)optional - if not set or false : normal is not reversedsun\_axis\_system[Scene.SourceInstance.AmbientProperties.SunAxisSystem](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-SunAxisSystem)Set the Sun direction ### Scene.SourceInstance.AmbientProperties.SunAxisSystem FieldTypeLabelDescriptionautomatic\_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 setmanual\_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 FieldTypeLabelDescriptiontime\_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 FieldTypeLabelDescriptionmanual\_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 FieldTypeLabelDescriptionnorth\_direction[double](#double)repeated(X Y Z) Direction to the Northreverse\_north[bool](#bool)optional - if not set or false : normal is not reversedsun\_axis\_system[Scene.SourceInstance.AmbientProperties.SunAxisSystem](#ansys-api-speos-scene-v2-Scene-SourceInstance-AmbientProperties-SunAxisSystem)Set the Sun direction ### Scene.SourceInstance.DisplayProperties FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 orthonormalizedintensity\_properties[Scene.SourceInstance.IntensityProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-IntensityProperties) ### Scene.SourceInstance.IntensityProperties FieldTypeLabelDescriptionlibrary\_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 Librarygaussian\_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 FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedoptional - 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 FieldTypeLabelDescriptionexit\_geometries[Scene.GeoPaths](#ansys-api-speos-scene-v2-Scene-GeoPaths)Exit Geometries that will use this surface sourceaxis\_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 orthonormalizednormal\_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 FieldTypeLabelDescriptionvalues[double](#double)repeatedorientation (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 FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Scene.SourceInstance.RayFileProperties FieldTypeLabelDescriptionaxis\_system[double](#double)repeatedPosition 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 FieldTypeLabelDescriptionexitance\_constant\_properties[Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-SurfaceProperties-ExitanceConstantProperties)To be filled if the Surface SourceTemplate has ExitanceConstantexitance\_variable\_properties[Scene.SourceInstance.SurfaceProperties.ExitanceVariableProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-SurfaceProperties-ExitanceVariableProperties)To be filled if the Surface SourceTemplate has ExitanceVariableintensity\_properties[Scene.SourceInstance.IntensityProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-IntensityProperties) ### Scene.SourceInstance.SurfaceProperties.ExitanceConstantProperties FieldTypeLabelDescriptiongeo\_paths[Scene.GeoPath](#ansys-api-speos-scene-v2-Scene-GeoPath)repeated ### Scene.SourceInstance.SurfaceProperties.ExitanceVariableProperties FieldTypeLabelDescriptionaxis\_plane[double](#double)repeatedPosition 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 FieldTypeLabelDescriptionemissive\_faces\_properties[Scene.SourceInstance.ThermicProperties.EmissiveFacesProperties](#ansys-api-speos-scene-v2-Scene-SourceInstance-ThermicProperties-EmissiveFacesProperties)source emits from facestemperature\_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 FieldTypeLabelDescriptiongeo\_paths[Scene.GeoPath](#ansys-api-speos-scene-v2-Scene-GeoPath)repeatedthe list of emitting faces of the source ### Scene.SourceInstance.ThermicProperties.TemperatureFieldProperties FieldTypeLabelDescriptionaxis\_plane[double](#double)repeatedPosition 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the Scene to be updatedscene[Scene](#ansys-api-speos-scene-v2-Scene)Scene that will be used for the update ### Update\_Response ### Scene.SensorInstance.EnumRayFileType Ray file types available NameNumberDescriptionRayFileNone0Generates no ray file.RayFileClassic1Generates a ray file without polarization data.RayFilePolarization2Generates a ray file with the polarization data for each ray.RayFileTM253Generates a .tm25ray file with polarization data for each ray.RayFileTM25NoPolarization4Generates a .tm25ray file without polarization data. ### Scene.SensorInstance.LayerTypeFace.EnumSCAFilteringType NameNumberDescriptionLastImpact0IntersectedOneTime1 ### Scene.SensorInstance.LayerTypeSequence.EnumSequenceType NameNumberDescriptionGeometries0Faces1 ### SceneActions Actions available on a Scene Method NameRequest TypeResponse TypeDescriptionLoadFile[LoadFile\_Request](#ansys-api-speos-scene-v2-LoadFile_Request)[LoadFile\_Response](#ansys-api-speos-scene-v2-LoadFile_Response)Load .speos, .SPEOSLightBox fileSaveFile[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) streamGet RayPaths generated by a source ### ScenesManager Manager for Scenes Method NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-scene-v2-Create_Request)[Create\_Response](#ansys-api-speos-scene-v2-Create_Response)Create a SceneRead[Read\_Request](#ansys-api-speos-scene-v2-Read_Request)[Read\_Response](#ansys-api-speos-scene-v2-Read_Response)Read a SceneUpdate[Update\_Request](#ansys-api-speos-scene-v2-Update_Request)[Update\_Response](#ansys-api-speos-scene-v2-Update_Response)Update a SceneDelete[Delete\_Request](#ansys-api-speos-scene-v2-Delete_Request)[Delete\_Response](#ansys-api-speos-scene-v2-Delete_Response)Delete a SceneList[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 FieldTypeLabelDescriptionsensor\_mode\_geometric[SensorCameraModeGeometric](#ansys-api-speos-sensor-v1-SensorCameraModeGeometric)Sensor mode : Geometricsensor\_mode\_photometric[SensorCameraModePhotometric](#ansys-api-speos-sensor-v1-SensorCameraModePhotometric)Sensor mode : Photometricfocal\_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\_uridistortion\_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. FieldTypeLabelDescriptionred\_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. FieldTypeLabelDescriptionred\_gain[double](#double)green\_gain[double](#double)blue\_gain[double](#double) ### SensorCameraColorModeColor Simulation results are available in color according to the White Balance mode. FieldTypeLabelDescriptionred\_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 : Nonebalance\_mode\_greyworld[SensorCameraBalanceModeGreyworld](#ansys-api-speos-sensor-v1-SensorCameraBalanceModeGreyworld)Balance mode : Greyworldbalance\_mode\_userwhite[SensorCameraBalanceModeUserwhite](#ansys-api-speos-sensor-v1-SensorCameraBalanceModeUserwhite)Balance mode : Userwhitebalance\_mode\_display[SensorCameraBalanceModeDisplay](#ansys-api-speos-sensor-v1-SensorCameraBalanceModeDisplay)Balance mode : Display ### SensorCameraColorModeMonochromatic Simulation results are available in grey scale. FieldTypeLabelDescriptionspectrum\_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 FieldTypeLabelDescriptionacquisition\_integration[double](#double)Acquisition integration in sacquisition\_lag\_time[double](#double)Acquisition lag time in stransmittance\_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 : Colorcolor\_mode\_monochromatic[SensorCameraColorModeMonochromatic](#ansys-api-speos-sensor-v1-SensorCameraColorModeMonochromatic)Color mode : Monochromaticwavelengths\_range[WavelengthsRange](#ansys-api-speos-sensor-v1-WavelengthsRange)Spectral range to use for simulation. ### EnumSensorCameraPNGBits NameNumberDescriptionPNG\_080PNG\_101PNG\_122PNG\_163 ## sensor/v1/common.proto (c) 2026 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited. ### AngularRange Angular range and sampling along two directions. FieldTypeLabelDescriptionx\_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 FieldTypeLabelDescriptiontheta\_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 FieldTypeLabelDescriptionx\_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. FieldTypeLabelDescriptionconoscopic\_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. FieldTypeLabelDescriptionintensity\_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. FieldTypeLabelDescriptionintensity\_dimensions[IntensityDimensions](#ansys-api-speos-sensor-v1-IntensityDimensions)Dimensions for non conoscopic sensor ### PolarIntensityDimensions Dimensions of the conoscopic intensity sensor FieldTypeLabelDescriptionhorizontal\_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 FieldTypeLabelDescriptionx\_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 FieldTypeLabelDescriptioncell\_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. FieldTypeLabelDescriptionwavelengths\_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. FieldTypeLabelDescriptionwavelengths\_range[WavelengthsRange](#ansys-api-speos-sensor-v1-WavelengthsRange)Spectral range to use for simulation. ### WavelengthsRange Spectral range to use for simulation. FieldTypeLabelDescriptionw\_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 FieldTypeLabelDescriptionsensor\_type\_photometric[SensorTypePhotometric](#ansys-api-speos-sensor-v1-SensorTypePhotometric)Sensor type : Photometricsensor\_type\_colorimetric[SensorTypeColorimetric](#ansys-api-speos-sensor-v1-SensorTypeColorimetric)Sensor type : Colorimetricsensor\_type\_radiometric[SensorTypeRadiometric](#ansys-api-speos-sensor-v1-SensorTypeRadiometric)Sensor type : Radiometricsensor\_type\_spectral[SensorTypeSpectral](#ansys-api-speos-sensor-v1-SensorTypeSpectral)Sensor type : Spectralilluminance\_type\_planar[IlluminanceTypePlanar](#ansys-api-speos-sensor-v1-IlluminanceTypePlanar)Illuminance type : Planarilluminance\_type\_radial[IlluminanceTypeRadial](#ansys-api-speos-sensor-v1-IlluminanceTypeRadial)Illuminance type : Radialilluminance\_type\_hemispherical[IlluminanceTypeHemispherical](#ansys-api-speos-sensor-v1-IlluminanceTypeHemispherical)Illuminance type : Hemisphericalilluminance\_type\_cylindrical[IlluminanceTypeCylindrical](#ansys-api-speos-sensor-v1-IlluminanceTypeCylindrical)Illuminance type : Cylindricalilluminance\_type\_semi\_cylindrical[IlluminanceTypeSemiCylindrical](#ansys-api-speos-sensor-v1-IlluminanceTypeSemiCylindrical)Illuminance type : SemiCylindricaldimensions[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 FieldTypeLabelDescriptionsensor\_template[SensorTemplate](#ansys-api-speos-sensor-v1-SensorTemplate)SensorTemplate containing its basic characteristicsguid[string](#string)optionalOptional 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the SensorTemplate created in SensorTemplatesManager ### Delete\_Request Request to delete a SensorTemplate in SensorTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the SensorTemplate to be deleted ### Delete\_Response ### List\_Request ### List\_Response FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of the SensorTemplates in SensorTemplatesManager ### Read\_Request Request to read a SensorTemplate in SensorTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the SensorTemplate to be read ### Read\_Response FieldTypeLabelDescriptionsensor\_template[SensorTemplate](#ansys-api-speos-sensor-v1-SensorTemplate)SensorTemplate corresponding to the guid given in Read\_Request ### SensorTemplate Sensor template with its basic characteristics FieldTypeLabelDescriptionname[string](#string)SensorTemplate namedescription[string](#string)SensorTemplate descriptionmetadata[SensorTemplate.MetadataEntry](#ansys-api-speos-sensor-v1-SensorTemplate-MetadataEntry)repeatedUser defined metadatacamera\_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 FieldTypeLabelDescriptionsampling[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 FieldTypeLabelDescriptionfront[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 FieldTypeLabelDescriptionsensor\_type\_photometric[SensorTypePhotometric](#ansys-api-speos-sensor-v1-SensorTypePhotometric)Sensor type: Photometricsensor\_type\_colorimetric[SensorTypeColorimetric](#ansys-api-speos-sensor-v1-SensorTypeColorimetric)Sensor type: Colorimetricsensor\_type\_radiometric[SensorTypeRadiometric](#ansys-api-speos-sensor-v1-SensorTypeRadiometric)Sensor type: Radiometricsensor\_type\_spectral[SensorTypeSpectral](#ansys-api-speos-sensor-v1-SensorTypeSpectral)Sensor type: Spectralintensity\_orientation\_x\_as\_meridian[IntensityOrientationXAsMeridian](#ansys-api-speos-sensor-v1-IntensityOrientationXAsMeridian)Orientation type: X As Meridian, Y as Parallelintensity\_orientation\_x\_as\_parallel[IntensityOrientationXAsParallel](#ansys-api-speos-sensor-v1-IntensityOrientationXAsParallel)Orientation type: X As Parallel, Y as Meridianintensity\_orientation\_conoscopic[IntensityOrientationConoscopic](#ansys-api-speos-sensor-v1-IntensityOrientationConoscopic)Orientation type: Conoscopicnear\_field[SensorNearField](#ansys-api-speos-sensor-v1-SensorNearField)Activates Near field. When not set, near field is disabled for the sensorfrom\_source\_looking\_at\_sensor[FromSourceLookingAtSensor](#ansys-api-speos-sensor-v1-FromSourceLookingAtSensor)Viewing direction from source looking at sensorfrom\_sensor\_looking\_at\_source[FromSensorLookingAtSource](#ansys-api-speos-sensor-v1-FromSensorLookingAtSource)Viewing direction from sensor looking at source ### SensorTemplate.Irradiance3D FieldTypeLabelDescriptiontype\_photometric[SensorTemplate.Irradiance3D.TypePhotometric](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-TypePhotometric)Sensor type : Photometrictype\_colorimetric[SensorTemplate.Irradiance3D.TypeColorimetric](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-TypeColorimetric)Sensor type : Colorimetrictype\_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. FieldTypeLabelDescriptionreflection[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). FieldTypeLabelDescriptionwavelength\_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. FieldTypeLabelDescriptionintegration\_type\_radial[SensorTemplate.Irradiance3D.IntegrationTypeRadial](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-IntegrationTypeRadial)Integration type : Radialintegration\_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. FieldTypeLabelDescriptionintegration\_type\_radial[SensorTemplate.Irradiance3D.IntegrationTypeRadial](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-IntegrationTypeRadial)Integration type : Radialintegration\_type\_planar[SensorTemplate.Irradiance3D.IntegrationTypePlanar](#ansys-api-speos-sensor-v1-SensorTemplate-Irradiance3D-IntegrationTypePlanar)Integration type : Planar ### SensorTemplate.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### SensorTemplate.Observer FieldTypeLabelDescriptionfocal[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 FieldTypeLabelDescriptioniesna\_a[PolarIntensityIesnaA](#ansys-api-speos-sensor-v1-PolarIntensityIesnaA)Sensor format: Iesna A typeiesna\_b[PolarIntensityIesnaB](#ansys-api-speos-sensor-v1-PolarIntensityIesnaB)Sensor format: Iesna B typeiesna\_c[PolarIntensityIesnaC](#ansys-api-speos-sensor-v1-PolarIntensityIesnaC)Sensor format: Iesna C typeeulumdat[PolarIntensityEulumdat](#ansys-api-speos-sensor-v1-PolarIntensityEulumdat)Sensor format: Eulumdatdimensions[PolarIntensityDimensions](#ansys-api-speos-sensor-v1-PolarIntensityDimensions)Horizontal and vertical samplings. Dimensions are fixed by the format or the adaptive sampling fileadaptive\_sampling\_uri[string](#string)Path to the adaptive sampling filefar\_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 FieldTypeLabelDescriptionintegration\_angle[double](#double)Integration angle (deg) ### SensorTemplate.Radiance FieldTypeLabelDescriptionsensor\_type\_photometric[SensorTypePhotometric](#ansys-api-speos-sensor-v1-SensorTypePhotometric)Sensor type : Photometricsensor\_type\_colorimetric[SensorTypeColorimetric](#ansys-api-speos-sensor-v1-SensorTypeColorimetric)Sensor type : Colorimetricsensor\_type\_radiometric[SensorTypeRadiometric](#ansys-api-speos-sensor-v1-SensorTypeRadiometric)Sensor type : Radiometricsensor\_type\_spectral[SensorTypeSpectral](#ansys-api-speos-sensor-v1-SensorTypeSpectral)Sensor type : Spectralfocal[double](#double)Observer type : focal (mm)integration\_angle[double](#double)Integration angle, in degreedimensions[SensorDimensions](#ansys-api-speos-sensor-v1-SensorDimensions)Dimensions of the sensor ### SensorTemplate.Stereo FieldTypeLabelDescriptioninterocular\_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 FieldTypeLabelDescriptionguid[string](#string)Guid of the SensorTemplate to be updatedsensor\_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 NameNumberDescriptionRadial0Integration type : RadialPlanar1Integration type : Planar ### SensorTemplatesManager Method NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-sensor-v1-Create_Request)[Create\_Response](#ansys-api-speos-sensor-v1-Create_Response)Create a SensorTemplateRead[Read\_Request](#ansys-api-speos-sensor-v1-Read_Request)[Read\_Response](#ansys-api-speos-sensor-v1-Read_Response)Read a SensorTemplateUpdate[Update\_Request](#ansys-api-speos-sensor-v1-Update_Request)[Update\_Response](#ansys-api-speos-sensor-v1-Update_Response)Update a SensorTemplateDelete[Delete\_Request](#ansys-api-speos-sensor-v1-Delete_Request)[Delete\_Response](#ansys-api-speos-sensor-v1-Delete_Response)Delete a SensorTemplateList[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 FieldTypeLabelDescriptionversion[string](#string)Version of the server. Format: "major.minor.patch.build". Example "2025.2.1.31394". ### ServerInfo Method NameRequest TypeResponse TypeDescriptionGetVersion[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 FieldTypeLabelDescriptionsimulation\_template[SimulationTemplate](#ansys-api-speos-simulation-v1-templates-SimulationTemplate)SimulationTemplate containing its basic characteristicsguid[string](#string)optionalOptional 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the SimulationTemplate created in SimulationTemplatesManager ### Delete\_Request Request to delete a SimulationTemplate in SimulationTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the SimulationTemplate to be deleted ### Delete\_Response ### DirectMCSimulationTemplate FieldTypeLabelDescriptiongeom\_distance\_tolerance[double](#double)Maximum distance in mm to consider two faces as tangentmax\_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 Standarddispersion[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 \*.materialtexture[Texture](#ansys-api-speos-simulation-v1-templates-Texture)To activate texture. ### InverseMCSimulationTemplate FieldTypeLabelDescriptiongeom\_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 Standarddispersion[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 \*.materialtexture[Texture](#ansys-api-speos-simulation-v1-templates-Texture)To activate texture. ### List\_Request ### List\_Response FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of the SimulationTemplates in SimulationTemplatesManager ### Read\_Request Request to read a SimulationTemplate in SimulationTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the SimulationTemplate to be read ### Read\_Response FieldTypeLabelDescriptionsimulation\_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 FieldTypeLabelDescriptionname[string](#string)Simulation namedescription[string](#string)Simulation descriptionmetadata[SimulationTemplate.MetadataEntry](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-MetadataEntry)repeatedUser defined metadatadirect\_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 FieldTypeLabelDescriptiongeom\_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 fillcolorimetric\_standard[EnumColorimetricStandard](#ansys-api-speos-simulation-v1-templates-EnumColorimetricStandard)Default Colorimetric Standardambient\_material\_uri[string](#string)To define the environment in which the light will propagate (water, fog, smoke etc.). It is expressed in a .material filetexture[Texture](#ansys-api-speos-simulation-v1-templates-Texture)To activate texture. ### SimulationTemplate.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### SimulationTemplate.VirtualBSDFBench Virtual BSDF Bench FieldTypeLabelDescriptiongeom\_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 Standardtexture[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 onlyall\_characteristics[SimulationTemplate.VirtualBSDFBench.AllCharacteristics](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-AllCharacteristics)BSDF depends on all propertieswavelengths\_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 FieldTypeLabelDescriptionis\_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 directionno\_iridescence[SimulationTemplate.VirtualBSDFBench.AllCharacteristics.NoIridescence](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-AllCharacteristics-NoIridescence)Color does not depend on viewing directionsensor\_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 FieldTypeLabelDescriptionuniform\_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 FieldTypeLabelDescriptionisotropic[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 FieldTypeLabelDescriptionuniform\_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 FieldTypeLabelDescriptionuniform\_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 FieldTypeLabelDescriptionuniform\_isotropic[SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformIsotropic](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-SourceSamplingUniformIsotropic)oneof with adaptiveadaptive[SimulationTemplate.VirtualBSDFBench.SourceSamplingAdaptive](#ansys-api-speos-simulation-v1-templates-SimulationTemplate-VirtualBSDFBench-SourceSamplingAdaptive) ### SimulationTemplate.VirtualBSDFBench.Sensor FieldTypeLabelDescriptionintegration\_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 FieldTypeLabelDescriptiontheta\_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 FieldTypeLabelDescriptionfile\_uri[string](#string)uri of incident sampling file ### SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformAnisotropic FieldTypeLabelDescriptiontheta\_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 FieldTypeLabelDescriptiontheta\_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. FieldTypeLabelDescriptiontexture\_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 FieldTypeLabelDescriptionguid[string](#string)Guid of the SimulationTemplate to be updatedsimulation\_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. FieldTypeLabelDescriptionminimum\_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 NameNumberDescriptionCIE\_193102 degrees CIE Standard Colorimetric Observer Data.CIE\_1964110 degrees CIE Standard Colorimetric Observer Data. ### SimulationTemplate.VirtualBSDFBench.SourceSamplingUniformAnisotropic.PhiSymmetry NameNumberDescriptionPHI\_SYMMETRY\_UNSPECIFIED0PHI\_SYMMETRY\_NONE1PHI\_SYMMETRY\_1\_PLANE2Symmetry to plane 0 - 180PHI\_SYMMETRY\_2\_PLANES3Symmetry to planes 0 - 180 and 90 - 270 ### Texture.TextureNormalization NameNumberDescriptionTEXTURE\_NORMALIZATION\_UNSPECIFIED0TEXTURE\_NORMALIZATION\_NONE1The simulation result uses both the image texture and the texture mapping optical properties.TEXTURE\_NORMALIZATION\_COLOR\_FROM\_TEXTURE2The simulation result uses the color and the color lightness of the image texture.TEXTURE\_NORMALIZATION\_COLOR\_FROM\_BSDF3The simulation result uses the BSDF information of the texture mapping optical properties. ### SimulationTemplatesManager Method NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-simulation-v1-templates-Create_Request)[Create\_Response](#ansys-api-speos-simulation-v1-templates-Create_Response)Create a SimulationTemplateRead[Read\_Request](#ansys-api-speos-simulation-v1-templates-Read_Request)[Read\_Response](#ansys-api-speos-simulation-v1-templates-Read_Response)Read a SimulationTemplateUpdate[Update\_Request](#ansys-api-speos-simulation-v1-templates-Update_Request)[Update\_Response](#ansys-api-speos-simulation-v1-templates-Update_Response)Update a SimulationTemplateDelete[Delete\_Request](#ansys-api-speos-simulation-v1-templates-Delete_Request)[Delete\_Response](#ansys-api-speos-simulation-v1-templates-Delete_Response)Delete a SimulationTemplateList[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 FieldTypeLabelDescriptionsop\_template[SOPTemplate](#ansys-api-speos-sop-v1-SOPTemplate)SOPTemplate containing its basic characteristicsguid[string](#string)optionalOptional 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the SOPTemplate created in SOPTemplatesManager ### Delete\_Request Request to delete a SOPTemplate in SOPTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the SOPTemplate to be deleted ### Delete\_Response ### List\_Request ### List\_Response FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of the SOPTemplates in SOPTemplatesManager ### Read\_Request Request to read a SOPTemplate in SOPTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the SOPTemplate to be read ### Read\_Response FieldTypeLabelDescriptionsop\_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. FieldTypeLabelDescriptionname[string](#string)SOPTemplate namedescription[string](#string)SOPTemplate descriptionmetadata[SOPTemplate.MetadataEntry](#ansys-api-speos-sop-v1-SOPTemplate-MetadataEntry)repeatedUser defined metadatamirror[SOPTemplate.Mirror](#ansys-api-speos-sop-v1-SOPTemplate-Mirror)Perfect specular surfaceoptical\_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 fileplugin[SOPTemplate.Plugin](#ansys-api-speos-sop-v1-SOPTemplate-Plugin)Custom made plug-intexture[SOPTemplate.Texture](#ansys-api-speos-sop-v1-SOPTemplate-Texture)Define to activate texture - optional ### SOPTemplate.Library FieldTypeLabelDescriptionsop\_file\_uri[string](#string)Surface optical properties file, \*.scattering, \*.bsdf, \*.brdf, \*.coated, ... ### SOPTemplate.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### SOPTemplate.Mirror Perfect specular surface FieldTypeLabelDescriptionreflectance[double](#double)Reflectance, expected from 0. to 100. in % ### SOPTemplate.OpticalPolished Transparent or perfectly polished material (glass, plastic) ### SOPTemplate.Plugin Custom made plug-in FieldTypeLabelDescriptionplugin\_sop\_file\_uri[string](#string).sop plug-inparameters\_file\_uri[string](#string)parameters file needed for the plug-in ### SOPTemplate.Texture Activate texture FieldTypeLabelDescriptionimage[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 FieldTypeLabelDescriptionbitmap\_file\_uri[string](#string)Bitmaprepeat\_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 FieldTypeLabelDescriptionfrom\_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 FieldTypeLabelDescriptionbitmap\_file\_uri[string](#string)Bitmap used to build normal map. ### SOPTemplate.Texture.NormalMap.FromNormalMap FieldTypeLabelDescriptionnormal\_map\_file\_uri[string](#string)Normal map file. ### Update\_Request Request to update a SOPTemplate in SOPTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the SOPTemplate to be updatedsop\_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 NameRequest TypeResponse TypeDescription ### SOPTemplatesManager Manager for SOPTemplates (SOP: Surface Optical Properties) Method NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-sop-v1-Create_Request)[Create\_Response](#ansys-api-speos-sop-v1-Create_Response)Create a SOPTemplateRead[Read\_Request](#ansys-api-speos-sop-v1-Read_Request)[Read\_Response](#ansys-api-speos-sop-v1-Read_Response)Read a SOPTemplateUpdate[Update\_Request](#ansys-api-speos-sop-v1-Update_Request)[Update\_Response](#ansys-api-speos-sop-v1-Update_Response)Update a SOPTemplateDelete[Delete\_Request](#ansys-api-speos-sop-v1-Delete_Request)[Delete\_Response](#ansys-api-speos-sop-v1-Delete_Response)Delete a SOPTemplateList[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 FieldTypeLabelDescriptionsource\_template[SourceTemplate](#ansys-api-speos-source-v1-SourceTemplate)SourceTemplate containing its basic characteristicsguid[string](#string)optionalOptional 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the SourceTemplate created in SourceTemplatesManager ### Delete\_Request Request to delete a SourceTemplate in SourceTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the SourceTemplate to be deleted ### Delete\_Response ### GetRayFileInfo\_Request Request of GetRayFileInfo FieldTypeLabelDescriptionguid[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 FieldTypeLabelDescriptionflux[common.v1.DataDoubles](#ansys-api-speos-common-v1-DataDoubles)Flux of the ray filehas\_spectral\_data[bool](#bool)The ray file contains Spectrum information ### List\_Request ### List\_Response FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of the SourceTemplates in SourceTemplatesManager ### Read\_Request Request to read a SourceTemplate in SourceTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the SourceTemplate to be read ### Read\_Response FieldTypeLabelDescriptionsource\_template[SourceTemplate](#ansys-api-speos-source-v1-SourceTemplate)SourceTemplate corresponding to the guid given in Read\_Request ### SourceTemplate Source template with its basic characteristics FieldTypeLabelDescriptionname[string](#string)SourceTemplate namedescription[string](#string)SourceTemplate descriptionmetadata[SourceTemplate.MetadataEntry](#ansys-api-speos-source-v1-SourceTemplate-MetadataEntry)repeatedUser defined metadataluminaire[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 FieldTypeLabelDescriptionuniform\_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 positioncie\_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 modelcie\_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 modelnatural\_light[SourceTemplate.Ambient.NaturalLight](#ansys-api-speos-source-v1-SourceTemplate-Ambient-NaturalLight)generates natural lighting based on a day time or night time modelus\_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 FieldTypeLabelDescriptionluminance[double](#double)Luminance in cd per squared metercie\_type[SourceTemplate.Ambient.CieGeneral.CieType](#ansys-api-speos-source-v1-SourceTemplate-Ambient-CieGeneral-CieType)sky model ### SourceTemplate.Ambient.CieOvercast FieldTypeLabelDescriptionluminance[double](#double)Luminance in cd per squared meterspectrum\_guid[string](#string)blackbody or library spectra only ### SourceTemplate.Ambient.EnvironmentMap FieldTypeLabelDescriptionluminance[double](#double)Luminance in cd per squared meterimage\_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 relativelypredefined\_color\_space[SourceTemplate.PredefinedColorSpace](#ansys-api-speos-source-v1-SourceTemplate-PredefinedColorSpace)pre-defined color spaceuser\_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 FieldTypeLabelDescriptionturbidity[double](#double)cloudiness of the environment. The lower the value the clearer the environment. Varies between 1.9 and 9.9with\_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 FieldTypeLabelDescriptionluminance[double](#double)Luminance in cd per squared metermirrored\_extent[bool](#bool)if true then the ambient light covers all space, if false only covers the upper half spacespectrum\_guid[string](#string)blackbody or library spectra only ### SourceTemplate.Ambient.UsStandard ### SourceTemplate.Display FieldTypeLabelDescriptionimage\_file\_uri[string](#string)png,jpeg,bmp,tiff or rgb format file urisource\_dimensions[SourceTemplate.SourceDimensions](#ansys-api-speos-source-v1-SourceTemplate-SourceDimensions)horizontal and vertical dimensions (mm)luminous\_flux[double](#double)luminace in cd/m2contrast\_ratio[int32](#int32)optionalContrast ratio, infitine if not definedintensity\_guid[string](#string)Intensity guid in intensity managerpre\_defined\_color\_space[SourceTemplate.PredefinedColorSpace](#ansys-api-speos-source-v1-SourceTemplate-PredefinedColorSpace)pre-defined color spaceuser\_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 FieldTypeLabelDescriptionflux\_from\_intensity\_file[SourceTemplate.FromIntensityFile](#ansys-api-speos-source-v1-SourceTemplate-FromIntensityFile)Take flux from intensity file providedluminous\_flux[SourceTemplate.Luminous](#ansys-api-speos-source-v1-SourceTemplate-Luminous)Luminous flux in lumens, value >=0radiant\_flux[SourceTemplate.Radiant](#ansys-api-speos-source-v1-SourceTemplate-Radiant)Radiant flux in watts, value >=0intensity\_file\_uri[string](#string)IES or EULUMDAT format file urispectrum\_guid[string](#string)Spectrum guid in spectrum manager ### SourceTemplate.Luminous FieldTypeLabelDescriptionluminous\_value[double](#double)Luminous flux in lumens ### SourceTemplate.LuminousIntensity FieldTypeLabelDescriptionluminous\_intensity\_value[double](#double)Luminous intensity in candelas ### SourceTemplate.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### SourceTemplate.PredefinedColorSpace FieldTypeLabelDescriptioncolor\_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 FieldTypeLabelDescriptionwhite\_point\_type[SourceTemplate.PredefinedWhitePoint.WhitePointType](#ansys-api-speos-source-v1-SourceTemplate-PredefinedWhitePoint-WhitePointType)pre-defined white point type ### SourceTemplate.Radiant FieldTypeLabelDescriptionradiant\_value[double](#double)Radiant flux in watts ### SourceTemplate.RayFile FieldTypeLabelDescriptionray\_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 providedluminous\_flux[SourceTemplate.Luminous](#ansys-api-speos-source-v1-SourceTemplate-Luminous)Luminous flux in lumens, value >=0radiant\_flux[SourceTemplate.Radiant](#ansys-api-speos-source-v1-SourceTemplate-Radiant)Radiant flux in watts, value >=0spectrum\_from\_ray\_file[SourceTemplate.RayFile.SpectrumFromRayFile](#ansys-api-speos-source-v1-SourceTemplate-RayFile-SpectrumFromRayFile)Take spectrum from ray file providedspectrum\_guid[string](#string)Spectrum guid in spectrum manager ### SourceTemplate.RayFile.SpectrumFromRayFile Spectrum messages ### SourceTemplate.SourceDimensions source dimensions FieldTypeLabelDescriptionx\_start[double](#double)(mm)x\_end[double](#double)(mm)y\_start[double](#double)(mm)y\_end[double](#double)(mm) ### SourceTemplate.Surface FieldTypeLabelDescriptionflux\_from\_intensity\_file[SourceTemplate.FromIntensityFile](#ansys-api-speos-source-v1-SourceTemplate-FromIntensityFile)Take flux from intensity file providedluminous\_flux[SourceTemplate.Luminous](#ansys-api-speos-source-v1-SourceTemplate-Luminous)Luminous flux in lumensradiant\_flux[SourceTemplate.Radiant](#ansys-api-speos-source-v1-SourceTemplate-Radiant)Radiant flux in wattsluminous\_intensity\_flux[SourceTemplate.LuminousIntensity](#ansys-api-speos-source-v1-SourceTemplate-LuminousIntensity)Luminous intensity in candelasintensity\_guid[string](#string)Intensity guid in intensity managerexitance\_constant[SourceTemplate.Surface.ExitanceConstant](#ansys-api-speos-source-v1-SourceTemplate-Surface-ExitanceConstant)Constantexitance\_variable[SourceTemplate.Surface.ExitanceVariable](#ansys-api-speos-source-v1-SourceTemplate-Surface-ExitanceVariable)Taken from XMP mapspectrum\_from\_xmp\_file[SourceTemplate.Surface.SpectrumFromXMPFile](#ansys-api-speos-source-v1-SourceTemplate-Surface-SpectrumFromXMPFile)Take spectrum from xmp file providedspectrum\_guid[string](#string)Spectrum guid in spectrum managertimeline[SourceTemplate.Surface.Timeline](#ansys-api-speos-source-v1-SourceTemplate-Surface-Timeline)Define timeline parameters ### SourceTemplate.Surface.ExitanceConstant ### SourceTemplate.Surface.ExitanceVariable Exitance messages FieldTypeLabelDescriptionexitance\_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 FieldTypeLabelDescriptionflux\_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 FieldTypeLabelDescriptionemissives\_faces[SourceTemplate.Thermic.EmissiveFaces](#ansys-api-speos-source-v1-SourceTemplate-Thermic-EmissiveFaces)black body with temperature on each facetemperature\_field[SourceTemplate.Thermic.TemperatureField](#ansys-api-speos-source-v1-SourceTemplate-Thermic-TemperatureField)file with meshed data and triangle temperatureintensity\_guid[string](#string)Intensity guid in intensity manager Lambertian or cos only ### SourceTemplate.Thermic.EmissiveFaces FieldTypeLabelDescriptiontemperature[double](#double)the temperature in Kelvin of the blackbody (Kirchhoff's law) for every face ### SourceTemplate.Thermic.TemperatureField FieldTypeLabelDescriptiontemperature\_field\_uri[string](#string)file with meshed data and temperature for each trianglesop\_guid[string](#string)SOP for geometry, must have absorption, required with temperature field ### SourceTemplate.UserDefinedRGBSpace FieldTypeLabelDescriptionpre\_defined\_white\_point[SourceTemplate.PredefinedWhitePoint](#ansys-api-speos-source-v1-SourceTemplate-PredefinedWhitePoint)pre-defined white pointuser\_defined\_white\_point[SourceTemplate.UserDefinedWhitePoint](#ansys-api-speos-source-v1-SourceTemplate-UserDefinedWhitePoint)custom Y and X white point coordinatesred\_spectrum\_guid[string](#string)red Spectrum guid in spectrum managergreen\_spectrum\_guid[string](#string)green Spectrum guid in spectrum managerblue\_spectrum\_guid[string](#string)blue Spectrum guid in spectrum manager ### SourceTemplate.UserDefinedWhitePoint FieldTypeLabelDescriptionwhite\_point[double](#double)repeatedX and Y coordinates of the white point. ### Update\_Request Request to update a SourceTemplate in SourceTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the SourceTemplate to be updatedsource\_template[SourceTemplate](#ansys-api-speos-source-v1-SourceTemplate)SourceTemplate that will be used for the update ### Update\_Response ### SourceTemplate.Ambient.CieGeneral.CieType NameNumberDescriptionstandard\_overcast0overcast\_steep\_gradation1overcast\_azimuthal\_uniformity2overcast\_slight\_brightening3uniform\_luminance4cloudy\_slight\_brightening5cloudy\_nogradation\_circumsolar6cloudy\_solar\_corona7cloudy\_obscured\_sun8cloudy\_circumsolar\_region9white\_blue\_distinct10standard\_low\_luminance11standard\_polluted\_atmosphere12cloudless\_turbid\_corona13white\_blue\_broad14 ### SourceTemplate.PredefinedColorSpace.ColorSpaceType NameNumberDescriptionsRGB0standard and most commonly used modelAdobeRGB1larger gamut ### SourceTemplate.PredefinedWhitePoint.WhitePointType NameNumberDescriptionC0average daylight illuminantD501natural horizon lightD652standard daylight illuminantE3illuminant that gives equal weight to all wavelengths ### SourceTemplateActions Actions available on a SourceTemplate Method NameRequest TypeResponse TypeDescriptionGetRayFileInfo[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 NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-source-v1-Create_Request)[Create\_Response](#ansys-api-speos-source-v1-Create_Response)Create a SourceTemplateRead[Read\_Request](#ansys-api-speos-source-v1-Read_Request)[Read\_Response](#ansys-api-speos-source-v1-Read_Response)Read a SourceTemplateUpdate[Update\_Request](#ansys-api-speos-source-v1-Update_Request)[Update\_Response](#ansys-api-speos-source-v1-Update_Response)Update a SourceTemplateDelete[Delete\_Request](#ansys-api-speos-source-v1-Delete_Request)[Delete\_Response](#ansys-api-speos-source-v1-Delete_Response)Delete a SourceTemplateList[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 FieldTypeLabelDescriptionspectrum[Spectrum](#ansys-api-speos-spectrum-v1-Spectrum)Spectrum containing its basic characteristicsguid[string](#string)optionalOptional 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the Spectrum created in SpectrumsManager ### Delete\_Request Request to delete a Spectrum in SpectrumsManager FieldTypeLabelDescriptionguid[string](#string)Guid of the Spectrum to be deleted ### Delete\_Response ### List\_Request ### List\_Response FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of the Spectrums in SpectrumsManager ### Read\_Request Request to read a Spectrum in SpectrumsManager FieldTypeLabelDescriptionguid[string](#string)Guid of the Spectrum to be read ### Read\_Response FieldTypeLabelDescriptionspectrum[Spectrum](#ansys-api-speos-spectrum-v1-Spectrum)Spectrum corresponding to the guid given in Read\_Request ### Spectrum Spectrum with its basic characteristics FieldTypeLabelDescriptionname[string](#string)Spectrum namedescription[string](#string)Spectrum descriptionmetadata[Spectrum.MetadataEntry](#ansys-api-speos-spectrum-v1-Spectrum-MetadataEntry)repeatedUser defined metadatamonochromatic[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 FieldTypeLabelDescriptiontemperature[double](#double)Temperature of the blackbody, in K ### Spectrum.DaylightFluorescent ### Spectrum.Halogen ### Spectrum.HighPressureSodium ### Spectrum.Incandescent ### Spectrum.Library FieldTypeLabelDescriptionfile\_uri[string](#string)uri of the spectrum file ### Spectrum.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### Spectrum.MetalHalide ### Spectrum.Monochromatic FieldTypeLabelDescriptionwavelength[double](#double)Wavelength of the monochromatic spectrum, in nm ### Spectrum.Predefined Predefined sampled spectrums FieldTypeLabelDescriptionincandescent[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 FieldTypeLabelDescriptionwavelengths[double](#double)repeatedList of wavelengths, in nmvalues[double](#double)repeatedList of values, expected from 0. to 100. in % ### Spectrum.WarmWhiteFluorescent ### Spectrum.WhiteLED ### Update\_Request Request to update a Spectrum in SpectrumsManager FieldTypeLabelDescriptionguid[string](#string)Guid of the Spectrum to be updatedspectrum[Spectrum](#ansys-api-speos-spectrum-v1-Spectrum)Spectrum that will be used for the update ### Update\_Response ### SpectrumsManager Method NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-spectrum-v1-Create_Request)[Create\_Response](#ansys-api-speos-spectrum-v1-Create_Response)Create a SpectrumRead[Read\_Request](#ansys-api-speos-spectrum-v1-Read_Request)[Read\_Response](#ansys-api-speos-spectrum-v1-Read_Response)Read a SpectrumUpdate[Update\_Request](#ansys-api-speos-spectrum-v1-Update_Request)[Update\_Response](#ansys-api-speos-spectrum-v1-Update_Response)Update a SpectrumDelete[Delete\_Request](#ansys-api-speos-spectrum-v1-Delete_Request)[Delete\_Response](#ansys-api-speos-spectrum-v1-Delete_Response)Delete a SpectrumList[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 FieldTypeLabelDescriptionvop\_template[VOPTemplate](#ansys-api-speos-vop-v1-VOPTemplate)VOPTemplate containing its basic characteristicsguid[string](#string)optionalOptional 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 FieldTypeLabelDescriptionguid[string](#string)Guid of the VOPTemplate created in VOPTemplatesManager ### Delete\_Request Request to delete a VOPTemplate in VOPTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the VOPTemplate to be deleted ### Delete\_Response ### List\_Request ### List\_Response FieldTypeLabelDescriptionguids[string](#string)repeatedGuids of the VOPTemplates in VOPTemplatesManager ### Read\_Request Request to read a VOPTemplate in VOPTemplatesManager FieldTypeLabelDescriptionguid[string](#string)Guid of the VOPTemplate to be read ### Read\_Response FieldTypeLabelDescriptionvop\_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 FieldTypeLabelDescriptionguid[string](#string)Guid of the VOPTemplate to be updatedvop\_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. FieldTypeLabelDescriptionname[string](#string)VOPTemplate namedescription[string](#string)VOPTemplate descriptionmetadata[VOPTemplate.MetadataEntry](#ansys-api-speos-vop-v1-VOPTemplate-MetadataEntry)repeatedUser defined metadatasopaque[VOPTemplate.Opaque](#ansys-api-speos-vop-v1-VOPTemplate-Opaque)Non-transparent materialoptic[VOPTemplate.Optic](#ansys-api-speos-vop-v1-VOPTemplate-Optic)Transparent colorless material without bulk scatteringlibrary[VOPTemplate.Library](#ansys-api-speos-vop-v1-VOPTemplate-Library)Based on \*.material filenon\_homogeneous[VOPTemplate.NonHomogeneous](#ansys-api-speos-vop-v1-VOPTemplate-NonHomogeneous)Material with non-homogeneous refractive index ### VOPTemplate.Library FieldTypeLabelDescriptionmaterial\_file\_uri[string](#string).material file ### VOPTemplate.MetadataEntry FieldTypeLabelDescriptionkey[string](#string)value[string](#string) ### VOPTemplate.NonHomogeneous Material with non-homogeneous refractive index FieldTypeLabelDescriptiongradedmaterial\_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 FieldTypeLabelDescriptionindex[double](#double)Refractive indexabsorption[double](#double)constringence[double](#double)optionalAbbe number ### VOPTemplateActions Actions available on a VOPTemplate Method NameRequest TypeResponse TypeDescription ### VOPTemplatesManager Manager for VOPTemplates (VOP: Volume Optical Properties) Method NameRequest TypeResponse TypeDescriptionCreate[Create\_Request](#ansys-api-speos-vop-v1-Create_Request)[Create\_Response](#ansys-api-speos-vop-v1-Create_Response)Create a VOPTemplateRead[Read\_Request](#ansys-api-speos-vop-v1-Read_Request)[Read\_Response](#ansys-api-speos-vop-v1-Read_Response)Read a VOPTemplateUpdate[Update\_Request](#ansys-api-speos-vop-v1-Update_Request)[Update\_Response](#ansys-api-speos-vop-v1-Update_Response)Update a VOPTemplateDelete[Delete\_Request](#ansys-api-speos-vop-v1-Delete_Request)[Delete\_Response](#ansys-api-speos-vop-v1-Delete_Response)Delete a VOPTemplateList[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 FieldTypeLabelDescriptionpixel\_x[uint32](#uint32)pixel\_y[uint32](#uint32) ### FileName FieldTypeLabelDescriptionfile\_name[string](#string).xmp ### Pixel FieldTypeLabelDescriptionnb\_pixel[uint32](#uint32) ### Value FieldTypeLabelDescriptionvalue[float](#float) ### XmpFileService\_Mono service to manage xmp file Method NameRequest TypeResponse TypeDescriptionCreateXMPFileInfo[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 fileGetValueRelativeStandardError[Coordinate2d](#ansys-api-speos-xmp-v1-Coordinate2d)[Value](#ansys-api-speos-xmp-v1-Value)Get Value Relative Standard Error fileGetNbPixelXRelativeStandardError[.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 fileGetNbPixelYRelativeStandardError[.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 fileExportXmpFileRelativeStandardError[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 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)