MicroscopeTube
Bases: OpticalAssembly_Type
Represents the XML element MicroscopeTube.
Illumination Tubes are Lens systems, which might be embedded within the Microscope Stand and therefore not immediately accessible. They are essential for infinity-correction and should be regarded as integral parts of the Objective Lens System when magnification and correction are considered.
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 |
setType(value)
Sets the value of the Type attribute.
This field captures the category of this Tube.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
MicroscopeTubeType_Type
|
The value to set |
required |
getType()
Returns the value of the Type attribute.
This field captures the category of this Tube.
Returns:
| Type | Description |
|---|---|
MicroscopeTubeType_Type
|
The value of the attribute |
resetType()
Resets the Type attribute to an unset state.
This field captures the category of this Tube.
hasType()
Checks whether the optional Type attribute is present.
This field captures the category of this Tube.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMechanicalLength(value)
Sets the value of the MechanicalLength attribute.
For Objectives corrected for a finite primary Image distance, this is the length of the Tube in its simplest form, and it corresponds to the distance in air between the Objective and the Camera port. It commonly has a value of 160 mm (ISO 9345-1). For infinity-corrected objectives, the mechanical tube length is hypothetically considered to be infinite.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getMechanicalLength()
Returns the value of the MechanicalLength attribute.
For Objectives corrected for a finite primary Image distance, this is the length of the Tube in its simplest form, and it corresponds to the distance in air between the Objective and the Camera port. It commonly has a value of 160 mm (ISO 9345-1). For infinity-corrected objectives, the mechanical tube length is hypothetically considered to be infinite.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetMechanicalLength()
Resets the MechanicalLength attribute to an unset state.
For Objectives corrected for a finite primary Image distance, this is the length of the Tube in its simplest form, and it corresponds to the distance in air between the Objective and the Camera port. It commonly has a value of 160 mm (ISO 9345-1). For infinity-corrected objectives, the mechanical tube length is hypothetically considered to be infinite.
hasMechanicalLength()
Checks whether the optional MechanicalLength attribute is present.
For Objectives corrected for a finite primary Image distance, this is the length of the Tube in its simplest form, and it corresponds to the distance in air between the Objective and the Camera port. It commonly has a value of 160 mm (ISO 9345-1). For infinity-corrected objectives, the mechanical tube length is hypothetically considered to be infinite.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMechanicalLengthUnit(value)
Sets the value of the MechanicalLengthUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsLength_Type
|
The value to set |
required |
getMechanicalLengthUnit()
Returns the value of the MechanicalLengthUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsLength_Type
|
The value of the attribute |
resetMechanicalLengthUnit()
Resets the MechanicalLengthUnit attribute to an unset state.
No description available in the XSD standard.
hasMechanicalLengthUnit()
Checks whether the optional MechanicalLengthUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setOpticalLength(value)
Sets the value of the OpticalLength attribute.
This is the distance between the back focal Plane of the Objective and the primary Image Plane. This distance is relevant only when using finite primary Image distance Objectives.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getOpticalLength()
Returns the value of the OpticalLength attribute.
This is the distance between the back focal Plane of the Objective and the primary Image Plane. This distance is relevant only when using finite primary Image distance Objectives.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetOpticalLength()
Resets the OpticalLength attribute to an unset state.
This is the distance between the back focal Plane of the Objective and the primary Image Plane. This distance is relevant only when using finite primary Image distance Objectives.
hasOpticalLength()
Checks whether the optional OpticalLength attribute is present.
This is the distance between the back focal Plane of the Objective and the primary Image Plane. This distance is relevant only when using finite primary Image distance Objectives.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setOpticalLengthUnit(value)
Sets the value of the OpticalLengthUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsLength_Type
|
The value to set |
required |
getOpticalLengthUnit()
Returns the value of the OpticalLengthUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsLength_Type
|
The value of the attribute |
resetOpticalLengthUnit()
Resets the OpticalLengthUnit attribute to an unset state.
No description available in the XSD standard.
hasOpticalLengthUnit()
Checks whether the optional OpticalLengthUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setFactor(value)
Sets the value of the Factor attribute.
Factor (q) by which the lateral Magnification at the primary Image is changed by an intermediate Lens or Lens System inserted between the Objective and the primary Image.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getFactor()
Returns the value of the Factor attribute.
Factor (q) by which the lateral Magnification at the primary Image is changed by an intermediate Lens or Lens System inserted between the Objective and the primary Image.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetFactor()
Resets the Factor attribute to an unset state.
Factor (q) by which the lateral Magnification at the primary Image is changed by an intermediate Lens or Lens System inserted between the Objective and the primary Image.
hasFactor()
Checks whether the optional Factor attribute is present.
Factor (q) by which the lateral Magnification at the primary Image is changed by an intermediate Lens or Lens System inserted between the Objective and the primary Image.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |