Program: gdcm
Module: $RCSfile: gdcmFileHelper.cxx,v $
Language: C++
- Date: $Date: 2005/01/20 16:22:52 $
- Version: $Revision: 1.1 $
+ Date: $Date: 2005/01/26 16:28:58 $
+ Version: $Revision: 1.8 $
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 "gdcmHeader.h"
+#include "gdcmValEntry.h"
+#include "gdcmContentEntry.h"
+#include "gdcmFile.h"
#include "gdcmPixelReadConvert.h"
#include "gdcmPixelWriteConvert.h"
#include "gdcmDocEntryArchive.h"
// Constructor / Destructor
/**
* \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
- * file (Header only deals with the ... header)
+ * file (gdcm::File 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
*/
FileHelper::FileHelper( )
{
- HeaderInternal = new Header( );
+ FileInternal = new File( );
SelfHeader = true;
- Initialise();
+ Initialize();
}
/**
* \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
- * file (Header only deals with the ... header)
+ * file (File 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
* seen as a side effect).
* @param header already built Header
*/
-FileHelper::FileHelper(Header *header)
+FileHelper::FileHelper(File *header)
{
- HeaderInternal = header;
+ FileInternal = header;
SelfHeader = false;
- Initialise();
+ Initialize();
}
/**
* \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
- * file (Header only deals with the ... header)
+ * file (gdcm::File 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
*/
FileHelper::FileHelper(std::string const & filename )
{
- HeaderInternal = new Header( filename );
+ FileInternal = new File( filename );
SelfHeader = true;
- Initialise();
+ Initialize();
}
/**
if( SelfHeader )
{
- delete HeaderInternal;
+ delete FileInternal;
}
- HeaderInternal = 0;
+ FileInternal = 0;
}
//-----------------------------------------------------------------------------
// Print
void FileHelper::Print(std::ostream &os, std::string const &)
{
- HeaderInternal->SetPrintLevel(PrintLevel);
- HeaderInternal->Print(os);
+ FileInternal->SetPrintLevel(PrintLevel);
+ FileInternal->Print(os);
PixelReadConverter->SetPrintLevel(PrintLevel);
PixelReadConverter->Print(os);
return 0;
}
- if ( HeaderInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
+ if ( FileInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
{
return PixelReadConverter->GetRGB();
}
return 0;
}
- if ( HeaderInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
+ if ( FileInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
{
if ( PixelReadConverter->GetRGBSize() > maxSize )
{
* '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
+ * not to deallocate its data before gdcm uses them (e.g. with
* the Write() method.
* @param inData user supplied pixel area
* @param expectedSize total image size, in Bytes
}
/**
- * \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
*/
void FileHelper::SetUserData(uint8_t *data, size_t 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()
{
bool check = CheckWriteIntegrity();
if(check)
{
- check = HeaderInternal->Write(fileName,WriteType);
+ check = FileInternal->Write(fileName,WriteType);
}
RestoreWrite();
// --------------------------------------------------------------
// Special Patch to allow gdcm to re-write ACR-LibIDO formated images
//
- // ...and we restore the Header to be Dicom Compliant again
+ // ...and we restore the header to be Dicom Compliant again
// just after writting
RestoreWriteOfLibido();
// ----------------- End of Special Patch ----------------
* 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 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,
+bool FileHelper::SetValEntry(std::string const &content,
uint16_t group, uint16_t elem)
{
- return HeaderInternal->SetEntry(content,group,elem);
+ return FileInternal->SetValEntry(content,group,elem);
}
* 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 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)
+bool FileHelper::SetBinEntry(uint8_t *content, int lgth,
+ uint16_t group, uint16_t elem)
{
- return HeaderInternal->SetEntry(content,lgth,group,elem);
+ return FileInternal->SetBinEntry(content,lgth,group,elem);
}
/**
- * \brief Modifies the value of a given Doc Entry (Dicom Element)
+ * \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 Header Entry (NULL when creation
+ * \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)
+ValEntry *FileHelper::InsertValEntry(std::string const &content,
+ uint16_t group, uint16_t elem)
{
- return HeaderInternal->ReplaceOrCreate(content,group,elem) != NULL;
+ return FileInternal->InsertValEntry(content,group,elem);
}
/*
- * \brief Modifies the value of a given Header Entry (Dicom Element)
+ * \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 Header Entry (NULL when creation
+ * \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).
*/
-bool FileHelper::ReplaceOrCreate(uint8_t *binArea, int lgth,
- uint16_t group, uint16_t elem)
+SeqEntry *FileHelper::InsertSeqEntry(uint16_t group, uint16_t elem)
{
- return HeaderInternal->ReplaceOrCreate(binArea,lgth,group,elem) != NULL;
+ return FileInternal->InsertSeqEntry(group,elem);
}
/**
* 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()
{
if(PixelWriteConverter->GetUserData())
{
- int numberBitsAllocated = HeaderInternal->GetBitsAllocated();
+ int numberBitsAllocated = FileInternal->GetBitsAllocated();
if ( numberBitsAllocated == 0 || numberBitsAllocated == 12 )
{
numberBitsAllocated = 16;
}
- size_t decSize = HeaderInternal->GetXSize()
- * HeaderInternal->GetYSize()
- * HeaderInternal->GetZSize()
+ size_t decSize = FileInternal->GetXSize()
+ * FileInternal->GetYSize()
+ * FileInternal->GetZSize()
* ( numberBitsAllocated / 8 )
- * HeaderInternal->GetSamplesPerPixel();
+ * FileInternal->GetSamplesPerPixel();
size_t rgbSize = decSize;
- if( HeaderInternal->HasLUT() )
+ if( FileInternal->HasLUT() )
rgbSize = decSize * 3;
switch(WriteMode)
case WMODE_RAW :
if( decSize!=PixelWriteConverter->GetUserDataSize() )
{
- gdcmVerboseMacro( "Data size is incorrect (Raw)" << decSize
- << " / " << PixelWriteConverter->GetUserDataSize() );
+ gdcmVerboseMacro( "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() );
+ gdcmVerboseMacro( "Data size (RGB) is incorrect. Should be "
+ << decSize << " / Found "
+ << PixelWriteConverter->GetUserDataSize() );
return false;
}
break;
*/
void FileHelper::SetWriteToRaw()
{
- if( HeaderInternal->GetNumberOfScalarComponents() == 3
- && !HeaderInternal->HasLUT())
+ if( FileInternal->GetNumberOfScalarComponents() == 3
+ && !FileInternal->HasLUT())
{
SetWriteToRGB();
}
else
{
ValEntry *photInt = CopyValEntry(0x0028,0x0004);
- if(HeaderInternal->HasLUT())
+ if(FileInternal->HasLUT())
{
photInt->SetValue("PALETTE COLOR ");
}
PixelReadConverter->GetRawSize());
BinEntry *pixel =
- CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
+ CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel());
pixel->SetValue(GDCM_BINLOADED);
pixel->SetBinArea(PixelWriteConverter->GetData(),false);
pixel->SetLength(PixelWriteConverter->GetDataSize());
}
}
-
/**
* \brief
*/
void FileHelper::SetWriteToRGB()
{
- if(HeaderInternal->GetNumberOfScalarComponents()==3)
+ if(FileInternal->GetNumberOfScalarComponents()==3)
{
PixelReadConverter->BuildRGBImage();
}
BinEntry *pixel =
- CopyBinEntry(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
+ CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel());
pixel->SetValue(GDCM_BINLOADED);
pixel->SetBinArea(PixelWriteConverter->GetData(),false);
pixel->SetLength(PixelWriteConverter->GetDataSize());
// For old ACR-NEMA
// Thus, we have a RGB image and the bits allocated = 24 and
// samples per pixels = 1 (in the read file)
- if(HeaderInternal->GetBitsAllocated()==24)
+ if(FileInternal->GetBitsAllocated()==24)
{
ValEntry *bitsAlloc = CopyValEntry(0x0028,0x0100);
bitsAlloc->SetValue("8 ");
Archive->Restore(0x0028,0x0002);
Archive->Restore(0x0028,0x0004);
Archive->Restore(0x0028,0x0006);
- Archive->Restore(GetHeader()->GetGrPixel(),GetHeader()->GetNumPixel());
+ Archive->Restore(GetFile()->GetGrPixel(),GetFile()->GetNumPixel());
// For old ACR-NEMA (24 bits problem)
Archive->Restore(0x0028,0x0100);
void FileHelper::SetWriteToLibido()
{
ValEntry *oldRow = dynamic_cast<ValEntry *>
- (HeaderInternal->GetDocEntry(0x0028, 0x0010));
+ (FileInternal->GetDocEntry(0x0028, 0x0010));
ValEntry *oldCol = dynamic_cast<ValEntry *>
- (HeaderInternal->GetDocEntry(0x0028, 0x0011));
+ (FileInternal->GetDocEntry(0x0028, 0x0011));
if( oldRow && oldCol )
{
void FileHelper::SetWriteToNoLibido()
{
ValEntry *recCode = dynamic_cast<ValEntry *>
- (HeaderInternal->GetDocEntry(0x0008,0x0010));
+ (FileInternal->GetDocEntry(0x0008,0x0010));
if( recCode )
{
if( recCode->GetValue() == "ACRNEMA_LIBIDO_1.1" )
ValEntry *FileHelper::CopyValEntry(uint16_t group,uint16_t elem)
{
- DocEntry *oldE = HeaderInternal->GetDocEntry(group, elem);
+ DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
ValEntry *newE;
if(oldE)
}
else
{
- newE = GetHeader()->NewValEntry(group,elem);
+ newE = GetFile()->NewValEntry(group,elem);
}
return 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
*/
BinEntry *FileHelper::CopyBinEntry(uint16_t group,uint16_t elem)
{
- DocEntry *oldE = HeaderInternal->GetDocEntry(group, elem);
+ DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
BinEntry *newE;
if(oldE)
}
else
{
- newE = GetHeader()->NewBinEntry(group,elem);
+ newE = GetFile()->NewBinEntry(group,elem);
}
return newE;
/**
* \brief Factorization for various forms of constructors.
*/
-void FileHelper::Initialise()
+void FileHelper::Initialize()
{
WriteMode = WMODE_RAW;
WriteType = ExplicitVR;
PixelReadConverter = new PixelReadConvert;
PixelWriteConverter = new PixelWriteConvert;
- Archive = new DocEntryArchive( HeaderInternal );
+ Archive = new DocEntryArchive( FileInternal );
- if ( HeaderInternal->IsReadable() )
+ if ( FileInternal->IsReadable() )
{
- PixelReadConverter->GrabInformationsFromHeader( HeaderInternal );
+ PixelReadConverter->GrabInformationsFromFile( FileInternal );
}
}
if ( ! raw )
{
// The Raw image migth not be loaded yet:
- std::ifstream *fp = HeaderInternal->OpenFile();
+ std::ifstream *fp = FileInternal->OpenFile();
PixelReadConverter->ReadAndDecompressPixelData( fp );
if(fp)
- HeaderInternal->CloseFile();
+ FileInternal->CloseFile();
raw = PixelReadConverter->GetRaw();
if ( ! raw )