/* * 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 "@(#) pitch_frac.c 1.10 05/08/19 SwRI" #include "libbase_idfs.h" #include "user_defs.h" #include "frac_defs.h" /******************************************************************************* * * * IR_PITCH_TIME_FRAC SUBROUTINE * * * * DESCRIPTION * * This routine is called to determine what percentage of the data sample * * should be included for the current delta-t processing. Based upon where * * the start time of the sample lies with respect to the start time defined * * for the delta-t being processed, the fraction is either calculated with * * respect to the top edge (start time) or bottom edge (end time) of the * * delta-t time period. * * * * INPUT VARIABLES * * struct pitch_info *pa_ptr a pointer to the structure that holds pitch * * angle information * * struct time_span structure that holds the time period for * * src_time the current delta-t being processed * * SDDAS_SHORT which_comp index specifying which of the 3 components * * is being processed * * * * USAGE * * x = ir_pitch_time_frac (&pa_ptr, src_time, which_comp) * * * * NECESSARY SUBPROGRAMS * * ir_ancillary_data_end_time() determines if current sample terminates * * the acquisition for the current component * * ir_frac_start_time () determines which edge should be used in the * * percentage calculation * * ir_check_time_range () determines if sample is totally outside the * * time range of delta-t period * * ir_compute_delta_combo () determine the delta-t period in seconds * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * struct idf_data *ANC_DATA structure holding the data for the ancillary* * data product being processed * * SDDAS_DOUBLE delta_combo the delta-t period combined into seconds * * SDDAS_DOUBLE diff_combo the sample duration combined into seconds * * SDDAS_FLOAT frac the percentage of the data sample * * SDDAS_LONG bmilli start time of day for the sample in msec * * SDDAS_LONG bnano start time of day residual for the sample * * SDDAS_LONG emilli end time of day for the sample in msec * * SDDAS_LONG enano end time of day residual for the sample * * SDDAS_LONG diff_milli the time of day difference between the * * sample and the edge of the delta-t period * * SDDAS_LONG diff_nano the time of day residual difference between * * the sample and the edge of delta-t period * * SDDAS_SHORT byear start year value for the sample * * SDDAS_SHORT eyear end year value for the sample * * SDDAS_SHORT bday start day value for the sample * * SDDAS_SHORT eday end day value for the sample * * SDDAS_SHORT diff_year the year difference between the sample and * * the edge of the delta-t period * * SDDAS_SHORT diff_day the day difference between the sample and * * the edge of the delta-t period * * SDDAS_SHORT days_in_yr the number of day in the year - takes leap * * year into account * * SDDAS_CHAR use_top indicates if top edge or bottom edge is to * * used in percentage calculation * * SDDAS_CHAR time_out flag that indicates if data is to be used * * or not (time out of range being processed) * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_FLOAT ir_pitch_time_frac (struct pitch_info *pa_ptr, struct time_span src_time, SDDAS_SHORT which_comp) { struct idf_data *ANC_DATA; SDDAS_DOUBLE delta_combo, diff_combo; SDDAS_FLOAT frac; SDDAS_LONG bmilli, bnano, emilli, enano, diff_milli, diff_nano; SDDAS_SHORT byear, eyear, bday, eday, diff_year, diff_day, days_in_yr; SDDAS_CHAR use_top, time_out; /**************************************************************************/ /* Since ir_acquire_pitch_data () ensures that data from the same data */ /* set returns ONE consistent time value, all three components share the */ /* same time tag so for speed reasons, just compute once and save. */ /**************************************************************************/ if (which_comp != 0) { if (pa_ptr->copy_next_data) pa_ptr->next_data[which_comp] = pa_ptr->next_data[0]; if (pa_ptr->copy_all_done) pa_ptr->all_done[which_comp] = pa_ptr->all_done[0]; return (pa_ptr->last_comp_frac); } /*************************************************************************/ /* Get the time of this sample. */ /*************************************************************************/ ANC_DATA = (struct idf_data *) pa_ptr->idf_data_ptr[which_comp]; byear = ANC_DATA->byear; bday = ANC_DATA->bday; bmilli = ANC_DATA->bmilli; bnano = ANC_DATA->bnano; eyear = ANC_DATA->eyear; eday = ANC_DATA->eday; emilli = ANC_DATA->emilli; enano = ANC_DATA->enano; ir_ancillary_data_end_time (src_time, eyear, eday, emilli, enano, &pa_ptr->next_data[which_comp], &pa_ptr->all_done[which_comp], &pa_ptr->copy_next_data, &pa_ptr->copy_all_done); use_top = ir_frac_start_time (src_time, byear, bday, bmilli, bnano); /***************************************************************************/ /* The start time of this sample is before or equal to the start time of */ /* the delta-t being processed. */ /***************************************************************************/ if (use_top == FRAC_BEFORE_START || use_top == FRAC_EQUAL_START) { /***********************************************************************/ /* The all_done element is set if the end time of the sample is equal */ /* to or beyond the end time of the delta-t being processed. */ /***********************************************************************/ if (pa_ptr->all_done[which_comp]) { frac = 1.0; return (frac); } else { /********************************************************************/ /* Did a data gap occur such that the time of this sample is not */ /* contained in the delta-t period? If so, set the frac to */ /* negative value so the sample will not be included. all_done */ /* will be 0 and next_data will be 1 so more data will be acquired.*/ /* Do not return 0.0 as frac since check on frac is < 0.0, which */ /* fails and then 0.0 / 0.0 is performed, resulting in NaN. */ /* Original conditional was WAY TO COMPLICATED so broke up into */ /* more manageable parts. */ /********************************************************************/ if (eyear == src_time.byear) { if (eday == src_time.bday) { if (emilli < src_time.bmilli || (emilli == src_time.bmilli && enano < src_time.bnano)) { frac = -1.0; return (frac); } } else if (eday < src_time.bday) { frac = -1.0; return (frac); } } else if (eyear < src_time.byear) { frac = -1.0; return (frac); } /********************************************************************/ /* The time duration of the sample is computed by subtracting the */ /* top edge of the delta-t time period from the end time of the */ /* sample. The time duration for the sample is converted into a */ /* single value in terms of seconds. */ /********************************************************************/ diff_year = eyear - src_time.byear; diff_day = eday - src_time.bday; diff_milli = emilli - src_time.bmilli; diff_nano = enano - src_time.bnano; if (diff_nano < 0) { --diff_milli; diff_nano += 1000000; /* 1 milli = 1000000 nanoseconds */ } diff_combo = (diff_year * src_time.bdays_in_yr * 86400) + diff_day * 86400 + (diff_milli / 1000.0) + (diff_nano / 1000000000.0); } } /***************************************************************************/ /* The start time of this sample is after the start time of the delta-t */ /* being processed. */ /***************************************************************************/ else { /***********************************************************************/ /* This scenario means that the current sample starts after the start */ /* time of the delta-t period AND ends after the stop time of the */ /* delta-t period. Check to see if sample is totally outside the */ /* time range of the delta-t period being processed. */ /***********************************************************************/ if (pa_ptr->all_done[which_comp]) { if (pa_ptr->next_data[which_comp] == 0) { time_out = ir_check_time_range (src_time, byear, bday, bmilli, bnano); /******************************************************************/ /* Do not return 0.0 as frac since check on frac is < 0.0, which */ /* fails and then 0.0 / 0.0 is performed, resulting in NaN. */ /* Negative fracs are simply ignored values. */ /******************************************************************/ if (time_out) { frac = -1.0; return (frac); } } /***********************************************************************/ /* If this is true, the time period is WITHIN the delta-t time period.*/ /***********************************************************************/ else { frac = 1.0; return (frac); } } /*********************************************************************/ /* The time duration of the sample is computed by subtracting the */ /* start time of the sample from the bottom edge of the delta-t */ /* time period. The time duration for the sample is converted into */ /* a single value in terms of seconds. */ /*********************************************************************/ if ((byear % 4 == 0 && byear % 100 != 0) || byear % 400 == 0) days_in_yr = 366; else days_in_yr = 365; diff_year = src_time.eyear - byear; diff_day = src_time.eday - bday; diff_milli = src_time.emilli - bmilli; diff_nano = src_time.enano - bnano; if (diff_nano < 0) { --diff_milli; diff_nano += 1000000; /* 1 milli = 1000000 nanoseconds */ } diff_combo = (diff_year * days_in_yr * 86400) + diff_day * 86400 + (diff_milli / 1000.0) + (diff_nano / 1000000000.0); } /*********************************************************************/ /* Compute the percentage of the sample that should be included for */ /* the current delta-t processing. */ /*********************************************************************/ delta_combo = ir_compute_delta_combo (src_time); frac = diff_combo / delta_combo; return (frac); }