Program: gdcm
Module: $RCSfile: gdcmFileHelper.h,v $
Language: C++
- Date: $Date: 2005/10/25 12:43:25 $
- Version: $Revision: 1.28 $
+ Date: $Date: 2006/03/01 15:32:52 $
+ Version: $Revision: 1.40 $
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"
namespace gdcm
* 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
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();
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;
/// 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