src.functions

In this directory the functions for processing SVF and SOLWEIG are found.

Subpackages

• functions.SOLWEIGpython
  • Subpackages
    • src.functions.SOLWEIGpython.UTIL
      • functions.SOLWEIGpython.UTIL.Perez_v3
      • functions.SOLWEIGpython.UTIL.Solweig_v2015_metdata_noload
      • functions.SOLWEIGpython.UTIL.clearnessindex_2013b
      • functions.SOLWEIGpython.UTIL.create_patches
      • functions.SOLWEIGpython.UTIL.diffusefraction
      • functions.SOLWEIGpython.UTIL.shadowingfunction_wallheight_13_cupy
      • functions.SOLWEIGpython.UTIL.shadowingfunction_wallheight_23_cupy
      • functions.SOLWEIGpython.UTIL.sun_distance
  • functions.SOLWEIGpython.Kside_veg_v2022a_cupy
    • Kside_veg_v2022a()
  • functions.SOLWEIGpython.Kup_veg_2015a
    • Kup_veg_2015a()
  • functions.SOLWEIGpython.Kvikt_veg
    • Kvikt_veg()
  • functions.SOLWEIGpython.Lcyl_v2022a_cupy
    • Lcyl_v2022a_cupy()
  • functions.SOLWEIGpython.Lside_veg_v2022a_cupy
    • Lside_veg_v2022a_cupy()
  • functions.SOLWEIGpython.Lvikt_veg
    • Lvikt_veg()
  • functions.SOLWEIGpython.Solweig_2022a_calc_forprocessing_cupy
    • Solweig_2022a_calc()
    • Solweig_2022a_calc_3d()
  • functions.SOLWEIGpython.Tgmaps_v1_cupy
    • Tgmaps_v1()
  • functions.SOLWEIGpython.TsWaveDelay_2015a
    • TsWaveDelay_2015a()
  • functions.SOLWEIGpython.WriteMetadataSOLWEIG
    • writeRunInfo()
  • functions.SOLWEIGpython.cylindric_wedge_cupy
    • cylindric_wedge_cupy()
  • functions.SOLWEIGpython.daylen
    • daylen()
  • functions.SOLWEIGpython.emissivity_models
    • model1()
    • model2()
    • model3()
  • functions.SOLWEIGpython.gvf_2018a_cupy
    • gvf_2018a_cupy()
  • functions.SOLWEIGpython.patch_characteristics_cupy
    • define_patch_characteristics()
  • functions.SOLWEIGpython.sunlit_shaded_patches
    • shaded_or_sunlit()
  • functions.SOLWEIGpython.sunonsurface_2018a_cupy
    • sunonsurface_2018a_cupy()

Submodules

functions.svf_functions

undoc-members:

src.functions.svf_functions.annulus_weight(altitude, aziinterval)

Unchanged function. Computes a weight for annuli at a given altitude, using sine functions based on azimuth intervals.

src.functions.svf_functions.svfForProcessing153(dsm, dtm, vegdem, vegdem2, scale, usevegdem)

Calculates sky view factor (SVF) and directional SVFs using 153 sky patch divisions, an updated function. This function is used for the Anisotropic sky model.

Parameters:

• dsm (cp.ndarray) – Digital Surface Model containing building + ground elevations.

• dtm (cp.ndarray) – Digital terrain model, containing only ground elevations. If None, DSM is used as base elevation.

• vegdem (cp.ndarray) – Vegetation height layer (CHM)

• vegdem2 (cp.ndarray) – Secondary vegetation layer, containing trunk heights.

• scale (float) – Pixel resolution in meters.

• usevegdem (int) – If 1, include vegetation in SVF calculation; if 0, ignore it.

Returns:

Contains SVF arrays for total, directional (E/S/W/N), vegetation, and shadow matrices.

Return type:

dict

src.functions.svf_functions.svfForProcessing153_3d(dsms, dtm, vegdem, vegdem2, scale, usevegdem)

Calculates sky view factor (SVF) and directional SVFs using 153 sky patch divisions for 3D input. This function is used for the Anisotropic sky model.

Parameters:

• dsms (cp.ndarray) – 3D-layered Digital Surface Model containing building + ground elevations, and gap layers.

• dtm (cp.ndarray) – Digital terrain model, containing only ground elevations. If None, DSM is used as base elevation.

• vegdem (cp.ndarray) – Vegetation height layer (CHM)

• vegdem2 (cp.ndarray) – Secondary vegetation layer, containing trunk heights.

• scale (float) – Pixel resolution in meters.

• usevegdem (int) – If 1, include vegetation in SVF calculation; if 0, ignore it.

Returns:

Contains SVF arrays for total, directional (E/S/W/N), vegetation, and shadow matrices, all at base layer.

Return type:

dict

src.functions.svf_functions.svfForProcessing655(dsm, dtm, vegdem, vegdem2, scale, usevegdem)

Calculates sky view factor (SVF) and directional SVFs using 655 sky patch divisions, updated function. This function is used for the isotropic sky model.

Parameters:

• dsm (cp.ndarray) – Digital Surface Model containing building + ground elevations.

• dtm (cp.ndarray) – Digital terrain model, containing only ground elevations. If None, DSM is used as base elevation.

• vegdem (cp.ndarray) – Vegetation height layer (CHM)

• vegdem2 (cp.ndarray) – Secondary vegetation layer, containing trunk heights.

• scale (float) – Pixel resolution in meters.

• usevegdem (int) – If 1, include vegetation in SVF calculation; if 0, ignore it.

Returns:

Contains SVF arrays for total, directional (E/S/W/N), vegetation, and shadow matrices, all at base layer.

Return type:

dict

src.functions.svf_functions.svfForProcessing655_3d(dsms, dtm, vegdem, vegdem2, scale, usevegdem)

Calculates sky view factor (SVF) and directional SVFs using 655 sky patch divisions for 3D input. This function is used for the isotropic sky model.

Parameters:

• dsms (cp.ndarray) – 3D-layered Digital Surface Model containing building + ground elevations, and gap layers.

• dtm (cp.ndarray) – Digital terrain model, containing only ground elevations. If None, DSM is used as base elevation.

• vegdem (cp.ndarray) – Vegetation height layer (CHM)

• vegdem2 (cp.ndarray) – Secondary vegetation layer, containing trunk heights.

• scale (float) – Pixel resolution in meters.

• usevegdem (int) – If 1, include vegetation in SVF calculation; if 0, ignore it.

Returns:

Contains SVF arrays for total, directional (E/S/W/N), vegetation, and shadow matrices, all at base layer.

Return type:

dict

src.functions.svf_functions.svf_angles_100121()

Unchanged function. Generates azimuth intervals and angles for calculating SVF.