public class FrameSet extends Object
A class to describe a set of frames sharing common characteristics suitable for display or analysis as an entity.
There is no constructor or factory method, since one or more FrameSet
s is created by using SetOfFrameSets
.
The list of "distinguishing" attributes that are used to determine commonality is currently fixed, and includes the unique identifying attributes at the Patient, Study, Equipment levels, the Modality and SOP Class, and ImageType as well as the characteristics of the Pixel Data, and those attributes that for cross-sectional images imply consistent sampling, such as ImageOrientationPatient, PixelSpacing and SliceThickness, and in addition AcquisitionContextSequence and BurnedInAnnotation.
Note that Series identification, specifically SeriesInstanceUID is NOT a distinguishing attribute; i.e.,
FrameSet
s may span Series.
Modifier and Type | Method and Description |
---|---|
static Set<AttributeTag> |
getAttributeTagsInMapWithValues(Map<AttributeTag,String> map)
Given a map of tags to values or empty strings, return only those with values.
|
Set<AttributeTag> |
getDistinguishingAttributeTags()
Get the distinguishing AttributeTags used in this
FrameSet that are present with values. |
Set<AttributeTag> |
getPerFrameAttributeTags()
Get the per-frame varying AttributeTags used in this
FrameSet that are present with values. |
Set<AttributeTag> |
getSharedAttributeTags()
Get the shared AttributeTags used in this
FrameSet that are present with values. |
List<String> |
getSOPInstanceUIDsSortedByFrameOrder()
Get a sorted list of the frames.
|
int |
size()
Get the number of frames in this
FrameSet . |
String |
toString()
Return a String representing this object's value.
|
public List<String> getSOPInstanceUIDsSortedByFrameOrder()
Get a sorted list of the frames.
public static Set<AttributeTag> getAttributeTagsInMapWithValues(Map<AttributeTag,String> map)
Given a map of tags to values or empty strings, return only those with values.
map
- a Map
of AttributeTag
s to String
sSet
of AttributeTag
spublic Set<AttributeTag> getDistinguishingAttributeTags()
Get the distinguishing AttributeTags used in this FrameSet
that are present with values.
public Set<AttributeTag> getSharedAttributeTags()
Get the shared AttributeTags used in this FrameSet
that are present with values.
public Set<AttributeTag> getPerFrameAttributeTags()
Get the per-frame varying AttributeTags used in this FrameSet
that are present with values.
This is the set used in any frame (not necessarily all frames).
public int size()
Get the number of frames in this FrameSet
.
FrameSet