Program: gdcm
Module: $RCSfile: gdcmFileHelper.cxx,v $
Language: C++
- Date: $Date: 2005/01/23 10:12:34 $
- Version: $Revision: 1.3 $
+ Date: $Date: 2005/02/11 11:22:59 $
+ Version: $Revision: 1.16 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#include "gdcmDebug.h"
#include "gdcmUtil.h"
#include "gdcmBinEntry.h"
+#include "gdcmValEntry.h"
+#include "gdcmContentEntry.h"
#include "gdcmFile.h"
#include "gdcmPixelReadConvert.h"
#include "gdcmPixelWriteConvert.h"
namespace gdcm
{
-typedef std::pair<TagDocEntryHT::iterator,TagDocEntryHT::iterator> IterHT;
-
//-------------------------------------------------------------------------
// Constructor / Destructor
/**
* seen as a side effect).
* @param filename file to be opened for parsing
*/
-FileHelper::FileHelper(std::string const & filename )
+FileHelper::FileHelper(std::string const &filename )
{
FileInternal = new File( filename );
SelfHeader = true;
}
//-----------------------------------------------------------------------------
-// Print
-void FileHelper::Print(std::ostream &os, std::string const &)
+// Public
+/**
+ * \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 elem element number of the Dicom Element to modify
+ */
+bool FileHelper::SetValEntry(std::string const &content,
+ uint16_t group, uint16_t elem)
+{
+ return FileInternal->SetValEntry(content,group,elem);
+}
+
+
+/**
+ * \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 elem element number of the Dicom Element to modify
+ */
+bool FileHelper::SetBinEntry(uint8_t *content, int lgth,
+ uint16_t group, uint16_t elem)
{
- FileInternal->SetPrintLevel(PrintLevel);
- FileInternal->Print(os);
+ return FileInternal->SetBinEntry(content,lgth,group,elem);
+}
- PixelReadConverter->SetPrintLevel(PrintLevel);
- PixelReadConverter->Print(os);
+/**
+ * \brief Modifies the value of a given DocEntry (Dicom entry)
+ * 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 elem Element number of the Entry
+ * \return pointer to the modified/created Dicom entry (NULL when creation
+ * failed).
+ */
+ValEntry *FileHelper::InsertValEntry(std::string const &content,
+ uint16_t group, uint16_t elem)
+{
+ return FileInternal->InsertValEntry(content,group,elem);
+}
+
+/**
+ * \brief Modifies the value of a given DocEntry (Dicom entry)
+ * 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 lgth new value length
+ * @param group Group number of the Entry
+ * @param elem Element number of the Entry
+ * \return pointer to the modified/created Dicom entry (NULL when creation
+ * failed).
+ */
+BinEntry *FileHelper::InsertBinEntry(uint8_t *binArea, int lgth,
+ uint16_t group, uint16_t elem)
+{
+ return FileInternal->InsertBinEntry(binArea,lgth,group,elem);
+}
+
+/**
+ * \brief Modifies the value of a given DocEntry (Dicom entry)
+ * 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 group Group number of the Entry
+ * @param elem Element number of the Entry
+ * \return pointer to the modified/created Dicom entry (NULL when creation
+ * failed).
+ */
+SeqEntry *FileHelper::InsertSeqEntry(uint16_t group, uint16_t elem)
+{
+ return FileInternal->InsertSeqEntry(group,elem);
}
-//-----------------------------------------------------------------------------
-// Public
/**
* \brief Get the size of the image data
* If the image can be RGB (with a lut or by default), the size
}
/**
- * \brief - Allocates necessary memory,
+ * \brief - Allocates necessary memory,
* - Reads the pixels from disk (uncompress if necessary),
- * - Transforms YBR pixels, if any, into RGB pixels
+ * - 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.
{
if ( PixelReadConverter->GetRGBSize() > maxSize )
{
- gdcmVerboseMacro( "Pixel data bigger than caller's expected MaxSize");
+ gdcmWarningMacro( "Pixel data bigger than caller's expected MaxSize");
return 0;
}
memcpy( destination,
// Either no LUT conversion necessary or LUT conversion failed
if ( PixelReadConverter->GetRawSize() > maxSize )
{
- gdcmVerboseMacro( "Pixel data bigger than caller's expected MaxSize");
+ gdcmWarningMacro( "Pixel data bigger than caller's expected MaxSize");
return 0;
}
memcpy( destination,
* '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
+ * not to deallocate its data before gdcm uses them (e.g. with
+ * the Write() method )
+ * @param inData user supplied pixel area (uint8_t* is just for the compiler.
+ * user is allowed to pass any kind of pixelsn since the size is
+ * given in bytes)
+ * @param expectedSize total image size, *in Bytes*
*
* @return boolean
*/
}
/**
- * \brief Set the image datas defined by the user
- * \warning When writting the file, this datas are get as default datas to write
+ * \brief Set the image data defined by the user
+ * \warning When writting the file, this data are get as default data to write
+ * @param inData user supplied pixel area (uint8_t* is just for the compiler.
+ * user is allowed to pass any kind of pixelsn since the size is
+ * given in bytes)
+ * @param expectedSize total image size, *in Bytes*
+
*/
-void FileHelper::SetUserData(uint8_t *data, size_t expectedSize)
+void FileHelper::SetUserData(uint8_t *inData, size_t expectedSize)
{
- PixelWriteConverter->SetUserData(data,expectedSize);
+ PixelWriteConverter->SetUserData(inData,expectedSize);
}
/**
- * \brief Get the image datas defined by the user
- * \warning When writting the file, this datas are get as default data to write
+ * \brief Get the image data defined by the user
+ * \warning When writting the file, this data are get as default data to write
*/
uint8_t *FileHelper::GetUserData()
{
/**
* \brief Get the image data size defined by the user
- * \warning When writting the file, this datas are get as default data to write
+ * \warning When writting the file, this data are get as default data to write
*/
size_t FileHelper::GetUserDataSize()
{
}
/**
- * \brief Get the image datas from the file.
+ * \brief Get the image data from the file.
* If a LUT is found, the data are expanded to be RGB
*/
uint8_t *FileHelper::GetRGBData()
}
/**
- * \brief Get the image datas from the file.
- * If a LUT is found, the datas are not expanded !
+ * \brief Get the image data from the file.
+ * If a LUT is found, the data are not expanded !
*/
uint8_t *FileHelper::GetRawData()
{
return PixelReadConverter->GetRawSize();
}
+/**
+ * \brief Access to the underlying \ref PixelReadConverter RGBA LUT
+ */
+uint8_t* FileHelper::GetLutRGBA()
+{
+ return PixelReadConverter->GetLutRGBA();
+}
+
/**
* \brief Writes on disk A SINGLE Dicom file
* NO test is performed on processor "Endiannity".
* (any already existing file is over written)
* @return false if write fails
*/
-
bool FileHelper::WriteRawData(std::string const &fileName)
{
std::ofstream fp1(fileName.c_str(), std::ios::out | std::ios::binary );
if (!fp1)
{
- gdcmVerboseMacro( "Fail to open (write) file:" << fileName.c_str());
+ gdcmWarningMacro( "Fail to open (write) file:" << fileName.c_str());
return false;
}
return check;
}
-/**
- * \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 elem element number of the Dicom Element to modify
- */
-bool FileHelper::SetEntry(std::string const &content,
- uint16_t group, uint16_t elem)
-{
- return FileInternal->SetEntry(content,group,elem);
-}
-
-
-/**
- * \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 elem element number of the Dicom Element to modify
- */
-bool FileHelper::SetEntry(uint8_t *content, int lgth,
- uint16_t group, uint16_t elem)
-{
- return FileInternal->SetEntry(content,lgth,group,elem);
-}
-
-/**
- * \brief Modifies the value of a given DocEntry (Dicom entry)
- * 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 elem Element number of the Entry
- * \return pointer to the modified/created Dicom entry (NULL when creation
- * failed).
- */
-bool FileHelper::ReplaceOrCreate(std::string const &content,
- uint16_t group, uint16_t elem)
-{
- return FileInternal->ReplaceOrCreate(content,group,elem) != NULL;
-}
-
-/*
- * \brief Modifies the value of a given DocEntry (Dicom entry)
- * 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 elem Element number of the Entry
- * \return pointer to the modified/created Dicom entry (NULL when creation
- * failed).
- */
-bool FileHelper::ReplaceOrCreate(uint8_t *binArea, int lgth,
- uint16_t group, uint16_t elem)
-{
- return FileInternal->ReplaceOrCreate(binArea,lgth,group,elem) != NULL;
-}
-
-/**
- * \brief Access to the underlying \ref PixelReadConverter RGBA LUT
- */
-uint8_t* FileHelper::GetLutRGBA()
-{
- return PixelReadConverter->GetLutRGBA();
-}
-
//-----------------------------------------------------------------------------
// Protected
-
/**
* \brief Check the write integrity
*
* The tests made are :
* - verify the size of the image to write with the possible write
* when the user set an image data
- * @return true if the check successfulls
+ * @return true if check is successfull
*/
bool FileHelper::CheckWriteIntegrity()
{
case WMODE_RAW :
if( decSize!=PixelWriteConverter->GetUserDataSize() )
{
- gdcmVerboseMacro( "Data size is incorrect (Raw)" << decSize
- << " / " << PixelWriteConverter->GetUserDataSize() );
+ gdcmWarningMacro( "Data size (Raw) is incorrect. Should be "
+ << decSize << " / Found :"
+ << PixelWriteConverter->GetUserDataSize() );
return false;
}
break;
case WMODE_RGB :
if( rgbSize!=PixelWriteConverter->GetUserDataSize() )
{
- gdcmVerboseMacro( "Data size is incorrect (RGB)" << decSize
- << " / " << PixelWriteConverter->GetUserDataSize() );
+ gdcmWarningMacro( "Data size (RGB) is incorrect. Should be "
+ << decSize << " / Found "
+ << PixelWriteConverter->GetUserDataSize() );
return false;
}
break;
}
/**
- * \brief
+ * \brief Update the File to write RAW datas
*/
void FileHelper::SetWriteToRaw()
{
}
else
{
- photInt->SetValue("MONOCHROME1 ");
+ photInt->SetValue("MONOCHROME2 ");
}
PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(),
PixelReadConverter->GetRawSize());
+ std::string vr = "OB";
+ if( FileInternal->GetBitsAllocated()>8 )
+ vr = "OW";
+ if( FileInternal->GetBitsAllocated()==24 ) // For RGB ACR files
+ vr = "OB";
BinEntry *pixel =
- CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel());
+ CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel(),vr);
pixel->SetValue(GDCM_BINLOADED);
pixel->SetBinArea(PixelWriteConverter->GetData(),false);
pixel->SetLength(PixelWriteConverter->GetDataSize());
}
/**
- * \brief
+ * \brief Update the File to write RGB datas
*/
void FileHelper::SetWriteToRGB()
{
PixelReadConverter->GetRawSize());
}
+ std::string vr = "OB";
+ if( FileInternal->GetBitsAllocated()>8 )
+ vr = "OW";
+ if( FileInternal->GetBitsAllocated()==24 ) // For RGB ACR files
+ vr = "OB";
BinEntry *pixel =
- CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel());
+ CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel(),vr);
pixel->SetValue(GDCM_BINLOADED);
pixel->SetBinArea(PixelWriteConverter->GetData(),false);
pixel->SetLength(PixelWriteConverter->GetDataSize());
}
/**
- * \brief
+ * \brief Restore the File write mode
*/
void FileHelper::RestoreWrite()
{
}
/**
- * \brief
+ * \brief Set in the File the write type to ACR
*/
void FileHelper::SetWriteFileTypeToACR()
{
}
/**
- * \brief
+ * \brief Set in the File the write type to Explicit VR
*/
void FileHelper::SetWriteFileTypeToExplicitVR()
{
}
/**
- * \brief
+ * \brief Set in the File the write type to Implicit VR
*/
void FileHelper::SetWriteFileTypeToImplicitVR()
{
/**
- * \brief
+ * \brief Restore in the File the write type
*/
void FileHelper::RestoreWriteFileType()
{
Archive->Restore(0x0002,0x0010);
}
+/**
+ * \brief Set the Write not to Libido format
+ */
void FileHelper::SetWriteToLibido()
{
ValEntry *oldRow = dynamic_cast<ValEntry *>
}
/**
- * \brief
+ * \brief Set the Write not to No Libido format
*/
void FileHelper::SetWriteToNoLibido()
{
}
/**
- * \brief
+ * \brief Restore the Write format
*/
void FileHelper::RestoreWriteOfLibido()
{
Archive->Restore(0x0008,0x0010);
}
+/**
+ * \brief Copy a ValEntry content
+ * @param group Group number of the Entry
+ * @param elem Element number of the Entry
+ * \return pointer to the modified/created Val Entry (NULL when creation
+ * failed).
+ */
ValEntry *FileHelper::CopyValEntry(uint16_t group,uint16_t elem)
{
DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
ValEntry *newE;
- if(oldE)
+ if( oldE )
{
newE = new ValEntry(oldE->GetDictEntry());
newE->Copy(oldE);
* when it exists. Create it with the given value when unexistant.
* @param group Group number of the Entry
* @param elem Element number of the Entry
+ * @param vr Value Representation of the Entry
* \return pointer to the modified/created Bin Entry (NULL when creation
* failed).
*/
-BinEntry *FileHelper::CopyBinEntry(uint16_t group,uint16_t elem)
+BinEntry *FileHelper::CopyBinEntry(uint16_t group,uint16_t elem,
+ const std::string &vr)
{
DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
BinEntry *newE;
- if(oldE)
+ if( oldE )
+ if( oldE->GetVR()!=vr )
+ oldE = NULL;
+
+ if( oldE )
{
newE = new BinEntry(oldE->GetDictEntry());
newE->Copy(oldE);
}
else
{
- newE = GetFile()->NewBinEntry(group,elem);
+ newE = GetFile()->NewBinEntry(group,elem,vr);
}
return newE;
}
//-----------------------------------------------------------------------------
-// Protected
+// Private
/**
* \brief Factorization for various forms of constructors.
*/
if ( FileInternal->IsReadable() )
{
- PixelReadConverter->GrabInformationsFromHeader( FileInternal );
+ PixelReadConverter->GrabInformationsFromFile( FileInternal );
}
}
raw = PixelReadConverter->GetRaw();
if ( ! raw )
{
- gdcmVerboseMacro( "Read/decompress of pixel data apparently went wrong.");
+ gdcmWarningMacro( "Read/decompress of pixel data apparently went wrong.");
return 0;
}
}
}
//-----------------------------------------------------------------------------
-// Private
+// Print
+void FileHelper::Print(std::ostream &os, std::string const &)
+{
+ FileInternal->SetPrintLevel(PrintLevel);
+ FileInternal->Print(os);
+
+ PixelReadConverter->SetPrintLevel(PrintLevel);
+ PixelReadConverter->Print(os);
+}
//-----------------------------------------------------------------------------
} // end namespace gdcm
-