GDCM_NAME_SPACE::FileHelper Class Reference

In addition to Dicom header exploration, this class is designed for accessing the image/volume content. One can also use it to write Dicom/ACR-NEMA/RAW files. More...

#include <gdcmFileHelper.h>

Inheritance diagram for GDCM_NAME_SPACE::FileHelper:

[legend]Collaboration diagram for GDCM_NAME_SPACE::FileHelper:

[legend]List of all members.

Public Types
enum	FileMode { WMODE_RAW, WMODE_RGB }
Public Member Functions
void	Print (std::ostream &os=std::cout, std::string const &indent="")
	Prints the FileInternal + info on PixelReadConvertor.
File *	GetFile ()
	Accessor to File.
void	SetLoadMode (int loadMode)
	Sets the LoadMode of the internal gdcm::File as a boolean string. NO_SEQ, NO_SHADOW, NO_SHADOWSEQ ... (nothing more, right now) WARNING : before using NO_SHADOW, be sure *all* your files contain accurate values in the 0x0000 element (if any) of *each* Shadow Group. The parser will fail if the size is wrong !
void	SetFileName (std::string const &fileName)
	Sets the LoadMode of the internal gdcm::File.
bool	Load ()
	Loader.
void	SetUserFunction (VOID_FUNCTION_PUINT8_PFILE_POINTER userFunc)
	to allow user to modify pixel order (e.g. Mirror, UpsideDown,...)
bool	SetEntryString (std::string const &content, uint16_t group, uint16_t elem)
	Accesses an existing DataEntry through its (group, element) and modifies its content with the given value.
bool	SetEntryBinArea (uint8_t *content, int lgth, uint16_t group, uint16_t elem)
	Accesses an existing DataEntry through its (group, element) and modifies its content with the given value.
DataEntry *	InsertEntryString (std::string const &content, uint16_t group, uint16_t elem, const VRKey &vr)
	Modifies the value of a given DataEntry when it exists. Creates it with the given value when unexistant.
DataEntry *	InsertEntryBinArea (uint8_t *binArea, int lgth, uint16_t group, uint16_t elem, const VRKey &vr)
	Modifies the value of a given DataEntry when it exists. Creates it with the given value when unexistant. A copy of the binArea is made to be kept in the Document.
SeqEntry *	InsertSeqEntry (uint16_t group, uint16_t elem)
	Adds an empty SeqEntry (remove any existing entry with same group,elem).
size_t	GetImageDataSize ()
	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).
size_t	GetImageDataRawSize ()
	Get the size of the image data. 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).
uint8_t *	GetImageData ()
	brings pixels into memory : Allocates necessary memory, Reads the pixels from disk (uncompress if necessary), 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.
uint8_t *	GetImageDataRaw ()
	brings pixels into memory : Allocates necessary memory, Transforms YBR pixels (if any) into RGB pixels Transforms 3 planes R, G, B (if any) into a single RGB Plane Copies the pixel data (image[s]/volume[s]) to newly allocated zone. DOES NOT transform Grey plane + 3 Palettes into a RGB Plane
void	SetImageData (uint8_t *data, size_t expectedSize)
	Points the internal pointer to the callers inData image representation, BUT WITHOUT COPYING THE DATA. 'image' Pixels are presented as C-like 2D arrays : line per line. 'volume'Pixels are presented as C-like 3D arrays : plane per plane.
void	SetUserData (uint8_t *data, size_t expectedSize)
	Set the image data defined by the user.
uint8_t *	GetUserData ()
	Get the image data defined by the user.
size_t	GetUserDataSize ()
	Get the image data size defined by the user.
uint8_t *	GetRGBData ()
	Get the image data from the file. If a LUT is found, the data are expanded to be RGB.
size_t	GetRGBDataSize ()
	Get the image data size from the file. If a LUT is found, the data are expanded to be RGB.
uint8_t *	GetRawData ()
	Get the image data from the file. Even when a LUT is found, the data are not expanded to RGB!
size_t	GetRawDataSize ()
	Get the image data size from the file. Even when a LUT is found, the data are not expanded to RGB!
void	ConvertFixGreyLevels (uint8_t *data, size_t size)
	Deal with Grey levels i.e. re-arange them to have low values = dark, high values = bright.
uint8_t *	GetLutRGBA ()
	Access to the underlying PixelReadConverter RGBA LUT.
int	GetLutItemNumber ()
	Access to the underlying PixelReadConverter RGBA LUT Item Number.
int	GetLutItemSize ()
	Access to the underlying PixelReadConverter RGBA LUT Item Size.
void	SetWriteModeToRaw ()
	Tells the writer we want to keep 'Grey pixels + Palettes color' when possible (as opposed to convert 'Palettes color' to RGB).
void	SetWriteModeToRGB ()
	Tells the writer we want to write RGB image when possible (as opposed to 'Grey pixels + Palettes color').
void	SetWriteMode (FileMode mode)
	Sets the Write Mode ( ).
FileMode	GetWriteMode ()
	Gets the Write Mode ( ).
void	SetWriteTypeToDcmImplVR ()
	Tells the writer we want to write as Implicit VR.
void	SetWriteTypeToDcmExplVR ()
	Tells the writer we want to write as Explicit VR.
void	SetWriteTypeToAcr ()
	Tells the writer we want to write as ACR-NEMA.
void	SetWriteTypeToAcrLibido ()
	Tells the writer we want to write as LibIDO.
void	SetWriteTypeToJPEG ()
	Tells the writer we want to write as JPEG.
void	SetWriteTypeToJPEG2000 ()
	Tells the writer we want to write as JPEG2000.
void	SetWriteType (FileType format)
	Tells the writer which format we want to write (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO).
FileType	GetWriteType ()
	Gets the format we talled the write we wanted to write (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO).
void	SetPhotometricInterpretationToMonochrome1 ()
	1 : white=0, black=high value
void	SetPhotometricInterpretationToMonochrome2 ()
	2 : black=0, white=high value (default)
int	GetPhotometricInterpretation ()
	1 : white=0, black=high value
bool	WriteRawData (std::string const &fileName)
	Writes on disk A SINGLE Dicom file NO test is performed on processor "Endiannity". It's up to the user to call his Reader properly.
bool	WriteDcmImplVR (std::string const &fileName)
	Writes on disk A SINGLE Dicom file, using the Implicit Value Representation convention NO test is performed on processor "Endianity".
bool	WriteDcmExplVR (std::string const &fileName)
	Writes on disk A SINGLE Dicom file, using the Explicit Value Representation convention NO test is performed on processor "Endiannity".
bool	WriteAcr (std::string const &fileName)
	Writes on disk A SINGLE Dicom file, using the ACR-NEMA convention NO test is performed on processor "Endiannity". (a l'attention des logiciels cliniques qui ne prennent en entrée QUE des images ACR ...
bool	Write (std::string const &fileName)
	Writes on disk A SINGLE Dicom file,.
void	SetContentType (ImageContentType c)
	We have to deal with 4 *very* different cases : -1) user created ex nihilo his own image and wants to write it as a Dicom image. USER_OWN_IMAGE -2) user modified the pixels of an existing image. FILTERED_IMAGE -3) user created a new image, using existing images (eg MIP, MPR, cartography image) CREATED_IMAGE -4) user modified/added some tags *without processing* the pixels (anonymization... UNMODIFIED_PIXELS_IMAGE.
void	CallStartMethod ()
	CallStartMethod.
void	CallProgressMethod ()
	CallProgressMethod.
void	CallEndMethod ()
	CallEndMethod.
void	Delete ()
	Delete the object.
void	Register ()
	Register the object.
void	Unregister ()
	Unregister the object.
const unsigned long &	GetRefCount () const
	Get the reference counting.
void	SetPrintLevel (int level)
	Sets the print level for the Dicom Header Elements.
int	GetPrintLevel ()
	Gets the print level for the Dicom Entries.
Static Public Member Functions
static FileHelper *	New ()
	Constructs a FileHelper with a RefCounter.
static FileHelper *	New (File *header)
	Constructs a FileHelper with a RefCounter from a fileHelper.
Protected Member Functions
	FileHelper ()
	Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3 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 ( GetImageDataSize() + GetImageData() methods).
	FileHelper (File *header)
	Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3 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 ( GetImageDataSize() + GetImageData() methods).
	~FileHelper ()
	canonical destructor
bool	CheckWriteIntegrity ()
	Verifies the size of the user given PixelData.
void	SetWriteToRaw ()
	Updates the File to write RAW data (as opposed to RGB data) (modifies, when necessary, photochromatic interpretation, bits allocated, Pixels element VR) WARNING : if SetPhotometricInterpretationToMonochrome1() was called before Pixel Elements if modified :-(.
void	SetWriteToRGB ()
	Updates the File to write RGB data (as opposed to RAW data) (modifies, when necessary, photochromatic interpretation, samples per pixel, Planar configuration, bits allocated, bits stored, high bit -ACR 24 bits- Pixels element VR, pushes out the LUT, ).
void	RestoreWrite ()
	Restore the File write mode.
void	SetWriteFileTypeToACR ()
	Pushes out the whole group 0002 FIXME : better, set a flag to tell the writer not to write it ... FIXME : method should probably have an other name ! SetWriteFileTypeToACR is NOT opposed to SetWriteFileTypeToExplicitVR and SetWriteFileTypeToImplicitVR.
void	SetWriteFileTypeToJPEG ()
	Sets in the File the TransferSyntax to 'JPEG'.
void	SetWriteFileTypeToJPEG2000 ()
	Sets in the File the TransferSyntax to 'JPEG2000'.
void	SetWriteFileTypeToExplicitVR ()
	Sets in the File the TransferSyntax to 'Explicit VR Little Endian".
void	SetWriteFileTypeToImplicitVR ()
	Sets in the File the TransferSyntax to 'Implicit VR Little Endian".
void	RestoreWriteFileType ()
void	SetWriteToLibido ()
	Set the Write not to Libido format.
void	SetWriteToNoLibido ()
	Set the Write not to No Libido format.
void	RestoreWriteOfLibido ()
	Restore the Write format.
DataEntry *	CopyDataEntry (uint16_t group, uint16_t elem, const VRKey &vr=GDCM_VRUNKNOWN)
	Duplicates a DataEntry or creates it.
void	CheckMandatoryElements ()
	This method is called automatically, just before writting in order to produce a 'True Dicom V3' image.
void	CheckMandatoryEntry (uint16_t group, uint16_t elem, std::string value, const VRKey &vr=GDCM_VRUNKNOWN)
void	SetMandatoryEntry (uint16_t group, uint16_t elem, std::string value, const VRKey &vr=GDCM_VRUNKNOWN)
void	CopyMandatoryEntry (uint16_t group, uint16_t elem, std::string value, const VRKey &vr=GDCM_VRUNKNOWN)
void	RestoreWriteMandatory ()
	Restore in the File the initial group 0002.
Protected Attributes
float	Progress
	value of the ??? for any progress bar
bool	Abort
int	PrintLevel
	Amount of printed details for each Dicom Entries : 0 : stands for the least detail level.
Private Member Functions
	gdcmTypeMacro (FileHelper)
void	Initialize ()
	Factorization for various forms of constructors.
uint8_t *	GetRaw ()
	Reads/[decompresses] the pixels, *without* making RGB from Palette Colors.
Private Attributes
File *	FileInternal
	gdcm::File to use to load the file
bool	Parsed
	Whether already parsed or not.
PixelReadConvert *	PixelReadConverter
	Pointer to the PixelReadConverter.
PixelWriteConvert *	PixelWriteConverter
	Pointer to the PixelWriteConverter.
DocEntryArchive *	Archive
	Pointer to the DocEntryArchive (used while writting process).
FileMode	WriteMode
	(WMODE_RAW, WMODE_RGB)
FileType	WriteType
	(ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
VOID_FUNCTION_PUINT8_PFILE_POINTER	UserFunction
	Pointer to a user supplied function to allow modification of pixel order (e.g. : Mirror, UpsideDown, 90°Rotation, ...) use as : void userSuppliedFunction(uint8_t *im, gdcm::File *f) NB : the "uint8_t *" type of first param is just for prototyping. User will Cast it according what he founds with f->GetPixelType() See vtkgdcmSerieViewer for an example.
ImageContentType	ContentType
	only user knows what he did before asking the image to be written he created ex nihilo his own image he just applied a mathematical process on the pixels he created a new image, using existing images (eg MIP, MPR,cartography) he anonymized and image (*no* modif on the pixels)
int	PhotometricInterpretation
	1 : white=0, black=high value 2 : black=0, white=high value (default)

---

Detailed Description

In addition to Dicom header exploration, this class is designed for accessing the image/volume content. One can also use it to write Dicom/ACR-NEMA/RAW files.

Definition at line 44 of file gdcmFileHelper.h.

---

Member Enumeration Documentation

enum GDCM_NAME_SPACE::FileHelper::FileMode

Enumerator: WMODE_RAW  WMODE_RGB  Definition at line 49 of file gdcmFileHelper.h. { WMODE_RAW, WMODE_RGB };

---

Constructor & Destructor Documentation

GDCM_NAME_SPACE::FileHelper::FileHelper (   )  [protected]

Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3 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 ( GetImageDataSize() + GetImageData() methods). 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 one sets an a posteriori shadow dictionary (efficiency can be seen as a side effect). Definition at line 175 of file gdcmFileHelper.cxx. References FileInternal, Initialize(), and GDCM_NAME_SPACE::File::New(). { FileInternal = File::New( ); Initialize(); }

GDCM_NAME_SPACE::FileHelper::FileHelper (  File *  header  )  [protected]

Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3 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 ( GetImageDataSize() + GetImageData() methods). 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 user sets an a posteriori shadow dictionary (efficiency can be seen as a side effect). Parameters: header  already built Header Definition at line 195 of file gdcmFileHelper.cxx. References FileInternal, gdcmAssertMacro, GDCM_NAME_SPACE::PixelReadConvert::GrabInformationsFromFile(), Initialize(), GDCM_NAME_SPACE::File::IsReadable(), PixelReadConverter, and GDCM_NAME_SPACE::RefCounter::Register(). { gdcmAssertMacro(header); FileInternal = header; FileInternal->Register(); Initialize(); if ( FileInternal->IsReadable() ) { PixelReadConverter->GrabInformationsFromFile( FileInternal, this ); } }

GDCM_NAME_SPACE::FileHelper::~FileHelper (   )  [protected]

canonical destructor Note: If the header (gdcm::File) was created by the FileHelper constructor, it is destroyed by the FileHelper Definition at line 213 of file gdcmFileHelper.cxx. References Archive, FileInternal, PixelReadConverter, PixelWriteConverter, and GDCM_NAME_SPACE::RefCounter::Unregister(). { if ( PixelReadConverter ) { delete PixelReadConverter; } if ( PixelWriteConverter ) { delete PixelWriteConverter; } if ( Archive ) { delete Archive; } FileInternal->Unregister(); }

---

Member Function Documentation

void GDCM_NAME_SPACE::FileHelper::CallEndMethod (   )

CallEndMethod. Definition at line 1964 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::CMD_ENDPROGRESS, GDCM_NAME_SPACE::CommandManager::ExecuteCommand(), and Progress. { Progress = 1.0f; CommandManager::ExecuteCommand(this,CMD_ENDPROGRESS); }

void GDCM_NAME_SPACE::FileHelper::CallProgressMethod (   )

CallProgressMethod. Definition at line 1956 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::CMD_PROGRESS, and GDCM_NAME_SPACE::CommandManager::ExecuteCommand(). { CommandManager::ExecuteCommand(this,CMD_PROGRESS); }

void GDCM_NAME_SPACE::FileHelper::CallStartMethod (   )

CallStartMethod. Definition at line 1946 of file gdcmFileHelper.cxx. References Abort, GDCM_NAME_SPACE::CMD_STARTPROGRESS, GDCM_NAME_SPACE::CommandManager::ExecuteCommand(), and Progress. { Progress = 0.0f; Abort = false; CommandManager::ExecuteCommand(this,CMD_STARTPROGRESS); }

void GDCM_NAME_SPACE::FileHelper::CheckMandatoryElements (   )  [protected]

This method is called automatically, just before writting in order to produce a 'True Dicom V3' image. We cannot know *how* the user made the File : (reading an old ACR-NEMA file or a not very clean DICOM file ...) Just before writting : we check the Entries we create the mandatory entries if they are missing we modify the values if necessary we push the sensitive entries to the Archive The writing process will restore the entries as they where before entering FileHelper::CheckMandatoryElements, so the user will always see the entries just as they were before he decided to write. Note: Entries whose type is 1 are mandatory, with a mandatory value Entries whose type is 1c are mandatory-inside-a-Sequence, with a mandatory value Entries whose type is 2 are mandatory, with an optional value Entries whose type is 2c are mandatory-inside-a-Sequence, with an optional value Entries whose type is 3 are optional Todo: warn the user if we had to add some entries : even if a mandatory entry is missing, we add it, with a default value (we don't want to give up the writting process if user forgot to specify Lena's Patient ID, for instance ...) read the whole PS 3.3 Part of DICOM (890 pages) and write a *full* checker (probably one method per Modality ...) Any contribution is welcome. write a user callable full checker, to allow post reading and/or pre writting image consistency check. Todo: : find if there is a rule! Definition at line 1448 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::ACR, GDCM_NAME_SPACE::ACR_LIBIDO, GDCM_NAME_SPACE::SQItem::AddEntry(), GDCM_NAME_SPACE::SeqEntry::AddSQItem(), Archive, CheckMandatoryEntry(), ContentType, CopyDataEntry(), CopyMandatoryEntry(), GDCM_NAME_SPACE::Util::CreateUniqueUID(), GDCM_NAME_SPACE::RefCounter::Delete(), FileInternal, GDCM_NAME_SPACE::FILTERED_IMAGE, gdcmDebugMacro, GDCM_NAME_SPACE::DocEntrySet::GetDataEntry(), GDCM_NAME_SPACE::DocEntrySet::GetEntryString(), GDCM_NAME_SPACE::Util::GetFileMetaInformationVersion(), GDCM_NAME_SPACE::DataEntry::GetString(), GDCM_NAME_SPACE::Util::GetVersion(), GDCM_NAME_SPACE::DataEntry::New(), GDCM_NAME_SPACE::SQItem::New(), GDCM_NAME_SPACE::SeqEntry::New(), GDCM_NAME_SPACE::DocEntryArchive::Push(), GDCM_NAME_SPACE::DataEntry::SetBinArea(), GDCM_NAME_SPACE::DocEntry::SetLength(), GDCM_NAME_SPACE::DataEntry::SetString(), GDCM_NAME_SPACE::UNMODIFIED_PIXELS_IMAGE, GDCM_NAME_SPACE::USER_OWN_IMAGE, and WriteType. Referenced by Write(). { std::string sop = Util::CreateUniqueUID(); // --------------------- For Meta Elements --------------------- // just to remember : 'official' 0002 group if ( WriteType != ACR && WriteType != ACR_LIBIDO ) { // Group 000002 (Meta Elements) already pushed out //0002 0000 UL 1 Meta Group Length //0002 0001 OB 1 File Meta Information Version //0002 0002 UI 1 Media Storage SOP Class UID //0002 0003 UI 1 Media Storage SOP Instance UID //0002 0010 UI 1 Transfer Syntax UID //0002 0012 UI 1 Implementation Class UID //0002 0013 SH 1 Implementation Version Name //0002 0016 AE 1 Source Application Entity Title //0002 0100 UI 1 Private Information Creator //0002 0102 OB 1 Private Information // Push out 'ACR-NEMA-special' entries, if any Archive->Push(0x0008,0x0001); // Length to End Archive->Push(0x0008,0x0010); // Recognition Code Archive->Push(0x0028,0x0005); // Image Dimension // Create them if not found // Always modify the value // Push the entries to the archive. CopyMandatoryEntry(0x0002,0x0000,"0","UL"); DataEntry *e_0002_0001 = CopyDataEntry(0x0002,0x0001, "OB"); e_0002_0001->SetBinArea((uint8_t*)Util::GetFileMetaInformationVersion(), false); e_0002_0001->SetLength(2); Archive->Push(e_0002_0001); e_0002_0001->Delete(); if ( ContentType == FILTERED_IMAGE || ContentType == UNMODIFIED_PIXELS_IMAGE) { // we keep the original 'Media Storage SOP Class UID', we default it if missing CheckMandatoryEntry(0x0002,0x0002,"1.2.840.10008.5.1.4.1.1.7","UI"); } else { // It's *not* an image comming straight from a source. We force // 'Media Storage SOP Class UID' --> [Secondary Capture Image Storage] CopyMandatoryEntry(0x0002,0x0002,"1.2.840.10008.5.1.4.1.1.7","UI"); } // 'Media Storage SOP Instance UID' CopyMandatoryEntry(0x0002,0x0003,sop,"UI"); // 'Implementation Class UID' // FIXME : in all examples we have, 0x0002,0x0012 is not so long : // seems to be Root UID + 4 digits (?) CopyMandatoryEntry(0x0002,0x0012,Util::CreateUniqueUID(),"UI"); // 'Implementation Version Name' std::string version = "GDCM "; version += Util::GetVersion(); CopyMandatoryEntry(0x0002,0x0013,version,"SH"); } // --------------------- For DataSet --------------------- if ( ContentType != USER_OWN_IMAGE) // when it's not a user made image { gdcmDebugMacro( "USER_OWN_IMAGE (1)"); // If 'SOP Class UID' exists ('true DICOM' image) // we create the 'Source Image Sequence' SeqEntry // to hold informations about the Source Image DataEntry *e_0008_0016 = FileInternal->GetDataEntry(0x0008, 0x0016); if ( e_0008_0016 ) { // Create 'Source Image Sequence' SeqEntry // SeqEntry *sis = SeqEntry::New ( // Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x2112) ); SeqEntry *sis = SeqEntry::New (0x0008, 0x2112); SQItem *sqi = SQItem::New(1); // (we assume 'SOP Instance UID' exists too) // create 'Referenced SOP Class UID' // DataEntry *e_0008_1150 = DataEntry::New( // Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x1150) ); DataEntry *e_0008_1150 = DataEntry::New(0x0008, 0x1150, "UI"); e_0008_1150->SetString( e_0008_0016->GetString()); sqi->AddEntry(e_0008_1150); e_0008_1150->Delete(); // create 'Referenced SOP Instance UID' DataEntry *e_0008_0018 = FileInternal->GetDataEntry(0x0008, 0x0018); // DataEntry *e_0008_1155 = DataEntry::New( // Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x1155) ); DataEntry *e_0008_1155 = DataEntry::New(0x0008, 0x1155, "UI"); e_0008_1155->SetString( e_0008_0018->GetString()); sqi->AddEntry(e_0008_1155); e_0008_1155->Delete(); sis->AddSQItem(sqi,1); sqi->Delete(); // temporarily replaces any previous 'Source Image Sequence' Archive->Push(sis); sis->Delete(); // FIXME : is 'Image Type' *really* depending on the presence of 'SOP Class UID'? if ( ContentType == FILTERED_IMAGE) // the user *knows* he just modified the pixels // the image is no longer an 'Original' one CopyMandatoryEntry(0x0008,0x0008,"DERIVED\\PRIMARY","CS"); } } if ( ContentType == FILTERED_IMAGE || ContentType == UNMODIFIED_PIXELS_IMAGE) { // we keep the original 'Media Storage SOP Class UID', we default it if missing (it should be present !) CheckMandatoryEntry(0x0008,0x0016,"1.2.840.10008.5.1.4.1.1.7","UI"); } else { // It's *not* an image comming straight from a source. We force // 'Media Storage SOP Class UID' --> [Secondary Capture Image Storage] CopyMandatoryEntry(0x0008,0x0016,"1.2.840.10008.5.1.4.1.1.7", "UI"); } Archive->Push(0x0028,0x005); // [Image Dimensions (RET) // Push out 'LibIDO-special' entries, if any Archive->Push(0x0028,0x0015); Archive->Push(0x0028,0x0016); Archive->Push(0x0028,0x0017); Archive->Push(0x0028,0x0198); // very old versions Archive->Push(0x0028,0x0199); // Replace deprecated 0028 0012 US Planes // by new 0028 0008 IS Number of Frames DataEntry *e_0028_0012 = FileInternal->GetDataEntry(0x0028, 0x0012); if ( e_0028_0012 ) { CopyMandatoryEntry(0x0028, 0x0008,e_0028_0012->GetString(),"IS"); Archive->Push(0x0028,0x0012); } // Deal with the pb of (Bits Stored = 12) // - we're gonna write the image as Bits Stored = 16 if ( FileInternal->GetEntryString(0x0028,0x0100) == "12") { CopyMandatoryEntry(0x0028,0x0100,"16","US"); } // Check if user wasn't drunk ;-) std::ostringstream s; // check 'Bits Allocated' vs decent values int nbBitsAllocated = FileInternal->GetBitsAllocated(); if ( (nbBitsAllocated == 0 || nbBitsAllocated > 32) || ( nbBitsAllocated > 8 && nbBitsAllocated <16) ) { CopyMandatoryEntry(0x0028,0x0100,"16","US"); gdcmWarningMacro("(0028,0100) changed from " << nbBitsAllocated << " to 16 for consistency purpose"); nbBitsAllocated = 16; } // check 'Bits Stored' vs 'Bits Allocated' int nbBitsStored = FileInternal->GetBitsStored(); if ( nbBitsStored == 0 || nbBitsStored > nbBitsAllocated ) { s.str(""); s << nbBitsAllocated; CopyMandatoryEntry(0x0028,0x0101,s.str(),"US"); gdcmWarningMacro("(0028,0101) changed from " << nbBitsStored << " to " << nbBitsAllocated << " for consistency purpose" ); nbBitsStored = nbBitsAllocated; } // check 'Hight Bit Position' vs 'Bits Allocated' and 'Bits Stored' int highBitPosition = FileInternal->GetHighBitPosition(); if ( highBitPosition == 0 || highBitPosition > nbBitsAllocated-1 || highBitPosition < nbBitsStored-1 ) { s.str(""); s << nbBitsStored - 1; CopyMandatoryEntry(0x0028,0x0102,s.str(),"US"); gdcmWarningMacro("(0028,0102) changed from " << highBitPosition << " to " << nbBitsAllocated-1 << " for consistency purpose"); } // check Pixel Representation (default it as 0 -unsigned-) DataEntry *e_0028_0103 = FileInternal->GetDataEntry(0x0028, 0x0103); if ( !e_0028_0103 ) { gdcmWarningMacro("PixelRepresentation (0028,0103) is supposed to be mandatory"); CopyMandatoryEntry(0x0028, 0x0103,"0","US"); } else { int sign = (int)e_0028_0103->GetValue(0); if (sign !=1 && sign !=0) { gdcmWarningMacro("PixelRepresentation (0028,0103) is supposed to be =1 or =0"); CopyMandatoryEntry(0x0028, 0x0103,"0","US"); } } std::string pixelSpacing = FileInternal->GetEntryString(0x0028,0x0030); if ( pixelSpacing == GDCM_UNFOUND ) { pixelSpacing = "1.0\\1.0"; // if missing, Pixel Spacing forced to "1.0\1.0" CopyMandatoryEntry(0x0028,0x0030,pixelSpacing,"DS"); } // 'Imager Pixel Spacing' : defaulted to 'Pixel Spacing' // --> This one is the *legal* one ! if ( ContentType != USER_OWN_IMAGE) // we write it only when we are *sure* the image comes from // an imager (see also 0008,0x0064) CheckMandatoryEntry(0x0018,0x1164,pixelSpacing,"DS"); /* // See page 73 of ACR-NEMA_300-1988.pdf ! // 0020,0020 : Patient Orientation : Patient direction of the first row and column of the images. The first entry id the direction of the raws, given by the direction of the last pixel in the first row from the first pixel in tha row. the second entry is the direction of the columns, given by the direction of the last pixel in the first column from the first pixel in that column. L : Left, F : Feet, A : Anterior, P : Posterior. Up to 3 letters can be used in combination to indicate oblique planes. //0020,0030 Image Position (RET) x,y,z coordinates im mm of the first pixel in the image // 0020,0035 Image Orientation (RET) Direction cosines of the R axis of the image system with respect to the equipment coordinate axes x,y,z, followed by direction cosines of the C axis of the image system with respect to the same axes //0020,0050 Location An image location reference, standard for the modality (such as CT bed position), used to indicate position. Calculation of position for other purposes is only from (0020,0030) and (0020,0035) */ /* // if imagePositionPatient not found, default it with imagePositionRet, if any // if imageOrientationPatient not found, default it with imageOrientationRet, if any std::string imagePositionRet = FileInternal->GetEntryString(0x0020,0x0030); std::string imageOrientationRet = FileInternal->GetEntryString(0x0020,0x0035); std::string imagePositionPatient = FileInternal->GetEntryString(0x0020,0x0032); std::string imageOrientationPatient = FileInternal->GetEntryString(0x0020,0x0037); if( imagePositionPatient == GDCM_UNFOUND && imageOrientationPatient == GDCM_UNFOUND && imagePositionRet != GDCM_UNFOUND && imageOrientationRet != GDCM_UNFOUND) { CopyMandatoryEntry(0x0020, 0x0032,imagePositionRet,"DS"); Archive->Push(0x0020,0x0030); CopyMandatoryEntry(0x0020, 0x0037,imageOrientationRet,"DS"); Archive->Push(0x0020,0x0035); } */ // Samples Per Pixel (type 1) : default to grayscale CheckMandatoryEntry(0x0028,0x0002,"1","US"); // --- Check UID-related Entries --- // At the end, not to overwrite the original ones, // needed by 'Referenced SOP Instance UID', 'Referenced SOP Class UID' // 'SOP Instance UID' CopyMandatoryEntry(0x0008,0x0018,sop,"UI"); if ( ContentType == USER_OWN_IMAGE) { gdcmDebugMacro( "USER_OWN_IMAGE (2)"); // Conversion Type. // Other possible values are : // See PS 3.3, Page 408 // DV = Digitized Video // DI = Digital Interface // DF = Digitized Film // WSD = Workstation // SD = Scanned Document // SI = Scanned Image // DRW = Drawing // SYN = Synthetic Image CheckMandatoryEntry(0x0008,0x0064,"SYN","CS"); // Why not? } /* if ( ContentType == CREATED_IMAGE) { } */ // ---- The user will never have to take any action on the following ---- // new value for 'SOP Instance UID' //SetMandatoryEntry(0x0008,0x0018,Util::CreateUniqueUID()); // Instance Creation Date const std::string &date = Util::GetCurrentDate(); CopyMandatoryEntry(0x0008,0x0012,date,"DA"); // Instance Creation Time const std::string &time = Util::GetCurrentTime(); CopyMandatoryEntry(0x0008,0x0013,time,"TM"); // Study Date CheckMandatoryEntry(0x0008,0x0020,date,"DA"); // Study Time CheckMandatoryEntry(0x0008,0x0030,time,"TM"); // Accession Number //CopyMandatoryEntry(0x0008,0x0050,""); CheckMandatoryEntry(0x0008,0x0050,"","SH"); // ----- Add Mandatory Entries if missing --- // Entries whose type is 1 are mandatory, with a mandatory value // Entries whose type is 1c are mandatory-inside-a-Sequence, // with a mandatory value // Entries whose type is 2 are mandatory, with an optional value // Entries whose type is 2c are mandatory-inside-a-Sequence, // with an optional value // Entries whose type is 3 are optional // 'Study Instance UID' // Keep the value if exists // The user is allowed to create his own Study, // keeping the same 'Study Instance UID' for various images // The user may add images to a 'Manufacturer Study', // adding new Series to an already existing Study CheckMandatoryEntry(0x0020,0x000d,Util::CreateUniqueUID(),"UI"); // 'Serie Instance UID' // Keep the value if exists // The user is allowed to create his own Series, // keeping the same 'Serie Instance UID' for various images // The user shouldn't add any image to a 'Manufacturer Serie' // but there is no way no to prevent him for doing that CheckMandatoryEntry(0x0020,0x000e,Util::CreateUniqueUID(),"UI"); // Study ID CheckMandatoryEntry(0x0020,0x0010,"","SH"); // Series Number CheckMandatoryEntry(0x0020,0x0011,"","IS"); // Instance Number CheckMandatoryEntry(0x0020,0x0013,"","IS"); // Patient Orientation // Can be computed from (0020|0037) : Image Orientation (Patient) GDCM_NAME_SPACE::Orientation *o = GDCM_NAME_SPACE::Orientation::New(); std::string ori = o->GetOrientation ( FileInternal ); o->Delete(); if (ori != "\\" && ori != GDCM_UNFOUND) CheckMandatoryEntry(0x0020,0x0020,ori,"CS"); else CheckMandatoryEntry(0x0020,0x0020,"","CS"); // Default Patient Position to HFS CheckMandatoryEntry(0x0018,0x5100,"HFS","CS"); // Modality : if missing we set it to 'OTher' CheckMandatoryEntry(0x0008,0x0060,"OT","CS"); // Manufacturer : if missing we set it to 'GDCM Factory' CheckMandatoryEntry(0x0008,0x0070,"GDCM Factory","LO"); // Institution Name : if missing we set it to 'GDCM Hospital' CheckMandatoryEntry(0x0008,0x0080,"GDCM Hospital","LO"); // Patient's Name : if missing, we set it to 'GDCM^Patient' CheckMandatoryEntry(0x0010,0x0010,"GDCM^Patient","PN"); // Patient ID : some clinical softwares *demand* it although it's a 'type 2' entry. CheckMandatoryEntry(0x0010,0x0020,"gdcm ID","LO"); // Patient's Birth Date : 'type 2' entry -> must exist, value not mandatory CheckMandatoryEntry(0x0010,0x0030,"","DA"); // Patient's Sex :'type 2' entry -> must exist, value not mandatory CheckMandatoryEntry(0x0010,0x0040,"","CS"); // Referring Physician's Name :'type 2' entry -> must exist, value not mandatory CheckMandatoryEntry(0x0008,0x0090,"","PN"); /* // Deal with element 0x0000 (group length) of each group. // First stage : get all the different Groups GroupHT grHT; DocEntry *d = FileInternal->GetFirstEntry(); while(d) { grHT[d->GetGroup()] = 0; d=FileInternal->GetNextEntry(); } // Second stage : add the missing ones (if any) for (GroupHT::iterator it = grHT.begin(); it != grHT.end(); ++it) { CheckMandatoryEntry(it->first, 0x0000, "0"); } // Third stage : update all 'zero level' groups length */ if (PhotometricInterpretation == 1) { } }

void GDCM_NAME_SPACE::FileHelper::CheckMandatoryEntry (  uint16_t  group, uint16_t  elem, std::string  value, const VRKey &  vr = GDCM_VRUNKNOWN )  [protected]

Definition at line 1875 of file gdcmFileHelper.cxx. References Archive, GDCM_NAME_SPACE::RefCounter::Delete(), FileInternal, GDCM_NAME_SPACE::DocEntrySet::GetDataEntry(), GDCM_NAME_SPACE::DataEntry::New(), GDCM_NAME_SPACE::DocEntryArchive::Push(), and GDCM_NAME_SPACE::DataEntry::SetString(). Referenced by CheckMandatoryElements(). { DataEntry *entry = FileInternal->GetDataEntry(group,elem); if ( !entry ) { //entry = DataEntry::New(Global::GetDicts()->GetDefaultPubDict()->GetEntry(group,elem)); entry = DataEntry::New(group,elem,vr); entry->SetString(value); Archive->Push(entry); entry->Delete(); } }

bool GDCM_NAME_SPACE::FileHelper::CheckWriteIntegrity (   )  [protected]

Verifies the size of the user given PixelData. Todo: move all those 'protected' methods to 'private' since FileHelper is not derived in anything! Definition at line 851 of file gdcmFileHelper.cxx. References FileInternal, gdcmWarningMacro, GDCM_NAME_SPACE::File::GetBitsAllocated(), GDCM_NAME_SPACE::File::GetSamplesPerPixel(), GDCM_NAME_SPACE::File::GetTSize(), GDCM_NAME_SPACE::PixelWriteConvert::GetUserData(), GDCM_NAME_SPACE::PixelWriteConvert::GetUserDataSize(), GDCM_NAME_SPACE::File::GetXSize(), GDCM_NAME_SPACE::File::GetYSize(), GDCM_NAME_SPACE::File::GetZSize(), GDCM_NAME_SPACE::File::HasLUT(), PixelWriteConverter, WMODE_RAW, WMODE_RGB, and WriteMode. Referenced by Write(). { if ( PixelWriteConverter->GetUserData() ) { int numberBitsAllocated = FileInternal->GetBitsAllocated(); if ( numberBitsAllocated == 0 || numberBitsAllocated == 12 ) { gdcmWarningMacro( "numberBitsAllocated changed from " << numberBitsAllocated << " to 16 " << " for consistency purpose" ); numberBitsAllocated = 16; } size_t decSize = FileInternal->GetXSize() * FileInternal->GetYSize() * FileInternal->GetZSize() * FileInternal->GetTSize() * FileInternal->GetSamplesPerPixel() * ( numberBitsAllocated / 8 ); size_t rgbSize = decSize; if ( FileInternal->HasLUT() ) rgbSize = decSize * 3; switch(WriteMode) { case WMODE_RAW : if ( 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() ) { gdcmWarningMacro( "Data size (RGB) is incorrect. Should be " << decSize << " / Found " << PixelWriteConverter->GetUserDataSize() ); return false; } break; } } return true; }

void GDCM_NAME_SPACE::FileHelper::ConvertFixGreyLevels (  uint8_t *  data, size_t  size )

Deal with Grey levels i.e. re-arange them to have low values = dark, high values = bright. Definition at line 2023 of file gdcmFileHelper.cxx. References FileInternal, GDCM_NAME_SPACE::File::GetBitsAllocated(), GDCM_NAME_SPACE::File::GetBitsStored(), and GDCM_NAME_SPACE::File::IsSignedPixelData(). { uint32_t i; // to please M$VC6 int16_t j; // Number of Bits Allocated for storing a Pixel is defaulted to 16 // when absent from the file. int bitsAllocated = FileInternal->GetBitsAllocated(); if ( bitsAllocated == 0 ) { bitsAllocated = 16; } else if (bitsAllocated > 8 && bitsAllocated < 16 && bitsAllocated != 12) { bitsAllocated = 16; } // Number of "Bits Stored", defaulted to number of "Bits Allocated" // when absent from the file. int bitsStored = FileInternal->GetBitsStored(); if ( bitsStored == 0 ) { bitsStored = bitsAllocated; } if (!FileInternal->IsSignedPixelData()) { if ( bitsAllocated == 8 ) { uint8_t *deb = (uint8_t *)raw; for (i=0; i<rawSize; i++) { *deb = 255 - *deb; deb++; } return; } if ( bitsAllocated == 16 ) { uint16_t mask =1; for (j=0; j<bitsStored-1; j++) { mask = (mask << 1) +1; // will be fff when BitsStored=12 } uint16_t *deb = (uint16_t *)raw; for (i=0; i<rawSize/2; i++) { *deb = mask - *deb; deb++; } return; } } else { if ( bitsAllocated == 8 ) { uint8_t smask8 = 255; uint8_t *deb = (uint8_t *)raw; for (i=0; i<rawSize; i++) { *deb = smask8 - *deb; deb++; } return; } if ( bitsAllocated == 16 ) { uint16_t smask16 = 65535; uint16_t *deb = (uint16_t *)raw; for (i=0; i<rawSize/2; i++) { *deb = smask16 - *deb; deb++; } return; } } }

DataEntry * GDCM_NAME_SPACE::FileHelper::CopyDataEntry (  uint16_t  group, uint16_t  elem, const VRKey &  vr = GDCM_VRUNKNOWN )  [protected]

Duplicates a DataEntry or creates it. Parameters: group  Group number of the Entry elem  Element number of the Entry vr  Value Representation of the Entry Returns: pointer to the new Bin Entry (NULL when creation failed). Definition at line 1252 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::DataEntry::Copy(), FileInternal, GDCM_NAME_SPACE::GDCM_VRUNKNOWN, GDCM_NAME_SPACE::ElementSet::GetDocEntry(), GetFile(), GDCM_NAME_SPACE::DocEntry::GetVR(), GDCM_NAME_SPACE::DataEntry::New(), and GDCM_NAME_SPACE::DocEntrySet::NewDataEntry(). Referenced by CheckMandatoryElements(), CopyMandatoryEntry(), SetWriteFileTypeToExplicitVR(), SetWriteFileTypeToImplicitVR(), SetWriteFileTypeToJPEG(), SetWriteFileTypeToJPEG2000(), SetWriteToLibido(), SetWriteToNoLibido(), and SetWriteToRGB(). { DocEntry *oldE = FileInternal->GetDocEntry(group, elem); DataEntry *newE; if ( oldE && vr != GDCM_VRUNKNOWN ) if ( oldE->GetVR() != vr ) oldE = NULL; if ( oldE ) { newE = DataEntry::New(group, elem, vr); newE->Copy(oldE); } else { newE = GetFile()->NewDataEntry(group, elem, vr); } return newE; }

void GDCM_NAME_SPACE::FileHelper::CopyMandatoryEntry (  uint16_t  group, uint16_t  elem, std::string  value, const VRKey &  vr = GDCM_VRUNKNOWN )  [protected]

Definition at line 1898 of file gdcmFileHelper.cxx. References Archive, CopyDataEntry(), GDCM_NAME_SPACE::RefCounter::Delete(), GDCM_NAME_SPACE::DocEntryArchive::Push(), and GDCM_NAME_SPACE::DataEntry::SetString(). Referenced by CheckMandatoryElements(). { DataEntry *entry = CopyDataEntry(group,elem,vr); entry->SetString(value); Archive->Push(entry); entry->Delete(); }

void GDCM_NAME_SPACE::RefCounter::Delete (   )  [inline, inherited]

Delete the object. Remarks: The object is deleted only if its reference counting is to zero Definition at line 41 of file gdcmRefCounter.h. Referenced by GDCM_NAME_SPACE::SerieHelper::AddFileName(), GDCM_NAME_SPACE::Document::Backtrack(), CheckMandatoryElements(), CheckMandatoryEntry(), CopyMandatoryEntry(), GDCM_NAME_SPACE::Dict::DoTheLoadingJob(), GDCM_NAME_SPACE::FillDefaultDataDict(), GDCM_NAME_SPACE::DicomDirObject::FillObject(), vtkGdcmReader::GetFileInformation(), GDCM_NAME_SPACE::DocEntrySet::InsertEntryBinArea(), GDCM_NAME_SPACE::DocEntrySet::InsertEntryString(), GDCM_NAME_SPACE::DocEntrySet::InsertSeqEntry(), vtkGdcmReader::LoadFileInformation(), GDCM_NAME_SPACE::DicomDir::NewMeta(), GDCM_NAME_SPACE::DicomDirStudy::NewVisit(), GDCM_NAME_SPACE::Document::ReadNextDocEntry(), GDCM_NAME_SPACE::DicomDir::SetElement(), SetMandatoryEntry(), SetWriteFileTypeToExplicitVR(), SetWriteFileTypeToImplicitVR(), SetWriteFileTypeToJPEG(), SetWriteFileTypeToJPEG2000(), SetWriteToLibido(), GDCM_NAME_SPACE::DicomDir::~DicomDir(), GDCM_NAME_SPACE::DictSet::~DictSet(), and GDCM_NAME_SPACE::Global::~Global(). { Unregister(); }

GDCM_NAME_SPACE::FileHelper::gdcmTypeMacro (  FileHelper   )  [private]

File* GDCM_NAME_SPACE::FileHelper::GetFile (   )  [inline]

Accessor to File. Definition at line 63 of file gdcmFileHelper.h. Referenced by CopyDataEntry(), vtkGdcmReader::LoadImageInMemory(), RestoreWrite(), and SetLoadMode(). { return FileInternal; }

uint8_t * GDCM_NAME_SPACE::FileHelper::GetImageData (   )

brings pixels into memory : Allocates necessary memory, Reads the pixels from disk (uncompress if necessary), 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. Returns: Pointer to newly allocated pixel data. (uint8_t is just for prototyping. feel free to cast) NULL if alloc fails Definition at line 393 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelWriteConvert::GetUserData(), and PixelWriteConverter. { if ( PixelWriteConverter->GetUserData() ) { return PixelWriteConverter->GetUserData(); } if ( ! GetRaw() ) { // If the decompression failed nothing can be done. return 0; } if ( FileInternal->HasLUT() && PixelReadConverter->BuildRGBImage() ) { return PixelReadConverter->GetRGB(); } else { // When no LUT or LUT conversion fails, return the Raw return PixelReadConverter->GetRaw(); } }

uint8_t * GDCM_NAME_SPACE::FileHelper::GetImageDataRaw (   )

brings pixels into memory : Allocates necessary memory, Transforms YBR pixels (if any) into RGB pixels Transforms 3 planes R, G, B (if any) into a single RGB Plane Copies the pixel data (image[s]/volume[s]) to newly allocated zone. DOES NOT transform Grey plane + 3 Palettes into a RGB Plane Returns: Pointer to newly allocated pixel data. (uint8_t is just for prototyping. feel free to cast) NULL if alloc fails Definition at line 428 of file gdcmFileHelper.cxx. References GetRaw(). Referenced by vtkGdcmReader::LoadImageInMemory(). { return GetRaw(); }

size_t GDCM_NAME_SPACE::FileHelper::GetImageDataRawSize (   )

Get the size of the image data. 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). Returns: The raw image size Definition at line 372 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelWriteConvert::GetUserData(), GDCM_NAME_SPACE::PixelWriteConvert::GetUserDataSize(), and PixelWriteConverter. { if ( PixelWriteConverter->GetUserData() ) { return PixelWriteConverter->GetUserDataSize(); } return PixelReadConverter->GetRawSize(); }

size_t GDCM_NAME_SPACE::FileHelper::GetImageDataSize (   )

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). Returns: The image size Definition at line 356 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelWriteConvert::GetUserData(), GDCM_NAME_SPACE::PixelWriteConvert::GetUserDataSize(), and PixelWriteConverter. Referenced by vtkGdcmReader::LoadImageInMemory(). { if ( PixelWriteConverter->GetUserData() ) { return PixelWriteConverter->GetUserDataSize(); } return PixelReadConverter->GetRGBSize(); }

int GDCM_NAME_SPACE::FileHelper::GetLutItemNumber (   )

Access to the underlying PixelReadConverter RGBA LUT Item Number. Definition at line 605 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelReadConvert::GetLutItemNumber(), and PixelReadConverter. { return PixelReadConverter->GetLutItemNumber(); }

int GDCM_NAME_SPACE::FileHelper::GetLutItemSize (   )

Access to the underlying PixelReadConverter RGBA LUT Item Size. Definition at line 613 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelReadConvert::GetLutItemSize(), and PixelReadConverter. { return PixelReadConverter->GetLutItemSize(); }

uint8_t * GDCM_NAME_SPACE::FileHelper::GetLutRGBA (   )

Access to the underlying PixelReadConverter RGBA LUT. Definition at line 595 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelReadConvert::BuildLUTRGBA(), GDCM_NAME_SPACE::PixelReadConvert::GetLutRGBA(), and PixelReadConverter. Referenced by vtkGdcmReader::LoadImageInMemory(). { if ( PixelReadConverter->GetLutRGBA() ==0 ) PixelReadConverter->BuildLUTRGBA(); return PixelReadConverter->GetLutRGBA(); }

int GDCM_NAME_SPACE::FileHelper::GetPhotometricInterpretation (   )  [inline]

1 : white=0, black=high value Definition at line 153 of file gdcmFileHelper.h. { return PhotometricInterpretation; }

int GDCM_NAME_SPACE::Base::GetPrintLevel (   )  [inline, inherited]

Gets the print level for the Dicom Entries. Definition at line 50 of file gdcmBase.h. { return PrintLevel; }

uint8_t * GDCM_NAME_SPACE::FileHelper::GetRaw (   )  [private]

Reads/[decompresses] the pixels, *without* making RGB from Palette Colors. Returns: the pixels area, whatever its type (uint8_t is just for prototyping : feel free to Cast it) Definition at line 1996 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::Document::CloseFile(), FileInternal, gdcmWarningMacro, GDCM_NAME_SPACE::PixelReadConvert::GetRaw(), GDCM_NAME_SPACE::Document::OpenFile(), PixelReadConverter, GDCM_NAME_SPACE::PixelReadConvert::ReadAndDecompressPixelData(), GDCM_NAME_SPACE::PixelReadConvert::SetUserFunction(), and UserFunction. Referenced by GetImageDataRaw(). { PixelReadConverter->SetUserFunction( UserFunction ); uint8_t *raw = PixelReadConverter->GetRaw(); if ( ! raw ) { // The Raw image migth not be loaded yet: std::ifstream *fp = FileInternal->OpenFile(); PixelReadConverter->ReadAndDecompressPixelData( fp ); if ( fp ) FileInternal->CloseFile(); raw = PixelReadConverter->GetRaw(); if ( ! raw ) { gdcmWarningMacro( "Read/decompress of pixel data apparently went wrong."); return 0; } } return raw; }

uint8_t * GDCM_NAME_SPACE::FileHelper::GetRawData (   )

Get the image data from the file. Even when a LUT is found, the data are not expanded to RGB! Definition at line 578 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelReadConvert::GetRaw(), and PixelReadConverter. { return PixelReadConverter->GetRaw(); }

size_t GDCM_NAME_SPACE::FileHelper::GetRawDataSize (   )

Get the image data size from the file. Even when a LUT is found, the data are not expanded to RGB! Definition at line 587 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelReadConvert::GetRawSize(), and PixelReadConverter. { return PixelReadConverter->GetRawSize(); }

const unsigned long& GDCM_NAME_SPACE::RefCounter::GetRefCount (   )  const [inline, inherited]

Get the reference counting. Returns: Reference count Definition at line 59 of file gdcmRefCounter.h. { return RefCount; }

uint8_t * GDCM_NAME_SPACE::FileHelper::GetRGBData (   )

Get the image data from the file. If a LUT is found, the data are expanded to be RGB. Definition at line 560 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelReadConvert::GetRGB(), and PixelReadConverter. { return PixelReadConverter->GetRGB(); }

size_t GDCM_NAME_SPACE::FileHelper::GetRGBDataSize (   )

Get the image data size from the file. If a LUT is found, the data are expanded to be RGB. Definition at line 569 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelReadConvert::GetRGBSize(), and PixelReadConverter. { return PixelReadConverter->GetRGBSize(); }

uint8_t * GDCM_NAME_SPACE::FileHelper::GetUserData (   )

Get the image data defined by the user. Warning: When writting the file, this data are get as default data to write Definition at line 542 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelWriteConvert::GetUserData(), and PixelWriteConverter. { return PixelWriteConverter->GetUserData(); }

size_t GDCM_NAME_SPACE::FileHelper::GetUserDataSize (   )

Get the image data size defined by the user. Warning: When writting the file, this data are get as default data to write Definition at line 551 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelWriteConvert::GetUserDataSize(), and PixelWriteConverter. { return PixelWriteConverter->GetUserDataSize(); }

FileMode GDCM_NAME_SPACE::FileHelper::GetWriteMode (   )  [inline]

Gets the Write Mode ( ). Definition at line 124 of file gdcmFileHelper.h. { return WriteMode; }

FileType GDCM_NAME_SPACE::FileHelper::GetWriteType (   )  [inline]

Gets the format we talled the write we wanted to write (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO). Definition at line 145 of file gdcmFileHelper.h. { return WriteType; }

void GDCM_NAME_SPACE::FileHelper::Initialize (   )  [private]

Factorization for various forms of constructors. Definition at line 1975 of file gdcmFileHelper.cxx. References Archive, ContentType, GDCM_NAME_SPACE::ExplicitVR, FileInternal, PhotometricInterpretation, PixelReadConverter, PixelWriteConverter, GDCM_NAME_SPACE::USER_OWN_IMAGE, UserFunction, WMODE_RAW, WriteMode, and WriteType. Referenced by FileHelper(). { UserFunction = 0; ContentType = USER_OWN_IMAGE; WriteMode = WMODE_RAW; WriteType = ExplicitVR; PhotometricInterpretation = 2; // Black = 0 PixelReadConverter = new PixelReadConvert; PixelWriteConverter = new PixelWriteConvert; Archive = new DocEntryArchive( FileInternal ); }

DataEntry * GDCM_NAME_SPACE::FileHelper::InsertEntryBinArea (  uint8_t *  binArea, int  lgth, uint16_t  group, uint16_t  elem, const VRKey &  vr )

Modifies the value of a given DataEntry when it exists. Creates it with the given value when unexistant. A copy of the binArea is made to be kept in the Document. Parameters: binArea  (binary) value to be set lgth  new value length group  Group number of the Entry elem  Element number of the Entry vr  Value Representation of the DataElement to be inserted Returns: pointer to the modified/created DataEntry (NULL when creation failed). Definition at line 328 of file gdcmFileHelper.cxx. References FileInternal, and GDCM_NAME_SPACE::DocEntrySet::InsertEntryBinArea(). { return FileInternal->InsertEntryBinArea(binArea, lgth, group, elem, vr); }

DataEntry * GDCM_NAME_SPACE::FileHelper::InsertEntryString (  std::string const &  content, uint16_t  group, uint16_t  elem, const VRKey &  vr )

Modifies the value of a given DataEntry when it exists. Creates it with the given value when unexistant. Parameters: content  (string) value to be set group  Group number of the Entry elem  Element number of the Entry vr  Value Representation of the DataElement to be inserted Returns: pointer to the modified/created DataEntry (NULL when creation failed). Definition at line 309 of file gdcmFileHelper.cxx. References FileInternal, and GDCM_NAME_SPACE::DocEntrySet::InsertEntryString(). Referenced by SetImageInformation(). { return FileInternal->InsertEntryString(content, group, elem, vr); }

SeqEntry * GDCM_NAME_SPACE::FileHelper::InsertSeqEntry (  uint16_t  group, uint16_t  elem )

Adds an empty SeqEntry (remove any existing entry with same group,elem). Parameters: group  Group number of the Entry elem  Element number of the Entry Returns: pointer to the created SeqEntry (NULL when creation failed). Definition at line 343 of file gdcmFileHelper.cxx. References FileInternal, and GDCM_NAME_SPACE::DocEntrySet::InsertSeqEntry(). { return FileInternal->InsertSeqEntry(group, elem); }

bool GDCM_NAME_SPACE::FileHelper::Load (   )

Loader. Returns: false if file cannot be open or no swap info was found, or no tag was found. Definition at line 260 of file gdcmFileHelper.cxx. References FileInternal, GDCM_NAME_SPACE::PixelReadConvert::GrabInformationsFromFile(), GDCM_NAME_SPACE::File::Load(), and PixelReadConverter. { if ( !FileInternal->Load() ) return false; PixelReadConverter->GrabInformationsFromFile( FileInternal, this ); return true; }

static FileHelper* GDCM_NAME_SPACE::FileHelper::New (  File *  header  )  [inline, static]

Constructs a FileHelper with a RefCounter from a fileHelper. Definition at line 58 of file gdcmFileHelper.h. {return new FileHelper(header);}

static FileHelper* GDCM_NAME_SPACE::FileHelper::New (   )  [inline, static]

Constructs a FileHelper with a RefCounter. Definition at line 56 of file gdcmFileHelper.h. Referenced by vtkGdcmReader::LoadImageInMemory(), and vtkGdcmWriter::WriteDcmFile(). {return new FileHelper();}

void GDCM_NAME_SPACE::FileHelper::Print (  std::ostream &  os = std::cout, std::string const &  indent = "" )  [virtual]

Prints the FileInternal + info on PixelReadConvertor. Parameters: os  ostream we want to print in indent  (unused) Reimplemented from GDCM_NAME_SPACE::Base. Definition at line 2111 of file gdcmFileHelper.cxx. References FileInternal, GDCM_NAME_SPACE::File::IsReadable(), PixelReadConverter, GDCM_NAME_SPACE::PixelReadConvert::Print(), GDCM_NAME_SPACE::ElementSet::Print(), GDCM_NAME_SPACE::Base::PrintLevel, and GDCM_NAME_SPACE::Base::SetPrintLevel(). { FileInternal->SetPrintLevel(PrintLevel); FileInternal->Print(os); if ( FileInternal->IsReadable() ) { PixelReadConverter->SetPrintLevel(PrintLevel); PixelReadConverter->Print(os); } }

void GDCM_NAME_SPACE::RefCounter::Register (   )  [inline, inherited]

Register the object. Remarks: It increments the reference counting Definition at line 46 of file gdcmRefCounter.h. Referenced by GDCM_NAME_SPACE::SQItem::AddEntry(), GDCM_NAME_SPACE::SeqEntry::AddSQItem(), GDCM_NAME_SPACE::SeqEntry::Copy(), GDCM_NAME_SPACE::DicomDir::Copy(), FileHelper(), GDCM_NAME_SPACE::DocEntrySet::GetDictEntry(), GDCM_NAME_SPACE::DocEntry::GetName(), GDCM_NAME_SPACE::DocEntry::GetVM(), GDCM_NAME_SPACE::DocEntrySet::InsertEntryString(), GDCM_NAME_SPACE::CommandManager::InSetCommand(), GDCM_NAME_SPACE::DocEntryArchive::Push(), and GDCM_NAME_SPACE::SeqEntry::SetDelimitationItem(). { RefCount++; }

void GDCM_NAME_SPACE::FileHelper::RestoreWrite (   )  [protected]

Restore the File write mode. Definition at line 1060 of file gdcmFileHelper.cxx. References Archive, GetFile(), and GDCM_NAME_SPACE::DocEntryArchive::Restore(). Referenced by Write(). { Archive->Restore(0x0028,0x0002); Archive->Restore(0x0028,0x0004); Archive->Restore(0x0028,0x0006); Archive->Restore(GetFile()->GetGrPixel(),GetFile()->GetNumPixel()); // For old ACR-NEMA (24 bits problem) Archive->Restore(0x0028,0x0100); Archive->Restore(0x0028,0x0101); Archive->Restore(0x0028,0x0102); // For the LUT Archive->Restore(0x0028,0x1101); Archive->Restore(0x0028,0x1102); Archive->Restore(0x0028,0x1103); Archive->Restore(0x0028,0x1201); Archive->Restore(0x0028,0x1202); Archive->Restore(0x0028,0x1203); // For the Palette Color Lookup Table UID Archive->Restore(0x0028,0x1203); // group 0002 may be pushed out for ACR-NEMA writting purposes Archive->Restore(0x0002,0x0000); Archive->Restore(0x0002,0x0001); Archive->Restore(0x0002,0x0002); Archive->Restore(0x0002,0x0003); Archive->Restore(0x0002,0x0010); Archive->Restore(0x0002,0x0012); Archive->Restore(0x0002,0x0013); Archive->Restore(0x0002,0x0016); Archive->Restore(0x0002,0x0100); Archive->Restore(0x0002,0x0102); }

void GDCM_NAME_SPACE::FileHelper::RestoreWriteFileType (   )  [protected]

void GDCM_NAME_SPACE::FileHelper::RestoreWriteMandatory (   )  [protected]

Restore in the File the initial group 0002. Definition at line 1909 of file gdcmFileHelper.cxx. References Archive, and GDCM_NAME_SPACE::DocEntryArchive::Restore(). { // group 0002 may be pushed out for ACR-NEMA writting purposes Archive->Restore(0x0002,0x0000); Archive->Restore(0x0002,0x0001); Archive->Restore(0x0002,0x0002); Archive->Restore(0x0002,0x0003); Archive->Restore(0x0002,0x0010); Archive->Restore(0x0002,0x0012); Archive->Restore(0x0002,0x0013); Archive->Restore(0x0002,0x0016); Archive->Restore(0x0002,0x0100); Archive->Restore(0x0002,0x0102); // FIXME : Check if none is missing ! Archive->Restore(0x0008,0x0012); Archive->Restore(0x0008,0x0013); Archive->Restore(0x0008,0x0016); Archive->Restore(0x0008,0x0018); Archive->Restore(0x0008,0x0060); Archive->Restore(0x0008,0x0070); Archive->Restore(0x0008,0x0080); Archive->Restore(0x0008,0x0090); Archive->Restore(0x0008,0x2112); Archive->Restore(0x0010,0x0010); Archive->Restore(0x0010,0x0030); Archive->Restore(0x0010,0x0040); Archive->Restore(0x0020,0x000d); Archive->Restore(0x0020,0x000e); }

void GDCM_NAME_SPACE::FileHelper::RestoreWriteOfLibido (   )  [protected]

Restore the Write format. Definition at line 1232 of file gdcmFileHelper.cxx. References Archive, and GDCM_NAME_SPACE::DocEntryArchive::Restore(). Referenced by Write(). { Archive->Restore(0x0028,0x0010); Archive->Restore(0x0028,0x0011); Archive->Restore(0x0008,0x0010); // Restore 'LibIDO-special' entries, if any Archive->Restore(0x0028,0x0015); Archive->Restore(0x0028,0x0016); Archive->Restore(0x0028,0x0017); Archive->Restore(0x0028,0x00199); }

void GDCM_NAME_SPACE::FileHelper::SetContentType (  ImageContentType  c  )  [inline]

We have to deal with 4 *very* different cases : -1) user created ex nihilo his own image and wants to write it as a Dicom image. USER_OWN_IMAGE -2) user modified the pixels of an existing image. FILTERED_IMAGE -3) user created a new image, using existing images (eg MIP, MPR, cartography image) CREATED_IMAGE -4) user modified/added some tags *without processing* the pixels (anonymization... UNMODIFIED_PIXELS_IMAGE. Definition at line 175 of file gdcmFileHelper.h. Referenced by vtkGdcmWriter::WriteDcmFile(). { ContentType = c; }

bool GDCM_NAME_SPACE::FileHelper::SetEntryBinArea (  uint8_t *  content, int  lgth, uint16_t  group, uint16_t  elem )

Accesses an existing DataEntry through its (group, element) and modifies its content with the given value. Parameters: content  new value (void* -> uint8_t*) to substitute with lgth  new value length group  group number of the Dicom Element to modify elem  element number of the Dicom Element to modify Returns: false if DataEntry not found Definition at line 293 of file gdcmFileHelper.cxx. References FileInternal, and GDCM_NAME_SPACE::DocEntrySet::SetEntryBinArea(). { return FileInternal->SetEntryBinArea(content, lgth, group, elem); }

bool GDCM_NAME_SPACE::FileHelper::SetEntryString (  std::string const &  content, uint16_t  group, uint16_t  elem )

Accesses an existing DataEntry through its (group, element) and modifies its content with the given value. Parameters: content  new value (string) to substitute with group  group number of the Dicom Element to modify elem  element number of the Dicom Element to modify Returns: false if DataEntry not found Definition at line 277 of file gdcmFileHelper.cxx. References FileInternal, and GDCM_NAME_SPACE::DocEntrySet::SetEntryString(). { return FileInternal->SetEntryString(content, group, elem); }

void GDCM_NAME_SPACE::FileHelper::SetFileName (  std::string const &  fileName  )

Sets the LoadMode of the internal gdcm::File. Parameters: fileName  name of the file to be open Definition at line 250 of file gdcmFileHelper.cxx. References FileInternal, and GDCM_NAME_SPACE::Document::SetFileName(). { FileInternal->SetFileName( fileName ); }

void GDCM_NAME_SPACE::FileHelper::SetImageData (  uint8_t *  inData, size_t  expectedSize )

Points the internal pointer to the callers inData image representation, BUT WITHOUT COPYING THE DATA. '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 its data before gdcm uses them (e.g. with the Write() method ) Parameters: inData  user supplied pixel area (uint8_t* is just for the compiler. user is allowed to pass any kind of pixels since the size is given in bytes) expectedSize  total image size, *in Bytes* Definition at line 509 of file gdcmFileHelper.cxx. References PixelWriteConverter, and GDCM_NAME_SPACE::PixelWriteConvert::SetUserData(). { PixelWriteConverter->SetUserData(inData, expectedSize); }

void GDCM_NAME_SPACE::FileHelper::SetLoadMode (  int  loadMode  )

Sets the LoadMode of the internal gdcm::File as a boolean string. NO_SEQ, NO_SHADOW, NO_SHADOWSEQ ... (nothing more, right now) WARNING : before using NO_SHADOW, be sure *all* your files contain accurate values in the 0x0000 element (if any) of *each* Shadow Group. The parser will fail if the size is wrong ! Parameters: loadMode  Load mode to be used Definition at line 242 of file gdcmFileHelper.cxx. References GetFile(), and GDCM_NAME_SPACE::Document::SetLoadMode(). { GetFile()->SetLoadMode( loadMode ); }

void GDCM_NAME_SPACE::FileHelper::SetMandatoryEntry (  uint16_t  group, uint16_t  elem, std::string  value, const VRKey &  vr = GDCM_VRUNKNOWN )  [protected]

Todo: : what is it used for ? (FileHelper::SetMandatoryEntry) Definition at line 1889 of file gdcmFileHelper.cxx. References Archive, GDCM_NAME_SPACE::RefCounter::Delete(), GDCM_NAME_SPACE::DataEntry::New(), GDCM_NAME_SPACE::DocEntryArchive::Push(), and GDCM_NAME_SPACE::DataEntry::SetString(). { //DataEntry *entry = DataEntry::New(Global::GetDicts()->GetDefaultPubDict()->GetEntry(group,elem)); DataEntry *entry = DataEntry::New(group,elem,vr); entry->SetString(value); Archive->Push(entry); entry->Delete(); }

void GDCM_NAME_SPACE::FileHelper::SetPhotometricInterpretationToMonochrome1 (   )  [inline]

1 : white=0, black=high value Definition at line 147 of file gdcmFileHelper.h. { PhotometricInterpretation = 1;}

void GDCM_NAME_SPACE::FileHelper::SetPhotometricInterpretationToMonochrome2 (   )  [inline]

2 : black=0, white=high value (default) Definition at line 150 of file gdcmFileHelper.h. { PhotometricInterpretation = 2;}

void GDCM_NAME_SPACE::Base::SetPrintLevel (  int  level  )  [inline, inherited]

Sets the print level for the Dicom Header Elements. Note: 0 for Light Print; 1 for 'medium' Print, 2 for Heavy Print Definition at line 47 of file gdcmBase.h. Referenced by Print(), and GDCM_NAME_SPACE::DicomDir::Print(). { PrintLevel = level; }

void GDCM_NAME_SPACE::FileHelper::SetUserData (  uint8_t *  inData, size_t  expectedSize )

Set the image data defined by the user. Warning: When writting the file, this data are get as default data to write Parameters: inData  user supplied pixel area (uint8_t* is just for the compiler. user is allowed to pass any kind of pixels since the size is given in bytes) expectedSize  total image size, *in Bytes* Definition at line 522 of file gdcmFileHelper.cxx. References FileInternal, GDCM_NAME_SPACE::JPEG, GDCM_NAME_SPACE::JPEG2000, PixelWriteConverter, GDCM_NAME_SPACE::PixelWriteConvert::SetCompressJPEG2000UserData(), GDCM_NAME_SPACE::PixelWriteConvert::SetCompressJPEGUserData(), GDCM_NAME_SPACE::PixelWriteConvert::SetUserData(), and WriteType. { if( WriteType == JPEG2000 ) { PixelWriteConverter->SetCompressJPEG2000UserData(inData, expectedSize, FileInternal); } else if( WriteType == JPEG ) { PixelWriteConverter->SetCompressJPEGUserData(inData, expectedSize, FileInternal); } else { PixelWriteConverter->SetUserData(inData, expectedSize); } }

void GDCM_NAME_SPACE::FileHelper::SetUserFunction (  VOID_FUNCTION_PUINT8_PFILE_POINTER  userFunc  )  [inline]

to allow user to modify pixel order (e.g. Mirror, UpsideDown,...) Definition at line 70 of file gdcmFileHelper.h. Referenced by vtkGdcmReader::LoadImageInMemory(). { UserFunction = userFunc; }

void GDCM_NAME_SPACE::FileHelper::SetWriteFileTypeToACR (   )  [protected]

Pushes out the whole group 0002 FIXME : better, set a flag to tell the writer not to write it ... FIXME : method should probably have an other name ! SetWriteFileTypeToACR is NOT opposed to SetWriteFileTypeToExplicitVR and SetWriteFileTypeToImplicitVR. Definition at line 1105 of file gdcmFileHelper.cxx. References Archive, and GDCM_NAME_SPACE::DocEntryArchive::Push(). Referenced by Write(). { Archive->Push(0x0002,0x0000); Archive->Push(0x0002,0x0001); Archive->Push(0x0002,0x0002); Archive->Push(0x0002,0x0003); Archive->Push(0x0002,0x0010); Archive->Push(0x0002,0x0012); Archive->Push(0x0002,0x0013); Archive->Push(0x0002,0x0016); Archive->Push(0x0002,0x0100); Archive->Push(0x0002,0x0102); }

void GDCM_NAME_SPACE::FileHelper::SetWriteFileTypeToExplicitVR (   )  [protected]

Sets in the File the TransferSyntax to 'Explicit VR Little Endian". Definition at line 1152 of file gdcmFileHelper.cxx. References Archive, CopyDataEntry(), GDCM_NAME_SPACE::RefCounter::Delete(), GDCM_NAME_SPACE::Util::DicomString(), GDCM_NAME_SPACE::TS::ExplicitVRLittleEndian, GDCM_NAME_SPACE::Global::GetTS(), GDCM_NAME_SPACE::DocEntryArchive::Push(), and GDCM_NAME_SPACE::DataEntry::SetString(). Referenced by Write(). { std::string ts = Util::DicomString( Global::GetTS()->GetSpecialTransferSyntax(TS::ExplicitVRLittleEndian) ); DataEntry *tss = CopyDataEntry(0x0002,0x0010,"UI"); tss->SetString(ts); Archive->Push(tss); tss->Delete(); }

void GDCM_NAME_SPACE::FileHelper::SetWriteFileTypeToImplicitVR (   )  [protected]

Sets in the File the TransferSyntax to 'Implicit VR Little Endian". Definition at line 1166 of file gdcmFileHelper.cxx. References Archive, CopyDataEntry(), GDCM_NAME_SPACE::RefCounter::Delete(), GDCM_NAME_SPACE::Util::DicomString(), GDCM_NAME_SPACE::Global::GetTS(), GDCM_NAME_SPACE::TS::ImplicitVRLittleEndian, GDCM_NAME_SPACE::DocEntryArchive::Push(), and GDCM_NAME_SPACE::DataEntry::SetString(). Referenced by Write(). { std::string ts = Util::DicomString( Global::GetTS()->GetSpecialTransferSyntax(TS::ImplicitVRLittleEndian) ); DataEntry *tss = CopyDataEntry(0x0002,0x0010,"UI"); tss->SetString(ts); Archive->Push(tss); tss->Delete(); }

void GDCM_NAME_SPACE::FileHelper::SetWriteFileTypeToJPEG (   )  [protected]

Sets in the File the TransferSyntax to 'JPEG'. Definition at line 1137 of file gdcmFileHelper.cxx. References Archive, CopyDataEntry(), GDCM_NAME_SPACE::RefCounter::Delete(), GDCM_NAME_SPACE::Util::DicomString(), GDCM_NAME_SPACE::Global::GetTS(), GDCM_NAME_SPACE::TS::JPEGLosslessProcess14_1, GDCM_NAME_SPACE::DocEntryArchive::Push(), and GDCM_NAME_SPACE::DataEntry::SetString(). Referenced by Write(). { std::string ts = Util::DicomString( Global::GetTS()->GetSpecialTransferSyntax(TS::JPEGLosslessProcess14_1) ); DataEntry *tss = CopyDataEntry(0x0002,0x0010,"UI"); tss->SetString(ts); Archive->Push(tss); tss->Delete(); }

void GDCM_NAME_SPACE::FileHelper::SetWriteFileTypeToJPEG2000 (   )  [protected]

Sets in the File the TransferSyntax to 'JPEG2000'. Definition at line 1122 of file gdcmFileHelper.cxx. References Archive, CopyDataEntry(), GDCM_NAME_SPACE::RefCounter::Delete(), GDCM_NAME_SPACE::Util::DicomString(), GDCM_NAME_SPACE::Global::GetTS(), GDCM_NAME_SPACE::TS::JPEG2000Lossless, GDCM_NAME_SPACE::DocEntryArchive::Push(), and GDCM_NAME_SPACE::DataEntry::SetString(). Referenced by Write(). { std::string ts = Util::DicomString( Global::GetTS()->GetSpecialTransferSyntax(TS::JPEG2000Lossless) ); DataEntry *tss = CopyDataEntry(0x0002,0x0010,"UI"); tss->SetString(ts); Archive->Push(tss); tss->Delete(); }

void GDCM_NAME_SPACE::FileHelper::SetWriteMode (  FileMode  mode  )  [inline]

Sets the Write Mode ( ). Definition at line 122 of file gdcmFileHelper.h. { WriteMode = mode; }

void GDCM_NAME_SPACE::FileHelper::SetWriteModeToRaw (   )  [inline]

Tells the writer we want to keep 'Grey pixels + Palettes color' when possible (as opposed to convert 'Palettes color' to RGB). Definition at line 117 of file gdcmFileHelper.h. { SetWriteMode(WMODE_RAW); }

void GDCM_NAME_SPACE::FileHelper::SetWriteModeToRGB (   )  [inline]

Tells the writer we want to write RGB image when possible (as opposed to 'Grey pixels + Palettes color'). Definition at line 120 of file gdcmFileHelper.h. { SetWriteMode(WMODE_RGB); }

void GDCM_NAME_SPACE::FileHelper::SetWriteToLibido (   )  [protected]

Set the Write not to Libido format. Definition at line 1180 of file gdcmFileHelper.cxx. References Archive, GDCM_NAME_SPACE::DataEntry::Copy(), CopyDataEntry(), GDCM_NAME_SPACE::RefCounter::Delete(), FileInternal, GDCM_NAME_SPACE::DocEntrySet::GetDataEntry(), GDCM_NAME_SPACE::DataEntry::GetString(), GDCM_NAME_SPACE::DataEntry::New(), GDCM_NAME_SPACE::DocEntryArchive::Push(), and GDCM_NAME_SPACE::DataEntry::SetString(). Referenced by Write(). { DataEntry *oldRow = FileInternal->GetDataEntry(0x0028, 0x0010); DataEntry *oldCol = FileInternal->GetDataEntry(0x0028, 0x0011); if ( oldRow && oldCol ) { std::string rows, columns; DataEntry *newRow=DataEntry::New(0x0028, 0x0010, "US"); DataEntry *newCol=DataEntry::New(0x0028, 0x0011, "US"); newRow->Copy(oldCol); newCol->Copy(oldRow); newRow->SetString(oldCol->GetString()); newCol->SetString(oldRow->GetString()); Archive->Push(newRow); Archive->Push(newCol); newRow->Delete(); newCol->Delete(); } DataEntry *libidoCode = CopyDataEntry(0x0008,0x0010,"LO"); libidoCode->SetString("ACRNEMA_LIBIDO_1.1"); Archive->Push(libidoCode); libidoCode->Delete(); }

void GDCM_NAME_SPACE::FileHelper::SetWriteToNoLibido (   )  [protected]

Set the Write not to No Libido format. Definition at line 1214 of file gdcmFileHelper.cxx. References Archive, CopyDataEntry(), FileInternal, GDCM_NAME_SPACE::DocEntrySet::GetDataEntry(), GDCM_NAME_SPACE::DataEntry::GetString(), GDCM_NAME_SPACE::DocEntryArchive::Push(), and GDCM_NAME_SPACE::DataEntry::SetString(). Referenced by Write(). { DataEntry *recCode = FileInternal->GetDataEntry(0x0008,0x0010); if ( recCode ) { if ( recCode->GetString() == "ACRNEMA_LIBIDO_1.1" ) { DataEntry *libidoCode = CopyDataEntry(0x0008,0x0010,"LO"); libidoCode->SetString(""); Archive->Push(libidoCode); libidoCode->Delete(); } } }

void GDCM_NAME_SPACE::FileHelper::SetWriteToRaw (   )  [protected]

Updates the File to write RAW data (as opposed to RGB data) (modifies, when necessary, photochromatic interpretation, bits allocated, Pixels element VR) WARNING : if SetPhotometricInterpretationToMonochrome1() was called before Pixel Elements if modified :-(. Definition at line 906 of file gdcmFileHelper.cxx. References FileInternal, GDCM_NAME_SPACE::File::GetNumberOfScalarComponents(), GDCM_NAME_SPACE::File::HasLUT(), and SetWriteToRGB(). Referenced by Write(). { if ( FileInternal->GetNumberOfScalarComponents() == 3 && !FileInternal->HasLUT() ) { SetWriteToRGB(); } else { // 0x0028,0x0004 : Photometric Interpretation DataEntry *photInt = CopyDataEntry(0x0028,0x0004,"CS"); if (FileInternal->HasLUT() ) { photInt->SetString("PALETTE COLOR "); } else { if (GetPhotometricInterpretation() == 2) photInt->SetString("MONOCHROME2 "); // 0 = Black else photInt->SetString("MONOCHROME1 "); // 0 = White ! } 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"; // For non RAW data. Mainly JPEG if( WriteType == JPEG || WriteType == JPEG2000) { vr = "OW"; } DataEntry *pixel = CopyDataEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel(),vr); pixel->SetFlag(DataEntry::FLAG_PIXELDATA); pixel->SetBinArea(PixelWriteConverter->GetData(),false); pixel->SetLength( static_cast< uint32_t >(PixelWriteConverter->GetDataSize()) ); if (!FileInternal->HasLUT() && GetPhotometricInterpretation() == 1) { ConvertFixGreyLevels( pixel->GetBinArea(), pixel->GetLength() ); } Archive->Push(photInt); Archive->Push(pixel); photInt->Delete(); pixel->Delete(); } }

void GDCM_NAME_SPACE::FileHelper::SetWriteToRGB (   )  [protected]

Updates the File to write RGB data (as opposed to RAW data) (modifies, when necessary, photochromatic interpretation, samples per pixel, Planar configuration, bits allocated, bits stored, high bit -ACR 24 bits- Pixels element VR, pushes out the LUT, ). Definition at line 970 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::PixelReadConvert::BuildRGBImage(), CopyDataEntry(), FileInternal, GDCM_NAME_SPACE::File::GetNumberOfScalarComponents(), GDCM_NAME_SPACE::PixelReadConvert::GetRGB(), GDCM_NAME_SPACE::PixelReadConvert::GetRGBSize(), PixelReadConverter, PixelWriteConverter, GDCM_NAME_SPACE::PixelWriteConvert::SetReadData(), and GDCM_NAME_SPACE::DataEntry::SetString(). Referenced by SetWriteToRaw(), and Write(). { if ( FileInternal->GetNumberOfScalarComponents()==3 ) { PixelReadConverter->BuildRGBImage(); DataEntry *spp = CopyDataEntry(0x0028,0x0002,"US"); spp->SetString("3 "); DataEntry *planConfig = CopyDataEntry(0x0028,0x0006,"US"); planConfig->SetString("0 "); DataEntry *photInt = CopyDataEntry(0x0028,0x0004,"CS"); photInt->SetString("RGB "); if ( PixelReadConverter->GetRGB() ) { PixelWriteConverter->SetReadData(PixelReadConverter->GetRGB(), PixelReadConverter->GetRGBSize()); } else // Raw data { 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"; DataEntry *pixel = CopyDataEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel(),vr); pixel->SetFlag(DataEntry::FLAG_PIXELDATA); pixel->SetBinArea(PixelWriteConverter->GetData(),false); pixel->SetLength(PixelWriteConverter->GetDataSize()); Archive->Push(spp); Archive->Push(planConfig); Archive->Push(photInt); Archive->Push(pixel); spp->Delete(); planConfig->Delete(); photInt->Delete(); pixel->Delete(); // Remove any LUT Archive->Push(0x0028,0x1101); Archive->Push(0x0028,0x1102); Archive->Push(0x0028,0x1103); Archive->Push(0x0028,0x1201); Archive->Push(0x0028,0x1202); Archive->Push(0x0028,0x1203); // push out Palette Color Lookup Table UID, if any Archive->Push(0x0028,0x1199); // For old '24 Bits' ACR-NEMA // Thus, we have a RGB image and the bits allocated = 24 and // samples per pixels = 1 (in the read file) if ( FileInternal->GetBitsAllocated()==24 ) { DataEntry *bitsAlloc = CopyDataEntry(0x0028,0x0100,"US"); bitsAlloc->SetString("8 "); DataEntry *bitsStored = CopyDataEntry(0x0028,0x0101,"US"); bitsStored->SetString("8 "); DataEntry *highBit = CopyDataEntry(0x0028,0x0102,"US"); highBit->SetString("7 "); Archive->Push(bitsAlloc); Archive->Push(bitsStored); Archive->Push(highBit); bitsAlloc->Delete(); bitsStored->Delete(); highBit->Delete(); } } else { SetWriteToRaw(); } }

void GDCM_NAME_SPACE::FileHelper::SetWriteType (  FileType  format  )  [inline]

Tells the writer which format we want to write (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO). Definition at line 142 of file gdcmFileHelper.h. { WriteType = format; }

void GDCM_NAME_SPACE::FileHelper::SetWriteTypeToAcr (   )  [inline]

Tells the writer we want to write as ACR-NEMA. Definition at line 133 of file gdcmFileHelper.h. References GDCM_NAME_SPACE::ACR. Referenced by WriteAcr(), and vtkGdcmWriter::WriteDcmFile(). { SetWriteType(ACR); }

void GDCM_NAME_SPACE::FileHelper::SetWriteTypeToAcrLibido (   )  [inline]

Tells the writer we want to write as LibIDO. Definition at line 135 of file gdcmFileHelper.h. References GDCM_NAME_SPACE::ACR_LIBIDO. Referenced by vtkGdcmWriter::WriteDcmFile(). { SetWriteType(ACR_LIBIDO); }

void GDCM_NAME_SPACE::FileHelper::SetWriteTypeToDcmExplVR (   )  [inline]

Tells the writer we want to write as Explicit VR. Definition at line 131 of file gdcmFileHelper.h. References GDCM_NAME_SPACE::ExplicitVR. Referenced by WriteDcmExplVR(), and vtkGdcmWriter::WriteDcmFile(). { SetWriteType(ExplicitVR); }

void GDCM_NAME_SPACE::FileHelper::SetWriteTypeToDcmImplVR (   )  [inline]

Tells the writer we want to write as Implicit VR. Definition at line 129 of file gdcmFileHelper.h. References GDCM_NAME_SPACE::ImplicitVR. Referenced by vtkGdcmWriter::WriteDcmFile(), and WriteDcmImplVR(). { SetWriteType(ImplicitVR); }

void GDCM_NAME_SPACE::FileHelper::SetWriteTypeToJPEG (   )  [inline]

Tells the writer we want to write as JPEG. Definition at line 137 of file gdcmFileHelper.h. References GDCM_NAME_SPACE::JPEG. { SetWriteType(JPEG); }

void GDCM_NAME_SPACE::FileHelper::SetWriteTypeToJPEG2000 (   )  [inline]

Tells the writer we want to write as JPEG2000. Definition at line 139 of file gdcmFileHelper.h. References GDCM_NAME_SPACE::JPEG2000. { SetWriteType(JPEG2000); }

void GDCM_NAME_SPACE::RefCounter::Unregister (   )  [inline, inherited]

Unregister the object. Remarks: It decrements the reference counting Definition at line 50 of file gdcmRefCounter.h. Referenced by GDCM_NAME_SPACE::Document::ReadNextDocEntry(), GDCM_NAME_SPACE::SQItem::RemoveEntry(), GDCM_NAME_SPACE::ElementSet::RemoveEntry(), and ~FileHelper(). { //std::cout <<"================Unreg " << typeid(*this).name() << std::endl; RefCount--; if(RefCount<=0) delete this; }

bool GDCM_NAME_SPACE::FileHelper::Write (  std::string const &  fileName  )

Writes on disk A SINGLE Dicom file,. Parameters: fileName  name of the file to be created (any already existing file is overwritten) Returns: false if write fails Todo: FIXME : JPEG may be either ExplicitVR or ImplicitVR Todo: the best trick would be *change* the recognition code but pb expected if user deals with, e.g. COMPLEX images Definition at line 716 of file gdcmFileHelper.cxx. References GDCM_NAME_SPACE::ACR, GDCM_NAME_SPACE::ACR_LIBIDO, CheckMandatoryElements(), CheckWriteIntegrity(), GDCM_NAME_SPACE::ExplicitVR, FileInternal, GDCM_NAME_SPACE::DocEntrySet::GetDataEntry(), GDCM_NAME_SPACE::ImplicitVR, GDCM_NAME_SPACE::DocEntrySet::InsertEntryString(), GDCM_NAME_SPACE::JPEG, GDCM_NAME_SPACE::JPEG2000, RestoreWrite(), RestoreWriteOfLibido(), SetWriteFileTypeToACR(), SetWriteFileTypeToExplicitVR(), SetWriteFileTypeToImplicitVR(), SetWriteFileTypeToJPEG(), SetWriteFileTypeToJPEG2000(), SetWriteToLibido(), SetWriteToNoLibido(), SetWriteToRaw(), SetWriteToRGB(), GDCM_NAME_SPACE::Unknown, WMODE_RAW, WMODE_RGB, GDCM_NAME_SPACE::File::Write(), WriteMode, and WriteType. Referenced by WriteAcr(), WriteDcmExplVR(), vtkGdcmWriter::WriteDcmFile(), and WriteDcmImplVR(). { CheckMandatoryElements(); //called once, here ! bool flag = false; DocEntry *e; switch(WriteType) { case ImplicitVR: SetWriteFileTypeToImplicitVR(); break; case Unknown: // should never happen; ExplicitVR is the default value case ExplicitVR: // User should ask gdcm to write an image in Explicit VR mode // only when he is sure *all* the VR of *all* the DataElements is known. // i.e : when there are *only* Public Groups // or *all* the Shadow Groups are fully described in the relevant Shadow // Dictionnary // Let's just *dream* about it; *never* trust a user ! // We turn to Implicit VR if at least the VR of one element is unknown. // Better we let DocEntry::WriteContent to put vr=UN for undocumented Shadow Groups ! /* e = FileInternal->GetFirstEntry(); while (e != 0) { if (e->GetVR() == " ") { SetWriteTypeToDcmImplVR(); SetWriteFileTypeToImplicitVR(); flag = true; break; } e = FileInternal->GetNextEntry(); } if (!flag) { SetWriteFileTypeToExplicitVR(); } break; */ SetWriteFileTypeToExplicitVR(); break; case ACR: case ACR_LIBIDO: // NOTHING is done here just for LibIDO. // Just to avoid further trouble if user creates a file ex-nihilo, // wants to write it as an ACR-NEMA file, // and forgets to create any Entry belonging to group 0008 // (shame on him !) // We add Recognition Code (RET) if ( ! FileInternal->GetDataEntry(0x0008, 0x0010) ) FileInternal->InsertEntryString("ACR-NEMA V1.0 ", 0x0008, 0x0010, "LO"); SetWriteFileTypeToACR(); // SetWriteFileTypeToImplicitVR(); // ACR IS implicit VR ! break; case JPEG: SetWriteFileTypeToJPEG(); break; case JPEG2000: SetWriteFileTypeToJPEG2000(); break; } // -------------------------------------------------------------- // Special Patch to allow gdcm to re-write ACR-LibIDO formated images // // if recognition code tells us we dealt with a LibIDO image // we reproduce on disk the switch between lineNumber and columnNumber // just before writting ... if ( WriteType == ACR_LIBIDO ) { SetWriteToLibido(); } else { SetWriteToNoLibido(); } // ----------------- End of Special Patch ---------------- switch(WriteMode) { case WMODE_RAW : SetWriteToRaw(); // modifies and pushes to the archive, when necessary break; case WMODE_RGB : SetWriteToRGB(); // modifies and pushes to the archive, when necessary break; } bool check; if (WriteType == JPEG || WriteType == JPEG2000) check = true; else check = CheckWriteIntegrity(); // verifies length if (check) { check = FileInternal->Write(fileName,WriteType); } RestoreWrite(); // RestoreWriteFileType(); // RestoreWriteMandatory(); // -------------------------------------------------------------- // Special Patch to allow gdcm to re-write ACR-LibIDO formated images // // ...and we restore the header to be Dicom Compliant again // just after writting RestoreWriteOfLibido(); // ----------------- End of Special Patch ---------------- return check; }

bool GDCM_NAME_SPACE::FileHelper::WriteAcr (  std::string const &  fileName  )

Writes on disk A SINGLE Dicom file, using the ACR-NEMA convention NO test is performed on processor "Endiannity". (a l'attention des logiciels cliniques qui ne prennent en entrée QUE des images ACR ... Warning: if a DICOM_V3 header is supplied, groups < 0x0008 and shadow groups are ignored NO TEST is performed on processor "Endiannity". Parameters: fileName  name of the file to be created (any already existing file is overwritten) Returns: false if write fails Definition at line 704 of file gdcmFileHelper.cxx. References SetWriteTypeToAcr(), and Write(). { SetWriteTypeToAcr(); return Write(fileName); }

bool GDCM_NAME_SPACE::FileHelper::WriteDcmExplVR (  std::string const &  fileName  )

Writes on disk A SINGLE Dicom file, using the Explicit Value Representation convention NO test is performed on processor "Endiannity". Parameters: fileName  name of the file to be created (any already existing file is overwritten) Returns: false if write fails Definition at line 684 of file gdcmFileHelper.cxx. References SetWriteTypeToDcmExplVR(), and Write(). { SetWriteTypeToDcmExplVR(); return Write(fileName); }

bool GDCM_NAME_SPACE::FileHelper::WriteDcmImplVR (  std::string const &  fileName  )

Writes on disk A SINGLE Dicom file, using the Implicit Value Representation convention NO test is performed on processor "Endianity". Parameters: fileName  name of the file to be created (any already existing file is overwritten) Returns: false if write fails Definition at line 669 of file gdcmFileHelper.cxx. References SetWriteTypeToDcmImplVR(), and Write(). { SetWriteTypeToDcmImplVR(); return Write(fileName); }

bool GDCM_NAME_SPACE::FileHelper::WriteRawData (  std::string const &  fileName  )

Writes on disk A SINGLE Dicom file NO test is performed on processor "Endiannity". It's up to the user to call his Reader properly. Parameters: fileName  name of the file to be created (any already existing file is over written) Returns: false if write fails Definition at line 626 of file gdcmFileHelper.cxx. References gdcmWarningMacro, GDCM_NAME_SPACE::PixelWriteConvert::GetUserData(), GDCM_NAME_SPACE::PixelWriteConvert::GetUserDataSize(), and PixelWriteConverter. { std::ofstream fp1(fileName.c_str(), std::ios::out | std::ios::binary ); if (!fp1) { gdcmWarningMacro( "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()); } else { gdcmErrorMacro( "Nothing written." ); } fp1.close(); return true; }

---

Member Data Documentation

bool GDCM_NAME_SPACE::FileHelper::Abort [mutable, protected]

Definition at line 226 of file gdcmFileHelper.h. Referenced by CallStartMethod().

DocEntryArchive* GDCM_NAME_SPACE::FileHelper::Archive [private]

Pointer to the DocEntryArchive (used while writting process). Definition at line 246 of file gdcmFileHelper.h. Referenced by CheckMandatoryElements(), CheckMandatoryEntry(), CopyMandatoryEntry(), Initialize(), RestoreWrite(), RestoreWriteMandatory(), RestoreWriteOfLibido(), SetMandatoryEntry(), SetWriteFileTypeToACR(), SetWriteFileTypeToExplicitVR(), SetWriteFileTypeToImplicitVR(), SetWriteFileTypeToJPEG(), SetWriteFileTypeToJPEG2000(), SetWriteToLibido(), SetWriteToNoLibido(), and ~FileHelper().

ImageContentType GDCM_NAME_SPACE::FileHelper::ContentType [private]

only user knows what he did before asking the image to be written he created ex nihilo his own image he just applied a mathematical process on the pixels he created a new image, using existing images (eg MIP, MPR,cartography) he anonymized and image (*no* modif on the pixels) Definition at line 268 of file gdcmFileHelper.h. Referenced by CheckMandatoryElements(), and Initialize().

File* GDCM_NAME_SPACE::FileHelper::FileInternal [private]

gdcm::File to use to load the file Definition at line 231 of file gdcmFileHelper.h. Referenced by CheckMandatoryElements(), CheckMandatoryEntry(), CheckWriteIntegrity(), ConvertFixGreyLevels(), CopyDataEntry(), FileHelper(), GetRaw(), Initialize(), InsertEntryBinArea(), InsertEntryString(), InsertSeqEntry(), Load(), Print(), SetEntryBinArea(), SetEntryString(), SetFileName(), SetUserData(), SetWriteToLibido(), SetWriteToNoLibido(), SetWriteToRaw(), SetWriteToRGB(), Write(), and ~FileHelper().

bool GDCM_NAME_SPACE::FileHelper::Parsed [private]

Whether already parsed or not. Definition at line 234 of file gdcmFileHelper.h.

int GDCM_NAME_SPACE::FileHelper::PhotometricInterpretation [private]

1 : white=0, black=high value 2 : black=0, white=high value (default) Definition at line 272 of file gdcmFileHelper.h. Referenced by Initialize().

PixelReadConvert* GDCM_NAME_SPACE::FileHelper::PixelReadConverter [private]

Pointer to the PixelReadConverter. Definition at line 239 of file gdcmFileHelper.h. Referenced by FileHelper(), GetLutItemNumber(), GetLutItemSize(), GetLutRGBA(), GetRaw(), GetRawData(), GetRawDataSize(), GetRGBData(), GetRGBDataSize(), Initialize(), Load(), Print(), SetWriteToRGB(), and ~FileHelper().

PixelWriteConvert* GDCM_NAME_SPACE::FileHelper::PixelWriteConverter [private]

Pointer to the PixelWriteConverter. Definition at line 242 of file gdcmFileHelper.h. Referenced by CheckWriteIntegrity(), GetImageData(), GetImageDataRawSize(), GetImageDataSize(), GetUserData(), GetUserDataSize(), Initialize(), SetImageData(), SetUserData(), SetWriteToRGB(), WriteRawData(), and ~FileHelper().

int GDCM_NAME_SPACE::Base::PrintLevel [protected, inherited]

Amount of printed details for each Dicom Entries : 0 : stands for the least detail level. Definition at line 55 of file gdcmBase.h. Referenced by GDCM_NAME_SPACE::SeqEntry::Print(), Print(), GDCM_NAME_SPACE::ElementSet::Print(), GDCM_NAME_SPACE::DocEntry::Print(), GDCM_NAME_SPACE::DictEntry::Print(), GDCM_NAME_SPACE::DicomDirStudy::Print(), GDCM_NAME_SPACE::DicomDirSerie::Print(), GDCM_NAME_SPACE::DicomDirPatient::Print(), GDCM_NAME_SPACE::DicomDirMeta::Print(), GDCM_NAME_SPACE::DicomDir::Print(), and GDCM_NAME_SPACE::DataEntry::Print().

float GDCM_NAME_SPACE::FileHelper::Progress [protected]

value of the ??? for any progress bar Definition at line 225 of file gdcmFileHelper.h. Referenced by CallEndMethod(), and CallStartMethod().

VOID_FUNCTION_PUINT8_PFILE_POINTER GDCM_NAME_SPACE::FileHelper::UserFunction [private]

Pointer to a user supplied function to allow modification of pixel order (e.g. : Mirror, UpsideDown, 90°Rotation, ...) use as : void userSuppliedFunction(uint8_t *im, gdcm::File *f) NB : the "uint8_t *" type of first param is just for prototyping. User will Cast it according what he founds with f->GetPixelType() See vtkgdcmSerieViewer for an example. Definition at line 261 of file gdcmFileHelper.h. Referenced by GetRaw(), and Initialize().

FileMode GDCM_NAME_SPACE::FileHelper::WriteMode [private]

(WMODE_RAW, WMODE_RGB) Definition at line 250 of file gdcmFileHelper.h. Referenced by CheckWriteIntegrity(), Initialize(), and Write().

FileType GDCM_NAME_SPACE::FileHelper::WriteType [private]

(ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO) Definition at line 253 of file gdcmFileHelper.h. Referenced by CheckMandatoryElements(), Initialize(), SetUserData(), and Write().

---

The documentation for this class was generated from the following files:

• gdcmFileHelper.h
• gdcmFileHelper.cxx

---