Package org.dcm4che.typeddicom.dataelements

Class SamplesPerPixelUsed

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SamplesPerPixelUsed

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class SamplesPerPixelUsed
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Samples per Pixel Used
Keyword: SamplesPerPixelUsed
Tag: (0028,0003)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Ophthalmic Photography Image Module > Samples per Pixel Used
  as follows:
  Attribute Name: Samples per Pixel Used
  Type: 1C
  Attribute Description:

  The number of samples (planes) containing information.

  Enumerated Values:

  2

  Required if different from Samples per Pixel (0028,0002).

  See DICOM Standard Part 3 - Section C.8.17.2.1.2

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SamplesPerPixelUsed.Builder<SELF extends SamplesPerPixelUsed.Builder<SELF,T>,T extends SamplesPerPixelUsed.Holder>
static interface	SamplesPerPixelUsed.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Samples per Pixel Used" (see SamplesPerPixelUsed)
static class	SamplesPerPixelUsed.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
SamplesPerPixelUsed()	Creates a new Samples per Pixel Used object which wraps a new and empty Attributes object.
SamplesPerPixelUsed(org.dcm4che3.data.Attributes attributes)	Creates a new Samples per Pixel Used object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
SamplesPerPixelUsed	copy()	Returns a new Samples per Pixel Used which wraps a copy of the Attributes wrapped in this Samples per Pixel Used.
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

SamplesPerPixelUsed

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

Creates a new Samples per Pixel Used object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SamplesPerPixelUsed

public SamplesPerPixelUsed()

Creates a new Samples per Pixel Used object which wraps a new and empty Attributes object.

Method Details

copy

public SamplesPerPixelUsed copy()

Returns a new Samples per Pixel Used which wraps a copy of the Attributes wrapped in this Samples per Pixel Used. (see Attributes(Attributes)

Returns:

a new Samples per Pixel Used which wraps a copy of the Attributes wrapped in this Samples per Pixel Used.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.