-
Notifications
You must be signed in to change notification settings - Fork 1
/
README
41 lines (30 loc) · 1.65 KB
/
README
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
giraffe
provides functionality for angular cross-correlation analysis
the underlying classes may also be used for more general purposes
The classes in this package are the following
CrossCorrelator --- a class to compute angular auto- and cross-correlations
arraydata --- a general class for dynamically allocated array (parent class)
array1D --- derived class for one-dimensional arrays
array2D --- derived class for two-dimensional arrays
array3D --- derived class for three-dimensional arrays
arraydataIO --- functionality to get HDF5, EDF, TIFF in and out of arraydata objects
FourierTransformer --- wrapper for the Fourier tranforms of the fft library
The giraffe library can be used, for example in Anton Barty's cheetah
found at https://github.com/antonbarty/cheetah
*** building ***
This package can be built using the SCons software construction tool (http://www.scons.org/) using commands
scons -c
scons
to yield
libgiraffe_static.a --- static library
libgiraffe_dynamic.so/dylib --- dynamic library (extension is platform dependent)
filehandler --- stand-alone tool for common tasks around the array classes (I/O, basic math, ...)
xcca --- stand-alone tool for X-ray Cross Correlation Analysis
testsuite --- a bunch of test functions for the classes contained
*** main contributors ***
Jan M. Feldkamp, SLAC
Jonas Sellberg, SLAC
*** note on edf support ***
the code in edf_support is borrowed and slightly altered for this package
origin: 'matlib' package, hosted at ISP/TUD
for more information, contact Prof. C. Schroer at the Institute of Structural Physics, TU Dresden, Germany