Package org.dcm4che.typeddicom.dataelements

Class OverlayOrigin

  • All Implemented Interfaces:
    org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementMultiWrapper, SignedShortMultiWrapper
    public class OverlayOrigin
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements SignedShortMultiWrapper
    Name: Overlay Origin
    Keyword: OverlayOrigin
    Tag: (60xx,0050)
    Value Representation: SignedShort
    Value Multiplicity: 2
    • Described in the contexts: as follows:
      Attribute Name: Overlay Origin
      Type: 1
      Attribute Description:

      Location of first overlay point with respect to pixels in the image, given as row\column.

      The upper left pixel of the image has the coordinate 1\1.

      Column values greater than 1 indicate the overlay plane origin is to the right of the image origin. Row values greater than 1 indicate the overlay plane origin is below the image origin. Values less than 1 indicate the overlay plane origin is above or to the left of the image origin.

      Note

      Values of 0\0 indicate that the overlay pixels start 1 row above and one column to the left of the image pixels.


    • Constructor Summary

      Constructors 
      Constructor Description
      OverlayOrigin()
      Creates a new Overlay Origin object which wraps a new and empty Attributes object.
      OverlayOrigin​(org.dcm4che3.data.Attributes attributes)
      Creates a new Overlay Origin object which wraps the provided attributes.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      OverlayOrigin copy()
      Returns a new Overlay Origin which wraps a copy of the Attributes wrapped in this Overlay Origin.
      java.lang.String getPrivateCreator()  
      int getTag()  

      • Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

        equals, exists, getValue, hashCode, toString

      • Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

        getAttributes

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

        copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

      • Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

        getBytes, getSafeBytes, setBytes

      • Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

        exists, getValue

      • Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntDataElementMultiWrapper

        getInt, getInts, setInts

    • Constructor Detail

      • OverlayOrigin

        public OverlayOrigin​(org.dcm4che3.data.Attributes attributes)
        Creates a new Overlay Origin object which wraps the provided attributes.
        Parameters:
        attributes - the Attributes object to be wrapped.

      • OverlayOrigin

        public OverlayOrigin()
        Creates a new Overlay Origin object which wraps a new and empty Attributes object.

    • Method Detail

      • copy

        public OverlayOrigin copy()
        Returns a new Overlay Origin which wraps a copy of the Attributes wrapped in this Overlay Origin. (see Attributes(Attributes)
        Returns:
        a new Overlay Origin which wraps a copy of the Attributes wrapped in this Overlay Origin.

      • getPrivateCreator

        public java.lang.String getPrivateCreator()
        Specified by:
        getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

      • getTag

        public int getTag()
        Specified by:
        getTag in interface org.dcm4che.typeddicom.DataElementWrapper