Class TransferSyntax
A class to represent the characteristics of a DICOM Transfer Syntax, which may be instantiated from a UID or from basic characteristics, as well as static UID strings for known Transfer Syntaxes, and static methods for extracting the characteristics of known Transfer Syntaxes.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
static final String
static final String
protected String
protected boolean
protected boolean
static final String
static final String
protected String
static final String
static final String
static final String
static final String
static final String
protected boolean
static final String
static final String
static final String
static final String
static final String
protected boolean
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
protected boolean
static final String
protected String
-
Constructor Summary
ConstructorsConstructorDescriptionTransferSyntax
(String uid) Construct a Transfer Syntax using the specified UID, automatically determining its characteristics.TransferSyntax
(String transferSyntaxUID, String description, boolean explicitVR, boolean bigEndian, boolean encapsulatedPixelData, boolean lossy) Construct a Transfer Syntax using the specified UID and characteristics.TransferSyntax
(String transferSyntaxUID, String description, boolean explicitVR, boolean bigEndian, boolean encapsulatedPixelData, boolean lossy, String fileNameExtension) Construct a Transfer Syntax using the specified UID and characteristics.TransferSyntax
(String transferSyntaxUID, String description, boolean explicitVR, boolean bigEndian, boolean encapsulatedPixelData, boolean lossy, String fileNameExtension, boolean jpegFamily) Construct a Transfer Syntax using the specified UID and characteristics. -
Method Summary
Modifier and TypeMethodDescriptiondump()
Describe the characteristics of Transfer Syntax.Get a human-readable description of the Transfer Syntax.Get the file name extension appropriate for the Transfer Syntax.getUID()
Get the UID of the Transfer Syntax.boolean
Is the Transfer Syntax big endian ?static boolean
isBigEndian
(String uid) Is the Transfer Syntax with the specified UID big endian ?boolean
Does the Transfer Syntax use bzip2 compression ?boolean
Does the Transfer Syntax use deflate compression ?boolean
Does the Transfer Syntax encapsulate the pixel data ?static boolean
isEncapsulated
(String uid) Does the Transfer Syntax encapsulate the pixel data ?boolean
Is the Transfer Syntax explicit VR ?static boolean
isExplicitVR
(String uid) Is the Transfer Syntax with the specified UID explicit VR ?boolean
Is the Transfer Syntax implicit VR ?static boolean
isImplicitVR
(String uid) Is the Transfer Syntax with the specified UID implicit VR ?boolean
Is the Transfer Syntax part of the JPEG family of Transfer Syntaxes?boolean
Is the Transfer Syntax little endian ?static boolean
isLittleEndian
(String uid) Is the Transfer Syntax with the specified UID little endian ?boolean
isLossy()
Is the Transfer Syntax potentially lossy ?boolean
Does the Transfer Syntax encode the pixel data without encapsulation?static boolean
isNotEncapsulated
(String uid) Does the Transfer Syntax encode the pixel data without encapsulation?boolean
Is the Transfer Syntax recognized ?toString()
Get the Transfer Syntax as a string.
-
Field Details
-
ImplicitVRLittleEndian
- See Also:
-
ExplicitVRLittleEndian
- See Also:
-
ExplicitVRBigEndian
- See Also:
-
Default
- See Also:
-
DeflatedExplicitVRLittleEndian
- See Also:
-
JPEGBaseline
- See Also:
-
JPEGExtended
- See Also:
-
JPEGFullProgressionNonHierarchical1012
- See Also:
-
JPEGLossless
- See Also:
-
JPEGLosslessSV1
- See Also:
-
JPEGLS
- See Also:
-
JPEGNLS
- See Also:
-
JPEG2000Lossless
- See Also:
-
JPEG2000
- See Also:
-
MPEG2MPML
- See Also:
-
MPEG2MPHL
- See Also:
-
MPEG4HP41
- See Also:
-
MPEG4HP41BD
- See Also:
-
MPEG4HP422D
- See Also:
-
MPEG4HP423D
- See Also:
-
MPEG4HP42ST
- See Also:
-
RLE
- See Also:
-
PixelMedBzip2ExplicitVRLittleEndian
- See Also:
-
PixelMedEncapsulatedRawLittleEndian
- See Also:
-
Papyrus3ImplicitVRLittleEndian
- See Also:
-
transferSyntaxUID
-
description
-
bigEndian
protected boolean bigEndian -
explicitVR
protected boolean explicitVR -
encapsulatedPixelData
protected boolean encapsulatedPixelData -
lossy
protected boolean lossy -
recognized
protected boolean recognized -
jpegFamily
protected boolean jpegFamily -
fileNameExtension
-
-
Constructor Details
-
TransferSyntax
Construct a Transfer Syntax using the specified UID, automatically determining its characteristics.
- Parameters:
uid
- the UID to use to refer to this transfer syntax
-
TransferSyntax
public TransferSyntax(String transferSyntaxUID, String description, boolean explicitVR, boolean bigEndian, boolean encapsulatedPixelData, boolean lossy) Construct a Transfer Syntax using the specified UID and characteristics.
- Parameters:
transferSyntaxUID
- the UID to use to refer to this transfer syntaxdescription
- the description of this transfer syntaxexplicitVR
- true if an explicit VR transfer syntaxbigEndian
- true if big-endian transfer syntaxencapsulatedPixelData
- true if a pixel data encapsulated transfer syntaxlossy
- true if lossy compression
-
TransferSyntax
public TransferSyntax(String transferSyntaxUID, String description, boolean explicitVR, boolean bigEndian, boolean encapsulatedPixelData, boolean lossy, String fileNameExtension) Construct a Transfer Syntax using the specified UID and characteristics.
- Parameters:
transferSyntaxUID
- the UID to use to refer to this transfer syntaxdescription
- the description of this transfer syntaxexplicitVR
- true if an explicit VR transfer syntaxbigEndian
- true if big-endian transfer syntaxencapsulatedPixelData
- true if a pixel data encapsulated transfer syntaxlossy
- true if lossy compressionfileNameExtension
- fileNameExtension to use if bit stream is to be saved as a file
-
TransferSyntax
public TransferSyntax(String transferSyntaxUID, String description, boolean explicitVR, boolean bigEndian, boolean encapsulatedPixelData, boolean lossy, String fileNameExtension, boolean jpegFamily) Construct a Transfer Syntax using the specified UID and characteristics.
- Parameters:
transferSyntaxUID
- the UID to use to refer to this transfer syntaxdescription
- the description of this transfer syntaxexplicitVR
- true if an explicit VR transfer syntaxbigEndian
- true if big-endian transfer syntaxencapsulatedPixelData
- true if a pixel data encapsulated transfer syntaxlossy
- true if lossy compressionfileNameExtension
- fileNameExtension to use if bit stream is to be saved as a filejpegFamily
- true if uses JPEG family marker segments
-
-
Method Details
-
getUID
Get the UID of the Transfer Syntax.
- Returns:
- the UID of the Transfer Syntax
-
getDescription
Get a human-readable description of the Transfer Syntax.
- Returns:
- the description of the Transfer Syntax
-
isRecognized
public boolean isRecognized()Is the Transfer Syntax recognized ?
- Returns:
- true if recognized
-
isBigEndian
public boolean isBigEndian()Is the Transfer Syntax big endian ?
- Returns:
- true if big endian
-
isLittleEndian
public boolean isLittleEndian()Is the Transfer Syntax little endian ?
- Returns:
- true if little endian
-
isExplicitVR
public boolean isExplicitVR()Is the Transfer Syntax explicit VR ?
- Returns:
- true if explicit VR
-
isImplicitVR
public boolean isImplicitVR()Is the Transfer Syntax implicit VR ?
- Returns:
- true if implicit VR
-
isEncapsulated
public boolean isEncapsulated()Does the Transfer Syntax encapsulate the pixel data ?
- Returns:
- true if encapsulate
-
isNotEncapsulated
public boolean isNotEncapsulated()Does the Transfer Syntax encode the pixel data without encapsulation?
- Returns:
- true if not encapsulated
-
isLossy
public boolean isLossy()Is the Transfer Syntax potentially lossy ?
- Returns:
- true if lossy
-
getFileNameExtension
Get the file name extension appropriate for the Transfer Syntax.
Will be "unk" if unrecognized.
- Returns:
- the fileNameExtension to use if bit stream is to be saved as a file
-
isJPEGFamily
public boolean isJPEGFamily()Is the Transfer Syntax part of the JPEG family of Transfer Syntaxes?
I.e., those that share the same marker segments, such as the EOI marker used for end of frame in fragment detection.
- Returns:
- true if is JPEG family
-
isDeflated
public boolean isDeflated()Does the Transfer Syntax use deflate compression ?
- Returns:
- true if deflated
-
isBzip2ed
public boolean isBzip2ed()Does the Transfer Syntax use bzip2 compression ?
- Returns:
- true if bzip2
-
toString
Get the Transfer Syntax as a string.
-
dump
Describe the characteristics of Transfer Syntax.
- Returns:
- a detailed description of the Transfer Syntax
-
isExplicitVR
Is the Transfer Syntax with the specified UID explicit VR ?
- Parameters:
uid
-- Returns:
- true if explicit VR
-
isImplicitVR
Is the Transfer Syntax with the specified UID implicit VR ?
- Parameters:
uid
-- Returns:
- true if explicit VR
-
isBigEndian
Is the Transfer Syntax with the specified UID big endian ?
- Parameters:
uid
-- Returns:
- true if big endian
-
isLittleEndian
Is the Transfer Syntax with the specified UID little endian ?
- Parameters:
uid
-- Returns:
- true if little endian
-
isEncapsulated
Does the Transfer Syntax encapsulate the pixel data ?
- Parameters:
uid
-- Returns:
- true if encapsulate
-
isNotEncapsulated
Does the Transfer Syntax encode the pixel data without encapsulation?
- Parameters:
uid
-- Returns:
- true if not encapsulated
-