honeybee_radiance_command.pinterp module¶
pinterp command.
-
class
honeybee_radiance_command.pinterp.
Pinterp
(options=None, output=None, view=None, image=None, zspec=None)[source]¶ Bases:
honeybee_radiance_command._command.Command
Pinterp command.
Pinterp interpolates or extrapolates a new view from one or more RADIANCE pictures and sends the result 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).
view – File path to a view file. This is the view to interpolate or extrapolate (Default: None).
image – Radiance HDR image(s) to interpolate or extrapolate from. A list of images can be given if multiple images are used (Default: None).
zspec – The distance from the view point to each pixel in the image(s). Typically this input is generated as a file by using the -z option of rpict. A number can also be given instead, which should only be used if the view point remains constanst, e.g., if the view point in a single input image is equal to that of the input view. If a list of images is given, then the zspec must also be a list matching the length of the list of images. (Default: None).
- Properties:
options
output
view
image
zspec
-
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
image
¶ Radiance HDR image file(s).
-
property
options
¶ pinterp options.
-
property
output
¶ output file.
-
property
pipe_to
¶ Second command to pipe the outputs from this command.
-
property
view
¶ View to interpolate or extrapolate.
-
property
zspec
¶ z specification for input image(s)