migrate geojson and physdim services from annex to registry

IIIF · Jan 28, 2022 · 6cdc1cc · 6cdc1cc
1 parent 7cfb5b4
commit 6cdc1cc
Show file tree

Hide file tree

Showing 2 changed files with 117 additions and 3 deletions.
diff --git a/source/registry/services/index.md b/source/registry/services/index.md
@@ -19,6 +19,12 @@ editors:
   - name: Simeon Warner
     ORCID: https://orcid.org/0000-0002-7970-7855
     institution: Cornell University
+  - name: Dawn Childress
+    ORCID: https://orcid.org/0000-0003-2602-2788
+    institution: UCLA
+  - name: Jeff Mixter
+    ORCID: https://orcid.org/0000-0002-8411-2952
+    institution: OCLC Research
 ---
 
 ## Status of this Document
@@ -58,9 +64,11 @@ The process for having a new entry added to this registry is [described here][re
 
 This table summarizes the services available and which APIs they may be used in.  The '![not allowed][icon-na]' icon means that the service is not to be used in the API. The '![recommended][icon-rec]' icon means that the service can be used in the API.
 
-| Service                        | Image API                 | Presentation API          |
-| ------------------------------ |:-------------------------:|:-------------------------:|
-| [Image Information][image-api] | ![optional][icon-opt]     | ![recommended][icon-rec] |  
+| Service                        | Image API                 | Presentation 2 API        | Presentation 3 API   |
+| ------------------------------ |:-------------------------:|:-------------------------:|:-------------------------:|
+| [Image Information][image-api] | ![optional][icon-opt]     | ![recommended][icon-rec]  | ![recommended][icon-rec] |
+| [GeoJSON][lgeojson]            | ![not allowed][icon3-na]  | ![recommended][icon3-rec] | ![not allowed][icon3-na] |
+| [Physical Dimensions][physdim] | ![recommended][icon3-rec] | ![recommended][icon3-rec] | ![recommended][icon3-rec] |
 {: .api-table}
 
 
@@ -134,6 +142,93 @@ With the `logo` property added to the Image Information description in version 2
 }
 ```
 
+### 3.2 GeoJSON
+
+### 3.2 GeoJSON
+{: #geojson}
+_Added: 2014-05-20_, _Latest Revision: 2022-02-01_
+
+*Note: GeoJSON as a service is supported in the Presentation 2 API. For the Presentation 3 API, use the [navPlace extension][navPlace].*
+
+[GeoJSON][geojson] provides the ability to associate a geographical place with a resource, in order to drive a map-based user interface or visualization tool.  This might be a location associated with the provenance of the object such as where it was created, or where it is currently held.  The location might also be related to the content of the resource, such as a city mentioned in the text or the landmark depicted in a photograph.  It is not appropriate to use this feature for tagging of time, people, events, and other semantic metadata outside of the scope of the Presentation API.
+
+The [JSON-LD representation][geojson-ld] of GeoJSON, with `@context` `http://geojson.org/geojson-ld/geojson-context.jsonld` _SHOULD_ be used. See the GeoJSON documentation for a full description of the functionality available.
+
+An external reference example for tagging a place, where the URI would return a GeoJSON description of the city of Paris, France:
+
+{% include api/code_header.html %}
+``` json-doc
+{
+  "service": {
+    "@context" : "http://geojson.org/geojson-ld/geojson-context.jsonld",
+    "@id" : "http://www.example.org/geojson/paris.json"
+  }
+}
+```
+
+Or embedding the content:
+
+{% include api/code_header.html %}
+``` json-doc
+{
+  "service": {
+    "@context" : "http://geojson.org/geojson-ld/geojson-context.jsonld",
+    "@id" : "http://www.example.org/geojson/paris.json",
+    "type": "Feature",
+    "properties": {"name": "Paris"},
+    "geometry": {
+      "type": "Point",
+      "coordinates" : [48.8567,2.3508]
+    }
+  }
+}
+```
+### 3.3 Physical Dimensions
+{: #physical-dimensions}
+_Added: 2014-05-20_, _Latest Revision: 2015-12-04_
+
+For digitized objects, it is often useful to know the physical dimensions of the object.  When available, they allow a client to present a ruler, or other rendition of physical scale, to the user.  However, implementers are warned that while this information may be available, frequently:
+
+  * It is not available at all.
+  * It is unreliable when it is recorded.
+  * It is different for every view of an object.
+  * When used with the Presentation API, the Canvas might not be sized to depict only the physical object, but might also include a ruler, color bar, the scanning bed or other background objects.  In these cases, the Canvas height and width will not be representative of the main object.
+
+As the Presentation API already includes an aspect ratio for the Canvas, and the Image API includes the height and width of the Image, the physical dimensions service need only report two additional pieces of information: the scale factor to multiply the dimensions by to calculate the physical dimensions, and the units for those generated physical dimensions.  It is _RECOMMENDED_ that the information always be embedded rather than requiring the client to retrieve it with an additional HTTP request, however some implementers _MAY WISH TO_ keep the information separate.
+
+When used with the Image API, it allows a client to calculate the pixels per inch (often abbreviated as PPI or DPI) of the image it is associated with.  When used with the Presentation API, it gives the size of the object that the Canvas is a surrogate for.
+
+The physical dimensions description includes the following properties:
+
+| Property         | Required? | Description |
+| ---------------- | --------- | ----------- |
+| `@context`       | Required  | The string "http://iiif.io/api/registry/services/physdim/1/context.json". |
+| `@id`            | Optional  | A URI that will return the information, perhaps generated dynamically from the image. |
+| `profile`        | Required  | The string "http://iiif.io/api/registry/services/physdim". |
+| `physicalScale` | Required  | The floating point ratio by which the digital resource's height and width are multiplied in order to determine the depicted scene's height and width.  |
+| `physicalUnits` | Required  | The physical units for the generated height and width.  Possible values are: "mm", "cm", in". |
+{: .api-table}
+
+The following example demonstrates the resulting structure, as embedded within the [Presentation API][prezi-api] response:
+
+{% include api/code_header.html %}
+``` json-doc
+{
+  "service": {
+    "@context": "http://iiif.io/api/registry/services/physdim/1/context.json",
+    "profile": "http://iiif.io/api/registry/services/physdim",
+    "physicalScale": 0.0025,
+    "physicalUnits": "in"
+  }
+}
+```
+
+If the above example was associated with a Canvas of width 4000 and height 6000, then the physical object would be 4000 * 0.0025 = 10 inches wide, and 15 inches high.  If it was associated with an image with width 4000 and height 6000, then it would mean the image was 4000 pixels for 10 inches, or 400 pixels per inch.
+
+__Note:__
+There is a proposal to add a confidence label or value to this service to allow clients to either determine if they should use the information, or to display an appropriate warning or description when using it.  This proposal is currently deferred until additional experience and use cases have been explored.  Any interest in this feature should be brought up on [iiif-discuss][iiif-discuss].
+{: .note}
+
 ## Appendices
 
 ### A. Acknowledgements
@@ -146,7 +241,10 @@ Thanks to the members of the [IIIF][iiif-community] for their continuous engagem
 
 | Date       | Description                                        |
 | ---------- | -------------------------------------------------- |
+| 2022-02-01 | Migrate Physical Dimensions from Annex             |
+| 2022-02-01 | Migrate GeoJSON from Annex                         |
 | 2018-XX-YY | New Version 3 Registries                           |
 
+
 {% include acronyms.md %}
 {% include links.md %}
diff --git a/source/registry/services/physdim/1/context.json b/source/registry/services/physdim/1/context.json
@@ -0,0 +1,16 @@
+---
+---
+{
+  "@context": {
+    "iiif": "http://iiif.io/api/presentation/2#",
+    "xsd": "http://www.w3.org/2001/XMLSchema#",
+    "physicalScale": {
+      "@id": "iiif:physicalScale",
+      "@type": "xsd:float"
+    },
+    "physicalUnits": {
+      "@id": "iiif:physicalUnits",
+      "@type": "xsd:string"
+    }
+  }
+}