/* * 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 "@(#) acq_pitch.c 1.8 05/08/19 SwRI" #include "libbase_idfs.h" #include "ret_codes.h" /******************************************************************************* * * * IR_ACQUIRE_PITCH_DATA SUBROUTINE * * * * DESCRIPTION * * This routine is called to acquire data for the three components of the * * magnetic field used to compute pitch angles. The data will either need to * * be read or the previous sample will hold for the current delta-t * * processing. If a header change is encountered, there is an need to check * * the sizes of arrays in the idf_data structure since the calls to read_drec * * with the same data set, but different idf_data pointers, will result in * * the first call getting the idf_data structure updated, but the rest will * * not. Data is acquired for one element of the sweep. * * * * INPUT VARIABLES * * struct time_span structure that holds the time period for * * src_time the current delta-t being processed * * struct pitch_info *pa_ptr a pointer to the structure that holds pitch * * angle information * * SDDAS_USHORT swp_step current step of the sweep being processed * * * * USAGE * * x = ir_acquire_pitch_data (src_time, pa_ptr, swp_step) * * * * NECESSARY SUBPROGRAMS * * read_drec() the universal read routine that retrieves * * the data for the time sample being processed* * ir_same_pitch_time () sets all time values to the time of the * * first sensor processed for the data set * * ir_check_idf_data_memory () makes sure that all allocated arrays in the * * idf_data structure are of sufficient size * * ir_process_pitch_data () processes the data for the three components * * of the magnetic field * * ir_ancillary_data_los_next_file () handles the case when an LOS_STATUS * * or NEXT_FILE_STATUS is encountered * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * struct idf_data *PA_DATA structure holding the data for the pitch * * angle component being processed * * register SDDAS_DOUBLE *dptr pointer to data for the three components * * reg. SDDAS_DOUBLE *dptr_end loop termination variable * * reg. SDDAS_DOUBLE *sa_ptr ptr to start az. angles for the 3 components* * reg. SDDAS_DOUBLE *ea_ptr ptr to stop az. angles for the 3 components * * reg. SDDAS_DOUBLE *st_ptr ptr to start theta angles for 3 components * * reg. SDDAS_DOUBLE *et_ptr ptr to stop theta angles for 3 components * * register SDDAS_FLOAT *fptr pointer to the normalization factors * * SDDAS_LONG offset offset into data locations * * SDDAS_SHORT ret_val the value returned by the called routine * * SDDAS_SHORT read_code status code returned from READ_DREC() * * SDDAS_SHORT i looping variable * * SDDAS_SHORT all_done the number of components that have data * * ready for pitch angle calculation * * SDDAS_CHAR full_swp flag that indicates if 1 value is being * * requested or all values for the record * * SDDAS_CHAR set_time flag indicating if time is to be set or * * retrieved * * SDDAS_CHAR data_adv time advancement flag * * char more_data terminate processing of data flag * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_acquire_pitch_data (struct time_span src_time, struct pitch_info *pa_ptr, SDDAS_USHORT swp_step) { struct idf_data *PA_DATA; register SDDAS_DOUBLE *dptr, *dptr_end, *sa_ptr, *ea_ptr, *st_ptr, *et_ptr; register SDDAS_FLOAT *fptr; SDDAS_LONG offset; SDDAS_SHORT ret_val, read_code, i, all_done; SDDAS_CHAR full_swp = 0, set_time, data_adv; char more_data = 1; /***********************************************************************/ /* Retrieve data for all three components so that the current sample */ /* of the sweep can be processed. */ /***********************************************************************/ while (more_data) { all_done = 0; for (i = 0, set_time = 1; i < 3; ++i) { /*********************************************************************/ /* Has the entire time delta been processed for this component? */ /*********************************************************************/ if (!pa_ptr->all_done[i]) { /******************************************************************/ /* Does the next data sample need to be read from the data file? */ /******************************************************************/ if (pa_ptr->next_data[i]) { data_adv = (i == 2) ? 1 : 0; read_code = read_drec (pa_ptr->data_key, pa_ptr->exten, pa_ptr->version, pa_ptr->idf_data_ptr[i], pa_ptr->sensor[i], data_adv, full_swp); /***************************************************************/ /* If an error was encountered, return to the calling routine.*/ /***************************************************************/ if (read_code < 0) return (read_code); /***************************************************************/ /* Since the data set could have different TIME_OFF values for*/ /* the sensors within a data set, make sure data from the same*/ /* data set returns one consistent time value. */ /***************************************************************/ ir_same_pitch_time (pa_ptr, set_time, i); /*************************************************************/ /* Need to check the sizes of arrays in the idf_data */ /* structure since header changed. */ /*************************************************************/ PA_DATA = (struct idf_data *) pa_ptr->idf_data_ptr[i]; if (PA_DATA->hdr_change) { ret_val = ir_check_idf_data_memory (pa_ptr->data_key, pa_ptr->exten, pa_ptr->version, pa_ptr->idf_data_ptr[0]); if (ret_val != ALL_OKAY) return (ret_val); ret_val = ir_check_idf_data_memory (pa_ptr->data_key, pa_ptr->exten, pa_ptr->version, pa_ptr->idf_data_ptr[1]); if (ret_val != ALL_OKAY) return (ret_val); ret_val = ir_check_idf_data_memory (pa_ptr->data_key, pa_ptr->exten, pa_ptr->version, pa_ptr->idf_data_ptr[2]); if (ret_val != ALL_OKAY) return (ret_val); } /***************************************************************/ /* Process the data just read for the current component. */ /***************************************************************/ ret_val = ir_process_pitch_data (pa_ptr, src_time, i, swp_step); if (ret_val != ALL_OKAY) return (ret_val); /***************************************************************/ /* Handle file crossing condition. */ /***************************************************************/ if (read_code == LOS_STATUS || read_code == NEXT_FILE_STATUS) { ret_val = ir_ancillary_data_los_next_file (pa_ptr->data_key, pa_ptr->exten, pa_ptr->version, pa_ptr->idf_data_ptr[i], src_time, pa_ptr->stop_year, pa_ptr->stop_day, pa_ptr->stop_sec, pa_ptr->stop_nano, PITCH_FLAG, &pa_ptr->file_status); if (ret_val != ALL_OKAY) return (ret_val); } } /******************************************************************/ /* The existing data is utilized for current delta-t processing. */ /******************************************************************/ else { ret_val = ir_process_pitch_data (pa_ptr, src_time, i, swp_step); if (ret_val != ALL_OKAY) return (ret_val); } } all_done += pa_ptr->all_done[i]; set_time = 0; } /******************************************************************/ /* Once the data for all three components has been acquired, the */ /* pitch angles can be computed. */ /******************************************************************/ if (all_done == 3) more_data = 0; } /**********************************************************************/ /* Normalize the data and angles for the 3 magnetic field components.*/ /**********************************************************************/ offset = 3 * swp_step; sa_ptr = pa_ptr->start_az + offset; ea_ptr = pa_ptr->stop_az + offset; st_ptr = pa_ptr->start_theta + offset; et_ptr = pa_ptr->stop_theta + offset; fptr = pa_ptr->time_frac + offset; dptr = pa_ptr->data_val + offset; dptr_end = dptr + 3; for (; dptr < dptr_end; ++dptr, ++fptr, ++sa_ptr, ++ea_ptr, ++st_ptr, ++et_ptr) { if (*fptr < 0.0) continue; *dptr /= *fptr; *sa_ptr /= *fptr; *ea_ptr /= *fptr; *st_ptr /= *fptr; *et_ptr /= *fptr; } /************************************************************************/ /* Reset the flag for each component to process the next delta-t. */ /************************************************************************/ pa_ptr->all_done[0] = 0; pa_ptr->all_done[1] = 0; pa_ptr->all_done[2] = 0; return (ALL_OKAY); }