Package org.dcm4che.typeddicom.dataelements

Class PixelPaddingValueAsUS

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PixelPaddingValueAsUS

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class PixelPaddingValueAsUS
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Pixel Padding Value
Keyword: PixelPaddingValueAsUS
Tag: (0028,0120)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • General Equipment Module > Pixel Padding Value
  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. 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 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.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PixelPaddingValueAsUS.Builder<SELF extends PixelPaddingValueAsUS.Builder<SELF,T>,T extends PixelPaddingValueAsUS.Holder>
static interface	PixelPaddingValueAsUS.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Pixel Padding Value" (see PixelPaddingValueAsUS)
static class	PixelPaddingValueAsUS.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnsignedShortWrapper

UnsignedShortWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends UnsignedShortWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnsignedShortWrapper

VALUE_REPRESENTATION

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

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.
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, isEmpty

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

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getPrivateCreator, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper

getInt, setInt

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnsignedShortWrapper

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

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 Details

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.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.