1 /* 2 3 -Header_File SpiceOccult.h ( CSPICE Occultation specific definitions ) 4 5 -Abstract 6 7 Perform CSPICE occultation specific definitions. 8 9 -Disclaimer 10 11 THIS SOFTWARE AND ANY RELATED MATERIALS WERE CREATED BY THE 12 CALIFORNIA INSTITUTE OF TECHNOLOGY (CALTECH) UNDER A U.S. 13 GOVERNMENT CONTRACT WITH THE NATIONAL AERONAUTICS AND SPACE 14 ADMINISTRATION (NASA). THE SOFTWARE IS TECHNOLOGY AND SOFTWARE 15 PUBLICLY AVAILABLE UNDER U.S. EXPORT LAWS AND IS PROVIDED "AS-IS" 16 TO THE RECIPIENT WITHOUT WARRANTY OF ANY KIND, INCLUDING ANY 17 WARRANTIES OF PERFORMANCE OR MERCHANTABILITY OR FITNESS FOR A 18 PARTICULAR USE OR PURPOSE (AS SET FORTH IN UNITED STATES UCC 19 SECTIONS 2312-2313) OR FOR ANY PURPOSE WHATSOEVER, FOR THE 20 SOFTWARE AND RELATED MATERIALS, HOWEVER USED. 21 22 IN NO EVENT SHALL CALTECH, ITS JET PROPULSION LABORATORY, OR NASA 23 BE LIABLE FOR ANY DAMAGES AND/OR COSTS, INCLUDING, BUT NOT 24 LIMITED TO, INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND, 25 INCLUDING ECONOMIC DAMAGE OR INJURY TO PROPERTY AND LOST PROFITS, 26 REGARDLESS OF WHETHER CALTECH, JPL, OR NASA BE ADVISED, HAVE 27 REASON TO KNOW, OR, IN FACT, SHALL KNOW OF THE POSSIBILITY. 28 29 RECIPIENT BEARS ALL RISK RELATING TO QUALITY AND PERFORMANCE OF 30 THE SOFTWARE AND ANY RELATED MATERIALS, AND AGREES TO INDEMNIFY 31 CALTECH AND NASA FOR ALL THIRD-PARTY CLAIMS RESULTING FROM THE 32 ACTIONS OF RECIPIENT IN THE USE OF THE SOFTWARE. 33 34 -Required_Reading 35 36 None. 37 38 -Keywords 39 40 OCCULTATION 41 GEOMETRY 42 ELLIPSOID 43 44 -Exceptions 45 46 None 47 48 -Files 49 50 None 51 52 -Particulars 53 54 The following integer codes indicate the geometric relationship 55 of the three bodies. 56 57 The meaning of the sign of each code is given below. 58 59 Code sign Meaning 60 --------- ------------------------------ 61 > 0 The second ellipsoid is 62 partially or fully occulted 63 by the first. 64 65 < 0 The first ellipsoid is 66 partially of fully 67 occulted by the second. 68 69 = 0 No occultation. 70 71 The meanings of the codes are given below. The variable names 72 indicate the type of occultation and which target is in the back. 73 For example, SPICE_OCCULT_TOTAL1 represents a total occultation in which 74 the first target is in the back (or occulted by) the second target. 75 76 Name Code Meaning 77 ------ ----- ------------------------------ 78 SPICE_OCCULT_TOTAL1 -3 Total occultation of first 79 target by second. 80 81 SPICE_OCCULT_ANNLR1 -2 Annular occultation of first 82 target by second. The second 83 target does not block the limb 84 of the first. 85 86 SPICE_OCCULT_PARTL1 -1 Partial occultation of first 87 target by second target. 88 89 SPICE_OCCULT_NOOCC 0 No occultation or transit: both 90 objects are completely visible 91 to the observer. 92 93 SPICE_OCCULT_PARTL2 1 Partial occultation of second 94 target by first target. 95 96 SPICE_OCCULT_ANNLR2 2 Annular occultation of second 97 target by first. 98 99 SPICE_OCCULT_TOTAL2 3 Total occultation of second 100 target by first. 101 102 -Examples 103 104 None 105 106 -Restrictions 107 108 None. 109 110 -Literature_References 111 112 None. 113 114 -Author_and_Institution 115 116 S.C. Krening (JPL) 117 N.J. Bachman (JPL) 118 119 -Version 120 121 -CSPICE Version 1.0.0, 23-FEB-2012 (SCK) 122 123 */ 124 125 126 #ifndef HAVE_SPICE_OCCULT_H 127 128 #define HAVE_SPICE_OCCULT_H 129 130 /* 131 See the Particulars section above for parameter descriptions. 132 */ 133 134 /* 135 Occultation parameters 136 */ 137 138 #define SPICE_OCCULT_TOTAL1 -3 139 #define SPICE_OCCULT_ANNLR1 -2 140 #define SPICE_OCCULT_PARTL1 -1 141 #define SPICE_OCCULT_NOOCC 0 142 #define SPICE_OCCULT_PARTL2 1 143 #define SPICE_OCCULT_ANNLR2 2 144 #define SPICE_OCCULT_TOTAL2 3 145 146 147 #endif 148