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