/* * 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 "@(#) time_frac.c 1.18 05/08/19 SwRI" #include "ret_codes.h" #include "user_defs.h" #include "gen_defs.h" #include "libtrec_idfs.h" /**************************************************************************** * * * IR_CALC_TIME_FRAC SUBROUTINE * * * * DESCRIPTION * * This routine determines the percentage of the requested pixel time * * resolution covered by the current sweep. This is needed to determine * * the amount of data that should go into a bin if the sample lies within * * the same pixel. This is achieved by determining the amount of time, * * in seconds, covered by the sweep and then dividing by the pixel time * * resolution, also in seconds. * * * * INPUT VARIABLES * * SDDAS_CHAR mode_data flag indicating if mode data is being * * processed * * void *idf_data_ptr ptr to memory location for the structure * * that holds returned data values (read_drec)* * * * USAGE * * x = ir_calc_time_frac (mode_data, idf_data_ptr) * * * * NECESSARY SUBPROGRAMS * * None * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure holding information concerning * * the experiment that is being processed * * * * INTERNAL VARIABLES * * struct idf_data *EXP_DATA structure that holds all of the currently * * returned data values to be processed * * struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * reg SDDAS_FLOAT ret_frac the percentage of the requested pixel time * * resolution covered by the current sample * * reg SDDAS_FLOAT res_comp time resolution in terms of seconds * * reg SDDAS_FLOAT diff_samp the time covered by the sample * * SDDAS_SHORT diff_year the year difference between the start and * * the end of the sample time period * * SDDAS_SHORT diff_day the day difference between the start and * * the end of the sample time period * * SDDAS_SHORT days_in_yr the number of day in the year - takes leap * * year into account * * * * SUBSYSTEM * * Display Level * * * ***************************************************************************/ SDDAS_FLOAT ir_calc_time_frac (SDDAS_CHAR mode_data, void *idf_data_ptr) { extern struct general_info ginfo; struct idf_data *EXP_DATA; struct experiment_info *ex; register SDDAS_FLOAT ret_frac, res_comp, diff_samp; SDDAS_SHORT diff_year, diff_day, days_in_yr; /******************************************************************/ /* Determine the time covered by the sample */ /******************************************************************/ EXP_DATA = (struct idf_data *) idf_data_ptr; ex = ginfo.expt; if (mode_data) { diff_year = EXP_DATA->mode_eyear - EXP_DATA->mode_byear; diff_day = EXP_DATA->mode_eday - EXP_DATA->mode_bday; /******************************************************************/ /* The sample's time range covers a day or more? */ /******************************************************************/ if (diff_day != 0 || diff_year != 0) { /******************************************************************/ /* Assumption is no more than a year difference. */ /******************************************************************/ if ((EXP_DATA->mode_byear % 4 == 0 && EXP_DATA->mode_byear % 100 != 0) || EXP_DATA->mode_byear % 400 == 0) days_in_yr = 366; else days_in_yr = 365; diff_samp = (diff_year * days_in_yr * 86400) + diff_day * 86400 + (EXP_DATA->mode_emilli - EXP_DATA->mode_bmilli) / 1000.0 + (EXP_DATA->mode_enano - EXP_DATA->mode_bnano) / 1000000000.0; } else diff_samp = (EXP_DATA->mode_emilli - EXP_DATA->mode_bmilli) / 1000.0 + (EXP_DATA->mode_enano - EXP_DATA->mode_bnano) / 1000000000.0; } else { diff_year = EXP_DATA->eyear - EXP_DATA->byear; diff_day = EXP_DATA->eday - EXP_DATA->bday; /******************************************************************/ /* The sample's time range covers a day or more? */ /******************************************************************/ if (diff_day != 0 || diff_year != 0) { /******************************************************************/ /* Assumption is no more than a year difference. */ /******************************************************************/ if ((EXP_DATA->byear % 4 == 0 && EXP_DATA->byear % 100 != 0) || EXP_DATA->byear % 400 == 0) days_in_yr = 366; else days_in_yr = 365; diff_samp = (diff_year * days_in_yr * 86400) + diff_day * 86400 + (EXP_DATA->emilli - EXP_DATA->bmilli) / 1000.0 + (EXP_DATA->enano - EXP_DATA->bnano) / 1000000000.0; } else diff_samp = (EXP_DATA->emilli - EXP_DATA->bmilli) / 1000.0 + (EXP_DATA->enano - EXP_DATA->bnano) / 1000000000.0; } /*******************************************************************/ /* Put the resolution per pixel in terms of seconds and calculate */ /* the amount of time covered by this sample with respect to the */ /* resolution value. 86400 - no. of seconds in a day. */ /*******************************************************************/ res_comp = ex->time_values.res_sec + (ex->time_values.res_nano / 1000000000.0); ret_frac = (diff_samp >= 0.0) ? diff_samp / res_comp : (diff_samp + 86400.0) / res_comp; return (ret_frac); }