001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2004-2023 Open Geospatial Consortium, Inc.
004 *    http://www.geoapi.org
005 *
006 *    Licensed under the Apache License, Version 2.0 (the "License");
007 *    you may not use this file except in compliance with the License.
008 *    You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *    Unless required by applicable law or agreed to in writing, software
013 *    distributed under the License is distributed on an "AS IS" BASIS,
014 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 *    See the License for the specific language governing permissions and
016 *    limitations under the License.
017 */
018package org.opengis.metadata.quality;
019
020import org.opengis.annotation.UML;
021import org.opengis.referencing.operation.Matrix;
022
023import static org.opengis.annotation.Specification.*;
024
025
026/**
027 * Comparison of the classes assigned to features or their attributes to a universe of discourse.
028 * The assignment of an item to a certain class can either be correct or incorrect.
029 * Depending on the item that is classified, several data quality measures exist.
030 *
031 * <h2>Standardized values</h2>
032 * In order to achieve well defined and comparable quality information, it is recommended to
033 * report data quality using {@linkplain Measure quality measures} listed in ISO 19157 annex.
034 * The following table provides a summary; see ISO 19157 for more complete descriptions and examples.
035 * All identifiers should be in "ISO 19157" namespace.
036 *
037 * <table class="ogc">
038 *   <caption>Standardized values derived from ISO 19157</caption>
039 *   <tr>
040 *     <th>{@linkplain MeasureReference#getMeasureIdentification() Identifier}</th>
041 *     <th>{@linkplain MeasureReference#getNamesOfMeasure() Name of measure}</th>
042 *     <th>{@linkplain Measure#getBasicMeasure() Basic measure}</th>
043 *     <th>{@linkplain Measure#getParameters() Parameters}</th>
044 *     <th>{@linkplain Measure#getValueType() Value type}</th>
045 *   </tr><tr>
046 *     <td>60</td>
047 *     <td>number of incorrectly classified features</td>
048 *     <td>error count</td>
049 *     <td></td>
050 *     <td>Integer</td>
051 *   </tr><tr>
052 *     <td>61</td>
053 *     <td>misclassification rate</td>
054 *     <td>error rate</td>
055 *     <td></td>
056 *     <td>Real</td>
057 *   </tr><tr>
058 *     <td>62</td>
059 *     <td>misclassification matrix</td>
060 *     <td></td>
061 *     <td></td>
062 *     <td>{@link Matrix}</td>
063 *   </tr><tr>
064 *     <td>63</td>
065 *     <td>relative misclassification matrix</td>
066 *     <td></td>
067 *     <td></td>
068 *     <td>{@link Matrix}</td>
069 *   </tr><tr>
070 *     <td>64</td>
071 *     <td>kappa coefficient</td>
072 *     <td></td>
073 *     <td>n (number of classes)</td>
074 *     <td>{@link Matrix}</td>
075 *   </tr>
076 * </table>
077 *
078 * <p><b>Note:</b>
079 * ISO 19157 declares the <i>misclassification matrix</i> value type as "Integer" or "Real"
080 * associated with {@link ValueStructure#MATRIX}. For an object oriented language like Java,
081 * a more natural approach is to use an object of specific type for the value.</p>
082 *
083 * <p>{@linkplain Measure#getDefinition() Definitions}:</p>
084 * <ol start="60">
085 *   <li>Number of incorrectly classified features</li>
086 *   <li>Number of incorrectly classified features relative to the number of features that should be there.</li>
087 *   <li>Matrix that indicates the number of items of class (i) classified as class (j).</li>
088 *   <li>Matrix that indicates the number of items of class (i) classified as class (j) divided by the number of items of class (i).</li>
089 *   <li>coefficient to quantify the proportion of agreement of assignments to classes by removing misclassifications.</li>
090 * </ol>
091 *
092 * @author  Martin Desruisseaux (IRD)
093 * @author  Alexis Gaillard (Geomatys)
094 * @version 3.1
095 * @since   2.0
096 */
097@UML(identifier="DQ_ThematicClassificationCorrectness", specification=ISO_19157)
098public interface ThematicClassificationCorrectness extends ThematicAccuracy {
099}