<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.imagick.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'imagick.sigmoidalcontrastimage.php',
    1 => 'Imagick::sigmoidalContrastImage',
    2 => 'Adjusts the contrast of an image',
  ),
  'up' => 
  array (
    0 => 'class.imagick.php',
    1 => 'Imagick',
  ),
  'prev' => 
  array (
    0 => 'imagick.shearimage.php',
    1 => 'Imagick::shearImage',
  ),
  'next' => 
  array (
    0 => 'imagick.sketchimage.php',
    1 => 'Imagick::sketchImage',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/imagick/imagick/sigmoidalcontrastimage.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="imagick.sigmoidalcontrastimage" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Imagick::sigmoidalContrastImage</h1>
  <p class="verinfo">(PECL imagick 2, PECL imagick 3)</p><p class="refpurpose"><span class="refname">Imagick::sigmoidalContrastImage</span> &mdash; <span class="dc-title">Adjusts the contrast of an image</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-imagick.sigmoidalcontrastimage-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>Imagick::sigmoidalContrastImage</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$sharpen</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$alpha</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$beta</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$channel</code><span class="initializer"> = Imagick::CHANNEL_DEFAULT</span></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Adjusts the contrast of an image with a non-linear sigmoidal contrast
   algorithm. Increase the contrast of the image using a sigmoidal transfer
   function without saturating highlights or shadows. <code class="parameter">alpha</code> indicates
   how much to increase the contrast: <code class="literal">0.00</code> is none; <code class="literal">3.00</code> is
   typical; <code class="literal">20.00</code> is pushing it.
   <code class="parameter">beta</code> indicates where midtones fall in the resultant
   image, as a fraction of the quantum range: <code class="literal">0.0</code> is white,
   <code class="literal">0.5</code> is middle-gray, <code class="literal">1.0</code> is black
   (multiply by <code class="code">getQuantumRange()[&#039;quantumRangeLong&#039;]</code> to get the value to
   pass).
  </p>
  <p class="simpara">
   See also <a href="https://usage.imagemagick.org/color_mods/#sigmoidal" class="link external">&raquo;&nbsp;ImageMagick
    Examples -- Color Modifications — Sigmoidal Non-linearity Contrast</a>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-imagick.sigmoidalcontrastimage-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">sharpen</code></dt>
     <dd>
      <p class="simpara">
       If <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> increase the contrast, if <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> decrease the contrast.
      </p>
     </dd>
    
    
     <dt><code class="parameter">alpha</code></dt>
     <dd>
      <p class="simpara">
       The amount of contrast to apply. <code class="literal">1.00</code> is very little, <code class="literal">5.00</code>
       is a significant amount, <code class="literal">20.00</code> is extreme.
      </p>
     </dd>
    
    
     <dt><code class="parameter">beta</code></dt>
     <dd>
      <p class="simpara">
       Where the midpoint of the gradient will be. This value should be in the range <code class="literal">0.00</code>
       to <code class="literal">1.00</code> - multiplied by the quantum value for ImageMagick.
      </p>
     </dd>
    
    
     <dt><code class="parameter">channel</code></dt>
     <dd>
      <p class="simpara">
       Which color channels the contrast will be applied to.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-imagick.sigmoidalcontrastimage-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   成功时返回 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>。
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-imagick.sigmoidalcontrastimage-errors">
  <h3 class="title">错误／异常</h3>
  <p class="para">
   错误时抛出 ImagickException。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-imagick.sigmoidalcontrastimage-examples">
  <h3 class="title">示例</h3>
  <div class="example" id="example-1">
   <p><strong>示例 #1 
    Create a gradient image using <span class="function"><strong>Imagick::sigmoidalContrastImage()</strong></span>
    suitable for blending two images together smoothly, with the blending
    defined by <code class="parameter">alpha</code> and <code class="parameter">beta</code>
   </strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php

</span><span style="color: #007700">function </span><span style="color: #0000BB">generateBlendImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$width</span><span style="color: #007700">, </span><span style="color: #0000BB">$height</span><span style="color: #007700">, </span><span style="color: #0000BB">$alpha </span><span style="color: #007700">= </span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #0000BB">$beta </span><span style="color: #007700">= </span><span style="color: #0000BB">0.5</span><span style="color: #007700">)
{
    </span><span style="color: #0000BB">$imagick </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">();
    </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">newPseudoImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$width</span><span style="color: #007700">, </span><span style="color: #0000BB">$height</span><span style="color: #007700">, </span><span style="color: #DD0000">'gradient:black-white'</span><span style="color: #007700">);
    </span><span style="color: #0000BB">$quanta </span><span style="color: #007700">= </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getQuantumRange</span><span style="color: #007700">();
    </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sigmoidalContrastImage</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">, </span><span style="color: #0000BB">$alpha</span><span style="color: #007700">, </span><span style="color: #0000BB">$beta </span><span style="color: #007700">* </span><span style="color: #0000BB">$quanta</span><span style="color: #007700">[</span><span style="color: #DD0000">"quantumRangeLong"</span><span style="color: #007700">]);

    return </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">;
}</span></code></pre></div>
   </div>

  </div>
 </div>


</div><?php manual_footer($setup); ?>