diff --git a/doc/Makefile b/doc/Makefile index dc91cdfef468a7875c2f05e9a24abfc5c5d5644d..2335ffd0916c9b2e85325336c9f029e96854fd04 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -11,12 +11,12 @@ DOC_FILENAME_BT = ISISscripts_by_topic ######################################################################## -BUILDFILES = $(SLHLP_FILE) $(DOC_FILENAME).pdf +BUILDFILES = $(SLHLP_FILE) $(DOC_FILENAME).pdf src/isisscripts.tm src/isisscripts.tm.BAK $(DOC_FILENAME).md all: $(BUILDFILES) clean: - rm -rf *~ */*~ src/isisscripts src/$(DOC_FILENAME).sgml $(DOC_FILENAME).tex $(DOC_FILENAME).md src/isisscripts.tm *.log *.aux *.out *.toc *.dvi + rm -rf *~ */*~ src/isisscripts src/$(DOC_FILENAME).sgml $(DOC_FILENAME).tex *.log *.aux *.out *.toc *.dvi distclean: clean rm -f $(BUILDFILES) $(DOC_FILENAME)-*.html @@ -54,8 +54,8 @@ isisscripts_help.html: $(DOC_FILENAME).html mv $(DOC_FILENAME).html $@ %.pdf: %.tex - pdflatex $< - pdflatex $< > /dev/null + xelatex $< + xelatex $< > /dev/null rm -f $(subst .tex,.log,$<) $(subst .tex,.aux,$<) $(subst .tex,.out,$<) $(subst .tex,.toc,$<) $(DOC_FILENAME).ps: $(DOC_FILENAME).tex diff --git a/doc/doc/ISISscripts_html.tm b/doc/doc/ISISscripts_html.tm index 50e188b906a5aab84e8795d24ccfa8f7cf31ab16..3672e7d249eb453d1e8eef50e39f8310c3ff09ba 100644 --- a/doc/doc/ISISscripts_html.tm +++ b/doc/doc/ISISscripts_html.tm @@ -2,6 +2,7 @@ #% d __remove_comment_lines 1 #d function#1 \FUNCTION{$1} +#d datatype#1 \FUNCTION{$1} #d synopsis#1 \SYNOPSIS{$1} #d usage#1 \USAGE{$1} #d altusage#1 \ALTUSAGE{$1} @@ -11,7 +12,7 @@ #d notes \HEADINGV{Notes} #d seealso#1 \SEEALSO{$1} #d qualifiers#1 \HEADINGV{Qualifiers}{$1} -#d qualifier#2 * $1$2 +#d qualifier#2 * $1: $2 #d done \lt/p\gt\lt/div\gt\n #d n \__newline__ #d code#1 \lt{}code\gt{}\lt{}pre\gt{}$1\lt{}/pre\gt{}\lt{}/code\gt{} diff --git a/doc/doc/ISISscripts_md.tm b/doc/doc/ISISscripts_md.tm index dd15ee6c44d5ab03e88ba0d8f954bbe8c111b5b2..5cd1dc25e2d5c2f8ad6863dc576042aab7978c61 100644 --- a/doc/doc/ISISscripts_md.tm +++ b/doc/doc/ISISscripts_md.tm @@ -2,6 +2,7 @@ #% d __remove_comment_lines 1 #d function#1 ----\__newline__\__newline__\headingiv{$1} +#d datatype#1 ----\__newline__\__newline__\headingiv{$1} #d synopsis#1 \SYNOPSIS{$1} #d usage#1 \USAGE{$1} #d altusage#1 \ALTUSAGE{$1} @@ -11,7 +12,7 @@ #d notes \HEADINGV{Notes} #d seealso#1 \SEEALSO{$1} #d qualifiers#1 \HEADINGV{Qualifiers}{$1} -#d qualifier#2 * $1$2 +#d qualifier#2 * $1: $2 #d done \n #d n \__newline__ \__newline__ #d code#1 $1 @@ -41,6 +42,10 @@ define headingv_fun () { insert(sprintf("##### %s\n%s", s1, s2)); } +define math_fun (s) { + vinsert("$%s", s); +} + define synopsis_fun (s) {headingv_fun("Synopsis", sprintf(" %s\n", s));} define usage_fun (s) {headingv_fun("Usage", sprintf("```c\n %s\n```\n\n", s));} @@ -70,6 +75,7 @@ tm_add_macro("USAGE", &usage_fun, 1, 1); tm_add_macro("ALTUSAGE", &altusage_fun, 1, 1); tm_add_macro("SEEALSO", &seealso_fun, 1, 1); tm_add_macro("WIKILINK", &wikilink_fun, 1, 1); +tm_add_macro("math", &math_fun, 1, 1); %#% tm_map_character ('{', "\\{"R); %#% tm_map_character ('}', "\\}"R); #s- diff --git a/doc/doc/ISISscripts_tex.tm b/doc/doc/ISISscripts_tex.tm index e0e067b5a8e39f50ff4cb34f080923ad6ef34048..27677c4405d404fc9c3ddbbd1694667b406f8094 100644 --- a/doc/doc/ISISscripts_tex.tm +++ b/doc/doc/ISISscripts_tex.tm @@ -2,6 +2,7 @@ #d __remove_comment_lines 1 #d function#1 \__newline__{}\\section*{\\texttt{$1}}\\addcontentsline{toc}{section}{$1}\\begin{description} +#d datatype#1 \__newline__{}\\section*{\\texttt{$1}}\\addcontentsline{toc}{section}{$1}\\begin{description} #d synopsis#1 \\item[Synopsis]~\\newline $1 #d usage#1 \\item[Usage]~\\newline\\texttt{$1} #d altusage#1 \n or\n\\texttt{$1} @@ -11,13 +12,21 @@ #d notes \\item[Notes]~\\newline #d seealso#1 \\item[See also]~\\newline\\texttt{$1} #d qualifiers#1 \\item[Qualifiers]\\end{description}\\begin{itemize}$1\\end{itemize}\\begin{description} -#d qualifier#2 \\item \\texttt{$1}$2 +#d qualifier#2 \\item \\texttt{$1}: $2 #d done \\item[]\\end{description}\__newline__{} #d n \\newline #d code#1 \\texttt{$1} +#d __verbatim_begin \begin{verbatim} +#d __verbatim_end \end{verbatim} + #s+ -tm_map_character ('_', "\\_"R); +define math_function (s) +{ + vinsert("$%s$", s); +} +tm_add_macro("math", &math_function, 1, 1); +tm_map_character ('_', "_"R); tm_map_character ('%', "\\%"R); tm_map_character ('#', "\\#"R); tm_map_character ('<', "$<$"); @@ -29,18 +38,21 @@ tm_map_character ('|', "$|$"R); %#% tm_map_character ('}', "\\}"R); #s- + \\documentclass{article} + \\usepackage[a4paper,hmargin=2cm,vmargin=1cm,bottom=0.5cm,includefoot]{geometry} \\usepackage[colorlinks=true,urlcolor=blue,linkcolor=blue]{hyperref} \\usepackage{multicol} - +\\usepackage[utf8]{inputenc} +\\usepackage{underscore} \\begin{document} \\setcounter{page}{1} \\pagenumbering{roman} \\title{\\vskip-1cm \\textsf{\\textsc{ISIS / S-Lang} scripts} \\vskip-3mm} -\\author{ Contributors to the ISISscripts } -\\date{ Dr.~Karl Remeis observatory,\\\\Bamberg, Germany } +\\author{Contributors to the ISISscripts} +\\date{\\today} \\maketitle \\setlength{\\columnsep}{1cm} \\setlength{\\columnseprule}{1pt} diff --git a/doc/share/slhlp_isisscripts.tm b/doc/share/slhlp_isisscripts.tm index 22c1b17aa85c0bb5fdd5dccd0fd91051cb831106..271a2181b7b3f41f0faad04f69eee619b8f004ee 100644 --- a/doc/share/slhlp_isisscripts.tm +++ b/doc/share/slhlp_isisscripts.tm @@ -26,12 +26,14 @@ tm_add_macro("WIKILINK", &wikilink_fun, 1, 1); #d variable#1 \__newline__{}$1\__newline__ #d datatype#1 \__newline__{}$1\__newline__ +#d math#1 $1 + #d synopsis#1 \_hlp_section{SYNOPSIS}\__newline__{}\__space__{4}$1\__newline__ #d usage#1 \_hlp_section{USAGE}\__newline__\__space__{4}$1 #d altusage#1 \__space__{4}% or\__newline__\__space__{4}$1 #d description \_hlp_section{DESCRIPTION} #d qualifiers#1 \_hlp_section{QUALIFIERS}$1 -#d qualifier#2 \__space__{4}; $1: $2 +#d qualifier#2 \__space__{4}* $1: $2 #d example \_hlp_section{EXAMPLE} #d examples \_hlp_section{EXAMPLES} #d notes \_hlp_section{NOTES} diff --git a/src/FITS/ad_image/ad_make_image.sl b/src/FITS/ad_image/ad_make_image.sl index be230af83fc98983614d5b84ad2aacac842d889c..fc80c6aaae175667ed2829b42a539ed5cde79043 100644 --- a/src/FITS/ad_image/ad_make_image.sl +++ b/src/FITS/ad_image/ad_make_image.sl @@ -10,10 +10,10 @@ define ad_make_image() { %respect to alpha and beta} %\usage{(img, alp_lo, alp_hi, bet_lo, bet_hi) = ad_make_image(filename);} %\qualifiers{ -%\qualifier{sho_minmax}{: show the extrem values of alpha and beta?} -%\qualifier{timing}{: read a Brod-Timing-FITS-Table} -%\qualifier{field}{: specify which values are plotted} -%\qualifier{disk}{: use intrinsic x and y instead of alpha and beta (only working for timing yet)} +%\qualifier{sho_minmax}{show the extrem values of alpha and beta?} +%\qualifier{timing}{read a Brod-Timing-FITS-Table} +%\qualifier{field}{specify which values are plotted} +%\qualifier{disk}{kuse intrinsic x and y instead of alpha and beta (only working for timing yet)} %} %!%- diff --git a/src/FITS/ascii_read_table.sl b/src/FITS/ascii_read_table.sl index 77016f6d252b38674cb17374dd68559ff25a0109..096fd787c9d7c5a0a40156e0734184d9a4a14a9d 100644 --- a/src/FITS/ascii_read_table.sl +++ b/src/FITS/ascii_read_table.sl @@ -3,8 +3,7 @@ define ascii_read_table() %\function{ascii_read_table} %\synopsis{reads an ASCII table from a file into a structure} %\usage{Struct_Type table = ascii_read_table(String_Type filename, String_Type formats[]); -%\altusage{Struct_Type table = ascii_read_table(String_Type filename, List_Type infos[]);\n -% % with infos[i] = { formats[i], columns[i] };} +%\altusage{Struct_Type table = ascii_read_table(String_Type filename, List_Type infos[]); with infos[i] = { formats[i], columns[i] };} %\altusage{(table, keys) = ascii_read_table(String_Type filename, List_Type infos[]);\n % % with infos[i] = { formats[i], columns[i], units[i] };} %} @@ -19,9 +18,9 @@ define ascii_read_table() % If a unit is given, the function ascii_read_table has a second return value, % namely a keys-structure which can be used for \code{fits_write_binary_table}. %\qualifiers{ -%\qualifier{comment}{: string which indicates comments [default = "#"]} -%\qualifier{startline}{: Only lines after this number are considered.} -%\qualifier{endline}{: The file is not read after this line number.} +%\qualifier{comment}{string which indicates comments [default = "#"]} +%\qualifier{startline}{Only lines after this number are considered.} +%\qualifier{endline}{The file is not read after this line number.} %\qualifier{verbose}{} %} %\examples diff --git a/src/FITS/fits_plot_rmf.sl b/src/FITS/fits_plot_rmf.sl index 05dc91cdfda9dd5740dd3ad9badc1875b704458b..8cdf3dbfc2f8402cadc754d338bcd590e91a5720 100644 --- a/src/FITS/fits_plot_rmf.sl +++ b/src/FITS/fits_plot_rmf.sl @@ -8,10 +8,10 @@ define fits_plot_rmf() %\altusage{(interpol_matrix_density, Ebounds, energ) = fits_plot_rmf(RMFfile; getvalues)} %} %\qualifiers{ -%\qualifier{nx}{: number of pixels in x-direction [default=400]} -%\qualifier{ny}{: number of pixels in x-direction [default=300]} -%\qualifier{getvalues}{: retrieves the interpolated matrix density} -%\qualifier{noplot}{: skip plotting, but retrieves the interpolated matrix density} +%\qualifier{nx}{number of pixels in x-direction [default=400]} +%\qualifier{ny}{number of pixels in x-direction [default=300]} +%\qualifier{getvalues}{retrieves the interpolated matrix density} +%\qualifier{noplot}{skip plotting, but retrieves the interpolated matrix density} %} %\seealso{fits_read_rmf} %!%- diff --git a/src/FITS/fits_read_header.sl b/src/FITS/fits_read_header.sl index 3eca1ed15ca6a7f9bf95241330111cb40abdec01..81a916558b8c5b8594dc1fb80fedf30058291f68 100644 --- a/src/FITS/fits_read_header.sl +++ b/src/FITS/fits_read_header.sl @@ -11,7 +11,7 @@ define fits_read_header() % automatically. Otherwise, `file' should represent an already % opened FITS file (which will remain opened). %\qualifiers{ -% \qualifier{lowercase}{: return structure tags in lower case +% \qualifier{lowercase}{return structure tags in lower case % (default: upper case)} %} %\seealso{fits_read_records, fits_open_file} diff --git a/src/FITS/fits_read_lc.sl b/src/FITS/fits_read_lc.sl index c82ac3a648dffa49e7562b82d818d87b28d86e5b..9ddc56101a2a776dc92ae066a5fe5ae36cf4ed86 100644 --- a/src/FITS/fits_read_lc.sl +++ b/src/FITS/fits_read_lc.sl @@ -16,18 +16,18 @@ define fits_read_lc() % The time field is always converted into Modified Julian Date % according to the MJDREF[{I,F}], TIMEUNIT and TIMEZERO keywords. %\qualifiers{ -%\qualifier{verbose}{: show the filename of the light curves when reading more than one} -%\qualifier{cut}{: cut all fields but time, rate, error} -%\qualifier{rate_per_PCU}{: divide count rate for RXTE-PCA light curves +%\qualifier{verbose}{show the filename of the light curves when reading more than one} +%\qualifier{cut}{cut all fields but time, rate, error} +%\qualifier{rate_per_PCU}{divide count rate for RXTE-PCA light curves % by number of PCUs determined from the given filterfile % (*.xfl, see 'RXTE_nr_PCUs_from_filterfile').} -%\qualifier{time}{ [=\code{"time"}]: name of the time field, e.g., \code{"barytime"}; +%\qualifier{time}{[=\code{"time"}]: name of the time field, e.g., \code{"barytime"}; % if \code{!= "time"}, this field is renamed \code{"time"}, % overwriting any previously existing \code{time} field} -%\qualifier{time_in_s}{: add structure fields for time in sec, MJDref +%\qualifier{time_in_s}{add structure fields for time in sec, MJDref % and T0 to the output structure} -%\qualifier{filename}{: add filename structure field} -%\qualifier{extension}{: add number of extension to be read} +%\qualifier{filename}{add filename structure field} +%\qualifier{extension}{add number of extension to be read} %} %\seealso{fits_read_table, fits_read_key, fits_read_key_int_frac, RXTE_nr_PCUs_from_filename} %!%- diff --git a/src/FITS/fits_read_rmf.sl b/src/FITS/fits_read_rmf.sl index 76f36b46a36615ba4beca53bfb23a2aa25c80b0b..6f745dc7ba7a6e07aec3799d0f784a10bf712973 100644 --- a/src/FITS/fits_read_rmf.sl +++ b/src/FITS/fits_read_rmf.sl @@ -15,9 +15,9 @@ define fits_read_rmf() %\description % \code{rmf.matrix[j,i]} describes \code{rmf.ebounds.}*\code{[i]} and \code{rmf.energy.}*\code{[j]}. %\qualifiers{ -%\qualifier{check}{: checks rmf-normalization: \code{rmf.matrixsum_ebounds} is the sum over all ebounds, which should be 1.} -%\qualifier{spec}{: \code{rmf.whitespectrum} is the sum over all ebounds, which should be 1.} -%\qualifier{float}{: use for larger RMFs to be able to be loaded in isis.} +%\qualifier{check}{checks rmf-normalization: \code{rmf.matrixsum_ebounds} is the sum over all ebounds, which should be 1.} +%\qualifier{spec}{\code{rmf.whitespectrum} is the sum over all ebounds, which should be 1.} +%\qualifier{float}{use for larger RMFs to be able to be loaded in isis.} %} %\seealso{fits_plot_rmf} %!%- diff --git a/src/FITS/fits_save_fit/fits_save_fit.sl b/src/FITS/fits_save_fit/fits_save_fit.sl index 9b9d1c09bf243b8b964de970ce6fc1efee80acd1..51b08b47137c19c0e5bfb0b1e3bd45a540f1fa94 100644 --- a/src/FITS/fits_save_fit/fits_save_fit.sl +++ b/src/FITS/fits_save_fit/fits_save_fit.sl @@ -24,7 +24,7 @@ define fits_conv_to_legal_char(aba_str) %\function{fits_conv_to_legal_char} %\synopsis{converts a string into legal characters to be used as a FITS column name} %\usage{String_Type legal_str = fits_conv_to_legal_char(String_Type str);} -%} +% %\seealso{fits_save_fit} %!%- % @@ -487,9 +487,9 @@ define fits_save_fit() % should only yield values equal or better than the original ones. % %\qualifiers{ -%\qualifier{info=Struct_Type}{: appends the given structure to the table} -%\qualifier{hard_limits}{: also saves all hard limits of the parameters} -%\qualifier{silent}{: no warnings are printed to STDOUT} +%\qualifier{info=Struct_Type}{appends the given structure to the table} +%\qualifier{hard_limits}{also saves all hard limits of the parameters} +%\qualifier{silent}{no warnings are printed to STDOUT} %} %\seealso{fits_load_fit_struct,fits_write_TeX_table,save_par,pvm_fit_pars,fits_save_fit_struct,fits_write_fits_struct,fits_list_fit_pars} %!%- diff --git a/src/FITS/fits_save_fit/hardnessratio_from_spec.sl b/src/FITS/fits_save_fit/hardnessratio_from_spec.sl index 61033e09818b74c4be954216595cc3fd094bc361..681f65cf03f195f1d246176ea37cafabf317802b 100644 --- a/src/FITS/fits_save_fit/hardnessratio_from_spec.sl +++ b/src/FITS/fits_save_fit/hardnessratio_from_spec.sl @@ -14,10 +14,10 @@ define hardnessratio_from_spec() % For the hardness ratio two different definitions can be chosen (either h/s or % (h-s)/(h+s)). %\qualifiers{ -%\qualifier{hard_band}{: Double_Type[2], hard energy band, default = [7.,10.]} -%\qualifier{soft_band}{: Double_Type[2], soft energy band, default = [2.,4.]} -%\qualifier{hr_def}{: Integer_Type, for hr=h/s choose 1, for hr=(h-s)/(h+s) choose 2, default = 1} -%\qualifier{roc}{: Integer_Type, RMF OGIP compliance, default = 2} +%\qualifier{hard_band}{Double_Type[2], hard energy band, default = [7.,10.]} +%\qualifier{soft_band}{Double_Type[2], soft energy band, default = [2.,4.]} +%\qualifier{hr_def}{Integer_Type, for hr=h/s choose 1, for hr=(h-s)/(h+s) choose 2, default = 1} +%\qualifier{roc}{Integer_Type, RMF OGIP compliance, default = 2} %} %\seealso{hardnessratio_error_prop,enflux,fits_save_fit} %!%- diff --git a/src/FITS/fits_wcs_struct.sl b/src/FITS/fits_wcs_struct.sl index 492e03e68e111cac3d3eb26405913bab60766055..30f99a7d5e8ca1b919be36217ef84756f1d4b77b 100644 --- a/src/FITS/fits_wcs_struct.sl +++ b/src/FITS/fits_wcs_struct.sl @@ -8,7 +8,7 @@ define fits_wcs_struct() %\altusage{Struct_Type fits_wcs_struct(Double_Type X[], Y[] [, String_Type xtype, ytype[, xunit, yunit]])} %} %\qualifiers{ -%\qualifier{arrays}{: return a struct { ctype=[ctype1, ctype2], ... } with arrays +%\qualifier{arrays}{return a struct { ctype=[ctype1, ctype2], ... } with arrays % instead of struct { ctype1=ctype1, ctype2=ctype2, ... }. % This form is, e.g., required by ds9_put_wcs_struct.} %} diff --git a/src/FITS/fits_write_arf.sl b/src/FITS/fits_write_arf.sl index 6931f73880b5476fc1899846efaac7ab91f40b6a..29d358f430dfbe6fea8de9b3d936abbe9a2ead2e 100644 --- a/src/FITS/fits_write_arf.sl +++ b/src/FITS/fits_write_arf.sl @@ -6,13 +6,13 @@ define fits_write_arf() %\synopsis{Write a FITS ancilliary response matrix file} %\usage{fits_write_arf(arfname,arf;qualifiers);} % \qualifiers{ -% \qualifier{telescope}{: telescope for the ARF} -% \qualifier{instrument}{: instrument for the ARF} -% \qualifier{filter}{: filter of the instrument} -% \qualifier{detnam}{: name of the detector} -% \qualifier{exposure}{: exposure time associated with the ARF} -% \qualifier{chantype}{: see FITS ARF specification (default: PI)} -% \qualifier{origin}{: who write this file (default: ECAP)} +% \qualifier{telescope}{telescope for the ARF} +% \qualifier{instrument}{instrument for the ARF} +% \qualifier{filter}{filter of the instrument} +% \qualifier{detnam}{name of the detector} +% \qualifier{exposure}{exposure time associated with the ARF} +% \qualifier{chantype}{see FITS ARF specification (default: PI)} +% \qualifier{origin}{who write this file (default: ECAP)} %} %\description % Write a FITS compliant ancilliary response matrix diff --git a/src/FITS/fits_write_gti.sl b/src/FITS/fits_write_gti.sl index 2d69498f3c80e7811abf24e60e575cb8ba8401a8..8b6672f5fb2575ca85c11015ebb84bffa9b9f805 100644 --- a/src/FITS/fits_write_gti.sl +++ b/src/FITS/fits_write_gti.sl @@ -8,10 +8,10 @@ define fits_write_gti() %\altusage{fits_write_gti(String_Type filename, Double_Type start[], stop[], MJDref);} %} %\qualifiers{ -%\qualifier{creator}{ [\code{="isisscripts:fits_write_gti"}] (XMM SAS needs an arbitrary value)} -%\qualifier{date}{ [\code{="1998-JAN-01"}] (XMM SAS needs an arbitrary value)} -%\qualifier{combineGTIs}{ [\code{=1}]: combine intervals that adjoin each other} -%\qualifier{verbose}{ [\code{=1}]: tell when intervals are combined} +%\qualifier{creator}{[\code{="isisscripts:fits_write_gti"}] (XMM SAS needs an arbitrary value)} +%\qualifier{date}{[\code{="1998-JAN-01"}] (XMM SAS needs an arbitrary value)} +%\qualifier{combineGTIs}{[\code{=1}]: combine intervals that adjoin each other} +%\qualifier{verbose}{[\code{=1}]: tell when intervals are combined} %} %\description % Good time intervals are organized as \code{gti} structures diff --git a/src/FITS/fits_write_image.sl b/src/FITS/fits_write_image.sl index e1b69ac5582b02a05f4aa2997b5e10569e94dd65..cdaac24b61b86f3ef82901481c6499eb62b83306 100644 --- a/src/FITS/fits_write_image.sl +++ b/src/FITS/fits_write_image.sl @@ -6,7 +6,7 @@ define fits_write_image() %\altusage{fits_write_image(FITSfile, extname, image, [xvalues, yvalues[, xlabel, ylabel]][, comments]);} %} %\qualifiers{ -%\qualifier{WCS}{ [=\code{""}]: world coordinate system to use, e.g. \code{"P"}} +%\qualifier{WCS}{[=\code{""}]: world coordinate system to use, e.g. \code{"P"}} %} %\description % It is assumed that \code{x}/\code{yvalues} (if provided) are linear arrays, diff --git a/src/FITS/fits_write_pha_file.sl b/src/FITS/fits_write_pha_file.sl index ff2623a4d545286645a5877a5fb711e73b13a761..6edecea194ef8bfe9cb0ab03db5e07b006fe9ec5 100644 --- a/src/FITS/fits_write_pha_file.sl +++ b/src/FITS/fits_write_pha_file.sl @@ -26,26 +26,26 @@ define fits_write_pha_file() % directly from the data set. % %\qualifiers{ -%\qualifier{TELESCOP}{: the "telescope" (mission/satellite name) ["unknown"]} -%\qualifier{INSTRUME}{: the instrument/detector ["unknown"]} -%\qualifier{FILTER}{: the instrument filter in use (if any) ["none"]} -%\qualifier{EXPOSURE}{: the integration time (in seconds) for the PHA data +%\qualifier{TELESCOP}{the "telescope" (mission/satellite name) ["unknown"]} +%\qualifier{INSTRUME}{the instrument/detector ["unknown"]} +%\qualifier{FILTER}{the instrument filter in use (if any) ["none"]} +%\qualifier{EXPOSURE}{the integration time (in seconds) for the PHA data % (assumed to be corrected for deadtime, data drop-outs etc. ) [1.0]} -%\qualifier{AREASCAL}{: nominal effective area [1.0]} -%\qualifier{BACKFILE}{: the name of the corresponding background file (if any) ["none"]} -%\qualifier{BACKSCAL}{: background scale factor [1.0]} -%\qualifier{CORRFILE}{: the name of the corresponding correction file (if any) ["none"]} -%\qualifier{CORRSCAL}{: the correction scaling factor [1.0]} -%\qualifier{RESPFILE}{: the name of the corresponding (default) redistribution matrix file ["none"]} -%\qualifier{ANCRFILE}{: the name of the corresponding (default) ancillary response file ["none"]} -%\qualifier{HDUCLASS}{: should contain the string "OGIP" to indicate that this is an OGIP style file ["OGIP"]} -%\qualifier{HDUCLAS1}{: should contain the string "SPECTRUM" to indicate this is a spectrum ["SPECTRUM"]} -%\qualifier{HDUCLAS2}{: indicating the type of data stored: "TOTAL", "NET", "BKG" ["TOTAL"]} -%\qualifier{HDUVERS1}{: the version number of the format ["1.2.1"]} -%\qualifier{CHANTYPE}{: whether the channels used in the file have been corrected in anyway, +%\qualifier{AREASCAL}{nominal effective area [1.0]} +%\qualifier{BACKFILE}{the name of the corresponding background file (if any) ["none"]} +%\qualifier{BACKSCAL}{background scale factor [1.0]} +%\qualifier{CORRFILE}{the name of the corresponding correction file (if any) ["none"]} +%\qualifier{CORRSCAL}{the correction scaling factor [1.0]} +%\qualifier{RESPFILE}{the name of the corresponding (default) redistribution matrix file ["none"]} +%\qualifier{ANCRFILE}{the name of the corresponding (default) ancillary response file ["none"]} +%\qualifier{HDUCLASS}{should contain the string "OGIP" to indicate that this is an OGIP style file ["OGIP"]} +%\qualifier{HDUCLAS1}{should contain the string "SPECTRUM" to indicate this is a spectrum ["SPECTRUM"]} +%\qualifier{HDUCLAS2}{indicating the type of data stored: "TOTAL", "NET", "BKG" ["TOTAL"]} +%\qualifier{HDUVERS1}{the version number of the format ["1.2.1"]} +%\qualifier{CHANTYPE}{whether the channels used in the file have been corrected in anyway, % values: "PHA" or "PI" (see also CAL/GEN/92-002, George et al. 1992, Section 7) % ["PHA"]} -%\qualifier{start_channel}{: start value of 'channel' column [1]} +%\qualifier{start_channel}{start value of 'channel' column [1]} %} % % \seealso{Definition of PHA FITS format: OGIP/92-007 and OGIP/92-007a} diff --git a/src/FITS/fits_write_rmf.sl b/src/FITS/fits_write_rmf.sl index f72dd0099d80e5d05b6d187272fb55892455b766..d7393f623014dd7bf14d0bba48076a5417bed6eb 100644 --- a/src/FITS/fits_write_rmf.sl +++ b/src/FITS/fits_write_rmf.sl @@ -4,18 +4,18 @@ define fits_write_rmf() %\synopsis{Write a FITS response matrix file} %\usage{fits_write_rmf(rmfname,rmf;qualifiers);} % \qualifiers{ -% \qualifier{telescope}{: telescope for the response} -% \qualifier{instrument}{: instrument for the response} -% \qualifier{filter}{: filter of the instrument} -% \qualifier{detnam}{: name of the detector} -% \qualifier{effarea}{: effective area of the detector (default: 1cm**2)} -% \qualifier{lo_thresh}{: lower threshold of the matrix, i.e., values below +% \qualifier{telescope}{telescope for the response} +% \qualifier{instrument}{instrument for the response} +% \qualifier{filter}{filter of the instrument} +% \qualifier{detnam}{name of the detector} +% \qualifier{effarea}{effective area of the detector (default: 1cm**2)} +% \qualifier{lo_thresh}{lower threshold of the matrix, i.e., values below % this number have been set to zero. Default: 0.} -% \qualifier{chantype}{: see FITS RMF specification (default: PI)} -% \qualifier{channel}{: array of channel numbers for the ebounds extension +% \qualifier{chantype}{see FITS RMF specification (default: PI)} +% \qualifier{channel}{array of channel numbers for the ebounds extension % (default: channels are assumed to start at 1)} -% \qualifier{origin}{: who write this file (default: ECAP)} -% \qualifier{constantwidth}{: write data with width constantwidth around +% \qualifier{origin}{who write this file (default: ECAP)} +% \qualifier{constantwidth}{write data with width constantwidth around % maximum of the matrix.} %} %\description diff --git a/src/FITS/fits_write_tex_table.sl b/src/FITS/fits_write_tex_table.sl index 70e4169b65a24e108efd9e13035fed9b8bd9bfde..32db9692dccfa7fe5c40bdcc66d5bdd3242182fe 100644 --- a/src/FITS/fits_write_tex_table.sl +++ b/src/FITS/fits_write_tex_table.sl @@ -8,35 +8,35 @@ define fits_write_tex_table() %\usage{fits_write_tex_table(String_Type inputFile);} % %\qualifiers{ -%\qualifier{pars}{ : model names given as an array} -%\qualifier{exclude}{ parameters to exclude. One can give whole +%\qualifier{pars}{model names given as an array} +%\qualifier{exclude}{parameters to exclude. One can give whole % parameter name as is written in the window output, or just a main % part of it (see examples below).} -%\qualifier{extraInfo}{: extra information such as target name, +%\qualifier{extraInfo}{extra information such as target name, % exposure, etc., the input name is given in % the fits header. This qualifier can lead to % nasty look of your table. } -%\qualifier{texMulti}{ : tries to fix long extraInfo output in your table.} -%\qualifier{everyPar}{ : parameter name as given can be used as a +%\qualifier{texMulti}{tries to fix long extraInfo output in your table.} +%\qualifier{everyPar}{parameter name as given can be used as a % qualifier itself for changing: % name, digits, factor and sciMode (see % TeX_value_pm_error on how to use them). % Example: % powerlaw_1_PhoIndex_value={"name","$\\Gamma$","digits",3} % } -%\qualifier{sci}{ : change scientific output in one step, for +%\qualifier{sci}{change scientific output in one step, for % an easier look of the value and its errors in the table. % sci=0 will give you maximally correct output. % sci=1 will also give you nice output, but may not % care about last significant digit.} -%\qualifier{colNames}{ : give new names for your output columns. Applicable +%\qualifier{colNames}{give new names for your output columns. Applicable % only when all names change.} -%\qualifier{fullStat}{ : prints also chi^2_red values.} -%\qualifier{silent}{ : No output generated.} -%\qualifier{flip}{ : flips the table.} -%\qualifier{pdf}{ : produces pdfout.pdf file for a quick look at +%\qualifier{fullStat}{prints also chi^2_red values.} +%\qualifier{silent}{No output generated.} +%\qualifier{flip}{flips the table.} +%\qualifier{pdf}{produces pdfout.pdf file for a quick look at % your table.} -%\qualifier{output}{ TeX output name, default is "default.tex"} +%\qualifier{output}{TeX output name, default is "default.tex"} %} %\description % - \code{inFile} input fits file produced by fits_save_fit. @@ -55,7 +55,7 @@ define fits_write_tex_table() % If issues emerge, contact refiz.duro@sternwarte.uni-erlangen.de. % % -% EXAMPLE: +%\example % % fits_write_tex_table("input.fits"; % pars=["cutoffpl","reflionx","diskbb","constant"] diff --git a/src/FITS/get_map_value_at_position.sl b/src/FITS/get_map_value_at_position.sl index b1235a88e2749e49afd283b92f4c246d8e4a6867..3a47c8154679e9c25f4f7cba5dde8f663c595794 100644 --- a/src/FITS/get_map_value_at_position.sl +++ b/src/FITS/get_map_value_at_position.sl @@ -5,7 +5,7 @@ require("fitswcs"); %\synopsis{Extract map value from ra/dec position} %\usage{Double_Type value = get_map_value_at_position(map,ra,dec);} %\qualifiers{ -%\qualifier{verbose}{: Output detector coordinates on display. Default: 0} +%\qualifier{verbose}{Output detector coordinates on display. Default: 0} %} %\description % This function returns the value of a map at a certain ra/dec position diff --git a/src/Mike/append_chain.sl b/src/Mike/append_chain.sl index 76a4b47efade0821b5e7c6f36ef657898e1c08ea..d0296a3bfab0554f4f0d428a524c6f944c488755 100644 --- a/src/Mike/append_chain.sl +++ b/src/Mike/append_chain.sl @@ -86,7 +86,7 @@ define append_chain () %\synopsis{Append a chain fits file to another chain fits file} %\usage{append_chain(String_Type chainfile1, String_Type chainfile2, String_Type chainoutfile)} %\qualifiers{ -%\qualifier{verbose}{: show progress} +%\qualifier{verbose}{show progress} %} %\description % This function takes two chains stored in chainfile1 and chainfile2 written with the write_chain function @@ -306,7 +306,7 @@ define combine_chain () %\synopsis{Combine several mcmc chains generated with the same configuration} %\usage{combine_chain(Array_Type chaininfiles, String_Type chainoutfile)} %\qualifiers{ -%\qualifier{verbose}{: show progress} +%\qualifier{verbose}{show progress} %} %\description % This function takes mcmc chains stored in files passed as an array of strings in chaininfiles, diff --git a/src/Mike/isis_emcee_hammer.sl b/src/Mike/isis_emcee_hammer.sl index 3b2e2c09e6376b9a809d89c01c5d7bc9ff8eb2e0..8b2ae87e489413f923ea4173bce568ae21f05fd8 100644 --- a/src/Mike/isis_emcee_hammer.sl +++ b/src/Mike/isis_emcee_hammer.sl @@ -1229,15 +1229,15 @@ public define emcee_merge() %{{{ %\usage{emcee_merge( String_Type[] InFiles, String_Type OutFile)} %\altusage{emcee_merge( String_Type[] InFiles )} %\qualifiers{ -%\qualifier{chatty: }{If given, enable informative output.} -%\qualifier{force: }{If given, overwrite existing OutFile.} -%\qualifier{adjuststeps: }{If given, do not disregard InFiles with different #simsteps. +%\qualifier{chatty}{If given, enable informative output.} +%\qualifier{force}{If given, overwrite existing OutFile.} +%\qualifier{adjuststeps}{If given, do not disregard InFiles with different #simsteps. % Instead cut all InFiles to min(#simsteps).} -%\qualifier{ncut[=0]: }{#sim. steps to be cut from the start of the chains.} -%\qualifier{autocut: }{If given, 'ncut' is automatically set, s.t. the faulty sim. steps +%\qualifier{ncut}{[=0] #sim. steps to be cut from the start of the chains.} +%\qualifier{autocut}{If given, 'ncut' is automatically set, s.t. the faulty sim. steps % containing ZERO entries are deleted. These entries corresponds % to the initialisation of the walkers.} -%\qualifier{id[=0]: }{Index of the InFiles to check consistency to.} +%\qualifier{id[=0]}{Index of the InFiles to check consistency to.} %} %\description % Merge several FITS Infiles created with emcee into one OutFile. It is required that @@ -1534,15 +1534,15 @@ public define emcee_chain_hist_collect() %{{{ %\usage{Struct_Type[] chist = emcee_chain_hist_collect( String_Type[] InFiles, Interger_Type[] PID )} %\altusage{Struct_Type[] chist = emcee_chain_hist_collect( String_Type[] InFiles )} %\qualifiers{ -%\qualifier{chatty: }{If given, enable informative output.} -%\qualifier{ncut[=0]: }{#sim. steps to be cut from the start of the chains.} -%\qualifier{autocut: }{If given, 'ncut' is automatically set, s.t. the faulty sim. steps +%\qualifier{chatty}{If given, enable informative output.} +%\qualifier{ncut}{[=0] #sim. steps to be cut from the start of the chains.} +%\qualifier{autocut}{If given, 'ncut' is automatically set, s.t. the faulty sim. steps % containing ZERO entries are deleted. These entries corresponds % to the initialisation of the walkers.} -%\qualifier{id[=0]: }{Index of the InFiles to check consistency to.} -%\qualifier{nbin[=100]: }{Number of histogram bins.} -%\qualifier{pmin: }{Double_Type[length(PID)]: Containing parmater lower limits.} -%\qualifier{pmax: }{Double_Type[length(PID)]: Containing parmater upper limits.} +%\qualifier{id[=0]}{Index of the InFiles to check consistency to.} +%\qualifier{nbin[=100]}{Number of histogram bins.} +%\qualifier{pmin}{Double_Type[length(PID)]: Containing parmater lower limits.} +%\qualifier{pmax}{Double_Type[length(PID)]: Containing parmater upper limits.} %} %\description % Generate parameter histograms by collecting chains from several FITS Infiles diff --git a/src/Mike/isis_fancy_plots.sl b/src/Mike/isis_fancy_plots.sl index 716fc56d8985cb3a416946594f60555b3c37dcf4..65a655d1161dbccc963e3a1559beea10b102e3a8 100644 --- a/src/Mike/isis_fancy_plots.sl +++ b/src/Mike/isis_fancy_plots.sl @@ -107,9 +107,6 @@ public define pg_info() %\function{pg_info} %\synopsis{Print a core dump of some useful pgplot and isis_fancy_plots information.} %\usage{pg_info; -or- pginfo;} -%\qualifiers{ -%\qualifier{NONE}{} -%} %\description %\seealso{Nearly all isis_fancy_plot functions return a use message if invoked without arguments} %!%- @@ -117,9 +114,6 @@ public define pg_info() %\function{pginfo} %\synopsis{Print a core dump of some useful pgplot and isis_fancy_plots information.} %\usage{pg_info; -or- pginfo;} -%\qualifiers{ -%\qualifier{NONE}{} -%} %\description %\seealso{Nearly all isis_fancy_plot functions return a use message if invoked without arguments} %!%- @@ -448,14 +442,14 @@ public define set_plot_widths() %\synopsis{Sets plot widths for isis_fancy_plots package} %\usage{set_plot_widths([;qualifiers]);} %\qualifiers{ -%\qualifier{m_width}{ : Model line width} -%\qualifier{d_width}{ : Data line width} -%\qualifier{de_width}{ : Data error bar line width} -%\qualifier{r_width}{ : Residual line width} -%\qualifier{re_width}{ : Residual error bar line width} -%\qualifier{ebar_x}{ : X error bar term cap length} -%\qualifier{ebar_y}{ : Y error bar term cap length} -%\qualifier{data_err}{ : !=0 X error bars plotted} +%\qualifier{m_width}{Model line width} +%\qualifier{d_width}{Data line width} +%\qualifier{de_width}{Data error bar line width} +%\qualifier{r_width}{Residual line width} +%\qualifier{re_width}{Residual error bar line width} +%\qualifier{ebar_x}{X error bar term cap length} +%\qualifier{ebar_y}{Y error bar term cap length} +%\qualifier{data_err}{!=0 X error bars plotted} %} %\description % @@ -520,12 +514,12 @@ public define reset_plot_defaults() %\synopsis{Changes some of the defaults on the isis_fancy_plots package} %\usage{reset_plot_defaults(;dcol=Integer_Type, ...);} %\qualifiers{ -%\qualifier{dcol}{ : Data color value} -%\qualifier{dsym}{ : Data symbol value} -%\qualifier{mcol}{ : Model color value} -%\qualifier{sum_exp}{ : !=0, Sum the exposures when combining data} -%\qualifier{use_con_flux}{ : !=0, the unfolded model includes response smearing} -%\qualifier{gap}{ : ==0, plot models across data gaps.} +%\qualifier{dcol}{Data color value} +%\qualifier{dsym}{Data symbol value} +%\qualifier{mcol}{Model color value} +%\qualifier{sum_exp}{!=0, Sum the exposures when combining data} +%\qualifier{use_con_flux}{!=0, the unfolded model includes response smearing} +%\qualifier{gap}{==0, plot models across data gaps.} %} %\description % @@ -638,9 +632,9 @@ public define set_plot_labels() %!%+ %\function{set_plot_labels} %\synopsis{Restore default plot labels of isis_fancy_plots package} -%\usage{set_plot_labels(;pg_font="\\\\fr") -or- set_plot_labels(;pg_font=``\\fr``)} +%\usage{set_plot_labels(;pg_font="\\\\fr") -or- set_plot_labels(;pg_font=``\\\\fr``)} %\qualifiers{ -%\qualifier{pg_font}{ : ="\\\\fn", "\\\\fr", "\\\\fs", or "\\\\fi"} +%\qualifier{pg_font}{="\\\\fn", "\\\\fr", "\\\\fs", or "\\\\fi"} %} %\description %\seealso{new_plot_labels, fancy_plot_unit, add_plot_unit} @@ -802,14 +796,14 @@ public define new_plot_labels() %\synopsis{Create new plot labels for routines in isis_fancy_plots package.} %\usage{new_plot_labels(String_Type [, String_Type]);} %\qualifiers{ -%\qualifier{xlabel}{ : New X-axis label} -%\qualifier{ylabel}{ : String array with new Y-axis labels for data} -%\qualifier{rlabel}{ : String array with new Y-axis labels for residuals} -%\qualifier{clabel}{ : String array with new Y-axis residual labels for Cash statistics} -%\qualifier{mllabel}{ : String array with new Y-axis residual labels for Maximum Likelihood statistics} -%\qualifier{vlabel}{ : String with new Doppler velocity X-axis label} -%\qualifier{zlabel}{ : String with new redshift X-axis label} -%\qualifier{pg_font}{ : PGPLOT font type (default is \\fr)} +%\qualifier{xlabel}{New X-axis label} +%\qualifier{ylabel}{String array with new Y-axis labels for data} +%\qualifier{rlabel}{String array with new Y-axis labels for residuals} +%\qualifier{clabel}{String array with new Y-axis residual labels for Cash statistics} +%\qualifier{mllabel}{String array with new Y-axis residual labels for Maximum Likelihood statistics} +%\qualifier{vlabel}{String with new Doppler velocity X-axis label} +%\qualifier{zlabel}{String with new redshift X-axis label} +%\qualifier{pg_font}{PGPLOT font type (default is \\\\fr)} %} %\description % @@ -823,7 +817,7 @@ public define new_plot_labels() % % Use: % -% set_plot_labels(;pg_font="\\\\fr") -or- set_plot_labels(;pg_font=``\\fr``) +% set_plot_labels(;pg_font="\\\\fr") -or- set_plot_labels(;pg_font=``\\\\fr``) % % to restore defaults. % @@ -845,8 +839,8 @@ public define new_plot_labels() % 2 or 5, which yield +/-sqrt(|Delta ML|), Delta ML, respectively] % vlabel : String with new Doppler velocity X-axis label % zlabel : String with new Redshift X-axis label -% pg_font: "\\fn", "\\fr", "\\fi", "\\fs" = normal, roman, italic, -% or script fonts will be used on the labels (Default is \\fr.) +% pg_font: "\\\\fn", "\\\\fr", "\\\\fi", "\\\\fs" = normal, roman, italic, +% or script fonts will be used on the labels (Default is \\\\fr.) %\seealso{set_plot_labels, fancy_plot_unit, add_plot_unit} %!%- { @@ -2989,8 +2983,8 @@ public define write_plot() %\synopsis{Write the data from the last plot made with the isis_fancy_plots package } %\usage{[pd =] write_plot(root; head=0, data);} %\qualifiers{ -%\qualifier{head}{ : ==0 to suppress header in output file} -%\qualifier{data}{ : if set, return data as a structure instead} +%\qualifier{head}{==0 to suppress header in output file} +%\qualifier{data}{if set, return data as a structure instead} %} %\description % @@ -3813,8 +3807,8 @@ public define plot_unfold() % con_mod= 1 (default), the smear the model by the detector response, otherwise % plot the unsmeared model at the internal resolution of the arf % -% Note: Model flux is: ( \\int dE S(E) )/dE, while data is -% (C(h) - B(h))/(\\int R(h,E) A(E) dE)/dh/t, where A(E) is effective area, +% Note: Model flux is: ( \\\\int dE S(E) )/dE, while data is +% (C(h) - B(h))/(\\\\int R(h,E) A(E) dE)/dh/t, where A(E) is effective area, % R(h,E) is RMF, C(h)/B(h) are total/background counts. Thus, the data % and model will match best only in the limit of a delta function RMF, % and in fact might look different than the residuals (which is the @@ -4222,11 +4216,9 @@ public define plot_comps() %!%+ %\function{plot_comps} %\synopsis{Create a data plot with model components explicitly shown (isis_fancy_plots package)} +%\usage{plot_comps({data},&plot_func;dcol={val},mcol={val},ccol={val},cstyle=val,...);} +%\altusage{plot_comps({data},pstrut,&plot_func); where pstruct=struct{dcol, mcol, ...}} %\description -% -%plot_comps({data},pstruct,&plot_func); % pstruct=struct{dcol, mcol, ...} -%plot_comps({data},&plot_func;dcol={val},mcol={val},ccol={val},cstyle=val,...); -% % Use a fancy plotting function, e.g., plot_counts or plot_data or % plot unfold, passed as a reference, and cycle through all the % components with a norm parameter. Plot each of these as a separate @@ -4239,11 +4231,12 @@ public define plot_comps() % model components. (I.e., only one alternate line_style can be % chosen.) data is the usual combination of integers (=individual % data sets), arrays (=data sets to be combined), and lists (=id of -% combined datasets). Examples: +% combined datasets). % +%\examples % plot_comps({1,[2,3]},popt,&plot_counts;xrange={1,10}); % plot_comps({5,8},&plot_unfold); -% plot_comps{{{1}},popt,&plot_data); +% plot_comps({{1}},popt,&plot_data); %\seealso{plot_counts, plot_data, plot_unfold, plot_residuals, plot_fit_model, plotxy, plot_comps, plot_double} %!%- { @@ -4275,7 +4268,7 @@ plot_comps({data},&plot_func;dcol={val},mcol={val},ccol={val},cstyle=val,...); plot_comps({1,[2,3]},popt,&plot_counts;xrange={1,10}); plot_comps({5,8},&plot_unfold); - plot_comps{{{1}},popt,&plot_data); + plot_comps({{1}},popt,&plot_data); ` ); %%%}}} return; } @@ -4543,11 +4536,12 @@ public define plot_double() % two applying to plot_funcI, the next two applying to plot_funcII, % and the final two applying to the residuals. If power is a list of % two elements, then the first element applies to plot_funcI and the -% second element applies to plot_funcII. Examples: +% second element applies to plot_funcII. % +%\examples % plot_double({1,[2,3]},popt,&plot_unfold,&plot_counts;xrange={1,10}); % plot_double({5,8},&plot_unfold,&plot_data); -% plot_double{{{1}},popt,&plot_data,&plot_counts); +% plot_double({{1}},popt,&plot_data,&plot_counts); %\seealso{plot_counts, plot_data, plot_unfold, plot_residuals, plot_fit_model, plotxy, plot_comps, plot_double} %!%- { @@ -4587,7 +4581,7 @@ plot_double({data},&plot_funcI,&plot_funcII;dcol={val},mcol={val},ccol={val},... plot_double({1,[2,3]},popt,&plot_unfold,&plot_counts;xrange={1,10}); plot_double({5,8},&plot_unfold,&plot_data); - plot_double{{{1}},popt,&plot_data,&plot_counts); + plot_double({{1}},popt,&plot_data,&plot_counts); ` ); %%%}}} return; } diff --git a/src/Mike/isisrc_data.sl b/src/Mike/isisrc_data.sl index 42df1e14d978b3ffd8b85d4a87b66305855df762..a1a27eb64abd2ef7e7c2fa97a1ecfe9868b52598 100644 --- a/src/Mike/isisrc_data.sl +++ b/src/Mike/isisrc_data.sl @@ -80,9 +80,9 @@ public define load_scaled_data() %\synopsis{Loads a dataset with a non-unity AREASCAL keyword or column} %\usage{id = load_scaled_data( String_Type file);} %\qualifiers{ -%\qualifier{rmf}{ [="rmf.fits", response file if not in data header]} -%\qualifier{arf}{ [="arf.fits", effective area file if not in data header]} -%\qualifier{bkg}{ [="bkg.fits", background file if not in data header]} +%\qualifier{rmf}{[="rmf.fits", response file if not in data header]} +%\qualifier{arf}{[="arf.fits", effective area file if not in data header]} +%\qualifier{bkg}{[="bkg.fits", background file if not in data header]} %} %\description % Load a data file with a non-unity AREASCAL, rewrite the @@ -579,7 +579,7 @@ public define clear_all() %\synopsis{Deletes data & corresponding ARFs and RMFs} %\usage{clear_all();} %\qualifiers{ -%\qualifier{noprompt}{ avoid the prompt in scripts} +%\qualifier{noprompt}{avoid the prompt in scripts} %} %\description % Deletes all data, the corresponding ARFs and RMFS, as well diff --git a/src/Mike/sitar.sl b/src/Mike/sitar.sl index 2b55e1d875a430e621e7f1ec36ff0e169cc93fdf..19885d7a979cf5904b677132b254a37979f197cf 100644 --- a/src/Mike/sitar.sl +++ b/src/Mike/sitar.sl @@ -1017,12 +1017,12 @@ public define sitar_readasm( ) %\synopsis{Read and RXTE ASM data file} %\usage{event = sitar_readasm( file );} %\qualifiers{ -%\qualifier{tstart}{ [Start time to be read; units of MET or MJD]} -%\qualifier{tstop}{ [Stop time to be read; units of MET or MJD]} -%\qualifier{maxchi2}{ [Maximum acceptable chi2 for ASM solution]} -%\qualifier{chnl}{ [0 for total band; !=0 for three ASM colors+total]} -%\qualifier{mjd}{ [Changes from default of Mission Elapsed Time (days) to MJD]} -%\qualifier{jd}{ [Changes from default of Mission Elapsed Time (days) to JD]} +%\qualifier{tstart}{[Start time to be read; units of MET or MJD]} +%\qualifier{tstop}{[Stop time to be read; units of MET or MJD]} +%\qualifier{maxchi2}{[Maximum acceptable chi2 for ASM solution]} +%\qualifier{chnl}{[0 for total band; !=0 for three ASM colors+total]} +%\qualifier{mjd}{[Changes from default of Mission Elapsed Time (days) to MJD]} +%\qualifier{jd}{[Changes from default of Mission Elapsed Time (days) to JD]} %} %\description % Inputs: @@ -1270,13 +1270,13 @@ public define sitar_rebin_rate( ) %\synopsis{Rebin a rate lightcurve} %\usage{lc = sitar_rebin_rate(t,dt,rate [,err]);} %\qualifiers{ -%\qualifier{tstart}{ [Beginning of first output time bin]} -%\qualifier{tstop}{ [End of last output time bin]} -%\qualifier{minbin}{ [Minimum required events per bin, else the bin is set to 0, or ignored. Default=1.]} -%\qualifier{user_bin.lo}{ [Lower time bounds for user defined grid]} -%\qualifier{user_bin.hi}{ [Upper time bounds for a user defined grid. Overrides dt, tstart, and tstop inputs]} -%\qualifier{delgap}{ [If set, delete empty bins from the lightcurve, otherwise, set them to 0]} -%\qualifier{weight}{ [If set and err input, the mean is weighted by the error. I.e., mean = (\\sum rate/err^2)/(\\sum 1/err^2), and the output variance becomes (\\sum (mean-rate/err^2)^2)/(\\sum 1/err^2)^2]} +%\qualifier{tstart}{[Beginning of first output time bin]} +%\qualifier{tstop}{[End of last output time bin]} +%\qualifier{minbin}{[Minimum required events per bin, else the bin is set to 0, or ignored. Default=1.]} +%\qualifier{user_bin.lo}{[Lower time bounds for user defined grid]} +%\qualifier{user_bin.hi}{[Upper time bounds for a user defined grid. Overrides dt, tstart, and tstop inputs]} +%\qualifier{delgap}{[If set, delete empty bins from the lightcurve, otherwise, set them to 0]} +%\qualifier{weight}{[If set and err input, the mean is weighted by the error. I.e., mean = (\\\\sum rate/err^2)/(\\\\sum 1/err^2), and the output variance becomes (\\\\sum (mean-rate/err^2)^2)/(\\\\sum 1/err^2)^2]} %} %\description % Variables in [] are optional, but are order specific unless a qualifier. @@ -1300,7 +1300,7 @@ public define sitar_rebin_rate( ) % % Optional Outputs: % lc.err : Rate errors combined in quadrature, i.e., it's -% sqrt{\\sum{ err^2 }}/N, where N is the number of points +% sqrt{\\\\sum{ err^2 }}/N, where N is the number of points % in that particular bin (i.e., lc.num). Only computed if % err is input [otherwise, just use sqrt(lc.var)]. %\seealso{sitar_bin_events} @@ -1614,12 +1614,12 @@ public define sitar_pfold_rate( ) %\synopsis{Fold a rate-based lightcurve on a given period (with derivatives).} %\usage{profile = sitar_pfold_rate(t,rate,p);} %\qualifiers{ -%\qualifier{pdot}{ [Period derivative.]} -%\qualifier{pddot}{ [Period second derivative.]} -%\qualifier{nphs}{ [Number of phase bins in output folded lightcurve.]} -%\qualifier{tzero}{ [Time of zero phase. Default = t[0].]} -%\qualifier{phase_lo}{ [Arrays for phase bin boundaries (e.g., for uneven phase bins).]} -%\qualifier{phase_hi}{ [Arrays must be same length with matched boundaries. Supercedes nphs.]} +%\qualifier{pdot}{[Period derivative.]} +%\qualifier{pddot}{[Period second derivative.]} +%\qualifier{nphs}{[Number of phase bins in output folded lightcurve.]} +%\qualifier{tzero}{[Time of zero phase. Default = t[0].]} +%\qualifier{phase_lo}{[Arrays for phase bin boundaries (e.g., for uneven phase bins).]} +%\qualifier{phase_hi}{[Arrays must be same length with matched boundaries. Supercedes nphs.]} %} %\description % Inputs: @@ -1939,12 +1939,12 @@ public define sitar_pfold_event( ) %\synopsis{Fold an event-based lightcurve on a given period (with derivatives).} %\usage{profile = sitar_pfold_event(t, p, gti_lo, gti_hi);} %\qualifiers{ -%\qualifier{pdot}{ [Period derivative.]} -%\qualifier{pddot}{ [Period second derivative.]} -%\qualifier{nphs}{ [Number of phase bins in output folded lightcurve.]} -%\qualifier{tzero}{ [Time of zero phase. Default = t[0].]} -%\qualifier{phase_lo}{ [Arrays for phase bin boundaries (e.g., for uneven phase bins).]} -%\qualifier{phase_hi}{ [Arrays must be same length with matched boundaries. Supercedes nphs.]} +%\qualifier{pdot}{[Period derivative.]} +%\qualifier{pddot}{[Period second derivative.]} +%\qualifier{nphs}{[Number of phase bins in output folded lightcurve.]} +%\qualifier{tzero}{[Time of zero phase. Default = t[0].]} +%\qualifier{phase_lo}{[Arrays for phase bin boundaries (e.g., for uneven phase bins).]} +%\qualifier{phase_hi}{[Arrays must be same length with matched boundaries. Supercedes nphs.]} %} %\description % Inputs: @@ -2099,10 +2099,10 @@ public define sitar_epfold_rate( ) %\synopsis{Epoch fold a rate based lightcurve.} %\usage{fold = sitar_epfold_rate(t,rate [,pstart,pstop]);} %\qualifiers{ -%\qualifier{nphs}{ [Number of phase bins in folded lightcurve. Default=20.]} -%\qualifier{nsrch}{ [Number of periods to search. Default=20.]} -%\qualifier{loggrid}{ [If input, the period search grid is logarithmic]} -%\qualifier{prds}{ [Alternative array of periods to search prds supersedes pstart/pstop inputs]} +%\qualifier{nphs}{[Number of phase bins in folded lightcurve. Default=20.]} +%\qualifier{nsrch}{[Number of periods to search. Default=20.]} +%\qualifier{loggrid}{[If input, the period search grid is logarithmic]} +%\qualifier{prds}{[Alternative array of periods to search prds supersedes pstart/pstop inputs]} %} %\description % Variables omitted or set to 0 take on default values. @@ -2269,9 +2269,9 @@ public define sitar_avg_cpd() %\synopsis{Create an averaged cross power spectral density.} %\usage{(f,psd_a,psd_b,cpd,navg,avg_a,avg_b,) = sitar_avg_cpd(cnts_a,cnts_b,l);} %\qualifiers{ -%\qualifier{dt}{ [Length of evenly spaced bins. Default == 1.]} -%\qualifier{times}{ [Times of measurements (otherwise presumed to have no gaps).]} -%\qualifier{norm}{ [Determine PSD normalization convention. =1, 'Leahy normalization'. Poisson noise PSD == 2, in absence of deadtime effects. !=1, rms or Belloni-Hasinger or Miyamoto normalization, i.e., PSD == (rms)^2/Hz & Poisson noise== 2/Rate.]} +%\qualifier{dt}{[Length of evenly spaced bins. Default == 1.]} +%\qualifier{times}{[Times of measurements (otherwise presumed to have no gaps).]} +%\qualifier{norm}{[Determine PSD normalization convention. =1, 'Leahy normalization'. Poisson noise PSD == 2, in absence of deadtime effects. !=1, rms or Belloni-Hasinger or Miyamoto normalization, i.e., PSD == (rms)^2/Hz & Poisson noise== 2/Rate.]} %} %\description % Take an evenly spaced lightcurve (presumed counts vs. time), and @@ -2568,10 +2568,10 @@ public define sitar_avg_psd() %\synopsis{Create an averaged power spectral density.} %\usage{(f,psd,navg,avg_cnts [,psd_err]) = sitar_avg_psd(cnts,l);} %\qualifiers{ -%\qualifier{dt}{ [Length of evenly spaced bins. Default == 1.]} -%\qualifier{times}{ [Times of measurements (otherwise presumed to have no gaps).]} -%\qualifier{norm}{ [Determine PSD normalization convention. =1, Leahy normalization. Poisson noise PSD == 2, in absence of deadtime effects. !=1, rms or Belloni-Hasinger or Miyamoto normalization, i.e., PSD == (rms)^2/Hz & Poisson noise== 2/Rate.]} -%\qualifier{err}{ [If it exists, also return the PSD error calculated directly by assuming each sample has 100% error.]} +%\qualifier{dt}{[Length of evenly spaced bins. Default == 1.]} +%\qualifier{times}{[Times of measurements (otherwise presumed to have no gaps).]} +%\qualifier{norm}{[Determine PSD normalization convention. =1, Leahy normalization. Poisson noise PSD == 2, in absence of deadtime effects. !=1, rms or Belloni-Hasinger or Miyamoto normalization, i.e., PSD == (rms)^2/Hz & Poisson noise== 2/Rate.]} +%\qualifier{err}{[If it exists, also return the PSD error calculated directly by assuming each sample has 100% error.]} %} %\description % Take an evenly spaced lightcurve (presumed counts vs. time), and @@ -3186,9 +3186,9 @@ public define sitar_lbin_psd() %\synopsis{Logarithmically rebin a power spectral density.} %\usage{(aflo,afhi,apsd,nf [,anoise,apsd_err]) = sitar_lbin_psd(f,psd,dff);} %\qualifiers{ -%\qualifier{noise}{ [Array (*or single value*) of Poisson noise levels.]} -%\qualifier{rev}{ [If declared (i.e., 'isis> variable rev;') and input, rev returns the reverse indices for the binning (i.e., af[i] = mean( freq[ rev[i] ] ), etc.).]} -%\qualifier{psd_err}{ [Array of errors for the PSD, in which case a PSD error array will be returned.]} +%\qualifier{noise}{[Array (*or single value*) of Poisson noise levels.]} +%\qualifier{rev}{[If declared (i.e., 'isis> variable rev;') and input, rev returns the reverse indices for the binning (i.e., af[i] = mean( freq[ rev[i] ] ), etc.).]} +%\qualifier{psd_err}{[Array of errors for the PSD, in which case a PSD error array will be returned.]} %} %\description % Logarithmically rebin a PSD (and, optionally, its associated @@ -3380,7 +3380,7 @@ public define sitar_define_psd() %\synopsis{Store a power spectral density as a fittable dataset.} %\usage{id = sitar_define_psd(flo,fhi,psd,err [,noise]);} %\qualifiers{ -%\qualifier{noise}{ [Same as optional input, noise.]} +%\qualifier{noise}{[Same as optional input, noise.]} %} %\description % Inputs: @@ -3490,12 +3490,12 @@ public define sitar_glvary() %\synopsis{Create an optimal lightcurve using the Gregory-Loredo algorithm.} %\usage{gl = sitar_glvary(t);} %\qualifiers{ -%\qualifier{tmin}{ [The minimum time to consider. Default=min(t)-1]} -%\qualifier{tmax}{ [The maximum time to consider. Default=max(t)+1]} -%\qualifier{mmax}{ [Consider lightcurve divisions from 2 to mmax evenly spaced bins. Default=300.]} -%\qualifier{thresh }{ [Truncate the number of partitions by ignoring those for which \\sum_m(odds ratio) mmax. thresh sets a minimum probability: (1-p_min) ~ exp(thresh)*(1-p_peak). Default=2.]} -%\qualifier{nbins}{ [Create an output lightcurve with nbins. Default=mmax.]} -%\qualifier{texp, frac_exp}{ [Array pair that give for fractional exposure as a function of time, which will be interpolated and used to correct lightcurve rates. Arrays must have a minimum of five entries. Default is for no correction.]} +%\qualifier{tmin}{[The minimum time to consider. Default=min(t)-1]} +%\qualifier{tmax}{[The maximum time to consider. Default=max(t)+1]} +%\qualifier{mmax}{[Consider lightcurve divisions from 2 to mmax evenly spaced bins. Default=300.]} +%\qualifier{thresh }{[Truncate the number of partitions by ignoring those for which \\\\sum_m(odds ratio) mmax. thresh sets a minimum probability: (1-p_min) ~ exp(thresh)*(1-p_peak). Default=2.]} +%\qualifier{nbins}{[Create an output lightcurve with nbins. Default=mmax.]} +%\qualifier{texp, frac_exp}{[Array pair that give for fractional exposure as a function of time, which will be interpolated and used to correct lightcurve rates. Arrays must have a minimum of five entries. Default is for no correction.]} %} %\description % Use the Gregory-Loredo algorithm to find the odds ratios that @@ -3861,13 +3861,13 @@ public define sitar_bin_events( ) %\synopsis{Bin an event-based lightcurve.} %\usage{lc = sitar_bin_events(t,dt,gti_lo,gti_hi);} %\qualifiers{ -%\qualifier{tstart}{ [Beginning of first output time bin. Default: min(t).]} -%\qualifier{tstop}{ [End of last output time bin. Default: max(t).]} -%\qualifier{obin}{ [For a tstop, last bin width might be < dt. Include this overflow bin if width is > obin*dt. Default: obin=0.1.]} -%\qualifier{user_bin.lo}{ [Lower time bounds for user defined grid.]} -%\qualifier{user_bin.hi}{ [Upper time bounds for a user defined grid. Overrides dt, tstart, and tstop inputs.]} -%\qualifier{minexp}{ [Do not include bins with exposure < minexp. Default: 0.]} -%\qualifier{delgap}{ [If set, delete 0 exposure bins from the lightcurve, otherwise set their rate & error to 0.]} +%\qualifier{tstart}{[Beginning of first output time bin. Default: min(t).]} +%\qualifier{tstop}{[End of last output time bin. Default: max(t).]} +%\qualifier{obin}{[For a tstop, last bin width might be < dt. Include this overflow bin if width is > obin*dt. Default: obin=0.1.]} +%\qualifier{user_bin.lo}{[Lower time bounds for user defined grid.]} +%\qualifier{user_bin.hi}{[Upper time bounds for a user defined grid. Overrides dt, tstart, and tstop inputs.]} +%\qualifier{minexp}{[Do not include bins with exposure < minexp. Default: 0.]} +%\qualifier{delgap}{[If set, delete 0 exposure bins from the lightcurve, otherwise set their rate & error to 0.]} %} %\description % Inputs: diff --git a/src/data/GTI/filter_gti.sl b/src/data/GTI/filter_gti.sl index 294f31e30d510ac4511ddbe3f68e32da44416bd4..aa5d4c63f17909885b90e10e312adda6f3987149 100644 --- a/src/data/GTI/filter_gti.sl +++ b/src/data/GTI/filter_gti.sl @@ -4,13 +4,13 @@ define filter_gti() %\usage{Integer_Type ind[] = filter_gti(Double_Type time[], Struct_Type gti); % or filter_gti(Double_Type time_lo[], time_hi[], Struct_Type gti);} %\qualifiers{ -% \qualifier{minfracexp}{: minimum fractional exposure a time bin has to have, +% \qualifier{minfracexp}{minimum fractional exposure a time bin has to have, % otherwise it is considered bad (lightcurves only, default: 1e-4)} -% \qualifier{fracexp}{: if set to a reference, returns the fractional exposure +% \qualifier{fracexp}{if set to a reference, returns the fractional exposure % of each time bin (lightcurves only)} -% \qualifier{exposure}{: if set to a reference, returns the livetime +% \qualifier{exposure}{if set to a reference, returns the livetime % in each time bin (lightcurves only)} -% \qualifier{indarray}{: return an array of index arrays instead (in case +% \qualifier{indarray}{return an array of index arrays instead (in case % of events only)} %} %\description diff --git a/src/data/GTI/pulsar_GTI.sl b/src/data/GTI/pulsar_GTI.sl index bbdaa495342585654fcb5b045065e1374b461214..99f47ffc42363dc2db0a86316557f574513690ed 100644 --- a/src/data/GTI/pulsar_GTI.sl +++ b/src/data/GTI/pulsar_GTI.sl @@ -56,12 +56,12 @@ define pulsar_GTI(){ %{{{ %\synopsis{Calculates GTIs for pulse phase resolved spectroscopy} %\usage{pulsar_GTI(Double_Type tstart, tstop, String_Type satellite, basefilename, Double_Type t0, p, phase_lo, phase_hi);} %\qualifiers{ -%\qualifier{pdot}{: first derivative of the pulse period in s/s (default: 0) } -%\qualifier{pddot}{: second derivative of the pulse period in s/s^2 (default: 0) } -%\qualifier{MJD}{: If set, tstart, tstop and t0 are assumed to in MJD} -%\qualifier{local}{: create GTIs in satellite's local time system. Requires qualifiers 'nobarevt' and 'barevt' to be set.} -%\qualifier{barevt}{: event file in barycentered time frame} -%\qualifier{nobarevt}{: event file in local time frame} +%\qualifier{pdot}{first derivative of the pulse period in s/s (default: 0) } +%\qualifier{pddot}{second derivative of the pulse period in s/s^2 (default: 0) } +%\qualifier{MJD}{If set, tstart, tstop and t0 are assumed to in MJD} +%\qualifier{local}{create GTIs in satellite's local time system. Requires qualifiers 'nobarevt' and 'barevt' to be set.} +%\qualifier{barevt}{event file in barycentered time frame} +%\qualifier{nobarevt}{event file in local time frame} %\qualifier{}{all other qualifiers are passed to BinaryPos} %} %\description diff --git a/src/data/data_response.sl b/src/data/data_response.sl index 84c618bf899ea9c92a1c84815c71e24c3f6f792e..09e45afd2591c780a510a628eebc6a9efea5866a 100644 --- a/src/data/data_response.sl +++ b/src/data/data_response.sl @@ -64,7 +64,7 @@ define get_dataset_response () %\usage{Response = get_dataset_response(id, [channel]);} %\synopsis{Compute response of dataset associated to 'id' to delta peak} %\qualifiers{ -%\qualifier{energy}{: If given, return response on energy grid (default: wavelength)} +%\qualifier{energy}{If given, return response on energy grid (default: wavelength)} %} %\description % This function evaluates a delta peak function set at each nominal diff --git a/src/data/flux2lum.sl b/src/data/flux2lum.sl index 66e2e79b23cf248970a58fafe7de89c9065a4351..538218a6e3919cc1d91feb9d3de3841e4d8929f0 100644 --- a/src/data/flux2lum.sl +++ b/src/data/flux2lum.sl @@ -7,16 +7,16 @@ define flux2lum() %\synopsis{Calculates the source luminosity} %\usage{Double_Type lum = flux2lum (Double_Type flux, Double_Type z);} %\qualifiers{ -%\qualifier{silent}{: If set, the program will not display adopted +%\qualifier{silent}{ If set, the program will not display adopted % cosmological parameters at the terminal.} -%\qualifier{h0 [=70]}{: Hubble parameter in km/s/Mpc} -%\qualifier{omega_m [=0.3]}{: Matter density, normalized to the closure density, +%\qualifier{h0}{[=70] Hubble parameter in km/s/Mpc} +%\qualifier{omega_m}{[=0.3] Matter density, normalized to the closure density, % default is 0.3. Must be non-negative.} -%\qualifier{omega_lambda [=0.7]}{: Cosmological constant, normalized to the +%\qualifier{omega_lambda}{[=0.7] Cosmological constant, normalized to the % critical density.} -%\qualifier{omega_k [=0]}{: curvature constant, normalized to the critical density. +%\qualifier{omega_k}{[=0] curvature constant, normalized to the critical density. % Default is 0, indicating a flat universe.} -%\qualifier{q0 [=-0.55]}{: Deceleration parameter, numeric scalar = -R*(R'')/(R')^2} +%\qualifier{q0}{[=-0.55] Deceleration parameter, numeric scalar = -R*(R'')/(R')^2} %} %\description % This function calculates the luminosity of a source diff --git a/src/data/get_count_rate.sl b/src/data/get_count_rate.sl index 1ed2fc17f948e3e6a22465c8a49d61d80d413702..60ac96afa71abf3caea80c3dbac3a2e0bf58fe86 100644 --- a/src/data/get_count_rate.sl +++ b/src/data/get_count_rate.sl @@ -45,38 +45,32 @@ define get_count_rate() % and respective uncertainties for spectra that have been loaded. % %\qualifiers{ -% -% tex: additional TeXoutput of CRs, choose this if you need -% values and uncertainties in LaTeX-format (only printed in terminal) -% bkg: 0 (default: background subtracted CR), 1 (count rates), -% 2 (background count rate) -% fake: Set this qualifier if you have a faked spectrum and a +% \qualifier{tex}{additional TeXoutput of CRs, choose this if you need +% values and uncertainties in LaTeX-format (only printed in terminal)} +% \qualifier{bkg}{0 (default: background subtracted CR), 1 (count rates), +% 2 (background count rate)} +% \qualifier{fake}{Set this qualifier if you have a faked spectrum and a % faked background (which has not been deleted!); -% Assumption: hist_index(bkg) = hist_index(dset) +1 !! -% fake_expo: set exposure time of fake spectrum, in case -% set_data_exposure was not used when faking -% bkg_id: set hist_index(bkg) if background is loaded or faked, if set to 0, no background -% is subtracted. Will overrule the id-setting made by fake-qualifier -% E_range: Set this qualifier if you want the countrate within +% Assumption: hist_index(bkg) = hist_index(dset) +1 !!} +% \qualifier{fake_expo}{set exposure time of fake spectrum, in case +% set_data_exposure was not used when faking} +% \qualifier{bkg_id}{set hist_index(bkg) if background is loaded or faked, if set to 0, no background +% is subtracted. Will overrule the id-setting made by fake-qualifier} +% \qualifier{E_range}{Set this qualifier if you want the countrate within % a certain energy range. Use E_range = [E_min , E_max]. -% If not given full energy range is used. (Energy in keV!) -% counts: if present function will only return counts instead of countrates -% err : if present function will return CR and respective uncertainty -% -% } -% +% If not given full energy range is used. (Energy in keV!)} +% \qualifier{counts}{if present function will only return counts instead +% of countrates} +% \qualifier{err}{if present function will return CR and +% respective uncertainty} %} -% -% -% -%EXAMPLE % +%\example % isis>xray = load_data("data.pha"); % isis>variable countrate = get_count_rate (1 ;tex, bkg=1 , E_range = [0.2 , 2.3]); % isis>variable counts , counts_err; % isis>(counts , counts_err) = get_count_rate (1 ;tex, bkg=1 , E_range = [0.2 , 2.3] , counts , err); % -% %\seealso{get_data_counts; TeX_value_pm_error; cut_dataset_range;} %!%- { diff --git a/src/data/lightcurve/color_color_data.sl b/src/data/lightcurve/color_color_data.sl index c39f9d577cac92d0fff49d73d075f3bb8824cceb..82eb749af69df371c291f522e13d47760dfc648f 100644 --- a/src/data/lightcurve/color_color_data.sl +++ b/src/data/lightcurve/color_color_data.sl @@ -6,8 +6,8 @@ define color_color_data() %\synopsis{extracts light curves in 3 consecutive bands and the corresponding colors from an event list} %\usage{Struct_Type dat = color_color_data(Struct_Type evts, Double_Type E0, E1, E2, E3);} %\qualifiers{ -%\qualifier{dt}{: time resolution [default: 100]} -%\qualifier{field}{: field used for selection of the bands [default: "pi"]} +%\qualifier{dt}{time resolution [default: 100]} +%\qualifier{field}{field used for selection of the bands [default: "pi"]} %} %\description % \code{dat.a} = lightcurve in "E0 <= field < E1" band\n diff --git a/src/data/lightcurve/lc_from_events.sl b/src/data/lightcurve/lc_from_events.sl index 3769c4cb1382b985f0836e7af8288de75981dc6c..d50961f78b7c674b2f6dda970ee569b060ef91de 100644 --- a/src/data/lightcurve/lc_from_events.sl +++ b/src/data/lightcurve/lc_from_events.sl @@ -22,10 +22,10 @@ define lc_from_events() %\synopsis{extracts light curves from an event list} %\usage{Struct_Type dat = lc_from_events(Struct_Type evts [, Array_Type bands]);} %\qualifiers{ -%\qualifier{dt}{: time resolution in sec [default: 100]} -%\qualifier{back}{ = Struct_Type b_evts : subtract background events} -%\qualifier{gti}{ = struct { Double_Type start, stop } : GTIs for events} -%\qualifier{minfracexp}{: minimum allowed fractional exposure of a time bin, requires GTIs to be set} +%\qualifier{dt}{time resolution in sec [default: 100]} +%\qualifier{back}{Struct_Type b_evts : subtract background events} +%\qualifier{gti}{struct { Double_Type start, stop } : GTIs for events} +%\qualifier{minfracexp}{minimum allowed fractional exposure of a time bin, requires GTIs to be set} %} %\description % This function extracts light curves from an event list given as the diff --git a/src/data/lightcurve/rebin_lc.sl b/src/data/lightcurve/rebin_lc.sl index 6f36a4903c23f03c42639671e746b6479814f4ff..8db08cf69864b1a4117c4e7ddc723d9372e27403 100644 --- a/src/data/lightcurve/rebin_lc.sl +++ b/src/data/lightcurve/rebin_lc.sl @@ -4,11 +4,11 @@ define rebin_lc() %\synopsis{rebins a lightcurve structure to a new time resolution} %\usage{Struct_Type new_lc = rebin_lc(Struct_Type lc, Double_Type new_dt);} %\qualifiers{ -%\qualifier{time}{[= \code{"time"}]: field name in the structure containing the time} -%\qualifier{rate}{[= \code{"rate"}]: field name(s) in the structure containing the rate(s)} -%\qualifier{error}{[= \code{"error"}]: field name(s) containig the corresponding error(s)} -%\qualifier{float}{: type cast rate(s) and error(s) to Float_Type} -%\qualifier{verbose}{: shows the assumed time resolution of the initial light curve} +%\qualifier{time}{[= \code{"time"}] field name in the structure containing the time} +%\qualifier{rate}{[= \code{"rate"}] field name(s) in the structure containing the rate(s)} +%\qualifier{error}{[= \code{"error"}] field name(s) containig the corresponding error(s)} +%\qualifier{float}{type cast rate(s) and error(s) to Float_Type} +%\qualifier{verbose}{shows the assumed time resolution of the initial light curve} %} %\description % The original light curve \code{lc} may contain discontinuities. diff --git a/src/data/lightcurve/sum_lc.sl b/src/data/lightcurve/sum_lc.sl index 59bc4815c9f9b31a757f3572d5e884f92df22658..8a3d9177aa874c92ffaf830d6a031dd533dac2e6 100644 --- a/src/data/lightcurve/sum_lc.sl +++ b/src/data/lightcurve/sum_lc.sl @@ -6,9 +6,9 @@ define sum_lc() %\synopsis{combines light curves from one structure} %\usage{Struct_Type sum_lc(Struct_Type lc, Array_Type inds)} %\qualifiers{ -%\qualifier{time}{: name of the time field (default: \code{"time"})} -%\qualifier{rate}{: format string for the rate field (default: \code{"rate%S"})} -%\qualifier{error}{: format string for the error field (default: \code{"error%S"})} +%\qualifier{time}{name of the time field (default: \code{"time"})} +%\qualifier{rate}{format string for the rate field (default: \code{"rate%S"})} +%\qualifier{error}{format string for the error field (default: \code{"error%S"})} %} %\description % The rates in the fields of \code{lc} (named by \code{inds} diff --git a/src/data/load_fermi.sl b/src/data/load_fermi.sl index 8863880f837117f104972b5b3de41ea593baadb7..9fda8bfab6dc5e3b0e8e23347ae521b8fe7b1f5c 100644 --- a/src/data/load_fermi.sl +++ b/src/data/load_fermi.sl @@ -71,7 +71,6 @@ define load_fermi()%{{{ % This function is not working if you have computed a Fermi spectrum % with Fermipy! % -% %\seealso{load_fermi_spectrum,load_fermi_catalog} %!%- { @@ -228,18 +227,19 @@ define load_fermi_catalog() %{{{ %\function{load_fermi_catalog} %\synopsis{loads Fermi data from a catalog for a given source} %\usage{Integer_Type data_id = load_fermi_catalog(String_Type sourcename); -% -% WARNING: Use clear_all to delete the correction factors (as well -% as the data). This is necessary as otherwise the correction factors -% are applied to a newly loaded dataset with the same ID. %} %\qualifiers{ -%\qualifier{list}{: return list of available sources} -%\qualifier{ul}{: Load includes upper limits} -%\qualifier{catalog}{: specify the catalog (default: 2FGL_point_source@Remeis) } -%\qualifier{fgl3}{: Use this when reading in the 3FGL catalog, either with +%\qualifier{list}{return list of available sources} +%\qualifier{ul}{Load includes upper limits} +%\qualifier{catalog}{specify the catalog (default: 2FGL_point_source@Remeis) } +%\qualifier{fgl3}{Use this when reading in the 3FGL catalog, either with % the catalog qualifier or without } %} +%\description +% WARNING: Use clear_all to delete the correction factors (as well +% as the data). This is necessary as otherwise the correction factors +% are applied to a newly loaded dataset with the same ID. +% %\seealso{load_fermi} %!%- { diff --git a/src/data/load_radio2.sl b/src/data/load_radio2.sl index 9dec0bfef25a767f7b5a1e05ecb60e4f8eb1da5f..b9ca914505e61c26eecf41c4dac0709d1895c706 100644 --- a/src/data/load_radio2.sl +++ b/src/data/load_radio2.sl @@ -18,8 +18,8 @@ define load_radio2() % WARNING: Bins cannot overlap, as grid needs to be continuous! % %\qualifiers{ -%\qualifier{binwidth}{: specify bin width} -%\qualifier{use_struct}{: use an ISIS structure with the +%\qualifier{binwidth}{ specify bin width} +%\qualifier{use_struct}{ use an ISIS structure with the % following fields: freq[Hz], % bandwidth[Hz], flux[mJy], err[mJy]; % with full bandwidth given} diff --git a/src/data/logging.sl b/src/data/logging.sl index 202c5a0a1808511f666158918f8c7ed876cfc768..141abd129fcabcb5b9114b4dca5ac1c0cdbb791a 100644 --- a/src/data/logging.sl +++ b/src/data/logging.sl @@ -14,7 +14,7 @@ define logging() % file. % %\qualifiers{ -%\qualifier{v}{: verbosity: [default: 1] print output also to stdout, set this +%\qualifier{v}{verbosity: [default: 1] print output also to stdout, set this % qualifier to 0 for no output to stdout} %} % diff --git a/src/data/nuFnu.sl b/src/data/nuFnu.sl index 95b71f4b4bdf67d0c7c2eb3b9feaaeca9f0f0175..7e9ec616b55df78dd79dc16d6df2e757cdd0d64f 100644 --- a/src/data/nuFnu.sl +++ b/src/data/nuFnu.sl @@ -44,10 +44,10 @@ define nuFnu() % number of counts. % %\qualifiers{ -%\qualifier{deabs}{: evaluate deabsorbed flux} -%\qualifier{ff}{: define deabsorbed fit function} -%\qualifier{numbin}{: define number of bins} -%\qualifier{group}{: define S/N for grouping} +%\qualifier{deabs}{ evaluate deabsorbed flux} +%\qualifier{ff}{ define deabsorbed fit function} +%\qualifier{numbin}{ define number of bins} +%\qualifier{group}{ define S/N for grouping} %} % %\example diff --git a/src/data/num_bin.sl b/src/data/num_bin.sl index 009662fabf56acc8f7dcf430ffe41703aa6ae1b3..acaeb6427fa37331240370deac7cb243b3d854a8 100644 --- a/src/data/num_bin.sl +++ b/src/data/num_bin.sl @@ -10,7 +10,7 @@ define num_bin() % Use this function to retrieve number of % noticed bins. %\qualifiers{ -% \qualifier{dof}{: gives degrees of freedom instead of number of bins} +% \qualifier{dof}{gives degrees of freedom instead of number of bins} %} % %\example diff --git a/src/data/pulsar/arrivaltimes.sl b/src/data/pulsar/arrivaltimes.sl index aaf7f66e43827607f1381837910cdc1632bc7e4d..b5bbf07e5e6c80ab168c5defd81d2ac8fdb40956 100644 --- a/src/data/pulsar/arrivaltimes.sl +++ b/src/data/pulsar/arrivaltimes.sl @@ -16,9 +16,9 @@ define atime_det() %\usage{Struct_Type atime_det(Struct_Type lc, Struct_Type[] pattern, Double_Type t0, Struct_Type ephemeris[, Struct_Type orbit]); % or Struct_Type atime_det(String_Type lc, Struct_Type[] pattern, Double_Type t0, Double_Type[] period[, Struct_Type orbit]);} %\qualifiers{ -% \qualifier{time}{ name of the time field in the FITS-file, +% \qualifier{time}{name of the time field in the FITS-file, % see fits_read_lc for details} -% \qualifier{indiv}{ determine individual pulses. If no value +% \qualifier{indiv}{determine individual pulses. If no value % is assigned, all arrival times are re- % turned. Otherwise a given integer sets % the number of pulses to average} diff --git a/src/data/pulsar/pulseperiod2phase.sl b/src/data/pulsar/pulseperiod2phase.sl index c826a12b7207486ed75b3223033f4e880bb5174b..b5ee929f71b225e40d2dbfdb8445f5a332635810 100644 --- a/src/data/pulsar/pulseperiod2phase.sl +++ b/src/data/pulsar/pulseperiod2phase.sl @@ -60,7 +60,7 @@ define pulseperiod2phase() % % In case orbital elements are provided, the additional % phase shift is calculated after Hilditch Eq 3.43: -% \\delta \\phi = z(t)/c (f0 \\dot{z}(t)/c - f(t-t0)) +% delta phi = z(t)/c (f0 zdot(t)/c - f(t-t0)) % with the projected position z(t) of the neutron star % and its spin frequency evolution f(t) = 1 / p(t), % where p(t) is the given pulse period evolution. diff --git a/src/data/pulsar/pulseprofile_de-compose.sl b/src/data/pulsar/pulseprofile_de-compose.sl index b114a4f8dbc65af991801aec9562e4a8a727be4f..a2a95e8f206b42238d14e5718f940b70ef519180 100644 --- a/src/data/pulsar/pulseprofile_de-compose.sl +++ b/src/data/pulsar/pulseprofile_de-compose.sl @@ -86,13 +86,15 @@ define pulseprofile_decompose() % The values for a_n and b_n only apply if % a_orders and b_orders are specified % (default: [0, mean(profile.value), 0..., 0...])} +% \qualifier{maxord}{highest order to use (if no specific orders for +% a or b are given; default: nbins/2-1)} %} %\description % The given pulse profile, F, of the form % struct { Double_Type[] bin_lo, bin_hi, value } % is fitted by a series of sine and cosine functions, % -% F(phi) = ampl + \\sum_n^N a_n*sin(2PI*(phi+phi_0)*n) +% F(phi) = ampl + sum_n^N a_n*sin(2PI*(phi+phi_0)*n) % + b_n*cos(2PI*(phi+phi_0)*n) % % where phi is the phase bin, ampl is the mean flux, N is @@ -133,10 +135,6 @@ define pulseprofile_decompose() % % order cosine coefficients only % variable decomp = pulseprofile_decompose(prof, [1], [2]); % ohplot(pulseprofile_compose(decomp)); -%\qualifiers{ -% maxord: highest order to use (if no specific orders for -% a or b are given; default: nbins/2-1) -%} %\seealso{pfold, pulseprofile_compose} %!%- { diff --git a/src/data/resolution_rebin.sl b/src/data/resolution_rebin.sl index 279413cea98de76f380cc3e19226edc12bbb764d..990da40f7e77114226bae924dd49ff19f978cbac 100644 --- a/src/data/resolution_rebin.sl +++ b/src/data/resolution_rebin.sl @@ -45,8 +45,8 @@ define resolution_rebin(id, instrument) { %\synopsis{Rebin spectra based on approximated detector resolution.} %\usage{Array_Type resolution_rebin(dataset_id, instrument; oversampling, min_counts);} %\qualifiers{ -%\qualifier{sampling}{: Float_Type, oversampling factor of detector resolution/bin width, default: 3} -%\qualifier{min_sn}{: Float_Type, minimum signal-to-noise ratio, default: 5} +%\qualifier{sampling}{Float_Type, oversampling factor of detector resolution/bin width, default: 3} +%\qualifier{min_sn}{Float_Type, minimum signal-to-noise ratio, default: 5} %} %\description % This function rebins a dataset to fulfill the following two criteria:\n diff --git a/src/data/savitzky_golay.sl b/src/data/savitzky_golay.sl index b58614327df54df7c59c7194d2642b4214c48d07..f3f1dc6cbe00811d2fc61faf192b849a34b70401 100644 --- a/src/data/savitzky_golay.sl +++ b/src/data/savitzky_golay.sl @@ -22,7 +22,7 @@ define savitzky_golay_coefficients() %{{{ %\notes % Requires GSL module. %\qualifiers{ -%\qualifier{derivative [=0]}{: Savitzky-Golay coefficients used for calculating the numerical +%\qualifier{derivative [=0]}{Savitzky-Golay coefficients used for calculating the numerical % derivative of the corresponding order (must not exceed `p', i.e., the order of % the polynomial).} %} @@ -105,14 +105,14 @@ define savitzky_golay_smoothing() %{{{ %\notes % Requires GSL module. %\qualifiers{ -%\qualifier{derivative [=0]}{: Apart from smoothing noisy data, the Savitzky-Golay method +%\qualifier{derivative [=0]}{Apart from smoothing noisy data, the Savitzky-Golay method % is also capable to compute numerical derivatives from the fitted polynomials. % In order to calculate the `k'-th derivative of the data, set this qualifier % equal to `k' and divide the returned array by the data stepsize to the power % of `k'. Note that `k' has to be a positive integer (otherwise it is replaced % by the next nearest integer of its absolute value). Note that `k' must not % exceed `p'.} -%\qualifier{periodic}{: Set this qualifer to assume periodic boundary conditions for your +%\qualifier{periodic}{Set this qualifer to assume periodic boundary conditions for your % data avoiding special treatment of data points close to the edges and thus % speeding up the computation. In this case, the condition `p' 'steppar_PID001.fits'} -%\qualifier{force}{: Forces to overwrite an existing file given with 'save'.} -%\qualifier{chatty}{: Prints fitting information.} +%\qualifier{force}{Forces to overwrite an existing file given with 'save'.} +%\qualifier{chatty}{Prints fitting information.} %} %\description % This function is calling 'steppar' with an adjusted fitting function: diff --git a/src/data/spectrum.datastructures/energyflux.sl b/src/data/spectrum.datastructures/energyflux.sl index a677843fa6b2a57837653566862377d36cbd4445..efb2adcdf46bba6593a1a2caba6a29c047952392 100644 --- a/src/data/spectrum.datastructures/energyflux.sl +++ b/src/data/spectrum.datastructures/energyflux.sl @@ -6,10 +6,10 @@ define energyflux() %\synopsis{evaluates the energy flux of the current fit model in a given energy range} %\usage{Double_Type energyflux(Double_Type Emin, Emax)} %\qualifiers{ -%\qualifier{factor}{ [=\code{1.001}]: step size of the logarithmic energy grid} -%\qualifier{Emin}{: minimum energy of (extended) grid} -%\qualifier{Emax}{: maximum energy of (extended) grid} -%\qualifier{cgs}{: return flux in erg/cm^2/s} +%\qualifier{factor}{[=\code{1.001}] step size of the logarithmic energy grid} +%\qualifier{Emin}{minimum energy of (extended) grid} +%\qualifier{Emax}{maximum energy of (extended) grid} +%\qualifier{cgs}{return flux in erg/cm^2/s} %} %\description % This function calculates the energy flux of the current best fit model diff --git a/src/data/spectrum.datastructures/get_combined_data_model_residuals.sl b/src/data/spectrum.datastructures/get_combined_data_model_residuals.sl index 50b622bcbcc3657470489a08f59b04e0efc4e76f..fb7279dbf6057657367eaee0a8ea804470e7a91b 100644 --- a/src/data/spectrum.datastructures/get_combined_data_model_residuals.sl +++ b/src/data/spectrum.datastructures/get_combined_data_model_residuals.sl @@ -13,7 +13,7 @@ define get_combined_data_model_residuals() % \code{r.value = (d.value-m.value)/d.err} contains the residuals % unless the \code{ratio} qualifier is set (see below). %\qualifiers{ -%\qualifier{ratio}{: use ratio-residuals \code{r.value = d.value/m.value}} +%\qualifier{ratio}{use ratio-residuals \code{r.value = d.value/m.value}} %} %\seealso{get_data_counts, get_model_counts, rebin} %!%- diff --git a/src/data/spectrum.datastructures/get_residuals.sl b/src/data/spectrum.datastructures/get_residuals.sl index 39cbbece86d319fce4d3c722fa536ebfc38b0e79..581fef6d92db9e54164bf2cc739625b7aa543a37 100644 --- a/src/data/spectrum.datastructures/get_residuals.sl +++ b/src/data/spectrum.datastructures/get_residuals.sl @@ -11,8 +11,8 @@ define get_residuals() % residuals obtained for the data set \code{id[i]}.\n % If only a scalar \code{id} is given, only a single structure is returned. %\qualifiers{ -%\qualifier{noticed}{: restrict to noticed bins} -%\qualifier{keV}{: convert Angstrom-bins to keV-bins} +%\qualifier{noticed}{restrict to noticed bins} +%\qualifier{keV}{convert Angstrom-bins to keV-bins} %} %\seealso{get_data_counts, get_model_counts, get_ratio} %!%- diff --git a/src/data/spectrum.datastructures/luminosity.sl b/src/data/spectrum.datastructures/luminosity.sl index ab079e3d27799a5002b7b7e6e4ae298f4cb73345..95e331a964bafa3e592de9ce96b002d5a39aab6f 100644 --- a/src/data/spectrum.datastructures/luminosity.sl +++ b/src/data/spectrum.datastructures/luminosity.sl @@ -6,9 +6,9 @@ define luminosity() %\synopsis{computes a source luminosity assuming the current fit-function and a distance} %\usage{Double_Type luminosity(Double_Type Emin, Emax, d);} %\qualifiers{ -%\qualifier{factor}{ [=\code{1.001}]: step of logarithmic energy grid} -%\qualifier{Emin}{: minimum energy of (extended) grid} -%\qualifier{Emax}{: maximum energy of (extended) grid} +%\qualifier{factor}{[=\code{1.001}] step of logarithmic energy grid} +%\qualifier{Emin}{minimum energy of (extended) grid} +%\qualifier{Emax}{maximum energy of (extended) grid} %} %\description % returns \code{4pi (d kpc)^2 * int_Emin^Emax E*S_E(E) dE} (in erg/s) diff --git a/src/data/spectrum.datastructures/plot_combined_data_model_residuals.sl b/src/data/spectrum.datastructures/plot_combined_data_model_residuals.sl index 796d2b87010eb0e87ce87b7e03aa8f4dbf55fb6e..1520833532fb5dbe6fbc30bd23d78f4845c50e5d 100644 --- a/src/data/spectrum.datastructures/plot_combined_data_model_residuals.sl +++ b/src/data/spectrum.datastructures/plot_combined_data_model_residuals.sl @@ -6,8 +6,8 @@ define plot_combined_data_model_residuals() %\synopsis{plots data and model counts, and residuals for a combination of data sets} %\usage{plot_combined_data_model_residuals([Integer_Type id[]]);} %\qualifiers{ -%\qualifier{dcol}{: color of data [default=1]} -%\qualifier{mcol}{: color of model [default=2]} +%\qualifier{dcol}{color of data [default=1]} +%\qualifier{mcol}{color of model [default=2]} %} %\description % If no indices \code{id} of data sets are specified, \code{all_data} are used.\n diff --git a/src/data/spectrum.loaddata/load_data_integral.sl b/src/data/spectrum.loaddata/load_data_integral.sl index 8d563ad7f6971d0f2ddc9534bc233281e1f91b4b..58883a831f10c99c770de8e138ee66ef43ac6faa 100644 --- a/src/data/spectrum.loaddata/load_data_integral.sl +++ b/src/data/spectrum.loaddata/load_data_integral.sl @@ -12,7 +12,7 @@ define load_data_integral() % The function load_data_integral tries to make the appropriate changes % (modify the extension names, write a new ARF file) and finally uses load_data. %\qualifiers{ -%\qualifier{verbose}{ [=1]: show changes} +%\qualifier{verbose}{[=1] show changes} %} %\seealso{load_data} %!%- diff --git a/src/data/timing/epferror.sl b/src/data/timing/epferror.sl index d054c61a806a115d49962c8936df03100ddf7670..d306441e228ba0fe919ddb3b927a8c9124de42b8 100644 --- a/src/data/timing/epferror.sl +++ b/src/data/timing/epferror.sl @@ -15,23 +15,23 @@ define epferror () % approach.} %\usage{(Double_Type err) = epferror(Double_Type time, rate, period[, rate_error]);} %\qualifiers{ -%\qualifier{pstart}{: start period for epoch folding period search. +%\qualifier{pstart}{start period for epoch folding period search. % (default: 0.5*period)} -%\qualifier{pstop}{: stop period for epoch folding period search. +%\qualifier{pstop}{stop period for epoch folding period search. % (default: 1.5*period)} -%\qualifier{ntrial}{: number of MC iterations. (default: 20)} -%\qualifier{pget}{: function reference to determine the period from the +%\qualifier{ntrial}{number of MC iterations. (default: 20)} +%\qualifier{pget}{function reference to determine the period from the % chi^2 landscape. Arguments passed are % Double_Type[] p, stat % as returned by epfold. Has to return the period and -1 % if the period could not be determined. (default: find % maximum, see below)} -%\qualifier{pdist}{: set to a variable reference in order to retrieve +%\qualifier{pdist}{set to a variable reference in order to retrieve % the simulated period distribution.} -%\qualifier{chatty}{: chattiness of this function: If >0 print some debug +%\qualifier{chatty}{chattiness of this function: If >0 print some debug % messages. If >1 plot the chi^2 landscape at each MC % iteration. (default: 0)} -%\qualifier{fchatty}{: chattiness piped to epfold.} +%\qualifier{fchatty}{chattiness piped to epfold.} %} %\description % Note: All qualifiers are passed to pfold (for pulse profile diff --git a/src/data/timing/epfold.sl b/src/data/timing/epfold.sl index e79f50757808acfa55819b6d2c34b1ea074894d2..092cd4db6ffdc0dbf4009376f7eea3fefb02ba55 100644 --- a/src/data/timing/epfold.sl +++ b/src/data/timing/epfold.sl @@ -9,15 +9,15 @@ define epfold () %or (Struct_Type res) = epfold(Double_Type t, pstart, pstop) ; (event data)} % %\qualifiers{ -%\qualifier{nbins}{: number of bins for the pulse profile (default=20)} -%\qualifier{exact}{: calculate the pulse profile in a more exact way, see description of pfold (not recommended as it takes a very long time!).} -%\qualifier{dt} {:exposure of every lightcurve time bin, should be given to ensure correct results.} -%\qualifier{sampling} {: how many periods per peak to use (default=10)} -%\qualifier{nsrch} {: how many periods to search in a linear grid (default not set)} -%\qualifier{dp} {: delta period of linear period grid (default not set)} -%\qualifier{lstat} {: use L-statistics instead of chi^2 statistics} -%\qualifier{chatty} {: set the verbosity, chatty-1 is piped to pfold (default=0)} -%\qualifier{gti}{:GTIs for event data, given as struct{start=Double_Type, stop=Double_Type}} +%\qualifier{nbins}{number of bins for the pulse profile (default=20)} +%\qualifier{exact}{calculate the pulse profile in a more exact way, see description of pfold (not recommended as it takes a very long time!).} +%\qualifier{dt}{exposure of every lightcurve time bin, should be given to ensure correct results.} +%\qualifier{sampling}{how many periods per peak to use (default=10)} +%\qualifier{nsrch}{how many periods to search in a linear grid (default not set)} +%\qualifier{dp}{delta period of linear period grid (default not set)} +%\qualifier{lstat}{use L-statistics instead of chi^2 statistics} +%\qualifier{chatty}{set the verbosity, chatty-1 is piped to pfold (default=0)} +%\qualifier{gti}{GTIs for event data, given as struct{start=Double_Type, stop=Double_Type}} %} % % diff --git a/src/data/timing/epfoldpdot.sl b/src/data/timing/epfoldpdot.sl index 3bc6accdd653ab25fb9edb2e7ae656fec0c2c276..3084b9ee0c332479f8717a7fa9a58e2731760cea 100644 --- a/src/data/timing/epfoldpdot.sl +++ b/src/data/timing/epfoldpdot.sl @@ -10,18 +10,18 @@ define epfoldpdot () %or (Struct_Type res) = epfoldpdot(Double_Type t, pstart, pstop) ; (event data)} % %\qualifiers{ -%\qualifier{nbins}{: number of bins for the pulse profile} -%\qualifier{exact}{: calculate the pulse profile in a more exact way, see description of pfold (not recommed as it takes a very long time!).} -%\qualifier{dt} {:exposure of every lightcurve time bin, should be given to ensure correct results.} -%\qualifier{sampling} {: how many periods per peak to use (default=10)} -%\qualifier{nsrch} {: how many periods to search in a linear grid (default not set)} -%\qualifier{dp} {: delta period of linear period grid (default not set)} -%\qualifier{lstat} {: use L-statistics instead of chi^2 statistics} -%\qualifier{chatty} {: set the verbosity, chatty-1 is piped to pfold (default=0)} -%\qualifier{gti}{:GTIs for event data, given as struct{start=Double_Type, stop=Double_Type}} -%\qualifier{pdstart}{: start p-dot for grid search (default=0)} -%\qualifier{pdstop}{: stop p-dot for grid search (default=0)} -%\qualifier{pdnsrch}{: search point for p-dot grid, (default = nsrch +%\qualifier{nbins}{number of bins for the pulse profile} +%\qualifier{exact}{calculate the pulse profile in a more exact way, see description of pfold (not recommed as it takes a very long time!).} +%\qualifier{dt}{exposure of every lightcurve time bin, should be given to ensure correct results.} +%\qualifier{sampling}{how many periods per peak to use (default=10)} +%\qualifier{nsrch}{how many periods to search in a linear grid (default not set)} +%\qualifier{dp}{delta period of linear period grid (default not set)} +%\qualifier{lstat}{use L-statistics instead of chi^2 statistics} +%\qualifier{chatty}{set the verbosity, chatty-1 is piped to pfold (default=0)} +%\qualifier{gti}{GTIs for event data, given as struct{start=Double_Type, stop=Double_Type}} +%\qualifier{pdstart}{start p-dot for grid search (default=0)} +%\qualifier{pdstop}{stop p-dot for grid search (default=0)} +%\qualifier{pdnsrch}{search point for p-dot grid, (default = nsrch %(if defined, otherwise 10))} %} % diff --git a/src/data/timing/find_peak.sl b/src/data/timing/find_peak.sl index 9e48ebc209000de6fe057a12c0b00677fcb9a091..c91710211960381a7a3d6816465d519a9e0a6a50 100644 --- a/src/data/timing/find_peak.sl +++ b/src/data/timing/find_peak.sl @@ -194,23 +194,23 @@ define find_peak ( ) %{{{ % helpful if you want to make things easier to read in scripts. % %\qualifiers{ -%\qualifier{only_max}{: neither block analysis nor fit are performed} -%\qualifier{blocks_but_only_max}{: block analysis is performed but only the highest bin in the best block taken} -%\qualifier{weighting}{: weights for properties of a peak [area, sharpness, distance to expectation, profile quality] (default: [1,1,1,1])} -%\qualifier{no_fit}{: nlock analysis is performed but only the first estimate taken} -%\qualifier{fit_fct}{: an xyfit function for the fit, passed as a string (default: "sqrsinc")} -%\qualifier{fit_part}{: measure for the part of the peak used for the fit (default: .3)} -%\qualifier{tolerance}{: determines how many peaks are passed to step (4), in [0,1) (default: .99)} -%\qualifier{smoothing}{: how strong the smoothing algorithm works (default: 10.)} -%\qualifier{ncp_prior}{: argument for block analysis. If a string is given, the default block analysis routine will be used (default: 100)} -%\qualifier{fp_rate}{: argument for block analysis, see its help} -%\qualifier{no_profile}{: No pfold will be executed. Corresponds to tolerance -> 1 and less computation} -%\qualifier{nbins_pfold}{: argument for pfold, see its help} -%\qualifier{pfold_not_exact}{: changes how pfold is executed. Recommended as long as the exact-bug is not fixed} -%\qualifier{exact}{: passes the information that the statistic was calculated using the exact qualifier} -%\qualifier{flag_info}{: detailed information regarding the content of the flags structure is given, NOTHING else is done} -%\qualifier{error_info}{: detailed information about the calculation of errors is given, NOTHING else is done} -%\qualifier{chatty}{: boolean value (default: 1)}; +%\qualifier{only_max}{neither block analysis nor fit are performed} +%\qualifier{blocks_but_only_max}{block analysis is performed but only the highest bin in the best block taken} +%\qualifier{weighting}{weights for properties of a peak [area, sharpness, distance to expectation, profile quality] (default: [1,1,1,1])} +%\qualifier{no_fit}{nlock analysis is performed but only the first estimate taken} +%\qualifier{fit_fct}{an xyfit function for the fit, passed as a string (default: "sqrsinc")} +%\qualifier{fit_part}{measure for the part of the peak used for the fit (default: .3)} +%\qualifier{tolerance}{determines how many peaks are passed to step (4), in [0,1) (default: .99)} +%\qualifier{smoothing}{how strong the smoothing algorithm works (default: 10.)} +%\qualifier{ncp_prior}{argument for block analysis. If a string is given, the default block analysis routine will be used (default: 100)} +%\qualifier{fp_rate}{argument for block analysis, see its help} +%\qualifier{no_profile}{No pfold will be executed. Corresponds to tolerance -> 1 and less computation} +%\qualifier{nbins_pfold}{argument for pfold, see its help} +%\qualifier{pfold_not_exact}{changes how pfold is executed. Recommended as long as the exact-bug is not fixed} +%\qualifier{exact}{passes the information that the statistic was calculated using the exact qualifier} +%\qualifier{flag_info}{detailed information regarding the content of the flags structure is given, NOTHING else is done} +%\qualifier{error_info}{detailed information about the calculation of errors is given, NOTHING else is done} +%\qualifier{chatty}{boolean value (default: 1)}; %} %\seealso{pulseperiod_search, epfold, pulseperiod_epfold, split_and_epfold_lc, bayesian_blocks, pfold} %!%- diff --git a/src/data/timing/foucalc.sl b/src/data/timing/foucalc.sl index 6f4d00cc1c8039d6638e7b81e2136666822585bb..c7309941e24b686adcd5362810b42d33433731ab 100644 --- a/src/data/timing/foucalc.sl +++ b/src/data/timing/foucalc.sl @@ -7,21 +7,21 @@ define foucalc() %\usage{Struct_Type foucalc(Struct_Type lc, Integer_Type dimseg)} %\qualifiers{ %\qualifier{verbose}{} -%\qualifier{normtype}{: normalization type of PSD data, can be \code{"Miyamoto"} [default], \code{"Leahy"}, or \code{"Schlittgen"}} +%\qualifier{normtype}{normalization type of PSD data, can be \code{"Miyamoto"} [default], \code{"Leahy"}, or \code{"Schlittgen"}} %\qualifier{normindiv}{} -%\qualifier{avgbkg}{: array of average background rates for each energy band} -%\qualifier{numinst}{ [\code{=1}]: number of activated PCUs on XTE, required for noise correction} -%\qualifier{deadtime}{ [\code{=1e-5}]: detector deadtime in seconds} -%\qualifier{fmin}{: minimum frequency used for RMS calculation} -%\qualifier{fmax}{: maximum frequency used for RMS calculation} -%\qualifier{RMS}{: DEPRECATED, use rms qualifier instead.} -%\qualifier{rms}{: reference to a variable to store the signal, noise RMS and error +%\qualifier{avgbkg}{array of average background rates for each energy band} +%\qualifier{numinst}{[\code{=1}] number of activated PCUs on XTE, required for noise correction} +%\qualifier{deadtime}{[\code{=1e-5}] detector deadtime in seconds} +%\qualifier{fmin}{minimum frequency used for RMS calculation} +%\qualifier{fmax}{maximum frequency used for RMS calculation} +%\qualifier{RMS}{DEPRECATED, use rms qualifier instead.} +%\qualifier{rms}{reference to a variable to store the signal, noise RMS and error % of each light curve in the [fmin, fmax] band. Can only be used with % normtype="Miyamoto". The error is calculated using Vaughan % et al., MNRAS 345, 1271, 2003 Eq. 11.} -%\qualifier{avgrate}{: reference to a variable to store the average rate of each light curve} -%\qualifier{compact}{: compact the output structure, only keep the most important quantities} -%\qualifier{noCPD}{: do not calculate cross power densities and derived quantities} +%\qualifier{avgrate}{reference to a variable to store the average rate of each light curve} +%\qualifier{compact}{compact the output structure, only keep the most important quantities} +%\qualifier{noCPD}{do not calculate cross power densities and derived quantities} %} %\description % \code{lc} contains (properly segmented) light curves in several energy bands. diff --git a/src/data/timing/makepsd.sl b/src/data/timing/makepsd.sl index a91ec266495ebb6c402a4f636910893e6170be38..b50f5e55d2d175309591f60e9a37778aa9ea4d12 100644 --- a/src/data/timing/makepsd.sl +++ b/src/data/timing/makepsd.sl @@ -15,8 +15,8 @@ define makepsd() % psd - unnormalized, averaged PSD % nipsd - averaged PSD, individual segments normalized %\qualifiers{ -%\qualifier{avgbkg}{: Average background count rate for Miyamoto normalization} -%\qualifier{normtype}{: "Miyamoto", "Leahy", "Schlittgen" normalization type} +%\qualifier{avgbkg}{Average background count rate for Miyamoto normalization} +%\qualifier{normtype}{"Miyamoto", "Leahy", "Schlittgen" normalization type} %} %!%- { diff --git a/src/data/timing/pfold.sl b/src/data/timing/pfold.sl index 697605f510369677c617ff99673b98cb8b8e6fe8..3aa2810623105ec36b74bcc378b67e073475c506 100644 --- a/src/data/timing/pfold.sl +++ b/src/data/timing/pfold.sl @@ -312,15 +312,15 @@ define pfold () %\altusage{Struct_Type pp = pfoldpfold(Double_Type t, r, p, e);} %\altusage{Struct_Type pp = pfold(Double_Type t, p);}} %\qualifiers{ -%\qualifier{nbins}{[=30]: number of bins for the pulse profile} -%\qualifier{exact}{: take finite lightcurve bins into account (LC case). +%\qualifier{nbins}{[=30] number of bins for the pulse profile} +%\qualifier{exact}{take finite lightcurve bins into account (LC case). % take differantial phase grid into account (Events case).} -%\qualifier{dt}{: lightcurve bin size.} -%\qualifier{fracexp}{: fractional exposure per lightcurve bin.} -%\qualifier{t0}{: set reference time.} -%\qualifier{pdot}{[=0]: first derivative of pulse period p.} -%\qualifier{pddot}{[=0]: second derivative of pulse period p.} -%\qualifier{gti}{: GTIs for event data, given as struct{start=Double_Type, stop=Double_Type}} +%\qualifier{dt}{lightcurve bin size.} +%\qualifier{fracexp}{fractional exposure per lightcurve bin.} +%\qualifier{t0}{set reference time.} +%\qualifier{pdot}{[=0] first derivative of pulse period p.} +%\qualifier{pddot}{[=0] second derivative of pulse period p.} +%\qualifier{gti}{GTIs for event data, given as struct{start=Double_Type, stop=Double_Type}} %} %\description % Calculates the pulse profile of a given lightcurve or event list diff --git a/src/data/timing/pulseperiod_search.sl b/src/data/timing/pulseperiod_search.sl index a308efaa68fca74d4423d9e2c9ee0811dd978fdc..daf5e8746aea0a619aa17928dabeb18121fca2ae 100644 --- a/src/data/timing/pulseperiod_search.sl +++ b/src/data/timing/pulseperiod_search.sl @@ -40,19 +40,19 @@ define pulseperiod_search ( ) %{{{ % with the names given below. See their helps for further information. % %\qualifiers{ -%\qualifier{compact}{: output contains only the essential information} -%\qualifier{epfold_fourier_qu}{: contains qualifiers for step (1)} -%\qualifier{fourier_qu}{: contains qualifiers for step (1)} -%\qualifier{epfold_split_qu}{: contains qualifiers for step (2)} -%\qualifier{pulse2pulse_slope_qu}{: contains qualifiers for step (3)} -%\qualifier{epfold_qu}{: contains qualifiers for step (4)} -%\qualifier{find_peak_qu}{: contains qualifiers for step (5)} -%\qualifier{no_slope_correction}{: step (3) is not done} -%\qualifier{no_splitting}{: step (2) is not done} -%\qualifier{exact}{: forces epfold to use exact} -%\qualifier{not_exact}{: forces epfold not to use exact} -%\qualifier{fourier}{: fourier is used, even if p0 is given -- can be used to pass sigma} -%\qualifier{chatty}{: boolean value (default: 1)} +%\qualifier{compact}{output contains only the essential information} +%\qualifier{epfold_fourier_qu}{contains qualifiers for step (1)} +%\qualifier{fourier_qu}{contains qualifiers for step (1)} +%\qualifier{epfold_split_qu}{contains qualifiers for step (2)} +%\qualifier{pulse2pulse_slope_qu}{contains qualifiers for step (3)} +%\qualifier{epfold_qu}{contains qualifiers for step (4)} +%\qualifier{find_peak_qu}{contains qualifiers for step (5)} +%\qualifier{no_slope_correction}{step (3) is not done} +%\qualifier{no_splitting}{step (2) is not done} +%\qualifier{exact}{forces epfold to use exact} +%\qualifier{not_exact}{forces epfold not to use exact} +%\qualifier{fourier}{fourier is used, even if p0 is given -- can be used to pass sigma} +%\qualifier{chatty}{boolean value (default: 1)} % %} %\seealso{foucalc, split_and_epfold_lc, pulse2pulse_flux_lc, find_peak} diff --git a/src/data/timing/rebin_fouquan.sl b/src/data/timing/rebin_fouquan.sl index e77e5960534b1e5b8e1c3cb96228a3536896535b..ec4054b81591f6ca7b00522e7bdd9c32492bb183 100644 --- a/src/data/timing/rebin_fouquan.sl +++ b/src/data/timing/rebin_fouquan.sl @@ -19,8 +19,8 @@ define rebin_fouquan() %\qualifiers{ %\qualifier{logfreq}{} %\qualifier{linfreq}{} -%\qualifier{newfreq}{: array of new frequencies} -%\qualifier{nofreq}{: no rebinning} +%\qualifier{newfreq}{array of new frequencies} +%\qualifier{nofreq}{no rebinning} %\qualifier{verbose}{} %} %!%- diff --git a/src/data/timing/scargle.sl b/src/data/timing/scargle.sl index 6f659be510e659275a68cc6c7199f2b01e81728f..0b39c6e2d1e4431c0dc52547f0101fece908c637 100644 --- a/src/data/timing/scargle.sl +++ b/src/data/timing/scargle.sl @@ -5,20 +5,20 @@ define scargle() %\synopsis{Computes the lomb-scargle periodogram of an unevenly sampled lightcurve} %\usage{Struct_Type res = scargle (t, c); % where t and c contain time and counts of the lc} %\qualifiers{ -%\qualifier{fmin}{: minimum frequency to be used (NOT ANGULAR FREQ!), has precede over pmin, pmax} -%\qualifier{fmax}{: maximum frequency to be used (NOT ANGULAR FREQ!), has precede over pmin, pmax} -%\qualifier{pmin}{: minimum period to be used} -%\qualifier{pmax}{: maximum period to be used} -%\qualifier{omega}{: array of angular frequencies for which the PSD values are desired; +%\qualifier{fmin}{minimum frequency to be used (NOT ANGULAR FREQ!), has precede over pmin, pmax} +%\qualifier{fmax}{maximum frequency to be used (NOT ANGULAR FREQ!), has precede over pmin, pmax} +%\qualifier{pmin}{minimum period to be used} +%\qualifier{pmax}{maximum period to be used} +%\qualifier{omega}{array of angular frequencies for which the PSD values are desired; % if set, value for numf will be reset to length of omega during code} -%\qualifier{noise}{: for the normalization of the periodogram. +%\qualifier{noise}{for the normalization of the periodogram. % if not set, equal to the variance of the original lc.} -%\qualifier{numf}{: number of independent frequencies} -%\qualifier{old}{: if set computing the periodogram according to J.D. Scargle, 1982, ApJ 263, 835 +%\qualifier{numf}{number of independent frequencies} +%\qualifier{old}{if set computing the periodogram according to J.D. Scargle, 1982, ApJ 263, 835 % if not set, computing the periodogram with the fast algorithm % of W.H. Press and G.B. Rybicki, 1989, ApJ 338, 277.} -%\qualifier{nu}{: if set, output structure also contains frequency} -%\qualifier{om}{: if set, output structure also contains angluar frequency} +%\qualifier{nu}{if set, output structure also contains frequency} +%\qualifier{om}{if set, output structure also contains angluar frequency} %} %\description % (transcribed from IDL-program scargle.pro) diff --git a/src/data/timing/split_and_epfold_lc.sl b/src/data/timing/split_and_epfold_lc.sl index 58f351c5834eb656702dcd9ed504b65c1dd563c8..601955bf7b98a3d28c639e7fadc41246213bd86b 100644 --- a/src/data/timing/split_and_epfold_lc.sl +++ b/src/data/timing/split_and_epfold_lc.sl @@ -16,18 +16,18 @@ define split_and_epfold_lc()%{{{ %\synopsis{Takes lightcurve and pulse period, splits if necessary and executes epfold for each segment.} %\usage{Struct_Type split_and_epfold_lc(Struct_Type OR Array_Type lc, Double_Type p0), all times in the same units} %\qualifiers{ -%\qualifier{exact}{: Forces execution of pfold with exact qualifier} -%\qualifier{not_exact}{: Forces execution of pfold without exact qualifier} -%\qualifier{exact_threshold}{: see description (default: 6.)} -%\qualifier{split_only}{: Only the splitting is performed} -%\qualifier{nbins}{: Sampling of pfold (default: min(32, p0 / dt), dt time resolution} -%\qualifier{nsrch}{: Number of trial periods for epfold (default: 1e4)} -%\qualifier{grid_steps}{: Period resolution for epfold (default: not set)} -%\qualifier{search_range}{: Period interval considered left/right of p0 in terms of dp=p0^2/T (default: 2.)} -%\qualifier{dpmin}{: For very long lightcurves, this can replace dp (default: p0e-3)} -%\qualifier{gap_scale}{: the smaller, the higher is the sensitivity for gaps (default: .5)} -%\qualifier{fracexp}{: Only timebins with fracexp >= this value will be considered (default: 1.)} -%\qualifier{chatty}{: chattiness (default: 1)} +%\qualifier{exact}{Forces execution of pfold with exact qualifier} +%\qualifier{not_exact}{Forces execution of pfold without exact qualifier} +%\qualifier{exact_threshold}{see description (default: 6.)} +%\qualifier{split_only}{Only the splitting is performed} +%\qualifier{nbins}{Sampling of pfold (default: min(32, p0 / dt), dt time resolution} +%\qualifier{nsrch}{Number of trial periods for epfold (default: 1e4)} +%\qualifier{grid_steps}{Period resolution for epfold (default: not set)} +%\qualifier{search_range}{Period interval considered left/right of p0 in terms of dp=p0^2/T (default: 2.)} +%\qualifier{dpmin}{For very long lightcurves, this can replace dp (default: p0e-3)} +%\qualifier{gap_scale}{the smaller, the higher is the sensitivity for gaps (default: .5)} +%\qualifier{fracexp}{Only timebins with fracexp >= this value will be considered (default: 1.)} +%\qualifier{chatty}{chattiness (default: 1)} %} %\description % diff --git a/src/data/timing/z2fold.sl b/src/data/timing/z2fold.sl index f845390288b191443d82e9155e56d716b4f89c9f..a4ab0c21e32d9dfccd1014f0efc7456a35cccbea 100644 --- a/src/data/timing/z2fold.sl +++ b/src/data/timing/z2fold.sl @@ -11,12 +11,12 @@ define z2fold () %or (Struct_Type res) = z2fold(Double_Type t, pstart, pstop) ; (event data)} % %\qualifiers{ -%%\qualifier{sampling} {: how many periods per peak to use (default=10)} -%\qualifier{nsrch} {: how many periods to search in a linear grid (default not set)} -%\qualifier{dp} {: delta period of linear period grid (default not set)} -%\qualifier{m} {: number of harmonics used (default =2)} -%\qualifier{chatty} {: set the verbosity, (default=0)} -%\qualifier{gti}{:GTIs for event data, given as struct{start=Double_Type, stop=Double_Type}} +%\qualifier{sampling} {how many periods per peak to use (default=10)} +%\qualifier{nsrch} {how many periods to search in a linear grid (default not set)} +%\qualifier{dp} {delta period of linear period grid (default not set)} +%\qualifier{m} {number of harmonics used (default =2)} +%\qualifier{chatty} {set the verbosity, (default=0)} +%\qualifier{gti}{GTIs for event data, given as struct{start=Double_Type, stop=Double_Type}} %} % %\description diff --git a/src/data/timing/zsquare.sl b/src/data/timing/zsquare.sl index 212c1028236385dbbc7868191e3b7dbb1f179fa9..26dee5a6b47f7ac26550dfa2fd9d2a9bb3d05989 100644 --- a/src/data/timing/zsquare.sl +++ b/src/data/timing/zsquare.sl @@ -5,19 +5,16 @@ define zsquare () %\function{zsquare} %\synopsis{calculate Z^2 statistics for pulse period search} %\usage{Double_Type Z2 = zsquare(Double_Type times, Double_Type testperiod} -%\qualifiers{ -%\qualifier{lc}{: =Double_Type rate; allows the use of a lightcurve instead of event files} -%\qualifier{m}{: = Integer_Type; determines the highest order of summations (default 2)} -%} % %\description % Calculates the Z^2 statistics of an event list or light-curve for % a given period. By itself not very useful, but is used in z2fold % to search for periodicities using the Z^2 statistics. % -% Please see Buccheri et al., 1983, Astron. Astrophys. 128, 245 for -% more information on the Z-square statistics. -% +%\qualifiers{ +%\qualifier{lc}{=Double_Type rate; allows the use of a lightcurve instead of event files} +%\qualifier{m}{= Integer_Type; determines the highest order of summations (default 2)} +%} %!%- { variable t, P ; diff --git a/src/fitting/_fitfun_cache.sl b/src/fitting/_fitfun_cache.sl index 8048d378d1583a33d0bba3dcb20296870379046b..ed598a9c5ebb5d9d45984be4515bf05ae44b1d8f 100644 --- a/src/fitting/_fitfun_cache.sl +++ b/src/fitting/_fitfun_cache.sl @@ -57,7 +57,7 @@ % Please read the documentation of 'fitfun_get_cache' and % 'fitfun_init_cache' fot details and further examples. %\seealso{fitfun_get_cache, fitfun_init_cache, fitfun_cache_enabled} -%} +% %!%- private variable _fitfun_cache_enabled = 1; diff --git a/src/fitting/cl_save.sl b/src/fitting/cl_save.sl index 7b66014a55adf71deaface357c7e225459829822..7d19d7a124b01f709eb7a85ca05283b6284e76a3 100644 --- a/src/fitting/cl_save.sl +++ b/src/fitting/cl_save.sl @@ -12,9 +12,9 @@ define cl_save() %\qualifier{level}{[=1]: specifies the confidence level. Values of 0, 1, or 2 % indicate 68%, 90%, or 99% confidence levels respectively. % By default, 90% confidence limits are computed.} -%\qualifier{tolerance}{: convergence criterion for the calculation of the confidence +%\qualifier{tolerance}{convergence criterion for the calculation of the confidence % limits (see help for the conf command). Default: 1e-3} -%\qualifier{cleanup}{: will remove all temporary files ending in *.[0-9][0-9]* from the basefilename directory} +%\qualifier{cleanup}{will remove all temporary files ending in *.[0-9][0-9]* from the basefilename directory} %} %\description % This function is a direct copy of fit_pars, however, using diff --git a/src/fitting/contour_trq.sl b/src/fitting/contour_trq.sl index 7fc39e8584cdeadaec323846d5211ef6d20625cf..964b9c632c232b0389666c9a952d19557b9e604c 100644 --- a/src/fitting/contour_trq.sl +++ b/src/fitting/contour_trq.sl @@ -10,7 +10,7 @@ define contour_trq(){ % Double_Type lowLimPar1, upLimPar1,lowLimPar2, upLimPar2, % String_Type startUpFile [, parFile], outDir, time);} %\qualifiers{ -%\qualifier{trq}{: Sends the jobs to Remeis torque} +%\qualifier{trq}{Sends the jobs to Remeis torque} %} % %\description diff --git a/src/fitting/cstat_unc.sl b/src/fitting/cstat_unc.sl index 453a385c43a14c20efabee90a3a6b1eb64705fa1..f06d883efddf932ac150a20acab1341bb764fe7b 100755 --- a/src/fitting/cstat_unc.sl +++ b/src/fitting/cstat_unc.sl @@ -19,7 +19,7 @@ define kaastra_cstat_goodness() % want to do this). % %\qualifiers{ -%\qualifier{exact}{: use Kaastra's exact equations 4-6 (slow; use only +%\qualifier{exact}{use Kaastra's exact equations 4-6 (slow; use only % for testing, not necessary for practical work)} %} % @@ -178,9 +178,9 @@ define cstat_goodness() % to cstat_theory + f * c_variance. % %\qualifiers{ -%\qualifier{quiet}{: if set, the function will not complain if the fit +%\qualifier{quiet}{if set, the function will not complain if the fit % statistics is not set to Cash or if there are bins without counts.} -%\qualifier{data}{: if set, uses the measured counts in the computation +%\qualifier{data}{if set, uses the measured counts in the computation % (the default is the expected counts in the bin)} %} % diff --git a/src/fitting/ensemble-samplers/emcee.sl b/src/fitting/ensemble-samplers/emcee.sl index 052753d0e08391fe23a1a349791819f86cc2385a..ba85f13a06110d8034015c686ee4e39be9413541 100644 --- a/src/fitting/ensemble-samplers/emcee.sl +++ b/src/fitting/ensemble-samplers/emcee.sl @@ -2048,21 +2048,21 @@ define emcee_hammer (steps) %\qualifiers{ % \qualifier{Basic Qualifiers}{} % \qualifier{walkers}{[=10]: Number of walkers per parameter} -% \qualifier{continue}{: If given (and possible set to a file) continue chain from this file +% \qualifier{continue}{If given (and possible set to a file) continue chain from this file % (using init="file", file="fits" per default)} -% \qualifier{cont}{: same as 'continue'} -% \qualifier{infile}{: Set the input file name for reading and continuing} -% \qualifier{outfile}{: Set the output file name} -% \qualifier{clobber}{: Ovwerwrite output file if exists} +% \qualifier{cont}{same as 'continue'} +% \qualifier{infile}{Set the input file name for reading and continuing} +% \qualifier{outfile}{Set the output file name} +% \qualifier{clobber}{Ovwerwrite output file if exists} % \qualifier{Advanced Qualifiers}{} -% \qualifier{init}{[="uniform" or "file"]: The walker initialization method} -% \qualifier{driver}{[="mpi"]: The parallelization method} -% \qualifier{step}{[="stretch"]: The walker step algorithm} -% \qualifier{input}{[="fits"]: The file reading method} -% \qualifier{output}{[="fits"]: The file writing method} -% \qualifier{progress}{="none"]: Show progres} -% \qualifier{urand}{[=&rand_uniform]: PRNG for uniform numbers (Double_Type[] = urand(Int_Type))} -% \qualifier{upick}{[=&rand_int]: PRNG to chose complement walker (Int_Type[] = upick(Int_Type, Int_Type, Int_Type))} +% \qualifier{init}{[="uniform" or "file"] The walker initialization method} +% \qualifier{driver}{[="mpi"] The parallelization method} +% \qualifier{step}{[="stretch"] The walker step algorithm} +% \qualifier{input}{[="fits"] The file reading method} +% \qualifier{output}{[="fits"] The file writing method} +% \qualifier{progress}{="none"] Show progres} +% \qualifier{urand}{[=&rand_uniform] PRNG for uniform numbers (Double_Type[] = urand(Int_Type))} +% \qualifier{upick}{[=&rand_int] PRNG to chose complement walker (Int_Type[] = upick(Int_Type, Int_Type, Int_Type))} %} % %\description diff --git a/src/fitting/fit-functions/pulsar/pulsarorbit.sl b/src/fitting/fit-functions/pulsar/pulsarorbit.sl index aebb36a479811d19cd1444efbd0b8fad737903ff..627d20013e0dc7dcd4a84f94f9038663aa9827bf 100644 --- a/src/fitting/fit-functions/pulsar/pulsarorbit.sl +++ b/src/fitting/fit-functions/pulsar/pulsarorbit.sl @@ -6,7 +6,7 @@ private define pulsarorbit_fit(lo, hi, par) %\synopsis{fit-function modelling a neutron star pulse period evolution} %\usage{fit_fun("pulsarorbit");} %\description -% Deprecated, use +% DEPRECATED, use % fit_fun("dopplerorbit*pulsartorque"); % from now on. %!%- diff --git a/src/fitting/fit-functions/pulsar/pulsarorbit_fluxerror_mc.sl b/src/fitting/fit-functions/pulsar/pulsarorbit_fluxerror_mc.sl index 53a69449a14e8a4ec28e390aea12064d3cc6b559..a3c549776ebd0f19f72e2d109b789b181e5eea95 100644 --- a/src/fitting/fit-functions/pulsar/pulsarorbit_fluxerror_mc.sl +++ b/src/fitting/fit-functions/pulsar/pulsarorbit_fluxerror_mc.sl @@ -6,15 +6,15 @@ define pulsarorbit_fluxerror_mc() %\synopsis{estimates additional uncertainties caused by the flux measurements} %\usage{Double_Type[] pulsarorbit_fluxerror_mc(Integer_Type dataset);} %\qualifiers{ -% runs - number of MC loops (default: 100) -% save - save the uncertainty estimation to the -% assigned FITS-filename -% collect - file-pattern used by 'glob' to read and -% merge all FITS-files from previous runs -% modify - add the estimated uncertainties to the +% \qualifier{runs}{number of MC loops (default: 100)} +% \qualifier{save}{save the uncertainty estimation to the +% assigned FITS-filename} +% \qualifier{collect}{file-pattern used by 'glob' to read and +% merge all FITS-files from previous runs} +% \qualifier{modify}{add the estimated uncertainties to the % dataset(s) assigned to this qualifier -% (see below for a detailed description) -% chatty - be chatty if > 0 (default: 0) +% (see below for a detailed description)} +% \qualifier{chatty}{be chatty if > 0 (default: 0)} %} %\description % The flux measurements used to calculate the evolution diff --git a/src/fitting/fit-functions/pulsar/pulsartaylor.sl b/src/fitting/fit-functions/pulsar/pulsartaylor.sl index 4223a08f6a7a342ef0d20adf183e17d33819816e..44b8b85c573e5084678c2f44c2078f53ff539c17 100644 --- a/src/fitting/fit-functions/pulsar/pulsartaylor.sl +++ b/src/fitting/fit-functions/pulsar/pulsartaylor.sl @@ -9,16 +9,16 @@ private define pulsartaylor_fit(lo, hi, par) %\description % This fit-function computes the pulse period evolution of, e.g., % a neutron star based on a Taylor series. That is -% p(t) = p0 + \\dot{P}*(t-t0) + .5*\\ddot{P}*(t-t0)^2 + ... +% p(t) = p0 + Pdot*(t-t0) + .5*Pddot*(t-t0)^2 + ... % Here, p0 is the pulse period at the reference time t0 and -% \\dot{P}, \\ddot{P}, ... are the higher order derivatives. +% Pdot, Pddot,... are the higher order derivatives. % % The parameters of the fit-function are: % p0 - spin-period at t0 (s) % t0 - reference time t0 (MJD), has to be fixed % pdot - period derivative (s/s) % p2dot - 2nd period derivative (s/s^2) -% ... +% etc. % % By default the Taylor series is computed up to the second % order. If your data requires higher orders, you can change this diff --git a/src/fitting/fit-functions/pulsar/pulsartorque.sl b/src/fitting/fit-functions/pulsar/pulsartorque.sl index 22b3a99bc526a2d1504aaedbcebfbc10e27ba77a..a5cee6d7bda29b92881b5bb83972e5745d3ee699 100644 --- a/src/fitting/fit-functions/pulsar/pulsartorque.sl +++ b/src/fitting/fit-functions/pulsar/pulsartorque.sl @@ -26,7 +26,7 @@ private define pulsartorque_fit(lo, hi, par) %\description % The spin-up of an accreting neutron star is connected with its % luminosity via -% \\dot{P} = - b * P^2 L^alpha +% Pdot = - b * P^2 L^alpha % as found by Ghosh & Lamb (1979). This fit-function solves this % differential equation in order to calculate the spin-evolution of % the neutron star. @@ -43,7 +43,7 @@ private define pulsartorque_fit(lo, hi, par) % In order to express the torque strength, b, in the usual unit of % a spin-change (s/s), the equation is modfied by two normalization % constants: -% \\dot{P} = - b * (P/Pnorm)^2 (L/Lnorm)^alpha +% Pdot = - b * (P/Pnorm)^2 (L/Lnorm)^alpha % where Pnorm is a reference spin-period and Lnorm a reference % luminosity. For instance, Pnorm could be tied to parameter p, % i.e., the period p at t0. This should be avoided, however, when diff --git a/src/fitting/fit_brute_force.sl b/src/fitting/fit_brute_force.sl index c22aed55e0623182de7a86f44bf92f7085432d93..38d0a84f5521bdb70e410d1e22c9b951a472733a 100644 --- a/src/fitting/fit_brute_force.sl +++ b/src/fitting/fit_brute_force.sl @@ -9,10 +9,10 @@ define fit_brute_force() %\usage{Struct_Type fit_brute_force(Integer_Type[] par [, Double_Type[] stepsize]) % or Struct_Type fit_brute_force(String_Type[] par [, Double_Type[] stepsize])} %\qualifiers{ -%\qualifier{nofit}{: instead of fitting the remaining parameters the +%\qualifier{nofit}{instead of fitting the remaining parameters the % model is just evaluated} -%\qualifier{nomap}{: the chi-square map will not be created} -%\qualifier{chatty}{: boolean value to show the remaining time +%\qualifier{nomap}{the chi-square map will not be created} +%\qualifier{chatty}{boolean value to show the remaining time % (default=1)} %} %\description diff --git a/src/fitting/fit_pars.sl b/src/fitting/fit_pars.sl index ce27a6e57406b4054cab803695b51ef237340fc5..9969aa115c640922ce680cd4b87bbcb6f8c57519 100644 --- a/src/fitting/fit_pars.sl +++ b/src/fitting/fit_pars.sl @@ -14,13 +14,13 @@ define fit_pars() %\qualifier{level}{[=1]: specifies the confidence level. Values of 0, 1, or 2 % indicate 68%, 90%, or 99% confidence levels respectively. % By default, 90% confidence limits are computed.} -%\qualifier{chi2diff}{: if given, fit_pars invokes fconf instead of +%\qualifier{chi2diff}{if given, fit_pars invokes fconf instead of % conf with the value given to caluculate confidence in chi2 % range. Defaults to 1.0.} -%\qualifier{tolerance}{: convergence criterion for the calculation of the confidence +%\qualifier{tolerance}{convergence criterion for the calculation of the confidence % limits (see help for the conf command). Default: 1e-3} %} -%\qualifier{quiet}{: If set, don't print any information on stdout} +%\qualifier{quiet}{If set, don't print any information on stdout} %\description % The return value \code{results = struct { index, name, value, min, max, conf_min, conf_max, buf_below, buf_above, tex }} % is a table with the following information for each parameter:\n diff --git a/src/fitting/fit_steppar.sl b/src/fitting/fit_steppar.sl index 9748151731e9a1c4c13f17f93c50c73087db541a..2107de390e8c34590ba979ef0af2caa4aaf8db6e 100644 --- a/src/fitting/fit_steppar.sl +++ b/src/fitting/fit_steppar.sl @@ -53,8 +53,8 @@ define fit_steppar() %\synopsis{tries to obtain better fits for a stepped parameter} %\usage{Struct_Type result = fit_steppar(String_Type parname, parfiles[]);} %\qualifiers{ -%\qualifier{method}{: "optimize", "interpol_guess", or "eval_all"} -%\qualifier{extrapol}{: allows for extrapolation as well} +%\qualifier{method}{"optimize", "interpol_guess", or "eval_all"} +%\qualifier{extrapol}{allows for extrapolation as well} %\qualifier{fit [=1]}{} %\qualifier{min_improvement}{} %\qualifier{plot}{} diff --git a/src/fitting/get_confmap.sl b/src/fitting/get_confmap.sl index a0e4e5e2c499b7cc473f9b100ddee9539f5c01c1..a097fefdfbb0cf9fa0b4f07f6ebc7f887b93a993 100644 --- a/src/fitting/get_confmap.sl +++ b/src/fitting/get_confmap.sl @@ -21,9 +21,9 @@ define get_confmap() %\synopsis{computes a 2d confidence map and possibly stores the fit-parameters in a file} %\usage{conf_map = get_confmap(par1, min1, max1[, n1], par2, min2, max2[, n2]);} %\qualifiers{ -%\qualifier{save}{ [=\code{"confmap"}]: save all parameters to \code{save}+".fits"} -%\qualifier{fail}{ [=\code{NULL}]: failure recovery hook, see \code{conf_map_counts}} -%\qualifier{mask}{ [=\code{NULL}]: region mask out hook, see \code{conf_map_counts}} +%\qualifier{save}{[=\code{"confmap"}]: save all parameters to \code{save}+".fits"} +%\qualifier{fail}{[=\code{NULL}]: failure recovery hook, see \code{conf_map_counts}} +%\qualifier{mask}{[=\code{NULL}]: region mask out hook, see \code{conf_map_counts}} %} %\description % (All qualifiers are also passed to the \code{conf_map_counts} function.) diff --git a/src/fitting/linear_fit_xerr_yerr_data.sl b/src/fitting/linear_fit_xerr_yerr_data.sl index ba7941cae438e44ef25bf1d09dedd20bd87bbc89..06f8d02721a9c1e4d8ebd7d8953e610298a66c6a 100644 --- a/src/fitting/linear_fit_xerr_yerr_data.sl +++ b/src/fitting/linear_fit_xerr_yerr_data.sl @@ -9,8 +9,8 @@ define linear_fit_xerr_yerr_data() %} %\qualifiers{ %\qualifier{verbose}{} -%\qualifier{n}{: number of iterations} -%\qualifier{with_errors}{: The 90% confidence interval (Delta chi^2 = 2.7) is computed as well.} +%\qualifier{n}{number of iterations} +%\qualifier{with_errors}{The 90% confidence interval (Delta chi^2 = 2.7) is computed as well.} %} %\description % The data points \code{(X[i]+-Xerr[i], Y[i]+-Yerr[i])} diff --git a/src/fitting/load_grouped_xmm_data.sl b/src/fitting/load_grouped_xmm_data.sl index 31ac0f7a5dd2039b18a0fa5744e11655c409954a..d1716a21ca877db3298693009c21d8879ab575d2 100644 --- a/src/fitting/load_grouped_xmm_data.sl +++ b/src/fitting/load_grouped_xmm_data.sl @@ -4,9 +4,9 @@ define load_grouped_xmm_data() %\synopsis{wrapper for load_data, which sets already a few basic options} %\usage{Integer_Type Index = load_grouped_xmm_data([String_Type Path], [E_lo, E_hi]);} %\qualifiers{ -%\qualifier{min_sn[=5]}{ [\code{=5}]: Set the minimal S/N ratio (see help("group");) } -%\qualifier{min_chan[=2]}{ [\code{=2}]: Set the minimal number of Channels do be rebinned (see help("group");) } -%\qualifier{delete_data}{ If set, any data sets loaded previously will be deleted.} +%\qualifier{min_sn[=5]}{[\code{=5}]: Set the minimal S/N ratio (see help("group");) } +%\qualifier{min_chan[=2]}{[\code{=2}]: Set the minimal number of Channels do be rebinned (see help("group");) } +%\qualifier{delete_data}{If set, any data sets loaded previously will be deleted.} %} %\description % This functions loads data (by default "src_sd.pha"), groups it, diff --git a/src/fitting/mpi_fit_pars.sl b/src/fitting/mpi_fit_pars.sl index e71c6ee195a26d1914017bd9ca0efae1be0e3c72..f4c98c4721baa4da1412d42fe6446add53742e21 100644 --- a/src/fitting/mpi_fit_pars.sl +++ b/src/fitting/mpi_fit_pars.sl @@ -267,25 +267,25 @@ define mpi_fit_pars() % IMPORTANT: This code is still in test. It might happen % that the function ends unexpectedly. %\qualifiers{ -%\qualifier{level}{: specifies the confidence level to be computed. +%\qualifier{level}{confidence level to be computed. % As for conf, 0 means 68%, 1 means 90% [default], and 2 means 99% confidence level.} -%\qualifier{tolerance}{: the tolerance for chi^2 improvements without interrupting the search +%\qualifier{tolerance}{the tolerance for chi^2 improvements without interrupting the search % for the confidence intervals, see \code{help("conf");}. The default is \code{1e-3}.} -%\qualifier{fitmethod}{: fit-method to be used, see \code{help("set_fit_method");} +%\qualifier{fitmethod}{fit-method to be used, see \code{help("set_fit_method");} % Default is the currently used fit-method returned by \code{get_fit_method()}.} -%\qualifier{dir}{ [="."]: specifies the directory in which the logfiles shall be stored. +%\qualifier{dir}{[="."] specifies the directory in which the logfiles shall be stored. % It may be a relative path to the current working directory.} -%\qualifier{basefilename}{ [=startdate]} -%\qualifier{verbose}{ Files with the stdout and the inital parameters are kept after program +%\qualifier{basefilename}{[=startdate]} +%\qualifier{verbose}{Files with the stdout and the inital parameters are kept after program % is finished. } -%\qualifier{forked}{ [=0] Use a separate (forked) process to +%\qualifier{forked}{[=0] Use a separate (forked) process to % calculate the confidence levels. It speeds up the calculation, but % might cause troubles for models which write files to disk, as this % process is killed immediatelly when asked to restart % calculation and not stopped smoothly. This option can also % cause your job to be killed if run via slurm, as it requests % additional threads beyond those allocated by slurm. } -%\qualifier{do_not_finalize}{ if set, "mpi_finalize()" is not called +%\qualifier{do_not_finalize}{if set, "mpi_finalize()" is not called % within the routine. In this case the code following the % mpi_fit_pars() call will be executed on *all* nodes. Only the % master process will return the confidence structure (see above); diff --git a/src/fitting/mpi_fit_pars_trqscript_gen.sl b/src/fitting/mpi_fit_pars_trqscript_gen.sl index e759f346f443140fb5fc89e7dc3c1cb62523f930..d889f465104ce44a03a6d8f24714f89b602f4241 100644 --- a/src/fitting/mpi_fit_pars_trqscript_gen.sl +++ b/src/fitting/mpi_fit_pars_trqscript_gen.sl @@ -29,8 +29,8 @@ define mpi_fit_pars_trqscript_gen(){ % fits_load_fit. %\qualifiers{ %\qualifier{walltime}{[="00:30:00"]: String_Type, wallime for the torque} -%\qualifier{ROC}{: Rmf OGIP Compliance (see fits_load_fit} -%\qualifier{submit}{: 1-submit to torque, 0-only create job files}% +%\qualifier{ROC}{Rmf OGIP Compliance (see fits_load_fit} +%\qualifier{submit}{1-submit to torque, 0-only create job files}% %} %\example % isis> diff --git a/src/fitting/parameters/compare_par.sl b/src/fitting/parameters/compare_par.sl index a01066090a41204f9586302a223d2154982188dc..40642f971df2a5df83c0636edf426dba681b8587 100644 --- a/src/fitting/parameters/compare_par.sl +++ b/src/fitting/parameters/compare_par.sl @@ -8,10 +8,10 @@ define compare_par() %\altusage{Struct_Type info = compare_par([String_Type pattern]; get_list);} %} %\qualifiers{ -%\qualifier{fit_fun}{: include fit-function} -%\qualifier{fit_fun=fitfun}{: only include models using the fit-function \code{fitfun}} -%\qualifier{get_list}{: the information is not printed, but returned} -%\qualifier{load_best}{: load the best fit parameters} +%\qualifier{fit_fun}{include fit-function} +%\qualifier{fit_fun=fitfun}{only include models using the fit-function \code{fitfun}} +%\qualifier{get_list}{the information is not printed, but returned} +%\qualifier{load_best}{load the best fit parameters} %\qualifier{verbose}{} %} %\description diff --git a/src/fitting/parameters/get_params_table_from_files.sl b/src/fitting/parameters/get_params_table_from_files.sl index cf3fb8f46359e872cfdaf4014a577cb49074781c..b423cd3757347c6565b421f76283b482c1493e1d 100644 --- a/src/fitting/parameters/get_params_table_from_files.sl +++ b/src/fitting/parameters/get_params_table_from_files.sl @@ -4,13 +4,13 @@ define get_params_table_from_files() %\synopsis{retrieves fit-parameter information from files} %\usage{Struct_Type get_params_table_from_files(String_Type filenames[]);} %\qualifiers{ -%\qualifier{free}{: only include free parameters} -%\qualifier{par}{: array of parameters to be included} -%\qualifier{filename}{: include filenames into the structure} -%\qualifier{nominmax}{: do not include min max values} -%\qualifier{eval_counts}{: evaluates the model and returns the statistic as well. +%\qualifier{free}{only include free parameters} +%\qualifier{par}{array of parameters to be included} +%\qualifier{filename}{include filenames into the structure} +%\qualifier{nominmax}{do not include min max values} +%\qualifier{eval_counts}{evaluates the model and returns the statistic as well. % It is assumed that the appropriate data is already loaded.} -%\qualifier{verbose}{: show name of parameter files while being processed} +%\qualifier{verbose}{show name of parameter files while being processed} %} %\description % \code{filename} may be a globbing expression. diff --git a/src/fitting/parameters/list_Par.sl b/src/fitting/parameters/list_Par.sl index 330a97c1c841b3075e544dbd1967ecbf8f0381da..14b4e2180390ba7cc7eec6a1f3b94f3205de52fc 100644 --- a/src/fitting/parameters/list_Par.sl +++ b/src/fitting/parameters/list_Par.sl @@ -4,8 +4,8 @@ define list_Par() %\synopsis{lists parameters of the current fit-function as ISIS-commands} %\usage{list_Par([ pars[] ]);} %\qualifiers{ -%\qualifier{fit_fun}{: lists also the fit-function} -%\qualifier{fmt}{: format statement for min/max/value} +%\qualifier{fit_fun}{lists also the fit-function} +%\qualifier{fmt}{format statement for min/max/value} %} %!%- { diff --git a/src/fitting/parameters/switch_tbnew_rel_abund.sl b/src/fitting/parameters/switch_tbnew_rel_abund.sl index 62b1e26c2b0831bfcb0ca2f3199569d1787fe0a7..d4637469550f56f2a87ae7bade3b2e0b43269bf6 100644 --- a/src/fitting/parameters/switch_tbnew_rel_abund.sl +++ b/src/fitting/parameters/switch_tbnew_rel_abund.sl @@ -9,7 +9,7 @@ define switch_tbnew_rel_abund() %\description % Unless one or more \code{parnames} are given, all elements are switched. %\qualifiers{ -%\qualifier{inst}{ [=1]: instance of tbnew} +%\qualifier{inst}{[=1] instance of tbnew} %\qualifier{verbose}{} %} %!%- diff --git a/src/fitting/pvm_fit_pars.sl b/src/fitting/pvm_fit_pars.sl index 7b406a96602f839c8e64cb522d06d2ac01398c43..9491e13460bf1998842d4e77327919126e9d9092 100644 --- a/src/fitting/pvm_fit_pars.sl +++ b/src/fitting/pvm_fit_pars.sl @@ -147,21 +147,21 @@ define pvm_fit_pars() % and <\code{dir}>/<\code{basefilename}>\code{_conf.fits}. % In case of any error, the return value is \code{NULL}. %\qualifiers{ -%\qualifier{level}{: specifies the confidence level to be computed. +%\qualifier{level}{confidence level to be computed. % As for conf, 0 means 68%, 1 means 90% [default], and 2 means 99% confidence level.} -%\qualifier{tolerance}{: the tolerance for chi^2 improvements without interrupting the search +%\qualifier{tolerance}{the tolerance for chi^2 improvements without interrupting the search % for the confidence intervals, see \code{help("conf");}. The default is \code{1e-3}.} -%\qualifier{fitmethod}{: fit-method to be used, see \code{help("set_fit_method");} +%\qualifier{fitmethod}{fit-method to be used, see \code{help("set_fit_method");} % Default is the currently used fit-method returned by \code{get_fit_method()}.} -%\qualifier{nph}{: the number of processes per host, see \code{pvm_ms}.} -%\qualifier{debug}{ [=1]: prints additional debug information from \code{pvm_ms}. (Default=0)} -%\qualifier{dir}{ [="."]: specifies the directory in which the logfiles shall be stored. +%\qualifier{nph}{the number of processes per host, see \code{pvm_ms}.} +%\qualifier{debug}{[=1] prints additional debug information from \code{pvm_ms}. (Default=0)} +%\qualifier{dir}{[="."] specifies the directory in which the logfiles shall be stored. % It may be a relative path to the current working directory.} -%\qualifier{basefilename}{ [=startdate]} -%\qualifier{verbose}{: log every output -- from the master script or any slave -- +%\qualifier{basefilename}{[=startdate]} +%\qualifier{verbose}{log every output -- from the master script or any slave -- % in the file <\code{dir}>/<\code{basefilename}>\code{_stdout.log}, % and keep the initial parameters.} -%\qualifier{isisscript}{ [="isis-script"]: command to start ISIS for slaves.} +%\qualifier{isisscript}{[="isis-script"] command to start ISIS for slaves.} %} %\seealso{fit_pars; conf, set_fit_method, cl_master/cl_slave [Houck/Noble], pvm_ms [S-Lang module]} %!%- diff --git a/src/fitting/steppar.sl b/src/fitting/steppar.sl index 3683d59c9f8af1bdc699d11aaf09dcab66821827..e6ddd7c189f42a9e62c96d7b328883bcfbd062da 100644 --- a/src/fitting/steppar.sl +++ b/src/fitting/steppar.sl @@ -77,10 +77,10 @@ define steppar_load() %{{{ %\usage{ Struct_Type[] steppar = steppar_load( String_Typep[] pat ); } %\altusage{ Struct_Type[] steppar, keys = steppar_load( String_Type[] pat ; keys ); } %\qualifiers{ -%\qualifier{keys}{: If given also the key structure is returned (using fits_read_header). +%\qualifier{keys}{If given also the key structure is returned (using fits_read_header). % If keys is a List_Type with keynames, only these keys are read using % fits_read_key_struct, which is faster!} -%\qualifier{ext}{: Only loads extension fitting 'ext' (String_Type)!} +%\qualifier{ext}{Only loads extension fitting 'ext' (String_Type)!} %} %\description % Loads a *.fits file storing the steppar information saved with @@ -280,11 +280,11 @@ define steppar_get_bestparams() %{{{ %\usage{ Struct_Type[] params = steppar_get_bestparams( String_Type[] File );} %\altusage{ Struct_Type[] params = steppar_get_bestparams( Struct_Type[] steppar );} %\qualifiers{ -%\qualifier{chatty}{: Information output} -%\qualifier{minchi2}{: Chi2 limit the new parameter set has to beat +%\qualifier{chatty}{Information output} +%\qualifier{minchi2}{Chi2 limit the new parameter set has to beat % to be taken into accounts! % Default: eval_stat_counts.statistic} -%\qualifier{groups}{: Allows to extract best parameter sets for defined parameter +%\qualifier{groups}{Allows to extract best parameter sets for defined parameter % groups. 'groups' has to be an Array_Type, where each entry % represents a group and contains an Integer/String array % with the according parameter indices/names. @@ -404,8 +404,8 @@ define steppar_get_conf() %{{{ %\usage{ Struct_Type[] conf = steppar_get_conf( String_Type[] File );} %\altusage{ Struct_Type[] conf = steppar_get_conf( Struct_Type[] steppar );} %\qualifiers{ -%\qualifier{chatty}{: Information output} -%\qualifier{dchi2}{[=2.71]: Delta Chisqr} +%\qualifier{chatty}{Information output} +%\qualifier{dchi2}{[=2.71] Delta Chisqr} %} %\description % Tries to obtain confidence level related to the given 'dchi2' @@ -485,24 +485,24 @@ define steppar() %{{{ %\usage{Struct_Type info = steppar(String/Integer_Type par [, Double_Type val1, val2, step] );} %\altusage{(Struct_Type info, keys) = steppar( String/Integer_Type par [, Double_Type val1, val2, step]; keys);} %\qualifiers{ -%\qualifier{keys}{: An additional structure is returned that can be used as FITS header keys} -%\qualifier{frozen}{[=0]: Perform steppar also for frozen Parameters.} -%\qualifier{range}{[parmin,parmax]: Stepping range. Default is the +%\qualifier{keys}{An additional structure is returned that can be used as FITS header keys} +%\qualifier{frozen}{[=0] Perform steppar also for frozen Parameters.} +%\qualifier{range}{[parmin,parmax] Stepping range. Default is the % minimal/maximal allowed parameter value.} -%\qualifier{nsteps}{[=10]: Number of steps the parameter 'par' is +%\qualifier{nsteps}{[=10] Number of steps the parameter 'par' is % stepped from range[0] to range[1].} -%\qualifier{reset}{: If given after each step the initial parameter set, which was +%\qualifier{reset}{If given after each step the initial parameter set, which was % valid before this function was called, is restored.} -%\qualifier{fit}{[=&fit_counts]: Reference to the function running the fit algorithm.} -%\qualifier{fitargs}{: Arguments required by the 'fit' function. See __push_list for +%\qualifier{fit}{[=&fit_counts] Reference to the function running the fit algorithm.} +%\qualifier{fitargs}{Arguments required by the 'fit' function. See __push_list for % format information!} -%\qualifier{rerun}{: Reruns a stepping procedure based on results of a previous run, +%\qualifier{rerun}{Reruns a stepping procedure based on results of a previous run, % i.e., before each step the according parameter set of the previous % run is loaded, e.g., to improve the results using another fit_method.} -%\qualifier{resume}{: Missing steps in the given steppar-file will be calculated based +%\qualifier{resume}{Missing steps in the given steppar-file will be calculated based % on the previous steps, i.e., resuming the stepping where it was % stopped.} -%\qualifier{check}{[=0]: Before each step saved steppar informations of other stepped +%\qualifier{check}{[=0] Before each step saved steppar informations of other stepped % parameters are gathered and checked for a parameter set with a % better chi2 (using steppar_get_bestparams). In case a better % parameter set was found the stepping will be restarted. @@ -518,15 +518,15 @@ define steppar() %{{{ % chi2_new < chi2_init * ( 1 - dchi2 ) % * NOTE: Parameter grouping is possible (see steppar_get_bestparams) % } -%\qualifier{dchi2}{[=0.1]: Percental limit for the chi2 of a new parameter set to be +%\qualifier{dchi2}{[=0.1] Percental limit for the chi2 of a new parameter set to be % considered as a better parameter set (see 'check'): % chi2_new < chi2_init * ( 1 - dchi2 ).} -%\qualifier{save}{: After each stepping the result is saved in the file given +%\qualifier{save}{After each stepping the result is saved in the file given % (as String_Type) with this qualifier. The chi2 of undone steps % are set to 0.! Also note that the filename is appended with % the parameterindex: 'steppar.fits' -> 'steppar_PID00001.fits'} -%\qualifier{force}{: Forces to overwrite an existing file given with 'save'.} -%\qualifier{chatty}{: Prints fitting information.} +%\qualifier{force}{Forces to overwrite an existing file given with 'save'.} +%\qualifier{chatty}{Prints fitting information.} %} %\description % The given parameter is stepped through in the given parameter 'range', @@ -930,15 +930,15 @@ define steppar_plot() %{{{ %\usage{steppar_plot( Struct_Type steppar, key );} %\altusage{steppar_plot( String_Type stepparfile );} %\qualifiers{ -%\qualifier{norender}{: If given xfig plots are returned instead of rendered} -%\qualifier{pdfunite}{: If given the rendered plots are united into a single one} -%\qualifier{ignorez}{: Ignores Chi2 values equal to Zero} -%\qualifier{size}{=[15,11]: Size of the plot} +%\qualifier{norender}{If given xfig plots are returned instead of rendered} +%\qualifier{pdfunite}{If given the rendered plots are united into a single one} +%\qualifier{ignorez}{Ignores Chi2 values equal to Zero} +%\qualifier{size}{=[15,11] Size of the plot} %\qualifier{path}{="steppar.pdf": Path for the rendered file} %\qualifier{ext}{=".pdf": File Type, e.g., "png"} -%\qualifier{yoff}{: Constant offset for the y-axis. Set to the initial statistic +%\qualifier{yoff}{Constant offset for the y-axis. Set to the initial statistic % by default} -%\qualifier{yrange}{: Range of the y-axis. Either Double_Type[1] or [2]. +%\qualifier{yrange}{Range of the y-axis. Either Double_Type[1] or [2]. % If only one value is given it is taken as ymax! } %\qualifier{dchi2}{=2.71: Delta Chisqr} %} diff --git a/src/fitting/xspec_to_isis.sl b/src/fitting/xspec_to_isis.sl index 63b93317565c44f4127d48c3e9a354d3e828fc2b..67d80beb65992814fe61a10930a9484b3c348e4a 100644 --- a/src/fitting/xspec_to_isis.sl +++ b/src/fitting/xspec_to_isis.sl @@ -169,10 +169,10 @@ define xspec_to_isis (name) %\synopsis{Parse xspec parameter file to isis parameter file} %\usage{Integer_Type t = xspec_to_isis(String_Type xspec_par)} %\qualifiers{ -%\qualifier{set}{: set loadad parameters} -%\qualifier{save [=String_Type filename]}{: save parameters as isis parameter file +%\qualifier{set}{set loadad parameters} +%\qualifier{save}{ [=String_Type filename] save parameters as isis parameter file % if filename is not specified it is saved as the .xcm file but with .par suffix} -%\qualifier{nonverbose}{: suppress any output not produced by errors} +%\qualifier{nonverbose}{suppress any output not produced by errors} %} %\description % Parse an xspec parameter file \code{.xcm} to an isis parameter file. diff --git a/src/fitting/xyfit/array_fit_gauss.sl b/src/fitting/xyfit/array_fit_gauss.sl index 4f5200f77432a8b0f142588a0c3689788b10108f..66a219fc9ae36729498c081881f513949cd5ed91 100644 --- a/src/fitting/xyfit/array_fit_gauss.sl +++ b/src/fitting/xyfit/array_fit_gauss.sl @@ -6,10 +6,10 @@ define array_fit_gauss() %\synopsis{performs a gaussian fit on given x- or xy-data} %\usage{Struct_Type array_fit_gauss(x [,y] [,dy] [,c] [,s] [,a] [,o]);} %\qualifiers{ -%\qualifier{frz}{: boolean array determining which parameters (c,s,a,o) are frozen} -%\qualifier{keep}{: keeps the data and fit function (be careful, needs to be deleted for the next fit} -%\qualifier{plot}{: plot the given data and oplot the fit} -%\qualifier{oplot}{: only oplot the fit} +%\qualifier{frz}{boolean array determining which parameters (c,s,a,o) are frozen} +%\qualifier{keep}{keeps the data and fit function (be careful, needs to be deleted for the next fit} +%\qualifier{plot}{plot the given data and oplot the fit} +%\qualifier{oplot}{only oplot the fit} %} %\description % Tries to fit the given data by a gaussian and an offset. If the y-data is diff --git a/src/histogram/bin_average.sl b/src/histogram/bin_average.sl index 8d84901fdb54dc420e932dabbb8e5937f641196e..3068d556d197c143ee6ac9a434efd377d0796e4d 100644 --- a/src/histogram/bin_average.sl +++ b/src/histogram/bin_average.sl @@ -4,9 +4,9 @@ define bin_average() %\synopsis{computes averages in histogram bins} %\usage{Struct_Type bin_average(phi, rate, phi_lo[, phi_hi])} %\qualifiers{ -%\qualifier{err}{: error on rate} -%\qualifier{quantiles}{: array of quantiles to calculate for the distribution} -%\qualifier{quartiles}{: calculate the .25, .5 and .75 quantiles} +%\qualifier{err}{error on rate} +%\qualifier{quantiles}{array of quantiles to calculate for the distribution} +%\qualifier{quartiles}{calculate the .25, .5 and .75 quantiles} %} %\description % The fields of the returned structure are:\n diff --git a/src/histogram/hist_fwhm.sl b/src/histogram/hist_fwhm.sl index e606205cf7cd2cd867e6487bf1e934579192a87d..ce2235a2a8947f3aa57606261d81d12eddfdef09 100644 --- a/src/histogram/hist_fwhm.sl +++ b/src/histogram/hist_fwhm.sl @@ -109,7 +109,7 @@ define get_instrument_resolution_from_data (id) %\usage{R = get_instrument_resolution_from_data(id)} %\synopsis{Compute energy resolution from data set 'id'} %\qualifiers{ -%\qualifier{energy}{: If given will return the grid as energy grid +%\qualifier{energy}{If given will return the grid as energy grid % instead of wavelength} %} %\description diff --git a/src/histogram/histogram2d_min_max.sl b/src/histogram/histogram2d_min_max.sl index 491dd95224cf28e49ce0d268bd3ed3c33958f23c..d902f4cc9461489a265e31398dec9a958d7e26e0 100644 --- a/src/histogram/histogram2d_min_max.sl +++ b/src/histogram/histogram2d_min_max.sl @@ -6,14 +6,14 @@ define histogram2d_min_max() %\synopsis{computes a 2d histogram between minimum and maximum data values} %\usage{h2 = histogram2d_min_max(Double_Type Y, X);} %\qualifiers{ -%\qualifier{xmin}{ [\code{=min(X)}]: first value of \code{Xlo}-grid} -%\qualifier{xmax}{ [\code{=max(X)}]: last value of \code{Xhi}-grid} -%\qualifier{ymin}{ [\code{=min(Y)}]: first value of \code{Ylo}-grid} -%\qualifier{ymax}{ [\code{=max(Y)}]: last value of \code{Yhi}-grid} -%\qualifier{Nx}{ [=50]: number of bins of (linear) \code{Xlo}-grid} -%\qualifier{Ny}{ [=50]: number of bins of (linear) \code{Ylo}-grid} -%\qualifier{Xlo}{: reference to a variable to store the \code{Xlo} array} -%\qualifier{Ylo}{: reference to a variable to store the \code{Ylo} array} +%\qualifier{xmin}{[\code{=min(X)}]: first value of \code{Xlo}-grid} +%\qualifier{xmax}{[\code{=max(X)}]: last value of \code{Xhi}-grid} +%\qualifier{ymin}{[\code{=min(Y)}]: first value of \code{Ylo}-grid} +%\qualifier{ymax}{[\code{=max(Y)}]: last value of \code{Yhi}-grid} +%\qualifier{Nx}{[=50]: number of bins of (linear) \code{Xlo}-grid} +%\qualifier{Ny}{[=50]: number of bins of (linear) \code{Ylo}-grid} +%\qualifier{Xlo}{reference to a variable to store the \code{Xlo} array} +%\qualifier{Ylo}{reference to a variable to store the \code{Ylo} array} %} %\description % For 2d arrays, the order of the indices matters. diff --git a/src/histogram/histogram_min_max.sl b/src/histogram/histogram_min_max.sl index 55d67e5b02deb246ff0938c6849a95d14e4884ca..96a425cf1d18cace24d22db1065b1f06dc1c5058 100644 --- a/src/histogram/histogram_min_max.sl +++ b/src/histogram/histogram_min_max.sl @@ -6,8 +6,8 @@ define histogram_min_max() %\synopsis{computes a histogram between minimum and maximum value} %\usage{Struct_Type h = histogram_min_max(Double_Type X[, Double_Type dx]);} %\qualifiers{ -%\qualifier{log}{: use a logarithmic grid with the following number of bins:} -%\qualifier{N}{ [=100]: number of bins of logarithmic or linear grid} +%\qualifier{log}{use a logarithmic grid with the following number of bins:} +%\qualifier{N}{[=100] number of bins of logarithmic or linear grid} %} %\description % The return value is a \code{{ bin_lo, bin_hi, value, err }} structure which diff --git a/src/misc/SRT/SRT_image.sl b/src/misc/SRT/SRT_image.sl index fcc597baae2171ec2170d46e19368b2d4f96c9a6..aaa53d88d44f871dabe6f1719cc5488414598948 100644 --- a/src/misc/SRT/SRT_image.sl +++ b/src/misc/SRT/SRT_image.sl @@ -4,7 +4,7 @@ define SRT_image() %\synopsis{extracts an image from a SRT data structure containing an npoinscan} %\usage{Float_Type img[] = SRT_image(Struct_Type data);} %\qualifiers{ -%\qualifier{plot}{: plots the image} +%\qualifier{plot}{plots the image} %} %\seealso{SRT_read} %!%- diff --git a/src/misc/SRT/SRT_mw_plots.sl b/src/misc/SRT/SRT_mw_plots.sl index 9fe13b1fbba8a0d2942260374a2d65c1097901f8..97a81e43c6b1972f6bc689c0c3ff9e293b3920ed 100644 --- a/src/misc/SRT/SRT_mw_plots.sl +++ b/src/misc/SRT/SRT_mw_plots.sl @@ -46,17 +46,18 @@ define SRT_plot_mw_spectra() { %\usage{SRT_plot_mw_spectra(Struct_Type[] spectrum);} %\altusage{SRT_plot_mw_spectra(Struct_Type[] data, Integer_Type[] chunks);} %\qualifiers{ -%\qualifier{pad}{: additional space between plot frame and data limits} -%\qualifier{fMax}{: give the frequency of the cloud to be plotted, has to be of same length as spectra/chunks} -%\qualifier{fConfMax}{: give the upper confidence leve of the maximal frequency of the cloud to be plotted, has to be of same length as spectra/chunks} -%\qualifier{fConfMin}{: give the lower confidence leve of the maximal frequency of the cloud to be plotted, has to be of same length as spectra/chunks} -%\qualifier{fMaxLin}{: type of line used to plot fMax} -%\qualifier{fConfLine}{: type of line used to plot fConfMin and fConfMax} -%\qualifier{xlabel}{: specify label for x-axis} -%\qualifier{ylabel}{: specify label for y-axis} -%\qualifier{title}{: give title for plot either as single title or for each plot individually as an array of strings} -%\qualifier{name}{: file name of plot, either a single one or for each plot as a an array of string, specify file format, i.e. mw_scan.pdf} -%\qualifier{return_xfig}{: return xfig-data instead of plotting}} +%\qualifier{pad}{additional space between plot frame and data limits} +%\qualifier{fMax}{give the frequency of the cloud to be plotted, has to be of same length as spectra/chunks} +%\qualifier{fConfMax}{upper confidence level of the maximal frequency of the cloud to be plotted, has to be of same length as spectra/chunks} +%\qualifier{fConfMin}{lower confidence level of the maximal frequency of the cloud to be plotted, has to be of same length as spectra/chunks} +%\qualifier{fMaxLin}{type of line used to plot fMax} +%\qualifier{fConfLine}{type of line used to plot fConfMin and fConfMax} +%\qualifier{xlabel}{label for x-axis} +%\qualifier{ylabel}{label for y-axis} +%\qualifier{title}{title for plot, either as single title or for each plot individually as an array of strings} +%\qualifier{name}{file name of plot, either a single one or for each plot as a an array of string, specify file format, i.e., mw_scan.pdf} +%\qualifier{return_xfig}{return xfig-data instead of plotting} +%} %\description % The function automatically plots Milky Way spectra obtained with the SRT. % It can be given a single or an array of spectra or the data and an array of chunk numbers. The required data format is based on the output of SRT_get_mw_spectrum and all of its qualifiers can be used. diff --git a/src/misc/SRT/SRT_read.sl b/src/misc/SRT/SRT_read.sl index ae72e8b44482ccedf6aff487c6ca3cdd05f5113c..e4b1bce0d8fda96b0f00fa419a01c05fdb5b9bd6 100644 --- a/src/misc/SRT/SRT_read.sl +++ b/src/misc/SRT/SRT_read.sl @@ -5,10 +5,10 @@ define SRT_read() %\usage{Struct_Type data[] = SRT_read(String_Type filename);} %\qualifiers{ %\qualifier{verbose}{} -%\qualifier{onechunk}{: read all data into one structure instead of an array +%\qualifier{onechunk}{read all data into one structure instead of an array % (default if file has no comments)} %\qualifier{bins_to_cut}{[=8]: number of bad bins at high and low frequencies} -%\qualifier{position}{: [lat,longw] position of the SRT +%\qualifier{position}{[lat,longw] position of the SRT % (default: lat=49.90 and longw=349.10)} %} %\seealso{SRT_spectrum, SRT_image} diff --git a/src/misc/SRT/SRT_spectrum.sl b/src/misc/SRT/SRT_spectrum.sl index 2edf6dfa73663a31a374cf25bf708f56e3c69ed4..43dc7942d798cb7376a155e488b0f47b3183e052 100644 --- a/src/misc/SRT/SRT_spectrum.sl +++ b/src/misc/SRT/SRT_spectrum.sl @@ -5,12 +5,12 @@ define SRT_spectrum() %\usage{Struct_Type spec = SRT_spectrum(Struct_Type data);} %\qualifiers{ %\qualifier{verbose}{} -%\qualifier{bins_to_cut}{ [\code{=8}]: number of bins at both sides of the spectrum that are discarded} -%\qualifier{bins_cut_low}{ [\code{=0}]: number of bins to additionaly cut from lower side} -%\qualifier{bins_cut_high}{ [\code{=0}]: number of bins to additionaly cut from upper side} -%\qualifier{normalize}{: \code{spec.value} is normalized between 0 and 1.} -%\qualifier{vLSR}{: transform the frequency grid to a velocity grid} -%\qualifier{filename=name}{: plots the spectrum as name.ps in the +%\qualifier{bins_to_cut}{[\code{=8}] number of bins at both sides of the spectrum that are discarded} +%\qualifier{bins_cut_low}{[\code{=0}] number of bins to additionaly cut from lower side} +%\qualifier{bins_cut_high}{[\code{=0}] number of bins to additionaly cut from upper side} +%\qualifier{normalize}{\code{spec.value} is normalized between 0 and 1.} +%\qualifier{vLSR}{transform the frequency grid to a velocity grid} +%\qualifier{filename=name}{plots the spectrum as name.ps in the % current directory} %} %\description diff --git a/src/misc/astronomy/N_body_simulation_MW_kernel.sl b/src/misc/astronomy/N_body_simulation_MW_kernel.sl index 32ac0b023ae04b7151fb8b23d645d6277047774b..b650b4484c045f5b9e328d82d9ad970700a6083f 100644 --- a/src/misc/astronomy/N_body_simulation_MW_kernel.sl +++ b/src/misc/astronomy/N_body_simulation_MW_kernel.sl @@ -15,7 +15,7 @@ define N_body_simulation_MW_kernel() % mass units and then multiplied with a constant accounting for the remaining unit % conversions (see example below). The units of 'psb' have to be kpc^2. %\qualifiers{ -%\qualifier{model}{ [\code{="AS"}]: Function ("AS", "MN_NFW", or "MN_TF"), which evaluates the equations of +%\qualifier{model}{[\code{="AS"}]: Function ("AS", "MN_NFW", or "MN_TF"), which evaluates the equations of % motion that result from a model for the gravitational potential of the Milky Way.} %\qualifier{All qualifiers from the model potential function except 'coords'.}{} %\qualifier{All qualifiers from the function 'N_body_simulation_std_kernel'.}{} diff --git a/src/misc/astronomy/galactic_rotation_velocity.sl b/src/misc/astronomy/galactic_rotation_velocity.sl index 5900c8c949641001a688007ebbd28cd04cd8aa23..2b9e3fca6bae15fa7b79ddc347df97736d1f1ccc 100644 --- a/src/misc/astronomy/galactic_rotation_velocity.sl +++ b/src/misc/astronomy/galactic_rotation_velocity.sl @@ -3,7 +3,7 @@ define galactic_rotation_velocity(r) %\function{galactic_rotation_velocity} %\usage{Double_Type galactic_rotation_velocity(Double_Type r; model=m)} %\qualifiers{ -%\qualifier{model}{: \code{m=1} selects Model I (B&T, Fig. 2.20), \code{m=2} selects Model II (B&T, Fig. 2.22) +%\qualifier{model}{\code{m=1} selects Model I (B&T, Fig. 2.20), \code{m=2} selects Model II (B&T, Fig. 2.22) % If neither \code{m=1} nor \code{m=2} is specified, the constant 220 is returned.} %} %\description diff --git a/src/misc/astronomy/hardnessratio.sl b/src/misc/astronomy/hardnessratio.sl index ebac361f41281125d65312cbe57ccf6842b42c6e..ff06d9265bc67f3b996210493b759fc60a97a040 100644 --- a/src/misc/astronomy/hardnessratio.sl +++ b/src/misc/astronomy/hardnessratio.sl @@ -9,17 +9,17 @@ define behr() %\synopsis{calculates fractional difference hardness ratio thorugh bayesian estimation} %\usage{Double_Type (HR , HR_err_max , HR_err_min) = behr(Double_Type soft_count, Double_Type hard_count);} %\qualifiers{ -% \qualifier{scale_s}{: Scaling factor for soft_count; soft_count = scale_s*soft_count (default = 1)} -% \qualifier{scale_h}{: Scaling factor for hard_count; hard_count = scale_h*hard_count (default = 1)} -% \qualifier{back_s}{: background counts in the soft band} -% \qualifier{back_h}{: background counts in the hard band} -% \qualifier{bkg_scale_s}{: Scaling factor for source background to observed background counts in the soft band. +% \qualifier{scale_s}{Scaling factor for soft_count; soft_count = scale_s*soft_count (default = 1)} +% \qualifier{scale_h}{Scaling factor for hard_count; hard_count = scale_h*hard_count (default = 1)} +% \qualifier{back_s}{background counts in the soft band} +% \qualifier{back_h}{background counts in the hard band} +% \qualifier{bkg_scale_s}{Scaling factor for source background to observed background counts in the soft band. % Expected background in source region is ~ back_s/bkg_scale_s.} -% \qualifier{bkg_scale_h}{: Scaling factor for source background to observed background counts in the hard band. +% \qualifier{bkg_scale_h}{Scaling factor for source background to observed background counts in the hard band. % Expected background in source region is ~ back_h/bkg_scale_h.} % \qualifier{aprox_n}{= run aproximation which keeps powers of bkg_scale_h^i*bkg_scale_s^j, with i+j <= n} -% \qualifier{significance}{: significance of calculated uncertainties in percent (default = 68 per cent)} -% \qualifier{fulloutput}{: if present function will additionally return the Grid used (2000 color values ranging from -0.999 to 0.999), and the +% \qualifier{significance}{significance of calculated uncertainties in percent (default = 68 per cent)} +% \qualifier{fulloutput}{if present function will additionally return the Grid used (2000 color values ranging from -0.999 to 0.999), and the % normalized probability distribution} %} %\description @@ -218,23 +218,23 @@ define hardnessratio() %\usage{Double_Type (HR , HR_err) = hardnessratio(Double_Type soft_count, Double_Type hard_count);} %\altusage{Double_Type (HR , HR_err_up , HR_err_down) = hardnessratio(Double_Type soft_count, Double_Type hard_count ; bayesian);} %\qualifiers{ -% \qualifier{color}{: calculate the hardness ratio according to color=log10(S/H)} -% \qualifier{hardness}{: calculate the hardness ratio according to hardness=(H-S)/(H+S)} -% \qualifier{ratio}{: calculate the hardness ratio according to ratio=S/H (the default)} -% \qualifier{bayesian}{: returns hardness calculated using the bayesian estimation, calling +% \qualifier{color}{calculate the hardness ratio according to color=log10(S/H)} +% \qualifier{hardness}{calculate the hardness ratio according to hardness=(H-S)/(H+S)} +% \qualifier{ratio}{calculate the hardness ratio according to ratio=S/H (the default)} +% \qualifier{bayesian}{returns hardness calculated using the bayesian estimation, calling % the function behr()} -% \qualifier{back_s}{: background counts in the soft band} -% \qualifier{back_h}{: background counts in the hard band} -% \qualifier{backscale}{: ratio between the extraction regions for the source and the background} -% \qualifier{exposure}{: Exposure per bin in seconds. If given, interpret soft_count, hard_count and t +% \qualifier{back_s}{background counts in the soft band} +% \qualifier{back_h}{background counts in the hard band} +% \qualifier{backscale}{ratio between the extraction regions for the source and the background} +% \qualifier{exposure}{Exposure per bin in seconds. If given, interpret soft_count, hard_count and t % he backgrounds as rates. Multiply the rates with exposure to get the counts.} -% \qualifier{backexposure}{: if given, the background exposure. Only taken into +% \qualifier{backexposure}{if given, the background exposure. Only taken into % account if exposure is also set. If not given, it is assumed that % the source and background exposures are identical.} -% \qualifier{ratio_type}{: (DEPRECATED) Integer_Type, for hr=s/h choose 1, +% \qualifier{ratio_type}{(DEPRECATED) Integer_Type, for hr=s/h choose 1, % for hr=(h-s)/(h+s) choose 2, for hr=log(s/h) choose 3, default = 1} -% \qualifier{err_s}{: Array containing the uncertainties of the soft light curve} -% \qualifier{err_h}{: Array containing the uncertainties of the hard light curve} +% \qualifier{err_s}{Array containing the uncertainties of the soft light curve} +% \qualifier{err_h}{Array containing the uncertainties of the hard light curve} % additional qualifiers are passed to 'behr' for bayesian estimation %} %\description diff --git a/src/misc/astronomy/hardnessratio_from_dataset.sl b/src/misc/astronomy/hardnessratio_from_dataset.sl index 13b7a64a361aaf9008f15f2ff877f6c5760e97d5..249d80868ad5078fc645eb676e4e738e8e2bdcde 100644 --- a/src/misc/astronomy/hardnessratio_from_dataset.sl +++ b/src/misc/astronomy/hardnessratio_from_dataset.sl @@ -8,10 +8,10 @@ define hardnessratio_from_dataset() % Integer_Type data-id, Integer_Type[2] soft_ch, hard_ch % );} %\qualifiers{ -%\qualifier{soft_en}{: Double_Type[2]} -%\qualifier{hard_en}{: Double_Type[2]} -%\qualifier{get_counts}{: set to '&get_model_counts' if needed, default: get_data_counts} -%\qualifier{subtract_background}{: subtract background from data. Only possible if get_counts is not set.} +%\qualifier{soft_en}{Double_Type[2]} +%\qualifier{hard_en}{Double_Type[2]} +%\qualifier{get_counts}{set to '&get_model_counts' if needed, default: get_data_counts} +%\qualifier{subtract_background}{subtract background from data. Only possible if get_counts is not set.} % additional qualifiers are passed to 'hardnessratio' %} %\description diff --git a/src/misc/astronomy/hardnessratio_simulate_grid.sl b/src/misc/astronomy/hardnessratio_simulate_grid.sl index 1844da4cb2ccda41a113ddea29c9b3cf1c99ea9c..36d28192fabe6323b59289189c8e12f7aae532bf 100644 --- a/src/misc/astronomy/hardnessratio_simulate_grid.sl +++ b/src/misc/astronomy/hardnessratio_simulate_grid.sl @@ -10,21 +10,21 @@ define hardnessratio_simulate_grid() % Integer_Type soft_ch1, hard_ch1, soft_ch2, hard_ch2 % );} %\qualifiers{ -%\qualifier{dataindex}{: Integer_Type, dataset index to use, default = 1} -%\qualifier{grid1scale}{: 0 = linear (default), 1 = logarithmic} -%\qualifier{grid2scale}{: 0 = linear (default), 1 = logarithmic} -%\qualifier{par1grid}{: Double_Type[], override value grid of paramter 1} -%\qualifier{par2grid}{: Double_Type[], override value grid of paramter 2} -%\qualifier{sample1}{: Integer_Type, sampling-factor along each track, default 10} -%\qualifier{sample2}{: Integer_Type, sampling-factor along each track, default 10} -%\qualifier{exposure}{: Double_Type, default: 1e4} -%\qualifier{arf}{: String_Type, file path of arf} -%\qualifier{rmf}{: String_Type, file path of rmf} -%\qualifier{rsp}{: String_Type, file path of rsp (arf and rmf combined)} -%\qualifier{soft_en1}{: Double_Type[2], additional qualifier, soft band for all tracks in one direction} -%\qualifier{hard_en1}{: Double_Type[2], additional qualifier, hard band for all tracks in one direction} -%\qualifier{soft_en2}{: Double_Type[2], additional qualifier, soft band for all tracks in other direction} -%\qualifier{hard_en2}{: Double_Type[2], additional qualifier, hard band for all tracks in other direction} +%\qualifier{dataindex}{Integer_Type, dataset index to use, default = 1} +%\qualifier{grid1scale}{0 = linear (default), 1 = logarithmic} +%\qualifier{grid2scale}{0 = linear (default), 1 = logarithmic} +%\qualifier{par1grid}{Double_Type[], override value grid of paramter 1} +%\qualifier{par2grid}{Double_Type[], override value grid of paramter 2} +%\qualifier{sample1}{Integer_Type, sampling-factor along each track, default 10} +%\qualifier{sample2}{Integer_Type, sampling-factor along each track, default 10} +%\qualifier{exposure}{Double_Type, default: 1e4} +%\qualifier{arf}{String_Type, file path of arf} +%\qualifier{rmf}{String_Type, file path of rmf} +%\qualifier{rsp}{String_Type, file path of rsp (arf and rmf combined)} +%\qualifier{soft_en1}{Double_Type[2], additional qualifier, soft band for all tracks in one direction} +%\qualifier{hard_en1}{Double_Type[2], additional qualifier, hard band for all tracks in one direction} +%\qualifier{soft_en2}{Double_Type[2], additional qualifier, soft band for all tracks in other direction} +%\qualifier{hard_en2}{Double_Type[2], additional qualifier, hard band for all tracks in other direction} % additional qualifiers are passed to 'hardnessratio_from_dataset' and 'hardnessratio' %} %\description diff --git a/src/misc/astronomy/orbit_calculator.sl b/src/misc/astronomy/orbit_calculator.sl index ffb620326cf5da56ef12458158c42d9619954792..16937c437a4e2a2588020f948f17620b8dc79118 100644 --- a/src/misc/astronomy/orbit_calculator.sl +++ b/src/misc/astronomy/orbit_calculator.sl @@ -4,6 +4,21 @@ define AS() %{{{ %\synopsis{Evaluate equations of motion, total energy, or circular velocity derived from a revised % Allen & Santillan potential} %\usage{AS(Double_Types t, m[6,n]; qualifiers)} +%\qualifiers{ +%\qualifier{coords}{[\code{="cyl"}] Use cylindrical ("cyl") or cartesian ("cart") coordinates.} +%\qualifier{eomecd}{[\code{="eom"}] Return equations of motion ("eom"), total energy ("energy"), +% circular velocity ("circ"), or Sun-Galactic center distance ("sgcd").} +%\qualifier{Mb}{[\code{=409}] Mass of bulge in Galactic mass units, see Irrgang et al. 2013.} +%\qualifier{Md}{[\code{=2856}] Mass of disc in Galactic mass units, see Irrgang et al. 2013.} +%\qualifier{Mh}{[\code{=1018}] Mass scale factor of halo in Galactic mass units, +% see Irrgang et al. 2013.} +%\qualifier{bb}{[\code{=0.23}] Bulge scale length, see Irrgang et al. 2013.} +%\qualifier{ad}{[\code{=4.22}] Disc scale length, see Irrgang et al. 2013.} +%\qualifier{bd}{[\code{=0.292}] Disc scale length, see Irrgang et al. 2013.} +%\qualifier{ah}{[\code{=2.562}] Halo scale length, see Irrgang et al. 2013.} +%\qualifier{exponent}{[\code{=2}] Exponent in the halo mass distribution, see Irrgang et al. 2013.} +%\qualifier{cutoff}{[\code{=200}] Halo cutoff, see Irrgang et al. 2013.} +%} %\description % Evaluate the equations of motion, the total energy, or the circular velocity at time 't' % derived from the revised Galactic gravitational potential by Allen & Santillan (see Model I @@ -41,20 +56,6 @@ define AS() %{{{ % v_circ(r,z) = Double_Type[n] = sqrt( r * d/dr Potential(r,z) ) % If the qualifier 'eomecd' is set to "sgcd", the function returns the Sun-Galactic center % distance found to fit best to this potential. -%\qualifiers{ -%\qualifier{coords}{ [\code{="cyl"}]: Use cylindrical ("cyl") or cartesian ("cart") coordinates.} -%\qualifier{eomecd}{ [\code{="eom"}]: Return equations of motion ("eom"), total energy ("energy"), -% circular velocity ("circ"), or Sun-Galactic center distance ("sgcd").} -%\qualifier{Mb}{ [\code{=409}]: Mass of bulge in Galactic mass units, see Irrgang et al. 2013.} -%\qualifier{Md}{ [\code{=2856}]: Mass of disc in Galactic mass units, see Irrgang et al. 2013.} -%\qualifier{Mh}{ [\code{=1018}]: Mass scale factor of halo in Galactic mass units, see Irrgang et al. 2013.} -%\qualifier{bb}{ [\code{=0.23}]: Bulge scale length, see Irrgang et al. 2013.} -%\qualifier{ad}{ [\code{=4.22}]: Disc scale length, see Irrgang et al. 2013.} -%\qualifier{bd}{ [\code{=0.292}]: Disc scale length, see Irrgang et al. 2013.} -%\qualifier{ah}{ [\code{=2.562}]: Halo scale length, see Irrgang et al. 2013.} -%\qualifier{exponent}{ [\code{=2}]: Exponent in the halo mass distribution, see Irrgang et al. 2013.} -%\qualifier{cutoff}{ [\code{=200}]: Halo cutoff, see Irrgang et al. 2013.} -%} %\example % delta = AS(0, m); % energy = AS(0, m; eomecd="energy"); @@ -219,6 +220,18 @@ define MN_NFW() %{{{ % potential with a Miyamoto & Nagai bulge and disk component and a Navarro, Frenk, % & White dark matter halo} %\usage{MN_NFW(Double_Types t, m[6,n]; qualifiers)} +%\qualifiers{ +%\qualifier{coords}{[\code{="cyl"}] Use cylindrical ("cyl") or cartesian ("cart") coordinates.} +%\qualifier{eomecd}{[\code{="eom"}] Return equations of motion ("eom"), total energy ("energy"), +% circular velocity ("circ"), or Sun-Galactic center distance ("sgcd").} +%\qualifier{Mb}{[\code{=439}] Mass of bulge in Galactic mass units, see Irrgang et al. 2013.} +%\qualifier{Md}{[\code{=3096}] Mass of disc in Galactic mass units, see Irrgang et al. 2013.} +%\qualifier{Mh}{[\code{=142200}] Mass scale factor of halo in Galactic mass units, see Irrgang et al. 2013.} +%\qualifier{bb}{[\code{=0.236}] Bulge scale length, see Irrgang et al. 2013.} +%\qualifier{ad}{[\code{=3.262}] Disc scale length, see Irrgang et al. 2013.} +%\qualifier{bd}{[\code{=0.289}] Disc scale length, see Irrgang et al. 2013.} +%\qualifier{ah}{[\code{=45.02}] Halo scale length, see Irrgang et al. 2013.} +%} %\description % Evaluate the equations of motion, the total energy, or the circular velocity at time 't' % derived from a potential with a Miyamoto & Nagai bulge and disk component and a Navarro, @@ -257,18 +270,6 @@ define MN_NFW() %{{{ % v_circ(r,z) = Double_Type[n] = sqrt( r * d/dr Potential(r,z) ) % If the qualifier 'eomecd' is set to "sgcd", the function returns the Sun-Galactic center % distance found to fit best to this potential. -%\qualifiers{ -%\qualifier{coords}{ [\code{="cyl"}]: Use cylindrical ("cyl") or cartesian ("cart") coordinates.} -%\qualifier{eomecd}{ [\code{="eom"}]: Return equations of motion ("eom"), total energy ("energy"), -% circular velocity ("circ"), or Sun-Galactic center distance ("sgcd").} -%\qualifier{Mb}{ [\code{=439}]: Mass of bulge in Galactic mass units, see Irrgang et al. 2013.} -%\qualifier{Md}{ [\code{=3096}]: Mass of disc in Galactic mass units, see Irrgang et al. 2013.} -%\qualifier{Mh}{ [\code{=142200}]: Mass scale factor of halo in Galactic mass units, see Irrgang et al. 2013.} -%\qualifier{bb}{ [\code{=0.236}]: Bulge scale length, see Irrgang et al. 2013.} -%\qualifier{ad}{ [\code{=3.262}]: Disc scale length, see Irrgang et al. 2013.} -%\qualifier{bd}{ [\code{=0.289}]: Disc scale length, see Irrgang et al. 2013.} -%\qualifier{ah}{ [\code{=45.02}]: Halo scale length, see Irrgang et al. 2013.} -%} %\example % delta = MN_NFW(0, m); % energy = MN_NFW(0, m; eomecd="energy"); @@ -418,6 +419,18 @@ define MN_TF() %{{{ % potential with a Miyamoto & Nagai bulge and disk component and a truncated, flat % rotation curve halo model} %\usage{MN_TF(Double_Types t, m[6,n]; qualifiers)} +%\qualifiers{ +%\qualifier{coords}{[\code{="cyl"}] Use cylindrical ("cyl") or cartesian ("cart") coordinates.} +%\qualifier{eomecd}{[\code{="eom"}] Return equations of motion ("eom"), total energy ("energy"), +% circular velocity ("circ"), or Sun-Galactic center distance ("sgcd").} +%\qualifier{Mb}{[\code{=175}] Mass of bulge in Galactic mass units, see Irrgang et al. 2013.} +%\qualifier{Md}{[\code{=2829}] Mass of disc in Galactic mass units, see Irrgang et al. 2013.} +%\qualifier{Mh}{[\code{=69725}] Mass of halo in Galactic mass units, see Irrgang et al. 2013.} +%\qualifier{bb}{[\code{=0.184}] Bulge scale length, see Irrgang et al. 2013.} +%\qualifier{ad}{[\code{=4.85}] Disc scale length, see Irrgang et al. 2013.} +%\qualifier{bd}{[\code{=0.305}] Disc scale length, see Irrgang et al. 2013.} +%\qualifier{ah}{[\code{=200}] Halo scale length, see Irrgang et al. 2013.} +%} %\description % Evaluate the equations of motion, the total energy, or the circular velocity at time 't' % derived from a potential with a Miyamoto & Nagai bulge and disk component and a truncated, @@ -456,18 +469,6 @@ define MN_TF() %{{{ % v_circ(r,z) = Double_Type[n] = sqrt( r * d/dr Potential(r,z) ) % If the qualifier 'eomecd' is set to "sgcd", the function returns the Sun-Galactic center % distance found to fit best to this potential. -%\qualifiers{ -%\qualifier{coords}{ [\code{="cyl"}]: Use cylindrical ("cyl") or cartesian ("cart") coordinates.} -%\qualifier{eomecd}{ [\code{="eom"}]: Return equations of motion ("eom"), total energy ("energy"), -% circular velocity ("circ"), or Sun-Galactic center distance ("sgcd").} -%\qualifier{Mb}{ [\code{=175}]: Mass of bulge in Galactic mass units, see Irrgang et al. 2013.} -%\qualifier{Md}{ [\code{=2829}]: Mass of disc in Galactic mass units, see Irrgang et al. 2013.} -%\qualifier{Mh}{ [\code{=69725}]: Mass of halo in Galactic mass units, see Irrgang et al. 2013.} -%\qualifier{bb}{ [\code{=0.184}]: Bulge scale length, see Irrgang et al. 2013.} -%\qualifier{ad}{ [\code{=4.85}]: Disc scale length, see Irrgang et al. 2013.} -%\qualifier{bd}{ [\code{=0.305}]: Disc scale length, see Irrgang et al. 2013.} -%\qualifier{ah}{ [\code{=200}]: Halo scale length, see Irrgang et al. 2013.} -%} %\example % delta = MN_TF(0, m); % energy = MN_TF(0, m; eomecd="energy"); @@ -617,6 +618,18 @@ define plummer_MW() %{{{ %\function{plummer_MW} %\synopsis{Alternative model potential for the function 'orbit_calculator'} %\usage{plummer_MW(Double_Types t, m[6,n]; qualifiers)} +%\qualifiers{ +%\qualifier{plummer_spheres}{Structure whose fields are again structures with fields 't' [Myr], +% 'x' [kpc], 'y' [kpc], 'z' [kpc], 'psa' [Msun/Mgal*constant] (see notes), and 'psb' +% [kpc^2] describing the orbits and shapes of the Plummer spheres. +% Always make sure that the tabulated times 't[*]' are in monotonic increasing order +% if 't[-1]' is positive or in monotonic decreasing order if 't[-1]' is negative.} +%\qualifier{MW_potential}{[\code{="AS"}]: Function ("AS", "MN_NFW", or "MN_TF"), which evaluates the +% equations of motion that result from a model for the gravitational potential of +% the Milky Way.} +%\qualifier{All qualifiers from the Milky Way model potential (see qualifier 'MW_potential').}{} +%\qualifier{All qualifiers from the function 'plummer_interaction_kernel'.}{} +%} %\description % This function provides an alternative model for the gravitational potential of the % Milky Way which can be used by the function 'orbit_calculator'. The gravitational @@ -630,19 +643,6 @@ define plummer_MW() %{{{ % respective Plummer sphere in solar masses, has to be converted to Galactic mass units % and then multiplied with a constant accounting for the remaining unit conversions % (see example below). The units of 'psb' have to be kpc^2. -% -%\qualifiers{ -%\qualifier{plummer_spheres}{: Structure whose fields are again structures with fields 't' [Myr], -% 'x' [kpc], 'y' [kpc], 'z' [kpc], 'psa' [Msun/Mgal*constant] (see notes), and 'psb' -% [kpc^2] describing the orbits and shapes of the Plummer spheres. -% Always make sure that the tabulated times 't[*]' are in monotonic increasing order -% if 't[-1]' is positive or in monotonic decreasing order if 't[-1]' is negative.} -%\qualifier{MW_potential}{ [\code{="AS"}]: Function ("AS", "MN_NFW", or "MN_TF"), which evaluates the -% equations of motion that result from a model for the gravitational potential of -% the Milky Way.} -%\qualifier{All qualifiers from the Milky Way model potential (see qualifier 'MW_potential').}{} -%\qualifier{All qualifiers from the function 'plummer_interaction_kernel'.}{} -%} %\example % % Test particle affected by the Milky Way and satellite galaxies: % t_end = -100; % integration time in Myr @@ -728,6 +728,39 @@ define orbit_calculator() %{{{ % % or (for error propagation) % orbit_calculator(Double_Types ah, am, as, dd, dm, ds, dist, dist_sigma[], vrad, vrad_sigma[], pma_cos_d, pma_cos_d_sigma[], pmd, pmd_sigma[], t_end; qualifiers)} %\altusage{orbit_calculator(Double_Types x[], y[], z[], vx[], vy[], vz[], t_end; qualifiers)} +%\qualifiers{ +%\qualifier{coords}{[\code{="cyl"}]: Use cylindrical ("cyl") or cartesian ("cart") coordinates for the internal +% computations. Note that circular orbits like that of the Sun are computed faster in cylindrical +% coordinates whereas cartesian coordinates are much more efficient for straight-line trajectories +% or those that come very close to the z-axis where angular momentum terms slow down cylindrical +% calculations.} +%\qualifier{dt}{Deactivate adaptive mode and use this fixed stepsize instead.} +%\qualifier{model}{[\code{="AS"}]: Function ("AS", "MN_NFW", "MN_TF", or "plummer_MW") evaluating the equations +% of motion, circular velocity, and energy of the model potential.} +%\qualifier{MC_runs}{[\code{=nint(10^5)}]: Number of Monte Carlo realizations in the case that 1-sigma errors are given.} +%\qualifier{ODE_solver}{[\code{="RKCK"}]: Choose among three different Runge-Kutta (RK) integration methods: +% "RKF": RK-Fehlberg, "RKCK": RK-Cash-Karp, "RKDP": RK-Dormand-Prince.} +%\qualifier{parallax_pma_corr}{[\code{=0}]: Correlation between parallax and proper motion in right ascension.} +%\qualifier{parallax_pmd_corr}{[\code{=0}]: Correlation between parallax and proper motion in declination.} +%\qualifier{pma_pmd_corr}{[\code{=0}]: Correlation between proper motion in right ascension and in declination.} +%\qualifier{disk}{[\code{=struct{radius = 0, height = 0.1, x = 0, y = 0, z = 0, crossings = 1}}]: If disk.radius > 0, +% orbit integration will be stopped at the moment a trajectory has crossed a horizontal plane +% located at z = disk.z + disk.height * Gaussian-random-number inside a circle of radius +% disk.radius centered at (disk.x, disk.y) for the disk.crossings-th time.} +%\qualifier{seed}{[\code{=_time()}]: Seed the random number generator via the function 'seed_random'.} +%\qualifier{set}{[\code{=0}]: If present, trajectories will be saved ("Save entire trajectories"). As +% this can be very memory-consuming for a large number of orbits, one can additionally +% use the value of this qualifier to specify a lower limit on the time difference of +% two consecutive moments of time that will be saved.} +%\qualifier{stff}{"Save to fits files": Prefix of fits files to which initial and final structures are written.} +%\qualifier{SunGCDist}{By default, the Sun-Galactic center distance is taken from the current model. +% Use this qualifier to explicitly set a distance in kpc.} +%\qualifier{tolerance}{[\code{=1e-8}]: Absolute error control tolerance; lower limit: 1e-15.} +%\qualifier{verbose}{Show intermediate times t.} +%\qualifier{Any qualifiers from 'cel2gal' and the model potential function except 'vlsr' and 'eomecd'.}{ +% Important note: for consistency, the local standard of rest velocity vlsr is calculated from the +% circular velocity of the current model potential evaluated at (r=SunGCDist, z=0).} +%} %\description % Calculate orbits of test particles in a Galactic gravitational potential from given % initial conditions. The latter can be given either in celestial or Galactic cartesian @@ -776,39 +809,6 @@ define orbit_calculator() %{{{ % orbits. For tracing back orbits to the Galactic disk, use the 'disk' qualifier to stop % individual calculations at the moment a trajectory has crossed the disk for a certain % number of times. -%\qualifiers{ -%\qualifier{coords}{ [\code{="cyl"}]: Use cylindrical ("cyl") or cartesian ("cart") coordinates for the internal -% computations. Note that circular orbits like that of the Sun are computed faster in cylindrical -% coordinates whereas cartesian coordinates are much more efficient for straight-line trajectories -% or those that come very close to the z-axis where angular momentum terms slow down cylindrical -% calculations.} -%\qualifier{dt}{: Deactivate adaptive mode and use this fixed stepsize instead.} -%\qualifier{model}{ [\code{="AS"}]: Function ("AS", "MN_NFW", "MN_TF", or "plummer_MW") evaluating the equations -% of motion, circular velocity, and energy of the model potential.} -%\qualifier{MC_runs}{ [\code{=nint(10^5)}]: Number of Monte Carlo realizations in the case that 1-sigma errors are given.} -%\qualifier{ODE_solver}{ [\code{="RKCK"}]: Choose among three different Runge-Kutta (RK) integration methods: -% "RKF": RK-Fehlberg, "RKCK": RK-Cash-Karp, "RKDP": RK-Dormand-Prince.} -%\qualifier{parallax_pma_corr}{ [\code{=0}]: Correlation between parallax and proper motion in right ascension.} -%\qualifier{parallax_pmd_corr}{ [\code{=0}]: Correlation between parallax and proper motion in declination.} -%\qualifier{pma_pmd_corr}{ [\code{=0}]: Correlation between proper motion in right ascension and in declination.} -%\qualifier{disk}{ [\code{=struct{radius = 0, height = 0.1, x = 0, y = 0, z = 0, crossings = 1}}]: If disk.radius > 0, -% orbit integration will be stopped at the moment a trajectory has crossed a horizontal plane -% located at z = disk.z + disk.height * Gaussian-random-number inside a circle of radius -% disk.radius centered at (disk.x, disk.y) for the disk.crossings-th time.} -%\qualifier{seed}{ [\code{=_time()}]: Seed the random number generator via the function 'seed_random'.} -%\qualifier{set}{ [\code{=0}]: If present, trajectories will be saved ("Save entire trajectories"). As -% this can be very memory-consuming for a large number of orbits, one can additionally -% use the value of this qualifier to specify a lower limit on the time difference of -% two consecutive moments of time that will be saved.} -%\qualifier{stff}{: "Save to fits files": Prefix of fits files to which initial and final structures are written.} -%\qualifier{SunGCDist}{: By default, the Sun-Galactic center distance is taken from the current model. -% Use this qualifier to explicitly set a distance in kpc.} -%\qualifier{tolerance}{ [\code{=1e-8}]: Absolute error control tolerance; lower limit: 1e-15.} -%\qualifier{verbose}{: Show intermediate times t.} -%\qualifier{Any qualifiers from 'cel2gal' and the model potential function except 'vlsr' and 'eomecd'.}{ -% Important note: for consistency, the local standard of rest velocity vlsr is calculated from the -% circular velocity of the current model potential evaluated at (r=SunGCDist, z=0).} -%} %\example % s = orbit_calculator(12,22,29.6,40,49,36,3.078,262,-13.52,16.34,-1000; disk = struct{radius=50, height=0.2, x=0, y=0, z=0, crossings=1}); % s = orbit_calculator(12,22,29.6,40,49,36,3.078,[0.6,0.3],262,5,-13.52,1.31,16.34,1.37,-1000; disk = struct{radius=50, height=0.2, x=0, y=0, z=0, crossings=1}, stff="HIP60350", MC_runs=100); diff --git a/src/misc/astronomy/plummer_interaction_kernel.sl b/src/misc/astronomy/plummer_interaction_kernel.sl index fca48d75b1d4c1d43468164110a62c302d6d1b7b..980f3f8e7c7514769a553689c2548c3dc1699656 100644 --- a/src/misc/astronomy/plummer_interaction_kernel.sl +++ b/src/misc/astronomy/plummer_interaction_kernel.sl @@ -6,6 +6,10 @@ define plummer_interaction_kernel() %\synopsis{Evaluate equations of motion or potential energy from a number of Plummer spheres} %\usage{Double_Type eom[3,n] = plummer_interaction_kernel(Double_Types t, m[6,n], Struct_Type ps; qualifiers)} %\altusage{Double_Type energy[n] = plummer_interaction_kernel(Double_Types t, m[6,n], Struct_Type ps; qualifiers)} +%\qualifiers{ +%\qualifier{coords}{[\code{="cyl"}] Use cylindrical ("cyl") or cartesian ("cart") coordinates.} +%\qualifier{eomecd}{[\code{="eom"}] Return equations of motion ("eom") or potential energy ("energy").} +%} %\description % This function computes the equations of motion or potential energy of n test particles % at time 't' caused by the interaction with a number of moving Plummer spheres. Depending @@ -46,10 +50,6 @@ define plummer_interaction_kernel() % Extrapolation is not allowed. Always make sure that the tabulated times '.t[*]' are in % monotonic increasing order if '.t[-1]' is positive or in monotonic decreasing order if % '.t[-1]' is negative. -%\qualifiers{ -%\qualifier{coords}{ [\code{="cyl"}]: Use cylindrical ("cyl") or cartesian ("cart") coordinates.} -%\qualifier{eomecd}{ [\code{="eom"}]: Return equations of motion ("eom") or potential energy ("energy").} -%} %\example % ps = struct{ o0, o1 }; % ps.o0 = struct{ t=[0,1,2], x=[-1,0,1], y=[0,1,2], z=[0,1,2], psa=1, psb=4 }; diff --git a/src/misc/astronomy/xfigplot_hardnessratio_grid.sl b/src/misc/astronomy/xfigplot_hardnessratio_grid.sl index c06ebc38e24a5ef429590d1187b1ee0b847ed1b2..7f44d177bc0a5c2691021aad6bcf0208d3f83512 100644 --- a/src/misc/astronomy/xfigplot_hardnessratio_grid.sl +++ b/src/misc/astronomy/xfigplot_hardnessratio_grid.sl @@ -10,77 +10,77 @@ define xfigplot_hardnessratio_grid() % or xfigplot_hardnessratio_grid(Struct_Type tracks, String_Type fits_hr_table % );} %\qualifiers{ -%\qualifier{outputdir}{: String_Type, name of output directory, +%\qualifier{outputdir}{String_Type, name of output directory, % default: 'testplot.pdf'} -%\qualifier{W}{: Integer_Type, width of new xfig-plot} -%\qualifier{H}{: Integer_Type, height of new xfig-plot} -%\qualifier{xrange}{: Double_Type[2], range on x-axis} -%\qualifier{yrange}{: Double_Type[2], range on y-axis} -%\qualifier{padx}{: Double_Type, percentage of padding of whole plot in x direction, +%\qualifier{W}{Integer_Type, width of new xfig-plot} +%\qualifier{H}{Integer_Type, height of new xfig-plot} +%\qualifier{xrange}{Double_Type[2], range on x-axis} +%\qualifier{yrange}{Double_Type[2], range on y-axis} +%\qualifier{padx}{Double_Type, percentage of padding of whole plot in x direction, % default: 0.05} -%\qualifier{pady}{: Double_Type, percentage of padding of whole plot in y direction, +%\qualifier{pady}{Double_Type, percentage of padding of whole plot in y direction, % default: 0.05} -%\qualifier{xlabel}{: String_Type, label on x-axis} -%\qualifier{ylabel}{: String_Type, label on y-axis} -%\qualifier{par1label}{: String_Type, label within plot of par1} -%\qualifier{par1label_x}{: Double_Type, x-position of 'par1label' as percentage +%\qualifier{xlabel}{String_Type, label on x-axis} +%\qualifier{ylabel}{String_Type, label on y-axis} +%\qualifier{par1label}{String_Type, label within plot of par1} +%\qualifier{par1label_x}{Double_Type, x-position of 'par1label' as percentage % (needs to be set, if 'par1label' is given)} -%\qualifier{par1label_y}{: Double_Type, y-position of 'par1label' as percentage +%\qualifier{par1label_y}{Double_Type, y-position of 'par1label' as percentage % (needs to be set, if 'par1label' is given)} -%\qualifier{par1label_c}{: Integer_Type/String_Type, color of 'par1label' as RGB, +%\qualifier{par1label_c}{Integer_Type/String_Type, color of 'par1label' as RGB, % default: 0x000000 (black)} -%\qualifier{par2label}{: String_Type, label within graph of par2} -%\qualifier{par2label_x}{: Double_Type, x-position of 'par2label' as percentage +%\qualifier{par2label}{String_Type, label within graph of par2} +%\qualifier{par2label_x}{Double_Type, x-position of 'par2label' as percentage % (needs to be set, if 'par2label' is given)} -%\qualifier{par2label_y}{: Double_Type, y-position of 'par2label' as percentage +%\qualifier{par2label_y}{Double_Type, y-position of 'par2label' as percentage % (needs to be set, if 'par2label' is given)} -%\qualifier{par2label_c}{: Integer_Type/String_Type, color of 'par2label' as RGB, +%\qualifier{par2label_c}{Integer_Type/String_Type, color of 'par2label' as RGB, % default: 0x000000 (black)} -%\qualifier{extralabel}{: String_Type, extra label within graph} -%\qualifier{extralabel_x}{: Double_Type, x-position of 'extralabel' as percentage +%\qualifier{extralabel}{String_Type, extra label within graph} +%\qualifier{extralabel_x}{Double_Type, x-position of 'extralabel' as percentage % (needs to be set, if 'extralabel' is given)} -%\qualifier{extralabel_y}{: Double_Type, y-position of 'extralabel' as percentage +%\qualifier{extralabel_y}{Double_Type, y-position of 'extralabel' as percentage % (needs to be set, if 'extralabel' is given)} -%\qualifier{extralabel_c}{: Integer_Type/String_Type, color of 'extralabel' as RGB, +%\qualifier{extralabel_c}{Integer_Type/String_Type, color of 'extralabel' as RGB, % default: 0x000000 (black)} -%\qualifier{extralabel2}{: String_Type, extra label within graph} -%\qualifier{extralabel2_x}{: Double_Type, x-position of 'extralabel2' as percentage +%\qualifier{extralabel2}{String_Type, extra label within graph} +%\qualifier{extralabel2_x}{Double_Type, x-position of 'extralabel2' as percentage % (needs to be set, if 'extralabel' is given)} -%\qualifier{extralabel2_y}{: Double_Type, y-position of 'extralabel2' as percentage +%\qualifier{extralabel2_y}{Double_Type, y-position of 'extralabel2' as percentage % (needs to be set, if 'extralabel' is given)} -%\qualifier{extralabel2_c}{: Integer_Type/String_Type, color of 'extralabel2' as RGB, +%\qualifier{extralabel2_c}{Integer_Type/String_Type, color of 'extralabel2' as RGB, % default: 0x000000 (black)} -%\qualifier{cstart}{: Integer_Type/String_Type, start color of grid as RGB, +%\qualifier{cstart}{Integer_Type/String_Type, start color of grid as RGB, % default: 0xC1CDCD (gray)} -%\qualifier{cstop}{: Integer_Type/String_Type, stop color of grid as RGB} +%\qualifier{cstop}{Integer_Type/String_Type, stop color of grid as RGB} % default: 0xC1CDCD (gray)} -%\qualifier{lend1}{: if exists, switch end (or begin) of tracks1 +%\qualifier{lend1}{if exists, switch end (or begin) of tracks1 % (where each tracks' value will be assigned)} -%\qualifier{lend2}{: if exists, switch end (or begin) of tracks2} +%\qualifier{lend2}{if exists, switch end (or begin) of tracks2 % (where each tracks' value will be assigned)} -%\qualifier{shift1x}{: Double_Type, x-position of par1-values at end of track, default: 0.} -%\qualifier{shift1y}{: Double_Type, y-position of par1-values at end of track, default: 0.} -%\qualifier{shift2x}{: Double_Type, x-position of par2-values at end of track, default: 0.} -%\qualifier{shift2y}{: Double_Type, y-position of par2-values at end of track, default: 0.} -%\qualifier{hr_x_col}{: String_Type, name of hr_x-column ('fits_hr_table') for plotting datapoints} -%\qualifier{hr_y_col}{: String_Type, name of hr_y-column ('fits_hr_table') for plotting datapoints} -%\qualifier{err_x_col}{: String_Type, name of error_x-column ('fits_hr_table') for plotting datapoints} -%\qualifier{err_y_col}{: String_Type, name of error_y-column ('fits_hr_table)' for plotting datapoints} -%\qualifier{err_c}{: Integer_Type/String_Type, color of errorbars as RGB} +%\qualifier{shift1x}{Double_Type, x-position of par1-values at end of track, default: 0.} +%\qualifier{shift1y}{Double_Type, y-position of par1-values at end of track, default: 0.} +%\qualifier{shift2x}{Double_Type, x-position of par2-values at end of track, default: 0.} +%\qualifier{shift2y}{Double_Type, y-position of par2-values at end of track, default: 0.} +%\qualifier{hr_x_col}{String_Type, name of hr_x-column ('fits_hr_table') for plotting datapoints} +%\qualifier{hr_y_col}{String_Type, name of hr_y-column ('fits_hr_table') for plotting datapoints} +%\qualifier{err_x_col}{String_Type, name of error_x-column ('fits_hr_table') for plotting datapoints} +%\qualifier{err_y_col}{String_Type, name of error_y-column ('fits_hr_table)' for plotting datapoints} +%\qualifier{err_c}{Integer_Type/String_Type, color of errorbars as RGB % default: 0x000000 (black)} -%\qualifier{symbol_shape}{: String_Type, shape of datapoints} -%\qualifier{symbol_size}{: Double_Type, size of datapoints, default: 1.} -%\qualifier{symbol_cstart}{: Integer_Type/String_Type, (start) color of datapoints as RGB} -%\qualifier{symbol_cstop}{: Integer_Type/String_Type, stop color of datapoints as RGB, +%\qualifier{symbol_shape}{String_Type, shape of datapoints} +%\qualifier{symbol_size}{Double_Type, size of datapoints, default: 1.} +%\qualifier{symbol_cstart}{Integer_Type/String_Type, (start) color of datapoints as RGB} +%\qualifier{symbol_cstop}{Integer_Type/String_Type, stop color of datapoints as RGB, % if not given 'symbol_cstart' is color of all} -%\qualifier{source_col}{: String_Type, name of source-column ('fits_hr_table') for plotting datapoints, +%\qualifier{source_col}{String_Type, name of source-column ('fits_hr_table') for plotting datapoints, % needs to be given only if different colors for different sources} -%\qualifier{extralabel_sources_x}{: Double_Type, x-position of source_names as percentage +%\qualifier{extralabel_sources_x}{Double_Type, x-position of source_names as percentage % (if given, source names are displayed in their respective color)} -%\qualifier{extralabel_sources_y}{: Double_Type, y-position of source_names as percentage -%\qualifier{tracks1}{: Integer_Type, if given, only tracks1 are plottet} -%\qualifier{tracks2}{: Integer_Type, if given, only tracks2 are plottet} -%\qualifier{notracks}{: Integer_Type, if given, no tracks are plottet, 'fits_hr_table' must be +%\qualifier{extralabel_sources_y}{Double_Type, y-position of source_names as percentage +%\qualifier{tracks1}{Integer_Type, if given, only tracks1 are plottet} +%\qualifier{tracks2}{Integer_Type, if given, only tracks2 are plottet} +%\qualifier{notracks}{Integer_Type, if given, no tracks are plottet, 'fits_hr_table' must be % given for datapoints} %} %\description diff --git a/src/misc/atomic/ionized_phabs_sigma.sl b/src/misc/atomic/ionized_phabs_sigma.sl index 5cc18ba48a6ea7e69521e8688a2799d9a1dc93ec..ade7fdab3343b908c9cf35da835f98251eac9e1b 100644 --- a/src/misc/atomic/ionized_phabs_sigma.sl +++ b/src/misc/atomic/ionized_phabs_sigma.sl @@ -581,10 +581,10 @@ define ionized_phabs_sigma() % \code{sigma} is the corresponding cross section in cm^2. % The ion of interest is specified by the following %\qualifiers{ -%\qualifier{Z}{: atomic number (1 <= \code{Z} <= 30)} -%\qualifier{Nel}{: number of electrons (\code{Z} >= \code{Nel} > 0)} -%\qualifier{n}{: principal quantum number for the selection of a subshell (together with l)} -%\qualifier{l}{: orbital angular momentum quantum number for the selection of a subshell} +%\qualifier{Z}{atomic number (1 <= \code{Z} <= 30)} +%\qualifier{Nel}{number of electrons (\code{Z} >= \code{Nel} > 0)} +%\qualifier{n}{principal quantum number for the selection of a subshell (together with l)} +%\qualifier{l}{orbital angular momentum quantum number for the selection of a subshell} %} %\seealso{Verner & Yakovlev (1995)} %!%- diff --git a/src/misc/atomic/xstar/XSTAR_read_pops.sl b/src/misc/atomic/xstar/XSTAR_read_pops.sl index a38fe89361ee77400250f8a7f3780db98d9a40bc..192e12b860526b8258029bb96027174e3876041a 100644 --- a/src/misc/atomic/xstar/XSTAR_read_pops.sl +++ b/src/misc/atomic/xstar/XSTAR_read_pops.sl @@ -7,8 +7,8 @@ define XSTAR_read_pops() %\usage{Struct_Type XSTAR_read_pops(String_Type filename)} %\qualifiers{ %\qualifier{verbose}{} -%\qualifier{Z}{: array of Z values of elements to include} -%\qualifier{ions}{: array of ions to include (overrides Z qualifier)} +%\qualifier{Z}{array of Z values of elements to include} +%\qualifier{ions}{array of ions to include (overrides Z qualifier)} %} %!%- { diff --git a/src/misc/image/enlarge_image.sl b/src/misc/image/enlarge_image.sl index 06c16657e8c52c8ea5f083481ea920934ba8c9f9..3156f0b640d1a5659491e3e75298e034014e5ef6 100644 --- a/src/misc/image/enlarge_image.sl +++ b/src/misc/image/enlarge_image.sl @@ -10,8 +10,8 @@ define enlarge_image() %\altusage{Double_Type IMG = enlarge_image(img, Integer_Type nx, ny);} %} %\qualifiers{ -%\qualifier{interp}{: reference to interpolation function (see below)} -%\qualifier{y_first}{: interpolate first in y-, then in x-direction} +%\qualifier{interp}{reference to interpolation function (see below)} +%\qualifier{y_first}{interpolate first in y-, then in x-direction} %} %\description % The pixels of \code{img} are mapped to every \code{nx}-th pixel diff --git a/src/misc/image/fit_gauss_to_img_noise.sl b/src/misc/image/fit_gauss_to_img_noise.sl index f4f462f4af6328e9d498eb0b9fd58f4a2b37bcfe..412a69170e41599356b93c5edab5fe942d86db31 100644 --- a/src/misc/image/fit_gauss_to_img_noise.sl +++ b/src/misc/image/fit_gauss_to_img_noise.sl @@ -4,10 +4,10 @@ define fit_gauss_to_img_noise () %\synopsis{fits a gaussian profile to the distribution of pixel values} %\usage{mu,sigma = fit_gauss_to_img_noise(\code{img})} %\qualifiers{ -%\qualifier{grid_scale [="log"]}{: change between fitting on "lin" or "log" grid} -%\qualifier{cut_nsig [=NULL]}{: set to \code{N} in order to ignore values above +%\qualifier{grid_scale [="log"]}{change between fitting on "lin" or "log" grid} +%\qualifier{cut_nsig [=NULL]}{set to \code{N} in order to ignore values above % \code{N} sigma after the first iteration} -%\qualifier{keep_data}{: do not delete loaded data after fitting} +%\qualifier{keep_data}{do not delete loaded data after fitting} %} %\description % This function fits a Gaussian profile to the distribution of diff --git a/src/misc/image/simbad2ds9.sl b/src/misc/image/simbad2ds9.sl index 0e5146a1e1646f7709bab5761a324307e83324e4..c73613be79eb885698852d34a07d6e076af24b2b 100644 --- a/src/misc/image/simbad2ds9.sl +++ b/src/misc/image/simbad2ds9.sl @@ -13,8 +13,8 @@ public define simbad2ds9(){ %\synopsis{Converts a SIMBAD cone search ASCII file into a DS9 region % file (default outfile: "ds9.reg")} %\qualifiers{ -%\qualifier{radius}{: circle radius (arcsec), default: 20arcsec} -%\qualifier{type}{: regex to filter for source type, default ""} +%\qualifier{radius}{circle radius (arcsec), default: 20arcsec} +%\qualifier{type}{regex to filter for source type, default ""} %} %\notes % See http://simbad.u-strasbg.fr/simbad/sim-display?data=otypes diff --git a/src/misc/image/wcs_axes_plot.sl b/src/misc/image/wcs_axes_plot.sl index adc5a283fd77e9a0699173a41d1d0aed97fa78b4..345ba8157fae0cee3ef1359ae2995f853ae5c3b8 100644 --- a/src/misc/image/wcs_axes_plot.sl +++ b/src/misc/image/wcs_axes_plot.sl @@ -34,28 +34,28 @@ define wcs_axes_plot () %\usage{xfig_plot_object = wcs_axes_plot (String_Type image_filename); } %\altusage{xfig_plot_object = wcs_axes_plot (image, wcs); } %\qualifiers{ -%\qualifier{width}{: set plot width} -%\qualifier{height [=14]}{: set plot height, unless width and height are both +%\qualifier{width}{set plot width} +%\qualifier{height}{[=14] set plot height, unless width and height are both % set, the other one is calculated based on the % format of the image (currently CDELT1 != CDELT2 % is not taken into account, but only #pixels)} -%\qualifier{x1label [=WCS of major]}{: set ticlabels of x1-axis} -%\qualifier{x2label [=0]}{: set ticlabels of x2-axis} -%\qualifier{y1label [=WCS of major]}{: set ticlabels of y1-axis} -%\qualifier{y2label [=0]}{: set ticlabels of y2-axis} -%\qualifier{axis_color [="white"]}{: set the color of the axes} -%\qualifier{x1major}{: set WCS values for major tics of x1-axis. +%\qualifier{x1label}{[=WCS of major] set ticlabels of x1-axis} +%\qualifier{x2label}{[=0] set ticlabels of x2-axis} +%\qualifier{y1label}{[=WCS of major] set ticlabels of y1-axis} +%\qualifier{y2label}{[=0] set ticlabels of y2-axis} +%\qualifier{axis_color}{[="white"] set the color of the axes} +%\qualifier{x1major}{set WCS values for major tics of x1-axis. % similar qualifiers exist for x2, y1, and y2-axes. % unless x1 and x2 are both set, the qualifier affects % both x-axes. the same holds for the y-axes and the % minor qualifiers.} -%\qualifier{x1minor}{: set WCS values for minor tics of x1-axis. +%\qualifier{x1minor}{set WCS values for minor tics of x1-axis. % similar qualifiers exist for x2, y1, and y2 axes} -%\qualifier{return_axes}{: set qualifier to additionally return +%\qualifier{return_axes}{set qualifier to additionally return % data (Assoc_Type) including axes information. % the returned object \code{wcsaxes} can be accessed % with \code{wcsaxes["x1"]} (keys are ["x1","x2","y1","y2"])} -%\qualifier{info}{: print the WCS (RA-DEC) ranges of the axes +%\qualifier{info}{print the WCS (RA-DEC) ranges of the axes % (helpful for setting minor and major by hand)} %} %\description diff --git a/src/misc/imagedownload/panstarrs.sl b/src/misc/imagedownload/panstarrs.sl index c3f021eff15574a05aee9daffca8be78123ba2cb..c952c3eeb3e178c9ec58877f65a3a99b8cc37b40 100644 --- a/src/misc/imagedownload/panstarrs.sl +++ b/src/misc/imagedownload/panstarrs.sl @@ -314,6 +314,8 @@ private define __panstarrsInsertWarpAuxMatch(assoc, aux, col, field, url) { % └── z % ├── 55546.50549=url % ├── ... +%#p- +%#v- % Where all nodes are Assoc_Type[Assoc_Type] except each deepst leave which is % an Assoc_Type[String_Type]. Note that not all of the branches might be there, % depending on what has been asked for to query and what is actually available @@ -541,19 +543,19 @@ private define __panstarrsDownloadImages(urls, outdir, filters, fileTypes, auxil %\usage{Assoc_Type fileNames = panstarrsImageDownload(String_Type position, Double_Type size, String_Type outdir) % Assoc_Type fileNames = panstarrsImageDownload(Double_Type ra, Double_Type dec, Double_Type size, String_Type outdir)} %\qualifiers{ -%\qualifier{g}{: Download images taken with the g filter} -%\qualifier{r}{: Download images taken with the r filter} -%\qualifier{i}{: Download images taken with the i filter} -%\qualifier{z}{: Download images taken with the z filter} -%\qualifier{y}{: Download images taken with the y filter} -%\qualifier{stack}{: Download final stacks} -%\qualifier{warp}{: Download individual warps (single epoch images)} -%\qualifier{data}{: Download main data products} -%\qualifier{mask}{: Download masks} -%\qualifier{wt}{: Download weight images} -%\qualifier{exp}{: Download exposure maps} -%\qualifier{expwt}{: Download weighted exposure maps (undocumented)} -%\qualifier{num}{: Download num images (undocumented)} +%\qualifier{g}{Download images taken with the g filter} +%\qualifier{r}{Download images taken with the r filter} +%\qualifier{i}{Download images taken with the i filter} +%\qualifier{z}{Download images taken with the z filter} +%\qualifier{y}{Download images taken with the y filter} +%\qualifier{stack}{Download final stacks} +%\qualifier{warp}{Download individual warps (single epoch images)} +%\qualifier{data}{Download main data products} +%\qualifier{mask}{Download masks} +%\qualifier{wt}{Download weight images} +%\qualifier{exp}{Download exposure maps} +%\qualifier{expwt}{Download weighted exposure maps (undocumented)} +%\qualifier{num}{Download num images (undocumented)} %} %\notes % Please note that PanSTARRS only covers the sky north of DEC=-30 deg. @@ -574,6 +576,8 @@ private define __panstarrsDownloadImages(urls, outdir, filters, fileTypes, auxil % outdir must supply a directory where the output files shall be written. % The function returns an Assoc_Type which contains the information about % the downloaded files. If all options are set the assoc looks like this: +%#v+ +%#p+ % assoc % ├── stack % │   ├── aux @@ -645,6 +649,8 @@ private define __panstarrsDownloadImages(urls, outdir, filters, fileTypes, auxil % └── z % ├── 55302.23917=path % ├── ... +%#p- +%#v- % The structure should be self explanatory, except the set of numbers at % the lowest level of the warps. These are the MJDs when the exposure % was completed. diff --git a/src/misc/math/circle_from_points.sl b/src/misc/math/circle_from_points.sl index 511d1741777ee09e80d23287c3b7a0f3f82f5675..e188a0ff8528cf68e74e6bfae3cd90deaa5e7482 100644 --- a/src/misc/math/circle_from_points.sl +++ b/src/misc/math/circle_from_points.sl @@ -23,9 +23,9 @@ define circle_from_points(x,y) % or NULL if no solution could be found (points are on a straight line). % % \qualifiers{ -% \qualifier{eps}{: if the determinant of the three point solution is less than +% \qualifier{eps}{if the determinant of the three point solution is less than % than this number, the points lie on a straight line} -% \qualifier{maxiter}{: average at most maxiter tuples of three points} +% \qualifier{maxiter}{average at most maxiter tuples of three points} %} %!%- { diff --git a/src/misc/mpi_master_only.sl b/src/misc/mpi_master_only.sl index 4bd12568028cb4e90da662e7357c06743bfee700..181d9a1f9bff52ccdc0c911c2f9aa9ed541f905f 100644 --- a/src/misc/mpi_master_only.sl +++ b/src/misc/mpi_master_only.sl @@ -7,8 +7,8 @@ define mpi_master_only () %\synopsis{Use function with on one host only in an MPI job} %\usage{mpi_master_only (Reference_Type function, arg1, arg2, ...)} %\qualifiers{ -%\qualifier{verbose}{: show name of host which acts as MPI master} -%\qualifier{veryverbose}{: show name of host which acts as MPI master, PID and parent PID (overwrites verbose)} +%\qualifier{verbose}{show name of host which acts as MPI master} +%\qualifier{veryverbose}{show name of host which acts as MPI master, PID and parent PID (overwrites verbose)} %} %\description % Sometimes, for example by saving files, it is required that a function is only called once diff --git a/src/misc/radio/compare_modelfits.sl b/src/misc/radio/compare_modelfits.sl index 3cc96f0f9d60ce5197852209b3be32dbc07f50e3..6c10e48eab90c852bc6d0c4949cc59b9cb502a16 100644 --- a/src/misc/radio/compare_modelfits.sl +++ b/src/misc/radio/compare_modelfits.sl @@ -8,29 +8,29 @@ define compare_modelfits () %\synopsis{to compare modelfit parameters of different epochs} %\usage{compare_modelfits([array of \code{epoch fitsfiles}]);} %\qualifiers{ -%\qualifier{plottype [="overlay"]}{: specifies the layout of the comparison plot, +%\qualifier{plottype}{[="overlay"] layout of the comparison plot, % by default it shows the overlay of all component positions, % alternatives are "distancevsmjd","fluxvsdistance","TBvsdistance"} -%\qualifier{fileextent [=.eps]}{: output is given by default as .eps-file in working directory} -%\qualifier{outputfile }{: give outputfile name and directory by hand} -%\qualifier{sourcename[=default]}{: set the name of the source, by default the name is read from the .fits file,\n +%\qualifier{fileextent}{[=.eps] output is given by default as .eps-file in working directory} +%\qualifier{outputfile}{give outputfile name and directory by hand} +%\qualifier{sourcename}{[=default] set the name of the source, by default the name is read from the .fits file,\n % set to NULL for not plotting a source name} -%\qualifier{ra_mas [=[20,-20]]}{ specifiy ra range (for "overlay")} -%\qualifier{dec_mas [=[-20,20]]}{ specifiy dec range (for "overlay")} -%\qualifier{mjd_min [=54101.0]}{: to specify lower limit of time axis (default: 1/1/2007)} -%\qualifier{mjd_max [=55927.0]}{: to specify lower limit of time axis (default: 1/1/2012)} -%\qualifier{distance_min [=0]}{: lower limit of distance axis in mas} -%\qualifier{distance_max [=50]}{: upper limit of distance axis in mas} -%\qualifier{flux_min [=1e-5]}{: lower limit of flux axis in Jy} -%\qualifier{flux_max [=2]}{: upper limit of flux axis in Jy} -%\qualifier{TB_min [=10^5]}{: lower limit of brightness temperature axis in K} -%\qualifier{TB_max [=10^15]}{: upper limit of brightness temperature axis in K} -%\qualifier{linestyle [=default]}{: set to 0 if the flux values should not be conntected (or to another value for +%\qualifier{ra_mas}{[=[20,-20]] ra range (for "overlay")} +%\qualifier{dec_mas}{[=[-20,20]] dec range (for "overlay")} +%\qualifier{mjd_min}{[=54101.0] lower limit of time axis (default: 1/1/2007)} +%\qualifier{mjd_max}{[=55927.0] lower limit of time axis (default: 1/1/2012)} +%\qualifier{distance_min}{[=0] lower limit of distance axis in mas} +%\qualifier{distance_max}{[=50] upper limit of distance axis in mas} +%\qualifier{flux_min}{[=1e-5] lower limit of flux axis in Jy} +%\qualifier{flux_max}{[=2] upper limit of flux axis in Jy} +%\qualifier{TB_min}{[=10^5] lower limit of brightness temperature axis in K} +%\qualifier{TB_max}{[=10^15] upper limit of brightness temperature axis in K} +%\qualifier{linestyle}{[=default] set to 0 if the flux values should not be conntected (or to another value for % another line style} -%\qualifier{ex_comps [=0]}{: set to 1 if components should be excluded and define +%\qualifier{ex_comps}{[=0] set to 1 if components should be excluded and define % the corresponding quadrant of the plot via the ex_comps-coordinates} -%\qualifier{ex_comps_ra [=NULL]}{: define quadrant coordinates in mas where components should be excluded} -%\qualifier{ex_comps_dec [=NULL]}{: define quadrant coordinates in mas where components should be excluded} +%\qualifier{ex_comps_ra}{[=NULL] quadrant coordinates in mas where components should be excluded} +%\qualifier{ex_comps_dec}{[=NULL] define quadrant coordinates in mas where components should be excluded} %} %\description % This function creates an overlay of a VLBI-clean image and the corresponding\n diff --git a/src/misc/radio/difmap_restore.sl b/src/misc/radio/difmap_restore.sl index cbd3271d1c6c9e4ce7127f9c4600d74011c69831..af121ba0ed6e619b8ff1ad9dfb78ef73d826b64c 100644 --- a/src/misc/radio/difmap_restore.sl +++ b/src/misc/radio/difmap_restore.sl @@ -4,15 +4,15 @@ define difmap_restore() %\synopsis{DIFMAP is used to restore a radio image with a new beam} %\usage{String_Type outname = difmap_restore(String_Type \code{fitsfile}, Double_Type \code{smajor}, \code{sminor}, \code{pos_angle})} %\qualifiers{ -%\qualifier{chan [=i]}{: choose channel (i,q,u)} -%\qualifier{xsize [= key "NAXIS1"]}{: number of RA pixels} -%\qualifier{xsetp [= key "CDELT1"]}{: step size of each RA pixel in mas} -%\qualifier{ysize [= key "NAXIS2"]}{: number of DEC pixels} -%\qualifier{ysetp [= key "CDELT2"]}{: step size of each DEC pixel in mas} -%\qualifier{uvtaper [= " "]}{: apply a uvtaper before restoring} -%\qualifier{outname [= "xxxxMHz_restore.fits"]}{: filename of the output, be default the +%\qualifier{chan}{[=i] choose channel (i,q,u)} +%\qualifier{xsize}{[= key "NAXIS1"] number of RA pixels} +%\qualifier{xsetp}{[= key "CDELT1"] step size of each RA pixel in mas} +%\qualifier{ysize}{[= key "NAXIS2"] number of DEC pixels} +%\qualifier{ysetp}{[= key "CDELT2"] step size of each DEC pixel in mas} +%\qualifier{uvtaper}{[= " "] pply a uvtaper before restoring} +%\qualifier{outname}{[= "xxxxMHz_restore.fits"] filename of the output, be default the % frequency is read from the input file} -%\qualifier{overwrite}{: overwrite file with outname if it already exists} +%\qualifier{overwrite}{overwrite file with outname if it already exists} %} %\description % This function creates a radio image with a given beam using DIFMAP. The diff --git a/src/misc/radio/get_component.sl b/src/misc/radio/get_component.sl index 573ae1b07a96bb6b7198e2f7d96cf970766e4f6f..bcbbe3b2b4f0830c9936ca869e7df6825cf90d1b 100644 --- a/src/misc/radio/get_component.sl +++ b/src/misc/radio/get_component.sl @@ -5,9 +5,9 @@ define get_component() %\synopsis{to extract the component from the epoch files} %\usage{get_component([array of position number in the epoch file], [array of epoch fits files]);} %\qualifiers{ -%\qualifier{quadrant [=1]}{: Quadrant which is defined as a positive distance ( RA, DEC > 0 == 1 || RA < 0, DEC > 0 == 2 || +%\qualifier{quadrant}{[=1] Quadrant which is defined as a positive distance ( RA, DEC > 0 == 1 || RA < 0, DEC > 0 == 2 || % RA < 0, DEC < 0 == 3 || RA > 0, DEC < 0 == 4)} -%\qualifier{zero}{: shift all distances, so that the last component is at 0,0 ("core" component) } +%\qualifier{zero}{shift all distances, so that the last component is at 0,0 ("core" component) } %} %\description % This function returns a structure of a component. diff --git a/src/misc/radio/init_jet_fit.sl b/src/misc/radio/init_jet_fit.sl index 0a32e474079acadf5d2a9b35a7f212a2bdfa8c02..70f56c95200fa14d93e0f2925e8e4f63ed791b25 100644 --- a/src/misc/radio/init_jet_fit.sl +++ b/src/misc/radio/init_jet_fit.sl @@ -3,6 +3,11 @@ define init_jet_fit() %\function{init_jet_fit} %\synopsis{inititialize the fit function for the speed of jet components} %\usage{init_jet_fit (Ref_Type jet_component_structure);} +%\qualifiers{ +%\qualifier{pa}{[=90] position angle of the jet in degrees (required)} +%\qualifier{recalc_distance}{set to 1 in order to recalculate the distance +% of each component based on deltax and deltay} +%} %\description % This function initializes the fit function \code{jet_speed}, which % can fit a linear function of the form: @@ -31,19 +36,11 @@ define init_jet_fit() %\seealso{plot_jet_speed} %!%- % -% -% -% -%\qualifiers{ -%\qualifier{pa [=90]: position angle of the jet in degrees (required)} -%\qualifier{recalc_distance [=0]: set to 1 in order to recalculate the distance -% of each component based on deltax and deltay} -%} { % use a pointer to the jet_speed_struct, this allows the function to % change the structure permanently (add fields) variable jet_speed_struct_pointer; - variable pa = qualifier("pa",90); + variable pa = qualifier("pa",90.); variable recalc_dist = qualifier("recalc_distance",0); switch(_NARGS) diff --git a/src/misc/radio/make_spix.sl b/src/misc/radio/make_spix.sl index 4f430382444ae7465297333662218a8f950ecb27..c4f335b0b2b4c8c503e0fafd20a0fd3ef5f11a02 100644 --- a/src/misc/radio/make_spix.sl +++ b/src/misc/radio/make_spix.sl @@ -6,44 +6,44 @@ define make_spix() %\synopsis{creates a spectral index map using two .fits files (provided by DIFMAP)} %\usage{make_spix(String_Type \code{name_lo}, String_Type \code{name_hi});} %\qualifiers{ -%\qualifier{iterations [=1]}{: set number of translations to average over} -%\qualifier{cc [=cc.fits]}{: name of the cross correlation map. Will generate +%\qualifier{iterations}{[=1] set number of translations to average over} +%\qualifier{cc}{[=cc.fits] name of the cross correlation map. Will generate % one if the file does not exist.} -%\qualifier{lothreshold [=NULL]}{: if image has a pixel below this value it's set to +%\qualifier{lothreshold}{[=NULL] if image has a pixel below this value it's set to % this value. also criterion for showing spectral index if % req_both_bands is set to 1} -%\qualifier{hithreshold [=NULL]}{: if image has a pixel below this value it's set to +%\qualifier{hithreshold}{[=NULL] if image has a pixel below this value it's set to % this value. also criterion for showing spectral index if % req_both_bands is set to 1} -%\qualifier{shift [={NULL,NULL}]}{: define the shift of the second image wrt the first +%\qualifier{shift}{[={NULL,NULL}] define the shift of the second image wrt the first % in format {x,y} in mas} -%\qualifier{crpix_shift [=0.]}{: Extra shift for converting mas in pixel. In the past, 0.5 was used, +%\qualifier{crpix_shift}{[=0.] Extra shift for converting mas in pixel. In the past, 0.5 was used, % but default is now 0., as only a relative is needed} -%\qualifier{dec_step [=NULL]}{: set the pixel size in declination (value>0). +%\qualifier{dec_step}{[=NULL] pixel size in declination (value>0). % Default value is the largest pixel size of the two images} -%\qualifier{dec_size [=NULL]}{: set the mapsize size in declination. +%\qualifier{dec_size}{[=NULL] mapsize size in declination. % Default value is the largest map size of the two images} -%\qualifier{ra_step [=NULL]}{: set the pixel size in right ascension (value>0). +%\qualifier{ra_step}{[=NULL] pixel size in right ascension (value>0). % Default value is the largest pixel size of the two images} -%\qualifier{ra_size [=NULL]}{: set the mapsize size in right ascension +%\qualifier{ra_size}{[=NULL] mapsize size in right ascension % Default value is the largest map size of the two images} -%\qualifier{beam [=[NULL,NULL,NULL]]}{: set a beam for restoring the two images +%\qualifier{beam}{[=[NULL,NULL,NULL]] defines beam for restoring the two images % [semi-major axis, semi-minor axis, position angle] % in mas (major and minor axis) and degree (position angle)} -%\qualifier{req_both_bands [=0]}{: only make calculations if both bands are above the +%\qualifier{req_both_bands}{[=0] only make calculations if both bands are above the % noise level} -%\qualifier{fit_noise [=1]}{: set to 0 to use fits header for noise information} -%\qualifier{lo_nsigma [=3]}{: number of standard deviations from mean to define +%\qualifier{fit_noise}{[=1] set to 0 to use fits header for noise information} +%\qualifier{lo_nsigma}{[=3] number of standard deviations from mean to define % noise limit. Only matters if fit_noise==1, % overrides lothreshold} -%\qualifier{hi_nsigma [=3]}{: number of standard deviations from mean to define +%\qualifier{hi_nsigma}{[=3] number of standard deviations from mean to define % noise limit. Only matters if fit_noise==1, % overrides hithreshold} -%\qualifier{n_beams [=3]}{: size of beam to exclude from core on correlation +%\qualifier{n_beams}{[=3] size of beam to exclude from core on correlation % calculation} -%\qualifier{excl_core [=1]}{: set to 0 if you don't want the program to +%\qualifier{excl_core}{[=1] set to 0 if you do not want the program to % automatically exclude the core from correlation calculations} -%\qualifier{overwrite}{: overwrite the restore fits files (if already existing)} +%\qualifier{overwrite}{overwrite the restore fits files (if already existing)} %} %\description % This function creates a spectral index (F=v^a) map from two fits files provided by diff --git a/src/misc/radio/overplot_clean_model.sl b/src/misc/radio/overplot_clean_model.sl index 13e1106c7f9b3ba4567f0297c6bb7f3f3449686a..9ef904fafdf3b8cbfebe06bab3eba594890faa22 100644 --- a/src/misc/radio/overplot_clean_model.sl +++ b/src/misc/radio/overplot_clean_model.sl @@ -15,28 +15,28 @@ define overplot_clean_model() %\synopsis{creates an overlay of an clean VLBI image and the modelfit components} %\usage{overplot_clean_model(String_Type \code{cleanfile}, String_Type \code{modfile}, String_Type \code{outputfile});} %\qualifiers{ -%\qualifier{ra_mas [={20,-20}]}{: specifies {left,right} limits of image in mas} -%\qualifier{dec_mas [={-20,20}]}{: specifies {top,bottom} limits of image in mas} -%\qualifier{plot_size [=15]}{: size of plot} -%\qualifier{n_sigma [=3.0]}{: lowest contour of clean image} -%\qualifier{sourcename [=default]}{: set the name of the source, by default the name is read from the .fits file,\n +%\qualifier{ra_mas}{[={20,-20}] {left,right} limits of image in mas} +%\qualifier{dec_mas}{[={-20,20}] {top,bottom} limits of image in mas} +%\qualifier{plot_size}{[=15] size of plot} +%\qualifier{n_sigma}{[=3.0] lowest contour of clean image} +%\qualifier{sourcename}{[=default] name of the source, by default the name is read from the .fits file,\n % set to NULL for not plotting a source name} -%\qualifier{obs_date [=default]}{: set the observation date, by default the observation date is read from the .fits file, \n +%\qualifier{obs_date}{[=default] the observation date, by default the observation date is read from the .fits file, \n % set to NULL for not plotting a observation date, set to "mjd" when MJD format required} -%\qualifier{cont_color [="gray"]}{: color of contours of clean image} -%\qualifier{cont_scl [="2"]}{: set factor to change the separation between contour levels} -%\qualifier{cont_lvl [=[c1,c2,..]}{: set contour levels [Jy] manually, overwrites other contour parameters} -%\qualifier{model_color [="black"]}{: color of Gaussian ellipses} -%\qualifier{center_symbol [="+"]}{: symbol stating the ellipse center, set to NULL for no symbol} -%\qualifier{comp_label [=0]}{: set to 1 when labelling of components depending on distance from [0,0] +%\qualifier{cont_color}{[="gray"] color of contours of clean image} +%\qualifier{cont_scl}{[="2"] set factor to change the separation between contour levels} +%\qualifier{cont_lvl}{[=[c1,c2,..] set contour levels [Jy] manually, overwrites other contour parameters} +%\qualifier{model_color}{[="black"] color of Gaussian ellipses} +%\qualifier{center_symbol}{[="+"] symbol stating the ellipse center, set to NULL for no symbol} +%\qualifier{comp_label}{[=0] set to 1 when labelling of components depending on distance from [0,0] % is requested} -%\qualifier{ind_inverse [=0]}{: if the labels should be in inverse order set to 1} -%\qualifier{label_alt [=NULL]}{: give list of alternative labels} -%\qualifier{label_color [="red"]}{: color of component labels} -%\qualifier{ex_counterjet [=0]}{: set to 1 if counterjet components (and core) should be excluded and define +%\qualifier{ind_inverse}{[=0] if the labels should be in inverse order set to 1} +%\qualifier{label_alt}{[=NULL] give list of alternative labels} +%\qualifier{label_color}{[="red"] color of component labels} +%\qualifier{ex_counterjet}{[=0] set to 1 if counterjet components (and core) should be excluded and define % the corresponding quadrant of the plot via the CJ-coordinates} -%\qualifier{counterjet_ra [=NULL]}{: define counterjet coordinates in mas} -%\qualifier{counterjet_dec [=NULL]}{: define counterjet coordinates in mas} +%\qualifier{counterjet_ra}{[=NULL] define counterjet coordinates in mas} +%\qualifier{counterjet_dec}{[=NULL] define counterjet coordinates in mas} %} %\description % This function creates an overlay of a VLBI-clean image and the corresponding\n diff --git a/src/misc/radio/plot_component.sl b/src/misc/radio/plot_component.sl index a2aa5a274fc34a681479eec6a07b64c25adeee53..3571b833ccb2a5215cd8fdd4a5905a0e468da14b 100644 --- a/src/misc/radio/plot_component.sl +++ b/src/misc/radio/plot_component.sl @@ -8,32 +8,32 @@ define plot_component() { %\synopsis{to plot modelfit parameters of different components} %\usage{plot_component([array of \code{struct comp}]);} %\qualifiers{ -%\qualifier{outputfile }{: give outputfile name and directory by hand} -%\qualifier{mjd_min [=53736.0]}{: to specify lower limit of time axis in mjd (default: 1/1/2006)} -%\qualifier{mjd_max [=55927.0]}{: to specify lower limit of time axis in mjd (default: 1/1/2012)} -%\qualifier{date_min [=2006.0]}{: to specify lower limit of time axis (default: 1/1/2006)} -%\qualifier{date_max [=2012.0]}{: to specify lower limit of time axis (default: 1/1/2012)} -%\qualifier{distance_min [=-2]}{: lower limit of distance axis in mas} -%\qualifier{distance_max [=20]}{: upper limit of distance axis in mas} -%\qualifier{flux_min [=1e-5]}{: lower limit of flux axis in Jy} -%\qualifier{flux_max [=5]}{: upper limit of flux axis in Jy} -%\qualifier{TB_min [=10^5]}{: lower limit of brightness temperature axis in K} -%\qualifier{TB_max [=10^15]}{: upper limit of brightness temperature axis in K} -%\qualifier{size_min [=1e-3]}{: lower limit of size axis in mas^2} -%\qualifier{size_max [=100]}{: upper limit of size axis in mas^2} -%\qualifier{pos_min [=-180]}{: lower limit of pos angle in degrees} -%\qualifier{pos_max [=180]}{: upper limit of pos angle in degrees} -%\qualifier{labels [=default]}{: provide array of custom labels for the components} -%\qualifier{sym [=default]}{: provide array of custom symbols for the components} -%\qualifier{symcolor [=default]}{: provide array of custom colors for the components} -%\qualifier{symsize [=1]}{: provide array of custom symbol sizes or one value to apply size to all} -%\qualifier{legend}{: create a legend} -%\qualifier{lpos_x}{: set the x position of the legend in world0 system (0 = left, 1=right)} -%\qualifier{lpos_y}{: set the y position of the legend in world0 system (0 = bottom, 1=top)} -%\qualifier{linestyle [=default]}{: set to 0 if the flux values should not be conntected (or to another value for +%\qualifier{outputfile}{outputfile name and directory by hand} +%\qualifier{mjd_min}{[=53736.0] lower limit of time axis in mjd (default: 1/1/2006)} +%\qualifier{mjd_max}{[=55927.0] upper limit of time axis in mjd (default: 1/1/2012)} +%\qualifier{date_min}{[=2006.0] lower limit of time axis (default: 1/1/2006)} +%\qualifier{date_max}{[=2012.0] upper limit of time axis (default: 1/1/2012)} +%\qualifier{distance_min}{[=-2] lower limit of distance axis in mas} +%\qualifier{distance_max}{[=20] upper limit of distance axis in mas} +%\qualifier{flux_min}{[=1e-5] lower limit of flux axis in Jy} +%\qualifier{flux_max}{[=5] upper limit of flux axis in Jy} +%\qualifier{TB_min}{[=10^5] lower limit of brightness temperature axis in K} +%\qualifier{TB_max}{[=10^15] upper limit of brightness temperature axis in K} +%\qualifier{size_min}{[=1e-3] lower limit of size axis in mas^2} +%\qualifier{size_max}{[=100] upper limit of size axis in mas^2} +%\qualifier{pos_min}{[=-180] lower limit of pos angle in degrees} +%\qualifier{pos_max}{[=180] upper limit of pos angle in degrees} +%\qualifier{labels}{[=default] provide array of custom labels for the components} +%\qualifier{sym}{[=default] provide array of custom symbols for the components} +%\qualifier{symcolor}{[=default] provide array of custom colors for the components} +%\qualifier{symsize}{[=1] provide array of custom symbol sizes or one value to apply size to all} +%\qualifier{legend}{create a legend} +%\qualifier{lpos_x}{set the x position of the legend in world0 system (0 = left, 1=right)} +%\qualifier{lpos_y}{set the y position of the legend in world0 system (0 = bottom, 1=top)} +%\qualifier{linestyle}{[=default] set to 0 if the flux values should not be conntected (or to another value for % another line style} -%\qualifier{nocomp}{: provide a comp structure (or array of structures) to plot not identified components in black} -%\qualifier{plots [=[9,10,3,4,11,12]]}{:provide an array of numbers to generated specified plots: +%\qualifier{nocomp}{provide a comp structure (or array of structures) to plot not identified components in black} +%\qualifier{plots}{[=[9,10,3,4,11,12]]: provide an array of numbers to generated specified plots: % 1: distance vs mjd % 2: flux vs mjd % 3: T_B vs distance @@ -48,7 +48,7 @@ define plot_component() { % 12: pos_angle vs time } %} %\description -%This functions creates overview plots for modelfit compoents. The required input format is the comp structure which can be obtained with get_component or an array of the comp structure. +%This functions creates overview plots for modelfit components. The required input format is the comp structure which can be obtained with get_component or an array of the comp structure. %!%- variable comp; switch(_NARGS) diff --git a/src/misc/radio/plot_jet_speed.sl b/src/misc/radio/plot_jet_speed.sl index fff541516d7c23d69e870cc6c2e80439181cd67e..ce6cee4fe17a1cc99741c1cc814f01fed4b8790e 100644 --- a/src/misc/radio/plot_jet_speed.sl +++ b/src/misc/radio/plot_jet_speed.sl @@ -6,8 +6,8 @@ define plot_jet_speed () %\synopsis{visualizes the jet_speed_struct used by init_jet_fit} %\usage{plot_jet_speed (Struct_Type jet_speed_struct);} %\qualifiers{ -%\qualifier{xrange}{: set the xrange (provide a list or array)} -%\qualifier{yrange}{: set the yrange (provide a list or array)} +%\qualifier{xrange}{set the xrange (provide a list or array)} +%\qualifier{yrange}{set the yrange (provide a list or array)} %} %\seealso{init_jet_fit} %!%- diff --git a/src/misc/radio/plot_spix.sl b/src/misc/radio/plot_spix.sl index 4bba1d0a24172f97a4b1e3ee0e9738c592569691..5c9460696b313d082dd6251454258440dcf5da49 100644 --- a/src/misc/radio/plot_spix.sl +++ b/src/misc/radio/plot_spix.sl @@ -9,46 +9,46 @@ define plot_spix() %\synopsis{plots a spectral index map using the struct provided by make_spix} %\usage{plot_spix(Struct_Type values, String_Type outputname);} %\qualifiers{ -%\qualifier{inv_color [=0]}{: inverts color scale (i.e. roles of red and blue switch)} -%\qualifier{min_spix [=min(values.spec_map)]}{: minimum spectral index to be plotted} -%\qualifier{max_spix [=max(values.spec_map)]}{: maximum spectral index to be plotted} -%\qualifier{lum_scale [=1]}{: use the sum of the intensity of both images to scale -% the brightness of the spectral index map, set to 0 in order to -% show the significant regions at uniform brightness} -%\qualifier{nsigma [=0]}{: spectral index values are only shown for pixels where -% the emission (in both bands) is above the specified -% significance (e.g., nsigma=3 means that the emission -% has to be 3*sigma above the noise level)} -%\qualifier{nsigma_lo [=0]}{: specify emission limit for low frequency band separately} -%\qualifier{nsigma_hi [=0]}{: specify emission limit for high frequency band separately} -%\qualifier{low_lum_limit [=0]}{: number of stdevs above the median that luminosity data +%\qualifier{inv_color}{[=0] inverts color scale (i.e., roles of red and blue switch)} +%\qualifier{min_spix}{[=min(values.spec_map)] minimum spectral index to be plotted} +%\qualifier{max_spix}{[=max(values.spec_map)] maximum spectral index to be plotted} +%\qualifier{lum_scale}{[=1] use the sum of the intensity of both images to scale +% the brightness of the spectral index map, set to 0 in order to +% show the significant regions at uniform brightness} +%\qualifier{nsigma [=0]}{spectral index values are only shown for pixels where +% the emission (in both bands) is above the specified +% significance (e.g., nsigma=3 means that the emission +% has to be 3*sigma above the noise level)} +%\qualifier{nsigma_lo}{[=0] emission limit for low frequency band separately} +%\qualifier{nsigma_hi}{[=0] emission limit for high frequency band separately} +%\qualifier{low_lum_limit}{[=0] number of stdevs above the median that luminosity data % begins to be displayed} -%\qualifier{hi_lum_limit [=0]}{: number of (e^n) stdevs above the median at which color +%\qualifier{hi_lum_limit}{[=0] number of (e^n) stdevs above the median at which color % is fully saturated (0 -> no limit)} -%\qualifier{ra_frac [={0.0,1.0}]}{: specifies fraction of RA to display with {left,right} limits, +%\qualifier{ra_frac}{[={0.0,1.0}] fraction of RA to display with {left,right} limits, % will keep scaling} -%\qualifier{dec_frac [={0.0,1.0}]}{: specifies fraction of DEC to display with {left,right} limits, +%\qualifier{dec_frac}{[={0.0,1.0}] fraction of DEC to display with {left,right} limits, % will keep scaling} -%\qualifier{ra_mas [={NULL,NULL}]}{: specifies {left,right} limits of image in mas} -%\qualifier{dec_mas [={NULL,NULL}]}{: specifies {top,bottom} limits of image in mas} -%\qualifier{size [=14]}{: size of plot (maximum dimension)} -%\qualifier{print_mode [=0]}{: set =1 for white background} -%\qualifier{blue_bkgr [=0]}{: for a dark blue background set to 1} -%\qualifier{quadratic}{: create a quadratic image, by default the scaling is such that +%\qualifier{ra_mas}{[={NULL,NULL}] {left,right} limits of image in mas} +%\qualifier{dec_mas}{[={NULL,NULL}] {top,bottom} limits of image in mas} +%\qualifier{size}{[=14] size of plot (maximum dimension)} +%\qualifier{print_mode}{[=0] set =1 for white background} +%\qualifier{blue_bkgr}{[=0] for a dark blue background set to 1} +%\qualifier{quadratic}{create a quadratic image, by default the scaling is such that % scaling in RA and DEC is equal} -%\qualifier{no_labels }{: plot no labels} -%\qualifier{pmodecolor [=1]}{: color saturation decreases wth this root of luminosity -% (i.e. 2=sqrt) in print mode only} -%\qualifier{beam_color [="gray"]}{: beam color} -%\qualifier{src_name [=values.source]}{: manually set source name in plot} -%\qualifier{obs_date [=values.date]}{: manually set date in plot} -%\qualifier{xyunit [="mas"]}{: unit of the x/y labels, can be changed between "mas", "arcsec", "arcmin" and "deg"; +%\qualifier{no_labels}{plot no labels} +%\qualifier{pmodecolor}{[=1] color saturation decreases wth this root of luminosity +% (i.e., 2=sqrt) in print mode only} +%\qualifier{beam_color}{[="gray"] beam color} +%\qualifier{src_name}{[=values.source] manually set source name in plot} +%\qualifier{obs_date}{[=values.date] manually set date in plot} +%\qualifier{xyunit}{[="mas"] unit of the x/y labels, can be changed between "mas", "arcsec", "arcmin" and "deg"; % assumption: FITS header sets unit "mas"} -%\qualifier{xfig_tmp_dir [=xfig_get_tmp_dir]}{: set the path for the tmp directory used by xfig} -%\qualifier{xfig_autoeps_dir [=xfig_get_autoeps_dir]}{: set the path for the autoeps directory} -%\qualifier{color_scheme [="hot"]}{: setting another colorscheme (lum_scale=0 is automatically set)} -%\qualifier{h_scalebar}{: if given, a horizontal scalebar is plotted above the spixmap} -%\qualifier{no_scalebar}{: if given, no scalebar is plotted} +%\qualifier{xfig_tmp_dir}{[=xfig_get_tmp_dir] set the path for the tmp directory used by xfig} +%\qualifier{xfig_autoeps_dir}{[=xfig_get_autoeps_dir] set the path for the autoeps directory} +%\qualifier{color_scheme}{[="hot"] setting another colorscheme (lum_scale=0 is automatically set)} +%\qualifier{h_scalebar}{if given, a horizontal scalebar is plotted above the spixmap} +%\qualifier{no_scalebar}{if given, no scalebar is plotted} %} %\description % This function creates a spectral image plot with xfig from the diff --git a/src/misc/radio/plot_vlbi_map.sl b/src/misc/radio/plot_vlbi_map.sl index 3b423b2a29c5cb165fe6a9d020ef7f3b417b823a..ab266907b6d8bf3678d452dc48b875fc5e1e0d3c 100644 --- a/src/misc/radio/plot_vlbi_map.sl +++ b/src/misc/radio/plot_vlbi_map.sl @@ -92,78 +92,78 @@ define plot_vlbi_map() %\usage{plot_vlbi_map(String_Type \code{fitsfile}, [String_Type \code{fitsfile (polflux)}], String_Type \code{filename})} %\altusage{plot_vlbi_map(Struct_Type \code{img_struct}, String_Type \code{filename})} %\qualifiers{ -%\qualifier{color_scheme [="ds9b"]}{: select a color scheme for the image} -%\qualifier{dec_frac [={0.0,1.0}]}{: declination range of the image by +%\qualifier{color_scheme [="ds9b"]}{ select a color scheme for the image} +%\qualifier{dec_frac [={0.0,1.0}]}{ declination range of the image by % selecting a fraction of the file's range} -%\qualifier{ra_frac [={0.0,1.0}]}{: right ascension range of the image by +%\qualifier{ra_frac [={0.0,1.0}]}{ right ascension range of the image by % selecting a fraction of the file's range} -%\qualifier{dec_mas [={min,max}]}{: set declination range of the image directly in mas. +%\qualifier{dec_mas [={min,max}]}{ set declination range of the image directly in mas. % overwrites \code{dec_frac}} -%\qualifier{ra_mas [={min,max}]}{: set right ascension range of the image directly in mas +%\qualifier{ra_mas [={min,max}]}{ set right ascension range of the image directly in mas % (analog to \code{dec_mas})} -%\qualifier{fit_noise [=1]}{: fit the noise of a map} -%\qualifier{n_sigma [=3.0]}{: start color scaling at \code{n_sigma*sigma}} -%\qualifier{cont_scl [=2.0]}{: set factor to change the separation between\n +%\qualifier{fit_noise [=1]}{ fit the noise of a map} +%\qualifier{n_sigma [=3.0]}{ start color scaling at \code{n_sigma*sigma}} +%\qualifier{cont_scl [=2.0]}{ set factor to change the separation between\n % contour levels, the levels are placed at:\n % \code{cont_scl^[0,1,...]*n_sigma*sigma}} -%\qualifier{cont_lvl [=[c1,c2,..]}{: set contour levels [Jy] manually, overwrites\n +%\qualifier{cont_lvl [=[c1,c2,..]}{ set contour levels [Jy] manually, overwrites\n % other contour parameters} -%\qualifier{cont_width [=2]}{: set width of contour lines} -%\qualifier{plot_cont [=1]}{: set to 0 in order to plot without contour lines} -%\qualifier{cont_depth [=2]}{: set contour-line depth} -%\qualifier{plot_vec [=0]}{: set to 1 in order to plot with vectors +%\qualifier{cont_width [=2]}{ set width of contour lines} +%\qualifier{plot_cont [=1]}{ set to 0 in order to plot without contour lines} +%\qualifier{cont_depth [=2]}{ set contour-line depth} +%\qualifier{plot_vec [=0]}{ set to 1 in order to plot with vectors % (requires second fits file with polarized flux density)} -%\qualifier{vec_density [=5]}{: density of EVPA vectors; possible values: [1..10]} -%\qualifier{vec_width [=1]}{: width of EVPA vectors} -%\qualifier{vec_color [="black"]}{: color of EVPA vectors} -%\qualifier{plot_clr_img [=1]}{: set to 0 in order to plot without colored image} -%\qualifier{plot_clr_key [=1]}{: set to 0 in order to plot without key for color scale} -%\qualifier{plot_scale_arrows [=1]}{: set to 1 in order to plot with arrows denoting the size scalesin the map} -%\qualifier{clrcut [=0]}{: set to 1 in order to start the color scale at the +%\qualifier{vec_density [=5]}{ density of EVPA vectors; possible values: [1..10]} +%\qualifier{vec_width [=1]}{ width of EVPA vectors} +%\qualifier{vec_color [="black"]}{ color of EVPA vectors} +%\qualifier{plot_clr_img [=1]}{ set to 0 in order to plot without colored image} +%\qualifier{plot_clr_key [=1]}{ set to 0 in order to plot without key for color scale} +%\qualifier{plot_scale_arrows [=1]}{ set to 1 in order to plot with arrows denoting the size scalesin the map} +%\qualifier{clrcut [=0]}{ set to 1 in order to start the color scale at the % significant emission (i.e., no color scaling below)} -%\qualifier{clrmin [=min(image)]}{: set minimum value [Jy] for color scale (see png_gray_to_rgb)} -%\qualifier{clrmax [=max(image)]}{: set maximum value [Jy] for color scale (see png_gray_to_rgb)} -%\qualifier{clrmu [from fit_gauss_to_img_noise]}{: set noise level of the image [Jy] for color scale +%\qualifier{clrmin [=min(image)]}{ set minimum value [Jy] for color scale (see png_gray_to_rgb)} +%\qualifier{clrmax [=max(image)]}{ set maximum value [Jy] for color scale (see png_gray_to_rgb)} +%\qualifier{clrmu [from fit_gauss_to_img_noise]}{set noise level of the image [Jy] for color scale % (mean value of regions without significant emission)} -%\qualifier{clrsig [from fit_gauss_to_img_noise]}{: set width of noise (1-sigma) [Jy] for color scale, +%\qualifier{clrsig [from fit_gauss_to_img_noise]}{set width of noise (1-sigma) [Jy] for color scale, % for identical color scale (e.g., in order to compare % different images) the following qualifiers have to be set: % clrmin, clrmax, clrmu, clrsig} -%\qualifier{colmap_depth}{: set depth of png map} -%\qualifier{bkg_white}{: set white map below clrmin, if clrcut is set, clrmin equals +%\qualifier{colmap_depth}{ set depth of png map} +%\qualifier{bkg_white}{ set white map below clrmin, if clrcut is set, clrmin equals % n_sigma above the mean background.} -%\qualifier{quadratic}{: create a quadratic image, by default the scaling is such that +%\qualifier{quadratic}{ create a quadratic image, by default the scaling is such that % scaling in RA and DEC is equal} -%\qualifier{plotsize [=14]}{: size of the plot (scaling of image relative to font size)} -%\qualifier{src_name [=default]}{: set the name of the source, by default the name\n +%\qualifier{plotsize [=14]}{ size of the plot (scaling of image relative to font size)} +%\qualifier{src_name [=default]}{ set the name of the source, by default the name\n % is read from the .fits file % set to NULL for not plotting a source name} -%\qualifier{obs_date [=default]}{: set the observation date, by default the observation\n +%\qualifier{obs_date [=default]}{ set the observation date, by default the observation\n % date is read from the .fits file % set to NULL for not plotting a observation date} -%\qualifier{axis_color [="gray"]}{: set axis color} -%\qualifier{source_color [="gray"]}{: set color of source name} -%\qualifier{date_color [="gray"]}{: set color of observation date} -%\qualifier{date_depth [=1]}{: set depth of observation date} -%\qualifier{source_depth [=1]}{: set depth of source name} -%\qualifier{cont_color [="gray"]}{: set color of contour lines} -%\qualifier{neg_cont_color [="gray"]}{: set color of contour lines below noise level} -%\qualifier{date_xy [=[0.95,0.95]]}{: set world0 coordinates of date string} -%\qualifier{plot_beam [=1]}{: set to 1 in order to plot the beam} -%\qualifier{plot_components}{: set to plot model components on top of image} -%\qualifier{model_circs}{: set to plot model component circles on top of image} -%\qualifier{pos_comp_color [="seagreen"]}{: set for color of model components with positive flux} -%\qualifier{neg_comp_color [="seagreen"]}{: set for color of model components with negative flux} -%\qualifier{beam_color [="gray"]}{: set color of the beam} +%\qualifier{axis_color [="gray"]}{ set axis color} +%\qualifier{source_color [="gray"]}{ set color of source name} +%\qualifier{date_color [="gray"]}{ set color of observation date} +%\qualifier{date_depth [=1]}{ set depth of observation date} +%\qualifier{source_depth [=1]}{ set depth of source name} +%\qualifier{cont_color [="gray"]}{ set color of contour lines} +%\qualifier{neg_cont_color [="gray"]}{set color of contour lines below noise level} +%\qualifier{date_xy [=[0.95,0.95]]}{ set world0 coordinates of date string} +%\qualifier{plot_beam [=1]}{ set to 1 in order to plot the beam} +%\qualifier{plot_components}{ set to plot model components on top of image} +%\qualifier{model_circs}{ set to plot model component circles on top of image} +%\qualifier{pos_comp_color [="seagreen"]}{set for color of model components with positive flux} +%\qualifier{neg_comp_color [="seagreen"]}{set for color of model components with negative flux} +%\qualifier{beam_color [="gray"]}{ set color of the beam} %\qualifier{no_labels}{: plot no labels} %\qualifier{colmap_label}{: set label of colormap} -%\qualifier{neglog [=0]}{: use log scale for negative flux values} +%\qualifier{neglog [=0]}{ use log scale for negative flux values} %\qualifier{frac [=0.1]}{: fraction to which the linear region below n_sigma*sigma % is scaled in the color scale (if clrcut != 0)} -%\qualifier{funit [="mJy"]}{: unit of the color scale bar, can be changed from "mJy" to "Jy"} -%\qualifier{xyunit [="mas"]}{: unit of the x/y labels, can be changed between "mas", "arcsec", "arcmin" and "deg"; +%\qualifier{funit [="mJy"]}{ unit of the color scale bar, can be changed from "mJy" to "Jy"} +%\qualifier{xyunit [="mas"]}{ unit of the x/y labels, can be changed between "mas", "arcsec", "arcmin" and "deg"; % assumption: FITS header sets unit "mas"} -%\qualifier{return_xfig}{: set qualifier to return the xfig object(s) instead than +%\qualifier{return_xfig}{ set qualifier to return the xfig object(s) instead than % rendering directly} %} %\description diff --git a/src/misc/radio/plot_vlbi_pol_map.sl b/src/misc/radio/plot_vlbi_pol_map.sl index c8990eec3b7735c2384c10f92d3f9ce479fff051..89f9b473aeab6f9f72d3503f7a6ad166c1b7044c 100644 --- a/src/misc/radio/plot_vlbi_pol_map.sl +++ b/src/misc/radio/plot_vlbi_pol_map.sl @@ -16,17 +16,17 @@ define plot_vlbi_pol_map () % plot_vlbi_pol_map(String_Type \code{fitsfile flux-map-1}, String_Type \code{fitsfile EVPA-map}, % String_Type \code{filename flux-map-2}, String_Type \code{filename plot-product})} %\qualifiers{ -%\qualifier{n_sigma_pol [=5]}{: start color scaling of polarized flux at \code{n_sigma*sigma}} -%\qualifier{n_sigma_vec [=5]}{: start plotting of EVPA vectors at \code{n_sigma*sigma} in reference to the polarized flux} -%\qualifier{colmap_pol}{: if qualifier exists, plot most significant polarized flux (depending on n_sigma_pol), +%\qualifier{n_sigma_pol}{[=5] start color scaling of polarized flux at \code{n_sigma*sigma}} +%\qualifier{n_sigma_vec}{[=5] start plotting of EVPA vectors at \code{n_sigma*sigma} in reference to the polarized flux} +%\qualifier{colmap_pol}{if set, plot most significant polarized flux (depending on n_sigma_pol), % recommended: color map "iceandfire"} -%\qualifier{colmap_back}{: if qualifier exists, plot polarized flux or total intensity flux, recommended: color map "ds9b"} -%\qualifier{pol_cont}{: set to 1 in order to plot contours of flux-map-1} -%\qualifier{pol_cont_col [="white"]}{: set color of contours of flux-map-1} -%\qualifier{pol_cont_depth [=0]}{: set depth of contours of flux-map-1} -%\qualifier{pol_translate [=0.4]}{: if plot_pol_colmap=0, the contours of polarized flux will be translated +%\qualifier{colmap_back}{if set, plot polarized flux or total intensity flux, recommended: color map "ds9b"} +%\qualifier{pol_cont}{set to 1 in order to plot contours of flux-map-1} +%\qualifier{pol_cont_col}{[="white"] color of contours of flux-map-1} +%\qualifier{pol_cont_depth}{[=0] depth of contours of flux-map-1} +%\qualifier{pol_translate}{[=0.4] if plot_pol_colmap=0, the contours of polarized flux will be translated % by \code{pol_translate*range_in_declination}} -%\qualifier{render_object [=1]}{: set to 1 in order to render the plot object} +%\qualifier{render_object}{[=1] set to 1 in order to render the plot object} %} %\description % This function uses the existing maps flux-map-1 (polarized flux), diff --git a/src/misc/radio/radio_mod2img.sl b/src/misc/radio/radio_mod2img.sl index 661a905c32b8d4544e36d19f81b1481472a3efd1..6af11a00b822bbb89bbc8e419cc41ca386179576 100644 --- a/src/misc/radio/radio_mod2img.sl +++ b/src/misc/radio/radio_mod2img.sl @@ -21,17 +21,17 @@ define radio_mod2img () %\synopsis{creates an image using a model and a beam} %\usage{Struct_Type img = radio_mod2img( Struct_Type \code{mdl}, Double_Type \code{beam});} %\qualifiers{ -%\qualifier{src_name [=NULL]}{: set the name of the source} -%\qualifier{date_mjd [=_NaN]}{: set the observation date (MJD)} -%\qualifier{obs_date [=NULL]}{: set the observation date (string). if only date_mjd or only obs_date +%\qualifier{src_name}{[=NULL] name of the source} +%\qualifier{date_mjd}{[=_NaN] observation date (MJD)} +%\qualifier{obs_date}{[=NULL] observation date (string). if only date_mjd or only obs_date % are set, the other one is calculated.} -%\qualifier{nrpix_ra [=512]}{: number of pixels for right ascension} -%\qualifier{nrpix_dec}{: number of pixels in declination (by default calculated from RA-DEC-range)} -%\qualifier{ra [=[ra_min,ra_max]]}{: RA range in mas} -%\qualifier{dec [=[dec_min,dec_max]]}{: DEC range in mas, by default the RA-DEC-range is +%\qualifier{nrpix_ra}{[=512] number of pixels for right ascension} +%\qualifier{nrpix_dec}{number of pixels in declination (by default calculated from RA-DEC-range)} +%\qualifier{ra}{[=[ra_min,ra_max]] RA range in mas} +%\qualifier{dec}{[=[dec_min,dec_max]] DEC range in mas, by default the RA-DEC-range is % calculated from the distribution of model components and the beam size} -%\qualifier{delt [=[ra_delt,dec_delt]]}{: resolution in mas/pixel, overwrites nrpix qualifiers} -%\qualifier{sigma [=1e-3*max(img)]}{: set the value for 1 sigma (used by plot_vlbi_map)} +%\qualifier{delt}{[=[ra_delt,dec_delt]] resolution in mas/pixel, overwrites nrpix qualifiers} +%\qualifier{sigma}{[=1e-3*max(img)] value for 1 sigma (used by plot_vlbi_map)} %} %\description % This function uses a model to generate an image and convolves it with the beam. diff --git a/src/misc/radio/read_difmap_fits.sl b/src/misc/radio/read_difmap_fits.sl index 7a390cfca054e94fbd0465dac61e5b726803dbae..9eaf37123a22e1c0c44416e4ece640e3bb560390 100644 --- a/src/misc/radio/read_difmap_fits.sl +++ b/src/misc/radio/read_difmap_fits.sl @@ -12,7 +12,7 @@ define read_difmap_fits () %\synopsis{read a fits image provided by DIFMAP} %\usage{Struct_Type img_struct = read_difmap_fits(String_Type \code{fitsfile_name})} %\qualifiers{ -%\qualifier{fit_noise}{: fit properties of the image noise} +%\qualifier{fit_noise}{fit properties of the image noise} %} %\description % This function reads a .fits file provided by DIFMAP and returns diff --git a/src/misc/radio/read_ep.sl b/src/misc/radio/read_ep.sl index 5917af6aec183479d46feceb0384477f964237e9..3fa319447fa8be3d53246899b9414e8009ec9f60 100644 --- a/src/misc/radio/read_ep.sl +++ b/src/misc/radio/read_ep.sl @@ -4,7 +4,7 @@ define read_ep(){ %\synopsis{read in the epoch files} %\usage{read_ep([array of epoch fits files]);} %\qualifiers{ -%\qualifier{quadrant [=1]}{: Quadrant which is defined as a positive distance ( RA, DEC > 0 == 1 || RA < 0, DEC > 0 == 2 || RA < 0, DEC < 0 == 3 || RA > 0, DEC < 0 == 4) +%\qualifier{quadrant}{[=1] Quadrant which is defined as a positive distance ( RA, DEC > 0 == 1 || RA < 0, DEC > 0 == 2 || RA < 0, DEC < 0 == 3 || RA > 0, DEC < 0 == 4) %} %} %\description diff --git a/src/misc/radio/ridge_line.sl b/src/misc/radio/ridge_line.sl index 1aa38b8e2117e4fa0941371723517efc75b492db..82456880e845faeda6c9058a1ba0d8aeb89b8e0d 100644 --- a/src/misc/radio/ridge_line.sl +++ b/src/misc/radio/ridge_line.sl @@ -4,10 +4,10 @@ define ridge_line () %\synopsis{calculates the ridge line} %\usage{Struct_Type ridge_line = ridge_line (Array_Type \code{img})} %\qualifiers{ -%\qualifier{ref_pix [=[y,x]]}{: starting pixel of the ridge line (index convention: img[y,x]) +%\qualifier{ref_pix}{[=[y,x]] starting pixel of the ridge line (index convention: img[y,x]) % brightest pixel used by default} -%\qualifier{dr [=0.8]}{: step size in pixels} -%\qualifier{steps}{: number of steps (default is maximal length of dimensions)} +%\qualifier{dr}{[=0.8] step size in pixels} +%\qualifier{steps}{number of steps (default is maximal length of dimensions)} %} %\description % This function calculates the ridge line in a (jet) image. diff --git a/src/misc/radio/stacking_vlbi_images.sl b/src/misc/radio/stacking_vlbi_images.sl index 135ad3afcc5176ef30414251fcfe0fe0517a8005..1c47c6ac23257f079d4d7731e1104d9f47b130c5 100644 --- a/src/misc/radio/stacking_vlbi_images.sl +++ b/src/misc/radio/stacking_vlbi_images.sl @@ -17,20 +17,20 @@ define stacking_vlbi_images() %\synopsis{stack VLBI images of same size} %\usage{stacking_vlbi_images(Array_Type \code{string(cleanfiles)}, String_Type \code{outputfile});} %\qualifiers{ -%\qualifier{ra_mas [={20,-20}]}{: specifies {left,right} limits of image in mas} -%\qualifier{dec_mas [={-20,20}]}{: specifies {top,bottom} limits of image in mas} -%\qualifier{plot_size [=15]}{: size of plot} -%\qualifier{n_sigma [=3.0]}{: lowest contour of clean image} -%\qualifier{sourcename [=default]}{: set the name of the source, by default the name is read from the +%\qualifier{ra_mas}{[={20,-20}] {left,right} limits of image in mas} +%\qualifier{dec_mas}{[={-20,20}] {top,bottom} limits of image in mas} +%\qualifier{plot_size}{[=15] size of plot} +%\qualifier{n_sigma}{[=3.0] lowest contour of clean image} +%\qualifier{sourcename}{[=default] name of the source, by default the name is read from the % .fits file, set to NULL for not plotting a source name} -%\qualifier{obs_date1 [=default]}{: set the observation date, by default the date of the first +%\qualifier{obs_date1}{[=default] observation date, by default the date of the first % observation is used} -%\qualifier{obs_date2 [=default]}{: set the observation date, by default the date of the last +%\qualifier{obs_date2}{[=default] 2nd observation date, by default the date of the last % observation is used} -%\qualifier{cont_scl [="2"]}{: set factor to change the separation between contour levels} -%\qualifier{cont_lvl [=[c1,c2,..]}{: set contour levels [Jy] manually, overwrites other contour parameters} -%\qualifier{major}{: specify a vector for the major tic marks of the plot} -%\qualifier{minor}{: specify a vector for the minor tic marks of the plot} +%\qualifier{cont_scl}{[="2"] set factor to change the separation between contour levels} +%\qualifier{cont_lvl}{[=[c1,c2,..] contour levels [Jy] manually, overwrites other contour parameters} +%\qualifier{major}{specify a vector for the major tic marks of the plot} +%\qualifier{minor}{specify a vector for the minor tic marks of the plot} %} %\description % This function creates a stacked image of individual VLBI-clean images.\n diff --git a/src/misc/satellites/INTEGRAL/integral_cat2ds9.sl b/src/misc/satellites/INTEGRAL/integral_cat2ds9.sl index b3f0272fd4928426a835372e7c9a3859d1d02cb0..772c3d1731be72f64f9360305d0402ad2926ec67 100644 --- a/src/misc/satellites/INTEGRAL/integral_cat2ds9.sl +++ b/src/misc/satellites/INTEGRAL/integral_cat2ds9.sl @@ -6,16 +6,16 @@ define integral_cat2ds9(inputfile,outputfile) %\usage{ ()=integral_cat2ds9(String_Type inputfile, % String_Type outputfile)} %\qualifiers{ -%\qualifier{source_name}{: name of the column with source names +%\qualifier{source_name}{name of the column with source names % (default: NAME)} -%\qualifier{ra_name}{: name of the column with right ascension of the +%\qualifier{ra_name}{name of the column with right ascension of the % sources (default: RA_OBJ)} %\qualifier{dec_name}{:name of the column with declination of the % sources (default: DEC_OBJ)} -%\qualifier{color}{: color to be used for the ds9 region (default: +%\qualifier{color}{color to be used for the ds9 region (default: % black)} -%\qualifier{symbol}{: form of the ds9 region (default:box)} -%\qualifier{noname}{: only boxes, no text with source names} +%\qualifier{symbol}{form of the ds9 region (default:box)} +%\qualifier{noname}{only boxes, no text with source names} %} %!%- { diff --git a/src/misc/satellites/RXTE/RXTE_ASM_lightcurve.sl b/src/misc/satellites/RXTE/RXTE_ASM_lightcurve.sl index 24c408870dd800fc58c4268968aad2207ea92bec..d040eb6242f259d11da34fc47dc306ffc88fb7be 100644 --- a/src/misc/satellites/RXTE/RXTE_ASM_lightcurve.sl +++ b/src/misc/satellites/RXTE/RXTE_ASM_lightcurve.sl @@ -4,13 +4,13 @@ define RXTE_ASM_lightcurve() %\synopsis{retrieves ASM lightcurves for a given source} %\usage{Struct_Type RXTE_ASM_lightcurve(String_Type sourcename);} %\qualifiers{ -%\qualifier{MJDmin}{: earliest MJD to be used} -%\qualifier{MJDmax}{: latest MJD to be used} -%\qualifier{dt}{: if specified, time resolution in MJD for rebinning} -%\qualifier{no_filter_nan}{: do not remove empty bins after rebinning (only with \code{dt})} -%\qualifier{list}{: lists available sources; \code{sourcename} may be omitted but can be a regular expression} -%\qualifier{get_list}{: as list, but the list of sources is returned as an array of strings} -%\qualifier{save}{: saves the light curve data in a local FITS file} +%\qualifier{MJDmin}{earliest MJD to be used} +%\qualifier{MJDmax}{latest MJD to be used} +%\qualifier{dt}{if specified, time resolution in MJD for rebinning} +%\qualifier{no_filter_nan}{do not remove empty bins after rebinning (only with \code{dt})} +%\qualifier{list}{lists available sources; \code{sourcename} may be omitted but can be a regular expression} +%\qualifier{get_list}{as list, but the list of sources is returned as an array of strings} +%\qualifier{save}{saves the light curve data in a local FITS file} %\qualifier{verbose}{} %} %!%- diff --git a/src/misc/satellites/RXTE/RXTE_PCA_info.sl b/src/misc/satellites/RXTE/RXTE_PCA_info.sl index f9c685266145aa5891d4c658834f1dc8559cf606..4c900036cc2f16b594348024fff857e8a0c9747e 100644 --- a/src/misc/satellites/RXTE/RXTE_PCA_info.sl +++ b/src/misc/satellites/RXTE/RXTE_PCA_info.sl @@ -3,46 +3,44 @@ define RXTE_PCA_info() %\function{RXTE_PCA_info} %\synopsis{retrieves light curves for a given RXTE-PCA observation} %\usage{Struct_Type RXTE_PCA_info(String_Type dirs[])} +%\qualifiers{ +% \qualifier{binning}{how much datapoints are to be summed up into a single point} +% \qualifier{path}{path to the observation} +% \qualifier{dirs}{subdirectories to the individual observing blocks} +% +% \qualifier{noback}{set if no bkg subtraction is to be performed} +% \qualifier{earthvle}{set if EarthVLE background model is to be used} +% \qualifier{faint}{set if Faint background model is to be used} +% \qualifier{q6}{set if Q6 background model is to be used +% (default is to test for earthvle,faint,q6)} +% \qualifier{skyvle}{set if SkyVLE background model is to be used +% (default is 0 for noback,earthvle,faint,q6,skyvle)} +% \qualifier{exclusive}{set to search for data that was extracted +% with the exclusive keyword to pca_standard being set.} +% \qualifier{top}{set to read top-layer data} +% \qualifier{nopcu0}{set to search for data that was extracted +% ignoring PCU0} +% \qualifier{fivepcu}{plot count-rates wrt to whole PCA, i.e., +% normalizing to five PCU; default is to plot the average +% countrate per PCU} +% \qualifier{bary}{Try to use barycenter time column in data. Must be +% created with fxbary before into file with postfix _bary.} +% \qualifier{t}{time array of data in MJD.} +% \qualifier{c}{count array of data} +% \qualifier{err}{Estimated error by applying Poisson statistic. +% Binning/background subtraction will be acknowledged.} %\description % The elements of \code{dirs} may contain globbing expressions. % % The returned structure has the following fields:\n -% - \code{obstime = struct { start, stop}} with the times for each observation in \code{dirs}\n +% \code{obstime = struct { start, stop}} with the times for each observation in \code{dirs}\n % \code{lc = struct { time, rate, error }} with the PCA light curve\n % \code{obscat = struct} with information from the observation catalogue (occultation, saa, good time)\n % \code{gti}\n % \code{xfl = struct} with information from the filter file %\seealso{aitlib/rxte/readxtedata.pro} +%} %!%- -%% \qualifiers{ -%% \qualifier{binning}{: how much datapoints are to be summed up into a single point} -%% } -% path: path to the observation -% dirs: subdirectories to the individual observing blocks -% -% noback: set if no bkg subtraction is to be performed -% earthvle: set if EarthVLE background model is to be used -% faint: set if Faint background model is to be used -% q6: set if Q6 background model is to be used -% (default is to test for earthvle,faint,q6) -% skyvle: set if SkyVLE background model is to be used -% (default is 0 for noback,earthvle,faint,q6,skyvle) -% -% exclusive: set to search for data that was extracted -% with the exclusive keyword to pca_standard being set. -% top: set to read top-layer data -% nopcu0: set to search for data that was extracted -% ignoring PCU0 -% fivepcu: plot count-rates wrt to whole PCA, i.e., -% normalizing to five PCU; default is to plot the average -% countrate per PCU -% bary: Try to use barycenter time column in data. Must be -% created with fxbary before into file with postfix _bary. -% -% t : time array of data in MJD. -% c : count array of data -% err: Estimated error by applying poisson -% statistic. Binning/background subtraction will be acknowledged. % { variable dirs; diff --git a/src/misc/satellites/RXTE/RXTE_PCA_modes.sl b/src/misc/satellites/RXTE/RXTE_PCA_modes.sl index 31b3e0389b26a8afe445a4baf3bda806458905e4..77ab2cd08fa839b0ca3b36469aae95b4e4287eb5 100644 --- a/src/misc/satellites/RXTE/RXTE_PCA_modes.sl +++ b/src/misc/satellites/RXTE/RXTE_PCA_modes.sl @@ -3,9 +3,9 @@ define RXTE_PCA_modes() %\function{RXTE_PCA_modes} %\usage{RXTE_PCA_modes(String_Type obsids);} %\qualifiers{ -%\qualifier{compact}{: only one row per ObsID, omit TSTART, TSTOP and duration} -%\qualifier{get_struct}{: return information on PCA modes in a structure, too} -%\qualifier{quiet}{: do not show information, implies \code{get_struct}} +%\qualifier{compact}{only one row per ObsID, omit TSTART, TSTOP and duration} +%\qualifier{get_struct}{return information on PCA modes in a structure, too} +%\qualifier{quiet}{do not show information, implies \code{get_struct}} %} %\description % Reads RXTE-PCA data modes from the PCA FITS-index (FIPC) file. diff --git a/src/misc/satellites/RXTE/RXTE_plot_PCA_info.sl b/src/misc/satellites/RXTE/RXTE_plot_PCA_info.sl index 1b485df7cfbdc995fbcbb9d525fb2fdcdd8fbd95..2b79c13d98fa36ee6f1b7e8681963a2d17ec5464 100644 --- a/src/misc/satellites/RXTE/RXTE_plot_PCA_info.sl +++ b/src/misc/satellites/RXTE/RXTE_plot_PCA_info.sl @@ -6,20 +6,20 @@ define RXTE_plot_PCA_info() %\altusage{Struct_Type RXTE_plot_PCA_info(String_Type dirs[]; get_info)} %} %\qualifiers{ -%\qualifier{electron}{: set to electron ratio threshold for data extraction} -%\qualifier{noback}{: set if no bkg subtraction is to be performed} -%\qualifier{earthvle}{: set if EarthVLE background model is to be used} -%\qualifier{faint}{: set if Faint background model is to be used} -%\qualifier{q6}{: set if Q6 background model is to be used (default is to test for earthvle,faint,q6)} -%\qualifier{skyvle}{: set if SkyVLE background model is to be used (default)} -%\qualifier{exclusive}{: set to search for data that was extracted +%\qualifier{electron}{set to electron ratio threshold for data extraction} +%\qualifier{noback}{set if no bkg subtraction is to be performed} +%\qualifier{earthvle}{set if EarthVLE background model is to be used} +%\qualifier{faint}{set if Faint background model is to be used} +%\qualifier{q6}{set if Q6 background model is to be used (default is to test for earthvle,faint,q6)} +%\qualifier{skyvle}{set if SkyVLE background model is to be used (default)} +%\qualifier{exclusive}{set to search for data that was extracted % with the exclusive keyword to pca_standard being set.} -%\qualifier{top}{: set to read top-layer data} -%\qualifier{nopcu0}{: set to search for data that was extracted ignoring PCU0} -%\qualifier{fivepcu}{: plot count-rates wrt to whole PCA, i.e., normalizing to 5 PCUs. +%\qualifier{top}{set to read top-layer data} +%\qualifier{nopcu0}{set to search for data that was extracted ignoring PCU0} +%\qualifier{fivepcu}{plot count-rates wrt to whole PCA, i.e., normalizing to 5 PCUs. % Default is to plot the average countrate per PCU.} %\qualifier{charsize_obsid}{} -%\qualifier{get_info}{: returns the info structure} +%\qualifier{get_info}{returns the info structure} %} %\description % The elements of \code{dirs} may contain globbing expressions. diff --git a/src/misc/simulation/mc_sig.sl b/src/misc/simulation/mc_sig.sl index 032b212116e38fff1622a9e47711b54e1978149c..24781160cbec0844a233318e8287f9a45bb41376 100644 --- a/src/misc/simulation/mc_sig.sl +++ b/src/misc/simulation/mc_sig.sl @@ -18,7 +18,7 @@ define mc_sig() % \qualifier{ignbinning}{do not apply the same binning after faking the data} % \qualifier{ignnotice}{do not use the same energy ranges after faking the data} % \qualifier{torque}{calculate significance using given number of torque jobs, i.e., total -% number of runs = mcruns*torque (default: 0, i.e. don't use torque)} +% number of runs = mcruns*torque (default: 0, i.e., don't use torque)} % \qualifier{walltime}{walltime of each torque job in minutes (default: 3 minutes times % number of MC runs per job)} % \qualifier{dontSubmit}{do not submit the torque job-file (implies qualifier 'dontwaint') @@ -27,7 +27,7 @@ define mc_sig() % 'dontClean') (default: wait)} % \qualifier{torqueDir}{temporary directory to save necessary torque files % NOTE: this directory will be deleted afterwards completely! -% (default: $HOME/.isis_mc_sig/)} +% (default: ~/.isis_mc_sig/)} % \qualifier{dontClean}{do not delete temporary torque directory afterwards} % \qualifier{chatty}{a number >0 means more chatty (default: 0)} % \qualifier{ }{additional qualifiers are passed to fits_load_fit} diff --git a/src/misc/simulation/powerlaw_noise.sl b/src/misc/simulation/powerlaw_noise.sl index 79ee718bd7aa85ab324ca828745bab348241e8a9..7bd8be8c63c7ce4885b7c16dd599fb2ced56bc11 100644 --- a/src/misc/simulation/powerlaw_noise.sl +++ b/src/misc/simulation/powerlaw_noise.sl @@ -4,9 +4,9 @@ define powerlaw_noise() %\synopsis{simulates a light curve with a power law distributed power spectrum} %\usage{Double_Type rate[] = powerlaw_noise(Integer_Type n);} %\qualifiers{ -%\qualifier{beta}{ [= 1.5]: power law index of the power spectrum} -%\qualifier{mean}{ [= 0]: mean rate of the simulated light curve} -%\qualifier{sigma}{ [= 1]: standard deviation of the simulated light curve} +%\qualifier{beta}{[= 1.5]: power law index of the power spectrum} +%\qualifier{mean}{[= 0]: mean rate of the simulated light curve} +%\qualifier{sigma}{[= 1]: standard deviation of the simulated light curve} %} %\description % \code{n} is the number of bins of the simulated lightcurve. diff --git a/src/misc/simulation/psd_lc.sl b/src/misc/simulation/psd_lc.sl index aab7257a2c976d063a3f71610c547f07b1aa1fb0..2b814b699dab26d38e2ec38acbcf45a2f7d6197c 100644 --- a/src/misc/simulation/psd_lc.sl +++ b/src/misc/simulation/psd_lc.sl @@ -27,13 +27,13 @@ define psd_lc() %\altusage{(rate1, rate2) = psd_lc(Integer_Type n, Double_Type dt, Ref_Type PSD; time_lag_spectrum=...);} %} %\qualifiers{ -%\qualifier{mean}{ [= 100]: mean count rate of the simulated lightcurve} -%\qualifier{sigma}{ [= 20]: standard deviation of the simulated lightcurve} -%\qualifier{poisson}{: if poisson noise should be applied on the lightcrurve} -%\qualifier{nr_PCUs}{ [= 1]: number of PCUs} -%\qualifier{time_lag_spectrum}{: spectrum of time lags (two lightcurves will be returned)} -%\qualifier{mean_2}{ [= 100]: mean count rate of the second lightcurve} -%\qualifier{sigma_2}{ [= 20]: standard deviation of the second lightcurve} +%\qualifier{mean}{[= 100]: mean count rate of the simulated lightcurve} +%\qualifier{sigma}{[= 20]: standard deviation of the simulated lightcurve} +%\qualifier{poisson}{if Poisson noise should be applied on the lightcrurve} +%\qualifier{nr_PCUs}{[= 1]: number of PCUs} +%\qualifier{time_lag_spectrum}{spectrum of time lags (two lightcurves will be returned)} +%\qualifier{mean_2}{[= 100]: mean count rate of the second lightcurve} +%\qualifier{sigma_2}{[= 20]: standard deviation of the second lightcurve} %} %\description % \code{n} is the number of bins of the simulated lightcurve. @@ -48,7 +48,9 @@ define psd_lc() % -- the frequency -- that calculates the time lag spectrum, % an additional second lightcurve is returned that has % the corresponding time lag with respect to the first one. -%\seealso{Timmer & Koenig (1995): "On generating power law noise", A&A 300, 707-710} +% +% see Timmer & Koenig (1995): "On generating power law noise", +% A&A 300, 707-710 %!%- { variable n, dt, PSD; diff --git a/src/misc/simulation/rndpwrlc.sl b/src/misc/simulation/rndpwrlc.sl index 3dc2752a9b7856b10a694a4b08759ab2c93699fe..27e9d9a5db131e354c768af40aabb86067698435 100644 --- a/src/misc/simulation/rndpwrlc.sl +++ b/src/misc/simulation/rndpwrlc.sl @@ -4,15 +4,16 @@ define rndpwrlc() %\synopsis{simulates a light curve with a power law distributed power spectrum} %\usage{(t, rate) = rndpwrlc(Integer_Type nt);} %\qualifiers{ -%\qualifier{beta}{ [=1.5]: power law index of the power spectrum} -%\qualifier{mean}{ [=0]: mean rate of the simulated light curve} -%\qualifier{sigma}{ [=1]: standard deviation of the simulated light curve} -%\qualifier{dt}{ [=1]: time resolution of the simulated light curve} +%\qualifier{beta}{[=1.5] power law index of the power spectrum} +%\qualifier{mean}{[=0] mean rate of the simulated light curve} +%\qualifier{sigma}{[=1] standard deviation of the simulated light curve} +%\qualifier{dt}{[=1] time resolution of the simulated light curve} %} %\description % \code{nt} is the number of bins of the simulated lightcurve. % It should be a power of two best performance of the fast Fourier transform. -%\seealso{Timmer & Koenig (1995): "On generating power law noise", A&A 300, 707-710} +% See also Timmer & Koenig (1995): "On generating power law noise", +% A&A 300, 707-710 %!%- { variable nt; diff --git a/src/misc/sltable.sl b/src/misc/sltable.sl index 0d3b35973607ac14bea49e91eb2de64293e3627c..eaef836bf89476987c59491512f8640b4c4d0177 100644 --- a/src/misc/sltable.sl +++ b/src/misc/sltable.sl @@ -431,6 +431,20 @@ define sltableBuildBody() %\function{sltableBuildBody} %\synopsis{Build a 2D array of table cells} %\usage{String_Type table[] = sltableBuildBody(Array_Type par1[, Array_Type par2,...])} +%\qualifiers{ +%\qualifier{horiz}{Integer_Type. If zero, each argument defines one column of +% the table. If nonzero, each argument defines one row. Default 0.} +%\qualifier{frozendelim}{String_Type[2]. Defines strings to use before and +% after a frozen parameter value. Default ["(",")"].} +%\qualifier{nodata}{String_Type. Defines string to use when no data is +% present in a cell. Default is "\\\\nodata" for deluxetables and +% "\\\\ldots" for tabular tables.} +%\qualifier{rownames}{String_Type[] or List_Type. Names for rows of table. +% If given as a List_Type of String_Type arrays, each element of the +% list will be included in its own column (this is useful for, e.g., +% putting the parameter name and the units in separate columns).} +%} +% %\description % Builds the "body" of a table (in the form of a 2D array of strings, % containing the fields of the table). @@ -465,20 +479,6 @@ define sltableBuildBody() % array or the first struct's value field. All later arrays and struct fields % should have the same number of elements. % -%\qualifiers{ -%\qualifier{horiz}{: Integer_Type. If zero, each argument defines one column of -% the table. If nonzero, each argument defines one row. Default 0.} -%\qualifier{frozendelim}{: String_Type[2]. Defines strings to use before and -% after a frozen parameter value. Default ["(",")"].} -%\qualifier{nodata}{: String_Type. Defines string to use when no data is -% present in a cell. Default is "\\nodata" for deluxetables and -% "\\ldots" for tabular tables.} -%\qualifier{rownames}{: String_Type[] or List_Type. Names for rows of table. -% If given as a List_Type of String_Type arrays, each element of the -% list will be included in its own column (this is useful for, e.g., -% putting the parameter name and the units in separate columns).} -%} -% %\seealso{sltable} %!%- { @@ -745,8 +745,8 @@ define sltable() % disabled to produce standard "tabular" tables by setting the "deluxe" % qualifier to zero. The deluxetable environment has been tested using the % latest aastex61.cls stylefile. Tabular tables will require the "booktabs" -% package, as they provide the \\toprule, \\midrule, and \\bottomrule -% commands used here. +% package, as they provide the toprule, midrule, and +% bottomrule LaXeX macros used here. % % Each argument given to sltable() provides the values of one % column of the table (or one row, if the "horiz" qualifier is nonzero). @@ -779,8 +779,8 @@ define sltable() % "frozendelim" qualifier). % % If the "nodata" field is nonzero, then a "no data" indicator will be -% printed. By default, for a deluxetable, this is "\\nodata" and for a -% tabular table it is "\\ldots". This is useful if you are putting multiple +% printed. By default, for a deluxetable, this is "\\\\nodata" and for a +% tabular table it is "\\\\ldots". This is useful if you are putting multiple % models which do not share the same parameters into the same table. % % This is a lot of words, so here is an @@ -816,45 +816,45 @@ define sltable() % if you find any bugs. % %\qualifiers{ -%\qualifier{deluxe}{: Integer_Type. If nonzero, we'll produce a deluxetable. +%\qualifier{deluxe}{Integer_Type. If nonzero, we'll produce a deluxetable. % Otherwise, tabular. Tabular tables aren't as fancy and aren't % implemented as well at the moment. In theory we could add other table % types. Default 1.} -%\qualifier{horiz}{: Integer_Type. If nonzero, arguments to sltable +%\qualifier{horiz}{Integer_Type. If nonzero, arguments to sltable % indicate _rows_ of the table. If 0, they indicate _columns_.} -%\qualifier{rownames}{: String_Type[] or List_Type[]. Names for the rows +%\qualifier{rownames}{String_Type[] or List_Type[]. Names for the rows % of the table. Multiple columns for the row names (e.g., parameter names % and units in separate columns) can be handled by providing a List_Type % containing multiple String_Type arrays.} -%\qualifier{colnames}{: String_Type[] or List_Type[]. Names for the columns of +%\qualifier{colnames}{String_Type[] or List_Type[]. Names for the columns of % the table (i.e., the column headers). Similar to rownames above, % multi-line headers can be produced by passing a List_Type to this % qualifier.} -%\qualifier{caption}{: String_Type. LaTeX caption for the table. Default is +%\qualifier{caption}{String_Type. LaTeX caption for the table. Default is % blank. Don't include a label statement here - that's handled by the % "label" qualifier below.} -%\qualifier{label}{: String_Type. LaTeX label for the table. Default is +%\qualifier{label}{String_Type. LaTeX label for the table. Default is % "placeholder," so make sure to set this.} -%\qualifier{nodata}{: String_Type, set to what should be printed if there is no +%\qualifier{nodata}{String_Type, set to what should be printed if there is no % data for a particular field (e.g., if you are putting multiple models % into the same table and they do not share the same parameters).} -%\qualifier{frozendelim}{: String_Type[], two-element string array containing +%\qualifier{frozendelim}{String_Type[], two-element string array containing % opening and closing delimiters for a frozen value. By default this is % ["(",")"], i.e., the frozen value is surrounded by parentheses.} -%\qualifier{star}{: Integer_Type. If nonzero, the table will be a table* or +%\qualifier{star}{Integer_Type. If nonzero, the table will be a table* or % deluxetable*. If 0, the table will be a table or deluxetable.} -%\qualifier{tabletypesize}{: String_Type. Sets the font size of the table. +%\qualifier{tabletypesize}{String_Type. Sets the font size of the table. % Should be a LaTeX font size without the backslash. Default is % "footnotesize".} -%\qualifier{longtable}{: Integer_Type. If nonzero (and we're making a +%\qualifier{longtable}{Integer_Type. If nonzero (and we're making a % deluxetable), this is a long table, so a startlongtable statement will % be included in the table header. I don't think tabular tables do % anything with this right now. Default 0.} -%\qualifier{landscape}{: Integer_Type. If nonzero, this is a -% landscape-orientation table. Includes a \\rotate command if +%\qualifier{landscape}{Integer_Type. If nonzero, this is a +% landscape-orientation table. Includes a \\\\rotate command if % deluxetable, or wraps everything in a begin/end landscape block if % tabular. Default 0.} -%\qualifier{notes}{: List_Type[2]. Element 0 should be a String_Type[] array of +%\qualifier{notes}{List_Type[2]. Element 0 should be a String_Type[] array of % the text of any footnotes; element 1 should be a String_Type[] array of % the symbols associated with those notes.} %} diff --git a/src/plot/BoundingBox.sl b/src/plot/BoundingBox.sl index d9b875268702e27471f13b17ec67f261c7634a7d..b273ceb9fd6d302b6c2259e164c10676dd7d38ee 100644 --- a/src/plot/BoundingBox.sl +++ b/src/plot/BoundingBox.sl @@ -10,8 +10,8 @@ define BoundingBox() % of the form \code{"%%BoundingBox: x1 y1 x2 y2"}. % \code{x1, y1, x2, y2} are \code{NULL} if no such line is found. %\qualifiers{ -%\qualifier{first}{: Take the first matching %%BoundingBox line instead of the last.} -%\qualifier{size}{: If this qualifier is set, \code{w = x2-x1} and \code{h = y2-y1} are returned.} +%\qualifier{first}{Take the first matching %%BoundingBox line instead of the last.} +%\qualifier{size}{If this qualifier is set, \code{w = x2-x1} and \code{h = y2-y1} are returned.} %} %!%- { diff --git a/src/plot/array2image.sl b/src/plot/array2image.sl index ad0be6e1bacf34422eed07a538a9aeb75d20d475..b5b75feb632c2b934653e767d515a2005964f9b3 100644 --- a/src/plot/array2image.sl +++ b/src/plot/array2image.sl @@ -40,21 +40,18 @@ define array2image() %\synopsis{Converts three x, y, z arrays into a 2D array} %\usage{image[,] = array2image(x,y,z)} %\qualifiers{ -%\qualifier{nbinx}{: number of bins along x-axis} -%\qualifier{nbiny}{: number of bins along y-axis} -%\qualifier{xgrid}{: 1D array containing grid of values for x-axis. Ignores nbinx.} -%\qualifier{ygrid}{: 1D array containing grid of values for y-axis. Ignores nbiny.} -%\qualifier{func}{: reference to a single-parameter S-Lang function used to determine pixel values from z-values (see below).} -%\qualifier{func_quals}{: struct containing additional qualifiers to be passed to the function defined in func} -%\qualifier{include_inf}{: include points where x, y, or z are inf or -inf} -%\qualifier{include_nan}{: include points where x, y, or z are NaN (not a number)} +%\qualifier{nbinx}{number of bins along x-axis} +%\qualifier{nbiny}{number of bins along y-axis} +%\qualifier{xgrid}{1D array containing grid of values for x-axis. Ignores nbinx.} +%\qualifier{ygrid}{1D array containing grid of values for y-axis. Ignores nbiny.} +%\qualifier{func}{reference to a single-parameter S-Lang function used to determine pixel values from z-values (see below).} +%\qualifier{func_quals}{struct containing additional qualifiers to be passed to the function defined in func} +%\qualifier{include_inf}{include points where x, y, or z are inf or -inf} +%\qualifier{include_nan}{Note that this means the returned 2D array is of the form +% im[y,x]. By default this ignores any points with infinite or NaN values +% (this can be turned off with the include_inf and include_nan switches).} %} %\description -% Rebins x, y, and z arrays to produce a 2D image suitable for plotting with -% plot_image(). Note that this means the returned 2D array is of the form -% im[y,x]. By default this ignores any points with infinite or NaN values -% (this can be turned off with the include_inf and include_nan switches). -% % The x-y grid is determined automatically from the ranges of the data, or % can be defined by the "xgrid" and "ygrid" qualifiers. If "xgrid" or "ygrid" % is a reference to a local variable, the automatically-determined grids will diff --git a/src/plot/distribution_matrix.sl b/src/plot/distribution_matrix.sl index 79020e4cb206f47a43811859cacc99893615fecf..3a9b5aec7ed3baa72d3bd0b3db81b0f3569c92b8 100644 --- a/src/plot/distribution_matrix.sl +++ b/src/plot/distribution_matrix.sl @@ -10,8 +10,8 @@ define hist1d_confidence (lo, hi, h) %\synopsis{Find the confidence interval for histogram} %\usage{(Min,Max) = hist1d_confidence(lo, hi, hist);} %\qualifiers{ -%\qualifier{conf}{[=0.9]: confidence limit (between 0 and 1)} -%\qualifier{index}{: if given, return the indices of lo and hi bin} +%\qualifier{conf}{[=0.9] confidence limit (between 0 and 1)} +%\qualifier{index}{if given, return the indices of lo and hi bin} %} %\description % Find the bin boundary values such that they enclose the smallest volume @@ -174,11 +174,11 @@ define distribution_matrix (distribution_points) %\usage{Struct_Type dm = distribution_matrix(Array_Type/List_Type v); %\altusage{dm = distribution_matrix(Struct_Type v);}} %\qualifiers{ -%\qualifier{gridX}{: histogram grid for dimension X where X starts counting at 0} -%\qualifier{gridXmin}{[=min(vX)]: bottom boundary for dimension X grid} -%\qualifier{gridXmax}{[=max(vX)]: top boundary for dimension X grid} -%\qualifier{n}{: number of grid points (only relevant for min/max)} -%\qualifier{fields}{: Use only struct fields given in this name array (only +%\qualifier{gridX}{histogram grid for dimension X where X starts counting at 0} +%\qualifier{gridXmin}{[=min(vX)] bottom boundary for dimension X grid} +%\qualifier{gridXmax}{[=max(vX)] top boundary for dimension X grid} +%\qualifier{n}{number of grid points (only relevant for min/max)} +%\qualifier{fields}{Use only struct fields given in this name array (only % relevant if input is a struct)} %} %\description diff --git a/src/plot/draw_plot_commands.sl b/src/plot/draw_plot_commands.sl index addce6f629e5b0abff7f7b37690e88b75a28e952..56531bfb0f744e84b6e174d8b7b6736ce27a8923 100644 --- a/src/plot/draw_plot_commands.sl +++ b/src/plot/draw_plot_commands.sl @@ -6,7 +6,7 @@ define draw_plot_commands() %\synopsis{creates plot commands for drawing lines with the mouse} %\usage{draw_plot_commands();} %\qualifiers{ -%\qualifier{init}{ [\code{=1}]: initializes plot window at the beginning} +%\qualifier{init}{[\code{=1}] initializes plot window at the beginning} %} %!%- { diff --git a/src/plot/err_map_gaussian.sl b/src/plot/err_map_gaussian.sl index 0a6449ba17e820a24a56a2be93a3aed757920264..26bd3db8308f3c232916ca652ccc957ba9eafb75 100644 --- a/src/plot/err_map_gaussian.sl +++ b/src/plot/err_map_gaussian.sl @@ -6,21 +6,21 @@ define err_map_gaussian () %\altusage{err_map_gaussian(Struct_Type s);} %} %\qualifiers{ -%\qualifier{xerr}{: change 3-argument-syntax to \code{err_map_gaussian(x, xErr, y);}} -%\qualifier{xminmax}{: changes the meaning of \code{xErr} -- and \code{x}, if \code{xErr} is not a list} -%\qualifier{yminmax}{: changes the meaning of \code{yErr} -- and \code{y}, if \code{yErr} is not a list} -%\qualifier{minmax}{: equivalent to both \code{x}- and \code{yminmax}} -%\qualifier{x_pixel [=400]}{: number of x-axis bins of the image} -%\qualifier{y_pixel [=400]}{: number of y-axis bins of the image} -%\qualifier{i}{: index-array of subset of data points to be plotted} -%\qualifier{xmin [=min(x data)]}{: minimal value of x-axis} -%\qualifier{xmax [=max(x data)]}{: maximal value of x-axis} -%\qualifier{ymin [=min(y data)]}{: minimal value of y-axis} -%\qualifier{ymax [=max(y data)]}{: maximal value of y-axis} -%\qualifier{min_xerr [=1e-10]}{: minimal error for x-values} -%\qualifier{min_yerr [=1e-10]}{: minimal error for y-values} -%\qualifier{xlog}{: switch to logarithmic x-axis} -%\qualifier{ylog}{: switch to logarithmic y-axis} +%\qualifier{xerr}{ change 3-argument-syntax to \code{err_map_gaussian(x, xErr, y);}} +%\qualifier{xminmax}{ changes the meaning of \code{xErr} -- and \code{x}, if \code{xErr} is not a list} +%\qualifier{yminmax}{ changes the meaning of \code{yErr} -- and \code{y}, if \code{yErr} is not a list} +%\qualifier{minmax}{ equivalent to both \code{x}- and \code{yminmax}} +%\qualifier{x_pixel [=400]}{ number of x-axis bins of the image} +%\qualifier{y_pixel [=400]}{ number of y-axis bins of the image} +%\qualifier{i}{ index-array of subset of data points to be plotted} +%\qualifier{xmin [=min(x data)]}{minimal value of x-axis} +%\qualifier{xmax [=max(x data)]}{maximal value of x-axis} +%\qualifier{ymin [=min(y data)]}{minimal value of y-axis} +%\qualifier{ymax [=max(y data)]}{maximal value of y-axis} +%\qualifier{min_xerr [=1e-10]}{ minimal error for x-values} +%\qualifier{min_yerr [=1e-10]}{ minimal error for y-values} +%\qualifier{xlog}{ switch to logarithmic x-axis} +%\qualifier{ylog}{ switch to logarithmic y-axis} %} %\description % Plots a 2D gaussian for each data point. The given errors are used as the diff --git a/src/plot/fplot.sl b/src/plot/fplot.sl index 099f24abdf2ec0d52ec3ec82256bed1e7343190f..2282d8490836e1d077e2654d136bc1d4641fb9d9 100644 --- a/src/plot/fplot.sl +++ b/src/plot/fplot.sl @@ -5,17 +5,17 @@ define fplot() { %\synopsis{plots data and residuals from the fits-files created with 'save_plot'} %\usage{fplot(filename, [color, [dataset]]);} %\qualifiers{ -%\qualifier{flux}{: plot flux [photons/s/cm^2/keV] and not [counts/bin]} -%\qualifier{overplot}{: Overplot previous plot} -%\qualifier{type}{: defines what should be plotted. It can have the values 'model', 'data', 'res' (residuals), +%\qualifier{flux}{plot flux [photons/s/cm^2/keV] and not [counts/bin]} +%\qualifier{overplot}{Overplot previous plot} +%\qualifier{type}{defines what should be plotted. It can have the values 'model', 'data', 'res' (residuals), % 'ratio', 'diff' (difference between model an data. By default model and data is plotted.)} -%\qualifier{nolabel}{: The routine uses the labels given in 'plot_options' and does not create its own. } -%\qualifier{space}{: If at the qualifer 'type' data, model or diff is chosen, one can specifiy if it is +%\qualifier{nolabel}{The routine uses the labels given in 'plot_options' and does not create its own. } +%\qualifier{space}{If at the qualifer 'type' data, model or diff is chosen, one can specifiy if it is % plotted in counts/bin (by default), counts/keV/s ('density') or photons/keV/s/cm^2 ('flux').} -%\qualifier{auto}{: Set the ranges automatically.} -%\qualifier{xauto}{: Set the x-range automatically.} -%\qualifier{yauto}{: Set the y-range automatically.} -%\qualifier{unit}{: Specifies the unit of the x-axis. By default the unit from the fitstable is taken. +%\qualifier{auto}{Set the ranges automatically.} +%\qualifier{xauto}{Set the x-range automatically.} +%\qualifier{yauto}{Set the y-range automatically.} +%\qualifier{unit}{Specifies the unit of the x-axis. By default the unit from the fitstable is taken. % Possible values are 'keV' or Angstrom 'A'.} %} %\description diff --git a/src/plot/get_contour_lines.sl b/src/plot/get_contour_lines.sl index abc154f15621bcab9db17b0e349bc6a486830869..0909d8532a3b62f345b0947638c5a34c6872b66a 100644 --- a/src/plot/get_contour_lines.sl +++ b/src/plot/get_contour_lines.sl @@ -4,7 +4,7 @@ define get_contour_lines() %\synopsis{finds a set of contour lines for a 2d-array of values} %\usage{Struct_Type l[] = get_contour_lines(Double_Type f[], Double_Type f0);} %\qualifiers{ -%\qualifier{save}{: filename of a FITS file to save contours} +%\qualifier{save}{filename of a FITS file to save contours} %} %\description % \code{f} has to be a two-dimensional array (an image). diff --git a/src/plot/get_sron_colors.sl b/src/plot/get_sron_colors.sl index fc17203be0df38e4efbbbf6e0c811883829226c4..51e82bec98f63736667adb6f49d57b188decc3d9 100644 --- a/src/plot/get_sron_colors.sl +++ b/src/plot/get_sron_colors.sl @@ -47,9 +47,9 @@ define get_sron_colors() % "cont"). % %\qualifiers{ -%\qualifier{type}{: =String_Type select color scheme ("qualitative" (default),"diverging", or "rainbow"} -%\qualifier{names}{: (Boolean) return color names in structure for qualitative color scheme} -%\qualifier{cont}{: (Boolean) change meaning of argument to value between 0 and 1, return corresponding color} +%\qualifier{type}{=String_Type select color scheme ("qualitative" (default),"diverging", or "rainbow"} +%\qualifier{names}{(Boolean) return color names in structure for qualitative color scheme} +%\qualifier{cont}{(Boolean) change meaning of argument to value between 0 and 1, return corresponding color} %} %!%- { diff --git a/src/plot/hplot_filled.sl b/src/plot/hplot_filled.sl index 360b166d4dc05a3e5b8a76630cb1ad6f8be2b9b9..73dc69bffb3e1bb077bfde3028dbcb1777aeb690 100644 --- a/src/plot/hplot_filled.sl +++ b/src/plot/hplot_filled.sl @@ -5,18 +5,18 @@ define hplot_filled(lo,hi,val) %\usage{hplot_filled(Array_Type bin_lo, Array_Type bin_hi, Array_Type values) %} %\qualifiers{ -%\qualifier{fill_style}{ [\code{=1}]: set the fill style:\n +%\qualifier{fill_style}{[\code{=1}] set the fill style:\n % \code{FS = 1} \code{=>} solid (default)\n % \code{FS = 2} \code{=>} outline\n % \code{FS = 3} \code{=>} hatched (cannot be used with ylog;)\n % \code{FS = 4} \code{=>} cross-hatched (cannot be used with ylog;)\n %} -%\qualifier{ticks}{ [\code{=""}]: set to \code{"I"} or \code{"P"} to invert or project the ticks +%\qualifier{ticks}{[\code{=""}] set to \code{"I"} or \code{"P"} to invert or project the ticks % of both axis (additional to initial plot options)} -%\qualifier{xopt}{ [\code{=get_plot_options.xopt}]: set the plot options of the x-axis directly} -%\qualifier{yopt}{ [\code{=get_plot_options.yopt}]: set the plot options of the y-axis directly} -%\qualifier{ymin}{ [\code{=min(values)}]: set the lower y-value to which the areas are filled} -%\qualifier{angle}{ [\code{=degrees}]: sets the angle of the hatched lines for FS=3 [default = 45] } +%\qualifier{xopt}{[\code{=get_plot_options.xopt}] set the plot options of the x-axis directly} +%\qualifier{yopt}{[\code{=get_plot_options.yopt}] set the plot options of the y-axis directly} +%\qualifier{ymin}{[\code{=min(values)}] set the lower y-value to which the areas are filled} +%\qualifier{angle}{[\code{=degrees}] sets the angle of the hatched lines for FS=3 [default = 45] } %} %\description % This function plots a histogram described by three 1-D S-Lang arrays of size N. diff --git a/src/plot/ohplot_filled.sl b/src/plot/ohplot_filled.sl index af6b4456112132dae026563da22e739c49ba3aef..b40c4552f1b19f7d7e305c388dc2154933633c1f 100644 --- a/src/plot/ohplot_filled.sl +++ b/src/plot/ohplot_filled.sl @@ -7,13 +7,13 @@ define ohplot_filled(lo,hi,val) %\usage{ohplot_filled(Array_Type bin_lo, Array_Type bin_hi, Array_Type values) %} %\qualifiers{ -%\qualifier{fill_style}{ [\code{=1}]: set the fill style:\n +%\qualifier{fill_style}{[\code{=1}] set the fill style:\n % \code{FS = 1} \code{=>} solid (default)\n % \code{FS = 2} \code{=>} outline\n % \code{FS = 3} \code{=>} hatched (cannot be used with ylog;)\n % \code{FS = 4} \code{=>} cross-hatched (cannot be used with ylog;)\n} -%\qualifier{ymin}{ [\code{=min(values)}]: set the lower y-value to which the areas are filled} -%\qualifier{angle}{ [\code{=degrees}]: sets the angle of the hatched lines for FS=3 [default = 45] } +%\qualifier{ymin}{[\code{=min(values)}] set the lower y-value to which the areas are filled} +%\qualifier{angle}{[\code{=degrees}] sets the angle of the hatched lines for FS=3 [default = 45] } %} %\description % This function overplots a histogram described by three 1-D S-Lang arrays of size N. diff --git a/src/plot/open_plot_ps2eps.sl b/src/plot/open_plot_ps2eps.sl index fb8d912e8c86b86071db64d5de235e6f8c0884d4..f5c721e8d01d6f68d17935be1be0295d92f0937d 100644 --- a/src/plot/open_plot_ps2eps.sl +++ b/src/plot/open_plot_ps2eps.sl @@ -13,12 +13,12 @@ define open_plot_ps2eps() % a \code{.ps} file with \code{/}[\code{v}][\code{c}]\code{ps} specification. %\qualifiers{ %\qualifier{ps2epsopt}{ [="-R=+ -B -f"]: option for ps2eps} -%\qualifier{noremoveps}{: the .ps file will not be removed after conversion} -%\qualifier{pre_enlargeBB}{: enlarge bounding box by specified value [=1, if none specified] before ps2eps} -%\qualifier{pre_run_cmd=cmd}{: command to run before ps2eps. +%\qualifier{noremoveps}{the .ps file will not be removed after conversion} +%\qualifier{pre_enlargeBB}{enlarge bounding box by specified value [=1, if none specified] before ps2eps} +%\qualifier{pre_run_cmd=cmd}{command to run before ps2eps. % The ps-file is passed to \code{cmd} as an argument. % \code{cmd} is expected to write the modified ps file to \code{stdout}.} -%\qualifier{enlargeBB}{: enlarge bounding box by specified value [=1, if none specified] after ps2eps} +%\qualifier{enlargeBB}{enlarge bounding box by specified value [=1, if none specified] after ps2eps} %} %\seealso{open_plot, close_plot_ps2eps} %!%- diff --git a/src/plot/oplot_contour_lines.sl b/src/plot/oplot_contour_lines.sl index 783a7d4be1fdddc993000b9a41c58e2e12a19fcf..f51cd4c0719afb30330e908270aeea840b7fa859 100644 --- a/src/plot/oplot_contour_lines.sl +++ b/src/plot/oplot_contour_lines.sl @@ -7,7 +7,7 @@ define oplot_contour_lines() %\usage{oplot_contour_lines(f, f0[, X, Y]);} %\qualifiers{ %\qualifier{save}{=filename: saves/restores the contour lines in a FITS file} -%\qualifier{pgplot}{: uses \code{_pgline} instead of \code{oplot}} +%\qualifier{pgplot}{uses \code{_pgline} instead of \code{oplot}} %} %\description % \code{f} has to be a two-dimensional array (an image). diff --git a/src/plot/oplot_xline.sl b/src/plot/oplot_xline.sl index 2a00412c6eac0eefddc18d1c8e74e88042366ce5..de8b806fc146098b8bc18fcdf1e2ae8b598617f4 100644 --- a/src/plot/oplot_xline.sl +++ b/src/plot/oplot_xline.sl @@ -4,9 +4,9 @@ define oplot_xline() %\synopsis{overplots one or more vertical line(s)} %\usage{oplot_xline(Double_Type x1[, x2, ...]);} %\qualifiers{ -%\qualifier{ymin}{ [=]} -%\qualifier{ymax}{ [=]} -%\qualifier{color}{: number of the color to use} +%\qualifier{ymin}{[=]} +%\qualifier{ymax}{[=]} +%\qualifier{color}{number of the color to use} %} %\description % For each \code{x} of \code{x1}[, \code{x2}, ...] (which may be arrays, too), diff --git a/src/plot/oplot_yline.sl b/src/plot/oplot_yline.sl index 071cde7fd2cc6150310d6c9f5ae17dc74e515413..46fea87c487c1dbdb25ec8c3943807b24c078de7 100644 --- a/src/plot/oplot_yline.sl +++ b/src/plot/oplot_yline.sl @@ -6,9 +6,9 @@ define oplot_yline() %\synopsis{overplots one or more horizontal line(s)} %\usage{oplot_yline(Double_Type y1[, y2, ...]);} %\qualifiers{ -%\qualifier{xmin}{ [=]} -%\qualifier{xmax}{ [=]} -%\qualifier{color}{: number of the color to use} +%\qualifier{xmin}{[=]} +%\qualifier{xmax}{[=]} +%\qualifier{color}{number of the color to use} %} %\description % For each \code{y} of \code{y1}[, \code{y2}, ...] (which may be arrays, too), diff --git a/src/plot/plotGTI.sl b/src/plot/plotGTI.sl index 6144c5bd20c66276d36feeea45d9cb887ac980c5..da5c57e02bc288e8ce811350945c22e310011f46 100644 --- a/src/plot/plotGTI.sl +++ b/src/plot/plotGTI.sl @@ -4,7 +4,7 @@ define plotGTI() %\synopsis{visualizes Good Time Intervals} %\usage{plotGTI(Struct_Type gti[, Double_Type offset]);} %\qualifiers{ -%\qualifier{ylevel}{: plot GTIs at constant y-level} +%\qualifier{ylevel}{plot GTIs at constant y-level} %\qualifier{overplot}{} %} %!%- diff --git a/src/plot/plot_contour_trq.sl b/src/plot/plot_contour_trq.sl index 01b81ea13101c9f10509c511f435f706af9a3854..6eea0599425319acb31258869b172fa6cb016167 100644 --- a/src/plot/plot_contour_trq.sl +++ b/src/plot/plot_contour_trq.sl @@ -6,10 +6,10 @@ define plot_contour_trq(){ % contour_trq.} %\usage{plot_contour_trq(String_Type inputDir);} %\qualifiers{ -%\qualifier{out}{: post script outputname} -%\qualifier{image}{: fits image outputname} -%\qualifier{x}{: x label} -%\qualifier{y}{: y label} +%\qualifier{out}{ post script outputname} +%\qualifier{image}{ fits image outputname} +%\qualifier{x}{ x label} +%\qualifier{y}{ y label} %} %\description % - \code{inputDir} directory where all torque job files are, diff --git a/src/plot/plot_table_columns.sl b/src/plot/plot_table_columns.sl index da0813b8773b20bc4d9331ec0931bbc7a39fc418..e1b5b7ea6eb95fb67e70925b10ad5cfae346db2e 100644 --- a/src/plot/plot_table_columns.sl +++ b/src/plot/plot_table_columns.sl @@ -4,10 +4,10 @@ define plot_table_columns() %\synopsis{plots columns of a table against each other} %\usage{plot_table_columns(Struct_Type table);} %\qualifiers{ -%\qualifier{x}{: array of columns to be used for the x-axis [default: all columns]} -%\qualifier{y}{: array of columns to be used for the y-axis [default: all columns]} -%\qualifier{path}{: path to save the postscript plots} -%\qualifier{multiplot}{: produce one single multiplot (does not call open_plot)} +%\qualifier{x}{array of columns to be used for the x-axis [default: all columns]} +%\qualifier{y}{array of columns to be used for the y-axis [default: all columns]} +%\qualifier{path}{path to save the postscript plots} +%\qualifier{multiplot}{produce one single multiplot (does not call open_plot)} %} %!%- { diff --git a/src/plot/plot_with_err.sl b/src/plot/plot_with_err.sl index 10311832e7e43066f5645790d1d61f5f1c41afe2..dc41c4bfdabcb1f54cd44b7c78612073f18da266 100644 --- a/src/plot/plot_with_err.sl +++ b/src/plot/plot_with_err.sl @@ -6,20 +6,20 @@ define plot_with_err() %\altusage{plot_with_err(Struct_Type s);} %} %\qualifiers{ -%\qualifier{xerr}{: change 3-argument-syntax to \code{plot_with_err(x, xErr, y);}} -%\qualifier{xminmax}{: changes the meaning of \code{xErr} -- and \code{x}, if \code{xErr} is not a list} -%\qualifier{yminmax}{: changes the meaning of \code{yErr} -- and \code{y}, if \code{yErr} is not a list} -%\qualifier{minmax}{: equivalent to both \code{x}- and \code{yminmax}} -%\qualifier{i}{: index-array of subset of data points to be plotted} +%\qualifier{xerr}{change 3-argument-syntax to \code{plot_with_err(x, xErr, y);}} +%\qualifier{xminmax}{changes the meaning of \code{xErr} -- and \code{x}, if \code{xErr} is not a list} +%\qualifier{yminmax}{changes the meaning of \code{yErr} -- and \code{y}, if \code{yErr} is not a list} +%\qualifier{minmax}{equivalent to both \code{x}- and \code{yminmax}} +%\qualifier{i}{index-array of subset of data points to be plotted} %\qualifier{set_xrange=frac}{ (default: 0.05): set the \code{xrange} from the lowest to highest x-value % with additional padding (given as a fraction fo the x-range) on both sides} %\qualifier{set_yrange=frac}{ (default: 0.05): set the \code{xrange} from the lowest to highest y-value % with additional padding (given as a fraction of the y-range) on both sides} -%\qualifier{set_ranges}{: equivalent to both \code{set_xrange} and \code{set_yrange}} -%\qualifier{overplot}{: The data will be overplotted.} -%\qualifier{connect_points}{: data points are also connected} -%\qualifier{histogram}{: draw histogram lines, too} -%\qualifier{error_color}{: draw error bars in a different color} +%\qualifier{set_ranges}{equivalent to both \code{set_xrange} and \code{set_yrange}} +%\qualifier{overplot}{The data will be overplotted.} +%\qualifier{connect_points}{data points are also connected} +%\qualifier{histogram}{draw histogram lines, too} +%\qualifier{error_color}{draw error bars in a different color} %} %\description % In order to use asymetric errors for x and/or y, diff --git a/src/plot/plot_with_y2axis.sl b/src/plot/plot_with_y2axis.sl index 2fa750647df01870820bb61026b6e4181215cff3..b3a79f08b1e7000599a091da277bf953c683c9c8 100644 --- a/src/plot/plot_with_y2axis.sl +++ b/src/plot/plot_with_y2axis.sl @@ -6,8 +6,8 @@ define plot_with_y2axis() %\synopsis{plot two functions with different y-axes} %\usage{plot_with_y2axis(x1, y1, [ x2,] y2);} %\qualifiers{ -%\qualifier{color}{: set the color of the 2nd y-axis [default: red]} -%\qualifier{yspace}{: space above and below the last data point in units of the total y-range.} +%\qualifier{color}{set the color of the 2nd y-axis [default: red]} +%\qualifier{yspace}{space above and below the last data point in units of the total y-range.} %} %\description % This function plots two different parameters y1 and y2, which depend diff --git a/src/plot/save_plot.sl b/src/plot/save_plot.sl index a2474c68ffe6ad9319d698948898ebe7eea41842..24fcdbc028934ea0acb6ac531cb636abf604bdb4 100644 --- a/src/plot/save_plot.sl +++ b/src/plot/save_plot.sl @@ -4,7 +4,7 @@ define save_plot() %\synopsis{saves ISIS spectral data into a FITS file} %\usage{save_plot([filename[, ids]]);} %\qualifiers{ -%\qualifier{A}{: Save the data in Angstrom and not in keV.} +%\qualifier{A}{Save the data in Angstrom and not in keV.} %} %\description % This functions saves all data and model points as currently diff --git a/src/plot/setPGPLOTenv.sl b/src/plot/setPGPLOTenv.sl index a3cdd0ae1460319e7d4c46c547be7e3a10f8e950..dc9aa4cc1999a9375202711ea1128c9a62efe9f2 100644 --- a/src/plot/setPGPLOTenv.sl +++ b/src/plot/setPGPLOTenv.sl @@ -6,7 +6,7 @@ define setPGPLOTenv() %\synopsis{sets environment variables used by PGPLOT} %\usage{setPGPLOTenv(Double_Type w, h[, hoff[, voff]]);} %\qualifiers{ -%\qualifier{gif}{: sets the PGPLOT_GIF enviroment variables} +%\qualifier{gif}{sets the PGPLOT_GIF enviroment variables} %} %\description % The environment variables for the PGPLOT postscript driver, diff --git a/src/plot/x1axis.sl b/src/plot/x1axis.sl index aaa89744a09d8984c44a733c5c9fc9630e63787b..e3e699725edc4a5ae4e0157a3c98f869aebf7f18 100644 --- a/src/plot/x1axis.sl +++ b/src/plot/x1axis.sl @@ -6,18 +6,18 @@ define x1axis() %\synopsis{(re)draws a first x-axis} %\usage{x1axis(Double_Type min_value, Double_Type max_value[, Double_Type step]);} %\qualifiers{ -%\qualifier{nsub}{ [=0]: number of minor tick marks within each major divison (nsub=0 => no minor ticks)} -%\qualifier{maji}{ [=0.5]: length of major tick marks, drawn inwards (in units of the character height)} -%\qualifier{majo}{ [=0]: length of major tick marks, drawn outwards (in units of the character height)} -%\qualifier{fmin}{ [=0.5]: length of minor tick marks (as fraction of the major tick marks)} -%\qualifier{disp}{ [=0.5]: displacement of baseline of tick labels to the axis (in units of the character height)} -%\qualifier{angle}{ [=0]: orientation of the text (in degrees)} -%\qualifier{color}{ [=1]: color of the axis} -%\qualifier{linewidth}{ [=1]: line width of the axis} -%\qualifier{opt}{ [="N"/"LN"]: pgaxis-options: "L" (log), "N" (numbers), "1" (force decimal), "2" (force EE)} -%\qualifier{yrel}{ [=0]: relative position of the x1axis (0=bottom, 1=top)} -%\qualifier{xmin}{ [=xmin]: absolute x-position of the axis} -%\qualifier{xmax}{ [=xmax]: absolute x-position of the axis} +%\qualifier{nsub}{[=0] number of minor tick marks within each major divison (nsub=0 => no minor ticks)} +%\qualifier{maji}{[=0.5] length of major tick marks, drawn inwards (in units of the character height)} +%\qualifier{majo}{[=0] length of major tick marks, drawn outwards (in units of the character height)} +%\qualifier{fmin}{[=0.5] length of minor tick marks (as fraction of the major tick marks)} +%\qualifier{disp}{[=0.5] displacement of baseline of tick labels to the axis (in units of the character height)} +%\qualifier{angle}{[=0] orientation of the text (in degrees)} +%\qualifier{color}{[=1] color of the axis} +%\qualifier{linewidth}{[=1] line width of the axis} +%\qualifier{opt}{[="N"/"LN"] pgaxis-options: "L" (log), "N" (numbers), "1" (force decimal), "2" (force EE)} +%\qualifier{yrel}{[=0] relative position of the x1axis (0=bottom, 1=top)} +%\qualifier{xmin}{[=xmin] absolute x-position of the axis} +%\qualifier{xmax}{[=xmax] absolute x-position of the axis} %} %\seealso{x2axis (and references therein)} %!%- diff --git a/src/plot/x2axis.sl b/src/plot/x2axis.sl index 2f170d52fac8ed4975ee9a14ac56021af93cb183..0065414c61b4760f97af68fa2e3af254e5e19340 100644 --- a/src/plot/x2axis.sl +++ b/src/plot/x2axis.sl @@ -6,18 +6,18 @@ define x2axis() %\synopsis{draws a second x-axis} %\usage{x2axis(Double_Type min_value, Double_Type max_value[, Double_Type step]);} %\qualifiers{ -%\qualifier{nsub}{ [=0]: number of minor tick marks within each major divison (nsub=0 => no minor ticks)} -%\qualifier{maji}{ [=0.5]: length of major tick marks, drawn inwards (in units of the character height)} -%\qualifier{majo}{ [=0]: length of major tick marks, drawn outwards (in units of the character height)} -%\qualifier{fmin}{ [=0.5]: length of minor tick marks (as fraction of the major tick marks)} -%\qualifier{disp}{ [=0.5]: displacement of baseline of tick labels to the axis (in units of the character height)} -%\qualifier{angle}{ [=0]: orientation of the text (in degrees)} -%\qualifier{color}{ [=1]: color of the axis} -%\qualifier{linewidth}{ [=1]: line width of the axis} -%\qualifier{opt}{ [="N"/"LN"]: pgaxis-options: "L" (log), "N" (numbers), "1" (force decimal), "2" (force EE)} -%\qualifier{yrel}{ [=1]: relative position of the x2axis (0=bottom, 1=top)} -%\qualifier{xmin}{ [=xmin]: absolute x-position of the axis} -%\qualifier{xmax}{ [=xmax]: absolute x-position of the axis} +%\qualifier{nsub}{[=0] number of minor tick marks within each major divison (nsub=0 => no minor ticks)} +%\qualifier{maji}{[=0.5] length of major tick marks, drawn inwards (in units of the character height)} +%\qualifier{majo}{[=0] length of major tick marks, drawn outwards (in units of the character height)} +%\qualifier{fmin}{[=0.5] length of minor tick marks (as fraction of the major tick marks)} +%\qualifier{disp}{[=0.5] displacement of baseline of tick labels to the axis (in units of the character height)} +%\qualifier{angle}{[=0] orientation of the text (in degrees)} +%\qualifier{color}{[=1] color of the axis} +%\qualifier{linewidth}{[=1] line width of the axis} +%\qualifier{opt}{[="N"/"LN"] pgaxis-options: "L" (log), "N" (numbers), "1" (force decimal), "2" (force EE)} +%\qualifier{yrel}{[=1] relative position of the x2axis (0=bottom, 1=top)} +%\qualifier{xmin}{[=xmin] absolute x-position of the axis} +%\qualifier{xmax}{[=xmax] absolute x-position of the axis} %} %\description % \code{x2axis} has to be called after the plot window is drawn. diff --git a/src/plot/x2label.sl b/src/plot/x2label.sl index e0cb63034cd8e8b60499278543badffd061eb2b8..4b2370ff5975c62c5dc29726d5c7c349ca50ae53 100644 --- a/src/plot/x2label.sl +++ b/src/plot/x2label.sl @@ -5,8 +5,8 @@ define x2label() %\synopsis{labels the second x-axis} %\usage{x2label(String_Type s);} %\qualifiers{ -%\qualifier{color}{ [=1]: textcolor} -%\qualifier{f}{ [=0.03]: fraction of the plot-area's height that the label is above} +%\qualifier{color}{[=1] textcolor} +%\qualifier{f}{[=0.03] fraction of the plot-area's height that the label is above} %} %\seealso{xylabel} %!%- diff --git a/src/plot/xfig_3d_orbit_on_cube.sl b/src/plot/xfig_3d_orbit_on_cube.sl index 4b35758d957d2925748b120a057348fb5983f93d..208a1df4c83c41bed14295e1f26cdd2de48ac6f0 100644 --- a/src/plot/xfig_3d_orbit_on_cube.sl +++ b/src/plot/xfig_3d_orbit_on_cube.sl @@ -48,18 +48,18 @@ define xfig_3d_orbit_on_cube() % field 'qualies' to the structure that decribes the orbit. The field 'qualies' is % again a structure whose fields are qualifiers of the function 'xfig_new_polyline'. %\qualifiers{ -%\qualifier{phi [=-45]}{: Azimuthal angle in the x-y-plane in degrees (-90 < phi < 0).} -%\qualifier{theta [=60]}{: Polar angle from the z-axis in degrees (0 < theta < 90).} -%\qualifier{dist [=1e6]}{: Distance of the eye from the focus.} -%\qualifier{scale [=4]}{: Factor to scale dimensions with respect to the character size (scale > 0).} -%\qualifier{x_label [="$x$\\,(kpc)"]}{: x-label.} -%\qualifier{y_label [="$y$\\,(kpc)"]}{: y-label.} -%\qualifier{z_label [="$z$\\,(kpc)"]}{: z-label.} -%\qualifier{digits [=1]}{: Digits for ticmarks (a non-negative integer).} -%\qualifier{cube}{: Modify the cube by providing a structure whose fields are qualifiers of the function 'xfig_new_polyline'.} -%\qualifier{grid}{: Modify the grid by providing a structure whose fields are qualifiers of the function 'xfig_new_polyline'.} -%\qualifier{center}{: Center the cube at (0,0,0).} -%\qualifier{z_adjust}{: Use separate scale for z-axis.} +%\qualifier{phi [=-45]}{Azimuthal angle in the x-y-plane in degrees (-90 < phi < 0).} +%\qualifier{theta [=60]}{Polar angle from the z-axis in degrees (0 < theta < 90).} +%\qualifier{dist [=1e6]}{Distance of the eye from the focus.} +%\qualifier{scale [=4]}{Factor to scale dimensions with respect to the character size (scale > 0).} +%\qualifier{x_label [="$x$\\,(kpc)"]}{x-label.} +%\qualifier{y_label [="$y$\\,(kpc)"]}{y-label.} +%\qualifier{z_label [="$z$\\,(kpc)"]}{z-label.} +%\qualifier{digits [=1]}{Digits for ticmarks (a non-negative integer).} +%\qualifier{cube}{Modify the cube by providing a structure whose fields are qualifiers of the function 'xfig_new_polyline'.} +%\qualifier{grid}{Modify the grid by providing a structure whose fields are qualifiers of the function 'xfig_new_polyline'.} +%\qualifier{center}{Center the cube at (0,0,0).} +%\qualifier{z_adjust}{Use separate scale for z-axis.} %} %\example % % basic example: diff --git a/src/plot/xfig_draw_orbit.sl b/src/plot/xfig_draw_orbit.sl index d36451d5161d8a845047615a8f8e9386ae41be4a..5885498d74b24609155a845f0da312d01a4fb7a0 100644 --- a/src/plot/xfig_draw_orbit.sl +++ b/src/plot/xfig_draw_orbit.sl @@ -8,28 +8,28 @@ define xfig_draw_orbit () %\usage{xfig_draw_orbit(Xfig_Object xf, Double_Type asini, i, ecc, omega, rstar) %} %\qualifiers{ -%\qualifier{line_color}{ [\code{="gray"}]: color of the lines showing the +%\qualifier{line_color}{[\code{="gray"}] color of the lines showing the % coordinate main axes and the orientation of the semi-major axis of % the orbit} -%\qualifier{phases}{ [\code{=\{\}}]: list of Double_Type[2] arrays indicating +%\qualifier{phases}{[\code{=\{\}}] list of Double_Type[2] arrays indicating % the phases which should be highlighted} -%\qualifier{scale}{ [\code{=1.05}]: compression/streching for the highlighted +%\qualifier{scale}{[\code{=1.05}] compression/streching for the highlighted % phases over/under the orbit} -%\qualifier{phase_color}{ [\code{="red"}]: color of the highlighted phases, +%\qualifier{phase_color}{[\code{="red"}] color of the highlighted phases, % can be a single string or an array of strings, with the same length % as phases so that every highlighted phase can be drawn in -% a different color. } -%\qualifier{phase_width}{ [\code{=2}]: width of the highlighted phases, can +% a different color.} +%\qualifier{phase_width}{[\code{=2}] width of the highlighted phases, can % also be an array, just as phase_color.} -%\qualifier{star_color}{ [\code{=lightblue}]: fill-color of the companion star} -%\qualifier{trueanom}{ : if set, phases are given in true anomaly, i.e., equal +%\qualifier{star_color}{[\code{=lightblue}] fill-color of the companion star} +%\qualifier{trueanom}{if set, phases are given in true anomaly, i.e., equal % delta-phi values will correspond to equal delta-t on the % orbit.} -%\qualifier{zerolines}{ [\code{=1}]: plot x- and y-axis lines through [0,0]} -%\qualifier{phaselines}{ : draw a lightgray line every phase n*0.1 and label it} -%\qualifier{label_phase_switch}{ [\code{=0}] : phase at witch phase labels +%\qualifier{zerolines}{[\code{=1}] plot x- and y-axis lines through [0,0]} +%\qualifier{phaselines}{draw a lightgray line every phase n*0.1 and label it} +%\qualifier{label_phase_switch}{[\code{=0}] : phase at witch phase labels % are switched from before the line to after the line.} -%\qualifier{label_pos}{ [\code{=0.85}] : distance of the phase labels from the +%\qualifier{label_pos}{[\code{=0.85}] distance of the phase labels from the % orbit line, in fraction of distance to center.} %\qualifier{nolabel} { : removes the coordinate system } %} @@ -70,28 +70,27 @@ variable xfgx, asini, i, ecc, omega, rstar ; { help(_function_name()); return; } xfgx.axis(;off) ; -variable c= 2.998e8 ; %speed of light in cm/s -variable rsun=1.3914e9/2. ; %solar radius in cm + variable c= 2.998e8 ; %speed of light in cm/s + variable rsun=1.3914e9/2. ; %solar radius in cm -% orbit parameters of GX 301-2 according to Koh et al (1997). -i = i /360.*2*PI ; % degree to rad + i = i*PI/180.; % degree to rad - variable a = asini/sin(i) ; + variable a = asini/sin(i) ; - variable b = sqrt( a^2 * (1-ecc^2) ); % semi-minor axis, lt-sec -omega = omega / 360. * 2 * PI ; + variable b = sqrt( a^2 * (1.-ecc)*(1.+ecc) ); % semi-minor axis, lt-sec + omega = omega*PI/180.; -rstar = rstar*rsun/c ; % solar radii in lt-sec + rstar = rstar*rsun/c ; % solar radii in lt-sec -variable scal = qualifier("scale",1.05) ; -variable lcol = qualifier("line_color","gray") ; + variable scal = qualifier("scale",1.05) ; + variable lcol = qualifier("line_color","gray") ; -variable phases = qualifier("phases", {}) ; -variable ph ; -variable phcol = [qualifier("phase_color", "red")] ; -variable phwid = [qualifier("phase_width", 2)] ; + variable phases = qualifier("phases", {}) ; + variable ph ; + variable phcol = [qualifier("phase_color", "red")] ; + variable phwid = [qualifier("phase_width", 2)] ; - if (length(phcol)==1) + if (length(phcol)==1) {phcol = phcol[Integer_Type[length(phases)]];} if (length(phwid)==1) {phwid = phwid[Integer_Type[length(phases)]];} diff --git a/src/plot/xfig_multibox.sl b/src/plot/xfig_multibox.sl index e3c14f612c4cf70f366e875775e701d8491af522..32bcfe32cbb6d53b9007b356296de431f227c607 100644 --- a/src/plot/xfig_multibox.sl +++ b/src/plot/xfig_multibox.sl @@ -6,7 +6,7 @@ define xfig_multibox() %\synopsis{combines M x N xfig-objects in one box} %\usage{pl = xfig_multibox(XFig_Plot_Type pl[M,N] [, Double_Type spacing])} %\qualifiers{ -%\qualifier{rotate}{: switch the meaning of M and N} +%\qualifier{rotate}{switch the meaning of M and N} %} %\seealso{xfig_new_vbox_compound, xfig_new_hbox_compound} %!%- diff --git a/src/plot/xfig_plot_conf.sl b/src/plot/xfig_plot_conf.sl index f2877f7d878f3d61f0d81bf7a1da682cc7b3277e..7df6994f8897ae2b30e6878c59a3d7c9d65b5c47 100644 --- a/src/plot/xfig_plot_conf.sl +++ b/src/plot/xfig_plot_conf.sl @@ -8,22 +8,22 @@ define xfig_plot_conf() %\synopsis{plots contour levels stored with save_conf} %\usage{XFig_Plot_Type pl = xfig_plot_conf(String_Type file[, XFig_Plot_Type pl])} %\qualifiers{ -%\qualifier{lvls}{: specify the Delta chi-sqr values for the contour levels, +%\qualifier{lvls}{specify the Delta chi-sqr values for the contour levels, % default: [2.30, 4.61, 9.21], i.e., 1 sigma, 90% and 99% CL} -%\qualifier{color}{: specify the colors of the contour lines +%\qualifier{color}{specify the colors of the contour lines % The array's last value is used for the best fit's cross (if % length of array > number of levels).} -%\qualifier{line}{ [=0]: specify the line styles of the contour lines} -%\qualifier{width}{ [=1]: specify the width of the contour lines +%\qualifier{line}{[=0] specify the line styles of the contour lines} +%\qualifier{width}{[=1] specify the width of the contour lines % The array's last value is used for the best fit's cross.} -%\qualifier{smooth}{ [=1]: this integer>=1 specifies the interpolation factor +%\qualifier{smooth}{[=1] this integer>=1 specifies the interpolation factor % for the image used to calculate the contours} -%\qualifier{W}{: width of the plot if created by \code{xfig_plot_contours}} -%\qualifier{H}{: height of the plot if created by \code{xfig_plot_contours}} -%\qualifier{worldXY}{: any world qualifier to the xfig-plot will be passed, +%\qualifier{W}{width of the plot if created by \code{xfig_plot_contours}} +%\qualifier{H}{height of the plot if created by \code{xfig_plot_contours}} +%\qualifier{worldXY}{any world qualifier to the xfig-plot will be passed, % which requires an existing SLxfig plot object to be given} -%\qualifier{transpose}{: transposes the countour map (exchange x- and y-values)} -%\qualifier{nocross}{: do not plot best fit cross} +%\qualifier{transpose}{transposes the countour map (exchange x- and y-values)} +%\qualifier{nocross}{do not plot best fit cross} %} %\description % If no SLxfig plot object \code{pl} is given, a new one is created diff --git a/src/plot/xfig_plot_confmap.sl b/src/plot/xfig_plot_confmap.sl index 4171cf53a7c38996bdc49e9eb282b5c1d9df4184..f2c08ec598eea62facdb66126c0c80b6b95cb30f 100644 --- a/src/plot/xfig_plot_confmap.sl +++ b/src/plot/xfig_plot_confmap.sl @@ -13,28 +13,28 @@ define xfig_plot_confmap() %{{{ % Create an xfig plot from a pre-calculated confidence map `cm' computed and saved with % the function `get_confmap'. %\qualifiers{ -%\qualifier{best_fit}{: Mark the best fit with a cross.} -%\qualifier{CDF}{: If set to a positive integer, the chi^2 values are converted to a cumulative +%\qualifier{best_fit}{Mark the best fit with a cross.} +%\qualifier{CDF}{If set to a positive integer, the chi^2 values are converted to a cumulative % distribution function with the degree of freedom given by this qualifier. For % instance, CDF=1 implies that chi^2 values of 1, 2.71, and 6.63 are converted % to 0.68, 0.9, and 0.99 (this qualifier requires the gsl-module).} -%\qualifier{colormap [="haxby"]}{: Choose, e.g., "ds9sls", "seis", "rainbow", "haxby", "topo", +%\qualifier{colormap [="haxby"]}{Choose, e.g., "ds9sls", "seis", "rainbow", "haxby", "topo", % "globe" (see the function `png_get_colormap' for more information).} -%\qualifier{colormap_gmin, colormap_gmax}{: Minimum and maximum grayscale value for the colormap, +%\qualifier{colormap_gmin, colormap_gmax}{Minimum and maximum grayscale value for the colormap, % see `png_gray_to_rgb'.} -%\qualifier{chi2 [=Double_Type[0]]}{: Chi^2 values for which contour lines should be drawn (this +%\qualifier{chi2 [=Double_Type[0]]}{Chi^2 values for which contour lines should be drawn (this % qualifier requires the gcontour-module).} -%\qualifier{chi2_color [="magenta"]}{: Color of the contour lines and the best fit cross.} -%\qualifier{factor [=1]}{: Factor by which the x- and y-sampling of the confidence map is increased.} -%\qualifier{field [="chisqr"]}{: Which field of the confidence map shall be plotted.} -%\qualifier{width [=8], height [=8]}{: Width and height of the confidence map.} -%\qualifier{latex_package [="txfonts"]}{: Load a package in the preamble of LaTeX documents.} -%\qualifier{reverse_axes}{: If present, both axes are reversed.} -%\qualifier{[xyz]label}{: Add a x-, y-, or z-label to the confidence map.} -%\qualifier{[xyz]axis [=struct{ticlabels_confine=0, ticlabels2=0}]}{: Modify the x-, y-, or z-axis +%\qualifier{chi2_color [="magenta"]}{Color of the contour lines and the best fit cross.} +%\qualifier{factor [=1]}{Factor by which the x- and y-sampling of the confidence map is increased.} +%\qualifier{field [="chisqr"]}{Which field of the confidence map shall be plotted.} +%\qualifier{width [=8], height [=8]}{Width and height of the confidence map.} +%\qualifier{latex_package [="txfonts"]}{Load a package in the preamble of LaTeX documents.} +%\qualifier{reverse_axes}{If present, both axes are reversed.} +%\qualifier{[xyz]label}{Add a x-, y-, or z-label to the confidence map.} +%\qualifier{[xyz]axis [=struct{ticlabels_confine=0, ticlabels2=0}]}{Modify the x-, y-, or z-axis % by providing a structure whose fields are qualifiers of the function `xfig_plot.axis'. % Note that the `log' qualifier (set logarithmic axis scale) does not work.} -%\qualifier{nomultiplot}{: Return the confidence map and its corresponding colormap in two separate +%\qualifier{nomultiplot}{Return the confidence map and its corresponding colormap in two separate % xfig objects instead of one multiplot object.} %} %\example diff --git a/src/plot/xfig_plot_epfpd.sl b/src/plot/xfig_plot_epfpd.sl index 6b727827b68c9fa83650d6830eb8b2cb72274f0b..d8f8cb1b4337397e00f8480f7dd509584ed7e6ec 100644 --- a/src/plot/xfig_plot_epfpd.sl +++ b/src/plot/xfig_plot_epfpd.sl @@ -10,18 +10,18 @@ define xfig_plot_epfpd (ep, lc) %\usage{xfig_plot_epfpd(Struct_Type eppd, Struct_Type lc) %} %\qualifiers{ -%\qualifier{W}{ : width of resulting plot (default=12)} -%\qualifier{H}{ : height of resulting plot (default=W)} -%\qualifier{pdstart}{ : start of P-dot axis (default read from eppd)} -%\qualifier{pdstop}{ : end of P-dot axis (default read from eppd)} -%\qualifier{pstart}{ : start of P axis (default read from eppd)} -%\qualifier{pstop}{ : end of P axis (default read from eppd)} -%\qualifier{p0}{ : center of P axis (default mean of periods in eppd)} -%\qualifier{cmap}{ [\code{="iceandfire"}]: Color-map of Chi^2 landscape } -%\qualifier{cont}{ : switch to plot FWHM contour on map } -%\qualifier{pp}{ : switch to plot pulse profile below map } -%\qualifier{t0}{ [\code{="0"}]: t0 for pulse profile } -%\qualifier{nbins}{ [\code{="12"}]: number of phase bins for pulse profile } +%\qualifier{W}{width of resulting plot (default=12)} +%\qualifier{H}{height of resulting plot (default=W)} +%\qualifier{pdstart}{start of P-dot axis (default read from eppd)} +%\qualifier{pdstop}{end of P-dot axis (default read from eppd)} +%\qualifier{pstart}{start of P axis (default read from eppd)} +%\qualifier{pstop}{end of P axis (default read from eppd)} +%\qualifier{p0}{center of P axis (default mean of periods in eppd)} +%\qualifier{cmap}{[\code{="iceandfire"}] Color-map of Chi^2 landscape } +%\qualifier{cont}{switch to plot FWHM contour on map } +%\qualifier{pp}{switch to plot pulse profile below map } +%\qualifier{t0}{[\code{="0"}] t0 for pulse profile } +%\qualifier{nbins}{[\code{="12"}] number of phase bins for pulse profile } %} % %\description diff --git a/src/plot/xfig_plot_image.sl b/src/plot/xfig_plot_image.sl index 240ec57a16f26cce19d1f2da0f381ec8533f304a..12ab49a07ad623b0e27afc332575e016e9f9b2cb 100644 --- a/src/plot/xfig_plot_image.sl +++ b/src/plot/xfig_plot_image.sl @@ -8,31 +8,31 @@ define xfig_plot_image() %\usage{Struct_Type xfig_plot_new( Double_Type[n,m] IMG, [Double/Struct_Type x, y] );} %\altusage{xfig_plot_new( Double_Type[n,m] IMG, [Double/Struct_Type x, y [, Struct_Type xf]] );} %\qualifiers{ -%\qualifier{cmap}{ [="ds9b"]: Either a name (String_Type) of a colormap +%\qualifier{cmap}{[="ds9b"] Either a name (String_Type) of a colormap % (see png_get_colormap_names), or a self defined % colormap (Integer_Type[]).} -%\qualifier{gmin}{ [=min(IMG)]: Minimal value of image to be plotted} -%\qualifier{gmax}{ [=max(IMG)]: Maximal value of image to be plotted} -%\qualifier{xmin}{ [=min(x)]: Minimal value of x-axis} -%\qualifier{xmax}{ [=max(x)]: Maximal value of x-axis} -%\qualifier{ymin}{ [=min(y)]: Minimal value of y-axis} -%\qualifier{ymax}{ [=max(y)]: Maximal value of y-axis} -%\qualifier{dx}{ [=0.]: Relative justification of pixels in x-direction. Used if 'x' is no grid.} -%\qualifier{dy}{ [=dx]: Relative justification of pixels in y-direction. Used if 'y' is no grid.} -%\qualifier{fill}{ [=20]: global filling method (see %.shade_region) } -%\qualifier{fmap}{ [=Integer_Type[n,m]+fill]: individual filling method for each pixel} -%%\qualifier{nancol}{ [="black"]: Extra color for IMG pixel values, which are NAN.} -%\qualifier{ratio}{ [=1]: Desired ratio of x and y-axis scale} -%\qualifier{W}{ [=14]: Plot width [cm]. 'ratio' is overwritten if W & H are given!} -%\qualifier{H}{ [=W/ratio]: Plot height [cm]. 'ratio' is overwritten if W & H are given!} -%\qualifier{colorscale}{ : If given an inlay colorscale is plotted using xfig_plot_colorscale} -%\qualifier{format}{: Format for colormap axis ticlabels, see 'help xfig_plot.axis'} -%\qualifier{just}{ [=[.95,.05,-.5,.5]]: Position (world00) & relative justification +%\qualifier{gmin}{[=min(IMG)] Minimal value of image to be plotted} +%\qualifier{gmax}{[=max(IMG)] Maximal value of image to be plotted} +%\qualifier{xmin}{[=min(x)] Minimal value of x-axis} +%\qualifier{xmax}{[=max(x)] Maximal value of x-axis} +%\qualifier{ymin}{[=min(y)] Minimal value of y-axis} +%\qualifier{ymax}{[=max(y)] Maximal value of y-axis} +%\qualifier{dx}{[=0.] Relative justification of pixels in x-direction. Used if 'x' is no grid.} +%\qualifier{dy}{[=dx] Relative justification of pixels in y-direction. Used if 'y' is no grid.} +%\qualifier{fill}{[=20] global filling method (see %.shade_region) } +%\qualifier{fmap}{[=Integer_Type[n,m]+fill] individual filling method for each pixel} +%%\qualifier{nancol}{[="black"] Extra color for IMG pixel values, which are NAN.} +%\qualifier{ratio}{[=1] Desired ratio of x and y-axis scale} +%\qualifier{W}{[=14] Plot width [cm]. 'ratio' is overwritten if W & H are given!} +%\qualifier{H}{[=W/ratio] Plot height [cm]. 'ratio' is overwritten if W & H are given!} +%\qualifier{colorscale}{If given an inlay colorscale is plotted using xfig_plot_colorscale} +%\qualifier{format}{Format for colormap axis ticlabels, see 'help xfig_plot.axis'} +%\qualifier{just}{[=[.95,.05,-.5,.5]] Position (world00) & relative justification % of the colorscale.} -%\qualifier{scale}{ [=[.33,.05]] : Relative size of the colorscale in respect to W & H.} -%\qualifier{xlabel}{: Label of x-axis} -%\qualifier{ylabel}{: Label of y-axis} -%\qualifier{depth}{ [=150]: xfig depth} +%\qualifier{scale}{[=[.33,.05]] : Relative size of the colorscale in respect to W & H.} +%\qualifier{xlabel}{Label of x-axis} +%\qualifier{ylabel}{Label of y-axis} +%\qualifier{depth}{[=150] xfig depth} %} %\description % Other than the %plot_png function of the xfig_plot structure this function @@ -285,24 +285,24 @@ define xfig_plot_colormap() %\synopsis{Plots a colormap/colorscale} %\usage{Struct_Type xfig_plot_new( Double_Type[n,m] IMG );} %\qualifiers{ -%\qualifier{cmap}{ [="ds9b"]: Either a name (String_Type) of a colormap +%\qualifier{cmap}{[="ds9b"] Either a name (String_Type) of a colormap % (see png_get_colormap_names), or a self defined % colormap (Integer_Type[]).} -%\qualifier{gmin}{ [=min(IMG)]: Minimal value of image to be plotted} -%\qualifier{gmax}{ [=max(IMG)]: Maximal value of image to be plotted} -%\qualifier{W}{ [=14]: Plot width [cm]. 'ratio' is overwritten if W & H are given!} -%\qualifier{H}{ [=W/ratio]: Plot height [cm]. 'ratio' is overwritten if W & H are given!} -%\qualifier{orientation}{ [=1]: Horizontal if 1, vertical if 0. Set Horizontal if W/H > 1, +%\qualifier{gmin}{[=min(IMG)] Minimal value of image to be plotted} +%\qualifier{gmax}{[=max(IMG)] Maximal value of image to be plotted} +%\qualifier{W}{[=14] Plot width [cm]. 'ratio' is overwritten if W & H are given!} +%\qualifier{H}{[=W/ratio] Plot height [cm]. 'ratio' is overwritten if W & H are given!} +%\qualifier{orientation}{[=1] Horizontal if 1, vertical if 0. Set Horizontal if W/H > 1, % otherwise set to vertical.} -%\qualifier{label}{: Label for the colormap} -%\qualifier{format}{: Format for colormap axis ticlabels, see 'help xfig_plot.axis'} -%\qualifier{depth}{ [=80]: Depth of the colormap} -%\qualifier{fontsize}{ [="scriptsize"]: Font size of tic & axis label} -%\qualifier{ticlen}{ [=.15]: Length of major tic marks (minor tic are .5*ticlen).} -%\qualifier{maxtics}{ [=5]: Maximal number of labeled tics} -%\qualifier{box}{ : Draws a box behind the colormap} -%\qualifier{border}{ [=.01]: Relative size of box excess length} -%\qualifier{boxcolor}{ [="#FFFFFF"]: Color of the box} +%\qualifier{label}{Label for the colormap} +%\qualifier{format}{Format for colormap axis ticlabels, see 'help xfig_plot.axis'} +%\qualifier{depth}{[=80] Depth of the colormap} +%\qualifier{fontsize}{[="scriptsize"] Font size of tic & axis label} +%\qualifier{ticlen}{[=.15] Length of major tic marks (minor tic are .5*ticlen).} +%\qualifier{maxtics}{[=5] Maximal number of labeled tics} +%\qualifier{box}{Draws a box behind the colormap} +%\qualifier{border}{[=.01] Relative size of box excess length} +%\qualifier{boxcolor}{[="#FFFFFF"] Color of the box} %} %\description % This function uses xfig_plot_image to create a colormap based on the given diff --git a/src/plot/xfig_plot_ionization_structure.sl b/src/plot/xfig_plot_ionization_structure.sl index 05f339170fd408e065736023654553a55b9c9b25..83f396939408e5dd9fcf30c9e3aa42e05c434339 100644 --- a/src/plot/xfig_plot_ionization_structure.sl +++ b/src/plot/xfig_plot_ionization_structure.sl @@ -146,16 +146,16 @@ define xfig_plot_ionization_structure (){ %{{{ %\synopsis{plots the ionization structure from an abundance file produced by xstar} %\usage{plot_ionization_structure(String_Type abundace_file, String_Type[] elements, String_Type ouput_file)} %\qualifiers{ -% \qualifier{xpow}{: plot radius in units of 10^xpow (default: 10)} -% \qualifier{xaxis}{: use 'logxi' or 'radius' to set the abscissa (default: radius)} -% \qualifier{temp}{: add temperature panel} -% \qualifier{press}{: add pressure panel} -% \qualifier{xee}{: add electron fraction panel} -% \qualifier{dens}{: add density panel} -% \qualifier{athresh}{: only ionization states are plotted which exceed a certain threshold (default: 0.3)} -% \qualifier{ion_states}{: string array of ionization states in roman numbers} -% \qualifier{width}{: plot witdh} -% \qualifier{height}{: plot height} +% \qualifier{xpow}{plot radius in units of 10^xpow (default: 10)} +% \qualifier{xaxis}{use 'logxi' or 'radius' to set the abscissa (default: radius)} +% \qualifier{temp}{add temperature panel} +% \qualifier{press}{add pressure panel} +% \qualifier{xee}{add electron fraction panel} +% \qualifier{dens}{add density panel} +% \qualifier{athresh}{only ionization states are plotted which exceed a certain threshold (default: 0.3)} +% \qualifier{ion_states}{string array of ionization states in roman numbers} +% \qualifier{width}{plot witdh} +% \qualifier{height}{plot height} % % All other qualifiers are passed to xfig_plot.plot() %} diff --git a/src/plot/xfig_plot_params.sl b/src/plot/xfig_plot_params.sl index 6f32800f4adfcd9dd659c23dce1a70721265c7c3..21150b8c41c9d948c73d9bc99d45e146934a0ca9 100644 --- a/src/plot/xfig_plot_params.sl +++ b/src/plot/xfig_plot_params.sl @@ -13,22 +13,22 @@ define xfig_plot_params() %\qualifier{space}{[=.05*size[0]]: Space between parameter columns. % Dimension in cm of the (main) plot} %\qualifier{xwidth}{[=.5]: Width of the parameter symbols (same units as x values).} -%\qualifier{x}{: Alternative values for the x-axis (e.g., time in MJD)} -%\qualifier{xlabel}{: Label for the alternative x-axis.} -%\qualifier{connect}{: Connects the individual parameter values with a line.} -%\qualifier{conf}{: Confidence level for the given parameters are plotted, if given. +%\qualifier{x}{Alternative values for the x-axis (e.g., time in MJD)} +%\qualifier{xlabel}{Label for the alternative x-axis.} +%\qualifier{connect}{Connects the individual parameter values with a line.} +%\qualifier{conf}{Confidence level for the given parameters are plotted, if given. % conf must be a Struct_Type[] with fields: the 'index' of the % parameter and the corresponding confidence (absolut) limits % 'conf_min' and 'conf_max'.} -%\qualifier{steppar}{: Steppar information (see 'steppar'). Either steppar filename +%\qualifier{steppar}{Steppar information (see 'steppar'). Either steppar filename % which is loaded with steppar_load or a List_Type with two % elemtents 1. stepparinformation and 2. the keys.} -%\qualifier{chi2log}{: Logarithmic scales for chi2 plots} -%\qualifier{grid}{: Enables gridlines on the chi2 plots} -%\qualifier{chi2max}{: Custom max value for chi2 range} -%\qualifier{chi2min}{: Custom min value for chi2 range} -%\qualifier{cmap}{[='ds9b']: Colormap for the colorcoded chi2 landscapes} -%\qualifier{ticmap}{[='rainbow']: Colormap for the ticlabels/chi2 landscapes} +%\qualifier{chi2log}{Logarithmic scales for chi2 plots} +%\qualifier{grid}{Enables gridlines on the chi2 plots} +%\qualifier{chi2max}{Custom max value for chi2 range} +%\qualifier{chi2min}{Custom min value for chi2 range} +%\qualifier{cmap}{[='ds9b'] Colormap for the colorcoded chi2 landscapes} +%\qualifier{ticmap}{[='rainbow'] Colormap for the ticlabels/chi2 landscapes} %} %\description % This function creates and returns a xfig-plot showing a compact overview @@ -75,7 +75,7 @@ define xfig_plot_params() % name (String_Type) of an existing colormap (png_get_colormap_names) or % a colormap itself. %\seealso{steppar, steppar_load, png_get_colormap_names} -%} +% %!%- { %%% CAPTURE ARGUMENTS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% diff --git a/src/plot/xfig_plot_spectrum.sl b/src/plot/xfig_plot_spectrum.sl index 5c288d17d115217720c38b848844449f52437db2..7e8af2134a455c7666e992e64d399feb067e8ee0 100644 --- a/src/plot/xfig_plot_spectrum.sl +++ b/src/plot/xfig_plot_spectrum.sl @@ -117,36 +117,36 @@ define xfig_plot_spectrum() % intentionally). % %\qualifiers{ -%\qualifier{topPanelFrac}{: Double_Type, fraction of plot taken up by top panel, default 0.5} -%\qualifier{height}{: Double_Type, height of plot in cm, default 14.2} -%\qualifier{width}{: Double_Type, width of plot in cm, default 12.6} -%\qualifier{colors}{: String_Type[] or Integer_Type[], xfig colors for each spectrum plotted, by default uses get_sron_colors() to get a set of colors} -%\qualifier{mcolors}{: String_Type[] or Integer_Type[], xfig colors for each model plotted. By default each model is plotted with the same color as its associated data.} -%\qualifier{dsym}{: String_Type[] or Integer_Type[], xfig symbols for data for each spectrum plotted, defaults to "point"} -%\qualifier{symsize}{: Integer_Type[], size of symbols for each spectrum plotted. Can be a single value or an array (one element for each spectrum).} -%\qualifier{mstyle}{: Integer_Type[], xfig linestyle for overplotted best-fit model for each spectrum. mstyle = -1 plots the model as a histogram. As with symsize, can be single value or array. Default -1} -%\qualifier{mwidth}{: Integer_Type[], xfig line width for overplotted best-fit model. As with symsize, can be single value or array. Default 1.} -%\qualifier{mscale}{: Double_Type[], multiplicative scale for model (e.g., if you want to plot your model above your data points). Single value or array.} -%\qualifier{dataDepth}{: Integer_Type[], xfig depth for data points, either a single value or an array specifying the depth for each spectrum. Default 1} -%\qualifier{modelDepth}{: Integer_Type[], xfig depth for model lines. See dataDepth. Default 0 (this means models are plotted over data by default)} -%\qualifier{ratio}{: If present, residuals are ratio residuals, otherwise residuals are assumed to be some variant of data-model.} -%\qualifier{no_residuals}{: If set, no residuals are plotted.} -%\qualifier{gaps}{: List_Type, indicates where gaps in an instrument's spectrum mean the model should not be plotted.} -%\qualifier{xrange}{: Double_Type[2], range for x-axis (default autoscaled)} -%\qualifier{yrange}{: Double_Type[2], range for y-axis of top panel (default autoscaled)} -%\qualifier{rrange}{: List_Type[]. Should be a list of two-element arrays containing the minimum and maximum for the y-axis of each residual plot, in the order that they appear on the plot.} -%\qualifier{xlog}{: Axes are linear by default. If "xlog" is set, or if it is set to a nonzero number, the x-axis will be logarithmic. If "xlog" is not set, or is set to zero, the x-axis will be linear.} -%\qualifier{ylog}{: See xlog; sets log/linear scale for y-axis on top panel. Residual plots always have linear y-axes.} -%\qualifier{unit}{: String_Type, either "keV" (energy, default) or "A" (wavelength).} -%\qualifier{xlabel}{: String_Type, label for x-axis, default depends on units. If unit="keV", "Energy (keV)"; if unit="A", "Wavelength (\\AA)". Set to NULL for no label.} -%\qualifier{ylabel}{: String_Type, label for y-axis of spectrum, default depends on units. If unit="keV", "Counts s$^-1$ keV$^-1$"; if unit="A", "Counts s$^{-1}$ \\AA$^{-1}$".} -%\qualifier{rlabel}{: String_Type, label for y-axis of residuals. If the "ratio" qualifier is set, default is "Ratio", otherwise default is "$\\chi$".} -%\qualifier{labels}{: String_Type[], labels for individual panels.} -%\qualifier{firstPanelLabel}{: String_Type or Integer_Type, label for first panel (further panels will increment this value, so if you give 'b' the next panels will be 'c', 'd', etc).} -%\qualifier{label_x}{: Double_Type[], x-positions (in world0 coordinates) of panel labels.} -%\qualifier{label_y}{: Double_Type[], y-positions (in world0 coordinates) of panel labels.} -%\qualifier{arrowY}{: Double_Type[2], lower and upper device coordinates for arrows for bins extending off the screen, default [0.01,0.1].} -%\qualifier{version}{: Display version information and exit.} +%\qualifier{topPanelFrac}{Double_Type, fraction of plot taken up by top panel, default 0.5} +%\qualifier{height}{Double_Type, height of plot in cm, default 14.2} +%\qualifier{width}{Double_Type, width of plot in cm, default 12.6} +%\qualifier{colors}{String_Type[] or Integer_Type[], xfig colors for each spectrum plotted, by default uses get_sron_colors() to get a set of colors} +%\qualifier{mcolors}{String_Type[] or Integer_Type[], xfig colors for each model plotted. By default each model is plotted with the same color as its associated data.} +%\qualifier{dsym}{String_Type[] or Integer_Type[], xfig symbols for data for each spectrum plotted, defaults to "point"} +%\qualifier{symsize}{Integer_Type[], size of symbols for each spectrum plotted. Can be a single value or an array (one element for each spectrum).} +%\qualifier{mstyle}{Integer_Type[], xfig linestyle for overplotted best-fit model for each spectrum. mstyle = -1 plots the model as a histogram. As with symsize, can be single value or array. Default -1} +%\qualifier{mwidth}{Integer_Type[], xfig line width for overplotted best-fit model. As with symsize, can be single value or array. Default 1.} +%\qualifier{mscale}{Double_Type[], multiplicative scale for model (e.g., if you want to plot your model above your data points). Single value or array.} +%\qualifier{dataDepth}{Integer_Type[], xfig depth for data points, either a single value or an array specifying the depth for each spectrum. Default 1} +%\qualifier{modelDepth}{Integer_Type[], xfig depth for model lines. See dataDepth. Default 0 (this means models are plotted over data by default)} +%\qualifier{ratio}{If present, residuals are ratio residuals, otherwise residuals are assumed to be some variant of data-model.} +%\qualifier{no_residuals}{If set, no residuals are plotted.} +%\qualifier{gaps}{List_Type, indicates where gaps in an instrument's spectrum mean the model should not be plotted.} +%\qualifier{xrange}{Double_Type[2], range for x-axis (default autoscaled)} +%\qualifier{yrange}{Double_Type[2], range for y-axis of top panel (default autoscaled)} +%\qualifier{rrange}{List_Type[]. Should be a list of two-element arrays containing the minimum and maximum for the y-axis of each residual plot, in the order that they appear on the plot.} +%\qualifier{xlog}{Axes are linear by default. If "xlog" is set, or if it is set to a nonzero number, the x-axis will be logarithmic. If "xlog" is not set, or is set to zero, the x-axis will be linear.} +%\qualifier{ylog}{See xlog; sets log/linear scale for y-axis on top panel. Residual plots always have linear y-axes.} +%\qualifier{unit}{String_Type, either "keV" (energy, default) or "A" (wavelength).} +%\qualifier{xlabel}{String_Type, label for x-axis, default depends on units. If unit="keV", "Energy (keV)"; if unit="A", "Wavelength (\\AA)". Set to NULL for no label.} +%\qualifier{ylabel}{String_Type, label for y-axis of spectrum, default depends on units. If unit="keV", "Counts s$^-1$ keV$^-1$"; if unit="A", "Counts s$^{-1}$ \\AA$^{-1}$".} +%\qualifier{rlabel}{String_Type, label for y-axis of residuals. If the "ratio" qualifier is set, default is "Ratio", otherwise default is "$\\chi$".} +%\qualifier{labels}{String_Type[], labels for individual panels.} +%\qualifier{firstPanelLabel}{String_Type or Integer_Type, label for first panel (further panels will increment this value, so if you give 'b' the next panels will be 'c', 'd', etc).} +%\qualifier{label_x}{Double_Type[], x-positions (in world0 coordinates) of panel labels.} +%\qualifier{label_y}{Double_Type[], y-positions (in world0 coordinates) of panel labels.} +%\qualifier{arrowY}{Double_Type[2], lower and upper device coordinates for arrows for bins extending off the screen, default [0.01,0.1].} +%\qualifier{version}{Display version information and exit.} %} %\seealso{write_plot, xfig_multiplot, xfig_plot_unfold, xfig_plot--wcs} %!%- diff --git a/src/plot/xfig_plot_unfold.sl b/src/plot/xfig_plot_unfold.sl index 6cd7c2686d1c2e0cb176cf91bc3ccc529cb4d034..63b7c5f6657351cc0f8e4767e0b86de78fb96331 100644 --- a/src/plot/xfig_plot_unfold.sl +++ b/src/plot/xfig_plot_unfold.sl @@ -41,10 +41,10 @@ define xfig_plot_data(pl,d) %\synopsis{plots data which was loaded by "read_data_from_write_plot"} %\usage{XFig_Plot_Type pl = xfig_plot_data(XFig_Plot_Type pl, Struct_Type dat)} %\qualifiers{ -%\qualifier{color}{: specify the color} -%\qualifier{width}{: line width} -%\qualifier{depth}{: depth in plot} -%\qualifier{pp}{: data are plotted twice (pulse profile)} +%\qualifier{color}{specify the color} +%\qualifier{width}{line width} +%\qualifier{depth}{depth in plot} +%\qualifier{pp}{data are plotted twice (pulse profile)} %} %\seealso{xfig_plot_unfold,read_data_from_write_plot,read_col,write_plot} %!%- @@ -73,11 +73,11 @@ define xfig_plot_model(pl,d) %\synopsis{plots the model which was loaded by "read_data_from_write_plot"} %\usage{XFig_Plot_Type pl = xfig_plot_model(XFig_Plot_Type pl, Struct_Type dat)} %\qualifiers{ -%\qualifier{color}{: specify the color} -%\qualifier{width}{: line width} -%\qualifier{depth}{: depth in plot} -%\qualifier{hplot}{: make it a histogram plot} -%\qualifier{pp}{: model is plotted twice (pulse profile)} +%\qualifier{color}{specify the color} +%\qualifier{width}{line width} +%\qualifier{depth}{depth in plot} +%\qualifier{hplot}{make it a histogram plot} +%\qualifier{pp}{model is plotted twice (pulse profile)} %} %\seealso{xfig_plot_data,read_data_from_write_plot,read_col,write_plot} %!%- @@ -110,12 +110,12 @@ define xfig_plot_res(pl,s) %\synopsis{plots the residuals which were loaded by "read_data_from_write_plot"} %\usage{XFig_Plot_Type pl = xfig_plot_model(XFig_Plot_Type pl, Struct_Type dat)} %\qualifiers{ -%\qualifier{color}{: specify the color} -%\qualifier{width}{: line width} -%\qualifier{depth}{: depth in plot} -%\qualifier{chi}{: specifies that the residuals are in chi} -%\qualifier{ratio}{: specifies that the residuals are a ratio} -%\qualifier{pp}{: residuals are plotted twice (pulse profile)} +%\qualifier{color}{specify the color} +%\qualifier{width}{line width} +%\qualifier{depth}{depth in plot} +%\qualifier{chi}{specifies that the residuals are in chi} +%\qualifier{ratio}{specifies that the residuals are a ratio} +%\qualifier{pp}{residuals are plotted twice (pulse profile)} %} %\seealso{xfig_plot_data,read_data_from_write_plot,read_col,write_plot} %!%- @@ -155,19 +155,19 @@ define xfig_plot_unfold(d) %\synopsis{tries to plot the complete plot loaded by "read_data_from_write_plot"} %\usage{XFig_Plot_Type pl = xfig_plot_unfold(Struct_Type dat)} %\qualifiers{ -%\qualifier{size}{: [dx,dy,dr] size of the xfig-plot} -%\qualifier{dcol}{: color of the data} -%\qualifier{mcol}{: color of the model} -%\qualifier{xrng}{: [xmin,xmax]} -%\qualifier{yrng}{: [ymin,ymax]} -%\qualifier{rrng}{: [rmin,rmax]} -%\qualifier{ranges}{: [xmin,xmax,ymin,ymax,rmin,rmax]} -%\qualifier{chi}{: specifies that the residuals are chi} -%\qualifier{ratio}{: specifies that the residuals are ratio} -%\qualifier{y_label}{: set a y-label for the data/model plot} -%\qualifier{keV2erg_fac}{: if given, the y-label is given in units of +%\qualifier{size}{[dx,dy,dr] size of the xfig-plot} +%\qualifier{dcol}{color of the data} +%\qualifier{mcol}{color of the model} +%\qualifier{xrng}{[xmin,xmax]} +%\qualifier{yrng}{[ymin,ymax]} +%\qualifier{rrng}{[rmin,rmax]} +%\qualifier{ranges}{[xmin,xmax,ymin,ymax,rmin,rmax]} +%\qualifier{chi}{specifies that the residuals are chi} +%\qualifier{ratio}{specifies that the residuals are ratio} +%\qualifier{y_label}{set a y-label for the data/model plot} +%\qualifier{keV2erg_fac}{if given, the y-label is given in units of % ergs/s/cm^2 x 10^keV2erg_fac } -%\qualifier{pp}{: data is plotted twice (pulse profile)} +%\qualifier{pp}{data is plotted twice (pulse profile)} %} %\description % With "read_data_from_write_plot", previously stored data can be diff --git a/src/plot/xfig_polarplot_new.sl b/src/plot/xfig_polarplot_new.sl index d19cd3594a87b6539e932c615949bd0fa3300d9d..902c9b399d2f062413ddf6a13e09542be3aea700 100644 --- a/src/plot/xfig_polarplot_new.sl +++ b/src/plot/xfig_polarplot_new.sl @@ -7,31 +7,31 @@ define xfig_polarplot_new() %\usage{Struct_Type xfig_plot_new( Double_Type Size )} %\altusage{Struct_Type xfig_plot_new()} %\qualifiers{ -%\qualifier{S}{ [=10]: Size of quadratic plot in width and height [cm]. +%\qualifier{S}{[=10] Size of quadratic plot in width and height [cm]. % Is overwritten by argument size!} -%\qualifier{min}{ [=0]: Minimal angle of polar plot [degree]} -%\qualifier{max}{ [=180]: Maximal angle of polar plot [degree]} -%\qualifier{origin}{ [=90]: Origin of angular axis measured from x-axis [degree]} -%\qualifier{dir}{ [=-1]: Clockwise direction of polar plot axis (-1/1)} -%\qualifier{ticlabels}{ [=.6]: If 0 ticlabels are turned of. If not 0 it is used +%\qualifier{min}{[=0] Minimal angle of polar plot [degree]} +%\qualifier{max}{[=180] Maximal angle of polar plot [degree]} +%\qualifier{origin}{[=90] Origin of angular axis measured from x-axis [degree]} +%\qualifier{dir}{[=-1] Clockwise direction of polar plot axis (-1/1)} +%\qualifier{ticlabels}{[=.6] If 0 ticlabels are turned of. If not 0 it is used % as relative justification} -%\qualifier{ticlabelsize}{ [="small"]: Size of ticlabels} -%\qualifier{ticlabelrotate}{ [=1]: Rotate polar ticlabels corresponding to their position (0/1)} -%\qualifier{ticthickness}{ [=2]: Thickness of tics} -%\qualifier{smallticinc}{ [=2]: Increment for small tics [degree]} -%\qualifier{medticinc}{ [=10]: Increment for medium tics [degree]} -%\qualifier{bigticinc}{ [=20]: Increment for big tics [degrees]} -%\qualifier{aticlables}{ [=[min:max:bigticinc]]: Ticlabels of angular axis} -%\qualifier{aticformat}{ ["$%d^\\circ$"]: Format for the angular ticlabels} -%\qualifier{rlabel}{ [=NULL]: Label for the radial axis} -%\qualifier{rtics}{ [=11]: Number of radial tics} -%\qualifier{rticlabel}{ [ =[0:1:#rtics/2] ]: Radial tic labels. The 0th rtic label will not be drawn!} -%\qualifier{norticlabel}{ If given, disabels radial tic labels.} -%\qualifier{rticlabelrotate}{ [=0]: Rotate polar ticlabels corresponding to their position (0/1)} -%\qualifier{padr}{ [=0.05]: Padding of radial axis} -%\qualifier{grid}{ : If given grid lines are plotted} -%\qualifier{gridcolor}{ [="#BBBBBB"]: Color of the grid lines} -%\qualifier{debug}{ If given the x-y-axis of the underlying xfig_plot are shown} +%\qualifier{ticlabelsize}{[="small"] Size of ticlabels} +%\qualifier{ticlabelrotate}{[=1] Rotate polar ticlabels corresponding to their position (0/1)} +%\qualifier{ticthickness}{[=2] Thickness of tics} +%\qualifier{smallticinc}{[=2] Increment for small tics [degree]} +%\qualifier{medticinc}{[=10] Increment for medium tics [degree]} +%\qualifier{bigticinc}{[=20] Increment for big tics [degrees]} +%\qualifier{aticlables}{[=[min:max:bigticinc]] Ticlabels of angular axis} +%\qualifier{aticformat}{["$%d^\\circ$"] Format for the angular ticlabels} +%\qualifier{rlabel}{[=NULL] Label for the radial axis} +%\qualifier{rtics}{[=11] Number of radial tics} +%\qualifier{rticlabel}{[ =[0:1:#rtics/2] ] Radial tic labels. The 0th rtic label will not be drawn!} +%\qualifier{norticlabel}{If given, disabels radial tic labels.} +%\qualifier{rticlabelrotate}{[=0] Rotate polar ticlabels corresponding to their position (0/1)} +%\qualifier{padr}{[=0.05] Padding of radial axis} +%\qualifier{grid}{If given grid lines are plotted} +%\qualifier{gridcolor}{[="#BBBBBB"] Color of the grid lines} +%\qualifier{debug}{If given the x-y-axis of the underlying xfig_plot are shown} %} %\description % This function returns a xfig_plot_new structure but imprinted with polar axis. diff --git a/src/plot/y1axis.sl b/src/plot/y1axis.sl index 8351ececfc2db6f7a192096d4e4cef2a08e80b39..8de63f87c22bd5f391c2ae237934a9f746734fdd 100644 --- a/src/plot/y1axis.sl +++ b/src/plot/y1axis.sl @@ -5,18 +5,18 @@ define y1axis() %\synopsis{(re)draws a first y-axis} %\usage{y1axis(Double_Type min_value, Double_Type max_value[, Double_Type step]);} %\qualifiers{ -%\qualifier{nsub}{ [=0]: number of minor tick marks within each major divison (nsub=0 => no minor ticks)} -%\qualifier{maji}{ [=0.5]: length of major tick marks, drawn inwards (in units of the character height)} -%\qualifier{majo}{ [=0]: length of major tick marks, drawn outwards (in units of the character height)} -%\qualifier{fmin}{ [=0.5]: length of minor tick marks (as fraction of the major tick marks)} -%\qualifier{disp}{ [=0.5]: displacement of baseline of tick labels to the axis (in units of the character height)} -%\qualifier{angle}{ [=0]: orientation of the text (in degrees)} -%\qualifier{color}{ [=1]: color of the axis} -%\qualifier{linewidth}{ [=1]: line width of the axis} -%\qualifier{opt}{ [="N"/"LN"]: pgaxis-options: "L" (log), "N" (numbers), "1" (force decimal), "2" (force EE)} -%\qualifier{xrel}{ [=0]: relative position of the y1axis (0=left, 1=right)} -%\qualifier{ymin}{ [=ymin]: absolute y-position of the axis} -%\qualifier{ymax}{ [=ymax]: absolute y-position of the axis} +%\qualifier{nsub}{[=0] number of minor tick marks within each major divison (nsub=0 => no minor ticks)} +%\qualifier{maji}{[=0.5] length of major tick marks, drawn inwards (in units of the character height)} +%\qualifier{majo}{[=0] length of major tick marks, drawn outwards (in units of the character height)} +%\qualifier{fmin}{[=0.5] length of minor tick marks (as fraction of the major tick marks)} +%\qualifier{disp}{[=0.5] displacement of baseline of tick labels to the axis (in units of the character height)} +%\qualifier{angle}{[=0] orientation of the text (in degrees)} +%\qualifier{color}{[=1] color of the axis} +%\qualifier{linewidth}{[=1] line width of the axis} +%\qualifier{opt}{[="N"/"LN"] pgaxis-options: "L" (log), "N" (numbers), "1" (force decimal), "2" (force EE)} +%\qualifier{xrel}{[=0] relative position of the y1axis (0=left, 1=right)} +%\qualifier{ymin}{[=ymin] absolute y-position of the axis} +%\qualifier{ymax}{[=ymax] absolute y-position of the axis} %} %\seealso{x2axis (and references therein)} %!%- diff --git a/src/plot/y2axis.sl b/src/plot/y2axis.sl index f5bf903e44d2dfb3a009c02201b65f9a208b7301..337816c50e1d444d489e92666cdb8846858e84c1 100644 --- a/src/plot/y2axis.sl +++ b/src/plot/y2axis.sl @@ -5,18 +5,18 @@ define y2axis() %\synopsis{draws a second y-axis} %\usage{y2axis(Double_Type min_value, Double_Type max_value[, Double_Type step]);} %\qualifiers{ -%\qualifier{nsub}{ [=0]: number of minor tick marks within each major divison (nsub=0 => no minor ticks)} -%\qualifier{maji}{ [=0.5]: length of major tick marks, drawn inwards (in units of the character height)} -%\qualifier{majo}{ [=0]: length of major tick marks, drawn outwards (in units of the character height)} -%\qualifier{fmin}{ [=0.5]: length of minor tick marks (as fraction of the major tick marks)} -%\qualifier{disp}{ [=0.5]: displacement of baseline of tick labels to the axis (in units of the character height)} -%\qualifier{angle}{ [=0]: orientation of the text (in degrees)} -%\qualifier{color}{ [=1]: color of the axis} -%\qualifier{linewidth}{ [=1]: line width of the axis} -%\qualifier{opt}{ [="N"/"LN"]: pgaxis-options: "L" (log), "N" (numbers), "1" (force decimal), "2" (force EE)} -%\qualifier{xrel}{ [=1]: relative position of the y2axis (0=left, 1=right)} -%\qualifier{ymin}{ [=ymin]: absolute y-position of the axis} -%\qualifier{ymax}{ [=ymax]: absolute y-position of the axis} +%\qualifier{nsub}{[=0] number of minor tick marks within each major divison (nsub=0 => no minor ticks)} +%\qualifier{maji}{[=0.5] length of major tick marks, drawn inwards (in units of the character height)} +%\qualifier{majo}{[=0] length of major tick marks, drawn outwards (in units of the character height)} +%\qualifier{fmin}{[=0.5] length of minor tick marks (as fraction of the major tick marks)} +%\qualifier{disp}{[=0.5] displacement of baseline of tick labels to the axis (in units of the character height)} +%\qualifier{angle}{[=0] orientation of the text (in degrees)} +%\qualifier{color}{[=1] color of the axis} +%\qualifier{linewidth}{[=1] line width of the axis} +%\qualifier{opt}{[="N"/"LN"] pgaxis-options: "L" (log), "N" (numbers), "1" (force decimal), "2" (force EE)} +%\qualifier{xrel}{[=1] relative position of the y2axis (0=left, 1=right)} +%\qualifier{ymin}{[=ymin] absolute y-position of the axis} +%\qualifier{ymax}{[=ymax] absolute y-position of the axis} %} %\seealso{x2axis (and references therein)} %!%- diff --git a/src/plot/y2label.sl b/src/plot/y2label.sl index 6e029f55f105e7acfe78307484c5caa7126194b2..d4ea82906ed235d8b4c148a7604de0894631882d 100644 --- a/src/plot/y2label.sl +++ b/src/plot/y2label.sl @@ -4,8 +4,8 @@ define y2label() %\synopsis{labels the second y-axis} %\usage{y2label(String_Type s);} %\qualifiers{ -%\qualifier{color}{ [=1]: textcolor} -%\qualifier{f}{ [=0.03]: fraction of the plot-area's width that the label is to the right} +%\qualifier{color}{[=1] textcolor} +%\qualifier{f}{[=0.03] fraction of the plot-area's width that the label is to the right} %} %\seealso{xylabel} %!%- diff --git a/src/sixte/get_sixte_eventfile_statistic.sl b/src/sixte/get_sixte_eventfile_statistic.sl index e684f73dbf1288b102eda41d49359d304013e073..2a4a18070c90bcda509aa07fcf74a6c7441d58d7 100644 --- a/src/sixte/get_sixte_eventfile_statistic.sl +++ b/src/sixte/get_sixte_eventfile_statistic.sl @@ -61,12 +61,12 @@ define get_sixte_eventfile_statistic(){ % skipped and only the energy/channel resolved patterns are % returned (requires lo, hi, and field qualifiers). %\qualifiers{ -%\qualifier{lo}{: low grid for calculation of pattern fractions (in +%\qualifier{lo}{low grid for calculation of pattern fractions (in % unit of fields} -%\qualifier{hi}{: high grid} -%\qualifier{field}{: Name of event file column for filtering (for +%\qualifier{hi}{high grid} +%\qualifier{field}{Name of event file column for filtering (for % example "signal" or "pha")} -%\qualifier{nphot}{: Adds an additional struct field with number of +%\qualifier{nphot}{Adds an additional struct field with number of % photons in the SIXTE event file} %} %\seealso{ratio_error_prop} diff --git a/src/sixte/make_movie_from_evtList.sl b/src/sixte/make_movie_from_evtList.sl index 6611962f7c754c81e9e3c7ebee43456ffc1ecdff..1ec7bb12d82c488d56e698c8e513e70f299dfa74 100644 --- a/src/sixte/make_movie_from_evtList.sl +++ b/src/sixte/make_movie_from_evtList.sl @@ -51,13 +51,13 @@ define make_movie_from_evtList(fevt,dt,output){ %{{{ % seconds) of each frame is adjusted by "dt". The output file is % written to "movieFile" (best use a mp4 file). %\qualifiers{ -%\qualifier{cmap}{["hot"]: color map} -%\qualifier{thres}{[0.0]: threshold of counts/frame, when a frame should be discarded} -%\qualifier{fps}{: frames per secondswitch on the scale} -%\qualifier{size}{[10,10]: size of the image in cm} -%\qualifier{tstart}{: start time of the movie (sec)} -%\qualifier{tstop}{: end time of the movie (sec)} -%\qualifier{labels}{: draw some labels (white frame and time in ksec)} +%\qualifier{cmap}{["hot"] color map} +%\qualifier{thres}{[0.0] threshold of counts/frame, when a frame should be discarded} +%\qualifier{fps}{frames per secondswitch on the scale} +%\qualifier{size}{[10,10] size of the image in cm} +%\qualifier{tstart}{start time of the movie (sec)} +%\qualifier{tstop}{end time of the movie (sec)} +%\qualifier{labels}{draw some labels (white frame and time in ksec)} %} %\seealso{xfig_plot_new,fitswcs_get_img_wcs} %!%- diff --git a/src/sixte/simput_athenacrab.sl b/src/sixte/simput_athenacrab.sl index e26f55854cd9c9a08242e58324f16ebd8eeb40a9..96cebac91d5901abaf13987e434126f9e6318fa4 100644 --- a/src/sixte/simput_athenacrab.sl +++ b/src/sixte/simput_athenacrab.sl @@ -10,11 +10,11 @@ define simput_athenacrab(flux){ % cm^-2, norm of 9.5 ph/kev/cm^2/s at 1keV, and powerlaw index of % 2.1. The source position is RA=Dec=0. %\qualifiers{ -%\qualifier{unit}{: crab or cgs, default: crab} -%\qualifier{dir}{: To append a full directory path, default: cwd} -%\qualifier{logEgrid}{: use a logarithmic energy grid (from Elow to +%\qualifier{unit}{crab or cgs, default: crab} +%\qualifier{dir}{To append a full directory path, default: cwd} +%\qualifier{logEgrid}{use a logarithmic energy grid (from Elow to % Eup with Nbins), default: no} -%\qualifier{Nbins}{: number of energy bins created from Elow to Eup, +%\qualifier{Nbins}{number of energy bins created from Elow to Eup, % default: 1000} %} %!%- diff --git a/src/sixte/simputfile.sl b/src/sixte/simputfile.sl index 5f8b46c10d3015be58cc9ad376f36f6ab6c2e596..7690989cf163cc761daf3e8dbea658413105e5c4 100644 --- a/src/sixte/simputfile.sl +++ b/src/sixte/simputfile.sl @@ -52,7 +52,7 @@ define get_simputfile_struct(Simput,RA,Dec,flux){ %{{{ % Note: All parameters and there usage are according to the simputfile % routine of the SIMPUT package. E.g., flux is given in erg/cm^2/s. %\qualifiers{ -%\qualifier{crab}{: flux is given in units of Crab} +%\qualifier{crab}{flux is given in units of Crab} %\qualifier{emin}{[2.0]: lower limit of the energy band of the given flux in keV} %\qualifier{emax}{[10.0]: lower limit of the energy band of the given flux in keV} %} @@ -116,7 +116,7 @@ define eval_simputfile(str){ % with "get_simputfile_struct". Generally, all fields of the % structure == NULL are skipped. %\qualifiers{ -%\qualifier{quiet}{: don't show any output} +%\qualifier{quiet}{don't show any output} %} %\seealso{create_basic_simputfile,get_simputfile_struct,set_simputfile_model_grid,set_simputfile_flux} %!%- @@ -162,11 +162,11 @@ define create_basic_simputfile(Simput,RA,Dec,flux,nh,pl){ % This structure can be further modifed, and then evaluated with % the function "eval_simputfile". %\qualifiers{ -%\qualifier{crab}{: flux is given in units of Crab} -%\qualifier{eval}{: directly evalute the returned structure (similar to call eval_simputfile(str); } -%\qualifier{emin}{: lower limit of the energy band of the given flux in keV} -%\qualifier{emax}{: lower limit of the energy band of the given flux in keV} -%\qualifier{quite}{: don't show any output} +%\qualifier{crab}{flux is given in units of Crab} +%\qualifier{eval}{directly evalute the returned structure (similar to call eval_simputfile(str); } +%\qualifier{emin}{lower limit of the energy band of the given flux in keV} +%\qualifier{emax}{lower limit of the energy band of the given flux in keV} +%\qualifier{quite}{don't show any output} %} %\examples % \code{variable str = create_basic_simputfile("velaX-1.fits",135.528583,40.554722,100e-3,1.8,5.0;crab);} diff --git a/src/sixte/write_simput_dummy_bkg.sl b/src/sixte/write_simput_dummy_bkg.sl index 463328755fcdbb4fe78c1075676d6abd307d7c15..1f1e7e7404396a7642102603a656d22e4778907d 100644 --- a/src/sixte/write_simput_dummy_bkg.sl +++ b/src/sixte/write_simput_dummy_bkg.sl @@ -75,9 +75,9 @@ define write_simput_dummy_bkg(fsimput,fsrc,fpar){ % fsrc: Name of a SRC-FITS-Image (with FK5 WCS Header) % fpar: ISIS-par File (with proper normalization) of the BKG %\qualifiers{ -%\qualifier{src_name}{["BKG"]: name of the source in the SIMPUT file} -%\qualifier{overwrite}{: if given, already exsiting simput files are overwritten} -%\qualifier{arcmin_area}{=[1.0]: area in arcmin specifying the flux for the given spectrum } +%\qualifier{src_name}{["BKG"] name of the source in the SIMPUT file} +%\qualifier{overwrite}{if given, already exsiting simput files are overwritten} +%\qualifier{arcmin_area}{=[1.0] area in arcmin specifying the flux for the given spectrum } %} %\seealso{xfig_plot_new,fitswcs_get_img_wcs} %!%- diff --git a/src/sixte/xfig_plot_sky_img.sl b/src/sixte/xfig_plot_sky_img.sl index 3f32d773521634ee185bc990397de8730486cebc..c1e7843719f5554fe0e6ab2902649582eedbe0c1 100644 --- a/src/sixte/xfig_plot_sky_img.sl +++ b/src/sixte/xfig_plot_sky_img.sl @@ -89,18 +89,18 @@ define xfig_plot_sky_img(fimg){ %{{{ % scale ("hot" by default). With a separate qualifier, a scale can % be switched on. The %\qualifiers{ -%\qualifier{cmap}{["hot"]: color map} -%\qualifier{scale}{: switch on the scale} -%\qualifier{arcmin}{[=5]: length of the scale in arcmin} -%\qualifier{lin}{: linear image scale instead of logarithmic} -%\qualifier{func}{: giva a reference to an arbitrary function to be applied to the image} -%\qualifier{size}{[10,10]: size of the image in cm} -%\qualifier{ref_img}{[fits_img]: if not given as direct argument, a reference FITS image has to be provided for the scale (filename!)} -%\qualifier{grid}{: draw a grid and corresponding labels} -%\qualifier{step_ra}{[=1]: step size of the RA-grid (given in min)} -%\qualifier{step_ra}{[=5]: step size of the Dec-grid (given in arcmin)} -%\qualifier{grid_color}{[#BBBBBB]: color of the grid} -%\qualifier{scale_color}{[white]: color of the scale} +%\qualifier{cmap}{["hot"] color map} +%\qualifier{scale}{switch on the scale} +%\qualifier{arcmin}{[=5] length of the scale in arcmin} +%\qualifier{lin}{linear image scale instead of logarithmic} +%\qualifier{func}{giva a reference to an arbitrary function to be applied to the image} +%\qualifier{size}{[10,10] size of the image in cm} +%\qualifier{ref_img}{[fits_img] if not given as direct argument, a reference FITS image has to be provided for the scale (filename!)} +%\qualifier{grid}{draw a grid and corresponding labels} +%\qualifier{step_ra}{[=1] step size of the RA-grid (given in min)} +%\qualifier{step_ra}{[=5] step size of the Dec-grid (given in arcmin)} +%\qualifier{grid_color}{[#BBBBBB] color of the grid} +%\qualifier{scale_color}{[white] color of the scale} %} %\seealso{xfig_plot_new,fitswcs_get_img_wcs} %!%- diff --git a/src/slang/arrays/2d/CCF_2d.sl b/src/slang/arrays/2d/CCF_2d.sl index 117156afebb2034fa0d047a70fa4c3f2e0da19d3..fd98d2aede09b20d2f9a4d03883317671302768f 100644 --- a/src/slang/arrays/2d/CCF_2d.sl +++ b/src/slang/arrays/2d/CCF_2d.sl @@ -13,7 +13,7 @@ define CCF_2d() % for any image \code{img}.\n % If \code{dx} or \code{dy} are arrays, \code{CCF} will be a 2d array. %\qualifiers{ -%\qualifier{verbose}{: turns on verbosity} +%\qualifier{verbose}{turns on verbosity} %\qualifier{savebest}{=&best: if \code{dx} or \code{dy} are arrays, the best combination will be saved in \code{best}.} %} %\seealso{CCF_1d} diff --git a/src/slang/arrays/CCF_1d.sl b/src/slang/arrays/CCF_1d.sl index 1de82bd1b1afc24f3c38a2256596d36dad5900bf..6679df42802784278f032e1246e1e12096079741 100644 --- a/src/slang/arrays/CCF_1d.sl +++ b/src/slang/arrays/CCF_1d.sl @@ -8,7 +8,7 @@ define CCF_1d() %\altusage{Array_Type CCF = CCF_1d(a1, a2);} %} %\qualifiers{ -%\qualifier{notperiodic}{: arrays are not extended periodically.} +%\qualifier{notperiodic}{arrays are not extended periodically.} %} %\description % The arrays \code{a1} and \code{a2} have to have the same length \code{n}. diff --git a/src/slang/arrays/associate_coords.sl b/src/slang/arrays/associate_coords.sl index 35b529363643c555395ded9a77823d5958061705..f8a1c10ab1e39aea8f280a802e67ececb1d75649 100644 --- a/src/slang/arrays/associate_coords.sl +++ b/src/slang/arrays/associate_coords.sl @@ -4,15 +4,15 @@ define associate_coords(ra1, dec1, ra2, dec2) %\synopsis{computes the smallest pairwise angular separation between arrays of positions and returns the indices} %\usage{Struct_Type result = associate_coords(Double_Type[n1] RA1, Double_Type[n1] DEC1),Double_Type[n2] RA2, Double_Type[n2] DEC2);} %\qualifiers{ -%\qualifier{nr_closest}{ [=1]: set to N, to obtain the N closest elements. +%\qualifier{nr_closest}{[=1] set to N, to obtain the N closest elements. % In this case additionally the index of the second, ..., N-th closest element is % returned as \code{result.index2[*,0], ..., result.index2[*,N-2]}, % the same holds for \code{result.sep2}.} -%\qualifier{unit}{ [\code{="deg"}]: unit of the angular coordinates} -%\qualifier{alpha1_unit}{ [\code{="deg"}]: unit of the RA1} -%\qualifier{alpha2_unit}{ [\code{="deg"}]: unit of the RA2} -%\qualifier{delta1_unit}{ [\code{="deg"}]: unit of the DEC1} -%\qualifier{delta2_unit}{ [\code{="deg"}]: unit of the DEC2} +%\qualifier{unit}{[\code{="deg"}] unit of the angular coordinates} +%\qualifier{alpha1_unit}{[\code{="deg"}] unit of the RA1} +%\qualifier{alpha2_unit}{[\code{="deg"}] unit of the RA2} +%\qualifier{delta1_unit}{[\code{="deg"}] unit of the DEC1} +%\qualifier{delta2_unit}{[\code{="deg"}] unit of the DEC2} %} %\description % For each position \code{(RA1[i], DEC1[i])} this function searches the element \code{(RA2[j],DEC2[j])} diff --git a/src/slang/arrays/binary_search.sl b/src/slang/arrays/binary_search.sl index b134d86d470c8751aac72b744fe60bb12a8be4dd..22eaacff79931ccd3708ca613bcd89ccd02785cf 100644 --- a/src/slang/arrays/binary_search.sl +++ b/src/slang/arrays/binary_search.sl @@ -4,7 +4,7 @@ define binary_search() %\synopsis{searches a value in a sorted list} %\usage{Integer_Type ndx=binary_search(Array_Type arr, Data_Type val);} %\qualifiers{ -%\qualifier{interval}{: do an interval search, return +%\qualifier{interval}{do an interval search, return % ndx such that arr[ndx]<=val23deg)} -%\qualifier{ suzaku }{: 70-110 deg from Sun} -%\qualifier{ xmm }{: 70-110 deg from Sun} -%\qualifier{ chandra}{: >46deg from Sun; ignores lunar constraint (>6deg)} -%\qualifier{ hst }{: >50deg from Sun} -%\qualifier{ nustar }{: no solar avoidance constraints(!)} +%\qualifier{swift}{46-180 deg from Sun; so far ignores lunar constraint (>23deg)} +%\qualifier{suzaku}{70-110 deg from Sun} +%\qualifier{xmm}{70-110 deg from Sun} +%\qualifier{chandra}{>46deg from Sun; ignores lunar constraint (>6deg)} +%\qualifier{hst}{>50deg from Sun} +%\qualifier{nustar}{no solar avoidance constraints(!)} %} %\description % This routine calculates the time intervals during which an astronomical diff --git a/src/slang/astronomy/obliquity.sl b/src/slang/astronomy/obliquity.sl index 0afd4dac17d839025f8d73b125b1346d8b61136e..a3cb4845f7e12c1e32648dfa4fe8f00271a8e926 100644 --- a/src/slang/astronomy/obliquity.sl +++ b/src/slang/astronomy/obliquity.sl @@ -4,17 +4,17 @@ define obliquity () %\synopsis{calculate the obliquity of the ecliptic} %\usage{eps=obliquity(JD;mjd);} %\qualifiers{ -% \qualifier{mjd}{: if set, the argument is in MJD, not in JD} -% \qualifier{laskar}{: use the polynomial expression by Laskar (1986, +% \qualifier{mjd}{if set, the argument is in MJD, not in JD} +% \qualifier{laskar}{use the polynomial expression by Laskar (1986, % Astron. Astrophys. 157, 59), which is valid for a time % span of around 10000 years around J2000, rather than % the IAU 2006 expression.} -% \qualifier{true}{: return the true obliquity for the date by applying +% \qualifier{true}{return the true obliquity for the date by applying % nutation} -% \qualifier{theory}{: nutation theory to use, see help for +% \qualifier{theory}{nutation theory to use, see help for % function nutation_angles; default: NU2000K} -% \qualifier{deg}{: return the obliquity in degrees } -% \qualifier{arcsec}{: return the obliquity in arcseconds} +% \qualifier{deg}{return the obliquity in degrees } +% \qualifier{arcsec}{return the obliquity in arcseconds} %} %\description % This routine calculates the obliquity of the ecliptic for diff --git a/src/slang/astronomy/position_angle.sl b/src/slang/astronomy/position_angle.sl index 45fc9a43a0b33eb1b3b660e0a6b718c2fa8cf498..c6a3db6497bcd6622568ce98674f3a97df1d7c0d 100644 --- a/src/slang/astronomy/position_angle.sl +++ b/src/slang/astronomy/position_angle.sl @@ -4,8 +4,8 @@ define position_angle() %\usage{ sep=position_angle(ra1,dec1,ra2,dec2);} %\synopsis{calculates the position angle of object1 with respect to object2} %\qualifiers{ -%\qualifier{deg}{: if set, the input coordinates and output are in degrees (default: radian)} -%\qualifier{radian}{: if set, the input coordinates and output are in radian (the default))} +%\qualifier{deg}{if set, the input coordinates and output are in degrees (default: radian)} +%\qualifier{radian}{if set, the input coordinates and output are in radian (the default))} %} %\description % This routine calculates the position angle on the sky of the point diff --git a/src/slang/astronomy/radial_velocity_binary.sl b/src/slang/astronomy/radial_velocity_binary.sl index 970308df2db8067f38a8b2e97575d2b88c091160..ea5700038f4bd91320ae8a82fc10e4b2bf0982f4 100644 --- a/src/slang/astronomy/radial_velocity_binary.sl +++ b/src/slang/astronomy/radial_velocity_binary.sl @@ -6,15 +6,15 @@ define radial_velocity_binary() %\synopsis{computes the radial velocity of a binary system as a function of orbital phase or time} %\usage{Double_Type v = radial_velocity_binary(Double_Type x);} %\qualifiers{ -%\qualifier{v0}{: systemic velocity} -%\qualifier{K}{: velocity semi amplitude, in km/s} -%\qualifier{asini}{: value of a * sin i, in kilometers} -%\qualifier{P}{: orbital period, in days} -%\qualifier{T0}{: epoch of periastron, x means time in days} -%\qualifier{T90}{: epoch of mean longitude 90 degr, x means time in days} -%\qualifier{e}{: eccentricity (0 <= e < 1)} -%\qualifier{omega}{: longitude of periastron in radian (unless degrees is set), default = 0} -%\qualifier{degrees}{: omega is measured in degrees instead of radian} +%\qualifier{v0}{systemic velocity} +%\qualifier{K}{velocity semi amplitude, in km/s} +%\qualifier{asini}{value of a * sin i, in kilometers} +%\qualifier{P}{orbital period, in days} +%\qualifier{T0}{epoch of periastron, x means time in days} +%\qualifier{T90}{epoch of mean longitude 90 degr, x means time in days} +%\qualifier{e}{eccentricity (0 <= e < 1)} +%\qualifier{omega}{longitude of periastron in radian (unless degrees is set), default = 0} +%\qualifier{degrees}{omega is measured in degrees instead of radian} %} %\description % x has the meaning of orbital phase (0 <= x < 1) unless T0 or T90 is specified. diff --git a/src/slang/astronomy/solve_Lane_Emden_equation.sl b/src/slang/astronomy/solve_Lane_Emden_equation.sl index d07bd300bc3817ca42abd12cdf9796ba91dfbc88..a6f1477fd285154dee39ca15e7d838b020277512 100644 --- a/src/slang/astronomy/solve_Lane_Emden_equation.sl +++ b/src/slang/astronomy/solve_Lane_Emden_equation.sl @@ -56,7 +56,7 @@ define solve_Lane_Emden_equation() %{{{ % which then allows an adaptive Runge-Kutta method of 4./5. order % to be applied. %\qualifiers{ -%\qualifier{tol}{ [=1e-10]: Absolute error control tolerance. Lower limit is 1e-15.} +%\qualifier{tol}{[=1e-10] Absolute error control tolerance. Lower limit is 1e-15.} %} %\example % s = solve_Lane_Emden_equation(3); diff --git a/src/slang/astronomy/sunpos.sl b/src/slang/astronomy/sunpos.sl index 29b6295aacda22d80faa983e32415727e3577707..9be4b49d3871c6d1d6285b51d946641ef899a65f 100644 --- a/src/slang/astronomy/sunpos.sl +++ b/src/slang/astronomy/sunpos.sl @@ -15,9 +15,9 @@ define sunpos () % Note: Function adopted from the IDL function with the same name. % See there for accuracy tests, which should also apply here. %\qualifiers{ -%\qualifier{MJD}{: give time in MJD instead of JD} -%\qualifier{radian}{: return all variables as radians rather than degrees} -%\qualifier{hour}{: return RA in hours rather than degrees (not possible when radian is set).} +%\qualifier{MJD}{give time in MJD instead of JD} +%\qualifier{radian}{return all variables as radians rather than degrees} +%\qualifier{hour}{return RA in hours rather than degrees (not possible when radian is set).} %} %\example % (eq, ecl) = sunpos(2455055.5) ; diff --git a/src/slang/astronomy/vsop87.sl b/src/slang/astronomy/vsop87.sl index bab1f6c48911c6a854447052fb08a3fec35e10b1..eef6f35821efb17e619ba30ccdf93210e0bb1075 100644 --- a/src/slang/astronomy/vsop87.sl +++ b/src/slang/astronomy/vsop87.sl @@ -53,22 +53,22 @@ define vsop87() % functions provide simpler interfaces. % %\qualifiers{ -% \qualifier{mjd}{: The argument is in MJD(TT), not in JD(TT)} -% \qualifier{tdb}{: The argument is in TDB, not TT} -% \qualifier{barycentric}{: Return coordinates with respect to the solar system barycenter rather +% \qualifier{mjd}{The argument is in MJD(TT), not in JD(TT)} +% \qualifier{tdb}{The argument is in TDB, not TT} +% \qualifier{barycentric}{Return coordinates with respect to the solar system barycenter rather % than heliocentric coordinates. This implies that coordinates are for J2000.} -% \qualifier{spherical}{: Return spherical coordinates in the ecliptical coordinate system. +% \qualifier{spherical}{Return spherical coordinates in the ecliptical coordinate system. % Only possible for heliocentric data. % In this case the structure returned contains the elements % lat, lon, r, latdot, londot, rdot, where lat and lon are the ecliptical % latitude and longitude (in rad), r is the distance in AU, and % latdot, londot, rdot are their time derivatives (in rad/day or % AU/day, respectively.)} -% \qualifier{mean_equinox}{: Coordinates are given in the frame defined by the +% \qualifier{mean_equinox}{Coordinates are given in the frame defined by the % mean equinox and ecliptic of the date. In VSOP87, this % system is derived from the J2000 one by pure precessional % motion. The default is to return J2000 coordinates.} -% \qualifier{elements}{: Return the orbital elements. The structure contains +% \qualifier{elements}{Return the orbital elements. The structure contains % the following tags: % a: semi-major axis (in AU) % l: mean longitude (rad) @@ -82,16 +82,16 @@ define vsop87() % i: inclination (rad) % omega: longitude of the ascending node (also called G) % } -% \qualifier{deg}{: All angle quantities to be returned are in deg, or deg/day.} -% \qualifier{mks}{: All distances returned by the function are given in meters or m/s, depending +% \qualifier{deg}{All angle quantities to be returned are in deg, or deg/day.} +% \qualifier{mks}{All distances returned by the function are given in meters or m/s, depending % on the deg qualifier, angles are returned in rad and rad/s or deg and deg/s.} -% \qualifier{cgs}{: Dito, but use centimeters instead of meters.} -% \qualifier{vsopfile}{: Path to file containing the VSOP quantities; only necessary if +% \qualifier{cgs}{Dito, but use centimeters instead of meters.} +% \qualifier{vsopfile}{Path to file containing the VSOP quantities; only necessary if % this is a non-standard installation of isisscripts. This qualifier is % only used if the vsop87 data have not yet been read. % By default, the file with the coefficients is searched for in the % directory pointed to by the environment variable ISISSCRIPTS_REFPATH.} -% \qualifier{forcearray}{: Force the tags in the returned struct to be arrays. The default is +% \qualifier{forcearray}{Force the tags in the returned struct to be arrays. The default is % that they are arrays only if JD is an array.} %} %\seealso{planetpos,jpl_eph,jpl_eph_vec} diff --git a/src/slang/color/rgb2gray.sl b/src/slang/color/rgb2gray.sl index 9b41d3fd9cd0696640a7571ba8c9a9e3f2968623..c5ae02eb99ef6b33f265efef7ed0cff40831fcc8 100644 --- a/src/slang/color/rgb2gray.sl +++ b/src/slang/color/rgb2gray.sl @@ -13,8 +13,8 @@ define rgb2gray() % The 8 bit gray value(s) are return as % Integer_Type[] in the interval [0,255]. %\qualifiers{ -%\qualifier{norm}{: return values are in Double_Type interval [0,1].} -%\qualifier{rgb}{: return values as single RGB encoding: +%\qualifier{norm}{return values are in Double_Type interval [0,1].} +%\qualifier{rgb}{return values as single RGB encoding: % GRAY << 16 | GRAY << 8 | GRAY} %} % diff --git a/src/slang/color/rgb2hex.sl b/src/slang/color/rgb2hex.sl index 99ac5c278a16b11c86140707d705709a21bf9142..eaff389dbd69e3a361738956b03bd99efcc8aa19 100644 --- a/src/slang/color/rgb2hex.sl +++ b/src/slang/color/rgb2hex.sl @@ -4,8 +4,8 @@ define rgb2hex() %\synopsis{converts r, g, b values between 0 and 1 to a 24-bit integer} %\usage{Integer_Type rgb2hex(Double_Type r, g, b)} %\qualifiers{ -%\qualifier{str}{: return value is a string with preceding "#".} -%\qualifier{des}{: input color will be desaturated to gray-scale values. +%\qualifier{str}{return value is a string with preceding "#".} +%\qualifier{des}{input color will be desaturated to gray-scale values. % If a value is given, the saturation will be scaled accordingly.} %} %\seealso{rgb2hsl} diff --git a/src/slang/color/rgb2r_g_b.sl b/src/slang/color/rgb2r_g_b.sl index 13e3822626f1eec2cea8ac17690fa16e96ee67b5..e127d8d2f61f70e9d369c47cfc065987d70aee1b 100644 --- a/src/slang/color/rgb2r_g_b.sl +++ b/src/slang/color/rgb2r_g_b.sl @@ -9,8 +9,8 @@ define rgb2r_g_b( rgb ) % The return value is a(n array of) 24 bit RGB value(s) % in Integer_Type interval [0,255]. %\qualifiers{ -%\qualifier{norm}{: return values are in Double_Type interval [0,1].} -%\qualifier{str}{: If qualifier is given ('str'=NULL) r,g,b will be retruned +%\qualifier{norm}{return values are in Double_Type interval [0,1].} +%\qualifier{str}{If qualifier is given ('str'=NULL) r,g,b will be retruned % as strings. If 'str' != NULL, e.g., 'str'=',', than % the singe color channels are combined and returned: % r + str + g + str + b} diff --git a/src/slang/color/xfig_mix_colors.sl b/src/slang/color/xfig_mix_colors.sl index f391dbb6944016f8430351706d621002ae7b200a..f23e03c613d546221ad3958f9eb11ac0e5d31b90 100644 --- a/src/slang/color/xfig_mix_colors.sl +++ b/src/slang/color/xfig_mix_colors.sl @@ -6,7 +6,7 @@ define xfig_mix_colors(color1,color2,fraction) { %\synopsis{mix two named xfig colors} %\usage{xfig_mix_colors(color1,color2,fraction)} %\qualifiers{ -%\qualifier{name}{: xfig name of the color mix} +%\qualifier{name}{xfig name of the color mix} %} %\description % This function mixes two named xfig colors in rgb space. The function looks up diff --git a/src/slang/date/DateOfJD.sl b/src/slang/date/DateOfJD.sl index 248520783cc1a089f6fe48ff28590a2f46037037..c4abcbff2e58f217a17bd253d7ba8a074df0cb3f 100644 --- a/src/slang/date/DateOfJD.sl +++ b/src/slang/date/DateOfJD.sl @@ -9,7 +9,7 @@ define DateOfJD() { % The algorithm used is that by Meeus, Astronomical Formulae for % Calculators. This routine is array safe. %\qualifiers{ -%\qualifier{julianswitch}{: For JD smaller than this date, return the date +%\qualifier{julianswitch}{For JD smaller than this date, return the date % in the Julian calendar rather than in the Gregorian % calendar. The default is JD2299161 (15 October 1582), % which is appropriate for most of catholic Europe. @@ -17,9 +17,9 @@ define DateOfJD() { % only much later (see https://en.wikipedia.org/wiki/Julian_calendar % and https://de.wikipedia.org/wiki/Gregorianischer_Kalender). % For example, Russia only switched on 1 February 1918 (Gregorian).} -%\qualifier{julian_calendar}{: force returning the date in the Julian Calendar +%\qualifier{julian_calendar}{force returning the date in the Julian Calendar % (ignore julianswitch)} -%\qualifier{gregorian_calendar}{: force returning the date in the Gregorian Calendar +%\qualifier{gregorian_calendar}{force returning the date in the Gregorian Calendar % (ignore julianswitch)} %} %\seealso{JDofDate, MJDofDate} diff --git a/src/slang/date/EasterSunday.sl b/src/slang/date/EasterSunday.sl index 307061223cdfcbd1eabc68da0ea0b0fe93d93649..612ded93e67f389319ff7c34d1f29eee5f62a6d5 100644 --- a/src/slang/date/EasterSunday.sl +++ b/src/slang/date/EasterSunday.sl @@ -14,15 +14,15 @@ define EasterSunday() %This function is array safe, i.e., an array of years can be given. % %\qualifiers{ -%\qualifier{mjd}{: Return dates in MJD, not in JD.} -%\qualifier{orthodox}{: Return the JD of Easter Sunday using the rules +%\qualifier{mjd}{Return dates in MJD, not in JD.} +%\qualifier{orthodox}{Return the JD of Easter Sunday using the rules % appropriate for Eastern Christianity such as the % Russian Orthodox church.} -%\qualifier{get_date}{: Return date as a struct (year, month, date, hour, +%\qualifier{get_date}{Return date as a struct (year, month, date, hour, % minute, second). If the orthodox keyword is given, % the date will be in the Julian calendar, otherwise % it will be in the Gregorian calendar.} -%\qualifier{backward}{: an undocumented function with the same name +%\qualifier{backward}{An undocumented function with the same name % as this one existed in the isisscripts until % 17 January 2020. It returned the date of Easter Sunday % in the Gregorian calendar as the number of days diff --git a/src/slang/date/EpochofJD.sl b/src/slang/date/EpochofJD.sl index 4aed39123e9a5571da6c77b3691c0626042cca8b..b6613970cc2cd87082011d4fae2baaeede618773 100644 --- a/src/slang/date/EpochofJD.sl +++ b/src/slang/date/EpochofJD.sl @@ -4,9 +4,9 @@ define EpochofJD() %\synopsis{Returns the Julian or Besselian epoch of a (M)JD} %\usage{epoch=EpochofJD(jd;qualifiers)} %\qualifiers{ -%\qualifier{mjd}{: argument is a modified julian date, not a JD} -%\qualifier{besselian}{: return the Besselian epoch} -%\qualifier{julian}{: return the Julian epoch (the default)} +%\qualifier{mjd}{argument is a modified julian date, not a JD} +%\qualifier{besselian}{return the Besselian epoch} +%\qualifier{julian}{return the Julian epoch (the default)} %} %\description % This function converts a (modified) julian date into the corresponding diff --git a/src/slang/date/GMST.sl b/src/slang/date/GMST.sl index b27363229a8c63640cfd5d58e2d3778e135f113c..22bf81ba12c7dfb8860ed40aead6f7f5222ce76b 100755 --- a/src/slang/date/GMST.sl +++ b/src/slang/date/GMST.sl @@ -5,22 +5,22 @@ define GMST() %\usage{Double_Type GST = GMST(Double_Type JD);} % %\qualifiers{ -%\qualifier{hour}{: Return the GMST in hours, not in seconds.} -%\qualifier{dut1}{: The difference UT1-UTC in seconds (see IERS Bull. A).} -%\qualifier{mjd}{: Argument is in MJD, not in JD.} -%\qualifier{gast}{: Return the Greenwhich Apparent Siderial Time, GAST.} -%\qualifier{era}{: Return the Earth rotation angle (in rotations).} -%\qualifier{lst}{: Return the local mean siderial time LST.} -%\qualifier{lon}{: longitude for the calculation of the LST (east is positive; +%\qualifier{hour}{Return the GMST in hours, not in seconds.} +%\qualifier{dut1}{The difference UT1-UTC in seconds (see IERS Bull. A).} +%\qualifier{mjd}{Argument is in MJD, not in JD.} +%\qualifier{gast}{Return the Greenwhich Apparent Siderial Time, GAST.} +%\qualifier{era}{Return the Earth rotation angle (in rotations).} +%\qualifier{lst}{Return the local mean siderial time LST.} +%\qualifier{lon}{longitude for the calculation of the LST (east is positive; % in geodetic [ITRS] coordinates, for % practical purposes these are identical to the % WGS-84 coordinates given by GPS).} -%\qualifier{lat}{: latitude for the calculation of the LST (north is positive, +%\qualifier{lat}{latitude for the calculation of the LST (north is positive, % only needed if xp and yp are given)} -%\qualifier{deg}{: lon and lat are in degrees, not in radian.} -%\qualifier{xp}{: x-coordinate of the Celestial Intermediate Pole (CIP) +%\qualifier{deg}{lon and lat are in degrees, not in radian.} +%\qualifier{xp}{x-coordinate of the Celestial Intermediate Pole (CIP) % ALWAYS in arcseconds, as given by the IERS bulletin.} -%\qualifier{yp}{: y-coordinate of the CIP, ALWAYS in arcseconds.} +%\qualifier{yp}{y-coordinate of the CIP, ALWAYS in arcseconds.} %} %\description % This code calculates the Greenwich Mean Siderial Time and the diff --git a/src/slang/date/GreenwichSiderealTime_from_MJD.sl b/src/slang/date/GreenwichSiderealTime_from_MJD.sl index 4bfb102a1a8f5575740b4511433197efe38d4001..66065dc42ccc9ff7d1e02461ade9e3fbff62b53c 100644 --- a/src/slang/date/GreenwichSiderealTime_from_MJD.sl +++ b/src/slang/date/GreenwichSiderealTime_from_MJD.sl @@ -8,7 +8,7 @@ define GreenwichSiderealTime_from_MJD() % \code{MJD} is the Modified Julian Date (*in UT*). % This routine is a wrapper around GMST(JD), and only % kept for compatibility reasons. -% This function is deprecated. Please do not use for future work. +% This function is DEPRECATED. Please do not use for future work. %\seealso{GMST} %!%- { diff --git a/src/slang/date/JDofDate.sl b/src/slang/date/JDofDate.sl index c3ee3bf2dd5b55bd3bd16ebfcd86cdfb1103afd9..9498c510e766838528543006f6f340b2ea6f7f63 100644 --- a/src/slang/date/JDofDate.sl +++ b/src/slang/date/JDofDate.sl @@ -5,6 +5,11 @@ define JDofDate() %\usage{Double_Type JD = JDofDate( struct { year, month, day, hour, minute, second } ); %\altusage{Double_Type JD = JDofDate(year, month, day[, hour[, minute[, second]]]);} %} +%\qualifiers{ +%\qualifier{mjd}{return the MJD, i.e., JD-2400000.5} +%\qualifier{julian_calendar}{return the JD/MJD assuming the +% Julian calendar rather than the Gegorian one} +%} %\description % This routine calculates the Julian Date for a given Gregorian date % following the routine by Fliegel and van Flandern (1968, Comm. ACM 11, 657) @@ -23,13 +28,8 @@ define JDofDate() % taken into account. % % The year must be larger than -4716 (4717 BC). -% -%\qualifiers{ -%\qualifier{mjd}{: return the MJD, i.e., JD-2400000.5} -%\qualifier{julian_calendar}{: return the JD/MJD assuming the Julian calendar rather -% than the Gegorian one} -%} % This function is array safe. +% %\seealso{MJDofDate,dateOfMJD} %!%- { diff --git a/src/slang/date/JDofEpoch.sl b/src/slang/date/JDofEpoch.sl index e5044ebd8efc395f2902c7326176b4221f856b86..74eb61fee676e4611bdc3cd5e50f03d0d46f8471 100644 --- a/src/slang/date/JDofEpoch.sl +++ b/src/slang/date/JDofEpoch.sl @@ -4,7 +4,7 @@ define JDofEpoch() %\synopsis{Returns the (M)JD of a Julian or Besselian epoch such as J2000.0} %\usage{jd=JDofEpoch(epochstring;qualifiers)} %\qualifiers{ -%\qualifier{mjd}{: Return the modified julian date (default: JD)} +%\qualifier{mjd}{Return the modified julian date (default: JD)} %} %\description % This function returns the julian date corresponding to a diff --git a/src/slang/date/MJDofDate.sl b/src/slang/date/MJDofDate.sl index 84b7783804fb8296fdfc326c8baae3b1c93eb8ef..2586832fedabf8acffcdc2055d3f6a828dac0f31 100644 --- a/src/slang/date/MJDofDate.sl +++ b/src/slang/date/MJDofDate.sl @@ -14,7 +14,7 @@ define MJDofDate() % This function is array safe and equivalent to calling JDofDate with the % mjd qualifier. %\qualifiers{ -%\qualifier{julian_calendar}{: return the JD/MJD for the date in the Julian calendar rather +%\qualifier{julian_calendar}{return the JD/MJD for the date in the Julian calendar rather % the Gegorian date. This does not make much sense for the MJD, which was negative % for the time when the Julian calendar was used.} %} diff --git a/src/slang/date/MJDofDateString.sl b/src/slang/date/MJDofDateString.sl index aea57b7797a8c3716d493370d80514dfc1e66243..8339f5e3c085a9efdcebd93ce33c30336350638f 100644 --- a/src/slang/date/MJDofDateString.sl +++ b/src/slang/date/MJDofDateString.sl @@ -4,8 +4,8 @@ define MJDofDateString () %\synopsis{calculates the MJD from a string including year, month, day [, hour [, minute [, second]]]} %\usage{Double_Type \code{mjd} = MJDofDateString(String_Type \code{date_string});} %\qualifiers{ -%\qualifier{verbose}{: prints the found values for YYYY-MM-DD hh:mm:ss.sss} -%\qualifier{no_2digit_correction}{: see `parseDateString`} +%\qualifier{verbose}{prints the found values for YYYY-MM-DD hh:mm:ss.sss} +%\qualifier{no_2digit_correction}{see `parseDateString`} %} %\description % This function calculates the Modified Julian Date from a String @@ -13,7 +13,7 @@ define MJDofDateString () %\example % MJDofDateString("69/07/21"); % MJDofDateString("1969-07-21 02:56:30.44"); -% MJDofDateString("sdf1969--$07..21QQ_02/56((30,,44xyz"); +% MJDofDateString("sdf1969--X07..21QQ_02/56((30,,44xyz"); %\seealso{parseDateString} %!%- { diff --git a/src/slang/date/equation_equinoxes.sl b/src/slang/date/equation_equinoxes.sl index ffaa839addec1a7c1f581203e656d90a1b8fdd95..1a9db635bfab4e9b3bd71b4c0fe1b27cfa5f9ff8 100644 --- a/src/slang/date/equation_equinoxes.sl +++ b/src/slang/date/equation_equinoxes.sl @@ -3,11 +3,11 @@ define equation_equinoxes() { %\function{equation_equinoxes} %\usage { egam = equation_equinoxes(JD;qualifiers)} %\qualifiers{ -% \qualifier{mjd}{: the time argument is in MJD, not in JD} -% \qualifier{deg}{: return equation of equinoxes in degrees} -% \qualifier{arcsec}{: return equation of equinoxes in arcseconds} -% \qualifier{mas}{: return equation of equinoxes in milliarcseconds} -% \qualifier{seconds}{: return equation of equinoxes in seconds} +% \qualifier{mjd}{the time argument is in MJD, not in JD} +% \qualifier{deg}{return equation of equinoxes in degrees} +% \qualifier{arcsec}{return equation of equinoxes in arcseconds} +% \qualifier{mas}{return equation of equinoxes in milliarcseconds} +% \qualifier{seconds}{return equation of equinoxes in seconds} %} % %\description diff --git a/src/slang/date/jd2year.sl b/src/slang/date/jd2year.sl index b9e8cc460e4e900798f9d796a28d72ff274fc7f6..0ef32af869401c4298111ee478641165cb202fc6 100644 --- a/src/slang/date/jd2year.sl +++ b/src/slang/date/jd2year.sl @@ -4,7 +4,7 @@ define jd2year() %\synopsis{transform a JD into a fractional year} %\usage{Double_Type year = jd2year(Double_Type JD);} %\qualifiers{ -%\qualifier{mjd}{: The argument is given in MJD, not in JD.} +%\qualifier{mjd}{The argument is given in MJD, not in JD.} %} %\description % NOTE: This routine takes into account leap years. This is good for diff --git a/src/slang/date/orbitalphase.sl b/src/slang/date/orbitalphase.sl index 97590069a0cec0cb3e253f831b19d6e2bb9e7191..ff6a939f8d6c301577142c8a25bba6ef73426fd9 100644 --- a/src/slang/date/orbitalphase.sl +++ b/src/slang/date/orbitalphase.sl @@ -15,7 +15,7 @@ define orbitalphase() % If \code{orbitalphase} is called with an unknown \code{ephemeris}, % the allowed values are shown by \code{get_ephemeris}. %\qualifiers{ -%\qualifier{numpulse}{: return pulse number instead of phase} +%\qualifier{numpulse}{return pulse number instead of phase} %} %\seealso{get_ephemeris} %!%- diff --git a/src/slang/date/parseDateString.sl b/src/slang/date/parseDateString.sl index d7af1c5a092da5dad4af33561181ec825acae5a1..d54cdcb34aef807c43c7f56a7ad65b3c99fbcae7 100644 --- a/src/slang/date/parseDateString.sl +++ b/src/slang/date/parseDateString.sl @@ -4,7 +4,7 @@ define parseDateString() %\synopsis{parses a string including year, month, day [, hour [, minute [, second]]]} %\usage{Struct_Type parseDateString(String_Type date_string);} %\qualifiers{ -%\qualifier{no_2digit_correction}{: prevents the correction of two digit year specification, +%\qualifier{no_2digit_correction}{prevents the correction of two digit year specification, % e.g., 83/12/13 instead of 1983/12/13. If this qualifier % is not set, 2000 is added to years from 00-19 and % 1900 to years 20-99.} @@ -21,7 +21,7 @@ define parseDateString() %\example % parseDateString("69/07/21"); % parseDateString("1969-07-21 02:56:30.44"); -% parseDateString("sdf1969--$07..21QQ_02/56((30,,44xyz"); +% parseDateString("sdf1969--X07..21QQ_02/56((30,,44xyz"); %\seealso{localtime} %!%- { diff --git a/src/slang/date/tai2tt.sl b/src/slang/date/tai2tt.sl index 62826558e208640e5af00777d63e341b299567ff..21cc1bc6772e05c138e4f4a80c468f3cf95ef1ec 100644 --- a/src/slang/date/tai2tt.sl +++ b/src/slang/date/tai2tt.sl @@ -10,8 +10,8 @@ define tai2tt() %adding 32.184s to the TT. This routine is array safe. % %\qualifiers{ -%\qualifier{mjd}{: The argument is given in MJD, not in JD.} -%\qualifier{deltat}{: Return the TT-TAI in seconds, rather than the corrected (M)JD.} +%\qualifier{mjd}{The argument is given in MJD, not in JD.} +%\qualifier{deltat}{Return the TT-TAI in seconds, rather than the corrected (M)JD.} %} %\seealso{utc2tai,tai2utc,tt2tai,tt2tdb} %!%- diff --git a/src/slang/date/time_array.sl b/src/slang/date/time_array.sl index fa51ec64e451ccfc33f0faf771c1d2979dca5bb1..2cce8145fc370a9536ab60396b883d573ff39b2f 100644 --- a/src/slang/date/time_array.sl +++ b/src/slang/date/time_array.sl @@ -5,7 +5,7 @@ define time_array( time ) %\usage{Integer_Type[] = time_array( Integer_Type );} %\altusage{String_Type = time_array( Integer_Type ; str);} %\qualifiers{ -%\qualifier{str}{: Instead of a time array a String_Type is returned!} +%\qualifier{str}{Instead of a time array a String_Type is returned!} %} %\description % Converts a time given in seconds into a time array, where diff --git a/src/slang/date/tt2tai.sl b/src/slang/date/tt2tai.sl index c4615f423a267137f71777dbfd835db036ba8b76..bcaae6ea5f93b1e4b4b279451c5938e63fc98b5f 100644 --- a/src/slang/date/tt2tai.sl +++ b/src/slang/date/tt2tai.sl @@ -9,8 +9,8 @@ define tt2tai() %TAI. This is done by subtracting 32.184s from the TT. % This routine is array safe. %\qualifiers{ -%\qualifier{mjd}{: The argument is given in MJD, not in JD.} -%\qualifier{deltat}{: Return the TAI-TT in seconds, rather than the corrected (M)JD.} +%\qualifier{mjd}{The argument is given in MJD, not in JD.} +%\qualifier{deltat}{Return the TAI-TT in seconds, rather than the corrected (M)JD.} %} %\seealso{utc2tai,tai2utc,tai2tt,tt2tdb} %!%- diff --git a/src/slang/date/tt2tcg.sl b/src/slang/date/tt2tcg.sl index b2c8adb95f46379963a2f40ae844c508c38db2d5..0dbe7c63ce44412145a47fde8ecb2012b6a178f7 100644 --- a/src/slang/date/tt2tcg.sl +++ b/src/slang/date/tt2tcg.sl @@ -11,8 +11,8 @@ define tt2tcg() %the SI second at the potential of the center of the Earth. % This routine is array safe. %\qualifiers{ -%\qualifier{mjd}{: The argument is given in MJD, not in JD.} -%\qualifier{deltat}{: Return the TCG-TT in seconds, rather than the corrected (M)JD.} +%\qualifier{mjd}{The argument is given in MJD, not in JD.} +%\qualifier{deltat}{Return the TCG-TT in seconds, rather than the corrected (M)JD.} %} %\seealso{tcg2tt,utc2tai,tai2utc,tai2tt,tt2tdb} %!%- @@ -66,8 +66,8 @@ define tcg2tt() %uses the SI second at the potential of the center of the Earth. % This routine is array safe. %\qualifiers{ -%\qualifier{mjd}{: The argument is given in MJD, not in JD.} -%\qualifier{deltat}{: Return the TT-TCG in seconds, rather than the corrected (M)JD.} +%\qualifier{mjd}{The argument is given in MJD, not in JD.} +%\qualifier{deltat}{Return the TT-TCG in seconds, rather than the corrected (M)JD.} %} %\seealso{tcg2tt,utc2tai,tai2utc,tai2tt,tt2tdb} %!%- diff --git a/src/slang/date/tt2tdb.sl b/src/slang/date/tt2tdb.sl index 1b63ddf90ebc2e5c58a134837557885830cc0c48..fd00e31cc22f567244b361bad19fc96160b52ba4 100644 --- a/src/slang/date/tt2tdb.sl +++ b/src/slang/date/tt2tdb.sl @@ -22,9 +22,9 @@ define tt2tdb() % %This routine is array safe. %\qualifiers{ -%\qualifier{mjd}{: The argument is given in MJD, not in JD.} -%\qualifier{deltat}{: Return the difference TDB-TT in seconds, rather than the corrected (M)JD.} -%\qualifier{ephemeris}{: if set and no argument, then correct using DE430, otherwise +%\qualifier{mjd}{The argument is given in MJD, not in JD.} +%\qualifier{deltat}{Return the difference TDB-TT in seconds, rather than the corrected (M)JD.} +%\qualifier{ephemeris}{if set and no argument, then correct using DE430, otherwise % use the ephemeris provided (see function jpl_initeph).} %} %\seealso{tdb2tt,utc2tai,tai2utc,tai2tt,jpl_initeph} @@ -125,9 +125,9 @@ define tdb2tt() % %This routine is array safe. %\qualifiers{ -%\qualifier{mjd}{: The argument is given in MJD, not in JD.} -%\qualifier{deltat}{: Return the difference TT-TDB in seconds, rather than the corrected (M)JD.} -%\qualifier{ephemeris}{: if set and no argument, then correct using DE430, otherwise +%\qualifier{mjd}{The argument is given in MJD, not in JD.} +%\qualifier{deltat}{Return the difference TT-TDB in seconds, rather than the corrected (M)JD.} +%\qualifier{ephemeris}{if set and no argument, then correct using DE430, otherwise % use the ephemeris provided (see function jpl_initeph).} %} %\seealso{tdb2tt,utc2tai,tai2utc,tai2tt,jpl_initeph} diff --git a/src/slang/date/ut12tt.sl b/src/slang/date/ut12tt.sl index 532676f7ee5ed6a708f311db588db317211282fc..8baece2d977e2e8565d5eae87f662a5489c5c9c7 100644 --- a/src/slang/date/ut12tt.sl +++ b/src/slang/date/ut12tt.sl @@ -16,36 +16,36 @@ define ut12tt() { %\function{ut12tt} %\synopsis{Convert a (M)JD in UT1 into TT} %\usage{utc=ut12tt(JD)} -%\description -%This function converts a (Modified) Julian Date that is given in UT1, -%i.e., the timescale that defines the earth rotation angle, -%into a (M)JD in TT. -% -%By default, for years before 2005 the function uses the polynomial -%expressions for TT-UT1 published by F. Espenak and J. Meeus, 2006, -%Five Millenium Canon of Solar Eclipses: -1999 to +3000, -%NASA TP-2006-214141, for years after 2005 the polynomials published -%by Espenak at http://www.eclipsewise.com/help/deltatpoly2014.html are -%used. -% -%Alternatively, a linar interpolation in the solar eclipse derived -%data by Morrison and Stephenson (2000) can be used (see morrison -%qualifier). -% -%The uncertainty of the result is 1s or less from 1780 until 1830, -%less than 1s from 1830-2000. It increases quadratically backwards -%from 1820, sigma ~32((year-1820)/100)^2. -% -%This routine is array safe. % %\qualifiers{ -%\qualifier{mjd}{: The argument is given in MJD, not in JD.} -%\qualifier{deltat}{: Return the TT-UT1 in seconds, rather than the corrected (M)JD.} -%\qualifier{morrison}{: perform the correction using a linear interpolation +%\qualifier{mjd}{The argument is given in MJD, not in JD.} +%\qualifier{deltat}{Return the TT-UT1 in seconds, rather than the corrected (M)JD.} +%\qualifier{morrison}{Perform the correction using a linear interpolation % to the points by Morrison and Stephenson, 2004, % Journal for the History of Astronomy 35, 327. % Not really good after 2000} %} +%\description +% This function converts a (Modified) Julian Date that is given in UT1, +% i.e., the timescale that defines the earth rotation angle, +% into a (M)JD in TT. +% +% By default, for years before 2005 the function uses the polynomial +% expressions for TT-UT1 published by F. Espenak and J. Meeus, 2006, +% Five Millenium Canon of Solar Eclipses: -1999 to +3000, +% NASA TP-2006-214141, for years after 2005 the polynomials published +% by Espenak at http://www.eclipsewise.com/help/deltatpoly2014.html are +% used. +% +% Alternatively, a linar interpolation in the solar eclipse derived +% data by Morrison and Stephenson (2000) can be used (see morrison +% qualifier). +% +% The uncertainty of the result is 1s or less from 1780 until 1830, +% less than 1s from 1830-2000. It increases quadratically backwards +% from 1820, sigma ~32((year-1820)/100)^2. +% +% This function is array safe. %\seealso{tt2ut1,utc2tai,tai2utc,tai2tt} %!%- variable JD; @@ -171,40 +171,40 @@ define tt2ut1() { %\function{tt2ut1} %\synopsis{Convert a (M)JD in TT into UT1} %\usage{ut1=tt2ut1(JD)} +%\qualifiers{ +%\qualifier{mjd}{The argument is given in MJD, not in JD.} +%\qualifier{deltat}{Return the TT-UT1 in seconds, rather than the corrected (M)JD.} +%\qualifier{morrison}{Perform the correction using a linear interpolation +% to the points by Morrison and Stephenson, 2004, +% Journal for the History of Astronomy 35, 327. +% Not good after 2000.} +%} %\description % -%This function converts a (Modified) Julian Date that is given in -%TT into UT1, i.e., the timescale that defines the earth rotation angle. +% This function converts a (Modified) Julian Date that is given in +% TT into UT1, i.e., the timescale that defines the earth rotation angle. % -%By default, for years before 2005 the function uses the polynomial -%expressions for TT-UT1 published by F. Espenak and J. Meeus, 2006, -%Five Millenium Canon of Solar Eclipses: -1999 to +3000, -%NASA TP-2006-214141, for years after 2005 the polynomials published -%by Espenak at http://www.eclipsewise.com/help/deltatpoly2014.html are -%used. +% By default, for years before 2005 the function uses the polynomial +% expressions for TT-UT1 published by F. Espenak and J. Meeus, 2006, +% Five Millenium Canon of Solar Eclipses: -1999 to +3000, +% NASA TP-2006-214141, for years after 2005 the polynomials published +% by Espenak at http://www.eclipsewise.com/help/deltatpoly2014.html are +% used. % -%Alternatively, a linar interpolation in the solar eclipse derived -%data by Morrison and Stephenson (200$) can be used (see morrison -%qualifier). +% Alternatively, a linar interpolation in the solar eclipse derived +% data by Morrison and Stephenson (2000) can be used (see morrison +% qualifier). % -%The uncertainty of the result is 1s or less from 1780 until 1830, -%less than 1s from 1830-2000. It increases quadratically backwards -%from 1820, sigma ~32((year-1820)/100)^2. +% The uncertainty of the result is 1s or less from 1780 until 1830, +% less than 1s from 1830-2000. It increases quadratically backwards +% from 1820, sigma ~32((year-1820)/100)^2. % -%This routine is array safe. +% This routine is array safe. % -%Note: Because of the uncertainty in TT-UT1, the same -%polynomial is used for the TT->UT1 and UT1->TT conversion, -%and therefore it generally is NOT true that JD==ut12tt(tt2ut1(JD)). +% Note: Because of the uncertainty in TT-UT1, the same +% polynomial is used for the TT->UT1 and UT1->TT conversion, +% and therefore it generally is NOT true that JD==ut12tt(tt2ut1(JD)). % -%\qualifiers{ -%\qualifier{mjd}{: The argument is given in MJD, not in JD.} -%\qualifier{deltat}{: Return the TT-UT1 in seconds, rather than the corrected (M)JD.} -%\qualifier{morrison}{: perform the correction using a linear interpolation -% to the points by Morrison and Stephenson, 2004, -% Journal for the History of Astronomy 35, 327. -% Not good after 2000.} -%} %\seealso{ut12tt,utc2tai,tai2utc,tai2tt} %!%- variable JD; diff --git a/src/slang/date/utc2tai.sl b/src/slang/date/utc2tai.sl index 4c93aa2d813644d718a6321d06f2dc652a1f37a0..92730fc2625f57c06100ca8dc366365d9a061b94 100644 --- a/src/slang/date/utc2tai.sl +++ b/src/slang/date/utc2tai.sl @@ -54,13 +54,13 @@ define utc2tai() %Universal Time, UTC) into International Atomic Time (TAI) by applying %the relevant correction for leap seconds. This routine is array safe. %\qualifiers{ -%\qualifier{mjd}{: The argument is given in MJD, not in JD.} -%\qualifier{deltat}{: Return the TAI-UTC in seconds, rather than the corrected (M)JD.} -%\qualifier{leapfile}{: path to a file containing the leap second +%\qualifier{mjd}{The argument is given in MJD, not in JD.} +%\qualifier{deltat}{Return the TAI-UTC in seconds, rather than the corrected (M)JD.} +%\qualifier{leapfile}{path to a file containing the leap second % information. This file is available, e.g., from % ftp://maia.usno.navy.mil/ser7/tai-utc.dat % Most astronomical software systems distribute this file. The default -% is to look for it in $LHEASOFT/refdata} +% is to look for it in getenv("LHEASOFT")/refdata} %} %\seealso{utc2tai,tt2tai,tai2tt} %!%- @@ -128,13 +128,13 @@ define tai2utc() %minute of a leap second this routine can be off by as much as %one second. %\qualifiers{ -%\qualifier{mjd}{: The argument is given in MJD, not in JD.} -%\qualifier{deltat}{: Return the UTC-TAI in seconds, rather than the corrected (M)JD.} -%\qualifier{leapfile}{: path to a file containing the leap second +%\qualifier{mjd}{The argument is given in MJD, not in JD.} +%\qualifier{deltat}{Return the UTC-TAI in seconds, rather than the corrected (M)JD.} +%\qualifier{leapfile}{Path to a file containing the leap second % information. This file is available, e.g., from % ftp://maia.usno.navy.mil/ser7/tai-utc.dat % Most astronomical software systems distribute this file. The default -% is to look for it in $LHEASOFT/refdata} +% is getenv("LHEASOFT")/refdata} %} %\seealso{utc2tai,tt2tai,tai2tt} %!%- diff --git a/src/slang/edit_var.sl b/src/slang/edit_var.sl index e387deb6d85b49888dde56abf1a127396338d35b..5cf84897063845c87dbe907ed8bd40260854f96e 100644 --- a/src/slang/edit_var.sl +++ b/src/slang/edit_var.sl @@ -113,7 +113,7 @@ define edit_var() %\altusage{Any_Type y = edit_var(Any_Type x);} %} %\qualifiers{ -%\qualifier{tmpfile}{: temporary file [default: /tmp/edit_var_$UID_$PID]} +%\qualifier{tmpfile}{temporary file [default: /tmp/edit_var_$UID_$PID]} %} %\description % edit_var supports the following data types: diff --git a/src/slang/geometry/clip_points_polygon.sl b/src/slang/geometry/clip_points_polygon.sl index 52016f7b821c3c7cafa2e0fa83f6d06a4a7540cc..ed932c811d04fbd6885d8e331093e7db5c4d381f 100644 --- a/src/slang/geometry/clip_points_polygon.sl +++ b/src/slang/geometry/clip_points_polygon.sl @@ -11,17 +11,17 @@ define clip_points_polygon() %} % %\description -%This function clips points defined by (x,y), where x and y can be arrays, -%against a closed polygon defined by the arrays (xp, yp) and returns the -%clipped points (xc,yc) where xc, yc are arrays (which can be empty -%if all points are outside of the polygon). Here, a closed polygon -%means that xp[0]==xp[-1] and yp[0]==yp[-1]. +% This function clips points defined by (x,y), where x and y can be arrays, +% against a closed polygon defined by the arrays (xp, yp) and returns the +% clipped points (xc,yc) where xc, yc are arrays (which can be empty +% if all points are outside of the polygon). Here, a closed polygon +% means that xp[0]==xp[-1] and yp[0]==yp[-1]. % -%Alternatively, the points and polygon can be defined as structs, -%where points=struct{ x=[], y=[] } and where the polygon is defined -%as poly=struct{x=xp,y=yp} +% Alternatively, the points and polygon can be defined as structs, +% where points=struct{ x=[], y=[] } and where the polygon is defined +% as poly=struct{x=xp,y=yp} % -%The qualifiers define what to consider the "inside" of the polygon. +% The qualifiers define what to consider the "inside" of the polygon. % %\seealso{clip_points_rectangle, greiner_hormann, point_in_polygon} % diff --git a/src/slang/geometry/clip_polyline_polygon.sl b/src/slang/geometry/clip_polyline_polygon.sl index eda0938b646128c642ee69df9b9416eeb5e5dfbd..0c95861324f4de3d4e790c2654031e354f6573e5 100755 --- a/src/slang/geometry/clip_polyline_polygon.sl +++ b/src/slang/geometry/clip_polyline_polygon.sl @@ -3,25 +3,25 @@ define clip_polyline_polygon(polyline,polygon) %\function{clip_polyline_polygon} %\usage{clipped=clip_polyline_polygon(line,polygon)} %\qualifiers{ -%\qualifier{evenodd}{: use the crossing number method} -%\qualifier{crossing}{: use the crossing number method} -%\qualifier{winding}{: use the winding number method (the default)} +%\qualifier{evenodd}{use the crossing number method} +%\qualifier{crossing}{use the crossing number method} +%\qualifier{winding}{use the winding number method (the default)} %} %\description -%This function clips a polyline defined by line=struct{x=[],y=[]}, -%where x and y are the points connected by the polyline, against -%a closed polygon=struct{x=[],y=[]}, where again x and y are the points -%connected by the polygon and where x[0]==x[-1] and y[0]==y[-1]. +% This function clips a polyline defined by line=struct{x=[],y=[]}, +% where x and y are the points connected by the polyline, against +% a closed polygon=struct{x=[],y=[]}, where again x and y are the points +% connected by the polygon and where x[0]==x[-1] and y[0]==y[-1]. % -%The function returns a list of polylines that contain the segments -%of the line that are inside of the polygon. This list can be empty if -%there is no overlap. +% The function returns a list of polylines that contain the segments +% of the line that are inside of the polygon. This list can be empty if +% there is no overlap. % -%For complex polygons with intersecting segments, the qualifier defines -%what constitues the inside of the polygon. +% For complex polygons with intersecting segments, the qualifier defines +% what constitues the inside of the polygon. % -%If you want to clip against a simple rectangle, use clip_polyline_rectangle -%for a faster algorithm. +% If you want to clip against a simple rectangle, use clip_polyline_rectangle +% for a faster algorithm. % %\seealso{point_in_polygon,clip_polyline_rectangle,clip_points_polygon} %!%- diff --git a/src/slang/geometry/cohen_sutherland.sl b/src/slang/geometry/cohen_sutherland.sl index 4cc0b75d08cc726251801d6fc445341406231fbf..f1eb6386db42a73610bec5b92e69d7ac7c64f8e3 100644 --- a/src/slang/geometry/cohen_sutherland.sl +++ b/src/slang/geometry/cohen_sutherland.sl @@ -34,16 +34,16 @@ define cohen_sutherland() %\usage{(xc0,yc0,xc1,yc1)=cohen_sutherland(x0,y0,x1,y1,xmin,ymin,xmax,ymax)} %\altusage{clipped=cohen_sutherland(line,box)} %\description -%This function clips a line defined by the points (x0,y0) and (x1,y1) against -%a box defined by the corner points (xmin,ymin) and (xmax,ymax) and returns -%the clipped line (xc0,yc0) -- (xc1,yc1). The clipped coordinates are set -%to _NaN if the line misses the box. +% This function clips a line defined by the points (x0,y0) and (x1,y1) against +% a box defined by the corner points (xmin,ymin) and (xmax,ymax) and returns +% the clipped line (xc0,yc0) -- (xc1,yc1). The clipped coordinates are set +% to _NaN if the line misses the box. % -%The line segment and clipping box can be either defined directly by giving the -%coordinates or as structs, In the latter case, the line segment -%is defined as line= struct{ x=[x0,x1], y=[y0,y1] } and the -%rectangular box is defined either as box=struct{x=[xmin,xmax],y=[ymin,ymax]} -%or as box=struct{xmin=xmin,ymin=ymin,xmax=xmax,ymax=ymax}. +% The line segment and clipping box can be either defined directly by giving the +% coordinates or as structs, In the latter case, the line segment +% is defined as line= struct{ x=[x0,x1], y=[y0,y1] } and the +% rectangular box is defined either as box=struct{x=[xmin,xmax],y=[ymin,ymax]} +% or as box=struct{xmin=xmin,ymin=ymin,xmax=xmax,ymax=ymax}. % %\seealso{clip_points_rectangle,clip_points_polygon, clip_polyline_rectangle,greiner_hormann} % @@ -157,10 +157,10 @@ define clip_polyline_rectangle(src,box) { %\synopsis{Clip a polyline against a rectangle} %\usage{clipped=clip_polyline_rectangle(poly,box)} %\description -%This function clips the polyline poly=struct{x=[],y=[]}, where x and y are arrays containing -%the points of the polyline, against a rectangle defined by the corner points (xmin,ymin) and -%(xmax,ymax). It returns a list of structs{x,y}, where each list element contains the points of -%a segment of the polygon that is inside the box. +% This function clips the polyline poly=struct{x=[],y=[]}, where x and y are arrays containing +% the points of the polyline, against a rectangle defined by the corner points (xmin,ymin) and +% (xmax,ymax). It returns a list of structs{x,y}, where each list element contains the points of +% a segment of the polygon that is inside the box. % %\seealso{clip_points_polygon, clip_polyline_rectangle, cohen_sutherland, greiner_hormann} % diff --git a/src/slang/geometry/greiner_hormann.sl b/src/slang/geometry/greiner_hormann.sl index 67ce525bf3412bbe172f387fc3a3aa3937cc1b70..2afdcf9e4af295a48a0cbcc3655fcda7a615d8db 100755 --- a/src/slang/geometry/greiner_hormann.sl +++ b/src/slang/geometry/greiner_hormann.sl @@ -146,9 +146,9 @@ define greiner_hormann() %\qualifiers{ %\qualifier{intersection}{return the intersection of src and clp % (i.e., clip src against clp), the default} -%\qualifier{union}{: return the union of src and clp} -%\qualifier{without}{: remove clp from src} -%\qualifier{perturb}{: slightly perturb src to reduce probability of +%\qualifier{union}{return the union of src and clp} +%\qualifier{without}{remove clp from src} +%\qualifier{perturb}{slightly perturb src to reduce probability of % failure of the algorithm (see description below)} %} %\description diff --git a/src/slang/geometry/point_in_polygon.sl b/src/slang/geometry/point_in_polygon.sl index 9414986073705b7acda9ccff8e1536968c19a49d..b213b7a0cd02cf33342ed834b2ee372165e32978 100644 --- a/src/slang/geometry/point_in_polygon.sl +++ b/src/slang/geometry/point_in_polygon.sl @@ -156,9 +156,9 @@ define point_in_polygon() %\altusage{ret=point_in_polygon(x,y,Vx,Vy);} %\synopsis{determine whether a point is in a polygon} %\qualifiers{ -%\qualifier{evenodd}{: use the crossing number method} -%\qualifier{crossing}{: use the crossing number method} -%\qualifier{winding}{: use the winding number method (the default)} +%\qualifier{evenodd}{use the crossing number method} +%\qualifier{crossing}{use the crossing number method} +%\qualifier{winding}{use the winding number method (the default)} %} %\description % The function returns 1 if the point p0 is located inside the diff --git a/src/slang/geometry/rectangles_overlap.sl b/src/slang/geometry/rectangles_overlap.sl index 0b0cd5ec0ece118bd23f8b6952a4413c967f5e80..57586876e26e97b43894240cfde93ff1aa555a3d 100644 --- a/src/slang/geometry/rectangles_overlap.sl +++ b/src/slang/geometry/rectangles_overlap.sl @@ -5,8 +5,8 @@ define rectangles_overlap (src,clp) %\usage{res=rectangles_overlap(src,clp)} %\description % -%This function checks whether the two rectangles src and clp -%overlap (return value=1) or not (return value =0). +% This function checks whether the two rectangles src and clp +% overlap (return value=1) or not (return value =0). % % The rectangles are defined by (xmin,ymin,xmax,ymax) % either as a 4 element array in this order or as a diff --git a/src/slang/get_arg_struct.sl b/src/slang/get_arg_struct.sl index 82bf9cd7d6946d831fd4685550030ab9303a1d2b..c28b92f6c83f703d810fd545790c7a798324bf85 100644 --- a/src/slang/get_arg_struct.sl +++ b/src/slang/get_arg_struct.sl @@ -5,8 +5,8 @@ define get_arg_struct() %{{{ %\usage{Struct_Type = get_arg_struct( );} %\altusage{Struct_Type = get_arg_struct( String_Type[] name, type);} %\qualifiers{ -%\qualifier{delim}{: [="="] Delimeter between argument name and value (e.g., also, "=.,").} -%\qualifier{prefix}{: [="--"] Argument prefix. Arguments missing this prefix are ignored.} +%\qualifier{delim}{[="="] Delimeter between argument name and value (e.g., also, "=.,").} +%\qualifier{prefix}{[="--"] Argument prefix. Arguments missing this prefix are ignored.} %} %\description % This function returns a Struct_Type with fields corresponding to diff --git a/src/slang/images/png_read_curve.sl b/src/slang/images/png_read_curve.sl index ada3155d393060566c3427728948b6975f910d50..54d4b49aa67811610b801e79cbf1f0d122e084f7 100644 --- a/src/slang/images/png_read_curve.sl +++ b/src/slang/images/png_read_curve.sl @@ -15,8 +15,8 @@ define png_read_curve() % The return values are calibrated x-values and y-values % averaged over all pixels of the curve in the corresponding column. %\qualifiers{ -%\qualifier{color}{ [\code{=0x000000} (black)]: considered color of the curve} -%\qualifier{wherenot}{: consider any color except the one specified above} +%\qualifier{color}{[\code{=0x000000} (black)]: considered color of the curve} +%\qualifier{wherenot}{consider any color except the one specified above} %} %!%- { diff --git a/src/slang/math/Aitoff_projection.sl b/src/slang/math/Aitoff_projection.sl index 653015c0b752dcbacb84c2837abe16ab4fb0a3b1..aabe065768e96898e1d97cf381872f4785fd610a 100644 --- a/src/slang/math/Aitoff_projection.sl +++ b/src/slang/math/Aitoff_projection.sl @@ -4,8 +4,8 @@ define Aitoff_projection() %\synopsis{computes an Aitoff projection} %\usage{(Double_Type x, y) = Aitoff_projection(Double_Type l, b);} %\qualifiers{ -%\qualifier{deg}{: \code{l} and \code{b} are in degrees, not in radian} -%\qualifier{normalized}{: \code{x} and \code{y} are normalized (by \code{PI/2}) +%\qualifier{deg}{\code{l} and \code{b} are in degrees, not in radian} +%\qualifier{normalized}{\code{x} and \code{y} are normalized (by \code{PI/2}) % such that \code{abs(x) <= 2} and \code{abs(y) <= 1}.} %} %\description diff --git a/src/slang/math/Hammer_projection.sl b/src/slang/math/Hammer_projection.sl index 7a9ce460ef4897548188edacb01cb62660c61d61..e5b6f44e98a192be63016bbee739d5d8b6bc0492 100644 --- a/src/slang/math/Hammer_projection.sl +++ b/src/slang/math/Hammer_projection.sl @@ -6,12 +6,12 @@ define Hammer_projection() %\synopsis{Computes the Hammer-Aitoff projection} %\usage{(Double_Type x, y) = Hammer_projection(Double_Type l, b);} %\qualifiers{ -%\qualifier{deg}{: \code{l} and \code{b} are in degrees, not in radian} -%\qualifier{normalized}{: \code{x} and \code{y} are normalized (by \code{sqrt(2)}) +%\qualifier{deg}{\code{l} and \code{b} are in degrees, not in radian} +%\qualifier{normalized}{\code{x} and \code{y} are normalized (by \code{sqrt(2)}) % such that \code{abs(x) <= 2} and \code{abs(y) <= 1}.} -%\qualifier{astronomical}{: flip x-axis for astronomical maps, where east is +%\qualifier{astronomical}{flip x-axis for astronomical maps, where east is % to the left} -%\qualifier{inverse}{: calculate the inverse projection, interpreting l as the x- and +%\qualifier{inverse}{calculate the inverse projection, interpreting l as the x- and % b as the y-coordinate; all other qualifiers are % also interpreted as expected.} %} diff --git a/src/slang/math/Lambert_Equal_Area_projection.sl b/src/slang/math/Lambert_Equal_Area_projection.sl index ed167c0ba9c11d18de3f1e09bc306c68c37c7030..807cd419175af9b5bfc3f61f677f0bd068555246 100644 --- a/src/slang/math/Lambert_Equal_Area_projection.sl +++ b/src/slang/math/Lambert_Equal_Area_projection.sl @@ -4,8 +4,8 @@ define Lambert_Equal_Area_projection(phi,theta) { %\synopsis{Computes the Lambert_Equal_Area_projection} %\usage{(Double_Type x, y) = Lambert_Equal_Area_projection(Double_Type phi,theta);} %\qualifiers{ -%\qualifier{deg}{: \code{phi} and \code{theta} are in degrees, not in radian} -%\qualifier{inverse}{: calculate the inverse projection, interpreting phi as the x- and +%\qualifier{deg}{\code{phi} and \code{theta} are in degrees, not in radian} +%\qualifier{inverse}{calculate the inverse projection, interpreting phi as the x- and % theta as the y-coordinate; all other qualifiers are % also interpreted as expected.} %} diff --git a/src/slang/math/angle_to_rad.sl b/src/slang/math/angle_to_rad.sl index 69dc788a4c1be277e3d4d3df9b7f109418da45fd..54dd274cf1d7097e4cecd78af35ea2a9c9379e81 100644 --- a/src/slang/math/angle_to_rad.sl +++ b/src/slang/math/angle_to_rad.sl @@ -4,7 +4,7 @@ define angle_to_rad() %\synopsis{converts an angle in degrees or h:m:s format into radian} %\usage{Double_Type angle_to_rad(Double_Type x);} %\qualifiers{ -%\qualifier{unit}{ [\code{="deg"}]: unit of \code{x} (\code{"deg"}/\code{"hms"}/\code{"rad"})} +%\qualifier{unit}{[\code{="deg"}] unit of \code{x} (\code{"deg"}/\code{"hms"}/\code{"rad"})} %} %\description % \code{x} can be a scalar value or (unless \code{unit="rad"}) an array of the form\n diff --git a/src/slang/math/angular_separation.sl b/src/slang/math/angular_separation.sl index fdb185fc8210f40e17e786f60674553ba38fc213..c8ba3633587a0044fdaa5c0e37494c64f17540c6 100644 --- a/src/slang/math/angular_separation.sl +++ b/src/slang/math/angular_separation.sl @@ -4,8 +4,8 @@ define angular_separation() %\usage{ sep=angular_separation(ra1,dec1,ra2,dec2);} %\synopsis{calculates the angular distance between two points on a sphere} %\qualifiers{ -%\qualifier{deg}{: if set, the input coordinates and output are in degrees (default: radian)} -%\qualifier{radian}{: if set, the input coordinates and output are in radian (the default))} +%\qualifier{deg}{if set, the input coordinates and output are in degrees (default: radian)} +%\qualifier{radian}{if set, the input coordinates and output are in radian (the default))} %} %\description % This routine calculates the angular separation between points on the sky diff --git a/src/slang/math/bezier.sl b/src/slang/math/bezier.sl index 40c9404b7417bac885ae0009c29d51c57de89713..cf9bf8b2d6cb883b2b70dcb3b31ab23c9edf7d8c 100644 --- a/src/slang/math/bezier.sl +++ b/src/slang/math/bezier.sl @@ -71,9 +71,9 @@ define bezier () { % of the curve, as well as the length of the returned curve. % %\qualifiers{ -%\qualifier{allbez}{ : if set, all intermediate Bezier curves are +%\qualifier{allbez}{if set, all intermediate Bezier curves are % returned as a List, containing all the Vector_Type Bezier curves.} -%\qualifier{conline}{ : if set, the initial lines connecting the +%\qualifier{conline}{if set, the initial lines connecting the % points are also returned, i.e., the return value becomes (Vector_Type % conlines, Vector_Type bez).} %} diff --git a/src/slang/math/binarydigits.sl b/src/slang/math/binarydigits.sl index 2fa3c0cc9bb31a1d4e89b577e8ff90c4580f803d..98ec0887934bda3d759f403e9677d8184927a514 100644 --- a/src/slang/math/binarydigits.sl +++ b/src/slang/math/binarydigits.sl @@ -6,7 +6,7 @@ define binarydigits(x) %\synopsis{retrieves a number's dual representaion} %\usage{String_Type binarydigits(Integer_Type x)} %\qualifiers{ -%\qualifier{n}{ [\code{=16}]: number of bits} +%\qualifier{n}{[\code{=16}] number of bits} %} %!%- { diff --git a/src/slang/math/continued_fraction_expansion.sl b/src/slang/math/continued_fraction_expansion.sl index 3d72d6c9e8a5cb4e50a8036977e515043945bbac..9d2d1a68733157e9cb3f2eb0117cee97988cdfb5 100644 --- a/src/slang/math/continued_fraction_expansion.sl +++ b/src/slang/math/continued_fraction_expansion.sl @@ -7,7 +7,7 @@ define continued_fraction_expansion() %\usage{UInteger_Type[] continued_fraction_expansion(Double_Type x)} %\qualifiers{ %\qualifier{verbose}{} -%\qualifier{maxlen}{ [\code{=64}]} +%\qualifier{maxlen}{[\code{=64}]} %} %!%- { diff --git a/src/slang/math/ellipse.sl b/src/slang/math/ellipse.sl index da1e06e1f5183a76b56e09298759d837d673947a..857301c2f6e7b8d2c56315bde495938631353328 100644 --- a/src/slang/math/ellipse.sl +++ b/src/slang/math/ellipse.sl @@ -5,8 +5,8 @@ define ellipse () %\usage{(Double_Type X,Y) = ellipse(Double_Type smaj, smin, posang, phi) %} %\qualifiers{ -%\qualifier{x}{ [\code{=1}]: compression/streching factor along the x-axis} -%\qualifier{y}{ [\code{=1}]: compression/streching factor along the y-axis} +%\qualifier{x}{[\code{=1}] compression/streching factor along the x-axis} +%\qualifier{y}{[\code{=1}] compression/streching factor along the y-axis} %} %\description % This function calculates the coordinates \code{X}, \code{Y} of an ellipse with diff --git a/src/slang/math/find_function_maximum.sl b/src/slang/math/find_function_maximum.sl index 1f2b8485ef90bd2d0117b72b8f6d4df882e7b1f5..11126aa580f310a0d93f903a56611526c2c2f220 100644 --- a/src/slang/math/find_function_maximum.sl +++ b/src/slang/math/find_function_maximum.sl @@ -6,8 +6,8 @@ define find_function_maximum() %\altusage{Double_Type x0 = find_function_maximum(Ref_Type &f, Double_Type x1, Double_Type x2, &f_x0);} %} %\qualifiers{ -%\qualifier{qualifiers}{: structure of qualifiers to be passed to f} -%\qualifier{eps}{ [=1e-12]} +%\qualifier{qualifiers}{structure of qualifiers to be passed to f} +%\qualifier{eps}{[=1e-12]} %} %\description % \code{f} has to be a real function with one argument. diff --git a/src/slang/math/find_function_value.sl b/src/slang/math/find_function_value.sl index 6f39e2b1dbdc8fbaa03120b68972a5ef2d85d8fc..8a8883e36e7815c2f4e85f86a56c60b37f6d4f83 100644 --- a/src/slang/math/find_function_value.sl +++ b/src/slang/math/find_function_value.sl @@ -4,9 +4,9 @@ define find_function_value() %\synopsis{computes an inverse function} %\usage{Double_Type x0 = find_function_value(Ref_Type &f, Double_Type val, x1, x2);} %\qualifiers{ -%\qualifier{qualifiers}{: structure of qualifiers to be passed to f} -%\qualifier{eps}{ [=1e-12]} -%\qualifier{quiet}{: do not show error message} +%\qualifier{qualifiers}{structure of qualifiers to be passed to f} +%\qualifier{eps}{[=1e-12]} +%\qualifier{quiet}{do not show error message} %} %\description % \code{f} has to be a real function with one argument. diff --git a/src/slang/math/find_multiargumentfunction_value.sl b/src/slang/math/find_multiargumentfunction_value.sl index ac9a8295bf4491956f12a88919dd348c06d0f63a..ff78ba75298bb20b0053bd8288ef19c46af7829b 100644 --- a/src/slang/math/find_multiargumentfunction_value.sl +++ b/src/slang/math/find_multiargumentfunction_value.sl @@ -6,8 +6,8 @@ define find_multiargumentfunction_value() %\synopsis{computes an inverse function} %\usage{Double_Type xi0 = find_multiargumentfunction_value(Ref_Type &f, Double_Type val, x1, x2, ..., xn);} %\qualifiers{ -%\qualifier{qualifiers}{: structure of qualifiers to be passed to f} -%\qualifier{eps}{ [=1e-12]} +%\qualifier{qualifiers}{structure of qualifiers to be passed to f} +%\qualifier{eps}{[=1e-12]} %} %\description % \code{f} has to be a real function with n arguments. diff --git a/src/slang/math/greatcircle_coordinates.sl b/src/slang/math/greatcircle_coordinates.sl index bd6c0e199b093893c09c33eb143146c002032a9e..62df51566b076e1e7c92dc2038077a7a6c7bb4d1 100644 --- a/src/slang/math/greatcircle_coordinates.sl +++ b/src/slang/math/greatcircle_coordinates.sl @@ -6,8 +6,8 @@ define greatcircle_coordinates() %\synopsis{calculates the coordinates of the greatcircle between two points on a sphere} %\usage{(Double_Type lambda[], phi[]) = greatcircle_coordinates(lambda1, phi1, lambda2, phi2);} %\qualifiers{ -%\qualifier{unit}{ [\code{="deg"}]: unit of the angular coordinates} -%\qualifier{delta}{ [\code{=0.5}]: angular step in degrees} +%\qualifier{unit}{[\code{="deg"}] unit of the angular coordinates} +%\qualifier{delta}{[\code{=0.5}] angular step in degrees} %} %\description % (\code{lambda}i, \code{phi}i) are the spherical coordinates of point i.\n diff --git a/src/slang/math/greatcircle_distance.sl b/src/slang/math/greatcircle_distance.sl index 42411e787fa7b87e3af66ea6587e6267bfc91f1a..37afa9d9cbf441b846b23d579d648a2f868df1f9 100644 --- a/src/slang/math/greatcircle_distance.sl +++ b/src/slang/math/greatcircle_distance.sl @@ -5,13 +5,15 @@ define greatcircle_distance() %\synopsis{calculates the angular distance between two points on a sphere in radians} %\usage{Double_Type greatcircle_distance(alpha1, delta1, alpha2, delta2)} %\qualifiers{ -%\qualifier{unit}{ [\code{="deg"}]: unit of the input angular coordinates} -%\qualifier{alpha1_unit}{ [\code{="deg"}]: unit of the alpha1} -%\qualifier{alpha2_unit}{ [\code{="deg"}]: unit of the alpha2} -%\qualifier{delta1_unit}{ [\code{="deg"}]: unit of the delta1} -%\qualifier{delta2_unit}{ [\code{="deg"}]: unit of the delta2} +%\qualifier{unit}{[\code{="deg"}] unit of the input angular coordinates} +%\qualifier{alpha1_unit}{[\code{="deg"}] unit of the alpha1} +%\qualifier{alpha2_unit}{[\code{="deg"}] unit of the alpha2} +%\qualifier{delta1_unit}{[\code{="deg"}] unit of the delta1} +%\qualifier{delta2_unit}{[\code{="deg"}] unit of the delta2} %} %\description +% +% DEPRECATED - please use angular_separation instead % (\code{alpha}i, \code{delta}i) are the spherical coordinates of point i.\n % \code{unit="deg"}: \code{alpha}i and \code{delta}i are in degrees.\n % They can be scalar values or arrays of the form diff --git a/src/slang/math/integrateRK45_adaptive.sl b/src/slang/math/integrateRK45_adaptive.sl index 72e528231b1141abf97f4a6ec1bac6670c00c921..65c737e11e623fc44a7afd228c888a281ead8cd5 100644 --- a/src/slang/math/integrateRK45_adaptive.sl +++ b/src/slang/math/integrateRK45_adaptive.sl @@ -23,11 +23,11 @@ define integrateRK45_adaptive() % % Note: All qualifiers are also passed to the function f. %\qualifiers{ -%\qualifier{eps}{ [\code{=1e-12}]: absolut error control tolerance; lower limit: 1e-15} -%\qualifier{method}{ [\code{="RKCK"}]: choose among three different RK45 methods: +%\qualifier{eps}{[\code{=1e-12}] absolut error control tolerance; lower limit: 1e-15} +%\qualifier{method}{[\code{="RKCK"}] choose among three different RK45 methods: % "RKF": RK-Fehlberg, "RKCK": RK-Cash-Karp, "RKDP": RK-Dormand-Prince} -%\qualifier{path}{: return the entire path and not only the final result} -%\qualifier{verbose}{: show intermediate "times" \code{t}} +%\qualifier{path}{return the entire path and not only the final result} +%\qualifier{verbose}{show intermediate "times" \code{t}} %\qualifier{plus all qualifiers of the function f}{} %} %\example diff --git a/src/slang/math/integrateRKF45.sl b/src/slang/math/integrateRKF45.sl index 8cc442695be4816be23df6d2560bd68614c0c401..0a3a6244d1be3b87a590acfca9ae55d4ee4d7355 100644 --- a/src/slang/math/integrateRKF45.sl +++ b/src/slang/math/integrateRKF45.sl @@ -4,8 +4,8 @@ define integrateRKF45() %\synopsis{integrates an ODE with the adaptive 4th/5th order Runge-Kutta-Fehlberg algorithm} %\usage{x = integrateRKF45(&f, t1, t2, dt[, x0]);} %\qualifiers{ -%\qualifier{eps}{ [\code{=1e-12}]: error control tolerance} -%\qualifier{verbose}{: show intermediate "times" \code{t}} +%\qualifier{eps}{[\code{=1e-12}] error control tolerance} +%\qualifier{verbose}{show intermediate "times" \code{t}} %} %\description % This implementation of the adaptive Runge-Kutta-Fehlberg algorithm diff --git a/src/slang/math/lagrange.sl b/src/slang/math/lagrange.sl index 3175d00e21aef67494b432cf8e046b0c975270c4..53bf1620c5900a972584a7ae4ab2d8881dbcb41a 100644 --- a/src/slang/math/lagrange.sl +++ b/src/slang/math/lagrange.sl @@ -4,9 +4,9 @@ define chebyshev_nodes (n) %\synopsis{Get nodes of Chebyshev polynomial} %\usage{Double_Type[] nodes = chebyshev_nodes(Int_Type n);} %\qualifiers{ -% \qualifier{second}{: if given, return nodes of second order polynomal.} -% \qualifier{min}{[=-1]: rescale to min} -% \qualifier{max}{[=1]: rescale to max} +% \qualifier{second}{if given, return nodes of second order polynomal.} +% \qualifier{min}{[=-1] rescale to min} +% \qualifier{max}{[=1] rescale to max} %} %\description % Given an integer \code{n} this function returns the nodes @@ -40,7 +40,7 @@ define chebyshev_lagrange_weights (n) %\synopsis{Get Lagrange weights for the chebyshev_nodes} %\usage{Double_Type[] chebyshev_lagrange_weights(Int_Type n);} %\qualifiers{ -% \qualifier{second}{: if given, return weights of second order polynomal.} +% \qualifier{second}{if given, return weights of second order polynomal.} %} %\description % Given an integer \code{n} this function returns the weights for the @@ -91,7 +91,7 @@ define lagrange_poly (x, x0, y0) %\synopsis{Interpolate points with Lagrange polynomial} %\usage{Double_Type[] lagrange_poly(Double_Type[] x, x0, y0);} %\qualifiers{ -% \qualifier{w}{: calculated nodes can be passed directly} +% \qualifier{w}{calculated nodes can be passed directly} %} %\description % Calculate the Lagrange interpolation at points \code{x} given diff --git a/src/slang/math/matrix33.sl b/src/slang/math/matrix33.sl index 1bf45937b5ed9c8b5951fdc16775b17e4c3872ee..30f8fe05a18c06163e456c49bf4648343b9221dd 100644 --- a/src/slang/math/matrix33.sl +++ b/src/slang/math/matrix33.sl @@ -15,13 +15,13 @@ define vector_astro () %\altusage{Vector_Type vector_astro(Double_Type phi, theta; sph)} %\altusage{Vector_Type vector_astro(Double_Type lon, lat; astro)} %\qualifiers{ -%\qualifier{astro}{: consider the given coordinates to be astronomical (r, lon, lat) +%\qualifier{astro}{consider the given coordinates to be astronomical (r, lon, lat) % following the astronomical definition (i.e., lon ranges from % 0 to 2pi, lat from -pi/2 to pi/2; default for two arguments)} -%\qualifier{sph}{: consider the given coordinates to be spherical (r, phi, theta) +%\qualifier{sph}{consider the given coordinates to be spherical (r, phi, theta) % following the mathematical definition (i.e., theta ranges from % 0 to pi)} -%\qualifier{deg}{: interpret angular arguments in degrees} +%\qualifier{deg}{interpret angular arguments in degrees} %} %\description % The components of the vector are returned within the Vector_Type @@ -105,10 +105,10 @@ define vector_to_spherical () %\synopsis{Returns the spherical coordinates corresponding to a 3D Vector} %\usage{(r,lon,lat)=vector_to_spherical(Vector_Type v)} %\qualifiers{ -%\qualifier{astro}{: return coordinates using the astronomical convention (the default)} -%\qualifier{sph}{: return coordinates (r,theta,phi) using the mathematical definition +%\qualifier{astro}{return coordinates using the astronomical convention (the default)} +%\qualifier{sph}{return coordinates (r,theta,phi) using the mathematical definition % (i.e., theta ranges from 0 to pi)} -%\qualifier{deg}{: return angular arguments in degrees (default: radian)} +%\qualifier{deg}{return angular arguments in degrees (default: radian)} %} % %\description @@ -672,7 +672,7 @@ define matrix33_rot() %\synopsis{return a standard rotation matrix about the x-, y-, or z-axis} %\usage{ Matrix33_Type=matrix33_rot(i,angle;qualifiers);} %\qualifiers{ -% \qualifier{deg}{: angle is given in deg [default: radians]} +% \qualifier{deg}{angle is given in deg [default: radians]} %} %\description % Returns a rotation matrix to transform a column-3 vector from diff --git a/src/slang/math/ratio_error_prop.sl b/src/slang/math/ratio_error_prop.sl index 5a1969b26751aa63f846b266c6430137b55c9d0e..880565cfef4336aaf78b61610a363529f4675a39 100644 --- a/src/slang/math/ratio_error_prop.sl +++ b/src/slang/math/ratio_error_prop.sl @@ -11,7 +11,7 @@ define ratio_error_prop() % \code{rat = a/b}\n % \code{err = sqrt[ (1/b * a_err)^2 + (a/b^2 * b_err)^2 ]} %\qualifiers{ -%\qualifier{Poisson}{: \code{a_err = sqrt(a); b_err = sqrt(b);}} +%\qualifier{Poisson}{\code{a_err = sqrt(a); b_err = sqrt(b);}} %} %\seealso{hardnessratio_error_prop} %!%- diff --git a/src/slang/math/rescale_range.sl b/src/slang/math/rescale_range.sl index eba3afbd14007548ceb3ab3fe1828cc262963276..4da747ea8aeee3c751b4984da819a1ff25929e50 100644 --- a/src/slang/math/rescale_range.sl +++ b/src/slang/math/rescale_range.sl @@ -4,8 +4,8 @@ define rescale_range() %\synopsis{rescales a value} %\usage{Double_Type y = rescale_range(Double_Type x);} %\qualifiers{ -%\qualifier{in}{: inputrange} -%\qualifier{out}{: outputrange} +%\qualifier{in}{inputrange} +%\qualifier{out}{outputrange} %} %\description % possibilities for in/out and the corresponding scaling function:\n diff --git a/src/slang/math/runs_test.sl b/src/slang/math/runs_test.sl index aa56a6ec6aed5eabcff1abc2e48206c71e56c08a..5c20d78a2f5092f52ce17f6a63f7c9097c5f6735 100644 --- a/src/slang/math/runs_test.sl +++ b/src/slang/math/runs_test.sl @@ -105,8 +105,8 @@ define runs_test (sequence) %\usage{Int_Type = runs_test(Num_Type[]);} %\qualifiers{ % \qualifier{confidence}{[=0.05]: Critical test probability} -% \qualifier{overmixing}{: Test for overmixing} -% \qualifier{undermixing}{: Test for undermixing} +% \qualifier{overmixing}{Test for overmixing} +% \qualifier{undermixing}{Test for undermixing} %} %\description % This function performs the runs test (Wald-Wolfowitz test) diff --git a/src/slang/misc/progress_bar.sl b/src/slang/misc/progress_bar.sl index a17c983b6cbe57a44bf33b3f39af488536750e2c..8c7df63b279dbebf5337d1a17dde6e1ef31b8ded 100644 --- a/src/slang/misc/progress_bar.sl +++ b/src/slang/misc/progress_bar.sl @@ -4,12 +4,12 @@ define draw_progress_bar(cur, goal) %\synopsis{Draw a progress bar} %\usage{draw_progress_bar( position , maximum )} %\qualifiers{ -%\qualifier{tip}{: String to draw tip of the arrow (default: ">")} -%\qualifier{bar}{: String to draw bar of the arrow (default: "=")} -%\qualifier{front}{: String to draw space in front of arrow (default: ".")} -%\qualifier{append}{: String to append to each drawn progress bar (default: "")} -%\qualifier{columns}{: Columns to use to write progress bar (default: Terminal width)} -%\qualifier{fmt}{: Format to use for writing the percentage info in front of the bar. +%\qualifier{tip}{String to draw tip of the arrow (default: ">")} +%\qualifier{bar}{String to draw bar of the arrow (default: "=")} +%\qualifier{front}{String to draw space in front of arrow (default: ".")} +%\qualifier{append}{String to append to each drawn progress bar (default: "")} +%\qualifier{columns}{Columns to use to write progress bar (default: Terminal width)} +%\qualifier{fmt}{Format to use for writing the percentage info in front of the bar. % The printing function gets passed the percentage of the current % state to the function as the second argument after the format % (default: "%.1f%%", for example 01.3%)} diff --git a/src/slang/pack_obj.sl b/src/slang/pack_obj.sl index 77419003c0e6c04483dc87be2dafa84eba54c4a3..e1f600a4e1d54cfe5f90c00c5076adbd06dc0f97 100644 --- a/src/slang/pack_obj.sl +++ b/src/slang/pack_obj.sl @@ -57,12 +57,14 @@ define pack_obj() % Char_Type, String_Type, Array_Type, Struct_Type % and its aliases. %\example -% s = pack_obj(PI); % s[0] = "d\\030-DT\\373!\\011@" +%#v+ +%#p+ +% s = pack_obj(PI); % s[0] = "d\030-DT\373!\011@" % -% s = pack_obj([1:3] + 4); % s[0] = "ak\\003\\000\\000\\000" -% % s[1] = "\\005\\000\\000\\000" -% % s[2] = "\\006\\000\\000\\000" -% % s[3] = "\\007\\000\\000\\000" +% s = pack_obj([1:3] + 4); % s[0] = "ak\003\000\000\000" +% % s[1] = "\005\000\000\000" +% % s[2] = "\006\000\000\000" +% % s[3] = "\007\000\000\000" % % variable obj = struct { % number = 598105, @@ -73,6 +75,8 @@ define pack_obj() % }; % s = pack_obj(obj); % print(s); +%#p- +%#v- %\seealso{unpack_obj, pack, unpack} %!%- { @@ -145,9 +149,13 @@ define unpack_obj() % % See the documentation of `pack_obj` for more details. %\example +%#v+ +%#p+ % s = pack_obj(PI); % s[0] = "d\\030-DT\\373!\\011@" % % a = unpack_obj(s); % a = 3.141592653589793; +%#p- +%#v- %\seealso{pack_obj, unpack, pack} %!%- { diff --git a/src/slang/physics/B_lambda.sl b/src/slang/physics/B_lambda.sl index 8d6b2eda24822ba7aa5583beedc76a9e39ec6952..0833ec013048248dfc45745e1fb061ec0b2f4bd9 100644 --- a/src/slang/physics/B_lambda.sl +++ b/src/slang/physics/B_lambda.sl @@ -5,9 +5,9 @@ define B_lambda() { %\usage{Double_Type Blambda = B_lambda(lambda,T);} % %\qualifiers{ -%\qualifier{keV}{: T argument is kT in keV} -%\qualifier{A}{: Wavelength is given in Angstroms} -%\qualifier{Angstrom}{: Wavelength is given in Angstroms} +%\qualifier{keV}{T argument is kT in keV} +%\qualifier{A}{Wavelength is given in Angstroms} +%\qualifier{Angstrom}{Wavelength is given in Angstroms} %} %\description % This function returns the spectral energy density of a black body, diff --git a/src/slang/physics/B_nu.sl b/src/slang/physics/B_nu.sl index 3a704d5070d637b84f228b8dc0fcb1bb58dfd0c4..27b5557e4a987f151e37ccf7b44d0b021332383f 100644 --- a/src/slang/physics/B_nu.sl +++ b/src/slang/physics/B_nu.sl @@ -5,10 +5,10 @@ define B_nu() { %\usage{Double_Type Bnu = B_nu(nu,T);} % %\qualifiers{ -%\qualifier{keV}{: 1st argument is energy in keV, +%\qualifier{keV}{1st argument is energy in keV, % T argument is kT in keV} -%\qualifier{MHz}{: Frequency is given in MHz} -%\qualifier{GHz}{: Frequency is given in GHz} +%\qualifier{MHz}{Frequency is given in MHz} +%\qualifier{GHz}{Frequency is given in GHz} %} %\description % This function returns the spectral energy density of a black body, diff --git a/src/slang/physics/N_body_simulation.sl b/src/slang/physics/N_body_simulation.sl index 4558352f34aae725a4ab079dba05b06468e2ccc9..e0329471da5b17410565e79a0ff3e69f8c719d43 100644 --- a/src/slang/physics/N_body_simulation.sl +++ b/src/slang/physics/N_body_simulation.sl @@ -33,8 +33,8 @@ define N_body_simulation_std_kernel() % d/dt vy_j = r[4,j] = -d/dy_j Phi = sum( psa_i*(psb_i+dis^2)^(-3/2)*(y_i-y_j), i!=j) % d/dt vz_j = r[5,j] = -d/dz_j Phi = sum( psa_i*(psb_i+dis^2)^(-3/2)*(z_i-z_j), i!=j) %\qualifiers{ -%\qualifier{psa}{ [\code{=Double_Type[N]+1}]: Parameter used to parametrize the interaction potential.} -%\qualifier{psb}{ [\code{=Double_Type[N]+0}]: Parameter used to parametrize the interaction potential.} +%\qualifier{psa}{[\code{=Double_Type[N]+1}] Parameter used to parametrize the interaction potential.} +%\qualifier{psb}{[\code{=Double_Type[N]+0}] Parameter used to parametrize the interaction potential.} %} %\example % N = 4; @@ -109,12 +109,12 @@ define N_body_simulation() % such that for each step an absolute accuracy in coordinates and velocity components is % achieved that is smaller than given by the qualifier 'tolerance'. %\qualifiers{ -%\qualifier{kernel}{ [\code{="N_body_simulation_std_kernel"}]: Name of the function which describes the +%\qualifier{kernel}{[\code{="N_body_simulation_std_kernel"}] Name of the function which describes the % mutual interaction. Note that all qualifiers are passed to this function as well.} -%\qualifier{threshold}{ [\code{=0}]: Lower limit on the time difference of two consecutive moments of time +%\qualifier{threshold}{[\code{=0}] Lower limit on the time difference of two consecutive moments of time % that will be saved.} -%\qualifier{tolerance}{ [\code{=1e-10}]: Absolut error control tolerance; lower limit: 1e-15.} -%\qualifier{verbose}{: Show intermediate times t.} +%\qualifier{tolerance}{[\code{=1e-10}] Absolut error control tolerance; lower limit: 1e-15.} +%\qualifier{verbose}{Show intermediate times t.} %} %\example % % Four interacting particles: diff --git a/src/slang/physics/SaturationVaporPressure.sl b/src/slang/physics/SaturationVaporPressure.sl index 554ac69a91c2303200e534f4e1211bca6f278489..68cb1f9bc8261e19d299af6eca67451f61a71c38 100644 --- a/src/slang/physics/SaturationVaporPressure.sl +++ b/src/slang/physics/SaturationVaporPressure.sl @@ -4,12 +4,12 @@ define SaturationVaporPressure() { %\synopsis{calculate the saturation vapor pressure of water in air} %\usage{Double_Type[] SaturationWaterPressure(T;qualifiers)} %\qualifiers{ -% \qualifier{centigrade}{: temperature argument is in centigrade (default: K)} -% \qualifier{kPa }{: Return saturation vapor pressure in kilopascals} -% \qualifier{hPa }{: Return saturation vapor pressure in hectopascals (=mbar)} -% \qualifier{water }{: Calculate saturation vapor pressure over water} -% \qualifier{ice }{: Calculate saturation vapor pressure over ice} -% \qualifier{iapws }{: Use the more precise IAPWS prescription (see below)} +% \qualifier{centigrade}{temperature argument is in centigrade (default: K)} +% \qualifier{kPa}{Return saturation vapor pressure in kilopascals} +% \qualifier{hPa}{Return saturation vapor pressure in hectopascals (=mbar)} +% \qualifier{water}{Calculate saturation vapor pressure over water} +% \qualifier{ice}{Calculate saturation vapor pressure over ice} +% \qualifier{iapws}{Use the more precise IAPWS prescription (see below)} %} %\description % This function calculates the saturation vapor pressure (svp) of water over diff --git a/src/slang/physics/alpha_ff.sl b/src/slang/physics/alpha_ff.sl index 0861228be08a35fb78c3f671cb37414eb7e48415..dfd14bdccea1f80e2c4fa3a4b94f4a9c8098bfca 100644 --- a/src/slang/physics/alpha_ff.sl +++ b/src/slang/physics/alpha_ff.sl @@ -5,9 +5,9 @@ define alpha_ff() { %\usage{Double_Type alpha = alpha_ff(nu,T);} % %\qualifiers{ -%\qualifier{Z}{: average nuclear charge (default=1)} -%\qualifier{ne}{: electron particle density (cm^-3; default: 1e10)} -%\qualifier{np}{: proton particle density (cm^-3; default: 1e10)} +%\qualifier{Z}{average nuclear charge (default=1)} +%\qualifier{ne}{electron particle density (cm^-3; default: 1e10)} +%\qualifier{np}{proton particle density (cm^-3; default: 1e10)} %} %\description % This function returns the absorption coefficient for free-free radiation diff --git a/src/slang/physics/j_ff.sl b/src/slang/physics/j_ff.sl index f12f627c4e299c21e1d44dfc3d38f74adb209626..2c1064c6806633f6ee0a835af8c0eabf17f98f4f 100644 --- a/src/slang/physics/j_ff.sl +++ b/src/slang/physics/j_ff.sl @@ -5,9 +5,9 @@ define j_ff() { %\usage{Double_Type j = j_ff(nu,T);} % %\qualifiers{ -%\qualifier{Z}{: average nuclear charge (default=1)} -%\qualifier{ne}{: electron particle density (cm^-3; default: 1e10)} -%\qualifier{np}{: proton particle density (cm^-3; default: 1e10)} +%\qualifier{Z}{average nuclear charge (default=1)} +%\qualifier{ne}{electron particle density (cm^-3; default: 1e10)} +%\qualifier{np}{proton particle density (cm^-3; default: 1e10)} %} %\description % This function returns the emission coefficient for free-free radiation diff --git a/src/slang/physics/physical_quantity.sl b/src/slang/physics/physical_quantity.sl index 7cff02bca79012076fe39c83301f7a8d0eb5a663..d55bc19b648b6e4defac9f0899ee2230a8ca4350 100644 --- a/src/slang/physics/physical_quantity.sl +++ b/src/slang/physics/physical_quantity.sl @@ -49,12 +49,12 @@ define physical_quantity() %\synopsis{initializes a physical quantity with number and units} %\usage{PhysicalQuantity_Type physical_quantity(Double_Type number)} %\qualifiers{ -%\qualifier{leng}{: length unit and dimension} -%\qualifier{time}{: time unit and dimension} -%\qualifier{mass}{: mass unit and dimension} -%\qualifier{curr}{: electrical current unit and dimension} -%\qualifier{temp}{: temperature unit and dimension} -%\qualifier{unit}{: array of compound units (see \code{physical_quantity_unit})} +%\qualifier{leng}{length unit and dimension} +%\qualifier{time}{time unit and dimension} +%\qualifier{mass}{mass unit and dimension} +%\qualifier{curr}{electrical current unit and dimension} +%\qualifier{temp}{temperature unit and dimension} +%\qualifier{unit}{array of compound units (see \code{physical_quantity_unit})} %} %\description % The units are specified as strings with their dimensionality @@ -166,13 +166,13 @@ define convert_units() %\altusage{PhysicalQuantity_Type convert_units(PhysicalQuantity_Type q; copy)} %} %\qualifiers{ -%\qualifier{leng}{: unit of length} -%\qualifier{time}{: unit of time} -%\qualifier{mass}{: unit of mass} -%\qualifier{curr}{: unit of electrical current} -%\qualifier{temp}{: unit of temperature} -%\qualifier{SI}{: sets leng="m", time="s", mass="kg", curr="A", temp="K"} -%\qualifier{copy}{: does not change unit of q, but returns a copy of q} +%\qualifier{leng}{unit of length} +%\qualifier{time}{unit of time} +%\qualifier{mass}{unit of mass} +%\qualifier{curr}{unit of electrical current} +%\qualifier{temp}{unit of temperature} +%\qualifier{SI}{sets leng="m", time="s", mass="kg", curr="A", temp="K"} +%\qualifier{copy}{does not change unit of q, but returns a copy of q} %} %\description % The allowed units are specified by the associative arrays diff --git a/src/slang/physics/refraction.sl b/src/slang/physics/refraction.sl index 6489146e1c722ee067195d004f5544f62a46256b..7c189d99de17e8fcb05c24c728fc57a1bf733aae 100644 --- a/src/slang/physics/refraction.sl +++ b/src/slang/physics/refraction.sl @@ -96,20 +96,20 @@ define refraction() { %\synopsis{calculate the correction for astronomical refraction} %\usage{Double_Type refraction(z0;qualifiers)} %\qualifiers{ -% \qualifier{lambda}{: wavelength (in A, between 3000 and 17000 A)} -% \qualifier{mum}{: wavelength is in microns} -% \qualifier{nm}{: wavelength is in nanometers} -% \qualifier{temperature}{: temperature at observer [K; default: 288.15K=15C]} -% \qualifier{lapse_rate}{: temperature lapse rate [K/m; default: 0.0065K/m = 6.5K/km]} -% \qualifier{centigrade}{: temperature is given in C} -% \qualifier{pressure}{: ambient total pressure at observer (Pa, default: 1013.25kPa)} -% \qualifier{kPa}{: ambient pressure is in kPa} -% \qualifier{hPa}{: ambient pressure is in hPa (or mbar)} -% \qualifier{rel_humidity}{: relative humidity at observer (between 0 and 1)} -% \qualifier{altitude}{: altitude of observer above geoid (m; below 11000m)} -% \qualifier{latitude}{: geographical latitude of the observer (rad; default: 0)} -% \qualifier{deg}{: all angles are given in degrees, not radians} -% \qualifier{exact}{: use numerical integration also for z0 below 80deg} +% \qualifier{lambda}{wavelength (in A, between 3000 and 17000 A)} +% \qualifier{mum}{wavelength is in microns} +% \qualifier{nm}{wavelength is in nanometers} +% \qualifier{temperature}{temperature at observer [K; default: 288.15K=15C]} +% \qualifier{lapse_rate}{temperature lapse rate [K/m; default: 0.0065K/m = 6.5K/km]} +% \qualifier{centigrade}{temperature is given in C} +% \qualifier{pressure}{ambient total pressure at observer (Pa, default: 1013.25kPa)} +% \qualifier{kPa}{ambient pressure is in kPa} +% \qualifier{hPa}{ambient pressure is in hPa (or mbar)} +% \qualifier{rel_humidity}{relative humidity at observer (between 0 and 1)} +% \qualifier{altitude}{altitude of observer above geoid (m; below 11000m)} +% \qualifier{latitude}{geographical latitude of the observer (rad; default: 0)} +% \qualifier{deg}{all angles are given in degrees, not radians} +% \qualifier{exact}{use numerical integration also for z0 below 80deg} %} %\description % For a given zenith distance z and local observing conditions, this function calculates diff --git a/src/slang/physics/refractive_index_air.sl b/src/slang/physics/refractive_index_air.sl index c64c0979518151b257762eb9b692af4275986abb..477d9d42f510dca92a7a34f277046a66f8def14d 100644 --- a/src/slang/physics/refractive_index_air.sl +++ b/src/slang/physics/refractive_index_air.sl @@ -4,17 +4,17 @@ define refractive_index_air() { %\synopsis{calculate the refractive index of dry and moist air} %\usage{Double_Type refractive_index_air(lambda;qualifiers)} %\qualifiers{ -% \qualifier{mum}{: wavelength is in microns} -% \qualifier{nm}{: wavelength is in nanometers} -% \qualifier{temperature}{: temperature [K; default: 288.15K]} -% \qualifier{centigrade}{: temperature is given in C} -% \qualifier{pressure}{: ambient total pressure (Pa, default: 1013.25kPa)} -% \qualifier{kPa}{: all pressure arguments are in kPa} -% \qualifier{hPa}{: all pressure arguments are in hPa (or mbar)} -% \qualifier{CO2_ppm}{: CO2 fraction in ppm (default: 450)} -% \qualifier{water_pressure}{: partial water vapor pressure} -% \qualifier{rel_humidity}{: relative humidity} -% \qualifier{silent}{: do not emit warning messages} +% \qualifier{mum}{wavelength is in microns} +% \qualifier{nm}{wavelength is in nanometers} +% \qualifier{temperature}{temperature [K; default: 288.15K]} +% \qualifier{centigrade}{temperature is given in C} +% \qualifier{pressure}{ambient total pressure (Pa, default: 1013.25kPa)} +% \qualifier{kPa}{all pressure arguments are in kPa} +% \qualifier{hPa}{all pressure arguments are in hPa (or mbar)} +% \qualifier{CO2_ppm}{CO2 fraction in ppm (default: 450)} +% \qualifier{water_pressure}{partial water vapor pressure} +% \qualifier{rel_humidity}{relative humidity} +% \qualifier{silent}{do not emit warning messages} %} %\description % This function calculates the phase refractive index of dry and moist air diff --git a/src/slang/strings/Roman.sl b/src/slang/strings/Roman.sl index f492a41fc645b1afaef2718812dda340362b12e1..05675a01f924b09f7136209204b549c09de3ee23 100644 --- a/src/slang/strings/Roman.sl +++ b/src/slang/strings/Roman.sl @@ -5,8 +5,8 @@ define Roman(n) { %\synopsis{translates n to upper-case string with roman numeral} %\usage{String_Type res = Roman(Integer_Type n)} %\qualifiers{ -%\qualifier{latex}{: typeset minus sign ("$-$"R)} -%\qualifier{toobig [=""]}{: string that is returned of n is larger +%\qualifier{latex}{typeset minus sign ("$-$"R)} +%\qualifier{toobig}{[=""] string that is returned of n is larger % than the largest known Roman numeral (3999) } %} %\description @@ -69,8 +69,8 @@ define roman(n) %\synopsis{translates n to lower-case string with roman numeral} %\usage{String_Type roman = romann(Integer_Type n)} %\qualifiers{ -%\qualifier{latex}{: typeset minus sign ("$-$"R)} -%\qualifier{toobig [=""]}{: string that is returned of n is larger +%\qualifier{latex}{typeset minus sign ("$-$"R)} +%\qualifier{toobig [=""]}{string that is returned of n is larger % than the largest known Roman numeral} %} %\seealso{Roman} diff --git a/src/slang/strings/TeX_value_pm_error.sl b/src/slang/strings/TeX_value_pm_error.sl index 6975cd8aefbb68c79a7979aebf5a28d6c25cbe37..24288cd3a031b988ecd30d6d01939336ab2f4884 100644 --- a/src/slang/strings/TeX_value_pm_error.sl +++ b/src/slang/strings/TeX_value_pm_error.sl @@ -5,12 +5,12 @@ define TeX_value_pm_error() %\usage{String_Type TeX_value_pm_error(Double_Type value, Double_Type min, Double_Type max)} %\altusage{String_Type TeX_value_pm_error(Struct_Type output_of__round_conf)} %\qualifiers{ -%\qualifier{factor}{ [=\code{1}]: factor to multiply \code{value, min, max}, will not be shown, +%\qualifier{factor}{[=\code{1}]: factor to multiply \code{value, min, max}, will not be shown, % works only if the function is called with three arguments} -%\qualifier{neg}{: factorize overall minus sign} -%\qualifier{sci}{ [=\code{2}]: exponent to switch to scienficic notation} -%\qualifier{scismall}{ [=\code{-sci}]: exponent for small numbers} -%\qualifier{scilarge}{ [=\code{+sci}]: exponent for large numbers} +%\qualifier{neg}{factorize overall minus sign} +%\qualifier{sci}{[=\code{2}]: exponent to switch to scienficic notation} +%\qualifier{scismall}{[=\code{-sci}]: exponent for small numbers} +%\qualifier{scilarge}{[=\code{+sci}]: exponent for large numbers} %} %\description % \code{TeX_value_pm_error} tries to produce a reasonable TeX output diff --git a/src/slang/strings/angle2string.sl b/src/slang/strings/angle2string.sl index 3420c201aa814c6bfd025739f3b682f39b6790f7..a42bf3b9689478961ef2e5fe249e2120b1fca5cb 100644 --- a/src/slang/strings/angle2string.sl +++ b/src/slang/strings/angle2string.sl @@ -4,23 +4,23 @@ define angle2string() %\synopsis{convert an angle to a string for pretty printing} %\usage{string=angle2string(angle;qualifiers)} %\qualifiers{ -% \qualifier{hoursign}{: angle is a hour angle, always include sign} -% \qualifier{declination}{: angle is a declination, always include sign} -% \qualifier{latitude}{: angle is a latitude, always include sign} -% \qualifier{hours}{: display hours, not degrees} -% \qualifier{deg}{: input angle is in degrees (default: radians)} -% \qualifier{separator}{: string to insert between the degrees/hours, +% \qualifier{hoursign}{angle is a hour angle, always include sign} +% \qualifier{declination}{angle is a declination, always include sign} +% \qualifier{latitude}{angle is a latitude, always include sign} +% \qualifier{hours}{display hours, not degrees} +% \qualifier{deg}{input angle is in degrees (default: radians)} +% \qualifier{separator}{string to insert between the degrees/hours, % minutes, and after the seconds. If a scalar: insert between % degrees and minutes only [e.g., ":"]. If an array: insert % the three array elements between the output numbers (e.g., % ["h","m","s"]). Default is ["d","m","s"] and ["h","m","s"] % depending on whether the hours-qualifier is set or not.} -% \qualifier{blank}{: do not display leading zeros} -% \qualifier{secfmt}{: sprintf format for the seconds (default: +% \qualifier{blank}{do not display leading zeros} +% \qualifier{secfmt}{sprintf format for the seconds (default: % %04.1f, i.e., a precision of 0.1 sec)} -% \qualifier{mas}{: display to a precision of milliseconds +% \qualifier{mas}{display to a precision of milliseconds % corresponds to secfmt="%06.3f"} -% \qualifier{muas}{: display to a precision of microseconds +% \qualifier{muas}{display to a precision of microseconds % corresponds to secfmt="%08.5f"} %} %\description diff --git a/src/slang/strings/generate_iauname.sl b/src/slang/strings/generate_iauname.sl index fe2e3da2e66460637d6f78efbbca2df2dad8c5ea..b6c31f75f5f8e7848be542dc4b181502d05af2f7 100644 --- a/src/slang/strings/generate_iauname.sl +++ b/src/slang/strings/generate_iauname.sl @@ -3,20 +3,20 @@ define generate_iauname() { %\function{generate_iauname} %\synopsis{for a given position, generate a coordinate string obeying the IAU convention} %\usage{string=generate_iauname(ra,dec)} -%\qualifiers{% -% \qualifier{prefix}{: prefix for the string (e.g., "XMMU_")} -% \qualifier{radian}{: if set, the angles are in radians, not degrees} +%\qualifiers{ +% \qualifier{prefix}{prefix for the string (e.g., "XMMU_")} +% \qualifier{radian}{if set, the angles are in radians, not degrees} %} %\description -%This is a convenience routine to produce strings of the type -%XMMU Jhhmmss.s+ddmmss -%from J2000.0 positions. The routine obeys the IAU convention of -%truncating (not rounding!) the coordinate to the digits shown. +% This is a convenience routine to produce strings of the type +% XMMU Jhhmmss.s+ddmmss +% from J2000.0 positions. The routine obeys the IAU convention of +% truncating (not rounding!) the coordinate to the digits shown. % -%The default-string is "Jhhmmss.s+ddmmss", use the prefix qualifier -%to prepend the mission name. +% The default-string is "Jhhmmss.s+ddmmss", use the prefix qualifier +% to prepend the mission name. % -%Use angle2string to format coordinates with appropriate rounding. +% Use angle2string to format coordinates with appropriate rounding. % %\seealso{dms2deg, hms2deg, angle2string, deg2dms} %!%- diff --git a/src/slang/structs/get_struct_fields.sl b/src/slang/structs/get_struct_fields.sl index 5e60ad00e9f3499bdc08e9ee6fac46e67b9f8716..85f6018e586bffe6c97f49b8a4e39dbdb6a857f8 100644 --- a/src/slang/structs/get_struct_fields.sl +++ b/src/slang/structs/get_struct_fields.sl @@ -4,7 +4,7 @@ define get_struct_fields() %\synopsis{returns several fields of a structure} %\usage{(Any_Type val1, val2, ...) = get_struct_fields(Struct_Type s, String_Type fieldname1, fieldname2, ...);} %\qualifiers{ -%\qualifier{i}{: indices used for filtering array fields} +%\qualifier{i}{indices used for filtering array fields} %} %\description % Each value corresponds to the according field of the structure. diff --git a/src/slang/structs/histograms/read_histo.sl b/src/slang/structs/histograms/read_histo.sl index 99b41a17ac9e1b60169f87a605d241ec03652b32..9a3d1dadb2660c9b8bea2844d1413c40da50c955 100644 --- a/src/slang/structs/histograms/read_histo.sl +++ b/src/slang/structs/histograms/read_histo.sl @@ -3,6 +3,15 @@ define read_histo(inf){ %\function{read_histo} %\synopsis{read text data into histogram structure} %\usage{Struct_Type hist = read_histo(String_Type filename);} +%\qualifiers{ +%\qualifier{cols}{[=4] number of columns in the data file} +%\qualifier{collist}{array of column index for bin_lo, bin_hi, +% value, err in that order. Needs col=-1.} +%\qualifier{bin_lo}{column index for bin_lo. Needs col=-1.} +%\qualifier{bin_hi}{column index for bin_hi. Needs col=-1.} +%\qualifier{value}{column index for value. Needs col=-1.} +%\qualifier{err}{column index for err. Needs col=-1.} +%} %\description % Read a text file with column data directly into a histogram % structure struct{bin_lo,bin_hi,value,err};. @@ -32,15 +41,6 @@ define read_histo(inf){ % this field is ignored. Missing columns are populated % as described above. % Presence of collist takes presedence over the others. -%\qualifiers{ -%\qualifier{cols[=4]}{: number of columns in the data file} -%\qualifier{collist}{ : array of column index for bin_lo, bin_hi, -% value, err in that order. Needs col=-1.} -%\qualifier{bin_lo}{ : column index for bin_lo. Needs col=-1.} -%\qualifier{bin_hi}{ : column index for bin_hi. Needs col=-1.} -%\qualifier{value}{ : column index for value. Needs col=-1.} -%\qualifier{err}{ : column index for err. Needs col=-1.} -%} %\seealso{init_histo, add_hist, shift_hist, %scale_hist, stretch_hist} %!%- diff --git a/src/slang/structs/tables/lightcurves/split_lc_at_gaps.sl b/src/slang/structs/tables/lightcurves/split_lc_at_gaps.sl index d03a874c5950c1c9bdb189780db2f9e71dcfee9b..872a6a4d1d78de8fcb064adc775d1b3b37039448 100644 --- a/src/slang/structs/tables/lightcurves/split_lc_at_gaps.sl +++ b/src/slang/structs/tables/lightcurves/split_lc_at_gaps.sl @@ -6,7 +6,7 @@ define split_lc_at_gaps() %\synopsis{splits a light curve at gaps of a certain length} %\usage{Struct_Type split_lc[] = split_lc_at_gaps(Struct_Type lc, Double_Type gap_threshold);} %\qualifiers{ -%\qualifier{time}{ [\code{="time"}]: time field} +%\qualifier{time}{[\code{="time"}] time field} %} %\description % \code{lc} has to be a structure containing a \code{time} field, which is an array of ascending values, diff --git a/src/slang/structs/tables/par2tex.sl b/src/slang/structs/tables/par2tex.sl index ed183aba75074b416332d9af3bc8c60ada36d788..175404b8cccffbc0a1a8350e9f1749acba46db72 100644 --- a/src/slang/structs/tables/par2tex.sl +++ b/src/slang/structs/tables/par2tex.sl @@ -195,8 +195,8 @@ define par2tex() %\synopsis{Write a LaTeX parameter table from a fit saved with fits_save_fit} %\usage{ Integer_Type status = par2tex(fits-fit);} %\qualifiers{ - %\qualifier{Obsid}{: observation identifier (e.g. obsid)} - %\qualifier{Src}{: source string} + %\qualifier{Obsid}{observation identifier (e.g. obsid)} + %\qualifier{Src}{source string} %} %\description % Uses fit saved with fits_save_fit (basename.fits) to write diff --git a/src/slang/structs/tables/struct-arrays/print_struct.sl b/src/slang/structs/tables/struct-arrays/print_struct.sl index e5373fa80e5fdc417066801fe05673ef536331c7..ff138b96ea4129d552548ee90e4df089fcdd85af 100644 --- a/src/slang/structs/tables/struct-arrays/print_struct.sl +++ b/src/slang/structs/tables/struct-arrays/print_struct.sl @@ -12,16 +12,16 @@ define print_struct() % is specified, which may either be a file pointer % or a string containing the filename. %\qualifiers{ -%\qualifier{i}{: array of rows which are to be shown at all} -%\qualifier{mark}{: array of rows which are to be marked} -%\qualifier{fields}{: array of fieldnames (columns) which are to be shown} -%\qualifier{fmt}{: format string(s) for the columns, see \code{help("sprintf");}} -%\qualifier{sep}{: string separator between the columns (default = \code{" "})} -%\qualifier{initial}{: initial separator on a line (default = \code{""})} -%\qualifier{final}{: final separator on a line (default = \code{""})} -%\qualifier{html}{: set \code{sep}, \code{initial} and \code{final} such that an HTML table is produced} -%\qualifier{tex}{: set \code{sep}, \code{initial} and \code{final} such that a TeX table is produced} -%\qualifier{nohead}{: don't show head line with field names} +%\qualifier{i}{array of rows which are to be shown at all} +%\qualifier{mark}{array of rows which are to be marked} +%\qualifier{fields}{array of fieldnames (columns) which are to be shown} +%\qualifier{fmt}{format string(s) for the columns, see \code{help("sprintf");}} +%\qualifier{sep}{string separator between the columns (default = \code{" "})} +%\qualifier{initial}{initial separator on a line (default = \code{""})} +%\qualifier{final}{final separator on a line (default = \code{""})} +%\qualifier{html}{set \code{sep}, \code{initial} and \code{final} such that an HTML table is produced} +%\qualifier{tex}{set \code{sep}, \code{initial} and \code{final} such that a TeX table is produced} +%\qualifier{nohead}{don't show head line with field names} %} %\examples % \code{print_struct( s); %} The fields of \code{s} are printed.\n diff --git a/src/slang/structs/tables/struct-arrays/replicate_table.sl b/src/slang/structs/tables/struct-arrays/replicate_table.sl index 66a8eac9a36043b5ebb13528fb89031e10603c72..c40bcecb0797c2b1a26a83daa086f4146b167b22 100644 --- a/src/slang/structs/tables/struct-arrays/replicate_table.sl +++ b/src/slang/structs/tables/struct-arrays/replicate_table.sl @@ -4,10 +4,10 @@ define replicate_table() %\synopsis{repeats columns of a table, possibly with a periodic shift} %\usage{Struct_Type replicate_table(Struct_Type t);} %\qualifiers{ -%\qualifier{P}{ [= 1]: period} -%\qualifier{back}{ [= 0]: repeat periods backwards} -%\qualifier{ahead}{ [= 1]: repeat periods forwards} -%\qualifier{periodic}{ [\code{= ["bin_lo", "bin_hi"]}]: periodic structure fields} +%\qualifier{P}{[= 1] period} +%\qualifier{back}{[= 0] repeat periods backwards} +%\qualifier{ahead}{[= 1] repeat periods forwards} +%\qualifier{periodic}{[\code{= ["bin_lo", "bin_hi"]}] periodic structure fields} %} %\description % The return value is a structure with the same fields as \code{t}. diff --git a/src/slang/structs/tables/table_print_TeX.sl b/src/slang/structs/tables/table_print_TeX.sl index 303c21c2c07d922ebbccdf5f597124622ba974c9..1668c73f2bf8adf6f7d0044da29a1336a662595b 100644 --- a/src/slang/structs/tables/table_print_TeX.sl +++ b/src/slang/structs/tables/table_print_TeX.sl @@ -7,7 +7,7 @@ define table_print_TeX() % If no columns are specified by the string-array \code{cols}, % all columns of the table tab are used. %\qualifiers{ -%\qualifier{align}{: alignment of all columns: "l", "c", "r" [default: "l"]} +%\qualifier{align}{alignment of all columns: "l", "c", "r" [default: "l"]} %\qualifier{heading}{[=\code{cols}]: headings for TeX table} %\qualifier{output}{[=stdout]: output can be written in a file by stating % a File_Type or the filename (String_Type)} diff --git a/src/slang/system/make_path.sl b/src/slang/system/make_path.sl index 268a302f90043bb61dd677b5ecbbc90a4f0764db..8bf61a81654437aae778c8f256b57bf40393af1c 100644 --- a/src/slang/system/make_path.sl +++ b/src/slang/system/make_path.sl @@ -13,10 +13,10 @@ define make_path () % and is not a directory. % %\qualifiers{ -%\qualifier{mode}{: mode for the paths to be generated. If mode is an +%\qualifier{mode}{mode for the paths to be generated. If mode is an % array, it contains the mode for each individual path % specified. Default: 0777} -%\qualifier{separator}{: path separator. Default is /, so you will +%\qualifier{separator}{path separator. Default is /, so you will % probably not have to use it...} %} %\example diff --git a/src/slang/write_slurm_script.sl b/src/slang/write_slurm_script.sl index 90ff57136e3fbbf6057f5a0fdb627b18042c581c..5939cc79865173a7b740bc2033cace15817611d7 100644 --- a/src/slang/write_slurm_script.sl +++ b/src/slang/write_slurm_script.sl @@ -6,16 +6,16 @@ define write_slurm_script(){ %\synopsis{writes a slurm job script, which can be submitted with squeue} %\usage{write_slurm_script(file,jobname,walltime,cmds);} %\qualifiers{ -%\qualifier{queue}{:set the queue (remeis by default)} -%\qualifier{silent}{: don't show any output} -%\qualifier{serial}{: instead of parallel, execute commands one after the other} -%\qualifier{option}{: setting commands or environment variables before executing the actual commands} -%\qualifier{ntaks}{[=1]: number of tasks per CPU} -%\qualifier{memory}{[=1000]: MByte in memory allocated (--mem-per-cpu in slurm)} -%\qualifier{output}{: output logfile name} -%\qualifier{error}{: error logfile name} -%\qualifier{account}{: if the selected queue needs a specific account set this qualifier accordingly} -%\qualifier{dir}{[=getcwd()]: absolut path where the script should be run (default is cwd)} +%\qualifier{queue}{set the queue (remeis by default)} +%\qualifier{silent}{do not show any output} +%\qualifier{serial}{instead of parallel, execute commands one after the other} +%\qualifier{option}{setting commands or environment variables before executing the actual commands} +%\qualifier{ntaks}{[=1] number of tasks per CPU} +%\qualifier{memory}{[=1000] MByte in memory allocated (--mem-per-cpu in slurm)} +%\qualifier{output}{output logfile name} +%\qualifier{error}{error logfile name} +%\qualifier{account}{if the selected queue needs a specific account set this qualifier accordingly} +%\qualifier{dir}{[=getcwd()] absolut path where the script should be run (default is cwd)} %} %\description % Writing a slurm job script, which can be submitted with squeue. diff --git a/src/xspec/table_models.sl b/src/xspec/table_models.sl index 4ad7fd84b2dd2c476a75a2101b7157ce67d223ff..7b7c9823a1a7cc85329e0786bb256e62cdecb449 100644 --- a/src/xspec/table_models.sl +++ b/src/xspec/table_models.sl @@ -73,14 +73,14 @@ private define tableModelAddParameter (self, name, values) %\usage{table_model.add_parameter(String_Type name, Double_Type[] values);} %#c%{{{ %\qualifiers{ -% \qualifier{log}{: if given, parameter is interpolated logarithmically rather than linearly} -% \qualifier{unit}{[=""]: Set the unit of the parameter} -% \qualifier{minimum}{[=min(values)]: Set hard lower limit} -% \qualifier{bottom}{[=min(values)]: Set minimum parameter range} -% \qualifier{top}{[=max(values)]: Set maximum parameter range} -% \qualifier{maximum}{[=max(values)]: Set hard upper limit} -% \qualifier{initial}{[=mean(values)]: Set initial parameter value} -% \qualifier{delta}{[=(max(values)-min(values))*1e-2]: Set parameter step hint} +% \qualifier{log}{if given, parameter is interpolated logarithmically rather than linearly} +% \qualifier{unit}{[=""] Set the unit of the parameter} +% \qualifier{minimum}{[=min(values)] Set hard lower limit} +% \qualifier{bottom}{[=min(values)] Set minimum parameter range} +% \qualifier{top}{[=max(values)] Set maximum parameter range} +% \qualifier{maximum}{[=max(values)] Set hard upper limit} +% \qualifier{initial}{[=mean(values)] Set initial parameter value} +% \qualifier{delta}{[=(max(values)-min(values))*1e-2] Set parameter step hint} %} %\description % Each call to this function adds a new parameter with the given name @@ -104,13 +104,13 @@ private define tableModelAddAdditionalParameter (self, name) %\usage{table_model.add_additional(String_Type name);} %#c%{{{ %\qualifiers{ -% \qualifier{unit}{[=""]: Set the unit of the parameter} -% \qualifier{minimum}{[=min(values)]: Set hard lower limit} -% \qualifier{bottom}{[=min(values)]: Set minimum parameter range} -% \qualifier{top}{[=max(values)]: Set maximum parameter range} -% \qualifier{maximum}{[=max(values)]: Set hard upper limit} -% \qualifier{initial}{[=mean(values)]: Set initial parameter value} -% \qualifier{delta}{[=(max(values)-min(values))*1e-2]: Set parameter step hint} +% \qualifier{unit}{[=""] Set the unit of the parameter} +% \qualifier{minimum}{[=min(values)] Set hard lower limit} +% \qualifier{bottom}{[=min(values)] Set minimum parameter range} +% \qualifier{top}{[=max(values)] Set maximum parameter range} +% \qualifier{maximum}{[=max(values)] Set hard upper limit} +% \qualifier{initial}{[=mean(values)] Set initial parameter value} +% \qualifier{delta}{[=(max(values)-min(values))*1e-2] Set parameter step hint} %} %\description % Add additional contributions to the interpolated spectra. These parameters @@ -135,8 +135,8 @@ private define tableModelSetEnergyGrid (self, bin_lo, bin_hi) %\usage{table_model.set_grid(bin_lo, bin_hi);} %#c%{{{ %\qualifiers{ -% \qualifier{lolimit}{[=0]: The model value if lower than lowest bin} -% \qualifier{hilimit}{[=0]: The model value if higher than highest bin} +% \qualifier{lolimit}{[=0] The model value if lower than lowest bin} +% \qualifier{hilimit}{[=0] The model value if higher than highest bin} %} %\description % Set the energy grid on which the model gets interpolated. @@ -580,9 +580,9 @@ private define tableModelWriteTable (self) %\usage{table_model.write();} %#c%{{{ %\qualifiers{ -% \qualifier{redshift}{: if given, set redshift parameter flag} -% \qualifier{mult}{: if given, model is multiplicative (default additive)} -% \qualifier{verbose}{: show additional information} +% \qualifier{redshift}{if given, set redshift parameter flag} +% \qualifier{mult}{if given, model is multiplicative (default additive)} +% \qualifier{verbose}{show additional information} %} %\description % Given the model function and additional contributions, this @@ -665,9 +665,9 @@ define new_table_model (filename) %\usage{Struct_Type model = new_table_model(String_Type filename)} %#c%{{{ %\qualifiers{ -% \qualifier{name}{[=]: set model name} -% \qualifier{double}{: if set, stores all values as doubles instead of floats} -% \qualifier{overwrite}{: if set, ignores existing file with same name} +% \qualifier{name}{[=] set model name} +% \qualifier{double}{if set, stores all values as doubles instead of floats} +% \qualifier{overwrite}{if set, ignores existing file with same name} %} %\description % Giving a file name the function creates a fits file with the given