Program: gdcm
Module: $RCSfile: gdcmFile.cxx,v $
Language: C++
- Date: $Date: 2005/01/13 22:30:11 $
- Version: $Revision: 1.192 $
+ 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"
* 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 File::Print(std::ostream &os)
+void FileHelper::Print(std::ostream &os, std::string const &)
{
HeaderInternal->SetPrintLevel(PrintLevel);
HeaderInternal->Print(os);
* the size of the pixels)
* @return The image size
*/
-size_t File::GetImageDataSize()
+size_t FileHelper::GetImageDataSize()
{
if ( PixelWriteConverter->GetUserData() )
{
* (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() )
{
*
* @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 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 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 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 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 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)
* @return false if write fails
*/
-bool File::WriteDcmImplVR (std::string const &fileName)
+bool FileHelper::WriteDcmImplVR (std::string const &fileName)
{
SetWriteTypeToDcmImplVR();
return Write(fileName);
* @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);
* (any already existing file is overwritten)
* @return false if write fails
*/
-bool File::Write(std::string const &fileName)
+bool FileHelper::Write(std::string const &fileName)
{
switch(WriteType)
{
* @param group group number of the Dicom Element to modify
* @param elem element number of the Dicom Element to modify
*/
-bool File::SetEntry(std::string const &content,
+bool FileHelper::SetEntry(std::string const &content,
uint16_t group, uint16_t elem)
{
return HeaderInternal->SetEntry(content,group,elem);
* @param group group number of the Dicom Element to modify
* @param elem element number of the Dicom Element to modify
*/
-bool File::SetEntry(uint8_t *content, int lgth,
+bool FileHelper::SetEntry(uint8_t *content, int lgth,
uint16_t group, uint16_t elem)
{
return HeaderInternal->SetEntry(content,lgth,group,elem);
* \return pointer to the modified/created Header Entry (NULL when creation
* failed).
*/
-bool File::ReplaceOrCreate(std::string const &content,
+bool FileHelper::ReplaceOrCreate(std::string const &content,
uint16_t group, uint16_t elem)
{
return HeaderInternal->ReplaceOrCreate(content,group,elem) != NULL;
* \return pointer to the modified/created Header Entry (NULL when creation
* failed).
*/
-bool File::ReplaceOrCreate(uint8_t *binArea, int lgth,
+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* File::GetLutRGBA()
+uint8_t* FileHelper::GetLutRGBA()
{
return PixelReadConverter->GetLutRGBA();
}
* when the user set an image data
* @return true if the check successfulls
*/
-bool File::CheckWriteIntegrity()
+bool FileHelper::CheckWriteIntegrity()
{
if(PixelWriteConverter->GetUserData())
{
return true;
}
-void File::SetWriteToRaw()
+/**
+ * \brief
+ */
+void FileHelper::SetWriteToRaw()
{
if( HeaderInternal->GetNumberOfScalarComponents() == 3
&& !HeaderInternal->HasLUT())
}
}
-void File::SetWriteToRGB()
+
+/**
+ * \brief
+ */
+void FileHelper::SetWriteToRGB()
{
if(HeaderInternal->GetNumberOfScalarComponents()==3)
{
}
}
-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(
Global::GetTS()->GetSpecialTransferSyntax(TS::ExplicitVRLittleEndian) );
Archive->Push(tss);
}
-void File::SetWriteFileTypeToImplicitVR()
+/**
+ * \brief
+ */
+void FileHelper::SetWriteFileTypeToImplicitVR()
{
std::string ts = Util::DicomString(
Global::GetTS()->GetSpecialTransferSyntax(TS::ImplicitVRLittleEndian) );
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->GetDocEntry(0x0028, 0x0010));
Archive->Push(libidoCode);
}
-void File::SetWriteToNoLibido()
+/**
+ * \brief
+ */
+void FileHelper::SetWriteToNoLibido()
{
ValEntry *recCode = dynamic_cast<ValEntry *>
(HeaderInternal->GetDocEntry(0x0008,0x0010));
}
}
-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 elem)
+ValEntry *FileHelper::CopyValEntry(uint16_t group,uint16_t elem)
{
DocEntry *oldE = HeaderInternal->GetDocEntry(group, elem);
ValEntry *newE;
return newE;
}
-BinEntry *File::CopyBinEntry(uint16_t group,uint16_t elem)
+/**
+ * \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;
/**
* \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();
if ( ! raw )