Package org.dcm4che.typeddicom.dataelements

Class PixelPaddingValueAsUS

  • All Implemented Interfaces:
    org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, UnsignedShortWrapper
    public class PixelPaddingValueAsUS
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements UnsignedShortWrapper
    Name: Pixel Padding Value
    Keyword: PixelPaddingValueAsUS
    Tag: (0028,0120)
    Value Representation: UnsignedShort
    Value Multiplicity: 1
    • Described in the contexts: as follows:
      Attribute Name: Pixel Padding Value
      Type: 1C
      Attribute Description:

      Single pixel value or one limit (inclusive) of a range of pixel values used in an image to pad to rectangular format or to signal background that may be suppressed or that may be rendered "transparently" when superimposing images. See DICOM Standard Part 3 - Section C.7.5.1.1.2 for further explanation.

      Required if Pixel Padding Range Limit (0028,0121) is present and either Pixel Data (7FE0,0010) or Pixel Data Provider URL (0028,7FE0) is present. May be present otherwise only if Pixel Data (7FE0,0010) or Pixel Data Provider URL (0028,7FE0) is present.

      Note

      1. The Value Representation of this Attribute is determined by the value of Pixel Representation (0028,0103).

      2. This Attribute is not used in Presentation State Instances; there is no means in a Presentation State to "override" any Pixel Padding Value (0028,0120) specified in the referenced images.

      3. This Attribute does apply to RT Dose and Segmentation Instances, since they include Pixel Data.

      4. This Attribute does not apply when Float Pixel Data (7FE0,0008) or Double Float Pixel Data (7FE0,0009) are used instead of Pixel Data (7FE0,0010); Float Pixel Padding Value (0028,0122) or Double Float Pixel Padding Value (0028,0123), respectively, are used instead, and defined at the Image, not the Equipment, level.

      5. Only a single Value is allowed for this Attribute, so it only applies to images with Samples per Pixel (0028,0002) of 1, i.e., images with a Photometric Interpretation (0028,0004) of MONOCHROME1, MONOCHROME2 or PALETTE COLOR. See DICOM Standard Part 3 - Section C.7.5.1.1.2 for details.


    • Constructor Summary

      Constructors 
      Constructor Description
      PixelPaddingValueAsUS()
      Creates a new Pixel Padding Value object which wraps a new and empty Attributes object.
      PixelPaddingValueAsUS​(org.dcm4che3.data.Attributes attributes)
      Creates a new Pixel Padding Value object which wraps the provided attributes.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      PixelPaddingValueAsUS copy()
      Returns a new Pixel Padding Value which wraps a copy of the Attributes wrapped in this Pixel Padding Value.
      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.IntDataElementWrapper

        getInt, setInt

    • Constructor Detail

      • PixelPaddingValueAsUS

        public PixelPaddingValueAsUS​(org.dcm4che3.data.Attributes attributes)
        Creates a new Pixel Padding Value object which wraps the provided attributes.
        Parameters:
        attributes - the Attributes object to be wrapped.

      • PixelPaddingValueAsUS

        public PixelPaddingValueAsUS()
        Creates a new Pixel Padding Value object which wraps a new and empty Attributes object.

    • Method Detail

      • copy

        public PixelPaddingValueAsUS copy()
        Returns a new Pixel Padding Value which wraps a copy of the Attributes wrapped in this Pixel Padding Value. (see Attributes(Attributes)
        Returns:
        a new Pixel Padding Value which wraps a copy of the Attributes wrapped in this Pixel Padding Value.

      • 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