NitfImageSegment

Parsed subheader for one NITF/NSIF image segment. The image data (the pixel grid itself, possibly preceded by a block mask) is not decoded here — see NitfImageReader.decodeArgb / NitfImageReader.decodeRaw.

Fields follow MIL-STD-2500C §5.4 and use the spec acronyms in the doc comments so the source is easy to cross-reference with the standard.

Types

Link copied to clipboard
class Band

Per-band metadata.

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

ABPP — actual bits per pixel (1..96).

Link copied to clipboard

IALVL — attachment level.

Link copied to clipboard

Per-band information (length == numBands).

Link copied to clipboard

NBPP — number of bits per pixel per band (storage size; ≥ ABPP).

Link copied to clipboard

NBPC — number of blocks per column of the image grid.

Link copied to clipboard

NBPR — number of blocks per row of the image grid.

Link copied to clipboard

Sample alignment for uncompressed reads — same as bytesPerSampleUncompressed.

Link copied to clipboard

Total uncompressed bytes per band (rounded up to a byte) ignoring masking.

Link copied to clipboard

IC — compression code.

Link copied to clipboard

COMRAT — compression rate code (e.g. "C8C5" for some J2K profiles). null if uncompressed.

Link copied to clipboard

ICORDS — coordinate system selector.

Link copied to clipboard

Decoded corners (NW, NE, SE, SW) when coordinateSystem is decodable.

Link copied to clipboard

Length of the image data section in bytes (matches LI).

Link copied to clipboard

Absolute byte offset of the image data section (just past the subheader).

Link copied to clipboard

IDATIM — image date/time (CCYYMMDDhhmmss).

Link copied to clipboard

IDLVL — display level.

Link copied to clipboard

ENCRYP — must be 0 in NITF 2.1.

Link copied to clipboard

Raw IXSHD bytes if IXSHDL > 0.

Link copied to clipboard

Length of the subheader in bytes (matches LISH).

Link copied to clipboard

Absolute byte offset of this segment's subheader inside the file.

Link copied to clipboard

Raw 60-byte IGEOLO field if present, or null.

Link copied to clipboard

ICAT — image category, kept as raw 8-char code (VIS, SL, TI, MAP, …).

Link copied to clipboard

NICOM + ICOM records.

Link copied to clipboard

IID1 — image identification 1.

Link copied to clipboard

ILOC — image location offset (row, col).

Link copied to clipboard

IMODE — pixel/band/block ordering.

Link copied to clipboard

IREP — image representation.

Link copied to clipboard

ISORCE — image source.

Link copied to clipboard

IID2 — image identification 2 (a longer free-text title).

Link copied to clipboard

IMAG — magnification.

Link copied to clipboard

NBANDS / XBANDS resolved to a single integer band count.

Link copied to clipboard

NCOLS — number of significant columns in the image.

Link copied to clipboard

NROWS — number of significant rows in the image.

Link copied to clipboard

PJUST — 'L' (left) or 'R' (right) justification for sub-byte sizes.

Link copied to clipboard

NPPBH — number of pixels per block, horizontal.

Link copied to clipboard

NPPBV — number of pixels per block, vertical.

Link copied to clipboard

PVTYPE — pixel value type.

Link copied to clipboard

Axis-aligned bounding box derived from corners, or null.

Link copied to clipboard

ISYNC — image sync code (always 0 per spec).

Link copied to clipboard

TGTID — target identifier.

Link copied to clipboard

Raw UDID bytes if UDIDL > 0.