QGIS algorithm - r.sun.incidout

Source: R/grass_r_sun_incidout.R

QGIS Algorithm provided by GRASS r.sun.incidout (grass:r.sun.incidout). r.sun.incidout - Solar irradiance and irradiation model ( for the set local time).

grass_r_sun_incidout(
  elevation = qgisprocess:::qgis_default_value(),
  aspect = qgisprocess:::qgis_default_value(),
  aspect_value = qgisprocess:::qgis_default_value(),
  slope = qgisprocess:::qgis_default_value(),
  slope_value = qgisprocess:::qgis_default_value(),
  linke = qgisprocess:::qgis_default_value(),
  albedo = qgisprocess:::qgis_default_value(),
  albedo_value = qgisprocess:::qgis_default_value(),
  lat = qgisprocess:::qgis_default_value(),
  long = qgisprocess:::qgis_default_value(),
  coeff_bh = qgisprocess:::qgis_default_value(),
  coeff_dh = qgisprocess:::qgis_default_value(),
  horizon_basemap = qgisprocess:::qgis_default_value(),
  horizon_step = qgisprocess:::qgis_default_value(),
  day = qgisprocess:::qgis_default_value(),
  step = qgisprocess:::qgis_default_value(),
  declination = qgisprocess:::qgis_default_value(),
  distance_step = qgisprocess:::qgis_default_value(),
  npartitions = qgisprocess:::qgis_default_value(),
  civil_time = qgisprocess:::qgis_default_value(),
  time = qgisprocess:::qgis_default_value(),
  .p = qgisprocess:::qgis_default_value(),
  .m = qgisprocess:::qgis_default_value(),
  incidout = qgisprocess:::qgis_default_value(),
  beam_rad = qgisprocess:::qgis_default_value(),
  diff_rad = qgisprocess:::qgis_default_value(),
  refl_rad = qgisprocess:::qgis_default_value(),
  glob_rad = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_OPT = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_META = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

elevation

raster - Elevation layer (meters). Path to a raster layer.

aspect

raster - Aspect layer (decimal degrees). Path to a raster layer.

aspect_value

number - A single value of the orientation (aspect), 270 is south. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

slope

raster - Name of the input slope raster map (terrain slope or solar panel inclination) (decimal degrees). Path to a raster layer.

slope_value

number - A single value of inclination (slope). A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

linke

raster - Name of the Linke atmospheric turbidity coefficient input raster map. Path to a raster layer.

albedo

raster - Name of the ground albedo coefficient input raster map. Path to a raster layer.

albedo_value

number - A single value of the ground albedo coefficient. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

lat

raster - Name of input raster map containing latitudes (decimal degrees). Path to a raster layer.

long

raster - Name of input raster map containing longitudes (decimal degrees). Path to a raster layer.

coeff_bh

raster - Name of real-sky beam radiation coefficient input raster map. Path to a raster layer.

coeff_dh

raster - Name of real-sky diffuse radiation coefficient input raster map. Path to a raster layer.

horizon_basemap

raster - The horizon information input map basename. Path to a raster layer.

horizon_step

number - Angle step size for multidirectional horizon (degrees). A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

day

number - No. of day of the year (1-365). A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

step

number - Time step when computing all-day radiation sums (decimal hours). A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

declination

number - Declination value (overriding the internally computed value) (radians). A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

distance_step

number - Sampling distance step coefficient (0.5-1.5). A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

npartitions

number - Read the input files in this number of chunks. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

civil_time

number - Civil time zone value, if none, the time will be local solar time. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

time

number - Local (solar) time (decimal hours). A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

.p

boolean - Do not incorporate the shadowing effect of terrain. 1 for true/yes. 0 for false/no. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression. Original algorithm parameter name: -p.

.m

boolean - Use the low-memory version of the program. 1 for true/yes. 0 for false/no. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression. Original algorithm parameter name: -m.

incidout

rasterDestination - incidence angle raster map. Path for new raster layer.

beam_rad

rasterDestination - Beam irradiance (W.m-2). Path for new raster layer.

diff_rad

rasterDestination - Diffuse irradiance (W.m-2). Path for new raster layer.

refl_rad

rasterDestination - Ground reflected irradiance (W.m-2). Path for new raster layer.

glob_rad

rasterDestination - Global (total) irradiance/irradiation (W.m-2). Path for new raster layer.

GRASS_REGION_PARAMETER

extent - GRASS GIS region extent. A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'. Path to a layer. The extent of the layer is used..

GRASS_REGION_CELLSIZE_PARAMETER

number - GRASS GIS region cellsize (leave 0 for default). A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

GRASS_RASTER_FORMAT_OPT

string - Output Rasters format options (createopt). String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

GRASS_RASTER_FORMAT_META

string - Output Rasters format metadata options (metaopt). String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

...

further parameters passed to qgisprocess::qgis_run_algorithm()

.complete_output

logical specifying if complete out of qgisprocess::qgis_run_algorithm() should be used (TRUE) or first output (most likely the main) should read (FALSE). Default value is TRUE.

.quiet

logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.

.messages

logical specifying if messages from qgisprocess::qgis_run_algorithm() should be printed (TRUE) or not (FALSE). Default value is FALSE.

Details

Outputs description

  • beam_rad - outputRaster - Beam irradiance (W.m-2)

  • diff_rad - outputRaster - Diffuse irradiance (W.m-2)

  • glob_rad - outputRaster - Global (total) irradiance/irradiation (W.m-2)

  • incidout - outputRaster - incidence angle raster map

  • refl_rad - outputRaster - Ground reflected irradiance (W.m-2)