HeaderDecoder Class Members
In This Topic
The following tables list the members exposed by HeaderDecoder.
Public Constructors
| Name | Description |
![Public Constructor](template/packages/core-dotnet/images/publicConstructor.png) | HeaderDecoder Constructor | Creates a HeaderDecoder instance and read in two passes the main header of the codestream. The first and last marker segments shall be respectively SOC and SOT. |
Top
Public Fields
| Name | Description |
![Public Field](template/packages/core-dotnet/images/publicField.png) | CRG_FOUND | Flag bit for CRG marker segment found |
![Public Field](template/packages/core-dotnet/images/publicField.png) | mainHeadOff | The offset of the main header in the input stream |
![Public Field](template/packages/core-dotnet/images/publicField.png) | nTileParts | The number of tile parts in each tile |
![Public Field](template/packages/core-dotnet/images/publicField.png) | OPT_PREFIX | The prefix for header decoder options: 'H' |
![Public Field](template/packages/core-dotnet/images/publicField.png) | PPM_FOUND | Flag bit for SOD marker segment found |
![Public Field](template/packages/core-dotnet/images/publicField.png) | PPT_FOUND | Flag bit for SOD marker segment found |
![Public Field](template/packages/core-dotnet/images/publicField.png) | SOD_FOUND | Flag bit for SOD marker segment found |
Top
Public Properties
| Name | Description |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | CbULX | Returns the horizontal code-block partition origin.Allowable values are 0 and 1, nothing else. |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | CbULY | Returns the vertical code-block partition origin. Allowable values are 0 and 1, nothing else. |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | DecoderSpecs | Return the DecoderSpecs instance filled when reading the headers |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | ImgHeight | Returns the image height in the reference grid. |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | ImgULX | Return the horizontal upper-left coordinate of the image in the reference grid. |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | ImgULY | Return the vertical upper-left coordinate of the image in the reference grid. |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | ImgWidth | Returns the image width in the reference grid. |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | MaxCompImgHeight | Return the maximum height among all components |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | MaxCompImgWidth | Return the maximum width among all components |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | NomTileHeight | Returns the nominal width of the tiles in the reference grid. |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | NomTileWidth | Returns the nominal width of the tiles in the reference grid. |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | NumComps | Returns the number of components in the image. |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | NumFoundMarkSeg | Returns the number of found marker segments in the current header. |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | NumTiles | Return the number of tiles in the image |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) ![static (Shared in Visual Basic)](template/packages/core-dotnet/images/static.png) | ParameterInfo | Returns the parameters that are used in this class. It returns a 2D String array. Each of the 1D arrays is for a different option, and they have 3 elements. The first element is the option name, the second one is the synopsis and the third one is a long description of what the parameter is. The synopsis or description may be 'null', in which case it is assumed that there is no synopsis or description of the option, respectively. |
![Public Property](template/packages/core-dotnet/images/publicProperty.png) | TileOfTileParts | Sets the tile of each tile part in order. This information is needed for identifying which packet header belongs to which tile when using the PPM marker. |
Top
Public Methods
| Name | Description |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | checkMarkerLength | Checks that the marker segment length is correct. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | createChannelDefinitionMapper | Creates and returns the ChannelDefinitonMapper which maps the input channels to the channel definition for the appropriate colorspace. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | createColorSpaceMapper | Creates and returns the EnumeratedColorSpaceMapper corresponding to the information read from the JP2 image file via the ColorSpace parameter. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | createDequantizer | Returns the dequantizer parameters. Dequantizer parameters normally are the quantization step sizes, see DequantizerParams. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | createEntropyDecoder | Creates and returns the entropy decoder corresponding to the information read from the codestream header and with the special additional parameters from the parameter list. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | createPalettizedColorSpaceMapper | Creates and returns the PalettizedColorSpaceMapper which uses the input samples as indicies into a sample palette to construct the output. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | createResampler | Creates and returns the Resampler which converts the input source to one in which all channels have the same number of samples. This is required for colorspace conversions. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | createROIDeScaler | Creates and returns the ROIDeScaler corresponding to the information read from the codestream header and with the special additional parameters from the parameter list. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | extractTilePartMarkSeg | This method extracts a marker segment in a tile-part header and stores it into a byte buffer for the second pass. The marker is first recognized, then its flag is activated and, finally, its content is buffered in an element of byte arrays accessible thanks to a hashTable. If a marker segment is not recognized, it prints a warning and skip it according to its length. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | getCompSubsX | Returns the component sub-sampling factor, with respect to the reference grid, along the horizontal direction for the specified component. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | getCompSubsY | Returns the component sub-sampling factor, with respect to the reference grid, along the vertical direction for the specified component. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | getOriginalBitDepth | Returns the original bitdepth of the specified component. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | getPackedPktHead | Return the packed packet headers for a given tile. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | getPPX | Returns the precinct partition width for the specified tile-component and resolution level. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | getPPY | Returns the precinct partition height for the specified tile-component and resolution level. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | getTilingOrigin | Returns the tiling origin, referred to as '(Px,Py)' in the 'ImgData' interface. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | isOriginalSigned | Returns true if the original data of the specified component was signed. If the data was not signed a level shift has to be applied at the end of the decompression chain. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | precinctPartitionUsed | Returns the boolean used to know if the precinct partition is used |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | readFoundTilePartMarkSeg | Retrieves and reads all marker segments previously found in the tile-part header. |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | resetHeaderMarkers | Method that resets members indicating which markers have already been found |
![Public Method](template/packages/core-dotnet/images/publicMethod.png) | ToString | Print information about the current header. |
Top
See Also