honeybee_plus.radiance.command.rfluxmtx module

class honeybee_plus.radiance.command.rfluxmtx.Rfluxmtx(sender=None, receiver_file=None, octree_file=None, rad_files=None, points_file=None, output_matrix=None, view_rays_file=None, view_info_file=None, output_filename_format=None, num_processors=None)

Bases: honeybee_plus.radiance.command._commandbase.RadianceCommand

Radiance Rfluxmtx matrix.

static add_control_parameters(input_string, modifier_dict)

static check_for_rflux_parameters(file_val)

static control_parameters(hemi_type='u', hemi_up_direction='Y', output_file='')

Rfluxmtx ControlParameters.

static default_sky_ground(file_name, sky_type=None, sky_file_format=None, ground_file_format=None)

Parameters

• file_name – This should be the name of the file to which the sky defintion should be written to.

• sky_type –

  The acceptable inputs for hemisphere type are: u for uniform.(Usually applicable for ground).

  kf for klems full.

  kh for klems half.

  kq for klems quarter.

  rN for Reinhart - Tregenza type skies. N stands for

  subdivisions and defaults to 1.

  scN for shirley-chiu subdivisions.

Returns

Passes back the same file_name that was provided as input.

Return type

file_name

ground_string = '\n void glow ground_glow\n 0\n 0\n 4 1 1 1 0\n\n ground_glow source ground\n 0\n 0\n 4 0 0 -1 180\n '

property input_files

Return list of input files for this command.

num_processors = None

Number of processors

number_of_points

Number of test points. Initially set to 0.

octree_file = None

Octree file containing the other rad file in the scene.

output_data_format = None

property output_filename_format

Filename format

output_matrix = None

The flux matrix file that will be created by rfluxmtx.

property points_file

The points file or input vwrays for which the illuminance/luminance value are to be calculated.

property rad_files

Rad files other than the sender and receiver that are a part of the scene.

receiver_file = None

Receiver file will usually be the sky file containing rfluxmtx variables

property rfluxmtx_parameters

sender

Sender file will be either a rad file containing rfluxmtx variables or just a -

sky_string = '\n void glow sky_glow\n 0\n 0\n 4 1 1 1 0\n\n sky_glow source sky\n 0\n 0\n 4 0 0 1 180\n '

to_rad_string(relative_path=False)

Return full command as a string.

verbose = None

property view_info_file

File containing view dimensions calculated from vwrays.

view_rays_file = None

File containing ray samples generated from vwrays

class honeybee_plus.radiance.command.rfluxmtx.RfluxmtxControlParameters(hemi_type='u', hemi_up_direction='Y', output_file='')

Bases: object

Rfluxmtx ControlParameters.

Set the values for hemispheretype, hemisphere up direction and output file location (optional).

property hemisphere_type

The acceptable inputs for hemisphere type are: u for uniform.(Usually applicable for ground). kf for klems full. kh for klems half. kq for klems quarter. rN for Reinhart - Tregenza type skies. N stands for subdivisions

and defaults to 1.

scN for shirley-chiu subdivisions.

property hemisphere_up_direction