Reference

pyradiance

pyradiance is a Python interface for Radiance. It is a collection of Python modules that provide a high level interface to Radiance. It is designed to make Radiance easier to use and accessible to Python user.

Pcomb

__init__(xres=None, yres=None, inform='a', fout=True, header=False, expression=None, source=None)

combine Radiance pictures and/or float matrices

Parameters:

Name	Type	Description	Default
xres	None | int	horizontal resolution	None
yres	None | int	vertical resolution	None
inform	str	input data format. Default is "a" for ascii.	'a'
fout	bool	if True, write output to file	True
header	bool	if True, write header	False
expression	None | str	expression	None
source	None | str	source	None

add(image, original=False, scaler=1.0)

Add images to command.

Parameters:

Name	Type	Description	Default
image	Path | str | bytes	Input image file or bytes	required
original	bool	keep original exposure	False
scaler	float	Scaling factor	1.0

Returns:

Type	Description
Pcomb	self

Primitive dataclass

Radiance Primitive.

Attributes one-to-one mapped from Radiance.

Attributes:

Name	Type	Description
modifier	str	modifier, which primitive modifies this one
ptype	str	primitive type
identifier	str	identifier, name of this primitive
sargs	Sequence[str]	string arguments
fargs	Sequence[float]	real arguments

RayParams

__module__ = 'pyradiance.rad_params' class

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

aa property

ambient accuracy

ab property

ambient bounce

ad property

ambient division

af property

ambient file

ambincl property

ambient inclusion/exclusion

amblist property

(self) -> list

ar property

ambient resolution

as_ property

ambient super sampling

av property

ambient values

aw property

ambient weight

bv property

source back side visibility

dc property

direct certainty

dj property

direct jitter

dp property

virtual source pretesting

dr property

direct relay

ds property

source size aspect ratio

dt property

direct threshold

dv property

direct visibility

i property

do irradiance

lr property

max depth

lw property

minimum ray weight

ma property

medium (mist) scattering albedo

me property

medium(mist) extinction coefficients

mg property

medium (mist) eccentricity factor

ms property

medium (mist) sampling distance

ss property

specular jitter

st property

specular threshold

u property

random sampling

__init__(*args, **kwargs) method descriptor

Initialize self. See help(type(self)) for accurate signature.

__new__(*args, **kwargs) builtin

Create and return a new object. See help(type) for accurate signature.

Rcomb

__init__(transform=None, transform_all=None, source=None, expression=None, concat=None, outform=None, header=True, silent=False)

Combine multiple rasters.

Parameters:

Name	Type	Description	Default
transform	None | str	transform	None
transform_all	None | str	transform all	None
source	None | str	source	None
expression	None | str	expression	None
concat	None | Sequence[str]	concat	None
outform	None | str	output format	None
header	bool	include header	True
silent	bool	suppress output	False

add_input(input, transform=None, scale=None)

Insert commands for inputs

Parameters:

Name	Type	Description	Default
input	str | Path | bytes	input can be file path or bytes	required
transform	None | str	transform string	None
scale	None | Sequence[float]	sequence of scaling factors	None

Returns:

Type	Description
Rcomb	self

Resolu

__module__ = 'pyradiance.rad_params' class

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

rt property

(self) -> int

xr property

(self) -> int

yr property

(self) -> int

__init__() method descriptor

init(self) -> None

__new__(*args, **kwargs) builtin

Create and return a new object. See help(type) for accurate signature.

Scene

Radiance Scene.

materials property

Scene materials.

octree property

Scene id.

sid property

Scene id.

sources property

Scene sources.

surfaces property

Scene surfaces.

__init__(sid, **kwargs)

Parameters:

Name	Type	Description	Default
sid	str	scene id	required

add_material(material)

Add material to the scene. Args: material: material to be added

add_sensor(sensor)

Add sensor to the scene. Args: sensor: sensor to be added

add_source(source)

Add source to the scene. Args: source: source to be added

add_surface(surface)

Add surface to the scene. Args: surface: surface to be added

add_view(view)

Add view to the scene. Args: view: view to be added

build()

Build an octree, as {sid}.oct in the current directory. Will not build if scene has not changed since last build.

remove_material(material)

Remove material from the scene. Args: material: material to be removed

remove_source(source)

Remove source from the scene. Args: source: source to be removed

remove_surface(surface)

Remove surface from the scene. Args: surface: surface to be removed

View

__module__ = 'pyradiance.rad_params' class

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

hn2 property

(self) -> float

hoff property

View horizontal offset

horiz property

View horizontal size

hvec property

(self) -> tuple

type property

View types: 'v': perspective, 'l': parallel, 'c': cylindrical panorma, 'h': hemispherical fisheye, 'a': angular fisheye, 's': planispherical fisheye

vaft property

View aft clipping plane

vdir property

View direction: x, y, z

vdist property

(self) -> float

vert property

View vertical size

vfore property

View fore clipping plane

vn2 property

(self) -> float

voff property

View vertical offset

vp property

View position: x, y, z

vu property

View up direction: x, y, z

vvec property

(self) -> tuple

__init__() method descriptor

init(self) -> None

__new__(*args, **kwargs) builtin

Create and return a new object. See help(type) for accurate signature.

WrapBSDF

__init__(inxml=None, enforce_window=False, comment=None, correct_solid_angle=False, basis=None, unlink=False, unit=None, geometry=None, **kwargs)

Initialize wrapper operation of BSDF data into XML

Parameters:

Name	Type	Description	Default
inxml	None | str | Path	input xml file	None
enforce_window	bool	Enforcing LBNL Window XML schema,	False
comment	None | str	additional comment to add to XML,	None
correct_solid_angle	bool	Correct the input BSDF by solid angles,	False
basis	None | str	BSDF basis to use, "kf", "kh", "kq",	None
unlink	bool	Whether to remove input file after creating XML file,	False
unit	None | str	BSDF geometry unit,	None
geometry	None | str	Whether to include geometry in XML,	None
**kwargs	str | float	Additional tags to be passed into XML	{}

add_solar(tb=None, tf=None, rb=None, rf=None)

Insert commands for solar data

Parameters:

Name	Type	Description	Default
tb	None | str	back transmittance file	None
tf	None | str	front transmittance file	None
rb	None | str	back reflectance file	None
rf	None | str	front reflectance file	None

Returns:

Type	Description
WrapBSDF	self

add_visible(tb=None, tf=None, rb=None, rf=None)

Insert commands for visible data

Parameters:

Name	Type	Description	Default
tb	None | str	back transmittance file	None
tf	None | str	front transmittance file	None
rb	None | str	back reflectance file	None
rf	None | str	front reflectance file	None

Returns:

Type	Description
WrapBSDF	self

Xform

__init__(inp, expand_cmd=True, invert=False, iprefix=None, modifier=None)

Initialize a transformation operation of a RADIANCE scene description

Parameters:

Name	Type	Description	Default
inp	str | Path | bytes	Input file or bytes	required
expand_cmd	bool	Set to True to expand command	True
iprefix	None | str	Prefix identifier	None
modifier	None | str	Set surface modifier to this name	None
invert	bool	Invert surface normal	False

array(number)

Insert array command.

Parameters:

Name	Type	Description	Default
number	int	array number	required

Returns:

Type	Description
Xform	self

iterate(number)

Insert iterate command.

Parameters:

Name	Type	Description	Default
number	int	iterate number	required

Returns:

Type	Description
Xform	self

mirrorx()

Insert mirror about yz plane command.

Returns:

Type	Description
Xform	self

mirrory()

Insert mirror about xz plane command.

Returns:

Type	Description
Xform	self

mirrorz()

Insert mirror about xy plane command.

Returns:

Type	Description
Xform	self

rotatex(deg)

Insert rotation around x axis command.

Parameters:

Name	Type	Description	Default
deg	float	rotation in degree	required

Returns:

Type	Description
Xform	self

rotatey(deg)

Insert rotation around x axis command.

Parameters:

Name	Type	Description	Default
deg	float	rotation in degree	required

Returns:

Type	Description
Xform	self

rotatez(deg)

Insert rotation around x axis command.

Parameters:

Name	Type	Description	Default
deg	float	rotation in degree	required

Returns:

Type	Description
Xform	self

scale(ratio)

Insert scaling command.

Parameters:

Name	Type	Description	Default
ratio	float	scaling factor	required

Returns:

Type	Description
Xform	self

translate(x, y, z)

Insert translate command.

Parameters:

Name	Type	Description	Default
x	float	translation in x coordinate	required
y	float	translation in y coordinate	required
z	float	translation in z coordinate	required

Returns:

Type	Description
Xform	self

bsdf2klems(*inp, spp=None, half=False, quater=False, progress_bar=False, progress_bar_length=None, maxlobes=None, forward=False, backward=True, expr=None, file=None)

Generate XML Klems matrix description of a BSDF.

Parameters:

Name	Type	Description	Default
inp	str	Path to XML file	()
spp	None | int	number of samples for each input-output patch pair, default=1024.	None
half	bool	Generate instead a half Klems basis XML.	False
quater	bool	Generate instead a quater Klems basis XML.	False
progress_bar	bool	toggle to show progress bar.	False
progress_bar_length	None | int	length of the progress bar, default=79 characters.	None
maxlobes	None | int	maximum number of lobes in any interpolated radial basis function (default=15000). Setting the value to 0 turns off this limit.	None
forward	bool	generate forward matrix (default=off).	False
backward	bool	generate backward matrixi (default=on).	True
expr	None | str	expression to evaluate.	None
file	None | str	file to write the output to	None

Returns:

Type	Description
bytes	The output of the command

bsdf2ttree(*inp, isotropic=False, reciprocity_averaging=True, resolution=6, percent_cull=[90], super_samples=256, difference_threshold=0.35, progress_bar=False, progress_bar_length=None, maxlobes=15000, forward=False, backward=True, expr=None, file=None)

Generate XML tensor tree description of a BSDF.

Parameters:

Name	Type	Description	Default
inp	str	Path to XML file	()
isotropic	bool	Generate an isotropic ttree.	False
reciprocity_averaging	bool	Use reciprocity averaging.	True
resolution	int	resolution of the ttree.	6
percent_cull	Sequence[float]	percent of the ttree to cull.	[90]
super_samples	int	number of samples for each input-output patch pair, default=1024.	256
difference_threshold	float	difference threshold for culling.	0.35
progress_bar	bool	toggle to show progress bar.	False
progress_bar_length	None | int	length of the progress bar, default=79 characters.	None
maxlobes	int	maximum number of lobes in any interpolated radial basis function (default=15000). Setting the value to 0 turns off this limit.	15000
forward	bool	generate forward matrix (default=off).	False
backward	bool	generate backward matrixi (default=on).	True
expr	None | str	expression to evaluate.	None
file	None | str	file to write the output to	None

Returns:

Type	Description
bytes	Tensor tree BSDF XML in bytes

cnt(*dims, shuffled=False)

Index counter.

Parameters:

Name	Type	Description	Default
dims	int	list of dimensions	()
shuffled	bool	if True, the output will be shuffled	False

Returns:

Name	Type	Description
bytes	bytes	output of cnt

Examples:

>>> cnt(2, 3)
b'0 0\n0 1\n0 2\n1 0\n1 1\n1 2\n'
>>> cnt(2, 3, shuffled=True)
b'1 2\n0 1\n1 0\n0 2\n1 1\n0 0\n'

create_default_view(*args, **kwargs)

create_default_view() -> pyradiance.rad_params.View

dctimestep(*mtx, nstep=None, header=True, xres=None, yres=None, inform=None, outform=None, ospec=None)

Call dctimestep to perform matrix multiplication.

Parameters:

Name	Type	Description	Default
mtx	str | bytes	input matrices	()
nstep	None | int	number of steps	None
header	bool	include header	True
xres	None | int	x resolution	None
yres	None | int	y resolution	None
inform	None | str	input format	None
outform	None | str	output format	None
ospec	None | str	output specification	None

Returns:

Name	Type	Description
bytes	None | bytes	output of dctimestep

evalglare(inp, view=None, detailed=False, ev_only=False, ev=None, smooth=False, threshold=None, task_area=None, masking_file=None, band_lum_angle=None, check_file=None, correction_mode=None, peak_extraction=True, peak_extraction_value=50000, bg_lum_mode=0, search_radius=0.2, version=False, source_color=None, fast=None)

Run evalglare on a Radiance image.

Parameters:

Name	Type	Description	Default
inp	str | bytes | Path	input image	required
view	None | list[str]	view parameters	None
detailed	bool	detailed output	False
ev_only	bool	return vertical illuminance value	False
ev	None | float	vertical illuminance value to use instead of the one computer from the image.	None
smooth	bool	enable smoothing function.	False
threshold	None | float	Threshold factor.	None
task_area	None | tuple	task area	None
masking_file	None | str | Path	masking file	None
band_lum_angle	None | float	band luminance angle	None
check_file	None | str | Path	check file path.	None
correction_mode	None | str	correction mode	None
peak_extraction	bool	enable luminance peak extraction	True
peak_extraction_value	float	luminance peak extraction value	50000
bg_lum_mode	int	background luminance calculation mode	0
search_radius	float	search radius	0.2
version	bool	print version	False
source_color	None | tuple[float, float, float]	source color	None

Returns:

Type	Description
bytes	Evalglare output

falsecolor(inp, pic_overlay=None, contour=None, extrema=False, scale=None, digits=None, label=None, ndivs=None, lwidth=None, lheight=None, decades=None, multiplier=None, palette=None, redv=None, grnv=None, bluv=None)

Generate a falsecolor Radiance picture.

Parameters:

Name	Type	Description	Default
inp	str | Path | bytes	Path or bytes to input picture file.	required
pic_overlay	None | str	Path to another picture to overlay with contours.	None
contour	None | str	Type of contour ('b' for bands, 'l' for lines, 'p' for posterization).	None
extrema	bool	Flag to print extrema points on the brightest and darkest pixels.	False
scale	None | str	Scale for the false color (e.g., 'auto' or specific scale).	None
digits	None | int	Max number of decimal places for legend entries.	None
label	None | str	Label for the new image.	None
ndivs	None | int	Number of contours and corresponding legend entries.	None
lwidth	None | int	Width of the legend.	None
lheight	None | int	Height of the legend.	None
decades	None | int	Number of decades below the maximum scale for logarithmic mapping.	None
multiplier	None | float	Multiplier for the scale (e.g., to convert units).	None
palette	None | str	Color palette to use for false color.	None
redv	None | str	Expression for mapping values to red.	None
grnv	None | str	Expression for mapping values to green.	None
bluv	None | str	Expression for mapping values to blue.	None

Returns:

Name	Type	Description
bytes	bytes	Output of falsecolor.

genblinds(mat, name, depth, width, height, nslats, angle, rcurv=None)

Generate a RADIANCE description of venetian blinds.

Parameters:

Name	Type	Description	Default
mat	str	Material name	required
name	str	Name of the blinds	required
depth	float	Depth of the blinds	required
width	float	Width of the blinds	required
height	float	Height of the blinds	required
nslats	int	Number of slats	required
angle	float	Angle of the slats	required
rcurv	None | float	Radius of curvature of the slats, + for upward curvature, - for downward	None

Returns:

Name	Type	Description
bytes	bytes	RADIANCE description of the blinds

Examples:

>>> genblinds('mat', 'blinds', 0.1, 0.5, 1.0, 4, 45, 0.1)

genbox(mat, name, xsiz, ysiz, zsiz, inward=False, beveled=None, rounded=None, nsegs=None, smoothing=False, waveout=False)

Generate a box.

Parameters:

Name	Type	Description	Default
mat	str	material name	required
name	str	box name	required
xsiz	float	size in x dimension	required
ysiz	float	size in y dimension	required
zsiz	float	size in z dimension	required
inward	bool	box facing inward	False
beveled	None | float	beveled size	None
rounded	None | float	rounded corner size	None
nsegs	None | int	number of segments	None
smoothing	bool	to smooth	False
waveout	bool	wavefront (.obj) out	False

Returns:

Type	Description
bytes	the box

gendaylit(dt, latitude, longitude, timezone, year=None, dirnorm=None, diffhor=None, dirhor=None, dirnorm_illum=None, diffhor_illum=None, solar=False, sky_only=False, silent=False, grefl=None, interval=None)

Generates a RADIANCE description of the daylight sources using Perez models for direct and diffuse components.

Parameters:

Name	Type	Description	Default
dt	datetime	python datetime object	required
latitude	float	latitude in degrees	required
longitude	float	longitude in degrees	required
timezone	int	standard meridian timezone, e.g., 120 for PST	required
year	None | int	Need to set it explicitly, won't use year in datetime object	None
dirnorm	None | float	direct normal irradiance	None
diffhor	None | float	diffuse horizontal irradiance	None
dirhor	None | float	direct horizontal irradiance, either this or dirnorm	None
dirnorm_illum	None | float	direct normal illuminance	None
diffhor_illum	None | float	diffuse horizontal illuminance	None
solar	bool	if True, include solar position	False
sky_only	bool	sky description only	False
silent	bool	supress warnings,	False
grefl	None | float	ground reflectance	None
interval	None | int	interval for epw data	None

Returns:

Type	Description
bytes	output of gendaylit

gendaymtx(weather_data, verbose=False, header=True, average=False, sun_only=False, sky_only=False, sun_file=None, sun_mods=None, daylight_hours_only=False, dryrun=False, sky_color=None, ground_color=None, rotate=None, outform=None, onesun=False, solar_radiance=False, mfactor=1)

Generate an annual Perez sky matrix from a weather tape.

Parameters:

Name	Type	Description	Default
weather_data	str | Path | bytes	weather data	required
mfactor	int	multiplication factor	1
verbose	bool	verbose	False
header	bool	header	True
average	bool	average	False
sun_only	bool	sun only	False
sky_only	bool	sky only	False
sun_file	None | str	sun file	None
sun_mods	None | str	sun mods	None
daylight_hours_only	bool	daylight hours only	False
dryrun	bool	dryrun	False
sky_color	None | list[float]	sky color	None
ground_color	None | list[float]	ground color	None
rotate	None | float	rotate	None
outform	None | str	outform	None
onesun	bool	onesun	False
solar_radiance	bool	solar radiance	False

Returns:

Name	Type	Description
bytes	bytes	output of gendaymtx

gensdaymtx(weather_data, verbose=False, header=True, sun_only=False, sky_only=False, daylight_hours_only=False, ground_reflectance=None, rotate=None, outform=None, onesun=False, mfactor=1, nthreads=1)

Generate an annual spectral sky matrix from a weather tape.

Parameters:

Name	Type	Description	Default
weather_data	str | Path | bytes	weather data	required
mfactor	int	multiplication factor	1
verbose	bool	verbose	False
header	bool	header	True
sun_only	bool	sun only	False
sky_only	bool	sky only	False
daylight_hours_only	bool	daylight hours only	False
ground_reflectance	None | list[float]	ground color	None
rotate	None | float	rotate	None
outform	None | str	outform	None
onesun	bool	onesun	False
nthreads	int	number of threads to use for precomputations	1

Returns:

Name	Type	Description
bytes	bytes	output of gensdaymtx

gensky(dt=None, latitude=None, longitude=None, timezone=None, altitude=None, azimuth=None, year=None, sunny_with_sun=False, sunny_without_sun=False, cloudy=False, intermediate_with_sun=False, intermediate_without_sun=False, uniform=False, ground_reflectance=None, zenith_brightness=None, horizontal_brightness=None, solar_radiance=None, horizontal_direct_irradiance=None, turbidity=None)

Generate a RADIANCE description of the sky.

Parameters:

Name	Type	Description	Default
dt	None | datetime	datetime object, mutally exclusive with altitude and azimuth	None
latitude	None | float	latitude, only apply if dt is not None	None
longitude	None | float	longitude, only apply if dt is not None	None
timezone	None | int	timezone, only apply if dt is not None	None
altitude	None | float	solar altitude, mutally exclusive with dt	None
azimuth	None | float	solar azimuth, mutally exclusive with dt	None
year	None | int	year, only apply if dt is not None	None
sunny_with_sun	bool	sunny with sun	False
sunny_without_sun	bool	sunny without sun	False
cloudy	bool	CIE overcast sky	False
intermediate_with_sun	bool	intermediate with sun	False
intermediate_without_sun	bool	intermediate without sun	False
uniform	bool	uniform sky	False
ground_reflectance	None | float	ground reflectance	None
zenith_brightness	None | float	zenith brightness in watts/steradian/meter^2	None
horizontal_brightness	None | float	horizontal brightness in watts/metere^2	None
solar_radiance	None | float	solar radiance in watts/steradian/meter^2	None
horizontal_direct_irradiance	None | float	horizontal direct irradiance in watts/meter^2	None
turbidity	None | float	turbidity factor	None

Returns:

Name	Type	Description
str	bytes	output of gensky

genssky(dt, latitude=37.7, longitude=122.2, timezone=120, year=None, res=64, cloud_cover=0.0, ground_reflectance=0.2, broadband_aerosol_optical_depth=0.115, mie_file=None, nthreads=1, out_dir='.', out_name='out', dir_norm_illum=None, diff_hor_illum=None)

Generate a RADIANCE description of the spectral sky.

Parameters:

Name	Type	Description	Default
dt	datetime	datetime object, mutally exclusive with altitude and azimuth	required
latitude	float	latitude, only apply if dt is not None	37.7
longitude	float	longitude, only apply if dt is not None	122.2
timezone	int	timezone, only apply if dt is not None	120
year	None | int	year, only apply if dt is not None	None
res	int	hsr image resolution, default: 64,	64
cloud_cover	float	cloud cover 0.0: clear, 1.0: overcast,	0.0
ground_reflectance	float	default: 0.2,	0.2
broadband_aerosol_optical_depth	float	default: 0.115,	0.115
mie_file	None | str	mie scattering coefficient source file	None
nthreads	int	number of threads used for precomputation, default:1,	1
out_dir	str	directory to save precomputed data that can be reused, default to current working directory. This can be changed to RAYPATH for cross-section data reused.	'.'
out_name	str	output file name, defautl: "out"	'out'
dir_norm_illum	None | float	direct normal illuminance to calibrate the output against,	None
diff_hor_illum	None | float	diffuse horizontal illuminance to calibrate the output against.	None

Returns:

Name	Type	Description
str	bytes	output of gensky

get_default_ray_params(*args, **kwargs)

get_default_ray_params() -> pyradiance.rad_params.RayParams

get_header(inp, dimension=False)

Get header information from a Radiance file.

Parameters:

Name	Type	Description	Default
inp	str | Path | bytes	input file or bytes	required

Returns:

Name	Type	Description
bytes	bytes	header

get_image_dimensions(image)

Get the dimensions of an image.

Parameters:

Name	Type	Description	Default
image	str | Path | bytes	image file path or image bytes	required

Returns:

Type	Description
tuple[int, int]	Tuple[int, int]: width and height

get_ray_params_args(*args, **kwargs)

get_ray_params_args(arg: pyradiance.rad_params.RayParams, /) -> list

Returns a list of strings given a RayParams object

get_view_args(*args, **kwargs)

get_view_args(arg: pyradiance.rad_params.View, /) -> list

Returns a list of string for the view

getinfo(*inputs, dimension_only=False, dimension=False, strip_header=False, replace='', append='', command='')

Get header information from a Radiance file.

Parameters:

Name	Type	Description	Default
inputs	tuple[str | Path | bytes, ...]	input file or bytes	()
dimension_only	bool	return only the dimension	False
dimension	bool	return the dimension	False
strip_header	bool	strip header from the output	False
replace	str	replace the header with this string	''
append	str	append this string to the header	''
command	str	command to use to get the header	''

Returns:

Type	Description
bytes	getinfo output

ies2rad(*inp, libdir=None, prefdir=None, outname=None, stdout=False, units=None, radius=None, instancing_geometry=False, lampdat=None, lamp_type=None, lamp_color=None, set_default_lamp_color=None, multiply_factor=None)

Convert IES luminaire data to RADIANCE description.

Parameters:

Name	Type	Description	Default
inp	tuple[str | Path, ...]	Path to IES file	()
libdir	None | str	Path to directory where the library files are located.	None
prefdir	None | str	Set the library subdirectory.	None
outname	None | str	Output file name root.	None
stdout	bool	Print the output to stdout.	False
units	None | str	Set the units of the output file.	None
radius	None | float	ignore the crude geometry given by the IES input file and use instead an illum sphere with radius rad.	None
instancing_geometry	bool	compile MGF detail geometry into a separate octree and create a single instance referencing it.	False
lampdat	None | str	map lamp name to xy chromaticity and lumen depreciation data.	None
lamp_type	None | str	lamp type.	None
lamp_color	None | str	set lamp color to red green blue if lamp type is unknown.	None
set_default_lamp_color	None | str	set default lamp color according to the entry for lamp in the lookup table.	None
multiply_factor	None | float	multiply all output quantities by this factor. This is the best way to scale fixture brightness for different lamps.	None

Returns:

Type	Description
bytes	The output of the command

load_material_smd(file, roughness=0.0, spectral=False, metal=False)

Generate Radiance primitives from csv file from spectral material database (spectraldb.com).

Parameters:

Name	Type	Description	Default
file	Path	Path to .csv file	required
roughness	float	Roughtness of material	0.0
spectral	bool	Output spectral primitives	False
metal	bool	Whether material is metal	False

Returns:

Type	Description
list[Primitive]	A list of primitives

mgf2rad(*inp, matfile=None, mult=None, dist=None)

Convert Materials and Geometry Format file to RADIANCE description.

Parameters:

Name	Type	Description	Default
inp	str	Path to MGF file	()
matfile	None | str	Path to material file where the translated materials will be written.	None
mult	None | float	multiplier for all the emission values	None
dist	None | float	glow distance (in meters) for all emitting surfaces.	None

Returns:

Type	Description
bytes	The output of the command

mkillum(inp, octree, nproc=1, params=None)

Compute illum sources for a RADIANCE scene

Parameters:

Name	Type	Description	Default
inp	bytes	input file content as bytes	required
octree	str | Path	octree file	required
nproc	int	number of processes	1
params	None | Sequence[str]	additional parameters	None

Returns:

Type	Description
bytes	Output of mkillum in bytes

mkpmap(octree, global_map=None, caustic_map=None, volume_map=None, direct_map=None, contrib_map=None, pre_global_map=None, predistrib=None, rect_region=None, sphere_region=None, maxbounce=None, maxprepass=None, port_mod=None, port_modfile=None, precomp=None, seed=None, virtual_mod=None, virtual_modfile=None, amb_excl_mod=None, amb_excl_modfile=None, amb_incl_mod=None, amb_incl_modfile=None, backface_vis=False, sample_res=None, partition_size=None, progress_file=None, overwrite=False, maxdist=None, scattering_albedo=None, extinction_coefficient=None, scattering_eccentricity=None, nproc=1, progress_interval=None)

Mkpmap takes a RADIANCE scene description as an octree and performs Monte Carlo forward path tracing from the light sources, depositing indirect ray hitpoints along with their energy (flux) as "photons". The resulting localised energy distribution represents a global illumination solution which is written to a file for subsequent evaluation by rpict(1), rtrace(1) and rvu(1) in a backward raytracing pass. The photon map(s) can be reused for multiple viewpoints and sensor locations as long as the geometry remains unchanged. Args: octree: Octree file path. global_map: Global map file path and number of photons. caustic_map: Caustic map file path and number of photons. volume_map: Volume map file path and number of photons. direct_map: Direct map file path and number of photons. contrib_map: Contribution map file path and number of photons. pre_global_map: Precomputed global map file path, number of photons and bandwidth. predistrib: Photon predistribution factor. rect_region: Rectangular region sphere_region: Spherical region maxbounce: Maximum number of bounces. maxprepass: Maximum number of iteratiosn of distributoin prepass before terminating. port_mod: Specifies a modifier to act as a photon port. port_modfile: File with modifiers to act as photon ports. precomp: Fraction of global photons to precompute. seed: Random seed. virtual_mod: Specifies a modifier to act as a virtual source. virtual_modfile: File with modifiers to act as virtual sources. amb_excl_mod: Specifies a modifier to exclude from ambient calculation. amb_excl_modfile: File with modifiers to exclude from ambient calculation. amb_incl_mod: Specifies a modifier to include in ambient calculation. amb_incl_modfile: File with modifiers to include in ambient calculation. backface_vis: Backface visibility. sample_res: Sample resolution.

obj2mesh(inp, matfiles=None, matlib=None, objlim=9, maxres=16384, silent=False, stats=False)

Convert Wavefront .OBJ file to RADIANCE description.

Parameters:

Name	Type	Description	Default
inp	bytes | str | Path	Path to OBJ file, or bytes	required
matfiles	None | Sequence[str]	Radiance material files to use	None
matlib	None | str	Radiance material library file, RAYPATH are searched	None
objlim	int	the maximum surface setsize for each voxel	9
maxres	int	Maximum octree resolution	16384
silent	bool	Suppress warnings	False
stats	bool	Print statistics	False

Returns:

Type	Description
bytes	The converted RADIANCE scene description in bytes

obj2rad(inp, quallist=False, flatten=False, mapfile=None, objname=None)

Convert Wavefront .OBJ file to RADIANCE description.

Parameters:

Name	Type	Description	Default
inp	bytes | str | Path	Path to OBJ file	required
quallist	bool	Produce a list of qualifiers from which to construct a mapping for the given .OBJ file.	False
flatten	bool	Flatten all faces, effectively ignoring vertex normal information.	False
mapfile	None | str	Mapping rules files for assigning material names for the surfaces.	None
objname	None | str	Specify the name of this object, though it will be overriden by any "o" statements in the input file. If this option is absent, and there are no "o" statements, obj2rad will attempt to name surfaces based on their group associations.	None

Returns:

Type	Description
bytes	The converted RADIANCE scene description in bytes

oconv(*paths, warning=True, stdin=None, frozen=False, octree=None)

Run Radiance oconv tool to build an octree.

Parameters:

Name	Type	Description	Default
paths	str	list of Radiance files	()
warning	bool	if False, warnings will be suppressed	True
stdin	None | bytes	if not None, stdin will be used	None
frozen	bool	if True, the octree will be frozen	False
octree	None | str | Path	if provided, the resulting octree incorporate existing one	None

Returns:

Name	Type	Description
bytes	bytes	output of oconv

pabopto2bsdf(*inp, nproc=1, symmetry=None, angle=None, reverse=False)

Convert BSDF measurements to a scattering interpolant representation.

Parameters:

Name	Type	Description	Default
inp	str	pab-opto Mountain files, need two or more.	()
nproc	int	number of processors to use.	1
symmetry	None | str	BSDF symmetry, which is one of "isotropic", "quadrilateral", "bilateral", "up", or "anisotropic". Any of these may be abbreviated with as little as a single letter, and case is ignored.	None
angle	None | float	cull scattered measurements that are nearer to grazing than the given angle in degrees. If the word "auto" (which can be abbreviated as 'a' or 'A') is given instead of an angle, then the near-grazing angle will be determined by the lowest incident angle measurement present in the input data. This is sometimes necessary to eliminate noise and edge effects that some measurements exhibit near grazing.	None
reverse	bool	reverses the assumed sample orientation front-to-back, and is discussed below under the "#intheta" header entry.	False

Returns:

Type	Description
bytes	SIR data in bytes

parse_primitive(pstr)

Parse Radiance primitives inside a file path into a list of dictionary.

Parameters:

Name	Type	Description	Default
pstr	str	A string of Radiance primitives.	required

Returns:

Type	Description
list[Primitive]	list of primitives

parse_view(*args, **kwargs)

parse_view(arg: str, /) -> pyradiance.rad_params.View

Parse a view string into a View object

pcompos(inputs, pos=None, xres=None, yres=None, spacing=0, background=None, anchors=None, header=True, lower_threashold=None, upper_threshold=None, label=None, label_height=None, ncols=None, anchor_point=None)

Composite Radiance pictures

Parameters:

Name	Type	Description	Default
inputs	Sequence[Path | str | bytes]	list of input files	required
pos	None | Sequence[Sequence[float]]	list of positions	None
xres	None | int	horizontal resolution	None
yres	None | int	vertical resolution	None
spacing	int	spacing between images	0
background	None | tuple[float, float, float]	background color	None
anchors	None | Sequence[str]	list of anchors	None
header	bool	set to False if want to reduce header	True
lower_threashold	None | float	lower threshold	None
upper_threshold	None | float	upper threshold	None
label	None | str	label	None
label_height	None | int	label height	None
ncols	None | int	number of columns	None
anchor_point	None | Sequence[str]	anchor point	None

Returns:

Name	Type	Description
bytes	bytes	output of pcompos

pcond(hdr, human=False, acuity=False, veiling=False, sense=False, closs=False, center_weighted=False, linear=False, fixfrac=0.0, fixpoints=None, histo='', expval='', ldmax=100.0, lddyn=100.0, primaries=None, macbeth='', mapfile='')

Condition a Radiance picture.

Parameters:

Name	Type	Description	Default
hdr	Path	input hdr	required
human	bool	Mimic human visual response. This is the same as turning on all acuity, veiling, sensitivity, and color loss.	False
acuity	bool	Defocus darker region.	False
veiling	bool	Add veiling glare.	False
sense	bool	Use human contrast sensitivity, simulating eye internal scattering.	False
center_weighted	bool	Use center-weighted average for acuity and veiling.	False
linear	bool	Use a linear reponse function instead of the standard dynamic range compression. This preseves the extremas.	False
fixfrac	float	Fixation fraction for acuity and veiling.	0.0
histo	str	Histogram file for acuity and veiling.	''
expval	str	Exposure value for acuity and veiling.	''
ldmax	float	Maximum luminance for acuity and veiling.	100.0
lddyn	float	Luminance dynamic range for acuity and veiling.	100.0
primaries	None | list[float]	Color primaries for color loss.	None
macbeth	str	Macbeth chart file for color loss.	''
mapfile	str	Color map file for color loss.	''

Returns:

Name	Type	Description
bytes	bytes	output of pcond

pfilt(image, xres=None, yres=None, pixel_aspect=0, pa_correct=False, exposure=0, lamp=None, lampdat=None, one_pass=False, gaussian_filter_radius=None, limitfrac=None, hot_threshold=100, star_points=0, star_spread=0.0001, average_hot=False)

filter a Radiance picture. By default, it uses two passes on the input, using a box filter.

Parameters:

Name	Type	Description	Default
image	str | Path | bytes	input image	required
xres	None | str	horizontal resolution	None
yres	None | str	vertical resolution	None
pixel_aspect	float	pixel aspect ratio	0
exposure	None | float	exposure value	0
lamp	None | str	lamp file	None
lampdat	None | str	lamp data file	None
one_pass	bool	use one pass filter	False
gaussian_filter_radius	None | float	gaussian filter radius	None
limitfrac	None | float	limit fraction	None
hot_threshold	float	Set intensity considered 'hot', default 100 watts/sr/m2	100
star_points	int	Number of points on a start pattern.	0
star_spread	float	star pattern spread	0.0001
average_hot	bool	average hot spots	False

Returns:

Name	Type	Description
bytes	bytes	output of pfilt

pkgbsdf(*xml, frozen=False, stdout=False)

Pacakge BSDFs provided as XML for Radiance.

Parameters:

Name	Type	Description	Default
xml	tuple[str | Path, ...]	Path to XML files	()
frozen	bool	produce frozen octree instance for any detail geometry.	False
stdout	bool	print the output to stdout, only works for a single XML input.	False

Returns:

Type	Description
None | bytes	The output of the command

pvalue(pic, unique=False, original=False, header=True, resstr=True, skip=0, exposure=0, gamma=1.0, dataonly=False, outform='', reverse_rgb=False, interleaving=True, brightness=False, outprimary=None)

convert RADIANCE picture to/from alternate formats Pvalue converts the pixels of a RADIANCE picture to or from another format. In the default mode, pixels are sent to the standard output, one per line, in the following ascii format: xpos ypos red green blue

Parameters:

Name	Type	Description	Default
pic	Path | str | bytes	hdr file path. Either path or stdin is used, path takes precedence.	required
unique	bool	if True, only unique values will be returned	False
original	bool	if True, print original values, before exposure compensation	False
header	bool	if True, header will be returned	True
resstr	bool	if True, resolution string will be returned	True
skip	int	number of bytes to skip	0
exposure	int	exposure value	0
gamma	float	gamma value	1.0
dataonly	bool	if True, only data will be returned	False
outform	str	output data format	''
reverse_rgb	bool	if True, RGB values will be reversed	False
interleaving	bool	if True, interleaving will be used	True
brightness	bool	if True, only brightness will be returned	False
outprimary	None | str	output color primaries	None

Returns:

Name	Type	Description
bytes	bytes	output of pvalue

pvaluer(pic, xres=None, yres=None, inform='a', resstr=True, dataonly=False, header=True, primaries=None, pxyz=False)

Run Radiance pvalue tools reverse mode: constructing a image from pixel values.

Parameters:

Name	Type	Description	Default
pic	Path | str | bytes	Path or bytes of the input pixel data.	required
xres	None | int	X resolution.	None
yres	None | int	Y resolution.	None
inform	str	input data format. Default is "a" for ascii.	'a'
header	bool	Set to True if the picture file has a header. Default is False.	True
primaries	None | list[float]	list of primaries for XYZ calculation. Default is None.	None
pxyz	bool	Set to True to calculate XYZ values. Default is False.	False

Returns:

Type	Description
bytes	Bytes of the pvalue output

ra_ppm(inp, gamma=2.2, greyscale=False, reverse=False, exposure=0, ascii=False, outscale=255)

convert RADIANCE picture to/from a Poskanzer Portable Pixmap

Parameters:

Name	Type	Description	Default
inp	str | Path | bytes	Path or bytes to input picture file.	required
gamma	float	Gamma value for the output image. Default is 2.2.	2.2
reverse	bool	Set to True to invoke a reverse conversion, from a PPM to a RADIANCE picture. Default is False.	False
exposure	int	Exposure value for the output image. Default is 0.	0
ascii	bool	Set to True to use ASCII Pixmap output. Default is False.	False
outscale	int	Output scale value. Default is 255.	255

Returns:

Name	Type	Description
bytes	bytes	output of ra_ppm

ra_tiff(inp, out=None, gamma=2.2, greyscale=False, lzw=False, sgilog=False, sgilog24=False, ieee32=False, primary=False, exposure=0, reverse=False, xyze=False)

ra_tiff - convert RADIANCE picture to/from a TIFF color or greyscale image

Parameters:

Name	Type	Description	Default
inp	str | Path | bytes	Path or bytes to input picture file.	required
out	None | str	Path to output file, required when output is a TIFF file.	None
gamma	float	Gamma value for the output image. Default is 2.2.	2.2
greyscale	bool	Set to True to convert to greyscale. Default is False.	False
lzw	bool	Set to True to use LZW compression. Default is False.	False
sgilog	bool	Set to True to use SGI log compression. Default is False.	False
sgilog24	bool	Set to True to use SGI log 24 compression. Default is False.	False
ieee32	bool	Set to True to use IEEE 32-bit floating point compression.	False
primary	bool	Set to True to use 16-bit/primary output. Default is False.	False
reverse	bool	Set to True to invoke a reverse conversion, from a TIFF to a RADIANCE picture. Default is False.	False
xyze	bool	Set to True to use XYZE output when invoking a reverse conversion. Default is False.	False

Returns:

Name	Type	Description
bytes	None | bytes	output of ra_tiff

rcalc(inp, sep=None, inform=None, incount=1, outform=None, passive=False, pass_negative=False, inlimit=None, outlimit=None, source=None, expr=None, assign=None, exact_only=False, ignore_newlines=False, silent=False)

Run rcalc

Parameters:

Name	Type	Description	Default
inp	str | Path | bytes	input data	required
sep	None | str	separator	None
inform	None | str	input format	None
incount	int	input count	1
outform	None | str	output format	None
passive	bool	passive mode	False
pass_negative	bool	pass negative	False
inlimit	None | int	input limit	None
outlimit	None | int	output limit	None
source	None | str	source file	None
expr	None | str	expression	None
assign	None | str	assign	None
exact_only	bool	exact only	False
ignore_newlines	bool	ignore newlines	False
silent	bool	silent	False

Returns:

Name	Type	Description
bytes	bytes	output of rcalc

rcode_depth(inp, ref_depth='1.0', inheader=True, outheader=True, inresolution=True, outresolution=True, xres=None, yres=None, inform='a', outform='a', decode=False, compute_intersection=False, per_point=False, depth_file=None, flush=False)

Encode/decode 16-bit depth map.

Parameters:

Name	Type	Description	Default
inp	str | Path | bytes	input file or bytes	required
ref_depth	str	reference distance, can be follow by /unit.	'1.0'
inheader	bool	Set to False to not expect header on input	True
outheader	bool	Set to False to not include header on output	True
inresolution	bool	Set to False to not expect resolution on input	True
outresolution	bool	Set to False to not include resolution on output	True
xres	None | int	x resolution	None
yres	None | int	y resolution	None
inform	str	input format	'a'
outform	str	output format when decoding	'a'
decode	bool	Set to True to decode instead	False
compute_intersection	bool	Set to True to compute intersection instead	False
per_point	bool	Set to True to compute per point instead of per pixel	False
depth_file	None | str	depth file	None
flush	bool	Set to True to flush output	False

Returns:

Name	Type	Description
bytes	bytes	output of rcode_depth

rcode_ident(inp, index_size=16, sep='\n', decode=False, header=True, xres=None, yres=None, resstr=True, identifiers=False, indexes=False, per_point=False, flush=False)

Store identifiers in an indexed map and retrieve from same

Parameters:

Name	Type	Description	Default
inp	str | Path | bytes	input file or bytes	required
index_size	int	index size	16
sep	str	separator	'\n'
decode	bool	Set to True to decode instead	False
header	bool	Set to False to not to expect header on input; or not to include header on output when decoding	True
xres	None | int	x resolution	None
yres	None | int	y resolution	None
resstr	bool	Set to False to not include resolution string on output	True
identifiers	bool	Set to True to include identifiers on output	False
indexes	bool	Set to True to instead list identifiers indexes on output	False
per_point	bool	Set to True to compute per point instead of per pixel	False
flush	bool	Set to True to flush output after each identifier	False

Returns:

Name	Type	Description
bytes	bytes	output of rcode_ident

rcode_norm(inp, inheader=True, outheader=True, inresolution=True, outresolution=True, xres=None, yres=None, inform='a', outform='a', decode=False, per_point=False, norm_file=None, flush=False)

Encode/decode 32-bit surface normal map.

Parameters:

Name	Type	Description	Default
inp	str | Path | bytes	input file or bytes	required
inheader	bool	Set to False to not expect header on input	True
outheader	bool	Set to False to not include header on output	True
inresolution	bool	Set to False to not expect resolution on input	True
outresolution	bool	Set to False to not include resolution on output	True
xres	None | int	x resolution	None
yres	None | int	y resolution	None
inform	str	input format	'a'
outform	str	output format when decoding	'a'
decode	bool	Set to True to decode instead	False
per_point	bool	Set to True to compute per point instead of per pixel	False
flush	bool	Set to True to flush output	False

Returns:

Name	Type	Description
bytes	bytes	output of rcode_norm

render(scene, view=None, quality='Medium', variability='Medium', detail='Medium', nproc=1, ncssamp=3, resolution=None, ambbounce=0, ambcache=True, params=None)

Render a scene.

Parameters:

Name	Type	Description	Default
scene	Scene	Scene object.	required
quality	str	Quality level.	'Medium'
variability	str	Variability level.	'Medium'
detail	str	Detail level.	'Medium'
nproc	int	Number of processes to use.	1
ncssamp	int	Number of channels to sample	3
ambbounce	int	Number of ambient bounces.	0
ambcache	bool	Use ambient cache.	True
params	None | RayParams	Sampling parameters.	None

Returns:

Type	Description
bytes	tuple[bytes, int, int]: output of render, width, height

rfluxmtx(receiver, surface=None, rays=None, params=None, octree=None, scene=None)

Run rfluxmtx command.

Parameters:

Name	Type	Description	Default
receiver	str | Path	receiver file path	required
surface	None | str | Path	input surface file path, mutually exclusive with rays	None
rays	None | bytes	input rays bytes, mutually exclusive with surface	None
params	None | Sequence[str]	ray tracing parameters	None
octree	None | Path | str	octree file path	None
scene	None | Sequence[Path | str]	list of scene files	None

Returns:

Type	Description
bytes	The results of rfluxmtx in bytes

rlam(*inputs)

Laminate records from multiple files.

Parameters:

Name	Type	Description	Default
inputs	str | Path | bytes	list of input files or bytes. There can only be one bytes input.	()

Returns:

Name	Type	Description
bytes	bytes	output of rlam

rmtxop(inp, outform='a', transpose=False, scale=None, transform=None, reflectance=None)

Run rmtxop command.

Parameters:

Name	Type	Description	Default
inp	str | Path | bytes	input	required
outform	str	output format: 'a', 'f', 'd', 'c'	'a'
transpose	bool	whether to transpose matrix	False
scale	None | float	scaling factor	None
transform	None | Sequence[float]	transform factors for each channel	None

Returns:

Type	Description
bytes	The results of rmtxop in bytes

robjutil(inp, radout=False, verbose=False, remove_texture_coordinates=False, remove_surface_normal=False, remove_surface_by_modifier=None, keep_surface_by_modifier=None, remove_surface_by_group=None, keep_surface_by_group=None, epsilon=None, triangulate=False, transform=None)

Operate on Wavefront .OBJ file

Parameters:

Name	Type	Description	Default
inp	str | Path	Input .OBJ file path	required
radout	bool	Output RADIANCE scene description	False
verbose	bool	Set to True to turn on verbosity	False
remove_texture_coordinates	bool	Remove texture coordinates from the output	False
remove_surface_normal	bool	Remove surface normal from the output	False
remove_surface_by_modifier	None | Sequence[str]	Remove surfaces by modifier, mutually exclusive with keep_surface_by_modifier	None
keep_surface_by_modifier	None | Sequence[str]	Keep surfaces by modifier, mutually exclusive with remove_surface_by_modifier	None
remove_surface_by_group	None | Sequence[str]	Remove surfaces by group/object, mutually exclusive with keep_surface_by_group	None
keep_surface_by_group	None | Sequence[str]	Keep surfaces by group/object, mutually exclusive with remove_surface_by_group	None
epsilon	None | float	Coalesce vertices that are within the given epsilon	None
triangulate	bool	Turns all faces with 4 or more sides into triangles	False
transform	None | str	Transform the input, using xform CLI syntax.	None

Returns:

Type	Description
bytes	The output of the command

rpict(view, octree, xres=None, yres=None, report=0, report_file=None, params=None)

Get rpict command.

Parameters:

Name	Type	Description	Default
view	Sequence[str]	A list of view parameters in strings.	required
octree	Path | str	A path to octree file.	required
xres	None | int	X resolution.	None
yres	None | int	Y resolution.	None
report	float	Report.	0
report_file	None | Path	Report file.	None
params	None | Sequence[str]	A list of additional parameters.	None

Returns:

Type	Description
bytes	A bytes object.

rsensor(sensor, sensor_view=None, direct_ray=None, ray_count=None, octree=None, nproc=1, params=None)

Compute sensor signal from a RADIANCE scene

Parameters:

Name	Type	Description	Default
sensor	Sequence[str | Path]	Sensor file	required
sensor_view	None | Sequence[str | Path]	Sensor view file	None
direct_ray	None | Sequence[int]	The number of rays sent to each light source per sensor	None
ray_count	None | Sequence[int]	The number of ray samples sent at random	None
octree	None | str | Path	Octree file	None
nproc	int	Number of processors to use	1
params	None | Sequence[str]	Additional parameters for rsensor command	None

Returns:

Type	Description
bytes	Output of rsensor command

rtrace(rays, octree, header=True, inform='a', outform='a', irradiance=False, irradiance_lambertian=False, outspec=None, trace_exclude='', trace_include='', trace_exclude_file=None, trace_include_file=None, uncorrelated=False, xres=None, yres=None, nproc=None, params=None, report=False, version=False)

Run rtrace.

Parameters:

Name	Type	Description	Default
rays	bytes	A string of bytes representing the input rays.	required
octree	Path | str	Path to octree file.	required
header	bool	A boolean to indicate if the header should be included in the output.	True
inform	str	Input format. Default is 'a'.	'a'
outform	str	Output format. Default is 'a'.	'a'
irradiance	bool	A boolean to indicate if irradiance should be calculated.	False
irradiance_lambertian	bool	A boolean to indicate if irradiance should be calculated using Lambertian assumption.	False
outspec	None | str	Output specification. Default is None.	None
trace_exclude	str	A string of space separated material names to exclude from the trace.	''
trace_include	str	A string of space separated material names to include in the trace.	''
trace_exclude_file	None | str | Path	Path to a file containing material names to exclude from the trace.	None
trace_include_file	None | str | Path	Path to a file containing material names to include in the trace.	None
uncorrelated	bool	A boolean to indicate if uncorrelated sampling should be used.	False
xres	None | int	X resolution of the output image.	None
yres	None | int	Y resolution of the output image.	None
nproc	None | int	Number of processors to use.	None

Returns:

Type	Description
bytes	A string of bytes representing the output of rtrace.

spec_xyz(*args, **kwargs)

spec_xyz(arg0: collections.abc.Sequence[float], arg1: float, arg2: float, /) -> tuple

total(inp, mean=False, sumpower=0, multiply=False, find_max=False, find_min=False, inform=None, incount=1, outform=None, substep=None, substep_reset=True, inlimit=None, outlimit=None, sep=None)

Sum up columns.

Parameters:

Name	Type	Description	Default
inp	None | str | Path	input file or bytes	required
mean	bool	if True, the mean value will be calculated	False
sumpower	int	the power of the sum, mutally exclusive with multiply, find_max, and find_min	0
multiply	bool	if True, the values will be multiplied, mutally exclusive with sumpower, find_max, and find_min	False
find_max	bool	if True, the maximum value will be found, mutally exclusive with sumpower, multiply, and find_min	False
find_min	bool	if True, the minimum value will be found, mutally exclusive with sumpower, multiply, and find_max	False
inform	None | str	input format	None
incount	int	number of input values	1
outform	None | str	output format	None
substep	None | int	substep	None
substep_reset	bool	if True, the substep will be reset	True
inlimit	None | int	input limit	None
outlimit	None | int	output limit	None
sep	None | str	separator	None

Returns:

Name	Type	Description
bytes	bytes	output of total

viewfile(*args, **kwargs)

viewfile(arg: str, /) -> pyradiance.rad_params.View

Read a view file into a View object

vwrays(pixpos=None, unbuf=False, outform='a', ray_count=1, pixel_jitter=0, pixel_diameter=0, pixel_aspect=1, xres=512, yres=512, dimensions=False, view=None, pic=None, zbuf=None)

vwrays.

write(file_path, data, overwrite=True, mode='wb')

Write data to a file.

Parameters:

Name	Type	Description	Default
file_path	str | Path	path to file	required
data	str | bytes	data to write	required
overwrite	bool	if True, overwrite the file if it already exists	True
mode	str	'w' for text, 'wb' for binary	'wb'

Returns:

Name	Type	Description
str	str	path to file

xyz_rgb(*args, **kwargs)

xyz_rgb(arg0: float, arg1: float, arg2: float, /) -> tuple