com.inscoper.nbo.FieldUniformityEvaluation¶

Represents the XML element FieldUniformityEvaluation. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	FieldUniformityEvaluation()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setID(LSID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LSID_Type value) Sets the value of the ID attribute.
LSID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setMaxIntensityPixelXCoordinate(float value, boolean validate) Sets the value of the MaxIntensityPixelXCoordinate attribute.
void	setMaxIntensityPixelXCoordinate(float value) Sets the value of the MaxIntensityPixelXCoordinate attribute.
float	getMaxIntensityPixelXCoordinate() Returns the value of the MaxIntensityPixelXCoordinate attribute.
void	resetMaxIntensityPixelXCoordinate() Resets the MaxIntensityPixelXCoordinate attribute to an unset state.
boolean	hasMaxIntensityPixelXCoordinate() Checks whether the MaxIntensityPixelXCoordinate attribute is present.
void	setMaxIntensityPixelYCoordinate(float value, boolean validate) Sets the value of the MaxIntensityPixelYCoordinate attribute.
void	setMaxIntensityPixelYCoordinate(float value) Sets the value of the MaxIntensityPixelYCoordinate attribute.
float	getMaxIntensityPixelYCoordinate() Returns the value of the MaxIntensityPixelYCoordinate attribute.
void	resetMaxIntensityPixelYCoordinate() Resets the MaxIntensityPixelYCoordinate attribute to an unset state.
boolean	hasMaxIntensityPixelYCoordinate() Checks whether the MaxIntensityPixelYCoordinate attribute is present.
void	setMeanMaxtoCornerIntensityRatio(float value, boolean validate) Sets the value of the MeanMaxtoCornerIntensityRatio attribute.
void	setMeanMaxtoCornerIntensityRatio(float value) Sets the value of the MeanMaxtoCornerIntensityRatio attribute.
float	getMeanMaxtoCornerIntensityRatio() Returns the value of the MeanMaxtoCornerIntensityRatio attribute.
void	resetMeanMaxtoCornerIntensityRatio() Resets the MeanMaxtoCornerIntensityRatio attribute to an unset state.
boolean	hasMeanMaxtoCornerIntensityRatio() Checks whether the MeanMaxtoCornerIntensityRatio attribute is present.
void	setSDMaxtoCornerIntensityRatio(float value, boolean validate) Sets the value of the SDMaxtoCornerIntensityRatio attribute.
void	setSDMaxtoCornerIntensityRatio(float value) Sets the value of the SDMaxtoCornerIntensityRatio attribute.
float	getSDMaxtoCornerIntensityRatio() Returns the value of the SDMaxtoCornerIntensityRatio attribute.
void	resetSDMaxtoCornerIntensityRatio() Resets the SDMaxtoCornerIntensityRatio attribute to an unset state.
boolean	hasSDMaxtoCornerIntensityRatio() Checks whether the SDMaxtoCornerIntensityRatio attribute is present.
void	setFlatFieldImageRef_List(FlatFieldImageRefVector value, boolean validate) Sets the list of FlatFieldImageRef elements.
void	setFlatFieldImageRef_List(FlatFieldImageRefVector value) Sets the list of FlatFieldImageRef elements.
FlatFieldImageRefVector	getFlatFieldImageRef_List() Returns the list of FlatFieldImageRef elements.
void	addToFlatFieldImageRef_List(FlatFieldImageRef value, boolean validate) Adds a new FlatFieldImageRef element to this object.
void	addToFlatFieldImageRef_List(FlatFieldImageRef value) Adds a new FlatFieldImageRef element to this object.
void	clearFlatFieldImageRef_List() Clear the list of FlatFieldImageRef.
FieldUniformityEvaluation	__internal_create(long cPtr, boolean own)
FieldUniformityEvaluation	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a FieldUniformityEvaluation.

Protected Functions¶

	Name
	FieldUniformityEvaluation(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(FieldUniformityEvaluation obj)

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.FieldUniformityEvaluation;

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.

Public Functions Documentation¶

function delete¶

function FieldUniformityEvaluation¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonFile¶

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function toXmlString¶

function setID¶

public void setID(
    LSID_Type value,
    boolean validate
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A Unique Identifier for this component.

function setID¶

function getID¶

function resetID¶

function hasID¶

function setMaxIntensityPixelXCoordinate¶

public void setMaxIntensityPixelXCoordinate(
    float value,
    boolean validate
)

Sets the value of the MaxIntensityPixelXCoordinate attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setMaxIntensityPixelXCoordinate¶

public void setMaxIntensityPixelXCoordinate(
    float value
)

Sets the value of the MaxIntensityPixelXCoordinate attribute.

Parameters:

value The value to set

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.

function getMaxIntensityPixelXCoordinate¶

public float getMaxIntensityPixelXCoordinate()

Returns the value of the MaxIntensityPixelXCoordinate attribute.

Return: The value of the 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.

function resetMaxIntensityPixelXCoordinate¶

public void 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.

function hasMaxIntensityPixelXCoordinate¶

public boolean hasMaxIntensityPixelXCoordinate()

Checks whether the MaxIntensityPixelXCoordinate attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setMaxIntensityPixelYCoordinate¶

public void setMaxIntensityPixelYCoordinate(
    float value,
    boolean validate
)

Sets the value of the MaxIntensityPixelYCoordinate attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setMaxIntensityPixelYCoordinate¶

public void setMaxIntensityPixelYCoordinate(
    float value
)

Sets the value of the MaxIntensityPixelYCoordinate attribute.

Parameters:

value The value to set

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.

function getMaxIntensityPixelYCoordinate¶

public float getMaxIntensityPixelYCoordinate()

Returns the value of the MaxIntensityPixelYCoordinate attribute.

Return: The value of the 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.

function resetMaxIntensityPixelYCoordinate¶

public void 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.

function hasMaxIntensityPixelYCoordinate¶

public boolean hasMaxIntensityPixelYCoordinate()

Checks whether the MaxIntensityPixelYCoordinate attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setMeanMaxtoCornerIntensityRatio¶

public void setMeanMaxtoCornerIntensityRatio(
    float value,
    boolean validate
)

Sets the value of the MeanMaxtoCornerIntensityRatio attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setMeanMaxtoCornerIntensityRatio¶

public void setMeanMaxtoCornerIntensityRatio(
    float value
)

Sets the value of the MeanMaxtoCornerIntensityRatio attribute.

Parameters:

value The value to set

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.

function getMeanMaxtoCornerIntensityRatio¶

public float getMeanMaxtoCornerIntensityRatio()

Returns the value of the MeanMaxtoCornerIntensityRatio attribute.

Return: The value of the 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.

function resetMeanMaxtoCornerIntensityRatio¶

public void 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.

function hasMeanMaxtoCornerIntensityRatio¶

public boolean hasMeanMaxtoCornerIntensityRatio()

Checks whether the MeanMaxtoCornerIntensityRatio attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setSDMaxtoCornerIntensityRatio¶

public void setSDMaxtoCornerIntensityRatio(
    float value,
    boolean validate
)

Sets the value of the SDMaxtoCornerIntensityRatio attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setSDMaxtoCornerIntensityRatio¶

public void setSDMaxtoCornerIntensityRatio(
    float value
)

Sets the value of the SDMaxtoCornerIntensityRatio attribute.

Parameters:

value The value to set

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.

function getSDMaxtoCornerIntensityRatio¶

public float getSDMaxtoCornerIntensityRatio()

Returns the value of the SDMaxtoCornerIntensityRatio attribute.

Return: The value of the 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.

function resetSDMaxtoCornerIntensityRatio¶

public void 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.

function hasSDMaxtoCornerIntensityRatio¶

public boolean hasSDMaxtoCornerIntensityRatio()

Checks whether the SDMaxtoCornerIntensityRatio attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setFlatFieldImageRef_List¶

public void setFlatFieldImageRef_List(
    FlatFieldImageRefVector value,
    boolean validate
)

Sets the list of FlatFieldImageRef elements.

Parameters:

value The new list of FlatFieldImageRef elements
validate If true, validates constraints on value. Default is true.