REPORT
The REPORT command allows you to generate one or more reports from the images that are created by hwGenImages. Every instance of the REPORT command creates a different report which may be either a single run summary or a comparison of two runs.
Syntax
COVER_PAGE{ parameters}
Qualifier
This command has no qualifier.
Parameters
- report_type (enumerated)
- Type of report to generate. Valid options are
run_summary or run_comparison. A
run_summary creates output containing images from a
single result dataset. A run_comparison contains
results from two datasets presented side by side on each page
(
run_comparison_type = side_by_side
), or shown sequentially (run_comparison_type=woven
). - file_prefix (string)
- File prefix to use for naming the report on disk. If no value is specified, the prefix is taken from the name of the REPORT instance. The file extension is automatically added per the format option.
- format (enum)
- Format of the report. Valid options are pdf,
powerpoint, or both.
pdf and both are only valid for
report_type = run_summary
. Run comparisons can only be generated using powerpoint format. - slide_aspect_ratio (enum)
- Aspect ratio of the pages in the report. Valid options are 4:3 and 16:9. Default value is 16:9. The image_size command line option should have the same aspect ratio as the slide aspect ratio to produce the best quality reports.
- comparison_image_dir (string)
- Use with
report_type = run_comparison
. Directory to load images from when performing run comparison. This directory can be specified relative to the current run directory. - image_borders (boolean)
- Flag specifying whether or not image borders should be added to each image in the output. Default value is on.
- case_1_title (string)
- Used with
report_type = run_comparison
. Title of the images to be used for the primary results. - case_2_title (string)
- Used with
report_type = run_comparison
. Title of the images to be used for the comparison run, specified by comparison_image_dir. - run_comparison_type (enum)
- Type of run comparison to create. Valid options are
side_by_side or woven. When
run_comparison_type=side_by_side
, each slide containing output will have two images on it. One from the primary case, and one from the comparison case. Whenrun comparison_type = woven
, the results from each case are presented on alternating slides, allowing you to flip through them in presentation mode to make comparisons. Default is side_by_side.
Example
REPORT("Summary"){
report_type = run_summary
format = pdf
image_borders = on
file_prefix = "IsothermalResults"
slide_aspect_ratio = "4:3"
}
REPORT("Comparison-SideBySide"){
report_type = run_comparison
format = powerpoint
image_borders = off
file_prefix = "-side_by_side"
comparison_image_dir = "../Run_2/IMAGES.DIR"
slide_aspect_ratio = "16:9"
run_comparison_type = side_by_side
}
REPORT("Comparison-SideBySide"){
report_type = run_comparison
format = powerpoint
image_borders = off
file_prefix = "-side_by_side"
comparison_image_dir = "../Run_2/IMAGES.DIR"
slide_aspect_ratio = "16:9"
run_comparison_type = woven
}
The presence of any REPORT command in the input file overrides the command line options for -generate_report and -report_format. In the absence of any instances of the report command, hwGenImages reverts back to its behavior in previous releases of using the command line options to determine what report format to write.