diff options
Diffstat (limited to 'fitsy/doc/headget.html')
| -rw-r--r-- | fitsy/doc/headget.html | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/fitsy/doc/headget.html b/fitsy/doc/headget.html new file mode 100644 index 0000000..a9b666c --- /dev/null +++ b/fitsy/doc/headget.html @@ -0,0 +1,104 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3.2//EN"> +<HTML> +<HEAD> +<TITLE> headget +</TITLE> +<p> +<!-- pnuts --> <a href="headtable.html">[Previous]</a> <a href="headset.html">[Next]</a> <a href="fitsy.html">[Up]</a> <a href="../mmtilib.html">[Top]</a> +<META NAME="generator" CONTENT="txt2html v1.3"> +</HEAD> +<BODY> + + +<A NAME="section-1.1.1"><H3>NAME</H3></A> + +<P> + ft_headget,ft_headgetl,ft_headgeti,ft_headgetr,ft_headgets -Find and return + values from a FITS header. + +<A NAME="section-1.1.2"><H3>SYNOPSIS</H3></A> + + + +<PRE> +char *ft_headget(FITSHead fits, char *name, int n, FITSCard *card); +int ft_headgetl(FITSHead fits, char *name, int n, int ldefault, FITSCard *card); +int ft_headgeti(FITSHead fits, char *name, int n, int idefault, FITSCard *card); +double ft_headgetr(FITSHead fits, char *name, int n, double ddefault, FITSCard *card); +char *ft_headgets(FITSHead fits, char *name, int n, char *sdefault, FITSCard *card); + + +<P> +</PRE> +<A NAME="section-1.1.3"><H3>PARAMETERS</H3></A> + +<UL> +<P> + <LI> <B>FITSHead fits</B> - The FITS header to search. + <LI> <B>char *name</B> - Name of the card keyword to search for. + <LI> <B>int n</B> - keyword index number, if is zero no + index number is appended to the keyword. + <LI> <B>FITSCard *card</B> - The FITS card that was found. + <LI> <B>int ldefault</B> - Default logical value to return. + <LI> <B>int idefault</B> - Default integer value to return. + <LI> <B>double ddefault</B> - Default real value to return. + <LI> <B>char *sdefault</B> - Default string value to return. + +</UL> +<A NAME="section-1.1.4"><H3>DESCRIPTION</H3></A> + + +<A NAME="section-1.1.4.1"><H4>ft_headget</H4></A> + +<P> + Find and return the value of a FITS card as a static string. + +<A NAME="section-1.1.4.2"><H4>ft_headgetl</H4></A> + +<P> + Find and return the value of a FITS card as a logical. + +<A NAME="section-1.1.4.3"><H4>ft_headgeti</H4></A> + +<P> + Find and return the value of a FITS card as an integer. + +<A NAME="section-1.1.4.4"><H4>ft_headgetr</H4></A> + +<P> + Find and return the value of a FITS card as a real. + +<A NAME="section-1.1.4.5"><H4>ft_headgets</H4></A> + +<P> + Find and return the value of a FITS card as a allocated string. + +<A NAME="section-1.1.5"><H3>EXAMPLES</H3></A> + + +<PRE> + FITSHead fits; + FITSCard card; + + + int simple; + int ax1, ax2; + + /* Look up the SIMPLE card in the header and see if its is + True. If it's not found return False. + */ + simple = <B>ft_headgetl</B>(fits, "SIMPLE", 0, 0, &card); + + /* Look up the NAXIS1 and NAXIS2 cards in the header + if a card is not found return 0. + */ + ax1 = <B>ft_headgeti</B>(fits, "NAXIS", 1, 0, &card); + ax2 = <B>ft_headgeti</B>(fits, "NAXIS", 2, 0, &card); + +<P> +</PRE> + +<p> +<!-- pnuts --> <a href="headtable.html">[Previous]</a> <a href="headset.html">[Next]</a> <a href="fitsy.html">[Up]</a> <a href="../mmtilib.html">[Top]</a> +</BODY> +</HTML> |