IntensityCalibration_Type¶
Bases: NBOBaseClass
Represents the XML complex type IntensityCalibration.
This describes the procedure(s) that were used for excitation and detector calibration and the resulting calibration results.
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 |
|---|---|
IntensityCalibration_Type
|
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 |
setDate(value, validate=True)
¶
Sets the value of the Date attribute.
Ths field records the Date in which this Calibration procedure 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
|
getDate()
¶
Returns the value of the Date attribute.
Ths field records the Date in which this Calibration procedure was performed.
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
resetDate()
¶
Resets the Date attribute to an unset state.
Ths field records the Date in which this Calibration procedure was performed.
hasDate()
¶
Checks whether the Date attribute is present.
Ths field records the Date in which this Calibration procedure was performed.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the attribute has been set, false otherwise |
getDateAllowedValues()
staticmethod
¶
Returns the allowed values for this attribut.
Ths field records the Date in which this Calibration procedure was performed.
Returns:
| Type | Description |
|---|---|
std::set< str,std::less< str >,std::allocator< str > >
|
The list of allowed values |
setSampleSize(value, validate=True)
¶
Sets the value of the SampleSize attribute.
This field captures the Size of the Sample that was used to calculate the reported Intensity Calibration metrics. For example, this might represent the number of Illumination Power measurements that were utilized to calculate the Illumination Stability of a given Light Source.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PositiveInt_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getSampleSize()
¶
Returns the value of the SampleSize attribute.
This field captures the Size of the Sample that was used to calculate the reported Intensity Calibration metrics. For example, this might represent the number of Illumination Power measurements that were utilized to calculate the Illumination Stability of a given Light Source.
Returns:
| Type | Description |
|---|---|
PositiveInt_Type
|
The value of the attribute |
resetSampleSize()
¶
Resets the SampleSize attribute to an unset state.
This field captures the Size of the Sample that was used to calculate the reported Intensity Calibration metrics. For example, this might represent the number of Illumination Power measurements that were utilized to calculate the Illumination Stability of a given Light Source.
hasSampleSize()
¶
Checks whether the optional SampleSize attribute is present.
This field captures the Size of the Sample that was used to calculate the reported Intensity Calibration metrics. For example, this might represent the number of Illumination Power measurements that were utilized to calculate the Illumination Stability of a given Light Source.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMethod(value, validate=True)
¶
Sets the value of the Method attribute.
This field records a Description of Method used for this calibration procedure.
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
|
getMethod()
¶
Returns the value of the Method attribute.
This field records a Description of Method used for this calibration procedure.
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
resetMethod()
¶
Resets the Method attribute to an unset state.
This field records a Description of Method used for this calibration procedure.
hasMethod()
¶
Checks whether the Method attribute is present.
This field records a Description of Method used for this calibration procedure.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the attribute has been set, false otherwise |
getMethodAllowedValues()
staticmethod
¶
Returns the allowed values for this attribut.
This field records a Description of Method used for this calibration procedure.
Returns:
| Type | Description |
|---|---|
std::set< str,std::less< str >,std::allocator< str > >
|
The list of allowed values |
setIntensityCalibrationToolRef_List(value, validate=True)
¶
Sets the list of IntensityCalibrationToolRef elements.
This element is a reference to the tool, if any, used to perform this calibratin procdure
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[IntensityCalibration_Type_InlineIntensityCalibrationToolRef]
|
The new list of IntensityCalibrationToolRef elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getIntensityCalibrationToolRef_List()
¶
Returns the list of IntensityCalibrationToolRef elements.
This element is a reference to the tool, if any, used to perform this calibratin procdure
Returns:
| Type | Description |
|---|---|
List[IntensityCalibration_Type_InlineIntensityCalibrationToolRef]
|
The list of IntensityCalibrationToolRef elements |
addToIntensityCalibrationToolRef_List(value, validate=True)
¶
Adds a new IntensityCalibrationToolRef element to this object.
This element is a reference to the tool, if any, used to perform this calibratin procdure
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
IntensityCalibration_Type_InlineIntensityCalibrationToolRef
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearIntensityCalibrationToolRef_List()
¶
Clear the list of IntensityCalibrationToolRef.
This element is a reference to the tool, if any, used to perform this calibratin procdure
setIntensityCalibrationReport_List(value, validate=True)
¶
Sets the list of IntensityCalibrationReport elements.
This element refers to any File containing a report generated by the Calibration Software referred to in Calibration procedure.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[FileAnnotation_Type]
|
The new list of IntensityCalibrationReport elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getIntensityCalibrationReport_List()
¶
Returns the list of IntensityCalibrationReport elements.
This element refers to any File containing a report generated by the Calibration Software referred to in Calibration procedure.
Returns:
| Type | Description |
|---|---|
List[FileAnnotation_Type]
|
The list of IntensityCalibrationReport elements |
addToIntensityCalibrationReport_List(value, validate=True)
¶
Adds a new IntensityCalibrationReport element to this object.
This element refers to any File containing a report generated by the Calibration Software referred to in Calibration procedure.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
FileAnnotation_Type
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearIntensityCalibrationReport_List()
¶
Clear the list of IntensityCalibrationReport.
This element refers to any File containing a report generated by the Calibration Software referred to in Calibration procedure.
setCalibrationSoftware_List(value, validate=True)
¶
Sets the list of CalibrationSoftware elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[CalibrationSoftware]
|
The new list of CalibrationSoftware elements |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getCalibrationSoftware_List()
¶
Returns the list of CalibrationSoftware elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[CalibrationSoftware]
|
The list of CalibrationSoftware elements |
addToCalibrationSoftware_List(value, validate=True)
¶
Adds a new CalibrationSoftware element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
CalibrationSoftware
|
The element to add |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
clearCalibrationSoftware_List()
¶
Clear the list of CalibrationSoftware.
No description available in the XSD standard.
setAnnotationRef(value, validate=True)
¶
Sets the value of the AnnotationRef element.
This is a simple multi-line comment or annotation describing this component.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
IntensityCalibration_Type_InlineAnnotationRef
|
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 a simple multi-line comment or annotation describing this component.
Returns:
| Type | Description |
|---|---|
IntensityCalibration_Type_InlineAnnotationRef
|
The value of the element |
resetAnnotationRef()
¶
Resets the AnnotationRef element to an unset state.
This is a simple multi-line comment or annotation describing this component.
hasAnnotationRef()
¶
Checks whether the optional AnnotationRef element is present.
This is a simple multi-line comment or annotation describing this component.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |