Package org.dcm4che.typeddicom.dataelements

Class HighBit

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.HighBit

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class HighBit
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: High Bit
Keyword: HighBit
Tag: (0028,0102)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Whole Slide Microscopy Image Module > High Bit
  • Enhanced US Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data. High Bit (0028,0102) shall be one less than Bits Stored (0028,0101).

  
  
• Described in the contexts:
  • PET Image Module > High Bit
  • Enhanced CT Image Module > High Bit
  • X-Ray 3D Image Module > High Bit
  • Enhanced MR Image Module > High Bit
  • Enhanced XA/XRF Image Module Table > High Bit
  • NM Image Pixel Module > High Bit
  • Enhanced PET Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data. Each sample shall have the same high bit. Shall be one less than the value in Bits Stored (0028,0101).

  
  
• Described in the contexts:
  • Image Box Pixel Presentation Module > Basic Color Image Sequence > High Bit
  as follows:
  Attribute Name: High Bit
  Type:
  Attribute Description:

  See DICOM Standard Part 3 - Section C.7.6.3 for description.

  Enumerated Values:

  7

  
  
• Described in the contexts:
  • US Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data.

  See DICOM Standard Part 3 - Section C.8.5.6.1.15 for specialization.

  
  
• Described in the contexts:
  • DX Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data.

  Shall be one less than the value in Bit Stored (0028,0101).

  
  
• Described in the contexts:
  • Image Box Pixel Presentation Module > Basic Grayscale Image Sequence > High Bit
  as follows:
  Attribute Name: High Bit
  Type:
  Attribute Description:

  See DICOM Standard Part 3 - Section C.7.6.3 for description.

  Enumerated Values if Bits Stored = 8:

  7

  Enumerated Values if Bits Stored = 12:

  11

  
  
• Described in the contexts:
  • Ophthalmic Optical Coherence Tomography En Face Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data. Shall be one less than the value in Bits Stored (0028,0101). See DICOM Standard Part 3 - Section C.8.17.14.1.6 for specialization.

  
  
• Described in the contexts:
  • RT Dose Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1C
  Attribute Description:

  Most significant bit for each pixel sample. Each sample shall have the same high bit. See DICOM Standard Part 3 - Section C.8.8.3.4.5 for specialization. Required if Pixel Data (7FE0,0010) is present.

  
  
• Described in the contexts:
  • Ophthalmic Tomography Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data. Each sample shall have the same high bit.

  High Bit (0028,0102) shall be one less than Bits Stored

  
  
• Described in the contexts:
  • Segmentation Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  See DICOM Standard Part 3 - Section C.8.20.2.1.

  Enumerated Values if Segmentation Type (0062,0001) is BINARY:

  0

  Enumerated Values if Segmentation Type (0062,0001) is not BINARY:

  7

  
  
• Described in the contexts:
  • Ophthalmic Thickness Map Module > High Bit
  • Corneal Topography Map Image Module > High Bit
  • MR Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data. Each sample shall have the same high bit. High Bit (0028,0102) shall be one less than Bits Stored (0028,0101).

  
  
• Described in the contexts:
  • Ophthalmic Optical Coherence Tomography B-scan Volume Analysis Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data. Shall be one less than the value in Bits Stored (0028,0101).

  
  
• Described in the contexts:
  • CT Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data. Each sample shall have the same high bit. See DICOM Standard Part 3 - Section C.8.2.1.1.6 for specialization.

  
  
• Described in the contexts:
  • Enhanced Mammography Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data. Each sample shall have the same high bit.

  Shall have an Enumerated Value of one less than the value of Bits Stored (0028,0101).

  
  
• Described in the contexts:
  • RT Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for each pixel sample. Each sample shall have the same high bit. See DICOM Standard Part 3 - Section C.8.8.2.6.5 for specialization.

  
  
• Described in the contexts:
  • Parametric Map Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1C
  Attribute Description:

  Most significant bit for pixel sample data.

  Enumerated Values:

  15

  Required if Pixel Data (7FE0,0010) or Pixel Data Provider URL (0028,7FE0) is present.

  
  
• Described in the contexts:
  • VL Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data. Each sample shall have the same high bit.

  See DICOM Standard Part 3 - Section C.8.12.1.1.2 for specialization of this Attribute. See PS3.5 PS3.5 for further explanation.

  
  
• Described in the contexts:
  • Image Pixel Description Macro > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data. Each sample shall have the same high bit. High Bit (0028,0102) shall be one less than Bits Stored (0028,0101). See PS3.5 PS3.5 for further explanation.

  
  
• Described in the contexts:
  • Intravascular OCT Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data.

  High Bit (0028,0102) shall be one less than Bits Stored (0028,0101).

  
  
• Described in the contexts:
  • X-Ray Image Module > High Bit
  as follows:
  Attribute Name: High Bit
  Type: 1
  Attribute Description:

  Most significant bit for pixel sample data.

  See DICOM Standard Part 3 - Section C.8.7.1.1.8.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HighBit.Builder<SELF extends HighBit.Builder<SELF,T>,T extends HighBit.Holder>
static interface	HighBit.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "High Bit" (see HighBit)
static class	HighBit.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 String	PRIVATE_CREATOR	The Private Creator associated with this class.
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
HighBit()	Creates a new High Bit object which wraps a new and empty Attributes object.
HighBit(org.dcm4che3.data.Attributes attributes)	Creates a new High Bit object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
HighBit	copy()	Returns a new High Bit which wraps a copy of the Attributes wrapped in this High Bit.
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, 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

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

getValueRepresentation

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

HighBit

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

Creates a new High Bit object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

HighBit

public HighBit()

Creates a new High Bit object which wraps a new and empty Attributes object.

Method Details

copy

public HighBit copy()

Returns a new High Bit which wraps a copy of the Attributes wrapped in this High Bit. (see Attributes(Attributes)

Returns:

a new High Bit which wraps a copy of the Attributes wrapped in this High Bit.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.