]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.cxx
2004-03-24 Jean-Pierre Roux
[gdcm.git] / src / gdcmFile.cxx
index 3193f55406b763bafb89817c03037a80b2853dce..8e84268df4ab764a684ab6c9ea1ae541e64ae416 100644 (file)
@@ -79,7 +79,7 @@ gdcmFile::gdcmFile(std::string & filename) {
 /**
  * \ingroup   gdcmFile
  * \brief canonical destructor
- * \Note  If the gdcmHeader is created by the gdcmFile, it is destroyed
+ * \note  If the gdcmHeader is created by the gdcmFile, it is destroyed
  *        by the gdcmFile
  */
 gdcmFile::~gdcmFile(void) {
@@ -95,7 +95,7 @@ gdcmFile::~gdcmFile(void) {
 // Public
 /**
  * \ingroup   gdcmFile
- * \brief     
+ * \brief returns the gdcmHeader *Header   
  * @return     
  */
 gdcmHeader *gdcmFile::GetHeader(void) {
@@ -196,6 +196,7 @@ void * gdcmFile::GetImageData (void) {
    PixelData = (void *) malloc(lgrTotale);
    if (PixelData)
       GetImageDataIntoVector(PixelData, lgrTotale);
+      
    PixelRead=0; // no PixelRaw
    return(PixelData);
 }
@@ -332,7 +333,7 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
    }
        
    (void)ReadPixelData(destination);
-       
+       
        // Number of Bits Allocated for storing a Pixel
    str_nb = Header->GetEntryByNumber(0x0028,0x0100);
    if (str_nb == GDCM_UNFOUND ) {
@@ -378,7 +379,6 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
           deb++;   
          }
     }
-
    // re arange bits inside the bytes
    if (nbu != nb){
       int l = (int)lgrTotale / (nb/8);
@@ -403,7 +403,7 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
          return (size_t)0; 
       }
    } 
-// DO NOT remove this code commented out.
+// DO NOT remove this commented out code .
 // Nobody knows what's expecting you ...
 // Just to 'see' what was actually read on disk :-(
 
@@ -541,12 +541,13 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
 
 /**
  * \ingroup   gdcmFile
- * \brief TODO JPR
- * \warning doit-etre etre publique ?  
- * \toto : y a-t-il un inconvenient à fusioner ces 2 fonctions
- *
- * @param inData 
- * @param ExpectedSize 
+ * \brief performs a shadow copy (not a deep copy) of the user given
+ *        pixel area.
+ *        'image' Pixels are presented as C-like 2D arrays : line per line.
+ *        'volume'Pixels are presented as C-like 3D arrays : lane per plane 
+ * \warning user is kindly requested NOT TO 'free' the Pixel area
+ * @param inData user supplied pixel area
+ * @param ExpectedSize total image size, in Bytes
  *
  * @return boolean     
  */
@@ -581,7 +582,8 @@ bool gdcmFile::WriteRawData (std::string fileName) {
 
 /**
  * \ingroup   gdcmFile
- * \brief Writes on disk A SINGLE Dicom file
+ * \brief Writes on disk A SINGLE Dicom file, 
+ *        using the Implicit Value Representation convention
  *        NO test is performed on  processor "Endiannity".
  * @param fileName name of the file to be created
  *                 (any already existing file is overwritten)
@@ -594,8 +596,9 @@ bool gdcmFile::WriteDcmImplVR (std::string fileName) {
 
 /**
  * \ingroup   gdcmFile
- * \brief  
- * @param fileName name of the file to be created
+ * \brief Writes on disk A SINGLE Dicom file, 
+ *        using the Implicit Value Representation convention
+ *        NO test is performed on  processor "Endiannity". * @param fileName name of the file to be created
  *                 (any already existing file is overwritten)
  * @return false if write fails        
  */
@@ -606,8 +609,9 @@ bool gdcmFile::WriteDcmImplVR (const char* fileName) {
        
 /**
  * \ingroup   gdcmFile
- * \brief  
- * @param fileName name of the file to be created
+* \brief Writes on disk A SINGLE Dicom file, 
+ *        using the Explicit Value Representation convention
+ *        NO test is performed on  processor "Endiannity". * @param fileName name of the file to be created
  *                 (any already existing file is overwritten)
  * @return false if write fails        
  */
@@ -618,15 +622,14 @@ bool gdcmFile::WriteDcmExplVR (std::string fileName) {
        
 /**
  * \ingroup   gdcmFile
- * \brief  Ecrit au format ACR-NEMA sur disque l'entete et les pixels
+ * \brief Writes on disk A SINGLE Dicom file, 
+ *        using the ACR-NEMA convention
+ *        NO test is performed on  processor "Endiannity".
  *        (a l'attention des logiciels cliniques 
  *        qui ne prennent en entrée QUE des images ACR ...
  * \warning if a DICOM_V3 header is supplied,
- *         groups < 0x0008 and shadow groups are ignored)
+ *         groups < 0x0008 and shadow groups are ignored
  * \warning NO TEST is performed on processor "Endiannity".
- *        Ca fonctionnera correctement (?) sur processeur Intel
- *        (Equivalent a IdDcmWrite) 
- *
  * @param fileName name of the file to be created
  *                 (any already existing file is overwritten)
  * @return false if write fails                
@@ -640,10 +643,11 @@ bool gdcmFile::WriteAcr (std::string fileName) {
 // Protected
 /**
  * \ingroup   gdcmFile
- *
+ * \brief NOT a end user inteded function
+ *        (used by WriteDcmExplVR, WriteDcmImplVR, WriteAcr, etc)
  * @param fileName name of the file to be created
  *                 (any already existing file is overwritten)
- * @param  type file type (ExplicitVR, ImplicitVR, ...)
+ * @param  type file type (ExplicitVR, ImplicitVR, DICOMDIR, ...)
  * @return false if write fails                
  */
 bool gdcmFile::WriteBase (std::string fileName, FileType type) {
@@ -651,8 +655,8 @@ bool gdcmFile::WriteBase (std::string fileName, FileType type) {
    FILE * fp1;
    
    if (PixelRead==-1 && type != DICOMDIR) {
-      std::cout << "U never Read the pixels; U cannot write the file" 
-                << std::endl;
+/*      std::cout << "U never Read the pixels; U cannot write the file" 
+                << std::endl;*/
       return false;               
    }
 
@@ -768,9 +772,10 @@ if(nb == 16)
       case 2143:
       case 4321:
 
-         for(i=0;i<lgr;i++)
+         for(i=0;i<lgr/2;i++) {
             ((unsigned short int*)im)[i]= ((((unsigned short int*)im)[i])>>8)
                                         | ((((unsigned short int*)im)[i])<<8);
+       }
          break;
                        
       default:
@@ -784,7 +789,7 @@ if( nb == 32 )
          break;
 
       case 4321:
-         for(i=0;i<lgr;i++) {
+         for(i=0;i<lgr/4;i++) {
             faible=  ((unsigned long int*)im)[i]&0x0000ffff;    /* 4321 */
             fort  =((unsigned long int*)im)[i]>>16;
             fort=  (fort>>8)   | (fort<<8);
@@ -795,7 +800,7 @@ if( nb == 32 )
          break;
 
       case 2143:
-         for(i=0;i<lgr;i++) {
+         for(i=0;i<lgr/4;i++) {
             faible=  ((unsigned long int*)im)[i]&0x0000ffff;    /* 2143 */
             fort=((unsigned long int*)im)[i]>>16;
             fort=  (fort>>8)   | (fort<<8);
@@ -806,7 +811,7 @@ if( nb == 32 )
          break;
   
       case 3412:
-         for(i=0;i<lgr;i++) {
+         for(i=0;i<lgr/4;i++) {
             faible=  ((unsigned long int*)im)[i]&0x0000ffff;    /* 3412 */
             fort=((unsigned long int*)im)[i]>>16;                  
             s32=faible;