The Basic SICD building blocks

This module contains the base objects for use in the SICD elements, and the base serializable functionality.

class sarpy.io.complex.sicd_elements.base.SerializableCPArrayDescriptor(name: str, child_type, tag_dict: Dict, required: Tuple[str, ...], strict: bool = False, docstring: str | None = None)

Bases: BasicDescriptor

A descriptor for properties of a list or array of specified extension of Serializable

Basic building blocks for SICD standard.

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

Bases: Serializable, Arrayable

A spatial point in ECF coordinates.

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

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

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

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.complex.sicd_elements.blocks.LatLonType(Lat: float = None, Lon: float = None, **kwargs)

Bases: Serializable, Arrayable

A two-dimensional geographic point in WGS-84 coordinates.

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

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

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

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.

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.complex.sicd_elements.blocks.LatLonArrayElementType(Lat: float = None, Lon: float = None, index: int = None, **kwargs)

Bases: LatLonType

A geographic point in an array

index: int

The array index Required.

Type:

int

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

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_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.complex.sicd_elements.blocks.LatLonRestrictionType(Lat: float = None, Lon: float = None, **kwargs)

Bases: LatLonType

A two-dimensional geographic point in WGS-84 coordinates.

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

classmethod from_array(array: ndarray | list | tuple)

Create from an array type entry.

Parameters:

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

Return type:

LatLonRestrictionType

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_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.complex.sicd_elements.blocks.LatLonHAEType(Lat: float = None, Lon: float = None, HAE: float = None, **kwargs)

Bases: LatLonType

A three-dimensional geographic point in WGS-84 coordinates.

HAE: float

The Height Above Ellipsoid (in meters) attribute. Assumed to be WGS-84 coordinates. Required.

Type:

float

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

Gets an array representation of the data.

Parameters:

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

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

Returns:

data array with appropriate entry order

Return type:

numpy.ndarray

classmethod from_array(array: ndarray | list | tuple)

Create from an array type entry.

Parameters:

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

Return type:

LatLonHAEType

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_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.complex.sicd_elements.blocks.LatLonHAERestrictionType(Lat: float = None, Lon: float = None, HAE: float = None, **kwargs)

Bases: LatLonHAEType

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

classmethod from_array(array: ndarray | list | tuple)

Create from an array type entry.

Parameters:

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

Return type:

LatLonHAERestrictionType

HAE: float

The Height Above Ellipsoid (in meters) 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_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='LAT') → ndarray

Gets an array representation of the data.

Parameters:

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

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

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.complex.sicd_elements.blocks.LatLonCornerType(Lat: float = None, Lon: float = None, index: int = None, **kwargs)

Bases: LatLonType

A two-dimensional geographic point in WGS-84 coordinates representing a collection area box corner point.

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

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

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_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.complex.sicd_elements.blocks.LatLonCornerStringType(Lat: float = None, Lon: float = None, index: str = None, **kwargs)

Bases: LatLonType

A two-dimensional geographic point in WGS-84 coordinates representing a collection area box corner point.

index: str

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

Type:

str

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

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_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.complex.sicd_elements.blocks.LatLonHAECornerRestrictionType(Lat: float = None, Lon: float = None, HAE: float = None, index: int = None, **kwargs)

Bases: LatLonHAERestrictionType

A three-dimensional geographic point in WGS-84 coordinates. Represents a collection area box corner point.

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

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, HAE]

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

Return type:

LatLonHAECornerRestrictionType

HAE: float

The Height Above Ellipsoid (in meters) attribute. Assumed to be WGS-84 coordinates. Required.

Type:

float

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_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='LAT') → ndarray

Gets an array representation of the data.

Parameters:

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

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

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.complex.sicd_elements.blocks.LatLonHAECornerStringType(Lat: float = None, Lon: float = None, HAE: float = None, index: str = None, **kwargs)

Bases: LatLonHAEType

A three-dimensional geographic point in WGS-84 coordinates. Represents a collection area box corner point.

index: str

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

Type:

str

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, HAE]

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

Return type:

LatLonHAECornerStringType

HAE: float

The Height Above Ellipsoid (in meters) attribute. Assumed to be WGS-84 coordinates. Required.

Type:

float

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_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='LAT') → ndarray

Gets an array representation of the data.

Parameters:

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

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

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.complex.sicd_elements.blocks.RowColType(Row: int = None, Col: int = None, **kwargs)

Bases: Serializable, Arrayable

A row and column attribute container - used as indices into array(s).

Row: int

The Row attribute. Required.

Type:

int

Col: int

The Column attribute. Required.

Type:

int

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

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

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.complex.sicd_elements.blocks.RowColArrayElement(Row: int = None, Col: int = None, index: int = None, **kwargs)

Bases: RowColType

An array element row and column attribute container - used as indices into other array(s).

index: int

The array index attribute. Required.

Type:

int

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

Col: int

The Column attribute. Required.

Type:

int

Row: int

The Row attribute. Required.

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

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.complex.sicd_elements.blocks.Poly1DType(Coefs: None | ndarray | list | tuple = None, **kwargs)

Bases: Serializable, Arrayable

Represents a one-variable polynomial, defined by one-dimensional coefficient array.

property order1: int

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

Type:

int

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

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

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

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

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

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

minimize_order()

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

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

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.complex.sicd_elements.blocks.Poly2DType(Coefs: ndarray | list | tuple = None, **kwargs)

Bases: Serializable, Arrayable

Represents a one-variable polynomial, defined by two-dimensional coefficient array.

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

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

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

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

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

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

minimize_order()

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

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

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.complex.sicd_elements.blocks.XYZPolyType(X: Poly1DType | ndarray | list | tuple = None, Y: Poly1DType | ndarray | list | tuple = None, Z: Poly1DType | ndarray | list | tuple = None, **kwargs)

Bases: Serializable, Arrayable

Represents a single variable polynomial for each of X, Y, and Z. This gives position in ECF coordinates as a function of a single dependent variable.

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

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

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

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

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

minimize_order()

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

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

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.complex.sicd_elements.blocks.XYZPolyAttributeType(X: Poly1DType | ndarray | list | tuple = None, Y: Poly1DType | ndarray | list | tuple = None, Z: Poly1DType | ndarray | list | tuple = None, index: int = None, **kwargs)

Bases: XYZPolyType

An array element of X, Y, Z polynomials. The output of these polynomials are expected to be spatial variables in the ECF coordinate system.

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_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

index: int

The array index value. Required.

Type:

int

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

Create from an array type entry.

Parameters:

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

• index (int) – the array index

Return type:

XYZPolyAttributeType

class sarpy.io.complex.sicd_elements.blocks.GainPhasePolyType(GainPoly: Poly2DType | ndarray | list | tuple = None, PhasePoly: Poly2DType | ndarray | list | tuple = None, **kwargs)

Bases: Serializable

A container for the Gain and Phase Polygon definitions.

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

GainPoly: Poly2DType

One-way signal gain (in dB) as a function of X-axis direction cosine (DCX) (variable 1) and Y-axis direction cosine (DCY) (variable 2). Gain relative to gain at DCX = 0 and DCY = 0, so constant coefficient is always 0.0. Required.

Type:

Poly2DType

PhasePoly: Poly2DType

One-way signal phase (in cycles) as a function of DCX (variable 1) and DCY (variable 2). Phase relative to phase at DCX = 0 and DCY = 0, so constant coefficient is always 0.0. Required.

Type:

Poly2DType

minimize_order()

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

Return type:

None

class sarpy.io.complex.sicd_elements.blocks.ErrorDecorrFuncType(CorrCoefZero: float = None, DecorrRate: float = None, **kwargs)

Bases: Serializable

This container allows parameterization of linear error decorrelation rate model. If \((\Delta t) = |t2 - t1|\), then

\[CC(\Delta t) = \min(1.0, \max(0.0, CC0 - DCR\cdot(\Delta t)))\]

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

CorrCoefZero: float

Error correlation coefficient for zero time difference (CC0). Must be in the range [-1, 1] Required.

Type:

float

DecorrRate: float

Error decorrelation rate. Simple linear decorrelation rate (DCR). Must be in the range [0, None] Required.

Type:

float