OpenQualia Label Standard
URL Format
4 min
as encoded in the label oq labels must be a valid url following the url standard the url must start with https // rather than http // and must contain the following query parameters targetid – the serial number of the target if the target has an existing physical serial number (e g the dt ngt2 has a serial number written on the front bottom right of the target) then this serial number should be used for the targetid in the case the target does not natively have a serial number the user can make one up, but should use only letters, numbers, and dashes avoiding spaces or special characters manufacturer – the make of the target that is the entity whose brand is marked most prominently on the target for example, for a dt ngt2 the manufacturer is digital transitions or dt as passed to openqualia measurement file hosting the label url is meant to be user friendly in the case that it is scanned by a user using their smartphone for programmatic use within a software workflow the label should be passed by the user with one additional parameter added accessmode – this parameter is not present in the label itself it allows client software (e g image quality analysis software such as imagezebra or dt nexus) to directly receive a cgats file rather than a user friendly web page the following values are possible =interactive (default) – this is the default value, so if accessmode is missing (as it is in the label itself) then the result will be a user friendly website that provides at minimum a brief explanation of oq labels, a link to download the most recent measurement file, and the “measurement freshness” of that measurement (see “measurement freshness” later in this document) this provides a better experience for someone who scans the code with their smartphone than being taken directly to a measurement file in a machine readable format additional features of the interactive view are left to the host, but could include such things as an image of the target with values available via hover, a sample file that includes such a target, an overlay (png) with the measured values to use in software such as capture one for visual qc it is also acceptable for such pages to include commercial links to related software and hardware; for example, a link to purchase the same or similar targets, a link to purchase measurement service for the target, or software to analyze images containing such targets =activemeasurement – this is the value expected to be added by image quality software it should result in a measurement file that comports with the “openqualia compatible measurement file format” requirements (basically cgats with certain typically optional fields required) =allmeasurementszip (optional) – this allows software to automatically retrieve a zip file of all measurements, including older and current measurements it is not required that a openqualia measurement file host implement this parameter value in url encoding the first parameter name is preceded by ?, and additional parameters are separated using & below is an example of those parameters ?manufacturer=dt\&targettype=dtngt2\&targetid=dt ar 2020041 additional parameters may be added (e g a proprietary field to allow a proprietary feature in a particular program, such as user or measurementgeometry) openqualia compatible software should use all provided parameters in the url used to download the measurement file, but is otherwise free to disregard the additional parameters query parameter values for manufacturer and targetname a standardized short form and long form canonical names can be found here https //docs google com/spreadsheets/d/1 xqxr5rhknijvbeh7qfkvvhjc 3tgco4fmb9v7chbp0/edit?gid=0#gid=0 openqualia targets must use these canonical names when encoding oq labels to avoid confusion where the label uses a slightly different name for the target than the software expects; for example colorchecker sg rather than colorchecker digital sg query parameter matching evaluation of the manufacturer and targetname values should be done in a case agnostic and whitespace agnostic manner either short form or long form are equally acceptable for example, colorcheckerclassic , ccc , and ccc are all acceptable, as is colorchecker classic (which would be url encoded as colorchecker%20classic ) openqualia recommends encoding without whitespace and in titlecase to maximize the readability of the resulting url targettype and manufacturer display we recommend presenting the decoded values of these parameters using their long form canonical name that is, openqualia suggests encoding colorcheckerclassic but displaying colorchecker classic