From 8ac39b5f0c289e50ed29e1981c2c36a3a707c45d Mon Sep 17 00:00:00 2001 From: lleplat Date: Mon, 22 Jul 2024 16:00:45 +0100 Subject: [PATCH] Typos --- docs/index.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 4cda898..36a28f3 100755 --- a/docs/index.md +++ b/docs/index.md @@ -52,9 +52,9 @@ A feature object represents a spatially bounded entity associated with propertie - `"numeric"`: (Optional) A list with key-value pairs, with string keys and numerical values, e.g. `{"area": 123.45, "volume": 678.90}`. - `"multiNumeric"`: (Optional) A list with key-value pairs, with string keys and list of numerical values, e.g. `{"area": [123.45, 234.56], "volume": [678.90, 789.01]}`. - `"id"`: (Optional) A unique identifier for this feature. -- `"ref"`: (Optional) A reference to an external resource, e.g. URI to a zarr strcture, e.g. "s3://zarr-demo/store/my_array.zarr". +- `"ref"`: (Optional) A reference to an external resource, e.g. URI to a zarr structure, e.g. "s3://zarr-demo/store/my_array.zarr". - `"parentId"`: (Optional) A reference to the parent feature, e.g. the id of the feature that this feature is a part of. -- `"feeatureClass"`: (Optional) A string indicating the class of the feature, e.g. "cell", "nucleus", "mitochondria", etc. +- `"featureClass"`: (Optional) A string indicating the class of the feature, e.g. "cell", "nucleus", "mitochondria", etc. #### Special Feature Objects @@ -66,11 +66,13 @@ A feature object represents a spatially bounded entity associated with propertie - `"URI"`: A string with the image URI, e.g. “./image_1.tif" An Image MUST also have a geometry object (as its “geometry” member) of type "Polygon", subtype “Rectangle”, indicating the shape of the image. An Image may have the following additional key-value pairs in its “properties” object: + - `"correction"`: A list of coordinates indicating the relative correction of the image, e.g. `[1, 2]` indicating a correction of 1 units in the x direction and 2 units in the y direction, with units as defined by the coordinate system. If the coordinate system is not defined, the units are pixels. ### FeatureCollection Object A FeatureCollection object is a JSON object representing a collection of feature objects. A FeatureCollection object has a member with the name `"features"`. The value of `"features"` is a JSON array. Each element of the array is a Feature object as defined above. It is possible for this array to be empty. Additionally, it may have the following members: + - `"stringFields"`: (Optional) A list of strings, indicating the descriptive fields of the features in the collection, e.g. `["color", "size"]`. - `"valueRange"`: (Optional) A list of key-value pairs, with string keys and as keys another object with the fields: * `"min"`: The minimum value of the field in the key (both `"numeric"` and `"multiNumeric"`) of the features in the collection, e.g. `{"area": 123.45, "volume": 678.90}`. @@ -92,6 +94,7 @@ A multiscale object represents the choice of axes (2-5D) and potentially their t - `"axes"`: Representing the choice of axes as an Axis object. It may contain either of, but NOT both of the following properties: + - `"coordinateTransformations"`: Representing the set of coordinate transformations that should be applied to the numerical data in order to arrive to the actual size of the object described. It MUST be an array of objects, each object representing a coordinate transformation. Each object MUST have properties as follows: - `"type"`: Representing the type of the coordinate transformation. Currently supported types are `"identity"`, `"scale"`, and `"translate"`. If the type is `"scale"`, the object MUST have the property `"scale"`, representing the scaling factor. It MUST be an array of numbers, with the number of elements equal to the number of axes in the coordinate system. If the type is `"translate"`, the object MUST have the property `"translate"`, representing the translation vector. It MUST be an array of numbers, with the number of elements equal to the number of axes in the coordinate system. If the type is `"identity"`, the object MUST NOT have any other properties. - `"transformationMatrix"`: Representing the transformation matrix from the coordinate system of the image to the coordinate system of the MicroJSON object. It MUST be an array of arrays of numbers, with the number of rows equal to the number of axes in the coordinate system, and the number of columns equal to the number of axes in the image coordinate system. The transformation matrix MUST be invertible. @@ -100,6 +103,7 @@ It may contain either of, but NOT both of the following properties: ### Axis Object An axis object represents the choice of axes (2D or 3D). It MUST have the following properties: + - `"name"`: Representing the name of the axis. It MUST be a string. It may contain the following properties: - `"unit"`: Representing the units of the corresponding axis in the axes property. It MUST be an array with the elements having any of the following values: `[“angstrom", "attometer", "centimeter", "decimeter", "exameter", "femtometer", "foot", "gigameter", "hectometer", "inch", "kilometer", "megameter", "meter", "micrometer", "mile", "millimeter", "nanometer", "parsec", "petameter", "picometer", "terameter", "yard", "yoctometer", "yottameter", "zeptometer", "zettameter“]`