FieldUniformityEvaluation

Bases: NBOBaseClass

Represents the XML element FieldUniformityEvaluation.

This describes the procedure that was used to measure the Field dependent variations in the pixel-to-pixel sensitivity of the detector and/or by distortions in the optical path.

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

setMaxIntensityPixelXCoordinate(value, validate=True)

Sets the value of the MaxIntensityPixelXCoordinate attribute.

This field reports the x-axis coordinate of the Pixel that has the Maximum Intensity in the Image used for this Flat Field Calibration procedure.

Parameters:

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

getMaxIntensityPixelXCoordinate()

Returns the value of the MaxIntensityPixelXCoordinate attribute.

This field reports the x-axis coordinate of the Pixel that has the Maximum Intensity in the Image used for this Flat Field Calibration procedure.

Returns:

Type	Description
float	The value of the attribute

resetMaxIntensityPixelXCoordinate()

Resets the MaxIntensityPixelXCoordinate attribute to an unset state.

This field reports the x-axis coordinate of the Pixel that has the Maximum Intensity in the Image used for this Flat Field Calibration procedure.

hasMaxIntensityPixelXCoordinate()

Checks whether the MaxIntensityPixelXCoordinate attribute is present.

This field reports the x-axis coordinate of the Pixel that has the Maximum Intensity in the Image used for this Flat Field Calibration procedure.

Returns:

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

setMaxIntensityPixelYCoordinate(value, validate=True)

Sets the value of the MaxIntensityPixelYCoordinate attribute.

This field reports the y-axis coordinate of the Pixel that has the Maximum Intensity in the Image used for this Flat Field Calibration procedure.

Parameters:

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

getMaxIntensityPixelYCoordinate()

Returns the value of the MaxIntensityPixelYCoordinate attribute.

This field reports the y-axis coordinate of the Pixel that has the Maximum Intensity in the Image used for this Flat Field Calibration procedure.

Returns:

Type	Description
float	The value of the attribute

resetMaxIntensityPixelYCoordinate()

Resets the MaxIntensityPixelYCoordinate attribute to an unset state.

This field reports the y-axis coordinate of the Pixel that has the Maximum Intensity in the Image used for this Flat Field Calibration procedure.

hasMaxIntensityPixelYCoordinate()

Checks whether the MaxIntensityPixelYCoordinate attribute is present.

This field reports the y-axis coordinate of the Pixel that has the Maximum Intensity in the Image used for this Flat Field Calibration procedure.

Returns:

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

setMeanMaxtoCornerIntensityRatio(value, validate=True)

Sets the value of the MeanMaxtoCornerIntensityRatio attribute.

This field reports the Mean between the Ratios obtained by comparing the Maximum Pixel Intensity and the Intensities of the four corner Pixels of the Image used for this Flat Field Calibration procedure.

Parameters:

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

getMeanMaxtoCornerIntensityRatio()

Returns the value of the MeanMaxtoCornerIntensityRatio attribute.

This field reports the Mean between the Ratios obtained by comparing the Maximum Pixel Intensity and the Intensities of the four corner Pixels of the Image used for this Flat Field Calibration procedure.

Returns:

Type	Description
float	The value of the attribute

resetMeanMaxtoCornerIntensityRatio()

Resets the MeanMaxtoCornerIntensityRatio attribute to an unset state.

This field reports the Mean between the Ratios obtained by comparing the Maximum Pixel Intensity and the Intensities of the four corner Pixels of the Image used for this Flat Field Calibration procedure.

hasMeanMaxtoCornerIntensityRatio()

Checks whether the MeanMaxtoCornerIntensityRatio attribute is present.

This field reports the Mean between the Ratios obtained by comparing the Maximum Pixel Intensity and the Intensities of the four corner Pixels of the Image used for this Flat Field Calibration procedure.

Returns:

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

setSDMaxtoCornerIntensityRatio(value, validate=True)

Sets the value of the SDMaxtoCornerIntensityRatio attribute.

This field reports the Standard Deviation between the Ratios obtained by comparing the Maximum Pixel Intensity and the Intensities of the four corner Pixels of the Image used for this Flat Field Calibration procedure.

Parameters:

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

getSDMaxtoCornerIntensityRatio()

Returns the value of the SDMaxtoCornerIntensityRatio attribute.

This field reports the Standard Deviation between the Ratios obtained by comparing the Maximum Pixel Intensity and the Intensities of the four corner Pixels of the Image used for this Flat Field Calibration procedure.

Returns:

Type	Description
float	The value of the attribute

resetSDMaxtoCornerIntensityRatio()

Resets the SDMaxtoCornerIntensityRatio attribute to an unset state.

This field reports the Standard Deviation between the Ratios obtained by comparing the Maximum Pixel Intensity and the Intensities of the four corner Pixels of the Image used for this Flat Field Calibration procedure.

hasSDMaxtoCornerIntensityRatio()

Checks whether the SDMaxtoCornerIntensityRatio attribute is present.

This field reports the Standard Deviation between the Ratios obtained by comparing the Maximum Pixel Intensity and the Intensities of the four corner Pixels of the Image used for this Flat Field Calibration procedure.

Returns:

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

setFlatFieldImageRef_List(value, validate=True)

Sets the list of FlatFieldImageRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[FlatFieldImageRef]	The new list of FlatFieldImageRef elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getFlatFieldImageRef_List()

Returns the list of FlatFieldImageRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[FlatFieldImageRef]	The list of FlatFieldImageRef elements

addToFlatFieldImageRef_List(value, validate=True)

Adds a new FlatFieldImageRef element to this object.

No description available in the XSD standard.

Parameters:

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

clearFlatFieldImageRef_List()

Clear the list of FlatFieldImageRef.

No description available in the XSD standard.