]> Creatis software - gdcm.git/blob - Doc/Website/News.html
Update fo new features
[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 JPEG2000 encoded files.
37      <UL>
38          But we are working on it.
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>Both <TT>vtkgdcmViewer</TT> and <TT>vtkgdcmViewer2</TT> 
128           are available to allow easy displaying of single/multiframe 
129           GreyLevel/RGB/PaletteColor images<br><br>
130       <LI> <TT>DICOMDIR</TT> anonymiser (<TT>Load</TT> and <TT>Noload</TT> mode)
131            <br><br>
132       <LI> Because the <TT>gdcm::DicomDir::Load()</TT> method may be used
133            either for loading an already made <TT>DICOMDIR</TT> file or for
134            parsing all the dicom files with a given root directory we
135            syntaxically separated the operations: <br>
136            For loading an already made <TT>DICOMDIR</TT> file, use : <br>
137            <pre>
138            gdcm::DicomDir *d = new gdcm::DicomDir();
139            d->SetFileName(fileName);
140            d->Load( );  
141            </pre>
142  
143            For parsing all the dicom files with a given root directory, use :<br>
144            <pre>
145            gdcm::DicomDir *d = new gdcm::DicomDir();
146            d->SetDirectoryName(dirName);
147            d->Load( )  
148            </pre>
149
150            <b>Don't</b> use any longer old deprecated style: <br>
151            <TT>
152            gdcm::DicomDir *d = new gdcm::DicomDir();<br>
153            d->SetParseDir(true);   // </TT>or <TT>d->SetParseDir(false);<br>
154            d->Load( fileName );<br>  
155            </TT>
156            <br> 
157       <LI> User is now allowed to tell <TT>gdcm::Document</TT> constructor 
158             he doesn't want to deal with <TT>SeqEntry</TT> 
159             (every time it's possible) <br> and/or he doesn't 
160             want to deal with <TT>Shadow groups</TT> (every time it's
161             possible) <br> or he doesn't 
162             want to deal with <TT>SeqEntry</TT> that belong to a <TT>Shadow group</TT>  (every time it's
163             possible)<br>
164             use : <br>
165             <pre>
166             gdcm::File *f = new gdcm::File();
167                   f->SetLoadMode(NO_SEQ);            | depending on what
168                   f->SetLoadMode(NO_SHADOW);         | you want *not* 
169                   f->SetLoadMode(NO_SEQ | NO_SHADOW);| to load from the
170                   f->SetLoadMode(NO_SHADOWSEQ);      | target file
171             f->SetFileName(fileName);
172             f->Load( );
173             </pre>
174             <b>Don't</b> use any longer old deprecated style: <br>
175             <TT>
176             gdcm::File *f = new gdcm::File(fileName);</TT> <br>
177             <br>
178         <LI> User is now allowed to tell <TT>gdcm::DicomDir</TT> constructor 
179             he doesn't want to deal with <TT>SeqEntry</TT> 
180             he doesn't want to deal with <TT>SeqEntry</TT> 
181             (every time it's possible) <br> and/or he doesn't 
182             want to deal with <TT>Shadow groups</TT> (every time it's
183             possible) <br> or he doesn't 
184             want to deal with <TT>SeqEntry</TT> that belong to a <TT>Shadow group</TT>  (every time it's
185             possible)<br> when he parses all the Dicom files within a given
186             directory
187             use : <br>
188             <pre>
189             gdcm::DicomDir *f = new gdcm::DicomDir();
190                   f->SetLoadMode(NO_SEQ);            | depending on what
191                   f->SetLoadMode(NO_SHADOW);         | you want *not* 
192                   f->SetLoadMode(NO_SEQ | NO_SHADOW);| to load from the files
193                   f->SetLoadMode(NO_SHADOWSEQ);      | within the root directory 
194             f->SetDirectoryName(rootDirectoryName);
195             f->Load( );
196             </pre>
197             <b>Don't</b> use any longer old deprecated style: <br>
198             <TT>
199             gdcm::DicomDir *dcmdir = new gdcm::DicomDir(dirName, true);</TT><br>
200             <br>         
201    </UL>
202
203    <LI> Bug fixes
204    <UL>
205       <LI> The difference between <TT>MONOCHROME1</TT> (low values = bright,
206             high values = dark) and <TT>MONOCHROME2</TT> (low values = dark,
207             high values = bright) is now taken into account.<br> 
208             It's no longer up to the user to change the pixels value
209       <LI> Writing a 'True Dicom' image after reading an <TT>ACR-NEMA</TT> image 
210            does not request any longer from the user to build up 
211             'manually' the Meta Elements group (<TT>Ox0002</TT>)
212       <LI> Old '24 Bits' <TT>ACR-NEMA</TT> are now correctly re-written
213            in <TT>DICOM V3</TT> mode.
214       <LI> Element <TT>0x0000</TT> of <TT>Shadow groups</TT> is always forced to be a
215            <TT>ValEntry</TT> and its <TT>VR</TT> is forced to <TT>UL</TT> 
216       <LI>
217    </UL>
218
219    <LI> A.P.I. breaking modifications (since previous version : <TT>1.0</TT>)
220    <UL>    
221       <LI> NEVER more API breaking modifications !!!
222
223    </UL>
224
225    <LI> Known bugs
226    <UL>
227       <LI> Use of <TT>Implicit Value Representation</TT> writting mode may
228            causes troubles, when there are some <TT>SQ</TT> belonging to a 
229            <TT>Shadow Group</TT>. <br>
230            Better you use <TT>Explicit Value Representation</TT> writting mode ...
231    </UL>
232
233 </UL>
234
235
236
237 <!#######################################################################>
238 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
239 <H2>
240    <A CLASS="anchor" NAME="NewsVersion1_0">
241       <B>Version 1.0 (Feb 14 2005)</B></A>
242 </H2>
243 <UL>
244    <LI>State of the art
245    <UL>
246       <LI>
247          <a href="Doc1.0/uml-gdcmV1.0.pdf">gdcm 1.0 UML Class Diagram</a> version.
248       <LI> <a href= "Doc1.0/html.user/index.html">User Documentation"</a>
249       <LI> <a href= "Doc1.0/html.developper/index.html">Developper
250          Documentation"</a>
251       <LI> Final check of the jpeg sub-library: all 'classical' jpeg
252         compressed Dicom files can be read<br>
253       <LI>All the previously gdcm-breaker images are now readable<br>
254       <LI> A huge number of memory leaks removed
255       <LI> Improvement of write process   
256    </UL>
257
258  
259    <LI> A.P.I. breaking modifications (since previous version : <TT>0.6</TT>)
260    <UL>
261       <LI> Use of <TT> namespace</TT> : all the methods formerly named
262           <TT>className::gdcmXxx()</TT> are now named <TT>className::Xxx()</TT>
263           <br> End user will have to call them as <TT>gdcm::className::Xxx() </TT>
264       <LI> a <TT>gdcm::Document</TT> is now specialized in : 
265       <UL>
266          <LI> <TT>gdcm::DicomDir</TT>
267          <LI> <TT>gdcm::File</TT>
268       </UL>
269       <LI> a <TT>gdcm::DicomElementSet</TT> is composed of a set of 
270             <TT>gdcm::DicomDocEntry</TT>
271       <LI> a <TT>gdcm::DicomDocEntry</TT> can be :
272       <UL>
273          <LI> a <TT>gdcm::ContentEntry</TT>, specialized in :
274          <UL>
275             <LI> <TT>gdcm::ValEntry</TT>
276             <LI> <TT>gdcm::BinEntry</TT> (no longer a specialization of
277                  <TT>gdcm::ValEntry</TT>) 
278         </UL>
279       <LI> a <TT>gdcm::SeqEntry</TT> 
280       </UL>
281       <LI> Removal of useless accessors <TT>GetXxxByname</TT>, <TT>SetXxxByname</TT> 
282       <LI> Renaming of accessors <TT>GetXxxByNumber</TT>, <TT>SetXxxByNumber</TT> 
283            as follow :
284       <UL>
285          <LI> <TT>GetEntryByNumber 
286                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
287                                           --> GetEntryValue</TT>
288          <LI> <TT>GetEntryLengthByNumber  --> GetEntryLength</TT>
289          <LI> <TT>GetEntryOffsetByNumber  --> GetEntryOffset</TT>
290          <LI> <TT>GetEntryVRByNumber 
291                   &nbsp;&nbsp;&nbsp;      --> GetEntryVR</TT>
292          <LI>
293          <LI> <TT>GetDocEntryByNumber     
294                   &nbsp;&nbsp;            --> GetDocEntry</TT>
295          <LI> <TT>GetValEntryByNumber     
296                   &nbsp;&nbsp;            --> GetValEntry</TT>
297          <LI> <TT>GetBinEntryByNumber     
298                   &nbsp;&nbsp;            --> GetBinEntry</TT>
299          <LI> <TT>GetSeqEntryByNumber     
300                   &nbsp;&nbsp;            --> GetSeqEntry</TT>
301        </UL>
302    </UL>
303 </UL>
304
305 <!#######################################################################>
306 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
307 <H2>
308    <A CLASS="anchor" NAME="NewsVersion0_6">
309       <B>Version 0.6 (June 8 2004)</B></A>
310 </H2>
311 <UL>
312    This version will be used by Insight Tool Kit 
313    (<a href="http://www.itk.org">ITK</a> 2.0) at the beginning of 2005.<br>
314     It's not yet packaged ...<br><br>
315    <LI> <a href= "Doc0.6/html.user/index.html">User Documentation"</a>
316    <LI> <a href= "Doc0.6/html.developper/index.html">Developper Documentation"</a>  
317    <LI> The new <TT>gdcmDocument</TT> class is a parent class of 
318        <TT>gdcmHeader</TT> class and <TT>gdcmDicomDir</TT> class.
319    <LI> Massive modifications in the Class Diagram :
320    <UL>
321       <LI> any dicom related file is a <TT>gdcmDocument</TT>
322       <LI> a <TT>gdcmDocument</TT> can be :
323       <UL>
324          <LI> a <TT>gdcmHeader</TT>, if it contains pixel data
325          <LI> a <TT>gdcmDicomDir</TT>, if it contains only informations 
326               on the files in a given directory  
327       </UL>
328
329    <LI> a <TT>gdcmDocument</TT> is_a <TT>gdcmElementSet</TT>,
330         composed of a set of <TT>gdcmEntry</TT> separated into :
331       <UL>
332       <LI> <TT>gdcmValEntry</TT><br>
333            a specialization of <TT>gdcmValEntry</TT>, for 'non
334            <TT>std::string</TT> representable' values is 
335            <TT>gdcmBinEntry</TT> 
336        <LI> <TT>gdcmSeqEntry</TT> (VR = <TT>SQ</TT>, i.e Dicom Sequences)<br>
337              they are dealt as tree-like structures :<br>
338              - a <TT>gdcmSeqEntry</TT> is considered as a set 
339              of <TT>gdcmSQItem</TT>,<br>
340              - a <TT>gdcmSQItem</TT> is_a <TT>gdcmElementSet</TT>, composed 
341              of <TT>gdcmDocEntries</TT>, recursively <br>
342       </UL>
343    </UL>
344    <LI> Improvement of the jpeg sub-library: jpeg
345            compressed Dicom files (lossless and lossy) 
346            might be read (check-it out)
347 </UL>
348
349 <!#######################################################################>
350 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
351 <H2>
352    <A CLASS="anchor" NAME="NewsVersion0_4">
353       <B>Version 0.4 (February 6 2004)</B></A>
354 </H2>
355 <UL>
356
357    <LI> <a href="Doc0.4/uml-gdcmV0.4.pdf">gdcm 0.4 UML Class Diagram</a>.
358    <LI> <a href= "Doc0.4/html.user/index.html">User Documentation"</a>
359    <LI> <a href= "Doc0.4/html.developper/index.html">Developper Documentation </a>
360
361    <LI> Introduction of a jpeg sub-library: some very simple jpeg-lossy
362         compressed Dicom files might be working (check-it out).
363    <LI> And also, fewer memory leaks, cleaned-up stl usage (should work
364         with gcc-3.x), python disutil installer (see file setup.py)
365         supporting both Swig and vtk wrapping.
366    <LI> Introduction of a RLE (Run-Time Encoding) library
367    <LI> Color images (RGB or Palette Color) are dealt with
368    <LI> Confusing names <TT>gdcmPatient</TT>, <TT>gdcmStudy</TT>,
369         <TT>gdcmSerie</TT>, <TT>gdcmPatient</TT> changed to 
370         <TT>gdcmDicomDirPatient</TT>, <TT>gdcmDicomDirStudy</TT>, 
371         <TT>gdcmDicomDirSerie</TT>, <TT>gdcmDicomDirPatient</TT>
372  
373 </UL>
374
375 <!#######################################################################>
376 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
377 <H2>
378    <A CLASS="anchor" NAME="NewsVersion0_3">
379       <B>Version 0.3 (July 8 2003)</B></A>
380 </H2>
381 <UL>
382    <LI> <TT>gdcmFile</TT> class now enables acces to the data
383        i.e. the image[s] content. Previously only parsing of the
384        Dicom header was available through usage of <TT>gdcmHeader</TT>
385        class.
386    <LI> a <A HREF="http://public.kitware.com/VTK/">VTK</A> plugin
387        of gdcm is now available through the <TT>vtkGdcmReader</TT>
388        vtk class (see it as a vtk wrapper of gdcm), which enables
389        <UL>
390          <LI> Loading of a single image,
391          <LI> Loading of a stack of images from multiple Dicom files,
392          <LI> this class is wrapped for vtkPython (by using native vtk
393               wrappers).
394        </UL>
395    <LI> Introduction of a jpeg sub-library: lossless-jpeg
396         compressed Dicom files work.
397 <LI> <TT>vtkgdcmViewer</TT> allows easy displaying of single/multiframe 
398      GreyLevel/RGB/PaletteColor images
399 </UL>
400
401 <!#######################################################################>
402 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
403 <H2>
404    <A CLASS="anchor" NAME="NewsVersion0_1">
405       <B>Version 0.1 (April 1 2003)</B></A>
406
407 <!#######################################################################>
408 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
409 <H2>
410    <A CLASS="anchor" name="NewsVersion0_1">
411       <B>Version 0.0 (March 14 2003)</B></A>
412
413 <HR size="1"><ADDRESS style="align: right;"></ADRESS>
414
415 </BODY>
416 </HTML>