PockelsCell
Bases: NBOBaseClass
Represents the XML element PockelsCell.
Pockels cells are the basic components of electro-optic modulators. A Pockels cell is a device consisting of an electro-optic crystal (with some electrodes attached to it) through which a light beam can propagate. The phase delay in the crystal (→ Pockels effect) can be modulated by applying a variable electric voltage. The Pockels cell thus acts as a voltage-controlled waveplate.
getTypeName()
Returns the class type name.
Returns:
| Type | Description |
|---|---|
string
|
The class type name |
getXMLName()
Returns the XML element name corresponding to this class.
Returns:
| Type | Description |
|---|---|
string
|
The XML element name |
getNBOType()
Returns the NBO Type corresponding to this class.
Returns:
| Type | Description |
|---|---|
int
|
The NBO Type value |
getChildren()
Returns a list of all classes derived from this class.
Returns:
| Type | Description |
|---|---|
List[NBOBaseClass]
|
The list of derived classes |
getSubElements()
Returns a list of all child elements contained in this class.
Returns:
| Type | Description |
|---|---|
List[NBOBaseClass]
|
The list of child classes |
fromJsonFile(path)
Populates this object from a JSON file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the JSON file |
required |
fromJsonString(json_string)
Populates this object from a JSON string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
json_string
|
string
|
The JSON content as a string |
required |
fromXmlFile(path)
Populates this object from a XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the XML file |
required |
fromXmlString(xml_string)
Populates this object from a XML string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xml_string
|
string
|
The XML content as a string |
required |
toXmlFile(filename)
Serializes this object to an XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
string
|
The path to the output XML file |
required |
toXmlString()
Serializes this object to an XML string.
Returns:
| Type | Description |
|---|---|
string
|
A string containing the XML representation of this object |
setHalfWaveVoltage(value)
Sets the value of the HalfWaveVoltage attribute.
This field record the Voltage required for inducing a phase change equivalent to a half an optical wavelength. In an amplitude modulator, the applied voltage has to be changed by this value in order to go from the operation point with minimum transmission to that with maximum transmission. The HalfWaveVoltage can be referred to as, Uπ, Uλ/2 or Vλ/2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getHalfWaveVoltage()
Returns the value of the HalfWaveVoltage attribute.
This field record the Voltage required for inducing a phase change equivalent to a half an optical wavelength. In an amplitude modulator, the applied voltage has to be changed by this value in order to go from the operation point with minimum transmission to that with maximum transmission. The HalfWaveVoltage can be referred to as, Uπ, Uλ/2 or Vλ/2.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
setHalfWaveVoltageUnit(value)
Sets the value of the HalfWaveVoltageUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsElectricPotential_Type
|
The value to set |
required |
getHalfWaveVoltageUnit()
Returns the value of the HalfWaveVoltageUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsElectricPotential_Type
|
The value of the attribute |
resetHalfWaveVoltageUnit()
Resets the HalfWaveVoltageUnit attribute to an unset state.
No description available in the XSD standard.
hasHalfWaveVoltageUnit()
Checks whether the optional HalfWaveVoltageUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMaterial(value)
Sets the value of the Material attribute.
This field describes the nonlinear crystal materials used to contruct this Pockels cell.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PockelsCellMaterial_Type
|
The value to set |
required |
getMaterial()
Returns the value of the Material attribute.
This field describes the nonlinear crystal materials used to contruct this Pockels cell.
Returns:
| Type | Description |
|---|---|
PockelsCellMaterial_Type
|
The value of the attribute |
resetMaterial()
Resets the Material attribute to an unset state.
This field describes the nonlinear crystal materials used to contruct this Pockels cell.
hasMaterial()
Checks whether the optional Material attribute is present.
This field describes the nonlinear crystal materials used to contruct this Pockels cell.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |