Program: gdcm
Module: $RCSfile: gdcmFileHelper.h,v $
Language: C++
- Date: $Date: 2005/10/18 19:54:27 $
- Version: $Revision: 1.26 $
+ Date: $Date: 2006/04/11 16:03:26 $
+ Version: $Revision: 1.42 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#define GDCMFILEHELPER_H
#include "gdcmDebug.h"
-#include "gdcmBase.h"
-
+#include "gdcmRefCounter.h"
+#include "gdcmVRKey.h"
+#include "gdcmFile.h"
namespace gdcm
{
-class File;
+//class File;
class DataEntry;
class SeqEntry;
class PixelReadConvert;
* for accessing the image/volume content. One can also use it to
* write Dicom/ACR-NEMA/RAW files.
*/
-class GDCM_EXPORT FileHelper : public Base
+class GDCM_EXPORT FileHelper : public RefCounter
{
+ gdcmTypeMacro(FileHelper);
+
public:
enum FileMode
{
WMODE_RAW,
WMODE_RGB
};
-
-public:
- FileHelper( );
- FileHelper( File *header );
- GDCM_LEGACY(FileHelper( std::string const &filename ));
-
- virtual ~FileHelper();
+/// \brief Constructs a FileHelper with a RefCounter
+ static FileHelper *New() {return new FileHelper();}
+/// \brief Constructs a FileHelper with a RefCounter from a fileHelper
+ static FileHelper *New(File *header) {return new FileHelper(header);}
+
void Print(std::ostream &os = std::cout, std::string const &indent = "");
/// Accessor to \ref File
void SetLoadMode(int loadMode);
void SetFileName(std::string const &fileName);
bool Load();
- /// to allow user to modify pixel order (e.g. Mirror, TopDown,...)
+ /// to allow user to modify pixel order (e.g. Mirror, UpsideDown,...)
void SetUserFunction( VOID_FUNCTION_PUINT8_PFILE_POINTER userFunc )
{ UserFunction = userFunc; }
// File methods
/// (as opposed to 'Grey pixels + Palettes color')
void SetWriteModeToRGB() { SetWriteMode(WMODE_RGB); }
/// \brief Sets the Write Mode ( )
- void SetWriteMode(FileMode mode) { WriteMode = mode; }
+ void SetWriteMode(FileMode mode) {
+ WriteMode = mode;
+ // Deal with Samples per Pixel
+ //if (mode == WMODE_RGB) FileInternal->InsertEntryString("3",0x0028,0x0002);
+ }
/// \brief Gets the Write Mode ( )
FileMode GetWriteMode() { return WriteMode; }
void SetWriteTypeToAcr() { SetWriteType(ACR); }
/// \brief Tells the writer we want to write as LibIDO
void SetWriteTypeToAcrLibido() { SetWriteType(ACR_LIBIDO); }
- void SetWriteTypeToJPEG() { SetWriteType(JPEG); }
+ /// \brief Tells the writer we want to write as JPEG
+ void SetWriteTypeToJPEG() { SetWriteType(JPEG); }
/// \brief Tells the writer which format we want to write
/// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
void SetWriteType(FileType format) { WriteType = format; }
/// \brief Gets the format we talled the write we wanted to write
- /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
+ /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
FileType GetWriteType() { return WriteType; }
// Write pixels of ONE image on hard drive
bool WriteDcmExplVR(std::string const &fileName);
bool WriteAcr (std::string const &fileName);
bool Write (std::string const &fileName);
-
+
+/// \brief 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 SetContentType (ImageContentType c) { ContentType = c; }
+ // no GetContentType() method, on purpose!
+
+ void CallStartMethod();
+ void CallProgressMethod();
+ void CallEndMethod();
+
protected:
+ FileHelper( );
+ FileHelper( File *header );
+ ~FileHelper();
+
bool CheckWriteIntegrity();
void SetWriteToRaw();
void RestoreWriteOfLibido();
DataEntry *CopyDataEntry(uint16_t group, uint16_t elem,
- const TagName &vr = GDCM_VRUNKNOWN);
+ const VRKey &vr = GDCM_VRUNKNOWN);
void CheckMandatoryElements();
- void CheckMandatoryEntry(uint16_t group,uint16_t elem,std::string value);
- void SetMandatoryEntry(uint16_t group,uint16_t elem,std::string value);
- void CopyMandatoryEntry(uint16_t group,uint16_t elem,std::string value);
+ 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();
private:
uint8_t *GetRaw();
// members variables:
+protected:
+ /// value of the ??? for any progress bar
+ float Progress;
+ mutable bool Abort;
+
+private:
+
/// gdcm::File to use to load the file
File *FileInternal;
- /// \brief Whether the underlying \ref gdcm::File was loaded by
- /// the constructor or passed to the constructor.
- /// When false the destructor is in charge of deletion.
- bool SelfHeader;
-
/// Whether already parsed or not
bool Parsed;
// Write variables
/// \brief (WMODE_RAW, WMODE_RGB)
FileMode WriteMode;
+
/// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
FileType WriteType;
- /// Pointer to a user supplied function to allow modification of pixel order
- /// (i.e. : Mirror, TopDown, 90°Rotation, ...)
+
+ /// \brief 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
VOID_FUNCTION_PUINT8_PFILE_POINTER UserFunction;
+
+ /// \brief 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)
+ ImageContentType ContentType;
+
};
} // end namespace gdcm
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff