Class DescriptionFactory
A class of static methods to provide descriptions of images, including image orientation relative to the patient from the mathematical position and orientation attributes, and including other descriptive attributes such as from dicom directory records and images using multi-frame functional groups.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic final String
getMajorAxisFromPatientRelativeDirectionCosine
(double x, double y, double z) Get a label describing the major axis from a unit vector (direction cosine) as found in ImageOrientationPatient.static final String
Get a human readable string meaningfully describing an image from an attribute list such as from a directory record.static final String
makeImageDescription
(Map attributes) Get a human readable string meaningfully describing an image from a map of names and values such as from a database.static final String
makeImageOrientationLabelFromImageOrientationPatient
(double rowX, double rowY, double rowZ, double colX, double colY, double colZ) Get a label describing the axial, coronal or sagittal plane from row and column unit vectors (direction cosines) as found in ImageOrientationPatient.static final String
makeImageOrientationLabelFromImageOrientationPatient
(Attribute aImageOrientationPatient) Get a label describing the axial, coronal or sagittal plane from row and column unit vectors (direction cosines) in ImageOrientationPatient.static final String
Get a label describing the axial, coronal or sagittal plane from row and column unit vectors (direction cosines) found in ImageOrientationPatient in the supplied AttributeList.static final String
makePatientDescription
(Map attributes) Get a human readable string meaningfully describing a patient from an attribute list such as from a database or directory record.static final String
makePatientOrientationFromImageOrientationPatient
(double rowX, double rowY, double rowZ, double colX, double colY, double colZ) Get a PatientOrientation style string from row and column unit vectors (direction cosines) as found in ImageOrientationPatient.static final String
makePatientOrientationFromPatientRelativeDirectionCosine
(double x, double y, double z) Get a PatientOrientation style string from a unit vector (direction cosine) as found in ImageOrientationPatient.static final String
Get a human readable string meaningfully describing a series from an attribute list such as from a directory record.static final String
makeSeriesDescription
(Map attributes) Get a human readable string meaningfully describing a series from an attribute list such as from a directory record.
-
Field Details
-
AXIAL_LABEL
- See Also:
-
CORONAL_LABEL
- See Also:
-
SAGITTAL_LABEL
- See Also:
-
OBLIQUE_LABEL
- See Also:
-
-
Constructor Details
-
DescriptionFactory
public DescriptionFactory()
-
-
Method Details
-
getMajorAxisFromPatientRelativeDirectionCosine
public static final String getMajorAxisFromPatientRelativeDirectionCosine(double x, double y, double z) Get a label describing the major axis from a unit vector (direction cosine) as found in ImageOrientationPatient.
Some degree of deviation from one of the standard orthogonal axes is allowed before deciding no major axis applies and returning null.
- Parameters:
x
- x component between -1 and 1y
- y component between -1 and 1z
- z component between -1 and 1- Returns:
- the string describing the orientation of the vector, or null if oblique
-
makeImageOrientationLabelFromImageOrientationPatient
public static final String makeImageOrientationLabelFromImageOrientationPatient(double rowX, double rowY, double rowZ, double colX, double colY, double colZ) Get a label describing the axial, coronal or sagittal plane from row and column unit vectors (direction cosines) as found in ImageOrientationPatient.
Some degree of deviation from one of the standard orthogonal planes is allowed before deciding the plane is OBLIQUE.
- Parameters:
rowX
- row x component between -1 and 1rowY
- row y component between -1 and 1rowZ
- row z component between -1 and 1colX
- column x component between -1 and 1colY
- column y component between -1 and 1colZ
- column z component between -1 and 1- Returns:
- the string describing the plane of orientation, AXIAL, CORONAL, SAGITTAL or OBLIQUE, or null if undetermined
-
makeImageOrientationLabelFromImageOrientationPatient
public static final String makeImageOrientationLabelFromImageOrientationPatient(Attribute aImageOrientationPatient) Get a label describing the axial, coronal or sagittal plane from row and column unit vectors (direction cosines) in ImageOrientationPatient.
Some degree of deviation from one of the standard orthogonal planes is allowed before deciding the plane is OBLIQUE.
- Parameters:
aImageOrientationPatient
- attribute containing the patient-relative orientation- Returns:
- the string describing the plane of orientation, AXIAL, CORONAL, SAGITTAL or OBLIQUE, or null if undetermined
-
makeImageOrientationLabelFromImageOrientationPatient
Get a label describing the axial, coronal or sagittal plane from row and column unit vectors (direction cosines) found in ImageOrientationPatient in the supplied AttributeList.
Some degree of deviation from one of the standard orthogonal planes is allowed before deciding the plane is OBLIQUE.
- Parameters:
list
- list of attributes containing ImageOrientationPatient- Returns:
- the string describing the plane of orientation, AXIAL, CORONAL, SAGITTAL or OBLIQUE, or null if undetermined
-
makePatientOrientationFromPatientRelativeDirectionCosine
public static final String makePatientOrientationFromPatientRelativeDirectionCosine(double x, double y, double z) Get a PatientOrientation style string from a unit vector (direction cosine) as found in ImageOrientationPatient.
Returns letters representing R (right) or L (left), A (anterior) or P (posterior), F (feet) or H (head).
If the orientation is not precisely orthogonal to one of the major axes, more than one letter is returned, from major to minor axes, with up to three letters in the case of a "double oblique".
- Parameters:
x
- x component between -1 and 1y
- y component between -1 and 1z
- z component between -1 and 1- Returns:
- the string describing the orientation of the vector
-
makePatientOrientationFromImageOrientationPatient
public static final String makePatientOrientationFromImageOrientationPatient(double rowX, double rowY, double rowZ, double colX, double colY, double colZ) Get a PatientOrientation style string from row and column unit vectors (direction cosines) as found in ImageOrientationPatient.
Returns letters representing R (right) or L (left), A (anterior) or P (posterior), F (feet) or H (head).
If the orientation is not precisely orthogonal to one of the major axes, more than one letter is returned, from major to minor axes, with up to three letters in the case of a "double oblique".
The row and column letters returned are separated by the usual DICOM string delimiter, a backslash.
- Parameters:
rowX
- row x component between -1 and 1rowY
- row y component between -1 and 1rowZ
- row z component between -1 and 1colX
- column x component between -1 and 1colY
- column y component between -1 and 1colZ
- column z component between -1 and 1- Returns:
- the string describing the row and then the column
-
makeImageDescription
Get a human readable string meaningfully describing an image from an attribute list such as from a directory record.
This version is heavily tuned to describe MR multiframe images thoroughly.
- Parameters:
list
- the list of attributes (such as from an IMAGE level directory record)- Returns:
- a human readable string meaningfully describing the image
-
makeImageDescription
Get a human readable string meaningfully describing an image from a map of names and values such as from a database.
This version is heavily tuned to describe MR multiframe images thoroughly.
- Parameters:
attributes
- the map of upper case named attributes and their values (such as from a database query)- Returns:
- a human readable string meaningfully describing the image
-
makeSeriesDescription
Get a human readable string meaningfully describing a series from an attribute list such as from a directory record.
- Parameters:
list
- the list of attributes (such as from a SERIES level directory record)- Returns:
- a human readable string meaningfully describing the series
-
makeSeriesDescription
Get a human readable string meaningfully describing a series from an attribute list such as from a directory record.
- Parameters:
attributes
- the map of upper case named attributes and their values (such as from a database query)- Returns:
- a human readable string meaningfully describing the series
-
makePatientDescription
Get a human readable string meaningfully describing a patient from an attribute list such as from a database or directory record.
- Parameters:
attributes
- the map of upper case named attributes and their values (such as from a database query)- Returns:
- a human readable string meaningfully describing the patient
-