libodil0-doc 0.7.3-1 / usr / share / doc / libodil0-doc / html / classodil_1_1_basic_directory_creator.html

This file is indexed.

/usr/share/doc/libodil0-doc/html/classodil_1_1_basic_directory_creator.html is in libodil0-doc 0.7.3-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>odil: odil::BasicDirectoryCreator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">odil
   </div>
   <div id="projectbrief">C++11libraryfortheDICOMstandard</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>odil</b></li><li class="navelem"><a class="el" href="classodil_1_1_basic_directory_creator.html">BasicDirectoryCreator</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classodil_1_1_basic_directory_creator-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">odil::BasicDirectoryCreator Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Write a Basic Directory (i.e. DICOMDIR) object to the disk.  
 <a href="classodil_1_1_basic_directory_creator.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_basic_directory_creator_8h_source.html">BasicDirectoryCreator.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ad8bac5a8ffd5b45a50df42bbab4c66a1"><td class="memItemLeft" align="right" valign="top"><a id="ad8bac5a8ffd5b45a50df42bbab4c66a1"></a>
typedef std::pair&lt; <a class="el" href="classodil_1_1_tag.html">Tag</a>, int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classodil_1_1_basic_directory_creator.html#ad8bac5a8ffd5b45a50df42bbab4c66a1">RecordKey</a></td></tr>
<tr class="memdesc:ad8bac5a8ffd5b45a50df42bbab4c66a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The tag and its associated type in the record. <br /></td></tr>
<tr class="separator:ad8bac5a8ffd5b45a50df42bbab4c66a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af504ce944800e0607ec2a04376a3f33b"><td class="memItemLeft" align="right" valign="top"><a id="af504ce944800e0607ec2a04376a3f33b"></a>
typedef std::map&lt; std::string, std::vector&lt; <a class="el" href="classodil_1_1_basic_directory_creator.html#ad8bac5a8ffd5b45a50df42bbab4c66a1">RecordKey</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classodil_1_1_basic_directory_creator.html#af504ce944800e0607ec2a04376a3f33b">RecordKeyMap</a></td></tr>
<tr class="memdesc:af504ce944800e0607ec2a04376a3f33b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Map from a record type to the extra keys. <br /></td></tr>
<tr class="separator:af504ce944800e0607ec2a04376a3f33b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acfbc5677aa1f1f3d2110c2a3f9daee43"><td class="memItemLeft" align="right" valign="top"><a id="acfbc5677aa1f1f3d2110c2a3f9daee43"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classodil_1_1_basic_directory_creator.html#acfbc5677aa1f1f3d2110c2a3f9daee43">BasicDirectoryCreator</a> (std::string const &amp;<a class="el" href="classodil_1_1_basic_directory_creator.html#a93b1a6f022c984db2a2f97edd17f59e7">root</a>=&quot;&quot;, std::vector&lt; std::string &gt; const &amp;<a class="el" href="classodil_1_1_basic_directory_creator.html#a638fc0b8e143f6d2a3c5d8964050fcc9">files</a>=std::vector&lt; std::string &gt;(), <a class="el" href="classodil_1_1_basic_directory_creator.html#af504ce944800e0607ec2a04376a3f33b">RecordKeyMap</a> const &amp;<a class="el" href="classodil_1_1_basic_directory_creator.html#aa8f3ab62d32bb64743425db88d896bfc">extra_record_keys</a>=<a class="el" href="classodil_1_1_basic_directory_creator.html#af504ce944800e0607ec2a04376a3f33b">RecordKeyMap</a>(), <a class="el" href="classodil_1_1_writer.html#a6981282dffa762cc5b74095ecd940c15">Writer::ItemEncoding</a> <a class="el" href="classodil_1_1_basic_directory_creator.html#a9258d6c98ab698cb83f1fa5b80167a44">item_encoding</a>=Writer::ItemEncoding::ExplicitLength)</td></tr>
<tr class="memdesc:acfbc5677aa1f1f3d2110c2a3f9daee43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:acfbc5677aa1f1f3d2110c2a3f9daee43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f59a999b3f5101cb74692ce730cf2f3"><td class="memItemLeft" align="right" valign="top"><a id="a2f59a999b3f5101cb74692ce730cf2f3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classodil_1_1_basic_directory_creator.html#a2f59a999b3f5101cb74692ce730cf2f3">operator()</a> () const</td></tr>
<tr class="memdesc:a2f59a999b3f5101cb74692ce730cf2f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create and write the Basic Directory. <br /></td></tr>
<tr class="separator:a2f59a999b3f5101cb74692ce730cf2f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a93b1a6f022c984db2a2f97edd17f59e7"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classodil_1_1_basic_directory_creator.html#a93b1a6f022c984db2a2f97edd17f59e7">root</a></td></tr>
<tr class="memdesc:a93b1a6f022c984db2a2f97edd17f59e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Root of the DICOM files and location of the output DICOMDIR file.  <a href="#a93b1a6f022c984db2a2f97edd17f59e7">More...</a><br /></td></tr>
<tr class="separator:a93b1a6f022c984db2a2f97edd17f59e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a638fc0b8e143f6d2a3c5d8964050fcc9"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classodil_1_1_basic_directory_creator.html#a638fc0b8e143f6d2a3c5d8964050fcc9">files</a></td></tr>
<tr class="memdesc:a638fc0b8e143f6d2a3c5d8964050fcc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Path to the DICOM files, relative to root.  <a href="#a638fc0b8e143f6d2a3c5d8964050fcc9">More...</a><br /></td></tr>
<tr class="separator:a638fc0b8e143f6d2a3c5d8964050fcc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8f3ab62d32bb64743425db88d896bfc"><td class="memItemLeft" align="right" valign="top"><a id="aa8f3ab62d32bb64743425db88d896bfc"></a>
<a class="el" href="classodil_1_1_basic_directory_creator.html#af504ce944800e0607ec2a04376a3f33b">RecordKeyMap</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classodil_1_1_basic_directory_creator.html#aa8f3ab62d32bb64743425db88d896bfc">extra_record_keys</a></td></tr>
<tr class="memdesc:aa8f3ab62d32bb64743425db88d896bfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">User-defined record keys, classified by record type. <br /></td></tr>
<tr class="separator:aa8f3ab62d32bb64743425db88d896bfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9258d6c98ab698cb83f1fa5b80167a44"><td class="memItemLeft" align="right" valign="top"><a id="a9258d6c98ab698cb83f1fa5b80167a44"></a>
<a class="el" href="classodil_1_1_writer.html#a6981282dffa762cc5b74095ecd940c15">Writer::ItemEncoding</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classodil_1_1_basic_directory_creator.html#a9258d6c98ab698cb83f1fa5b80167a44">item_encoding</a></td></tr>
<tr class="memdesc:a9258d6c98ab698cb83f1fa5b80167a44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encoding of sequence items, defaults to Writer::ItemEncoding::ExplicitLength. <br /></td></tr>
<tr class="separator:a9258d6c98ab698cb83f1fa5b80167a44"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a6e63a46262feb1619d178688237022b1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classodil_1_1_basic_directory_creator.html#af504ce944800e0607ec2a04376a3f33b">RecordKeyMap</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classodil_1_1_basic_directory_creator.html#a6e63a46262feb1619d178688237022b1">default_record_keys</a></td></tr>
<tr class="memdesc:a6e63a46262feb1619d178688237022b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default record keys, classified by record type.  <a href="#a6e63a46262feb1619d178688237022b1">More...</a><br /></td></tr>
<tr class="separator:a6e63a46262feb1619d178688237022b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Write a Basic Directory (i.e. DICOMDIR) object to the disk. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a6e63a46262feb1619d178688237022b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e63a46262feb1619d178688237022b1">&sect;&nbsp;</a></span>default_record_keys</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::map&lt; std::string, std::vector&lt; <a class="el" href="classodil_1_1_basic_directory_creator.html#ad8bac5a8ffd5b45a50df42bbab4c66a1">BasicDirectoryCreator::RecordKey</a> &gt; &gt; const odil::BasicDirectoryCreator::default_record_keys</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= {</div><div class="line">    { <span class="stringliteral">&quot;PATIENT&quot;</span>, {</div><div class="line">        { registry::PatientName, 2},</div><div class="line">        { registry::PatientID, 1 } } },</div><div class="line">    { <span class="stringliteral">&quot;STUDY&quot;</span>, {</div><div class="line">        { registry::StudyDate, 1 },</div><div class="line">        { registry::StudyTime, 1 },</div><div class="line">        { registry::StudyDescription, 2 },</div><div class="line">        { registry::StudyInstanceUID, 1 }, </div><div class="line">        { registry::StudyID, 1 },</div><div class="line">        { registry::AccessionNumber, 2 } } },</div><div class="line">    { <span class="stringliteral">&quot;SERIES&quot;</span>, {</div><div class="line">        { registry::Modality, 1 },</div><div class="line">        { registry::SeriesInstanceUID, 1 },</div><div class="line">        { registry::SeriesNumber, 1 },</div><div class="line">        </div><div class="line">        } },</div><div class="line">    { <span class="stringliteral">&quot;IMAGE&quot;</span>, {</div><div class="line">        { registry::InstanceNumber, 1 },</div><div class="line">        </div><div class="line">        } },</div><div class="line">}</div></div><!-- fragment -->
<p>Default record keys, classified by record type. </p>

</div>
</div>
<a id="a638fc0b8e143f6d2a3c5d8964050fcc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a638fc0b8e143f6d2a3c5d8964050fcc9">&sect;&nbsp;</a></span>files</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::vector&lt;std::string&gt; odil::BasicDirectoryCreator::files</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Path to the DICOM files, relative to root. </p>
<p>The concatenation of root and each file must be a valid path. </p>

</div>
</div>
<a id="a93b1a6f022c984db2a2f97edd17f59e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93b1a6f022c984db2a2f97edd17f59e7">&sect;&nbsp;</a></span>root</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string odil::BasicDirectoryCreator::root</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Root of the DICOM files and location of the output DICOMDIR file. </p>
<p>The concatenation of root and each file, as well as of root and "DICOMDIR" must be a valid path. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/odil/<a class="el" href="_basic_directory_creator_8h_source.html">BasicDirectoryCreator.h</a></li>
<li>src/odil/BasicDirectoryCreator.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.