Difference between revisions of "Processing Information Dictionary"
(Created page with "= Notes = * It is not at all clear to me how the repeated phrase "most directly used as input" is supposed to mean. = <Processing_Information> = Documents sources, software,...") |
|||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
= Notes = | = Notes = | ||
− | * It is not at all clear to me | + | * It is not at all clear to me what the repeated phrase "most directly used as input" is supposed to mean. |
= <Processing_Information> = | = <Processing_Information> = | ||
Line 7: | Line 7: | ||
==<pds:Local_Internal_Reference>== | ==<pds:Local_Internal_Reference>== | ||
''REQUIRED'' | ''REQUIRED'' | ||
+ | |||
Not clear what is being referenced. Wouldn't this be about the entire product? | Not clear what is being referenced. Wouldn't this be about the entire product? | ||
Line 18: | Line 19: | ||
===<pds:Internal_Reference>=== | ===<pds:Internal_Reference>=== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
If present, it points to a PDS4 product that is itself a list of the sources for this product. (Format of that file is not specified.) | If present, it points to a PDS4 product that is itself a list of the sources for this product. (Format of that file is not specified.) | ||
===<pds:Local_Internal_Reference>=== | ===<pds:Local_Internal_Reference>=== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
If present, it points to an object in this product that is a list of sources for this product. (Format of that data object is not specified.) | If present, it points to an object in this product that is a list of sources for this product. (Format of that data object is not specified.) | ||
===<Input_Product>=== | ===<Input_Product>=== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Describes one source, with an optional local identifier for referencing this source. Three options are provided for linking to the source, exactly one must be selected. | Describes one source, with an optional local identifier for referencing this source. Three options are provided for linking to the source, exactly one must be selected. | ||
====<pds:local_indentifier>==== | ====<pds:local_indentifier>==== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Creates a local identifier for this input product description. | Creates a local identifier for this input product description. | ||
====<pds:Local_Internal_Reference>==== | ====<pds:Local_Internal_Reference>==== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
This would indicate that part of the product was input to the product. (''Does that make sense?'') | This would indicate that part of the product was input to the product. (''Does that make sense?'') | ||
====<pds:Internal_Reference>==== | ====<pds:Internal_Reference>==== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Links to a PDS4 product that acted as source. One would think this would require a LIDVID, rather than a LID, but it does not. | Links to a PDS4 product that acted as source. One would think this would require a LIDVID, rather than a LID, but it does not. | ||
====<pds:External_Reference>==== | ====<pds:External_Reference>==== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Provides a reference to an external source. Hard to make sure this would ever be resolvable. | Provides a reference to an external source. Hard to make sure this would ever be resolvable. | ||
Line 51: | Line 59: | ||
===<name>=== | ===<name>=== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Not defined. | Not defined. | ||
===<desciption>=== | ===<desciption>=== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Not defined. | Not defined. | ||
===<process_owner_name>=== | ===<process_owner_name>=== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
"Person or organization that owns the software process." | "Person or organization that owns the software process." | ||
===<process_owner_institution_name>=== | ===<process_owner_institution_name>=== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
"The name of the institution that owns the software process." | "The name of the institution that owns the software process." | ||
===<Software>=== | ===<Software>=== | ||
''OPTIONAL, REPEATABLE'' | ''OPTIONAL, REPEATABLE'' | ||
+ | |||
Describes the software used. | Describes the software used. | ||
====<name>==== | ====<name>==== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Undefined. | Undefined. | ||
====<software_id>==== | ====<software_id>==== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Undefined (typedef from pds:) | Undefined (typedef from pds:) | ||
====<software_version_id>==== | ====<software_version_id>==== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Undefined (typedef from pds:) | Undefined (typedef from pds:) | ||
====<software_type>==== | ====<software_type>==== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Undefined (typedef from pds:) | Undefined (typedef from pds:) | ||
====<description>==== | ====<description>==== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Undefined (typedef from pds:) | Undefined (typedef from pds:) | ||
====<pds:Internal_Reference>==== | ====<pds:Internal_Reference>==== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Presumably this would be used when and if PDS starts archiving software... | Presumably this would be used when and if PDS starts archiving software... | ||
Line 98: | Line 117: | ||
=====<name>===== | =====<name>===== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Undefined. | Undefined. | ||
=====<program_type_name>===== | =====<program_type_name>===== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
"Type of program used for processing", but the examples given (VICAR, ISIS, GDAL) are programs, not types of programs. | "Type of program used for processing", but the examples given (VICAR, ISIS, GDAL) are programs, not types of programs. | ||
=====<program_user>===== | =====<program_user>===== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
− | Username (''not'' | + | |
+ | Username (''not'' personal name?) of the person running the software. (''Isn't this potentially PID?'') | ||
=====<program_hostname>===== | =====<program_hostname>===== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Hostname of the machine running the process. | Hostname of the machine running the process. | ||
=====<program_path>===== | =====<program_path>===== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Path to the executable on the host machine. (''How the heck is this archival information?'') | Path to the executable on the host machine. (''How the heck is this archival information?'') | ||
=====<program_version>===== | =====<program_version>===== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Just what you'd think. (''Why is this optional?'') | Just what you'd think. (''Why is this optional?'') | ||
=====<program_start_date_time>===== | =====<program_start_date_time>===== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Timetag for beginning of run. | Timetag for beginning of run. | ||
=====<program_stop_date_time>===== | =====<program_stop_date_time>===== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Timetag for end of run. | Timetag for end of run. | ||
=====<description>===== | =====<description>===== | ||
''OPTIONAL'' | ''OPTIONAL'' | ||
+ | |||
Undefined. | Undefined. | ||
Line 137: | Line 165: | ||
======<Parameter>====== | ======<Parameter>====== | ||
''REQUIRED, REPEATABLE'' | ''REQUIRED, REPEATABLE'' | ||
+ | |||
A single parameter (think "argument). Various forms are allowed, including reference to other products. A name is required. | A single parameter (think "argument). Various forms are allowed, including reference to other products. A name is required. | ||
Latest revision as of 22:09, 24 December 2022
Contents
- 1 Notes
- 2 <Processing_Information>
- 2.1 <pds:Local_Internal_Reference>
- 2.2 <Input_Product_List>
- 2.3 <Process>
- 2.3.1 <name>
- 2.3.2 <desciption>
- 2.3.3 <process_owner_name>
- 2.3.4 <process_owner_institution_name>
- 2.3.5 <Software>
- 2.3.5.1 <name>
- 2.3.5.2 <software_id>
- 2.3.5.3 <software_version_id>
- 2.3.5.4 <software_type>
- 2.3.5.5 <description>
- 2.3.5.6 <pds:Internal_Reference>
- 2.3.5.7 <Software_Program>
Notes
- It is not at all clear to me what the repeated phrase "most directly used as input" is supposed to mean.
<Processing_Information>
Documents sources, software, and processes used to produce the product. (How is "software" different from "processes"?)
<pds:Local_Internal_Reference>
REQUIRED
Not clear what is being referenced. Wouldn't this be about the entire product?
<Input_Product_List>
OPTIONAL
List of source products, apparently intended to be the direct sources. Multiple options for listing them are provided by the subclasses. One or more may be used, each may be repeated as needed.
At least one of this or <Process> is required; both may be included.
<pds:Internal_Reference>
OPTIONAL
If present, it points to a PDS4 product that is itself a list of the sources for this product. (Format of that file is not specified.)
<pds:Local_Internal_Reference>
OPTIONAL
If present, it points to an object in this product that is a list of sources for this product. (Format of that data object is not specified.)
<Input_Product>
OPTIONAL
Describes one source, with an optional local identifier for referencing this source. Three options are provided for linking to the source, exactly one must be selected.
<pds:local_indentifier>
OPTIONAL
Creates a local identifier for this input product description.
<pds:Local_Internal_Reference>
OPTIONAL
This would indicate that part of the product was input to the product. (Does that make sense?)
<pds:Internal_Reference>
OPTIONAL
Links to a PDS4 product that acted as source. One would think this would require a LIDVID, rather than a LID, but it does not.
<pds:External_Reference>
OPTIONAL
Provides a reference to an external source. Hard to make sure this would ever be resolvable.
<Process>
OPTIONAL
"One of the software processes".
<name>
OPTIONAL
Not defined.
<desciption>
OPTIONAL
Not defined.
<process_owner_name>
OPTIONAL
"Person or organization that owns the software process."
<process_owner_institution_name>
OPTIONAL
"The name of the institution that owns the software process."
<Software>
OPTIONAL, REPEATABLE
Describes the software used.
<name>
OPTIONAL
Undefined.
<software_id>
OPTIONAL
Undefined (typedef from pds:)
<software_version_id>
OPTIONAL
Undefined (typedef from pds:)
<software_type>
OPTIONAL
Undefined (typedef from pds:)
<description>
OPTIONAL
Undefined (typedef from pds:)
<pds:Internal_Reference>
OPTIONAL
Presumably this would be used when and if PDS starts archiving software...
<Software_Program>
OPTIONAL, REPEATABLE
<name>
OPTIONAL
Undefined.
<program_type_name>
OPTIONAL
"Type of program used for processing", but the examples given (VICAR, ISIS, GDAL) are programs, not types of programs.
<program_user>
OPTIONAL
Username (not personal name?) of the person running the software. (Isn't this potentially PID?)
<program_hostname>
OPTIONAL
Hostname of the machine running the process.
<program_path>
OPTIONAL
Path to the executable on the host machine. (How the heck is this archival information?)
<program_version>
OPTIONAL
Just what you'd think. (Why is this optional?)
<program_start_date_time>
OPTIONAL
Timetag for beginning of run.
<program_stop_date_time>
OPTIONAL
Timetag for end of run.
<description>
OPTIONAL
Undefined.
<Software_Program_Parameters>
OPTIONAL
<Parameter>
REQUIRED, REPEATABLE
A single parameter (think "argument). Various forms are allowed, including reference to other products. A name is required.
- <name> REQUIRED Undefined.
- <parameter_type> OPTIONAL Definition says it's a PVL with values ("Input", "Output", and "Log"), but no PVL is defined.
- <value> OPTIONAL Undefined.
- <pds:Internal_Reference>
- <pds:Local_Internal_Reference>
- <pds:External_Reference>