--- /dev/null
+### This simple code illustrates how the behavior of the parsing of
+### directory in order to build a DicomDir can be controlled by
+### the caller. By caller control we mean two things:
+### 1/ watch the advancement of the parsing
+### 2/ abort it on caller demand
+### In this example we arbitrarily stop the parsing (see progessMethod() )
+### when the parsing reaches 20% of it's duty. A typical GUI usage of
+### this mecanism would be to offer a "Cancel" button to the user...
+from gdcmPython import *
+import sys
+
+### Get the pathname from command line or default it to .
+try:
+ DirPathName = sys.argv[1]
+except IndexError:
+ DirPathName = "."
+
+### The python defined methods that we wan't to call back
+def startMethod():
+ print "Start"
+def progressMethod():
+ print "Progress", dicomDir.GetProgress()
+ if( dicomDir.GetProgress() > 0.2 ):
+ dicomDir.AbortProgress()
+def endMethod():
+ print "End"
+
+dicomDir=gdcm.DicomDir( DirPathName )
+print dicomDir.IsReadable()
+### Set up the call backs:
+dicomDir.SetStartMethod(startMethod)
+dicomDir.SetProgressMethod(progressMethod)
+dicomDir.SetEndMethod(endMethod)
+### Launch the parsing of the directory
+dicomDir.ParseDirectory()
#include "gdcmValEntry.h"
////////////////////////////////////////////////////////////////////////////
-// Utility functions on strings for removing leading and trailing spaces
-void EatLeadingAndTrailingSpaces(std::string & s) {
- while ( s.length() && (s[0] == ' ') )
- s.erase(0,1);
- while ( s.length() && (s[s.length()-1] == ' ') )
- s.erase(s.length()-1, 1);
-}
-
+/// Refer (below) to the definition of multi-argument typemap
+/// %typemap(python, in)
+/// ( gdcm::DicomDir::Method*, void*, gdcm::DicomDir::Method*)
+/// for detail on gdcmPythonVoidFunc() and gdcmPythonVoidFuncArgDelete().
void gdcmPythonVoidFunc(void *arg)
{
PyObject *arglist, *result;
}
}
+/// This is required in order to avoid %including all the gdcm include files.
using namespace gdcm;
%}
-typedef unsigned short guint16;
-typedef unsigned int guint32;
-////////////////////////////////////////////////////////////////////////////
+
+/////////////////////// typemap section ////////////////////////////////////
+
+////////////////////////////////////////////////
// Convert an STL list<> to a python native list
%typemap(out) std::list<std::string> * {
PyObject* NewItem = (PyObject*)0;
$result = NewList;
}
-////////////////////////////////////////////////////////////////////////////
+//////////////////////////////////////////////////////////////////
// Convert an STL map<> (hash table) to a python native dictionary
%typemap(out) std::map<std::string, std::list<std::string> > * {
PyObject* NewDict = PyDict_New(); // The result of this typemap
$result = NewDict;
}
-////////////////////////////////////////////////////////////////////////////
+/////////////////////////////////////////////////////////
// Convert a c++ hash table in a python native dictionary
%typemap(out) gdcm::TagDocEntryHT & {
PyObject* NewDict = PyDict_New(); // The result of this typemap
}
else
continue;
- EatLeadingAndTrailingSpaces(RawValue);
NewVal = PyString_FromString(RawValue.c_str());
PyDict_SetItem( NewDict, NewKey, NewVal);
}
$result = NewDict;
}
-////////////////////////////////////////////////////////////////////////////
+/////////////////////////////////////
%typemap(out) ListDicomDirPatient & {
PyObject* NewItem = (PyObject*)0;
$result = PyList_New(0); // The result of this typemap
}
////////////////////////////////////////////////////////////////////////////
-// Deals with function returning a C++ string.
-%typemap(python, in) (gdcm::Method *,void * =NULL,gdcm::Method * =NULL) {
+// Multi-argument typemap designed for wrapping the progress related methods
+// in order to control from an external application the computation of
+// a DicomDir object (see DicomDir::SetStartMethod*,
+// DicomDir::SetProgressMethod* and DicomDir::SetEndMethod*).
+// Motivation: since DicomDir parsing can be quite long, a GUI application
+// needs to display the avancement and potentially offer a
+// cancel method to the user (when this one feels things are
+// longer than expected).
+// Example of usage: refer to demo/DicomDirProgressMethod.py
+// Note: Uses gdcmPythonVoidFunc and gdcmPythonVoidFuncArgDelete defined
+// in the Swig verbatim section of this gdcm.i i.e. in the above section
+// enclosed within the %{ ... %} scope operator ).
+%typemap(python, in) ( gdcm::DicomDir::Method *,
+ void * = NULL,
+ gdcm::DicomDir::Method * = NULL )
+{
if($input!=Py_None)
{
Py_INCREF($input);
}
}
-
//////////////////// STL string versus Python str ////////////////////////
// Convertion returning a C++ string.
%typemap(out) string, std::string {
////////////////////////////////////////////////////////////////////////////
// Because overloading and %rename don't work together (see below Note 1)
-// we need to ignore the default constructor.
+// we need to ignore some methods (e.g. the overloaded default constructor).
// The gdcm::Header class doesn't have any SetFilename method anyhow, and
// this constructor is only used internaly (not from the API) so this is
// not a big loss.
%ignore gdcm::Header::Header();
+%ignore gdcm::DicomDir::DicomDir();
////////////////////////////////////////////////////////////////////////////
// Warning: Order matters !
%include "gdcmCommon.h"
-%include "gdcmRLEFramesInfo.h"
-%include "gdcmJPEGFragmentsInfo.h"
-%include "gdcmDictEntry.h"
-%include "gdcmDict.h"
-%include "gdcmDocEntry.h"
+//CLEANME %include "gdcmRLEFramesInfo.h"
+//CLEANME %include "gdcmJPEGFragmentsInfo.h"
+//CLEANME %include "gdcmDictEntry.h"
+//CLEANME %include "gdcmDict.h"
+//CLEANME %include "gdcmDocEntry.h"
%include "gdcmDocEntrySet.h"
-%include "gdcmElementSet.h"
-%include "gdcmDictSet.h"
-%include "gdcmTS.h"
-%include "gdcmVR.h"
-%include "gdcmSQItem.h"
+//CLEANME %include "gdcmElementSet.h"
+//CLEANME %include "gdcmDictSet.h"
+//CLEANME %include "gdcmTS.h"
+//CLEANME %include "gdcmVR.h"
+//CLEANME %include "gdcmSQItem.h"
%include "gdcmDicomDirElement.h"
%include "gdcmDicomDirObject.h"
%include "gdcmDicomDirImage.h"
// {
// $1 = new std::string( PyString_AsString( $input ) );
// }
-// add a note on the rename that works !
// void Junk();
// void Junk(std::string const & bozo);
//
Program: gdcm
Module: $RCSfile: gdcmDicomDir.h,v $
Language: C++
- Date: $Date: 2004/11/02 03:10:32 $
- Version: $Revision: 1.36 $
+ Date: $Date: 2004/11/09 10:25:27 $
+ Version: $Revision: 1.37 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
typedef std::list<DicomDirPatient*> ListDicomDirPatient;
typedef std::vector<Document*> VectDocument;
-typedef GDCM_EXPORT void(Method)(void*);
//-----------------------------------------------------------------------------
/**
class GDCM_EXPORT DicomDir: public Document
{
public:
+ typedef GDCM_EXPORT void(Method)(void*);
DicomDir( std::string const & filename, bool parseDir = false );
DicomDir();
/// Parsing
void ParseDirectory();
- void SetStartMethod(Method*, void* = NULL, Method* = NULL);
- void SetStartMethodArgDelete(Method*);
- void SetProgressMethod(Method* ,void* = NULL, Method* = NULL);
- void SetProgressMethodArgDelete(Method*);
- void SetEndMethod(Method*, void* = NULL,Method* = NULL);
- void SetEndMethodArgDelete(Method*);
+ void SetStartMethod( DicomDir::Method*,
+ void* = NULL,
+ DicomDir::Method* = NULL );
+ void SetProgressMethod( DicomDir::Method*,
+ void* = NULL,
+ DicomDir::Method* = NULL );
+ void SetEndMethod( DicomDir::Method*,
+ void* = NULL,
+ DicomDir::Method* = NULL );
+ void SetStartMethodArgDelete( DicomDir::Method* );
+ void SetProgressMethodArgDelete( DicomDir::Method* );
+ void SetEndMethodArgDelete( DicomDir::Method* );
/// GetProgress GetProgress
float GetProgress() { return Progress; };