/* * 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 "@(#) idfs_pa.c 1.8 05/08/19 SwRI" #include #include "user_defs.h" #include "libbase_idfs.h" #include "ret_codes.h" /**************************************************************************** * * * IR_IDFS_PITCH_ANGLES SUBROUTINE * * * * DESCRIPTION * * This routine is called in order to calculate the pitch angles for * * a given sensor. One value is returned for each element of the sweep in * * the parent data source. The time range for each sweep step is computed * * and data from the IDFS pitch angle source is acquired for each time * * range. To be consistent with read_drec in regards to time advancement, * * the pitch angle data is retrieved when the time advancement flag says * * to advance in time. New data will be read the NEXT time this routine * * is called, except for the very first call, just like read_drec works. * * * * INPUT VARIABLES * * SDDAS_CHAR fwd flag that indicates when to advance to the * * time sample * * SDDAS_CHAR full_swp flag that indicates if 1 value is being * * requested or all values for the record (for * * a scalar parameter only) * * SDDAS_SHORT sensor the sensor for which data is requested * * void *idf_data_ptr ptr to the memory location for the structure * * that holds returned data values (read_drec) * * * * USAGE * * x = ir_idfs_pitch_angles (fwd, full_swp, sensor, idf_data_ptr) * * * * NECESSARY SUBPROGRAMS * * adjust_time () corrects time elements if too many seconds * * (day crossing) or too many days(year crossing)* * strcpy() copies a string to another string variable * * ir_locate_ex() determines if the requested combination has * * already been processed and points to the * * correct structure allocated for the combo * * ir_acquire_pitch_data () acquires the data from the 3 components of * * pitch angle source * * ir_compute_pitch_angle () computes pitch angle for each sweep step * * ir_copy_pitch_angle () handles the case where the time for each * * sweep step is the same (all pitch angle * * values should be the same) * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct idf_data structure that holds all of the currently * * *EXP_DATA returned data values to be processed * * struct experiment_info a pointer to the structure that holds * * *ex, *ex_new 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 * * struct pitch_info a pointer to the structure that holds pitch * * *pa_ptr angle information * * struct time_span structure that holds the time period for the * * src_time current delta-t being processed * * struct direction_cos *dcos_ptr ptr to the direction cosine structure* * reg SDDAS_LONG *bptr_ms, ptrs to the start time / end time memory * * *bptr_ns, *eptr_ms, *eptr_ns locations * * reg SDDAS_LONG *time_end loop termination variable * * reg SDDAS_DOUBLE *dptr pointer to the data for the 3 pitch components* * reg SDDAS_DOUBLE *dptr_end loop termination variable * * reg SDDAS_FLOAT *fptr ptr to normalization factors * * SDDAS_DOUBLE *start_az ptr to start az. angles for 3 pitch components* * SDDAS_DOUBLE *stop_az ptr to stop az. angles for 3 pitch components * * SDDAS_DOUBLE *start_theta ptr to start theta angles for 3 components * * SDDAS_DOUBLE *stop_theta ptr to stop theta angles for 3 components * * SDDAS_FLOAT *pitch_data pointer to the returned pitch angles * * SDDAS_ULONG old_dkey data key for parent source * * SDDAS_USHORT max_ele the number of elements in the sweep * * SDDAS_USHORT old_version version number for parent source * * SDDAS_USHORT swp_step current step of the sweep being processed * * SDDAS_USHORT n_sample the number of samples returned for each sensor* * SDDAS_SHORT ret_val holds value returned by called module * * SDDAS_SHORT max_size max. size for packed scalars or max elements * * in a sweep for a sweeping instrument * * SDDAS_SHORT eyear, eday end time components * * SDDAS_CHAR old_exten[] filename extension for parent source * * SDDAS_CHAR same_day flag indicating if the day of year changed * * within the sweep * * * * SUBSYSTEM * * Display Level * * * ***************************************************************************/ SDDAS_SHORT ir_idfs_pitch_angles (SDDAS_CHAR fwd, SDDAS_CHAR full_swp, SDDAS_SHORT sensor, void *idf_data_ptr) { extern struct general_info ginfo; struct idf_data *EXP_DATA; struct experiment_info *ex, *ex_new; struct ptr_rec *ptr; struct pitch_info *pa_ptr; struct time_span src_time; struct direction_cos *dcos_ptr; register SDDAS_LONG *bptr_ms, *bptr_ns, *eptr_ms, *eptr_ns, *time_end; register SDDAS_DOUBLE *dptr, *dptr_end; register SDDAS_FLOAT *fptr; SDDAS_DOUBLE *start_az, *stop_az, *start_theta, *stop_theta; SDDAS_FLOAT *pitch_data; SDDAS_ULONG old_dkey; SDDAS_USHORT max_ele, old_version, swp_step, n_sample; SDDAS_SHORT ret_val, max_size, eyear, eday; SDDAS_CHAR old_exten[3], same_day; /***********************************************************************/ /* Set a pointer to the structure which holds all pointers for header */ /* and data information for the experiment currently being processed. */ /***********************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; pa_ptr = ex->pitch_angles; old_dkey = ex->data_key; old_version = ex->version; strcpy (old_exten, ex->exten); /****************************************************************************/ /* No need to make sure data structure is correct type or that the header */ /* format is correct since this module is indirectly called by read_drec() */ /* which checks for this issue. */ /****************************************************************************/ EXP_DATA = (struct idf_data *) idf_data_ptr; /***************************************************************************/ /* Since read_drec is called when positioning a file, calculate pitch */ /* angles ONLY if the pitch angle IDFS source has been positioned. */ /***************************************************************************/ ret_val = ir_locate_ex (pa_ptr->data_key, pa_ptr->exten, pa_ptr->version, 0); ex_new = ginfo.expt; if (pa_ptr->file_status != ALL_OKAY || !ex_new->fnext) { EXP_DATA->num_pitch = 0; ret_val = ir_locate_ex (old_dkey, old_exten, old_version, 0); return (ALL_OKAY); } /************************************************************************/ /* For a full swp, max_ele is not just set to N_SAMPLE because the user */ /* could have asked for one at a time and then changed to a full swp to */ /* get the remainder of the elements. */ /************************************************************************/ n_sample = *ptr->hdr_fmt1_ptr->N_SAMPLE; max_ele = (ex->smp_id == 2 && !full_swp) ? 1 : n_sample - ptr->time_row; /************************************************************************/ /* Does the pitch angle data need to be retrieved? This is necessary */ /* due to time advancement on the parent data set (fwd flag sent to */ /* read_drec). */ /************************************************************************/ if (pa_ptr->get_pa_data) { /*************************************************************************/ /* Initialize data values and normalization factors. If instrument is */ /* a scalar, use the max_packing value in case of packed scalars, which */ /* will return 1 pitch for each packed value. */ /*************************************************************************/ pa_ptr->get_pa_data = 0; if (ex->smp_id == 2) max_size = ex->max_packing; else max_size = ex->swp_len; /**********************************************************************/ /* For optimization purposes, it's advised to use ++x instead of x++.*/ /* Also, addition is faster than multiplication (used for dptr_end). */ /**********************************************************************/ start_az = pa_ptr->start_az; stop_az = pa_ptr->stop_az; start_theta = pa_ptr->start_theta; stop_theta = pa_ptr->stop_theta; fptr = pa_ptr->time_frac; dptr = pa_ptr->data_val; dptr_end = pa_ptr->data_val + (max_size + max_size + max_size); for (; dptr < dptr_end; ++dptr, ++fptr, ++start_az, ++stop_az, ++start_theta, ++stop_theta) { *dptr = OUTSIDE_MIN; *start_az = OUTSIDE_MIN; *stop_az = OUTSIDE_MIN; *start_theta = OUTSIDE_MIN; *stop_theta = OUTSIDE_MIN; *fptr = -1.0; } /*************************************************************************/ /* Determine the time of each element in the sweep and retrieve pitch */ /* angle data for that time component. Since the EXP_DATA time values */ /* do not change, took these 3 lines out of the for loop. */ /*************************************************************************/ same_day = (EXP_DATA->eday == EXP_DATA->bday) ? 1 : 0; eyear = (ex->swp_times.use_end_yr_day) ? EXP_DATA->eyear : EXP_DATA->byear; eday = (ex->swp_times.use_end_yr_day) ? EXP_DATA->eday: EXP_DATA->bday; swp_step = 0; eptr_ms = ex->swp_times.etime_ms; eptr_ns = ex->swp_times.etime_ns; bptr_ms = ex->swp_times.btime_ms; bptr_ns = ex->swp_times.btime_ns; time_end = ex->swp_times.btime_ms + max_ele; for (; bptr_ms < time_end; ++bptr_ms, ++bptr_ns, ++eptr_ms, ++eptr_ns, ++swp_step) { src_time.byear = EXP_DATA->byear; src_time.bday = EXP_DATA->bday; src_time.bmilli = *bptr_ms; src_time.bnano = *bptr_ns; adjust_time (&src_time.byear, &src_time.bday, &src_time.bmilli, 2); src_time.eyear = eyear; src_time.eday = eday; src_time.emilli = *eptr_ms; src_time.enano = *eptr_ns; adjust_time (&src_time.eyear, &src_time.eday, &src_time.emilli, 2); /* printf ("\n pa_time bptr_ms = %09d bptr_ns = %06d eptr_ms = %09d eptr_ns = %06d", *bptr_ms, *bptr_ns, *eptr_ms, *eptr_ns); */ /*********************************************************************/ /* Did time go backwards? */ /*********************************************************************/ if (src_time.emilli < src_time.bmilli && src_time.eday == src_time.bday) { /*****************************************************************/ /* Check if time rolls over a day within the sweep. If not, bad */ /* time values. */ /*****************************************************************/ if (same_day) return (PA_BAD_TIMES); ++src_time.eday; adjust_time (&src_time.eyear, &src_time.eday, &src_time.emilli, 2); } /**********************************************************************/ /* Check for leap year whenever values are reset INSTEAD of at every */ /* access. */ /**********************************************************************/ if ((src_time.byear % 4 == 0 && src_time.byear % 100 != 0) || src_time.byear % 400 == 0) { src_time.leap_year = sTrue; src_time.bdays_in_yr = 366; } else { src_time.leap_year = sFalse; src_time.bdays_in_yr = 365; } /********************************************************************/ /* If the times of each step are the same, then simply copy the */ /* value computed for step 0. (due to file pointer manipulation). */ /********************************************************************/ if (ex->swp_times.same_times && swp_step != 0) ir_copy_pitch_angle (pa_ptr, swp_step); else { ret_val = ir_acquire_pitch_data (src_time, pa_ptr, swp_step); if (ret_val != ALL_OKAY) { /* Modify file_status so FUTURE calls to this module will */ /* force immediate return since error in processing. */ /* Only was to "reset" is if a new VIDF file is needed. */ pa_ptr->file_status = ret_val; EXP_DATA->num_pitch = 0; ret_val = ir_locate_ex (old_dkey, old_exten, old_version, 0); return (ALL_OKAY); } } } } /***************************************************************************/ /* Compute the pitch angle for each element of the sweep. */ /***************************************************************************/ pitch_data = EXP_DATA->pitch_angles; dcos_ptr = EXP_DATA->dir_cosines; ir_compute_pitch_angle (pa_ptr, pitch_data, sensor, max_ele, dcos_ptr); EXP_DATA->num_pitch = max_ele; ret_val = ir_locate_ex (old_dkey, old_exten, old_version, 0); /***************************************************************************/ /* If read_drec was called with the time advancement flag set, reset the */ /* pitch angle data retrieval flag for NEXT call. In this way, it is */ /* consistent with the read_drec time advancement philosophy. */ /***************************************************************************/ if (fwd) pa_ptr->get_pa_data = 1; return (ALL_OKAY); }