From: frog Date: Wed, 19 Feb 2003 23:37:47 +0000 (+0000) Subject: * Doc/Doxyfile configuration file for Doxygen and corresponding X-Git-Tag: April2003~39 X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=d84a0a9e04fe65dc2ff732d75731fa403d0e02b8;p=gdcm.git * Doc/Doxyfile configuration file for Doxygen and corresponding README file for usage added. * Test/testWrite.cxx added. This new test comes from a split of test.cxx that is now reverted to its original purpous i.e. testing the proper parsing of a Dicom related file. testWrite.cxx concentrates on testing the IO part of gdcm. * Test/bug1.cxx (containing a bug on WIn32) added. * src/gdcm.h, gdcmHeader.cxx, gdcmDictSet.cxx: - gdcmHeader::GetPubTagNames and gdcmHeader::GetPubTagNamesByCategory whose purpose is to publish the content of the TagNames of the Dicom public dictionnary were not accessible without an instance of class gdcmHeader. - those methods are now static methods of gdcmDictSet and hence require no instances at all to be invocated. - within gdcmDictSet this change required to change some method to class methods (i.e. are now static) among which SetDictPath (renamed to BuildDictPath) and LoadDefaultPubDict. * python/gdcmPython/demo/printGroupedPublicDict.py changed to illustrate the above changes by calling the new method classes of gdcmDictSet. * python/gdcmPython/__init__.py now exposes gdcm.gdcmDictSet for the above to be effective. * python/gdcmPython: in order to wrap properly the above changes for Python, swig version now needs to be > 1.3.17. * python/gdcmPython/Makefile fixed to adapt itself to new configure/make shema introduced by Johan Montagnat (thanks for the contribution). Alas this Makefile cannot be turned into a proper Makefile.am without some heavy changes in the configure.in (for python dectection). * python/gdcmPython/gdcm.i: the out typemap map>* now avoids publishing the empty entries. --- Frog --- diff --git a/ChangeLog b/ChangeLog index 23949304..450accfc 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,39 @@ +2003-02-19 Eric Boix + * As stated by the first lines of Test/ExceptionAndPython/README, it + looks like we can move back to original usage of exception within + src/gdcm* and hence remove the errno stuff that was introduced + as a quick and dirty fixture of this problem (added to the TODO). + * Doc/Doxyfile configuration file for Doxygen and corresponding + README file for usage added. + * Test/testWrite.cxx added. This new test comes from a split of + test.cxx that is now reverted to its original purpous i.e. + testing the proper parsing of a Dicom related file. + testWrite.cxx concentrates on testing the IO part of gdcm. + * Test/bug1.cxx (containing a bug on WIn32) added. + * src/gdcm.h, gdcmHeader.cxx, gdcmDictSet.cxx: + - gdcmHeader::GetPubTagNames and gdcmHeader::GetPubTagNamesByCategory + whose purpose is to publish the content of the TagNames of the + Dicom public dictionnary were not accessible without an + instance of class gdcmHeader. + - those methods are now static methods of gdcmDictSet and hence + require no instances at all to be invocated. + - within gdcmDictSet this change required to change some method + to class methods (i.e. are now static) among which SetDictPath + (renamed to BuildDictPath) and LoadDefaultPubDict. + * python/gdcmPython/demo/printGroupedPublicDict.py changed to illustrate + the above changes by calling the new method classes of gdcmDictSet. + * python/gdcmPython/__init__.py now exposes gdcm.gdcmDictSet for + the above to be effective. + * python/gdcmPython: in order to wrap properly the above changes + for Python, swig version now needs to be > 1.3.17. + * python/gdcmPython/Makefile fixed to adapt itself to new + configure/make shema introduced by Johan Montagnat (thanks for the + contribution). Alas this Makefile cannot be turned into a proper + Makefile.am without some heavy changes in the configure.in + (for python dectection). + * python/gdcmPython/gdcm.i: the out typemap map>* + now avoids publishing the empty entries. + 2003-02-13 Benoit Regrain * python/setup.py : bug fix concerning install under windows ExtraPath reused :-P diff --git a/Dicts/dicomV3.dic b/Dicts/dicomV3.dic index 48c9e418..25b94a97 100644 --- a/Dicts/dicomV3.dic +++ b/Dicts/dicomV3.dic @@ -2,7 +2,7 @@ 0000 0002 UI CMD Affected SOP Class UID 0000 0003 UI CMD Requested SOP Class UID 0000 0100 US CMD Command Field -0000 0110 US CMD Message ID +0000 0110 US CMD Message ID (first) 0000 0120 US CMD Message ID Responded to 0000 0600 AE CMD Move Destination 0000 0700 US CMD Priority @@ -20,7 +20,7 @@ 0000 1022 US CMD Failed Suboperations 0000 1023 US CMD Warning Suboperations 0000 1030 AE CMD AE Title -0000 1031 US CMD Message ID +0000 1031 US CMD Message ID (second) 0000 1005 AT CMD Attribute Identifier List 0002 0000 UL META Meta Group Length 0002 0001 OB META File Meta Information Version diff --git a/Doc/.cvsignore b/Doc/.cvsignore new file mode 100644 index 00000000..1936cc1d --- /dev/null +++ b/Doc/.cvsignore @@ -0,0 +1 @@ +html diff --git a/Doc/Doxyfile b/Doc/Doxyfile new file mode 100644 index 00000000..e2bceaad --- /dev/null +++ b/Doc/Doxyfile @@ -0,0 +1,921 @@ +# Doxyfile 1.2.14 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# General configuration options +#--------------------------------------------------------------------------- + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = gdcm + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, +# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, +# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish. + +OUTPUT_LANGUAGE = English + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these class will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited +# members of a class in the documentation of that class as if those members were +# ordinary class members. Constructors, destructors and assignment operators of +# the base classes will not be shown. + +INLINE_INHERITED_MEMB = YES + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. It is allowed to use relative paths in the argument list. + +STRIP_FROM_PATH = + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower case letters. If set to YES upper case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# users are adviced to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an +# explict @brief command for a brief description. + +JAVADOC_AUTOBRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# reimplements. + +INHERIT_DOCS = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consist of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. +# For instance some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = ../src + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp +# *.h++ *.idl *.odl + +FILE_PATTERNS = *.cxx *.h + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories +# that are symbolic links (a Unix filesystem feature) are excluded from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. + +EXCLUDE_PATTERNS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. + +INPUT_FILTER = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse. + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the Html help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, +# or Internet explorer 4.0+). Note that for large projects the tree generation +# can take a very long time. In such cases it is better to disable this feature. +# Windows users are probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = NO + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimised for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assigments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_XML = NO + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_PREDEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line and do not end with a semicolon. Such function macros are typically +# used for boiler-plate code, and will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::addtions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES tag can be used to specify one or more tagfiles. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or +# super classes. Setting the tag to NO turns the diagrams off. Note that this +# option is superceded by the HAVE_DOT option below. This is only a fallback. It is +# recommended to install and use dot, since it yield more powerful graphs. + +CLASS_DIAGRAMS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = YES + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are gif, jpg, and png +# If left blank gif will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found on the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_WIDTH = 1024 + +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_HEIGHT = 1024 + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermedate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::addtions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO + +# The CGI_NAME tag should be the name of the CGI script that +# starts the search engine (doxysearch) with the correct parameters. +# A script with this name will be generated by doxygen. + +CGI_NAME = search.cgi + +# The CGI_URL tag should be the absolute URL to the directory where the +# cgi binaries are located. See the documentation of your http daemon for +# details. + +CGI_URL = + +# The DOC_URL tag should be the absolute URL to the directory where the +# documentation is located. If left blank the absolute path to the +# documentation, with file:// prepended to it, will be used. + +DOC_URL = + +# The DOC_ABSPATH tag should be the absolute path to the directory where the +# documentation is located. If left blank the directory on the local machine +# will be used. + +DOC_ABSPATH = + +# The BIN_ABSPATH tag must point to the directory where the doxysearch binary +# is installed. + +BIN_ABSPATH = /usr/local/bin/ + +# The EXT_DOC_PATHS tag can be used to specify one or more paths to +# documentation generated for other projects. This allows doxysearch to search +# the documentation for these projects as well. + +EXT_DOC_PATHS = diff --git a/Doc/README b/Doc/README new file mode 100644 index 00000000..a6c806fc --- /dev/null +++ b/Doc/README @@ -0,0 +1,4 @@ +Documentation can be build with doxygen: +doxygen Doxyfile +mozilla html/index.html + diff --git a/INSTALL b/INSTALL index 93ffa792..e9072f57 100644 --- a/INSTALL +++ b/INSTALL @@ -23,3 +23,8 @@ python testSuite.py (test suite written in unittest, you should use python2) * For manual test in python: cd python/demo python test.py ../../Data/CR-MONO1-10-chest.dcm (or any other file) + + +----------------------------------------------------------------------------- +Documentation can be found in the Doc sub-directory. Please refer to +README file within Doc. diff --git a/README b/README index a1d5c20d..d6743f63 100644 --- a/README +++ b/README @@ -1 +1,2 @@ -Requires Swig version >= 1.3.11 for handling member overloading. +Requires Swig version >= 1.3.17 for handling member overloading, and +static methods. diff --git a/TODO b/TODO index 42235948..1b0dc98a 100644 --- a/TODO +++ b/TODO @@ -1,3 +1,16 @@ +* As stated by the first lines of Test/ExceptionAndPython/README, it looks + like we can move back to the exceptions and remove the errno stuff from + src/gdcm* ! +* adapt python/gdcmPython/Makefile to automake/autoconf tools +* Fix the bug in Test/bug1.cxx (see first comment line): Win32 only. +* All (or at least many of) the methods of gdcmHeader whose only arguments + are an ElValue* (e.g. FindLength, FindVR, LoadElementValue...) can + be moved away to ElValue class on condition of transmitting the + gdcmHeader.fp attribute. This change should be considered since it + would allow those method to avoid artificial calls to ElValue::GetElement(), + ElValue::GetVR()... +* Eat leanding_trailing_whitespace (found in python/gdcmPython/gdcmi) should + be used when parsing the dictionary in C++ ! * Group length is not a unique tag in a file. Hence avoid putting it in the element values dictionary without doing something smarter (say, instead of storing the length store the group and the length diff --git a/Testing/.cvsignore b/Testing/.cvsignore index 2cad7ce3..bd1fe827 100644 --- a/Testing/.cvsignore +++ b/Testing/.cvsignore @@ -1,9 +1,11 @@ -test +*.o .deps .libs Makefile.in Makefile +test +testWrite hashtest +bug1 image.dcm image.raw - diff --git a/Testing/ExceptionAndPython/.cvsignore b/Testing/ExceptionAndPython/.cvsignore index 5b6861ed..d76c3fd2 100644 --- a/Testing/ExceptionAndPython/.cvsignore +++ b/Testing/ExceptionAndPython/.cvsignore @@ -5,3 +5,4 @@ main *.o *.so *.pyc +*_wrap.doc diff --git a/Testing/ExceptionAndPython/README b/Testing/ExceptionAndPython/README index 6e9fd69e..09fa1d87 100644 --- a/Testing/ExceptionAndPython/README +++ b/Testing/ExceptionAndPython/README @@ -1,3 +1,7 @@ +READ THIS FIRST: +the oddities described below are NOT present when using +wxPythonGTK-py2.2-2.4.0.2-2 but are present when wxPythonGTK-py2.2-2.3.4.2-1. +------------------------------------------------------------------------- The purpous of this set of files is to illustrate an unexpected behavior of exception handling of swig wrapped c++ libraries with wxPython. Context: diff --git a/Testing/TestBug.cxx b/Testing/TestBug.cxx new file mode 100644 index 00000000..0d67a97d --- /dev/null +++ b/Testing/TestBug.cxx @@ -0,0 +1,17 @@ +// The following crashes on Win32 +#include "gdcm.h" + +int main(int argc, char* argv[]) +{ + gdcmHeader* e1; + + if (argc > 1) + e1 = new gdcmHeader(argv[1]); + else + e1 = new gdcmHeader("test.acr"); + e1->LoadElements(); + e1->PrintPubDict(); +} + + + diff --git a/src/gdcm.h b/src/gdcm.h index aea4edc5..735bd98c 100644 --- a/src/gdcm.h +++ b/src/gdcm.h @@ -170,13 +170,19 @@ typedef map DictSetHT; class GDCM_EXPORT gdcmDictSet { private: - string DictPath; // Directory path to dictionaries DictSetHT dicts; int AppendDict(gdcmDict* NewDict); - int LoadDictFromFile(string filename, DictKey); - void SetDictPath(void); + void LoadDictFromFile(string filename, DictKey); +private: + static string DictPath; // Directory path to dictionaries + static string BuildDictPath(void); + static gdcmDict* DefaultPubDict; public: - gdcmDictSet(void); // loads THE DICOM v3 dictionary + static list * GetPubDictTagNames(void); + static map >* GetPubDictTagNamesByCategory(void); + static gdcmDict* LoadDefaultPubDict(void); + + gdcmDictSet(void); // TODO Swig int LoadDictFromFile(string filename); // QUESTION: the following function might not be thread safe !? Maybe // we need some mutex here, to avoid concurent creation of @@ -185,14 +191,9 @@ public: // TODO Swig int LoadAllDictFromDirectory(string DirectoryName); // TODO Swig string* GetAllDictNames(); // - // Question : ne faudra-t-il pas mettre LE dictionnaire DICOM dans un Directory - // et les eventuels 'dictionnaires prives' dans un autre? - // (pour eviter a un utilisateur mal dégourdi de tout saccager ?) - // - int LoadDicomV3Dict(void); void Print(ostream&); gdcmDict* GetDict(DictKey DictName); - gdcmDict* GetDefaultPublicDict(void); + gdcmDict* GetDefaultPubDict(void); }; /////////////////////////////////////////////////////////////////////////// @@ -294,7 +295,7 @@ private: static VRHT *dicom_vr; // Dictionaries of data elements: - static gdcmDictSet* Dicts; // global dictionary container + gdcmDictSet* Dicts; // global dictionary container gdcmDict* RefPubDict; // public dictionary gdcmDict* RefShaDict; // shadow dictionary (optional) // Parsed element values: @@ -386,14 +387,7 @@ public: // an additional specific dictionary to access extra information. // TODO Swig int SetShaDict(string filename); - // Retrieve all potentially available tag [tag = (group, element)] names - // from the standard (or public) dictionary. Typical usage : enable the - // user of a GUI based interface to select his favorite fields for sorting - // or selecting. - list * GetPubTagNames(void); - map > * GetPubTagNamesByCategory(void); // Get the element values themselves: - string GetPubElValByName(string TagName); string GetPubElValByNumber(guint16 group, guint16 element); @@ -406,7 +400,7 @@ public: TagElValueHT & GetPubElVal(void) { return PubElVals.GetTagHt(); }; void PrintPubElVal(ostream & os = cout); - void PrintPubDict(ostream &); + void PrintPubDict(ostream & os = cout); // Same thing with the shadow : // TODO Swig string* GetShaTagNames(); diff --git a/src/gdcmDictSet.cxx b/src/gdcmDictSet.cxx index e24e8d0a..56482cb3 100644 --- a/src/gdcmDictSet.cxx +++ b/src/gdcmDictSet.cxx @@ -11,49 +11,104 @@ #endif #define PUB_DICT_FILENAME "dicomV3.dic" -gdcmDictSet::gdcmDictSet(void) { - SetDictPath(); - if (! LoadDicomV3Dict()) - return; -} - -void gdcmDictSet::SetDictPath(void) { - const char* EnvPath = (char*)0; - EnvPath = getenv("GDCM_DICT_PATH"); - if (EnvPath && (strlen(EnvPath) != 0)) { - DictPath = EnvPath; - if (DictPath[DictPath.length() -1] != '/' ) - DictPath += '/'; - dbg.Verbose(1, "gdcmDictSet::SetDictPath:", +string gdcmDictSet::DictPath = gdcmDictSet::BuildDictPath(); +gdcmDict* gdcmDictSet::DefaultPubDict = gdcmDictSet::LoadDefaultPubDict(); + +/** + * \ingroup gdcmDictSet + * \brief Consider all the entries of the public dicom dictionnary. + * Build all list of all the tag names of all those entries. + * \sa gdcmDictSet::GetPubDictTagNamesByCategory + * @return A list of all entries of the public dicom dictionnary. + */ +list * gdcmDictSet::GetPubDictTagNames(void) { + list * Result = new list; + TagKeyHT entries = gdcmDictSet::DefaultPubDict->GetEntries(); + + for (TagKeyHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){ + Result->push_back( tag->second->GetName() ); + } + return Result; +} + +/** + * \ingroup gdcmDictSet + * \brief Consider all the entries of the public dicom dictionnary. + * Build an hashtable whose keys are the names of the groups + * (fourth field in each line of dictionary) and whose corresponding + * values are lists of all the dictionnary entries among that + * group. Note that apparently the Dicom standard doesn't explicitely + * define a name (as a string) for each group. + * A typical usage of this method would be to enable a dynamic + * configuration of a Dicom file browser: the admin/user can + * select in the interface which Dicom tags should be displayed. + * @return An hashtable: whose keys are the names of the groups and whose + * corresponding values are lists of all the dictionnary entries + * among that group. + */ +map > * gdcmDictSet::GetPubDictTagNamesByCategory(void) { + map > * Result = new map >; + TagKeyHT entries = gdcmDictSet::DefaultPubDict->GetEntries(); + + for (TagKeyHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){ + (*Result)[tag->second->GetFourth()].push_back(tag->second->GetName()); + } + return Result; +} + +/** + * \ingroup gdcmDictSet + * \brief Obtain from the GDCM_DICT_PATH environnement variable the + * path to directory containing the dictionnaries. When + * the environnement variable is absent the path is defaulted + * to "../Dicts/". + */ +string gdcmDictSet::BuildDictPath(void) { + string ResultPath; + const char* EnvPath = (char*)0; + EnvPath = getenv("GDCM_DICT_PATH"); + if (EnvPath && (strlen(EnvPath) != 0)) { + ResultPath = EnvPath; + if (ResultPath[ResultPath.length() -1] != '/' ) + ResultPath += '/'; + dbg.Verbose(1, "gdcmDictSet::BuildDictPath:", "Dictionary path set from environnement"); - } else - DictPath = PUB_DICT_PATH; + } else + ResultPath = PUB_DICT_PATH; + return ResultPath; } -int gdcmDictSet::LoadDicomV3Dict(void) { - if (dicts.count(PUB_DICT_NAME)) - return 1; - return LoadDictFromFile(DictPath + PUB_DICT_FILENAME, PUB_DICT_NAME); +gdcmDict* gdcmDictSet::LoadDefaultPubDict(void) { + string PubDictFile = gdcmDictSet::DictPath + PUB_DICT_FILENAME; + return new gdcmDict(PubDictFile.c_str()); +} + +/** + * \ingroup gdcmDictSet + * \brief The Dictionnary Set obtained with this constructor simply + * contains the Default Public dictionnary. + */ +gdcmDictSet::gdcmDictSet(void) { + dicts[PUB_DICT_NAME] = DefaultPubDict; } -int gdcmDictSet::LoadDictFromFile(string FileName, DictKey Name) { - gdcmDict *NewDict = new gdcmDict(FileName.c_str()); - dicts[Name] = NewDict; - return 0; //FIXME if this is a dummy return make the method void +void gdcmDictSet::LoadDictFromFile(string FileName, DictKey Name) { + gdcmDict *NewDict = new gdcmDict(FileName.c_str()); + dicts[Name] = NewDict; } void gdcmDictSet::Print(ostream& os) { - for (DictSetHT::iterator dict = dicts.begin(); dict != dicts.end(); ++dict){ - os << "Printing dictionary " << dict->first << " \n"; - dict->second->Print(os); - } + for (DictSetHT::iterator dict = dicts.begin(); dict != dicts.end(); ++dict){ + os << "Printing dictionary " << dict->first << " \n"; + dict->second->Print(os); + } } gdcmDict * gdcmDictSet::GetDict(DictKey DictName) { - DictSetHT::iterator dict = dicts.find(DictName); - return dict->second; + DictSetHT::iterator dict = dicts.find(DictName); + return dict->second; } -gdcmDict * gdcmDictSet::GetDefaultPublicDict() { - return GetDict(PUB_DICT_NAME); +gdcmDict * gdcmDictSet::GetDefaultPubDict() { + return GetDict(PUB_DICT_NAME); } diff --git a/src/gdcmHeader.cxx b/src/gdcmHeader.cxx index a79be6e6..9246c452 100644 --- a/src/gdcmHeader.cxx +++ b/src/gdcmHeader.cxx @@ -28,12 +28,12 @@ // je suis preneur VRHT * gdcmHeader::dicom_vr = (VRHT*)0; -gdcmDictSet* gdcmHeader::Dicts = new gdcmDictSet(); void gdcmHeader::Initialise(void) { if (!gdcmHeader::dicom_vr) InitVRDict(); - RefPubDict = gdcmHeader::Dicts->GetDefaultPublicDict(); + Dicts = new gdcmDictSet(); + RefPubDict = Dicts->GetDefaultPubDict(); RefShaDict = (gdcmDict*)0; } @@ -255,20 +255,7 @@ void gdcmHeader::GetPixels(size_t lgrTotale, void* _Pixels) { /** * \ingroup gdcmHeader * \brief Find the value representation of the current tag. - * - * @param sw code swap - * @param skippedLength pointeur sur nombre d'octets que l'on a saute qd - * la lecture est finie - * @param longueurLue pointeur sur longueur (en nombre d'octets) - * effectivement lue - * @return longueur retenue pour le champ */ - -// --> -// --> Oops -// --> C'etait la description de quoi, ca? -// --> - void gdcmHeader::FindVR( ElValue *ElVal) { if (filetype != ExplicitVR) return; @@ -701,12 +688,9 @@ void gdcmHeader::SetMaxSizeLoadElementValue(long NewSize) { /** * \ingroup gdcmHeader - * \brief Loads the element if it's size is not to big. - * @param ElVal Element whose value shall be loaded. - * @param MaxSize Size treshold above which the element value is not - * loaded in memory. The element value is allways loaded - * when MaxSize is equal to UINT32_MAX. - * @return + * \brief Loads the element content if it's length is not bigger + * than the value specified with + * gdcmHeader::SetMaxSizeLoadElementValue() */ void gdcmHeader::LoadElementValue(ElValue * ElVal) { size_t item_read; @@ -755,17 +739,14 @@ void gdcmHeader::LoadElementValue(ElValue * ElVal) { return; } - // Values bigger than specified are not loaded. - // - // En fait, c'est les elements dont la longueur est superieure - // a celle fixee qui ne sont pas charges - // + // The elements whose length is bigger than the specified upper bound + // are not loaded. Instead we leave a short notice of the offset of + // the element content and it's length. if (length > MaxSizeLoadElementValue) { ostringstream s; s << "gdcm::NotLoaded."; s << " Address:" << (long)ElVal->GetOffset(); s << " Length:" << ElVal->GetLength(); - //mesg += " Length:" + ElVal->GetLength(); ElVal->SetValue(s.str()); return; } @@ -1005,7 +986,7 @@ size_t gdcmHeader::GetPixelOffset(void) { * group and element. The public dictionary has precedence on the * shadow one. * @param group group of the searched DictEntry - * @earam element element of the searched DictEntry + * @param element element of the searched DictEntry * @return Corresponding DictEntry when it exists, NULL otherwise. */ gdcmDictEntry * gdcmHeader::GetDictEntryByKey(guint16 group, guint16 element) { @@ -1054,26 +1035,6 @@ gdcmDictEntry * gdcmHeader::GetDictEntryByName(string Name) { return found; } -list * gdcmHeader::GetPubTagNames(void) { - list * Result = new list; - TagKeyHT entries = RefPubDict->GetEntries(); - - for (TagKeyHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){ - Result->push_back( tag->second->GetName() ); - } - return Result; -} - -map > * gdcmHeader::GetPubTagNamesByCategory(void) { - map > * Result = new map >; - TagKeyHT entries = RefPubDict->GetEntries(); - - for (TagKeyHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){ - (*Result)[tag->second->GetFourth()].push_back(tag->second->GetName()); - } - return Result; -} - string gdcmHeader::GetPubElValByNumber(guint16 group, guint16 element) { return PubElVals.GetElValueByNumber(group, element); }