You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/faq.md
+17-15Lines changed: 17 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@ toc: true
6
6
---
7
7
8
8
{:id="bboxes"}
9
-
## How to describe bounding boxes?
9
+
## How to describe bounding boxes of detected objects?
10
10
11
-
In camtrap-dp there are 4 terms used to describe bounding boxes: `bboxX`, `bboxY`, `bboxWidth` and `bboxHeight`. The values for all those fields are numbers between 0 and 1, relative to the image size.
11
+
In Camtrap DP, in the [observations](/data/#observations) table there are four terms used to describe bounding boxes: [`bboxX`](/data/#observations.bboxX), [`bboxY`](/data/#observations.bboxY), [`bboxWidth`](/data/#observations.bboxWidth), and [`bboxHeight`](/data/#observations.bboxHeight). The values for all these fields are numbers between 0 and 1, relative to the image size.
12
12
13
-
The `bboxX` and `bboxY` fields are the coordinates of the top-left corner of the bounding box. `bboxX` is measured from the left side of the image and`bboxY` is measured from the top of the image. `bboxWidth`is measured from the left side of the bounding box to the right side of the bounding box. `bboxHeight`is measured from the top of the bounding box to the bottom of the bounding box.
13
+
The `bboxX` and `bboxY` fields represent the coordinates of the top-left corner of the bounding box. `bboxX` is measured from the left edge of the image, while`bboxY` is measured from the top edge. `bboxWidth`represents the width of the bounding box, measured from its left edge to its right edge. Similarly, `bboxHeight`represents the height of the bounding box, measured from its top edge to its bottom edge.
14
14
15
15
{:id="multiple-events"}
16
16
## How to describe multiple events related to a single resource?
@@ -25,17 +25,18 @@ See the [github issue](https://github.com/tdwg/camtrap-dp/issues/328).
25
25
{:id="non-animal"}
26
26
## Can I describe plant or fungus observations using camtrap-dp?
27
27
28
-
Currently, possible values for the `observationType` field in the observations table are: `animal`, `human`, `vehicle`, `blank`, `unknown` and `unclassified`. This definition does not allow for observations of plants or fungi.
28
+
Currently, possible values for the [`observationType`](/data/#observations.observationType) field in the observations table are: `animal`, `human`, `vehicle`, `blank`, `unknown` and `unclassified`. This definition does not allow for observations of plants or fungi.
29
29
30
30
If you have a use case for describing non-animal observations using camtrap-dp, please let us know in [this github issue](https://github.com/tdwg/camtrap-dp/issues/346).
31
31
32
32
{:id="measurements"}
33
33
## How to include measurements in a data package?
34
34
35
35
There are two ways to include additional information (values not covered by the standard fields) in a camtrap-dp data package:
36
-
- Using tags
37
36
38
-
Deployment and observation tables include `deploymentTags` and `observationTags` fields. These fields can be used to store additional information as pipe-delimited key:value pairs. For example, this is how temperature and snow cover information could be represented in the deployment table:
37
+
### Using tags
38
+
39
+
Deployment and observation tables include [`deploymentTags`](/data/#deployments.deploymentTags) and [`observationTags`](/data/#observations.observationTags) fields. These fields can be used to store additional information as pipe-delimited key:value pairs. For example, this is how temperature and snow cover information could be represented in the deployment table:
There are some drawbacks to using this method. Storing additional information in the media table is not possible, since it does not contain a tags field. Additionally, data represented this way is difficult to parse.
46
47
47
-
- Using a custom table
48
+
### Using a custom table
49
+
50
+
A custom table can be added to the data package to store additional information. This requires providing a schema for the additional table. The schema must include a foreign key to the referenced table ([`deploymentID`](/data/#deployments.deploymentID), [`observationID`](/data/#observations.observationID), or [`mediaID`](/data/#media.mediaID)) and the additional fields. Here is an example schema for the deployment measurement table:
48
51
49
-
A custom table can be added to the data package to store additional information. This requires providing a schema for the additional table. This schema has to contain the foreign key to the referenced table (`deploymentID`, `observationID` or `mediaID`) and the additional fields. This in an example schema for the deployment measurement table:
50
-
```JSON
52
+
```json
51
53
{
52
54
"name": "deployment-measurements",
53
55
"title": "Deployment measurements",
@@ -96,26 +98,26 @@ A custom table can be added to the data package to store additional information.
96
98
}
97
99
```
98
100
99
-
The schema has to be added to the `datapackage.json` file in the `resources` field.
101
+
The schema has to be added to the `datapackage.json` file in the [`resources`](/metadata/#resources) field.
100
102
101
-
This is an example table following the above schema:
103
+
This is an example table following the schema above:
102
104
103
105
deploymentID | temperature | snowCover
104
106
--- | --- | ---
105
107
dep1 | 20 | false
106
108
dep2 | -5 | true
107
109
108
-
We recommend this approach for storing additional information. It allows for easy parsing and merging of tables and is more flexible than using tags.
110
+
We recommend this approach for storing additional information. It allows for easier parsing and merging of tables and is more flexible than using tags.
109
111
110
112
For more details, see [this github issue](https://github.com/tdwg/camtrap-dp/issues/358).
111
113
112
114
113
115
{:id="merge"}
114
116
## How to merge data packages describing different projects?
115
117
116
-
By design, a single camtrap-dp data package describes a single project. However, there are some use cases (for example a metaanalysis), where merging multiple data packages could be helpful.
118
+
By design, a single camtrap-dp data package describes a single project. However, there are some use cases (for example, a meta-analysis) where merging multiple data packages could be beneficial.
117
119
118
-
We provide an [R package](https://inbo.github.io/camtrapdp/) to read and manipulate camtrap-dp data packages. The R package contains the [merge function](https://inbo.github.io/camtrapdp/reference/merge_camtrapdp.html) that can be used to merge two data packages into one. The resulting data package is in valid camtrap-dp format and can be published.
120
+
We provide an [R package](https://inbo.github.io/camtrapdp/) to read and manipulate camtrap-dp data packages. The R package includes the [merge function](https://inbo.github.io/camtrapdp/reference/merge_camtrapdp.html), which can be used to merge two data packages into one. The resulting data package will be in a valid camtrap-dp format and can be published.
119
121
120
-
Read the merge function documentation on how particular fields are merged in order to avoid loss of information. Please note that when merging x and y data packages, the `project$samplingDesign` field in the resulting package will be set to the value of `project$samplingDesign` from data package x. Because of that, we recommend only merging data packages for projects using the same sampling design.
122
+
Refer to the merge function documentation to understand how specific fields are merged to avoid information loss. Please note that when merging data packages x and y, the [`project$samplingDesign`](/metadata/#project.samplingDesign) field in the resulting package will be set to the value of `project$samplingDesign` from data package x. Therefore, we recommend merging data packages only for projects that use the same sampling design.
0 commit comments