honeybee_radiance_command.rpict module

rpict command.

class honeybee_radiance_command.rpict.Rpict(options=None, output=None, octree=None, view=None)[source]

Bases: Command

Rpict Command.

Rpict generates a picture from the RADIANCE scene given in octree and sends it to the standard output.

Parameters:

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

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

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

  • view – File path to a view file (Default: None).

Properties:

  • options

  • output

  • octree

  • view

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

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 octree

Octree file path.

property options

Rpict options.

property output

output file.

property pipe_to

Second command to pipe the outputs from this command.

property view

View file path (can be obtained using honeybee-radiance).