Package org.dcm4che.typeddicom.dataelements

Class SpecimenLabelInImage

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SpecimenLabelInImage

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class SpecimenLabelInImage
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Specimen Label in Image
Keyword: SpecimenLabelInImage
Tag: (0048,0010)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Whole Slide Microscopy Image Module > Specimen Label in Image
  as follows:
  Attribute Name: Specimen Label in Image
  Type: 1
  Attribute Description:

  Indicates whether the specimen label is captured in the image.

  Enumerated Values:

  YES

  NO

  Shall be YES if Image Type (0008,0008) Value 3 is OVERVIEW or LABEL.

  Shall be NO if Image Type (0008,0008) Value 3 is THUMBNAIL or VOLUME.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SpecimenLabelInImage.Builder<SELF extends SpecimenLabelInImage.Builder<SELF,T>,T extends SpecimenLabelInImage.Holder>
static interface	SpecimenLabelInImage.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Specimen Label in Image" (see SpecimenLabelInImage)
static class	SpecimenLabelInImage.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
SpecimenLabelInImage()	Creates a new Specimen Label in Image object which wraps a new and empty Attributes object.
SpecimenLabelInImage(org.dcm4che3.data.Attributes attributes)	Creates a new Specimen Label in Image object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
SpecimenLabelInImage	copy()	Returns a new Specimen Label in Image which wraps a copy of the Attributes wrapped in this Specimen Label in 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

SpecimenLabelInImage

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

Creates a new Specimen Label in Image object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SpecimenLabelInImage

public SpecimenLabelInImage()

Creates a new Specimen Label in Image object which wraps a new and empty Attributes object.

Method Details

copy

public SpecimenLabelInImage copy()

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

Returns:

a new Specimen Label in Image which wraps a copy of the Attributes wrapped in this Specimen Label in 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.