AFRL/RDE labeling Info (sarpy.annotation.afrl_rde_elements.Research)

Definition for the main NGA modified RDE/AFRL labeling object

class sarpy.annotation.afrl_rde_elements.Research.ResearchType(MetadataVersion='Unknown', DetailCollectionInfo=None, DetailSubCollectionInfo=None, DetailImageInfo=None, DetailSensorInfo=None, DetailFiducialInfo=None, DetailObjectInfo=None, **kwargs)

Bases: Serializable

MetadataVersion: str

The version number Required.

Type:

str

DetailCollectionInfo: CollectionInfoType | None

High level information about the data collection Required.

Type:

CollectionInfoType

DetailSubCollectionInfo: SubCollectionInfoType | None

Information about sub-division of the overall data collection Required.

Type:

SubCollectionInfoType

DetailImageInfo: ImageInfoType | None

Information about the referenced image Required.

Type:

ImageInfoType

DetailSensorInfo: SensorInfoType | None

Information about the sensor Required.

Type:

SensorInfoType

DetailFiducialInfo: FiducialInfoType | None

Information about the ground-truthed fiducials Required.

Type:

FiducialInfoType

DetailObjectInfo: ObjectInfoType | None

Information about the ground-truthed objects Required.

Type:

ObjectInfoType

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='RESEARCH', 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='RESEARCH', 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

apply_sicd(sicd, base_file_name, layover_shift=False, populate_in_periphery=False, include_out_of_range=False, padding_fraction=0.05, minimum_pad=0, md5_checksum=None)

Apply the given sicd to define all the relevant derived data, assuming that the starting point is physical ground truth populated, and image details and locations will be inferred. This modifies the structure in place.

Parameters:

• sicd (SICDType) –

• base_file_name (str) –

• layover_shift (bool) –

• populate_in_periphery (bool) –

• include_out_of_range (bool) –

• padding_fraction (None|float) –

• minimum_pad (int|float) –

• md5_checksum (None|str) –

apply_sicd_reader(sicd_reader, layover_shift=False, populate_in_periphery=False, include_out_of_range=False, padding_fraction=0.05, minimum_pad=0, populate_md5=True)

Apply the given sicd to define all the relevant derived data, assuming that the starting point is physical ground truth populated, and image details and locations will be inferred. This modifies the structure in place.

Parameters:

• sicd_reader (SICDReader) –

• layover_shift (bool) –

• populate_in_periphery (bool) –

• include_out_of_range (bool) –

• padding_fraction (None|float) –

• minimum_pad (int|float) –

• populate_md5 (bool) –

classmethod from_xml_file(file_path)

Construct the research object from an xml file path.

Parameters:

file_path (str) –

Return type:

ResearchType

classmethod from_xml_string(xml_string)

Construct the research object from an xml string.

Parameters:

xml_string (str|bytes) –

Return type:

ResearchType