view¶

honeybee-radiance view¶

Commands for generating and modifying views.

honeybee-radiance view [OPTIONS] COMMAND [ARGS]...

merge¶

Merge several radiance HDR image files into a single file.

This command will also perform an anti-aliasing operation on the output and replace the view information in the header of the merged file if a single .vf file is found within the root of the input-folder.

Args:

input_folder: Input folder.

base_name: File base name. All of the files must start with base name and

continue with _ and an integer values.

extension: File extension. [Default: .unf]

honeybee-radiance view merge [OPTIONS] INPUT_FOLDER BASE_NAME [EXTENSION]

Options

-vf, --view <view>¶: Full path to the original view file.

-s, --scale-factor <scale_factor>¶

A number that will be used to scale the dimensions of the output image as it is filtered for anti-aliasing.

Default:: 1

-f, --folder <folder>¶

Optional output folder.

Default:: '.'

-n, --name <name>¶: Optional output filename. Default is base-name.

Arguments

INPUT_FOLDER¶: Required argument

BASE_NAME¶: Required argument

EXTENSION¶: Optional argument

split¶

Split a radiance view file into smaller views based on count.

Args:

view: Full path to input sensor view file.

count: Maximum number of sensors in new files. The number will be rounded to

closest round number for each file. For example if the input file has 21
sensors and input count is set to 5 this command will generate 4 files where
the first three files will have 5 sensors and the last file will have 6.

honeybee-radiance view split [OPTIONS] VIEW COUNT

Options

--skip-overture, -o, --overture¶

Flag to note whether an ambient file (.amb) should be generated for an overture calculation before the view is split into smaller views. The .amb file will have the same name as the view-file. With an overture calculation, the ambient file (aka ambient cache) is first populated with values. Thereby ensuring that - when reused to create an image - Radiance uses interpolation between already calculated values rather than less reliable extrapolation. The overture calculation has comparatively small computation time to full rendering but is single core can become time consuming in situations with very high numbers of rendering multiprocessors.

Default:: True

-r, --resolution <resolution>¶: An optional integer for the maximum dimension of the image in pixels. Specifying a value here will automatically lower the input –count to ensure the resulting images can be combined to meet this dimension. If unspecified, the –count will always be respected and the resulting images might not be combine-able to meet a specific target dimension.

-oct, --octree <octree>¶: Octree file for the overture calculation. This must be specified when the overture is not skipped.

-rp, --rad-params <rad_params>¶: Radiance parameters for the overture calculation. If unspecified, default rpict paramters will be used.

-f, --folder <folder>¶

Output folder.

Default:: '.'

-log, --log-file <log_file>¶: Optional log file to output the name of the newly created views. By default the list will be printed out to stdout

Arguments

VIEW¶: Required argument

COUNT¶: Required argument

split-count¶

Get the number of times to split each view in a model using a CPU count.

Args:

view_info_file: Input view info file.

cpu_count: Number of processes that will be used to run

the simulations in parallel.

honeybee-radiance view split-count [OPTIONS] VIEW_INFO_FILE CPU_COUNT

Options

-f, --output-file <output_file>¶

Optional file to output the integer for the number of times to split the view. By default this will be printed to stdout

Default:: '-'

Arguments

VIEW_INFO_FILE¶: Required argument

CPU_COUNT¶: Required argument