Setting Options for a Report Section | Setting Options for Data Providers

Report Content Properties

You can define the contents and format of a new report style or modify the contents and format of an existing style. The properties available for defining the content and format of data will depend on the data providers in the selected report style.

To display a subset of data providers, replace the asterisk, which means show all, with a partial data provider name and click Filter. To display all data providers, clear the filter check box. The filter text field is not case-sensitive and supports * and ? wildcards.

Reports are divided into sections and lines. Sections are blocks of similar data. Data with different time dependencies must be placed in separate sections of the report. Lines consist of various data elements included in the report. You can have any number of sections and lines in the report. Data providers are shown in a hierarchical format. Dynamic Displays are organized similarly but do not include sections.

You can create a report that contains data for two or more object classes (for example, facility and vehicle).

To customize a report, select Content in the Report Properties browser and choose one or more of the following options:

To.... Follow this Procedure...
Add data providers Select one or more data providers or data provider groups and click the right arrow to copy the selected items to the Report Contents list. Data providers define the content of your report. Select the new data provider entry and click Options.... Set the options for the new data provider. For data provider descriptions, see Data Providers Reference.
Remove a data provider, line, or entire section from the Report Contents Select the item or items in the Contents list and click Remove. You can also double-click an item to remove it from the list.
Reorder report content items Use the up and down buttons to order the items appropriately. Data providers will appear in the report in the order that they appear in the Report Contents list.
Add a new section Static reports only. Select the item under Report Contents that you want to appear before the section to be added, and click New Section. Select the new section entry and click Options.... Enter the title and set the options for the new section.
Add a new line of data to a section Static reports only. Select the item in the section that you want to appear before the line to be added, and click New Line. Use the right arrow to copy data providers to the new line.
Change units of measure for a section, line or data provider Select the section, line, or data provider under Report Contents and click Units.... The Units window that displays contains options for changing all applicable units of measure for the data selected.
Set section options Select the section under Report Contents and click Options....
Set data provider options Select the data provider under Report Contents and click Options....
Add user text to a dynamic display report Select the item that you want to appear before the user text to be added and click New User Text. A line titled User Text is added to the Report Contents. Select User Text and click Options.... Enter the text that you want to include at that point in the report and click OK.

You cannot add user text to a static report.

Changes you make to a particular section affect all lines and data elements associated with that section. To change one line in a section, make your changes to the line after all changes have been made to the section associated with that line. You can double-click an item in the Data Providers list to add it to the Report Contents.

Setting Options for a Report Section

To set options for a report section, select the section in the Report Contents list and click Options... to display the Options window. You can set the options in the following table.

Option Description
Title Title to be displayed at the top of the section.
Write Evaluation Intervals to Report Includes and saves time intervals in the report style for easy reference.
Use Ephemeris Steps Displays actual times in the report. Useful when reporting external ephemeris. If selected, Step Size is not available. Only available for time-dependent data.
Step Size Displays number of seconds per step. A step size of 300.00 is equal to 5 minutes. Only available for time-dependent data.
Multi Instance Only valid if multiple objects have been selected when generating the report.

Select Include Instance Name with Title to display one section for each object instance in the report or to display the data for an object on the same line in the report. The name of the object displays in the section title.

If you generate a report using an extremely small Step Size over a long period of time, the time STK requires to generate the report is significantly increased.

Setting Options for Data Providers

To set options for a data provider, select the data provider in the Report Contents list and click Options... to display the Options window. You can set the options in the following table. The Options window contains fields that allow you to specify the type of information to be included and format of the data provider.

Option Description
Title Title to be displayed as a column heading for the data provider
Data Format The format in which the data is displayed:
  • Number of Decimal Digits. Enter the number of digits to the right of the decimal point that will be displayed.
  • Fixed Field Width. Enter the total number of digits that will be displayed.
Notation Valid notation values are: Floating Point, Scientific (e) and Scientific (E).
Multi Instance Only valid if multiple objects have been selected when generating the report.

Select Include Instance Name with Title to display the names of the objects in the column title.
Summary Options

Summary Options are not available for all data providers.


Descriptions of the Statistics choices, except Total and Std Deviation, follow:
  • Min and Max. The min and max values are found after doing an iterative search using the report values as an initial sample set and then sub-sampling for the global min and max. The values are found to within a time tolerance of 5 msec. To accurately detect the true min and max the initial sample set must be reasonably representative of the behavior of the parameter reported. This means the report step size should be smaller than half the period of the parameter (assuming some sort of worst case oscillatory behavior), thus satisfying the Nyquist criterion.
  • Mean. The mean is the average of the values displayed in the report. The answer is dependent on the number of values present.
  • Max of Samples. Maximum value as derived from the sampled data.
  • Min of Samples. Minimum value as derived from the sampled data.
  • Percent Interval. Percentage of the interval represented by the total (e.g., total access duration).
  • Percent Not Interval. Percentage of the interval not represented by the total.
  • Discard Boundary Points. Data affected by interval boundaries (e.g., an access interval cut short by the end of the scenario) isn't used in the determination of statistical values.

Events:

  • Report Event Times. Compute times at which this data element's value attains the specified value.
  • Event Name. A user-specified text identifier for this event.
  • Value at Event. The value of the data element at which to declare an event time.
  • Convergence. Sets the time tolerance that is used to determine an event time
  • Direction. Report event times only when the data element is Increasing, Decreasing, or Both increasing and decreasing.
  • Create File. If selected and a file name is chosen, then the times of the events are written to the file name as an interval file.
  • Summary Only. If all data elements in a section are selected to report Summary Only, then the normal table of data is not produced for that section; only the summary data consisting of selected statistics and events is reported.