honeybee_radiance_command.getinfo module

getinfo command.

class honeybee_radiance_command.getinfo.Getinfo(options=None, output=None, input=None)[source]

Bases: Command

Getinfo command.

Getinfo reads the header of each RADIANCE file and writes it to the standard output. Octree and picture files are in a binary format, which makes it difficult to determine their content. Therefore, a few lines of text are placed at the beginning of each file by the RADIANCE program that creates it. The end of the header information and the start of the data is indicated by an empty line.

Parameters:

  • options – Command options. It will be set to Radiance default values if unspecified.

  • output – File path to the output file (Default: None).

  • input – A list of paths to radiance generated hdr images, octree files, etc. (Default: None).

Properties:

  • options

  • output

  • input

  • remove_header

after_run()

After run script.

Overwrite this method to add extra tasks that runs right after run method.

enclose_command(stdin_input=False)

Enclose command in quotes and exclamation point (‘!’). This method should be used when reading the input of a command from another Radiance command.

Example: rmtxop -c 47.4 119.9 11.6 “!rmtxop view transmission daylight sky” > output

classmethod remove_header(output=None, input=None)[source]

Return a class instance explicitly for removing the header.

This instance returns getinfo with a hyphen that simply removes the header and copies the body of the file from the standard input to the standard output. Options a and d will be ignored if this class is used.

run(env=None, cwd=None)

Run command as a subprocess.

Parameters:

  • env – Environmental variables (default: None).

  • cwd – Working directory (Default: ‘.’).

Returns:

Command return code.

Return type:

  • int

to_radiance(stdin_input=False)[source]

Command in Radiance format.

Parameters:

stdin_input – A boolean that indicates if the input for this command comes from stdin. This is for instance the case when you pipe the input from another command (default: False).

validate(stdin_input=False)[source]

Overwrite this method to add extra specific checks for the command. For instance for rcontrib you want to make sure there is at least one modifier set in the command.

This method will be executed right before running the command.

property command
property input

A string of joined paths to the hdr or octree files.

property options

getinfo options.

property output

output file.

property pipe_to

Second command to pipe the outputs from this command.