Package org.dcm4che.typeddicom.dataelements

Class PresentationPixelAspectRatio

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PresentationPixelAspectRatio

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, IntegerStringMultiWrapper, StringDataElementMultiWrapper

public class PresentationPixelAspectRatio
extends AbstractDataElementWrapper
implements IntegerStringMultiWrapper

Name: Presentation Pixel Aspect Ratio
Keyword: PresentationPixelAspectRatio
Tag: (0070,0102)
Value Representation: IS
Value Multiplicity: 2

• Described in the contexts:
  • Displayed Area Module > Displayed Area Selection Sequence > Presentation Pixel Aspect Ratio
  as follows:
  Attribute Name: Presentation Pixel Aspect Ratio
  Type: 1C
  Attribute Description:

  Ratio of the vertical size and the horizontal size of the pixels in the referenced image, to be used to display the referenced image, specified by a pair of integer values where the first value is the vertical pixel size and the second value is the horizontal pixel size. See DICOM Standard Part 3 - Section C.7.6.3.1.7.

  Required if Presentation Pixel Spacing (0070,0101) is not present.

  Note

  1. This value may be different from the aspect ratio specified by Pixel Aspect Ratio (0028,0034) in the referenced image, or implied by the values of Pixel Spacing (0028,0030) or Imager Pixel Spacing (0018,1164) specified in the referenced image, which are ignored.

  2. This value must be specified even if the aspect ratio is 1:1.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
PresentationPixelAspectRatio()	Creates a new Presentation Pixel Aspect Ratio object which wraps a new and empty Attributes object.
PresentationPixelAspectRatio(org.dcm4che3.data.Attributes attributes)	Creates a new Presentation Pixel Aspect Ratio object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
PresentationPixelAspectRatio	copy()	Returns a new Presentation Pixel Aspect Ratio which wraps a copy of the Attributes wrapped in this Presentation Pixel Aspect Ratio.
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.IntDataElementMultiWrapper

getInt, getInts, setInts

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

getValueRepresentation

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

getString, getString, getStrings, setStrings

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

PresentationPixelAspectRatio

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

Creates a new Presentation Pixel Aspect Ratio object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PresentationPixelAspectRatio

public PresentationPixelAspectRatio()

Creates a new Presentation Pixel Aspect Ratio object which wraps a new and empty Attributes object.

Method Details

copy

public PresentationPixelAspectRatio copy()

Returns a new Presentation Pixel Aspect Ratio which wraps a copy of the Attributes wrapped in this Presentation Pixel Aspect Ratio. (see Attributes(Attributes)

Returns:

a new Presentation Pixel Aspect Ratio which wraps a copy of the Attributes wrapped in this Presentation Pixel Aspect Ratio.

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.