honeybee_radiance_command.options.rcollate module

Rcollate parameters.

class honeybee_radiance_command.options.rcollate.RcollateOptions

Bases: honeybee_radiance_command.options.optionbase.OptionCollection

Rcollate command options.

[ -h[io] ][ -w ][ -f[afdb][N] ][ -t ][ -ic in_col ][ -ir in_row ][ -oc out_col ] [ -or out_row ][ -o RxC[xR1xC2..] ]

In this class the -f option has been implemented such that there are separate options like -fa , -ff etc. This is to enable the inclusion of numeric inputs for digits in an easy manner.

Also see: https://www.radiance-online.org/learning/documentation/manual-pages/pdfs/rcollate.pdf

to_file(folder, file_name, mkdir=False)

Write options to a file.

to_radiance()

Translate options to Radiance format.

update_from_string(string)

Update options from a standard radiance string.

If the option is not currently part of the collection, it will be added to additional_options.

additional_options

property command

Command name.

property fa

Number of words in the input, each record assumed to be in ASCII format. If an empty string is provided as input, then the number will be determined by Radiance while parsing.

property fb

Number of words in the input, each record assumed to be in binary format. If an empty string is provided as input, then the number will be determined by Radiance while parsing.

property fd

Number of words in the input, each record assumed to be in double format. If an empty string is provided as input, then the number will be determined by Radiance while parsing.

property ff

Number of words in the input, each record assumed to be in floating-point format. If an empty string is provided as input, then the number will be determined by Radiance while parsing.

property h

By default, header is expected to be present. “i” option turns off the expectation for input header and “o” option for output header Providing an empty string turns off both headers. If just an empty string is provided then both headers will be assumed to be empty.

property ic

Input columns

property ir

Input rows

property o

The number of rows may be specified with a -or option, or may be determined automatically from the size of the input if it is an even multiple of the number of columns (as it should be). Alternatively, both may be specified using a -o option with the number of rows and columns separated by an x, as in “30x14” for 30 rows by 14 columns. Rcollate can also reorder the input into nested blocks by continuing the output size string. For example, “3x10X7x2” would order output data with a 3x10 super-array of 7x2 subblocks. This type of block hierarchy is convenient for visualizing tensor data. If the -o option is also given with multiple block levels, the transpose operation will logically precede the reordering operation, regardless of their position on the command line.

property oc

Output columns

property options

Print out list of options.

property or_

Output rows

property slots

Return slots including the ones from the baseclass if any.

property t

The transpose option, -t swaps rows and columns on the input.

property w

The -w option turns off non-fatal warning messages, such as unexpected EOD.