Package org.dcm4che.typeddicom.dataelements

Class Polarity

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.Polarity

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class Polarity
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Polarity
Keyword: Polarity
Tag: (2020,0020)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Image Box Pixel Presentation Module > Polarity
  as follows:
  Attribute Name: Polarity
  Type:
  Attribute Description:

  Specifies whether minimum pixel values (after VOI LUT transformation) are to printed black or white.

  Enumerated Values:

  NORMAL

  pixels shall be printed as specified by Photometric Interpretation (0028,0004)

  REVERSE

  pixels shall be printed with the opposite polarity as specified by Photometric Interpretation (0028,0004)

  If Polarity (2020,0020) is not specified by the SCU, the SCP shall print with NORMAL polarity.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Polarity	copy()	Returns a new Polarity which wraps a copy of the Attributes wrapped in this Polarity.
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, getPrivateCreator, getValue

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

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

Polarity

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

Creates a new Polarity object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

Polarity

public Polarity()

Creates a new Polarity object which wraps a new and empty Attributes object.

Method Details

copy

public Polarity copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.