Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 60f1dc962abad0f3b492991a4fbef9be > files > 790

vtk-doc-5.4.2-5mdv2010.0.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: vtkImageLuminance Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>vtkImageLuminance Class Reference</h1><!-- doxytag: class="vtkImageLuminance" --><!-- doxytag: inherits="vtkThreadedImageAlgorithm" --><code>#include &lt;<a class="el" href="a04717.html">vtkImageLuminance.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkImageLuminance:</div>
<div class="dynsection">
<p><center><img src="a10971.png" border="0" usemap="#a10972" alt="Inheritance graph"></center>
<map name="a10972">
<area shape="rect" href="a01705.html" title="Generic filter that has one input.." alt="" coords="5,304,200,331"><area shape="rect" href="a00727.html" title="Generic algorithm superclass for image algs." alt="" coords="35,230,171,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="53,155,152,182"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="63,80,143,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="48,6,157,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkImageLuminance:</div>
<div class="dynsection">
<p><center><img src="a10973.png" border="0" usemap="#a10974" alt="Collaboration graph"></center>
<map name="a10974">
<area shape="rect" href="a01705.html" title="Generic filter that has one input.." alt="" coords="710,590,904,616"><area shape="rect" href="a00727.html" title="Generic algorithm superclass for image algs." alt="" coords="627,499,763,526"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="414,382,512,408"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="423,499,522,526"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="408,174,488,200"><area shape="rect" href="a00895.html" title="Store zero or more vtkInformation instances." alt="" coords="479,264,628,291"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="155,264,264,291"><area shape="rect" href="a01064.html" title="A class for performing multithreaded execution." alt="" coords="796,499,922,526"><area shape="rect" href="a01074.html" title="mutual exclusion locking class" alt="" coords="866,264,972,291"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="164,6,274,32"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="6,174,168,200"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="154,83,284,110"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="308,83,418,110"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="192,174,374,200"><area shape="rect" href="a01065.html" title="vtkMultiThreader::ThreadInfo" alt="" coords="1106,382,1306,408"><area shape="rect" href="a01552.html" title="vtkSimpleMutexLock" alt="" coords="846,174,992,200"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a10975.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Computes the luminance of the input. 
<p>
<a class="el" href="a00787.html" title="Computes the luminance of the input.">vtkImageLuminance</a> calculates luminance from an rgb input.<p>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_8.html#c2_vtk_t_vtkImageLuminance">vtkImageLuminance (Tests)</a> </dd></dl>

<p>Definition at line <a class="el" href="a04717.html#l00030">30</a> of file <a class="el" href="a04717.html">vtkImageLuminance.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a01705.html">vtkThreadedImageAlgorithm</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00787.html#5eaba0376c0d2d6e970d570a46cc9162">Superclass</a></td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00787.html#cc28fbbb6ab2f398eed20373366ad114">GetClassName</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00787.html#a6208c4d52d46e0300be563e31a2b07d">IsA</a> (const char *type)</td></tr>

<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00787.html">vtkImageLuminance</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00787.html#d4b2380aa5b253153a189ac2232e26fd">New</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00787.html#61e2e0d5037a09212afc77d273c88654">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00787.html">vtkImageLuminance</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00787.html#638d439edaa990fe4c5f02ebbed63aef">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00787.html#ba036994645c89f1d4c033a63ee1bfea">vtkImageLuminance</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00787.html#e3e773f3c0adc781012231751bff6fa8">~vtkImageLuminance</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00787.html#2335046ccf55814695942aa5f0fe275a">RequestInformation</a> (<a class="el" href="a00872.html">vtkInformation</a> *, <a class="el" href="a00895.html">vtkInformationVector</a> **, <a class="el" href="a00895.html">vtkInformationVector</a> *)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00787.html#6831e3da8d3f954a58baf3cac9f42322">ThreadedExecute</a> (<a class="el" href="a00751.html">vtkImageData</a> *inData, <a class="el" href="a00751.html">vtkImageData</a> *outData, int outExt[6], int id)</td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="5eaba0376c0d2d6e970d570a46cc9162"></a><!-- doxytag: member="vtkImageLuminance::Superclass" ref="5eaba0376c0d2d6e970d570a46cc9162" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a01705.html">vtkThreadedImageAlgorithm</a> <a class="el" href="a01705.html">vtkImageLuminance::Superclass</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a01705.html#67876177e53dbc18f91b9b50f8f03331">vtkThreadedImageAlgorithm</a>.</p>

<p>Definition at line <a class="el" href="a04717.html#l00034">34</a> of file <a class="el" href="a04717.html">vtkImageLuminance.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="ba036994645c89f1d4c033a63ee1bfea"></a><!-- doxytag: member="vtkImageLuminance::vtkImageLuminance" ref="ba036994645c89f1d4c033a63ee1bfea" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkImageLuminance::vtkImageLuminance           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="e3e773f3c0adc781012231751bff6fa8"></a><!-- doxytag: member="vtkImageLuminance::~vtkImageLuminance" ref="e3e773f3c0adc781012231751bff6fa8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkImageLuminance::~vtkImageLuminance           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04717.html#l00038">38</a> of file <a class="el" href="a04717.html">vtkImageLuminance.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d4b2380aa5b253153a189ac2232e26fd"></a><!-- doxytag: member="vtkImageLuminance::New" ref="d4b2380aa5b253153a189ac2232e26fd" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a00787.html">vtkImageLuminance</a>* vtkImageLuminance::New           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. 
<p>Reimplemented from <a class="el" href="a00101.html#06d80d8d4aa1a4856135fa003845be82">vtkAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="cc28fbbb6ab2f398eed20373366ad114"></a><!-- doxytag: member="vtkImageLuminance::GetClassName" ref="cc28fbbb6ab2f398eed20373366ad114" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkImageLuminance::GetClassName           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a01705.html#8622c920af18a6521f427d7b70613faa">vtkThreadedImageAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="61e2e0d5037a09212afc77d273c88654"></a><!-- doxytag: member="vtkImageLuminance::IsTypeOf" ref="61e2e0d5037a09212afc77d273c88654" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkImageLuminance::IsTypeOf           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. 
<p>Reimplemented from <a class="el" href="a01705.html#1e20b0feec3712e39d352e47d582ff4e">vtkThreadedImageAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="a6208c4d52d46e0300be563e31a2b07d"></a><!-- doxytag: member="vtkImageLuminance::IsA" ref="a6208c4d52d46e0300be563e31a2b07d" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkImageLuminance::IsA           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. 
<p>Reimplemented from <a class="el" href="a01705.html#250ac29fa902a270b6f94702f7f24e9b">vtkThreadedImageAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="638d439edaa990fe4c5f02ebbed63aef"></a><!-- doxytag: member="vtkImageLuminance::SafeDownCast" ref="638d439edaa990fe4c5f02ebbed63aef" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a00787.html">vtkImageLuminance</a>* vtkImageLuminance::SafeDownCast           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> *&nbsp;</td>
          <td class="paramname"> <em>o</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a01705.html#def8b2b0abda015b495884db6f717625">vtkThreadedImageAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="2335046ccf55814695942aa5f0fe275a"></a><!-- doxytag: member="vtkImageLuminance::RequestInformation" ref="2335046ccf55814695942aa5f0fe275a" args="(vtkInformation *, vtkInformationVector **, vtkInformationVector *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkImageLuminance::RequestInformation           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> **&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> *&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00727.html#b739abd84881f7e31a8a382bf5a06a91">vtkImageAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="6831e3da8d3f954a58baf3cac9f42322"></a><!-- doxytag: member="vtkImageLuminance::ThreadedExecute" ref="6831e3da8d3f954a58baf3cac9f42322" args="(vtkImageData *inData, vtkImageData *outData, int outExt[6], int id)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkImageLuminance::ThreadedExecute           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00751.html">vtkImageData</a> *&nbsp;</td>
          <td class="paramname"> <em>inData</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00751.html">vtkImageData</a> *&nbsp;</td>
          <td class="paramname"> <em>outData</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>outExt</em>[6], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>id</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a01705.html#6ba90d6d9626db478151ebf7d940122c">vtkThreadedImageAlgorithm</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Imaging/<a class="el" href="a04717.html">vtkImageLuminance.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:09:53 2009 for VTK by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>