Fix mistypings

[gdcm.git] / src / gdcmFile.h

diff --git a/src/gdcmFile.h b/src/gdcmFile.h
index 0afb7cef4f4f3d67782d60a7b6052a19fdfb9a80..86866908f34f68c5ded235aab4d5862a13ba5657 100644 (file)
--- a/src/gdcmFile.h
+++ b/src/gdcmFile.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.h,v $
   Language:  C++
-  Date:      $Date: 2005/03/22 11:37:15 $
-  Version:   $Revision: 1.106 $
+  Date:      $Date: 2007/09/17 12:16:02 $
+  Version:   $Revision: 1.134 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -16,13 +16,17 @@
                                                                                 
 =========================================================================*/
 
-#ifndef GDCMFILE_H
-#define GDCMFILE_H
+#ifndef _GDCMFILE_H_
+#define _GDCMFILE_H_
 
+#include "gdcmDebug.h"
 #include "gdcmDocument.h"
+#include "gdcmTagKey.h"
 
-namespace gdcm 
+
+namespace GDCM_NAME_SPACE 
 {
+
 class RLEFramesInfo;
 class JPEGFragmentsInfo;
 
@@ -84,7 +88,7 @@ enum ModalityType {
  * dicom files according to header information e.g. to create a file hierarchy
  * reflecting the Patient/Study/Serie informations, or extracting a given
  * SerieId. Accessing the content (image[s] or volume[s]) is beyond the
- * functionality of this class and belongs to gdmcFile.
+ * functionality of this class and belongs to gdcm::FileHelper.
  * \note  The various entries of the explicit value representation (VR) shall
  *        be managed within a dictionary which is shared by all File
  *        instances.
@@ -94,22 +98,30 @@ enum ModalityType {
  */
 class GDCM_EXPORT File : public Document
 {
+   gdcmTypeMacro(File);
+
 public:
-   File();
-   File( std::string const &filename );
-   ~File();
+   static File *New() {return new File();}
 
+   // Loading
+  // GDCM_LEGACY(bool Load( std::string const &filename ))
+   bool Load();
    // Standard values and informations contained in the header
    bool IsReadable();
 
-   // Some heuristic based accessors, end user intended 
+   void SetFourthDimensionLocation(uint16_t group, uint16_t elem) {
+                   FourthDimensionLocation = TagKey(group, elem); }
+
+   // Some heuristic based accessors, end user intended
    int GetImageNumber();
    ModalityType GetModality();
 
    int GetXSize();
    int GetYSize();
    int GetZSize();
+   int GetTSize(); // unnormalized in DICOM V3
 
+   bool GetSpacing(float &xspacing, float &yspacing, float &zspacing);
    float GetXSpacing();
    float GetYSpacing();
    float GetZSpacing();
@@ -118,8 +130,16 @@ public:
    float GetYOrigin();
    float GetZOrigin();
 
-   void GetImageOrientationPatient( float iop[6] );
-
+   float GetXCosineOnX();
+   float GetXCosineOnY();  
+   float GetXCosineOnZ();
+   float GetYCosineOnX();
+   float GetYCosineOnY();  
+   float GetYCosineOnZ();   
+     
+   bool GetImageOrientationPatient( float iop[6] );
+   bool GetImagePositionPatient( float ipp[3] );
+   
    int GetBitsStored();
    int GetBitsAllocated();
    int GetHighBitPosition();
@@ -137,15 +157,16 @@ public:
    int GetLUTNbits();
 
    // For rescaling graylevel:
-   float GetRescaleIntercept();
-   float GetRescaleSlope();
+   bool GetRescaleSlopeIntercept(double &slope, double &intercept);   
+   double GetRescaleIntercept();
+   double GetRescaleSlope();
 
    int GetNumberOfScalarComponents();
    int GetNumberOfScalarComponentsRaw();
 
-   /// Accessor to \ref File::GrPixel
+   /// Accessor to  File::GrPixel
    uint16_t GetGrPixel()  { return GrPixel; }
-   /// Accessor to \ref File::NumPixel
+   /// Accessor to  File::NumPixel
    uint16_t GetNumPixel() { return NumPixel; }
 
    size_t GetPixelOffset();
@@ -160,7 +181,7 @@ public:
    void AddAnonymizeElement (uint16_t group, uint16_t elem, 
                              std::string const &value);
    /// Clears the list of elements to be anonymized
-   void ClearAnonymizeList() { AnonymizeList.clear(); }      
+   void ClearAnonymizeList() { UserAnonymizeList.clear(); }      
    void AnonymizeNoLoad();
    /// Replace patient's own information by info from the Anonymization list
    bool AnonymizeFile();
@@ -168,7 +189,12 @@ public:
    bool Write(std::string fileName, FileType filetype);
 
 protected:
- 
+   File();
+   virtual ~File();
+   /// \brief Protect the Writer from writing illegal groups
+   bool MayIWrite(uint16_t group)
+     { if (group < 8 &&  group !=2 ) return false; else return true; }
+      
    /// Store the RLE frames info obtained during parsing of pixels.
    RLEFramesInfo *RLEInfo;
    /// Store the JPEG fragments info obtained during parsing of pixels.
@@ -184,13 +210,18 @@ protected:
    /// In order to make things easier the parser shall store the proper value
    /// in GrPixel to provide a unique access facility.
    uint16_t GrPixel;
+   /// \brief allows user to tell gdcm in which DataElement is stored 
+   ///the -unnormalized- 4th Dimension   
+   TagKey FourthDimensionLocation;
 
 private:
+   bool DoTheLoadingJob();
    void ComputeRLEInfo();
    void ComputeJPEGFragmentInfo();
    bool     ReadTag(uint16_t, uint16_t);
    uint32_t ReadTagLength(uint16_t, uint16_t);
-   void ReadAndSkipEncapsulatedBasicOffsetTable();
+   void ReadEncapsulatedBasicOffsetTable();
+   uint32_t *BasicOffsetTableItemValue;
 
 };
 } // end namespace gdcm