PointDetector_Type

Bases: Detector_Type

Represents the XML complex type PointDetector.

This element represents any Detector that collects light from a restricted point-like area of an Image. These detectors are typically used in Laser Scanning Confocal Microscopy.

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

setCoating(value)

Sets the value of the Coating attribute.

This field records the Coating Material used to increase the photoelectric properties of the metallic cathode used in this Detector. The coating releases electrons much more readily than the underlying metal, allowing it to detect the low-energy photons in infrared radiation. The lens transmits the radiation from the object being viewed to a layer of coated glass. The photons strike the metal surface and transfer electrons to its rear side. The freed electrons are then collected to produce the final Image.

Parameters:

Name	Type	Description	Default
value	CoatingMaterial_Type	The value to set	required

getCoating()

Returns the value of the Coating attribute.

This field records the Coating Material used to increase the photoelectric properties of the metallic cathode used in this Detector. The coating releases electrons much more readily than the underlying metal, allowing it to detect the low-energy photons in infrared radiation. The lens transmits the radiation from the object being viewed to a layer of coated glass. The photons strike the metal surface and transfer electrons to its rear side. The freed electrons are then collected to produce the final Image.

Returns:

Type	Description
CoatingMaterial_Type	The value of the attribute

resetCoating()

Resets the Coating attribute to an unset state.

This field records the Coating Material used to increase the photoelectric properties of the metallic cathode used in this Detector. The coating releases electrons much more readily than the underlying metal, allowing it to detect the low-energy photons in infrared radiation. The lens transmits the radiation from the object being viewed to a layer of coated glass. The photons strike the metal surface and transfer electrons to its rear side. The freed electrons are then collected to produce the final Image.

hasCoating()

Checks whether the optional Coating attribute is present.

This field records the Coating Material used to increase the photoelectric properties of the metallic cathode used in this Detector. The coating releases electrons much more readily than the underlying metal, allowing it to detect the low-energy photons in infrared radiation. The lens transmits the radiation from the object being viewed to a layer of coated glass. The photons strike the metal surface and transfer electrons to its rear side. The freed electrons are then collected to produce the final Image.

Returns:

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

setSignalProcessing(value)

Sets the value of the SignalProcessing attribute.

This field describes the method employed by this device to process the output signal and convert it into a measure of incident light intensity. In Photon Counting mode the system is set in a manner in which each photon hitting the head of the detector gives either no or 1 discrete pulse. This way by counting the pulses one is sure to be counting individual photons. In Analog mode the system is set so the mean value of all signal pulses is used as a measure of intensity.

Parameters:

Name	Type	Description	Default
value	SignalProcessingMode_Type	The value to set	required

getSignalProcessing()

Returns the value of the SignalProcessing attribute.

This field describes the method employed by this device to process the output signal and convert it into a measure of incident light intensity. In Photon Counting mode the system is set in a manner in which each photon hitting the head of the detector gives either no or 1 discrete pulse. This way by counting the pulses one is sure to be counting individual photons. In Analog mode the system is set so the mean value of all signal pulses is used as a measure of intensity.

Returns:

Type	Description
SignalProcessingMode_Type	The value of the attribute

resetSignalProcessing()

Resets the SignalProcessing attribute to an unset state.

This field describes the method employed by this device to process the output signal and convert it into a measure of incident light intensity. In Photon Counting mode the system is set in a manner in which each photon hitting the head of the detector gives either no or 1 discrete pulse. This way by counting the pulses one is sure to be counting individual photons. In Analog mode the system is set so the mean value of all signal pulses is used as a measure of intensity.

hasSignalProcessing()

Checks whether the optional SignalProcessing attribute is present.

This field describes the method employed by this device to process the output signal and convert it into a measure of incident light intensity. In Photon Counting mode the system is set in a manner in which each photon hitting the head of the detector gives either no or 1 discrete pulse. This way by counting the pulses one is sure to be counting individual photons. In Analog mode the system is set so the mean value of all signal pulses is used as a measure of intensity.

Returns:

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

setResponseTime(value)

Sets the value of the ResponseTime attribute.

This field records the Time required for the Detector to respond to an optical input.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getResponseTime()

Returns the value of the ResponseTime attribute.

This field records the Time required for the Detector to respond to an optical input.

Returns:

Type	Description
float	The value of the attribute

resetResponseTime()

Resets the ResponseTime attribute to an unset state.

This field records the Time required for the Detector to respond to an optical input.

hasResponseTime()

Checks whether the optional ResponseTime attribute is present.

This field records the Time required for the Detector to respond to an optical input.

Returns:

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

setResponseTimeUnit(value)

Sets the value of the ResponseTimeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTime_Type	The value to set	required

getResponseTimeUnit()

Returns the value of the ResponseTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetResponseTimeUnit()

Resets the ResponseTimeUnit attribute to an unset state.

No description available in the XSD standard.

hasResponseTimeUnit()

Checks whether the optional ResponseTimeUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setDeadTime(value)

Sets the value of the DeadTime attribute.

This field records the Time required for the Detector to become responsive again after being hit by a photon.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getDeadTime()

Returns the value of the DeadTime attribute.

This field records the Time required for the Detector to become responsive again after being hit by a photon.

Returns:

Type	Description
float	The value of the attribute

resetDeadTime()

Resets the DeadTime attribute to an unset state.

This field records the Time required for the Detector to become responsive again after being hit by a photon.

hasDeadTime()

Checks whether the optional DeadTime attribute is present.

This field records the Time required for the Detector to become responsive again after being hit by a photon.

Returns:

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

setDeadTimeUnit(value)

Sets the value of the DeadTimeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTime_Type	The value to set	required

getDeadTimeUnit()

Returns the value of the DeadTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetDeadTimeUnit()

Resets the DeadTimeUnit attribute to an unset state.

No description available in the XSD standard.

hasDeadTimeUnit()

Checks whether the optional DeadTimeUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setRadiantSensitivity(value)

Sets the value of the RadiantSensitivity attribute.

This field records the Radiant Sensitivity observed with this Detector at the peak Wavelength

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getRadiantSensitivity()

Returns the value of the RadiantSensitivity attribute.

This field records the Radiant Sensitivity observed with this Detector at the peak Wavelength

Returns:

Type	Description
float	The value of the attribute

resetRadiantSensitivity()

Resets the RadiantSensitivity attribute to an unset state.

This field records the Radiant Sensitivity observed with this Detector at the peak Wavelength

hasRadiantSensitivity()

Checks whether the optional RadiantSensitivity attribute is present.

This field records the Radiant Sensitivity observed with this Detector at the peak Wavelength

Returns:

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

setRadiantSensitivityUnit(value)

Sets the value of the RadiantSensitivityUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsPower_Type	The value to set	required

getRadiantSensitivityUnit()

Returns the value of the RadiantSensitivityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsPower_Type	The value of the attribute

resetRadiantSensitivityUnit()

Resets the RadiantSensitivityUnit attribute to an unset state.

No description available in the XSD standard.

hasRadiantSensitivityUnit()

Checks whether the optional RadiantSensitivityUnit attribute is present.

No description available in the XSD standard.

Returns:

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