The CRSD 1.0 Channel object¶

The Channel definition.

class sarpy.io.received.crsd1_elements.Channel.RcvAntennaType(RcvAPCId=None, RcvAPATId=None, **kwargs)¶

Bases: Serializable

The receive antenna information.

RcvAPCId: str¶

Identifier for the Receive APC to be used to compute the receive antenna pattern as a function of time for the channel (APC_ID). Required.

Type:: str

RcvAPATId: str¶

Identifier for the Receive Antenna pattern to collect the signal data (APAT_ID). Required.

Type:: str

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

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

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

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

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

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

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

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

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

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

Return type:

ElementTree.Element

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

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

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

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

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

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.received.crsd1_elements.Channel.SignalRefLevelType(PSCRSD=None, PRcvDensity=None, **kwargs)¶

Bases: Serializable

The signal power level information.

PSCRSD: float¶

Power level in the fast time signal vector for a CW tone at f = f_0_REF and for f_IC(v,t) = f_0_REF. Required.

Type:: float

PRcvDensity: float¶

Receive power density per unit area for a CW tone at f = f_0_REF that results in signal vector power PS_CRSD. Signal received from a far field source located along the receive antenna mainlobe boresight at t = trs(v_CH_REF). 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.received.crsd1_elements.Channel.NoiseLevelType(PNCRSD=None, BNCRSD=None, **kwargs)¶

Bases: Serializable

The thermal noise level information.

PNCRSD: float¶

Noise power level in fast time signal vector for f_IC(v,t) = f_0(v_CH_REF). Required.

Type:: float

BNCRSD: float¶

Noise Equivalent BW for the noise signal. Bandwidth BN_CRSD is expressed relative to the fast time sample rate for the channel (fs). 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.received.crsd1_elements.Channel.TxAntennaType(TxAPCId=None, TxAPATId=None, **kwargs)¶

Bases: Serializable

The receive antenna information.

TxAPCId: str¶

Identifier of Transmit APC to be used to compute the transmit antenna pattern as a function of time for the channel (APC_ID). Required.

Type:: str

TxAPATId: str¶

Identifier of the Transmit Antenna pattern used to form the channel signal array (APAT_ID). Required.

Type:: str

copy()¶: Create a deep copy.

classmethod from_dict(input_dict)¶

For json deserialization, from dict instance.

Parameters:: input_dict (dict) – Appropriate parameters dict instance for deserialization
Return type:: Corresponding class instance

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

For XML deserialization.

Parameters:

node (ElementTree.Element) – dom element for serialized class instance
xml_ns (None|dict) – The xml namespace dictionary.
ns_key (None|str) – The xml namespace key. If xml_ns is None, then this is ignored. If None and xml_ns is not None, then the string default will be used. This will be recursively passed down, unless overridden by an entry of the cls._child_xml_ns_key dictionary.
kwargs (None|dict) – None or dictionary of previously serialized attributes. For use in inheritance call, when certain attributes require specific deserialization.

Return type:

Corresponding class instance

is_valid(recursive=False, stack=False)¶

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

Parameters:

recursive (bool) – True if we recursively check that child are also valid. This may result in verbose (i.e. noisy) logging.
stack (bool) – Print a recursive error message?

Returns:

condition for validity of this element

Return type:

bool

log_validity_error(msg)¶

Log a validity check error message.

Parameters:: msg (str) –

log_validity_info(msg)¶

Log a validation info message.

Parameters:: msg (str) –

log_validity_warning(msg)¶

Log a validity check warning message.

Parameters:: msg (str) –

set_numeric_format(attribute, format_string)¶

Sets the numeric format string for the given attribute.

Parameters:

attribute (str) – attribute for which the format applies - must be in _fields.
format_string (str) – format string to be applied

Return type:

None

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

For json serialization.

Parameters:

check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

dict representation of class instance appropriate for direct json serialization.

Return type:

OrderedDict

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

For XML serialization, to a dom element.

Parameters:

doc (ElementTree.ElementTree) – The xml Document
tag (None|str) – The tag name. Defaults to the value of self._tag and then the class name if unspecified.
ns_key (None|str) – The namespace prefix. This will be recursively passed down, unless overridden by an entry in the _child_xml_ns_key dictionary.
parent (None|ElementTree.Element) – The parent element. Defaults to the document root element if unspecified.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.
exclude (tuple) – Attribute names to exclude from this generic serialization. This allows for child classes to provide specific serialization for special properties, after using this super method.

Returns:

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

Return type:

ElementTree.Element

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

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

Parameters:

urn (None|str|dict) – The xml namespace string or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

bytes array from ElementTree.tostring() call.

Return type:

bytes

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

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

Parameters:

urn (None|str|dict) – The xml namespace or dictionary describing the xml namespace.
tag (None|str) – The root node tag to use. If not given, then the class name will be used.
check_validity (bool) – Check whether the element is valid before serializing, by calling is_valid().
strict (bool) – Only used if check_validity = True. In that case, if True then raise an Exception (of appropriate type) if the structure is not valid, if False then log a hopefully helpful message.

Returns:

xml string from ElementTree.tostring() call.

Return type:

str

class sarpy.io.received.crsd1_elements.Channel.SARImagingType(TxLFMFixed=None, TxPol=None, DwellTimes=None, TxAntenna=None, ImageArea=None, **kwargs)¶

Bases: Serializable

The SAR Imaging parameters

TxLFMFixed: None | bool¶

Flag to indicate the same transmit LFM waveform is used for all pulses. vectors of the channel. Optional.

Type:: bool

TxPol: str¶

Transmitted signal polarization for the channel. Takes values in ('H', 'V', 'X', 'Y', 'S', 'E', 'RHC', 'LHC', 'UNSPECIFIED'). Required.

Type:: str

DwellTimes: DwellTimesType¶

COD Time and Dwell Time polynomials over the image area. Required.

Type:: DwellTimesType

TxAntenna: None | TxAntennaType¶

Antenna Phase Center and Antenna Pattern identifiers for the transmit antenna used to illuminate the imaged area. Optional.

Type:: TxAntennaType

ImageArea: None | AreaType¶

SAR Image Area for the channel defined by a rectangle aligned with (IAX, IAY). May be reduced by the optional polygon. Optional.

Type:: AreaType

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.received.crsd1_elements.Channel.ChannelParametersType(Identifier=None, RefVectorIndex=None, RefFreqFixed=None, FrcvFixed=None, DemodFixed=None, F0Ref=None, Fs=None, BWInst=None, RcvPol=None, SignalNormal=None, RcvAntenna=None, SignalRefLevel=None, NoiseLevel=None, AddedParameters=None, SARImaging=None, **kwargs)¶

Bases: Serializable

The CRSD data channel parameters

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

Identifier: str¶

String that uniquely identifies this CRSD data channel. Required.

Type:: str

RefVectorIndex: int¶

Index of the reference vector for the channel. Must be in the range [0, None] Required.

Type:: int

RefFreqFixed: bool¶

Flag to indicate a constant reference frequency is used for the channel. Required.

Type:: bool

FrcvFixed: bool¶

Flag to indicate a constant receive band is saved for the channel. Required.

Type:: bool

DemodFixed: bool¶

Flag to indicate a constant demodulation is used for the channel. Required.

Type:: bool

F0Ref: float¶

Reference frequency for the reference signal vector. Must be in the range [0, None] Required.

Type:: float

Fs: float¶

Fast time sample rate for the signal array. Must be in the range [0, None] Required.

Type:: float

BWInst: float¶

Nominal instantaneous bandwidth for the channel. Must be in the range [0, None] Required.

Type:: float

RcvPol: str¶

Receive polarization for the signal data processed to form the signal array. Parameter describes the E-Field orientation of the signal. Takes values in ('H', 'V', 'X', 'Y', 'S', 'E', 'RHC', 'LHC', 'UNSPECIFIED'). Required.

Type:: str

SignalNormal: None | bool¶

Flag to indicate when all signal array vectors are normal. Included if and only if the SIGNAL PVP is also included. Optional.

Type:: bool

RcvAntenna: None | RcvAntennaType¶

Antenna Phase Center and Antenna Pattern identifiers for the receive antenna used to collect and form the signal array data. Optional.

Type:: RcvAntennaType

SignalRefLevel: None | SignalRefLevelType¶

Signal power levels for a received CW signal with f = f_0_REF and polarization matched to RcvPol of the channel. Optional.

Type:: SignalRefLevelType

NoiseLevel: None | NoiseLevelType¶

Thermal noise level in the CRSD signal vector for f_IC(v,t) = f_0(v_CH_REF). Optional.

Type:: NoiseLevelType

AddedParameters: None | ParametersCollection¶

Additional free form parameters. Optional.

Type:: ParametersCollection

SARImaging: None | SARImagingType¶

Structure included for all SAR imaging collections. Optional.

Type:: SARImagingType

class sarpy.io.received.crsd1_elements.Channel.ChannelType(RefChId=None, Parameters=None, **kwargs)¶

Bases: Serializable

The channel 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

RefChId: str¶

Channel ID for the Reference Channel in the product. Required.

Type:: str

Parameters: List[ChannelParametersType]¶

Parameter Set that describes a CRSD data channel. Required.

Type:: List[ChannelParametersType]

The CRSD 1.0 Channel object¶

Table of Contents

Previous topic

Next topic

This Page