aboutsummaryrefslogtreecommitdiff
path: root/noao/nproto/doc/binpairs.hlp
blob: 09a019d0cdc45677f8df33cbe2d0b92326c3d8c2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
.help binpairs Oct84 noao.nproto
.ih
NAME
binpairs -- Bin pairs of (x,y) points in log separation
.ih
USAGE	
binpairs file1 file2 rmin rmax nbins
.ih
PARAMETERS
.ls file1
File containing (x,y) points to be paired.
.le
.ls file2
File containing (x,y) points to be paired.  This file may be the same
as file1.
.le
.ls rmin
The minimum separation to be binned.
.le
.ls rmax
The maximum separation to be binned.
.le
.ls nbins
The number of log separation bins to be computed.
.le
.ls verbose = no
Print progress information?
.le
.ih
DESCRIPTION
The (x,y) points in the specified files are paired and the number of pairs
in each bin of log separation is computed and output.  The two files may
be the same.  There are
\fInbins\fR separation bins between the separations \fIrmin\fR and \fIrmax\fR.
If the verbose parameter is yes then progress information is printed on the
standard error output at intervals of 5% of the time.
The output consists of the lower limit of the separation bin, the number of
pairs in the bin, the number of pairs divided by the total number of pairs,
and the annular area of the bin.

This task is useful for computing two point correlation functions.
.ih
EXAMPLES

.nf
    cl> binpairs data1 data2 .01 1 20 >> result

	    or

    cl> binpairs data data .01 1 20 >> result
.fi
.ih
SEE ALSO
.endhelp