## On this page

  

 

 # SourceLightFieldBuilder Class Reference

 Last update: 16.07.2025 

Represents a light field source builder. [More...](#details)

Inheritance diagram for SourceLightFieldBuilder:

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



## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

str [AxisSystem](#af0a012d49a5b59a4f43bb342b8c725c2) = property(fget=\_\_GetAxisSystem) Gets the Axis System of the source.   
 str [CustomAxisSystem](#ad4a0da998b5304280cb2770f84243b6d) = property(fget=\_\_GetCustomAxisSystem, fset=\_\_SetCustomAxisSystem) Gets or sets the custom axis system property.   
 str [LightFieldFilePath](#a230135e54bc72f58d0d2ade5d51dd38e) = property(fget=\_\_GetLightFieldFilePath, fset=\_\_SetLightFieldFilePath) Gets or sets the light field file path.   
 str [NumberOfRays](#aaa149f4084199f582574fb95a19750ec) = property(fget=\_\_GetNumberOfRays, fset=\_\_SetNumberOfRays) Gets or sets the number of rays.   
 str [PreviewMode](#af000d33c17bc2049aded27ce88b25ec9) = property(fget=\_\_GetPreviewMode, fset=\_\_SetPreviewMode) Gets or sets the preview mode.   
 str [RayLength](#a24786b401f788b91236f7c5238005822) = property(fget=\_\_GetRayLength, fset=\_\_SetRayLength) Gets or sets the ray length.   
 str [SpectrumFilePath](#a92b012ddaebe46fb4504668c118ac6ab) = property(fget=\_\_GetSpectrumFilePath, fset=\_\_SetSpectrumFilePath) Gets or sets the spectrum file path.   
 ![-](/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="inherited" name="inherited"></a>Additional Inherited Members

![-](/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="details" name="details"></a>## Detailed Description

Represents a light field source builder.

The light field source builder creates or edits light field source features.

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



## Member Data Documentation

<a id="af0a012d49a5b59a4f43bb342b8c725c2" name="af0a012d49a5b59a4f43bb342b8c725c2"></a>## [◆ ](#af0a012d49a5b59a4f43bb342b8c725c2)AxisSystem

 str [AxisSystem](class_speos_n_x__2412_1_1_axis_system.xhtml) = property(fget=\_\_GetAxisSystem)  static 

Gets the Axis System of the source.

**Prerequisite**: The CustomAxisSystem property must be True.

**Value type**: AxisSystem object.





<a id="ad4a0da998b5304280cb2770f84243b6d" name="ad4a0da998b5304280cb2770f84243b6d"></a>## [◆ ](#ad4a0da998b5304280cb2770f84243b6d)CustomAxisSystem

 str CustomAxisSystem = property(fget=\_\_GetCustomAxisSystem, fset=\_\_SetCustomAxisSystem)  static 

Gets or sets the custom axis system property.

True: Enables custom axis system.  
 False: Disables custom axis system.

**Value type**: Boolean.

The default value is False.





<a id="a230135e54bc72f58d0d2ade5d51dd38e" name="a230135e54bc72f58d0d2ade5d51dd38e"></a>## [◆ ](#a230135e54bc72f58d0d2ade5d51dd38e)LightFieldFilePath

 str LightFieldFilePath = property(fget=\_\_GetLightFieldFilePath, fset=\_\_SetLightFieldFilePath)  static 

Gets or sets the light field file path.

**Value type**: String.

The default value is an empty string.





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

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

Gets or sets the number of rays.

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

The default value is 100.





<a id="af000d33c17bc2049aded27ce88b25ec9" name="af000d33c17bc2049aded27ce88b25ec9"></a>## [◆ ](#af000d33c17bc2049aded27ce88b25ec9)PreviewMode

 str PreviewMode = property(fget=\_\_GetPreviewMode, fset=\_\_SetPreviewMode)  static 

Gets or sets the preview mode.

The values are:  
 0 - Meshing.  
 1 - BoundingBox.

**Value type**: Integer.

The default value is 0.





<a id="a24786b401f788b91236f7c5238005822" name="a24786b401f788b91236f7c5238005822"></a>## [◆ ](#a24786b401f788b91236f7c5238005822)RayLength

 str RayLength = property(fget=\_\_GetRayLength, fset=\_\_SetRayLength)  static 

Gets or sets the ray length.

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

The default value is 75.0 mm.





<a id="a92b012ddaebe46fb4504668c118ac6ab" name="a92b012ddaebe46fb4504668c118ac6ab"></a>## [◆ ](#a92b012ddaebe46fb4504668c118ac6ab)SpectrumFilePath

 str SpectrumFilePath = property(fget=\_\_GetSpectrumFilePath, fset=\_\_SetSpectrumFilePath)  static 

Gets or sets the spectrum file path.

**Prerequisite**: The Light Field file must contain radiometric or photometric data.

**Value type**: String.

The default value is an empty string.





---

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