]> Creatis software - gdcm.git/blob - Doc/Website/News.html
07d5ae731968567b711f95cdba05331eea661000
[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 <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          Update: as of Oct 10 2005, we are currently investigating another library:
40          openjpeg. The problem still exist for this library but one of the author
41          is currently working on it:
42             http://www.openjpeg.org/forum/viewtopic.php?t=18
43       </UL>
44       <LI> gdcm doesn't read yet <TT>MPEG2</TT> encoded files.
45
46    </UL>
47    <LI>Reader
48    <UL>
49       <LI> Allow user to tell <TT>gdcm::Document</TT> constructor he just wants 
50            to load a given list of <TT>DocEntries</TT> 
51            (to save CPU time and RAM space)
52       <LI> Allow 'frame by frame' reading (should be helpfull for huge 
53            multiframe images)
54       <LI> Allow subvolume selection / frames selection before reading.
55       <LI> Expose Read/Decompression mechanisms to allow user getting
56          information from <tt>DICOMDIR</TT> <br> -or from his own Data Base- 
57          and reading his images without parsing
58          the header, one more time.
59    </UL> 
60    <LI>Writer 
61    <UL> 
62       <LI> Allow user to tell the Writer he doesn't want to write down
63            <TT>SeqEntry</TT> (if any) 
64       <LI> Allow user to tell the Writer he doesn't want to write down
65            <TT>Shadow groups</TT> (if any)
66       <LI> Allow user to tell the Writer which compression mode he wants<br>
67            (Right now, no one is available)
68       <LI> Allow user to tell the Writer he wants to split a
69            <TT>Multiframe</TT> image into a serie of 
70            <TT>Single frame</TT> images.
71       <LI> Allow user to tell the Writer he wants to agregate a
72            Serie of <TT>Single frame</TT> images into a
73            <TT>Multiframe</TT> image.
74    </UL>
75 <LI>Reader / Writer 
76    <UL>  
77       <LI> Full <TT>Icon Image</TT> management (Read and Write) 
78       <LI> Full <TT>Overlays</TT> management (Read and Write) <br>
79            both for '<TT>ACR-NEMA</TT> style' (using groups <TT>0x6000</TT> 
80             and next) and '<TT>DICOM V3</TT> style' (using Sequences)
81    </UL>
82 <LI> <TT>DICOMDIR</TT> 
83     <UL>
84       <LI> <TT>DICOMDIR</TT> full management (not limited to
85            <TT> PATIENT</TT>/<TT>STUDY</TT>/<TT>SERIE</TT>/<TT>IMAGE</TT>)
86       <LI> Allow user to add an entry (belonging to the file header Dicom
87            entries)to the default entry list, before
88            making a <TT>DICOMDIR</TT> from a root directory
89       <LI> Allow user to add an entry of his owns (for instance an <TT>Icon</TT>
90            to each image, or to each Serie).  
91       </UL>
92 <LI> SerieHelper
93    <UL>
94
95       <LI> An accurate <TT>SerieHelper</TT> <br>
96            Right now <TT>SerieHelper</TT> only works on 'bona fide Series', and
97            breaks on wrongly forged Series.<br>
98            We are still looking for any heuristics...  
99       <LI> A <TT>SerieHelper</TT> that would use the <TT>DICOMDIR</TT> (if any)
100         instead of parsing all the files within the Root Directory
101    </UL>
102 <LI> Other
103    <UL>
104       <LI> 16-bits-LUT full Management
105       <LI> User friendly management of <TT>Rescale Slope</TT> and
106            <TT>Rescale Intercept</TT>.<br>
107            (Well... Maybe it's up to the application to deal with it, not to
108            gdcm ?)
109       <LI> Allow manual adjunction / automatic recognition (pfff!...)
110            of the private <TT>Dicom Dictionary</TT>
111            to be used to parse <TT>Shadow groups</TT> against.
112       <LI> User friendly way of anonymizing image when Patient's name is
113            carved in the Pixels :-(
114    </UL>
115 </UL>
116 <!#######################################################################>
117 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
118 <H2>
119    <A CLASS="anchor" NAME="NewsCurrentVersion">
120    <B>Current Version (CVS)</B></A>
121       <B></B></A>
122 </H2>
123
124 <UL>
125    <LI> <A HREF="News.html#missing">Missing Features</a>
126    <LI>State of the art
127    <UL>    
128       <LI>
129          <a href="uml-gdcmV1.2.pdf">gdcm UML Class Diagram</a> current version.
130       <LI> <a href= "DocCVS/html.user/index.html">User Documentation</a>
131       <LI> <a href= "DocCVS/html.developper/index.html">Developper
132          Documentation</a> 
133    <LI> New Features
134    <UL>
135       <LI> To <i>try to</i> make gdcm images PACS usable, user is now allowed to
136            gdcm what kind of image he wants to write, using :  <br>
137    <TT>void FileHelper::SetContentType (ImageContentType c);</TT> <br>
138    Four different types are identify (probabely more will be added) :
139       <UL> 
140          <LI>
141       1) user created ex nihilo his own image and wants to write it as a Dicom image.<br>
142           c : <TT>USER_OWN_IMAGE</TT>
143          <LI>
144       2) user modified the pixels of an existing image, using mathematical operations.<br>
145           c : <TT>FILTERED_IMAGE</TT>
146          <LI>
147       3) user created a new image, using existing images (eg MIP, MPR, cartography image)<br>
148           c : <TT>CREATED_IMAGE</TT>
149          <LI>
150        4) user modified/added some tags *without processing* the pixels (anonymization, etc)<br>
151          c : <TT>UNMODIFIED_PIXELS_IMAGE</TT> 
152       </UL>
153       <LI> Stupid difference between <TT>gdcm::ValEntry</TT> 
154            and <TT>gdcm::BinEntry</TT> removed. <br>
155            Only <TT>gdcm::DataEntry</TT> exist, now. 
156            Should have been considered as a 'Bug Fix'.<br>
157            Actually, it's an API breaking modification ...
158       <UL>
159          <LI>
160             <TT>std::string const &DataEntry::GetString() const</TT><br>
161             returns as a string (when possible) the value of the DataEntry
162          <LI>
163             <TT>void DataEntry::SetString(std::string const &value)</TT><br>
164              Sets the 'value' of a DataEntry, passed as a std::string 
165          <LI>
166             <TT>void DataEntry::SetBinArea( uint8_t *area, bool self ) </TT><br>
167              Sets the value (non string) of the current Dicom DataEntry
168          <LI>
169               <TT>void DataEntry::CopyBinArea( uint8_t *area, uint32_t length )</TT><br>
170                Inserts the value (non string) into the current DataEntry 
171          <LI>
172                <TT>void DataEntry::SetValue(const uint32_t &id, const double
173  &val)</TT><br>
174                Inserts the elementary (non string) value into the current
175                (multivaluated) DataEntry, at the <TT>id></TT> position.
176          <LI>
177                <TT>double DataEntry::GetValue(const uint32_t &id) const </TT><br>
178                returns, as a double one of the values (when entry is 
179                multivaluated), identified by its index <TT>id</TT>. 
180       </UL>
181       <LI> 
182    <TT>DocEntrySet::GetEntryValue()</TT> replaced by
183            <TT>DocEntrySet::GetEntryString()</TT> <br>
184       <LI> SerieHelper : <br>     
185            Add some methods, to split a 'SingleSerieUID' Fileset into 
186            'Extra Coherent'  FileSets. <br>
187            They return a std::map of 'Filesets' (actually : std::vector 
188            of gdcm::File*)<br>
189            The key is the 'Orientation', the 'Position' 
190            or the value of a user choosen 'Tag' <br>
191            -  <TT>XCoherentFileSetmap SplitOnOrientation(FileList *fileSet);
192               </TT><br>
193            -  <TT>XCoherentFileSetmap SplitOnPosition(FileList *fileSet);
194               </TT> <br>
195            -  <TT>XCoherentFileSetmap SplitOnTagValue(FileList *fileSet,
196                                        uint16_t group, uint16_t element);
197               </TT><br>
198            These methods must be called by user, depending on what he wants 
199            to do, at application time.- *he* only  knows what his Series 
200            contain !-
201       <LI> To avoid memory leaks and seg faults the user intended classes
202            use now a Reference Counter.<br>
203       <UL>
204          <LI> <TT>new()</TT> and <TT>delete()</TT> are replaced by
205               <TT>New()</TT> and <TT>Delete()</TT>
206          <LI> <TT>Register()</TT> and <TT>Unregister()</TT> methods are 
207          available.
208          <LI> --> Well ... People from ITK don't seem to agree too much with 
209              that feature.<br>
210           They demand to be allowed to allocate gdcm objects in the stack as
211           well, not only in the heap.
212       </UL>
213       <LI>
214    </UL>
215
216    <LI> API breaking modifications (since previous version)
217    <UL>
218       <LI> Stupid difference between <TT>gdcm::ValEntry</TT> 
219            and <TT>gdcm::BinEntry</TT> removed. <br>
220            Only <TT>gdcm::DataEntry</TT> exist, now. <br>  
221    <pre>
222    ValEntry(DictEntry *e);
223    BinEntry(DictEntry *e);
224 -->DataEntry *New(uint16_t group,uint16_t elem, VRKey const &vr);
225
226    std::string const &ValEntry::GetValue() const;
227    std::string const &BinEntry::GetValue() const;
228 -->std::string const &DataEntry::GetString() const;
229
230    uint8_t *BinEntry::GetBinArea();
231 -->uint8_t *DataEntry::GetBinArea();
232
233    void ValEntry::SetValue(std::string const &value);
234    void BinEntry::SetValue(std::string const &value);   
235 -->void DataEntry::SetString(std::string const &value);
236
237    void BinEntry::SetBinArea( uint8_t *area, bool self = true );
238 -->void DataEntry::SetBinArea( uint8_t *area, bool self = true );
239
240    void ValEntry::CopyValEntry(uint16_t gr, uint16_t el);
241 -->void DataEntry::CopyDataEntry(uint16_t gr, uint16_t el, VRKey const &vr);
242 </pre>
243
244 <pre>
245 Example :
246
247 old way :
248         DocEntry *p3 = item2->GetDocEntry(0x0018,0x0050);
249         if( !p3 ) return false;
250         ContentEntry *entry2 = dynamic_cast<ContentEntry *>(p3);
251         std::string thickness = entry2->GetValue();
252
253 new way :
254         DocEntry *p3 = item2->GetDocEntry(0x0018,0x0050);
255         if( !p3 ) return false;
256         DataEntry *entry2 = dynamic_cast<DataEntry *>(p3);
257         std::string thickness = entry2->GetString();
258
259 </pre>
260
261 <LI> Avoid tons of CPU time consuming accesses to DICOM Dictionnary
262 <pre>
263    DataEntry *FileHelper::CopyDataEntry(uint16_t group, uint16_t elem);
264 -->DataEntry *FileHelper::CopyDataEntry(uint16_t group, uint16_t elem, 
265                                         const VRKey &vr = GDCM_VRUNKNOWN);
266
267    void FileHelper::CheckMandatoryEntry(uint16_t group, uint16_t elem, std::string value);
268 -->void FileHelper::CheckMandatoryEntry(uint16_t group, uint16_t elem, std::string value,
269                                         const VRKey &vr = GDCM_VRUNKNOWN);
270       
271    void FileHelper::SetMandatoryEntry(uint16_t group, uint16_t elem, std::string value);       
272 -->void FileHelper::SetMandatoryEntry(uint16_t group, uint16_t elem, std::string value,
273                                       const VRKey &vr = GDCM_VRUNKNOWN);
274
275    void FileHelper::CopyMandatoryEntry(uint16_t group, uint16_t elem, std::string value);      
276 -->void FileHelper::CopyMandatoryEntry(uint16_t group, uint16_t elem, std::string value,
277                                        const VRKey &vr = GDCM_VRUNKNOWN);
278 </pre>
279 <LI> New features :
280 <pre>
281 For multivaluated numeric DataEntries
282 -->void DataEntry::SetValue(const uint32_t &id,const double &val);
283 -->double DataEntry::GetValue(const uint32_t &id) const;
284 -->uint32_t DataEntry::GetValueCount() const;
285
286 For converting 'Decimal String'
287 -->bool GetDSValue(std::vector &lt;double&gt; &valueVector);  
288 </pre>
289 <LI> Avoid too many source file modifications from gdcm1.2 to gdcm1.3
290 <pre>
291 use :
292
293 #define ValEntry              DataEntry
294
295 #define GetEntryValue(g,e)    GetEntryString(g,e)
296 #define GetValEntry(g,e)      GetDataEntry(g,e)
297 #define GetValue()            GetString()
298 #define InsertValEntry(a,b,c) InsertEntryString(a,b,c) // warning mind the VR!
299
300 </pre>
301    </UL> 
302       
303    <LI> Bug fixes
304    <UL>
305       <LI> Implicit VR - Big Endian (G.E Private) Transfert Syntax 16 Bits 
306            images are now read correctly.  
307       <LI> File::GetZOrigin() returns accurate result in any case.
308       <LI>
309       <LI>
310    </UL>
311    
312    <LI> Known Bugs
313    <UL>
314       <LI> Use of <TT>Implicit Value Representation</TT> writting mode may
315            causes troubles, when there are some <TT>SQ</TT> belonging to a 
316            <TT>Shadow Group</TT>. <br>
317            Better you use <TT>Explicit Value Representation</TT> writting mode ...
318       <LI> Troubles on 'Big endian' processors (i.e. Apple/Motorola, SunSparc
319            ...) when writting 16 Bits images.
320       <LI> Troubles on 64-bits processors.
321       <LI>
322       <LI>
323    </UL>
324  
325       <br><br>
326  </UL>
327
328
329   
330 <!#######################################################################>
331 <A CLASS="anchor" NAME="NewsPreviousVersions">
332 <!#######################################################################>
333
334 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
335 <H2>
336    <A CLASS="anchor" NAME="NewsVersion1_1">
337       <B>Version 1.1 (September 14 2005)</B></A>   
338 </H2> 
339    <LI>State of the art
340    <UL>
341       <LI>
342          <a href="Doc1.0/uml-gdcmV1.0.pdf">gdcm 1.1 UML Class Diagram</a> version.
343       <LI> <a href= "Doc1.0/html.user/index.html">User Documentation</a>
344       <LI> <a href= "Doc1.0/html.developper/index.html">Developper
345          Documentation</a> 
346    <LI> New Features
347    <UL>
348       <LI> Add the methods
349          <TT>gdcm::Dict:AddDict(std::string fullPathPrivateDictionaryFileName)</TT>
350         <br>and<br> 
351         <TT>gdcm::Dict::RemoveDict(std::string fullPathPrivateDictionaryFileName)</TT>
352         <br>
353         to allow user to choose the 'Private Dictionary' he wants to work with.
354         <br>
355         One can dream about a better API;<br>
356         This one allow right now anybody to see very easyly if the use 
357         of a given private dicom dictionary is of any help or not.
358         <br><br>
359       <LI>
360       <TT>PrintFile</TT> has now a new command line argument manager option :<br>
361           <TT>dict=fullPathNamePrivateDictionaryFile</TT><br>
362           to allow user to see with no extra coding what differences 
363           makes the use or not of a private Dicom Dictionary.<br>
364           e.g. : use it as follow <br>
365           <TT>PrintFile filein=myGEdicomFile.dcm 
366           dict=/user/userName/gdcm/Dicts/GEMS-Advance.dic</TT>
367           <br><br> 
368       <LI>
369           (Not a great one ...)  
370           Stupid method names : <br><TT>DicomDir::WriteDicomDir()</TT>
371           and <TT>DicomDir::AnonymizeDicomDir()</TT> <br>replaced by : <br>
372           <TT>DicomDir::Write()</TT>
373           and <TT>DicomDir::Anonymize()</TT>
374           <br><br> 
375       <LI><TT>
376           void Document::AddForceLoadElement(uint16_t group, uint16_t elem);
377           </TT><br>
378           allows user to tell <TT>gdcm::Document</TT> Loader he wants
379           to force the loading of a given set of <TT>DocEntries</TT>, 
380           even if their length exceeds the current 
381           <TT>MAX_SIZE_LOAD_ELEMENT_VALUE</TT>.
382           <br><br>
383        <LI>
384           Many users expect from <TT>vtkGdcmReader</TT> it 'orders' the images
385           (that's the job of <TT>gdcm::SerieHelper</TT> ...)<br>
386           When user <b>knows</b> the files with same Serie UID
387           have same sizes, same 'pixel' type, same color convention, ...
388           the right way to proceed is as follow :
389     <pre>
390         gdcm::SerieHelper *sh= new gdcm::SerieHelper();
391    //      if user wants *not* to load some parts of the file headers
392         sh->SetLoadMode(loadMode);
393
394    //      if user wants *not* to load some files
395         sh->AddRestriction(group, element, value, operator);
396         sh->AddRestriction( ...
397         sh->SetDirectory(directoryWithImages);
398
399    //      if user *knows* how to order his files
400         sh->SetUserLessThanFunction(userSuppliedComparisonFunction);
401    //      or/and
402    //      if user wants to sort reverse order
403         sh->SetSortOrderToReverse();
404    
405    //      here, we suppose only the first 'Single SerieUID' Fileset is of interest
406    //      Just iterate using sh->NextSingleSerieUIDFileSet()
407    //      if you want to get all of them
408         gdcm::FileList *l = sh->GetFirstSingleSerieUIDFileSet();
409
410    //      if user is doesn't trust too much the files with same Serie UID
411         if ( !sh->IsCoherent(l) )
412            return; // not same sizes, or not same 'pixel type' -> stop
413
414         sh->OrderFileList(l);        // sort the list
415
416         vtkGdcmReader *reader = vtkGdcmReader::New();
417    //      if user wants to modify pixel order (Mirror, TopDown, ...)
418    //      he has to supply the function that does the job
419    //      (a *very* simple example is given in vtkgdcmSerieViewer.cxx)
420         reader->SetUserFunction (userSuppliedFunction);
421
422    //      to pass a 'Single SerieUID' Fileset as produced by gdcm::SerieHelper
423         reader->SetCoherentFileList(l);
424         reader->Update();
425    </pre>
426    You can see a full example in <TT>vtk/vtkgdcmSerieViewer.cxx</TT><br>
427    e.g.<br>
428
429    <TT>vtkgdcmSerieViewer dirname=Dentist  mirror</TT><br>
430    <TT>vtkgdcmSerieViewer dirname=Dentist  reverse</TT><br>
431    <TT>vtkgdcmSerieViewer dirname=Dentist  reverse topdown</TT><br> 
432    </pre>
433       <br>
434
435       <LI> <TT>vtkGdcmReader::SetUserFunction (userSuppliedFunction)</TT><br>
436            with :<br>
437            <TT>void userSuppliedFunction(uint8_t *imageData, File *f);</TT><br>
438            allows user to reorganize the pixels of each image just after reading
439            it (to mirror, or topdown the image, for instance)<br>
440            Note : <TT>uint8_t *</TT> doesn't mean it works only on 8 Bits images.
441            <br> It's for prototyping. Feel free to cast it.
442            <br><br>  
443       <LI> <TT>
444            SerieHelper::SetUserLessThanFunction(userSuppliedComparisonFunction)
445            </TT><br> with : <br>
446            <TT>bool userSuppliedComparisonFunction(File *, File *);</TT><br>
447            allows user -when he knows more about his files than gdcm does-
448            to give his own comparison function. 
449       <LI> <TT>SerieHelper::SetSortOrderToReverse</TT> allows user to ask
450            to sort the Files reverse order.
451       <LI> <TT>SerieHelper::AddRestriction</TT> has now a new constructor<br>
452            <TT>AddRestriction(group, element, value, operator);</TT><br>
453            allows user to exclude some files from the sorting, according to
454            any comparison operator <br>
455            (<TT>GDCM_EQUAL</TT>, <TT>GDCM_DIFFERENT</TT>, 
456            <TT>GDCM_GREATER</TT>, <TT>GDCM_GREATEROREQUAL</TT>, 
457            <TT>GDCM_LESS</TT>, <TT>GDCM_LESSOREQUAL</TT>), not only on the
458            equality.
459            <br><br>
460       <LI> <TT>AnonymizeNoLoad</TT> used with <TT>dirin=inputDirectoryName</TT>
461            anonymizes all the files within the given Directory.
462            <br>
463            User may also choose extra elements he wants to rub out: <br>
464            <TT>rubout=listOfElementsToRubOut</TT><br>
465            with <tt>listOfElementsToRubOut : group1-elem1,group2-elem2,
466            ...</TT> (in hexa, no space within the list )
467            <br><br>
468       <LI> <TT>gdcm::SerieHelper()</TT> has a new method 
469            <TT>void AddGdcmFile(File *header)</TT>, that allows aware user to 
470            create a '<TT>FileList</TT>' (actually a 
471            <TT>std::vector< File* > </TT>).<br>
472            The <TT>FileList</TT> created this way will be the 
473            'first one' in the <TT>gdcm::FileHelper()</TT> (retrieve it with 
474            <TT>FileList *GetFirstCoherentFileList()</TT> ).<br>
475            It may be sorted using <TT>OrderFileList</TT>.<br>
476            No 'coherence check' will be performed on this <TT>FileList</TT>
477            before sorting.<br>
478            It may be passed to a <TT>vtkGdcmReader</TT> 
479            (to avoid parsing twice the files)
480            <br><br>
481       <LI> <TT>vtkGdcmReader</TT> can now get the result of
482            <TT>gdcm::SerieHelper</TT> (to avoid parsing twice the files)<br>
483             Proceed as follow :<br>
484            <pre>
485            gdcmSerieHelper *sh = new gdcmSerieHelper();
486            sh->SetDirectory(myImageDirectory, true);
487            gdcmFileList *l = s->GetFirstCoherentFileList();
488            s->OrderFileList(l);
489
490            vtkGdcmReader *gr = new vtkGdcmReader();
491            gr->SetCoherentFileList(l);
492            gr->Update();  
493            </pre>
494            This works with a directory that contains only one '<TT>Serie</TT>'
495            (same <TT>Serie UID</TT> for all the images).<br>
496            If it contains more than one <TT>Serie</TT>, you'll have to loop 
497            on the Series, using <TT>GetNextCoherentFileList()</TT>;<br>
498            It will be up to the user to delete the <TT>gdcm::File</TT>.
499            <br><br>
500            See <TT>vtkgdcmSerieViewer</TT> for an example.
501            <br><br>
502       <LI> Both <TT>vtkgdcmViewer</TT> and <TT>vtkgdcmViewer2</TT> 
503            are available to allow easy displaying of single/multiframe 
504            GreyLevel/RGB/PaletteColor images<br><br>
505       <LI> <TT>DICOMDIR</TT> anonymiser (<TT>Load</TT> and <TT>Noload</TT> mode)
506            <br><br>
507       <LI> Because the <TT>gdcm::DicomDir::Load()</TT> method may be used
508            either for loading an already made <TT>DICOMDIR</TT> file or for
509            parsing all the dicom files with a given root directory we
510            syntaxically separated the operations: <br>
511            For loading an already made <TT>DICOMDIR</TT> file, use : <br>
512            <pre>
513            gdcm::DicomDir *d = new gdcm::DicomDir();
514            d->SetFileName(fileName);
515            d->Load( );  
516            </pre>
517  
518            For parsing all the dicom files within a given root directory, use :<br>
519            <pre>
520            gdcm::DicomDir *d = new gdcm::DicomDir();
521            d->SetDirectoryName(dirName);
522            d->Load( )  
523            </pre>
524
525            <b>Don't</b> use any longer old deprecated style: <br>
526            <TT>
527            gdcm::DicomDir *d = new gdcm::DicomDir();<br>
528            d->SetParseDir(true);   // </TT>or <TT>d->SetParseDir(false);<br>
529            d->Load( fileName );<br>  
530            </TT>
531            <br> 
532       <LI> User is now allowed to tell <TT>gdcm::Document</TT> constructor 
533            he doesn't want to deal with <TT>SeqEntry</TT> 
534            (every time it's possible, i.e for 'true length' Sequences) <br>
535            and/or he doesn't want to deal with <TT>Shadow groups</TT> 
536            (every time it's possible i.e. when element <TT>0x0000</TT>
537            exists for this Group) <br> 
538            or he doesn't want to deal with <TT>SeqEntry</TT> that belong to a 
539            <TT>Shadow group</TT>  (every time it's possible 
540            -'true length' Sequence-)<br>
541            use : <br>
542            <pre>
543            gdcm::File *f = new gdcm::File();
544                   f->SetLoadMode(NO_SEQ);            | depending on what
545                   f->SetLoadMode(NO_SHADOW);         | you want *not* 
546                   f->SetLoadMode(NO_SEQ | NO_SHADOW);| to load from the
547                   f->SetLoadMode(NO_SHADOWSEQ);      | target file
548             f->SetFileName(fileName);
549             f->Load( );
550             </pre>
551             <b>Don't</b> use any longer old deprecated style: <br>
552             <TT>
553             gdcm::File *f = new gdcm::File(fileName);</TT> <br>
554             <br>
555         <LI> User is now allowed to tell <TT>gdcm::DicomDir</TT> constructor 
556              he doesn't want to deal with <TT>SeqEntry</TT> 
557              (every time it's possible, i.e for 'true length' Sequences) <br>
558              and/or he doesn't want to deal with <TT>Shadow groups</TT> 
559              (every time it's possible i.e. when element <TT>0x0000</TT>
560              exists for this Group) <br> 
561              or he doesn't want to deal with <TT>SeqEntry</TT> that belong to a 
562              <TT>Shadow group</TT>  (every time it's possible 
563              -'true length' Sequence-)<br>
564              when he parses all the Dicom files within a given directory.<br>
565              use : <br>
566              <pre>
567              gdcm::DicomDir *f = new gdcm::DicomDir();
568                   f->SetLoadMode(NO_SEQ);            | depending on what
569                   f->SetLoadMode(NO_SHADOW);         | you want *not* 
570                   f->SetLoadMode(NO_SEQ | NO_SHADOW);| to load from the files
571                   f->SetLoadMode(NO_SHADOWSEQ);      | within the root directory 
572              f->SetDirectoryName(rootDirectoryName);
573              f->Load( );
574             </pre>
575             <b>Don't</b> use any longer old deprecated style: <br>
576             <TT>
577             gdcm::DicomDir *dcmdir = new gdcm::DicomDir(dirName, true);</TT><br>
578             <br>         
579    </UL>
580
581    <LI> Bug fixes
582    <UL>
583       <LI> No more trouble when the 'endianess' switches within Sequences.
584       <LI> No more trouble with 'no length Sequences' belonging to a
585            <TT>Shadow Group</TT> when they are 'Implicit VR'.
586       <LI> The difference between <TT>MONOCHROME1</TT> (low values = bright,
587             high values = dark) and <TT>MONOCHROME2</TT> (low values = dark,
588             high values = bright) is now taken into account.<br> 
589             It's no longer up to the user to change the pixels value
590       <LI> Writing a 'True Dicom' image after reading an <TT>ACR-NEMA</TT> image 
591            does not request any longer from the user to build up 
592            'manually' the Meta Elements group (<TT>0x0002</TT>)
593       <LI> Old '24 Bits' <TT>ACR-NEMA</TT> are now correctly re-written
594            in <TT>DICOM V3</TT> mode.
595       <LI> Element <TT>0x0000</TT> of <TT>Shadow groups</TT> is always forced to be a
596            <TT>ValEntry</TT> and its <TT>VR</TT> is forced to <TT>UL</TT> 
597       <br><br>
598    </UL>
599
600    <LI> A.P.I. breaking modifications (since previous version : <TT>1.0</TT>)
601    <UL>    
602       <LI> NEVER more API breaking modifications !!!
603       <br><br>
604    </UL>
605
606    <LI> Known bugs
607    <UL>
608
609    </UL>
610
611 </UL>
612
613
614
615 <!#######################################################################>
616 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
617 <H2>
618    <A CLASS="anchor" NAME="NewsVersion1_0">
619       <B>Version 1.0 (Feb 14 2005)</B></A>
620 </H2>
621 <UL>
622    <LI>State of the art
623    <UL>
624       <LI>
625          <a href="Doc1.0/uml-gdcmV1.0.pdf">gdcm 1.0 UML Class Diagram</a> version.
626       <LI> <a href= "Doc1.0/html.user/index.html">User Documentation"</a>
627       <LI> <a href= "Doc1.0/html.developper/index.html">Developper
628          Documentation"</a>
629       <LI> Final check of the jpeg sub-library: all 'classical' jpeg
630         compressed Dicom files can be read<br>
631       <LI>All the previously gdcm-breaker images are now readable<br>
632       <LI> A huge number of memory leaks removed
633       <LI> Improvement of write process   
634    </UL>
635
636  
637    <LI> A.P.I. breaking modifications (since previous version : <TT>0.6</TT>)
638    <UL>
639       <LI> Use of <TT> namespace</TT> : all the methods formerly named
640           <TT>className::gdcmXxx()</TT> are now named <TT>className::Xxx()</TT>
641           <br> End user will have to call them as <TT>gdcm::className::Xxx() </TT>
642       <LI> a <TT>gdcm::Document</TT> is now specialized in : 
643       <UL>
644          <LI> <TT>gdcm::DicomDir</TT>
645          <LI> <TT>gdcm::File</TT>
646       </UL>
647       <LI> a <TT>gdcm::DicomElementSet</TT> is composed of a set of 
648             <TT>gdcm::DicomDocEntry</TT>
649       <LI> a <TT>gdcm::DicomDocEntry</TT> can be :
650       <UL>
651          <LI> a <TT>gdcm::ContentEntry</TT>, specialized in :
652          <UL>
653             <LI> <TT>gdcm::ValEntry</TT>
654             <LI> <TT>gdcm::BinEntry</TT> (no longer a specialization of
655                  <TT>gdcm::ValEntry</TT>) 
656         </UL>
657       <LI> a <TT>gdcm::SeqEntry</TT> 
658       </UL>
659       <LI> Removal of useless accessors <TT>GetXxxByname</TT>, <TT>SetXxxByname</TT> 
660       <LI> Renaming of accessors <TT>GetXxxByNumber</TT>, <TT>SetXxxByNumber</TT> 
661            as follow :
662       <UL>
663          <LI> <TT>GetEntryByNumber 
664                   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
665                                           --> GetEntryValue</TT>
666          <LI> <TT>GetEntryLengthByNumber  --> GetEntryLength</TT>
667          <LI> <TT>GetEntryOffsetByNumber  --> GetEntryOffset</TT>
668          <LI> <TT>GetEntryVRByNumber 
669                   &nbsp;&nbsp;&nbsp;      --> GetEntryVR</TT>
670          <LI>
671          <LI> <TT>GetDocEntryByNumber     
672                   &nbsp;&nbsp;            --> GetDocEntry</TT>
673          <LI> <TT>GetValEntryByNumber     
674                   &nbsp;&nbsp;            --> GetValEntry</TT>
675          <LI> <TT>GetBinEntryByNumber     
676                   &nbsp;&nbsp;            --> GetBinEntry</TT>
677          <LI> <TT>GetSeqEntryByNumber     
678                   &nbsp;&nbsp;            --> GetSeqEntry</TT>
679        </UL>
680    </UL>
681 </UL>
682
683 <!#######################################################################>
684 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
685 <H2>
686    <A CLASS="anchor" NAME="NewsVersion0_6">
687       <B>Version 0.6 (June 8 2004)</B></A>
688 </H2>
689 <UL>
690    This version will be used by Insight Tool Kit 
691    (<a href="http://www.itk.org">ITK</a> 2.0) at the beginning of 2005.<br>
692     It's not yet packaged ...<br><br>
693    <LI> <a href= "Doc0.6/html.user/index.html">User Documentation"</a>
694    <LI> <a href= "Doc0.6/html.developper/index.html">Developper Documentation"</a>  
695    <LI> The new <TT>gdcmDocument</TT> class is a parent class of 
696        <TT>gdcmHeader</TT> class and <TT>gdcmDicomDir</TT> class.
697    <LI> Massive modifications in the Class Diagram :
698    <UL>
699       <LI> any dicom related file is a <TT>gdcmDocument</TT>
700       <LI> a <TT>gdcmDocument</TT> can be :
701       <UL>
702          <LI> a <TT>gdcmHeader</TT>, if it contains pixel data
703          <LI> a <TT>gdcmDicomDir</TT>, if it contains only informations 
704               on the files in a given directory  
705       </UL>
706
707    <LI> a <TT>gdcmDocument</TT> is_a <TT>gdcmElementSet</TT>,
708         composed of a set of <TT>gdcmEntry</TT> separated into :
709       <UL>
710       <LI> <TT>gdcmValEntry</TT><br>
711            a specialization of <TT>gdcmValEntry</TT>, for 'non
712            <TT>std::string</TT> representable' values is 
713            <TT>gdcmBinEntry</TT> 
714        <LI> <TT>gdcmSeqEntry</TT> (VR = <TT>SQ</TT>, i.e Dicom Sequences)<br>
715              they are dealt as tree-like structures :<br>
716              - a <TT>gdcmSeqEntry</TT> is considered as a set 
717              of <TT>gdcmSQItem</TT>,<br>
718              - a <TT>gdcmSQItem</TT> is_a <TT>gdcmElementSet</TT>, composed 
719              of <TT>gdcmDocEntries</TT>, recursively <br>
720       </UL>
721    </UL>
722    <LI> Improvement of the jpeg sub-library: jpeg
723            compressed Dicom files (lossless and lossy) 
724            might be read (check-it out)
725 </UL>
726
727 <!#######################################################################>
728 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
729 <H2>
730    <A CLASS="anchor" NAME="NewsVersion0_4">
731       <B>Version 0.4 (February 6 2004)</B></A>
732 </H2>
733 <UL>
734
735    <LI> <a href="Doc0.4/uml-gdcmV0.4.pdf">gdcm 0.4 UML Class Diagram</a>.
736    <LI> <a href= "Doc0.4/html.user/index.html">User Documentation"</a>
737    <LI> <a href= "Doc0.4/html.developper/index.html">Developper Documentation </a>
738
739    <LI> Introduction of a jpeg sub-library: some very simple jpeg-lossy
740         compressed Dicom files might be working (check-it out).
741    <LI> And also, fewer memory leaks, cleaned-up stl usage (should work
742         with gcc-3.x), python disutil installer (see file setup.py)
743         supporting both Swig and vtk wrapping.
744    <LI> Introduction of a RLE (Run-Time Encoding) library
745    <LI> Color images (RGB or Palette Color) are dealt with
746    <LI> Confusing names <TT>gdcmPatient</TT>, <TT>gdcmStudy</TT>,
747         <TT>gdcmSerie</TT>, <TT>gdcmPatient</TT> changed to 
748         <TT>gdcmDicomDirPatient</TT>, <TT>gdcmDicomDirStudy</TT>, 
749         <TT>gdcmDicomDirSerie</TT>, <TT>gdcmDicomDirPatient</TT>
750  
751 </UL>
752
753 <!#######################################################################>
754 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
755 <H2>
756    <A CLASS="anchor" NAME="NewsVersion0_3">
757       <B>Version 0.3 (July 8 2003)</B></A>
758 </H2>
759 <UL>
760    <LI> <TT>gdcmFile</TT> class now enables acces to the data
761        i.e. the image[s] content. Previously only parsing of the
762        Dicom header was available through usage of <TT>gdcmHeader</TT>
763        class.
764    <LI> a <A HREF="http://public.kitware.com/VTK/">VTK</A> plugin
765        of gdcm is now available through the <TT>vtkGdcmReader</TT>
766        vtk class (see it as a vtk wrapper of gdcm), which enables
767        <UL>
768          <LI> Loading of a single image,
769          <LI> Loading of a stack of images from multiple Dicom files,
770          <LI> this class is wrapped for vtkPython (by using native vtk
771               wrappers).
772        </UL>
773    <LI> Introduction of a jpeg sub-library: lossless-jpeg
774         compressed Dicom files work.
775 <LI> <TT>vtkgdcmViewer</TT> allows easy displaying of single/multiframe 
776      GreyLevel/RGB/PaletteColor images
777 </UL>
778
779 <!#######################################################################>
780 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
781 <H2>
782    <A CLASS="anchor" NAME="NewsVersion0_1">
783       <B>Version 0.1 (April 1 2003)</B></A>
784
785 <!#######################################################################>
786 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
787 <H2>
788    <A CLASS="anchor" name="NewsVersion0_1">
789       <B>Version 0.0 (March 14 2003)</B></A>
790
791 <HR size="1"><ADDRESS style="align: right;"></ADRESS>
792
793 </BODY>
794 </HTML>