honeybee_radiance_command.options.pcompos module¶

class honeybee_radiance_command.options.pcompos.PcomposOptions[source]¶

Bases: OptionCollection

pcompos command options.

Also see: https://floyd.lbl.gov/radiance/man_html/pcompos.1.html

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.

property a¶

Number of columns for which anchor points will be automatically computed.

It is assumed that anchor points place successive pictures next to each other in ncols columns. The ordering will place the first picture in the lower left corner, the next just to the right of it, and so on for ncols pictures. Then, the next row up repeats the pattern until all the input pictures have been added to the output. If the pictures are of different size, pcompos will end up leaving some background areas in the output picture. There will also be an unfinished row at the top if the number of pictures is not evenly divided by ncols.

additional_options¶

property b¶

(0, 0, 0)

The background color appears wherever input files do not cover.

Type:: RGB value for background color - default

property command¶: Command name.

property h¶

False

The −h option may be used to reduce the information header size, which can grow disproportionately after multiple runs of pcompos and/or pcomb.

Type:: Reduce information header - default

property l¶: Text for a label for the output picture.

property la¶

Label images automatically according by name.

This is particularly useful in conjunction with the −a option for producing a catalog of images.

property lh¶

Type:: Label height in pixels - default

property o¶

Specify a nonzero anchor point for the bottom left image as (x0, y0).

This should be specified as a tuple of 2 integer values, denoting the X and Y pixels of the origin.

property options¶: Print out list of options.

property s¶

Integer for pixel spacing between images.

The −s option causes each image to be separated by at least N pixels.

property slots¶: Return slots including the ones from the baseclass if any.

property x¶

By default, the size of the output picture will be just large enough to encompass all the input files. By specifying a smaller dimension using the −x and −y options, input files can be cropped at the upper boundary. Specifying a larger dimension produces a border.

Type:: X dimension around the output image - default

property y¶

Type:: Y dimension around the output image - default