Skip to content

Commit

Permalink
caom2: omit counterpart, update ProductType source terms
Browse files Browse the repository at this point in the history
unable to build the html doc version at this time
  • Loading branch information
pdowler committed May 3, 2024
1 parent cec342e commit f482e19
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 12 deletions.
8 changes: 7 additions & 1 deletion caom2-dm/src/main/ProductType/description.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
<div>
Terms from the vocabulary may be used in CAOM instances as values of the
caom2:Artifact.productType field. Terms in the base vocabulary are to be
used without the URI prefix (e.g. science instead of http://www.opencadc.org/caom2/productType#science).
used without the URI prefix (e.g. science instead of http://www.opencadc.org/caom2/productType#science)
and (unlike DataLink) without the # symbol.
<hr/>
This vocabulary close mirrors the IVOA <a href="https://www.ivoa.net/rdf/datalink/core">DataLink core</a>
vocabulary. It currently includes the subset of terms that are sensibly "logical file types" and omits
those that are not used in CAOM (those that are relations with other observations or usually on-the-fly
process oputputs like cutouts). The plan is to deprecate this vocabulary and use DataLink core directly.
</div>
15 changes: 11 additions & 4 deletions caom2-dm/src/main/ProductType/terms.csv
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
#predicate,parent,label,"Description"

science,1,science data,"primary data file for observations that contains the science data (extraterrestrial photons)"
this,1,primary data,"primary data file for observations"
science,1,science data,"primary data file for observations that contains the science data"

coderived,1,coderived data,"output files produced along with this as additional or alternaticve product"

calibration,1,calibration data,"primary file for observations intended for use in removing instrument signature"
bias,2,bias frame,"calibration file used to correct for CCD bias"
dark,2,dark frame,"calibration file used to correct for no exposure counts in a CCD readout"
flat,2,flat field,"calibration file used to correct for sensitivity variation across a CCD"

auxiliary,1,related file,"file that could be useful in interpreting the primary file(s)"
noise,2,noise map,"auxiliary file that provides noise estimates per pixel in the primary file(s)"
weight,2,weight map,"auxiliary file that provides weights that can be used when analysing the primary file(s)"
error,2,error map,"resource with array(s) containing error values"
noise,2,noise map,"file that provides noise estimates per pixel in the primary file(s)"
weight,2,weight map,"file that provides weights that can be used when analysing the primary file(s)"

documentation,1,human-readable information,"extra information about the primary files (e.g. processing logs)"
info,1,human-readable information,"extra information about the primary files (e.g. processing logs)"

preview,1,preview image,"a degraded representation of the data useful for display and assessing content"
preview,1,preview,"a degraded representation of the data useful for display and assessing content"
preview-image,2,preview image,"a two-dimension image preview"
preview-plot,2,preview plot,"a preview presented as a plot/graph"
thumbnail,2,small preview image,"a highly degraded representation of the data suitable for displaying in a list"
16 changes: 9 additions & 7 deletions caom2/src/main/java/ca/nrc/cadc/caom2/ProductType.java
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
******************* CANADIAN ASTRONOMY DATA CENTRE *******************
************** CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES **************
*
* (c) 2011. (c) 2011.
* (c) 2024. (c) 2024.
* Government of Canada Gouvernement du Canada
* National Research Council Conseil national de recherches
* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
Expand Down Expand Up @@ -90,8 +90,8 @@ public class ProductType extends VocabularyTerm
public static ProductType BIAS = new ProductType("bias");
public static ProductType CALIBRATION = new ProductType("calibration");
public static ProductType CODERIVED = new ProductType("coderived");
public static ProductType COUNTERPART = new ProductType("counterpart");
public static ProductType DARK = new ProductType("dark");
public static ProductType DOCUMENTATION = new ProductType("documentation");
public static ProductType ERROR = new ProductType("error");
public static ProductType FLAT = new ProductType("flat");
public static ProductType NOISE = new ProductType("noise");
Expand All @@ -102,17 +102,19 @@ public class ProductType extends VocabularyTerm
public static ProductType WEIGHT = new ProductType("weight");

// DataLink terms explicitly not included
// counterpart
// cutout
// derivation
// documentation
// proc
// progenitor
// detached-header
// package
// proc
// progenitor

// CAOM specific terms
public static ProductType SCIENCE = new ProductType("science");
public static ProductType INFO = new ProductType("info");
public static ProductType SCIENCE = new ProductType("science"); // this

@Deprecated
public static ProductType INFO = new ProductType("info"); // documentation


/**
Expand Down

0 comments on commit f482e19

Please sign in to comment.