]> Creatis software - gdcm.git/blobdiff - Doc/Website/News.html
ENH: oh my god, none of the old ACR-NAME entry was correct, MR-MONO2-12-an2.acr is...
[gdcm.git] / Doc / Website / News.html
index dc42ddfd6e1134e463ffcc1c0c432a8408377278..49c6bfd6220f424385a9576d035241cd8a91682f 100644 (file)
@@ -8,10 +8,10 @@
 <BODY>
 
 
-<!#######################################################################>
+<!--#######################################################################-->
 <H1>Gdcm News</a></H1>
 
-<!#######################################################################>
+<!--#######################################################################-->
 
 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
 <H2>
 We know the following are missing; don't loose time looking for them ...<br>
 We know they could be helpfull. We shall add them some day.<br>
 Any contribution is welcome.
-
 <UL>
-   <LI> gdcm doesn't read yet JPEG-LS and JPEG2000 encoded files.
-   <LI> Allow user to tell <TT>gdcm::Document</TT> constructor he doesn't 
-           want to deal with <TT>SeqEntry</TT (every time it's possible)
-   <LI> Allow user to tell <TT>gdcm::Document</TT> constructor he doesn't 
-           want to deal with <TT>Shadow groups</TT> 
-   <LI> Allow user to tell <TT>gdcm::Document</TT> constructor he just wants 
-           to load a given list of <TT>DocEntries</TT> (to save CPU time and RAM
-           space)
-   <LI> Allow user to tell the Writer he doesn't want to write down
+<LI> Decoders   
+   <UL>
+      <LI> gdcm doesn't read yet <TT>JPEG-LS</TT> encoded files.
+      <UL>
+          We said '<TT>JPEG-LS</TT>', not Lossless Jpeg ...<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>
+   <LI>Reader
+   <UL>
+      <LI> Allow user to tell <TT>gdcm::Document</TT> constructor he just wants 
+           to load a given list of <TT>DocEntries</TT> 
+           (to save CPU time and RAM space)
+      <LI> Allow 'frame by frame' reading (should be helpfull for huge 
+           multiframe images)
+      <LI> Allow subvolume selection / frames selection before reading.
+      <LI> Expose Read/Decompression mechanisms to allow user getting
+         information from <tt>DICOMDIR</TT> <br> -or from his own Data Base- 
+         and reading his images without parsing
+         the header, one more time.
+   </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
+      <LI> Allow user to tell the Writer he doesn't want to write down
            <TT>Shadow groups</TT> (if any)
-   <LI> <TT>Icon Image</TT> management (Read and Write) 
-   <LI> <TT>DICOMDIR</TT> full management (not limited to
+      <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.
+      <LI> Allow user to tell the Writer he wants to agregate a
+           Serie of <TT>Single frame</TT> images into a
+           <TT>Multiframe</TT> image.
+   </UL>
+<LI>Reader / Writer 
+   <UL>  
+      <LI> Full <TT>Icon Image</TT> management (Read and Write) 
+      <LI> Full <TT>Overlays</TT> management (Read and Write) <br>
+           both for '<TT>ACR-NEMA</TT> style' (using groups <TT>0x6000</TT> 
+            and next) and '<TT>DICOM V3</TT> style' (using Sequences)
+   </UL>
+<LI> <TT>DICOMDIR</TT> 
+    <UL>
+      <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 to the default entry list, before
+      <LI> Allow user to add an entry (belonging to the file header Dicom
+           entries)to the default entry list, before
            making a <TT>DICOMDIR</TT> from a root directory
-   <LI> <TT>DICOMDIR</TT> anonymiser (<TT>Load</TT> and <TT>Noload</TT> mode)
-   <LI> 16-bits-LUT full Management
-   <LI> User friendly management of <TT>Rescale Slope</TT> and
+      <LI> Allow user to add an entry of his owns (for instance an <TT>Icon</TT>
+           to each image, or to each Serie).  
+      </UL>
+<LI> SerieHelper
+   <UL>
+
+      <LI> An accurate <TT>SerieHelper</TT> <br>
+           Right now <TT>SerieHelper</TT> only works on 'bona fide Series', and
+           breaks on wrongly forged Series.<br>
+           We are still looking for any heuristics...  
+      <LI> A <TT>SerieHelper</TT> that would use the <TT>DICOMDIR</TT> (if any)
+        instead of parsing all the files within the Root Directory
+   </UL>
+<LI> Other
+   <UL>
+      <LI> 16-bits-LUT full Management
+      <LI> User friendly management of <TT>Rescale Slope</TT> and
            <TT>Rescale Intercept</TT>
-   <LI> Allow parsing the <TT>Shadow groups</TT> against a user supplied 
-           private <TT>Dicom Dictionary</TT> (pfff!...)
-   <LI> An accurate <TT>SerieHelper</TT>
+      <LI> Allow manual adjunction / automatic recognition (pfff!...)
+           of the private <TT>Dicom Dictionary</TT>
+           to be used to parse <TT>Shadow groups</TT> against.
+   </UL>
 </UL>
-
 <!#######################################################################>
 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
 <H2>
@@ -62,44 +122,284 @@ Any contribution is welcome.
    <UL>    
       <LI>
          <a href="uml-gdcm.pdf">gdcm UML Class Diagram</a> current version.
-
-      <LI>
+      <br><br>
    </UL>
-
+   <LI> <A HREF="News.html#missing">Missing Features</a>
    <LI> New Features
    <UL>
-      <LI>Both <TT>vtkgdcmViewer</TT> and <TT>vtkgdcmViewer2</TT> 
-          are available to allow easy displaying of single/multiframe 
-          GreyLevel/RGB/PaletteColor images
+      <LI> Add the methods
+         <TT>gdcm::Dict:AddDict(std::string fullPathPrivateDictionaryFileName)</TT>
+        <br>and<br> 
+        <TT>gdcm::Dict::RemoveDict(std::string fullPathPrivateDictionaryFileName)</TT>
+        <br>
+        to allow user to choose the 'Private Dictionary' he wants to work with.
+        <br>
+        One can dream about a better API;<br>
+        This one allow right now anybody to see very easyly if the use 
+        of a given private dicom dictionary is of any help or not.
+        <br><br>
+      <LI>
+      <TT>PrintFile</TT> has now a new command line argument manager option :<br>
+          <TT>dict=fullPathNamePrivateDictionaryFile</TT><br>
+          to allow user to see with no extra coding what differences 
+          makes the use or not of a private Dicom Dictionary.<br>
+          e.g. : use it as follow <br>
+          <TT>PrintFile filein=myGEdicomFile.dcm 
+          dict=/user/userName/gdcm/Dicts/GEMS-Advance.dic</TT>
+          <br><br> 
+      <LI>
+          (Not a great one ...)  
+          Stupid method names : <br><TT>DicomDir::WriteDicomDir()</TT>
+          and <TT>DicomDir::AnonymizeDicomDir()</TT> <br>replaced by : <br>
+          <TT>DicomDir::Write()</TT>
+          and <TT>DicomDir::Anonymize()</TT>
+          <br><br> 
+      <LI><TT>
+          void Document::AddForceLoadElement(uint16_t group, uint16_t elem);
+          </TT><br>
+          allows user to tell <TT>gdcm::Document</TT> Loader he wants
+          to force the loading of a given set of <TT>DocEntries</TT>, 
+          even if their length exceeds the current 
+          <TT>MAX_SIZE_LOAD_ELEMENT_VALUE</TT>.
+          <br><br>
+       <LI>
+          Many users expect from <TT>vtkGdcmReader</TT> it 'orders' the images
+          (that's the job of <TT>gdcm::SerieHelper</TT> ...)<br>
+          When user <b>knows</b> the files with same Serie UID
+          have same sizes, same 'pixel' type, same color convention, ...
+          the right way to proceed is as follow :
+    <pre>
+        gdcm::SerieHelper *sh= new gdcm::SerieHelper();
+   //      if user wants *not* to load some parts of the file headers
+        sh->SetLoadMode(loadMode);
+
+   //      if user wants *not* to load some files
+        sh->AddRestriction(group, element, value, operator);
+        sh->AddRestriction( ...
+        sh->SetDirectory(directoryWithImages);
+
+   //      if user *knows* how to order his files
+        sh->SetUserLessThanFunction(userSuppliedComparisonFunction);
+   //      or/and
+   //      if user wants to sort reverse order
+        sh->SetSortOrderToReverse();
+   
+   //      here, we suppose only the first 'Single SerieUID' Fileset is of interest
+   //      Just iterate using sh->NextSingleSerieUIDFileSet()
+   //      if you want to get all of them
+        gdcm::FileList *l = sh->GetFirstSingleSerieUIDFileSet();
+
+   //      if user is doesn't trust too much the files with same Serie UID
+        if ( !sh->IsCoherent(l) )
+           return; // not same sizes, or not same 'pixel type' -> stop
+
+        sh->OrderFileList(l);        // sort the list
+
+        vtkGdcmReader *reader = vtkGdcmReader::New();
+   //      if user wants to modify pixel order (Mirror, TopDown, ...)
+   //      he has to supply the function that does the job
+   //      (a *very* simple example is given in vtkgdcmSerieViewer.cxx)
+        reader->SetUserFunction (userSuppliedFunction);
+
+   //      to pass a 'Single SerieUID' Fileset as produced by gdcm::SerieHelper
+        reader->SetCoherentFileList(l);
+        reader->Update();
+   </pre>
+   You can see a full example in <TT>vtk/vtkgdcmSerieViewer.cxx</TT><br>
+   e.g.<br>
+
+   <TT>vtkgdcmSerieViewer dirname=Dentist  mirror</TT><br>
+   <TT>vtkgdcmSerieViewer dirname=Dentist  reverse</TT><br>
+   <TT>vtkgdcmSerieViewer dirname=Dentist  reverse topdown</TT><br> 
+   </pre>
+      <br>
+
+      <LI> <TT>vtkGdcmReader::SetUserFunction (userSuppliedFunction)</TT><br>
+           with :<br>
+           <TT>void userSuppliedFunction(uint8_t *imageData, File *f);</TT><br>
+           allows user to reorganize the pixels of each image just after reading
+           it (to mirror, or topdown the image, for instance)<br>
+           Note : <TT>uint8_t *</TT> doesn't mean it works only on 8 Bits images.
+           <br> It's for prototyping. Feel free to cast it.
+           <br><br>  
+      <LI> <TT>
+           SerieHelper::SetUserLessThanFunction(userSuppliedComparisonFunction)
+           </TT><br> with : <br>
+           <TT>bool userSuppliedComparisonFunction(File *, File *);</TT><br>
+           allows user -when he knows more about his files than gdcm does-
+           to give his own comparison function. 
+      <LI> <TT>SerieHelper::SetSortOrderToReverse</TT> allows user to ask
+           to sort the Files reverse order.
+      <LI> <TT>SerieHelper::AddRestriction</TT> has now a new constructor<br>
+           <TT>AddRestriction(group, element, value, operator);</TT><br>
+           allows user to exclude some files from the sorting, according to
+           any comparison operator <br>
+           (<TT>GDCM_EQUAL</TT>, <TT>GDCM_DIFFERENT</TT>, 
+           <TT>GDCM_GREATER</TT>, <TT>GDCM_GREATEROREQUAL</TT>, 
+           <TT>GDCM_LESS</TT>, <TT>GDCM_LESSOREQUAL</TT>), not only on the
+           equality.
+           <br><br>
+      <LI> <TT>AnonymizeNoLoad</TT> used with <TT>dirin=inputDirectoryName</TT>
+           anonymizes all the files within the given Directory.
+           <br>
+           User may also choose extra elements he wants to rub out: <br>
+           <TT>rubout=listOfElementsToRubOut</TT><br>
+           with <tt>listOfElementsToRubOut : group1-elem1,group2-elem2,
+           ...</TT> (in hexa, no space within the list )
+           <br><br>
+      <LI> <TT>gdcm::SerieHelper()</TT> has a new method 
+           <TT>void AddGdcmFile(File *header)</TT>, that allows aware user to 
+           create a '<TT>FileList</TT>' (actually a 
+           <TT>std::vector< File* > </TT>).<br>
+           The <TT>FileList</TT> created this way will be the 
+           'first one' in the <TT>gdcm::FileHelper()</TT> (retrieve it with 
+           <TT>FileList *GetFirstCoherentFileList()</TT> ).<br>
+           It may be sorted using <TT>OrderFileList</TT>.<br>
+           No 'coherence check' will be performed on this <TT>FileList</TT>
+           before sorting.<br>
+           It may be passed to a <TT>vtkGdcmReader</TT> 
+           (to avoid parsing twice the files)
+           <br><br>
+      <LI> <TT>vtkGdcmReader</TT> can now get the result of
+           <TT>gdcm::SerieHelper</TT> (to avoid parsing twice the files)<br>
+            Proceed as follow :<br>
+           <pre>
+           gdcmSerieHelper *sh = new gdcmSerieHelper();
+           sh->SetDirectory(myImageDirectory, true);
+           gdcmFileList *l = s->GetFirstCoherentFileList();
+           s->OrderFileList(l);
 
+           vtkGdcmReader *gr = new vtkGdcmReader();
+           gr->SetCoherentFileList(l);
+           gr->Update();  
+           </pre>
+           This works with a directory that contains only one '<TT>Serie</TT>'
+           (same <TT>Serie UID</TT> for all the images).<br>
+           If it contains more than one <TT>Serie</TT>, you'll have to loop 
+           on the Series, using <TT>GetNextCoherentFileList()</TT>;<br>
+           It will be up to the user to delete the <TT>gdcm::File</TT>.
+           <br><br>
+           See <TT>vtkgdcmSerieViewer</TT> for an example.
+           <br><br>
+      <LI> Both <TT>vtkgdcmViewer</TT> and <TT>vtkgdcmViewer2</TT> 
+           are available to allow easy displaying of single/multiframe 
+           GreyLevel/RGB/PaletteColor images<br><br>
+      <LI> <TT>DICOMDIR</TT> anonymiser (<TT>Load</TT> and <TT>Noload</TT> mode)
+           <br><br>
+      <LI> Because the <TT>gdcm::DicomDir::Load()</TT> method may be used
+           either for loading an already made <TT>DICOMDIR</TT> file or for
+           parsing all the dicom files with a given root directory we
+           syntaxically separated the operations: <br>
+           For loading an already made <TT>DICOMDIR</TT> file, use : <br>
+           <pre>
+           gdcm::DicomDir *d = new gdcm::DicomDir();
+           d->SetFileName(fileName);
+           d->Load( );  
+           </pre>
+           For parsing all the dicom files within a given root directory, use :<br>
+           <pre>
+           gdcm::DicomDir *d = new gdcm::DicomDir();
+           d->SetDirectoryName(dirName);
+           d->Load( )  
+           </pre>
+
+           <b>Don't</b> use any longer old deprecated style: <br>
+           <TT>
+           gdcm::DicomDir *d = new gdcm::DicomDir();<br>
+           d->SetParseDir(true);   // </TT>or <TT>d->SetParseDir(false);<br>
+           d->Load( fileName );<br>  
+           </TT>
+           <br> 
+      <LI> User is now allowed to tell <TT>gdcm::Document</TT> constructor 
+           he doesn't want to deal with <TT>SeqEntry</TT> 
+           (every time it's possible, i.e for 'true length' Sequences) <br>
+           and/or he doesn't want to deal with <TT>Shadow groups</TT> 
+           (every time it's possible i.e. when element <TT>0x0000</TT>
+           exists for this Group) <br> 
+           or he doesn't want to deal with <TT>SeqEntry</TT> that belong to a 
+           <TT>Shadow group</TT>  (every time it's possible 
+           -'true length' Sequence-)<br>
+           use : <br>
+           <pre>
+           gdcm::File *f = new gdcm::File();
+                  f->SetLoadMode(NO_SEQ);            | depending on what
+                  f->SetLoadMode(NO_SHADOW);         | you want *not* 
+                  f->SetLoadMode(NO_SEQ | NO_SHADOW);| to load from the
+                  f->SetLoadMode(NO_SHADOWSEQ);      | target file
+            f->SetFileName(fileName);
+            f->Load( );
+            </pre>
+            <b>Don't</b> use any longer old deprecated style: <br>
+            <TT>
+            gdcm::File *f = new gdcm::File(fileName);</TT> <br>
+            <br>
+        <LI> User is now allowed to tell <TT>gdcm::DicomDir</TT> constructor 
+             he doesn't want to deal with <TT>SeqEntry</TT> 
+             (every time it's possible, i.e for 'true length' Sequences) <br>
+             and/or he doesn't want to deal with <TT>Shadow groups</TT> 
+             (every time it's possible i.e. when element <TT>0x0000</TT>
+             exists for this Group) <br> 
+             or he doesn't want to deal with <TT>SeqEntry</TT> that belong to a 
+             <TT>Shadow group</TT>  (every time it's possible 
+             -'true length' Sequence-)<br>
+             when he parses all the Dicom files within a given directory.<br>
+             use : <br>
+             <pre>
+             gdcm::DicomDir *f = new gdcm::DicomDir();
+                  f->SetLoadMode(NO_SEQ);            | depending on what
+                  f->SetLoadMode(NO_SHADOW);         | you want *not* 
+                  f->SetLoadMode(NO_SEQ | NO_SHADOW);| to load from the files
+                  f->SetLoadMode(NO_SHADOWSEQ);      | within the root directory 
+             f->SetDirectoryName(rootDirectoryName);
+             f->Load( );
+            </pre>
+            <b>Don't</b> use any longer old deprecated style: <br>
+            <TT>
+            gdcm::DicomDir *dcmdir = new gdcm::DicomDir(dirName, true);</TT><br>
+            <br>         
    </UL>
 
    <LI> Bug fixes
    <UL>
+      <LI> No more trouble when the 'endianess' switches within Sequences.
+      <LI> No more trouble with 'no length Sequences' belonging to a
+           <TT>Shadow Group</TT> when they are 'Implicit VR'.
       <LI> The difference between <TT>MONOCHROME1</TT> (low values = bright,
             high values = dark) and <TT>MONOCHROME2</TT> (low values = dark,
             high values = bright) is now taken into account.<br> 
             It's no longer up to the user to change the pixels value
+      <LI> Writing a 'True Dicom' image after reading an <TT>ACR-NEMA</TT> image 
+           does not request any longer from the user to build up 
+           'manually' the Meta Elements group (<TT>0x0002</TT>)
+      <LI> Old '24 Bits' <TT>ACR-NEMA</TT> are now correctly re-written
+           in <TT>DICOM V3</TT> mode.
+      <LI> Element <TT>0x0000</TT> of <TT>Shadow groups</TT> is always forced to be a
+           <TT>ValEntry</TT> and its <TT>VR</TT> is forced to <TT>UL</TT> 
+      <br><br>
    </UL>
 
    <LI> A.P.I. breaking modifications (since previous version : <TT>1.0</TT>)
    <UL>    
-      <LI>
-
+      <LI> NEVER more API breaking modifications !!!
+      <br><br>
    </UL>
 
-
    <LI> Known bugs
    <UL>
-      <LI> Writing a 'True Dicom' image after reading an ACR-NEMA image requests
-           from the user to build up 'manually' the Meta Elements group (0002) 
-      <LI> Management, on Big Endian Processors, of unloaded BinEntries
-      <LI> Old '24 Bits' ACR-NEMA are not correctly re-written in DICOM mode.
+      <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>
 
 
+
 <!#######################################################################>
 <HR size="1"><ADDRESS style="align: right;"></ADDRESS>
 <H2>
@@ -144,9 +444,27 @@ Any contribution is welcome.
         </UL>
       <LI> a <TT>gdcm::SeqEntry</TT> 
       </UL>
-   <LI> Removal of useless accessors <TT>GetXxxByname</TT>, <TT>SetXxxByname</TT> 
-   <LI> Removal of accessors <TT>GetXxxByNumber</TT>, <TT>SetXxxByNumber</TT>, 
-        renamed as <TT>GetXxx</TT>, <TT>SetXxx</TT>
+      <LI> Removal of useless accessors <TT>GetXxxByname</TT>, <TT>SetXxxByname</TT> 
+      <LI> Renaming of accessors <TT>GetXxxByNumber</TT>, <TT>SetXxxByNumber</TT> 
+           as follow :
+      <UL>
+         <LI> <TT>GetEntryByNumber 
+                  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+                                          --> GetEntryValue</TT>
+         <LI> <TT>GetEntryLengthByNumber  --> GetEntryLength</TT>
+         <LI> <TT>GetEntryOffsetByNumber  --> GetEntryOffset</TT>
+         <LI> <TT>GetEntryVRByNumber 
+                  &nbsp;&nbsp;&nbsp;      --> GetEntryVR</TT>
+         <LI>
+         <LI> <TT>GetDocEntryByNumber     
+                  &nbsp;&nbsp;            --> GetDocEntry</TT>
+         <LI> <TT>GetValEntryByNumber     
+                  &nbsp;&nbsp;            --> GetValEntry</TT>
+         <LI> <TT>GetBinEntryByNumber     
+                  &nbsp;&nbsp;            --> GetBinEntry</TT>
+         <LI> <TT>GetSeqEntryByNumber     
+                  &nbsp;&nbsp;            --> GetSeqEntry</TT>
+       </UL>
    </UL>
 </UL>