[ViewVC] Annotation of: radiance/ray/doc/notes/compile_switches

Here is a list of compile switches, used to customize Radiance code
for specific machines and users:

-DALIGNT=(type) Alignment type, machine-dependent.  Most RISC
                architectures align on 8-word boundaries (double).
                The default alignment type is int.

-DWFLUSH=(rays) Override for number of rays before flush in rvu.

-DBSD           Operating system has a strong Berkeley flavor, which
                affects certain system calls, such as signal handling and
                resource tracking.

-DSMLMEM        The system has little RAM available, so size hash
                tables and the like accordingly.  Only allows for
                small scene descriptions (32,256 primitives).

-DSMLFLT        This setting tells Radiance to use short floats
                (32 bits) throughout, which saves lots of memory
                but can cause calculation inaccuracies in many
                cases.  Its use has been discontinued for this reason.

-DSHADCACHE=N   The array size to use for caching occluders.
                Setting this to 0 turns off this optimization.
                Values greater than 20 use over 4 Kbytes per
                light source, which can add up to a lot of
                memory in scenes with many sources.

-DAVGREFL=R     Set the average surface reflectance for the purpose
                of indirect irradiance calculations to R, where
                R is a real number in the range (0,1.0).  The
                default value is 0.50 (50%).

-DPMAP_OOC      Builds the out-of-core photon map. The photon data resides
                in a leaf file on disk with suffix ".leaf" and is loaded on
                demand. This is intended for very large photon maps (up to
                4.3 billion photons) particularly for annual simulations
                with rcontrib. This switch is disabled by default, which
                builds the in-core photon map used in previous releases;
                this resides entirely in main memory. These options are
                mutually exclusive, and the resulting photon map files are
                incompatible.
                
-DPMAP_PRIMARYPOS       
                Stores photon primary hitpoints for binning using the -f
                option with rcontrib if the function file requires them.
                This consumes an additional 3 floats and is disabled per
                default to reduce the size of the resulting photon maps.
                
-DPMAP_FLOAT_FLUX
                Stores photon flux as floats instead of more compact RGBE
                (the default). In terms of accuracy, the difference would
                only be noticeable with highly saturated colours.
                
-DPMAP_ROI      Enables the -api option to mkpmap. This constrains photon
                deposition only to the specified region of interest (defined
                as a bounding volume) for situations where it is known a
                priori that photon map lookups will occur outside this
                region. This is disabled per default as it can lead to
                biased results outside the ROI, or near its boundaries. Ziss
                option for ze eckspertz only!

-DPMAP_RUNAWAY_WARN
                Causes mkpmap to issue a warning if a photon reaches the
                maximum number of bounces (as specified with -apm) and is
                terminated.
                                
-DPMAP_LOOKUP_WARN
                Causes rtrace et al to issue warnings when short photon
                lookups occur, i.e.  fewer photons are found than specified
                as lookup bandwidth with -ap.  This is generally not fatal,
                but can increase noise, and may indicate a higher bandwidth
                is needed. This is disabled per default as it can result in
                excessive console clutter.

-DPMAP_LOOKUP_REDO
                Causes rtrace et al to repeat short photon map
                lookups with a progressively larger radius until the
                target photon count specified with -ap is met. This switch
                has no effect in conjunction with the -am option, since this
                disables lookup radius adaptation.

-DPMAP_EPANECHNIKOV
                Causes rtrace et al to apply an Epanechnikov filter during 
                photon density estimates. This weights photons according to
                the inverse distance to the lookup point in order to reduce
                bias. The default behaviour does not perform filtering.
Revision:	1.7
Committed:	Mon May 30 12:21:56 2016 UTC (8 years, 11 months ago) by rschregle
Branch:	MAIN
Changes since 1.6:	+55 -0 lines
Log Message:	Documented PMAP options in compile_switches
#	User	Rev	Content
1	greg	1.1	Here is a list of compile switches, used to customize Radiance code
2			for specific machines and users:
3
4	greg	1.6	-DALIGNT=(type) Alignment type, machine-dependent. Most RISC
5	greg	1.1	architectures align on 8-word boundaries (double).
6			The default alignment type is int.
7
8	greg	1.2	-DWFLUSH=(rays) Override for number of rays before flush in rvu.
9	greg	1.1
10	greg	1.6	-DBSD Operating system has a strong Berkeley flavor, which
11	schorsch	1.5	affects certain system calls, such as signal handling and
12			resource tracking.
13	greg	1.1
14	greg	1.2	-DSMLMEM The system has little RAM available, so size hash
15			tables and the like accordingly. Only allows for
16			small scene descriptions (32,256 primitives).
17	greg	1.1
18			-DSMLFLT This setting tells Radiance to use short floats
19	greg	1.2	(32 bits) throughout, which saves lots of memory
20	greg	1.1	but can cause calculation inaccuracies in many
21			cases. Its use has been discontinued for this reason.
22	greg	1.2
23			-DSHADCACHE=N The array size to use for caching occluders.
24			Setting this to 0 turns off this optimization.
25			Values greater than 20 use over 4 Kbytes per
26			light source, which can add up to a lot of
27			memory in scenes with many sources.
28	greg	1.3
29			-DAVGREFL=R Set the average surface reflectance for the purpose
30			of indirect irradiance calculations to R, where
31			R is a real number in the range (0,1.0). The
32	greg	1.6	default value is 0.50 (50%).
33	rschregle	1.7
34			-DPMAP_OOC Builds the out-of-core photon map. The photon data resides
35			in a leaf file on disk with suffix ".leaf" and is loaded on
36			demand. This is intended for very large photon maps (up to
37			4.3 billion photons) particularly for annual simulations
38			with rcontrib. This switch is disabled by default, which
39			builds the in-core photon map used in previous releases;
40			this resides entirely in main memory. These options are
41			mutually exclusive, and the resulting photon map files are
42			incompatible.
43
44			-DPMAP_PRIMARYPOS
45			Stores photon primary hitpoints for binning using the -f
46			option with rcontrib if the function file requires them.
47			This consumes an additional 3 floats and is disabled per
48			default to reduce the size of the resulting photon maps.
49
50			-DPMAP_FLOAT_FLUX
51			Stores photon flux as floats instead of more compact RGBE
52			(the default). In terms of accuracy, the difference would
53			only be noticeable with highly saturated colours.
54
55			-DPMAP_ROI Enables the -api option to mkpmap. This constrains photon
56			deposition only to the specified region of interest (defined
57			as a bounding volume) for situations where it is known a
58			priori that photon map lookups will occur outside this
59			region. This is disabled per default as it can lead to
60			biased results outside the ROI, or near its boundaries. Ziss
61			option for ze eckspertz only!
62
63			-DPMAP_RUNAWAY_WARN
64			Causes mkpmap to issue a warning if a photon reaches the
65			maximum number of bounces (as specified with -apm) and is
66			terminated.
67
68			-DPMAP_LOOKUP_WARN
69			Causes rtrace et al to issue warnings when short photon
70			lookups occur, i.e. fewer photons are found than specified
71			as lookup bandwidth with -ap. This is generally not fatal,
72			but can increase noise, and may indicate a higher bandwidth
73			is needed. This is disabled per default as it can result in
74			excessive console clutter.
75
76			-DPMAP_LOOKUP_REDO
77			Causes rtrace et al to repeat short photon map
78			lookups with a progressively larger radius until the
79			target photon count specified with -ap is met. This switch
80			has no effect in conjunction with the -am option, since this
81			disables lookup radius adaptation.
82
83			-DPMAP_EPANECHNIKOV
84			Causes rtrace et al to apply an Epanechnikov filter during
85			photon density estimates. This weights photons according to
86			the inverse distance to the lookup point in order to reduce
87			bias. The default behaviour does not perform filtering.