Detailed Description

Apply a shading mask to the Incoming or Reflected Short Wave Radiation.

A shading mask that is either computed from the DEM or read from a separate file will be applied to the radiation and combined with the radiation splitting model in order to properly compute the shading effects on the measurement point. This mask will be linearly interpolated between the provided points in order to be applied to the true sun position.

When providing the shading mask in a separate file, the same mask will be applied to all stations. It simply need to contain the horizon elevation (in deg.) as a function of azimuth (in deg.), prefixed by either a stationID or "*" as fallback wildcard for all stationIDs:

DAV1    0       5
DAV1    15      25
DAV1    45      12
DAV1    180     30
DAV1    270     20
SLF2    0       7.5
SLF2    180     10
*       0       5
*       180     5

Therefore, the filter supports the following arguments:

INFILE: file (and path) to read the mask from (optional);
OUTFILE: file (and path) to write the mask to (optional, this is usefull if some masks have been computed from the DEM).

Then the filter is declared with the file name containing the horizon mask as argument:

ISWR::filter1 = SHADE

ISWR::arg1::infile = ../input/iswr_mask.dat

If no arguments are provided, then it will compute the mask from the Digital Elevation Model. In such as case, a DEM must be declared in the [Input] section and must contain the stations of interest as a mask will be computed for each station. Please make sure that the extent of the DEM is appropriate to correctly compute the shading effects!

#include <ProcShade.h>

Public Member Functions
	ProcShade (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &name, const Config &i_cfg)

	~ProcShade ()

virtual void	process (const unsigned int &param, const std::vector< MeteoData > &ivec, std::vector< MeteoData > &ovec)

Public Member Functions inherited from mio::ProcessingBlock
virtual	~ProcessingBlock ()

virtual void	process (const unsigned int &param, const std::vector< MeteoData > &ivec, std::vector< MeteoData > &ovec)=0

virtual void	process (Date &dateStart, Date &dateEnd)

std::string	getName () const

const ProcessingProperties &	getProperties () const

const std::string	toString () const

bool	skipStation (const std::string &station_id) const
	Should the provided station be skipped in the processing? More...

bool	noStationsRestrictions () const

const std::vector< DateRange >	getTimeRestrictions () const

bool	skipHeight (const double &height) const
	Should the provided height be skipped in the processing? More...

Additional Inherited Members
Static Public Member Functions inherited from mio::ProcessingBlock
static void	readCorrections (const std::string &filter, const std::string &filename, std::vector< double > &X, std::vector< double > &Y)
	Read a data file structured as X Y value on each lines. More...

static void	readCorrections (const std::string &filter, const std::string &filename, std::vector< double > &X, std::vector< double > &Y1, std::vector< double > &Y2)
	Read a data file structured as X Y1 Y2 value on each lines. More...

static std::vector< double >	readCorrections (const std::string &filter, const std::string &filename, const size_t &col_idx, const char &c_type, const double &init)
	Read a correction file applicable to repeating time period. More...

static std::vector< offset_spec >	readCorrections (const std::string &filter, const std::string &filename, const double &TZ, const size_t &col_idx=2)
	Read a correction file, ie a file structured as timestamps followed by values on each lines. More...

static std::map< std::string, std::vector< DateRange > >	readDates (const std::string &filter, const std::string &filename, const double &TZ)
	Read a list of date ranges by stationIDs from a file. More...

Static Public Attributes inherited from mio::ProcessingBlock
static const double	default_height

Protected Member Functions inherited from mio::ProcessingBlock
	ProcessingBlock (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &name, const Config &cfg)
	protected constructor only to be called by children More...

Static Protected Member Functions inherited from mio::ProcessingBlock
static void	extract_dbl_vector (const unsigned int &param, const std::vector< MeteoData > &ivec, std::vector< double > &ovec)

static void	extract_dbl_vector (const unsigned int &param, const std::vector< const MeteoData * > &ivec, std::vector< double > &ovec)

Protected Attributes inherited from mio::ProcessingBlock
const std::set< std::string >	excluded_stations

const std::set< std::string >	kept_stations

const std::vector< DateRange >	time_restrictions

std::set< double >	included_heights

std::set< double >	excluded_heights

bool	all_heights

ProcessingProperties	properties

const std::string	block_name

Static Protected Attributes inherited from mio::ProcessingBlock
static const double	soil_albedo = .23

static const double	snow_albedo = .85

static const double	snow_thresh = .1
	parametrize the albedo from HS More...

Constructor & Destructor Documentation

◆ ProcShade()

mio::ProcShade::ProcShade	(	const std::vector< std::pair< std::string, std::string > > &	vecArgs,
		const std::string &	name,
		const Config &	i_cfg
	)

◆ ~ProcShade()

mio::ProcShade::~ProcShade ( )

Member Function Documentation

◆ process()

void mio::ProcShade::process	(	const unsigned int &	param,
		const std::vector< MeteoData > &	ivec,
		std::vector< MeteoData > &	ovec
	)

virtual

Implements mio::ProcessingBlock.

The documentation for this class was generated from the following files: