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