wnsumd_c |

Table of contents## Procedurewnsumd_c ( Summary of a double precision window ) void wnsumd_c ( SpiceCell * window, SpiceDouble * meas, SpiceDouble * avg, SpiceDouble * stddev, SpiceInt * idxsml, SpiceInt * idxlon ) ## AbstractSummarize the contents of a double precision window. ## Required_ReadingWINDOWS ## KeywordsWINDOWS ## Brief_I/OVARIABLE I/O DESCRIPTION -------- --- -------------------------------------------------- window I Window to be summarized. meas O Total measure of intervals in window. avg O Average measure. stddev O Standard deviation. idxsml, idxlon O Locations of shortest, longest intervals. ## Detailed_Inputwindow is a window containing zero or more intervals. `window' must be declared as a double precision SpiceCell. CSPICE provides the following macro, which declares and initializes the cell SPICEDOUBLE_CELL ( window, WINDOWSZ ); where WINDOWSZ is the maximum capacity of `window'. ## Detailed_Outputmeas is the total measure of the intervals in the input window. This is just the sum of the measures of the individual intervals. avg is the average of the measures of the intervals in the input window. stddev is the standard deviation of the measures of the intervals in the input window. idxsml, idxlon are the locations of the shortest and longest intervals in the input window. The shortest interval is [ SPICE_CELL_ELEM_D( window, idxsml ), SPICE_CELL_ELEM_D( window, idxsml+1 ) ] and the longest is [ SPICE_CELL_ELEM_D( window, idxlon ), SPICE_CELL_ELEM_D( window, idxlon+1 ) ] `idxsml' and `idxlon' are both -1 if the input window contains no intervals. If `window' contains multiple intervals having the shortest length, `idxsml' is the index of the first such interval. Likewise for the longest length. Indices range from 0 to 2N-2, where N is the number of intervals in the window. ## ParametersNone. ## Exceptions1) If `window' has odd cardinality, the error SPICE(INVALIDCARDINALITY) is signaled by a routine in the call tree of this routine. 2) Left endpoints of stored intervals must be strictly greater than preceding right endpoints. Right endpoints must be greater than or equal to corresponding left endpoints. Invalid window data are not diagnosed by this routine and may lead to unpredictable results. 3) If the `window' cell argument has a type other than SpiceDouble, the error SPICE(TYPEMISMATCH) is signaled. ## FilesNone. ## ParticularsThis routine provides a summary of the input window, consisting of the following items: - The measure of the window. - The average and standard deviation of the measures of the individual intervals in the window. - The indices of the left endpoints of the shortest and longest intervals in the window. All of these quantities are zero if the window contains no intervals. ## ExamplesThe numerical results shown for these examples may differ across platforms. The results depend on the SPICE kernels used as input, the compiler and supporting libraries, and the machine specific arithmetic implementation. 1) Define a window with six intervals, and calculate the summary for that window. Example code begins here. /. Program wnsumd_ex1 ./ #include <stdio.h> #include "SpiceUsr.h" int main( ) { /. Local parameters. ./ #define WNSIZE 12 /. Local variables. ./ SpiceDouble avg; SpiceDouble left; SpiceDouble meas; SpiceDouble right; SpiceDouble stddev; SPICEDOUBLE_CELL ( window, WNSIZE ); SpiceInt idxlon; SpiceInt idxsml; SpiceInt intlon; SpiceInt intsml; /. Validate the window with size WNSIZE and zero elements. ./ wnvald_c ( WNSIZE, 0, &window ); /. Insert the intervals [ 1, 3 ] [ 7, 11 ] [ 18, 18 ] [ 23, 27 ] [ 30, 69 ] [ 72, 80 ] into `window'. ./ wninsd_c ( 1.0, 3.0, &window ); wninsd_c ( 7.0, 11.0, &window ); wninsd_c ( 18.0, 18.0, &window ); wninsd_c ( 23.0, 27.0, &window ); wninsd_c ( 30.0, 69.0, &window ); wninsd_c ( 72.0, 80.0, &window ); /. Calculate the summary for `window'. ./ ## RestrictionsNone. ## Literature_ReferencesNone. ## Author_and_InstitutionN.J. Bachman (JPL) J. Diaz del Rio (ODC Space) H.A. Neilan (JPL) W.L. Taber (JPL) I.M. Underwood (JPL) E.D. Wright (JPL) ## Version-CSPICE Version 1.1.0, 05-AUG-2021 (JDR) Changed output argument names "shortest" and "longest" to "idxsml" and "idxlon" for consistency with other routines. Edited the header to comply with NAIF standard. Added complete code example. Extended description of argument "window" in -Detailed_Input to include type and preferred declaration method. Fixed error in documentation of arguments "idxsml" and "idxlon": if the input window contains no intervals, both are -1 and not zero. Added entries #1 and #2 in -Exceptions section. -CSPICE Version 1.0.1, 27-JAN-2009 (EDW) Corrected argument names shown in Brief I/O list. "short" to "shortest"; "long" to "longest". -CSPICE Version 1.0.0, 29-JUL-2002 (NJB) (HAN) (WLT) (IMU) ## Index_Entriessummary of a d.p. window |

Fri Dec 31 18:41:15 2021