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