sarkit.verification.CphdConsistency.from_parts

static CphdConsistency.from_parts(cphd_xml, file_type_header=None, kvp_list=None, pvps=None, schema=None)

Create a CphdConsistency object from assorted parts

Parameters:

cphd_xmllxml.etree.Element or lxml.etree.ElementTree

CPHD XML

file_type_headerstr, optional

File type header from the first line of the file

kvp_listdict of {strstr}, optional

Key-Value pair list of header fields

pvpsdict of {strndarray], optional

CPHD Per-Vector-Parameters keyed by channel identifier

schemastr, optional

Path to XML Schema. If None, tries to find a version-specific schema

Returns:

CphdConsistency

The initialized consistency checker object

See also

from_file

Examples

Use from_parts to check a parsed XML element tree:

>>> import lxml.etree
>>> import sarkit.verification as skver
>>> cphd_xmltree = lxml.etree.parse("data/example-cphd-1.1.0.xml")
>>> con = skver.CphdConsistency.from_parts(cphd_xmltree)
>>> con.check()
>>> bool(con.passes())
True
>>> bool(con.failures())
False

Use from_parts to check a parsed XML element tree and an invalid file type header:

>>> con = skver.CphdConsistency.from_parts(cphd_xmltree, file_type_header="CPHD/INVALID\n")
>>> con.check()
>>> bool(con.failures())
True