X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=gdcmPython%2Fgdcm.i;h=3a6dcfd3c8bd6c415d3d65fc6c88a32e58848da8;hb=4a98a8e8b103c5bbe8a3dcacbd78c6e651e0eb1c;hp=82436e9ebe96e57f791b44e3094b75c23c0d24c1;hpb=dc78a7e599ec9f2fcd946c4d740f74da24be6f06;p=gdcm.git diff --git a/gdcmPython/gdcm.i b/gdcmPython/gdcm.i index 82436e9e..3a6dcfd3 100644 --- a/gdcmPython/gdcm.i +++ b/gdcmPython/gdcm.i @@ -1,182 +1,302 @@ %module gdcm +#pragma SWIG nowarn=504 %{ +#include + #include "gdcmCommon.h" -#include "gdcmDictEntry.h" +#include "gdcmBase.h" #include "gdcmDict.h" +#include "gdcmDictEntry.h" #include "gdcmDictSet.h" -#include "gdcmParser.h" -#include "gdcmHeaderEntry.h" -#include "gdcmHeader.h" -#include "gdcmHeaderHelper.h" -#include "gdcmFile.h" -#include "gdcmUtil.h" -#include "gdcmObject.h" #include "gdcmDicomDir.h" #include "gdcmDicomDirElement.h" -#include "gdcmPatient.h" -#include "gdcmStudy.h" -#include "gdcmSerie.h" -#include "gdcmImage.h" - -using namespace std; - -// Utility functions on strings for removing leading and trailing spaces -void EatLeadingAndTrailingSpaces(string & s) { - while ( s.length() && (s[0] == ' ') ) - s.erase(0,1); - while ( s.length() && (s[s.length()-1] == ' ') ) - s.erase(s.length()-1, 1); -} -%} -typedef unsigned short guint16; -typedef unsigned int guint32; +#include "gdcmDicomDirImage.h" +#include "gdcmDicomDirMeta.h" +#include "gdcmDicomDirObject.h" +#include "gdcmDicomDirPatient.h" +#include "gdcmDicomDirStudy.h" +#include "gdcmDicomDirSerie.h" +#include "gdcmDocEntrySet.h" +#include "gdcmDocument.h" +#include "gdcmElementSet.h" +#include "gdcmFileHelper.h" +#include "gdcmGlobal.h" +#include "gdcmFile.h" +#include "gdcmSerieHelper.h" +#include "gdcmRLEFramesInfo.h" +#include "gdcmJPEGFragmentsInfo.h" +#include "gdcmSQItem.h" +#include "gdcmUtil.h" +#include "gdcmDocEntry.h" +#include "gdcmDataEntry.h" +#include "gdcmSeqEntry.h" +#include "gdcmVR.h" +#include "gdcmTS.h" +#include "gdcmDictGroupName.h" //////////////////////////////////////////////////////////////////////////// -// Global variables get exported to cvar in Python -%immutable; -extern gdcmGlobal gdcmGlob; -%mutable; +/// 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; + PyObject *func = (PyObject *)arg; -//////////////////////////////////////////////////////////////////////////// -%typemap(out) std::list * { - PyObject* NewItem = (PyObject*)0; - PyObject* NewList = PyList_New(0); // The result of this typemap - for (list::iterator NewString = ($1)->begin(); - NewString != ($1)->end(); ++NewString) { - NewItem = PyString_FromString(NewString->c_str()); - PyList_Append( NewList, NewItem); - } - $result = NewList; + arglist = Py_BuildValue("()"); + + result = PyEval_CallObject(func, arglist); + Py_DECREF(arglist); + + if (result) + { + Py_XDECREF(result); + } + else + { + if (PyErr_ExceptionMatches(PyExc_KeyboardInterrupt)) + { + std::cerr << "Caught a Ctrl-C within python, exiting program.\n"; + Py_Exit(1); + } + PyErr_Print(); + } } -//////////////////////////////////////////////////////////////////////////// -// Convert a c++ hash table in a python native dictionary -%typemap(out) std::map > * { - PyObject* NewDict = PyDict_New(); // The result of this typemap - PyObject* NewKey = (PyObject*)0; - PyObject* NewVal = (PyObject*)0; - - for (map >::iterator tag = ($1)->begin(); - tag != ($1)->end(); ++tag) { - string first = tag->first; - // Do not publish entries whose keys is made of spaces - if (first.length() == 0) - continue; - NewKey = PyString_FromString(first.c_str()); - PyObject* NewList = PyList_New(0); - for (list::iterator Item = tag->second.begin(); - Item != tag->second.end(); ++Item) { - NewVal = PyString_FromString(Item->c_str()); - PyList_Append( NewList, NewVal); - } - PyDict_SetItem( NewDict, NewKey, NewList); - } - $result = NewDict; +void gdcmPythonVoidFuncArgDelete(void *arg) +{ + PyObject *func = (PyObject *)arg; + if (func) + { + Py_DECREF(func); + } } -//////////////////////////////////////////////////////////////////////////// -// Convert a c++ hash table in a python native dictionary -%typemap(out) TagHeaderEntryHT & { - PyObject* NewDict = PyDict_New(); // The result of this typemap - string RawName; // Element name as gotten from gdcm - PyObject* NewKey = (PyObject*)0; // Associated name as python object - string RawValue; // Element value as gotten from gdcm - PyObject* NewVal = (PyObject*)0; // Associated value as python object - - for (TagHeaderEntryHT::iterator tag = $1->begin(); tag != $1->end(); ++tag) { - - // The element name shall be the key: - RawName = tag->second->GetName(); - // gdcm unrecognized (including not loaded because their size exceeds - // the user specified treshold) elements are exported with their - // TagKey as key. - if (RawName == "Unknown") - RawName = tag->second->GetKey(); - NewKey = PyString_FromString(RawName.c_str()); - - // Element values are striped from leading/trailing spaces - RawValue = tag->second->GetValue(); - EatLeadingAndTrailingSpaces(RawValue); - NewVal = PyString_FromString(RawValue.c_str()); - - PyDict_SetItem( NewDict, NewKey, NewVal); - } - $result = NewDict; +/// This is required in order to avoid %including all the gdcm include files. +using namespace gdcm; +%} + + +/////////////////////// typemap section //////////////////////////////////// + +//////////////////////////////////////////////// +// Redefine all types used +typedef char int8_t; +typedef unsigned char uint8_t; +typedef short int16_t; +typedef unsigned short uint16_t; +typedef int int32_t; +typedef unsigned int uint32_t; +typedef long long int64_t; +typedef unsigned long long uint64_t; + +//////////////////////////////////////////////// +// Convert a DocEntry * to the real derived class +%typemap(out) gdcm::DocEntry * +{ + PyObject *newEntry; + + if($1) + { + if(dynamic_cast($1)) // SeqEntry * + newEntry = SWIG_NewPointerObj($1,SWIGTYPE_p_gdcm__SeqEntry,0); + else if(dynamic_cast($1)) // BinEntry * + newEntry = SWIG_NewPointerObj($1,SWIGTYPE_p_gdcm__BinEntry,0); + else // ValEntry * + newEntry = SWIG_NewPointerObj($1,SWIGTYPE_p_gdcm__ValEntry,0); + } + else + { + newEntry = Py_BuildValue(""); + } + $result = newEntry; } //////////////////////////////////////////////////////////////////////////// -%typemap(out) ListPatient & { - PyObject* NewItem = (PyObject*)0; - $result = PyList_New(0); // The result of this typemap - - for (list::iterator New = ($1)->begin(); - New != ($1)->end(); ++New) { - NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmPatient,1); - PyList_Append($result, NewItem); +// 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) (void(*method)(void *),void *arg,void(*argDelete)(void *)) +{ + if($input!=Py_None) + { + Py_INCREF($input); + $1=gdcmPythonVoidFunc; + $2=$input; + $3=gdcmPythonVoidFuncArgDelete; } -} - -%typemap(out) ListStudy & { - PyObject* NewItem = (PyObject*)0; - $result = PyList_New(0); // The result of this typemap - - for (list::iterator New = ($1)->begin(); - New != ($1)->end(); ++New) { - NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmStudy,1); - PyList_Append($result, NewItem); + else + { + $1=NULL; + $2=NULL; + $3=NULL; } } -%typemap(out) ListSerie & { - PyObject* NewItem = (PyObject*)0; - $result = PyList_New(0); // The result of this typemap +//////////////////// STL string versus Python str //////////////////////// +// Convertion returning a C++ string. +%typemap(out) std::string +{ + $result = PyString_FromString(($1).c_str()); +} - for (list::iterator New = ($1)->begin(); - New != ($1)->end(); ++New) { - NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmSerie,1); - PyList_Append($result, NewItem); - } +%typemap(out) string +{ + $result = PyString_FromString(($1).c_str()); } -%typemap(out) ListImage & { - PyObject* NewItem = (PyObject*)0; - $result = PyList_New(0); // The result of this typemap +%typemap(out) std::string const & +{ + $result = PyString_FromString(($1)->c_str()); +} - for (list::iterator New = ($1)->begin(); - New != ($1)->end(); ++New) { - NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmImage,1); - PyList_Append($result, NewItem); - } +// Convertion of incoming Python str to STL string +%typemap(python, in) const std::string, std::string +{ + $1 = PyString_AsString($input); } -//////////////////////////////////////////////////////////////////////////// +// Same convertion as above but references (since swig converts C++ +// refererences to pointers) +%typemap(python, in) std::string const & +{ + $1 = new std::string( PyString_AsString( $input ) ); +} -//////////////////////////////////////////////////////////////////////////// -// Deals with function returning a C++ string. -%typemap(out) string, std::string { - $result = PyString_FromString(($1).c_str()); +//////////////////// gdcm.TagName versus Python str ////////////////////// +%typemap(out) gdcm::TagName, const gdcm::TagName & +{ + $result = PyString_FromString(($1)->c_str()); } -%typemap(python, in) const std::string, std::string +// Convertion of incoming Python str to STL string +%typemap(python, in) const gdcm::TagName, gdcm::TagName { $1 = PyString_AsString($input); } +// Same convertion as above but references (since swig converts C++ +// refererences to pointers) +%typemap(python, in) gdcm::TagName const & +{ + $1 = new std::string( PyString_AsString( $input ) ); +} + //////////////////////////////////////////////////////////////////////////// +// Because overloading and %rename don't work together (see below Note 1) +// we need to ignore some methods (e.g. the overloaded default constructor). +// The gdcm::File 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::binary_write(std::ostream &,uint32_t const &); +%ignore gdcm::binary_write(std::ostream &,uint16_t const &); + +%ignore gdcm::DicomDir::SetStartMethod(DicomDir::Method *method,void *arg = NULL); +%ignore gdcm::DicomDir::SetProgressMethod(DicomDir::Method *method,void *arg = NULL); +%ignore gdcm::DicomDir::SetEndMethod(DicomDir::Method *method,void *arg = NULL); + +// Ignore all placed in gdcmCommon.h +%ignore GDCM_UNKNOWN; +%ignore GDCM_UNFOUND; +%ignore GDCM_BINLOADED; +%ignore GDCM_NOTLOADED; +%ignore GDCM_UNREAD; +%ignore GDCM_NOTASCII; +%ignore GDCM_PIXELDATA; +%ignore GDCM_LEGACY; +%ignore GDCM_VRUNKNOWN; + +%constant const char *UNKNOWN = "gdcm::Unknown"; +%constant const char *UNFOUND = "gdcm::Unfound"; +%constant const char *BINLOADED = "gdcm::Binary data loaded"; +%constant const char *NOTLOADED = "gdcm::NotLoaded"; +%constant const char *UNREAD = "gdcm::UnRead"; +%constant const char *GDCM_NOTASCII = "gdcm::NotAscii"; +%constant const char *GDCM_PIXELDATA = "gdcm::Pixel Data to be loaded"; +%constant const char *VRUNKNOWN = " "; + +//////////////////////////////////////////////////////////////////////////// +// Warning: Order matters ! %include "gdcmCommon.h" +%include "gdcmBase.h" %include "gdcmDictEntry.h" %include "gdcmDict.h" %include "gdcmDictSet.h" -%include "gdcmParser.h" -%include "gdcmHeaderEntry.h" -%include "gdcmHeader.h" -%include "gdcmHeaderHelper.h" +%include "gdcmDocEntrySet.h" +%include "gdcmElementSet.h" +%include "gdcmSQItem.h" +%include "gdcmDicomDirElement.h" +%include "gdcmDicomDirObject.h" +%include "gdcmDicomDirImage.h" +%include "gdcmDicomDirSerie.h" +%include "gdcmDicomDirStudy.h" +%include "gdcmDicomDirPatient.h" +%include "gdcmDicomDirMeta.h" +%include "gdcmDocument.h" %include "gdcmFile.h" +%include "gdcmSerieHelper.h" +%include "gdcmFileHelper.h" %include "gdcmUtil.h" -%include "gdcmObject.h" +%include "gdcmGlobal.h" %include "gdcmDicomDir.h" -%include "gdcmDicomDirElement.h" -%include "gdcmPatient.h" -%include "gdcmStudy.h" -%include "gdcmSerie.h" -%include "gdcmImage.h" +%include "gdcmDocEntry.h" +%include "gdcmDataEntry.h" +%include "gdcmSeqEntry.h" +%include "gdcmVR.h" +%include "gdcmTS.h" +%include "gdcmDictGroupName.h" + +//////////////////////////////////////////////////////////////////////////// +// Notes on swig and this file gdcm.i: +// +///////////////////////////////////// +// Note 1: swig collision of method overloading and %typemap +// Consider the following junk.i file: +// %module junk +// %{ +// #include +// #include +// void Junk(std::string const & bozo) { std::cout << bozo << std::endl; } +// void Junk() { std::cout << "Renamed Junk()" << std::endl; } +// %} +// +// %typemap(python, in) std::string const & +// { +// $1 = new std::string( PyString_AsString( $input ) ); +// } +// void Junk(); +// void Junk(std::string const & bozo); +// +// that we compile on linux with: +// swig -c++ -python junk.i +// g++ -g -I/usr/include/python2.3/ -o junk_wrap.o -c junk_wrap.cxx +// g++ junk_wrap.o -shared -g -o _junk.so -L/usr/lib/python2.3/config \ +// -lpython2.3 +// and invoque with: +// python -c 'from junk import *; Junk("aaa") ' +// then we get the following unexpected (for novice) python TypeError: +// TypeError: No matching function for overloaded 'Junk' +// +// This happens because the swig generated code (at least for python) does +// the following two stage process: +// 1/ first do a dynamic dispatch ON THE NUMBER OF ARGUMENTS of the overloaded +// Junk function (the same happens with method of course). [Note that the +// dispatch is NOT done on the type of the arguments]. +// 2/ second apply the typemap. +// When the first dynamic dispatch is executed, the swig generated code +// has no knowledge of the typemap, and thus expects a pointer to a std::string +// type i.e. an argument to Junk of the form _p_std__int
. But this +// is not what python handles to Junk ! An invocation of the form 'Junk("aaa")' +// will make Python pass a PyString to swig (and this is precisely why we +// wrote the typemap). And this will fail.... +/////////////////////////////////////