Skip to content

Commit ff3aa04

Browse files
committed
regenerated docs, fixed value of precincts property
1 parent 61856f0 commit ff3aa04

File tree

3 files changed

+48
-48
lines changed

3 files changed

+48
-48
lines changed

doc/jpylyzerUserManual.html

+23-23
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@ <h3 id="note-on-icc-profile-support"><span class="header-section-number">1.2.4</
499499
<h2 id="outline"><span class="header-section-number">1.3</span> Outline of this User Manual</h2>
500500
<p><a href="#installation">Chapter 2</a> describes the installation process of <em>jpylyzer</em> for Windows and Unix-based systems. <a href="#using-jpylyzer">Chapter 3</a> explains the usage of <em>jpylyzer</em> as a command-line tool, or as an importable Python module. <a href="#structure-jp2">Chapter 4</a> gives a brief overview of the structure of JP2 and its ‘box’ structure. <em>Jpylyzer</em>’s output format is explained in <a href="#output-format">chapter 5</a>. The final chapters give a detailed description of the tests that <em>jpylyzer</em> performs for validation, and its reported properties. <a href="#jp2-box-by-box">Chapter 6</a> does this for all ‘boxes’, except for the ‘Contiguous Codestream’ box, which is given a <a href="#contiguous-codestream-box-chapter">Chapter (7)</a> of its own.</p>
501501
<h2 id="funding"><span class="header-section-number">1.4</span> Funding</h2>
502-
<p>The development of <em>jpylyzer</em> was funded by the EU FP 7 project SCAPE (SCAlabable Preservation Environments). More information about this project can be found here:</p>
502+
<p>The development of <em>jpylyzer</em> was funded by the EU FP 7 project SCAPE (SCAlable Preservation Environments). More information about this project can be found here:</p>
503503
<p><a href="http://www.scape-project.eu/" class="uri">http://www.scape-project.eu/</a></p>
504504
<h2 id="license"><span class="header-section-number">1.5</span> License</h2>
505505
<p><em>Jpylyzer</em> is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this program. If not, see:</p>
@@ -2296,40 +2296,40 @@ <h3 id="main-codestream-header"><span class="header-section-number">7.2.1</span>
22962296
<li><p>Start of codestream (SOC) marker segment (required)</p></li>
22972297
<li><p>Image and tile size (SIZ) marker segment (required)</p></li>
22982298
<li><p>Coding style default (COD) marker segment (required)</p></li>
2299+
<li><p>Coding style component (COC) marker segment (optional)</p></li>
2300+
<li><p>Region-of-interest (RGN) marker segment (optional)</p></li>
22992301
<li><p>Quantization default (QCD) marker segment (required)</p></li>
2302+
<li><p>Quantization component (QCC) marker segment (optional)</p></li>
2303+
<li><p>Progression order change (POC) marker segment (optional)</p></li>
2304+
<li><p>Component registration (CRG) marker segment (optional)</p></li>
23002305
<li><p>Comment (COM) marker segment (optional)</p></li>
23012306
</ul>
23022307
<p>In addition the codestream header may also contain any of the following marker segments, which are all optional:</p>
23032308
<ul>
2304-
<li><p>Coding style component (COC) marker segment (optional)</p></li>
2305-
<li><p>Quantization component (QCC) marker segment (optional)</p></li>
2306-
<li><p>Region-of-interest (RGN) marker segment (optional) <sup>*</sup></p></li>
2307-
<li><p>Progression order change (POC) marker segment (optional) <sup>*</sup></p></li>
23082309
<li><p>Packet length, main header (PLM) marker segment (optional) <sup>*</sup></p></li>
23092310
<li><p>Packed packet headers, main header (PPM) marker segment (optional) <sup>*</sup></p></li>
23102311
<li><p>Tile-part lengths (TLM) marker segment (optional) <sup>*</sup></p></li>
2311-
<li><p>Component registration (CRG) marker segment (optional) <sup>*</sup></p></li>
23122312
</ul>
2313-
<p>Currently not all of these optional marker segments are fully supported. Those that are marked with an asterisk above are only minimally supported at this stage: if <em>jpylyzer</em> encounters them, it will include the corresponding element in the <em>properties</em> element of the output. However, <em>jpylyzer</em> does not analyse the contents of these marker segments, which means that the respective elements in the output will be empty.</p>
2313+
<p>The optional markers that are marked with an asterisk above are only minimally supported at this stage: if <em>jpylyzer</em> encounters them, it will include the corresponding element in the <em>properties</em> element of the output. However, <em>jpylyzer</em> does not analyse the contents of these marker segments, which means that the respective elements in the output will be empty.</p>
23142314
<h3 id="tile-parts"><span class="header-section-number">7.2.2</span> Tile parts</h3>
23152315
<p>The tile part validation has similar limitations. The standard lists 11 marker segments that can occur in the tile part header. Currently, <em>jpylyzer</em> only fully supports the following ones:</p>
23162316
<ul>
23172317
<li><p>Start of tile part (SOT) marker segment (required)</p></li>
23182318
<li><p>Coding style default (COD) marker segment (optional)</p></li>
2319+
<li><p>Coding style component (COC) marker segment (optional)</p></li>
2320+
<li><p>Region-of-interest (RGN) marker segment (optional)</p></li>
23192321
<li><p>Quantization default (QCD) marker segment (optional)</p></li>
2322+
<li><p>Quantization component (QCC) marker segment (optional)</p></li>
2323+
<li><p>Progression order change (POC) marker segment (optional)</p></li>
23202324
<li><p>Comment (COM) marker segment (optional)</p></li>
23212325
<li><p>Start of data (SOD) marker segment (required)</p></li>
23222326
</ul>
23232327
<p>In addition the following optional marker segments may also occur:</p>
23242328
<ul>
2325-
<li><p>Coding style component (COC) marker segment (optional)</p></li>
2326-
<li><p>Quantization component (QCC) marker segment (optional)</p></li>
2327-
<li><p>Region-of-interest (RGN) marker segment (optional) <sup>*</sup></p></li>
2328-
<li><p>Progression order change (POC) marker segment (optional) <sup>*</sup></p></li>
23292329
<li><p>Packet length, tile-part header (PLT) marker segment (optional) <sup>*</sup></p></li>
23302330
<li><p>Packed packet headers, tile-part header (PPT) marker segment (optional) <sup>*</sup></p></li>
23312331
</ul>
2332-
<p>These marker segments that are marked with an asterisk above are only minimally supported at this stage: if <em>jpylyzer</em> encounters any of them, it will include the corresponding element in the <em>properties</em> element of the output. However, <em>jpylyzer</em> currently does not analyse their contents, and the respective elements in the output will be empty.</p>
2332+
<p>The optional markers that are marked with an asterisk above are only minimally supported at this stage: if <em>jpylyzer</em> encounters them, it will include the corresponding element in the <em>properties</em> element of the output. However, <em>jpylyzer</em> does not analyse the contents of these marker segments, which means that the respective elements in the output will be empty.</p>
23332333
<h3 id="bit-streams"><span class="header-section-number">7.2.3</span> Bit streams</h3>
23342334
<p>In addition to the above limitations, <em>jpylyzer</em> can <em>not</em> be used to establish whether the data in the bitstream are correct (this would require decoding the compressed image data, which is completely out of <em>jpylyzer</em>’s scope)<a href="#fn15" class="footnote-ref" id="fnref15"><sup>15</sup></a>. As a result, if <em>jpylyzer</em> is used as part of a quality assurance workflow, it is recommended to also include an additional check on the image contents<a href="#fn16" class="footnote-ref" id="fnref16"><sup>16</sup></a>. Also, <em>jpylyzer</em> does not perform any checks on marker segments within the bit-stream: start-of packet (SOP) and end-of-packet (EPH) markers.</p>
23352335
<h3 id="detection-of-incomplete-or-truncated-codestreams"><span class="header-section-number">7.2.4</span> Detection of incomplete or truncated codestreams</h3>
@@ -2470,7 +2470,7 @@ <h3 id="reported-properties-20"><span class="header-section-number">7.5.2</span>
24702470
</tr>
24712471
<tr class="even">
24722472
<td style="text-align: left;">ysiz</td>
2473-
<td style="text-align: left;">Heigth of reference grid</td>
2473+
<td style="text-align: left;">Height of reference grid</td>
24742474
</tr>
24752475
<tr class="odd">
24762476
<td style="text-align: left;">xOsiz</td>
@@ -2611,7 +2611,7 @@ <h3 id="reported-properties-21"><span class="header-section-number">7.6.2</span>
26112611
</tr>
26122612
<tr class="even">
26132613
<td style="text-align: left;">precincts</td>
2614-
<td style="text-align: left;">Indicates use of precincts (“yes”/“no”)</td>
2614+
<td style="text-align: left;">Indicates default or user-defined precinct size (“default”/“user defined”)</td>
26152615
</tr>
26162616
<tr class="odd">
26172617
<td style="text-align: left;">sop</td>
@@ -2675,11 +2675,11 @@ <h3 id="reported-properties-21"><span class="header-section-number">7.6.2</span>
26752675
</tr>
26762676
<tr class="even">
26772677
<td style="text-align: left;">precinctSizeX<sup>*</sup></td>
2678-
<td style="text-align: left;">Precinct width (repeated for all resolution levels; order: low to high) (only if <em>precincts</em> is “yes”)</td>
2678+
<td style="text-align: left;">Precinct width (repeated for all resolution levels; order: low to high). Equals 32768 if <em>precincts</em> is “default”</td>
26792679
</tr>
26802680
<tr class="odd">
26812681
<td style="text-align: left;">precinctSizeY<sup>*</sup></td>
2682-
<td style="text-align: left;">Precinct heigth (repeated for all resolution levels; order: low to high) (only if <em>precincts</em> is “yes”)</td>
2682+
<td style="text-align: left;">Precinct height (repeated for all resolution levels; order: low to high). Equals 32768 if <em>precincts</em> is “default”</td>
26832683
</tr>
26842684
</tbody>
26852685
</table>
@@ -2730,11 +2730,11 @@ <h3 id="tests-20"><span class="header-section-number">7.6.3</span> Tests</h3>
27302730
</tr>
27312731
<tr class="even">
27322732
<td style="text-align: left;">precinctSizeXIsValid<sup>*</sup></td>
2733-
<td style="text-align: left;"><em>precinctSizeX</em> ≥ 2 (except lowest resolution level) (repeated for all resolution levels; order: low to high) (only if <em>precincts</em> is “yes”)</td>
2733+
<td style="text-align: left;"><em>precinctSizeX</em> ≥ 2 (except lowest resolution level) (repeated for all resolution levels; order: low to high) (only if <em>precincts</em> is “user defined”)</td>
27342734
</tr>
27352735
<tr class="odd">
27362736
<td style="text-align: left;">precinctSizeYIsValid<sup>*</sup></td>
2737-
<td style="text-align: left;"><em>precinctSizeY</em> ≥ 2 (except lowest resolution level) (repeated for all resolution levels; order: low to high) (only if <em>precincts</em> is “yes”)</td>
2737+
<td style="text-align: left;"><em>precinctSizeY</em> ≥ 2 (except lowest resolution level) (repeated for all resolution levels; order: low to high) (only if <em>precincts</em> is “user defined”)</td>
27382738
</tr>
27392739
</tbody>
27402740
</table>
@@ -2760,7 +2760,7 @@ <h3 id="reported-properties-22"><span class="header-section-number">7.7.2</span>
27602760
</tr>
27612761
<tr class="odd">
27622762
<td style="text-align: left;">precincts</td>
2763-
<td style="text-align: left;">Indicates use of precincts (“yes”/“no”)</td>
2763+
<td style="text-align: left;">Indicates default or user-defined precinct size (“default”/“user defined”)</td>
27642764
</tr>
27652765
<tr class="even">
27662766
<td style="text-align: left;">levels</td>
@@ -2804,11 +2804,11 @@ <h3 id="reported-properties-22"><span class="header-section-number">7.7.2</span>
28042804
</tr>
28052805
<tr class="even">
28062806
<td style="text-align: left;">precinctSizeX<sup>*</sup></td>
2807-
<td style="text-align: left;">Precinct width (repeated for all resolution levels; order: low to high) (only if <em>precincts</em> is “yes”)</td>
2807+
<td style="text-align: left;">Precinct width (repeated for all resolution levels; order: low to high). Equals 32768 if <em>precincts</em> is “default”</td>
28082808
</tr>
28092809
<tr class="odd">
28102810
<td style="text-align: left;">precinctSizeY<sup>*</sup></td>
2811-
<td style="text-align: left;">Precinct heigth (repeated for all resolution levels; order: low to high) (only if <em>precincts</em> is “yes”)</td>
2811+
<td style="text-align: left;">Precinct heigth (repeated for all resolution levels; order: low to high). Equals 32768 if <em>precincts</em> is “default”</td>
28122812
</tr>
28132813
</tbody>
28142814
</table>
@@ -2851,11 +2851,11 @@ <h3 id="tests-21"><span class="header-section-number">7.7.3</span> Tests</h3>
28512851
</tr>
28522852
<tr class="even">
28532853
<td style="text-align: left;">precinctSizeXIsValid<sup>*</sup></td>
2854-
<td style="text-align: left;"><em>precinctSizeX</em> ≥ 2 (except lowest resolution level) (repeated for all resolution levels; order: low to high) (only if <em>precincts</em> is “yes”)</td>
2854+
<td style="text-align: left;"><em>precinctSizeX</em> ≥ 2 (except lowest resolution level) (repeated for all resolution levels; order: low to high) (only if <em>precincts</em> is “user defined”)</td>
28552855
</tr>
28562856
<tr class="odd">
28572857
<td style="text-align: left;">precinctSizeYIsValid<sup>*</sup></td>
2858-
<td style="text-align: left;"><em>precinctSizeY</em> ≥ 2 (except lowest resolution level) (repeated for all resolution levels; order: low to high) (only if <em>precincts</em> is “yes”)</td>
2858+
<td style="text-align: left;"><em>precinctSizeY</em> ≥ 2 (except lowest resolution level) (repeated for all resolution levels; order: low to high) (only if <em>precincts</em> is “user defined”)</td>
28592859
</tr>
28602860
</tbody>
28612861
</table>

0 commit comments

Comments
 (0)