ComponentPolarizationPlateBuilder Class Reference
Last update: 16.07.2025Represents a Polarization Plate Component Builder. More...
Static Public Attributes | |
| str | Angle = property(fget=__GetAngle, fset=__SetAngle) |
| Gets or sets the angle value. | |
| str | AxisSystem = property(fget=__GetAxisSystem) |
| Gets the Axis System of the Component. | |
| str | DiattenuationType = property(fget=__GetDiattenuationType, fset=__SetDiattenuationType) |
| Gets or sets the Diattenuation type of the component. | |
| str | MaterialFilePath = property(fget=__GetMaterialFilePath, fset=__SetMaterialFilePath) |
| Gets or sets the material file path. | |
| str | OptimalWavelength = property(fget=__GetOptimalWavelength, fset=__SetOptimalWavelength) |
| Gets or sets the optimal wavelength value. | |
| str | PolarizationType = property(fget=__GetPolarizationType, fset=__SetPolarizationType) |
| Gets or sets the polarization type of the component. | |
| str | PolarizerFilePath = property(fget=__GetPolarizerFilePath, fset=__SetPolarizerFilePath) |
| Gets or sets the polarizer file path. | |
| str | RetardanceDivisor = property(fget=__GetRetardanceDivisor, fset=__SetRetardanceDivisor) |
| Gets or sets the retardance deivisor value. | |
| str | RetardanceMultiplicator = property(fget=__GetRetardanceMultiplicator, fset=__SetRetardanceMultiplicator) |
| Gets or sets the retardance multiplicator value. | |
| str | Thickness = property(fget=__GetThickness) |
| Gets the Thickness value. | |
| str | WavelengthIncidenceDependency = property(fget=__GetWavelengthIncidenceDependency, fset=__SetWavelengthIncidenceDependency) |
| Gets or sets the wavelength and incidence dependency value. | |
| str | XEnd = property(fget=__GetXEnd, fset=__SetXEnd) |
| Gets or sets the component X end dimension value. | |
| str | XMirroredExtent = property(fget=__GetXMirroredExtent, fset=__SetXMirroredExtent) |
| Gets or sets the component X dimension mirrored extent value. | |
| str | XStart = property(fget=__GetXStart, fset=__SetXStart) |
| Gets or sets the component X start dimension value. | |
| str | YEnd = property(fget=__GetYEnd, fset=__SetYEnd) |
| Gets or sets the component Y end dimension value. | |
| str | YMirroredExtent = property(fget=__GetYMirroredExtent, fset=__SetYMirroredExtent) |
| Gets or sets the component Y dimension mirrored extent value. | |
| str | YStart = property(fget=__GetYStart, fset=__SetYStart) |
| Gets or sets the component Y start dimension value. | |
 Static Public Attributes inherited from FeatureBuilder | |
| str | Feature = property(fget=__GetFeature) |
| Returns the feature being edited, or the created feature if the builder is being used in creation mode. | |
| str | FullName = property(fget=__GetFullName) |
| Gets the full name of the feature being edited. | |
| str | Name = property(fget=__GetName, fset=__SetName) |
| Gets or sets the name of the feature being edited. | |
| str | NameWithContext = property(fget=__GetNameWithContext) |
| Gets the name with context of the feature being edited. | |
| str | Status = property(fget=__GetStatus) |
| Returns the status of the feature being edited. | |
Properties | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
| Properties inherited from FeatureBuilder | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
| Properties inherited from Builder | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
Additional Inherited Members | |
| Public Member Functions inherited from FeatureBuilder | |
| 'None' | ShowResult (self) |
| Updates the feature to reflect the result of an edit to the feature for all builders that support showing results. | |
| Public Member Functions inherited from Builder | |
| 'None' | Commit (self) |
| Commits any edits that have been applied to the builder. | |
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 FeatureCollection::CreateComponentPolarizationPlateBuilder.
Polarization plate is used to define polarization components like polarizers, wave plates, or any component whose Jones matrix is known.
Member Data Documentation
◆ Angle
|
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.
◆ AxisSystem
|
static |
Gets the Axis System of the Component.
Value type: AxisSystem object.
◆ DiattenuationType
|
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.
◆ MaterialFilePath
|
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.
◆ OptimalWavelength
|
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.
◆ PolarizationType
|
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.
◆ PolarizerFilePath
|
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.
◆ RetardanceDivisor
|
static |
Gets or sets the retardance deivisor value.
Prerequisite: The WavelengthIncidenceDependency property must be True.
Value type: Double.
The default value is 2.0.
◆ RetardanceMultiplicator
|
static |
Gets or sets the retardance multiplicator value.
Prerequisite: The WavelengthIncidenceDependency property must be True.
Value type: Integer.
The default value is 100.
◆ Thickness
|
static |
Gets the Thickness value.
Prerequisite: The WavelengthIncidenceDependency property must be True.
Value type: Double.
◆ WavelengthIncidenceDependency
|
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.
◆ XEnd
|
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.
◆ XMirroredExtent
|
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.
◆ XStart
|
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.
◆ YEnd
|
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.
◆ YMirroredExtent
|
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.
◆ YStart
|
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
