Image

Bases: NBOBaseClass

Represents the XML element Image.

This element describes the actual Image that was acquired and its meta-data. The elements that are references (ending in Ref or Settings) refer to elements defined outside of the Image element. Ref elements are simple links, while Settings elements are links with additional values. If any of the required Image attributes or elements are missing, its guaranteed to be an invalid document.

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 Image.

Parameters:

Name	Type	Description	Default
value	ImageID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

A unique identifier for this Image.

Returns:

Type	Description
ImageID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A unique identifier for this Image.

hasID()

Checks whether the optional ID attribute is present.

A unique identifier for this Image.

Returns:

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

setName(value)

Sets the value of the Name attribute.

A user assigned name for this Image.

Parameters:

Name	Type	Description	Default
value	Denomination_Type	The value to set	required

getName()

Returns the value of the Name attribute.

A user assigned name for this Image.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A user assigned name for this Image.

hasName()

Checks whether the optional Name attribute is present.

A user assigned name for this Image.

Returns:

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

setAcquisitionDate(value)

Sets the value of the AcquisitionDate attribute.

The Date in which this Image was Acquired.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getAcquisitionDate()

Returns the value of the AcquisitionDate attribute.

The Date in which this Image was Acquired.

Returns:

Type	Description
string	The value of the attribute

resetAcquisitionDate()

Resets the AcquisitionDate attribute to an unset state.

The Date in which this Image was Acquired.

hasAcquisitionDate()

Checks whether the optional AcquisitionDate attribute is present.

The Date in which this Image was Acquired.

Returns:

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

setInstrumentRef(value)

Sets the value of the InstrumentRef element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	InstrumentRef	The value to set	required

getInstrumentRef()

Returns the value of the InstrumentRef element.

No description available in the XSD standard.

Returns:

Type	Description
InstrumentRef	The value of the element

resetInstrumentRef()

Resets the InstrumentRef element to an unset state.

No description available in the XSD standard.

hasInstrumentRef()

Checks whether the optional InstrumentRef element is present.

No description available in the XSD standard.

Returns:

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

setExperimentRef(value)

Sets the value of the ExperimentRef element.

This empty element refers to the Experiment during which this Image was acquired.

Parameters:

Name	Type	Description	Default
value	ExperimentRef	The value to set	required

getExperimentRef()

Returns the value of the ExperimentRef element.

This empty element refers to the Experiment during which this Image was acquired.

Returns:

Type	Description
ExperimentRef	The value of the element

resetExperimentRef()

Resets the ExperimentRef element to an unset state.

This empty element refers to the Experiment during which this Image was acquired.

hasExperimentRef()

Checks whether the optional ExperimentRef element is present.

This empty element refers to the Experiment during which this Image was acquired.

Returns:

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

setExperimenterRef_List(value)

Sets the list of ExperimenterRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[ExperimenterRef]	The new list of ExperimenterRef elements	required

getExperimenterRef_List()

Returns the list of ExperimenterRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[ExperimenterRef]	The list of ExperimenterRef elements

addToExperimenterRef_List(value)

Adds a new ExperimenterRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ExperimenterRef	The element to add	required

clearExperimenterRef_List()

Clear the list of ExperimenterRef.

No description available in the XSD standard.

setSampleRef_List(value)

Sets the list of SampleRef elements.

This empty element refers to the Sample that was imaged in this Image Acquisition.

Parameters:

Name	Type	Description	Default
value	List[SampleRef]	The new list of SampleRef elements	required

getSampleRef_List()

Returns the list of SampleRef elements.

This empty element refers to the Sample that was imaged in this Image Acquisition.

Returns:

Type	Description
List[SampleRef]	The list of SampleRef elements

addToSampleRef_List(value)

Adds a new SampleRef element to this object.

This empty element refers to the Sample that was imaged in this Image Acquisition.

Parameters:

Name	Type	Description	Default
value	SampleRef	The element to add	required

clearSampleRef_List()

Clear the list of SampleRef.

This empty element refers to the Sample that was imaged in this Image Acquisition.

setExperimenterGroupRef_List(value)

Sets the list of ExperimenterGroupRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[ExperimenterGroupRef]	The new list of ExperimenterGroupRef elements	required

getExperimenterGroupRef_List()

Returns the list of ExperimenterGroupRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[ExperimenterGroupRef]	The list of ExperimenterGroupRef elements

addToExperimenterGroupRef_List(value)

Adds a new ExperimenterGroupRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ExperimenterGroupRef	The element to add	required

clearExperimenterGroupRef_List()

Clear the list of ExperimenterGroupRef.

No description available in the XSD standard.

setROIRef_List(value)

Sets the list of ROIRef elements.

This empty element refers to any predefined four dimensional ROI (Region of Interest) that is associated with this Image.

Parameters:

Name	Type	Description	Default
value	List[ROIRef]	The new list of ROIRef elements	required

getROIRef_List()

Returns the list of ROIRef elements.

This empty element refers to any predefined four dimensional ROI (Region of Interest) that is associated with this Image.

Returns:

Type	Description
List[ROIRef]	The list of ROIRef elements

addToROIRef_List(value)

Adds a new ROIRef element to this object.

This empty element refers to any predefined four dimensional ROI (Region of Interest) that is associated with this Image.

Parameters:

Name	Type	Description	Default
value	ROIRef	The element to add	required

clearROIRef_List()

Clear the list of ROIRef.

This empty element refers to any predefined four dimensional ROI (Region of Interest) that is associated with this Image.

setStageInsertRef_List(value)

Sets the list of StageInsertRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[StageInsertRef]	The new list of StageInsertRef elements	required

getStageInsertRef_List()

Returns the list of StageInsertRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[StageInsertRef]	The list of StageInsertRef elements

addToStageInsertRef_List(value)

Adds a new StageInsertRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	StageInsertRef	The element to add	required

clearStageInsertRef_List()

Clear the list of StageInsertRef.

No description available in the XSD standard.

setFocusStabilizationDeviceRef_List(value)

Sets the list of FocusStabilizationDeviceRef elements.

This empty element refers to the optional Focus Stabilization device that was used for the Acquisition of this Image.

Parameters:

Name	Type	Description	Default
value	List[FocusStabilizationDeviceRef]	The new list of FocusStabilizationDeviceRef elements	required

getFocusStabilizationDeviceRef_List()

Returns the list of FocusStabilizationDeviceRef elements.

This empty element refers to the optional Focus Stabilization device that was used for the Acquisition of this Image.

Returns:

Type	Description
List[FocusStabilizationDeviceRef]	The list of FocusStabilizationDeviceRef elements

addToFocusStabilizationDeviceRef_List(value)

Adds a new FocusStabilizationDeviceRef element to this object.

This empty element refers to the optional Focus Stabilization device that was used for the Acquisition of this Image.

Parameters:

Name	Type	Description	Default
value	FocusStabilizationDeviceRef	The element to add	required

clearFocusStabilizationDeviceRef_List()

Clear the list of FocusStabilizationDeviceRef.

This empty element refers to the optional Focus Stabilization device that was used for the Acquisition of this Image.

setAcquisitionSoftwareRef_List(value)

Sets the list of AcquisitionSoftwareRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[AcquisitionSoftwareRef]	The new list of AcquisitionSoftwareRef elements	required

getAcquisitionSoftwareRef_List()

Returns the list of AcquisitionSoftwareRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[AcquisitionSoftwareRef]	The list of AcquisitionSoftwareRef elements

addToAcquisitionSoftwareRef_List(value)

Adds a new AcquisitionSoftwareRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	AcquisitionSoftwareRef	The element to add	required

clearAcquisitionSoftwareRef_List()

Clear the list of AcquisitionSoftwareRef.

No description available in the XSD standard.

setDescription(value)

Sets the value of the Description element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	Description	The value to set	required

getDescription()

Returns the value of the Description element.

No description available in the XSD standard.

Returns:

Type	Description
Description	The value of the element

resetDescription()

Resets the Description element to an unset state.

No description available in the XSD standard.

hasDescription()

Checks whether the optional Description element is present.

No description available in the XSD standard.

Returns:

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

setImagingEnvironment_List(value)

Sets the list of ImagingEnvironment elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[ImagingEnvironmen]	The new list of ImagingEnvironment elements	required

getImagingEnvironment_List()

Returns the list of ImagingEnvironment elements.

No description available in the XSD standard.

Returns:

Type	Description
List[ImagingEnvironmen]	The list of ImagingEnvironment elements

addToImagingEnvironment_List(value)

Adds a new ImagingEnvironment element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ImagingEnvironment	The element to add	required

clearImagingEnvironment_List()

Clear the list of ImagingEnvironment.

No description available in the XSD standard.

setMicroscopeStandSettings(value)

Sets the value of the MicroscopeStandSettings element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	MicroscopeStandSettings	The value to set	required

getMicroscopeStandSettings()

Returns the value of the MicroscopeStandSettings element.

No description available in the XSD standard.

Returns:

Type	Description
MicroscopeStandSettings	The value of the element

resetMicroscopeStandSettings()

Resets the MicroscopeStandSettings element to an unset state.

No description available in the XSD standard.

hasMicroscopeStandSettings()

Checks whether the optional MicroscopeStandSettings element is present.

No description available in the XSD standard.

Returns:

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

setMicroscopeTableSettings_List(value)

Sets the list of MicroscopeTableSettings elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[MicroscopeTableSettings]	The new list of MicroscopeTableSettings elements	required

getMicroscopeTableSettings_List()

Returns the list of MicroscopeTableSettings elements.

No description available in the XSD standard.

Returns:

Type	Description
List[MicroscopeTableSettings]	The list of MicroscopeTableSettings elements

addToMicroscopeTableSettings_List(value)

Adds a new MicroscopeTableSettings element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	MicroscopeTableSettings	The element to add	required

clearMicroscopeTableSettings_List()

Clear the list of MicroscopeTableSettings.

No description available in the XSD standard.

setObjectiveSettings(value)

Sets the value of the ObjectiveSettings element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ObjectiveSettings	The value to set	required

getObjectiveSettings()

Returns the value of the ObjectiveSettings element.

No description available in the XSD standard.

Returns:

Type	Description
ObjectiveSettings	The value of the element

resetObjectiveSettings()

Resets the ObjectiveSettings element to an unset state.

No description available in the XSD standard.

hasObjectiveSettings()

Checks whether the optional ObjectiveSettings element is present.

No description available in the XSD standard.

Returns:

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

setStageLabel_List(value)

Sets the list of StageLabel elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[StageLabel]	The new list of StageLabel elements	required

getStageLabel_List()

Returns the list of StageLabel elements.

No description available in the XSD standard.

Returns:

Type	Description
List[StageLabel]	The list of StageLabel elements

addToStageLabel_List(value)

Adds a new StageLabel element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	StageLabel	The element to add	required

clearStageLabel_List()

Clear the list of StageLabel.

No description available in the XSD standard.

setSamplePositioningSettings_List(value)

Sets the list of SamplePositioningSettings elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[SamplePositioningSettings]	The new list of SamplePositioningSettings elements	required

getSamplePositioningSettings_List()

Returns the list of SamplePositioningSettings elements.

No description available in the XSD standard.

Returns:

Type	Description
List[SamplePositioningSettings]	The list of SamplePositioningSettings elements

addToSamplePositioningSettings_List(value)

Adds a new SamplePositioningSettings element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	SamplePositioningSettings	The element to add	required

clearSamplePositioningSettings_List()

Clear the list of SamplePositioningSettings.

No description available in the XSD standard.

setOpticalCalibration_List(value)

Sets the list of OpticalCalibration elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[OpticalCalibration]	The new list of OpticalCalibration elements	required

getOpticalCalibration_List()

Returns the list of OpticalCalibration elements.

No description available in the XSD standard.

Returns:

Type	Description
List[OpticalCalibration]	The list of OpticalCalibration elements

addToOpticalCalibration_List(value)

Adds a new OpticalCalibration element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	OpticalCalibration	The element to add	required

clearOpticalCalibration_List()

Clear the list of OpticalCalibration.

No description available in the XSD standard.

setDetectorCalibration_List(value)

Sets the list of DetectorCalibration elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[DetectorCalibration]	The new list of DetectorCalibration elements	required

getDetectorCalibration_List()

Returns the list of DetectorCalibration elements.

No description available in the XSD standard.

Returns:

Type	Description
List[DetectorCalibration]	The list of DetectorCalibration elements

addToDetectorCalibration_List(value)

Adds a new DetectorCalibration element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	DetectorCalibration	The element to add	required

clearDetectorCalibration_List()

Clear the list of DetectorCalibration.

No description available in the XSD standard.

setPixels(value)

Sets the value of the Pixels element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	Pixels	The value to set	required

getPixels()

Returns the value of the Pixels element.

No description available in the XSD standard.

Returns:

Type	Description
Pixels	The value of the element

resetPixels()

Resets the Pixels element to an unset state.

No description available in the XSD standard.

hasPixels()

Checks whether the optional Pixels element is present.

No description available in the XSD standard.

Returns:

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

setAnnotationRef_List(value)

Sets the list of AnnotationRef elements.

This is a simple multi-line comment or annotation describing this component.

Parameters:

Name	Type	Description	Default
value	List[AnnotationRef]	The new list of AnnotationRef elements	required

getAnnotationRef_List()

Returns the list of AnnotationRef elements.

This is a simple multi-line comment or annotation describing this component.

Returns:

Type	Description
List[AnnotationRef]	The list of AnnotationRef elements

addToAnnotationRef_List(value)

Adds a new AnnotationRef element to this object.

This is a simple multi-line comment or annotation describing this component.

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The element to add	required

clearAnnotationRef_List()

Clear the list of AnnotationRef.

This is a simple multi-line comment or annotation describing this component.