PhotoDiode

Bases: PointDetector_Type

Represents the XML element PhotoDiode.

This element represents a Photovoltaic Detector. Most photodiodes used in confocal microscopes are Avalanche Photodiode (APD) which because of the amplification gain have good sensitivities and less dark current.

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

setAvalanche(value)

Sets the value of the Avalanche attribute.

This field records whether (True) or not (False) this is an Avalanche Photodiode.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getAvalanche()

Returns the value of the Avalanche attribute.

This field records whether (True) or not (False) this is an Avalanche Photodiode.

Returns:

Type	Description
boolean	The value of the attribute

resetAvalanche()

Resets the Avalanche attribute to an unset state.

This field records whether (True) or not (False) this is an Avalanche Photodiode.

hasAvalanche()

Checks whether the optional Avalanche attribute is present.

This field records whether (True) or not (False) this is an Avalanche Photodiode.

Returns:

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

setPINJunction(value)

Sets the value of the PINJunction attribute.

This field records whether this photodiode is based on a Positive-Intermediate-Negative (PIN) or a Positive-Negative (PN) architecture.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getPINJunction()

Returns the value of the PINJunction attribute.

This field records whether this photodiode is based on a Positive-Intermediate-Negative (PIN) or a Positive-Negative (PN) architecture.

Returns:

Type	Description
boolean	The value of the attribute

resetPINJunction()

Resets the PINJunction attribute to an unset state.

This field records whether this photodiode is based on a Positive-Intermediate-Negative (PIN) or a Positive-Negative (PN) architecture.

hasPINJunction()

Checks whether the optional PINJunction attribute is present.

This field records whether this photodiode is based on a Positive-Intermediate-Negative (PIN) or a Positive-Negative (PN) architecture.

Returns:

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