Pixels

Bases: NBOBaseClass

Represents the XML element Pixels.

The Pixels element is going to be removed in the future, but it is still required. This is just notice that the contents of Pixels will be moved up to Image in a future release. This is because there has only been 1 Pixels object in each Image for some time. The concept of multiple Pixels sets for one Image failed to take off. It is therefore redundant. The Image will be unreadable if any of the required Pixel attributes are missing. The Pixels themselves can be stored within the OME-XML compressed by Plane, and encoded in Base64. Or the Pixels may be stored in TIFF format. The Pixels element should contain a list of BinData or TiffData, each containing a single Plane of pixels. These Pixels elements, when read in document order, must produce a 5-D Pixel array of the size specified in this element, and in the dimension order specified by 'DimensionOrder'. All of the values in the Pixels object when present should match the same value stored in any associated TIFF format (e.g. SizeX should be the same). Where there is a mismatch our readers will take the value from the TIFF structure as overriding the value in the OME-XML. This is simply a pragmatic decision as it increases the likelihood of reading data from a slightly incorrect file.

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()

setDimensionOrder(value, validate=True)

getDimensionOrder()

resetDimensionOrder()

hasDimensionOrder()

setSizeX(value, validate=True)

getSizeX()

resetSizeX()

hasSizeX()

setSizeY(value, validate=True)

getSizeY()

resetSizeY()

hasSizeY()

setSizeZ(value, validate=True)

getSizeZ()

resetSizeZ()

hasSizeZ()

setSizeC(value, validate=True)

getSizeC()

resetSizeC()

hasSizeC()

setSizeT(value, validate=True)

getSizeT()

resetSizeT()

hasSizeT()

setPhysicalSizeX(value, validate=True)

getPhysicalSizeX()

resetPhysicalSizeX()

hasPhysicalSizeX()

setPhysicalSizeXUnit(value, validate=True)

getPhysicalSizeXUnit()

resetPhysicalSizeXUnit()

hasPhysicalSizeXUnit()

setPhysicalSizeY(value, validate=True)

getPhysicalSizeY()

resetPhysicalSizeY()

hasPhysicalSizeY()

setPhysicalSizeYUnit(value, validate=True)

getPhysicalSizeYUnit()

resetPhysicalSizeYUnit()

hasPhysicalSizeYUnit()

setPhysicalSizeZ(value, validate=True)

getPhysicalSizeZ()

resetPhysicalSizeZ()

hasPhysicalSizeZ()

setPhysicalSizeZUnit(value, validate=True)

getPhysicalSizeZUnit()

resetPhysicalSizeZUnit()

hasPhysicalSizeZUnit()

setTimeIncrement(value, validate=True)

getTimeIncrement()

resetTimeIncrement()

hasTimeIncrement()

setTimeIncrementUnit(value, validate=True)

getTimeIncrementUnit()

resetTimeIncrementUnit()

hasTimeIncrementUnit()

setPixelType(value, validate=True)

getPixelType()

resetPixelType()

hasPixelType()

setInterleaved(value, validate=True)

getInterleaved()

resetInterleaved()

hasInterleaved()

setSignificantBits(value, validate=True)

getSignificantBits()

resetSignificantBits()

hasSignificantBits()

setBigEndian(value, validate=True)

getBigEndian()

resetBigEndian()

hasBigEndian()

setPlane_List(value, validate=True)

getPlane_List()

addToPlane_List(value, validate=True)

clearPlane_List()

setChannel_List(value, validate=True)

getChannel_List()

addToChannel_List(value, validate=True)

clearChannel_List()

setAdditionalDimensionMap(value, validate=True)

getAdditionalDimensionMap()

resetAdditionalDimensionMap()

hasAdditionalDimensionMap()

setpixels_choice(value, validate=True)

getpixels_choice()

resetpixels_choice()

haspixels_choice()