Camera_Type

Bases: Detector_Type

Represents the XML complex type Camera.

This element describes a Camera available for this Instrument. A Camera is a device that converts optical brightness into an electrical signal using a grid of pixel sensor unit cells and then reproduces an image of the specimen. An Instrument may have more than one camera of different types, such as traditional CCD, EMCCD, Intensified EMCCD, sCMOS, or Analog Video.

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

setArrayWidth(value)

Sets the value of the ArrayWidth attribute.

This field records the Width of this Camera chip or sensor area, expressed in Pixel.

Parameters:

Name	Type	Description	Default
value	int	The value to set	required

getArrayWidth()

Returns the value of the ArrayWidth attribute.

This field records the Width of this Camera chip or sensor area, expressed in Pixel.

Returns:

Type	Description
int	The value of the attribute

resetArrayWidth()

Resets the ArrayWidth attribute to an unset state.

This field records the Width of this Camera chip or sensor area, expressed in Pixel.

hasArrayWidth()

Checks whether the optional ArrayWidth attribute is present.

This field records the Width of this Camera chip or sensor area, expressed in Pixel.

Returns:

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

setArrayHeight(value)

Sets the value of the ArrayHeight attribute.

This field records the Height of this Camera chip or sensor area, expressed in Pixel.

Parameters:

Name	Type	Description	Default
value	int	The value to set	required

getArrayHeight()

Returns the value of the ArrayHeight attribute.

This field records the Height of this Camera chip or sensor area, expressed in Pixel.

Returns:

Type	Description
int	The value of the attribute

resetArrayHeight()

Resets the ArrayHeight attribute to an unset state.

This field records the Height of this Camera chip or sensor area, expressed in Pixel.

hasArrayHeight()

Checks whether the optional ArrayHeight attribute is present.

This field records the Height of this Camera chip or sensor area, expressed in Pixel.

Returns:

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

setPixelWidth(value)

Sets the value of the PixelWidth attribute.

This field records the Physical Width of each Camera Pixel.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getPixelWidth()

Returns the value of the PixelWidth attribute.

This field records the Physical Width of each Camera Pixel.

Returns:

Type	Description
float	The value of the attribute

setPixelWidthUnit(value)

Sets the value of the PixelWidthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getPixelWidthUnit()

Returns the value of the PixelWidthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetPixelWidthUnit()

Resets the PixelWidthUnit attribute to an unset state.

No description available in the XSD standard.

hasPixelWidthUnit()

Checks whether the optional PixelWidthUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPixelHeight(value)

Sets the value of the PixelHeight attribute.

This field records the Physical Height of each Camera Pixel.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getPixelHeight()

Returns the value of the PixelHeight attribute.

This field records the Physical Height of each Camera Pixel.

Returns:

Type	Description
float	The value of the attribute

setPixelHeightUnit(value)

Sets the value of the PixelHeightUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getPixelHeightUnit()

Returns the value of the PixelHeightUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetPixelHeightUnit()

Resets the PixelHeightUnit attribute to an unset state.

No description available in the XSD standard.

hasPixelHeightUnit()

Checks whether the optional PixelHeightUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setIllumination(value)

Sets the value of the Illumination attribute.

This field records the type of illumination the Camera chip receives.

Parameters:

Name	Type	Description	Default
value	CameraIllumination_Type	The value to set	required

getIllumination()

Returns the value of the Illumination attribute.

This field records the type of illumination the Camera chip receives.

Returns:

Type	Description
CameraIllumination_Type	The value of the attribute

resetIllumination()

Resets the Illumination attribute to an unset state.

This field records the type of illumination the Camera chip receives.

hasIllumination()

Checks whether the optional Illumination attribute is present.

This field records the type of illumination the Camera chip receives.

Returns:

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

setManufacturerOffet(value)

Sets the value of the ManufacturerOffet attribute.

This field reports the Camera Offset when it is pre-set by the Manufacturer. The Offset is an electronic baseline added to the output signal from the sensor to ensure that the displayed signal level is always a positive number of counts.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getManufacturerOffet()

Returns the value of the ManufacturerOffet attribute.

This field reports the Camera Offset when it is pre-set by the Manufacturer. The Offset is an electronic baseline added to the output signal from the sensor to ensure that the displayed signal level is always a positive number of counts.

Returns:

Type	Description
float	The value of the attribute

resetManufacturerOffet()

Resets the ManufacturerOffet attribute to an unset state.

This field reports the Camera Offset when it is pre-set by the Manufacturer. The Offset is an electronic baseline added to the output signal from the sensor to ensure that the displayed signal level is always a positive number of counts.

hasManufacturerOffet()

Checks whether the optional ManufacturerOffet attribute is present.

This field reports the Camera Offset when it is pre-set by the Manufacturer. The Offset is an electronic baseline added to the output signal from the sensor to ensure that the displayed signal level is always a positive number of counts.

Returns:

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

setColor(value)

Sets the value of the Color attribute.

This field records whether this is a Color Camera and what type it is.

Parameters:

Name	Type	Description	Default
value	ColorMode_Type	The value to set	required

getColor()

Returns the value of the Color attribute.

This field records whether this is a Color Camera and what type it is.

Returns:

Type	Description
ColorMode_Type	The value of the attribute

resetColor()

Resets the Color attribute to an unset state.

This field records whether this is a Color Camera and what type it is.

hasColor()

Checks whether the optional Color attribute is present.

This field records whether this is a Color Camera and what type it is.

Returns:

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

setPixelWellCapacity(value)

Sets the value of the PixelWellCapacity attribute.

This field records the maximum amount of charge each Pixel Well can hold, measured in electron counts.

Parameters:

Name	Type	Description	Default
value	int	The value to set	required

getPixelWellCapacity()

Returns the value of the PixelWellCapacity attribute.

This field records the maximum amount of charge each Pixel Well can hold, measured in electron counts.

Returns:

Type	Description
int	The value of the attribute

setPixelWellCapacityUnit(value)

Sets the value of the PixelWellCapacityUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsElectricCharge_Type	The value to set	required

getPixelWellCapacityUnit()

Returns the value of the PixelWellCapacityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsElectricCharge_Type	The value of the attribute

resetPixelWellCapacityUnit()

Resets the PixelWellCapacityUnit attribute to an unset state.

No description available in the XSD standard.

hasPixelWellCapacityUnit()

Checks whether the optional PixelWellCapacityUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMaximumFrameRate(value)

Sets the value of the MaximumFrameRate attribute.

This field records the maximal rate at which this Camera can acquire a single full-frame.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getMaximumFrameRate()

Returns the value of the MaximumFrameRate attribute.

This field records the maximal rate at which this Camera can acquire a single full-frame.

Returns:

Type	Description
float	The value of the attribute

setMaximumFrameRateUnit(value)

Sets the value of the MaximumFrameRateUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsFrequency_Type	The value to set	required

getMaximumFrameRateUnit()

Returns the value of the MaximumFrameRateUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsFrequency_Type	The value of the attribute

resetMaximumFrameRateUnit()

Resets the MaximumFrameRateUnit attribute to an unset state.

No description available in the XSD standard.

hasMaximumFrameRateUnit()

Checks whether the optional MaximumFrameRateUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMaximumReadoutRate(value)

Sets the value of the MaximumReadoutRate attribute.

This field records the maximal Pixel Readout Rate allowed by this Camera.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getMaximumReadoutRate()

Returns the value of the MaximumReadoutRate attribute.

This field records the maximal Pixel Readout Rate allowed by this Camera.

Returns:

Type	Description
float	The value of the attribute

setMaximumReadoutRateUnit(value)

Sets the value of the MaximumReadoutRateUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsFrequency_Type	The value to set	required

getMaximumReadoutRateUnit()

Returns the value of the MaximumReadoutRateUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsFrequency_Type	The value of the attribute

resetMaximumReadoutRateUnit()

Resets the MaximumReadoutRateUnit attribute to an unset state.

No description available in the XSD standard.

hasMaximumReadoutRateUnit()

Checks whether the optional MaximumReadoutRateUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setVerticalClockSpeed(value)

Sets the value of the VerticalClockSpeed attribute.

This field records the maximal speed at which each vertical column of pixels in the camera chip can be shifted down and read.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getVerticalClockSpeed()

Returns the value of the VerticalClockSpeed attribute.

This field records the maximal speed at which each vertical column of pixels in the camera chip can be shifted down and read.

Returns:

Type	Description
float	The value of the attribute

resetVerticalClockSpeed()

Resets the VerticalClockSpeed attribute to an unset state.

This field records the maximal speed at which each vertical column of pixels in the camera chip can be shifted down and read.

hasVerticalClockSpeed()

Checks whether the optional VerticalClockSpeed attribute is present.

This field records the maximal speed at which each vertical column of pixels in the camera chip can be shifted down and read.

Returns:

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

setVerticalClockSpeedUnit(value)

Sets the value of the VerticalClockSpeedUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTime_Type	The value to set	required

getVerticalClockSpeedUnit()

Returns the value of the VerticalClockSpeedUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetVerticalClockSpeedUnit()

Resets the VerticalClockSpeedUnit attribute to an unset state.

No description available in the XSD standard.

hasVerticalClockSpeedUnit()

Checks whether the optional VerticalClockSpeedUnit attribute is present.

No description available in the XSD standard.

Returns:

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