packages/itk/src/bbitkDICOMSeriesFileNames.xml

   1 <!--==========================================================================
   2    STARTS THE DESCRIPTION OF THE BLACK BOX -->
   3 <blackbox name="DICOMSeriesFileNames">
   4 <!--=======================================================================-->
   5
   6   <!--========================================================================
   7     THE BOX DOCUMENTATION -->
   8   <author>laurent.guigues at creatis.insa-lyon.fr</author>
   9   <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>
  10   <category>read/write;image;dicom</category>
  11   <!--=====================================================================-->
  12
  13   <!--========================================================================
  14     #include directives to be put in the .h generated
  15     There must be one tag per file to include
  16     Here we include the standard header iostream.h -->
  17   <include><PRE>itkDICOMSeriesFileNames.h</PRE></include>
  18   <!--=====================================================================-->
  19
  20   <!--========================================================================
  21     INPUTS/OUTPUTS DECLARATION -->
  22   <!-- Declares an input with name 'In' -->
  23   <input name="In" type="std::string" description="DICOM directory"/>
  24
  25   <!-- Declares an output with name 'Out' -->
  26   <typedef><PRE>typedef std::vector<std::string> OutputType;</PRE></typedef>
  27   <output name="Out" type="OutputType" description="Vector of file names"/>
  28   <!--=====================================================================-->
  29
  30   <!--========================================================================
  31     THE PROCESSING METHOD BODY -->
  32   <process><PRE>
  33     itk::DICOMSeriesFileNames::Pointer names =
  34      itk::DICOMSeriesFileNames::New();
  35     names->SetDirectory(bbGetInputIn());
  36     bbSetOutputOut( names->GetFileNames() );
  37   </PRE></process>
  38   <!--=====================================================================-->
  39
  40   <!--========================================================================
  41     CONSTRUCTORS / DESTRUCTORS (OPTIONAL)
  42   <constructor><PRE>
  43   </PRE></constructor>
  44   <copyconstructor><PRE>
  45   </PRE></copyconstructor>
  46   <destructor><PRE>
  47   </PRE></destructor>
  48   <!--=====================================================================-->
  49
  50 <!--=======================================================================-->
  51 <!-- END OF BLACK BOX DESCRIPTION -->
  52 </blackbox>
  53 <!--=======================================================================-->