org.dcm4che2.iod.module.composite
Class AcquisitionContext

java.lang.Object
  org.dcm4che2.iod.module.Module
      org.dcm4che2.iod.module.composite.AcquisitionContext

Direct Known Subclasses:

AcquisitionContextModule

public class AcquisitionContext
extends Module

Item that describes the conditions present during the acquisition of the data of the SOP Instance.

Author:

Antonio Magni

Field Summary

Fields inherited from class org.dcm4che2.iod.module.Module

dcmobj

Constructor Summary

AcquisitionContext(DicomObject dcmobj)

Method Summary

Code	getConceptCode() Sequence This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a Coded Value.
Code	getConceptNameCode()
java.util.Date	getDateTime() This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a date or time.
Code	getMeasurementUnitsCode()
float	getNumericValue()
java.lang.String	getPersonName() This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a Person Name.
int[]	getReferencedFrameNumbers()
java.lang.String	getTextValue() This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a Text Observation Value.
java.lang.String	getValueType()
void	setConceptCode(Code code) Sequence This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a Coded Value.
void	setConceptNameCode(Code c) Sequence A concept that constrains the meaning of (i.e.
void	setDateTime(java.util.Date d)
void	setMeasurementUnitsCode(Code c) Code Sequence Units of measurement.
void	setNumericValue(float ds) This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a set of one or more numeric values.
void	setPersonName(java.lang.String s) This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a Person Name.
void	setReferencedFrameNumbers(int[] us) Numbers References one or more frames in a Multi-frame SOP Instance.
void	setTextValue(java.lang.String s) This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a Text Observation Value.
void	setValueType(java.lang.String cs) The type of the value encoded in this Item.
static AcquisitionContext[]	toAcquisitionContexts(DicomElement sq)

Methods inherited from class org.dcm4che2.iod.module.Module

getDicomObject, getType1Tags, getType2Tags, init, updateSequence, updateSequence, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AcquisitionContext

public AcquisitionContext(DicomObject dcmobj)

Method Detail

toAcquisitionContexts

public static AcquisitionContext[] toAcquisitionContexts(DicomElement sq)

setValueType

public void setValueType(java.lang.String cs)

The type of the value encoded in this Item.

Defined Terms: TEXT NUMERIC CODE DATE TIME PNAME

See Section 10.2.

Type 3

Parameters:

cs -

getValueType

public java.lang.String getValueType()

setConceptNameCode

public void setConceptNameCode(Code c)

Sequence A concept that constrains the meaning of (i.e. defines the role of) the Observation Value. The �Name� component of a Name/Value pair.

This sequence shall contain exactly one item.

Parameters:

c -

getConceptNameCode

public Code getConceptNameCode()

setReferencedFrameNumbers

public void setReferencedFrameNumbers(int[] us)

Numbers References one or more frames in a Multi-frame SOP Instance. The first frame shall be denoted as frame number one.

Required if this SOP Instance is a Multi-frame SOP Instance and the values in this sequence item do not apply to all frames.

Type 1C

Parameters:

us -

getReferencedFrameNumbers

public int[] getReferencedFrameNumbers()

setNumericValue

public void setNumericValue(float ds)

This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a set of one or more numeric values.

Required if the value that Concept Name Code Sequence (0040,A043) requires (implies) is a set of one or more integers or real numbers. Shall not be present otherwise.

Type 1C

Parameters:

ds -

getNumericValue

public float getNumericValue()

setMeasurementUnitsCode

public void setMeasurementUnitsCode(Code c)

Code Sequence Units of measurement. Only a single Item shall be permitted in this Sequence.

Required if Numeric Value (0040,A30A) is sent. Shall not be present otherwise.

Type 1C

Parameters:

c -

getMeasurementUnitsCode

public Code getMeasurementUnitsCode()

getDateTime

public java.util.Date getDateTime()

This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a date or time.

Note: The purpose or role of the date value could be specified in Concept Name Code Sequence (0040,A043).

Required if the value that Concept Name Code Sequence (0040,A043) requires (implies) is a date. Shall not be present otherwise.

Type 1C

Returns:

setDateTime

public void setDateTime(java.util.Date d)

getPersonName

public java.lang.String getPersonName()

This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a Person Name.

Note: The role of the person could be specified in Concept Name Code Sequence (0040,A043).

Required if the value that Concept Name Code Sequence (0040,A043) irequires (implies) is a person name. Shall not be present otherwise.

Type 1C

Returns:

setPersonName

public void setPersonName(java.lang.String s)

This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a Person Name.

Note: The role of the person could be specified in Concept Name Code Sequence (0040,A043).

Required if the value that Concept Name Code Sequence (0040,A043) irequires (implies) is a person name. Shall not be present otherwise.

Type 1C

Parameters:

s -

getTextValue

public java.lang.String getTextValue()

This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a Text Observation Value.

Required if Date (0040,A121), Time (0040,A122), and Person Name (0040,A123) do not fully describe the concept specified by Concept Name Code Sequence (0040,A043). Shall not be present otherwise.

Type 1C

Returns:

setTextValue

public void setTextValue(java.lang.String s)

This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a Text Observation Value.

Required if Date (0040,A121), Time (0040,A122), and Person Name (0040,A123) do not fully describe the concept specified by Concept Name Code Sequence (0040,A043). Shall not be present otherwise.

Type 1C

Parameters:

s -

getConceptCode

public Code getConceptCode()

Sequence This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a Coded Value. This sequence shall contain exactly one item.

Required if Date (0040,A121), Time (0040,A122), Person Name (0040,A123), Text Value (0040,A160), and the pair of Numeric Value (0040,A30A) and Measurement Units Code Sequence (0040,08EA) are not present.

Type 1C

Returns:

setConceptCode

public void setConceptCode(Code code)

Sequence This is the Value component of a Name/Value pair when the Concept implied by Concept Name Code Sequence (0040,A043) is a Coded Value. This sequence shall contain exactly one item.

Required if Date (0040,A121), Time (0040,A122), Person Name (0040,A123), Text Value (0040,A160), and the pair of Numeric Value (0040,A30A) and Measurement Units Code Sequence (0040,08EA) are not present.

Type 1C

Parameters:

code -