Package org.dcm4che.typeddicom.dataelements

Class InstanceNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.InstanceNumber

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, IntegerStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class InstanceNumber
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Instance Number
Keyword: InstanceNumber
Tag: (0020,0013)
Value Representation: IntegerString
Value Multiplicity: 1

• Described in the contexts:
  • Key Object Document Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 1
  Attribute Description:

  A number that identifies the Document.

  
  
• Described in the contexts:
  • RT General Plan Module > Instance Number
  • Structure Set Module > Instance Number
  • RT Dose Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 3
  Attribute Description:

  A number that identifies this object Instance.

  
  
• Described in the contexts:
  • Waveform Identification Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 1
  Attribute Description:

  A number that identifies this Waveform.

  
  
• Described in the contexts:
  • General Ophthalmic Refractive Measurements Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 1
  Attribute Description:

  A number that identifies these measurements.

  
  
• Described in the contexts:
  • Raw Data Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 2
  Attribute Description:

  A number that identifies this raw data. The value shall be unique within a Series.

  
  
• Described in the contexts:
  • Multi-frame Functional Groups Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 1
  Attribute Description:

  A number that identifies this Instance. The value shall be the same for all SOP Instances of a Concatenation, and different for each separate Concatenation and for each SOP Instance not within a Concatenation in a Series.

  
  
• Described in the contexts:
  • SR Document General Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 1
  Attribute Description:

  A number that identifies the SR Document.

  
  
• Described in the contexts:
  • Scan Procedure Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 1
  Attribute Description:

  A number that identifies this shot.

  Shall start at 1 and monotonically increase by 1 within a single acquisition.

  
  
• Described in the contexts:
  • General Image Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 2
  Attribute Description:

  A number that identifies this image.

  Note

  This Attribute was named Image Number in earlier versions of this Standard.

  
  
• Described in the contexts:
  • Content Identification Macro > Instance Number
  • Ophthalmic Optical Coherence Tomography En Face Image Module > Instance Number
  • Ophthalmic Optical Coherence Tomography B-scan Volume Analysis Image Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 1
  Attribute Description:

  A number that identifies this SOP Instance.

  
  
• Described in the contexts:
  • General Contributing Sources Macro > Contributing SOP Instances Reference Sequence > Referenced Series Sequence > Referenced Instance Sequence > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 2
  Attribute Description:

  A number that identifies this Instance.

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

  A number that identifies this Instance.

  
  
• Described in the contexts:
  • Encapsulated Document Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 1
  Attribute Description:

  A number that identifies this SOP Instance. The value shall be unique within a Series.

  
  
• Described in the contexts:
  • Ophthalmic Photography Image Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 1
  Attribute Description:

  A number that identifies this image.

  
  
• Described in the contexts:
  • Inventory Module > Inventoried Studies Sequence > Inventoried Series Sequence > Inventoried Instances Sequence > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 2
  Attribute Description:

  A number that identifies the inventoried SOP Instance.

  
  
• Described in the contexts:
  • RT General Treatment Record Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 1
  Attribute Description:

  Instance number identifying this particular Instance of the object.

  
  
• Described in the contexts:
  • SOP Common Module > Instance Number
  as follows:
  Attribute Name: Instance Number
  Type: 3
  Attribute Description:

  A number that identifies this Composite Instance.

  
  

Nested Class Summary

Nested Classes

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

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

IntegerStringWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends IntegerStringWrapper>

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.IntegerStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
InstanceNumber()	Creates a new Instance Number object which wraps a new and empty Attributes object.
InstanceNumber(org.dcm4che3.data.Attributes attributes)	Creates a new Instance Number object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
InstanceNumber	copy()	Returns a new Instance Number which wraps a copy of the Attributes wrapped in this Instance Number.
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.IntegerStringWrapper

getValueRepresentation

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

getString, setString

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

InstanceNumber

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

Creates a new Instance Number object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

InstanceNumber

public InstanceNumber()

Creates a new Instance Number object which wraps a new and empty Attributes object.

Method Detail

copy

public InstanceNumber copy()

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

Returns:

a new Instance Number which wraps a copy of the Attributes wrapped in this Instance Number.

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