honeybee_radiance_command.rfluxmtx module

rfluxmtx command

class honeybee_radiance_command.rfluxmtx.Rfluxmtx(options=None, output=None, sensors=None, sender=None, receivers=None, system=None, octree=None)[source]

Bases: honeybee_radiance_command._command.Command

Rfluxmtx command.

Rfluxmtx samples rays uniformly over the surface given in sender.rad and records rays arriving at surfaces in the file receivers.rad, producing a flux transfer matrix per receiver. A system octree to which the receivers will be appended may be given with a -i option following the receiver file. Additional system surfaces may be given in one or more system.rad files, which are compiled before the receiver file into an octree sent to the rcontrib program to do the actual work.

Args: options: Command options. It will be set to Radiance default values

if unspecified.

output: Output file (Default: None). octree: Octree file (Default: None). sensors: Sensors file (Default: None). receivers: Receivers file (Default: None). sender: Sender file (Default: None). system: System file (Default: None).

Properties:

  • options

  • output

  • octree

  • sensors

  • system

  • sender

  • receivers

Note: https://www.radiance-online.org/learning/documentation/manual-pages/pdfs/rfluxmtx.pdf

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.

property options

Rfluxmtx options.

property output

output file.

property pipe_to

Second command to pipe the outputs from this command.

property receivers

Receivers file.

property sender

Sender file.

property sensors

Sensor file.

property system

System file.

Note that rfluxmtx can accept any number of system files, however, to keep the implementation clean, only one system file is being allowed.