Condenser¶

Bases: OpticalAssembly_Type

Represents the XML element Condenser.

Condensers are Lens Systems located above the Light Source and under the sample in an Upright Microscope, and above the stage and below the Light Source in an Inverted Microscope. They act to gather light from the Light Source and concentrate it into a cone of light that illuminates the specimen. They typically include a Turret system and Diaphragms. The aperture and angle of the light cone must be adjusted (via the size of the Diaphragm) for each different Objective.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a Condenser.

Parameters:

Name	Type	Description	Default
`base`	`NBOBaseClass`	The base class to cast	required

Returns:

Type	Description
`Condenser`	The casted element, or nullptr if the cast fails

`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, validate=True)` ¶

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the JSON file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromJsonString(json_string, validate=True)` ¶

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
`json_string`	`string`	The JSON content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlFile(path, validate=True)` ¶

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlString(xml_string, validate=True)` ¶

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
`xml_string`	`string`	The XML content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlFile(filename, validate=True)` ¶

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
`filename`	`string`	The path to the output XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlString(validate=True)` ¶

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

Returns:

Type	Description
`string`	A string containing the XML representation of this object

`setCorrection(value, validate=True)` ¶

Sets the value of the Correction attribute.

This field captures any type of Aberration (i.e., failure of an optical system to produce a perfect image) this Condenser is design to correct.

Parameters:

Name	Type	Description	Default
`value`	`CondenserCorrection_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getCorrection()` ¶

Returns the value of the Correction attribute.

This field captures any type of Aberration (i.e., failure of an optical system to produce a perfect image) this Condenser is design to correct.

Returns:

Type	Description
`CondenserCorrection_Type`	The value of the attribute

`resetCorrection()` ¶

`hasCorrection()` ¶

Checks whether the optional Correction attribute is present.

This field captures any type of Aberration (i.e., failure of an optical system to produce a perfect image) this Condenser is design to correct.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setType(value, validate=True)` ¶

Sets the value of the Type attribute.

This field captures the general category this Condenser belongs to according to ISO 10934-1:2002. Specifically, this category refers to the type of Correction or Contrast Enhancement Method this Condenser is designed to achieve. According to ISO 10934-1:2002, options include: 1) Abbe, this is a condenser of simple design introduced by Abbe, in which there is only limited correction for spherical aberration and none for chromatic aberration. 2) Achromatic-aplanatic, this is a in which chromatic aberrations and spherical aberrations have been reduced. 3) Cardioid, this is a dark field condenser for transmitted light illumination that has spherical aberration and coma (i.e., aberration in which the image of an off-axis point object is deformed so that the image is shaped like a comet) correction. 4) Dark-field, this is a dark-ground condenser designed for dark-field microscopy, which for reflected-light microscopy might be located within the mount of the objective. 5) Pancratic, this is a condenser containing a variable “zoom” (pancratic) lens which allows the size of the illuminated field at the object to be varied while the illuminated field diaphragm remains of constant size. 6) Phase-contrast, this is condenser designed for phasecontrast microscopy. 6) Universal, this is a condenser designed for multiple contrast methods such as bright field, dark field, phase contrast, differential interference contrast, polarized light and modulation contrast.

Parameters:

Name	Type	Description	Default
`value`	`CondenserCategory_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getType()` ¶

Returns the value of the Type attribute.

This field captures the general category this Condenser belongs to according to ISO 10934-1:2002. Specifically, this category refers to the type of Correction or Contrast Enhancement Method this Condenser is designed to achieve. According to ISO 10934-1:2002, options include: 1) Abbe, this is a condenser of simple design introduced by Abbe, in which there is only limited correction for spherical aberration and none for chromatic aberration. 2) Achromatic-aplanatic, this is a in which chromatic aberrations and spherical aberrations have been reduced. 3) Cardioid, this is a dark field condenser for transmitted light illumination that has spherical aberration and coma (i.e., aberration in which the image of an off-axis point object is deformed so that the image is shaped like a comet) correction. 4) Dark-field, this is a dark-ground condenser designed for dark-field microscopy, which for reflected-light microscopy might be located within the mount of the objective. 5) Pancratic, this is a condenser containing a variable “zoom” (pancratic) lens which allows the size of the illuminated field at the object to be varied while the illuminated field diaphragm remains of constant size. 6) Phase-contrast, this is condenser designed for phasecontrast microscopy. 6) Universal, this is a condenser designed for multiple contrast methods such as bright field, dark field, phase contrast, differential interference contrast, polarized light and modulation contrast.

Returns:

Type	Description
`CondenserCategory_Type`	The value of the attribute

`resetType()` ¶

Resets the Type attribute to an unset state.

This field captures the general category this Condenser belongs to according to ISO 10934-1:2002. Specifically, this category refers to the type of Correction or Contrast Enhancement Method this Condenser is designed to achieve. According to ISO 10934-1:2002, options include: 1) Abbe, this is a condenser of simple design introduced by Abbe, in which there is only limited correction for spherical aberration and none for chromatic aberration. 2) Achromatic-aplanatic, this is a in which chromatic aberrations and spherical aberrations have been reduced. 3) Cardioid, this is a dark field condenser for transmitted light illumination that has spherical aberration and coma (i.e., aberration in which the image of an off-axis point object is deformed so that the image is shaped like a comet) correction. 4) Dark-field, this is a dark-ground condenser designed for dark-field microscopy, which for reflected-light microscopy might be located within the mount of the objective. 5) Pancratic, this is a condenser containing a variable “zoom” (pancratic) lens which allows the size of the illuminated field at the object to be varied while the illuminated field diaphragm remains of constant size. 6) Phase-contrast, this is condenser designed for phasecontrast microscopy. 6) Universal, this is a condenser designed for multiple contrast methods such as bright field, dark field, phase contrast, differential interference contrast, polarized light and modulation contrast.

`hasType()` ¶

Checks whether the optional Type attribute is present.

This field captures the general category this Condenser belongs to according to ISO 10934-1:2002. Specifically, this category refers to the type of Correction or Contrast Enhancement Method this Condenser is designed to achieve. According to ISO 10934-1:2002, options include: 1) Abbe, this is a condenser of simple design introduced by Abbe, in which there is only limited correction for spherical aberration and none for chromatic aberration. 2) Achromatic-aplanatic, this is a in which chromatic aberrations and spherical aberrations have been reduced. 3) Cardioid, this is a dark field condenser for transmitted light illumination that has spherical aberration and coma (i.e., aberration in which the image of an off-axis point object is deformed so that the image is shaped like a comet) correction. 4) Dark-field, this is a dark-ground condenser designed for dark-field microscopy, which for reflected-light microscopy might be located within the mount of the objective. 5) Pancratic, this is a condenser containing a variable “zoom” (pancratic) lens which allows the size of the illuminated field at the object to be varied while the illuminated field diaphragm remains of constant size. 6) Phase-contrast, this is condenser designed for phasecontrast microscopy. 6) Universal, this is a condenser designed for multiple contrast methods such as bright field, dark field, phase contrast, differential interference contrast, polarized light and modulation contrast.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

Condenser¶

fromBase(base) staticmethod ¶

getTypeName() ¶

getXMLName() ¶

getNBOType() ¶

getChildren() ¶

getSubElements() ¶

fromJsonFile(path, validate=True) ¶

fromJsonString(json_string, validate=True) ¶

fromXmlFile(path, validate=True) ¶

fromXmlString(xml_string, validate=True) ¶

toXmlFile(filename, validate=True) ¶

toXmlString(validate=True) ¶

setCorrection(value, validate=True) ¶

getCorrection() ¶

resetCorrection() ¶

hasCorrection() ¶

setType(value, validate=True) ¶

getType() ¶

resetType() ¶

hasType() ¶

`fromBase(base)` `staticmethod` ¶

`getTypeName()` ¶

`getXMLName()` ¶

`getNBOType()` ¶

`getChildren()` ¶

`getSubElements()` ¶

`fromJsonFile(path, validate=True)` ¶

`fromJsonString(json_string, validate=True)` ¶

`fromXmlFile(path, validate=True)` ¶

`fromXmlString(xml_string, validate=True)` ¶

`toXmlFile(filename, validate=True)` ¶

`toXmlString(validate=True)` ¶

`setCorrection(value, validate=True)` ¶

`getCorrection()` ¶

`resetCorrection()` ¶

`hasCorrection()` ¶

`setType(value, validate=True)` ¶

`getType()` ¶

`resetType()` ¶

`hasType()` ¶