~ubuntu-branches/ubuntu/trusty/yorick-yao/trusty

« back to all changes in this revision

Viewing changes to README

  • Committer: Package Import Robot
  • Author(s): Thibaut Paumard
  • Date: 2012-03-31 23:26:38 UTC
  • mfrom: (1.1.4)
  • Revision ID: package-import@ubuntu.com-20120331232638-dlbu8sjtpjbnh0df
Tags: 4.8.2-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
Developpers:
9
9
------------
10
10
Francois Rigaut         frigaut@gemini.edu
11
 
Ralf Flicker            flicker@strw.leidenuniv.nl
12
 
Damien Gratadour    dgratadour@gemini.edu
 
11
Ralf Flicker            (+ July 2009)
 
12
Damien Gratadour        damien.gratadour@obspm.fr
 
13
Marcos van Dam          marcos@flatwavefronts.com
 
14
Aurea Garcia-Rissmann   agrissmann@gmail.com
13
15
 
14
16
Help pages:
15
17
-----------
16
 
http://www.maumae.net/yao/aosimul.html (outdated)
 
18
http://www.maumae.net/yao/
17
19
 
18
20
 
19
21
RELEASE NOTES:
20
22
--------------
 
23
 
 
24
version 4.8.2, 2010dec17:
 
25
  - Added parallelization of WFS (i.e. one thread/WFS in a multi WFS system)
 
26
  - Tried implementing FFTW parallelization, but the gains were really marginal
 
27
    and often it would be more detrimental than good. Reverted, but left the
 
28
    code commented in Makefile, yao_fast.i and yao_fast.c
 
29
  - yao now looks for and includes yao.conf, if any (before was only in yao GUI)
 
30
  - changed all calls to fitsRead and fitsWrite to new function names
 
31
    yao_fitsread and yao_fitswrite. This way, I work around any conflict
 
32
    with fits.i function checks. Renamed newfits.i to yao_newfits.i
 
33
  - fixed a number of bugs in svipc implementation (mostly how it recovers from
 
34
    a previous svipc run within the same session). test-all.i now runs good
 
35
    with sim.svipc = 1, 5, with wfs.svipc>1, as well as sim.svipc=1 *and* wfs.svipc>1
 
36
    within the same run.
 
37
  - added items in check_parameters() to check for the svipc bad settings
 
38
  - re-introduced sim.name in graphic and nudged some labels in graphics a bit
 
39
  - introduced some changes to make the graphic look better when using
 
40
    xftfonts. also resized controlscreen
 
41
  - better handling of window closing/opening when using svipc
 
42
  - push to get reference tip is now 0.005 instead of 0.05 (there's no noise)
 
43
  - fixed a bug that animate would not be ON for display in close loop when
 
44
    using svipc
 
45
  - switched the Makefile to -Wall
 
46
  - 2 new sim structure members: sim.svipc_wfs_nfork and sim.svipc_wfs_forknb
 
47
  - fixed a bug in pyramid wfs, hopefully once and for all (bad sinc() function
 
48
    used).
 
49
  - added test3.par (same as glao.par)
 
50
  - fix a bug in test5.par (phase screen referred in parfile may not have
 
51
    existed)
 
52
  - fixed issue with animate being ON and preventing further plot
 
53
  - fixed bug in which background calib was not passed to wfs.svipc child (since
 
54
    4.7.1)
 
55
  - fixed nitegcycle for shwfs when no svipc
 
56
  - written test routine (examples/test-fr.i) to check correctness of main
 
57
    modes of svipc (wfs and sim).
 
58
    
 
59
 
 
60
version 4.8.1, 2010dec06:
 
61
- changed layout of graphic window to add residual phase
 
62
- display of residual phase (Marcos)
 
63
- nintegcycle in pyramid wfs (Marcos)
 
64
- "extended" object in pyramid wfs (Marcos)
 
65
- a couple of bugfix (Marcos and I)
 
66
 
 
67
  
 
68
version 4.8.0, 2010nov09:
 
69
- XFT related:
 
70
  * increased size of axis labels fonts on plsys(4)
 
71
- newfits:
 
72
  * fixed error handling. Now error in place, instead of calling error handling
 
73
    function (exitInError). Allows much clearer debugging.
 
74
- Pyramid:
 
75
  * merged pyramid_wfs() changes from marcos, upgraded my francois
 
76
  * changes in yao main routines to make re-introduced obsolete "pyramid" wfs type 
 
77
  * upgraded GUI to include pyramid modulation amplitude control
 
78
  * added 4 new structure members to wfs structure
 
79
- MISC:
 
80
  * added "--dpi ##" command line call option (for GUI call). Example:
 
81
    yao --dpi 75 sh6x6.par
 
82
  * added default animate() to iMat acquisition display.
 
83
  * cleanup of yao.py (dictionary autoconnect) + dpi stuff
 
84
  * shortened get_style() calls to viewport() call
 
85
  * gotten rid of get_processor_number() (use nprocs() function in svipc)
 
86
  * added a bunch of extern wfs, dm, ... in functions called by python to set
 
87
    values of parameters (how could it have worked before is a mystery).
 
88
- BUG FIXES:
 
89
  * fixed a bug in which the graphic would get stuck (animate call was done
 
90
  without ensuring a plsys,1)
 
91
  
 
92
 
 
93
 
 
94
version 4.7.3, 2010 oct12:
 
95
- merged SH threshold methods #2 and #3, patches from Yann Clenet
 
96
  Credits for original idea of method #3 (compute centroid on N
 
97
  brightest pixels instead of using a flux threshold) go to E.Gendron.
 
98
- added some safety for the choice of shthreshold when using shmethod=3
 
99
  to avoid getting segfaults in yao_fast.
 
100
 
 
101
version 4.7.2, 2010 oct12:
 
102
- added smooth animate=1 for iMat recording/display
 
103
- added ETA when taking iMat
 
104
- added option to findfwhm() to save RAM requirements (help,findfwhm)
 
105
- merged patch from Marcos van Dam:
 
106
  * implemented virtual DMs for tomography
 
107
  * implemented save of residual phase in go() (help,go)
 
108
 
 
109
version 4.7.1, 2010sep16:
 
110
- fixed nasty bug that was not switching noise off for background calib (SHWFS)
 
111
  Thanks Yann Clenet for noticing and pointing me to the right direction
 
112
- make screen now can drop the imaginary part (no_ipart=1) to produce larger
 
113
  screens by saving some RAM.
 
114
- Gotten rid of hdf5 call in yaodh (and thus of hdf5 dependency)
 
115
- switched the default mode in test-all.i to non svipc
 
116
 
 
117
Version 4.7.0, 2010aug14:
 
118
 
 
119
- Merged a bunch of changes from Marcos van Dam. From his changelog:
 
120
1. There is a new version of soy.i. I found more bugs and since it had to be modified, I added new functions. FR: I merged these changes in soy 1.3
 
121
2. filtertilt set to 0 for interaction matrix generation. I need this to generate sparse matrices.
 
122
3. filtertilt for zernike and stackarray DMs. I need to filter tilt from DMs when doing tomography with LGSs.
 
123
4. WFS measurements set to 0 if not from same subsystem as DM.
 
124
5. minimum zernike (to exclude piston/tip/tilt if desired). I need this feature for tip-tilt tomography.
 
125
6. I remove the reporting of the number of corrected modes... do we really need this? it makes no sense for anything other than classical AO.
 
126
7. pupil (real = 0). We discussed this earlier.
 
127
8. Introduced virtual DMs needed for tomographic reconstruction
 
128
9. mmse and mmse-sparse works fine with MCAO
 
129
10. Have loop.method set to closed-loop, open-loop and pseudo open-loop. Open loop means WFS sees uncorrected WF, not corrected WF.
 
130
11. Tomographic reconstruction!
 
131
 
 
132
- Fixed a broken re-opening of graphic window because of undefined dpi.
 
133
 
 
134
Version 4.6, 2010jun17:
 
135
 
 
136
- Merged Aurea Garcia-Rissmann additions for diskharmonic DMs
 
137
  Part of the code from Mark Milton (at the time at UofA). Used
 
138
  with authorization.
 
139
  
 
140
- Merged parallelization code (svipc). Can lead to 3x gains on
 
141
  multicore machines. Tweak with sim.svipc = value (see yao_structures)
 
142
 
 
143
- Gotten rid of redondant code in utils.c. poidev was in there, as well
 
144
  as other routines. These are already in imutil and imutil is definitely
 
145
  a dependency. This, combine with using the latest imutil v 0.5.6, solves
 
146
  a bug in which poidev would SIGFPE when using too brights GS in with
 
147
  CWFS mode.
 
148
 
 
149
- solved a bug in which not specifying skymag would means skymag=0
 
150
  and thus lots of photons in the sky in CWFS mode. Now skymag=0
 
151
  (default) is interpreted as "no sky".
 
152
 
 
153
- upgraded all the PROTOTYPES to new recommended syntax "type array"
 
154
  instead of "pointer".
 
155
  
 
156
V 4.5.6
 
157
- changed "least-squares" -> "mmse"
 
158
- changed "sparse" -> "mmse-sparse"
 
159
- updated documentation with input from Marcos Van Dam
 
160
 
 
161
// sorry for inconsistency. Below are cvs revision number of yao.i
 
162
 * Revision 1.16  2010/06/09 15:03:42  frigaut
 
163
 * - Merged changes of Marcos Van Dam: This implements new reconstructors
 
164
 *   methods "least-squares" (in fact a MMSE-like) and "sparse" (same but
 
165
 *   using sparse matrices, very fast). This adds a dependency on soy.
 
166
 *   There's now a few more elements in the dm and mat structures
 
167
 *
 
168
 * - added thback and cleaned up indentation in yao_fast.c
 
169
 *
 
170
 * Revision 1.15  2010/04/15 18:11:24  frigaut
 
171
 *
 
172
 * - strlower -> strcase
 
173
 *
 
174
 * Revision 1.14  2010/04/15 02:36:53  frigaut
 
175
 *
 
176
 *
 
177
 * final commit to upgrade this repo to yao 4.5.1
 
178
 *
 
179
 * Revision 1.13  2008/11/19 00:53:19  frigaut
 
180
 * - fixed memory leak in yao_fast.c (thanks Damien for reporting that)
 
181
 * - fixed comments in newfits.i
 
182
 * - upped version to 4.2.6
 
183
 *
 
184
 * Revision 1.12  2008/05/12 18:23:48  frigaut
 
185
 * version change
 
186
 *
 
187
 * Revision 1.11  2008/05/11 14:03:56  frigaut
 
188
 * - implemented zernike wfs
 
189
 * - gotten rid of faulty round function in yao_util
 
190
 *
 
191
 * Revision 1.10  2007/12/27 09:06:28  frigaut
 
192
 * - bumped to version 4.2.3
 
193
 * - corrected problem with glade path (python does not like ~, so
 
194
 * replaced by expansion)
 
195
 *
 
196
 * Revision 1.9  2007/12/20 13:35:55  frigaut
 
197
 * bumped to v4.2.2
 
198
 *
 
199
 * Revision 1.8  2007/12/20 13:34:53  frigaut
 
200
 * - various bug fixes
 
201
 * - better handlng of default parfile path
 
202
 * - better handling of options menu (WFS and DM)
 
203
 *
 
204
 * Revision 1.7  2007/12/19 20:00:08  frigaut
 
205
 * - statusbar updated to indicates where the results are saved when done
 
206
 * - bumped to 4.2.1
 
207
 *
 
208
 * Revision 1.6  2007/12/19 19:44:19  frigaut
 
209
 * - solved a number of bugs and inconsistencies between regular yao call and
 
210
 *   GUI calls.
 
211
 * - fixed misregistration for curvature systems
 
212
 * - change: misregistration entry from the GUI is now in pupil diameter unit,
 
213
 *   not in subaperture unit!
 
214
 * - changed default efd in c188-bench.par
 
215
 *
 
216
 * Revision 1.5  2007/12/19 15:45:32  frigaut
 
217
 * - implemented yao.conf which defines the YAO_SAVEPATH directory where
 
218
 * all temporary files and result files will be saved
 
219
 * - modified yao.i and aoutil.i to save in YAO_SAVEPATH
 
220
 * - bumped version to 4.2.0
 
221
 * - slight changes to GUI (edit conf file)
 
222
 *
 
223
 
21
224
version 4.1.1: 2007dec13:
22
225
    - upgrade/update of Makefile
23
226