- /*=========================================================================
+/*=========================================================================
Program: gdcm
Module: $RCSfile: gdcmFile.cxx,v $
Language: C++
- Date: $Date: 2004/12/16 10:51:49 $
- Version: $Revision: 1.177 $
+ Date: $Date: 2005/01/20 16:17:00 $
+ Version: $Revision: 1.194 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
=========================================================================*/
-#include "gdcmFile.h"
+#include "gdcmFileHelper.h"
+#include "gdcmGlobal.h"
+#include "gdcmTS.h"
#include "gdcmDocument.h"
#include "gdcmDebug.h"
#include "gdcmUtil.h"
* one sets an a posteriori shadow dictionary (efficiency can be
* seen as a side effect).
*/
-File::File( )
+FileHelper::FileHelper( )
{
HeaderInternal = new Header( );
SelfHeader = true;
* seen as a side effect).
* @param header already built Header
*/
-File::File(Header *header)
+FileHelper::FileHelper(Header *header)
{
HeaderInternal = header;
SelfHeader = false;
* seen as a side effect).
* @param filename file to be opened for parsing
*/
-File::File(std::string const & filename )
+FileHelper::FileHelper(std::string const & filename )
{
HeaderInternal = new Header( filename );
SelfHeader = true;
/**
* \brief canonical destructor
- * \note If the Header was created by the File constructor,
- * it is destroyed by the File
+ * \note If the header (gdcm::File) was created by the FileHelper constructor,
+ * it is destroyed by the FileHelper
*/
-File::~File()
+FileHelper::~FileHelper()
{
if( PixelReadConverter )
{
//-----------------------------------------------------------------------------
// Print
+void FileHelper::Print(std::ostream &os, std::string const &)
+{
+ HeaderInternal->SetPrintLevel(PrintLevel);
+ HeaderInternal->Print(os);
+
+ PixelReadConverter->SetPrintLevel(PrintLevel);
+ PixelReadConverter->Print(os);
+}
//-----------------------------------------------------------------------------
// Public
/**
* \brief Get the size of the image data
- *
* If the image can be RGB (with a lut or by default), the size
* corresponds to the RGB image
+ * (use GetImageDataRawSize if you want to be sure to get *only*
+ * the size of the pixels)
* @return The image size
*/
-size_t File::GetImageDataSize()
+size_t FileHelper::GetImageDataSize()
{
if ( PixelWriteConverter->GetUserData() )
{
/**
* \brief Get the size of the image data
- *
- * If the image can be RGB by transformation in a LUT, this
- * transformation isn't considered
+ * If the image could be converted to RGB using a LUT,
+ * this transformation is not taken into account by GetImageDataRawSize
+ * (use GetImageDataSize if you wish)
* @return The raw image size
*/
-size_t File::GetImageDataRawSize()
+size_t FileHelper::GetImageDataRawSize()
{
if ( PixelWriteConverter->GetUserData() )
{
* @return Pointer to newly allocated pixel data.
* NULL if alloc fails
*/
-uint8_t* File::GetImageData()
+uint8_t *FileHelper::GetImageData()
{
if ( PixelWriteConverter->GetUserData() )
{
* @return Pointer to newly allocated pixel data.
* \ NULL if alloc fails
*/
-uint8_t* File::GetImageDataRaw ()
+uint8_t *FileHelper::GetImageDataRaw ()
{
return GetRaw();
}
* @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 FileHelper::GetImageDataIntoVector (void *destination, size_t maxSize)
{
if ( ! GetRaw() )
{
{
if ( PixelReadConverter->GetRGBSize() > maxSize )
{
- dbg.Verbose(0, "File::GetImageDataIntoVector: pixel data bigger"
- "than caller's expected MaxSize");
+ gdcmVerboseMacro( "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 )
{
- dbg.Verbose(0, "File::GetImageDataIntoVector: pixel data bigger"
- "than caller's expected MaxSize");
+ gdcmVerboseMacro( "Pixel data bigger than caller's expected MaxSize");
return 0;
}
memcpy( destination,
*
* @return boolean
*/
-void File::SetImageData(uint8_t* inData, size_t expectedSize)
+void FileHelper::SetImageData(uint8_t *inData, size_t expectedSize)
{
SetUserData(inData,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 FileHelper::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 *FileHelper::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()
+size_t FileHelper::GetUserDataSize()
{
return PixelWriteConverter->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 *FileHelper::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()
+size_t FileHelper::GetRGBDataSize()
{
return PixelReadConverter->GetRGBSize();
}
* \brief Get the image datas from the file.
* If a LUT is found, the datas are not expanded !
*/
-uint8_t* File::GetRawData()
+uint8_t *FileHelper::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()
+size_t FileHelper::GetRawDataSize()
{
return PixelReadConverter->GetRawSize();
}
* @return false if write fails
*/
-bool File::WriteRawData(std::string const & fileName)
+bool FileHelper::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());
+ gdcmVerboseMacro( "Fail to open (write) file:" << fileName.c_str());
return false;
}
- if(PixelWriteConverter->GetUserData())
- fp1.write((char*)PixelWriteConverter->GetUserData(), PixelWriteConverter->GetUserDataSize());
- else if(PixelReadConverter->GetRGB())
- fp1.write((char*)PixelReadConverter->GetRGB(), PixelReadConverter->GetRGBSize());
- else if(PixelReadConverter->GetRaw())
- fp1.write((char*)PixelReadConverter->GetRaw(), PixelReadConverter->GetRawSize());
+ if( PixelWriteConverter->GetUserData() )
+ {
+ fp1.write( (char*)PixelWriteConverter->GetUserData(),
+ PixelWriteConverter->GetUserDataSize() );
+ }
+ else if ( PixelReadConverter->GetRGB() )
+ {
+ fp1.write( (char*)PixelReadConverter->GetRGB(),
+ PixelReadConverter->GetRGBSize());
+ }
+ else if ( PixelReadConverter->GetRaw() )
+ {
+ fp1.write( (char*)PixelReadConverter->GetRaw(),
+ PixelReadConverter->GetRawSize());
+ }
+ else
+ {
+ gdcmErrorMacro( "Nothing written." );
+ }
fp1.close();
* @return false if write fails
*/
-bool File::WriteDcmImplVR (std::string const & fileName)
+bool FileHelper::WriteDcmImplVR (std::string const &fileName)
{
SetWriteTypeToDcmImplVR();
return Write(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 FileHelper::WriteDcmExplVR (std::string const &fileName)
{
SetWriteTypeToDcmExplVR();
return Write(fileName);
* @return false if write fails
*/
-bool File::WriteAcr (std::string const & fileName)
+bool FileHelper::WriteAcr (std::string const &fileName)
{
SetWriteTypeToAcr();
return Write(fileName);
}
-bool File::Write(std::string const& fileName)
-{
- return WriteBase(fileName);
-}
-
-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,
- uint16_t group, uint16_t element)
-{
- return HeaderInternal->SetEntryByNumber(content,lgth,group,element);
-}
-
-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,
- uint16_t group, uint16_t element)
-{
- return HeaderInternal->ReplaceOrCreateByNumber(binArea,lgth,group,element) != NULL;
-}
-
-/**
- * \brief Access to the underlying \ref PixelReadConverter RGBA LUT
- */
-uint8_t* File::GetLutRGBA()
-{
- return PixelReadConverter->GetLutRGBA();
-}
-
-//-----------------------------------------------------------------------------
-// Protected
/**
- * \brief NOT a end user inteded function
- * (used by WriteDcmExplVR, WriteDcmImplVR, WriteAcr, etc)
+ * \brief Writes on disk A SINGLE Dicom file,
* @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)
+bool FileHelper::Write(std::string const &fileName)
{
switch(WriteType)
{
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 HeaderInternal->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 HeaderInternal->SetEntry(content,lgth,group,elem);
+}
+
+/**
+ * \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 elem Element number of the Entry
+ * \return pointer to the modified/created Header Entry (NULL when creation
+ * failed).
+ */
+bool FileHelper::ReplaceOrCreate(std::string const &content,
+ uint16_t group, uint16_t elem)
+{
+ return HeaderInternal->ReplaceOrCreate(content,group,elem) != NULL;
+}
+
+/*
+ * \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 elem Element number of the Entry
+ * \return pointer to the modified/created Header Entry (NULL when creation
+ * failed).
+ */
+bool FileHelper::ReplaceOrCreate(uint8_t *binArea, int lgth,
+ uint16_t group, uint16_t elem)
+{
+ return HeaderInternal->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
*
* when the user set an image data
* @return true if the check successfulls
*/
-bool File::CheckWriteIntegrity()
+bool FileHelper::CheckWriteIntegrity()
{
if(PixelWriteConverter->GetUserData())
{
case WMODE_RAW :
if( decSize!=PixelWriteConverter->GetUserDataSize() )
{
- dbg.Verbose(0, "File::CheckWriteIntegrity: Data size is incorrect (Raw)");
- //std::cerr << "File::CheckWriteIntegrity: Data size is incorrect (Raw)\n"
- // << decSize << " / " << PixelWriteConverter->GetUserDataSize() << "\n";
+ gdcmVerboseMacro( "Data size is incorrect (Raw)" << decSize
+ << " / " << PixelWriteConverter->GetUserDataSize() );
return false;
}
break;
case WMODE_RGB :
if( rgbSize!=PixelWriteConverter->GetUserDataSize() )
{
- dbg.Verbose(0, "File::CheckWriteIntegrity: Data size is incorrect (RGB)");
- //std::cerr << "File::CheckWriteIntegrity: Data size is incorrect (RGB)\n"
- // << decSize << " / " << PixelWriteConverter->GetUserDataSize() << "\n";
+ gdcmVerboseMacro( "Data size is incorrect (RGB)" << decSize
+ << " / " << PixelWriteConverter->GetUserDataSize() );
return false;
}
break;
return true;
}
-void File::SetWriteToRaw()
+/**
+ * \brief
+ */
+void FileHelper::SetWriteToRaw()
{
- if(HeaderInternal->GetNumberOfScalarComponents()==3 && !HeaderInternal->HasLUT())
+ if( HeaderInternal->GetNumberOfScalarComponents() == 3
+ && !HeaderInternal->HasLUT())
{
SetWriteToRGB();
}
else
{
- ValEntry* photInt = CopyValEntry(0x0028,0x0004);
+ ValEntry *photInt = CopyValEntry(0x0028,0x0004);
if(HeaderInternal->HasLUT())
{
photInt->SetValue("PALETTE COLOR ");
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());
}
}
-void File::SetWriteToRGB()
+
+/**
+ * \brief
+ */
+void FileHelper::SetWriteToRGB()
{
if(HeaderInternal->GetNumberOfScalarComponents()==3)
{
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())
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());
// 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);
}
}
-void File::RestoreWrite()
+/**
+ * \brief
+ */
+void FileHelper::RestoreWrite()
{
Archive->Restore(0x0028,0x0002);
Archive->Restore(0x0028,0x0004);
Archive->Restore(0x0028,0x1203);
}
-void File::SetWriteFileTypeToACR()
+/**
+ * \brief
+ */
+void FileHelper::SetWriteFileTypeToACR()
{
Archive->Push(0x0002,0x0010);
}
-void File::SetWriteFileTypeToExplicitVR()
+/**
+ * \brief
+ */
+void FileHelper::SetWriteFileTypeToExplicitVR()
{
std::string ts = Util::DicomString(
- Document::GetTransferSyntaxValue(ExplicitVRLittleEndian).c_str() );
+ Global::GetTS()->GetSpecialTransferSyntax(TS::ExplicitVRLittleEndian) );
- ValEntry* tss = CopyValEntry(0x0002,0x0010);
+ ValEntry *tss = CopyValEntry(0x0002,0x0010);
tss->SetValue(ts);
Archive->Push(tss);
}
-void File::SetWriteFileTypeToImplicitVR()
+/**
+ * \brief
+ */
+void FileHelper::SetWriteFileTypeToImplicitVR()
{
std::string ts = Util::DicomString(
- Document::GetTransferSyntaxValue(ImplicitVRLittleEndian).c_str() );
+ Global::GetTS()->GetSpecialTransferSyntax(TS::ImplicitVRLittleEndian) );
- ValEntry* tss = CopyValEntry(0x0002,0x0010);
+ ValEntry *tss = CopyValEntry(0x0002,0x0010);
tss->SetValue(ts);
Archive->Push(tss);
}
-void File::RestoreWriteFileType()
+
+/**
+ * \brief
+ */
+void FileHelper::RestoreWriteFileType()
{
Archive->Restore(0x0002,0x0010);
}
-void File::SetWriteToLibido()
+void FileHelper::SetWriteToLibido()
{
ValEntry *oldRow = dynamic_cast<ValEntry *>
- (HeaderInternal->GetDocEntryByNumber(0x0028, 0x0010));
+ (HeaderInternal->GetDocEntry(0x0028, 0x0010));
ValEntry *oldCol = dynamic_cast<ValEntry *>
- (HeaderInternal->GetDocEntryByNumber(0x0028, 0x0011));
+ (HeaderInternal->GetDocEntry(0x0028, 0x0011));
if( oldRow && oldCol )
{
Archive->Push(libidoCode);
}
-void File::SetWriteToNoLibido()
+/**
+ * \brief
+ */
+void FileHelper::SetWriteToNoLibido()
{
ValEntry *recCode = dynamic_cast<ValEntry *>
- (HeaderInternal->GetDocEntryByNumber(0x0008,0x0010));
+ (HeaderInternal->GetDocEntry(0x0008,0x0010));
if( recCode )
{
if( recCode->GetValue() == "ACRNEMA_LIBIDO_1.1" )
}
}
-void File::RestoreWriteOfLibido()
+/**
+ * \brief
+ */
+void FileHelper::RestoreWriteOfLibido()
{
Archive->Restore(0x0028,0x0010);
Archive->Restore(0x0028,0x0011);
Archive->Restore(0x0008,0x0010);
}
-ValEntry* File::CopyValEntry(uint16_t group,uint16_t element)
+ValEntry *FileHelper::CopyValEntry(uint16_t group,uint16_t elem)
{
- DocEntry* oldE = HeaderInternal->GetDocEntryByNumber(group, element);
- ValEntry* newE;
+ DocEntry *oldE = HeaderInternal->GetDocEntry(group, elem);
+ ValEntry *newE;
if(oldE)
{
}
else
{
- newE = GetHeader()->NewValEntryByNumber(group,element);
+ newE = GetHeader()->NewValEntry(group,elem);
}
- return(newE);
+ return newE;
}
-BinEntry* File::CopyBinEntry(uint16_t group,uint16_t element)
-{
- DocEntry* oldE = HeaderInternal->GetDocEntryByNumber(group, element);
- BinEntry* newE;
+/**
+ * \brief Modifies the value of a given Bin 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 elem Element number of the Entry
+ * \return pointer to the modified/created Bin Entry (NULL when creation
+ * failed).
+ */
+BinEntry *FileHelper::CopyBinEntry(uint16_t group,uint16_t elem)
+{
+ DocEntry *oldE = HeaderInternal->GetDocEntry(group, elem);
+ BinEntry *newE;
if(oldE)
{
}
else
{
- newE = GetHeader()->NewBinEntryByNumber(group,element);
+ newE = GetHeader()->NewBinEntry(group,elem);
}
- return(newE);
+ return newE;
}
//-----------------------------------------------------------------------------
/**
* \brief Factorization for various forms of constructors.
*/
-void File::Initialise()
+void FileHelper::Initialise()
{
WriteMode = WMODE_RAW;
WriteType = ExplicitVR;
}
}
-uint8_t* File::GetRaw()
+/**
+ * \brief
+ */
+uint8_t *FileHelper::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();
raw = PixelReadConverter->GetRaw();
if ( ! raw )
{
- dbg.Verbose(0, "File::GetRaw: read/decompress of "
- "pixel data apparently went wrong.");
+ gdcmVerboseMacro( "Read/decompress of pixel data apparently went wrong.");
return 0;
}
}
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff