Package org.dcm4che.typeddicom.dataelements

Class PixelAspectRatio

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PixelAspectRatio

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, IntegerStringMultiWrapper, StringDataElementMultiWrapper

public class PixelAspectRatio
extends AbstractDataElementWrapper
implements IntegerStringMultiWrapper

Name: Pixel Aspect Ratio
Keyword: PixelAspectRatio
Tag: (0028,0034)
Value Representation: IS
Value Multiplicity: 2

• Described in the contexts:
  • Ophthalmic Thickness Map Module > Pixel Aspect Ratio
  • Corneal Topography Map Image Module > Pixel Aspect Ratio
  as follows:
  Attribute Name: Pixel Aspect Ratio
  Type: 1
  Attribute Description:

  Ratio of the vertical size and horizontal size of the pixels in the 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.

  
  
• Described in the contexts:
  • Image Box Pixel Presentation Module > Basic Color Image Sequence > Pixel Aspect Ratio
  as follows:
  Attribute Name: Pixel Aspect Ratio
  Type:
  Attribute Description:

  See DICOM Standard Part 3 - Section C.7.6.3 for description.

  
  
• Described in the contexts:
  • Floating Point Image Pixel Module > Pixel Aspect Ratio
  • Image Pixel Description Macro > Pixel Aspect Ratio
  • Double Floating Point Image Pixel Module > Pixel Aspect Ratio
  as follows:
  Attribute Name: Pixel Aspect Ratio
  Type: 1C
  Attribute Description:

  Ratio of the vertical size and horizontal size of the pixels in the 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. Required if the aspect ratio values do not have a ratio of 1:1 and the physical pixel spacing is not specified by Pixel Spacing (0028,0030), or Imager Pixel Spacing (0018,1164) or Nominal Scanned Pixel Spacing (0018,2010), either for the entire Image or per-frame in a Functional Group Macro. See DICOM Standard Part 3 - Section C.7.6.3.1.7.

  
  
• Described in the contexts:
  • Image Box Pixel Presentation Module > Basic Grayscale Image Sequence > Pixel Aspect Ratio
  as follows:
  Attribute Name: Pixel Aspect Ratio
  Type:
  Attribute Description:

  See DICOM Standard Part 3 - Section C.7.6.3 for description

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

PixelAspectRatio

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

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

Parameters:

attributes - The Attributes object to be wrapped.

PixelAspectRatio

public PixelAspectRatio()

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

Method Details

copy

public PixelAspectRatio copy()

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

Returns:

a new Pixel Aspect Ratio which wraps a copy of the Attributes wrapped in this 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.