<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Mon Nov 19 10:37:02 PST 2018 -->
<title>CompressionImpl</title>
<meta name="date" content="2018-11-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="CompressionImpl";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../com/digitalpersona/uareu/dpfj/EngineImpl.html" title="class in com.digitalpersona.uareu.dpfj"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/digitalpersona/uareu/dpfj/CompressionImpl.html" target="_top">Frames</a></li>
<li><a href="CompressionImpl.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.digitalpersona.uareu.dpfj</div>
<h2 title="Class CompressionImpl" class="title">Class CompressionImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.digitalpersona.uareu.dpfj.CompressionImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.digitalpersona.uareu.Compression</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">CompressionImpl</span>
extends java.lang.Object
implements com.digitalpersona.uareu.Compression</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_com.digitalpersona.uareu.Compression">
<!--   -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.digitalpersona.uareu.Compression</h3>
<code>com.digitalpersona.uareu.Compression.CompressionAlgorithm, com.digitalpersona.uareu.Compression.RawImage</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/digitalpersona/uareu/dpfj/CompressionImpl.html#CompressionImpl()">CompressionImpl</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>com.digitalpersona.uareu.Fid</code></td>
<td class="colLast"><code><strong><a href="../../../../com/digitalpersona/uareu/dpfj/CompressionImpl.html#CompressFid(com.digitalpersona.uareu.Fid,%20com.digitalpersona.uareu.Compression.CompressionAlgorithm)">CompressFid</a></strong>(com.digitalpersona.uareu.Fid&nbsp;fid,
           com.digitalpersona.uareu.Compression.CompressionAlgorithm&nbsp;compression_alg)</code>
<div class="block">Compresses FID.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/digitalpersona/uareu/dpfj/CompressionImpl.html#CompressRaw(byte[],%20int,%20int,%20int,%20int,%20com.digitalpersona.uareu.Compression.CompressionAlgorithm)">CompressRaw</a></strong>(byte[]&nbsp;data,
           int&nbsp;width,
           int&nbsp;height,
           int&nbsp;dpi,
           int&nbsp;bpp,
           com.digitalpersona.uareu.Compression.CompressionAlgorithm&nbsp;compression_alg)</code>
<div class="block">Compresses raw image.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>com.digitalpersona.uareu.Fid</code></td>
<td class="colLast"><code><strong><a href="../../../../com/digitalpersona/uareu/dpfj/CompressionImpl.html#ExpandFid(com.digitalpersona.uareu.Fid,%20com.digitalpersona.uareu.Compression.CompressionAlgorithm)">ExpandFid</a></strong>(com.digitalpersona.uareu.Fid&nbsp;fid,
         com.digitalpersona.uareu.Compression.CompressionAlgorithm&nbsp;compression_alg)</code>
<div class="block">Expands compressed FID.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.digitalpersona.uareu.Compression.RawImage</code></td>
<td class="colLast"><code><strong><a href="../../../../com/digitalpersona/uareu/dpfj/CompressionImpl.html#ExpandRaw(byte[],%20com.digitalpersona.uareu.Compression.CompressionAlgorithm)">ExpandRaw</a></strong>(byte[]&nbsp;data,
         com.digitalpersona.uareu.Compression.CompressionAlgorithm&nbsp;compression_alg)</code>
<div class="block">Expands compressed raw image.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/digitalpersona/uareu/dpfj/CompressionImpl.html#Finish()">Finish</a></strong>()</code>
<div class="block">Ends compression or decompression operation, releases memory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/digitalpersona/uareu/dpfj/CompressionImpl.html#SetWsqBitrate(int,%20int)">SetWsqBitrate</a></strong>(int&nbsp;bitrate_x100,
             int&nbsp;tolerance_aw)</code>
<div class="block">Sets target bitrate and tolerance for WSQ compression operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/digitalpersona/uareu/dpfj/CompressionImpl.html#SetWsqSize(int,%20int)">SetWsqSize</a></strong>(int&nbsp;size,
          int&nbsp;tolerance_aw)</code>
<div class="block">Sets target size and tolerance for WSQ compression operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/digitalpersona/uareu/dpfj/CompressionImpl.html#Start()">Start</a></strong>()</code>
<div class="block">Starts compression or decompression operation.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="CompressionImpl()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CompressionImpl</h4>
<pre>public&nbsp;CompressionImpl()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="Start()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Start</h4>
<pre>public&nbsp;void&nbsp;Start()
           throws com.digitalpersona.uareu.UareUException</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code>com.digitalpersona.uareu.Compression</code></strong></div>
<div class="block">Starts compression or decompression operation.
 <p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>Start</code>&nbsp;in interface&nbsp;<code>com.digitalpersona.uareu.Compression</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>com.digitalpersona.uareu.UareUException</code> - if failed to start operation.</dd></dl>
</li>
</ul>
<a name="Finish()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Finish</h4>
<pre>public&nbsp;void&nbsp;Finish()
            throws com.digitalpersona.uareu.UareUException</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code>com.digitalpersona.uareu.Compression</code></strong></div>
<div class="block">Ends compression or decompression operation, releases memory.
 <p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>Finish</code>&nbsp;in interface&nbsp;<code>com.digitalpersona.uareu.Compression</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>com.digitalpersona.uareu.UareUException</code> - if failed to finish operation.</dd></dl>
</li>
</ul>
<a name="SetWsqBitrate(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SetWsqBitrate</h4>
<pre>public&nbsp;void&nbsp;SetWsqBitrate(int&nbsp;bitrate_x100,
                 int&nbsp;tolerance_aw)
                   throws com.digitalpersona.uareu.UareUException</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code>com.digitalpersona.uareu.Compression</code></strong></div>
<div class="block">Sets target bitrate and tolerance for WSQ compression operation.
 <p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>SetWsqBitrate</code>&nbsp;in interface&nbsp;<code>com.digitalpersona.uareu.Compression</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>bitrate_x100</code> - Requested bitrate multiplied by 100. For example, to request bitrate of 4.19, pass 419.</dd><dd><code>tolerance_aw</code> - Sets tolerance in percents for the Aware WSQ compression. Range is 1 to 100. If NIST algorithm used this parameter will be ignored.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>com.digitalpersona.uareu.UareUException</code> - if failed to set bitrate.</dd></dl>
</li>
</ul>
<a name="SetWsqSize(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SetWsqSize</h4>
<pre>public&nbsp;void&nbsp;SetWsqSize(int&nbsp;size,
              int&nbsp;tolerance_aw)
                throws com.digitalpersona.uareu.UareUException</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code>com.digitalpersona.uareu.Compression</code></strong></div>
<div class="block">Sets target size and tolerance for WSQ compression operation.
 <p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>SetWsqSize</code>&nbsp;in interface&nbsp;<code>com.digitalpersona.uareu.Compression</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>size</code> - Requested size of compressed image.</dd><dd><code>tolerance_aw</code> - Sets tolerance in percents for the Aware WSQ compression. Range is 1 to 100. If NIST algorithm used this parameter will be ignored.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>com.digitalpersona.uareu.UareUException</code> - if failed to set bitrate.</dd></dl>
</li>
</ul>
<a name="CompressFid(com.digitalpersona.uareu.Fid, com.digitalpersona.uareu.Compression.CompressionAlgorithm)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CompressFid</h4>
<pre>public&nbsp;com.digitalpersona.uareu.Fid&nbsp;CompressFid(com.digitalpersona.uareu.Fid&nbsp;fid,
                                       com.digitalpersona.uareu.Compression.CompressionAlgorithm&nbsp;compression_alg)
                                         throws com.digitalpersona.uareu.UareUException</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code>com.digitalpersona.uareu.Compression</code></strong></div>
<div class="block">Compresses FID.
 <p>
 This function attempts to compress FID using Aware WSQ library (WSQ1000) or NIST algorithm. It's necessary to set target bitrate or
 target size before calling CompressFid(). The resulting size likely will differ from the requested size, or bitrate.
 How much the difference will be is dictated by the image, requested size or bitrate and tolerance (only for Aware algorithm).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>CompressFid</code>&nbsp;in interface&nbsp;<code>com.digitalpersona.uareu.Compression</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>fid</code> - FID to compress.</dd><dd><code>compression_alg</code> - Compression algorithm to use.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Compressed FID.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>com.digitalpersona.uareu.UareUException</code> - if failed to compress FID.</dd></dl>
</li>
</ul>
<a name="CompressRaw(byte[], int, int, int, int, com.digitalpersona.uareu.Compression.CompressionAlgorithm)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CompressRaw</h4>
<pre>public&nbsp;byte[]&nbsp;CompressRaw(byte[]&nbsp;data,
                 int&nbsp;width,
                 int&nbsp;height,
                 int&nbsp;dpi,
                 int&nbsp;bpp,
                 com.digitalpersona.uareu.Compression.CompressionAlgorithm&nbsp;compression_alg)
                   throws com.digitalpersona.uareu.UareUException</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code>com.digitalpersona.uareu.Compression</code></strong></div>
<div class="block">Compresses raw image.
 <p>
 This function attempts to compress image using Aware WSQ library (WSQ1000) or NIST algorithm. It's necessary to set target bitrate or
 target size before calling CompressRaw(). The resulting size likely will differ from the requested size, or bitrate.
 How much the difference will be is dictated by the image, requested size or bitrate and tolerance (only for Aware algorithm).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>CompressRaw</code>&nbsp;in interface&nbsp;<code>com.digitalpersona.uareu.Compression</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - Image to compress.</dd><dd><code>width</code> - Width of the image.</dd><dd><code>height</code> - Heght of the image.</dd><dd><code>dpi</code> - Resolution of the image in DPI.</dd><dd><code>bpp</code> - Pixel depth of the image.</dd><dd><code>compression_alg</code> - Compression algorithm to use.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Compressed raw image.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>com.digitalpersona.uareu.UareUException</code> - if failed to compress FID.</dd></dl>
</li>
</ul>
<a name="ExpandFid(com.digitalpersona.uareu.Fid, com.digitalpersona.uareu.Compression.CompressionAlgorithm)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ExpandFid</h4>
<pre>public&nbsp;com.digitalpersona.uareu.Fid&nbsp;ExpandFid(com.digitalpersona.uareu.Fid&nbsp;fid,
                                     com.digitalpersona.uareu.Compression.CompressionAlgorithm&nbsp;compression_alg)
                                       throws com.digitalpersona.uareu.UareUException</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code>com.digitalpersona.uareu.Compression</code></strong></div>
<div class="block">Expands compressed FID.
 <p>
 This function attempts to expand FID using Aware WSQ library (WSQ1000) or NIST algorithm.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>ExpandFid</code>&nbsp;in interface&nbsp;<code>com.digitalpersona.uareu.Compression</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>fid</code> - FID to expand.</dd><dd><code>compression_alg</code> - Compression algorithm to use.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Expanded FID.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>com.digitalpersona.uareu.UareUException</code> - if failed to compress FID.</dd></dl>
</li>
</ul>
<a name="ExpandRaw(byte[], com.digitalpersona.uareu.Compression.CompressionAlgorithm)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ExpandRaw</h4>
<pre>public&nbsp;com.digitalpersona.uareu.Compression.RawImage&nbsp;ExpandRaw(byte[]&nbsp;data,
                                                      com.digitalpersona.uareu.Compression.CompressionAlgorithm&nbsp;compression_alg)
                                                        throws com.digitalpersona.uareu.UareUException</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code>com.digitalpersona.uareu.Compression</code></strong></div>
<div class="block">Expands compressed raw image.
 <p>
 This function attempts to expand raw image using Aware WSQ library (WSQ1000) or NIST algorithm.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>ExpandRaw</code>&nbsp;in interface&nbsp;<code>com.digitalpersona.uareu.Compression</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - Compressed raw image to expand.</dd><dd><code>compression_alg</code> - Compression algorithm to use.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Expanded raw image.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>com.digitalpersona.uareu.UareUException</code> - if failed to compress FID.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../com/digitalpersona/uareu/dpfj/EngineImpl.html" title="class in com.digitalpersona.uareu.dpfj"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/digitalpersona/uareu/dpfj/CompressionImpl.html" target="_top">Frames</a></li>
<li><a href="CompressionImpl.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
