From eb6fbf61ee9ad313273f137c359e0b9190e3e5d7 Mon Sep 17 00:00:00 2001 From: WillForan Date: Mon, 25 Nov 2024 09:06:15 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20template=5Fchecker.py=20more=20n?= =?UTF-8?q?otes=20on=20ErrorCompare=20and=20CheckResults?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- template_checker.py | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/template_checker.py b/template_checker.py index b28d912e..057e7407 100644 --- a/template_checker.py +++ b/template_checker.py @@ -7,12 +7,17 @@ from acq2sqlite import DBQuery from dcmmeta2tsv import DicomTagReader, TagValues +#: Dictonary for mismatches in input (``have`` key) and template (``expect`` key) ErrorCompare = TypedDict("ErrorCompare", {"have": str, "expect": str}) -#: * ``conforms``: false when a parameter between input and template mismatch -#: * ``errors``: mismatched_param: ``{'have':...,'expect':...}`` -#: * ``input``: all parameters of an input dicom header -#: * ``template``: all the parameters of a template (matching Study, SeriesName) +#: * | ``conforms``: false when a :py:data:`acq2sqlite.DBQuery.CONSTS` +#: | template-parameter between ``input`` and ``template`` mismatch +#: * | ``errors``: nested dict of {``mismatched_param``: ``{'have':...,'expect':...}}`` +#: (parameter keyed dictionary with :py:class:`ErrorCompare` values) +#: * | ``input``: dict of all parameters of an input dicom header +#: | (:py:class:`dcmmeta2tsv.TagValues`) +#: * | ``template``: all the parameters of a template (matching Study, SeriesName) +#: | Also a :py:class:`dcmmeta2tsv.TagValues` #: #: Here's an example of :py:class:`CheckResult` datastructure in html/javascript #: on the `static debug-enabled page <../_static/mrqart/index.html>`_