WorldWind Kotlin/earth.worldwind.formats.nitf/NitfFileHeader

NitfFileHeader

NITF 2.1 / NSIF 1.0 file header (the very first segment of every file). The parser walks the spec-defined positional layout (MIL-STD-2500C §5.2.1) and captures every spec field, but only a few are exposed as typed accessors — the rest are stashed in securityBlock / unparsed for applications that care.

The two non-header outputs that downstream code actually needs are:

the segment offset/length tables (imageSegments, graphicSegments, textSegments, dataExtensionSegments, reservedExtensionSegments).
the file/header lengths so callers can decide whether the byte buffer is a complete file.

Types

Companion

object Companion

SegmentLocation

data class SegmentLocation(val headerOffset: Int, val headerLength: Int, val dataLength: Long)

Position + size of a segment inside the file. headerLength is the subheader (LISH/LSSH/LTSH/LDSH/LRESH), dataLength is the segment data (LI/LS/LT/LD/LRE).

Properties

backgroundColor

val backgroundColor: IntArray?

FBKGC — file background colour (R,G,B) in 0..255, NITF 2.1 only.

complexityLevel

val complexityLevel: Int

CLEVEL — file complexity level (3–9 per spec).

dataExtensionSegments

val dataExtensionSegments: List<NitfFileHeader.SegmentLocation>

encryption

val encryption: Int

ENCRYP — must be "0" in NITF 2.1; we surface for inspection.

extendedHeader

val extendedHeader: ByteArray?

Raw XHD bytes (Extended Header Data), or null if XHDL == 0.

fileDateTime

val fileDateTime: String

FDT — file date/time, CCYYMMDDhhmmss.

fileLength

val fileLength: Long

Total file length in bytes (FL). May be 999…9 to indicate "not set" — spec §5.2.1.1; we surface the raw value and let callers decide.

format

val format: NitfFormat

Format + version pair (NITF 02.10 or NSIF 01.00).

graphicSegments

val graphicSegments: List<NitfFileHeader.SegmentLocation>

headerLength

val headerLength: Int

Header length in bytes (HL) — used to seek past the file header.

imageSegments

val imageSegments: List<NitfFileHeader.SegmentLocation>

Per-image (offset, length) pairs. Offsets are absolute file positions pointing at the IM header byte. Length = LISH + LI.

originatingStationId

val originatingStationId: String

OSTAID — originating station ID.

originatorName

val originatorName: String

ONAME / OPHONE.

originatorPhone

val originatorPhone: String

reservedExtensionSegments

val reservedExtensionSegments: List<NitfFileHeader.SegmentLocation>

securityBlock

var securityBlock: ByteArray?

Raw 167-byte security block (CLAS/CLSY/CODE/CTLH/REL/DCTP/DCDT/DCXM/DG/ DGDT/CLTX/CATP/CAUT/CRSN/SRDT/CTLN concatenated). Kept around for callers that need to inspect downgrade/release tags.

standardType

val standardType: String

STYPE — standard type ("BF01" per spec).

textSegments

val textSegments: List<NitfFileHeader.SegmentLocation>

title

val title: String

FTITLE — free-text title.

unparsed

val unparsed: MutableMap<String, ByteArray>

Tags consumed by future TRE parsers but currently uninterpreted.

userDefinedHeader

val userDefinedHeader: ByteArray?

Raw UDHD bytes (User-Defined Header Data), or null if UDHDL == 0.