CalibrationStandardSlide

Bases: OpticalCalibrationStandard_Type

Represents the XML element CalibrationStandardSlide.

This element describes a Standard Calibration Slide (also referred to as Standard Test Slide) used for assessing the Optical properties of the Microscope that was used to acquire this experimental Image. These Slides can be used to measure multiple different Optical properties including resolution, chromatic registration, magnification, distance, and different kinds of optical distorsions.

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

setType(value)

Sets the value of the Type attribute.

The type of calibration slide used in this case. Examples include slides produced by Argolight, Geller MicroAnalytical Laboratory, PSFCheck, Zeiss and others.

Parameters:

Name	Type	Description	Default
value	CalibrationSlideType_Type	The value to set	required

getType()

Returns the value of the Type attribute.

The type of calibration slide used in this case. Examples include slides produced by Argolight, Geller MicroAnalytical Laboratory, PSFCheck, Zeiss and others.

Returns:

Type	Description
CalibrationSlideType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

The type of calibration slide used in this case. Examples include slides produced by Argolight, Geller MicroAnalytical Laboratory, PSFCheck, Zeiss and others.

hasType()

Checks whether the optional Type attribute is present.

The type of calibration slide used in this case. Examples include slides produced by Argolight, Geller MicroAnalytical Laboratory, PSFCheck, Zeiss and others.

Returns:

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

setCalibrationMeasure(value)

Sets the value of the CalibrationMeasure attribute.

This field captures the Optical characteristic this Slide is intended to calibrate, examples include Co-registration Accuracy, Detector linearity, Distance, Magnification, Optical distorsion, Resolution, or Multi.

Parameters:

Name	Type	Description	Default
value	CalibrationMeasure_Type	The value to set	required

getCalibrationMeasure()

Returns the value of the CalibrationMeasure attribute.

This field captures the Optical characteristic this Slide is intended to calibrate, examples include Co-registration Accuracy, Detector linearity, Distance, Magnification, Optical distorsion, Resolution, or Multi.

Returns:

Type	Description
CalibrationMeasure_Type	The value of the attribute

resetCalibrationMeasure()

Resets the CalibrationMeasure attribute to an unset state.

This field captures the Optical characteristic this Slide is intended to calibrate, examples include Co-registration Accuracy, Detector linearity, Distance, Magnification, Optical distorsion, Resolution, or Multi.

hasCalibrationMeasure()

Checks whether the optional CalibrationMeasure attribute is present.

This field captures the Optical characteristic this Slide is intended to calibrate, examples include Co-registration Accuracy, Detector linearity, Distance, Magnification, Optical distorsion, Resolution, or Multi.

Returns:

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

setImagedArea(value)

Sets the value of the ImagedArea attribute.

This field describes the specific region or sets or regions of the Calibration Slide that have been used for this Optical Calibration procedure.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getImagedArea()

Returns the value of the ImagedArea attribute.

This field describes the specific region or sets or regions of the Calibration Slide that have been used for this Optical Calibration procedure.

Returns:

Type	Description
string	The value of the attribute

resetImagedArea()

Resets the ImagedArea attribute to an unset state.

This field describes the specific region or sets or regions of the Calibration Slide that have been used for this Optical Calibration procedure.

hasImagedArea()

Checks whether the optional ImagedArea attribute is present.

This field describes the specific region or sets or regions of the Calibration Slide that have been used for this Optical Calibration procedure.

Returns:

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

setPatternImageRef(value)

Sets the value of the PatternImageRef element.

This is an empty element that refers to an Image depcting the pattern etched on this Calibration Slide.

Parameters:

Name	Type	Description	Default
value	CalibrationStandardSlide_InlinePatternImageRef	The value to set	required

getPatternImageRef()

Returns the value of the PatternImageRef element.

This is an empty element that refers to an Image depcting the pattern etched on this Calibration Slide.

Returns:

Type	Description
CalibrationStandardSlide_InlinePatternImageRef	The value of the element

resetPatternImageRef()

Resets the PatternImageRef element to an unset state.

This is an empty element that refers to an Image depcting the pattern etched on this Calibration Slide.

hasPatternImageRef()

Checks whether the optional PatternImageRef element is present.

This is an empty element that refers to an Image depcting the pattern etched on this Calibration Slide.

Returns:

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