The Basic SIDD building blocks

Multipurpose basic SIDD elements

class sarpy.io.product.sidd2_elements.blocks.XYZType(X: float = None, Y: float = None, Z: float = None, **kwargs)

Bases: XYZType

X: float

The X attribute. Assumed to ECF or other, similar coordinates. Required.

Type:

float

Y: float

The Y attribute. Assumed to ECF or other, similar coordinates. Required.

Type:

float

Z: float

The Z attribute. Assumed to ECF or other, similar coordinates. Required.

Type:

float

copy()

Create a deep copy.

classmethod from_array(array: ndarray | list | tuple)

Create from an array type entry.

Parameters:

array (numpy.ndarray|list|tuple) – assumed [X, Y, Z]

Return type:

XYZType

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

get_array(dtype=<class 'numpy.float64'>) → ndarray

Gets an array representation of the class instance.

Parameters:

dtype (str|numpy.dtype|numpy.number) – numpy data type of the return

Returns:

array of the form [X,Y,Z]

Return type:

numpy.ndarray

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.LatLonType(Lat: float = None, Lon: float = None, **kwargs)

Bases: LatLonType

Lat: float

The latitude attribute. Assumed to be WGS-84 coordinates. Required.

Type:

float

Lon: float

The longitude attribute. Assumed to be WGS-84 coordinates. Required.

Type:

float

copy()

Create a deep copy.

dms_format(frac_secs: bool = False) → Tuple[Tuple[int, int, int, str], Tuple[int, int, int, str]]

Get degree-minutes-seconds representation. :param frac_secs: Should a fractional seconds (i.e. a float), otherwise integer :type frac_secs: bool

Returns:

• tuple – of the form ((deg lat, mins lat, secs lat, N/S), (deg lon, mins lon, secs lon, E/W))

• Here degrees and minutes will be int, secs will be a float.

classmethod from_array(array: ndarray | list | tuple)

Create from an array type entry.

Parameters:

array (numpy.ndarray|list|tuple) – assumed [Lat, Lon]

Return type:

LatLonType

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

get_array(dtype=<class 'numpy.float64'>, order: str = 'LAT') → ndarray

Gets an array representation of the data.

Parameters:

• order (str) – Determines array order. ‘LAT’ yields [Lat, Lon], and anything else yields [Lon, Lat].

• dtype (str|numpy.dtype|numpy.number) – data type of the return

• order –

Returns:

data array with appropriate entry order

Return type:

numpy.ndarray

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.LatLonCornerType(Lat: float = None, Lon: float = None, index: int = None, **kwargs)

Bases: LatLonCornerType

Lat: float

The latitude attribute. Assumed to be WGS-84 coordinates. Required.

Type:

float

Lon: float

The longitude attribute. Assumed to be WGS-84 coordinates. Required.

Type:

float

copy()

Create a deep copy.

dms_format(frac_secs: bool = False) → Tuple[Tuple[int, int, int, str], Tuple[int, int, int, str]]

Get degree-minutes-seconds representation. :param frac_secs: Should a fractional seconds (i.e. a float), otherwise integer :type frac_secs: bool

Returns:

• tuple – of the form ((deg lat, mins lat, secs lat, N/S), (deg lon, mins lon, secs lon, E/W))

• Here degrees and minutes will be int, secs will be a float.

classmethod from_array(array: ndarray | list | tuple, index: int = 1)

Create from an array type entry.

Parameters:

• array (numpy.ndarray|list|tuple) – assumed [Lat, Lon]

• index (int) – (1 based) array index

Return type:

LatLonCornerType

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

get_array(dtype=<class 'numpy.float64'>, order: str = 'LAT') → ndarray

Gets an array representation of the data.

Parameters:

• order (str) – Determines array order. ‘LAT’ yields [Lat, Lon], and anything else yields [Lon, Lat].

• dtype (str|numpy.dtype|numpy.number) – data type of the return

• order –

Returns:

data array with appropriate entry order

Return type:

numpy.ndarray

index: int

The integer index. This represents a clockwise enumeration of the rectangle vertices wrt the frame of reference of the collector. Should be 1-4, but 0-3 may be permissible. Must be in the range [1, 4] Required.

Type:

int

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.LatLonCornerStringType(Lat: float = None, Lon: float = None, index: str = None, **kwargs)

Bases: LatLonCornerStringType

Lat: float

The latitude attribute. Assumed to be WGS-84 coordinates. Required.

Type:

float

Lon: float

The longitude attribute. Assumed to be WGS-84 coordinates. Required.

Type:

float

copy()

Create a deep copy.

dms_format(frac_secs: bool = False) → Tuple[Tuple[int, int, int, str], Tuple[int, int, int, str]]

Get degree-minutes-seconds representation. :param frac_secs: Should a fractional seconds (i.e. a float), otherwise integer :type frac_secs: bool

Returns:

• tuple – of the form ((deg lat, mins lat, secs lat, N/S), (deg lon, mins lon, secs lon, E/W))

• Here degrees and minutes will be int, secs will be a float.

classmethod from_array(array: ndarray | list | tuple, index: str = '1:FRFC')

Create from an array type entry.

Parameters:

• array (numpy.ndarray|list|tuple) – assumed [Lat, Lon]

• index (str) – array index in (‘1:FRFC’, ‘2:FRLC’, ‘3:LRLC’, ‘4:LRFC’)

Return type:

LatLonCornerStringType

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

get_array(dtype=<class 'numpy.float64'>, order: str = 'LAT') → ndarray

Gets an array representation of the data.

Parameters:

• order (str) – Determines array order. ‘LAT’ yields [Lat, Lon], and anything else yields [Lon, Lat].

• dtype (str|numpy.dtype|numpy.number) – data type of the return

• order –

Returns:

data array with appropriate entry order

Return type:

numpy.ndarray

index: str

The string index. Takes values in ('1:FRFC', '2:FRLC', '3:LRLC', '4:LRFC'). Required.

Type:

str

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.LatLonArrayElementType(Lat: float = None, Lon: float = None, index: int = None, **kwargs)

Bases: LatLonArrayElementType

Lat: float

The latitude attribute. Assumed to be WGS-84 coordinates. Required.

Type:

float

Lon: float

The longitude attribute. Assumed to be WGS-84 coordinates. Required.

Type:

float

copy()

Create a deep copy.

dms_format(frac_secs: bool = False) → Tuple[Tuple[int, int, int, str], Tuple[int, int, int, str]]

Get degree-minutes-seconds representation. :param frac_secs: Should a fractional seconds (i.e. a float), otherwise integer :type frac_secs: bool

Returns:

• tuple – of the form ((deg lat, mins lat, secs lat, N/S), (deg lon, mins lon, secs lon, E/W))

• Here degrees and minutes will be int, secs will be a float.

classmethod from_array(array: ndarray | list | tuple, index: int = 1)

Create from an array type entry.

Parameters:

• array (numpy.ndarray|list|tuple) – assumed [Lat, Lon]

• index (int) – (1 based) array index

Return type:

LatLonArrayElementType

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

get_array(dtype=<class 'numpy.float64'>, order: str = 'LAT') → ndarray

Gets an array representation of the data.

Parameters:

• order (str) – Determines array order. ‘LAT’ yields [Lat, Lon], and anything else yields [Lon, Lat].

• dtype (str|numpy.dtype|numpy.number) – data type of the return

• order –

Returns:

data array with appropriate entry order

Return type:

numpy.ndarray

index: int

The array index Required.

Type:

int

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.RangeAzimuthType(Range=None, Azimuth=None, **kwargs)

Bases: Serializable, Arrayable

Represents range and azimuth.

Range: float

The range in meters. Required.

Type:

float

Azimuth: float

The azimuth in degrees. Required.

Type:

float

get_array(dtype=<class 'numpy.float64'>)

Gets an array representation of the class instance.

Parameters:

dtype (str|numpy.dtype|numpy.number) – numpy data type of the return

Returns:

array of the form [Range, Azimuth]

Return type:

numpy.ndarray

classmethod from_array(array)

Create from an array type entry.

Parameters:

array (numpy.ndarray|list|tuple) – assumed [Range, Azimuth]

Return type:

RangeAzimuthType

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.AngleMagnitudeType(Angle=None, Magnitude=None, **kwargs)

Bases: Serializable, Arrayable

Represents a magnitude and angle.

Angle: float

The angle. Required.

Type:

float

Magnitude: float

The magnitude. Must be in the range [0.0, None] Required.

Type:

float

get_array(dtype=<class 'numpy.float64'>)

Gets an array representation of the class instance.

Parameters:

dtype (str|numpy.dtype|numpy.number) – numpy data type of the return

Returns:

array of the form [Angle, Magnitude]

Return type:

numpy.ndarray

classmethod from_array(array)

Create from an array type entry.

Parameters:

array (numpy.ndarray|list|tuple) – assumed [Angle, Magnitude]

Return type:

AngleMagnitudeType

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.RowColIntType(Row: int = None, Col: int = None, **kwargs)

Bases: RowColType

Col: int

The Column attribute. Required.

Type:

int

Row: int

The Row attribute. Required.

Type:

int

copy()

Create a deep copy.

classmethod from_array(array: ndarray | list | tuple)

Create from an array type entry.

Parameters:

array (numpy.ndarray|list|tuple) – assumed [Row, Col]

Return type:

RowColType

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

get_array(dtype=<class 'numpy.int64'>) → ndarray

Gets an array representation of the class instance.

Parameters:

dtype (str|numpy.dtype|numpy.number) – numpy data type of the return

Returns:

array of the form [Row, Col]

Return type:

numpy.ndarray

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.RowColArrayElement(Row: int = None, Col: int = None, index: int = None, **kwargs)

Bases: RowColArrayElement

Col: int

The Column attribute. Required.

Type:

int

Row: int

The Row attribute. Required.

Type:

int

copy()

Create a deep copy.

classmethod from_array(array: ndarray | list | tuple, index: int = 1)

Create from an array type entry.

Parameters:

• array (numpy.ndarray|list|tuple) – assumed [Row, Col]

• index (int) – (1 based) the array index

Return type:

RowColArrayElement

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

get_array(dtype=<class 'numpy.int64'>) → ndarray

Gets an array representation of the class instance.

Parameters:

dtype (str|numpy.dtype|numpy.number) – numpy data type of the return

Returns:

array of the form [Row, Col]

Return type:

numpy.ndarray

index: int

The array index attribute. Required.

Type:

int

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.RowColDoubleType(Row=None, Col=None, **kwargs)

Bases: Serializable, Arrayable

Row: float

The Row attribute. Required.

Type:

float

Col: float

The Column attribute. Required.

Type:

float

get_array(dtype=<class 'numpy.float64'>)

Gets an array representation of the class instance.

Parameters:

dtype (str|numpy.dtype|numpy.number) – numpy data type of the return

Returns:

array of the form [Row, Col]

Return type:

numpy.ndarray

classmethod from_array(array)

Create from an array type entry.

Parameters:

array (numpy.ndarray|list|tuple) – assumed [Row, Col]

Return type:

RowColDoubleType

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.Poly1DType(Coefs: None | ndarray | list | tuple = None, **kwargs)

Bases: Poly1DType

property Coefs: ndarray

The one-dimensional polynomial coefficient array of dtype=float64. Assignment object must be a one-dimensional numpy.ndarray, or naively convertible to one.

Note

This returns the direct coefficient array. Use the get_array() method to get a copy of the coefficient array of specified data type.

Type:

numpy.ndarray

copy()

Create a deep copy.

derivative(der_order: int = 1, return_poly: bool = False)

Calculate the der_order derivative of the polynomial.

Parameters:

• der_order (int) – the order of the derivative

• return_poly (bool) – return a Poly1DType if True, otherwise return the coefficient array.

Return type:

Poly1DType|numpy.ndarray

derivative_eval(x: float | int | ndarray, der_order: int = 1) → ndarray

Evaluate the der_order derivative of the polynomial at points x. This uses the functionality presented in numpy.polynomial.polynomial.

Parameters:

• x (float|int|numpy.ndarray) – The point(s) at which to evaluate.

• der_order (int) – The derivative.

Return type:

numpy.ndarray

classmethod from_array(array: ndarray | list | tuple)

Create from the coefficients array type entry.

Parameters:

array (numpy.ndarray|list|tuple) – must be one-dimensional

Return type:

Poly1DType

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

get_array(dtype=<class 'numpy.float64'>) → ndarray

Gets a copy of the coefficent array of specified data type.

Parameters:

dtype (str|numpy.dtype|numpy.number) – numpy data type of the return

Returns:

one-dimensional coefficient array

Return type:

numpy.ndarray

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

minimize_order()

Trim the trailing zeros for the coefficient array. This modifies the object in place.

Return type:

None

property order1: int

The order1 attribute [READ ONLY] - that is, the largest exponent presented in the monomial terms of coefs.

Type:

int

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

shift(t_0: float, alpha: float = 1, return_poly: bool = False)

Transform a polynomial with respect to an affine shift in the coordinate system. That is, \(P(x) = Q(\alpha\cdot(t-t_0))\).

Be careful to follow the convention that the transformation parameters express the current coordinate system as a shifted, and then scaled version of the new coordinate system. If the new coordinate is \(t = \beta\cdot x - t_0\), then \(x = (t - t_0)/\beta\), and \(\alpha = 1/\beta\).

Parameters:

• t_0 (float) – the current center coordinate in the new coordinate system. That is, x=0 when t=t_0.

• alpha (float) – the scale. That is, when t = t0 + 1, then x = alpha. NOTE: it is assumed that the coordinate system is re-centered, and then scaled.

• return_poly (bool) – if True, a Poly1DType object be returned, otherwise the coefficients array is returned.

Return type:

Poly1DType|numpy.ndarray

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.Poly2DType(Coefs: ndarray | list | tuple = None, **kwargs)

Bases: Poly2DType

property Coefs: ndarray

The two-dimensional polynomial coefficient array of dtype=float64. Assignment object must be a two-dimensional numpy.ndarray, or naively convertible to one.

Note

this returns the direct coefficient array. Use the get_array() method to get a copy of the coefficient array of specified data type.

Type:

numpy.ndarray

copy()

Create a deep copy.

classmethod from_array(array: ndarray | list | tuple)

Create from the coefficients array type entry.

Parameters:

array (numpy.ndarray|list|tuple) – must be two-dimensional.

Return type:

Poly2DType

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

get_array(dtype=<class 'numpy.float64'>) → ndarray

Gets a copy of the coefficent array of specified data type.

Parameters:

dtype (str|numpy.dtype|numpy.number) – numpy data type of the return

Returns:

two-dimensional coefficient array

Return type:

numpy.ndarray

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

minimize_order()

Trim the trailing zeros for the coefficient array. This modifies the object in place.

Return type:

None

property order1: int

The order1 attribute [READ ONLY] - that is, largest exponent1 presented in the monomial terms of coefs.

Type:

int

property order2: int

The order1 attribute [READ ONLY] - that is, largest exponent2 presented in the monomial terms of coefs.

Type:

int

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

shift(t1_shift: float = 0, t1_scale: float = 1, t2_shift: float = 0, t2_scale: float = 1, return_poly: bool = False)

Transform a polynomial with respect to an affine shift in the coordinate system. That is, \(P(x1, x2) = Q(t1_scale\cdot(t1 - t1_shift), t2_scale\cdot(t2 - t2_shift))\).

Be careful to follow the convention that the transformation parameters express the current coordinate system as a shifted, and then scaled version of the new coordinate system.

Parameters:

• t1_shift (float) – the current center coordinate in the new coordinate system. That is, x1=0 when t1=t1_shift.

• t1_scale (float) – the scale. That is, when t1 = t1_shift + 1, then x1 = t1_scale. NOTE: it is assumed that the coordinate system is re-centered, and then scaled.

• t2_shift (float) – the current center coordinate in the new coordinate system. That is, x2=0 when t2=t2_shift.

• t2_scale (float) – the scale. That is, when t2 = t2_shift + 1, then x2 = t2_scale. NOTE: it is assumed that the coordinate system is re-centered, and then scaled.

• return_poly (bool) – if True, a Poly2DType object be returned, otherwise the coefficients array is returned.

Return type:

Poly2DType|numpy.ndarray

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.XYZPolyType(X: Poly1DType | ndarray | list | tuple = None, Y: Poly1DType | ndarray | list | tuple = None, Z: Poly1DType | ndarray | list | tuple = None, **kwargs)

Bases: XYZPolyType

X: Poly1DType

The polynomial for the X coordinate. Required.

Type:

Poly1DType

Y: Poly1DType

The polynomial for the Y coordinate. Required.

Type:

Poly1DType

Z: Poly1DType

The polynomial for the Z coordinate. Required.

Type:

Poly1DType

copy()

Create a deep copy.

derivative(der_order: int = 1, return_poly: bool = False)

Calculate the der_order derivative of each component polynomial.

Parameters:

• der_order (int) – the order of the derivative

• return_poly (bool) – if True, a XYZPolyType if returned, otherwise a list of the coefficient arrays is returned.

Return type:

XYZPolyType|list

derivative_eval(t: float | int | ndarray, der_order: int = 1) → ndarray

Evaluate the der_order derivative of the polynomial collection at points x. This uses the functionality presented in numpy.polynomial.polynomial.

Parameters:

• t (float|int|numpy.ndarray) – The point(s) at which to evaluate.

• der_order (int) – The derivative.

Return type:

numpy.ndarray

classmethod from_array(array: ndarray | list | tuple)

Create from an array type entry.

Parameters:

array (numpy.ndarray|list|tuple) – assumed [X, Y, Z]

Return type:

XYZPolyType

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

get_array(dtype='object') → ndarray

Gets an array representation of the class instance.

Parameters:

dtype (str|numpy.dtype|numpy.number) – numpy data type of the return. If object, an array of Poly1DType objects is returned. Otherwise, a ndarray of shape (3, N) of coefficient vectors is returned.

Returns:

array of the form [X,Y,Z].

Return type:

numpy.ndarray

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

minimize_order()

Trim the trailing zeros for each component coefficient array. This modifies the object in place.

Return type:

None

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

shift(t_0: float, alpha: float = 1, return_poly: bool = False)

Transform a polynomial with respect to an affine shift in the coordinate system. That is, \(P(u) = Q(\alpha\cdot(t-t_0))\).

Be careful to follow the convention that the transformation parameters express the current coordinate system as a shifted, and then scaled version of the new coordinate system. If the new coordinate is \(t = \beta\cdot u - t_0\), then \(u = (t - t_0)/\beta\), and \(\alpha = 1/\beta\).

Parameters:

• t_0 (float) – the current center coordinate in the new coordinate system. That is, u=0 when t=t_0.

• alpha (float) – the scale. That is, when t = t0 + 1, then \(u = \alpha\).

• return_poly (bool) – if True, an XYZPolyType instance is returned, otherwise a list of the coefficient arrays is returned.

Return type:

XYZPolyType|list

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.ErrorStatisticsType(CompositeSCP: CompositeSCPErrorType | None = None, Components: ErrorComponentsType | None = None, Unmodeled: UnmodeledType | None = None, AdditionalParms: None | ParametersCollection | Dict = None, **kwargs)

Bases: ErrorStatisticsType

AdditionalParms: ParametersCollection | None

Any additional parameters. Optional.

Type:

ParametersCollection

Components: ErrorComponentsType | None

Error statistics by components. Optional.

Type:

ErrorComponentsType

CompositeSCP: CompositeSCPErrorType | None

Composite error statistics for the scene center point. Slant plane range (Rg) and azimuth (Az) error statistics. Slant plane defined at Scene Center Point, Center of Azimuth (SCP COA). Optional.

Type:

CompositeSCPErrorType

Unmodeled: UnmodeledType | None

Optional.

Type:

UnmodeledType

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

version_required()

What SICD version is required?

Return type:

Tuple[int, int, int]

class sarpy.io.product.sidd2_elements.blocks.RadiometricType(NoiseLevel: NoiseLevelType_ | None = None, RCSSFPoly: None | Poly2DType | ndarray | list | tuple = None, SigmaZeroSFPoly: None | Poly2DType | ndarray | list | tuple = None, BetaZeroSFPoly: None | Poly2DType | ndarray | list | tuple = None, GammaZeroSFPoly: None | Poly2DType | ndarray | list | tuple = None, **kwargs)

Bases: RadiometricType

BetaZeroSFPoly: Poly2DType

Polynomial that yields a scale factor to convert pixel power to radar brightness or Beta-Zero as a function of image row coordinate (variable 1) and column coordinate (variable 2). Scale factor computed for a clutter cell at HAE = SCP_HAE. Optional.

Type:

Poly2DType

GammaZeroSFPoly: Poly2DType

Polynomial that yields a scale factor to convert pixel power to clutter parameter Gamma-Zero as a function of image row coordinate (variable 1) and column coordinate (variable 2). Scale factor computed for a clutter cell at HAE = SCP_HAE. Optional.

Type:

Poly2DType

NoiseLevel: NoiseLevelType_

Noise level structure. Optional.

Type:

NoiseLevelType_

RCSSFPoly: Poly2DType

Polynomial that yields a scale factor to convert pixel power to RCS (m^2) as a function of image row coordinate (variable 1) and column coordinate (variable 2). Scale factor computed for a target at HAE = SCP_HAE. Optional.

Type:

Poly2DType

SigmaZeroSFPoly: Poly2DType

Polynomial that yields a scale factor to convert pixel power to clutter parameter Sigma-Zero as a function of image row coordinate (variable 1) and column coordinate (variable 2). Scale factor computed for a clutter cell at HAE = SCP_HAE. Optional.

Type:

Poly2DType

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.MatchInfoType(MatchTypes: List[MatchType] = None, **kwargs)

Bases: MatchInfoType

MatchTypes: List[MatchType]

The match types list. Required.

Type:

List[MatchType]

property NumMatchTypes: int

The number of types of matched collections.

Type:

int

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.GeoInfoType(name: str = None, Descriptions: None | ParametersCollection | Dict = None, Point=None, Line=None, Polygon=None, GeoInfos=None, **kwargs)

Bases: GeoInfoType

Descriptions: ParametersCollection

Descriptions of the geographic feature. Optional.

Type:

ParametersCollection

property FeatureType: str | None

READ ONLY attribute. Identifies the feature type among. This is determined by returning the (first) attribute among Point, Line, Polygon which is populated. None will be returned if none of them are populated.

Type:

str

property GeoInfos

list of GeoInfos.

Type:

List[GeoInfoType]

Line: SerializableArray | List[LatLonArrayElementType]

A geographic line (array) with WGS-84 coordinates. Must have length exactly 2. Optional.

Type:

numpy.ndarray[LatLonArrayElementType]

Point: LatLonRestrictionType

A geographic point with WGS-84 coordinates. Optional.

Type:

LatLonRestrictionType

Polygon: SerializableArray | List[LatLonArrayElementType]

A geographic polygon (array) with WGS-84 coordinates. Must have length exactly 3. Optional.

Type:

numpy.ndarray[LatLonArrayElementType]

addGeoInfo(value)

Add the given GeoInfo to the GeoInfos list.

Parameters:

value (GeoInfoType|Dict) –

Return type:

None

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

getGeoInfo(key: str)

Get GeoInfo(s) with name attribute == key.

Parameters:

key (str) –

Return type:

List[GeoInfoType]

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

name: str

The name. Required.

Type:

str

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.RadarModeType(ModeType: str = None, ModeID: str | None = None, **kwargs)

Bases: RadarModeType

Radar mode type container class

ModeType: str

The Radar imaging mode. Takes values in ('SPOTLIGHT', 'STRIPMAP', 'DYNAMIC STRIPMAP', 'SCANSAR'). Required.

Type:

str

ModeID: str

Radar imaging mode per Program Specific Implementation Document. Optional.

Type:

str

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

get_mode_abbreviation() → str

Get the mode abbreviation for the suggested name.

Return type:

str

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.ReferencePointType(ECEF=None, Point=None, name=None, **kwargs)

Bases: Serializable

A reference point.

ECEF: XYZType

The ECEF coordinates of the reference point. Required.

Type:

XYZType

Point: RowColDoubleType

The pixel coordinates of the reference point. Required.

Type:

RowColDoubleType

name: None | str

Used for implementation specific signifier for the reference point. Optional.

Type:

str

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.PredefinedFilterType(DatabaseName=None, FilterFamily=None, FilterMember=None, **kwargs)

Bases: Serializable

The predefined filter type.

DatabaseName: str

The filter name. Takes values in ('BILINEAR', 'CUBIC', 'LAGRANGE', 'NEAREST NEIGHBOR'). Optional.

Type:

str

FilterFamily: int

The filter family number. Optional.

Type:

int

FilterMember: int

The filter member number. Optional.

Type:

int

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.FilterKernelType(Predefined=None, Custom=None, **kwargs)

Bases: Serializable

The filter kernel parameters. Provides the specifics for either a predefined or custom filter kernel.

Predefined: PredefinedFilterType

Optional.

Type:

PredefinedFilterType

Custom: str

Takes values in ('GENERAL', 'FILTER BANK'). Optional.

Type:

str

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.BankCustomType(Coefs=None, **kwargs)

Bases: Serializable, Arrayable

A custom filter bank array.

property numPhasings

The number of phasings [READ ONLY]

Type:

int

property numPoints

The number of points [READ ONLY]

Type:

int

property Coefs

The two-dimensional filter coefficient array of dtype=float64. Assignment object must be a two-dimensional numpy.ndarray, or naively convertible to one.

Note

this returns the direct coefficient array. Use the get_array() method to get a copy of the coefficient array of specified data type.

Type:

numpy.ndarray

classmethod from_array(array: ndarray) → BankCustomType

Create from an array type object.

Parameters:

array (numpy.ndarray|list|tuple) –

Return type:

Arrayable

get_array(dtype=<class 'numpy.float64'>)

Gets a copy of the coefficent array of specified data type.

Parameters:

dtype (str|numpy.dtype|numpy.number) – numpy data type of the return

Returns:

two-dimensional coefficient array

Return type:

numpy.ndarray

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.FilterBankType(Predefined=None, Custom=None, **kwargs)

Bases: Serializable

The filter bank type. Provides the specifics for either a predefined or custom filter bank.

Predefined: PredefinedFilterType

The predefined filter bank type. Optional.

Type:

PredefinedFilterType

Custom: BankCustomType

The custom filter bank. Optional.

Type:

BankCustomType

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.FilterType(FilterName=None, FilterKernel=None, FilterBank=None, Operation=None, **kwargs)

Bases: Serializable

Filter parameters for a variety of purposes. Provides either the filter bank or filter kernel parameters.

FilterName

The name of the filter. Required.

Type:

str

FilterKernel: FilterKernelType

The filter kernel. Optional.

Type:

FilterKernelType

FilterBank: FilterBankType

The filter bank. Optional.

Type:

FilterBankType

Operation: str

Takes values in ('CONVOLUTION', 'CORRELATION'). Required.

Type:

str

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.PredefinedLookupType(DatabaseName=None, RemapFamily=None, RemapMember=None, **kwargs)

Bases: Serializable

The predefined lookup table type. Allows for reference either by name, or family/member id number.

DatabaseName: str

Database name of LUT to use. Optional.

Type:

str

RemapFamily: int

The lookup family number. Optional.

Type:

int

RemapMember: int

The lookup member number. Optional.

Type:

int

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.product.sidd2_elements.blocks.LUTInfoType(LUTValues=None, **kwargs)

Bases: Serializable, Arrayable

The lookup table - basically just a one or two-dimensional unsigned integer array of bit depth 8 or 16.

property LUTValues

the two-dimensional look-up table, where the dtype must be uint8 or uint16. The first dimension should correspond to entries (i.e. size of the lookup table), and the second dimension should correspond to bands (i.e. number of bands).

Type:

numpy.ndarray

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

property size

the size of each lookup table

Type:

int

property numLUTs

The number of lookup tables

Type:

int

classmethod from_array(array)

Create from the lookup table array.

Parameters:

array (numpy.ndarray|list|tuple) – Must be two-dimensional. If not a numpy.ndarray, this will be naively interpreted as uint8.

Return type:

LUTInfoType

get_array(dtype=<class 'numpy.uint8'>)

Gets a copy of the coefficent array of specified data type.

Parameters:

dtype (str|numpy.dtype|numpy.number) – numpy data type of the return

Returns:

the lookup table array

Return type:

numpy.ndarray

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

class sarpy.io.product.sidd2_elements.blocks.CustomLookupType(LUTInfo=None, **kwargs)

Bases: Serializable

A custom lookup table.

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

LUTInfo: LUTInfoType

The lookup table. Required.

Type:

LUTInfoType

class sarpy.io.product.sidd2_elements.blocks.NewLookupTableType(LUTName=None, Predefined=None, Custom=None, **kwargs)

Bases: Serializable

The lookup table. Allows either a reference to a prefined lookup table, or custom lookup table array.

copy()

Create a deep copy.

classmethod from_dict(input_dict)

For json deserialization, from dict instance.

Parameters:

input_dict (dict) – Appropriate parameters dict instance for deserialization

Return type:

Corresponding class instance

classmethod from_node(node, xml_ns, ns_key=None, kwargs=None)

For XML deserialization.

Parameters:

• node (ElementTree.Element) – dom element for serialized class instance

• xml_ns (None|dict) – The xml namespace dictionary.

• ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.

• kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)

Returns the validity of this object according to the schema. This is done by inspecting that all required fields (i.e. entries of _required) are not None.

Parameters:

• recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.

• stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)

Log a validity check error message.

Parameters:

msg (str) –

log_validity_info(msg)

Log a validation info message.

Parameters:

msg (str) –

log_validity_warning(msg)

Log a validity check warning message.

Parameters:

msg (str) –

set_numeric_format(attribute, format_string)

Sets the numeric format string for the given attribute.

Parameters:

• attribute (str) – attribute for which the format applies - must be in _fields.

• format_string (str) – format string to be applied

Return type:

None

to_dict(check_validity=False, strict=False, exclude=())

For json serialization.

Parameters:

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

to_node(doc, tag, ns_key=None, parent=None, check_validity=False, strict=False, exclude=())

For XML serialization, to a dom element.

Parameters:

• doc (ElementTree.ElementTree) – The xml Document

• tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.

• ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.

• parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

• exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

The constructed dom element, already assigned to the parent element.

Return type:

ElementTree.Element

to_xml_bytes(urn=None, tag=None, check_validity=False, strict=False)

Gets a bytes array, which corresponds to the xml string in utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

to_xml_string(urn=None, tag=None, check_validity=False, strict=False)

Gets a xml string with utf-8 encoding, identified as using the namespace given by urn (if given).

Parameters:

• urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.

• tag (None|str) – The root node tag to use. If not given, then the class name will be used.

• check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().

• strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

LUTName: str

The lookup table name Required.

Type:

str

Predefined: PredefinedLookupType

Optional.

Type:

PredefinedLookupType

Custom: CustomLookupType

Optional.

Type:

CustomLookupType