1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
|
<html>
<head>
<title>How to use DicomCleaner</title>
</head>
<body>
<table width="100%">
<tr>
<td><img SRC="images/PixelMedLogoAndTitle.gif" ALT="PixelMed Publishing" BORDER=0></td>
<td><A HREF="http://www.opensource.org/"><IMG SRC="images/osi_standard_logo.png" width="90" height="103" border="0"/></A></td>
</tr>
</table>
<hr/>
<table>
<tr>
<td><a href="DicomCleaner.html"><IMG SRC="images/DicomCleanerMainPanelAfterClean.png" BORDER=0/></a></td>
</tr>
</table>
<hr/>
<a href="DicomCleaner.html"><IMG SRC="icons/DicomCleaner.png" ALT="Click here to start the DicomCleaner" BORDER=0/></a>
<a name="Description"><h1>What is <a href="DicomCleaner.html">DicomCleaner</a>?</h1></a>
<p><a href="DicomCleaner.html">DicomCleaner</a> is a free open source tool with a user interface for importing, "cleaning" and saving sets of DICOM instances (files). It can:</p>
<ul>
<li>Import files from a CD or the local hard drive or a shared network drive or any other media, with or without a DICOMDIR</li>
<li>Query and retrieve from remote DICOM devices</li>
<li>"Clean" the DICOM "header" of a selected set of instances</li>
<li>Blackout burned in annotations in the pixel data of the cleaned files</li>
<li>Export the cleaned instances to a folder with a DICOMDIR, which can be burned to a CD or DVD</li>
<li>Send the cleaned instances over the network to a remote DICOM device</li>
</ul>
<a name="Cleaning"><h1>What does "cleaning" mean?</h1></a>
<p>"Cleaning" is used to refer to the process of removing and/or replacing information in the DICOM "header". The user is given control over
what to remove and replace, including the ability to import and export without doing any cleaning at all, or to completely de-identify
the header and replace the identifying attributes with new values. Use cases that are supported include:</p>
<ul>
<li>Importing images into the local PACS, changing the Patient ID and Accession Number to local values</li>
<li>Cleaning images for research or teaching, by removing identifiers and replacing them with dummy values</li>
</ul>
<p>The user is provide with control over:</p>
<ul>
<li>Replacement values for Patient's Name, Patient's ID and Accession Number</li>
<li>Replacement of all other identifying attributes (e.g., referring doctor's name, etc.)</li>
<li>Removal of descriptions (e.g., Study Description), which though useful may sometimes have identifying information, with an option to retain only the Series Description (which is generally both useful and safe)</li>
<li>Removal of patient characteristics (e.g., sex and weight), which are essential for PET SUV but otherwise often removed</li>
<li>Replacement of DICOM unique identifiers, which is performed consistently for a set of instances to maintain referential integrity</li>
<li>Removal of private attributes, except those that are known to be safe to leave and are important (e.g., SUV scale factor)</li>
<li>Addition of a description of the <a href="DicomCleaner.html">DicomCleaner</a> software as contributing equipment, to maintain a record in the cleaned instances of what tool was used</li>
<li>Export of DICOM files and DICOMDIR directly into a zip file, rather than a folder intended for CD burning</li>
</ul>
<center>
<table>
<tr>
<td><IMG SRC="images/DicomCleanerControlPanel.png"/></td>
</tr>
</table>
</center>
<h1>Blackout</h1>
<p>Some types of images, particularly ultrasound, screen shots of analysis panels and 3D rendering, digitized film or paper documents, and some nuclear medicine images, contain
identifying information not just in the DICOM "header", but also burned in to the pixel data, which needs to be "blacked out" by replacing the pixel values using an image editor.</p>
<p>The "Blackout" button in the main <a href="DicomCleaner.html">DicomCleaner</a> control panel provides this capability. When a set of images has been cleaned and selected in the "Cleaned" panel,
pressing "Blackout" brings up an image editor that allows rectangular regions of the image to be filled with black pixels.</p>
<center>
<table>
<tr>
<td><IMG SRC="images/DicomImageBlackoutColorUltrasound.png"/></td>
</tr>
</table>
</center>
<p>The user has control over which value is used to replace the blacked out pixels. If Use Padding and Use Zero are unchecked,
then the lowest possible pixel value given the signedness and bit depth of the pixel data will be used. If Use Padding is checked
(which it is by default), then Pixel Padding Value, if present in the header, will be used instead of the lowest possible value. If
Use Zero is checked, than a value of zero will always be used, regardless of the lowest possible value or Pixel Padding Value; this
is sometimes necessary if no windowing information is present in the header, and the lowest possible value turns out to be very -ve
(everything turns white after Save is pressed).</p>
<p>Some images also contain information in overlay planes that are intended to be displayed on top of the pixel data, and this also can contain identifiable information that needs
to be removed.</p>
<p>The "Overlays" checkbox in the "Blackout" panel activitates display of this information, which can then be blacked out, in which case the remaining overlay information will
be "burned in" to the saved pixel data and the overlays themselves removed. Indeed, even if there is no need to blackout the overlay information, the side effect of burning in the overlay
may be useful, particularly if downstream viewers do not support overlay display, as many do not.</p>
<center>
<table>
<tr>
<td><IMG SRC="images/DicomImageBlackoutOverlayDose.png"/></td>
</tr>
</table>
</center>
<a name="Usage"><h1>How to start it</h1></a>
<p><a href="DicomCleaner.html">DicomCleaner</a> is an Java Web Start (JWS) application that you can run from within a web browser. It runs on any platform that supports Java 1.5 or greater,
and does not require any "installation" per se. Just click on the <a href="DicomCleaner.html">DicomCleaner</a> link. If you like, you can right-click on
the <a href="DicomCleaner.html">link</a> to save it as a Desktop Shortcut to make it as easy to start up as any other application, but this is not required, since you can always start it from a browser.</p>
<center>
<table>
<tr>
<td><IMG SRC="images/DicomCleanerCopyShortcut.png"/></td>
<td><IMG SRC="images/DicomCleanerPasteShortcut.png"/></td>
</tr>
</table>
</center>
<p>Whenever you use the web start application, it will automatically check for the
latest version on the web site and use that, so you never need to be concerned about upgrading or maintenance.</p>
<p>If you want to use a DICOM network (rather than importing from or exporting to folders and files), you can use the "Configure" button to enter information
about remote DICOM network devices and the port and AET of the DicomCleaner itself.</p>
<center>
<table>
<tr>
<td><IMG SRC="images/DicomCleanerLocalConfiguration.png"/></td>
<td><IMG SRC="images/DicomCleanerRemoteConfiguration.png"/></td>
</tr>
</table>
</center>
<p>This information will be saved in a properties files located in
the user's home directory, called ".com.pixelmed.display.DicomCleaner.properties", so that you do not have to re-enter it next time. The
property file can also be created or edited manually, though any comments will be lost when the "Configure" button in the user interface is used to
update it. Here is an <a href="sample.com.pixelmed.display.DicomCleaner.properties">example</a> properties file.
The application also supports DNS self-discovery of other DICOM applications, though this is not widely deployed.</p>
<a name="Installation"><h1>How to install it (locally)</h1></a>
<p>If for some reason you do not want to start the application using Java Web Start, but instead want to download it and install it, several versions are available:</p>
<ul>
<li><a href="http://www.dclunie.com/pixelmed/software/winexe/DicomCleanerWithOwnJRE.zip">Windows executable that does not require Java to be installed</a> [approx. 45 MB] (includes its own JRE, internationalized fonts, and JIIO libraries)</li>
<li><a href="http://www.dclunie.com/pixelmed/software/winexe/DicomCleanerAssumingJREInstalled.zip">Windows executable that requires Java 1.5 or later to already be installed</a> [approx. 3.9 MB] (includes its own JIIO libraries, since these are often not installed)</li>
<li><a href="http://www.dclunie.com/pixelmed/software/macexe/DicomCleanerMac.zip">MacOS executable that requires Java 1.5 or later to already be installed</a> [approx. 2.1 MB] (includes pure Java JIIO libraries for limited decompression support)</li>
</ul>
<p>The downloaded installable version does NOT automatically update when new versions are released, however.</p>
<p>If you need to report a problem, and want to know what version you are using, look at the status bar immediately after startint the application:</p>
<center>
<table>
<tr>
<td><IMG SRC="images/DicomCleanerShowVersion.png"/></td>
</tr>
</table>
</center>
<p>The open source code is contained within the <a href="http://www.dclunie.com/pixelmed/software/">PixelMed toolkit</a>.</p>
<hr/>
<a href="DicomCleaner.html"><IMG SRC="icons/DicomCleaner.png" ALT="Click here to start the DicomCleaner" BORDER=0/></a>
<p></a>Click here to start the <a href="DicomCleaner.html">DicomCleaner</a>.</p>
</body>
</html>
|