Plane

Bases: NBOBaseClass

Represents the XML element Plane.

Each Image has to have at least one Plane and one Channel. The Plane element holds the Microscope stage and Image timing data for a given Channel/z-section/timepoint. The total number of Plane elements for a given Image must equal to SizeZ x SizeC x SizeT.

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

Parameters:

Name	Type	Description	Default
value	PlaneID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

A unique identifier for this Plane.

Returns:

Type	Description
PlaneID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A unique identifier for this Plane.

hasID()

Checks whether the optional ID attribute is present.

A unique identifier for this Plane.

Returns:

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

setTheZ(value)

Sets the value of the TheZ attribute.

This field records the Z-section to which this Plane corresponds. This is numbered from 0.

Parameters:

Name	Type	Description	Default
value	NonNegativeInt_Type	The value to set	required

getTheZ()

Returns the value of the TheZ attribute.

This field records the Z-section to which this Plane corresponds. This is numbered from 0.

Returns:

Type	Description
NonNegativeInt_Type	The value of the attribute

resetTheZ()

Resets the TheZ attribute to an unset state.

This field records the Z-section to which this Plane corresponds. This is numbered from 0.

hasTheZ()

Checks whether the optional TheZ attribute is present.

This field records the Z-section to which this Plane corresponds. This is numbered from 0.

Returns:

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

setTheT(value)

Sets the value of the TheT attribute.

This field records th Timepoint to which this Plane corresponds. This is numbered from 0.

Parameters:

Name	Type	Description	Default
value	NonNegativeInt_Type	The value to set	required

getTheT()

Returns the value of the TheT attribute.

This field records th Timepoint to which this Plane corresponds. This is numbered from 0.

Returns:

Type	Description
NonNegativeInt_Type	The value of the attribute

resetTheT()

Resets the TheT attribute to an unset state.

This field records th Timepoint to which this Plane corresponds. This is numbered from 0.

hasTheT()

Checks whether the optional TheT attribute is present.

This field records th Timepoint to which this Plane corresponds. This is numbered from 0.

Returns:

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

setTheC(value)

Sets the value of the TheC attribute.

This field records th Channel to which this Plane corresponds. This is numbered from 0.

Parameters:

Name	Type	Description	Default
value	NonNegativeInt_Type	The value to set	required

getTheC()

Returns the value of the TheC attribute.

This field records th Channel to which this Plane corresponds. This is numbered from 0.

Returns:

Type	Description
NonNegativeInt_Type	The value of the attribute

resetTheC()

Resets the TheC attribute to an unset state.

This field records th Channel to which this Plane corresponds. This is numbered from 0.

hasTheC()

Checks whether the optional TheC attribute is present.

This field records th Channel to which this Plane corresponds. This is numbered from 0.

Returns:

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

setTimestamp(value)

Sets the value of the Timestamp attribute.

This field records the time at which this Plane was acquired as recorded from the beginning of Image Acquisition.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getTimestamp()

Returns the value of the Timestamp attribute.

This field records the time at which this Plane was acquired as recorded from the beginning of Image Acquisition.

Returns:

Type	Description
float	The value of the attribute

setTimestampUnit(value)

Sets the value of the TimestampUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTime_Type	The value to set	required

getTimestampUnit()

Returns the value of the TimestampUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetTimestampUnit()

Resets the TimestampUnit attribute to an unset state.

No description available in the XSD standard.

hasTimestampUnit()

Checks whether the optional TimestampUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setExposureTime(value)

Sets the value of the ExposureTime attribute.

This field records the duration of the Exposure utilized to acquire this Plane.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getExposureTime()

Returns the value of the ExposureTime attribute.

This field records the duration of the Exposure utilized to acquire this Plane.

Returns:

Type	Description
float	The value of the attribute

resetExposureTime()

Resets the ExposureTime attribute to an unset state.

This field records the duration of the Exposure utilized to acquire this Plane.

hasExposureTime()

Checks whether the optional ExposureTime attribute is present.

This field records the duration of the Exposure utilized to acquire this Plane.

Returns:

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

setExposureTimeUnit(value)

Sets the value of the ExposureTimeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTime_Type	The value to set	required

getExposureTimeUnit()

Returns the value of the ExposureTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetExposureTimeUnit()

Resets the ExposureTimeUnit attribute to an unset state.

No description available in the XSD standard.

hasExposureTimeUnit()

Checks whether the optional ExposureTimeUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPixelDwellTime(value)

Sets the value of the PixelDwellTime attribute.

This value typically refers to the settings applied to the Confocal Scanner during Acquisition, and it assumes that Pixel Dwell Time was set uniformly throughout the Plane. The Pixel Dwell Time represents the time this Confocal Scanner was set to dwell upon each pixel during the acquisition of this Plane (e.g. 1.58 µsec/pixel). The higher the Pixel Dwell Time the slower is the scan speed, the higher the sensitivity but also the potential photobleaching.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getPixelDwellTime()

Returns the value of the PixelDwellTime attribute.

This value typically refers to the settings applied to the Confocal Scanner during Acquisition, and it assumes that Pixel Dwell Time was set uniformly throughout the Plane. The Pixel Dwell Time represents the time this Confocal Scanner was set to dwell upon each pixel during the acquisition of this Plane (e.g. 1.58 µsec/pixel). The higher the Pixel Dwell Time the slower is the scan speed, the higher the sensitivity but also the potential photobleaching.

Returns:

Type	Description
float	The value of the attribute

resetPixelDwellTime()

Resets the PixelDwellTime attribute to an unset state.

This value typically refers to the settings applied to the Confocal Scanner during Acquisition, and it assumes that Pixel Dwell Time was set uniformly throughout the Plane. The Pixel Dwell Time represents the time this Confocal Scanner was set to dwell upon each pixel during the acquisition of this Plane (e.g. 1.58 µsec/pixel). The higher the Pixel Dwell Time the slower is the scan speed, the higher the sensitivity but also the potential photobleaching.

hasPixelDwellTime()

Checks whether the optional PixelDwellTime attribute is present.

This value typically refers to the settings applied to the Confocal Scanner during Acquisition, and it assumes that Pixel Dwell Time was set uniformly throughout the Plane. The Pixel Dwell Time represents the time this Confocal Scanner was set to dwell upon each pixel during the acquisition of this Plane (e.g. 1.58 µsec/pixel). The higher the Pixel Dwell Time the slower is the scan speed, the higher the sensitivity but also the potential photobleaching.

Returns:

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

setPixelDwellTimeUnit(value)

Sets the value of the PixelDwellTimeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTime_Type	The value to set	required

getPixelDwellTimeUnit()

Returns the value of the PixelDwellTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetPixelDwellTimeUnit()

Resets the PixelDwellTimeUnit attribute to an unset state.

No description available in the XSD standard.

hasPixelDwellTimeUnit()

Checks whether the optional PixelDwellTimeUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPositionX(value)

Sets the value of the PositionX attribute.

This field records the X position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getPositionX()

Returns the value of the PositionX attribute.

This field records the X position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

Returns:

Type	Description
float	The value of the attribute

resetPositionX()

Resets the PositionX attribute to an unset state.

This field records the X position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

hasPositionX()

Checks whether the optional PositionX attribute is present.

This field records the X position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

Returns:

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

setPositionXUnit(value)

Sets the value of the PositionXUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getPositionXUnit()

Returns the value of the PositionXUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetPositionXUnit()

Resets the PositionXUnit attribute to an unset state.

No description available in the XSD standard.

hasPositionXUnit()

Checks whether the optional PositionXUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPositionY(value)

Sets the value of the PositionY attribute.

This field records the Y position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getPositionY()

Returns the value of the PositionY attribute.

This field records the Y position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

Returns:

Type	Description
float	The value of the attribute

resetPositionY()

Resets the PositionY attribute to an unset state.

This field records the Y position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

hasPositionY()

Checks whether the optional PositionY attribute is present.

This field records the Y position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

Returns:

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

setPositionYUnit(value)

Sets the value of the PositionYUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getPositionYUnit()

Returns the value of the PositionYUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetPositionYUnit()

Resets the PositionYUnit attribute to an unset state.

No description available in the XSD standard.

hasPositionYUnit()

Checks whether the optional PositionYUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPositionZ(value)

Sets the value of the PositionZ attribute.

This field records the Z position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getPositionZ()

Returns the value of the PositionZ attribute.

This field records the Z position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

Returns:

Type	Description
float	The value of the attribute

resetPositionZ()

Resets the PositionZ attribute to an unset state.

This field records the Z position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

hasPositionZ()

Checks whether the optional PositionZ attribute is present.

This field records the Z position of the Plane within the Microscope's reference frame. This value can typically be obtained by recording the Sample Positioning Device and Stage Insert coordinates.

Returns:

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

setPositionZUnit(value)

Sets the value of the PositionZUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getPositionZUnit()

Returns the value of the PositionZUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetPositionZUnit()

Resets the PositionZUnit attribute to an unset state.

No description available in the XSD standard.

hasPositionZUnit()

Checks whether the optional PositionZUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPlaneXOffset(value)

Sets the value of the PlaneXOffset attribute.

This field records the X offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getPlaneXOffset()

Returns the value of the PlaneXOffset attribute.

This field records the X offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

Returns:

Type	Description
float	The value of the attribute

resetPlaneXOffset()

Resets the PlaneXOffset attribute to an unset state.

This field records the X offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

hasPlaneXOffset()

Checks whether the optional PlaneXOffset attribute is present.

This field records the X offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

Returns:

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

setPlaneYOffset(value)

Sets the value of the PlaneYOffset attribute.

This field records the Y offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getPlaneYOffset()

Returns the value of the PlaneYOffset attribute.

This field records the Y offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

Returns:

Type	Description
float	The value of the attribute

resetPlaneYOffset()

Resets the PlaneYOffset attribute to an unset state.

This field records the Y offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

hasPlaneYOffset()

Checks whether the optional PlaneYOffset attribute is present.

This field records the Y offset (expressed in Pixels) that specifies the position of this Plane's center with respect to the center of the full frame.

Returns:

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

setPlaneZOffset(value)

Sets the value of the PlaneZOffset attribute.

This field describes the Z-offset imposed by the Focal Positioning device.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getPlaneZOffset()

Returns the value of the PlaneZOffset attribute.

This field describes the Z-offset imposed by the Focal Positioning device.

Returns:

Type	Description
float	The value of the attribute

resetPlaneZOffset()

Resets the PlaneZOffset attribute to an unset state.

This field describes the Z-offset imposed by the Focal Positioning device.

hasPlaneZOffset()

Checks whether the optional PlaneZOffset attribute is present.

This field describes the Z-offset imposed by the Focal Positioning device.

Returns:

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

setMechanicalCalibration_List(value)

Sets the list of MechanicalCalibration elements.

No description available in the XSD standard.

Parameters:

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

getMechanicalCalibration_List()

Returns the list of MechanicalCalibration elements.

No description available in the XSD standard.

Returns:

Type	Description
List[MechanicalCalibration]	The list of MechanicalCalibration elements

addToMechanicalCalibration_List(value)

Adds a new MechanicalCalibration element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	MechanicalCalibration	The element to add	required

clearMechanicalCalibration_List()

Clear the list of MechanicalCalibration.

No description available in the XSD standard.

setTheAdditionalDimensionRef_List(value)

Sets the list of TheAdditionalDimensionRef elements.

No description available in the XSD standard.

Parameters:

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

getTheAdditionalDimensionRef_List()

Returns the list of TheAdditionalDimensionRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[TheAdditionalDimensionRef]	The list of TheAdditionalDimensionRef elements

addToTheAdditionalDimensionRef_List(value)

Adds a new TheAdditionalDimensionRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	TheAdditionalDimensionRef	The element to add	required

clearTheAdditionalDimensionRef_List()

Clear the list of TheAdditionalDimensionRef.

No description available in the XSD standard.

setPlaneTransformationMatrix_List(value)

Sets the list of PlaneTransformationMatrix elements.

No description available in the XSD standard.

Parameters:

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

getPlaneTransformationMatrix_List()

Returns the list of PlaneTransformationMatrix elements.

No description available in the XSD standard.

Returns:

Type	Description
List[PlaneTransformationMatrix]	The list of PlaneTransformationMatrix elements

addToPlaneTransformationMatrix_List(value)

Adds a new PlaneTransformationMatrix element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	PlaneTransformationMatrix	The element to add	required

clearPlaneTransformationMatrix_List()

Clear the list of PlaneTransformationMatrix.

No description available in the XSD standard.

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.

setplane_choice(value)

Sets the value of the plane_choice element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	Plane_Choice	The value to set	required

getplane_choice()

Returns the value of the plane_choice element.

No description available in the XSD standard.

Returns:

Type	Description
Plane_Choice	The value of the element

resetplane_choice()

Resets the plane_choice element to an unset state.

No description available in the XSD standard.

hasplane_choice()

Checks whether the optional plane_choice element is present.

No description available in the XSD standard.

Returns:

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