Package org.dcm4che.typeddicom.dataelements

Class AcquisitionDateTime

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.AcquisitionDateTime

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DateDataElementWrapper, DateTimeWrapper, StringDataElementWrapper

public class AcquisitionDateTime
extends AbstractDataElementWrapper
implements DateTimeWrapper

Name: Acquisition DateTime
Keyword: AcquisitionDateTime
Tag: (0008,002A)
Value Representation: DT
Value Multiplicity: 1

• Described in the contexts:
  • MR Image and Spectroscopy Instance Macro > Acquisition DateTime
  as follows:
  Attribute Name: Acquisition DateTime
  Type: 1C
  Attribute Description:

  The date and time that the acquisition of data started.

  Note

  The synchronization of this time with an external clock is specified in the synchronization Module in Acquisition Time synchronized (0018,1800).

  Required if Image Type (0008,0008) Value 1 is ORIGINAL or MIXED and SOP Class UID is not "1.2.840.10008.5.1.4.1.1.4.4" (Legacy Converted). May be present otherwise.

  
  
• Described in the contexts:
  • Enhanced CT Image Module > Acquisition DateTime
  as follows:
  Attribute Name: Acquisition DateTime
  Type: 1C
  Attribute Description:

  The date and time that the acquisition of data started.

  Note

  1. The synchronization of this time with an external clock is specified in the synchronization Module in Acquisition Time synchronized (0018,1800).

  2. See DICOM Standard Part 3 - Section C.7.6.16.2.2.1 for an overview of all acquisition related timing Attributes.

  Required if Image Type (0008,0008) Value 1 of this frame is ORIGINAL or MIXED and SOP Class UID is not "1.2.840.10008.5.1.4.1.1.2.2" (Legacy Converted), may be present otherwise.

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

  The date and time that the acquisition of data that resulted in this Instance started.

  
  
• Described in the contexts:
  • General Contributing Sources Macro > Acquisition DateTime
  as follows:
  Attribute Name: Acquisition DateTime
  Type: 1C
  Attribute Description:

  The time the acquisition of data that resulted in sources started.

  The value shall be the start date and time of the first contributing SOP Instance of the group specified by the Contributing SOP Instances Reference Sequence (0020,9529).

  Required if present and consistent in the contributing SOP Instances.

  Note

  The Acquisition DateTime may be created by combining the values of Acquisition Date (0008,0022) and Acquisition Time (0008,0032) Attributes in the contributing SOP Instances.

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

  The date and time that the acquisition of data that resulted in this waveform started; the reference timestamp for the Multiplex Group Time Offset (0018,1068) for a waveform multiplex group

  Note

  The synchronization of this time with an external clock is specified in the DICOM Standard Part 3 - Section C.7.4.2 in Acquisition Time Synchronized (0018,1800).

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

  The date and time that the acquisition of data that resulted in this image started.

  
  
• Described in the contexts:
  • Intravascular OCT Image Module > Acquisition DateTime
  • Ophthalmic Tomography Image Module > Acquisition DateTime
  as follows:
  Attribute Name: Acquisition DateTime
  Type: 1
  Attribute Description:

  The date and time that the acquisition of data started.

  Note

  The synchronization of this time with an external clock is specified in the synchronization Module in Acquisition Time synchronized (0018,1800).

  
  
• Described in the contexts:
  • Raw Data Module > Acquisition DateTime
  as follows:
  Attribute Name: Acquisition DateTime
  Type: 3
  Attribute Description:

  The date and time that the acquisition of data started.

  Note

  The synchronization of this time with an external clock is specified in the synchronization Module in Acquisition Time synchronized (0018,1800).

  
  
• Described in the contexts:
  • Ophthalmic Photography Image Module > Acquisition DateTime
  as follows:
  Attribute Name: Acquisition DateTime
  Type: 1C
  Attribute Description:

  The date and time that the acquisition of data started.

  Note

  The synchronization of this time with an external clock is specified in the synchronization Module in Acquisition Time Synchronized (0018,1800).

  Required if Image Type (0008,0008) Value 1 is ORIGINAL. May be present otherwise.

  
  
• Described in the contexts:
  • Encapsulated Document Module > Acquisition DateTime
  as follows:
  Attribute Name: Acquisition DateTime
  Type: 2
  Attribute Description:

  The date and time that the original generation of the data in the document started.

  
  
• Described in the contexts:
  • General Image Module > Acquisition DateTime
  as follows:
  Attribute Name: Acquisition DateTime
  Type: 3
  Attribute Description:

  The date and time that the acquisition of data that resulted in this image started.

  Note

  The synchronization of this time with an external clock is specified in the DICOM Standard Part 3 - Section C.7.4.2 in Acquisition Time Synchronized (0018,1800).

  
  
• Described in the contexts:
  • Enhanced XA/XRF Image Module Table > Acquisition DateTime
  • Ophthalmic Thickness Map Module > Acquisition DateTime
  • Corneal Topography Map Image Module > Acquisition DateTime
  • Enhanced Mammography Image Module > Acquisition DateTime
  as follows:
  Attribute Name: Acquisition DateTime
  Type: 1
  Attribute Description:

  The date and time that the acquisition of data that resulted in this image started.

  Note

  The synchronization of this time with an external clock is specified in the DICOM Standard Part 3 - Section C.7.4.2 in Acquisition Time Synchronized (0018,1800).

  
  
• Described in the contexts:
  • Enhanced PET Image Module > Acquisition DateTime
  as follows:
  Attribute Name: Acquisition DateTime
  Type: 1C
  Attribute Description:

  The date and time that the acquisition of data started.

  Note

  1. The synchronization of this time with an external clock is specified in the synchronization Module in Acquisition Time synchronized (0018,1800).

  2. See DICOM Standard Part 3 - Section C.7.6.16.2.2.1 for an overview of all acquisition related timing Attributes.

  Required if Image Type (0008,0008) Value 1 of this frame is ORIGINAL and SOP Class UID is not "1.2.840.10008.5.1.4.1.1.128.1" (Legacy Converted), may be present otherwise.

  
  
• Described in the contexts:
  • US Image Module > Acquisition DateTime
  as follows:
  Attribute Name: Acquisition DateTime
  Type: 1C
  Attribute Description:

  The date and time that the acquisition of data that resulted in this image started.

  Required if Modality (0008,0060) = IVUS

  May be present otherwise.

  Note

  The synchronization of this time with an external clock is specified in the DICOM Standard Part 3 - Section C.7.4.2 in Acquisition Time Synchronized (0018,1800).

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
AcquisitionDateTime()	Creates a new Acquisition DateTime object which wraps a new and empty Attributes object.
AcquisitionDateTime(org.dcm4che3.data.Attributes attributes)	Creates a new Acquisition DateTime object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
AcquisitionDateTime	copy()	Returns a new Acquisition DateTime which wraps a copy of the Attributes wrapped in this Acquisition DateTime.
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.DateDataElementWrapper

getDate, getDate, getDate, setDate, setDate

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

getValueRepresentation

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

getString, setString

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

AcquisitionDateTime

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

Creates a new Acquisition DateTime object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

AcquisitionDateTime

public AcquisitionDateTime()

Creates a new Acquisition DateTime object which wraps a new and empty Attributes object.

Method Details

copy

public AcquisitionDateTime copy()

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

Returns:

a new Acquisition DateTime which wraps a copy of the Attributes wrapped in this Acquisition DateTime.

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.