Next: , Previous: I/O, Up: Invoking


4.2 Binning Parameters

4.2.1 Generic Filter and Grid

filter_mode enumerated string (‘pass’|‘quantpos’|‘quantidx’|‘quantize’|‘bin’|‘mask’|‘negmask’)
Rays are filtered according to this parameter (see Filter).
pass
Rays are passed through untouched.
quantpos
Rays which are not clipped and which would be accumulated are passed through, with their positions changed to the position of the bin into which they would have been accumulated
quantize
A synonym for quantpos. Deprecated.
quantidx
Rays which are not clipped and which would be accumulated are passed through, with their positions changed to the index of the bin into which they would have been accumulated
mask
Rays which would be accumulated are passed through unchanged.
negmask
Rays which would not be accumulated are passed through unchanged.
bin
Rays are accumulated into bins and the bins are written out as rays with the accumulated weights
none
No rays are output. Only useful if you just want to create an image.

norm_area string list
This parameter determines if accumulated bin weights or image values are normalized by the areas of the bins. It takes a comma or white-space separated list of tokens which indicate the data which should be normalized. Possible tokens are:
bin
the accumulated bin weights are normalized.
image
the image pixel values are normalized

xcent float
ycent float
The coordinates of the center of the grid.
quant_method enumerated string
This parameter selects the grid and binning scheme.
rectrect
rectilinear grid and rectangular bins
rectcirc
rectilinear grid and circular bins
hexcirc
hexagonal grid and circular bins
wedge
circular grid and wedge bins

clip boolean
If this is true, the grid will be limited to specified dimensions. The parameters which determine those dimensions are specific to each grid scheme.

4.2.2 Rectilinear Grid, Rectangular Bin

n_x integer
The number of columns in the grid. This is used only if clipping is turned on.
n_y integer
The number of rows in the grid. This is used only if clipping is turned on.
x_sz float
The width of a bin, also the distance in x between grid points.
y_sz float
The height of a bin, also the distance in y between grid points.

4.2.3 Rectilinear Grid, Circular Bin

n_x integer
The number of columns in the grid. This is used only if clipping is turned on.
n_y integer
The number of rows in the grid. This is used only if clipping is turned on.
x_sp float
The spacing in x between bin centers.
y_sp float
The spacing in y between bin centers.
diameter float
The diameter of a bin. It must be less than or equal to the bin spacing.

4.2.4 Hexagonal Grid, Circular Bin

n_x integer
The number of columns in the grid. This is used only if clipping is turned on.
n_y integer
The number of rows in the grid. This is used only if clipping is turned on.
spacing float
The distance between centers of adjacent bins. It must be greater than or equal to the diameter of the bins.
diameter float
The diameter of a bin. It must be less than or equal to the bin spacing.

4.2.5 Circular Grid, Wedge Bin

rtype enumerated string (‘discrete’|‘exp’|‘file’|‘linear’)
How the wedges are to be entered.
discrete
A finite number of wedge bins are to be entered by the user
exp
The inner and outer radial dimension are defined as: a * b ^ ( n - 1), a * b ^ n for n = 1, 2... , respectively. For n = 0, the inner and outer radial dimension are: 0 and a, respectively.
file
An rdb file with columns Rmin, Rmax, Tmin and Tmax
linear
The inner and outer radial dimemsion are defined as: deltaR * n and deltaR * (n+1), respectively.

rspec string
rspec's meaning depends upon the value of rtype:
discrete
If the parameter rtype is set to ‘discrete’, then the parameter rspec must be entered as follows: Rmax,Nwedge,Tmin. Where Rmax denotes the outer radius of the wedge, Nwedge denotes the number of wedges within an annular ring. Tmin (in degrees) denotes theta min. A comma is used to delimit between an element of the list, a slash or colon can be used to delimit between different sets of lists.
exp
If the parameter rtype is set to ‘exp’, the parameter rspec must be entered as follows: a,b,Nwedge,Tmin. Where the inner and outer radius isdefined as a * b^(n-1) and a * b^n respectively for n=1, 2, 3,... For n=0, the inner and outer radius is defined as 0 and a, respectively. Nwedge denotes the number of wedges within an annular ring. Tmin (in degrees) denotes theta min. A comma is used to delimit between an element of the list
file
If the parameter rtype is set to ‘file’, the parameter rspec must be a name of an rdb file containing the following columns: Rmin, Rmax, Tmin and Tmax.
linear
If the parameter rtype is set to ‘linear’, the parameter rspec must be entered as follows: deltaR,Nwedge,Tmin. Where the inner and outer radius isdefined as deltaR * n and deltaR * (n+1), respectively. Nwedge denotes the number of wedges within an annular ring. Tmin (in degrees) denotes theta min. A comma is used to delimit between an element of the list