X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmFile.cxx;h=837df465e8139d9a30e94288c38bbb71e6ec6dc0;hb=bac2910466f502dec4c1842527aa81a8f83f04b8;hp=11f9b015aebae994137936a80914bb1a0b00d583;hpb=d0e0404925f8a3dc6f771ed598c75f9dea95912d;p=gdcm.git diff --git a/src/gdcmFile.cxx b/src/gdcmFile.cxx index 11f9b015..837df465 100644 --- a/src/gdcmFile.cxx +++ b/src/gdcmFile.cxx @@ -1,463 +1,739 @@ -// gdcmFile.cxx - -#include "gdcm.h" - -#define DEBUG 1 - -static void _Swap(void* im, int swap, int lgr, int nb); + /*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmFile.cxx,v $ + Language: C++ + Date: $Date: 2004/11/16 16:20:23 $ + Version: $Revision: 1.157 $ + + 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.html for details. + + This software is distributed WITHOUT ANY WARRANTY; without even + the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the above copyright notices for more information. + +=========================================================================*/ + +#include "gdcmFile.h" +#include "gdcmDebug.h" +#include "gdcmUtil.h" +#include "gdcmBinEntry.h" +#include + +namespace gdcm +{ +typedef std::pair IterHT; -///////////////////////////////////////////////////////////////// +//------------------------------------------------------------------------- +// 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 - * - * @return + * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3 + * file (Header only deals with the ... header) + * Opens (in read only and when possible) an existing file and checks + * for DICOM compliance. Returns NULL on failure. + * It will be up to the user to load the pixels into memory + * (see GetImageData, GetImageDataRaw) + * \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 + * user sets an a posteriori shadow dictionary (efficiency can be + * seen as a side effect). + * @param header already built Header */ - -gdcmFile::gdcmFile(string & filename) - :gdcmHeader(filename.c_str()) +File::File(Header *header) { - if (DEBUG) printf("On a echappe a gdcmHeader !\n"); + HeaderInternal = header; + SelfHeader = false; + Initialise(); } +/** + * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3 + * file (Header only deals with the ... header) + * Opens (in read only and when possible) an existing file and checks + * for DICOM compliance. Returns NULL on failure. + * It will be up to the user to load the pixels into memory + * (see GetImageData, GetImageDataRaw) + * \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 + */ +File::File(std::string const & filename ) +{ + HeaderInternal = new Header( filename ); + SelfHeader = true; + Initialise(); +} -///////////////////////////////////////////////////////////////// /** - * \ingroup gdcmFile - * \brief Renvoie la longueur A ALLOUER pour recevoir les pixels de l'image - * \ ou DES images dans le cas d'un multiframe - * \ ATTENTION : il ne s'agit PAS de la longueur du groupe des Pixels - * \ (dans le cas d'images compressees, elle n'a pas de sens). - * - * @param void Rien en entree - * - * @return longueur a allouer + * \brief Factorization for various forms of constructors. */ +void File::Initialise() +{ + PixelConverter = NULL; //just in case + if ( HeaderInternal->IsReadable() ) + { + ImageDataSizeRaw = ComputeDecompressedPixelDataSizeFromHeader(); + if ( HeaderInternal->HasLUT() ) + { + ImageDataSize = 3 * ImageDataSizeRaw; + } + else + { + ImageDataSize = ImageDataSizeRaw; + } + + PixelConverter = new PixelConvert; + PixelConverter->GrabInformationsFromHeader( HeaderInternal ); + } + SaveInitialValues(); +} -size_t gdcmFile::GetImageDataSize(void) { - int nbLignes, nbCol, nbFrames, nb; - string str_nbFrames, str_nb; - // Nombre de Lignes - nbLignes=atoi(gdcmHeader::GetPubElValByNumber(0x0028,0x0010).c_str()); - // Nombre de Colonnes - nbCol =atoi(gdcmHeader::GetPubElValByNumber(0x0028,0x0011).c_str()); - -printf("nbCol %d\n",nbCol); -printf("nbLig %d\n",nbLignes); - - - // Nombre de Frames - str_nbFrames=gdcmHeader::GetPubElValByNumber(0x0028,0x0008); - - if (str_nbFrames == "gdcm::Unfound" ) { - nbFrames = 1; - } else { - nbFrames = atoi(str_nbFrames.c_str() ); - } -printf("nbFrames %d\n",nbFrames); - - // Nombre de Bits Alloues pour le stockage d'un Pixel - str_nb=gdcmHeader::GetPubElValByNumber(0x0028,0x0100); - - if (str_nb == "gdcm::Unfound" ) { - nb = 16; - } else { - nb = atoi(str_nb.c_str() ); - } - -printf("nb %d\n",nb); - - size_t lgrTotale = nbFrames*nbLignes*nbCol*(nb/8); - return (lgrTotale); +/** + * \brief canonical destructor + * \note If the Header was created by the File constructor, + * it is destroyed by the File + */ +File::~File() +{ + if( SelfHeader ) + { + delete HeaderInternal; + } + HeaderInternal = 0; + + DeleteInitialValues(); + if( PixelConverter ) + { + delete PixelConverter; + } +} +/** + * \brief Sets some initial values for the Constructor + * \warning not end user intended + */ +void File::SaveInitialValues() +{ + + PixelRead = -1; // no ImageData read yet. + LastAllocatedPixelDataLength = 0; + Pixel_Data = 0; + + InitialSpp = ""; + InitialPhotInt = ""; + InitialPlanConfig = ""; + InitialBitsAllocated = ""; + InitialHighBit = ""; + + InitialRedLUTDescr = 0; + InitialGreenLUTDescr = 0; + InitialBlueLUTDescr = 0; + InitialRedLUTData = 0; + InitialGreenLUTData = 0; + InitialBlueLUTData = 0; + + if ( HeaderInternal->IsReadable() ) + { + // the following values *may* be modified + // by File::GetImageDataIntoVectorRaw + // we save their initial value. + InitialSpp = HeaderInternal->GetEntryByNumber(0x0028,0x0002); + InitialPhotInt = HeaderInternal->GetEntryByNumber(0x0028,0x0004); + InitialPlanConfig = HeaderInternal->GetEntryByNumber(0x0028,0x0006); + + InitialBitsAllocated = HeaderInternal->GetEntryByNumber(0x0028,0x0100); + InitialHighBit = HeaderInternal->GetEntryByNumber(0x0028,0x0102); + + // the following entries *may* be removed from the H table + // (NOT deleted ...) by File::GetImageDataIntoVectorRaw + // we keep a pointer on them. + InitialRedLUTDescr = HeaderInternal->GetDocEntryByNumber(0x0028,0x1101); + InitialGreenLUTDescr = HeaderInternal->GetDocEntryByNumber(0x0028,0x1102); + InitialBlueLUTDescr = HeaderInternal->GetDocEntryByNumber(0x0028,0x1103); + + InitialRedLUTData = HeaderInternal->GetDocEntryByNumber(0x0028,0x1201); + InitialGreenLUTData = HeaderInternal->GetDocEntryByNumber(0x0028,0x1202); + InitialBlueLUTData = HeaderInternal->GetDocEntryByNumber(0x0028,0x1203); + } } -///////////////////////////////////////////////////////////////// /** - * \ingroup gdcmFile - * \brief amene en mémoire les Pixels d'une image NON COMPRESSEE - * \Aucun test n'est fait pour le moment sur le caractere compresse ou non de l'image - * - * @param rien - * - * @return Pointeur sur la zone mémoire contenant les Pixels lus + * \brief restores some initial values + * \warning not end user intended */ +void File::RestoreInitialValues() +{ + if ( HeaderInternal->IsReadable() ) + { + // the following values *may* have been modified + // by File::GetImageDataIntoVectorRaw + // we restore their initial value. + if ( InitialSpp != "") + HeaderInternal->SetEntryByNumber(InitialSpp,0x0028,0x0002); + if ( InitialPhotInt != "") + HeaderInternal->SetEntryByNumber(InitialPhotInt,0x0028,0x0004); + if ( InitialPlanConfig != "") + + HeaderInternal->SetEntryByNumber(InitialPlanConfig,0x0028,0x0006); + if ( InitialBitsAllocated != "") + HeaderInternal->SetEntryByNumber(InitialBitsAllocated,0x0028,0x0100); + if ( InitialHighBit != "") + HeaderInternal->SetEntryByNumber(InitialHighBit,0x0028,0x0102); + + // the following entries *may* be have been removed from the H table + // (NOT deleted ...) by File::GetImageDataIntoVectorRaw + // we restore them. + + if (InitialRedLUTDescr) + HeaderInternal->AddEntry(InitialRedLUTDescr); + if (InitialGreenLUTDescr) + HeaderInternal->AddEntry(InitialGreenLUTDescr); + if (InitialBlueLUTDescr) + HeaderInternal->AddEntry(InitialBlueLUTDescr); + + if (InitialRedLUTData) + HeaderInternal->AddEntry(InitialBlueLUTDescr); + if (InitialGreenLUTData) + HeaderInternal->AddEntry(InitialGreenLUTData); + if (InitialBlueLUTData) + HeaderInternal->AddEntry(InitialBlueLUTData); + } +} -void * gdcmFile::GetImageData (void) { - - char* _Pixels; - int nbLignes, nbCol; - - int nbFrames, nb, nbu, highBit, signe; - string str_nbFrames, str_nb, str_nbu, str_highBit, str_signe; - - unsigned short int mask = 0xffff; - - // Nombre de Lignes - nbLignes=atoi(GetPubElValByNumber(0x0028,0x0010).c_str()); - // Nombre de Colonnes - nbCol =atoi(GetPubElValByNumber(0x0028,0x0011).c_str()); - - // Nombre de Frames - str_nbFrames=GetPubElValByNumber(0x0028,0x0008); - - - if (str_nbFrames == "gdcm::Unfound" ) { - nbFrames = 1; - } else { - nbFrames = atoi(str_nbFrames.c_str() ); - } - - // Nombre de Bits Alloues - str_nb=GetPubElValByNumber(0x0028,0x0100); - - if (str_nb == "gdcm::Unfound" ) { - nb = 16; - } else { - nb = atoi(str_nb.c_str() ); - } - - // Nombre de Bits Utilises - str_nbu=GetPubElValByNumber(0x0028,0x0101); - - if (str_nbu == "gdcm::Unfound" ) { - nbu = nb; - } else { - nbu = atoi(str_nbu.c_str() ); - } - - // Position du Bit de Poids Fort - str_highBit=GetPubElValByNumber(0x0028,0x0102); - - if (str_highBit == "gdcm::Unfound" ) { - highBit = nb - 1; - } else { - highBit = atoi(str_highBit.c_str() ); - } - - // Signe des Pixels 0 : Unsigned - str_signe=GetPubElValByNumber(0x0028,0x0103); - - if (str_signe == "gdcm::Unfound" ) { - signe = 1; - } else { - signe = atoi(str_signe.c_str() ); - } - - // Longueur en Octets des Pixels a lire - size_t _lgrTotale = nbFrames*nbLignes*nbCol*(nb/8); - - //Pixels = (char *) g_malloc(_lgrTotale); - _Pixels = (char *) malloc(_lgrTotale); - - GetPixels(lgrTotale, _Pixels); - - // On remet les Octets dans le bon ordre si besoin est - if (nb != 8) { - int _sw = GetSwapCode(); - - _Swap (_Pixels, _sw, _lgrTotale, nb); - } - - // On remet les Bits des Octets dans le bon ordre si besoin est - // - // ATTENTION : Jamais confronté a des pixels stockes sur 32 bits - // avec moins de 32 bits utilises - // et dont le bit de poids fort ne serait pas la ou on l'attend ... - // --> ne marchera pas dans ce cas - if (nbu!=nb){ - mask = mask >> (nb-nbu); - int l=(int)_lgrTotale/(nb/8); - unsigned short *deb = (unsigned short *)_Pixels; - for(int i=0;i> (nbu-highBit-1)) & mask; - deb ++; - } - } - - printf ("on est sorti\n"); - - // On l'affecte à un champ du dcmFile - - Pixels = _Pixels; - lgrTotale = _lgrTotale; - - // et on le retourne - // ca fait double emploi, il faudra nettoyer ça - - return (_Pixels); +/** + * \brief delete initial values (il they were saved) + * of InitialLutDescriptors and InitialLutData + */ +void File::DeleteInitialValues() +{ +// InitialLutDescriptors and InitialLutData +// will have to be deleted if the don't belong any longer +// to the Header H table when the header is deleted... + +// FIXME +// We don't know if the InitialLutData are still in the header or not ! +/* if ( InitialRedLUTDescr ) + delete InitialRedLUTDescr; + + if ( InitialGreenLUTDescr ) + delete InitialGreenLUTDescr; + + if ( InitialBlueLUTDescr ) + delete InitialBlueLUTDescr; + + if ( InitialRedLUTData ) + delete InitialRedLUTData; + + if ( InitialGreenLUTData ) + delete InitialGreenLUTData; + + if ( InitialBlueLUTData ) + delete InitialBlueLUTData;*/ } +//----------------------------------------------------------------------------- +// Print + +//----------------------------------------------------------------------------- +// Public -///////////////////////////////////////////////////////////////// /** - * \ingroup gdcmFile - * \brief amene en mémoire dans une zone précisee par l'utilisateur - * \les Pixels d'une image NON COMPRESSEE - * \Aucun test n'est fait pour le moment sur le caractere compresse ou non de l'image - * - * @param - * - * @return + * \brief computes the length (in bytes) we must ALLOCATE to receive the + * image(s) pixels (multiframes taken into account) + * \warning : it is NOT the group 7FE0 length + * (no interest for compressed images). */ +int File::ComputeDecompressedPixelDataSizeFromHeader() +{ + // 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 numberBitsAllocated = HeaderInternal->GetBitsAllocated(); + // Number of "Bits Allocated" is fixed to 16 when: + // - it is not defined (i.e. it's value is 0) + // - it's 12, since we will expand the image to 16 bits (see + // PixelConvert::ConvertDecompress12BitsTo16Bits() ) + if ( numberBitsAllocated == 0 || numberBitsAllocated == 12 ) + { + numberBitsAllocated = 16; + } + + int DecompressedSize = HeaderInternal->GetXSize() + * HeaderInternal->GetYSize() + * HeaderInternal->GetZSize() + * ( numberBitsAllocated / 8 ) + * HeaderInternal->GetSamplesPerPixel(); + + return DecompressedSize; +} -int gdcmFile::PutImageDataHere (void* destination, size_t MaxSize) { - - void * Pixels = destination; // pour garder le code identique avec GetImageData - int nbLignes, nbCol; - - int nbFrames, nb, nbu, highBit, signe; - string str_nbFrames, str_nb, str_nbu, str_highBit, str_signe; - - unsigned short int mask = 0xffff; - - // Nombre de Lignes - nbLignes=atoi(GetPubElValByNumber(0x0028,0x0010).c_str()); - // Nombre de Colonnes - nbCol =atoi(GetPubElValByNumber(0x0028,0x0011).c_str()); - - // Nombre de Frames - str_nbFrames=GetPubElValByNumber(0x0028,0x0008); - - - if (str_nbFrames == "gdcm::Unfound" ) { - nbFrames = 1; - } else { - nbFrames = atoi(str_nbFrames.c_str() ); - } - - // Nombre de Bits Alloues - str_nb=GetPubElValByNumber(0x0028,0x0100); - - if (str_nb == "gdcm::Unfound" ) { - nb = 16; - } else { - nb = atoi(str_nb.c_str() ); - } - - // Nombre de Bits Utilises - str_nbu=GetPubElValByNumber(0x0028,0x0101); - - if (str_nbu == "gdcm::Unfound" ) { - nbu = nb; - } else { - nbu = atoi(str_nbu.c_str() ); - } - - // Position du Bit de Poids Fort - str_highBit=GetPubElValByNumber(0x0028,0x0102); - - if (str_highBit == "gdcm::Unfound" ) { - highBit = nb - 1; - } else { - highBit = atoi(str_highBit.c_str() ); - } - - // Signe des Pixels - str_signe=GetPubElValByNumber(0x0028,0x0103); - - if (str_signe == "gdcm::Unfound" ) { - signe = 1; - } else { - signe = atoi(str_signe.c_str() ); - } - - // Longueur en Octets des Pixels a lire - size_t lgrTotale = nbFrames*nbLignes*nbCol*(nb/8); - - // si lgrTotale < MaxSize ==> Gros pb . A VOIR - - lgrTotale = MaxSize; // pour garder le code identique avec GetImageData - //Pixels = (char *) malloc(lgrTotale); // pour garder le code identique avec GetImageData - - GetPixels(lgrTotale, Pixels); - - // On remet les Octets dans le bon ordre si besoin est - if (nb != 8) { - int _sw = GetSwapCode(); - - _Swap (Pixels, _sw, lgrTotale, nb); - } - - // On remet les Bits des Octets dans le bon ordre si besoin est - // - // ATTENTION : Jamais confronté a des pixels stockes sur 32 bits - // avec moins de 32 bits utilises - // et dont le bit de poids fort ne serait pas la ou on l'attend ... - // --> ne marchera pas dans ce cas - if (nbu!=nb){ - mask = mask >> (nb-nbu); - int l=(int)lgrTotale/(nb/8); - unsigned short *deb = (unsigned short *)Pixels; - for(int i=0;i> (nbu-highBit-1)) & mask; - deb ++; - } - } - - printf ("on est sorti\n"); - - // VOIR s'il ne faudrait pas l'affecter à un champ du dcmHeader - - //return (Pixels); // pour garder le code identique avec GetImageData - return 1; +/** + * \brief - Allocates necessary memory, + * - Reads the pixels from disk (uncompress if necessary), + * - Transforms YBR pixels, if any, into RGB pixels + * - Transforms 3 planes R, G, B, if any, into a single RGB Plane + * - Transforms single Grey plane + 3 Palettes into a RGB Plane + * - Copies the pixel data (image[s]/volume[s]) to newly allocated zone. + * @return Pointer to newly allocated pixel data. + * NULL if alloc fails + */ +uint8_t* File::GetImageData() +{ + if ( ! GetDecompressed() ) + { + // If the decompression failed nothing can be done. + return 0; + } + + uint8_t* pixelData; + if ( HeaderInternal->HasLUT() && PixelConverter->BuildRGBImage() ) + { + pixelData = PixelConverter->GetRGB(); + } + else + { + // When no LUT or LUT conversion fails, return the decompressed + pixelData = PixelConverter->GetDecompressed(); + } + +// PIXELCONVERT CLEANME + // Restore the header in a disk-consistent state + // (if user asks twice to get the pixels from disk) + if ( PixelRead != -1 ) // File was "read" before + { + RestoreInitialValues(); + } + if ( PixelConverter->GetRGB() ) + { + // now, it's an RGB image + // Lets's write it in the Header + std::string spp = "3"; // Samples Per Pixel + HeaderInternal->SetEntryByNumber(spp,0x0028,0x0002); + std::string rgb = "RGB "; // Photometric Interpretation + HeaderInternal->SetEntryByNumber(rgb,0x0028,0x0004); + std::string planConfig = "0"; // Planar Configuration + HeaderInternal->SetEntryByNumber(planConfig,0x0028,0x0006); + PixelRead = 0; // no PixelRaw + } + else + { + if ( HeaderInternal->HasLUT() ) + { + // The LUT interpretation failed + std::string photometricInterpretation = Util::DicomString("MONOCHROME1"); + HeaderInternal->SetEntryByNumber( photometricInterpretation, + 0x0028, 0x0004 ); + PixelRead = 0; // no PixelRaw + } + else + { + if ( PixelConverter->IsDecompressedRGB() ) + { + /////////////////////////////////////////////////// + // now, it's an RGB image + // Lets's write it in the Header + // Droping Palette Color out of the Header + // has been moved to the Write process. + // TODO : move 'values' modification to the write process + // : save also (in order to be able to restore) + // : 'high bit' -when not equal to 'bits stored' + 1 + // : 'bits allocated', when it's equal to 12 ?! + std::string spp = "3"; // Samples Per Pixel + std::string photInt = "RGB "; // Photometric Interpretation + std::string planConfig = "0"; // Planar Configuration + HeaderInternal->SetEntryByNumber(spp,0x0028,0x0002); + HeaderInternal->SetEntryByNumber(photInt,0x0028,0x0004); + HeaderInternal->SetEntryByNumber(planConfig,0x0028,0x0006); + } + PixelRead = 1; // PixelRaw + } + } + + // We say the value *is* loaded. + SetPixelData(pixelData); +// END PIXELCONVERT CLEANME + + return pixelData; } -// -// Je laisse le code integral, au cas ça puisse etre reutilise ailleurs -// - -static void _Swap(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("valeur de SWAP (16 bits) non autorisee : %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: - printf("valeur de SWAP (32 bits) non autorisee : %d\n", swap); - } -return; +/** + * \brief + * Read the pixels from disk (uncompress if necessary), + * Transforms YBR pixels, if any, into RGB pixels + * Transforms 3 planes R, G, B, if any, into a single RGB Plane + * Transforms single Grey plane + 3 Palettes into a RGB Plane + * Copies at most MaxSize bytes of pixel data to caller allocated + * memory space. + * \warning This function allows people that want to build a volume + * from an image stack *not to* have, 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 File::GetImageDataIntoVector (void* destination, size_t maxSize) +{ + if ( ! GetDecompressed() ) + { + // If the decompression failed nothing can be done. + return 0; + } + + if ( HeaderInternal->HasLUT() && PixelConverter->BuildRGBImage() ) + { + if ( PixelConverter->GetRGBSize() > maxSize ) + { + dbg.Verbose(0, "File::GetImageDataIntoVector: pixel data bigger" + "than caller's expected MaxSize"); + return 0; + } + memcpy( destination, + (void*)PixelConverter->GetRGB(), + PixelConverter->GetRGBSize() ); + return PixelConverter->GetRGBSize(); + } + + // Either no LUT conversion necessary or LUT conversion failed + if ( PixelConverter->GetDecompressedSize() > maxSize ) + { + dbg.Verbose(0, "File::GetImageDataIntoVector: pixel data bigger" + "than caller's expected MaxSize"); + return 0; + } + memcpy( destination, + (void*)PixelConverter->GetDecompressed(), + PixelConverter->GetDecompressedSize() ); + return PixelConverter->GetDecompressedSize(); } +/** + * \brief Allocates necessary memory, + * Transforms YBR pixels (if any) into RGB pixels + * Transforms 3 planes R, G, B (if any) into a single RGB Plane + * Copies the pixel data (image[s]/volume[s]) to newly allocated zone. + * DOES NOT transform Grey plane + 3 Palettes into a RGB Plane + * @return Pointer to newly allocated pixel data. + * \ NULL if alloc fails + */ +uint8_t* File::GetImageDataRaw () +{ + uint8_t* decompressed = GetDecompressed(); + if ( ! decompressed ) + { + return 0; + } + +// PIXELCONVERT CLEANME + // Restore the header in a disk-consistent state + // (if user asks twice to get the pixels from disk) + if ( PixelRead != -1 ) // File was "read" before + { + RestoreInitialValues(); + } + if ( PixelConverter->IsDecompressedRGB() ) + { + /////////////////////////////////////////////////// + // now, it's an RGB image + // Lets's write it in the Header + // Droping Palette Color out of the Header + // has been moved to the Write process. + // TODO : move 'values' modification to the write process + // : save also (in order to be able to restore) + // : 'high bit' -when not equal to 'bits stored' + 1 + // : 'bits allocated', when it's equal to 12 ?! + std::string spp = "3"; // Samples Per Pixel + std::string photInt = "RGB "; // Photometric Interpretation + std::string planConfig = "0"; // Planar Configuration + HeaderInternal->SetEntryByNumber(spp,0x0028,0x0002); + HeaderInternal->SetEntryByNumber(photInt,0x0028,0x0004); + HeaderInternal->SetEntryByNumber(planConfig,0x0028,0x0006); + } + + // We say the value *is* loaded. +/* GetHeader()->SetEntryByNumber( GDCM_BINLOADED, + GetHeader()->GetGrPixel(), GetHeader()->GetNumPixel()); + + // will be 7fe0, 0010 in standard cases + GetHeader()->SetEntryBinAreaByNumber( decompressed, + GetHeader()->GetGrPixel(), GetHeader()->GetNumPixel());*/ + SetPixelData(decompressed); + + PixelRead = 1; // PixelRaw +// END PIXELCONVERT CLEANME + return decompressed; +} +uint8_t* File::GetDecompressed() +{ + uint8_t* decompressed = PixelConverter->GetDecompressed(); + if ( ! decompressed ) + { + // The decompressed image migth not be loaded yet: + std::ifstream* fp = HeaderInternal->OpenFile(); + PixelConverter->ReadAndDecompressPixelData( fp ); + if(fp) HeaderInternal->CloseFile(); + decompressed = PixelConverter->GetDecompressed(); + if ( ! decompressed ) + { + dbg.Verbose(0, "File::GetDecompressed: read/decompress of " + "pixel data apparently went wrong."); + return 0; + } + } + + return decompressed; +} -///////////////////////////////////////////////////////////////// /** - * \ingroup gdcmFile - * \brief Ecrit sur disque les pixels d'UNE image - * \Aucun test n'est fait sur l'"Endiannerie" du processeur. - * \Ca sera à l'utilisateur d'appeler son Reader correctement - * \ Equivalent a IdImaWriteRawFile) + * \brief Points the internal Pixel_Data pointer to the callers inData + * image representation, BUT WITHOUT COPYING THE DATA. + * 'image' Pixels are presented as C-like 2D arrays : line per line. + * 'volume'Pixels are presented as C-like 3D arrays : plane per plane + * \warning Since the pixels are not copied, it is the caller's responsability + * not to deallocate it's data before gdcm uses them (e.g. with + * the Write() method. + * @param inData user supplied pixel area + * @param expectedSize total image size, in Bytes * - * @param - * - * @return + * @return boolean + */ +bool File::SetImageData(uint8_t* inData, size_t expectedSize) +{ + HeaderInternal->SetImageDataSize( expectedSize ); +// FIXME : if already allocated, memory leak ! + Pixel_Data = inData; + ImageDataSize = ImageDataSizeRaw = expectedSize; + PixelRead = 1; +// FIXME : 7fe0, 0010 IS NOT set ... + return true; +} + +/** + * \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 */ -int gdcmFile::WriteRawData (string nomFichier) { - - FILE * fp1; - fp1 = fopen(nomFichier.c_str(),"wb"); - if (fp1 == NULL) { - printf("Echec ouverture (ecriture) Fichier [%s] \n",nomFichier.c_str()); - return (0); - } - - fwrite (Pixels,lgrTotale, 1, fp1); - fclose (fp1); - return(1); +bool File::WriteRawData(std::string const & fileName) +{ + std::ofstream fp1(fileName.c_str(), std::ios::out | std::ios::binary ); + if (!fp1) + { + dbg.Verbose(2, "Fail to open (write) file:", fileName.c_str()); + return false; + } + fp1.write((char*)Pixel_Data, ImageDataSize); + fp1.close(); + + return true; } +/** + * \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 + */ +bool File::WriteDcmImplVR (std::string const & fileName) +{ + return WriteBase(fileName, ImplicitVR); +} -///////////////////////////////////////////////////////////////// /** - * \ingroup gdcmFile - * \brief Ecrit sur disque UNE image Dicom - * \Aucun test n'est fait sur l'"Endiannerie" du processeur. - * \Ca sera à l'utilisateur d'appeler son Reader correctement - * \ Equivalent a IdDcmWrite) - * - * @param - * - * @return +* \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 */ -int gdcmFile::WriteDcm (string nomFichier) { +bool File::WriteDcmExplVR (std::string const & fileName) +{ + return WriteBase(fileName, ExplicitVR); +} +/** + * \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 + */ -// ATTENTION : fonction non terminée (commitée a titre de precaution) +bool File::WriteAcr (std::string const & fileName) +{ + return WriteBase(fileName, ACR); +} - FILE * fp1; - char* filePreamble; - fp1 = fopen(nomFichier.c_str(),"wb"); - if (fp1 == NULL) { - printf("Echec ouverture (ecriture) Fichier [%s] \n",nomFichier.c_str()); - return (0); - } - - // Ecriture Dicom File Preamble - //filePreamble=(char*)g_malloc0(128); // voir pourquoi ca ne passe pas a la compile - filePreamble=(char*)calloc(128,1); - fwrite(filePreamble,128,1,fp1); - fwrite("DICM",4,1,fp1); - if(DEBUG) printf("Ecriture File Preamble\n"); +//----------------------------------------------------------------------------- +// Protected +/** + * \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 + */ +bool File::WriteBase (std::string const & fileName, FileType type) +{ + if ( PixelRead == -1 && type != ExplicitVR) + { + return false; + } + + std::ofstream* fp1 = new std::ofstream(fileName.c_str(), + std::ios::out | std::ios::binary); + if (fp1 == NULL) + { + dbg.Verbose(2, "Failed to open (write) File: " , fileName.c_str()); + return false; + } + + if ( type == ImplicitVR || type == ExplicitVR ) + { + // writing Dicom File Preamble + char filePreamble[128]; + memset(filePreamble, 0, 128); + fp1->write(filePreamble, 128); + fp1->write("DICM", 4); + } + + // -------------------------------------------------------------- + // 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 ( HeaderInternal->GetFileType() == ACR_LIBIDO) + { + rows = HeaderInternal->GetEntryByNumber(0x0028, 0x0010); + columns = HeaderInternal->GetEntryByNumber(0x0028, 0x0011); + + HeaderInternal->SetEntryByNumber(columns, 0x0028, 0x0010); + HeaderInternal->SetEntryByNumber(rows , 0x0028, 0x0011); + } + // ----------------- End of Special Patch ---------------- + + uint16_t grPixel = HeaderInternal->GetGrPixel(); + uint16_t numPixel = HeaderInternal->GetNumPixel();; + + DocEntry* PixelElement = + GetHeader()->GetDocEntryByNumber(grPixel, numPixel); + + if ( PixelRead == 1 ) + { + // we read pixel 'as is' (no tranformation LUT -> RGB) + PixelElement->SetLength( ImageDataSizeRaw ); + } + else if ( PixelRead == 0 ) + { + // we tranformed GrayLevel pixels + LUT into RGB Pixel + PixelElement->SetLength( ImageDataSize ); + } + + HeaderInternal->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 ( HeaderInternal->GetFileType() == ACR_LIBIDO ) + { + HeaderInternal->SetEntryByNumber(rows , 0x0028, 0x0010); + HeaderInternal->SetEntryByNumber(columns, 0x0028, 0x0011); + } + // ----------------- End of Special Patch ---------------- + fp1->close (); + delete fp1; + + return true; +} - // un accesseur de + est obligatoire ??? - GetPubElVals().Write(fp1); +/** + * \brief Access to the underlying \ref PixelConverter RGBA LUT + */ +uint8_t* File::GetLutRGBA() +{ + return PixelConverter->GetLutRGBA(); +} - fclose (fp1); - return(1); +//----------------------------------------------------------------------------- +// Private +void File::SetPixelData(uint8_t* data) +{ + GetHeader()->SetEntryByNumber( GDCM_BINLOADED, + GetHeader()->GetGrPixel(), GetHeader()->GetNumPixel()); + + // Will be 7fe0, 0010 in standard case + DocEntry* currentEntry = GetHeader()->GetDocEntryByNumber(GetHeader()->GetGrPixel(), GetHeader()->GetNumPixel()); + if ( currentEntry ) + { + if ( BinEntry* binEntry = dynamic_cast(currentEntry) ) + // Flag is to false because datas are kept in the gdcmPixelConvert + binEntry->SetBinArea( data, false ); + } } - + +//----------------------------------------------------------------------------- +} // end namespace gdcm