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.
fromBase ( base )
staticmethod
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 )
setArrayWidth ( value , validate = True )
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
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
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 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 attribute has been set, false otherwise
setArrayHeight ( value , validate = True )
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
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
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 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 attribute has been set, false otherwise
setPixelWidth ( value , validate = True )
setPixelWidthUnit ( value , validate = True )
setPixelHeight ( value , validate = True )
setPixelHeightUnit ( value , validate = True )
setIllumination ( value , validate = True )
setManufacturerOffet ( value , validate = True )
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
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
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 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 attribute has been set, false otherwise
setColor ( value , validate = True )
setPixelWellCapacity ( value , validate = True )
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
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
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
resetPixelWellCapacity ()
Resets the PixelWellCapacity attribute to an unset state.
This field records the maximum amount of charge each Pixel Well can hold, measured in electron counts.
hasPixelWellCapacity ()
Checks whether the PixelWellCapacity attribute is present.
This field records the maximum amount of charge each Pixel Well can hold, measured in electron counts.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setPixelWellCapacityUnit ( value , validate = True )
getPixelWellCapacityUnit ()
resetPixelWellCapacityUnit ()
hasPixelWellCapacityUnit ()
setMaximumFrameRate ( value , validate = True )
setMaximumFrameRateUnit ( value , validate = True )
getMaximumFrameRateUnit ()
resetMaximumFrameRateUnit ()
hasMaximumFrameRateUnit ()
setMaximumReadoutRate ( value , validate = True )
resetMaximumReadoutRate ()
setMaximumReadoutRateUnit ( value , validate = True )
getMaximumReadoutRateUnit ()
resetMaximumReadoutRateUnit ()
hasMaximumReadoutRateUnit ()
setVerticalClockSpeed ( value , validate = True )
resetVerticalClockSpeed ()
setVerticalClockSpeedUnit ( value , validate = True )
getVerticalClockSpeedUnit ()
resetVerticalClockSpeedUnit ()
hasVerticalClockSpeedUnit ()