java.lang.Object
- org.dcm4che.typeddicom.AbstractAttributesWrapper
- - org.dcm4che.typeddicom.AbstractDataElementWrapper
  - - org.dcm4che.typeddicom.dataelements.SamplesPerPixel

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, UnsignedShortWrapper
```
public class SamplesPerPixel
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements UnsignedShortWrapper
```
Name: Samples per Pixel
Keyword: SamplesPerPixel
Tag: (0028,0002)
Value Representation: UnsignedShort
Value Multiplicity: 1
- Described in the contexts:
  - Corneal Topography Map Image Module > Samples Per Pixel
  - Ophthalmic Thickness Map Module > Samples Per Pixel
  as follows:
  Attribute Name: Samples Per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) in this image.
  
  See DICOM Standard Part 3 - Section C.7.6.3.1.1 for further explanation.
  
  Enumerated Values:
  
  1
- Described in the contexts:
  - NM Image Pixel Module > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1
  Attribute Description:
  Number of samples (color planes) in this image. The value shall be 1.
- Described in the contexts:
  - Enhanced US Image Module > Samples Per Pixel
  as follows:
  Attribute Name: Samples Per Pixel
  Type: 1
  Attribute Description:
  Number of samples per pixel in this image.
  
  Enumerated Values:
  
  1
- Described in the contexts:
  - Ophthalmic Optical Coherence Tomography En Face Image Module > Samples per Pixel
  - Parametric Map Image Module > Samples per Pixel
  - Ophthalmic Optical Coherence Tomography B-scan Volume Analysis Image Module > Samples per Pixel
  - Enhanced Mammography Image Module > Samples per Pixel
  - PET Image Module > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) in this image.
  
  Enumerated Values:
  
  1
- Described in the contexts:
  - Enhanced CT Image Module > Samples per Pixel
  - Enhanced PET Image Module > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) in this image. This value shall be 1.
- Described in the contexts:
  - VL Image Module > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) per image.
  
  See DICOM Standard Part 3 - Section C.8.12.1.1.4 for specialization of this Attribute.
- Described in the contexts:
  - Image Box Pixel Presentation Module > Basic Color Image Sequence > Samples Per Pixel
  as follows:
  Attribute Name: Samples Per Pixel
  Type:
  Attribute Description:
  See DICOM Standard Part 3 - Section C.7.6.3 for description.
  
  Enumerated Values:
  
  3
- Described in the contexts:
  - MR Image Module > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) in this image. See DICOM Standard Part 3 - Section C.8.3.1.1.2 for specialization.
- Described in the contexts:
  - Double Floating Point Image Pixel Module > Samples per Pixel
  - Image Pixel Description Macro > Samples per Pixel
  - Floating Point Image Pixel Module > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) in this image. See DICOM Standard Part 3 - Section C.7.6.3.1.1 for further explanation.
- Described in the contexts:
  - Ophthalmic Tomography Image Module > Samples Per Pixel
  as follows:
  Attribute Name: Samples Per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) in this image. See DICOM Standard Part 3 - Section C.7.6.3.1.1 for further explanation.
  
  Enumerated Values:
  
  1
- Described in the contexts:
  - RT Dose Module > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1C
  Attribute Description:
  Number of samples (planes) in this image. See DICOM Standard Part 3 - Section C.8.8.3.4.1 for specialization. Required if Pixel Data (7FE0,0010) is present.
- Described in the contexts:
  - Segmentation Image Module > Samples Per Pixel
  as follows:
  Attribute Name: Samples Per Pixel
  Type: 1
  Attribute Description:
  Enumerated Values:
  
  1
- Described in the contexts:
  - Whole Slide Microscopy Image Module > Samples Per Pixel
  as follows:
  Attribute Name: Samples Per Pixel
  Type: 1
  Attribute Description:
  Number of samples (color planes) per frame in this image.
  
  Enumerated Values:
  
  3
  
  1
  
  See DICOM Standard Part 3 - Section C.8.12.4.1.5 for further explanation.
- Described in the contexts:
  - US Image Module > Samples Per Pixel
  as follows:
  Attribute Name: Samples Per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) in this image.
  
  See DICOM Standard Part 3 - Section C.8.5.6.1.12 for specialization.
- Described in the contexts:
  - Intravascular OCT Image Module > Samples Per Pixel
  as follows:
  Attribute Name: Samples Per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) in this image.
  
  Enumerated Values:
  
  1
- Described in the contexts:
  - CT Image Module > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) in this image. See DICOM Standard Part 3 - Section C.8.2.1.1.2 for specialization.
- Described in the contexts:
  - RT Image Module > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) in this image. See DICOM Standard Part 3 - Section C.8.8.2.6.1 for specialization.
- Described in the contexts:
  - Image Box Pixel Presentation Module > Basic Grayscale Image Sequence > Samples Per Pixel
  as follows:
  Attribute Name: Samples Per Pixel
  Type:
  Attribute Description:
  See DICOM Standard Part 3 - Section C.7.6.3 for description.
  
  Enumerated Values:
  
  1
- Described in the contexts:
  - X-Ray 3D Image Module > Samples per Pixel
  - X-Ray Image Module > Samples per Pixel
  - Enhanced XA/XRF Image Module Table > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1
  Attribute Description:
  Number of samples (color planes) in this image shall have a value of 1.
- Described in the contexts:
  - DX Image Module > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1
  Attribute Description:
  Number of samples in this image.
  
  Enumerated Values:
  
  1
- Described in the contexts:
  - Ophthalmic Photography Image Module > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) in this image.
  
  Enumerated Values:
  
  3
  
  1
  
  See DICOM Standard Part 3 - Section C.8.17.2.1.2 for further explanation.
- Described in the contexts:
  - Enhanced MR Image Module > Samples per Pixel
  as follows:
  Attribute Name: Samples per Pixel
  Type: 1
  Attribute Description:
  Number of samples (planes) in this image. For Enumerated Values See DICOM Standard Part 3 - Section C.8.13.1.1.2.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`SamplesPerPixel.Builder<SELF extends SamplesPerPixel.Builder<SELF,T>,T extends SamplesPerPixel.Holder>`
`static interface`	`SamplesPerPixel.Holder`	A class implementing this interface can hold attributes which contain the DICOM tag "Samples per Pixel" (see `SamplesPerPixel`)
`static class`	`SamplesPerPixel.SimpleHolder`

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnsignedShortWrapper
UnsignedShortWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends UnsignedShortWrapper>

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`PRIVATE_CREATOR`	The Private Creator associated with this class.
`static 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
`SamplesPerPixel()`	Creates a new Samples per Pixel object which wraps a new and empty `Attributes` object.
`SamplesPerPixel(org.dcm4che3.data.Attributes attributes)`	Creates a new Samples per Pixel object which wraps the provided `attributes`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SamplesPerPixel`	`copy()`	Returns a new Samples per Pixel which wraps a copy of the Attributes wrapped in this Samples per Pixel.
`java.lang.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 Detail
  - PRIVATE_CREATOR
```
public static final java.lang.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 Detail
  - SamplesPerPixel
```
public SamplesPerPixel(org.dcm4che3.data.Attributes attributes)
```
    Creates a new Samples per Pixel object which wraps the provided attributes.
    
    Parameters:
    
    attributes - the Attributes object to be wrapped.
  - SamplesPerPixel
```
public SamplesPerPixel()
```
    Creates a new Samples per Pixel object which wraps a new and empty Attributes object.
- Method Detail
  - copy
```
public SamplesPerPixel copy()
```
    Returns a new Samples per Pixel which wraps a copy of the Attributes wrapped in this Samples per Pixel. (see Attributes(Attributes)
    
    Returns:
    
    a new Samples per Pixel which wraps a copy of the Attributes wrapped in this Samples per Pixel.
  - getPrivateCreator
```
public java.lang.String getPrivateCreator()
```
    Specified by:
    
    getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper
  - getTag
```
public int getTag()
```
    Specified by:
    
    getTag in interface org.dcm4che.typeddicom.DataElementWrapper

Class SamplesPerPixel

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

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

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

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

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

Field Detail

PRIVATE_CREATOR

TAG

Constructor Detail

SamplesPerPixel

SamplesPerPixel

Method Detail

copy

getPrivateCreator

getTag