Package ome.xml.model

Class Pixels

    • Constructor Detail

      • Pixels

        public Pixels()
        Default constructor.

      • Pixels

        public Pixels​(org.w3c.dom.Element element,
              OMEModel model)
       throws EnumerationException
        Constructs Pixels recursively from an XML DOM tree.
        Parameters:
        element - Root of the XML DOM tree to construct a model object graph from.
        model - Handler for the OME model which keeps track of instances and references seen during object population.
        Throws:
        EnumerationException - If there is an error instantiating an enumeration during model object creation.

      • Pixels

        public Pixels​(Pixels orig)
        Copy constructor.

    • Method Detail

      • update

        public void update​(org.w3c.dom.Element element,
                   OMEModel model)
            throws EnumerationException
        Updates Pixels recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.
        Specified by:
        update in interface OMEModelObject
        Overrides:
        update in class AbstractOMEModelObject
        Parameters:
        element - Root of the XML DOM tree to construct a model object graph from.
        model - Handler for the OME model which keeps track of instances and references seen during object population.
        Throws:
        EnumerationException - If there is an error instantiating an enumeration during model object creation.

      • link

        public boolean link​(Reference reference,
                    OMEModelObject o)
        Description copied from interface: OMEModelObject
        Link a given OME model object to this model object.
        Specified by:
        link in interface OMEModelObject
        Overrides:
        link in class AbstractOMEModelObject
        Parameters:
        reference - The type qualifier for the reference. This should be the corresponding reference type for o. If, for example, o is of type Image, reference MUST be of type ImageRef.
        o - Model object to link to.
        Returns:
        true if this model object was able to handle the reference, false otherwise.

      • getID

        public java.lang.String getID()

      • setID

        public void setID​(java.lang.String id)

      • setDimensionOrder

        public void setDimensionOrder​(DimensionOrder dimensionOrder)

      • setType

        public void setType​(PixelType type)

      • setSignificantBits

        public void setSignificantBits​(PositiveInteger significantBits)

      • getInterleaved

        public java.lang.Boolean getInterleaved()

      • setInterleaved

        public void setInterleaved​(java.lang.Boolean interleaved)

      • getBigEndian

        public java.lang.Boolean getBigEndian()

      • setBigEndian

        public void setBigEndian​(java.lang.Boolean bigEndian)

      • getPhysicalSizeX

        public Length getPhysicalSizeX()

      • setPhysicalSizeX

        public void setPhysicalSizeX​(Length physicalSizeX)

      • getPhysicalSizeXUnitXsdDefault

        public static java.lang.String getPhysicalSizeXUnitXsdDefault()

      • getPhysicalSizeY

        public Length getPhysicalSizeY()

      • setPhysicalSizeY

        public void setPhysicalSizeY​(Length physicalSizeY)

      • getPhysicalSizeYUnitXsdDefault

        public static java.lang.String getPhysicalSizeYUnitXsdDefault()

      • getPhysicalSizeZ

        public Length getPhysicalSizeZ()

      • setPhysicalSizeZ

        public void setPhysicalSizeZ​(Length physicalSizeZ)

      • getPhysicalSizeZUnitXsdDefault

        public static java.lang.String getPhysicalSizeZUnitXsdDefault()

      • getTimeIncrement

        public Time getTimeIncrement()

      • setTimeIncrement

        public void setTimeIncrement​(Time timeIncrement)

      • getTimeIncrementUnitXsdDefault

        public static java.lang.String getTimeIncrementUnitXsdDefault()

      • sizeOfChannelList

        public int sizeOfChannelList()

      • copyChannelList

        public java.util.List<Channel> copyChannelList()

      • getChannel

        public Channel getChannel​(int index)

      • setChannel

        public Channel setChannel​(int index,
                          Channel channel)

      • addChannel

        public void addChannel​(Channel channel)

      • removeChannel

        public void removeChannel​(Channel channel)

      • sizeOfBinDataList

        public int sizeOfBinDataList()

      • copyBinDataList

        public java.util.List<BinData> copyBinDataList()

      • getBinData

        public BinData getBinData​(int index)

      • setBinData

        public BinData setBinData​(int index,
                          BinData binData)

      • addBinData

        public void addBinData​(BinData binData)

      • removeBinData

        public void removeBinData​(BinData binData)

      • sizeOfTiffDataList

        public int sizeOfTiffDataList()

      • copyTiffDataList

        public java.util.List<TiffData> copyTiffDataList()

      • getTiffData

        public TiffData getTiffData​(int index)

      • addTiffData

        public void addTiffData​(TiffData tiffData)

      • removeTiffData

        public void removeTiffData​(TiffData tiffData)

      • setMetadataOnly

        public void setMetadataOnly​(MetadataOnly metadataOnly)

      • sizeOfPlaneList

        public int sizeOfPlaneList()

      • copyPlaneList

        public java.util.List<Plane> copyPlaneList()

      • getPlane

        public Plane getPlane​(int index)

      • setPlane

        public Plane setPlane​(int index,
                      Plane plane)

      • addPlane

        public void addPlane​(Plane plane)

      • removePlane

        public void removePlane​(Plane plane)

      • asXMLElement

        public org.w3c.dom.Element asXMLElement​(org.w3c.dom.Document document)
        Description copied from interface: OMEModelObject
        Takes the entire object hierarchy and produces an XML DOM tree.
        Specified by:
        asXMLElement in interface OMEModelObject
        Specified by:
        asXMLElement in class AbstractOMEModelObject
        Parameters:
        document - Destination document for element creation, etc.
        Returns:
        XML DOM tree root element for this model object.

      • asXMLElement

        public org.w3c.dom.Element asXMLElement​(org.w3c.dom.Document document,
                                        org.w3c.dom.Element Pixels_element)
        Description copied from class: AbstractOMEModelObject
        Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
        Overrides:
        asXMLElement in class AbstractOMEModelObject
        Parameters:
        document - Destination document for element creation, etc.
        Pixels_element - Element from the subclass. If null a new element will be created of this class.
        Returns:
        element populated with properties from this class.