CreateObstructionFile (Sensor)
Creates a file that indicates whether directions are obstructed by a sensor's body or AzEl mask.
Syntax
CreateObstructionFile <SensorObjectPath> <Parameters>
Description
Use the CreateObstructionFile command to create a file indicating obstructed directions by a sensor's body or AzEl mask. The file uses a '1' to indicate that a direction is obstructed; it uses a '0', ' ', or '' (depending on the settings) to indicate unobstructed. Direction is indicated by azimuth and elevation angles as defined natively by the mask file.
For body mask files, elevation is defined as the angle above the local XY-plane, positive toward the local Z-axis; azimuth is the angle to the projection into the local XY-plane from the local X-axis, positive using the right-hand rule about the local Z-axis. This definition of (az,el) is used for reporting the obstruction direction regardless of the actual LocalZ and LocalX settings in the file.
Values are reported over a range of azimuths and elevations, making a rectangular table.
| Keyword | Required | Description |
|---|---|---|
| OutFile | Yes | Name of file to create. If no filepath is specified, the file will be created in the scenario folder. |
| RowVar | No | {Az|Azimuth|El|Elev|Elevation}. Indicates whether azimuth or elevation will be row variable of the table, with the other angle being the column variable. Default is Elevation.
When Elevation is the row variable, elevation rows are reported in decreasing order, from maximum to minimum. When Azimuth is the row variable, azimuth rows are reported in increasing order, from minimum to maximum. |
| Format | No | {Csv|Fixed|FixedWidth}. Indicates the format of the table. Csv indicates comma separated values; Fixed and FixedWidth both indicate a file with each entry being 1 ascii character. Default is FixedWidth. |
| OnlyReportObstruction | No | {Yes|True|No|False}. If No or False, then reports '0' to indicate a direction is unobstructed. If Yes or True, reports ' ' in FixedWidth and '' in Csv format. Default is No. |
| MinAz | No | <Value> in degrees between -360 and 360 of the minimum azimuth to report. Default is 0 deg. |
| MaxAz | No | <Value> in degrees between -360 and 360 of the maximum azimuth to report. This value must be greater than MinAz. Default is 360 deg. |
| NumAzSteps | No | <IntegerValue> The number of samples of azimuth to report after reporting the minimum value. The actual number of samples reported will be NumAzSteps+1. Default is 360; however, if the range of azimuth to report is less than 2 deg, defaults to 10. |
| MinEl | No | <Value> in degrees between -90 and 90 of the minimum elevation to report. Default is -90 deg. |
| MaxEl | No | <Value> in degrees between -90 and 90 of the maximum elevation to report. This value must be greater than MinEl. Default is 90 deg. |
| NumElSteps | No | <IntegerValue> The number of samples of elevation to report after reporting the minimum value. The actual number of samples reported will be NumElSteps+1. Default is 180; however, if the range of elevation to report is less than 2 deg, defaults to 10. |
Examples
To create an obstruction file for all directions, starting at 90 deg elevation and decreasing each row until -90 deg, at 1 deg resolution:
To create an obstruction file in Csv format for the selected az-el range
Return message
Group membership
This command belongs to the following group(s):
Version
13.0