--- ray/doc/man/man1/rsensor.1 2008/04/15 00:14:22 1.1 +++ ray/doc/man/man1/rsensor.1 2012/06/14 22:42:21 1.5 @@ -1,4 +1,4 @@ -.\" RCSid "$Id: rsensor.1,v 1.1 2008/04/15 00:14:22 greg Exp $" +.\" RCSid "$Id: rsensor.1,v 1.5 2012/06/14 22:42:21 greg Exp $" .TH RSENSOR 1 4/11/2008 RADIANCE .SH NAME rsensor - compute sensor signal from a RADIANCE scene @@ -7,7 +7,9 @@ rsensor - compute sensor signal from a RADIANCE scene [ .B -n nprocs ][ -.B rtrace options +.B -h +][ +.B render options ] [ .B $EVAR @@ -27,6 +29,20 @@ rsensor - compute sensor signal from a RADIANCE scene } .B octree .br +.B rsensor +[ +.B -h +] +{ +[ +.B -rd nrays +][ +.B sensor_view +] +.B sensor_file .. +} +.B "." +.br .B "rsensor [ options ] \-defaults" .SH DESCRIPTION .I Rsensor @@ -36,7 +52,12 @@ sensors into the RADIANCE scene given by sending the computed sensor value to the standard output. (The octree may be given as the output of a command enclosed in quotes and preceded by a `!'.)\0 -In the second form, the default values +In the second form, a single period ('.') is given in place of an +octree, and the origin and directions of the specified +number of rays will be printed on the standard output. +If these rays are later traced and added together, the results +will sum to a signal proportional to the given sensor distribution. +In the third form, the default values for the options (modified by those options present) are printed with a brief explanation. .PP @@ -58,8 +79,10 @@ Before each sensor file, a separate view may be specif In this case, the view origin and direction will correspond to the position and orientation of the sensor, and the view up vector will determine the zero azimuthal direction of the sensor. +The fore clipping distance may be used as well, but other view +options will be ignored. (See -.I rpict\.1 +.I rpict(1) for details on how to specify a view.)\0 The actual data contained in the sensor file corresponds to the .I SPOT @@ -82,14 +105,17 @@ sensors, where the .I \-rd option controls the number of ray samples sent at random, and the .I \-dn -option controls the number of rays sent to light sources per sensor. +option controls the number of rays sent to each light source per sensor. .PP The +.I \-h +option toggles header output, which defaults to "on." +The .I \-n option may be used to specify multiple calculation processes on systems with more than one CPU. For additional options, consult the -.I rtrace\.1 +.I rtrace(1) man page. The final .I octree @@ -99,9 +125,14 @@ standard input. To compute values for the same sensor with two different positions: .IP "" .2i rsensor -ab 2 -vf posA.vf mysens.dat -vf posB.vf mysens.dat scene.oct +.PP +To generate a set of rays corresponding to a given sensor and compute +the resulting signal with rtrace: +.IP "" .2i +rsensor -h -vf posC.vf mysens.dat . | rtrace -h scene.oct | total -m .SH ENVIRONMENT RAYPATH the directories to check for auxiliary files. .SH AUTHOR Greg Ward for Architectural Energy Corporation .SH "SEE ALSO" -oconv(1), rpict(1), rtcontrib(1), rtrace(1) +oconv(1), rpict(1), rcontrib(1), rtrace(1)