Package org.dcm4che.typeddicom.dataelements

Class ShutterPresentationValue

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ShutterPresentationValue

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class ShutterPresentationValue
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Shutter Presentation Value
Keyword: ShutterPresentationValue
Tag: (0018,1622)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Presentation State Shutter Module > Shutter Presentation Value
  as follows:
  Attribute Name: Shutter Presentation Value
  Type: 1C
  Attribute Description:

  A single grayscale unsigned value used to replace those parts of the image occluded by the shutter, when rendered on a monochrome display. The units are specified in P-Values.

  Required if the DICOM Standard Part 3 - Section C.7.6.11 or DICOM Standard Part 3 - Section C.7.6.15 is present.

  Note

  The requirement in this Module is type 1C, which overrides the type 3 in the DICOM Standard Part 3 - Section C.7.6.11.

  
  
• Described in the contexts:
  • Bitmap Display Shutter Module > Shutter Presentation Value
  as follows:
  Attribute Name: Shutter Presentation Value
  Type: 1
  Attribute Description:

  A single gray unsigned value used to replace those parts of the image occluded by the shutter, when rendered on a monochrome display. The units are specified in P-Values, from a minimum of 0000H (black) up to a maximum of FFFFH (white).

  Note

  The maximum P-Value for this Attribute may be different from the maximum P-Value from the output of the Presentation LUT, which may be less than 16 bits in depth.

  
  
• Described in the contexts:
  • Display Shutter Macro > Shutter Presentation Value
  as follows:
  Attribute Name: Shutter Presentation Value
  Type: 3
  Attribute Description:

  A single gray unsigned value used to replace those parts of the image occluded by the shutter, when rendered on a monochrome display. The units are specified in P-Values, from a minimum of 0000H (black) up to a maximum of FFFFH (white).

  Note

  The maximum P-Value for this Attribute may be different from the maximum P-Value from the output of the Presentation LUT, which may be less than 16 bits in depth.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShutterPresentationValue.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Shutter Presentation Value" (see ShutterPresentationValue)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
ShutterPresentationValue()	Creates a new Shutter Presentation Value object which wraps a new and empty Attributes object.
ShutterPresentationValue(org.dcm4che3.data.Attributes attributes)	Creates a new Shutter Presentation Value object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ShutterPresentationValue	copy()	Returns a new Shutter Presentation Value which wraps a copy of the Attributes wrapped in this Shutter Presentation Value.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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, getValue

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

getInt, setInt

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

ShutterPresentationValue

public ShutterPresentationValue(org.dcm4che3.data.Attributes attributes)

Creates a new Shutter Presentation Value object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ShutterPresentationValue

public ShutterPresentationValue()

Creates a new Shutter Presentation Value object which wraps a new and empty Attributes object.

Method Details

copy

public ShutterPresentationValue copy()

Returns a new Shutter Presentation Value which wraps a copy of the Attributes wrapped in this Shutter Presentation Value. (see Attributes(Attributes)

Returns:

a new Shutter Presentation Value which wraps a copy of the Attributes wrapped in this Shutter Presentation Value.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.