ImageDescription (Mango Plugin API)

java.lang.Object
- edu.uthscsa.ric.volume.ImageDescription

All Implemented Interfaces:

Cloneable
```
public class ImageDescription
extends Object
implements Cloneable
```
ImageDescription contains textual information describing the image.

Field Summary

Fields
Modifier and Type Field and Description

SimpleDateFormat DATE_FORMAT

SimpleDateFormat DATETIME_FORMAT

SimpleDateFormat TIME_FORMAT

Fields
Modifier and Type	Field and Description
`SimpleDateFormat`	`DATE_FORMAT`
`SimpleDateFormat`	`DATETIME_FORMAT`
`SimpleDateFormat`	`TIME_FORMAT`

Constructor Summary

Constructors
Constructor and Description
`ImageDescription()` The default class constructor.
`ImageDescription(String studyID, String studyName, Date studyDate, String studyDes)` Class constructor.
`ImageDescription(String id, String name, String time, String date, String des)` Deprecated.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`anonymize()` Clears this data.
`Object`	`clone()` Returns a copy of this object.
`String`	`getAllID()` Returns both ID and name.
`String`	`getAllTime()` Deprecated.
`URI[]`	`getAssociatedFiles()` Returns an array of files associated with this image (e.g., a multifile image format).
`String`	`getDate()` Deprecated.
`String`	`getDescription()` Returns the description.
`Map<Long,String>`	`getDicomItems()` Returns a map of DICOM tag id to string value (see setDicomItems() for more explanation).
`URI`	`getFile()` Returns the URI of this image.
`String`	`getID()` Returns the scan ID.
`String`	`getImageTypeDescription()` Returns a description of the image type.
`String`	`getName()` Returns the scan name.
`Date`	`getStudyDate()` Returns the study date.
`String`	`getStudyDateString()`
`String`	`getStudyDateTimeString()`
`String`	`getStudyTimeString()`
`String`	`getTime()` Deprecated.
`String`	`getTitle()` Returns a nice title for this image.
`boolean`	`hasBeenEdited()` Returns true if this object has been edited since construction.
`void`	`setAssociatedFiles(URI[] associatedFiles)` Sets an array of files associated with this image.
`void`	`setDate(String date)` Deprecated.
`void`	`setDescription(String des)` Sets the description.
`void`	`setDicomItems(Map<Long,String> dicomItems)` Sets a map of DICOM tag id to string value.
`void`	`setFile(URI file)` Sets the URI of this image.
`void`	`setID(String id)` Sets the scan ID.
`void`	`setImageTypeDescription(String imageTypeDescription)` Sets the image type description.
`void`	`setName(String name)` Sets the scan name.
`void`	`setStudyDate(Date studyDate)` Sets the study date.
`void`	`setTime(String time)` Deprecated.
`void`	`setTitle(String title)` Sets a nice title for this image.
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DATETIME_FORMAT
```
public final SimpleDateFormat DATETIME_FORMAT
```
  - DATE_FORMAT
```
public final SimpleDateFormat DATE_FORMAT
```
  - TIME_FORMAT
```
public final SimpleDateFormat TIME_FORMAT
```
- Constructor Detail
  - ImageDescription
```
public ImageDescription()
```
    The default class constructor.
  - ImageDescription
```
@Deprecated
public ImageDescription(String id,
                           String name,
                           String time,
                           String date,
                           String des)
```
    Deprecated.
    
    Class constructor. Arguments include common textual information found in image headers.
    
    Parameters:
    id - the scan ID
    name - the name associated with the scan (e.g., patient name)
    time - the scan time
    date - the scan date
    des - any further description
  - ImageDescription
```
public ImageDescription(String studyID,
                String studyName,
                Date studyDate,
                String studyDes)
```
    Class constructor. Arguments include common textual information found in image headers.
    
    Parameters:
    studyID - the study ID
    studyName - the study name
    studyDate - the scan date
    studyDes - the study description
- Method Detail
  - anonymize
```
public void anonymize()
```
    Clears this data.
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Returns a copy of this object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    clone object
    
    Throws:
    
    CloneNotSupportedException - clone not supported exception
  - getAllID
```
public String getAllID()
```
    Returns both ID and name.
    
    Returns:
    ID and name
  - getAllTime
```
@Deprecated
public String getAllTime()
```
    Deprecated.
    
    Returns both time and date.
    
    Returns:
    time and date
  - getAssociatedFiles
```
public URI[] getAssociatedFiles()
```
    Returns an array of files associated with this image (e.g., a multifile image format).
    
    Returns:
    an array of files
  - getDate
```
@Deprecated
public String getDate()
```
    Deprecated.
    
    Returns the scan date.
    
    Returns:
    the scan date
  - getDescription
```
public String getDescription()
```
    Returns the description.
    
    Returns:
    the description
  - getDicomItems
```
public Map<Long,String> getDicomItems()
```
    Returns a map of DICOM tag id to string value (see setDicomItems() for more explanation).
    
    Returns:
    a map of dicom tags to data
  - getFile
```
public URI getFile()
```
    Returns the URI of this image.
    
    Returns:
    the URI
  - getID
```
public String getID()
```
    Returns the scan ID.
    
    Returns:
    the scan ID
  - getName
```
public String getName()
```
    Returns the scan name.
    
    Returns:
    the scan name
  - getTime
```
@Deprecated
public String getTime()
```
    Deprecated.
    
    Returns the scan time.
    
    Returns:
    the scan time
  - getTitle
```
public String getTitle()
```
    Returns a nice title for this image.
    
    Returns:
    a nice title for this image
  - hasBeenEdited
```
public boolean hasBeenEdited()
```
    Returns true if this object has been edited since construction.
    
    Returns:
    true if edited, false otherwise
  - setAssociatedFiles
```
public void setAssociatedFiles(URI[] associatedFiles)
```
    Sets an array of files associated with this image.
    
    Parameters:
    associatedFiles - an array of file
  - setDate
```
@Deprecated
public void setDate(String date)
```
    Deprecated.
    
    Sets the scan date.
    
    Parameters:
    date - the scan date
  - setDescription
```
public void setDescription(String des)
```
    Sets the description.
    
    Parameters:
    des - the description
  - setDicomItems
```
public void setDicomItems(Map<Long,String> dicomItems)
```
    Sets a map of DICOM tag id to string value. This map in intended to serve as a general way to store metadata information among different image format header types. The long map key is a concatenation of two integers corresponding to the DICOM tag group and element values. The value is a string representation of the DICOM tag value.
    
    Parameters:
    dicomItems - the DICOM map
  - setFile
```
public void setFile(URI file)
```
    Sets the URI of this image.
    
    Parameters:
    file - the URI
  - setID
```
public void setID(String id)
```
    Sets the scan ID.
    
    Parameters:
    id - the scan ID
  - setName
```
public void setName(String name)
```
    Sets the scan name.
    
    Parameters:
    name - the scan name
  - setTime
```
@Deprecated
public void setTime(String time)
```
    Deprecated.
    
    Sets the scan time.
    
    Parameters:
    time - the scan time
  - setTitle
```
public void setTitle(String title)
```
    Sets a nice title for this image.
    
    Parameters:
    title -
  - toString
```
public String toString()
```
    Returns a string representation of this object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of this object
  - getImageTypeDescription
```
public String getImageTypeDescription()
```
    Returns a description of the image type.
    
    Returns:
    a description of the image type
  - setImageTypeDescription
```
public void setImageTypeDescription(String imageTypeDescription)
```
    Sets the image type description.
    
    Parameters:
    imageTypeDescription - the image type description
  - setStudyDate
```
public void setStudyDate(Date studyDate)
```
    Sets the study date.
    
    Parameters:
    studyDate - the study date
  - getStudyDate
```
public Date getStudyDate()
```
    Returns the study date.
    
    Returns:
    the study date
  - getStudyDateString
```
public String getStudyDateString()
```
  - getStudyTimeString
```
public String getStudyTimeString()
```
  - getStudyDateTimeString
```
public String getStudyDateTimeString()
```

Class ImageDescription

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATETIME_FORMAT

DATE_FORMAT

TIME_FORMAT

Constructor Detail

ImageDescription

ImageDescription

ImageDescription

Method Detail

anonymize

clone

getAllID

getAllTime

getAssociatedFiles

getDate

getDescription

getDicomItems

getFile

getID

getName

getTime

getTitle

hasBeenEdited

setAssociatedFiles

setDate

setDescription

setDicomItems

setFile

setID

setName

setTime

setTitle

toString

getImageTypeDescription

setImageTypeDescription

setStudyDate

getStudyDate

getStudyDateString

getStudyTimeString

getStudyDateTimeString