CCD

Bases: Camera_Type

Represents the XML element CCD.

This element represents a Charged Coupled Device Camera.

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

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

Returns:

Type	Description
CCD	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

setType(value, validate=True)

Sets the value of the Type attribute.

This field records the Type of CCD camera used in this case.

Parameters:

Name	Type	Description	Default
value	CCDType_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 records the Type of CCD camera used in this case.

Returns:

Type	Description
CCDType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field records the Type of CCD camera used in this case.

hasType()

Checks whether the optional Type attribute is present.

This field records the Type of CCD camera used in this case.

Returns:

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

setCCDArchitecture(value, validate=True)

Sets the value of the CCDArchitecture attribute.

This field captures the Architecture of this CCD Camera and its associated Transfer Mode.

Parameters:

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

getCCDArchitecture()

Returns the value of the CCDArchitecture attribute.

This field captures the Architecture of this CCD Camera and its associated Transfer Mode.

Returns:

Type	Description
CCDArchitecture_Type	The value of the attribute

resetCCDArchitecture()

Resets the CCDArchitecture attribute to an unset state.

This field captures the Architecture of this CCD Camera and its associated Transfer Mode.

hasCCDArchitecture()

Checks whether the optional CCDArchitecture attribute is present.

This field captures the Architecture of this CCD Camera and its associated Transfer Mode.

Returns:

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

setRegisterWellCapacity(value, validate=True)

Sets the value of the RegisterWellCapacity attribute.

This field records the maximum amount of charge each read-out register well can hold, measured in electron counts.

Parameters:

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

getRegisterWellCapacity()

Returns the value of the RegisterWellCapacity attribute.

This field records the maximum amount of charge each read-out register well can hold, measured in electron counts.

Returns:

Type	Description
int	The value of the attribute

resetRegisterWellCapacity()

Resets the RegisterWellCapacity attribute to an unset state.

This field records the maximum amount of charge each read-out register well can hold, measured in electron counts.

hasRegisterWellCapacity()

Checks whether the RegisterWellCapacity attribute is present.

This field records the maximum amount of charge each read-out register well can hold, measured in electron counts.

Returns:

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

setRegisterWellCapacityUnit(value, validate=True)

Sets the value of the RegisterWellCapacityUnit attribute.

No description available in the XSD standard.

Parameters:

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

getRegisterWellCapacityUnit()

Returns the value of the RegisterWellCapacityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsElectricCharge_Type	The value of the attribute

resetRegisterWellCapacityUnit()

Resets the RegisterWellCapacityUnit attribute to an unset state.

No description available in the XSD standard.

hasRegisterWellCapacityUnit()

Checks whether the optional RegisterWellCapacityUnit attribute is present.

No description available in the XSD standard.

Returns:

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