IntensityCalibrationTool

Bases: ManufacturerSpec_Type

Represents the XML element IntensityCalibrationTool.

A tool, such as the Meta-Max calibration toold developed by the 4D Nucleome Imaging Standards Working Group, used to perform an intensity calibration procedure.

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
IntensityCalibrationTool	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

setID(value, validate=True)

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

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

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
LSID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

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

setName(value, validate=True)

Sets the value of the Name attribute.

A User-defined Name for this component.

Parameters:

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

getName()

Returns the value of the Name attribute.

A User-defined Name for this component.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

hasName()

Checks whether the optional Name attribute is present.

A User-defined Name for this component.

Returns:

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

setType(value, validate=True)

Sets the value of the Type attribute.

This field captures the general category to which this Intensity Calibration tool belongs.

Parameters:

Name	Type	Description	Default
value	string	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 captures the general category to which this Intensity Calibration tool belongs.

Returns:

Type	Description
string	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field captures the general category to which this Intensity Calibration tool belongs.

hasType()

Checks whether the Type attribute is present.

This field captures the general category to which this Intensity Calibration tool belongs.

Returns:

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

getTypeAllowedValues() staticmethod

Returns the allowed values for this attribut.

This field captures the general category to which this Intensity Calibration tool belongs.

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

setCalibrationType(value, validate=True)

Sets the value of the CalibrationType attribute.

The type of calibration proceudure this tool is intended to perform.

Parameters:

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

getCalibrationType()

Returns the value of the CalibrationType attribute.

The type of calibration proceudure this tool is intended to perform.

Returns:

Type	Description
IntensityCalibrationType_Type	The value of the attribute

resetCalibrationType()

Resets the CalibrationType attribute to an unset state.

The type of calibration proceudure this tool is intended to perform.

hasCalibrationType()

Checks whether the optional CalibrationType attribute is present.

The type of calibration proceudure this tool is intended to perform.

Returns:

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

setLastCalibrationDate(value, validate=True)

Sets the value of the LastCalibrationDate attribute.

This field records the Date in which the most recent Calibration Procedure of this Calibration Tool was performed.

Parameters:

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

getLastCalibrationDate()

Returns the value of the LastCalibrationDate attribute.

This field records the Date in which the most recent Calibration Procedure of this Calibration Tool was performed.

Returns:

Type	Description
string	The value of the attribute

resetLastCalibrationDate()

Resets the LastCalibrationDate attribute to an unset state.

This field records the Date in which the most recent Calibration Procedure of this Calibration Tool was performed.

hasLastCalibrationDate()

Checks whether the LastCalibrationDate attribute is present.

This field records the Date in which the most recent Calibration Procedure of this Calibration Tool was performed.

Returns:

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

getLastCalibrationDateAllowedValues() staticmethod

Returns the allowed values for this attribut.

This field records the Date in which the most recent Calibration Procedure of this Calibration Tool was performed.

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

setLightSensorRef(value, validate=True)

Sets the value of the LightSensorRef element.

No description available in the XSD standard.

Parameters:

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

getLightSensorRef()

Returns the value of the LightSensorRef element.

No description available in the XSD standard.

Returns:

Type	Description
LightSensorRef	The value of the element

resetLightSensorRef()

Resets the LightSensorRef element to an unset state.

No description available in the XSD standard.

hasLightSensorRef()

Checks whether the optional LightSensorRef element is present.

No description available in the XSD standard.

Returns:

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

setAnnotationRef(value, validate=True)

Sets the value of the AnnotationRef element.

This is an empty element that refers to an Annotation (typically a Comment Annotation that consists of a simple multi-line comment) describing this component.

Parameters:

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

getAnnotationRef()

Returns the value of the AnnotationRef element.

This is an empty element that refers to an Annotation (typically a Comment Annotation that consists of a simple multi-line comment) describing this component.

Returns:

Type	Description
AnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

This is an empty element that refers to an Annotation (typically a Comment Annotation that consists of a simple multi-line comment) describing this component.

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

This is an empty element that refers to an Annotation (typically a Comment Annotation that consists of a simple multi-line comment) describing this component.

Returns:

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