Package ome.xml.model

Class Pixels

All Implemented Interfaces:
OMEModelObject

public class Pixels extends AbstractOMEModelObject
  • Field Details

  • Constructor Details

    • Pixels

      public Pixels()
      Default constructor.
    • Pixels

      public Pixels(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 Details

    • update

      public void update(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 String getID()
    • setID

      public void setID(String id)
    • getDimensionOrder

      public DimensionOrder getDimensionOrder()
    • setDimensionOrder

      public void setDimensionOrder(DimensionOrder dimensionOrder)
    • getType

      public PixelType getType()
    • setType

      public void setType(PixelType type)
    • getSignificantBits

      public PositiveInteger getSignificantBits()
    • setSignificantBits

      public void setSignificantBits(PositiveInteger significantBits)
    • getInterleaved

      public Boolean getInterleaved()
    • setInterleaved

      public void setInterleaved(Boolean interleaved)
    • getBigEndian

      public Boolean getBigEndian()
    • setBigEndian

      public void setBigEndian(Boolean bigEndian)
    • getSizeX

      public PositiveInteger getSizeX()
    • setSizeX

      public void setSizeX(PositiveInteger sizeX)
    • getSizeY

      public PositiveInteger getSizeY()
    • setSizeY

      public void setSizeY(PositiveInteger sizeY)
    • getSizeZ

      public PositiveInteger getSizeZ()
    • setSizeZ

      public void setSizeZ(PositiveInteger sizeZ)
    • getSizeC

      public PositiveInteger getSizeC()
    • setSizeC

      public void setSizeC(PositiveInteger sizeC)
    • getSizeT

      public PositiveInteger getSizeT()
    • setSizeT

      public void setSizeT(PositiveInteger sizeT)
    • getPhysicalSizeX

      public Length getPhysicalSizeX()
    • setPhysicalSizeX

      public void setPhysicalSizeX(Length physicalSizeX)
    • getPhysicalSizeXUnitXsdDefault

      public static String getPhysicalSizeXUnitXsdDefault()
    • getPhysicalSizeY

      public Length getPhysicalSizeY()
    • setPhysicalSizeY

      public void setPhysicalSizeY(Length physicalSizeY)
    • getPhysicalSizeYUnitXsdDefault

      public static String getPhysicalSizeYUnitXsdDefault()
    • getPhysicalSizeZ

      public Length getPhysicalSizeZ()
    • setPhysicalSizeZ

      public void setPhysicalSizeZ(Length physicalSizeZ)
    • getPhysicalSizeZUnitXsdDefault

      public static String getPhysicalSizeZUnitXsdDefault()
    • getTimeIncrement

      public Time getTimeIncrement()
    • setTimeIncrement

      public void setTimeIncrement(Time timeIncrement)
    • getTimeIncrementUnitXsdDefault

      public static String getTimeIncrementUnitXsdDefault()
    • sizeOfChannelList

      public int sizeOfChannelList()
    • copyChannelList

      public List<Channel> copyChannelList()
    • clearChannelList

      public void clearChannelList()
    • 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 List<BinData> copyBinDataList()
    • clearBinDataList

      public void clearBinDataList()
    • 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 List<TiffData> copyTiffDataList()
    • clearTiffDataList

      public void clearTiffDataList()
    • getTiffData

      public TiffData getTiffData(int index)
    • setTiffData

      public TiffData setTiffData(int index, TiffData tiffData)
    • addTiffData

      public void addTiffData(TiffData tiffData)
    • removeTiffData

      public void removeTiffData(TiffData tiffData)
    • getMetadataOnly

      public MetadataOnly getMetadataOnly()
    • setMetadataOnly

      public void setMetadataOnly(MetadataOnly metadataOnly)
    • sizeOfPlaneList

      public int sizeOfPlaneList()
    • copyPlaneList

      public List<Plane> copyPlaneList()
    • clearPlaneList

      public void clearPlaneList()
    • 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 Element asXMLElement(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 Element asXMLElement(Document document, 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.