Refactor: enhance chunk compression parameter documentation

lib/cmp_chunk.h

@@ -66,44 +66,49 @@
 )
 
 
+/**
+ * @struct cmp_par
+ * @brief structure containing all the compression parameters needed for chunk compression
+ */
+
 struct cmp_par {
 	enum cmp_mode cmp_mode;		/**< compression mode parameter */
 	uint32_t model_value;		/**< model weighting parameter */
 	uint32_t lossy_par;		/**< lossy compression parameter */
 
-	uint32_t nc_imagette;		/**< compression parameter for imagette data compression */
-
-	uint32_t s_exp_flags;		/**< compression parameter for exposure flags compression */
-	uint32_t s_fx;			/**< compression parameter for normal flux compression */
-	uint32_t s_ncob;		/**< compression parameter for normal center of brightness compression */
-	uint32_t s_efx;			/**< compression parameter for extended flux compression */
-	uint32_t s_ecob;		/**< compression parameter for executed center of brightness compression */
-
-	uint32_t l_exp_flags;		/**< compression parameter for exposure flags compression */
-	uint32_t l_fx;			/**< compression parameter for normal flux compression */
-	uint32_t l_ncob;		/**< compression parameter for normal center of brightness compression */
-	uint32_t l_efx;			/**< compression parameter for extended flux compression */
-	uint32_t l_ecob;		/**< compression parameter for executed center of brightness compression */
-	uint32_t l_fx_cob_variance;	/**< compression parameter for flux/COB variance compression */
-
-	uint32_t saturated_imagette;	/**< compression parameter for saturated  imagette data compression */
-
-	uint32_t nc_offset_mean;
-	uint32_t nc_offset_variance;
-	uint32_t nc_background_mean;
-	uint32_t nc_background_variance;
-	uint32_t nc_background_outlier_pixels;
-
-	uint32_t smearing_mean;
-	uint32_t smearing_variance_mean;
-	uint32_t smearing_outlier_pixels;
-
-	uint32_t fc_imagette;
-	uint32_t fc_offset_mean;
-	uint32_t fc_offset_variance;
-	uint32_t fc_background_mean;
-	uint32_t fc_background_variance;
-	uint32_t fc_background_outlier_pixels;
+	uint32_t nc_imagette;		/**< compression parameter for imagette compression */
+
+	uint32_t s_exp_flags;		/**< compression parameter for short cadence exposure flags data */
+	uint32_t s_fx;			/**< compression parameter for short cadence normal flux data */
+	uint32_t s_ncob;		/**< compression parameter for short cadence normal center of brightness data */
+	uint32_t s_efx;			/**< compression parameter for short cadence extended flux data  */
+	uint32_t s_ecob;		/**< compression parameter for short cadence extended center of brightness data */
+
+	uint32_t l_exp_flags;		/**< compression parameter for long cadence exposure flags data */
+	uint32_t l_fx;			/**< compression parameter for long cadence normal flux data */
+	uint32_t l_ncob;		/**< compression parameter for long cadence normal center of brightness data */
+	uint32_t l_efx;			/**< compression parameter for long cadence extended flux data using extended mask */
+	uint32_t l_ecob;		/**< compression parameter for long cadence extended center of brightness data */
+	uint32_t l_fx_cob_variance;	/**< compression parameter for long cadence flux/COB variance data */
+
+	uint32_t saturated_imagette;	/**< compression parameter for saturated imagette data */
+
+	uint32_t nc_offset_mean;		/**< compression parameter for normal camera offset mean data */
+	uint32_t nc_offset_variance;		/**< compression parameter for normal camera offset variance data */
+	uint32_t nc_background_mean;		/**< compression parameter for normal camera background mean data */
+	uint32_t nc_background_variance;	/**< compression parameter for normal camera background variance data */
+	uint32_t nc_background_outlier_pixels;	/**< compression parameter for normal camera background outlier pixels data */
+
+	uint32_t smearing_mean;			/**< compression parameter for smearing mean data */
+	uint32_t smearing_variance_mean;	/**< compression parameter for smearing variance mean data */
+	uint32_t smearing_outlier_pixels;	/**< compression parameter for smearing outlier pixels data */
+
+	uint32_t fc_imagette;			/**< compression parameter for fast camera imagette data */
+	uint32_t fc_offset_mean;		/**< compression parameter for fast camera offset mean data */
+	uint32_t fc_offset_variance;		/**< compression parameter for fast camera offset variance data */
+	uint32_t fc_background_mean;		/**< compression parameter for fast camera background mean data */
+	uint32_t fc_background_variance;	/**< compression parameter for fast camera background variance data */
+	uint32_t fc_background_outlier_pixels;	/**< compression parameter for fast camera background outlier pixels data */
 };
 
 

lib/common/cmp_data_types.h

@@ -41,7 +41,7 @@
 
 
 /* subservice types for service 212 */
-#define SST_NCxx_S_SCIENCE_IMAGETTE		3 /* N-Camera image data */
+#define SST_NCxx_S_SCIENCE_IMAGETTE		3 /* N-Camera imagette data */
 #define SST_NCxx_S_SCIENCE_SAT_IMAGETTE		4 /* Extended imagettes for saturated star extra pixels */
 #define SST_NCxx_S_SCIENCE_OFFSET		5 /* Offset values Mean of the pixels of offset windows */
 #define SST_NCxx_S_SCIENCE_BACKGROUND		6 /* Background values Mean of the pixels of background windows */