## On this page

  

 

 # ComponentPolarizationPlateBuilder Class Reference

 Last update: 16.07.2025 

Represents a Polarization Plate Component Builder. [More...](#details)

Inheritance diagram for ComponentPolarizationPlateBuilder:

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



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

str [Angle](#af01763c3636aab4e703c277727a878eb) = property(fget=\_\_GetAngle, fset=\_\_SetAngle) Gets or sets the angle value.   
 str [AxisSystem](#af0a012d49a5b59a4f43bb342b8c725c2) = property(fget=\_\_GetAxisSystem) Gets the Axis System of the Component.   
 str [DiattenuationType](#a66968b11860afd5ccb6f420b63c73747) = property(fget=\_\_GetDiattenuationType, fset=\_\_SetDiattenuationType) Gets or sets the Diattenuation type of the component.   
 str [MaterialFilePath](#a99df23442f7a5156601f75bb1d60e7e1) = property(fget=\_\_GetMaterialFilePath, fset=\_\_SetMaterialFilePath) Gets or sets the material file path.   
 str [OptimalWavelength](#a572cedfceec60c5294c31e75738adec2) = property(fget=\_\_GetOptimalWavelength, fset=\_\_SetOptimalWavelength) Gets or sets the optimal wavelength value.   
 str [PolarizationType](#a737f20517e1c27c77f7d7a71861bc257) = property(fget=\_\_GetPolarizationType, fset=\_\_SetPolarizationType) Gets or sets the polarization type of the component.   
 str [PolarizerFilePath](#a94cc073f855752b58c1dec978e2f6eba) = property(fget=\_\_GetPolarizerFilePath, fset=\_\_SetPolarizerFilePath) Gets or sets the polarizer file path.   
 str [RetardanceDivisor](#ae3e202f4269969a41d88efcbc1e3c376) = property(fget=\_\_GetRetardanceDivisor, fset=\_\_SetRetardanceDivisor) Gets or sets the retardance deivisor value.   
 str [RetardanceMultiplicator](#ae221979bcc582c9d98550ad74835b59b) = property(fget=\_\_GetRetardanceMultiplicator, fset=\_\_SetRetardanceMultiplicator) Gets or sets the retardance multiplicator value.   
 str [Thickness](#a38dae86732c3090250bf508669835c81) = property(fget=\_\_GetThickness) Gets the Thickness value.   
 str [WavelengthIncidenceDependency](#aa453c0087c7da85c1dc87d12f3493e76) = property(fget=\_\_GetWavelengthIncidenceDependency, fset=\_\_SetWavelengthIncidenceDependency) Gets or sets the wavelength and incidence dependency value.   
 str [XEnd](#a26309a89380b2756527ec19cffef2b6c) = property(fget=\_\_GetXEnd, fset=\_\_SetXEnd) Gets or sets the component X end dimension value.   
 str [XMirroredExtent](#ae7c2faf5c62ec2baf03149375fadd672) = property(fget=\_\_GetXMirroredExtent, fset=\_\_SetXMirroredExtent) Gets or sets the component X dimension mirrored extent value.   
 str [XStart](#abcbac58872bdd9d694ee7177d1ef7973) = property(fget=\_\_GetXStart, fset=\_\_SetXStart) Gets or sets the component X start dimension value.   
 str [YEnd](#a3106ba653a070cd30ef2357bddd2cf60) = property(fget=\_\_GetYEnd, fset=\_\_SetYEnd) Gets or sets the component Y end dimension value.   
 str [YMirroredExtent](#a1a4644fb780cae70d397e455eac08e13) = property(fget=\_\_GetYMirroredExtent, fset=\_\_SetYMirroredExtent) Gets or sets the component Y dimension mirrored extent value.   
 str [YStart](#accbaddec059ec07b1ca7f3a94b4574d2) = property(fget=\_\_GetYStart, fset=\_\_SetYStart) Gets or sets the component Y start dimension value.   
 ![-](/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 Polarization Plate Component Builder.

The Polarization Plate Component Builder creates or edits Polarization Plate Component features.

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

Polarization plate is used to define polarization components like polarizers, wave plates, or any component whose Jones matrix is known.



## Member Data Documentation

<a id="af01763c3636aab4e703c277727a878eb" name="af01763c3636aab4e703c277727a878eb"></a>## [◆ ](#af01763c3636aab4e703c277727a878eb)Angle

 str Angle = property(fget=\_\_GetAngle, fset=\_\_SetAngle)  static 

Gets or sets the angle value.

**Prerequisite**: The PolarizationType property must be 0, 1, 4 or 5 ; or the DiattenuationType property must be 1 or 2.

**Value type**: Double (in degrees).

The default value is 0.0.





<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 Component.

**Value type**: AxisSystem object.





<a id="a66968b11860afd5ccb6f420b63c73747" name="a66968b11860afd5ccb6f420b63c73747"></a>## [◆ ](#a66968b11860afd5ccb6f420b63c73747)DiattenuationType

 str DiattenuationType = property(fget=\_\_GetDiattenuationType, fset=\_\_SetDiattenuationType)  static 

Gets or sets the Diattenuation type of the component.

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

The values are:  
 0 - None.  
 1 - Library.  
 2 - Linear Polarizer.  
 3 - Left Circular Polarizer.  
 4 - Right Circular Polarizer.

**Value type**: Integer.

The default value is 2.





<a id="a99df23442f7a5156601f75bb1d60e7e1" name="a99df23442f7a5156601f75bb1d60e7e1"></a>## [◆ ](#a99df23442f7a5156601f75bb1d60e7e1)MaterialFilePath

 str MaterialFilePath = property(fget=\_\_GetMaterialFilePath, fset=\_\_SetMaterialFilePath)  static 

Gets or sets the material file path.

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

**value type**: String.

The default value is an empty string.





<a id="a572cedfceec60c5294c31e75738adec2" name="a572cedfceec60c5294c31e75738adec2"></a>## [◆ ](#a572cedfceec60c5294c31e75738adec2)OptimalWavelength

 str OptimalWavelength = property(fget=\_\_GetOptimalWavelength, fset=\_\_SetOptimalWavelength)  static 

Gets or sets the optimal wavelength value.

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

**Value type**: Double (in nm).

The default value is 500.0 nm.





<a id="a737f20517e1c27c77f7d7a71861bc257" name="a737f20517e1c27c77f7d7a71861bc257"></a>## [◆ ](#a737f20517e1c27c77f7d7a71861bc257)PolarizationType

 str PolarizationType = property(fget=\_\_GetPolarizationType, fset=\_\_SetPolarizationType)  static 

Gets or sets the polarization type of the component.

**Prerequisite**: The WavelengthIncidenceDependency property must be False.

The values are:  
 0 - Library.  
 1 - Linear Polarizer.  
 2 - Left Circular Polarizer.  
 3 - Right Circular Polarizer.  
 4 - Half Wave Plate.  
 5 - Quarter Wave Plate.

**Value type**: Integer.

The default value is 1.





<a id="a94cc073f855752b58c1dec978e2f6eba" name="a94cc073f855752b58c1dec978e2f6eba"></a>## [◆ ](#a94cc073f855752b58c1dec978e2f6eba)PolarizerFilePath

 str PolarizerFilePath = property(fget=\_\_GetPolarizerFilePath, fset=\_\_SetPolarizerFilePath)  static 

Gets or sets the polarizer file path.

**Prerequisite**: The PolarizationType property must be 0 or the DiattenuationType property must be 1.

**value type**: String.

The default value is an empty string.





<a id="ae3e202f4269969a41d88efcbc1e3c376" name="ae3e202f4269969a41d88efcbc1e3c376"></a>## [◆ ](#ae3e202f4269969a41d88efcbc1e3c376)RetardanceDivisor

 str RetardanceDivisor = property(fget=\_\_GetRetardanceDivisor, fset=\_\_SetRetardanceDivisor)  static 

Gets or sets the retardance deivisor value.

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

**Value type**: Double.

The default value is 2.0.





<a id="ae221979bcc582c9d98550ad74835b59b" name="ae221979bcc582c9d98550ad74835b59b"></a>## [◆ ](#ae221979bcc582c9d98550ad74835b59b)RetardanceMultiplicator

 str RetardanceMultiplicator = property(fget=\_\_GetRetardanceMultiplicator, fset=\_\_SetRetardanceMultiplicator)  static 

Gets or sets the retardance multiplicator value.

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

**Value type**: Integer.

The default value is 100.





<a id="a38dae86732c3090250bf508669835c81" name="a38dae86732c3090250bf508669835c81"></a>## [◆ ](#a38dae86732c3090250bf508669835c81)Thickness

 str Thickness = property(fget=\_\_GetThickness)  static 

Gets the Thickness value.

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

**Value type**: Double.





<a id="aa453c0087c7da85c1dc87d12f3493e76" name="aa453c0087c7da85c1dc87d12f3493e76"></a>## [◆ ](#aa453c0087c7da85c1dc87d12f3493e76)WavelengthIncidenceDependency

 str WavelengthIncidenceDependency = property(fget=\_\_GetWavelengthIncidenceDependency, fset=\_\_SetWavelengthIncidenceDependency)  static 

Gets or sets the wavelength and incidence dependency value.

True: Uses Polarization.  
 False: Uses Retarder and Diattenuator.

**Value type**: Boolean.

The default value is False.





<a id="a26309a89380b2756527ec19cffef2b6c" name="a26309a89380b2756527ec19cffef2b6c"></a>## [◆ ](#a26309a89380b2756527ec19cffef2b6c)XEnd

 str XEnd = property(fget=\_\_GetXEnd, fset=\_\_SetXEnd)  static 

Gets or sets the component X end dimension value.

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

The default value is 1.0 mm.





<a id="ae7c2faf5c62ec2baf03149375fadd672" name="ae7c2faf5c62ec2baf03149375fadd672"></a>## [◆ ](#ae7c2faf5c62ec2baf03149375fadd672)XMirroredExtent

 str XMirroredExtent = property(fget=\_\_GetXMirroredExtent, fset=\_\_SetXMirroredExtent)  static 

Gets or sets the component X dimension mirrored extent value.

True: XStart == -XEnd, you can only change the XEnd value.  
 False: XStart and XEnd can have different value.

**Value type**: Boolean.

The default value is False.





<a id="abcbac58872bdd9d694ee7177d1ef7973" name="abcbac58872bdd9d694ee7177d1ef7973"></a>## [◆ ](#abcbac58872bdd9d694ee7177d1ef7973)XStart

 str XStart = property(fget=\_\_GetXStart, fset=\_\_SetXStart)  static 

Gets or sets the component X start dimension value.

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

The default value is -1.0 mm.





<a id="a3106ba653a070cd30ef2357bddd2cf60" name="a3106ba653a070cd30ef2357bddd2cf60"></a>## [◆ ](#a3106ba653a070cd30ef2357bddd2cf60)YEnd

 str YEnd = property(fget=\_\_GetYEnd, fset=\_\_SetYEnd)  static 

Gets or sets the component Y end dimension value.

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

The default value is 1.0 mm.





<a id="a1a4644fb780cae70d397e455eac08e13" name="a1a4644fb780cae70d397e455eac08e13"></a>## [◆ ](#a1a4644fb780cae70d397e455eac08e13)YMirroredExtent

 str YMirroredExtent = property(fget=\_\_GetYMirroredExtent, fset=\_\_SetYMirroredExtent)  static 

Gets or sets the component Y dimension mirrored extent value.

True: YStart == -YEnd, you can only change the YEnd value.  
 False: YStart and YEnd can have different value.

**Value type**: Boolean.

The default value is False.





<a id="accbaddec059ec07b1ca7f3a94b4574d2" name="accbaddec059ec07b1ca7f3a94b4574d2"></a>## [◆ ](#accbaddec059ec07b1ca7f3a94b4574d2)YStart

 str YStart = property(fget=\_\_GetYStart, fset=\_\_SetYStart)  static 

Gets or sets the component Y start dimension value.

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

The default value is -1.0 mm.





---

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