Changeset 833 for branches/ms-style

Timestamp:

Jun 9, 2017, 12:46:19 PM (8 years ago)

Author:

cresson

Message:

DOC: Add some comments

File:

• branches/ms-style/zoo-project/zoo-kernel/service_internal_ms.c (modified) (5 diffs)

branches/ms-style/zoo-project/zoo-kernel/service_internal_ms.c

@@ -136 +136 @@
     return (val-x0)*(y1-y0)/(x1-x0) + y0;
 }
-
 double base( double val ) {
     if ( val <= 0.25 ) return 0;
@@ -843 +842 @@
    */
 
-  /* msRasterResample (NEAREST/AVERAGE/BILINEAR) */
-  const char * msRasterResamplingPropertyName       = "msRasterResample";
-  /* msRasterStyle (linearStretching/classify) */
-  const char * msRasterStylePropertyName            = "msRasterStyle";
-  const char * msRasterStyleLinearStretchingPropertyValue       = "linearStretching";
+  // Properties names
+  const char * msRasterResamplingPropertyName       = "msRasterResample";       /* can be NEAREST/AVERAGE/BILINEAR */
+  const char * msRasterStylePropertyName            = "msRasterStyle";          /* can be linearStretching/classify */
+  const char * msRasterStyleOptionsPropertyName     = "msRasterStyleOptions";   /* can be the path to a mapfile */
+
+  // Allowed properties values
+  const char * msRasterStyleLinearStretchingPropertyValue       = "linearStretching";   /* RasterStyle */
   const char * msRasterStyleColorPalettePropertyValue           = "classify";
-  const char * msRasterStyleOptionsPropertyName     = "msRasterStyleOptions";
-  /* options for linear stretching */
-  const char * msRasterStyleLinearStretchingMinMaxPropertyName  = "minMax";
+  const char * msRasterStyleLinearStretchingMinMaxPropertyName  = "minMax";             /* Linear stretching */
   const char * msRasterStyleLinearStretchingMeanStdPropertyName = "meanStd";
 
+  // Maximum number of classes (classify mode)
   const unsigned int msRasterStyleClassifyAutoMaximumNumberOfClasses = 256;
 
@@ -953 +953 @@
   /*
    * This is just for the backward compatibility and will be deprecated
+   * TODO: mark this as deprecated
    */
   {
@@ -1166 +1167 @@
 
         } // styleType is LINEAR_STRETCHING
+
       else if( styleType == CLASSIFY )
         {
-        if(iBand==0)
+        if(iBand==0) // classify only the first band
           {
           if (classifyType == USER)
@@ -1291 +1293 @@
 
           } // styleType is CLASSIFY
+
         } //iBand is 0