Package org.dcm4che.typeddicom.dataelements

Class CalibrationImage

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CalibrationImage

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class CalibrationImage
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Calibration Image
Keyword: CalibrationImage
Tag: (0050,0004)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • DX Image Module > Calibration Image
  as follows:
  Attribute Name: Calibration Image
  Type: 3
  Attribute Description:

  Indicates whether a reference object (phantom) of known size is present in the image and was used for calibration.

  Enumerated Values:

  YES

  NO

  Device is identified using the DICOM Standard Part 3 - Section C.7.6.12. See DICOM Standard Part 3 - Section C.7.6.12 for further explanation.

  
  
• Described in the contexts:
  • X-Ray Image Module > Calibration Image
  as follows:
  Attribute Name: Calibration Image
  Type: 3
  Attribute Description:

  Indicates whether a reference object (phantom) of known size is present in the image and was used for calibration.

  Enumerated Values:

  YES

  NO

  Device is identified using the DICOM Standard Part 3 - Section C.7.6.12. See DICOM Standard Part 3 - Section C.7.6.12.

  
  
• Described in the contexts:
  • Ophthalmic Photography Image Module > Calibration Image
  • Ophthalmic Optical Coherence Tomography En Face Image Module > Calibration Image
  as follows:
  Attribute Name: Calibration Image
  Type: 3
  Attribute Description:

  Indicates whether a reference object (phantom) of known size is present in the image and was used for calibration.

  Enumerated Values:

  YES

  NO

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
CalibrationImage()	Creates a new Calibration Image object which wraps a new and empty Attributes object.
CalibrationImage(org.dcm4che3.data.Attributes attributes)	Creates a new Calibration Image object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
CalibrationImage	copy()	Returns a new Calibration Image which wraps a copy of the Attributes wrapped in this Calibration Image.
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.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

CalibrationImage

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

Creates a new Calibration Image object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

CalibrationImage

public CalibrationImage()

Creates a new Calibration Image object which wraps a new and empty Attributes object.

Method Details

copy

public CalibrationImage copy()

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

Returns:

a new Calibration Image which wraps a copy of the Attributes wrapped in this Calibration Image.

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.