## On this page

  

 

 # ResultLXPBuilder Class Reference

 Last update: 16.07.2025 

Represents a Result Light Expert builder. [More...](#details)

Inheritance diagram for ResultLXPBuilder:

 ![](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/class_speos_n_x__2412_1_1_result_l_x_p_builder.png)



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 'None' [CreateAreaRectangle](#a93d372b89be2b49b441fe2bd7d3038e1) (self, sensorIndex, xCenter, yCenter, width, height) Create a rectangle area.   
  'None' [CreateAreaEllipse](#a0d05427c0224b15030ab59bf1d4b6557) (self, sensorIndex, xCenter, yCenter, xRadius, yRadius) Create an ellipse area.   
  'None' [CreateAreaPolygon](#aae698d0462cfeaf3930e7b7c97fee602) (self, sensorIndex, xPts, yPts) Create an polygon area.   
  'float' [RetrieveMeasureValue](#a4a67938bf70b21e0e258b9e63391a252) (self, sensorIndex, measureType) Retrieve measure value.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) 'None' **ShowResult** (self) Updates the feature to reflect the result of an edit to the feature for all builders that support showing results.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) 'None' [Commit](class_speos_n_x__2412_1_1_builder.xhtml#a77581800008ea3179049e650e9d1787b) (self) Commits any edits that have been applied to the builder.   
 ## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

str [DrawingOptions](#a42e1880e6ea28298ec370b6c973b4280) = property(fget=\_\_GetDrawingOptions, fset=\_\_SetDrawingOptions) Gets or sets the drawing options.   
 str [InfiniteRayLength](#ad3b6d69f626ea6d9ac56466adf7f284e) = property(fget=\_\_GetInfiniteRayLength, fset=\_\_SetInfiniteRayLength) Gets or sets the infinite ray length.   
 str [NumberOfRays](#aaa149f4084199f582574fb95a19750ec) = property(fget=\_\_GetNumberOfRays, fset=\_\_SetNumberOfRays) Gets or sets the number of rays.   
 str [RejectedFaces](#a7d9bf3e59cf60f46c675f12cb4bdc52f) = property(fget=\_\_GetRejectedFaces, fset=\_\_SetRejectedFaces) Gets or sets rejected faces tag.   
 str [RequiredFaces](#abe597453e16a1964bb755dbb2070f1b3) = property(fget=\_\_GetRequiredFaces, fset=\_\_SetRequiredFaces) Gets or sets requiered faces tag.   
 str [RequiredFacesMode](#a11e831356ccb19f8e6329f7696104615) = property(fget=\_\_GetRequiredFacesMode, fset=\_\_SetRequiredFacesMode) Gets or sets the required faces mode.   
 str [SelectedRaysMode](#a50b86134ba7c7cca34c92387475f6d74) = property(fget=\_\_GetSelectedRaysMode, fset=\_\_SetSelectedRaysMode) Gets or sets the selected rays mode.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Static Public Attributes inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml)str [Feature](class_speos_n_x__2412_1_1_feature_builder.xhtml#af5dac7005c95ef44c2b66d7270709d0b) = property(fget=\_\_GetFeature) Returns the feature being edited, or the created feature if the builder is being used in creation mode.   
 str [FullName](class_speos_n_x__2412_1_1_feature_builder.xhtml#a6aac8aea55e1f962045d07a12b6569ea) = property(fget=\_\_GetFullName) Gets the full name of the feature being edited.   
 str [Name](class_speos_n_x__2412_1_1_feature_builder.xhtml#a19218d0239b929ca8aecfa629d0185d0) = property(fget=\_\_GetName, fset=\_\_SetName) Gets or sets the name of the feature being edited.   
 str [NameWithContext](class_speos_n_x__2412_1_1_feature_builder.xhtml#a89ee075a30b71ff6e3192d6bd6dd5515) = property(fget=\_\_GetNameWithContext) Gets the name with context of the feature being edited.   
 str [Status](class_speos_n_x__2412_1_1_feature_builder.xhtml#abfd5ba295bea008a0edf2f1a85bc6368) = property(fget=\_\_GetStatus) Returns the status of the feature being edited.   
 ## <a id="properties" name="properties"></a>Properties

<a id="a50e9fbdd6a13e9e50cfba34656086bb6" name="a50e9fbdd6a13e9e50cfba34656086bb6"></a> **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [FeatureBuilder](class_speos_n_x__2412_1_1_feature_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [Builder](class_speos_n_x__2412_1_1_builder.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') <a id="details" name="details"></a>## Detailed Description

Represents a Result Light Expert builder.

The ResultLXPBuilder is used to create and edit Result Light Expert features.

To create a new instance of this class, use <a class="el" href="">FeatureCollection::CreateResultLXPBuilder</a>



## Member Function Documentation

<a id="a0d05427c0224b15030ab59bf1d4b6557" name="a0d05427c0224b15030ab59bf1d4b6557"></a>## [◆ ](#a0d05427c0224b15030ab59bf1d4b6557)CreateAreaEllipse()

  'None' CreateAreaEllipse  (  *self*,     *sensorIndex*,     *xCenter*,     *yCenter*,     *xRadius*,     *yRadius* )

Create an ellipse area.

Parameters \[in\]viewerIdindex of XMP in the sensor group (must be 0 for non group sensor) : Unsigned integer.  
\[in\]xCenterCenter position X of the ellipse area : double.  
\[in\]yCenterCenter position Y of the ellipse area : double.  
\[in\]xRadiusRadius X of the ellipse area : double.  
\[in\]yRadiusRadius Y of the ellipse area : double.  
The default value is no reactangle area.





<a id="aae698d0462cfeaf3930e7b7c97fee602" name="aae698d0462cfeaf3930e7b7c97fee602"></a>## [◆ ](#aae698d0462cfeaf3930e7b7c97fee602)CreateAreaPolygon()

  'None' CreateAreaPolygon  (  *self*,     *sensorIndex*,     *xPts*,     *yPts* )

Create an polygon area.

Parameters \[in\]viewerIdindex of XMP in the sensor group (must be 0 for non group sensor) : Unsigned integer.  
\[in\]xPtsList of X position of the polygon area : List of double.  
\[in\]yPtsList of X position of the polygon area : List of double.  
The default value is no reactangle area.





<a id="a93d372b89be2b49b441fe2bd7d3038e1" name="a93d372b89be2b49b441fe2bd7d3038e1"></a>## [◆ ](#a93d372b89be2b49b441fe2bd7d3038e1)CreateAreaRectangle()

  'None' CreateAreaRectangle  (  *self*,     *sensorIndex*,     *xCenter*,     *yCenter*,     *width*,     *height* )

Create a rectangle area.

Parameters \[in\]viewerIdindex of XMP in the sensor group (must be 0 for non group sensor) : Unsigned integer.  
\[in\]xCenterCenter position X of the rectangle area : double.  
\[in\]yCenterCenter position Y of the rectangle area : double.  
\[in\]widthWidth of the rectangle area : double.  
\[in\]heightHeight of the rectangle area : double.  
The default value is no reactangle area.





<a id="a4a67938bf70b21e0e258b9e63391a252" name="a4a67938bf70b21e0e258b9e63391a252"></a>## [◆ ](#a4a67938bf70b21e0e258b9e63391a252)RetrieveMeasureValue()

  'float' RetrieveMeasureValue  (  *self*,     *sensorIndex*,     *measureType* )

Retrieve measure value.

RetrieveMeasureValue return measure value by Type.

Parameters \[in\]viewerIdindex of XMP in the sensor group (must be 0 for non group sensor) : Unsigned integer.  
\[in\]measureTypethe type of value to retrieve : Unsigned integer.  
 The values are:  
 1 - Maximum  
 2 - Maximum position X  
 3 - Maximum position Y  
 4 - Minimum  
 5 - Minimum position X  
 6 - Minimum position Y  
 7 - Average  
 8 - Flux  
 9 - Barycentre position X  
 10 - Barycentre position Y  
 11 - Sigma  
 12 - Sigma position X  
 13 - Sigma position Y  
 14 - Contrast  
 15 - RMS Contrast  
 16 - Eye Irradiance  
 17 - Range  
 19 - Range position X  
 2O - Range position Y  
 21 - Area  
 22 - UGR117  
 28 - Deviation Min  
 29 - Deviation Max  
 30 - Deviation Average  
Returnsthe result measure. 



## Member Data Documentation

<a id="a42e1880e6ea28298ec370b6c973b4280" name="a42e1880e6ea28298ec370b6c973b4280"></a>## [◆ ](#a42e1880e6ea28298ec370b6c973b4280)DrawingOptions

 str DrawingOptions = property(fget=\_\_GetDrawingOptions, fset=\_\_SetDrawingOptions)  static 

Gets or sets the drawing options.

The values are:  
 1 - Rays.  
 2 - Impact.   
 3 - Rays and Impacts.

**Value type**: Integer.

The default value is 0.





<a id="ad3b6d69f626ea6d9ac56466adf7f284e" name="ad3b6d69f626ea6d9ac56466adf7f284e"></a>## [◆ ](#ad3b6d69f626ea6d9ac56466adf7f284e)InfiniteRayLength

 str InfiniteRayLength = property(fget=\_\_GetInfiniteRayLength, fset=\_\_SetInfiniteRayLength)  static 

Gets or sets the infinite ray length.

Length used to draw infinite rays.

**Value type**: Double (in mm).  
**Range**: The value must be superior or equal to 0.0.

The default value is calculated based on the system bounding box.





<a id="aaa149f4084199f582574fb95a19750ec" name="aaa149f4084199f582574fb95a19750ec"></a>## [◆ ](#aaa149f4084199f582574fb95a19750ec)NumberOfRays

 str NumberOfRays = property(fget=\_\_GetNumberOfRays, fset=\_\_SetNumberOfRays)  static 

Gets or sets the number of rays.

Number of rays calculate.

**Value type**: Integer.  
**Range**: The value must be superior to 0.

The default value is 200.





<a id="a7d9bf3e59cf60f46c675f12cb4bdc52f" name="a7d9bf3e59cf60f46c675f12cb4bdc52f"></a>## [◆ ](#a7d9bf3e59cf60f46c675f12cb4bdc52f)RejectedFaces

 str RejectedFaces = property(fget=\_\_GetRejectedFaces, fset=\_\_SetRejectedFaces)  static 

Gets or sets rejected faces tag.

The RejectedFaces property returns a list of feature tag.

ReturnsList of integer. 



<a id="abe597453e16a1964bb755dbb2070f1b3" name="abe597453e16a1964bb755dbb2070f1b3"></a>## [◆ ](#abe597453e16a1964bb755dbb2070f1b3)RequiredFaces

 str RequiredFaces = property(fget=\_\_GetRequiredFaces, fset=\_\_SetRequiredFaces)  static 

Gets or sets requiered faces tag.

The RequiredFaces property returns a list of feature tag.

ReturnsList of integer. 



<a id="a11e831356ccb19f8e6329f7696104615" name="a11e831356ccb19f8e6329f7696104615"></a>## [◆ ](#a11e831356ccb19f8e6329f7696104615)RequiredFacesMode

 str RequiredFacesMode = property(fget=\_\_GetRequiredFacesMode, fset=\_\_SetRequiredFacesMode)  static 

Gets or sets the required faces mode.

The values are:  
 0 - AND.  
 1 - OR.

**Value type**: Integer.

The default value is 0.





<a id="a50b86134ba7c7cca34c92387475f6d74" name="a50b86134ba7c7cca34c92387475f6d74"></a>## [◆ ](#a50b86134ba7c7cca34c92387475f6d74)SelectedRaysMode

 str SelectedRaysMode = property(fget=\_\_GetSelectedRaysMode, fset=\_\_SetSelectedRaysMode)  static 

Gets or sets the selected rays mode.

The values are:  
 0 - IN.  
 1 - OUT.

**Value type**: Integer.

The default value is 0.





---

The documentation for this class was generated from the following file:- **SpeosNX\_2412.py**