]> Creatis software - gdcm.git/blobdiff - Doc/Website/News.html
Fix bug on SplitOnly
[gdcm.git] / Doc / Website / News.html
index 49c6bfd6220f424385a9576d035241cd8a91682f..3e98d7236b9281c70dc92405d12a45dd31a01e4b 100644 (file)
@@ -26,21 +26,13 @@ Any contribution is welcome.
    <UL>
       <LI> gdcm doesn't read yet <TT>JPEG-LS</TT> encoded files.
       <UL>
-          We said '<TT>JPEG-LS</TT>', not Lossless Jpeg ...<br>
+          We said '<TT>JPEG-LS</TT>', not <i>Lossless Jpeg </i>...<br>
           [<TT>JPEG-LS</TT> is the basis for new lossless/near-lossless compression
           standard for continuous-tone images intended for <TT>JPEG2000</TT>. 
           The standard is based on the LOCO-I algorithm 
           (LOw COmplexity LOssless COmpression for Images) 
           developed at Hewlett-Packard Laboratories] 
      </UL>
-     <LI> gdcm doesn't read yet all <TT>JPEG2000</TT> encoded files.
-     <UL>
-         But we are working on it (a lot of troubles with Jasper).
-         Update: as of Oct 10 2005, we are currently investigating another library:
-         openjpeg. The problem still exist for this library but one of the author
-         is currently working on it:
-            http://www.openjpeg.org/forum/viewtopic.php?t=18
-      </UL>
       <LI> gdcm doesn't read yet <TT>MPEG2</TT> encoded files.
 
    </UL>
@@ -59,12 +51,6 @@ Any contribution is welcome.
    </UL> 
    <LI>Writer 
    <UL> 
-      <LI> Allow user to tell the Writer he doesn't want to write down
-           <TT>SeqEntry</TT> (if any) 
-      <LI> Allow user to tell the Writer he doesn't want to write down
-           <TT>Shadow groups</TT> (if any)
-      <LI> Allow user to tell the Writer which compression mode he wants<br>
-           (Right now, no one is available)
       <LI> Allow user to tell the Writer he wants to split a
            <TT>Multiframe</TT> image into a serie of 
            <TT>Single frame</TT> images.
@@ -84,9 +70,9 @@ Any contribution is welcome.
       <LI> <TT>DICOMDIR</TT> full management (not limited to
            <TT> PATIENT</TT>/<TT>STUDY</TT>/<TT>SERIE</TT>/<TT>IMAGE</TT>)
       <LI> Allow user to add an entry (belonging to the file header Dicom
-           entries)to the default entry list, before
+           entries) to the default entry list, before
            making a <TT>DICOMDIR</TT> from a root directory
-      <LI> Allow user to add an entry of his owns (for instance an <TT>Icon</TT>
+      <LI> Allow user to add an entry of his own (for instance an <TT>Icon</TT>
            to each image, or to each Serie).  
       </UL>
 <LI> SerieHelper
@@ -103,28 +89,300 @@ Any contribution is welcome.
    <UL>
       <LI> 16-bits-LUT full Management
       <LI> User friendly management of <TT>Rescale Slope</TT> and
-           <TT>Rescale Intercept</TT>
+           <TT>Rescale Intercept</TT>.<br>
+           (Well... Maybe it's up to the application to deal with it, not to
+           gdcm ?)
       <LI> Allow manual adjunction / automatic recognition (pfff!...)
            of the private <TT>Dicom Dictionary</TT>
            to be used to parse <TT>Shadow groups</TT> against.
+      <LI> User friendly way of anonymizing image when Patient's name is
+           burnt-in within the Pixels :-(  <br>
+           --> In many cases, the burnt-in Patient's name, etc
+               are actually stored as 'overlays'.<br>
+              'Normal' reading doesn't load those type of overlays.
    </UL>
 </UL>
 <!#######################################################################>
 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
 <H2>
    <A CLASS="anchor" NAME="NewsCurrentVersion">
-   <B>Current Version</B></A>
+   <B>Current Version (CVS) : gdcm1.3.2 </B></A>
       <B></B></A>
 </H2>
 
 <UL>
+   <LI> <A HREF="News.html#missing">Missing Features</a>
+   <LI>Differences between <b>gdcm 1.3.1</b> and <b>gdcm 1.3.2</b>
+   <UL>
+       <LI> Uncorrect reading/writting of JPEG/JPE2000 images when
+       BitsAllocated=16/BitsStored=8
+       <LI> Uncorrect writing of JPEG/JPE2000 image with an 'Icon' Sequence
+       <LI> Uncorrect writting of JPE2000 multiframe images
+       <LI> Uncorrect writting of images with a DataElement belonging to group
+       0002, inside a Sequence
+       <LI> Uncorrect re-writting of Implicit Value Representation images with
+       'shadow groups' when Explicit Value Representation was asked
+       (unexpected swap to Implicit VR)
+   </UL>
+   If you experience troubles with gdcm-written images, check which
+   gdcm version was used (PrintFile filein=yourFileName.dcm)
+   
    <LI>State of the art
    <UL>    
       <LI>
-         <a href="uml-gdcm.pdf">gdcm UML Class Diagram</a> current version.
-      <br><br>
+         <a href="uml-gdcmV1.2.pdf">gdcm UML Class Diagram</a> current version.
+      <LI> <a href= "DocCVS/html.user/index.html">User Documentation</a>
+      <LI> <a href= "DocCVS/html.developper/index.html">Developper
+         Documentation</a> 
+   <LI> New Features
+   
+   <UL>
+      <LI> To be able to use gdcm1.3.x and ITK, developer is now allowed to
+      choose his own namespace for gdcm at CMake time : see GDCM_NAME_SPACE
+      option.
+      <LI> JPEG and JPEG2000 compression writting are now available.
+       see Examples/WriteDicomAsJPEG.cxx and Examples/WriteDicomAsJPEG2000.cxx
+      <LI> To <i>try to</i> make gdcm images PACS usable, user is now allowed to
+           gdcm what kind of image he wants to write, using :  <br>
+   <TT>void FileHelper::SetContentType (ImageContentType c);</TT> <br>
+   Four different types are identifyed (probabely more will be added) :
+      <UL> 
+         <LI>
+      1) user created ex nihilo his own image and wants to write it as a Dicom image.<br>
+          c : <TT>USER_OWN_IMAGE</TT>
+         <LI>
+      2) user modified the pixels of an existing image, using mathematical operations.<br>
+          c : <TT>FILTERED_IMAGE</TT>
+         <LI>
+      3) user created a new image, using existing images (eg MIP, MPR, cartography image)<br>
+          c : <TT>CREATED_IMAGE</TT>
+         <LI>
+       4) user modified/added some tags *without processing* the pixels (anonymization, etc)<br>
+         c : <TT>UNMODIFIED_PIXELS_IMAGE</TT> 
+      </UL>
+      <LI> Stupid difference between <TT>gdcm::ValEntry</TT> 
+           and <TT>gdcm::BinEntry</TT> removed. <br>
+           Only <TT>gdcm::DataEntry</TT> exist, now. 
+           Should have been considered as a 'Bug Fix'.<br>
+           Actually, it's an API breaking modification ...
+      <UL>
+         <LI>
+            <TT>std::string const &DataEntry::GetString() const</TT><br>
+            returns as a string (when possible) the value of the DataEntry
+         <LI>
+            <TT>void DataEntry::SetString(std::string const &value)</TT><br>
+             Sets the 'value' of a DataEntry, passed as a std::string 
+         <LI>
+            <TT>void DataEntry::SetBinArea( uint8_t *area, bool self ) </TT><br>
+             Sets the value (non string) of the current Dicom DataEntry
+         <LI>
+              <TT>void DataEntry::CopyBinArea( uint8_t *area, uint32_t length )</TT><br>
+               Inserts the value (non string) into the current DataEntry 
+         <LI>
+               <TT>void DataEntry::SetValue(const uint32_t &id, const double
+ &val)</TT><br>
+               Inserts the elementary (non string) value into the current
+               (multivaluated) DataEntry, at the <TT>id></TT> position.
+         <LI>
+               <TT>double DataEntry::GetValue(const uint32_t &id) const </TT><br>
+               returns, as a double one of the values (when entry is 
+               multivaluated), identified by its index <TT>id</TT>. 
+      </UL>
+      <LI> 
+   <TT>DocEntrySet::GetEntryValue()</TT> replaced by
+           <TT>DocEntrySet::GetEntryString()</TT> <br>
+      <LI> SerieHelper : <br>     
+           Add some methods, to split a 'SingleSerieUID' Fileset into 
+           'Extra Coherent'  FileSets. <br>
+           They return a std::map of 'Filesets' (actually : std::vector 
+           of gdcm::File*)<br>
+           The key is the 'Orientation', the 'Position' 
+           or the value of a user choosen 'Tag' <br>
+           -  <TT>XCoherentFileSetmap SplitOnOrientation(FileList *fileSet);
+              </TT><br>
+           -  <TT>XCoherentFileSetmap SplitOnPosition(FileList *fileSet);
+              </TT> <br>
+           -  <TT>XCoherentFileSetmap SplitOnTagValue(FileList *fileSet,
+                                       uint16_t group, uint16_t element);
+              </TT><br>
+           These methods must be called by user, depending on what he wants 
+           to do, at application time.- *he* only  knows what his Series 
+           contain !-
+      <LI> To avoid memory leaks and seg faults the user intended classes
+           use now a Reference Counter.<br>
+      <UL>
+         <LI> <TT>new()</TT> and <TT>delete()</TT> are replaced by
+              <TT>New()</TT> and <TT>Delete()</TT>
+         <LI> <TT>Register()</TT> and <TT>Unregister()</TT> methods are 
+         available.
+         <LI> --> Well ... People from ITK don't seem to agree too much with 
+             that feature.<br>
+          They demand to be allowed to allocate gdcm objects in the stack as
+          well, not only in the heap.
+      </UL>
+      <LI>
    </UL>
-   <LI> <A HREF="News.html#missing">Missing Features</a>
+
+   <LI> API breaking modifications (since previous version)
+   <UL>
+      <LI> Stupid difference between <TT>gdcm::ValEntry</TT> 
+           and <TT>gdcm::BinEntry</TT> removed. <br>
+           Only <TT>gdcm::DataEntry</TT> exist, now. <br>  
+   <pre>
+   ValEntry(DictEntry *e);
+   BinEntry(DictEntry *e);
+-->DataEntry *New(uint16_t group,uint16_t elem, VRKey const &vr);
+
+   std::string const &ValEntry::GetValue() const;
+   std::string const &BinEntry::GetValue() const;
+-->std::string const &DataEntry::GetString() const;
+
+   uint8_t *BinEntry::GetBinArea();
+-->uint8_t *DataEntry::GetBinArea();
+
+   void ValEntry::SetValue(std::string const &value);
+   void BinEntry::SetValue(std::string const &value);   
+-->void DataEntry::SetString(std::string const &value);
+
+   void BinEntry::SetBinArea( uint8_t *area, bool self = true );
+-->void DataEntry::SetBinArea( uint8_t *area, bool self = true );
+
+   void ValEntry::CopyValEntry(uint16_t gr, uint16_t el);
+-->void DataEntry::CopyDataEntry(uint16_t gr, uint16_t el, VRKey const &vr);
+</pre>
+
+<pre>
+Example :
+
+old way :
+        DocEntry *p3 = item2->GetDocEntry(0x0018,0x0050);
+        if( !p3 ) return false;
+        ContentEntry *entry2 = dynamic_cast<ContentEntry *>(p3);
+        std::string thickness = entry2->GetValue();
+
+new way :
+        DocEntry *p3 = item2->GetDocEntry(0x0018,0x0050);
+        if( !p3 ) return false;
+        DataEntry *entry2 = dynamic_cast<DataEntry *>(p3);
+        std::string thickness = entry2->GetString();
+
+</pre>
+
+<LI> Avoid tons of CPU time consuming accesses to DICOM Dictionnary
+<pre>
+   DataEntry *FileHelper::CopyDataEntry(uint16_t group, uint16_t elem);
+-->DataEntry *FileHelper::CopyDataEntry(uint16_t group, uint16_t elem, 
+                                        const VRKey &vr = GDCM_VRUNKNOWN);
+
+   void FileHelper::CheckMandatoryEntry(uint16_t group, uint16_t elem, std::string value);
+-->void FileHelper::CheckMandatoryEntry(uint16_t group, uint16_t elem, std::string value,
+                                        const VRKey &vr = GDCM_VRUNKNOWN);
+      
+   void FileHelper::SetMandatoryEntry(uint16_t group, uint16_t elem, std::string value);       
+-->void FileHelper::SetMandatoryEntry(uint16_t group, uint16_t elem, std::string value,
+                                      const VRKey &vr = GDCM_VRUNKNOWN);
+
+   void FileHelper::CopyMandatoryEntry(uint16_t group, uint16_t elem, std::string value);      
+-->void FileHelper::CopyMandatoryEntry(uint16_t group, uint16_t elem, std::string value,
+                                       const VRKey &vr = GDCM_VRUNKNOWN);
+</pre>
+<LI> New features :
+<pre>
+For multivaluated numeric DataEntries
+-->void DataEntry::SetValue(const uint32_t &id,const double &val);
+-->double DataEntry::GetValue(const uint32_t &id) const;
+-->uint32_t DataEntry::GetValueCount() const;
+
+For converting 'Decimal String'
+-->bool GetDSValue(std::vector &lt;double&gt; &valueVector);  
+</pre>
+
+<LI> Avoid too many source file modifications from gdcm1.2 to gdcm1.3
+<pre>
+use :
+
+#define ValEntry                      DataEntry
+#define BinEntry                      DataEntry
+
+#define GetEntryValue(g,e)            GetEntryString(g,e)
+#define GetEntryForcedAsciiValue(g,e) GetEntryString(g,e)
+
+#define GetValEntry(g,e)              GetDataEntry(g,e)
+#define GetBinEntry(g,e)              GetDataEntry(g,e)
+#define GetValue()                    GetString()
+
+#define InsertValEntry(v,g,e,vr)      InsertEntryString(v,g,e,vr) // warning mind the VR!
+#define InsertBinEntry(b,l,g,e,vr)    InsertEntryBinArea(b,l,g,e,vr)
+
+#define SetValEntry(c,g,e)            SetEntryString(c,g,e)  | !!
+#define SetValEntry(c,en)             SetEntryString(c,en)   | !!
+
+#define SetBinEntry(c,l,en)           SetEntryBinArea(c,l,en)   | !!
+#define SetBinEntry(c,l,g,e)          SetEntryBinArea(c,l,g,e)  | !!
+
+#define NewValEntry(g,e,vr)           NewDataEntry(g,e,vr)
+#define NewBinEntry(g,e,vr)           NewDataEntry(g,e,vr)       
+
+</pre>
+   </UL> 
+      
+   <LI> Bug fixes
+   <UL>
+      <LI> Implicit VR - Big Endian (G.E Private) Transfert Syntax 16 Bits 
+           images are now read correctly.  
+      <LI> File::GetZOrigin() returns accurate result in any case.
+      <LI>
+      <LI>
+   </UL>
+   
+   <LI> Known Bugs
+   <UL>
+      <LI> Use of <TT>Implicit Value Representation</TT> writting mode may
+           causes troubles, when there are some <TT>SQ</TT> belonging to a 
+           <TT>Shadow Group</TT>. <br>
+           Better you use <TT>Explicit Value Representation</TT> writting mode ...
+      <LI> Troubles on 'Big endian' processors (i.e. Apple/Motorola, SunSparc
+           ...) when writting 16 Bits images.
+      <LI> Troubles on 64-bits processors.
+      <LI>
+      <LI>
+   </UL>
+      <br><br>
+ </UL>
+
+
+  
+<!#######################################################################>
+<A CLASS="anchor" NAME="NewsPreviousVersions">
+<!#######################################################################>
+<HR size="1"><ADDRESS style="align: right;"></ADDRESS>
+<H2>
+   <A CLASS="anchor" NAME="NewsVersion1_2">
+      <B>Version 1.2 </B></A>  
+</H2> 
+   <LI>State of the art
+   <UL>
+      <LI>
+         <a href="Doc1.0/uml-gdcmV1.0.pdf">gdcm 1.2 UML Class Diagram</a> version
+      (same as 1.1)
+      <LI> This is the Class Diagram of the version used within ITK.
+           (Hope we unify CVS version and ITK version, some day!)
+  
+<!#######################################################################>
+
+<HR size="1"><ADDRESS style="align: right;"></ADDRESS>
+<H2>
+   <A CLASS="anchor" NAME="NewsVersion1_1">
+      <B>Version 1.1 (September 14 2005)</B></A>   
+</H2> 
+   <LI>State of the art
+   <UL>
+      <LI>
+         <a href="Doc1.0/uml-gdcmV1.0.pdf">gdcm 1.1 UML Class Diagram</a> version.
+      <LI> <a href= "Doc1.0/html.user/index.html">User Documentation</a>
+      <LI> <a href= "Doc1.0/html.developper/index.html">Developper
+         Documentation</a> 
    <LI> New Features
    <UL>
       <LI> Add the methods
@@ -387,13 +645,7 @@ Any contribution is welcome.
 
    <LI> Known bugs
    <UL>
-      <LI> Use of <TT>Implicit Value Representation</TT> writting mode may
-           causes troubles, when there are some <TT>SQ</TT> belonging to a 
-           <TT>Shadow Group</TT>. <br>
-           Better you use <TT>Explicit Value Representation</TT> writting mode ...
-      <LI> Troubles on 'Big endian' processors (i.e. Apple/Motorola, SunSparc
-           ...) when writting 16 Bits images.
-      <LI> Troubles on 64-bits processors.
+
    </UL>
 
 </UL>