X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmFile.cxx;h=cd6ec36b48bc77078dffe8723c58d6c785a33137;hb=51cbcb8520d5fcb26ea0ceec99f58b8db9692876;hp=f9780b8b1bd7f1eab78f2f5fa7683da5b5d9d2be;hpb=7b069497760da2dab81ddc2ea47b50573b11bb48;p=gdcm.git diff --git a/src/gdcmFile.cxx b/src/gdcmFile.cxx index f9780b8b..cd6ec36b 100644 --- a/src/gdcmFile.cxx +++ b/src/gdcmFile.cxx @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmFile.cxx,v $ Language: C++ - Date: $Date: 2005/01/06 08:46:21 $ - Version: $Revision: 1.180 $ + Date: $Date: 2005/01/06 20:03:27 $ + Version: $Revision: 1.183 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -180,7 +180,7 @@ size_t File::GetImageDataRawSize() * @return Pointer to newly allocated pixel data. * NULL if alloc fails */ -uint8_t* File::GetImageData() +uint8_t *File::GetImageData() { if ( PixelWriteConverter->GetUserData() ) { @@ -213,7 +213,7 @@ uint8_t* File::GetImageData() * @return Pointer to newly allocated pixel data. * \ NULL if alloc fails */ -uint8_t* File::GetImageDataRaw () +uint8_t *File::GetImageDataRaw () { return GetRaw(); } @@ -243,7 +243,7 @@ uint8_t* File::GetImageDataRaw () * @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) +size_t File::GetImageDataIntoVector (void *destination, size_t maxSize) { if ( ! GetRaw() ) { @@ -291,7 +291,7 @@ size_t File::GetImageDataIntoVector (void* destination, size_t maxSize) * * @return boolean */ -void File::SetImageData(uint8_t* inData, size_t expectedSize) +void File::SetImageData(uint8_t *inData, size_t expectedSize) { SetUserData(inData,expectedSize); } @@ -300,23 +300,23 @@ void File::SetImageData(uint8_t* inData, size_t expectedSize) * \brief Set the image datas defined by the user * \warning When writting the file, this datas are get as default datas to write */ -void File::SetUserData(uint8_t* data, size_t expectedSize) +void File::SetUserData(uint8_t *data, size_t expectedSize) { PixelWriteConverter->SetUserData(data,expectedSize); } /** * \brief Get the image datas defined by the user - * \warning When writting the file, this datas are get as default datas to write + * \warning When writting the file, this datas are get as default data to write */ -uint8_t* File::GetUserData() +uint8_t *File::GetUserData() { return PixelWriteConverter->GetUserData(); } /** * \brief Get the image data size defined by the user - * \warning When writting the file, this datas are get as default datas to write + * \warning When writting the file, this datas are get as default data to write */ size_t File::GetUserDataSize() { @@ -325,16 +325,16 @@ size_t File::GetUserDataSize() /** * \brief Get the image datas from the file. - * If a LUT is found, the datas are expanded to be RGB + * If a LUT is found, the data are expanded to be RGB */ -uint8_t* File::GetRGBData() +uint8_t *File::GetRGBData() { return PixelReadConverter->GetRGB(); } /** * \brief Get the image data size from the file. - * If a LUT is found, the datas are expanded to be RGB + * If a LUT is found, the data are expanded to be RGB */ size_t File::GetRGBDataSize() { @@ -345,14 +345,14 @@ size_t File::GetRGBDataSize() * \brief Get the image datas from the file. * If a LUT is found, the datas are not expanded ! */ -uint8_t* File::GetRawData() +uint8_t *File::GetRawData() { return PixelReadConverter->GetRaw(); } /** * \brief Get the image data size from the file. - * If a LUT is found, the datas are not expanded ! + * If a LUT is found, the data are not expanded ! */ size_t File::GetRawDataSize() { @@ -368,7 +368,7 @@ size_t File::GetRawDataSize() * @return false if write fails */ -bool File::WriteRawData(std::string const & fileName) +bool File::WriteRawData(std::string const &fileName) { std::ofstream fp1(fileName.c_str(), std::ios::out | std::ios::binary ); if (!fp1) @@ -398,7 +398,7 @@ bool File::WriteRawData(std::string const & fileName) * @return false if write fails */ -bool File::WriteDcmImplVR (std::string const & fileName) +bool File::WriteDcmImplVR (std::string const &fileName) { SetWriteTypeToDcmImplVR(); return Write(fileName); @@ -407,12 +407,13 @@ bool File::WriteDcmImplVR (std::string const & fileName) /** * \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 + * 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::WriteDcmExplVR (std::string const & fileName) +bool File::WriteDcmExplVR (std::string const &fileName) { SetWriteTypeToDcmExplVR(); return Write(fileName); @@ -432,7 +433,7 @@ bool File::WriteDcmExplVR (std::string const & fileName) * @return false if write fails */ -bool File::WriteAcr (std::string const & fileName) +bool File::WriteAcr (std::string const &fileName) { SetWriteTypeToAcr(); return Write(fileName); @@ -444,7 +445,7 @@ bool File::WriteAcr (std::string const & fileName) * (any already existing file is overwritten) * @return false if write fails */ -bool File::Write(std::string const& fileName) +bool File::Write(std::string const &fileName) { switch(WriteType) { @@ -510,25 +511,62 @@ bool File::Write(std::string const& fileName) return check; } -bool File::SetEntryByNumber(std::string const& content, +/** + * \brief Accesses an existing DocEntry (i.e. a Dicom Element) + * through it's (group, element) and modifies it's content with + * the given value. + * @param content new value (string) to substitute with + * @param group group number of the Dicom Element to modify + * @param element element number of the Dicom Element to modify + */ +bool File::SetEntryByNumber(std::string const &content, uint16_t group, uint16_t element) { return HeaderInternal->SetEntryByNumber(content,group,element); } -bool File::SetEntryByNumber(uint8_t* content, int lgth, + +/** + * \brief Accesses an existing DocEntry (i.e. a Dicom Element) + * through it's (group, element) and modifies it's content with + * the given value. + * @param content new value (void* -> uint8_t*) to substitute with + * @param lgth new value length + * @param group group number of the Dicom Element to modify + * @param element element number of the Dicom Element to modify + */ +bool File::SetEntryByNumber(uint8_t *content, int lgth, uint16_t group, uint16_t element) { return HeaderInternal->SetEntryByNumber(content,lgth,group,element); } -bool File::ReplaceOrCreateByNumber(std::string const& content, +/** + * \brief Modifies the value of a given Doc Entry (Dicom Element) + * when it exists. Create it with the given value when unexistant. + * @param content (string) Value to be set + * @param group Group number of the Entry + * @param element Element number of the Entry + * \return pointer to the modified/created Header Entry (NULL when creation + * failed). + */ +bool File::ReplaceOrCreateByNumber(std::string const &content, uint16_t group, uint16_t element) { return HeaderInternal->ReplaceOrCreateByNumber(content,group,element) != NULL; } -bool File::ReplaceOrCreateByNumber(uint8_t* binArea, int lgth, +/* + * \brief Modifies the value of a given Header Entry (Dicom Element) + * when it exists. Create it with the given value when unexistant. + * A copy of the binArea is made to be kept in the Document. + * @param binArea (binary) value to be set + * @param group Group number of the Entry + * @param element Element number of the Entry + * \return pointer to the modified/created Header Entry (NULL when creation + * failed). + */ +bool File::ReplaceOrCreateByNumber(uint8_t *binArea, int lgth, uint16_t group, uint16_t element) { return HeaderInternal->ReplaceOrCreateByNumber(binArea,lgth,group,element) != NULL; @@ -606,7 +644,7 @@ void File::SetWriteToRaw() } else { - ValEntry* photInt = CopyValEntry(0x0028,0x0004); + ValEntry *photInt = CopyValEntry(0x0028,0x0004); if(HeaderInternal->HasLUT()) { photInt->SetValue("PALETTE COLOR "); @@ -619,7 +657,7 @@ void File::SetWriteToRaw() PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(), PixelReadConverter->GetRawSize()); - BinEntry* pixel = CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel()); + BinEntry *pixel = CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel()); pixel->SetValue(GDCM_BINLOADED); pixel->SetBinArea(PixelWriteConverter->GetData(),false); pixel->SetLength(PixelWriteConverter->GetDataSize()); @@ -635,13 +673,13 @@ void File::SetWriteToRGB() { PixelReadConverter->BuildRGBImage(); - ValEntry* spp = CopyValEntry(0x0028,0x0002); + ValEntry *spp = CopyValEntry(0x0028,0x0002); spp->SetValue("3 "); - ValEntry* planConfig = CopyValEntry(0x0028,0x0006); + ValEntry *planConfig = CopyValEntry(0x0028,0x0006); planConfig->SetValue("0 "); - ValEntry* photInt = CopyValEntry(0x0028,0x0004); + ValEntry *photInt = CopyValEntry(0x0028,0x0004); photInt->SetValue("RGB "); if(PixelReadConverter->GetRGB()) @@ -655,7 +693,7 @@ void File::SetWriteToRGB() PixelReadConverter->GetRawSize()); } - BinEntry* pixel = CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel()); + BinEntry *pixel = CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel()); pixel->SetValue(GDCM_BINLOADED); pixel->SetBinArea(PixelWriteConverter->GetData(),false); pixel->SetLength(PixelWriteConverter->GetDataSize()); @@ -678,13 +716,13 @@ void File::SetWriteToRGB() // samples per pixels = 1 (in the read file) if(HeaderInternal->GetBitsAllocated()==24) { - ValEntry* bitsAlloc = CopyValEntry(0x0028,0x0100); + ValEntry *bitsAlloc = CopyValEntry(0x0028,0x0100); bitsAlloc->SetValue("8 "); - ValEntry* bitsStored = CopyValEntry(0x0028,0x0101); + ValEntry *bitsStored = CopyValEntry(0x0028,0x0101); bitsStored->SetValue("8 "); - ValEntry* highBit = CopyValEntry(0x0028,0x0102); + ValEntry *highBit = CopyValEntry(0x0028,0x0102); highBit->SetValue("7 "); Archive->Push(bitsAlloc); @@ -729,7 +767,7 @@ void File::SetWriteFileTypeToExplicitVR() std::string ts = Util::DicomString( Document::GetTransferSyntaxValue(ExplicitVRLittleEndian).c_str() ); - ValEntry* tss = CopyValEntry(0x0002,0x0010); + ValEntry *tss = CopyValEntry(0x0002,0x0010); tss->SetValue(ts); Archive->Push(tss); @@ -740,7 +778,7 @@ void File::SetWriteFileTypeToImplicitVR() std::string ts = Util::DicomString( Document::GetTransferSyntaxValue(ImplicitVRLittleEndian).c_str() ); - ValEntry* tss = CopyValEntry(0x0002,0x0010); + ValEntry *tss = CopyValEntry(0x0002,0x0010); tss->SetValue(ts); Archive->Push(tss); @@ -802,10 +840,10 @@ void File::RestoreWriteOfLibido() Archive->Restore(0x0008,0x0010); } -ValEntry* File::CopyValEntry(uint16_t group,uint16_t element) +ValEntry *File::CopyValEntry(uint16_t group,uint16_t element) { - DocEntry* oldE = HeaderInternal->GetDocEntryByNumber(group, element); - ValEntry* newE; + DocEntry *oldE = HeaderInternal->GetDocEntryByNumber(group, element); + ValEntry *newE; if(oldE) { @@ -820,10 +858,10 @@ ValEntry* File::CopyValEntry(uint16_t group,uint16_t element) return(newE); } -BinEntry* File::CopyBinEntry(uint16_t group,uint16_t element) +BinEntry *File::CopyBinEntry(uint16_t group,uint16_t element) { - DocEntry* oldE = HeaderInternal->GetDocEntryByNumber(group, element); - BinEntry* newE; + DocEntry *oldE = HeaderInternal->GetDocEntryByNumber(group, element); + BinEntry *newE; if(oldE) { @@ -858,13 +896,13 @@ void File::Initialise() } } -uint8_t* File::GetRaw() +uint8_t *File::GetRaw() { - uint8_t* raw = PixelReadConverter->GetRaw(); + uint8_t *raw = PixelReadConverter->GetRaw(); if ( ! raw ) { // The Raw image migth not be loaded yet: - std::ifstream* fp = HeaderInternal->OpenFile(); + std::ifstream *fp = HeaderInternal->OpenFile(); PixelReadConverter->ReadAndDecompressPixelData( fp ); if(fp) HeaderInternal->CloseFile();