Documenting the new SHADE filter

meteoio/meteoFilters/ProcShade.cc

@@ -95,7 +95,7 @@ void ProcShade::process(const unsigned int& param, const std::vector<MeteoData>&
 			it->second.calculateRadiation(TA, RH, albedo);
 			const double Md = it->second.getSplitting(ISWR);
 			
-			tmp *= Md; //only keep the diffuse radiation
+			tmp *= Md; //only keep the diffuse radiation, either on RSWR or ISWR
 		}
 	}
 	
@@ -185,6 +185,7 @@ void ProcShade::parse_args(const std::vector<std::string>& vec_args)
 	const size_t nrArgs = vec_args.size();
 	if (nrArgs==0) {
 		//compute from DEM
+		throw InvalidArgumentException("Shading from DEM not implemented yet in filter " + getName(), AT);
 	} else if (nrArgs==1) {
 		//if this is a relative path, prefix the path with the current path
 		const std::string in_filename = vec_args[0];

meteoio/meteoFilters/ProcShade.h

@@ -29,9 +29,22 @@ namespace mio {
  * @class  ProcShade
  * @ingroup processing
  * @author Mathias Bavay
- * @date   2012-02-06
- * @brief 
+ * @date   2016-01-22
+ * @brief Apply a shading mask to the Incoming or Reflected Short Wave Radiation
+ * A shading mask (that will be linearly interpolated between the provided points) must be provided in a separate file,
+ * simply containing the horizon elevation (in deg.) as a function of azimuth (in deg.):
  * @code
+ * 0	5
+ * 15	25
+ * 45	12
+ * 180	30
+ * 270	20
+ * @endcode
+ * 
+ * Then the filter is declared with the file name containing the horizon mask as argument:
+ * @code
+ * ISWR::filter1 = SHADE
+ * ISWR::arg1    = ../input/iswr_mask.dat
  * @endcode
  *
  */

meteoio/meteoFilters/ProcessingBlock.cc

@@ -119,6 +119,7 @@ namespace mio {
  * - UNDERCATCH_HAMON: Hamon1973 rain gauge correction for undercatch, see ProcUndercatch_Hamon
  * - UNVENTILATED_T: unventilated temperature sensor correction, see ProcUnventilatedT
  * - PSUM_DISTRIBUTE: distribute accumulated precipitation over preceeding timesteps, see ProcPSUMDistribute
+ * - SHADE: apply a shading mask to the Incoming or Reflected Short Wave Radiation, see ProcShade
  *
  */