<!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.3.1"/>
<title>Orthanc Client: OrthancClient::Instance 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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="projectlogo"><img alt="Logo" src="OrthancLogoDocumentation.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Orthanc Client
</div>
<div id="projectbrief">Documentation of the client library of Orthanc</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Groups</a></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>OrthancClient</b></li><li class="navelem"><a class="el" href="classOrthancClient_1_1Instance.html">Instance</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classOrthancClient_1_1Instance-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">OrthancClient::Instance Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Connection to an instance stored in Orthanc.
<a href="classOrthancClient_1_1Instance.html#details">More...</a></p>
<p><code>#include <<a class="el" href="OrthancCppClient_8h_source.html">OrthancCppClient.h</a>></code></p>
<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:a3abd07cc2d11cb0ca76f83b459d981d7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#a3abd07cc2d11cb0ca76f83b459d981d7">Instance</a> (const <a class="el" href="classOrthancClient_1_1Instance.html">Instance</a> &other)</td></tr>
<tr class="memdesc:a3abd07cc2d11cb0ca76f83b459d981d7"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new reference to this object. <a href="#a3abd07cc2d11cb0ca76f83b459d981d7">More...</a><br/></td></tr>
<tr class="separator:a3abd07cc2d11cb0ca76f83b459d981d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afec1cb05011cae6fc5543ab82d78419a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#afec1cb05011cae6fc5543ab82d78419a">Instance</a> (::<a class="el" href="classOrthancClient_1_1OrthancConnection.html">OrthancClient::OrthancConnection</a> &connection, const ::std::string &id)</td></tr>
<tr class="memdesc:afec1cb05011cae6fc5543ab82d78419a"><td class="mdescLeft"> </td><td class="mdescRight">Create a connection to some image instance. <a href="#afec1cb05011cae6fc5543ab82d78419a">More...</a><br/></td></tr>
<tr class="separator:afec1cb05011cae6fc5543ab82d78419a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7cb37b5e86de4eea2bd8fed70c780376"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#a7cb37b5e86de4eea2bd8fed70c780376">~Instance</a> ()</td></tr>
<tr class="separator:a7cb37b5e86de4eea2bd8fed70c780376"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1f59a554e7240a832f345e58785715b"><td class="memItemLeft" align="right" valign="top">inline::std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#ac1f59a554e7240a832f345e58785715b">GetId</a> () const </td></tr>
<tr class="memdesc:ac1f59a554e7240a832f345e58785715b"><td class="mdescLeft"> </td><td class="mdescRight">Get the Orthanc identifier of this identifier. <a href="#ac1f59a554e7240a832f345e58785715b">More...</a><br/></td></tr>
<tr class="separator:ac1f59a554e7240a832f345e58785715b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a470453200491b87db4b32e4d8f791042"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#a470453200491b87db4b32e4d8f791042">SetImageExtractionMode</a> (::<a class="el" href="group__Global.html#gae630d9dc0d9a970a22f6570e3ef0045e">Orthanc::ImageExtractionMode</a> mode)</td></tr>
<tr class="memdesc:a470453200491b87db4b32e4d8f791042"><td class="mdescLeft"> </td><td class="mdescRight">Set the extraction mode for the 2D image corresponding to this instance. <a href="#a470453200491b87db4b32e4d8f791042">More...</a><br/></td></tr>
<tr class="separator:a470453200491b87db4b32e4d8f791042"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7ccf92e0edd62d4e3e6d1e062f0b5ac"><td class="memItemLeft" align="right" valign="top">inline::Orthanc::ImageExtractionMode </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#ad7ccf92e0edd62d4e3e6d1e062f0b5ac">GetImageExtractionMode</a> () const </td></tr>
<tr class="memdesc:ad7ccf92e0edd62d4e3e6d1e062f0b5ac"><td class="mdescLeft"> </td><td class="mdescRight">Get the extraction mode for the 2D image corresponding to this instance. <a href="#ad7ccf92e0edd62d4e3e6d1e062f0b5ac">More...</a><br/></td></tr>
<tr class="separator:ad7ccf92e0edd62d4e3e6d1e062f0b5ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6802472d59f3c70c9ac25144a7dbe26"><td class="memItemLeft" align="right" valign="top">inline::std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#ae6802472d59f3c70c9ac25144a7dbe26">GetTagAsString</a> (const ::std::string &tag) const </td></tr>
<tr class="memdesc:ae6802472d59f3c70c9ac25144a7dbe26"><td class="mdescLeft"> </td><td class="mdescRight">Get the string value of some DICOM tag of this instance. <a href="#ae6802472d59f3c70c9ac25144a7dbe26">More...</a><br/></td></tr>
<tr class="separator:ae6802472d59f3c70c9ac25144a7dbe26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3061726f7c5895b835c5430e458046b1"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#a3061726f7c5895b835c5430e458046b1">GetTagAsFloat</a> (const ::std::string &tag) const </td></tr>
<tr class="memdesc:a3061726f7c5895b835c5430e458046b1"><td class="mdescLeft"> </td><td class="mdescRight">Get the floating point value that is stored in some DICOM tag of this instance. <a href="#a3061726f7c5895b835c5430e458046b1">More...</a><br/></td></tr>
<tr class="separator:a3061726f7c5895b835c5430e458046b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ee0196e57d7699961f7eed776275568"><td class="memItemLeft" align="right" valign="top">LAAW_INT32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#a3ee0196e57d7699961f7eed776275568">GetTagAsInt</a> (const ::std::string &tag) const </td></tr>
<tr class="memdesc:a3ee0196e57d7699961f7eed776275568"><td class="mdescLeft"> </td><td class="mdescRight">Get the integer value that is stored in some DICOM tag of this instance. <a href="#a3ee0196e57d7699961f7eed776275568">More...</a><br/></td></tr>
<tr class="separator:a3ee0196e57d7699961f7eed776275568"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae178a9490f77c63ae55bd4ebe5e0d734"><td class="memItemLeft" align="right" valign="top">LAAW_UINT32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#ae178a9490f77c63ae55bd4ebe5e0d734">GetWidth</a> ()</td></tr>
<tr class="memdesc:ae178a9490f77c63ae55bd4ebe5e0d734"><td class="mdescLeft"> </td><td class="mdescRight">Get the width of the 2D image. <a href="#ae178a9490f77c63ae55bd4ebe5e0d734">More...</a><br/></td></tr>
<tr class="separator:ae178a9490f77c63ae55bd4ebe5e0d734"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a646c53ee66798e560dbbcfa89e2178"><td class="memItemLeft" align="right" valign="top">LAAW_UINT32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#a9a646c53ee66798e560dbbcfa89e2178">GetHeight</a> ()</td></tr>
<tr class="memdesc:a9a646c53ee66798e560dbbcfa89e2178"><td class="mdescLeft"> </td><td class="mdescRight">Get the height of the 2D image. <a href="#a9a646c53ee66798e560dbbcfa89e2178">More...</a><br/></td></tr>
<tr class="separator:a9a646c53ee66798e560dbbcfa89e2178"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a163dd453a1899fdd24f4a97ef5122d9a"><td class="memItemLeft" align="right" valign="top">LAAW_UINT32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#a163dd453a1899fdd24f4a97ef5122d9a">GetPitch</a> ()</td></tr>
<tr class="memdesc:a163dd453a1899fdd24f4a97ef5122d9a"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of bytes between two lines of the image (pitch). <a href="#a163dd453a1899fdd24f4a97ef5122d9a">More...</a><br/></td></tr>
<tr class="separator:a163dd453a1899fdd24f4a97ef5122d9a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f23d556c0dfff6483f022650e28c217"><td class="memItemLeft" align="right" valign="top">inline::Orthanc::PixelFormat </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#a7f23d556c0dfff6483f022650e28c217">GetPixelFormat</a> ()</td></tr>
<tr class="memdesc:a7f23d556c0dfff6483f022650e28c217"><td class="mdescLeft"> </td><td class="mdescRight">Get the format of the pixels of the 2D image. <a href="#a7f23d556c0dfff6483f022650e28c217">More...</a><br/></td></tr>
<tr class="separator:a7f23d556c0dfff6483f022650e28c217"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4b899a18b18628bff0243848e66dc59"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#aa4b899a18b18628bff0243848e66dc59">GetBuffer</a> ()</td></tr>
<tr class="memdesc:aa4b899a18b18628bff0243848e66dc59"><td class="mdescLeft"> </td><td class="mdescRight">Access the memory buffer in which the raw pixels of the 2D image are stored. <a href="#aa4b899a18b18628bff0243848e66dc59">More...</a><br/></td></tr>
<tr class="separator:aa4b899a18b18628bff0243848e66dc59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a77fef4b8fbcef152f921e287ef2894"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#a8a77fef4b8fbcef152f921e287ef2894">GetBuffer</a> (LAAW_UINT32 y)</td></tr>
<tr class="memdesc:a8a77fef4b8fbcef152f921e287ef2894"><td class="mdescLeft"> </td><td class="mdescRight">Access the memory buffer in which the raw pixels of some line of the 2D image are stored. <a href="#a8a77fef4b8fbcef152f921e287ef2894">More...</a><br/></td></tr>
<tr class="separator:a8a77fef4b8fbcef152f921e287ef2894"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc757c1523f8ce3a8d68b7f5894d08ef"><td class="memItemLeft" align="right" valign="top">LAAW_UINT64 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#abc757c1523f8ce3a8d68b7f5894d08ef">GetDicomSize</a> ()</td></tr>
<tr class="memdesc:abc757c1523f8ce3a8d68b7f5894d08ef"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the DICOM file corresponding to this instance. <a href="#abc757c1523f8ce3a8d68b7f5894d08ef">More...</a><br/></td></tr>
<tr class="separator:abc757c1523f8ce3a8d68b7f5894d08ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a503d262f1bcb724b1e4ad50f22c38cd1"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#a503d262f1bcb724b1e4ad50f22c38cd1">GetDicom</a> ()</td></tr>
<tr class="memdesc:a503d262f1bcb724b1e4ad50f22c38cd1"><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the content of the DICOM file corresponding to this instance. <a href="#a503d262f1bcb724b1e4ad50f22c38cd1">More...</a><br/></td></tr>
<tr class="separator:a503d262f1bcb724b1e4ad50f22c38cd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82d145015a82303ff78e8f55c728da33"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#a82d145015a82303ff78e8f55c728da33">DiscardImage</a> ()</td></tr>
<tr class="separator:a82d145015a82303ff78e8f55c728da33"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e369a765be9560362f0d10b0fdfe6dc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOrthancClient_1_1Instance.html#a1e369a765be9560362f0d10b0fdfe6dc">DiscardDicom</a> ()</td></tr>
<tr class="separator:a1e369a765be9560362f0d10b0fdfe6dc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class encapsulates a connection to an image instance from a remote instance of Orthanc. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3abd07cc2d11cb0ca76f83b459d981d7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">OrthancClient::Instance::Instance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOrthancClient_1_1Instance.html">Instance</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new reference to this object. Pay attention to the fact that when the referenced object is deleted, the content of this object will be invalid.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The original object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afec1cb05011cae6fc5543ab82d78419a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">OrthancClient::Instance::Instance </td>
<td>(</td>
<td class="paramtype">::<a class="el" href="classOrthancClient_1_1OrthancConnection.html">OrthancClient::OrthancConnection</a> & </td>
<td class="paramname"><em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ::std::string & </td>
<td class="paramname"><em>id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a connection to some image instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">connection</td><td>The remote instance of Orthanc. </td></tr>
<tr><td class="paramname">id</td><td>The Orthanc identifier of the image instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7cb37b5e86de4eea2bd8fed70c780376"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">OrthancClient::Instance::~Instance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructs the object. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1e369a765be9560362f0d10b0fdfe6dc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OrthancClient::Instance::DiscardDicom </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Discard the downloaded DICOM file, so as to make room in memory. </p>
</div>
</div>
<a class="anchor" id="a82d145015a82303ff78e8f55c728da33"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OrthancClient::Instance::DiscardImage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Discard the downloaded 2D image, so as to make room in memory. </p>
</div>
</div>
<a class="anchor" id="aa4b899a18b18628bff0243848e66dc59"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const void * OrthancClient::Instance::GetBuffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access the memory buffer in which the raw pixels of the 2D image are stored.</p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the memory buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a8a77fef4b8fbcef152f921e287ef2894"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const void * OrthancClient::Instance::GetBuffer </td>
<td>(</td>
<td class="paramtype">LAAW_UINT32 </td>
<td class="paramname"><em>y</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access the memory buffer in which the raw pixels of some line of the 2D image are stored.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">y</td><td>The line of interest. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the memory buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a503d262f1bcb724b1e4ad50f22c38cd1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const void * OrthancClient::Instance::GetDicom </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a pointer to the content of the DICOM file corresponding to this instance.</p>
<dl class="section return"><dt>Returns</dt><dd>The DICOM file. </dd></dl>
</div>
</div>
<a class="anchor" id="abc757c1523f8ce3a8d68b7f5894d08ef"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LAAW_UINT64 OrthancClient::Instance::GetDicomSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the size of the DICOM file corresponding to this instance.</p>
<dl class="section return"><dt>Returns</dt><dd>The file size. </dd></dl>
</div>
</div>
<a class="anchor" id="a9a646c53ee66798e560dbbcfa89e2178"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LAAW_UINT32 OrthancClient::Instance::GetHeight </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the height of the 2D image that is encoded by this DICOM instance.</p>
<dl class="section return"><dt>Returns</dt><dd>The height. </dd></dl>
</div>
</div>
<a class="anchor" id="ac1f59a554e7240a832f345e58785715b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string OrthancClient::Instance::GetId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the Orthanc identifier of this identifier.</p>
<dl class="section return"><dt>Returns</dt><dd>The identifier. </dd></dl>
</div>
</div>
<a class="anchor" id="ad7ccf92e0edd62d4e3e6d1e062f0b5ac"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Global.html#gae630d9dc0d9a970a22f6570e3ef0045e">Orthanc::ImageExtractionMode</a> OrthancClient::Instance::GetImageExtractionMode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the extraction mode for the 2D image corresponding to this instance.</p>
<dl class="section return"><dt>Returns</dt><dd>The extraction mode. </dd></dl>
</div>
</div>
<a class="anchor" id="a163dd453a1899fdd24f4a97ef5122d9a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LAAW_UINT32 OrthancClient::Instance::GetPitch </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of bytes between two lines of the image in the memory buffer returned by <a class="el" href="classOrthancClient_1_1Instance.html#aa4b899a18b18628bff0243848e66dc59" title="Access the memory buffer in which the raw pixels of the 2D image are stored.">GetBuffer()</a>. This value depends on the extraction mode for the image.</p>
<dl class="section return"><dt>Returns</dt><dd>The pitch. </dd></dl>
</div>
</div>
<a class="anchor" id="a7f23d556c0dfff6483f022650e28c217"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Global.html#ga8289259779eb870aa3d5cb6bb6ab093e">Orthanc::PixelFormat</a> OrthancClient::Instance::GetPixelFormat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the memory layout that is used for the 2D image that is encoded by this DICOM instance. This value depends on the extraction mode for the image.</p>
<dl class="section return"><dt>Returns</dt><dd>The pixel format. </dd></dl>
</div>
</div>
<a class="anchor" id="a3061726f7c5895b835c5430e458046b1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float OrthancClient::Instance::GetTagAsFloat </td>
<td>(</td>
<td class="paramtype">const ::std::string & </td>
<td class="paramname"><em>tag</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the floating point value that is stored in some DICOM tag of this instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tag</td><td>The name of the tag of interest. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value of the tag. </dd></dl>
</div>
</div>
<a class="anchor" id="a3ee0196e57d7699961f7eed776275568"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LAAW_INT32 OrthancClient::Instance::GetTagAsInt </td>
<td>(</td>
<td class="paramtype">const ::std::string & </td>
<td class="paramname"><em>tag</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the integer value that is stored in some DICOM tag of this instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tag</td><td>The name of the tag of interest. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value of the tag. </dd></dl>
</div>
</div>
<a class="anchor" id="ae6802472d59f3c70c9ac25144a7dbe26"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string OrthancClient::Instance::GetTagAsString </td>
<td>(</td>
<td class="paramtype">const ::std::string & </td>
<td class="paramname"><em>tag</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the string value of some DICOM tag of this instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tag</td><td>The name of the tag of interest. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value of the tag. </dd></dl>
</div>
</div>
<a class="anchor" id="ae178a9490f77c63ae55bd4ebe5e0d734"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LAAW_UINT32 OrthancClient::Instance::GetWidth </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the width of the 2D image that is encoded by this DICOM instance.</p>
<dl class="section return"><dt>Returns</dt><dd>The width. </dd></dl>
</div>
</div>
<a class="anchor" id="a470453200491b87db4b32e4d8f791042"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OrthancClient::Instance::SetImageExtractionMode </td>
<td>(</td>
<td class="paramtype">::<a class="el" href="group__Global.html#gae630d9dc0d9a970a22f6570e3ef0045e">Orthanc::ImageExtractionMode</a> </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the extraction mode for the 2D image corresponding to this instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>The extraction mode. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OrthancCppClient_8h_source.html">OrthancCppClient.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Nov 8 2013 16:49:51 for Orthanc Client by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
