sarkit.sicd.NitfReader.read_sub_image

NitfReader.read_sub_image(start_row=None, start_col=None, stop_row=None, stop_col=None, *, out=None)

Read a 2D slice / sub-image from the file

Parameters:
start_rowint or None

Lowest row index to retrieve (inclusive). If None, defaults to first row.

start_colint or None

Lowest column index to retrieve (inclusive). If None, defaults to first column.

stop_rowint or None

Highest row index to retrieve (exclusive). If None, defaults to one after last row.

stop_colint or None

Highest col index to retrieve (exclusive). If None, defaults to one after last column.

outndarray or None, optional

Array to store the sub-image. If None, a new array will be created.

Returns:
ndarray

SICD sub-image array

lxml.etree.ElementTree

SICD XML updated to describe sub-image