# CSJ2K.j2k.roi.encoder.ROIMaskGenerator

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="CSJ2K_j2k_roi_encoder_ROIMaskGenerator" data-uid="CSJ2K.j2k.roi.encoder.ROIMaskGenerator" class="text-break">ROIMaskGenerator Class
</h1>
  <div class="markdown level0 summary"></div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><span class="xref">ROIMaskGenerator</span></div>
      <div class="level2"><a class="xref" href="CSJ2K.j2k.roi.encoder.ArbROIMaskGenerator.html">ArbROIMaskGenerator</a></div>
      <div class="level2"><a class="xref" href="CSJ2K.j2k.roi.encoder.RectROIMaskGenerator.html">RectROIMaskGenerator</a></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="CSJ2K.j2k.roi.encoder.html">CSJ2K.j2k.roi.encoder</a></h6>
  <h6><strong>Assembly</strong>: C1.C1Pdf.4.8.dll</h6>
  <h5 id="CSJ2K_j2k_roi_encoder_ROIMaskGenerator_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract class ROIMaskGenerator</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public MustInherit Class ROIMaskGenerator</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROIMaskGenerator__ctor_CSJ2K_j2k_roi_encoder_ROI___System_Int32_" data-uid="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.#ctor(CSJ2K.j2k.roi.encoder.ROI[],System.Int32)">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.-ctor.html#CSJ2K_j2k_roi_encoder_ROIMaskGenerator__ctor_CSJ2K_j2k_roi_encoder_ROI___System_Int32_">ROIMaskGenerator(ROI[], int)</a>
        </td>
        <td class="markdown level1 summary"><p>The constructor of the mask generator</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="fields">Fields
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROIMaskGenerator_nrc" data-uid="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.nrc">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.nrc.html">nrc</a>
        </td>
        <td class="markdown level1 summary"><p>Number of components</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROIMaskGenerator_roiInTile" data-uid="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.roiInTile">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.roiInTile.html">roiInTile</a>
        </td>
        <td class="markdown level1 summary"></td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROIMaskGenerator_roi_array" data-uid="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.roi_array">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.roi_array.html">roi_array</a>
        </td>
        <td class="markdown level1 summary"><p>Array containing the ROIs</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROIMaskGenerator_tileMaskMade" data-uid="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.tileMaskMade">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.tileMaskMade.html">tileMaskMade</a>
        </td>
        <td class="markdown level1 summary"><p>Flag indicating whether a mask has been made for the current tile</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROIMaskGenerator_ROIs" data-uid="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.ROIs">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.ROIs.html#CSJ2K_j2k_roi_encoder_ROIMaskGenerator_ROIs">ROIs</a>
        </td>
        <td class="markdown level1 summary"><p>This function returns the ROIs in the image</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROIMaskGenerator_getROIMask_CSJ2K_j2k_image_DataBlkInt_CSJ2K_j2k_wavelet_Subband_System_Int32_System_Int32_" data-uid="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.getROIMask(CSJ2K.j2k.image.DataBlkInt,CSJ2K.j2k.wavelet.Subband,System.Int32,System.Int32)">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.getROIMask.html#CSJ2K_j2k_roi_encoder_ROIMaskGenerator_getROIMask_CSJ2K_j2k_image_DataBlkInt_CSJ2K_j2k_wavelet_Subband_System_Int32_System_Int32_">getROIMask(DataBlkInt, Subband, int, int)</a>
        </td>
        <td class="markdown level1 summary"><p>This functions gets a DataBlk with the size of the current code-block
and fills it with the ROI mask. The lowest scaling value in the mask
for this code-block is returned by the function to be used for
modifying the rate distortion estimations.</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROIMaskGenerator_makeMask_CSJ2K_j2k_wavelet_Subband_System_Int32_System_Int32_" data-uid="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.makeMask(CSJ2K.j2k.wavelet.Subband,System.Int32,System.Int32)">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.makeMask.html#CSJ2K_j2k_roi_encoder_ROIMaskGenerator_makeMask_CSJ2K_j2k_wavelet_Subband_System_Int32_System_Int32_">makeMask(Subband, int, int)</a>
        </td>
        <td class="markdown level1 summary"><p>This function generates the ROI mask for the entire tile. The mask is
generated for one component. This method is called once for each tile
and component.</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROIMaskGenerator_tileChanged" data-uid="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.tileChanged">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.tileChanged.html#CSJ2K_j2k_roi_encoder_ROIMaskGenerator_tileChanged">tileChanged()</a>
        </td>
        <td class="markdown level1 summary"><p>This function is called every time the tile is changed to indicate
that there is need to make a new mask</p>
</td>
      </tr>
    </tbody>
  </table>

</div>