bifacial_radiance.AnalysisObj.moduleAnalysis

AnalysisObj.moduleAnalysis(scene, modWanted=None, rowWanted=None, sensorsy=9, sensorsx=1, frontsurfaceoffset=0.001, backsurfaceoffset=0.001, modscanfront=None, modscanback=None, relative=False, debug=False)[source]

Handler function that decides how to handle different number of front and back sensors. If number for front sensors is not provided or is the same as for the back, _moduleAnalysis is called only once. Else it is called twice to get the different front and back dictionary.

This function defines the scan points to be used in the analysis function, to perform the raytrace through Radiance function rtrace

Parameters
  • scene (SceneObj) – Generated with makeScene.

  • modWanted (int) – Module wanted to sample. If none, defaults to center module (rounding down)

  • rowWanted (int) – Row wanted to sample. If none, defaults to center row (rounding down)

  • sensorsy (int or list) – Number of ‘sensors’ or scanning points along the collector width (CW) of the module(s). If multiple values are passed, first value represents number of front sensors, second value is number of back sensors

  • sensorsx (int or list) – Number of ‘sensors’ or scanning points along the length, the side perpendicular to the collector width (CW) of the module(s) for the back side of the module. If multiple values are passed, first value represents number of front sensors, second value is number of back sensors.

  • debug (bool) – Activates various print statemetns for debugging this function.

  • modscanfront (dict) – Dictionary to modify the fronstcan values established by this routine and set a specific value. Keys possible are ‘xstart’, ‘ystart’, ‘zstart’, ‘xinc’, ‘yinc’, ‘zinc’, ‘Nx’, ‘Ny’, ‘Nz’, and ‘orient’. If modifying Nx, Ny or Nz, make sure to modify on modscanback to avoid issues on results writing stage. All of these keys are ints or floats except for ‘orient’ which takes x y z values as string ‘x y z’ for example ‘0 0 -1’. These values will overwrite the internally calculated frontscan dictionary for the module & row selected.

  • modscanback (dict) – Dictionary to modify the backscan values established by this routine and set a specific value. Keys possible are ‘xstart’, ‘ystart’, ‘zstart’, ‘xinc’, ‘yinc’, ‘zinc’, ‘Nx’, ‘Ny’, ‘Nz’, and ‘orient’. If modifying Nx, Ny or Nz, make sure to modify on modscanback to avoid issues on results writing stage. All of these keys are ints or floats except for ‘orient’ which takes x y z values as string ‘x y z’ for example ‘0 0 -1’. These values will overwrite the internally calculated frontscan dictionary for the module & row selected.

  • relative (Bool) – if passing modscanfront and modscanback to modify dictionarie of positions, this sets if the values passed to be updated are relative or absolute. Default is absolute value (relative=False)

Returns

  • frontscan (dictionary) – Scan dictionary for module’s front side. Used to pass into analysis function

  • backscan (dictionary) – Scan dictionary for module’s back side. Used to pass into analysis function