aws.osml.image_processing.sicd_updater module

class aws.osml.image_processing.sicd_updater.SICDUpdater(xml_str: str)

Bases: object

This class provides a means to perform common updates to a SICD XML metadata document.

update_image_data_for_chip(chip_bounds: List[int], output_size: Tuple[int, int] | None) → None

This updates the SICD ImageData structure so that the FirstRow, FirstCol and NumRows, NumCols elements match the new chip boundary.A sample of this XML structure is shown below:

<ImageData>
    <NumRows>3859</NumRows>
    <NumCols>6679</NumCols>
    <FirstRow>0</FirstRow>
    <FirstCol>0</FirstCol>
    <FullImage>
        <NumRows>3859</NumRows>
        <NumCols>6679</NumCols>
    </FullImage>
</ImageData>

Parameters:

• chip_bounds – the [col, row, width, height] of the chip boundary

• output_size – the [width, height] of the output chip

encode_current_xml() → str

Returns a copy of the current SICD metadata encoded in XML.

Returns:

xml encoded SICD metadata