Class ShadowFlickerToolbox
Shadow Flicker Toolbox functionality
Namespace: Scripting
Syntax
public class ShadowFlickerToolbox
Methods
CalculateShadowFlickerAtReceptors(IList<Double>)
Calculate shadow flicker at receptor locations
Declaration
public Scenario CalculateShadowFlickerAtReceptors(IList<double> timeSeriesWeightings = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IList<System.Double> | timeSeriesWeightings | If specified, a time series list of weightings to apply |
Returns
Type | Description |
---|---|
Scenario |
DeleteShadowFlickerGrid()
Deletes the shadow flicker grid in the workbook.
Declaration
public void DeleteShadowFlickerGrid()
ExportShadowFlickerGrid(String)
Exports the shadow flicker grid that has been generated.
Declaration
public void ExportShadowFlickerGrid(string destinationFilePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | destinationFilePath | The destination file path that the exported file will be saved to. |
GenerateDirectionalShadowFlickerGrids(Double, IEnumerable<Int32>, IEnumerable<Double>, String, String, IList<Double>)
Generate Shadow Flicker grids with user defined rotor orientations. these grids are exported to the specified directory, and an all directional grid weighted by specified frequencies is generated and imported to be displayed on the map.
Declaration
public void GenerateDirectionalShadowFlickerGrids(double gridResolution, IEnumerable<int> orientations, IEnumerable<double> frequencies, string outputDirectory, string name, IList<double> timeSeriesWeightings = null)
Parameters
Type | Name | Description |
---|---|---|
System.Double | gridResolution | The grid resolution to generate |
System.Collections.Generic.IEnumerable<System.Int32> | orientations | The rotor orientations to calculate |
System.Collections.Generic.IEnumerable<System.Double> | frequencies | The frequencies of each rotor orientation (must sum to 1) |
System.String | outputDirectory | The directory to export the grids to |
System.String | name | The file name to name grids |
System.Collections.Generic.IList<System.Double> | timeSeriesWeightings | The time series weightings for grid calculation |
GenerateShadowFlickerGrid(Double, IList<Double>)
Generates the shadow flicker grid.
Declaration
public void GenerateShadowFlickerGrid(double gridResolution, IList<double> timeSeriesWeightings = null)
Parameters
Type | Name | Description |
---|---|---|
System.Double | gridResolution | The grid pixel resolution (in metres). |
System.Collections.Generic.IList<System.Double> | timeSeriesWeightings | If specified, a time series list of weightings to apply |
SaveReceptorResultShadowFlickerChartImage(ReadOnlyReceptorResult, Int32, Int32, String)
Saves the receptor result shadow flicker chart image to a file.
Declaration
public void SaveReceptorResultShadowFlickerChartImage(ReadOnlyReceptorResult receptorResult, int imageWidth, int imageHeight, string imageFilePath)
Parameters
Type | Name | Description |
---|---|---|
ReadOnlyReceptorResult | receptorResult | The receptor result used to populate the chart. |
System.Int32 | imageWidth | Width of the image. |
System.Int32 | imageHeight | Height of the image. |
System.String | imageFilePath | The image file path (should have a .png extension). |