Package org.dcm4che.typeddicom.dataelements

Class RecommendedViewingMode

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RecommendedViewingMode

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class RecommendedViewingMode
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Recommended Viewing Mode
Keyword: RecommendedViewingMode
Tag: (0028,1090)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • XA/XRF Multi-frame Presentation Module > Frame Display Sequence > Recommended Viewing Mode
  as follows:
  Attribute Name: Recommended Viewing Mode
  Type: 2
  Attribute Description:

  Specifies the recommended viewing protocol(s).

  When this Attribute is present with a value, this value shall override the value of Recommended Viewing Mode (0028,1090) specified in the DICOM Standard Part 3 - Section C.7.6.10.

  Defined Terms:

  SUB

  subtraction with mask images

  NAT

  native viewing of image as stored

  Note

  If an implementation does not recognize the Defined Term for Recommended Viewing Mode (0028,1090), reverting to native display mode is recommended.

  
  
• Described in the contexts:
  • Mask Module > Recommended Viewing Mode
  as follows:
  Attribute Name: Recommended Viewing Mode
  Type: 2
  Attribute Description:

  Specifies the recommended viewing protocol(s).

  Defined Terms:

  SUB

  For subtraction with mask images.

  NAT

  Native viewing of image as encoded.

  Note

  If an implementation does not recognize the Defined Term for Recommended Viewing Mode (0028,1090), reverting to native display mode is recommended.

  
  
• Described in the contexts:
  • XA/XRF Presentation State Presentation Module > Multi-frame Presentation Sequence > Frame Display Sequence > Recommended Viewing Mode
  as follows:
  Attribute Name: Recommended Viewing Mode
  Type: 2
  Attribute Description:

  Specifies the recommended viewing protocol(s).

  Defined Terms:

  SUB

  subtraction with mask images

  NAT

  native viewing of image as stored

  Note

  If an implementation does not recognize the Defined Term for Recommended Viewing Mode (0028,1090), reverting to native display mode is recommended.

  
  
• Described in the contexts:
  • Presentation State Mask Module > Recommended Viewing Mode
  as follows:
  Attribute Name: Recommended Viewing Mode
  Type: 1C
  Attribute Description:

  Specifies the recommended viewing protocol(s).

  Enumerated Values:

  SUB

  for subtraction with mask images

  Required if Mask Subtraction Sequence (0028,6100) is present.

  Note

  The requirements in this Module are type 1C and a specified Enumerated Value, which override the requirements of the DICOM Standard Part 3 - Section C.7.6.10.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RecommendedViewingMode.Builder<SELF extends RecommendedViewingMode.Builder<SELF,T>,T extends RecommendedViewingMode.Holder>
static interface	RecommendedViewingMode.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Recommended Viewing Mode" (see RecommendedViewingMode)

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

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

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
RecommendedViewingMode()	Creates a new Recommended Viewing Mode object which wraps a new and empty Attributes object.
RecommendedViewingMode(org.dcm4che3.data.Attributes attributes)	Creates a new Recommended Viewing Mode object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RecommendedViewingMode	copy()	Returns a new Recommended Viewing Mode which wraps a copy of the Attributes wrapped in this Recommended Viewing Mode.
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.StringDataElementWrapper

getString, setString

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

RecommendedViewingMode

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

Creates a new Recommended Viewing Mode object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RecommendedViewingMode

public RecommendedViewingMode()

Creates a new Recommended Viewing Mode object which wraps a new and empty Attributes object.

Method Details

copy

public RecommendedViewingMode copy()

Returns a new Recommended Viewing Mode which wraps a copy of the Attributes wrapped in this Recommended Viewing Mode. (see Attributes(Attributes)

Returns:

a new Recommended Viewing Mode which wraps a copy of the Attributes wrapped in this Recommended Viewing Mode.

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.