Skip to content

Commit

Permalink
Updated ingest file with Alice and LORRI calibration processes
Browse files Browse the repository at this point in the history 
Added classes and attributes describing calibration files and processes used with the NH Alice and LORRI instruments.
  • Loading branch information
@benjhirsch
benjhirsch committed Jun 6, 2024
1 parent 8cdad1f commit bbe2f5a
Showing 1 changed file with 243 additions and 11 deletions.
254 changes: 243 additions & 11 deletions src/PDS4_SB_IngestLDD.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@

The initials "ACR" in the "submitter" field indicate Anne Raugh.
</comment>
<last_modification_date_time>2024-03-07</last_modification_date_time>
<!-- added x_axis_position_angle attribute and exactly_2_position_angle_axes rule -->
<last_modification_date_time>2024-04-03</last_modification_date_time>
<!-- added calibration file classes and attributes from the NH LORRI and Alice instruments -->

<!-- Attribute Definitions (alphabetical) -->

Expand Down Expand Up @@ -172,6 +172,23 @@
<value_data_type>ASCII_Boolean</value_data_type>
</DD_Value_Domain>
</DD_Attribute>

<DD_Attribute>
<name>dead_time_correction</name>
<version_id>1.0</version_id>
<local_identifier>dead_time_correction</local_identifier>
<nillable_flag>false</nillable_flag>
<submitter_name>AG</submitter_name>
<definition>
The sb:dead_time_correction attribute should be present and contain the value
"true" if deadtime correction has been performed as part of the processing
applied to the data comprising the product.
</definition>
<DD_Value_Domain>
<enumeration_flag>false</enumeration_flag>
<value_data_type>ASCII_Boolean</value_data_type>
</DD_Value_Domain>
</DD_Attribute>

<DD_Attribute>
<name>delta_time_from_sequence_start</name>
Expand All @@ -193,6 +210,24 @@
<specified_unit_id>s</specified_unit_id>
</DD_Value_Domain>
</DD_Attribute>

<DD_Attribute>
<name>effective_area_correction</name>
<version_id>1.0</version_id>
<local_identifier>effective_area_correction</local_identifier>
<nillable_flag>false</nillable_flag>
<submitter_name>AG</submitter_name>
<definition>
The sb:effective_area_correction attribute should be present and contain the value
"true" if effective area correction based on the calculated effective area of the
instrument due to varying sensitivity has been performed as part of the processing
applied to the data comprising the product.
</definition>
<DD_Value_Domain>
<enumeration_flag>false</enumeration_flag>
<value_data_type>ASCII_Boolean</value_data_type>
</DD_Value_Domain>
</DD_Attribute>

<DD_Attribute>
<name>exposure_description</name>
Expand Down Expand Up @@ -496,6 +531,12 @@
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 Expand Up @@ -777,6 +818,24 @@
<specified_unit_id>nm</specified_unit_id>
</DD_Value_Domain>
</DD_Attribute>

<DD_Attribute>
<name>smear_removal_applied</name>
<version_id>1.0</version_id>
<local_identifier>smear_removal_applied</local_identifier>
<nillable_flag>false</nillable_flag>
<submitter_name>BJH</submitter_name>
<definition>
The sb:smear_removal_applied attribute should be present and contain the value
"true" if a smear removal correction algorithm to remove readout smear generated
as charge is transferred across the CCD has been applied as part of the processing
of the data comprising the product.
</definition>
<DD_Value_Domain>
<enumeration_flag>false</enumeration_flag>
<value_data_type>ASCII_Boolean</value_data_type>
</DD_Value_Domain>
</DD_Attribute>

<DD_Attribute>
<name>standard_filter_identification</name>
Expand Down Expand Up @@ -949,7 +1008,25 @@
<value_data_type>ASCII_Date_Time_YMD_UTC</value_data_type>
</DD_Value_Domain>
</DD_Attribute>


<DD_Attribute>
<name>wavelength_solution_applied</name>
<version_id>1.0</version_id>
<local_identifier>wavelength_solution_applied</local_identifier>
<nillable_flag>false</nillable_flag>
<submitter_name>AG</submitter_name>
<definition>
The sb:wavelength_solution_applied attribute should be present and contain the value "true"
if a wavelength solution corresponding to the spectral dimension of the detector
has been determined as part of the processing applied to the data comprising the
product.
</definition>
<DD_Value_Domain>
<enumeration_flag>false</enumeration_flag>
<value_data_type>ASCII_Boolean</value_data_type>
</DD_Value_Domain>
</DD_Attribute>

<DD_Attribute>
<name>x_axis_position_angle</name>
<version_id>1.0</version_id>
Expand All @@ -970,7 +1047,7 @@
<specified_unit_id>deg</specified_unit_id>
</DD_Value_Domain>
</DD_Attribute>

<DD_Attribute>
<name>y_axis_position_angle</name>
<version_id>1.0</version_id>
Expand Down Expand Up @@ -1192,7 +1269,7 @@

<DD_Class>
<name>Calibration_Applied</name>
<version_id>1.0</version_id>
<version_id>1.1</version_id>
<local_identifier>Calibration_Applied</local_identifier>
<submitter_name>ACR</submitter_name>
<definition>
Expand Down Expand Up @@ -1220,6 +1297,18 @@
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<identifier_reference>dead_time_correction</identifier_reference>
<reference_type>attribute_of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<identifier_reference>effective_area_correction</identifier_reference>
<reference_type>attribute_of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<identifier_reference>flat_field_applied</identifier_reference>
<reference_type>attribute_of</reference_type>
Expand All @@ -1232,6 +1321,18 @@
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<identifier_reference>smear_removal_applied</identifier_reference>
<reference_type>attribute_of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<identifier_reference>wavelength_solution_applied</identifier_reference>
<reference_type>attribute_of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<identifier_reference>conversion_to_physical_units</identifier_reference>
<reference_type>attribute_of</reference_type>
Expand Down Expand Up @@ -1279,7 +1380,7 @@

<DD_Class>
<name>Calibration_Reference_Files</name>
<version_id>1.0</version_id>
<version_id>1.1</version_id>
<local_identifier>Calibration_Reference_Files</local_identifier>
<submitter_name>ACR</submitter_name>
<definition>
Expand All @@ -1305,7 +1406,10 @@
<identifier_reference>Bias_Map</identifier_reference>
<identifier_reference>Bad_Pixel_Map</identifier_reference>
<identifier_reference>Dark_Field</identifier_reference>
<identifier_reference>Desmear_Matrix</identifier_reference>
<identifier_reference>Effective_Area_Table</identifier_reference>
<identifier_reference>Flat_Field</identifier_reference>
<identifier_reference>Wavelength_Solution</identifier_reference>
<reference_type>component_of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>*</maximum_occurrences>
Expand Down Expand Up @@ -1341,8 +1445,69 @@
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
</DD_Class>



<DD_Class>
<name>Desmear_Matrix</name>
<version_id>1.0</version_id>
<local_identifier>Desmear_Matrix</local_identifier>
<submitter_name>BJH</submitter_name>
<definition>
The sb:Desmear_Matrix class identifies the PDS archive product containing the
desmear matrix used to calibrate the data in the product. A desmear matrix is used
to remove readout smear generated as charge is transferred across the CCD.
</definition>

<DD_Association>
<identifier_reference>file_name</identifier_reference>
<reference_type>attribute_of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<identifier_reference>pds.Internal_Reference</identifier_reference>
<reference_type>component_of</reference_type>
<minimum_occurrences>1</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<identifier_reference>comment</identifier_reference>
<reference_type>attribute_Of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
</DD_Class>

<DD_Class>
<name>Effective_Area_Table</name>
<version_id>1.0</version_id>
<local_identifier>Effective_Area_Table</local_identifier>
<submitter_name>AG</submitter_name>
<definition>
The sb:Effective_Area_Table class identifies the PDS archive product containing the
effective area table used to calibrate the data in the product. An effective area
table lists the calculated effected area of the detector at particular wavelengths.
</definition>

<DD_Association>
<identifier_reference>file_name</identifier_reference>
<reference_type>attribute_of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<identifier_reference>pds.Internal_Reference</identifier_reference>
<reference_type>component_of</reference_type>
<minimum_occurrences>1</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<identifier_reference>comment</identifier_reference>
<reference_type>attribute_of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
</DD_Class>

<DD_Class>
<name>Error_Estimates_Map</name>
<version_id>1.0</version_id>
Expand Down Expand Up @@ -1621,14 +1786,14 @@
be right-handed, so the direction of the boresight axis (into or out of the
image plane) can be inferred from the relative positions of the other two.
</definition>

<DD_Association>
<identifier_reference>x_axis_position_angle</identifier_reference>
<reference_type>attribute_of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<DD_Association>
<identifier_reference>y_axis_position_angle</identifier_reference>
<reference_type>attribute_of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
Expand Down Expand Up @@ -1988,6 +2153,38 @@
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
</DD_Class>

<DD_Class>
<name>Wavelength_Solution</name>
<version_id>1.0</version_id>
<local_identifier>Wavelength_Solution</local_identifier>
<submitter_name>AG</submitter_name>
<definition>
The sb:Wavelength_Solution class identifies the PDS archive product containing the
wavelength solution used to calibrate the data in the product. A wavelength solution
is a row of data representing the wavelengths corresponding to the spectral
dimension of the detector.
</definition>

<DD_Association>
<identifier_reference>file_name</identifier_reference>
<reference_type>attribute_of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<identifier_reference>pds.Internal_Reference</identifier_reference>
<reference_type>component_of</reference_type>
<minimum_occurrences>1</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
<DD_Association>
<identifier_reference>comment</identifier_reference>
<reference_type>attribute_of</reference_type>
<minimum_occurrences>0</minimum_occurrences>
<maximum_occurrences>1</maximum_occurrences>
</DD_Association>
</DD_Class>


<!-- Primary Public Class: SBS_Metadata -->
Expand Down Expand Up @@ -2099,6 +2296,29 @@
<rule_message>In sb:Dark_Field/pds:Internal_Reference, pds:reference_type must be "image_to_dark_field_file".</rule_message>
</DD_Rule_Statement>
</DD_Rule>

<!-- Desmear_Matrix/pds:Internal_Reference -->
<DD_Rule>
<local_identifier>desmear_ir</local_identifier>
<rule_context>sb:Desmear_Matrix/pds:Internal_Reference</rule_context>
<DD_Rule_Statement>
<rule_type>Assert</rule_type>
<rule_test>pds:reference_type eq 'image_to_desmear_matrix'</rule_test>
<rule_message>In sb:Desmear_Matrix/pds:Internal_Reference, pds:reference_type must be "image_to_desmear_matrix"</rule_message>
</DD_Rule_Statement>
</DD_Rule>

<!-- Effective_Area/pds:Internal_Reference -->

<DD_Rule>
<local_identifier>Effective_area_ir</local_identifier>
<rule_context>sb:Effective_Area_Table/pds:Internal_Reference</rule_context>
<DD_Rule_Statement>
<rule_type>Assert</rule_type>
<rule_test>pds:reference_type eq 'image_to_effective_area_file'</rule_test>
<rule_message>In sb:Effective_Area_Table/pds:Internal_Reference, pds:reference_type must be "image_to_effective_area_file".</rule_message>
</DD_Rule_Statement>
</DD_Rule>

<!-- Error_Map/pds:Local_Internal_Reference -->

Expand Down Expand Up @@ -2147,7 +2367,7 @@
<rule_message>In sb:Flat_Field/pds:Internal_Reference, pds:reference_type must be "image_to_flat_field_file".</rule_message>
</DD_Rule_Statement>
</DD_Rule>

<!-- Instrument_Position_Angles -->
<DD_Rule>
<local_identifier>exactly_2_position_angle_axes</local_identifier>
Expand Down Expand Up @@ -2206,5 +2426,17 @@
<rule_message>The attribute "&lt;sch:value-of select="name(.)"/&gt;" must be specified with "unit='julian day'".</rule_message>
</DD_Rule_Statement>
</DD_Rule>

<!-- Wavelength_Solution/pds:Internal_Reference -->

<DD_Rule>
<local_identifier>Wavelength_Solution_ir</local_identifier>
<rule_context>sb:Wavelength_Solution/pds:Internal_Reference</rule_context>
<DD_Rule_Statement>
<rule_type>Assert</rule_type>
<rule_test>pds:reference_type eq 'image_to_wavelength_solution_file'</rule_test>
<rule_message>In sb:Wavelength_Solution/pds:Internal_Reference, pds:reference_type must be "image_to_wavelength_solution_file".</rule_message>
</DD_Rule_Statement>
</DD_Rule>

</Ingest_LDD>

0 comments on commit bbe2f5a

Please sign in to comment.