OpticalCalibration
Bases: NBOBaseClass
Represents the XML element OpticalCalibration.
This describes the procedure that was used for Optical Calibration and the resulting Calibration measurements.
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 |
setID(value)
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 |
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)
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 |
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 |
setTheoreticalXYSpotSize_FWHM(value)
Sets the value of the TheoreticalXYSpotSize_FWHM attribute.
This field captures the Theoretical (expected) lateral spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the xy-plane. This value should be calculated in a manner as to be compared to the Median XY Spot Size_FWHM.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getTheoreticalXYSpotSize_FWHM()
Returns the value of the TheoreticalXYSpotSize_FWHM attribute.
This field captures the Theoretical (expected) lateral spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the xy-plane. This value should be calculated in a manner as to be compared to the Median XY Spot Size_FWHM.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetTheoreticalXYSpotSize_FWHM()
Resets the TheoreticalXYSpotSize_FWHM attribute to an unset state.
This field captures the Theoretical (expected) lateral spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the xy-plane. This value should be calculated in a manner as to be compared to the Median XY Spot Size_FWHM.
hasTheoreticalXYSpotSize_FWHM()
Checks whether the optional TheoreticalXYSpotSize_FWHM attribute is present.
This field captures the Theoretical (expected) lateral spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the xy-plane. This value should be calculated in a manner as to be compared to the Median XY Spot Size_FWHM.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setTheoreticalXYSpotSize_FWHMUnit(value)
Sets the value of the TheoreticalXYSpotSize_FWHMUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsLength_Type
|
The value to set |
required |
getTheoreticalXYSpotSize_FWHMUnit()
Returns the value of the TheoreticalXYSpotSize_FWHMUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsLength_Type
|
The value of the attribute |
resetTheoreticalXYSpotSize_FWHMUnit()
Resets the TheoreticalXYSpotSize_FWHMUnit attribute to an unset state.
No description available in the XSD standard.
hasTheoreticalXYSpotSize_FWHMUnit()
Checks whether the optional TheoreticalXYSpotSize_FWHMUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMedianXYSpotSize_FWHM(value)
Sets the value of the MedianXYSpotSize_FWHM attribute.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getMedianXYSpotSize_FWHM()
Returns the value of the MedianXYSpotSize_FWHM attribute.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetMedianXYSpotSize_FWHM()
Resets the MedianXYSpotSize_FWHM attribute to an unset state.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
hasMedianXYSpotSize_FWHM()
Checks whether the optional MedianXYSpotSize_FWHM attribute is present.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMedianXYSpotSize_FWHMUnit(value)
Sets the value of the MedianXYSpotSize_FWHMUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsLength_Type
|
The value to set |
required |
getMedianXYSpotSize_FWHMUnit()
Returns the value of the MedianXYSpotSize_FWHMUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsLength_Type
|
The value of the attribute |
resetMedianXYSpotSize_FWHMUnit()
Resets the MedianXYSpotSize_FWHMUnit attribute to an unset state.
No description available in the XSD standard.
hasMedianXYSpotSize_FWHMUnit()
Checks whether the optional MedianXYSpotSize_FWHMUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMinXYSpotSize_FWHM(value)
Sets the value of the MinXYSpotSize_FWHM attribute.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Minimum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getMinXYSpotSize_FWHM()
Returns the value of the MinXYSpotSize_FWHM attribute.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Minimum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetMinXYSpotSize_FWHM()
Resets the MinXYSpotSize_FWHM attribute to an unset state.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Minimum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
hasMinXYSpotSize_FWHM()
Checks whether the optional MinXYSpotSize_FWHM attribute is present.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Minimum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMinXYSpotSize_FWHMUnit(value)
Sets the value of the MinXYSpotSize_FWHMUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsLength_Type
|
The value to set |
required |
getMinXYSpotSize_FWHMUnit()
Returns the value of the MinXYSpotSize_FWHMUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsLength_Type
|
The value of the attribute |
resetMinXYSpotSize_FWHMUnit()
Resets the MinXYSpotSize_FWHMUnit attribute to an unset state.
No description available in the XSD standard.
hasMinXYSpotSize_FWHMUnit()
Checks whether the optional MinXYSpotSize_FWHMUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMaxXYSpotSize_FWHM(value)
Sets the value of the MaxXYSpotSize_FWHM attribute.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Maximum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getMaxXYSpotSize_FWHM()
Returns the value of the MaxXYSpotSize_FWHM attribute.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Maximum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetMaxXYSpotSize_FWHM()
Resets the MaxXYSpotSize_FWHM attribute to an unset state.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Maximum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
hasMaxXYSpotSize_FWHM()
Checks whether the optional MaxXYSpotSize_FWHM attribute is present.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Maximum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMaxXYSpotSize_FWHMUnit(value)
Sets the value of the MaxXYSpotSize_FWHMUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getMaxXYSpotSize_FWHMUnit()
Returns the value of the MaxXYSpotSize_FWHMUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetMaxXYSpotSize_FWHMUnit()
Resets the MaxXYSpotSize_FWHMUnit attribute to an unset state.
No description available in the XSD standard.
hasMaxXYSpotSize_FWHMUnit()
Checks whether the optional MaxXYSpotSize_FWHMUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setTheoreticaZSpotSize_FWHM(value)
Sets the value of the TheoreticaZSpotSize_FWHM attribute.
This field captures the Theoretical (expected) z-axial spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the z-plane. This value should be used calculated in a manner as to be compared to the median Z spot size.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getTheoreticaZSpotSize_FWHM()
Returns the value of the TheoreticaZSpotSize_FWHM attribute.
This field captures the Theoretical (expected) z-axial spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the z-plane. This value should be used calculated in a manner as to be compared to the median Z spot size.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetTheoreticaZSpotSize_FWHM()
Resets the TheoreticaZSpotSize_FWHM attribute to an unset state.
This field captures the Theoretical (expected) z-axial spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the z-plane. This value should be used calculated in a manner as to be compared to the median Z spot size.
hasTheoreticaZSpotSize_FWHM()
Checks whether the optional TheoreticaZSpotSize_FWHM attribute is present.
This field captures the Theoretical (expected) z-axial spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the z-plane. This value should be used calculated in a manner as to be compared to the median Z spot size.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setTheoreticaZSpotSize_FWHMUnit(value)
Sets the value of the TheoreticaZSpotSize_FWHMUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsLength_Type
|
The value to set |
required |
getTheoreticaZSpotSize_FWHMUnit()
Returns the value of the TheoreticaZSpotSize_FWHMUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsLength_Type
|
The value of the attribute |
resetTheoreticaZSpotSize_FWHMUnit()
Resets the TheoreticaZSpotSize_FWHMUnit attribute to an unset state.
No description available in the XSD standard.
hasTheoreticaZSpotSize_FWHMUnit()
Checks whether the optional TheoreticaZSpotSize_FWHMUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMedianZSpotSize_FWHM(value)
Sets the value of the MedianZSpotSize_FWHM attribute.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, axial Resolution is defined by the FWHM of the intensity signal along the axial direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median Z-axial Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getMedianZSpotSize_FWHM()
Returns the value of the MedianZSpotSize_FWHM attribute.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, axial Resolution is defined by the FWHM of the intensity signal along the axial direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median Z-axial Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetMedianZSpotSize_FWHM()
Resets the MedianZSpotSize_FWHM attribute to an unset state.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, axial Resolution is defined by the FWHM of the intensity signal along the axial direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median Z-axial Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
hasMedianZSpotSize_FWHM()
Checks whether the optional MedianZSpotSize_FWHM attribute is present.
An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, axial Resolution is defined by the FWHM of the intensity signal along the axial direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median Z-axial Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMedianZSpotSize_FWHMUnit(value)
Sets the value of the MedianZSpotSize_FWHMUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getMedianZSpotSize_FWHMUnit()
Returns the value of the MedianZSpotSize_FWHMUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetMedianZSpotSize_FWHMUnit()
Resets the MedianZSpotSize_FWHMUnit attribute to an unset state.
No description available in the XSD standard.
hasMedianZSpotSize_FWHMUnit()
Checks whether the optional MedianZSpotSize_FWHMUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setCheckedNA(value)
Sets the value of the CheckedNA attribute.
In case the Numerical Aperture (NA) of the Objective utilized to perform this Optical Calibration is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture whether (True) or not (False) a manual check was performed to confirm that the Numerical Aperture was set to the Maximum allowable value. This check is necessary because often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments. In this context, setting the collar to the Maximum NA position is desirable not only because it is more easy to reproduce and it best to estimate the maximal resolution of the system.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
boolean
|
The value to set |
required |
getCheckedNA()
Returns the value of the CheckedNA attribute.
In case the Numerical Aperture (NA) of the Objective utilized to perform this Optical Calibration is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture whether (True) or not (False) a manual check was performed to confirm that the Numerical Aperture was set to the Maximum allowable value. This check is necessary because often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments. In this context, setting the collar to the Maximum NA position is desirable not only because it is more easy to reproduce and it best to estimate the maximal resolution of the system.
Returns:
| Type | Description |
|---|---|
boolean
|
The value of the attribute |
resetCheckedNA()
Resets the CheckedNA attribute to an unset state.
In case the Numerical Aperture (NA) of the Objective utilized to perform this Optical Calibration is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture whether (True) or not (False) a manual check was performed to confirm that the Numerical Aperture was set to the Maximum allowable value. This check is necessary because often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments. In this context, setting the collar to the Maximum NA position is desirable not only because it is more easy to reproduce and it best to estimate the maximal resolution of the system.
hasCheckedNA()
Checks whether the optional CheckedNA attribute is present.
In case the Numerical Aperture (NA) of the Objective utilized to perform this Optical Calibration is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture whether (True) or not (False) a manual check was performed to confirm that the Numerical Aperture was set to the Maximum allowable value. This check is necessary because often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments. In this context, setting the collar to the Maximum NA position is desirable not only because it is more easy to reproduce and it best to estimate the maximal resolution of the system.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setZ_Dimension(value)
Sets the value of the Z_Dimension attribute.
This field records whether (True) or not (False) this Optical Calibration procedure was performed using XY or XYZ Images of the Optical Standard sample.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
boolean
|
The value to set |
required |
getZ_Dimension()
Returns the value of the Z_Dimension attribute.
This field records whether (True) or not (False) this Optical Calibration procedure was performed using XY or XYZ Images of the Optical Standard sample.
Returns:
| Type | Description |
|---|---|
boolean
|
The value of the attribute |
resetZ_Dimension()
Resets the Z_Dimension attribute to an unset state.
This field records whether (True) or not (False) this Optical Calibration procedure was performed using XY or XYZ Images of the Optical Standard sample.
hasZ_Dimension()
Checks whether the optional Z_Dimension attribute is present.
This field records whether (True) or not (False) this Optical Calibration procedure was performed using XY or XYZ Images of the Optical Standard sample.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setNyquistRate(value)
Sets the value of the NyquistRate attribute.
This field captures the ratio between the Pixel Size and the Nyquist Criterion. The Nyquist-Shannon sampling theorem establishes that 'when sampling a signal (e.g., converting from an analog signal to digital), the sampling frequency must be greater than twice the Band Width of the input signal in order to be able to reconstruct the original perfectly from the sampled version' (Whittaker E.T., (1915). Proc. Roy. Soc. Edinburgh Sect. A, 25:181; Shannon C.E., (1949) Proc. IRE, 37:10). The Nyquist Criterion determines the minimal Sampling Density needed to capture ALL information from the Specimen into the Image. It can be shown that if the Sampling Density is higher than the Nyquist Rate (also referred to as Critical Sampling Distance) all information about the object is captured. It is important to note that the Nyquist Rate depends on the Objective Numerical Aperture (NA) and on the Excitation and Emission WaveLengths. The recommended Nyquist Rate is > 2 for conventional light microscopy, and it is 2.5 - 3 for high resolution imaging.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getNyquistRate()
Returns the value of the NyquistRate attribute.
This field captures the ratio between the Pixel Size and the Nyquist Criterion. The Nyquist-Shannon sampling theorem establishes that 'when sampling a signal (e.g., converting from an analog signal to digital), the sampling frequency must be greater than twice the Band Width of the input signal in order to be able to reconstruct the original perfectly from the sampled version' (Whittaker E.T., (1915). Proc. Roy. Soc. Edinburgh Sect. A, 25:181; Shannon C.E., (1949) Proc. IRE, 37:10). The Nyquist Criterion determines the minimal Sampling Density needed to capture ALL information from the Specimen into the Image. It can be shown that if the Sampling Density is higher than the Nyquist Rate (also referred to as Critical Sampling Distance) all information about the object is captured. It is important to note that the Nyquist Rate depends on the Objective Numerical Aperture (NA) and on the Excitation and Emission WaveLengths. The recommended Nyquist Rate is > 2 for conventional light microscopy, and it is 2.5 - 3 for high resolution imaging.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetNyquistRate()
Resets the NyquistRate attribute to an unset state.
This field captures the ratio between the Pixel Size and the Nyquist Criterion. The Nyquist-Shannon sampling theorem establishes that 'when sampling a signal (e.g., converting from an analog signal to digital), the sampling frequency must be greater than twice the Band Width of the input signal in order to be able to reconstruct the original perfectly from the sampled version' (Whittaker E.T., (1915). Proc. Roy. Soc. Edinburgh Sect. A, 25:181; Shannon C.E., (1949) Proc. IRE, 37:10). The Nyquist Criterion determines the minimal Sampling Density needed to capture ALL information from the Specimen into the Image. It can be shown that if the Sampling Density is higher than the Nyquist Rate (also referred to as Critical Sampling Distance) all information about the object is captured. It is important to note that the Nyquist Rate depends on the Objective Numerical Aperture (NA) and on the Excitation and Emission WaveLengths. The recommended Nyquist Rate is > 2 for conventional light microscopy, and it is 2.5 - 3 for high resolution imaging.
hasNyquistRate()
Checks whether the optional NyquistRate attribute is present.
This field captures the ratio between the Pixel Size and the Nyquist Criterion. The Nyquist-Shannon sampling theorem establishes that 'when sampling a signal (e.g., converting from an analog signal to digital), the sampling frequency must be greater than twice the Band Width of the input signal in order to be able to reconstruct the original perfectly from the sampled version' (Whittaker E.T., (1915). Proc. Roy. Soc. Edinburgh Sect. A, 25:181; Shannon C.E., (1949) Proc. IRE, 37:10). The Nyquist Criterion determines the minimal Sampling Density needed to capture ALL information from the Specimen into the Image. It can be shown that if the Sampling Density is higher than the Nyquist Rate (also referred to as Critical Sampling Distance) all information about the object is captured. It is important to note that the Nyquist Rate depends on the Objective Numerical Aperture (NA) and on the Excitation and Emission WaveLengths. The recommended Nyquist Rate is > 2 for conventional light microscopy, and it is 2.5 - 3 for high resolution imaging.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setSampleSize(value)
Sets the value of the SampleSize attribute.
This field captures the Sample size that was used to calculate the reported Optical Calibration metrics. For example, this might represent the number of Colored Beads that were utilized to gather data on the Optical performance of the Microscope.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PositiveInt_Type
|
The value to set |
required |
getSampleSize()
Returns the value of the SampleSize attribute.
This field captures the Sample size that was used to calculate the reported Optical Calibration metrics. For example, this might represent the number of Colored Beads that were utilized to gather data on the Optical performance of the Microscope.
Returns:
| Type | Description |
|---|---|
PositiveInt_Type
|
The value of the attribute |
resetSampleSize()
Resets the SampleSize attribute to an unset state.
This field captures the Sample size that was used to calculate the reported Optical Calibration metrics. For example, this might represent the number of Colored Beads that were utilized to gather data on the Optical performance of the Microscope.
hasSampleSize()
Checks whether the optional SampleSize attribute is present.
This field captures the Sample size that was used to calculate the reported Optical Calibration metrics. For example, this might represent the number of Colored Beads that were utilized to gather data on the Optical performance of the Microscope.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setPSFEquation(value)
Sets the value of the PSFEquation attribute.
This field captures the Equation that was used to perform the Eliptical PSF Gaussian Fit.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
string
|
The value to set |
required |
getPSFEquation()
Returns the value of the PSFEquation attribute.
This field captures the Equation that was used to perform the Eliptical PSF Gaussian Fit.
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
resetPSFEquation()
Resets the PSFEquation attribute to an unset state.
This field captures the Equation that was used to perform the Eliptical PSF Gaussian Fit.
hasPSFEquation()
Checks whether the optional PSFEquation attribute is present.
This field captures the Equation that was used to perform the Eliptical PSF Gaussian Fit.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setPlanarity(value)
Sets the value of the Planarity attribute.
This is a measure of the flatness of the focal plane across the Field of View (FOV). The planarity of the focal plane is calculated from the observed z-position of the best focus of each Point Emitter. It indicates focal aberrations or tilt. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getPlanarity()
Returns the value of the Planarity attribute.
This is a measure of the flatness of the focal plane across the Field of View (FOV). The planarity of the focal plane is calculated from the observed z-position of the best focus of each Point Emitter. It indicates focal aberrations or tilt. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetPlanarity()
Resets the Planarity attribute to an unset state.
This is a measure of the flatness of the focal plane across the Field of View (FOV). The planarity of the focal plane is calculated from the observed z-position of the best focus of each Point Emitter. It indicates focal aberrations or tilt. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
hasPlanarity()
Checks whether the optional Planarity attribute is present.
This is a measure of the flatness of the focal plane across the Field of View (FOV). The planarity of the focal plane is calculated from the observed z-position of the best focus of each Point Emitter. It indicates focal aberrations or tilt. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setPlanarityUnit(value)
Sets the value of the PlanarityUnit attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UnitsLength_Type
|
The value to set |
required |
getPlanarityUnit()
Returns the value of the PlanarityUnit attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
UnitsLength_Type
|
The value of the attribute |
resetPlanarityUnit()
Resets the PlanarityUnit attribute to an unset state.
No description available in the XSD standard.
hasPlanarityUnit()
Checks whether the optional PlanarityUnit attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setLateralAsymmetry(value)
Sets the value of the LateralAsymmetry attribute.
This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Lateral Asymmetry (i.e. the ratio of the minimum lateral FWMH over the maximum lateral FWHM). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getLateralAsymmetry()
Returns the value of the LateralAsymmetry attribute.
This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Lateral Asymmetry (i.e. the ratio of the minimum lateral FWMH over the maximum lateral FWHM). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetLateralAsymmetry()
Resets the LateralAsymmetry attribute to an unset state.
This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Lateral Asymmetry (i.e. the ratio of the minimum lateral FWMH over the maximum lateral FWHM). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
hasLateralAsymmetry()
Checks whether the optional LateralAsymmetry attribute is present.
This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Lateral Asymmetry (i.e. the ratio of the minimum lateral FWMH over the maximum lateral FWHM). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setAxialAsymmetry(value)
Sets the value of the AxialAsymmetry attribute.
This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Axial Asymmetry (i.e. the ratio of the minimum axial FWMH over the maximum axial FWHM; also referred to as Spherical Aberration). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getAxialAsymmetry()
Returns the value of the AxialAsymmetry attribute.
This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Axial Asymmetry (i.e. the ratio of the minimum axial FWMH over the maximum axial FWHM; also referred to as Spherical Aberration). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetAxialAsymmetry()
Resets the AxialAsymmetry attribute to an unset state.
This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Axial Asymmetry (i.e. the ratio of the minimum axial FWMH over the maximum axial FWHM; also referred to as Spherical Aberration). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
hasAxialAsymmetry()
Checks whether the optional AxialAsymmetry attribute is present.
This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Axial Asymmetry (i.e. the ratio of the minimum axial FWMH over the maximum axial FWHM; also referred to as Spherical Aberration). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setOpticalCalibrationImageRef_List(value)
Sets the list of OpticalCalibrationImageRef elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[OpticalCalibrationImageRef]
|
The new list of OpticalCalibrationImageRef elements |
required |
getOpticalCalibrationImageRef_List()
Returns the list of OpticalCalibrationImageRef elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[OpticalCalibrationImageRef]
|
The list of OpticalCalibrationImageRef elements |
addToOpticalCalibrationImageRef_List(value)
Adds a new OpticalCalibrationImageRef element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
OpticalCalibrationImageRef
|
The element to add |
required |
clearOpticalCalibrationImageRef_List()
Clear the list of OpticalCalibrationImageRef.
No description available in the XSD standard.
setPSFEquationFile_List(value)
Sets the list of PSFEquationFile elements.
This element refers to any type of file describing the PSF Equation that was used in this case.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[FileAnnotation_Type]
|
The new list of PSFEquationFile elements |
required |
getPSFEquationFile_List()
Returns the list of PSFEquationFile elements.
This element refers to any type of file describing the PSF Equation that was used in this case.
Returns:
| Type | Description |
|---|---|
List[FileAnnotation_Type]
|
The list of PSFEquationFile elements |
addToPSFEquationFile_List(value)
Adds a new PSFEquationFile element to this object.
This element refers to any type of file describing the PSF Equation that was used in this case.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
FileAnnotation_Type
|
The element to add |
required |
clearPSFEquationFile_List()
Clear the list of PSFEquationFile.
This element refers to any type of file describing the PSF Equation that was used in this case.
setOpticalCalibrationReport_List(value)
Sets the list of OpticalCalibrationReport 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 OpticalCalibrationReport elements |
required |
getOpticalCalibrationReport_List()
Returns the list of OpticalCalibrationReport 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 OpticalCalibrationReport elements |
addToOpticalCalibrationReport_List(value)
Adds a new OpticalCalibrationReport 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 |
clearOpticalCalibrationReport_List()
Clear the list of OpticalCalibrationReport.
This element refers to any File containing a report generated by the Calibration Software referred to in Calibration procedure.
setChromaticRegistrationEvaluation_List(value)
Sets the list of ChromaticRegistrationEvaluation elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[ChromaticRegistrationEvaluation]
|
The new list of ChromaticRegistrationEvaluation elements |
required |
getChromaticRegistrationEvaluation_List()
Returns the list of ChromaticRegistrationEvaluation elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[ChromaticRegistrationEvaluation]
|
The list of ChromaticRegistrationEvaluation elements |
addToChromaticRegistrationEvaluation_List(value)
Adds a new ChromaticRegistrationEvaluation element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
ChromaticRegistrationEvaluation
|
The element to add |
required |
clearChromaticRegistrationEvaluation_List()
Clear the list of ChromaticRegistrationEvaluation.
No description available in the XSD standard.
setFieldUniformityEvaluation_List(value)
Sets the list of FieldUniformityEvaluation elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[FieldUniformityEvaluation]
|
The new list of FieldUniformityEvaluation elements |
required |
getFieldUniformityEvaluation_List()
Returns the list of FieldUniformityEvaluation elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[FieldUniformityEvaluation]
|
The list of FieldUniformityEvaluation elements |
addToFieldUniformityEvaluation_List(value)
Adds a new FieldUniformityEvaluation element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
FieldUniformityEvaluation
|
The element to add |
required |
clearFieldUniformityEvaluation_List()
Clear the list of FieldUniformityEvaluation.
No description available in the XSD standard.
setOpticalCalibrationStandardGroup_List(value)
Sets the list of OpticalCalibrationStandardGroup elements.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[OpticalCalibrationStandard_Type]
|
The new list of OpticalCalibrationStandardGroup elements |
required |
getOpticalCalibrationStandardGroup_List()
Returns the list of OpticalCalibrationStandardGroup elements.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
List[OpticalCalibrationStandard_Type]
|
The list of OpticalCalibrationStandardGroup elements |
addToOpticalCalibrationStandardGroup_List(value)
Adds a new OpticalCalibrationStandardGroup element to this object.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
OpticalCalibrationStandard_Type
|
The element to add |
required |
clearOpticalCalibrationStandardGroup_List()
Clear the list of OpticalCalibrationStandardGroup.
No description available in the XSD standard.
setCalibrationSoftware_List(value)
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 |
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)
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 |
clearCalibrationSoftware_List()
Clear the list of CalibrationSoftware.
No description available in the XSD standard.
setAnnotationRef(value)
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
|
OpticalCalibration_InlineAnnotationRef
|
The value to set |
required |
getAnnotationRef()
Returns the value of the AnnotationRef element.
This is a simple multi-line comment or annotation describing this component.
Returns:
| Type | Description |
|---|---|
OpticalCalibration_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 |