swh:1:snp:e6d42e6731ce66e3c09de07ac49964c03139e990
Tip revision: 26b818c8be2be41dd673d938b403c5c7562635de authored by Travis CI on 28 November 2019, 13:55:12 UTC
Deploy code docs to GitHub Pages Travis build: 305
Deploy code docs to GitHub Pages Travis build: 305
Tip revision: 26b818c
classitk_1_1_image_file_reader_k_w.html
<!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.6"/>
<title>Tomato: itk::ImageFileReaderKW< TOutputImage, ConvertPixelTraits > Class Template 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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 style="padding-left: 0.5em;">
<div id="projectname">Tomato
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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="pages.html"><span>Related Pages</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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classitk_1_1_image_file_reader_k_w.html','');});
</script>
<div id="doc-content">
<!-- 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>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Pages</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 class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classitk_1_1_image_file_reader_k_w-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">itk::ImageFileReaderKW< TOutputImage, ConvertPixelTraits > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Data source that reads image data from a single file.
<a href="classitk_1_1_image_file_reader_k_w.html#details">More...</a></p>
<p><code>#include <<a class="el" href="itk_image_file_reader_k_w_8h_source.html">itkImageFileReaderKW.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for itk::ImageFileReaderKW< TOutputImage, ConvertPixelTraits >:</div>
<div class="dyncontent">
<div class="center"><img src="classitk_1_1_image_file_reader_k_w__inherit__graph.png" border="0" usemap="#itk_1_1_image_file_reader_k_w_3_01_t_output_image_00_01_convert_pixel_traits_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="itk_1_1_image_file_reader_k_w_3_01_t_output_image_00_01_convert_pixel_traits_01_4_inherit__map" id="itk_1_1_image_file_reader_k_w_3_01_t_output_image_00_01_convert_pixel_traits_01_4_inherit__map">
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for itk::ImageFileReaderKW< TOutputImage, ConvertPixelTraits >:</div>
<div class="dyncontent">
<div class="center"><img src="classitk_1_1_image_file_reader_k_w__coll__graph.png" border="0" usemap="#itk_1_1_image_file_reader_k_w_3_01_t_output_image_00_01_convert_pixel_traits_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="itk_1_1_image_file_reader_k_w_3_01_t_output_image_00_01_convert_pixel_traits_01_4_coll__map" id="itk_1_1_image_file_reader_k_w_3_01_t_output_image_00_01_convert_pixel_traits_01_4_coll__map">
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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:a6616e1e0fe9f4aceb7f693250b5f5b5c"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classitk_1_1_image_file_reader_k_w.html">ImageFileReaderKW</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a6616e1e0fe9f4aceb7f693250b5f5b5c">Self</a></td></tr>
<tr class="separator:a6616e1e0fe9f4aceb7f693250b5f5b5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb5a9f09477bb47f45a4faf6832e74e4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb5a9f09477bb47f45a4faf6832e74e4"></a>
typedef ImageSource< TOutputImage > </td><td class="memItemRight" valign="bottom"><b>Superclass</b></td></tr>
<tr class="separator:afb5a9f09477bb47f45a4faf6832e74e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05a8d76fe334c335c3c432de498ca087"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05a8d76fe334c335c3c432de498ca087"></a>
typedef SmartPointer< <a class="el" href="classitk_1_1_image_file_reader_k_w.html#a6616e1e0fe9f4aceb7f693250b5f5b5c">Self</a> > </td><td class="memItemRight" valign="bottom"><b>Pointer</b></td></tr>
<tr class="separator:a05a8d76fe334c335c3c432de498ca087"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a7f4acf918af20f820cdb57ab4ae18d"><td class="memItemLeft" align="right" valign="top">typedef TOutputImage::SizeType </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a7a7f4acf918af20f820cdb57ab4ae18d">SizeType</a></td></tr>
<tr class="separator:a7a7f4acf918af20f820cdb57ab4ae18d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9daa1ecf6fe0192e6ea86f9bf9785912"><td class="memItemLeft" align="right" valign="top">typedef TOutputImage::IndexType </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a9daa1ecf6fe0192e6ea86f9bf9785912">IndexType</a></td></tr>
<tr class="separator:a9daa1ecf6fe0192e6ea86f9bf9785912"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb29601addf7afcf200728eafc93dccd"><td class="memItemLeft" align="right" valign="top">typedef TOutputImage::RegionType </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#aeb29601addf7afcf200728eafc93dccd">ImageRegionType</a></td></tr>
<tr class="separator:aeb29601addf7afcf200728eafc93dccd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3bc68922731e94450245260bc9eced45"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
TOutputImage::InternalPixelType </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a3bc68922731e94450245260bc9eced45">OutputImagePixelType</a></td></tr>
<tr class="separator:a3bc68922731e94450245260bc9eced45"><td class="memSeparator" colspan="2"> </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:a4513482202af52da330f62385fe410d2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a4513482202af52da330f62385fe410d2">itkNewMacro</a> (<a class="el" href="classitk_1_1_image_file_reader_k_w.html#a6616e1e0fe9f4aceb7f693250b5f5b5c">Self</a>)</td></tr>
<tr class="separator:a4513482202af52da330f62385fe410d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47c81c07c8aee4750469f79c97076e87"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a47c81c07c8aee4750469f79c97076e87">itkTypeMacro</a> (<a class="el" href="classitk_1_1_image_file_reader_k_w.html">ImageFileReaderKW</a>, ImageSource)</td></tr>
<tr class="separator:a47c81c07c8aee4750469f79c97076e87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab33b100a76cddfc01310a5b167994cd7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#ab33b100a76cddfc01310a5b167994cd7">itkSetGetDecoratedInputMacro</a> (FileName, std::string)</td></tr>
<tr class="separator:ab33b100a76cddfc01310a5b167994cd7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f6df1f414ee32ffc1a7042a2ac7769d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a5f6df1f414ee32ffc1a7042a2ac7769d">SetImageIO</a> (ImageIOBase *imageIO)</td></tr>
<tr class="separator:a5f6df1f414ee32ffc1a7042a2ac7769d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a34921bf522b330b9d2a6904019fea262"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34921bf522b330b9d2a6904019fea262"></a>
 </td><td class="memItemRight" valign="bottom"><b>itkGetModifiableObjectMacro</b> (ImageIO, ImageIOBase)</td></tr>
<tr class="separator:a34921bf522b330b9d2a6904019fea262"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adabd23848a1de6aaefe2108eed86de30"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#adabd23848a1de6aaefe2108eed86de30">itkSetMacro</a> (UseStreaming, bool)</td></tr>
<tr class="separator:adabd23848a1de6aaefe2108eed86de30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa762efa75974bceb3af017e411962d01"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa762efa75974bceb3af017e411962d01"></a>
 </td><td class="memItemRight" valign="bottom"><b>itkGetConstReferenceMacro</b> (UseStreaming, bool)</td></tr>
<tr class="separator:aa762efa75974bceb3af017e411962d01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a024a210a9cf0362a910f08efce300ce9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a024a210a9cf0362a910f08efce300ce9"></a>
 </td><td class="memItemRight" valign="bottom"><b>itkBooleanMacro</b> (UseStreaming)</td></tr>
<tr class="separator:a024a210a9cf0362a910f08efce300ce9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:abeb559364dac015e1430ef6fa0086d33"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abeb559364dac015e1430ef6fa0086d33"></a>
void </td><td class="memItemRight" valign="bottom"><b>PrintSelf</b> (std::ostream &os, Indent indent) const ITK_OVERRIDE</td></tr>
<tr class="separator:abeb559364dac015e1430ef6fa0086d33"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a36590b67313b769b377ab84dab64e6dc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a36590b67313b769b377ab84dab64e6dc">DoConvertBuffer</a> (void *buffer, size_t numberOfPixels)</td></tr>
<tr class="separator:a36590b67313b769b377ab84dab64e6dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68e1c6d1289530941de1424844f481b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a68e1c6d1289530941de1424844f481b5">TestFileExistanceAndReadability</a> ()</td></tr>
<tr class="separator:a68e1c6d1289530941de1424844f481b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5fc2235fca283e451de26035fd237cda"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a5fc2235fca283e451de26035fd237cda">GenerateOutputInformation</a> (void) ITK_OVERRIDE</td></tr>
<tr class="separator:a5fc2235fca283e451de26035fd237cda"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a313f37f91aad5e0c91fe9b37b9f1e156"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a313f37f91aad5e0c91fe9b37b9f1e156">EnlargeOutputRequestedRegion</a> (DataObject *output) ITK_OVERRIDE</td></tr>
<tr class="separator:a313f37f91aad5e0c91fe9b37b9f1e156"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1096f13bf512a24092565fa6a3a82508"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a1096f13bf512a24092565fa6a3a82508">GenerateData</a> () ITK_OVERRIDE</td></tr>
<tr class="separator:a1096f13bf512a24092565fa6a3a82508"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ad8257c25171cf6c698f19ece08189535"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8257c25171cf6c698f19ece08189535"></a>
ImageIOBase::Pointer </td><td class="memItemRight" valign="bottom"><b>m_ImageIO</b></td></tr>
<tr class="separator:ad8257c25171cf6c698f19ece08189535"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7a9a3dacdffcbfca83153ff40665ac4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7a9a3dacdffcbfca83153ff40665ac4"></a>
bool </td><td class="memItemRight" valign="bottom"><b>m_UserSpecifiedImageIO</b></td></tr>
<tr class="separator:ab7a9a3dacdffcbfca83153ff40665ac4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b56980da3e50436905c3ae5731fc557"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b56980da3e50436905c3ae5731fc557"></a>
bool </td><td class="memItemRight" valign="bottom"><b>m_UseStreaming</b></td></tr>
<tr class="separator:a7b56980da3e50436905c3ae5731fc557"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename TOutputImage, typename ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >><br/>
class itk::ImageFileReaderKW< TOutputImage, ConvertPixelTraits ></h3>
<p>Data source that reads image data from a single file. </p>
<p>This source object is a general filter to read data from a variety of file formats. It works with a ImageIOBase subclass to actually do the reading of the data. Object factory machinery can be used to automatically create the ImageIOBase, or the ImageIOBase can be manually created and set. Note that this class reads data from a single file; if you wish to read data from a series of files use ImageSeriesReader.</p>
<p>TOutputImage is the type expected by the external users of the filter. If data stored in the file is stored in a different format then specified by TOutputImage, than this filter converts data between the file type and the external expected type. The ConvertTraits template argument is used to do the conversion.</p>
<p>A Pluggable factory pattern is used this allows different kinds of readers to be registered (even at run time) without having to modify the code in this class. Normally just setting the FileName with the appropriate suffix is enough to get the reader to instantiate the correct ImageIO and read the file properly. However, some files (like raw binary format) have no accepted suffix, so you will have to manually create the ImageIO instance of the write type.</p>
<dl class="section see"><dt>See Also</dt><dd>ImageSeriesReader </dd>
<dd>
ImageIOBase</dd></dl>
<p>{IO/ReadVectorImage,Read an image file with an unknown number of components} {IO/ReadUnknownImageType,Read an image file without knowing its type before hand} {IO/ImageFileReaderKW,Read an image} </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="aeb29601addf7afcf200728eafc93dccd"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >> </div>
<table class="memname">
<tr>
<td class="memname">typedef TOutputImage::RegionType <a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::<a class="el" href="classitk_1_1_image_file_reader_k_w.html#aeb29601addf7afcf200728eafc93dccd">ImageRegionType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The region of the output image. </p>
</div>
</div>
<a class="anchor" id="a9daa1ecf6fe0192e6ea86f9bf9785912"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >> </div>
<table class="memname">
<tr>
<td class="memname">typedef TOutputImage::IndexType <a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::<a class="el" href="classitk_1_1_image_file_reader_k_w.html#a9daa1ecf6fe0192e6ea86f9bf9785912">IndexType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The size of the output image. </p>
</div>
</div>
<a class="anchor" id="a3bc68922731e94450245260bc9eced45"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >> </div>
<table class="memname">
<tr>
<td class="memname">typedef TOutputImage::InternalPixelType <a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::<a class="el" href="classitk_1_1_image_file_reader_k_w.html#a3bc68922731e94450245260bc9eced45">OutputImagePixelType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The pixel type of the output image. </p>
</div>
</div>
<a class="anchor" id="a6616e1e0fe9f4aceb7f693250b5f5b5c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classitk_1_1_image_file_reader_k_w.html">ImageFileReaderKW</a> <a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::<a class="el" href="classitk_1_1_image_file_reader_k_w.html#a6616e1e0fe9f4aceb7f693250b5f5b5c">Self</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Standard class typedefs. </p>
</div>
</div>
<a class="anchor" id="a7a7f4acf918af20f820cdb57ab4ae18d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >> </div>
<table class="memname">
<tr>
<td class="memname">typedef TOutputImage::SizeType <a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::<a class="el" href="classitk_1_1_image_file_reader_k_w.html#a7a7f4acf918af20f820cdb57ab4ae18d">SizeType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The size of the output image. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a36590b67313b769b377ab84dab64e6dc"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::DoConvertBuffer </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>numberOfPixels</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">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a block of pixels from one type to another. </p>
</div>
</div>
<a class="anchor" id="a313f37f91aad5e0c91fe9b37b9f1e156"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::EnlargeOutputRequestedRegion </td>
<td>(</td>
<td class="paramtype">DataObject * </td>
<td class="paramname"><em>output</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Give the reader a chance to indicate that it will produce more output than it was requested to produce. <a class="el" href="classitk_1_1_image_file_reader_k_w.html" title="Data source that reads image data from a single file. ">ImageFileReaderKW</a> cannot currently read a portion of an image (since the ImageIO objects cannot read a portion of an image), so the <a class="el" href="classitk_1_1_image_file_reader_k_w.html" title="Data source that reads image data from a single file. ">ImageFileReaderKW</a> must enlarge the RequestedRegion to the size of the image on disk. </p>
</div>
</div>
<a class="anchor" id="a1096f13bf512a24092565fa6a3a82508"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::GenerateData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Does the real work. </p>
</div>
</div>
<a class="anchor" id="a5fc2235fca283e451de26035fd237cda"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::GenerateOutputInformation </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Prepare the allocation of the output image during the first back propagation of the pipeline. </p>
</div>
</div>
<a class="anchor" id="a4513482202af52da330f62385fe410d2"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::itkNewMacro </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classitk_1_1_image_file_reader_k_w.html#a6616e1e0fe9f4aceb7f693250b5f5b5c">Self</a> </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Method for creation through the object factory. </p>
</div>
</div>
<a class="anchor" id="ab33b100a76cddfc01310a5b167994cd7"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::itkSetGetDecoratedInputMacro </td>
<td>(</td>
<td class="paramtype">FileName </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specify the file to read. This is forwarded to the IO instance. </p>
</div>
</div>
<a class="anchor" id="adabd23848a1de6aaefe2108eed86de30"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::itkSetMacro </td>
<td>(</td>
<td class="paramtype">UseStreaming </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the stream On or Off </p>
</div>
</div>
<a class="anchor" id="a47c81c07c8aee4750469f79c97076e87"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::itkTypeMacro </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classitk_1_1_image_file_reader_k_w.html">ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits > </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ImageSource </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Run-time type information (and related methods). </p>
</div>
</div>
<a class="anchor" id="a5f6df1f414ee32ffc1a7042a2ac7769d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::SetImageIO </td>
<td>(</td>
<td class="paramtype">ImageIOBase * </td>
<td class="paramname"><em>imageIO</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set/Get the ImageIO helper class. Often this is created via the object factory mechanism that determines whether a particular ImageIO can read a certain file. This method provides a way to get the ImageIO instance that is created. Or you can directly specify the ImageIO to use to read a particular file in case the factory mechanism will not work properly (e.g., unknown or unusual extension). </p>
</div>
</div>
<a class="anchor" id="a68e1c6d1289530941de1424844f481b5"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename TOutputImage , typename ConvertPixelTraits > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1_image_file_reader_k_w.html">itk::ImageFileReaderKW</a>< TOutputImage, ConvertPixelTraits >::TestFileExistanceAndReadability </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Test whether the given filename exist and it is readable, this is intended to be called before attempting to use ImageIO classes for actually reading the file. If the file doesn't exist or it is not readable, and exception with an approriate message will be thrown. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>lib/<a class="el" href="itk_image_file_reader_k_w_8h_source.html">itkImageFileReaderKW.h</a></li>
<li>lib/<a class="el" href="itk_image_file_reader_k_w_8hxx_source.html">itkImageFileReaderKW.hxx</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>itk</b></li><li class="navelem"><a class="el" href="classitk_1_1_image_file_reader_k_w.html">ImageFileReaderKW</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>
