# CSJ2K.j2k.roi.encoder.ROI

## Content

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



  <h1 id="CSJ2K_j2k_roi_encoder_ROI" data-uid="CSJ2K.j2k.roi.encoder.ROI" class="text-break">ROI Class
</h1>
  <div class="markdown level0 summary"><p>This class contains the shape of a single ROI. In the current
implementation only rectangles and circles are supported.</p>
</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">ROI</span></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.WPF.ReportViewer.4.6.2.dll</h6>
  <h5 id="CSJ2K_j2k_roi_encoder_ROI_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class ROI</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class ROI</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_ROI__ctor_System_Int32_CSJ2K_j2k_image_input_ImgReaderPGM_" data-uid="CSJ2K.j2k.roi.encoder.ROI.#ctor(System.Int32,CSJ2K.j2k.image.input.ImgReaderPGM)">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.-ctor.html#CSJ2K_j2k_roi_encoder_ROI__ctor_System_Int32_CSJ2K_j2k_image_input_ImgReaderPGM_">ROI(int, ImgReaderPGM)</a>
        </td>
        <td class="markdown level1 summary"><p>Constructor for ROI with arbitrary shape</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROI__ctor_System_Int32_System_Int32_System_Int32_System_Int32_" data-uid="CSJ2K.j2k.roi.encoder.ROI.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.-ctor.html#CSJ2K_j2k_roi_encoder_ROI__ctor_System_Int32_System_Int32_System_Int32_System_Int32_">ROI(int, int, int, int)</a>
        </td>
        <td class="markdown level1 summary"><p>Constructor for circular ROIs</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROI__ctor_System_Int32_System_Int32_System_Int32_System_Int32_System_Int32_" data-uid="CSJ2K.j2k.roi.encoder.ROI.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.-ctor.html#CSJ2K_j2k_roi_encoder_ROI__ctor_System_Int32_System_Int32_System_Int32_System_Int32_System_Int32_">ROI(int, int, int, int, int)</a>
        </td>
        <td class="markdown level1 summary"><p>Constructor for rectangular ROIs</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_ROI_arbShape" data-uid="CSJ2K.j2k.roi.encoder.ROI.arbShape">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.arbShape.html">arbShape</a>
        </td>
        <td class="markdown level1 summary"><p>Where or not the ROI shape is arbitrary</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROI_comp" data-uid="CSJ2K.j2k.roi.encoder.ROI.comp">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.comp.html">comp</a>
        </td>
        <td class="markdown level1 summary"><p>The components for which the ROI is relevant</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROI_h" data-uid="CSJ2K.j2k.roi.encoder.ROI.h">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.h.html">h</a>
        </td>
        <td class="markdown level1 summary"><p>height of rectangular ROI</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROI_maskPGM" data-uid="CSJ2K.j2k.roi.encoder.ROI.maskPGM">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.maskPGM.html">maskPGM</a>
        </td>
        <td class="markdown level1 summary"><p>ImgReaderPGM object with the arbrtrary ROI</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROI_r" data-uid="CSJ2K.j2k.roi.encoder.ROI.r">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.r.html">r</a>
        </td>
        <td class="markdown level1 summary"><p>radius of circular ROI</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROI_rect" data-uid="CSJ2K.j2k.roi.encoder.ROI.rect">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.rect.html">rect</a>
        </td>
        <td class="markdown level1 summary"><p>Flag indicating whether the ROI is rectangular or not</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROI_ulx" data-uid="CSJ2K.j2k.roi.encoder.ROI.ulx">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.ulx.html">ulx</a>
        </td>
        <td class="markdown level1 summary"><p>x coordinate of upper left corner of rectangular ROI</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROI_uly" data-uid="CSJ2K.j2k.roi.encoder.ROI.uly">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.uly.html">uly</a>
        </td>
        <td class="markdown level1 summary"><p>y coordinate of upper left corner of rectangular ROI</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROI_w" data-uid="CSJ2K.j2k.roi.encoder.ROI.w">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.w.html">w</a>
        </td>
        <td class="markdown level1 summary"><p>width of rectangular ROI</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROI_x" data-uid="CSJ2K.j2k.roi.encoder.ROI.x">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.x.html">x</a>
        </td>
        <td class="markdown level1 summary"><p>x coordinate of center of circular ROI</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_roi_encoder_ROI_y" data-uid="CSJ2K.j2k.roi.encoder.ROI.y">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.y.html">y</a>
        </td>
        <td class="markdown level1 summary"><p>y coordinate of center of circular ROI</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_ROI_ToString" data-uid="CSJ2K.j2k.roi.encoder.ROI.ToString">
          <a class="xref" href="CSJ2K.j2k.roi.encoder.ROI.ToString.html#CSJ2K_j2k_roi_encoder_ROI_ToString">ToString()</a>
        </td>
        <td class="markdown level1 summary"><p>This function prints all relevant data for the ROI</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="seealso">See Also</h3>
  <div class="seealso">
      <div><a class="xref" href="CSJ2K.j2k.roi.encoder.ROIMaskGenerator.html">ROIMaskGenerator</a></div>
  </div>

</div>