Doc/Website/News.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <HTML>
   3 <HEAD>
   4    <META http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   5    <TITLE>Gdcm News</TITLE>
   6 </HEAD>
   7
   8 <BODY>
   9
  10
  11 <!--#######################################################################-->
  12 <H1>Gdcm News</a></H1>
  13
  14 <!--#######################################################################-->
  15
  16 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
  17 <H2>
  18    <A CLASS="anchor" NAME="missing">
  19       <B>Missing features</B></A>
  20 </H2>
  21 We know the following are missing; don't loose time looking for them ...<br>
  22 We know they could be helpfull. We shall add them some day.<br>
  23 Any contribution is welcome.
  24 <UL>
  25 <LI> Decoders
  26    <UL>
  27       <LI> gdcm doesn't read yet <TT>JPEG-LS</TT> encoded files.
  28       <UL>
  29           We said '<TT>JPEG-LS</TT>', not Lossless Jpeg ...<br>
  30           [<TT>JPEG-LS</TT> is the basis for new lossless/near-lossless compression
  31           standard for continuous-tone images intended for <TT>JPEG2000</TT>.
  32           The standard is based on the LOCO-I algorithm
  33           (LOw COmplexity LOssless COmpression for Images)
  34           developed at Hewlett-Packard Laboratories]
  35      </UL>
  36      <LI> gdcm doesn't read yet all <TT>JPEG2000</TT> encoded files.
  37      <UL>
  38          But we are working on it (a lot of troubles with Jasper).
  39       </UL>
  40       <LI> gdcm doesn't read yet <TT>MPEG2</TT> encoded files.
  41       <UL>
  42           But we are working on it.
  43       </UL>
  44    </UL>
  45    <LI>Reader
  46    <UL>
  47       <LI> Allow user to tell <TT>gdcm::Document</TT> constructor he just wants
  48            to load a given list of <TT>DocEntries</TT>
  49            (to save CPU time and RAM space)
  50       <LI> Allow user to tell <TT>gdcm::Document</TT> constructor he wants
  51            to force the loading of a given list of <TT>DocEntries</TT>,
  52            even if there length exceeds the current
  53            <TT>MAX_SIZE_LOAD_ELEMENT_VALUE</TT>.
  54       <LI> Allow 'frame by frame' reading (should be helpfull for huge
  55            multiframe images)
  56       <LI> Allow subvolume selection / frames selection before reading.
  57       <LI> Expose Read/Decompression mechanisms to allow user getting
  58          information from <tt>DICOMDIR</TT> <br> -or from his own Data Base-
  59          and reading his images without parsing
  60          the header, one more time.
  61    </UL>
  62    <LI>Writer
  63    <UL>
  64       <LI> Allow user to tell the Writer he doesn't want to write down
  65            <TT>SeqEntry</TT> (if any)
  66       <LI> Allow user to tell the Writer he doesn't want to write down
  67            <TT>Shadow groups</TT> (if any)
  68       <LI> Allow user to tell the Writer which compression mode he wants<br>
  69            (Right now, no one is available)
  70       <LI> Allow user to tell the Writer he wants to split a
  71            <TT>Multiframe</TT> image into a serie of
  72            <TT>Single frame</TT> images.
  73       <LI> Allow user to tell the Writer he wants to agregate a
  74            Serie of <TT>Single frame</TT> images into a
  75            <TT>Multiframe</TT> image.
  76    </UL>
  77 <LI>Reader / Writer
  78    <UL>
  79       <LI> Full <TT>Icon Image</TT> management (Read and Write)
  80       <LI> Full <TT>Overlays</TT> management (Read and Write) <br>
  81            both for '<TT>ACR-NEMA</TT> style' (using groups <TT>0x6000</TT>
  82             and nexts) and '<TT>DICOM V3</TT> style' (using Sequences)
  83    </UL>
  84 <LI> <TT>DICOMDIR</TT>
  85     <UL>
  86       <LI> <TT>DICOMDIR</TT> full management (not limited to
  87            <TT> PATIENT</TT>/<TT>STUDY</TT>/<TT>SERIE</TT>/<TT>IMAGE</TT>)
  88       <LI> Allow user to add an entry (belonging to the file header Dicom
  89            entries)to the default entry list, before
  90            making a <TT>DICOMDIR</TT> from a root directory
  91       <LI> Allow user to add an entry of his owns (for instance an <TT>Icon</TT>
  92            to each image, or to each Serie).
  93       </UL>
  94 <LI> SerieHelper
  95    <UL>
  96
  97       <LI> An accurate <TT>SerieHelper</TT> <br>
  98            Right now <TT>SerieHelper</TT> only works on 'bona fide Series', and
  99            breaks on wrongly forged Series.<br>
 100            We are still looking for any heuristics...
 101       <LI> A <TT>SerieHelper</TT> that would use the <TT>DICOMDIR</TT> (if any)
 102         instead of parsing all the files within the Root Directory
 103    </UL>
 104 <LI> Other
 105    <UL>
 106       <LI> 16-bits-LUT full Management
 107       <LI> User friendly management of <TT>Rescale Slope</TT> and
 108            <TT>Rescale Intercept</TT>
 109       <LI> Allow parsing the <TT>Shadow groups</TT> against a user supplied
 110            private <TT>Dicom Dictionary</TT> (pfff!...)
 111    </UL>
 112 </UL>
 113 <!#######################################################################>
 114 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
 115 <H2>
 116    <A CLASS="anchor" NAME="NewsCurrentVersion">
 117    <B>Current Version</B></A>
 118       <B></B></A>
 119 </H2>
 120
 121 <UL>
 122    <LI>State of the art
 123    <UL>
 124       <LI>
 125          <a href="uml-gdcm.pdf">gdcm UML Class Diagram</a> current version.
 126       <br><br>
 127    </UL>
 128    <LI> <A HREF="News.html#missing">Missing Features</a>
 129    <LI> New Features
 130    <UL>
 131       <LI> <TT>AnonymizeNoLoad</TT> used with <TT>dirin=inputDirectoryName</TT>
 132            anonymizes all the files within the given Directory.
 133            <br>
 134            User may also choose extra elements he wants to rub out: <br>
 135            <TT>rubout=listOfElementsToRubOut</TT><br>
 136            with <tt>listOfElementsToRubOut : group1-elem1,group2-elem2,
 137            ...</TT> (in hexa, no space within the list )
 138            <br><br>
 139       <LI> <TT>gdcm::SerieHelper()</TT> has a new method
 140            <TT>void AddGdcmFile(File *header)</TT>, that allows aware user to
 141            create a '<TT>FileList</TT>' (actually a
 142            <TT>std::vector< File* > </TT>).<br>
 143            The <TT>FileList</TT> created this way will be the
 144            'first one' in the <TT>gdcm::FileHelper()</TT> (retrieve it with
 145            <TT>FileList *GetFirstCoherentFileList()</TT> ).<br>
 146            It may be sorted using <TT>OrderFileList</TT>.<br>
 147            No 'coherence check' will be performed on this <TT>FileList</TT>
 148            before sorting.<br>
 149            It may be passed to a <TT>vtkGdcmReader</TT>
 150            (to avoid parsing twice the files)
 151            <br><br>
 152       <LI> <TT>vtkGdcmReader</TT> can now get the result of
 153            <TT>gdcm::SerieHelper</TT> (to avoid parsing twice the files)<br>
 154             Proceed as follow :<br>
 155            <pre>
 156            gdcmSerieHelper *sh = new gdcmSerieHelper();
 157            sh->SetDirectory(myImageDirectory, true);
 158            gdcmFileList *l = s->GetFirstCoherentFileList();
 159            s->OrderFileList(l);
 160
 161            vtkGdcmReader *gr = new vtkGdcmReader();
 162            gr->SetCoherentFileList(l);
 163            gr->Update();
 164            </pre>
 165            This works with a directory that contains only one '<TT>Serie</TT>'
 166            (same <TT>Serie UID</TT> for all the images).<br>
 167            If it contains more than one <TT>Serie</TT>, you'll have to loop
 168            on the Series, using <TT>GetNextCoherentFileList()</TT>;<br>
 169            It will be up to the user to delete the <TT>gdcm::File</TT>.
 170            <br><br>
 171            See <TT>vtkgdcmSerieViewer</TT> for an example.
 172            <br><br>
 173       <LI>Both <TT>vtkgdcmViewer</TT> and <TT>vtkgdcmViewer2</TT>
 174           are available to allow easy displaying of single/multiframe
 175           GreyLevel/RGB/PaletteColor images<br><br>
 176       <LI> <TT>DICOMDIR</TT> anonymiser (<TT>Load</TT> and <TT>Noload</TT> mode)
 177            <br><br>
 178       <LI> Because the <TT>gdcm::DicomDir::Load()</TT> method may be used
 179            either for loading an already made <TT>DICOMDIR</TT> file or for
 180            parsing all the dicom files with a given root directory we
 181            syntaxically separated the operations: <br>
 182            For loading an already made <TT>DICOMDIR</TT> file, use : <br>
 183            <pre>
 184            gdcm::DicomDir *d = new gdcm::DicomDir();
 185            d->SetFileName(fileName);
 186            d->Load( );
 187            </pre>
 188
 189            For parsing all the dicom files within a given root directory, use :<br>
 190            <pre>
 191            gdcm::DicomDir *d = new gdcm::DicomDir();
 192            d->SetDirectoryName(dirName);
 193            d->Load( )
 194            </pre>
 195
 196            <b>Don't</b> use any longer old deprecated style: <br>
 197            <TT>
 198            gdcm::DicomDir *d = new gdcm::DicomDir();<br>
 199            d->SetParseDir(true);   // </TT>or <TT>d->SetParseDir(false);<br>
 200            d->Load( fileName );<br>
 201            </TT>
 202            <br>
 203       <LI> User is now allowed to tell <TT>gdcm::Document</TT> constructor
 204             he doesn't want to deal with <TT>SeqEntry</TT>
 205             (every time it's possible) <br> and/or he doesn't
 206             want to deal with <TT>Shadow groups</TT> (every time it's
 207             possible) <br> or he doesn't
 208             want to deal with <TT>SeqEntry</TT> that belong to a <TT>Shadow group</TT>  (every time it's
 209             possible)<br>
 210             use : <br>
 211             <pre>
 212             gdcm::File *f = new gdcm::File();
 213                   f->SetLoadMode(NO_SEQ);            | depending on what
 214                   f->SetLoadMode(NO_SHADOW);         | you want *not*
 215                   f->SetLoadMode(NO_SEQ | NO_SHADOW);| to load from the
 216                   f->SetLoadMode(NO_SHADOWSEQ);      | target file
 217             f->SetFileName(fileName);
 218             f->Load( );
 219             </pre>
 220             <b>Don't</b> use any longer old deprecated style: <br>
 221             <TT>
 222             gdcm::File *f = new gdcm::File(fileName);</TT> <br>
 223             <br>
 224         <LI> User is now allowed to tell <TT>gdcm::DicomDir</TT> constructor
 225             he doesn't want to deal with <TT>SeqEntry</TT>
 226             (every time it's possible) <br> and/or he doesn't
 227             want to deal with <TT>Shadow groups</TT> (every time it's
 228             possible) <br> or he doesn't
 229             want to deal with <TT>SeqEntry</TT> that belong to a <TT>Shadow group</TT>  (every time it's
 230             possible)<br> when he parses all the Dicom files within a given
 231             directory
 232             use : <br>
 233             <pre>
 234             gdcm::DicomDir *f = new gdcm::DicomDir();
 235                   f->SetLoadMode(NO_SEQ);            | depending on what
 236                   f->SetLoadMode(NO_SHADOW);         | you want *not*
 237                   f->SetLoadMode(NO_SEQ | NO_SHADOW);| to load from the files
 238                   f->SetLoadMode(NO_SHADOWSEQ);      | within the root directory
 239             f->SetDirectoryName(rootDirectoryName);
 240             f->Load( );
 241             </pre>
 242             <b>Don't</b> use any longer old deprecated style: <br>
 243             <TT>
 244             gdcm::DicomDir *dcmdir = new gdcm::DicomDir(dirName, true);</TT><br>
 245             <br>
 246    </UL>
 247
 248    <LI> Bug fixes
 249    <UL>
 250       <LI> The difference between <TT>MONOCHROME1</TT> (low values = bright,
 251             high values = dark) and <TT>MONOCHROME2</TT> (low values = dark,
 252             high values = bright) is now taken into account.<br>
 253             It's no longer up to the user to change the pixels value
 254       <LI> Writing a 'True Dicom' image after reading an <TT>ACR-NEMA</TT> image
 255            does not request any longer from the user to build up
 256            'manually' the Meta Elements group (<TT>Ox0002</TT>)
 257       <LI> Old '24 Bits' <TT>ACR-NEMA</TT> are now correctly re-written
 258            in <TT>DICOM V3</TT> mode.
 259       <LI> Element <TT>0x0000</TT> of <TT>Shadow groups</TT> is always forced to be a
 260            <TT>ValEntry</TT> and its <TT>VR</TT> is forced to <TT>UL</TT>
 261       <br><br>
 262    </UL>
 263
 264    <LI> A.P.I. breaking modifications (since previous version : <TT>1.0</TT>)
 265    <UL>
 266       <LI> NEVER more API breaking modifications !!!
 267       <br><br>
 268    </UL>
 269
 270    <LI> Known bugs
 271    <UL>
 272       <LI> Use of <TT>Implicit Value Representation</TT> writting mode may
 273            causes troubles, when there are some <TT>SQ</TT> belonging to a
 274            <TT>Shadow Group</TT>. <br>
 275            Better you use <TT>Explicit Value Representation</TT> writting mode ...
 276       <LI> Troubles on 'Big endian' processors (i.e. Apple/Motorola, SunSparc
 277            ...) when writting 16 Bits images.
 278    </UL>
 279
 280 </UL>
 281
 282
 283
 284 <!#######################################################################>
 285 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
 286 <H2>
 287    <A CLASS="anchor" NAME="NewsVersion1_0">
 288       <B>Version 1.0 (Feb 14 2005)</B></A>
 289 </H2>
 290 <UL>
 291    <LI>State of the art
 292    <UL>
 293       <LI>
 294          <a href="Doc1.0/uml-gdcmV1.0.pdf">gdcm 1.0 UML Class Diagram</a> version.
 295       <LI> <a href= "Doc1.0/html.user/index.html">User Documentation"</a>
 296       <LI> <a href= "Doc1.0/html.developper/index.html">Developper
 297          Documentation"</a>
 298       <LI> Final check of the jpeg sub-library: all 'classical' jpeg
 299         compressed Dicom files can be read<br>
 300       <LI>All the previously gdcm-breaker images are now readable<br>
 301       <LI> A huge number of memory leaks removed
 302       <LI> Improvement of write process
 303    </UL>
 304
 305
 306    <LI> A.P.I. breaking modifications (since previous version : <TT>0.6</TT>)
 307    <UL>
 308       <LI> Use of <TT> namespace</TT> : all the methods formerly named
 309           <TT>className::gdcmXxx()</TT> are now named <TT>className::Xxx()</TT>
 310           <br> End user will have to call them as <TT>gdcm::className::Xxx() </TT>
 311       <LI> a <TT>gdcm::Document</TT> is now specialized in :
 312       <UL>
 313          <LI> <TT>gdcm::DicomDir</TT>
 314          <LI> <TT>gdcm::File</TT>
 315       </UL>
 316       <LI> a <TT>gdcm::DicomElementSet</TT> is composed of a set of
 317             <TT>gdcm::DicomDocEntry</TT>
 318       <LI> a <TT>gdcm::DicomDocEntry</TT> can be :
 319       <UL>
 320          <LI> a <TT>gdcm::ContentEntry</TT>, specialized in :
 321          <UL>
 322             <LI> <TT>gdcm::ValEntry</TT>
 323             <LI> <TT>gdcm::BinEntry</TT> (no longer a specialization of
 324                  <TT>gdcm::ValEntry</TT>)
 325         </UL>
 326       <LI> a <TT>gdcm::SeqEntry</TT>
 327       </UL>
 328       <LI> Removal of useless accessors <TT>GetXxxByname</TT>, <TT>SetXxxByname</TT>
 329       <LI> Renaming of accessors <TT>GetXxxByNumber</TT>, <TT>SetXxxByNumber</TT>
 330            as follow :
 331       <UL>
 332          <LI> <TT>GetEntryByNumber
 333                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 334                                           --> GetEntryValue</TT>
 335          <LI> <TT>GetEntryLengthByNumber  --> GetEntryLength</TT>
 336          <LI> <TT>GetEntryOffsetByNumber  --> GetEntryOffset</TT>
 337          <LI> <TT>GetEntryVRByNumber
 338                   &nbsp;&nbsp;&nbsp;      --> GetEntryVR</TT>
 339          <LI>
 340          <LI> <TT>GetDocEntryByNumber
 341                   &nbsp;&nbsp;            --> GetDocEntry</TT>
 342          <LI> <TT>GetValEntryByNumber
 343                   &nbsp;&nbsp;            --> GetValEntry</TT>
 344          <LI> <TT>GetBinEntryByNumber
 345                   &nbsp;&nbsp;            --> GetBinEntry</TT>
 346          <LI> <TT>GetSeqEntryByNumber
 347                   &nbsp;&nbsp;            --> GetSeqEntry</TT>
 348        </UL>
 349    </UL>
 350 </UL>
 351
 352 <!#######################################################################>
 353 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
 354 <H2>
 355    <A CLASS="anchor" NAME="NewsVersion0_6">
 356       <B>Version 0.6 (June 8 2004)</B></A>
 357 </H2>
 358 <UL>
 359    This version will be used by Insight Tool Kit
 360    (<a href="http://www.itk.org">ITK</a> 2.0) at the beginning of 2005.<br>
 361     It's not yet packaged ...<br><br>
 362    <LI> <a href= "Doc0.6/html.user/index.html">User Documentation"</a>
 363    <LI> <a href= "Doc0.6/html.developper/index.html">Developper Documentation"</a>
 364    <LI> The new <TT>gdcmDocument</TT> class is a parent class of
 365        <TT>gdcmHeader</TT> class and <TT>gdcmDicomDir</TT> class.
 366    <LI> Massive modifications in the Class Diagram :
 367    <UL>
 368       <LI> any dicom related file is a <TT>gdcmDocument</TT>
 369       <LI> a <TT>gdcmDocument</TT> can be :
 370       <UL>
 371          <LI> a <TT>gdcmHeader</TT>, if it contains pixel data
 372          <LI> a <TT>gdcmDicomDir</TT>, if it contains only informations
 373               on the files in a given directory
 374       </UL>
 375
 376    <LI> a <TT>gdcmDocument</TT> is_a <TT>gdcmElementSet</TT>,
 377         composed of a set of <TT>gdcmEntry</TT> separated into :
 378       <UL>
 379       <LI> <TT>gdcmValEntry</TT><br>
 380            a specialization of <TT>gdcmValEntry</TT>, for 'non
 381            <TT>std::string</TT> representable' values is
 382            <TT>gdcmBinEntry</TT>
 383        <LI> <TT>gdcmSeqEntry</TT> (VR = <TT>SQ</TT>, i.e Dicom Sequences)<br>
 384              they are dealt as tree-like structures :<br>
 385              - a <TT>gdcmSeqEntry</TT> is considered as a set
 386              of <TT>gdcmSQItem</TT>,<br>
 387              - a <TT>gdcmSQItem</TT> is_a <TT>gdcmElementSet</TT>, composed
 388              of <TT>gdcmDocEntries</TT>, recursively <br>
 389       </UL>
 390    </UL>
 391    <LI> Improvement of the jpeg sub-library: jpeg
 392            compressed Dicom files (lossless and lossy)
 393            might be read (check-it out)
 394 </UL>
 395
 396 <!#######################################################################>
 397 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
 398 <H2>
 399    <A CLASS="anchor" NAME="NewsVersion0_4">
 400       <B>Version 0.4 (February 6 2004)</B></A>
 401 </H2>
 402 <UL>
 403
 404    <LI> <a href="Doc0.4/uml-gdcmV0.4.pdf">gdcm 0.4 UML Class Diagram</a>.
 405    <LI> <a href= "Doc0.4/html.user/index.html">User Documentation"</a>
 406    <LI> <a href= "Doc0.4/html.developper/index.html">Developper Documentation </a>
 407
 408    <LI> Introduction of a jpeg sub-library: some very simple jpeg-lossy
 409         compressed Dicom files might be working (check-it out).
 410    <LI> And also, fewer memory leaks, cleaned-up stl usage (should work
 411         with gcc-3.x), python disutil installer (see file setup.py)
 412         supporting both Swig and vtk wrapping.
 413    <LI> Introduction of a RLE (Run-Time Encoding) library
 414    <LI> Color images (RGB or Palette Color) are dealt with
 415    <LI> Confusing names <TT>gdcmPatient</TT>, <TT>gdcmStudy</TT>,
 416         <TT>gdcmSerie</TT>, <TT>gdcmPatient</TT> changed to
 417         <TT>gdcmDicomDirPatient</TT>, <TT>gdcmDicomDirStudy</TT>,
 418         <TT>gdcmDicomDirSerie</TT>, <TT>gdcmDicomDirPatient</TT>
 419
 420 </UL>
 421
 422 <!#######################################################################>
 423 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
 424 <H2>
 425    <A CLASS="anchor" NAME="NewsVersion0_3">
 426       <B>Version 0.3 (July 8 2003)</B></A>
 427 </H2>
 428 <UL>
 429    <LI> <TT>gdcmFile</TT> class now enables acces to the data
 430        i.e. the image[s] content. Previously only parsing of the
 431        Dicom header was available through usage of <TT>gdcmHeader</TT>
 432        class.
 433    <LI> a <A HREF="http://public.kitware.com/VTK/">VTK</A> plugin
 434        of gdcm is now available through the <TT>vtkGdcmReader</TT>
 435        vtk class (see it as a vtk wrapper of gdcm), which enables
 436        <UL>
 437          <LI> Loading of a single image,
 438          <LI> Loading of a stack of images from multiple Dicom files,
 439          <LI> this class is wrapped for vtkPython (by using native vtk
 440               wrappers).
 441        </UL>
 442    <LI> Introduction of a jpeg sub-library: lossless-jpeg
 443         compressed Dicom files work.
 444 <LI> <TT>vtkgdcmViewer</TT> allows easy displaying of single/multiframe
 445      GreyLevel/RGB/PaletteColor images
 446 </UL>
 447
 448 <!#######################################################################>
 449 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
 450 <H2>
 451    <A CLASS="anchor" NAME="NewsVersion0_1">
 452       <B>Version 0.1 (April 1 2003)</B></A>
 453
 454 <!#######################################################################>
 455 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
 456 <H2>
 457    <A CLASS="anchor" name="NewsVersion0_1">
 458       <B>Version 0.0 (March 14 2003)</B></A>
 459
 460 <HR size="1"><ADDRESS style="align: right;"></ADRESS>
 461
 462 </BODY>
 463 </HTML>