SIDD creation helper functions (sarpy.processing.sidd.sidd_structure_creation)

Common functionality for creating the SIDD structure from a SICD structure and OrthorectificationHelper.

sarpy.processing.sidd.sidd_structure_creation.create_sidd_structure_v3(ortho_helper, bounds, product_class, pixel_type)

Create a SIDD version 3.0 structure based on the orthorectification helper and pixel bounds.

Parameters:

  • ortho_helper (OrthorectificationHelper) –

  • bounds (numpy.ndarray|list|tuple) – The orthorectification pixel bounds of the form (min row, max row, min col, max col).

  • product_class (str) – A descriptive name for the product class. Examples - Dynamic Image, Amplitude Change Detection, Coherent Change Detection

  • pixel_type (str) – Must be one of MONO8I, MONO16I or RGB24I.

Return type:

SIDDType3

sarpy.processing.sidd.sidd_structure_creation.create_sidd_structure_v2(ortho_helper, bounds, product_class, pixel_type)

Create a SIDD version 2.0 structure based on the orthorectification helper and pixel bounds.

Parameters:

  • ortho_helper (OrthorectificationHelper) –

  • bounds (numpy.ndarray|list|tuple) – The orthorectification pixel bounds of the form (min row, max row, min col, max col).

  • product_class (str) – A descriptive name for the product class. Examples - Dynamic Image, Amplitude Change Detection, Coherent Change Detection

  • pixel_type (str) – Must be one of MONO8I, MONO16I or RGB24I.

Return type:

SIDDType2

sarpy.processing.sidd.sidd_structure_creation.create_sidd_structure_v1(ortho_helper, bounds, product_class, pixel_type)

Create a SIDD version 1.0 structure based on the orthorectification helper and pixel bounds.

Parameters:

  • ortho_helper (OrthorectificationHelper) –

  • bounds (numpy.ndarray|list|tuple) – The orthorectification pixel bounds of the form (min row, max row, min col, max col).

  • product_class (str) – A descriptive name for the product class. Examples - Dynamic Image, Amplitude Change Detection, Coherent Change Detection

  • pixel_type (str) – Must be one of MONO8I, MONO16I or RGB24I.

Return type:

SIDDType1

sarpy.processing.sidd.sidd_structure_creation.create_sidd_structure(ortho_helper, bounds, product_class, pixel_type, version=3)

Create a SIDD structure, with version specified, based on the orthorectification helper and pixel bounds.

Parameters:

  • ortho_helper (OrthorectificationHelper) –

  • bounds (numpy.ndarray|list|tuple) – The orthorectification pixel bounds of the form (min row, max row, min col, max col).

  • product_class (str) – A descriptive name for the product class. Examples - Dynamic Image, Amplitude Change Detection, Coherent Change Detection

  • pixel_type (str) – Must be one of MONO8I, MONO16I or RGB24I.

  • version (int) – The SIDD version, must be either 1, 2, or 3.

Return type:

SIDDType1|SIDDType2|SIDDType3