source: trunk/src/duchamp.hh @ 120

Last change on this file since 120 was 120, checked in by Matthew Whiting, 18 years ago

Introduced error and warning reporting functions, to normalise the format
of errors and warnings. Definitions of functions go in duchamp.cc.
Changed all code that reports errors/warnings to use these new functions.

Fixed a couple of bugs that affected the way 2D images were dealt with:
ReconSearch? now looks at how many dimensions there are in the data array
before choosing the dimension of the reconstruction, and the minChannels
test was improved for the case of minChannels=0.

Some minor additions made to the Guide as well.

File size: 2.4 KB
Line 
1/* src/duchamp.hh.  Generated by configure.  */
2#ifndef DUCHAMP_HH
3#define DUCHAMP_HH
4
5#include "config.h"
6
7#include <string.h>
8
9// how to convey whether a function has worked
10enum OUTCOME {SUCCESS, FAILURE};
11
12
13const std::string ERR_USAGE_MSG =
14"Usage:: Duchamp -p [parameter file]\n\
15  Other options:\n\
16    -f <file>  Use default parameters with imageFile=<file>\n\
17    -v         Version number\n\
18    -h         This help information\n";
19
20const std::string ERR_USAGE_MSG_SHORT = "Usage:: Duchamp -p [parameter file]\n";
21
22const std::string PROGNAME = PACKAGE_NAME;
23
24const std::string VERSION = PACKAGE_VERSION;
25
26// Specialised functions to report warnings and errors.
27// These are defined in duchamp.cc
28void duchampWarning(std::string subroutine, std::string warning);
29void duchampError(std::string subroutine, std::string error);
30
31// The spectral type that we want the wcsprm structs to be in
32const char duchampSpectralType[9] = "VELO-F2V";
33
34// The following are the FITS Header Keywords corresponding to the
35//  parameters related to the atrous reconstruction.
36const std::string keyword_scaleMin   = "DU_MINSC";
37const std::string keyword_snrRecon   = "DU_ATCUT";
38const std::string keyword_reconDim   = "DU_ATDIM";
39const std::string keyword_filterCode = "DU_FILTR";
40const std::string keyword_ReconResid = "DU_RECON"; // is this file the reconstruction or the residual?
41const std::string keyword_subsection = "DU_IMSUB";
42// And these are the comments corresponding to the relevant keywords
43const std::string comment_scaleMin   = "Duchamp parameter scaleMin";
44const std::string comment_snrRecon   = "Duchamp parameter snrRecon";
45const std::string comment_reconDim   = "Duchamp parameter reconDim";
46const std::string comment_filterCode = "Duchamp parameter filterCode";
47const std::string comment_ReconResid = "Is this the reconstruction or residual?";
48const std::string comment_subsection = "Subsection of the original image";
49// Descriptive Headers:
50const std::string header_history1 = "Reconstructed with a trous wavelet technique";
51const std::string header_history2 = "Reconstruction by Duchamp v." + VERSION;
52const std::string header_history_input = "Original (input) image used by Duchamp follows";
53const std::string header_subsection_comment  = "A subsection of the original was reconstructed by Duchamp";
54const std::string header_atrous_comment  = "The following are the Duchamp parameters used in reconstruction";
55
56#endif
57
Note: See TracBrowser for help on using the repository browser.