Skip to content

Commit

Permalink
Updated documentation for alice+lorri branch
Browse files Browse the repository at this point in the history 
Updated outline.rst, metadataTemplate.rst, and user-guide.rst in docs/source with new classes and attributes.

Updated changelog and version number in ingest file.

Updated test/SBmetadataTemplate_VALID.xml to include new classes and attributes.
  • Loading branch information
@benjhirsch
benjhirsch committed Jun 24, 2024
1 parent 2926b63 commit f98c772
Show file tree
Hide file tree
Showing 5 changed files with 145 additions and 49 deletions.
42 changes: 37 additions & 5 deletions docs/source/detailed/outline.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,19 @@ alternatives in this outline.

* <sb:bias_subtraction>
* <sb:dark_current_removal>
* <sb:dead_time_correction>
* <sb:effective_area_correction>
* <sb:flat_field_applied>
* <sb:scattered_light_correction>
* <sb:conversion_to_physical_uni>ts
* <sb:smear_removal_applied>
* <sb:wavelength_solution_applied>
* <sb:conversion_to_physical_units>
* <sb:comment>

* <sb:Calibration_Reference_Files>

* <sb:comment>
* <sb:Flat_Field>
* <sb:Bias_Map>

* <sb:file_name>
* <pds:Internal_Reference>
Expand All @@ -81,7 +85,7 @@ alternatives in this outline.
* <pds:reference_type>
* <pds:comment>

* <sb:Dark_Field >
* <sb:Bad_Pixel_Map>

* <sb:file_name>
* <pds:Internal_Reference>
Expand All @@ -90,7 +94,7 @@ alternatives in this outline.
* <pds:reference_type>
* <pds:comment>

* <sb:Bias_Map>
* <sb:Dark_Field>

* <sb:file_name>
* <pds:Internal_Reference>
Expand All @@ -99,7 +103,25 @@ alternatives in this outline.
* <pds:reference_type>
* <pds:comment>

* <sb:Bad_Pixel_Map>
* <sb:Demsear_Matrix>

* <sb:file_name>
* <pds:Internal_Reference>

* <pds:lidvid_reference>
* <pds:reference_type>
* <pds:comment>

* <sb:Effective_Area_Table>

* <sb:file_name>
* <pds:Internal_Reference>

* <pds:lidvid_reference>
* <pds:reference_type>
* <pds:comment>

* <sb:Flat_Field>

* <sb:file_name>
* <pds:Internal_Reference>
Expand All @@ -108,6 +130,15 @@ alternatives in this outline.
* <pds:reference_type>
* <pds:comment>

* <sb:Wavelength_Solution>

* <sb:file_name>
* <pds:Internal_Reference>

* <pds:lidvid_reference>
* <pds:reference_type>
* <pds:comment>

* <sb:Additional_Image_Metadata>

* <pds:Local_Internal_Reference>
Expand Down Expand Up @@ -161,6 +192,7 @@ alternatives in this outline.
* <sb:comment>
* <sb:Instrument_Position_Angles>

* <sb:x_axis_position_angle>
* <sb:y_axis_position_angle>
* <sb:z_axis_position_angle>

Expand Down
62 changes: 46 additions & 16 deletions docs/source/examples/metadataTemplate.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,29 +117,17 @@ however, is always the schemas - not the examples.
<sb:comment>something</sb:comment>
<sb:bias_subtraction>true</sb:bias_subtraction>
<sb:dark_current_removal>true</sb:dark_current_removal>
<sb:dead_time_correction>true</sb:dead_time_correction>
<sb:effective_area_correction>true</sb:effective_area_correction>
<sb:flat_field_applied>true</sb:flat_field_applied>
<sb:scattered_light_correction>false</sb:scattered_light_correction>
<sb:smear_removal_applied>true</sb:smear_removal_applied>
<sb:wavelength_solution_applied>true</sb:wavelength_solution_applied>
<sb:conversion_to_physical_units>true</sb:conversion_to_physical_units>
</sb:Calibration_Applied>
<sb:Calibration_Reference_Files>
<sb:comment>something</sb:comment>
<sb:Flat_Field>
<sb:file_name>flat.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
<lidvid_reference>urn:nasa:pds:bundle:collection:product::0.0</lidvid_reference> <!-- version ID is definitely required -->
<reference_type>image_to_flat_field_file</reference_type>
<comment>something</comment>
</Internal_Reference>
</sb:Flat_Field>
<sb:Dark_Field>
<sb:file_name>dark.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
<lidvid_reference>urn:nasa:pds:bundle:collection:product::0.0</lidvid_reference> <!-- version ID is definitely required -->
<reference_type>image_to_dark_field_file</reference_type>
<comment>something</comment>
</Internal_Reference>
</sb:Dark_Field>
<sb:Bias_Map>
<sb:file_name>bias_frame.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
Expand All @@ -155,6 +143,46 @@ however, is always the schemas - not the examples.
<comment>something</comment>
</Internal_Reference>
</sb:Bad_Pixel_Map>
<sb:Dark_Field>
<sb:file_name>dark.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
<lidvid_reference>urn:nasa:pds:bundle:collection:product::0.0</lidvid_reference> <!-- version ID is definitely required -->
<reference_type>image_to_dark_field_file</reference_type>
<comment>something</comment>
</Internal_Reference>
</sb:Dark_Field>
<sb:Demsear_Matrix>
<sb:file_name>desmear.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
<lidvid_reference>urn:nasa:pds:bundle:collection:product::0.0</lidvid_reference> <!-- version ID is definitely required -->
<reference_type>image_to_desmear_matrix</reference_type>
<comment>something</comment>
</Internal_Reference>
</sb:Demsear_Matrix>
<sb:Effective_Area_Table>
<sb:file_name>effective_area.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
<lidvid_reference>urn:nasa:pds:bundle:collection:product::0.0</lidvid_reference> <!-- version ID is definitely required -->
<reference_type>image_to_effective_area_file</reference_type>
<comment>something</comment>
</Internal_Reference>
</sb:Effective_Area_Table>
<sb:Flat_Field>
<sb:file_name>flat.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
<lidvid_reference>urn:nasa:pds:bundle:collection:product::0.0</lidvid_reference> <!-- version ID is definitely required -->
<reference_type>image_to_flat_field_file</reference_type>
<comment>something</comment>
</Internal_Reference>
</sb:Flat_Field>
<sb:Wavelength_Solution>
<sb:file_name>wavelength.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
<lidvid_reference>urn:nasa:pds:bundle:collection:product::0.0</lidvid_reference> <!-- version ID is definitely required -->
<reference_type>image_to_wavelength_solution_file</reference_type>
<comment>something</comment>
</Internal_Reference>
</sb:Wavelength_Solution>
</sb:Calibration_Reference_Files>
</sb:Calibration_Information>
Expand Down Expand Up @@ -260,6 +288,8 @@ however, is always the schemas - not the examples.
<sb:frame_center_dec unit="deg">-45.0</sb:frame_center_dec>
<sb:celestial_north_clock_angle unit="deg">75.123</sb:celestial_north_clock_angle>
<sb:Instrument_Position_Angles>
<!-- exactly 2 of these 3 attributes may be used -->
<!-- <sb:x_axis_position_angle unit="deg">90</sb:x_axis_position_angle> -->
<sb:y_axis_position_angle unit="deg">57.123</sb:y_axis_position_angle>
<sb:z_axis_position_angle unit="deg">123.04</sb:z_axis_position_angle>
</sb:Instrument_Position_Angles>
Expand Down
7 changes: 4 additions & 3 deletions docs/source/user/user-guide.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ label order these are:

- <pds:Local_Internal_Reference>
- <sb:comment>
- <sb:image_observation_type
- <sb:image_observation_type>
- <sb:Ancillary_Data_Objects>
- <sb:Additional_Geometry_Metadata>
- <sb:Per_Frame_Metadata>
Expand Down Expand Up @@ -263,9 +263,10 @@ assessments when provided in arrays that map pixel-to-pixel with the image.
- <sb:Geometry_Vector_Times>

The *<sb:Instrument_Position_Angles>* class supplements the *<geom:Image_Display_Geometry>*
class by adding position angles for the *y* and *z* axes of the instrument pointing on the
class by adding position angles for the *x*, *y*, and *z* axes of the instrument pointing on the
plane of the image, when displayed according to the directions in the *<disp:Display_Settings>*
class (which should be present in all image data labels).
class (which should be present in all image data labels). Exactly 2 of the 3 position angles
must appear when using the *<sb:Instrument_Position_Angles>* class.

The *<sb:Geometry_Vector_Times>* class provides a method for specifying UTC at an observer
located at one end point of the geometry vectors included in the *<geom:Geometry_Orbiter>*
Expand Down
24 changes: 16 additions & 8 deletions src/PDS4_SB_IngestLDD.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
xsi:schemaLocation="http://pds.nasa.gov/pds4/pds/v1 https://pds.nasa.gov/pds4/pds/v1/PDS4_PDS_1K00.xsd">

<name>Small Bodies Studies</name>
<ldd_version_id>1.0.0.0</ldd_version_id>
<ldd_version_id>1.1.0.0</ldd_version_id>
<dictionary_type>Discipline</dictionary_type>
<full_name>Anne Raugh</full_name>
<steward_id>sbn</steward_id>
Expand All @@ -19,8 +19,22 @@
provided in other discipline namespaces, which is expected to be present.

The initials "ACR" in the "submitter" field indicate Anne Raugh.

version 1.1.0 2024-06-23
- Added dead_time_correction, effective_area_correction, smear_removal_applied, and
wavelength_solution_applied attributes, which are boolean checks that should be
present if their respective calibration steps have been applied to the data product.
- Updated Calibration_Applied class to allow for the above attributes.
- Added Desmear_Matrix, Effective_Area_Table, and Wavelength_Solution classes, which
are containers providing a file_name and Internal_Reference to the calibration
product associated with a particular calibration process.
- Updated Calibration_Reference_File class to allow for the above classes.
- Added schematron rules specifying the reference_type used in pds:Internal_Reference
for the above classes.
- Added x_axis_position_angle attribute to Instrument_Position_Angles class along
with schematron rules requiring exactly 2 of the 3 attributes in that class.
</comment>
<last_modification_date_time>2024-04-03</last_modification_date_time>
<last_modification_date_time>2024-06-23</last_modification_date_time>
<!-- added calibration file classes and attributes from the NH LORRI and Alice instruments -->

<!-- Attribute Definitions (alphabetical) -->
Expand Down Expand Up @@ -531,12 +545,6 @@
The data array contains a single image.
</value_meaning>
</DD_Permissible_Value>
<DD_Permissible_Value>
<value>Spectral Image</value>
<value_meaning>
The data array contains a spectral image.
</value_meaning>
</DD_Permissible_Value>
</DD_Value_Domain>
</DD_Attribute>

Expand Down
59 changes: 42 additions & 17 deletions test/SBmetadataTemplate_VALID.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,21 +92,32 @@
<sb:comment>something</sb:comment>
<sb:bias_subtraction>true</sb:bias_subtraction>
<sb:dark_current_removal>true</sb:dark_current_removal>
<sb:dead_time_correction>true</sb:dead_time_correction>
<sb:effective_area_correction>true</sb:effective_area_correction>
<sb:flat_field_applied>true</sb:flat_field_applied>
<sb:scattered_light_correction>false</sb:scattered_light_correction>
<sb:scattered_light_correction>true</sb:scattered_light_correction>
<sb:smear_removal_applied>true</sb:smear_removal_applied>
<sb:wavelength_solution_applied>true</sb:wavelength_solution_applied>
<sb:conversion_to_physical_units>true</sb:conversion_to_physical_units>
</sb:Calibration_Applied>

<sb:Calibration_Reference_Files>
<sb:comment>something</sb:comment>
<sb:Flat_Field>
<sb:file_name>flat.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
<sb:Bad_Pixel_Map>
<sb:file_name>badpixel.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
<lidvid_reference>urn:nasa:pds:bundle:collection:product::0.0</lidvid_reference> <!-- version ID is definitely required -->
<reference_type>image_to_flat_field_file</reference_type>
<reference_type>image_to_bad_pixel_map</reference_type>
<comment>something</comment>
</Internal_Reference>
</sb:Flat_Field>
</sb:Bad_Pixel_Map>
<sb:Bias_Map>
<sb:file_name>bias_frame.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
<lidvid_reference>urn:nasa:pds:bundle:collection:product::2.0</lidvid_reference> <!-- version ID is definitely required -->
<reference_type>image_to_bias_levels</reference_type>
</Internal_Reference>
</sb:Bias_Map>
<sb:Dark_Field>
<sb:file_name>dark.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
Expand All @@ -115,21 +126,35 @@
<comment>something</comment>
</Internal_Reference>
</sb:Dark_Field>
<sb:Bias_Map>
<sb:file_name>bias_frame.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
<lidvid_reference>urn:nasa:pds:bundle:collection:product::2.0</lidvid_reference> <!-- version ID is definitely required -->
<reference_type>image_to_bias_levels</reference_type>
<sb:Desmear_Matrix>
<sb:file_name>desmear_matrix.fits</sb:file_name>
<Internal_Reference>
<lidvid_reference>urn:nasa:pds:nh_lorri:calibration_files:desmear_matrix::1.0</lidvid_reference>
<reference_type>image_to_desmear_matrix</reference_type>
</Internal_Reference>
</sb:Bias_Map>
<sb:Bad_Pixel_Map>
<sb:file_name>badpixel.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
</sb:Desmear_Matrix>
<sb:Effective_Area_Table>
<sb:file_name>effective_area.fits</sb:file_name>
<Internal_Reference>
<lidvid_reference>urn:nasa:pds:nh_lorri:calibration_files:effective_area::1.0</lidvid_reference>
<reference_type>image_to_effective_area_file</reference_type>
</Internal_Reference>
</sb:Effective_Area_Table>
<sb:Flat_Field>
<sb:file_name>flat.dat</sb:file_name> <!-- optional but recommended -->
<Internal_Reference> <!-- required -->
<lidvid_reference>urn:nasa:pds:bundle:collection:product::0.0</lidvid_reference> <!-- version ID is definitely required -->
<reference_type>image_to_bad_pixel_map</reference_type>
<reference_type>image_to_flat_field_file</reference_type>
<comment>something</comment>
</Internal_Reference>
</sb:Bad_Pixel_Map>
</sb:Flat_Field>
<sb:Wavelength_Solution>
<sb:file_name>wavelength_solution.fits</sb:file_name>
<Internal_Reference>
<lidvid_reference>urn:nasa:pds:nh_lorri:calibration_files:wavelength_solution::1.0</lidvid_reference>
<reference_type>image_to_wavelength_solution_file</reference_type>
</Internal_Reference>
</sb:Wavelength_Solution>
</sb:Calibration_Reference_Files>
</sb:Calibration_Information>

Expand Down

0 comments on commit f98c772

Please sign in to comment.