X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmFile.cxx;h=9e6788e6dc945d4df6e31f1448831cd955cd3e1d;hb=be54aab0103af7dee1a3bb5b8b3ee93b59ca9073;hp=97797c862b66fb3d91fba0ed6446ab3b35f8a3f8;hpb=19f72d139faa0f6a03f4e4a33be4c6b3e70b18b7;p=gdcm.git diff --git a/src/gdcmFile.cxx b/src/gdcmFile.cxx index 97797c86..9e6788e6 100644 --- a/src/gdcmFile.cxx +++ b/src/gdcmFile.cxx @@ -3,12 +3,12 @@ Program: gdcm Module: $RCSfile: gdcmFile.cxx,v $ Language: C++ - Date: $Date: 2004/06/23 03:36:24 $ - Version: $Revision: 1.107 $ + Date: $Date: 2005/01/24 16:44:54 $ + Version: $Revision: 1.199 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or - http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details. + http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR @@ -17,985 +17,1385 @@ =========================================================================*/ #include "gdcmFile.h" +#include "gdcmGlobal.h" +#include "gdcmUtil.h" #include "gdcmDebug.h" -#include "jpeg/ljpg/jpegless.h" +#include "gdcmTS.h" +#include "gdcmValEntry.h" +#include "gdcmBinEntry.h" +#include //sscanf -typedef std::pair IterHT; +#include +namespace gdcm +{ //----------------------------------------------------------------------------- // Constructor / Destructor /** - * \ingroup gdcmFile - * \brief Constructor dedicated to writing a new DICOMV3 part10 compliant - * file (see SetFileName, SetDcmTag and Write) - * Opens (in read only and when possible) an existing file and checks - * for DICOM compliance. Returns NULL on failure. - * \note the in-memory representation of all available tags found in - * the DICOM header is post-poned to first header information access. - * This avoid a double parsing of public part of the header when - * one sets an a posteriori shadow dictionary (efficiency can be - * seen as a side effect). - * @param header file to be opened for reading datas - * @return - */ -gdcmFile::gdcmFile(gdcmHeader *header) { - Header=header; - SelfHeader=false; - PixelRead=-1; // no ImageData read yet. - - if (Header->IsReadable()) - SetPixelDataSizeFromHeader(); -} - -/** - * \ingroup gdcmFile - * \brief Constructor dedicated to writing a new DICOMV3 part10 compliant - * file (see SetFileName, SetDcmTag and Write) - * Opens (in read only and when possible) an existing file and checks - * for DICOM compliance. Returns NULL on failure. - * \note the in-memory representation of all available tags found in - * the DICOM header is post-poned to first header information access. - * This avoid a double parsing of public part of the header when - * one sets an a posteriori shadow dictionary (efficiency can be - * seen as a side effect). - * @param filename file to be opened for parsing - * @param exception_on_error whether we throw an exception or not - * @param enable_sequences = true to allow the header - * to be parsed *inside* the SeQuences, - * when they have an actual length - * \warning enable_sequences *has to be* true for reading PAPYRUS 3.0 files - * @param ignore_shadow to allow skipping the shadow elements, - * to save memory space. - * \warning The TRUE value for this param has to be used - * with a FALSE value for the 'enable_sequence' param. - * ('public elements' may be embedded in 'shadow Sequences') - */ -gdcmFile::gdcmFile(std::string const & filename, - bool exception_on_error, - bool enable_sequences, - bool ignore_shadow) { - Header=new gdcmHeader(filename.c_str(), - exception_on_error, - enable_sequences, - ignore_shadow); - SelfHeader=true; - PixelRead=-1; // no ImageData read yet. - - if (Header->IsReadable()) - SetPixelDataSizeFromHeader(); -} - -/** - * \ingroup gdcmFile - * \brief canonical destructor - * \note If the gdcmHeader is created by the gdcmFile, it is destroyed - * by the gdcmFile - */ -gdcmFile::~gdcmFile() { - if(SelfHeader) - delete Header; - Header=NULL; + * \brief Constructor + * @param filename name of the file whose header we want to analyze + */ +File::File( std::string const &filename ): + Document( filename ) +{ + // for some ACR-NEMA images GrPixel, NumPixel is *not* 7fe0,0010 + // We may encounter the 'RETired' (0x0028, 0x0200) tag + // (Image Location") . This entry contains the number of + // the group that contains the pixel data (hence the "Pixel Data" + // is found by indirection through the "Image Location"). + // Inside the group pointed by "Image Location" the searched element + // is conventionally the element 0x0010 (when the norm is respected). + // When the "Image Location" is missing we default to group 0x7fe0. + // Note: this IS the right place for the code + + // Image Location + const std::string &imgLocation = GetEntryValue(0x0028, 0x0200); + if ( imgLocation == GDCM_UNFOUND ) + { + // default value + GrPixel = 0x7fe0; + } + else + { + GrPixel = (uint16_t) atoi( imgLocation.c_str() ); + } + + // sometimes Image Location value doesn't follow + // the supposed processor endianness. + // see gdcmData/cr172241.dcm + if ( GrPixel == 0xe07f ) + { + GrPixel = 0x7fe0; + } + + if ( GrPixel != 0x7fe0 ) + { + // This is a kludge for old dirty Philips imager. + NumPixel = 0x1010; + } + else + { + NumPixel = 0x0010; + } + + // Now, we know GrPixel and NumPixel. + // Let's create a VirtualDictEntry to allow a further VR modification + // and force VR to match with BitsAllocated. + DocEntry *entry = GetDocEntry(GrPixel, NumPixel); + if ( entry != 0 ) + { + + std::string PixelVR; + // 8 bits allocated is a 'O Bytes' , as well as 24 (old ACR-NEMA RGB) + // more than 8 (i.e 12, 16) is a 'O Words' + if ( GetBitsAllocated() == 8 || GetBitsAllocated() == 24 ) + PixelVR = "OB"; + else + PixelVR = "OW"; + + DictEntry* newEntry = NewVirtualDictEntry( + GrPixel, NumPixel, + PixelVR, "PXL", "Pixel Data"); + + // friend class hunting : should we *create* a new entry, + // instead of modifying its DictEntry,in order not to use 'friend' ? + entry->SetDictEntry( newEntry ); + } +} + +/** + * \brief Constructor used when we want to generate dicom files from scratch + */ +File::File() + :Document() +{ + InitializeDefaultFile(); +} + +/** + * \brief Canonical destructor. + */ +File::~File () +{ +} + +/** + * \brief Performs some consistency checking on various 'File related' + * (as opposed to 'DicomDir related') entries + * then writes in a file all the (Dicom Elements) included the Pixels + * @param fileName file name to write to + * @param filetype Type of the File to be written + * (ACR, ExplicitVR, ImplicitVR) + */ +bool File::Write(std::string fileName, FileType filetype) +{ + std::ofstream *fp = new std::ofstream(fileName.c_str(), + std::ios::out | std::ios::binary); + if (*fp == NULL) + { + gdcmVerboseMacro("Failed to open (write) File: " << fileName.c_str()); + return false; + } + + // Bits Allocated + if ( GetEntryValue(0x0028,0x0100) == "12") + { + SetEntryValue("16", 0x0028,0x0100); + } + + /// \todo correct 'Pixel group' Length if necessary + + int i_lgPix = GetEntryLength(GrPixel, NumPixel); + if (i_lgPix != -2) + { + // no (GrPixel, NumPixel) element + std::string s_lgPix = Util::Format("%d", i_lgPix+12); + s_lgPix = Util::DicomString( s_lgPix.c_str() ); + Insert(s_lgPix,GrPixel, 0x0000); + } + + // FIXME : should be nice if we could move it to File + // (or in future gdcmPixelData class) + + // Drop Palette Color, if necessary + + if ( GetEntryValue(0x0028,0x0002).c_str()[0] == '3' ) + { + // if SamplesPerPixel = 3, sure we don't need any LUT ! + // Drop 0028|1101, 0028|1102, 0028|1103 + // Drop 0028|1201, 0028|1202, 0028|1203 + + DocEntry *e = GetDocEntry(0x0028,0x01101); + if (e) + { + RemoveEntryNoDestroy(e); + } + e = GetDocEntry(0x0028,0x1102); + if (e) + { + RemoveEntryNoDestroy(e); + } + e = GetDocEntry(0x0028,0x1103); + if (e) + { + RemoveEntryNoDestroy(e); + } + e = GetDocEntry(0x0028,0x01201); + if (e) + { + RemoveEntryNoDestroy(e); + } + e = GetDocEntry(0x0028,0x1202); + if (e) + { + RemoveEntryNoDestroy(e); + } + e = GetDocEntry(0x0028,0x1203); + if (e) + { + RemoveEntryNoDestroy(e); + } + } + +/* +#ifdef GDCM_WORDS_BIGENDIAN + // Super Super hack that will make gdcm a BOMB ! but should + // Fix temporarily the dashboard + BinEntry *b = GetBinEntry(GrPixel,NumPixel); + if ( GetPixelSize() == 16 ) + { + uint16_t *im16 = (uint16_t*)b->GetBinArea(); + int lgr = b->GetLength(); + for( int i = 0; i < lgr / 2; i++ ) + { + im16[i]= (im16[i] >> 8) | (im16[i] << 8 ); + } + } +#endif //GDCM_WORDS_BIGENDIAN +*/ + + Document::WriteContent(fp,filetype); + +/* +#ifdef GDCM_WORDS_BIGENDIAN + // Flip back the pixel ... I told you this is a hack + if ( GetPixelSize() == 16 ) + { + uint16_t *im16 = (uint16_t*)b->GetBinArea(); + int lgr = b->GetLength(); + for( int i = 0; i < lgr / 2; i++ ) + { + im16[i]= (im16[i] >> 8) | (im16[i] << 8 ); + } + } +#endif //GDCM_WORDS_BIGENDIAN +*/ + + fp->close(); + delete fp; + + return true; } //----------------------------------------------------------------------------- // Print + //----------------------------------------------------------------------------- // Public /** - * \ingroup gdcmFile - * \brief computes the length (in bytes) to ALLOCATE to receive the - * image(s) pixels (multiframes taken into account) - * \warning : it is NOT the group 7FE0 length - * (no interest for compressed images). - * @return length to allocate - */ -void gdcmFile::SetPixelDataSizeFromHeader() { - // see PS 3.3-2003 : C.7.6.3.2.1 - // - // MONOCHROME1 - // MONOCHROME2 - // PALETTE COLOR - // RGB - // HSV (Retired) - // ARGB (Retired) - // CMYK (Retired) - // YBR_FULL - // YBR_FULL_422 (no LUT, no Palette) - // YBR_PARTIAL_422 - // YBR_ICT - // YBR_RCT - - // LUT's - // ex : gdcm-US-ALOKA-16.dcm - // 0028|1221 [OW] [Segmented Red Palette Color Lookup Table Data] - // 0028|1222 [OW] [Segmented Green Palette Color Lookup Table Data] - // 0028|1223 [OW] [Segmented Blue Palette Color Lookup Table Data] - - // ex : OT-PAL-8-face.dcm - // 0028|1201 [US] [Red Palette Color Lookup Table Data] - // 0028|1202 [US] [Green Palette Color Lookup Table Data] - // 0028|1203 [US] [Blue Palette Color Lookup Table Data] - - int nb; - std::string str_nb; - str_nb=Header->GetEntryByNumber(0x0028,0x0100); - if (str_nb == GDCM_UNFOUND ) { - nb = 16; - } else { - nb = atoi(str_nb.c_str() ); - if (nb == 12) nb =16; - } - lgrTotale = lgrTotaleRaw = Header->GetXSize() * Header->GetYSize() - * Header->GetZSize() * (nb/8)* Header->GetSamplesPerPixel(); - std::string str_PhotometricInterpretation = - Header->GetEntryByNumber(0x0028,0x0004); - - /*if ( str_PhotometricInterpretation == "PALETTE COLOR " )*/ - // pb when undealt Segmented Palette Color - - if (Header->HasLUT()) { - lgrTotale*=3; - } -} - -/** - * \ingroup gdcmFile - * \brief Returns the size (in bytes) of required memory to hold - * the pixel data represented in this file. - * @return The size of pixel data in bytes. - */ -size_t gdcmFile::GetImageDataSize() { - return lgrTotale; -} - -/** - * \ingroup gdcmFile - * \brief Returns the size (in bytes) of required memory to hold - * the pixel data represented in this file, when user DOESN'T want - * to get RGB pixels image when it's stored as a PALETTE COLOR image - * -the (vtk) user is supposed to know how deal with LUTs- - * \warning to be used with GetImagePixelsRaw() - * @return The size of pixel data in bytes. - */ -size_t gdcmFile::GetImageDataSizeRaw() { - return lgrTotaleRaw; -} - -/** - * \ingroup gdcmFile - * \brief Allocates necessary memory, copies the pixel data - * (image[s]/volume[s]) to newly allocated zone. - * Transforms YBR pixels into RGB pixels if any - * Transforms 3 planes R, G, B into a single RGB Plane - * Transforms single Grey plane + 3 Palettes into a RGB Plane - * @return Pointer to newly allocated pixel data. - * NULL if alloc fails - */ -void * gdcmFile::GetImageData () { - PixelData = new unsigned char[lgrTotale]; //consistant with GetImageDataIntoVector - if (PixelData) { - GetImageDataIntoVector(PixelData, lgrTotale); - GetHeader()->SetEntryVoidAreaByNumber(PixelData, - GetHeader()->GetGrPixel(), - GetHeader()->GetNumPixel()); - } - PixelRead=0; // no PixelRaw - - return PixelData; -} - -/** - * \ingroup gdcmFile - * \brief Copies at most MaxSize bytes of pixel data to caller's - * memory space. - * \warning This function was designed to avoid people that want to build - * a volume from an image stack to need first to get the image pixels - * and then move them to the volume area. - * It's absolutely useless for any VTK user since vtk chooses - * to invert the lines of an image, that is the last line comes first - * (for some axis related reasons?). Hence he will have - * to load the image line by line, starting from the end. - * VTK users have to call GetImageData - * - * @param destination Address (in caller's memory space) at which the - * pixel data should be copied - * @param MaxSize Maximum number of bytes to be copied. When MaxSize - * is not sufficient to hold the pixel data the copy is not - * executed (i.e. no partial copy). - * @return On success, the number of bytes actually copied. Zero on - * failure e.g. MaxSize is lower than necessary. - */ -size_t gdcmFile::GetImageDataIntoVector (void* destination, size_t MaxSize) { - //size_t l = GetImageDataIntoVectorRaw (destination, MaxSize); - GetImageDataIntoVectorRaw (destination, MaxSize); - PixelRead=0 ; // no PixelRaw - if (!Header->HasLUT()) - return lgrTotale; - - // from Lut R + Lut G + Lut B - unsigned char *newDest = new unsigned char[lgrTotale]; - unsigned char *a = (unsigned char *)destination; - unsigned char *lutRGBA = Header->GetLUTRGBA(); - if (lutRGBA) { - int l = lgrTotaleRaw; - memmove(newDest, destination, l);// move Gray pixels to temp area - int j; - for (int i=0;i 4 ) + { + return false; // Image Dimensions + } + if ( !GetDocEntry(0x0028, 0x0100) ) + { + return false; // "Bits Allocated" + } + if ( !GetDocEntry(0x0028, 0x0101) ) + { + return false; // "Bits Stored" + } + if ( !GetDocEntry(0x0028, 0x0102) ) + { + return false; // "High Bit" + } + if ( !GetDocEntry(0x0028, 0x0103) ) + { + return false; // "Pixel Representation" i.e. 'Sign' + } + + return true; +} + +/** + * \brief Retrieve the number of columns of image. + * @return The encountered size when found, 0 by default. + * 0 means the file is NOT USABLE. The caller will have to check + */ +int File::GetXSize() +{ + const std::string &strSize = GetEntryValue(0x0028,0x0011); + if ( strSize == GDCM_UNFOUND ) + { + return 0; + } + + return atoi( strSize.c_str() ); +} + +/** + * \brief Retrieve the number of lines of image. + * \warning The defaulted value is 1 as opposed to File::GetXSize() + * @return The encountered size when found, 1 by default + * (The ACR-NEMA file contains a Signal, not an Image). + */ +int File::GetYSize() +{ + const std::string &strSize = GetEntryValue(0x0028,0x0010); + if ( strSize != GDCM_UNFOUND ) + { + return atoi( strSize.c_str() ); + } + if ( IsDicomV3() ) + { + return 0; + } + + // The Rows (0028,0010) entry was optional for ACR/NEMA. It might + // hence be a signal (1D image). So we default to 1: + return 1; +} + +/** + * \brief Retrieve the number of planes of volume or the number + * of frames of a multiframe. + * \warning When present we consider the "Number of Frames" as the third + * dimension. When Missing we consider the third dimension as + * being the ACR-NEMA "Planes" tag content. + * @return The encountered size when found, 1 by default (single image). + */ +int File::GetZSize() +{ + // Both DicomV3 and ACR/Nema consider the "Number of Frames" + // as the third dimension. + const std::string &strSize = GetEntryValue(0x0028,0x0008); + if ( strSize != GDCM_UNFOUND ) + { + return atoi( strSize.c_str() ); + } + + // We then consider the "Planes" entry as the third dimension + const std::string &strSize2 = GetEntryValue(0x0028,0x0012); + if ( strSize2 != GDCM_UNFOUND ) + { + return atoi( strSize2.c_str() ); + } + + return 1; +} + +/** + * \brief gets the info from 0028,0030 : Pixel Spacing + * else 1.0 + * @return X dimension of a pixel + */ +float File::GetXSpacing() +{ + float xspacing, yspacing; + const std::string &strSpacing = GetEntryValue(0x0028,0x0030); + + if ( strSpacing == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "Unfound Pixel Spacing (0028,0030)" ); + return 1.; + } + + int nbValues; + if( ( nbValues = sscanf( strSpacing.c_str(), + "%f\\%f", &yspacing, &xspacing)) != 2 ) + { + // if single value is found, xspacing is defaulted to yspacing + if ( nbValues == 1 ) + { + xspacing = yspacing; } - delete[] newDest; - - // now, it's an RGB image - // Lets's write it in the Header - - // CreateOrReplaceIfExist ? - - std::string spp = "3"; // Samples Per Pixel - Header->SetEntryByNumber(spp,0x0028,0x0002); - std::string rgb= "RGB "; // Photometric Interpretation - Header->SetEntryByNumber(rgb,0x0028,0x0004); - std::string planConfig = "0"; // Planar Configuration - Header->SetEntryByNumber(planConfig,0x0028,0x0006); - - } else { - // need to make RGB Pixels (?) - // from grey Pixels (?!) - // and Gray Lut (!?!) - // or Segmented xxx Palette Color Lookup Table Data and so on - - // Oops! I get one (gdcm-US-ALOKA-16.dcm) - // No idea how to manage such an image - // It seems that *no Dicom Viewer* has any idea :-( - // Segmented xxx Palette Color are *more* than 65535 long ?!? - - std::string rgb= "MONOCHROME1 "; // Photometric Interpretation - Header->SetEntryByNumber(rgb,0x0028,0x0004); - } - /// \todo Drop Palette Color out of the Header? - return lgrTotale; -} - -/** - * \ingroup gdcmFile - * \brief Allocates necessary memory, copies the pixel data - * (image[s]/volume[s]) to newly allocated zone. - * Transforms YBR pixels into RGB pixels if any - * Transforms 3 planes R, G, B into a single RGB Plane - * DOES NOT transform Grey plane + 3 Palettes into a RGB Plane - * @return Pointer to newly allocated pixel data. - * \ NULL if alloc fails - */ -void * gdcmFile::GetImageDataRaw () { - if (Header->HasLUT()) - /// \todo Let gdcmHeadar user a chance to get the right value - /// Create a member lgrTotaleRaw ??? - lgrTotale /= 3; - PixelData = new unsigned char[lgrTotale]; - - if (PixelData) { - GetImageDataIntoVectorRaw(PixelData, lgrTotale); - GetHeader()->SetEntryVoidAreaByNumber(PixelData, - GetHeader()->GetGrPixel(), - GetHeader()->GetNumPixel()); - } - PixelRead=1; // PixelRaw - - return PixelData; -} - -/** - * \ingroup gdcmFile - * \brief Copies at most MaxSize bytes of pixel data to caller's - * memory space. - * \warning This function was designed to avoid people that want to build - * a volume from an image stack to need first to get the image pixels - * and then move them to the volume area. - * It's absolutely useless for any VTK user since vtk chooses - * to invert the lines of an image, that is the last line comes first - * (for some axis related reasons?). Hence he will have - * to load the image line by line, starting from the end. - * VTK users hace to call GetImageData - * \warning DOES NOT transform the Grey Plane + Palette Color (if any) - * into a single RGB Pixels Plane - * the (VTK) user will manage the palettes - * - * @param destination Address (in caller's memory space) at which the - * pixel data should be copied - * @param MaxSize Maximum number of bytes to be copied. When MaxSize - * is not sufficient to hold the pixel data the copy is not - * executed (i.e. no partial copy). - * @return On success, the number of bytes actually copied. Zero on - * failure e.g. MaxSize is lower than necessary. - */ -size_t gdcmFile::GetImageDataIntoVectorRaw (void *destination, size_t MaxSize) { - - int nb, nbu, highBit, signe; - std::string str_nbFrames, str_nb, str_nbu, str_highBit, str_signe; - PixelRead=1 ; // PixelRaw - - if ( lgrTotale > MaxSize ) { - dbg.Verbose(0, "gdcmFile::GetImageDataIntoVector: pixel data bigger" - "than caller's expected MaxSize"); - return (size_t)0; - } - - ReadPixelData(destination); - - // Number of Bits Allocated for storing a Pixel - str_nb = Header->GetEntryByNumber(0x0028,0x0100); - if (str_nb == GDCM_UNFOUND ) { - nb = 16; - } else { - nb = atoi(str_nb.c_str() ); - } - // Number of Bits actually used - str_nbu=Header->GetEntryByNumber(0x0028,0x0101); - if (str_nbu == GDCM_UNFOUND ) { - nbu = nb; - } else { - nbu = atoi(str_nbu.c_str() ); - } - // High Bit Position - str_highBit=Header->GetEntryByNumber(0x0028,0x0102); - if (str_highBit == GDCM_UNFOUND ) { - highBit = nb - 1; - } else { - highBit = atoi(str_highBit.c_str() ); - } - // Pixel sign - // 0 = Unsigned - // 1 = Signed - str_signe=Header->GetEntryByNumber(0x0028,0x0103); - if (str_signe == GDCM_UNFOUND ) { - signe = 0; // default is unsigned - } else { - signe = atoi(str_signe.c_str() ); - } - - // re arange bytes inside the integer (processor endianity) - if (nb != 8) - SwapZone(destination, Header->GetSwapCode(), lgrTotale, nb); - - // to avoid pb with some xmedcon breakers images - if (nb==16 && nbu> (nb-nbu); - guint16 *deb = (guint16 *)destination; - for(int i = 0; i> (nbu-highBit-1)) & mask; - deb ++; - } - } else if (nb == 32 ) { - guint32 mask = 0xffffffff; - mask = mask >> (nb-nbu); - guint32 *deb = (guint32 *)destination; - for(int i = 0; i> (nbu-highBit-1)) & mask; - deb ++; - } - } else { - dbg.Verbose(0, "gdcmFile::GetImageDataIntoVector: weird image"); - return 0; - } - } -// DO NOT remove this commented out code . -// Nobody knows what's expecting you ... -// Just to 'see' what was actually read on disk :-( - -// FILE * f2; -// f2 = fopen("SpuriousFile.RAW","wb"); -// fwrite(destination,lgrTotale,1,f2); -// fclose(f2); - - // Deal with the color - // ------------------- + + // if sscanf cannot read any float value, it won't affect yspacing + sscanf( strSpacing.c_str(), "%f", &yspacing); + + if ( yspacing == 0.0 ) + yspacing = 1.0; + + return yspacing; +} + +/** + * \brief gets the info from 0018,0088 : Space Between Slices + * else from 0018,0050 : Slice Thickness + * else 1.0 + * @return Z dimension of a voxel-to be + */ +float File::GetZSpacing() +{ + // Spacing Between Slices : distance entre le milieu de chaque coupe + // Les coupes peuvent etre : + // jointives (Spacing between Slices = Slice Thickness) + // chevauchantes (Spacing between Slices < Slice Thickness) + // disjointes (Spacing between Slices > Slice Thickness) + // Slice Thickness : epaisseur de tissus sur laquelle est acquis le signal + // ca interesse le physicien de l'IRM, pas le visualisateur de volumes ... + // Si le Spacing Between Slices est Missing, + // on suppose que les coupes sont jointives - std::string str_PhotometricInterpretation = - Header->GetEntryByNumber(0x0028,0x0004); - - if ( (str_PhotometricInterpretation == "MONOCHROME1 ") - || (str_PhotometricInterpretation == "MONOCHROME2 ") ) { - return lgrTotale; + const std::string &strSpacingBSlices = GetEntryValue(0x0018,0x0088); + + if ( strSpacingBSlices == GDCM_UNFOUND ) + { + gdcmVerboseMacro("Unfound Spacing Between Slices (0018,0088)"); + const std::string &strSliceThickness = GetEntryValue(0x0018,0x0050); + if ( strSliceThickness == GDCM_UNFOUND ) + { + gdcmVerboseMacro("Unfound Slice Thickness (0018,0050)"); + return 1.; } - - // Planar configuration = 0 : Pixels are already RGB - // Planar configuration = 1 : 3 planes : R, G, B - // Planar configuration = 2 : 1 gray Plane + 3 LUT - - // Well ... supposed to be ! - // See US-PAL-8-10x-echo.dcm: PlanarConfiguration=0, - // PhotometricInterpretation=PALETTE COLOR - // and heuristic has to be found :-( - - int planConf=Header->GetPlanarConfiguration(); // 0028,0006 - - // Whatever Planar Configuration is, - // "PALETTE COLOR " implies that we deal with the palette. - if (str_PhotometricInterpretation == "PALETTE COLOR ") - planConf=2; - - switch (planConf) { - case 0: - // Pixels are already RGB - break; - - case 1: - - { - if (str_PhotometricInterpretation == "YBR_FULL") { - - // Warning : YBR_FULL_422 acts as RGB - // : we need to make RGB Pixels from Planes Y,cB,cR - - // to see the tricks about YBR_FULL, YBR_FULL_422, - // YBR_PARTIAL_422, YBR_ICT, YBR_RCT have a look at : - // ftp://medical.nema.org/medical/dicom/final/sup61_ft.pdf - // and be *very* affraid - // - int l = Header->GetXSize()*Header->GetYSize(); - int nbFrames = Header->GetZSize(); - - unsigned char *newDest = new unsigned char[lgrTotale]; - unsigned char *x = newDest; - unsigned char *a = (unsigned char *)destination; - unsigned char *b = a + l; - unsigned char *c = b + l; - double R,G,B; - - /// \todo : Replace by the 'well known' integer computation - /// counterpart - /// see http://lestourtereaux.free.fr/papers/data/yuvrgb.pdf - /// for code optimisation - - for (int i=0;i255.0) R=255.0; - if (G>255.0) G=255.0; - if (B>255.0) B=255.0; - - *(x++) = (unsigned char)R; - *(x++) = (unsigned char)G; - *(x++) = (unsigned char)B; - a++; b++; c++; - } - } - memmove(destination,newDest,lgrTotale); - delete[] newDest; - - } else { - - // need to make RGB Pixels from R,G,B Planes - // (all the Frames at a time) - - int l = Header->GetXSize()*Header->GetYSize()*Header->GetZSize(); - - char *newDest = new char[lgrTotale]; - char *x = newDest; - char *a = (char *)destination; - char *b = a + l; - char *c = b + l; - - for (int j=0;jSetEntryByNumber(spp,0x0028,0x0002); - std::string rgb="RGB "; // Photometric Interpretation - Header->SetEntryByNumber(rgb,0x0028,0x0004); - - std::string planConfig = "0"; // Planar Configuration - Header->SetEntryByNumber(planConfig,0x0028,0x0006); - - /// \todo Drop Palette Color out of the Header? - return lgrTotale; -} - -/** - * \ingroup gdcmFile - * \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 - */ -bool gdcmFile::SetImageData(void *inData, size_t ExpectedSize) { - Header->SetImageDataSize(ExpectedSize); - PixelData = inData; - lgrTotale = ExpectedSize; - PixelRead = 1; + else + { + // if no 'Spacing Between Slices' is found, + // we assume slices join together + // (no overlapping, no interslice gap) + // if they don't, we're fucked up + return (float)atof( strSliceThickness.c_str() ); + } + } + //else + return (float)atof( strSpacingBSlices.c_str() ); +} - return true; +/** + *\brief gets the info from 0028,1052 : Rescale Intercept + * @return Rescale Intercept + */ +float File::GetRescaleIntercept() +{ + float resInter = 0.; + /// 0028 1052 DS IMG Rescale Intercept + const std::string &strRescInter = GetEntryValue(0x0028,0x1052); + if ( strRescInter != GDCM_UNFOUND ) + { + if( sscanf( strRescInter.c_str(), "%f", &resInter) != 1 ) + { + // bug in the element 0x0028,0x1052 + gdcmVerboseMacro( "Rescale Intercept (0028,1052) is empty." ); + } + } + + return resInter; } /** - * \ingroup gdcmFile - * \brief Writes on disk A SINGLE Dicom file - * NO test is performed on processor "Endiannity". - * It's up to the user to call his Reader properly - * @param fileName name of the file to be created - * (any already existing file is over written) - * @return false if write fails + *\brief gets the info from 0028,1053 : Rescale Slope + * @return Rescale Slope */ +float File::GetRescaleSlope() +{ + float resSlope = 1.; + //0028 1053 DS IMG Rescale Slope + std::string strRescSlope = GetEntryValue(0x0028,0x1053); + if ( strRescSlope != GDCM_UNFOUND ) + { + if( sscanf( strRescSlope.c_str(), "%f", &resSlope) != 1) + { + // bug in the element 0x0028,0x1053 + gdcmVerboseMacro( "Rescale Slope (0028,1053) is empty."); + } + } -bool gdcmFile::WriteRawData (std::string const & fileName) { - FILE *fp1; - fp1 = fopen(fileName.c_str(),"wb"); - if (fp1 == NULL) { - printf("Fail to open (write) file [%s] \n",fileName.c_str()); - return false; - } - fwrite (PixelData,lgrTotale, 1, fp1); - fclose (fp1); + return resSlope; +} - return true; +/** + * \brief This function is intended to user who doesn't want + * to have to manage a LUT and expects to get an RBG Pixel image + * (or a monochrome one ...) + * \warning to be used with GetImagePixels() + * @return 1 if Gray level, 3 if Color (RGB, YBR or PALETTE COLOR) + */ +int File::GetNumberOfScalarComponents() +{ + if ( GetSamplesPerPixel() == 3 ) + { + return 3; + } + + // 0028 0100 US IMG Bits Allocated + // (in order no to be messed up by old RGB images) + if ( GetEntryValue(0x0028,0x0100) == "24" ) + { + return 3; + } + + std::string strPhotometricInterpretation = GetEntryValue(0x0028,0x0004); + + if ( ( strPhotometricInterpretation == "PALETTE COLOR ") ) + { + if ( HasLUT() )// PALETTE COLOR is NOT enough + { + return 3; + } + else + { + return 1; + } + } + + // beware of trailing space at end of string + // DICOM tags are never of odd length + if ( strPhotometricInterpretation == GDCM_UNFOUND || + Util::DicomStringEqual(strPhotometricInterpretation, "MONOCHROME1") || + Util::DicomStringEqual(strPhotometricInterpretation, "MONOCHROME2") ) + { + return 1; + } + else + { + // we assume that *all* kinds of YBR are dealt with + return 3; + } } /** - * \ingroup gdcmFile - * \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 + * \brief This function is intended to user that DOESN'T want + * to get RGB pixels image when it's stored as a PALETTE COLOR image + * - the (vtk) user is supposed to know how deal with LUTs - + * \warning to be used with GetImagePixelsRaw() + * @return 1 if Gray level, 3 if Color (RGB or YBR - NOT 'PALETTE COLOR' -) */ +int File::GetNumberOfScalarComponentsRaw() +{ + // 0028 0100 US IMG Bits Allocated + // (in order no to be messed up by old RGB images) + if ( File::GetEntryValue(0x0028,0x0100) == "24" ) + { + return 3; + } -bool gdcmFile::WriteDcmImplVR (std::string const & fileName) { - return WriteBase(fileName, gdcmImplicitVR); + // we assume that *all* kinds of YBR are dealt with + return GetSamplesPerPixel(); } +// +// -------------- Remember ! ---------------------------------- +// +// Image Position Patient (0020,0032): +// If not found (ACR_NEMA) we try Image Position (0020,0030) +// If not found (ACR-NEMA), we consider Slice Location (0020,1041) +// or Location (0020,0050) +// as the Z coordinate, +// 0. for all the coordinates if nothing is found + +// \todo find a way to inform the caller nothing was found +// \todo How to tell the caller a wrong number of values was found? +// +// --------------------------------------------------------------- +// + /** - * \ingroup gdcmFile -* \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 + * \brief gets the info from 0020,0032 : Image Position Patient + * else from 0020,0030 : Image Position (RET) + * else 0. + * @return up-left image corner X position */ +float File::GetXOrigin() +{ + float xImPos, yImPos, zImPos; + std::string strImPos = GetEntryValue(0x0020,0x0032); + + if ( strImPos == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "Unfound Image Position Patient (0020,0032)"); + strImPos = GetEntryValue(0x0020,0x0030); // For ACR-NEMA images + if ( strImPos == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "Unfound Image Position (RET) (0020,0030)"); + /// \todo How to tell the caller nothing was found ? + return 0.; + } + } + + if( sscanf( strImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3 ) + { + return 0.; + } -bool gdcmFile::WriteDcmExplVR (std::string const & fileName) { - return WriteBase(fileName, gdcmExplicitVR); + return xImPos; } - + /** - * \ingroup gdcmFile - * \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 - * \warning 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 + * \brief gets the info from 0020,0032 : Image Position Patient + * else from 0020,0030 : Image Position (RET) + * else 0. + * @return up-left image corner Y position */ +float File::GetYOrigin() +{ + float xImPos, yImPos, zImPos; + std::string strImPos = GetEntryValue(0x0020,0x0032); + + if ( strImPos == GDCM_UNFOUND) + { + gdcmVerboseMacro( "Unfound Image Position Patient (0020,0032)"); + strImPos = GetEntryValue(0x0020,0x0030); // For ACR-NEMA images + if ( strImPos == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "Unfound Image Position (RET) (0020,0030)"); + /// \todo How to tell the caller nothing was found ? + return 0.; + } + } -bool gdcmFile::WriteAcr (std::string const & fileName) { - return WriteBase(fileName, gdcmACR); + if( sscanf( strImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3 ) + { + return 0.; + } + + return yImPos; } -//----------------------------------------------------------------------------- -// 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, ...) - * @return false if write fails + * \brief gets the info from 0020,0032 : Image Position Patient + * else from 0020,0030 : Image Position (RET) + * else from 0020,1041 : Slice Location + * else from 0020,0050 : Location + * else 0. + * @return up-left image corner Z position */ -bool gdcmFile::WriteBase (std::string const & fileName, FileType type) { +float File::GetZOrigin() +{ + float xImPos, yImPos, zImPos; + std::string strImPos = GetEntryValue(0x0020,0x0032); + + if ( strImPos != GDCM_UNFOUND ) + { + if( sscanf( strImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3) + { + gdcmVerboseMacro( "Wrong Image Position Patient (0020,0032)"); + return 0.; // bug in the element 0x0020,0x0032 + } + else + { + return zImPos; + } + } - FILE *fp1; - - if (PixelRead==-1 && type != gdcmExplicitVR) { - return false; + strImPos = GetEntryValue(0x0020,0x0030); // For ACR-NEMA images + if ( strImPos != GDCM_UNFOUND ) + { + if( sscanf( strImPos.c_str(), + "%f\\%f\\%f", &xImPos, &yImPos, &zImPos ) != 3 ) + { + gdcmVerboseMacro( "Wrong Image Position (RET) (0020,0030)"); + return 0.; // bug in the element 0x0020,0x0032 + } + else + { + return zImPos; + } } - fp1 = fopen(fileName.c_str(),"wb"); - if (fp1 == NULL) { - printf("Failed to open (write) File [%s] \n",fileName.c_str()); - return (false); + std::string strSliceLocation = GetEntryValue(0x0020,0x1041); // for *very* old ACR-NEMA images + if ( strSliceLocation != GDCM_UNFOUND ) + { + if( sscanf( strSliceLocation.c_str(), "%f", &zImPos) != 1) + { + gdcmVerboseMacro( "Wrong Slice Location (0020,1041)"); + return 0.; // bug in the element 0x0020,0x1041 + } + else + { + return zImPos; + } + } + gdcmVerboseMacro( "Unfound Slice Location (0020,1041)"); + + std::string strLocation = GetEntryValue(0x0020,0x0050); + if ( strLocation != GDCM_UNFOUND ) + { + if( sscanf( strLocation.c_str(), "%f", &zImPos) != 1) + { + gdcmVerboseMacro( "Wrong Location (0020,0050)"); + return 0.; // bug in the element 0x0020,0x0050 + } + else + { + return zImPos; + } + } + gdcmVerboseMacro( "Unfound Location (0020,0050)"); + + return 0.; // Hopeless +} + +/** + * \brief gets the info from 0020,0013 : Image Number else 0. + * @return image number + */ +int File::GetImageNumber() +{ + // The function i atoi() takes the address of an area of memory as + // parameter and converts the string stored at that location to an integer + // using the external decimal to internal binary conversion rules. This may + // be preferable to sscanf() since atoi() is a much smaller, simpler and + // faster function. sscanf() can do all possible conversions whereas + // atoi() can only do single decimal integer conversions. + //0020 0013 IS REL Image Number + std::string strImNumber = GetEntryValue(0x0020,0x0013); + if ( strImNumber != GDCM_UNFOUND ) + { + return atoi( strImNumber.c_str() ); } + return 0; //Hopeless +} - if ( (type == gdcmImplicitVR) || (type == gdcmExplicitVR) ) { - char *filePreamble; - // writing Dicom File Preamble - filePreamble=new char[128]; - memset(filePreamble,0,128); - fwrite(filePreamble,128,1,fp1); - fwrite("DICM",4,1,fp1); - delete[] filePreamble; +/** + * \brief gets the info from 0008,0060 : Modality + * @return Modality Type + */ +ModalityType File::GetModality() +{ + // 0008 0060 CS ID Modality + std::string strModality = GetEntryValue(0x0008,0x0060); + if ( strModality != GDCM_UNFOUND ) + { + if ( strModality.find("AU") < strModality.length()) return AU; + else if ( strModality.find("AS") < strModality.length()) return AS; + else if ( strModality.find("BI") < strModality.length()) return BI; + else if ( strModality.find("CF") < strModality.length()) return CF; + else if ( strModality.find("CP") < strModality.length()) return CP; + else if ( strModality.find("CR") < strModality.length()) return CR; + else if ( strModality.find("CT") < strModality.length()) return CT; + else if ( strModality.find("CS") < strModality.length()) return CS; + else if ( strModality.find("DD") < strModality.length()) return DD; + else if ( strModality.find("DF") < strModality.length()) return DF; + else if ( strModality.find("DG") < strModality.length()) return DG; + else if ( strModality.find("DM") < strModality.length()) return DM; + else if ( strModality.find("DS") < strModality.length()) return DS; + else if ( strModality.find("DX") < strModality.length()) return DX; + else if ( strModality.find("ECG") < strModality.length()) return ECG; + else if ( strModality.find("EPS") < strModality.length()) return EPS; + else if ( strModality.find("FA") < strModality.length()) return FA; + else if ( strModality.find("FS") < strModality.length()) return FS; + else if ( strModality.find("HC") < strModality.length()) return HC; + else if ( strModality.find("HD") < strModality.length()) return HD; + else if ( strModality.find("LP") < strModality.length()) return LP; + else if ( strModality.find("LS") < strModality.length()) return LS; + else if ( strModality.find("MA") < strModality.length()) return MA; + else if ( strModality.find("MR") < strModality.length()) return MR; + else if ( strModality.find("NM") < strModality.length()) return NM; + else if ( strModality.find("OT") < strModality.length()) return OT; + else if ( strModality.find("PT") < strModality.length()) return PT; + else if ( strModality.find("RF") < strModality.length()) return RF; + else if ( strModality.find("RG") < strModality.length()) return RG; + else if ( strModality.find("RTDOSE") < strModality.length()) return RTDOSE; + else if ( strModality.find("RTIMAGE") < strModality.length()) return RTIMAGE; + else if ( strModality.find("RTPLAN") < strModality.length()) return RTPLAN; + else if ( strModality.find("RTSTRUCT") < strModality.length()) return RTSTRUCT; + else if ( strModality.find("SM") < strModality.length()) return SM; + else if ( strModality.find("ST") < strModality.length()) return ST; + else if ( strModality.find("TG") < strModality.length()) return TG; + else if ( strModality.find("US") < strModality.length()) return US; + else if ( strModality.find("VF") < strModality.length()) return VF; + else if ( strModality.find("XA") < strModality.length()) return XA; + else if ( strModality.find("XC") < strModality.length()) return XC; + + else + { + /// \todo throw error return value ??? + /// specified <> unknown in our database + return Unknow; + } } - // -------------------------------------------------------------- - // Special Patch to allow gdcm to re-write ACR-LibIDO formated images - // - // if recognition code tells us we dealt with a LibIDO image - // we reproduce on disk the switch between lineNumber and columnNumber - // just before writting ... - - /// \todo the best trick would be *change* the recognition code - /// but pb expected if user deals with, e.g. COMPLEX images - - std::string rows, columns; - if ( Header->GetFileType() == gdcmACR_LIBIDO){ - rows = Header->GetEntryByNumber(0x0028, 0x0010); - columns = Header->GetEntryByNumber(0x0028, 0x0011); - Header->SetEntryByNumber(columns, 0x0028, 0x0010); - Header->SetEntryByNumber(rows , 0x0028, 0x0011); - } - // ----------------- End of Special Patch ---------------- - - /// \todo get the grPixel, numPixel values (for some ACR-NEMA images only) - - guint16 grPixel =Header->GetGrPixel(); - guint16 numPixel=Header->GetNumPixel();; - - // Update Pixel Data Length - // the *last* of the (GrPixel, NumPixel), if many. - - TagKey key = gdcmDictEntry::TranslateToKey(grPixel, numPixel); - TagDocEntryHT::iterator p2; - gdcmDocEntry *PixelElement; - - IterHT it= Header->GetEntry().equal_range(key); // get a pair of iterators first-last synonym + return Unknow; +} - if (Header->GetEntry().count(key) == 1) // only the first is significant - p2=it.first; // iterator on the first (unique) synonym - else - p2=it.second;// iterator on the last synonym - - PixelElement=p2->second; // H Table target column (2-nd col) - // PixelElement->SetPrintLevel(2); - // PixelElement->Print(); - - if (PixelRead==1) - PixelElement->SetLength(lgrTotaleRaw); - else if (PixelRead==0) - PixelElement->SetLength(lgrTotale); - - //PixelElement->SetPrintLevel(2); - //PixelElement->Print(); - Header->Write(fp1, type); - - // -------------------------------------------------------------- - // Special Patch to allow gdcm to re-write ACR-LibIDO formated images - // - // ...and we restore the Header to be Dicom Compliant again - // just after writting - - if (Header->GetFileType() == gdcmACR_LIBIDO){ - Header->SetEntryByNumber(rows , 0x0028, 0x0010); - Header->SetEntryByNumber(columns, 0x0028, 0x0011); - } - // ----------------- End of Special Patch ---------------- - - // fwrite(PixelData, lgrTotale, 1, fp1); // should be useless, now - fclose (fp1); +/** + * \brief Retrieve the number of Bits Stored (actually used) + * (as opposite to number of Bits Allocated) + * @return The encountered number of Bits Stored, 0 by default. + * 0 means the file is NOT USABLE. The caller has to check it ! + */ +int File::GetBitsStored() +{ + std::string strSize = GetEntryValue( 0x0028, 0x0101 ); + if ( strSize == GDCM_UNFOUND ) + { + gdcmVerboseMacro("(0028,0101) is supposed to be mandatory"); + return 0; // It's supposed to be mandatory + // the caller will have to check + } + return atoi( strSize.c_str() ); +} +/** + * \brief Retrieve the high bit position. + * \warning The method defaults to 0 when information is Missing. + * The responsability of checking this value is left to the caller. + * @return The high bit positin when present. 0 when Missing. + */ +int File::GetHighBitPosition() +{ + std::string strSize = GetEntryValue( 0x0028, 0x0102 ); + if ( strSize == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "(0028,0102) is supposed to be mandatory"); + return 0; + } + return atoi( strSize.c_str() ); +} + +/** + * \brief Check whether the pixels are signed or UNsigned data. + * \warning The method defaults to false (UNsigned) when information is Missing. + * The responsability of checking this value is left to the caller. + * @return True when signed, false when UNsigned + */ +bool File::IsSignedPixelData() +{ + std::string strSize = GetEntryValue( 0x0028, 0x0103 ); + if ( strSize == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "(0028,0103) is supposed to be mandatory"); + return false; + } + int sign = atoi( strSize.c_str() ); + if ( sign == 0 ) + { + return false; + } return true; } -//----------------------------------------------------------------------------- -// Private /** - * \ingroup gdcmFile - * \brief Swap the bytes, according to swap code. - * \warning not end user intended - * @param im area to deal with - * @param swap swap code - * @param lgr Area Length - * @param nb Pixels Bit number - */ -void gdcmFile::SwapZone(void *im, int swap, int lgr, int nb) { - guint32 s32; - guint16 fort,faible; - int i; - - if(nb == 16) - switch(swap) { - case 0: - case 12: - case 1234: - break; - - case 21: - case 3412: - case 2143: - case 4321: - - for(i=0;i>8) - | ((((unsigned short int *)im)[i])<<8); - } - break; - - default: - printf("SWAP value (16 bits) not allowed : %d\n", swap); - } - - if( nb == 32 ) - switch (swap) { - case 0: - case 1234: - break; - - case 4321: - for(i=0;i>16; - fort= (fort>>8) | (fort<<8); - faible=(faible>>8) | (faible<<8); - s32=faible; - ((unsigned long int *)im)[i]=(s32<<16)|fort; - } - break; - - case 2143: - for(i=0;i>16; - fort= (fort>>8) | (fort<<8); - faible=(faible>>8) | (faible<<8); - s32=fort; - ((unsigned long int *)im)[i]=(s32<<16)|faible; - } - break; - - case 3412: - for(i=0;i>16; - s32=faible; - ((unsigned long int *)im)[i]=(s32<<16)|fort; - } - break; - - default: - std::cout << "SWAP value (32 bits) not allowed : " << swap << std::endl; - } + * \brief Retrieve the number of Bits Allocated + * (8, 12 -compacted ACR-NEMA files, 16, ...) + * @return The encountered number of Bits Allocated, 0 by default. + * 0 means the file is NOT USABLE. The caller has to check it ! + */ +int File::GetBitsAllocated() +{ + std::string strSize = GetEntryValue(0x0028,0x0100); + if ( strSize == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "(0028,0100) is supposed to be mandatory"); + return 0; // It's supposed to be mandatory + // the caller will have to check + } + return atoi( strSize.c_str() ); +} + +/** + * \brief Retrieve the number of Samples Per Pixel + * (1 : gray level, 3 : RGB -1 or 3 Planes-) + * @return The encountered number of Samples Per Pixel, 1 by default. + * (Gray level Pixels) + */ +int File::GetSamplesPerPixel() +{ + const std::string& strSize = GetEntryValue(0x0028,0x0002); + if ( strSize == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "(0028,0002) is supposed to be mandatory"); + return 1; // Well, it's supposed to be mandatory ... + // but sometimes it's missing : *we* assume Gray pixels + } + return atoi( strSize.c_str() ); } /** - * \ingroup gdcmFile - * \brief Read pixel data from disk (optionaly decompressing) into the - * caller specified memory location. - * @param destination where the pixel data should be stored. - * + * \brief Check whether this a monochrome picture or not by accessing + * the "Photometric Interpretation" tag ( 0x0028, 0x0004 ). + * @return true when "MONOCHROME1" or "MONOCHROME2". False otherwise. */ -bool gdcmFile::ReadPixelData(void *destination) { +bool File::IsMonochrome() +{ + const std::string& PhotometricInterp = GetEntryValue( 0x0028, 0x0004 ); + if ( Util::DicomStringEqual(PhotometricInterp, "MONOCHROME1") + || Util::DicomStringEqual(PhotometricInterp, "MONOCHROME2") ) + { + return true; + } + if ( PhotometricInterp == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "Not found : Photometric Interpretation (0028,0004)"); + } + return false; +} - FILE *fp; +/** + * \brief Check whether this a "PALETTE COLOR" picture or not by accessing + * the "Photometric Interpretation" tag ( 0x0028, 0x0004 ). + * @return true when "PALETTE COLOR". False otherwise. + */ +bool File::IsPaletteColor() +{ + std::string PhotometricInterp = GetEntryValue( 0x0028, 0x0004 ); + if ( PhotometricInterp == "PALETTE COLOR " ) + { + return true; + } + if ( PhotometricInterp == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "Not found : Palette color (0028,0004)"); + } + return false; +} - if ( !(fp=Header->OpenFile())) +/** + * \brief Check whether this a "YBR_FULL" color picture or not by accessing + * the "Photometric Interpretation" tag ( 0x0028, 0x0004 ). + * @return true when "YBR_FULL". False otherwise. + */ +bool File::IsYBRFull() +{ + std::string PhotometricInterp = GetEntryValue( 0x0028, 0x0004 ); + if ( PhotometricInterp == "YBR_FULL" ) + { + return true; + } + if ( PhotometricInterp == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "Not found : YBR Full (0028,0004)"); + } + return false; +} + +/** + * \brief Retrieve the Planar Configuration for RGB images + * (0 : RGB Pixels , 1 : R Plane + G Plane + B Plane) + * @return The encountered Planar Configuration, 0 by default. + */ +int File::GetPlanarConfiguration() +{ + std::string strSize = GetEntryValue(0x0028,0x0006); + if ( strSize == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "Not found : Planar Configuration (0028,0006)"); + return 0; + } + return atoi( strSize.c_str() ); +} + +/** + * \brief Return the size (in bytes) of a single pixel of data. + * @return The size in bytes of a single pixel of data; 0 by default + * 0 means the file is NOT USABLE; the caller will have to check + */ +int File::GetPixelSize() +{ + // 0028 0100 US IMG Bits Allocated + // (in order no to be messed up by old RGB images) + // if (File::GetEntryValue(0x0028,0x0100) == "24") + // return 3; + + std::string pixelType = GetPixelType(); + if ( pixelType == "8U" || pixelType == "8S" ) + { + return 1; + } + if ( pixelType == "16U" || pixelType == "16S") + { + return 2; + } + if ( pixelType == "32U" || pixelType == "32S") + { + return 4; + } + if ( pixelType == "FD" ) + { + return 8; + } + gdcmVerboseMacro( "Unknown pixel type"); + return 0; +} + +/** + * \brief Build the Pixel Type of the image. + * Possible values are: + * - 8U unsigned 8 bit, + * - 8S signed 8 bit, + * - 16U unsigned 16 bit, + * - 16S signed 16 bit, + * - 32U unsigned 32 bit, + * - 32S signed 32 bit, + * - FD floating double 64 bits (Not kosher DICOM, but so usefull!) + * \warning 12 bit images appear as 16 bit. + * 24 bit images appear as 8 bit + * @return 0S if nothing found. NOT USABLE file. The caller has to check + */ +std::string File::GetPixelType() +{ + std::string bitsAlloc = GetEntryValue(0x0028, 0x0100); // Bits Allocated + if ( bitsAlloc == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "Missing Bits Allocated (0028,0100)"); + bitsAlloc = "16"; // default and arbitrary value, not to polute the output + } + + if ( bitsAlloc == "64" ) + { + return "FD"; + } + else if ( bitsAlloc == "12" ) + { + // It will be unpacked + bitsAlloc = "16"; + } + else if ( bitsAlloc == "24" ) + { + // (in order no to be messed up + bitsAlloc = "8"; // by old RGB images) + } + + std::string sign = GetEntryValue(0x0028, 0x0103);//"Pixel Representation" + + if (sign == GDCM_UNFOUND ) + { + gdcmVerboseMacro( "Missing Pixel Representation (0028,0103)"); + sign = "U"; // default and arbitrary value, not to polute the output + } + else if ( sign == "0" ) + { + sign = "U"; + } + else + { + sign = "S"; + } + return bitsAlloc + sign; +} + + +/** + * \brief Recover the offset (from the beginning of the file) + * of *image* pixels (not *icone image* pixels, if any !) + * @return Pixel Offset + */ +size_t File::GetPixelOffset() +{ + DocEntry* pxlElement = GetDocEntry(GrPixel,NumPixel); + if ( pxlElement ) + { + return pxlElement->GetOffset(); + } + else + { +#ifdef GDCM_DEBUG + std::cout << "Big trouble : Pixel Element (" + << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" + << std::endl; +#endif //GDCM_DEBUG + return 0; + } +} + +/// \todo TODO : unify those two (previous one and next one) +/** + * \brief Recover the pixel area length (in Bytes) + * @return Pixel Element Length, as stored in the header + * (NOT the memory space necessary to hold the Pixels + * -in case of embeded compressed image-) + * 0 : NOT USABLE file. The caller has to check. + */ +size_t File::GetPixelAreaLength() +{ + DocEntry* pxlElement = GetDocEntry(GrPixel,NumPixel); + if ( pxlElement ) + { + return pxlElement->GetLength(); + } + else + { +#ifdef GDCM_DEBUG + std::cout << "Big trouble : Pixel Element (" + << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" + << std::endl; +#endif //GDCM_DEBUG + return 0; + } +} + +/** + * \brief tells us if LUT are used + * \warning Right now, 'Segmented xxx Palette Color Lookup Table Data' + * are NOT considered as LUT, since nobody knows + * how to deal with them + * Please warn me if you know sbdy that *does* know ... jprx + * @return true if LUT Descriptors and LUT Tables were found + */ +bool File::HasLUT() +{ + // Check the presence of the LUT Descriptors, and LUT Tables + // LutDescriptorRed + if ( !GetDocEntry(0x0028,0x1101) ) + { return false; - if ( fseek(fp, Header->GetPixelOffset(), SEEK_SET) == -1 ) { - Header->CloseFile(); + } + // LutDescriptorGreen + if ( !GetDocEntry(0x0028,0x1102) ) + { return false; } - // ---------------------- Compacted File (12 Bits Per Pixel) - /* unpack 12 Bits pixels into 16 Bits pixels */ - /* 2 pixels 12bit = [0xABCDEF] */ - /* 2 pixels 16bit = [0x0ABD] + [0x0FCE] */ - - if (Header->GetBitsAllocated()==12) { - int nbPixels = Header->GetXSize() * Header->GetYSize(); - unsigned char b0, b1, b2; - - unsigned short int *pdestination = (unsigned short int*)destination; - for(int p=0;p> 4) << 8) + ((b0 & 0x0f) << 4) + (b1 & 0x0f); - /* A */ /* B */ /* D */ - *pdestination++ = ((b2 & 0x0f) << 8) + ((b1 >> 4) << 4) + (b2 >> 4); - /* F */ /* C */ /* E */ - - // Troubles expected on Big-Endian processors ? + // LutDescriptorBlue + if ( !GetDocEntry(0x0028,0x1103) ) + { + return false; + } + // Red Palette Color Lookup Table Data + if ( !GetDocEntry(0x0028,0x1201) ) + { + return false; + } + // Green Palette Color Lookup Table Data + if ( !GetDocEntry(0x0028,0x1202) ) + { + return false; + } + // Blue Palette Color Lookup Table Data + if ( !GetDocEntry(0x0028,0x1203) ) + { + return false; + } + + // FIXME : (0x0028,0x3006) : LUT Data (CTX dependent) + // NOT taken into account, but we don't know how to use it ... + return true; +} + +/** + * \brief gets the info from 0028,1101 : Lookup Table Desc-Red + * else 0 + * @return Lookup Table number of Bits , 0 by default + * when (0028,0004),Photometric Interpretation = [PALETTE COLOR ] + * @ return bit number of each LUT item + */ +int File::GetLUTNbits() +{ + std::vector tokens; + int lutNbits; + + //Just hope Lookup Table Desc-Red = Lookup Table Desc-Red + // = Lookup Table Desc-Blue + // Consistency already checked in GetLUTLength + std::string lutDescription = GetEntryValue(0x0028,0x1101); + if ( lutDescription == GDCM_UNFOUND ) + { + return 0; + } + + tokens.clear(); // clean any previous value + Util::Tokenize ( lutDescription, tokens, "\\" ); + //LutLength=atoi(tokens[0].c_str()); + //LutDepth=atoi(tokens[1].c_str()); + + lutNbits = atoi( tokens[2].c_str() ); + tokens.clear(); + + return lutNbits; +} + + +//----------------------------------------------------------------------------- +// Protected + +/** + * \brief anonymize a File (removes Patient's personal info) + * (read the code to see which ones ...) + */ +bool File::AnonymizeFile() +{ + // If exist, replace by spaces + SetEntryValue (" ",0x0010, 0x2154); // Telephone + SetEntryValue (" ",0x0010, 0x1040); // Adress + SetEntryValue (" ",0x0010, 0x0020); // Patient ID + + DocEntry* patientNameHE = GetDocEntry (0x0010, 0x0010); + + if ( patientNameHE ) // we replace it by Study Instance UID (why not) + { + std::string studyInstanceUID = GetEntryValue (0x0020, 0x000d); + if ( studyInstanceUID != GDCM_UNFOUND ) + { + Insert(studyInstanceUID, 0x0010, 0x0010); } + else + { + Insert("anonymised", 0x0010, 0x0010); + } + } - Header->CloseFile(); - return true; - } - - // ---------------------- Uncompressed File - if ( !Header->IsDicomV3() || - Header->IsImplicitVRLittleEndianTransferSyntax() || - Header->IsExplicitVRLittleEndianTransferSyntax() || - Header->IsExplicitVRBigEndianTransferSyntax() || - Header->IsDeflatedExplicitVRLittleEndianTransferSyntax() ) { - - size_t ItemRead = fread(destination, Header->GetPixelAreaLength(), 1, fp); - if ( ItemRead != 1 ) { - Header->CloseFile(); - return false; - } else { - Header->CloseFile(); - return true; + // Just for fun :-( + // (if any) remove or replace all the stuff that contains a Date + +//0008 0012 DA ID Instance Creation Date +//0008 0020 DA ID Study Date +//0008 0021 DA ID Series Date +//0008 0022 DA ID Acquisition Date +//0008 0023 DA ID Content Date +//0008 0024 DA ID Overlay Date +//0008 0025 DA ID Curve Date +//0008 002a DT ID Acquisition Datetime +//0018 9074 DT ACQ Frame Acquisition Datetime +//0018 9151 DT ACQ Frame Reference Datetime +//0018 a002 DT ACQ Contribution Date Time +//0020 3403 SH REL Modified Image Date (RET) +//0032 0032 DA SDY Study Verified Date +//0032 0034 DA SDY Study Read Date +//0032 1000 DA SDY Scheduled Study Start Date +//0032 1010 DA SDY Scheduled Study Stop Date +//0032 1040 DA SDY Study Arrival Date +//0032 1050 DA SDY Study Completion Date +//0038 001a DA VIS Scheduled Admission Date +//0038 001c DA VIS Scheduled Discharge Date +//0038 0020 DA VIS Admitting Date +//0038 0030 DA VIS Discharge Date +//0040 0002 DA PRC Scheduled Procedure Step Start Date +//0040 0004 DA PRC Scheduled Procedure Step End Date +//0040 0244 DA PRC Performed Procedure Step Start Date +//0040 0250 DA PRC Performed Procedure Step End Date +//0040 2004 DA PRC Issue Date of Imaging Service Request +//0040 4005 DT PRC Scheduled Procedure Step Start Date and Time +//0040 4011 DT PRC Expected Completion Date and Time +//0040 a030 DT PRC Verification Date Time +//0040 a032 DT PRC Observation Date Time +//0040 a120 DT PRC DateTime +//0040 a121 DA PRC Date +//0040 a13a DT PRC Referenced Datetime +//0070 0082 DA ??? Presentation Creation Date +//0100 0420 DT ??? SOP Autorization Date and Time +//0400 0105 DT ??? Digital Signature DateTime +//2100 0040 DA PJ Creation Date +//3006 0008 DA SSET Structure Set Date +//3008 0024 DA ??? Treatment Control Point Date +//3008 0054 DA ??? First Treatment Date +//3008 0056 DA ??? Most Recent Treatment Date +//3008 0162 DA ??? Safe Position Exit Date +//3008 0166 DA ??? Safe Position Return Date +//3008 0250 DA ??? Treatment Date +//300a 0006 DA RT RT Plan Date +//300a 022c DA RT Air Kerma Rate Reference Date +//300e 0004 DA RT Review Date + + return true; +} + +/** + * \brief gets the info from 0020,0037 : Image Orientation Patient + * (needed to organize DICOM files based on their x,y,z position) + * @param iop adress of the (6)float aray to receive values + * @return cosines of image orientation patient + */ +void File::GetImageOrientationPatient( float iop[6] ) +{ + std::string strImOriPat; + //iop is supposed to be float[6] + iop[0] = iop[1] = iop[2] = iop[3] = iop[4] = iop[5] = 0.; + + // 0020 0037 DS REL Image Orientation (Patient) + if ( (strImOriPat = GetEntryValue(0x0020,0x0037)) != GDCM_UNFOUND ) + { + if( sscanf( strImOriPat.c_str(), "%f\\%f\\%f\\%f\\%f\\%f", + &iop[0], &iop[1], &iop[2], &iop[3], &iop[4], &iop[5]) != 6 ) + { + gdcmVerboseMacro( "Wrong Image Orientation Patient (0020,0037). Less than 6 values were found." ); } - } - - // ---------------------- Run Length Encoding - if (Header->IsRLELossLessTransferSyntax()) { - bool res = (bool)gdcm_read_RLE_file (fp,destination); - Header->CloseFile(); - return res; - } - - // --------------- SingleFrame/Multiframe JPEG Lossless/Lossy/2000 - int nb; - std::string str_nb=Header->GetEntryByNumber(0x0028,0x0100); - if (str_nb == GDCM_UNFOUND ) { - nb = 16; - } else { - nb = atoi(str_nb.c_str() ); - if (nb == 12) nb =16; // ?? 12 should be ACR-NEMA only ? - } - - int nBytes= nb/8; - - int taille = Header->GetXSize() * Header->GetYSize() - * Header->GetSamplesPerPixel(); - long fragmentBegining; // for ftell, fseek - - bool jpg2000 = Header->IsJPEG2000(); - bool jpgLossless = Header->IsJPEGLossless(); - - bool res = true; - guint16 ItemTagGr,ItemTagEl; - int ln; - - // Position on begining of Jpeg Pixels - - fread(&ItemTagGr,2,1,fp); // Reading (fffe) : Item Tag Gr - fread(&ItemTagEl,2,1,fp); // Reading (e000) : Item Tag El - if(Header->GetSwapCode()) { - ItemTagGr=Header->SwapShort(ItemTagGr); - ItemTagEl=Header->SwapShort(ItemTagEl); - } - fread(&ln,4,1,fp); - if(Header->GetSwapCode()) - ln=Header->SwapLong(ln); // Basic Offset Table Item length - - if (ln != 0) { - // What is it used for ?!? - char *BasicOffsetTableItemValue = new char[ln+1]; - fread(BasicOffsetTableItemValue,ln,1,fp); } - - // first Fragment initialisation - fread(&ItemTagGr,2,1,fp); // Reading (fffe) : Item Tag Gr - fread(&ItemTagEl,2,1,fp); // Reading (e000) : Item Tag El - if(Header->GetSwapCode()) { - ItemTagGr=Header->SwapShort(ItemTagGr); - ItemTagEl=Header->SwapShort(ItemTagEl); - } - - // parsing fragments until Sequence Delim. Tag found - while ( ( ItemTagGr == 0xfffe) && (ItemTagEl != 0xe0dd) ) { - // --- for each Fragment - - fread(&ln,4,1,fp); - if(Header->GetSwapCode()) - ln=Header->SwapLong(ln); // Fragment Item length - - fragmentBegining=ftell(fp); + //For ACR-NEMA + // 0020 0035 DS REL Image Orientation (RET) + else if ( (strImOriPat = GetEntryValue(0x0020,0x0035)) != GDCM_UNFOUND ) + { + if( sscanf( strImOriPat.c_str(), "%f\\%f\\%f\\%f\\%f\\%f", + &iop[0], &iop[1], &iop[2], &iop[3], &iop[4], &iop[5]) != 6 ) + { + gdcmVerboseMacro( "wrong Image Orientation Patient (0020,0035). Less than 6 values were found." ); + } + } +} - if (jpg2000) { // JPEG 2000 : call to ??? - - res = (bool)gdcm_read_JPEG2000_file (fp,destination); // Not Yet written - - } // ------------------------------------- endif (JPEG2000) - - else if (jpgLossless) { // JPEG LossLess : call to xmedcom JPEG - - JPEGLosslessDecodeImage (fp, // Reading Fragment pixels - (unsigned short *)destination, - Header->GetPixelSize() * 8 * Header->GetSamplesPerPixel(), - ln); - res=1; // in order not to break the loop - - } // ------------------------------------- endif (JPEGLossless) - - else { // JPEG Lossy : call to IJG 6b - - if (Header->GetBitsStored() == 8) { - res = (bool)gdcm_read_JPEG_file (fp,destination); // Reading Fragment pixels - } else { - res = (bool)gdcm_read_JPEG_file12 (fp,destination);// Reading Fragment pixels - } - } // ------------------------------------- endif (JPEGLossy) - - if (!res) break; - - destination = (char *)destination + taille * nBytes; // location in user's memory - // for next fragment (if any) - - fseek(fp,fragmentBegining,SEEK_SET); // To be sure we start - fseek(fp,ln,SEEK_CUR); // at the begining of next fragment - - ItemTagGr = ItemTagEl =0; - fread(&ItemTagGr,2,1,fp); // Reading (fffe) : Item Tag Gr - fread(&ItemTagEl,2,1,fp); // Reading (e000) : Item Tag El - if(Header->GetSwapCode()) { - ItemTagGr=Header->SwapShort(ItemTagGr); - ItemTagEl=Header->SwapShort(ItemTagEl); - } - - } // endWhile parsing fragments until Sequence Delim. Tag found - - Header->CloseFile(); - return res; +/** + * \brief Initialize a default DICOM File that should contain all the + * field require by other reader. DICOM standard does not + * explicitely defines those fields, heuristic has been choosen. + * This is not perfect as we are writting a CT image... + */ +void File::InitializeDefaultFile() +{ + typedef struct + { + const char *value; + uint16_t group; + uint16_t elem; + } DICOM_DEFAULT_VALUE; + + std::string date = Util::GetCurrentDate(); + std::string time = Util::GetCurrentTime(); + std::string uid = Util::CreateUniqueUID(); + std::string uidMedia = uid; + std::string uidClass = uid + ".1"; + std::string uidInst = uid + ".10"; + std::string uidStudy = uid + ".100"; + std::string uidSerie = uid + ".1000"; + + static DICOM_DEFAULT_VALUE defaultvalue[] = { + { "146 ", 0x0002, 0x0000}, // Meta Element Group Length // FIXME: how to recompute ? + { "1.2.840.10008.5.1.4.1.1.2", 0x0002, 0x0002}, // Media Storage SOP Class UID (CT Image Storage) + { uidClass.c_str(), 0x0002, 0x0003}, // Media Storage SOP Instance UID + { "1.2.840.10008.1.2.1 ", 0x0002, 0x0010}, // Transfer Syntax UID (Explicit VR Little Endian) + { uidClass.c_str(), 0x0002, 0x0012}, // META Implementation Class UID + { "GDCM", 0x0002, 0x0016}, // Source Application Entity Title + + { date.c_str(), 0x0008, 0x0012}, // Instance Creation Date + { time.c_str(), 0x0008, 0x0013}, // Instance Creation Time + { "1.2.840.10008.5.1.4.1.1.2", 0x0008, 0x0016}, // SOP Class UID + { uidInst.c_str(), 0x0008, 0x0018}, // SOP Instance UID + { "CT", 0x0008, 0x0060}, // Modality + { "GDCM", 0x0008, 0x0070}, // Manufacturer + { "GDCM", 0x0008, 0x0080}, // Institution Name + { "http://www-creatis.insa-lyon.fr/Public/Gdcm", 0x0008, 0x0081}, // Institution Address + + { "GDCM", 0x0010, 0x0010}, // Patient's Name + { "GDCMID", 0x0010, 0x0020}, // Patient ID + + { uidStudy.c_str(), 0x0020, 0x000d}, // Study Instance UID + { uidSerie.c_str(), 0x0020, 0x000e}, // Series Instance UID + { "1", 0x0020, 0x0010}, // StudyID + { "1", 0x0020, 0x0011}, // SeriesNumber + + { "1", 0x0028, 0x0002}, // Samples per pixel 1 or 3 + { "MONOCHROME1", 0x0028, 0x0004}, // photochromatic interpretation + { "0", 0x0028, 0x0010}, // nbRows + { "0", 0x0028, 0x0011}, // nbCols + { "8", 0x0028, 0x0100}, // BitsAllocated 8 or 12 or 16 + { "8", 0x0028, 0x0101}, // BitsStored <= BitsAllocated + { "7", 0x0028, 0x0102}, // HighBit <= BitsAllocated - 1 + { "0", 0x0028, 0x0103}, // Pixel Representation 0(unsigned) or 1(signed) + { 0, 0, 0 } + }; + + // default value + // Special case this is the image (not a string) + GrPixel = 0x7fe0; + NumPixel = 0x0010; + Insert(0, 0, GrPixel, NumPixel); + + // All remaining strings: + unsigned int i = 0; + DICOM_DEFAULT_VALUE current = defaultvalue[i]; + while( current.value ) + { + Insert(current.value, current.group, current.elem); + current = defaultvalue[++i]; + } } + + //----------------------------------------------------------------------------- +// Private + +//----------------------------------------------------------------------------- + +} // end namespace gdcm