You can create and edit your own settings files for importing into ToolZ. These are either .plist or .json files. You may find it easier to edit the settings first in ToolZ and then export the file first before editing. These files can be shared amongst your team and provide a consistent set of parameters, labels and label groups when classifying images.
All the root keys are optional. If unspecified and importing creates a new configuration, unspecified keys will take a default value. If overwriting an existing configuration unspecified keys will have no affect.
Root Keys #
| Key | Type | Description |
|---|---|---|
| ZOModelType | Number | 0 – Object Detector 1 – Image Classifier |
| ZOLabelGroups | Array | An array of dictionaries. See below for a description of the group dictionary keys. |
| ZOLabels | Array | An array of dictionaries. See below for a description of the label dictionary keys. |
| ZOFilterMinimumRangeWidth | Number | Minimum allowable pixel width for filtering. |
| ZOFilterMaximumRangeWidth | Number | Maximum allowable pixel width for filtering. |
| ZOFilterMinimumRangeHeight | Number | Minimum allowable pixel height for filtering. |
| ZOFilterMaximumRangeHeight | Number | Maximum allowable pixel height for filtering. |
| ZOFilterMinimumWidth | Number | Minimum pixel width for filtering. This value must be between ZOFilterMinimumRangeWidth – ZOFilterMaximumRangeWidth and small than ZOFilterMaximumWidth. |
| ZOFilterMaximumWidth | Number | Maximum pixel width for filtering. This value must be between ZOFilterMinimumRangeWidth – ZOFilterMaximumRangeWidth and greater than ZOFilterMinimumWidth. |
| ZOFilterMinimumHeight | Number | Maximum pixel width for filtering. This value must be between ZOFilterMinimumRangeHeight – ZOFilterMaximumRangeHeight and smaller than ZOFilterMaximumHeight. |
| ZOFilterMaximumHeight | Number | Maximum pixel width for filtering. This value must be between ZOFilterMinimumRangeHeight – ZOFilterMaximumRangeHeight and greater than ZOFilterMinimumHeight. |
| ZOFilterMinimumArea | Number | Minimum pixel area for filtering. This value must be smaller than ZOFilterMaximumArea. |
| ZOFilterMaximumArea | Number | Maximum pixel area for filtering. This value must be greater than ZOFilterMinimumArea. |
| ZOFilterMinimumRed | Number | Minimum value for filtering the red channel when using the RGB colour model. It must be smaller than ZOFilterMaximumRed and in the range 0…1 |
| ZOFilterMaximumRed | Number | Maximum value for filtering the red channel when using the RGB colour model. It must be greater than ZOFilterMinimumRed and in the range 0…1 |
| ZOFilterMinimumGreen | Number | Minimum value for filtering the green channel when using the RGB colour model. It must be smaller than ZOFilterMaximumGreen and in the range 0…1 |
| ZOFilterMaximumGreen | Number | Maximum value for filtering the green channel when using the RGB colour model. It must be greater than ZOFilterMinimumGreen and in the range 0…1 |
| ZOFilterMinimumBlue | Number | Minimum value for filtering the blue channel when using the RGB colour model. It must be smaller than ZOFilterMaximumBlue and in the range 0…1 |
| ZOFilterMaximumBlue | Number | Maximum value for filtering the blue channel when using the RGB colour model. It must be greater than ZOFilterMinimumBlue and in the range 0…1 |
| ZOFilterMinimumY | Number | Minimum value for filtering the luminance channel when using the YCrCb colour model. It must be smaller than ZOFilterMaximumY and in the range 0…1 |
| ZOFilterMaximumY | Number | Maximum value for filtering the luminance channel when using the YCrCb colour model. It must be greater than ZOFilterMinimumY and in the range 0…1 |
| ZOFilterMinimumCr | Number | Minimum value for filtering the Cr channel when using the YCrCb colour model. It must be smaller than ZOFilterMaximumCr and in the range 0…1 |
| ZOFilterMaximumCr | Number | Maximum value for filtering the Cr channel when using the YCrCb colour model. It must be greater than ZOFilterMinimumCr and in the range 0…1 |
| ZOFilterMinimumCb | Number | Minimum value for filtering the Cb channel when using the YCrCb colour model. It must be smaller than ZOFilterMaximumCb and in the range 0…1 |
| ZOFilterMaximumCb | Number | Maximum value for filtering the Cb channel when using the YCrCb colour model. It must be greater than ZOFilterMinimumCb and in the range 0…1 |
| ZOFilterMinimumHue | Number | Minimum value for filtering the hue channel when using the HSV colour model. It must be smaller than ZOFilterMaximumHue and in the range 0…1 |
| ZOFilterMaximumHue | Number | Maximum value for filtering the hue channel when using the HSV colour model. It must be greater than ZOFilterMinimumHue and in the range 0…1 |
| ZOFilterMinimumSaturation | Number | Minimum value for filtering the saturation channel when using the HSV colour model. It must be smaller than ZOFilterMaximumSaturation and in the range 0…1 |
| ZOFilterMaximumSaturation | Number | Maximum value for filtering the saturation channel when using the HSV colour model. It must be greater than ZOFilterMinimumSaturation and in the range 0…1 |
| ZOFilterMinimumValue | Number | Minimum value for filtering the value channel when using the HSV colour model. It must be smaller than ZOFilterMaximumValue and in the range 0…1 |
| ZOFilterMaximumValue | Number | Maximum value for filtering the value channel when using the HSV colour model. It must be greater than ZOFilterMinimumValue and in the range 0…1 |
| ZOFilterMinimumGLV | Number | Minimum value for filtering the grey level variance. It must be smaller than ZOFilterMaximumGLV and in the range 0…0.2 |
| ZOFilterMaximumGLV | Number | Maximum value for filtering the grey level variance. It must be greater than ZOFilterMinimumGLV and in the range 0…0.2 |
| ZOFilterMinimumCoV | Number | Minimum value for filtering the coefficient of variation. It must be smaller than ZOFilterMaximumCoV and in the range 0…0.2 |
| ZOFilterMaximumCoV | Number | Maximum value for filtering the coefficient of variation. It must be greater than ZOFilterMinimumCoV and in the range 0…0.2 |
| ZOFilterColorModel | Number | 0 – RGB 1 – YCrCb 2 – HSV |
| ZOModelComputeUnits | Number | 0 – CPU Only 1 – CPU and GPU 2 – All Compute Units |
Label Keys #
| Key | Type | Description |
|---|---|---|
| ZOLabel | String | A non-optional unique string to identify the label. This must be specified and be unique within ToolZ. It is used when saving metadata in images and exporting data for model training. |
| ZOClassIndex | Number | An optional number used when a label should use a class index rather than a string value. These do not need to be unique within ToolZ but it is likely you will want them to be unique within a settings configuration. |
| ZODisplayName | String | An optional string that is displayed in the ToolZ interface instead of the ZOLabel. You may wish to use short codes for the labels but longer, more meaningful strings for display. |
| ZOColor | String | Either a color name recognised to iOS, such as; ‘black’ or ‘orange’ or a hex string in the format #RRGGBB. |
Label Group Keys #
| Key | Type | Description |
|---|---|---|
| ZODisplayName | String | A non-optional display name for the label group. |
| ZOLabelTypes | Array | An array of strings that refer to each label to include in the group. This references the ZOLabel described above. |
