The NITF reserved extension header (sarpy.io.general.nitf_elements.res)

The reserved extension subheader definitions.

class sarpy.io.general.nitf_elements.res.RESUserHeader(data=None, **kwargs)

Bases: Unstructured

classmethod from_bytes(value, start)
Parameters:

  • value (bytes|str) – the header string to scrape

  • start (int) – the beginning location in the string

get_bytes_length()

Get the length of the serialized bytes array

Return type:

int

classmethod minimum_length()

The minimum size in bytes that takes to write this header element.

Return type:

int

to_bytes()

Write the object to a properly packed str.

Return type:

bytes

to_json()

Serialize element to a json representation. This is intended to allow a simple presentation of the element.

Return type:

dict

class sarpy.io.general.nitf_elements.res.ReservedExtensionHeader(**kwargs)

Bases: NITFElement

The reserved extension subheader - see standards document Joint BIIF Profile (JBP) for more information.

RE: str

File part type. Takes values in {'RE'}. Default value is RE.

Type:

str

RESID: str

Unique RES Type Identifier. This field shall contain a valid alphanumeric identifier properly registered with the ISMC.

Type:

str

RESVER: int

Version of the Data Definition. This field shall contain the alphanumeric version number of the use of the tag. The version number is assigned as part of the registration process. Default value is 1.

Type:

int

Security: NITFSecurityTags

The security tags.

Type:

NITFSecurityTags

property UserHeader: RESUserHeader

The RES user header.

Type:

RESUserHeader

classmethod from_bytes(value, start)
Parameters:

  • value (bytes|str) – the header string to scrape

  • start (int) – the beginning location in the string

get_bytes_length()

Get the length of the serialized bytes array

Return type:

int

classmethod minimum_length()

The minimum size in bytes that takes to write this header element.

Return type:

int

to_bytes()

Write the object to a properly packed str.

Return type:

bytes

to_json()

Serialize element to a json representation. This is intended to allow a simple presentation of the element.

Return type:

dict

class sarpy.io.general.nitf_elements.res.ReservedExtensionHeader0(**kwargs)

Bases: NITFElement

The reserved extension subheader for NITF version 2.0 - see standards document MIL-STD-2500A for more information.

RE: str

File part type. Takes values in {'RE'}. Default value is RE.

Type:

str

RESID: str

Unique RES Type Identifier. This field shall contain a valid alphanumeric identifier properly registered with the ISMC.

Type:

str

RESVER: int

Version of the Data Definition. This field shall contain the alphanumeric version number of the use of the tag. The version number is assigned as part of the registration process. Default value is 1.

Type:

int

Security: NITFSecurityTags0

The security tags.

Type:

NITFSecurityTags0

property UserHeader: RESUserHeader

The RES user header.

Type:

RESUserHeader

classmethod from_bytes(value, start)
Parameters:

  • value (bytes|str) – the header string to scrape

  • start (int) – the beginning location in the string

get_bytes_length()

Get the length of the serialized bytes array

Return type:

int

classmethod minimum_length()

The minimum size in bytes that takes to write this header element.

Return type:

int

to_bytes()

Write the object to a properly packed str.

Return type:

bytes

to_json()

Serialize element to a json representation. This is intended to allow a simple presentation of the element.

Return type:

dict