packages/itk/src/bbitkDICOMSeriesFileNames.xml

   1 <!--
   2  /*
   3  # ---------------------------------------------------------------------
   4  #
   5  # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   6  #                        pour la SantÈ)
   7  # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   8  # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   9  # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
  10  #
  11  #  This software is governed by the CeCILL-B license under French law and
  12  #  abiding by the rules of distribution of free software. You can  use,
  13  #  modify and/ or redistribute the software under the terms of the CeCILL-B
  14  #  license as circulated by CEA, CNRS and INRIA at the following URL
  15  #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  16  #  or in the file LICENSE.txt.
  17  #
  18  #  As a counterpart to the access to the source code and  rights to copy,
  19  #  modify and redistribute granted by the license, users are provided only
  20  #  with a limited warranty  and the software's author,  the holder of the
  21  #  economic rights,  and the successive licensors  have only  limited
  22  #  liability.
  23  #
  24  #  The fact that you are presently reading this means that you have had
  25  #  knowledge of the CeCILL-B license and that you accept its terms.
  26  # ------------------------------------------------------------------------ */
  27 -->
  28
  29 <!--==========================================================================
  30    STARTS THE DESCRIPTION OF THE BLACK BOX -->
  31 <blackbox name="DICOMSeriesFileNames">
  32 <!--=======================================================================-->
  33
  34   <!--========================================================================
  35     THE BOX DOCUMENTATION -->
  36   <author>laurent.guigues at creatis.insa-lyon.fr</author>
  37   <description>Reads a DICOM directory and generates an ordered sequence of filenames based on the DICOM tags in the files. Files can be sorted based on image number, slice location, or patient position. The files in the specified directory are grouped by SeriesUID. The list of SeriesUIDs can be queried and the filenames for a specific series extracted.</description>
  38   <category>read/write;image;dicom</category>
  39   <!--=====================================================================-->
  40
  41   <!--========================================================================
  42     #include directives to be put in the .h generated
  43     There must be one tag per file to include
  44     Here we include the standard header iostream.h -->
  45   <include><PRE>itkDICOMSeriesFileNames.h</PRE></include>
  46   <!--=====================================================================-->
  47
  48   <!--========================================================================
  49     INPUTS/OUTPUTS DECLARATION -->
  50   <!-- Declares an input with name 'In' -->
  51   <input name="In" type="std::string" description="DICOM directory"/>
  52
  53   <!-- Declares an output with name 'Out' -->
  54   <typedef><PRE>typedef std::vector<std::string> OutputType;</PRE></typedef>
  55   <output name="Out" type="OutputType" description="Vector of file names"/>
  56   <!--=====================================================================-->
  57
  58   <!--========================================================================
  59     THE PROCESSING METHOD BODY -->
  60   <process><PRE>
  61     itk::DICOMSeriesFileNames::Pointer names =
  62      itk::DICOMSeriesFileNames::New();
  63     names->SetDirectory(bbGetInputIn());
  64     bbSetOutputOut( names->GetFileNames() );
  65   </PRE></process>
  66   <!--=====================================================================-->
  67
  68   <!--========================================================================
  69     CONSTRUCTORS / DESTRUCTORS (OPTIONAL)  -->
  70   <defaultValues><PRE>
  71   </PRE></defaultValues>
  72
  73   <initializeProcessing><PRE>
  74   </PRE></initializeProcessing>
  75
  76   <finalizeProcessing><PRE>
  77   </PRE></finalizeProcessing>
  78   <!--=====================================================================-->
  79
  80 <!--=======================================================================-->
  81 <!-- END OF BLACK BOX DESCRIPTION -->
  82 </blackbox>
  83 <!--=======================================================================-->