ErrorStatistics object and related elements¶

The ErrorStatisticsType definition.

class sarpy.io.complex.sicd_elements.ErrorStatistics.CompositeSCPErrorType(Rg: float = None, Az: float = None, RgAz: float = None, **kwargs)¶

Bases: Serializable

Composite error statistics for the Scene Center Point. Slant plane range (Rg) and azimuth (Az) error statistics. Slant plane defined at SCP COA.

Rg: float¶

Estimated range error standard deviation. Required.

Type:: float

Az: float¶

Estimated azimuth error standard deviation. Required.

Type:: float

RgAz: float¶

Estimated range and azimuth error correlation coefficient. Required.

Type:: 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.ErrorStatistics.CorrCoefsType(P1P2: float = None, P1P3: float = None, P1V1: float = None, P1V2: float = None, P1V3: float = None, P2P3: float = None, P2V1: float = None, P2V2: float = None, P2V3: float = None, P3V1: float = None, P3V2: float = None, P3V3: float = None, V1V2: float = None, V1V3: float = None, V2V3: float = None, **kwargs)¶

Bases: Serializable

Correlation Coefficient parameters.

P1P2: float¶

P1 and P2 correlation coefficient. Required.

Type:: float

P1P3: float¶

P1 and P3 correlation coefficient. Required.

Type:: float

P1V1: float¶

P1 and V1 correlation coefficient. Required.

Type:: float

P1V2: float¶

P1 and V2 correlation coefficient. Required.

Type:: float

P1V3: float¶

P1 and V3 correlation coefficient. Required.

Type:: float

P2P3: float¶

P2 and P3 correlation coefficient. Required.

Type:: float

P2V1: float¶

P2 and V1 correlation coefficient. Required.

Type:: float

P2V2: float¶

P2 and V2 correlation coefficient. Required.

Type:: float

P2V3: float¶

P2 and V3 correlation coefficient. Required.

Type:: float

P3V1: float¶

P3 and V1 correlation coefficient. Required.

Type:: float

P3V2: float¶

P3 and V2 correlation coefficient. Required.

Type:: float

P3V3: float¶

P3 and V3 correlation coefficient. Required.

Type:: float

V1V2: float¶

V1 and V2 correlation coefficient. Required.

Type:: float

V1V3: float¶

V1 and V3 correlation coefficient. Required.

Type:: float

V2V3: float¶

V2 and V3 correlation coefficient. Required.

Type:: 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.ErrorStatistics.PosVelErrType(Frame: str = None, P1: float = None, P2: float = None, P3: float = None, V1: float = None, V2: float = None, V3: float = None, CorrCoefs: CorrCoefsType | None = None, PositionDecorr: ErrorDecorrFuncType | None = None, **kwargs)¶

Bases: Serializable

Position and velocity error statistics for the radar platform.

Frame: str¶

RIC = Radial, In-Track, Cross-Track, where radial is defined to be from earth center through the platform position. Takes values in ('ECF', 'RIC_ECF', 'RIC_ECI'). Required.

Type:: str
Type:: Coordinate frame used for expressing P,V errors statistics. Note

P1: float¶

Position coordinate 1 standard deviation. Required.

Type:: float

P2: float¶

Position coordinate 2 standard deviation. Required.

Type:: float

P3: float¶

Position coordinate 3 standard deviation. Required.

Type:: float

V1: float¶

Velocity coordinate 1 standard deviation. Required.

Type:: float

V2: float¶

Velocity coordinate 2 standard deviation. Required.

Type:: float

V3: float¶

Velocity coordinate 3 standard deviation. Required.

Type:: float

CorrCoefs: CorrCoefsType | None¶

Correlation Coefficient parameters. Optional.

Type:: CorrCoefsType

PositionDecorr: ErrorDecorrFuncType | None¶

Platform position error decorrelation function. Optional.

Type:: ErrorDecorrFuncType

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.ErrorStatistics.RadarSensorErrorType(RangeBias: float = None, ClockFreqSF: float | None = None, TransmitFreqSF: float | None = None, RangeBiasDecorr: ErrorDecorrFuncType | None = None, **kwargs)¶

Bases: Serializable

Radar sensor error statistics.

RangeBias: float¶

Range bias error standard deviation. Required.

Type:: float

ClockFreqSF: float¶

Payload clock frequency scale factor standard deviation, where \(SF = (\Delta f)/f_0\). Optional.

Type:: float

TransmitFreqSF: float¶

Transmit frequency scale factor standard deviation, where \(SF = (\Delta f)/f_0\). Optional.

Type:: float

RangeBiasDecorr: ErrorDecorrFuncType¶

Range bias decorrelation rate. Optional.

Type:: ErrorDecorrFuncType

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.ErrorStatistics.TropoErrorType(TropoRangeVertical: float | None = None, TropoRangeSlant: float | None = None, TropoRangeDecorr: ErrorDecorrFuncType | None = None, **kwargs)¶

Bases: Serializable

Troposphere delay error statistics.

TropoRangeVertical: float¶

Troposphere two-way delay error for normal incidence standard deviation. Expressed as a range error. \((\Delta R) = (\Delta T) \cdot (c/2)\). Optional.

Type:: float

TropoRangeSlant: float¶

Troposphere two-way delay error for the SCP line of sight at COA standard deviation. Expressed as a range error. \((\Delta R) = (\Delta T) \cdot (c/2)\). Optional.

Type:: float

TropoRangeDecorr: ErrorDecorrFuncType¶

Troposphere range error decorrelation function. Optional.

Type:: ErrorDecorrFuncType

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.ErrorStatistics.IonoErrorType(IonoRangeVertical: float | None = None, IonoRangeSlant: float | None = None, IonoRgRgRateCC: float = None, IonoRangeDecorr: ErrorDecorrFuncType | None = None, **kwargs)¶

Bases: Serializable

Ionosphere delay error statistics.

IonoRangeVertical: float | None¶

Ionosphere two-way delay error for normal incidence standard deviation. Expressed as a range error. \((\Delta R) = (\Delta T) \cdot (c/2)\). Optional.

Type:: float

IonoRangeSlant: float | None¶

Ionosphere two-way delay rate of change error for normal incidence standard deviation. Expressed as a range rate error. \((\Delta \dot{R}) = (\Delta \dot{T}) \cdot (c/2)\). Optional.

Type:: float

IonoRgRgRateCC: float¶

Ionosphere range error and range rate error correlation coefficient. Required.

Type:: float

IonoRangeDecorr: ErrorDecorrFuncType | None¶

Ionosphere range error decorrelation rate. Optional.

Type:: ErrorDecorrFuncType

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.ErrorStatistics.ErrorComponentsType(PosVelErr: PosVelErrType = None, RadarSensor: RadarSensorErrorType = None, TropoError: TropoErrorType | None = None, IonoError: IonoErrorType | None = None, **kwargs)¶

Bases: Serializable

Error statistics by components.

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

PosVelErr: PosVelErrType¶

Position and velocity error statistics for the radar platform. Required.

Type:: PosVelErrType

RadarSensor: RadarSensorErrorType¶

Radar sensor error statistics. Required.

Type:: RadarSensorErrorType

TropoError: TropoErrorType¶

Troposphere delay error statistics. Optional.

Type:: TropoErrorType

IonoError: IonoErrorType¶

Ionosphere delay error statistics. Optional.

Type:: IonoErrorType

class sarpy.io.complex.sicd_elements.ErrorStatistics.UnmodeledDecorrType(Xrow: ErrorDecorrFuncType = None, Ycol: ErrorDecorrFuncType = None, **kwargs)¶

Bases: Serializable

Unmodeled decorrelation function definition

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

Xrow: ErrorDecorrFuncType¶

Required.

Type:: ErrorDecorrFuncType

Ycol: ErrorDecorrFuncType¶

Required.

Type:: ErrorDecorrFuncType

class sarpy.io.complex.sicd_elements.ErrorStatistics.UnmodeledType(Xrow: float = None, Ycol: float = None, XrowYcol: float = None, UnmodeledDecorr: UnmodeledDecorrType | None = None, **kwargs)¶

Bases: Serializable

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

Xrow: float¶

Required.

Type:: float

Ycol: float¶

Required.

Type:: float

XrowYcol: float¶

Required.

Type:: float

UnmodeledDecorr: UnmodeledDecorrType | None¶

Optional.

Type:: UnmodeledDecorrType

class sarpy.io.complex.sicd_elements.ErrorStatistics.ErrorStatisticsType(CompositeSCP: CompositeSCPErrorType | None = None, Components: ErrorComponentsType | None = None, Unmodeled: UnmodeledType | None = None, AdditionalParms: None | ParametersCollection | Dict = None, **kwargs)¶

Bases: Serializable

Parameters used to compute error statistics within the SICD sensor model.

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

CompositeSCP: CompositeSCPErrorType | None¶

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