Skip to content

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.

fromBase(base) staticmethod

getTypeName()

getXMLName()

getNBOType()

getChildren()

getSubElements()

fromJsonFile(path, validate=True)

fromJsonString(json_string, validate=True)

fromXmlFile(path, validate=True)

fromXmlString(xml_string, validate=True)

toXmlFile(filename, validate=True)

toXmlString(validate=True)

setID(value, validate=True)

getID()

resetID()

hasID()

setTheZ(value, validate=True)

getTheZ()

resetTheZ()

hasTheZ()

setTheT(value, validate=True)

getTheT()

resetTheT()

hasTheT()

setTheC(value, validate=True)

getTheC()

resetTheC()

hasTheC()

setTimestamp(value, validate=True)

getTimestamp()

resetTimestamp()

hasTimestamp()

setTimestampUnit(value, validate=True)

getTimestampUnit()

resetTimestampUnit()

hasTimestampUnit()

setExposureTime(value, validate=True)

getExposureTime()

resetExposureTime()

hasExposureTime()

setExposureTimeUnit(value, validate=True)

getExposureTimeUnit()

resetExposureTimeUnit()

hasExposureTimeUnit()

setPixelDwellTime(value, validate=True)

getPixelDwellTime()

resetPixelDwellTime()

hasPixelDwellTime()

setPixelDwellTimeUnit(value, validate=True)

getPixelDwellTimeUnit()

resetPixelDwellTimeUnit()

hasPixelDwellTimeUnit()

setPositionX(value, validate=True)

getPositionX()

resetPositionX()

hasPositionX()

setPositionXUnit(value, validate=True)

getPositionXUnit()

resetPositionXUnit()

hasPositionXUnit()

setPositionY(value, validate=True)

getPositionY()

resetPositionY()

hasPositionY()

setPositionYUnit(value, validate=True)

getPositionYUnit()

resetPositionYUnit()

hasPositionYUnit()

setPositionZ(value, validate=True)

getPositionZ()

resetPositionZ()

hasPositionZ()

setPositionZUnit(value, validate=True)

getPositionZUnit()

resetPositionZUnit()

hasPositionZUnit()

setPlaneXOffset(value, validate=True)

getPlaneXOffset()

resetPlaneXOffset()

hasPlaneXOffset()

setPlaneYOffset(value, validate=True)

getPlaneYOffset()

resetPlaneYOffset()

hasPlaneYOffset()

setPlaneZOffset(value, validate=True)

getPlaneZOffset()

resetPlaneZOffset()

hasPlaneZOffset()

setMechanicalCalibration_List(value, validate=True)

getMechanicalCalibration_List()

addToMechanicalCalibration_List(value, validate=True)

clearMechanicalCalibration_List()

setTheAdditionalDimensionRef_List(value, validate=True)

getTheAdditionalDimensionRef_List()

addToTheAdditionalDimensionRef_List(value, validate=True)

clearTheAdditionalDimensionRef_List()

setPlaneTransformationMatrix_List(value, validate=True)

getPlaneTransformationMatrix_List()

addToPlaneTransformationMatrix_List(value, validate=True)

clearPlaneTransformationMatrix_List()

setAnnotationRef_List(value, validate=True)

getAnnotationRef_List()

addToAnnotationRef_List(value, validate=True)

clearAnnotationRef_List()

setplane_choice(value, validate=True)

getplane_choice()

resetplane_choice()

hasplane_choice()