/* * Copyright (C) 1998 by Southwest Research Institute (SwRI) * * All rights reserved under U.S. Copyright Law and International Conventions. * * The development of this Software was supported by contracts NAG5-3148, * NAG5-6855, NAS8-36840, NAG5-2323, and NAG5-7043 issued on behalf of * the United States Government by its National Aeronautics and Space * Administration. Southwest Research Institute grants to the Government, * and others acting on its behalf, a paid-up nonexclusive, irrevocable, * worldwide license to reproduce, prepare derivative works, and perform * publicly and display publicly, by or on behalf of the Government. * Other than those rights granted to the United States Government, no part * of this Software may be reproduced in any form or by any means, electronic * or mechanical, including photocopying, without permission in writing from * Southwest Research Institute. All inquiries should be addressed to: * * Director of Contracts * Southwest Research Institute * P. O. Drawer 28510 * San Antonio, Texas 78228-0510 * * * Use of this Software is governed by the terms of the end user license * agreement, if any, which accompanies or is included with the Software * (the "License Agreement"). An end user will be unable to install any * Software that is accompanied by or includes a License Agreement, unless * the end user first agrees to the terms of the License Agreement. Except * as set forth in the applicable License Agreement, any further copying, * reproduction or distribution of this Software is expressly prohibited. * Installation assistance, product support and maintenance, if any, of the * Software is available from SwRI and/or the Third Party Providers, as the * case may be. * * Disclaimer of Warranty * * SOFTWARE IS WARRANTED, IF AT ALL, IN ACCORDANCE WITH THESE TERMS OF THE * LICENSE AGREEMENT. UNLESS OTHERWISE EXPLICITLY STATED, THIS SOFTWARE IS * PROVIDED "AS IS", IS EXPERIMENTAL, AND IS FOR NON-COMMERCIAL USE ONLY, * AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR * PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT * SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. * * Limitation of Liability * * SwRI SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED AS A RESULT OF USING, * MODIFYING, CONTRIBUTING, COPYING, DISTRIBUTING, OR DOWNLOADING THIS * SOFTWARE. IN NO EVENT SHALL SwRI BE LIABLE FOR ANY INDIRECT, PUNITIVE, * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGE (INCLUDING LOSS OF BUSINESS, * REVENUE, PROFITS, USE, DATA OR OTHER ECONOMIC ADVANTAGE) HOWEVER IT ARISES, * WHETHER FOR BREACH OF IN TORT, EVEN IF SwRI HAS BEEN PREVIOUSLY ADVISED OF * THE POSSIBILITY OF SUCH DAMAGE. YOU HAVE SOLE RESPONSIBILITY FOR ADEQUATE * PROTECTION AND BACKUP OF DATA AND/OR EQUIPMENT USED IN CONNECTION WITH THE * SOFTWARE AND WILL NOT MAKE A CLAIM AGAINST SwRI FOR LOST DATA, RE-RUN TIME, * INACCURATE OUTPUT, WORK DELAYS OR LOST PROFITS RESULTING FROM THE USE OF * THIS SOFTWARE. YOU AGREE TO HOLD SwRI HARMLESS FROM, AND YOU COVENANT NOT * TO SUE SwRI FOR, ANY CLAIMS BASED ON USING THE SOFTWARE. * * Local Laws: Export Control * * You acknowledge and agree this Software is subject to the U.S. Export * Administration Laws and Regulations. Diversion of such Software contrary * to U.S. law is prohibited. You agree that none of the Software, nor any * direct product therefrom, is being or will be acquired for, shipped, * transferred, or reexported, directly or indirectly, to proscribed or * embargoed countries or their nationals, nor be used for nuclear activities, * chemical biological weapons, or missile projects unless authorized by U.S. * Government. Proscribed countries are set forth in the U.S. Export * Administration Regulations. Countries subject to U.S embargo are: Cuba, * Iran, Iraq, Libya, North Korea, Syria, and the Sudan. This list is subject * to change without further notice from SwRI, and you must comply with the * list as it exists in fact. You certify that you are not on the U.S. * Department of Commerce's Denied Persons List or affiliated lists or on the * U.S. Department of Treasury's Specially Designated Nationals List. You agree * to comply strictly with all U.S. export laws and assume sole responsibilities * for obtaining licenses to export or reexport as may be required. * * General * * These Terms represent the entire understanding relating to the use of the * Software and prevail over any prior or contemporaneous, conflicting or * additional, communications. SwRI can revise these Terms at any time * without notice by updating this posting. * * Trademarks * * The SwRI logo is a trademark of SwRI in the United States and other countries. * */ #ident "@(#) calc_tres.c 1.16 05/08/19 SwRI" #include #include "ret_codes.h" #include "libbase_idfs.h" #include "libVIDF.h" /******************************************************************************* * * * CALC_TIME_RESOLUTION SUBROUTINE * * * * DESCRIPTION * * This routine is called to determine the time resolution for the specified* * data set. The varible NUM_SWEEPS indicates if time is determined in terms * * of sweeps or if time is determined in terms of spins. * * * * INPUT VARIABLES * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_CHAR *exten filename extension for the data to be used * * SDDAS_USHORT vnum version number to be associated with this * * combination (allows for multiple opens) * * void *idf_data_ptr ptr to the memory location for the structure * * that holds returned data values (read_drec) * * SDDAS_SHORT num_sweeps the number of sweeps/spins requested * * - positive value reflects sweeps * * - negative value reflects spins * * (value cannot be zero) * * SDDAS_LONG *res_sec, time resolution values * * *res_nsec * * * * USAGE * * x = calc_time_resolution (data_key, exten, vnum, idf_data_ptr, * * num_sweeps, &res_sec, &res_nsec) * * * * NECESSARY SUBPROGRAMS * * abs() returns the absolute value of a number * * ir_get_time_components() retrieves the time elements that are used to * * calculate the time associated with a sample * * ir_set_time() determines the time associated with the data * * being returned * * ir_locate_ex() determines if requested combination has already * * been processed and points to the correct * * structure allocated for the combo * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * struct ptr_rec *ptr a pointer to the structure which holds all * * pointers to the header and data for the * * experiment of interest * * SDDAS_LONG msecpswp the number of milliseconds per pixel for the * * SDDAS_LONG nsecpswp the number of nanoseconds per pixel for the * * SDDAS_LONG add_ms the number of milliseconds to add to the * * millisecond time element * * SDDAS_LONG spin_rate the spin rate for the instrument in question * * SDDAS_SHORT temp number of spins, sweeps asked for * * SDDAS_SHORT sensor the first sensor in the current sensor set * * SDDAS_SHORT rval holds called routine status flags * * SDDAS_CHAR decrement_bday flag indicating if start day needs to be * * modified (if btime ends up negative) * * SDDAS_CHAR decrement_eday flag indicating if end day needs to be * * modified (if etime ends up negative) * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT calc_time_resolution (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, void *idf_data_ptr, SDDAS_SHORT num_sweeps, SDDAS_LONG *res_sec, SDDAS_LONG *res_nsec) { extern struct general_info ginfo; struct experiment_info *ex; struct ptr_rec *ptr; SDDAS_LONG msecpswp, nsecpswp, add_ms, spin_rate; SDDAS_SHORT temp, sensor, rval; SDDAS_CHAR decrement_bday, decrement_eday; /***************************************************************************/ /* Check to see if the requested combination exists. Since a 0 is passed */ /* for the last parameter, the only possible error is that the combo was */ /* not found. */ /***************************************************************************/ if (!ginfo.called_locate) { rval = ir_locate_ex (data_key, exten, vnum, 0); if (rval != ALL_OKAY) return (CALC_TRES_NOT_FOUND); } /***************************************************************************/ /* Curently, this module cannot be called for Multi-dimensional data. */ /* CARRIE - not sure if this module needs to be restricted - may change. */ /***************************************************************************/ ex = ginfo.expt; if (ex->header_format != ORIGINAL_HEADER) return (WRONG_HEADER_FORMAT); /*************************************************************************/ /* The spin rate can either be positive or negative. Check for 0 spin. */ /*************************************************************************/ ptr = ex->info_ptr; spin_rate = abs (*ptr->SPIN); temp = abs (num_sweeps); if (num_sweeps > 0 || spin_rate == 0) { sensor = *ptr->SENSOR_INDEX; ir_get_time_components (); ir_set_time (0, sensor, idf_data_ptr, &decrement_bday, &decrement_eday); /************************************************************************/ /* The end time of the sweep is always greater than the start time of */ /* the sweep. */ /************************************************************************/ msecpswp = ex->etime_ms - ex->btime_ms; nsecpswp = ex->etime_ns - ex->btime_ns; /************************************************************************/ /* To get a better estimate, include the sweep reset time which in */ /* essence, gives the entire length of time for a complete sweep */ /* (from start of current sweep to start of next sweep). */ /************************************************************************/ msecpswp += ex->swp_ms; nsecpswp += ex->swp_ns; /************************************************************************/ /* If the amount of nanoseconds goes negative, one milliseconds worth */ /* of nanoseconds must be borrowed. */ /************************************************************************/ if (nsecpswp < 0) { --msecpswp; nsecpswp += 1000000; } /************************************************************************/ /* Multiply the base resolution by the value entered. */ /************************************************************************/ msecpswp *= temp; nsecpswp *= temp; /************************************************************************/ /* If the nanosecond time element can be converted into milliseconds, */ /* do so and add this to the millisecond time element and keep the */ /* leftover nanoseconds. 1000000 nanoseconds = 1 millisecond. */ /************************************************************************/ add_ms = nsecpswp / 1000000; msecpswp += add_ms; nsecpswp = nsecpswp % 1000000; /************************************************************************/ /* Save the resolution in terms of seconds and nanoseconds. */ /************************************************************************/ *res_sec = msecpswp / 1000; *res_nsec = (msecpswp % 1000) * 1000000 + nsecpswp; } else { /************************************************************************/ /* The spin rate is already expressed in terms of milliseconds. */ /************************************************************************/ msecpswp = spin_rate; nsecpswp = 0; /************************************************************************/ /* Multiply the spin rate by the value entered. For example, a -4 */ /* should be converted to 4 * spin rate. */ /************************************************************************/ msecpswp *= temp; nsecpswp *= temp; /************************************************************************/ /* Save the resolution in terms of seconds and nanoseconds. */ /************************************************************************/ *res_sec = msecpswp / 1000; *res_nsec = (msecpswp % 1000) * 1000000 + nsecpswp; } return (ALL_OKAY); }