X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=gdcmPython%2Fgdcm.i;h=2d3c5ad64e9d5a13c1c255949d7017b85ee0ab41;hb=d6e77ac1b3e594f70ce73df711ad6ec6969f6791;hp=169eff54b565690d241c5278621e7e9ff8f5af65;hpb=e1830579102f036e9e558320a21990a9438ec9ef;p=gdcm.git diff --git a/gdcmPython/gdcm.i b/gdcmPython/gdcm.i index 169eff54..2d3c5ad6 100644 --- a/gdcmPython/gdcm.i +++ b/gdcmPython/gdcm.i @@ -1,6 +1,7 @@ %module gdcm %{ #include "gdcmCommon.h" +#include "gdcmBase.h" #include "gdcmDict.h" #include "gdcmDictEntry.h" #include "gdcmDictSet.h" @@ -15,86 +16,111 @@ #include "gdcmDocEntrySet.h" #include "gdcmDocument.h" #include "gdcmElementSet.h" -#include "gdcmFile.h" +#include "gdcmFileHelper.h" #include "gdcmGlobal.h" #include "gdcmHeader.h" -#include "gdcmHeaderHelper.h" +#include "gdcmSerieHeader.h" #include "gdcmRLEFramesInfo.h" #include "gdcmJPEGFragmentsInfo.h" #include "gdcmSQItem.h" #include "gdcmUtil.h" +#include "gdcmDocEntry.h" #include "gdcmValEntry.h" +#include "gdcmBinEntry.h" +#include "gdcmSeqEntry.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; - PyObject *func = (PyObject *)arg; + PyObject *arglist, *result; + PyObject *func = (PyObject *)arg; - arglist = Py_BuildValue("()"); + arglist = Py_BuildValue("()"); - result = PyEval_CallObject(func, arglist); - Py_DECREF(arglist); + result = PyEval_CallObject(func, arglist); + Py_DECREF(arglist); - if (result) - { - Py_XDECREF(result); - } - else - { - if (PyErr_ExceptionMatches(PyExc_KeyboardInterrupt)) + 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); + std::cerr << "Caught a Ctrl-C within python, exiting program.\n"; + Py_Exit(1); } - PyErr_Print(); - } + PyErr_Print(); + } } void gdcmPythonVoidFuncArgDelete(void *arg) { - PyObject *func = (PyObject *)arg; - if (func) - { - Py_DECREF(func); - } + PyObject *func = (PyObject *)arg; + if (func) + { + Py_DECREF(func); + } } +/// 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 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; +} + +//////////////////////////////////////////////// // Convert an STL list<> to a python native list -%typemap(out) std::list * { - PyObject* NewItem = (PyObject*)0; - PyObject* NewList = PyList_New(0); // The result of this typemap +%typemap(out) std::list * +{ + PyObject *newItem = (PyObject *)0; + PyObject *newList = PyList_New(0); // The result of this typemap - for (std::list::iterator NewString = ($1)->begin(); - NewString != ($1)->end(); - ++NewString) + for (std::list::iterator strIt = ($1)->begin(); + strIt != ($1)->end(); + ++strIt) { - NewItem = PyString_FromString(NewString->c_str()); - PyList_Append( NewList, NewItem); + newItem = PyString_FromString(strIt->c_str()); + PyList_Append( newList, newItem); } - $result = NewList; + $result = newList; } -//////////////////////////////////////////////////////////////////////////// +////////////////////////////////////////////////////////////////// // Convert an STL map<> (hash table) to 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; +%typemap(out) std::map > * +{ + PyObject *newDict = PyDict_New(); // The result of this typemap + PyObject *newKey = (PyObject *)0; + PyObject *newVal = (PyObject *)0; for (std::map >::iterator tag = ($1)->begin(); @@ -104,103 +130,126 @@ typedef unsigned int guint32; // 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 (std::list::iterator Item = tag->second.begin(); - Item != tag->second.end(); - ++Item) + newKey = PyString_FromString(first.c_str()); + + PyObject *newList = PyList_New(0); + for (std::list::iterator itemIt = tag->second.begin(); + itemIt != tag->second.end(); + ++itemIt) { - NewVal = PyString_FromString(Item->c_str()); - PyList_Append( NewList, NewVal); + newVal = PyString_FromString(itemIt->c_str()); + PyList_Append( newList, newVal); } - PyDict_SetItem( NewDict, NewKey, NewList); + PyDict_SetItem( newDict, newKey, newList); } - $result = NewDict; + $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 - std::string RawName; // Element name as gotten from gdcm - PyObject* NewKey = (PyObject*)0; // Associated name as python object - std::string RawValue; // Element value as gotten from gdcm - PyObject* NewVal = (PyObject*)0; // Associated value as python object +%typemap(out) gdcm::TagDocEntryHT & +{ + PyObject *newDict = PyDict_New(); // The result of this typemap + std::string rawName; // Element name as gotten from gdcm + PyObject *newKey = (PyObject *)0; // Associated name as python object + std::string rawValue; // Element value as gotten from gdcm + PyObject *newVal = (PyObject *)0; // Associated value as python object for (gdcm::TagDocEntryHT::iterator tag = $1->begin(); tag != $1->end(); ++tag) { // The element name shall be the key: - RawName = tag->second->GetName(); + 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()); + if (rawName == "Unknown") + rawName = tag->second->GetKey(); + newKey = PyString_FromString(rawName.c_str()); // Element values are striped from leading/trailing spaces - if (gdcm::ValEntry* ValEntryPtr = - dynamic_cast< gdcm::ValEntry* >(tag->second) ) + gdcm::ValEntry *valEntryPtr = dynamic_cast< gdcm::ValEntry* >(tag->second); + if ( valEntryPtr ) { - RawValue = ValEntryPtr->GetValue(); + rawValue = valEntryPtr->GetValue(); } else continue; - EatLeadingAndTrailingSpaces(RawValue); - NewVal = PyString_FromString(RawValue.c_str()); - PyDict_SetItem( NewDict, NewKey, NewVal); + newVal = PyString_FromString(rawValue.c_str()); + PyDict_SetItem( newDict, newKey, newVal); } - $result = NewDict; + $result = newDict; } -//////////////////////////////////////////////////////////////////////////// -%typemap(out) ListDicomDirPatient & { - PyObject* NewItem = (PyObject*)0; +///////////////////////////////////// +%typemap(out) ListDicomDirPatient & +{ + PyObject *newItem = (PyObject *)0; $result = PyList_New(0); // The result of this typemap - for (std::list::iterator New = ($1)->begin(); - New != ($1)->end(); ++New) { - NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_DicomDirPatient,1); - PyList_Append($result, NewItem); + for (std::list::iterator newIt = ($1)->begin(); + newIt != ($1)->end(); ++newIt) + { + newItem = SWIG_NewPointerObj(*newIt,SWIGTYPE_p_DicomDirPatient,0); + PyList_Append($result, newItem); } } -%typemap(out) ListDicomDirStudy & { - PyObject* NewItem = (PyObject*)0; +%typemap(out) ListDicomDirStudy & +{ + PyObject *newItem = (PyObject *)0; $result = PyList_New(0); // The result of this typemap - for (std::list::iterator New = ($1)->begin(); - New != ($1)->end(); ++New) { - NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_DicomDirStudy,1); - PyList_Append($result, NewItem); + for (std::list::iterator newIt = ($1)->begin(); + newIt != ($1)->end(); ++newIt) + { + newItem = SWIG_NewPointerObj(*newIt,SWIGTYPE_p_DicomDirStudy,0); + PyList_Append($result, newItem); } } -%typemap(out) ListDicomDirSerie & { - PyObject* NewItem = (PyObject*)0; +%typemap(out) ListDicomDirSerie & +{ + PyObject* newItem = (PyObject*)0; $result = PyList_New(0); // The result of this typemap - for (std::list::iterator New = ($1)->begin(); - New != ($1)->end(); ++New) { - NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_DicomDirSerie,1); - PyList_Append($result, NewItem); + for (std::list::iterator newIt = ($1)->begin(); + newIt != ($1)->end(); ++newIt) + { + newItem = SWIG_NewPointerObj(*newIt,SWIGTYPE_p_DicomDirSerie,0); + PyList_Append($result, newItem); } } -%typemap(out) ListDicomDirImage & { - PyObject* NewItem = (PyObject*)0; +%typemap(out) ListDicomDirImage & +{ + PyObject* newItem = (PyObject*)0; $result = PyList_New(0); // The result of this typemap - for (std::list::iterator New = ($1)->begin(); - New != ($1)->end(); ++New) { - NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_DicomDirImage,1); - PyList_Append($result, NewItem); + for (std::list::iterator newIt = ($1)->begin(); + newIt != ($1)->end(); ++newIt) + { + newItem = SWIG_NewPointerObj(*newIt,SWIGTYPE_p_DicomDirImage,0); + PyList_Append($result, newItem); } } //////////////////////////////////////////////////////////////////////////// -// 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); @@ -216,10 +265,10 @@ typedef unsigned int guint32; } } - //////////////////// STL string versus Python str //////////////////////// // Convertion returning a C++ string. -%typemap(out) string, std::string { +%typemap(out) string, std::string +{ $result = PyString_FromString(($1).c_str()); } @@ -238,25 +287,32 @@ typedef unsigned int guint32; //////////////////////////////////////////////////////////////////////////// // 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::binary_write(std::ostream &,uint32_t const &); +%ignore gdcm::binary_write(std::ostream &,uint16_t const &); + %ignore gdcm::Header::Header(); +%ignore gdcm::DicomDir::DicomDir(); + +// Ignore all placed in gdcmCommon.h +%ignore GDCM_UNKNOWN; +%ignore GDCM_UNFOUND; +%ignore GDCM_BINLOADED; +%ignore GDCM_NOTLOADED; +%ignore GDCM_UNREAD; //////////////////////////////////////////////////////////////////////////// // Warning: Order matters ! %include "gdcmCommon.h" -%include "gdcmRLEFramesInfo.h" -%include "gdcmJPEGFragmentsInfo.h" +%include "gdcmBase.h" %include "gdcmDictEntry.h" %include "gdcmDict.h" -%include "gdcmDocEntry.h" %include "gdcmDocEntrySet.h" %include "gdcmElementSet.h" %include "gdcmDictSet.h" -%include "gdcmTS.h" -%include "gdcmVR.h" %include "gdcmSQItem.h" %include "gdcmDicomDirElement.h" %include "gdcmDicomDirObject.h" @@ -267,11 +323,15 @@ typedef unsigned int guint32; %include "gdcmDicomDirMeta.h" %include "gdcmDocument.h" %include "gdcmHeader.h" -%include "gdcmHeaderHelper.h" +%include "gdcmSerieHeader.h" %include "gdcmFile.h" %include "gdcmUtil.h" %include "gdcmGlobal.h" %include "gdcmDicomDir.h" +%include "gdcmDocEntry.h" +%include "gdcmValEntry.h" +%include "gdcmBinEntry.h" +%include "gdcmSeqEntry.h" //////////////////////////////////////////////////////////////////////////// // Notes on swig and this file gdcm.i: @@ -291,7 +351,6 @@ typedef unsigned int guint32; // { // $1 = new std::string( PyString_AsString( $input ) ); // } -// add a note on the rename that works ! // void Junk(); // void Junk(std::string const & bozo); //