/*
* 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 "@(#) $Id: trap_int.C 18484 2007-07-12 18:55:07Z carrie $ SwRI"
#include
#include "user_defs.h"
#include "libIDFSMath.h"
/*******************************************************************************
* *
* IDFSMATH_TRAPEZOIDAL_INT SUBROUTINE *
* *
* DESCRIPTION *
* This routine is called to calculate a trapezoidal integration method on *
* data which exists in a band, which means that X[n] is the starting location*
* of the band, X[n+1] is the ending location of the band, and Y[n] is the *
* ampltude of the band. Assume that the Y[n] values are measured at the *
* centers of the bands. There are terms number of bands, so there are terms *
* values of Y and terms+1 values of X. When converted to trapezoids, there *
* are terms-1 trapezoids. Points are measured as X, Y pairs. *
* *
* INPUT VARIABLES *
* SDDAS_FLOAT *X pointer to the band values (x component) *
* SDDAS_FLOAT *Y pointer to the data values (y component) *
* SDDAS_DOUBLE *X_rad pointer to band values expressed in radians *
* SDDAS_DOUBLE *X_centers pointer to center band values expressed in *
* radians *
* SDDAS_DOUBLE *Sin_Xc pointer to the result of the sin function *
* for the center band values *
* SDDAS_DOUBLE *Cos_Xc pointer to the result of the cos function *
* for the center band values *
* SDDAS_LONG skip number of elements to add to get to next *
* data element *
* SDDAS_LONG terms number of bands or terms to integrate *
* SDDAS_FLOAT start starting value to integrate over in X *
* SDDAS_FLOAT stop ending value to integrate over in X *
* SDDAS_CHAR which_dimen flag indicating which dimension is being *
* integrated over since multiple dimensions *
* make use of this code *
* SDDAS_CHAR norm flag indicating if the result is to be *
* normalized *
* SDDAS_INT power_sx the power of the extra "x" term or the power *
* of the sin term *
* SDDAS_INT power_c the power of the cos term *
* *
* USAGE *
* x = IDFSMath_trapezoidal_int (&X, &Y, &X_rad, &X_centers, &Sin_Xc, *
* &Cos_Xc, skip, terms, start, stop, *
* which_dimen, norm, power_sx, power_c) *
* *
* NECESSARY SUBPROGRAMS *
* IDFSMath_trapezoidal_int_angle () performs trapezoidal integration for *
* angular dimensions (PHI and/or THETA) *
* IDFSMath_trapezoidal_int_scan () performs trapezoidal integration for *
* SCAN dimension *
* *
* EXTERNAL VARIABLES *
* None *
* *
* INTERNAL VARIABLES *
* reg SDDAS_FLOAT *back_x pointers to reverse the X-Y pairs to be in *
* *back_y, *inc_X, *inc_Y increasing order *
* reg SDDAS_FLOAT *stop_X loop termination variable *
* SDDAS_DOUBLE sum integration amp. *
* SDDAS_FLOAT *increasing_X, pointers to X-Y pairs in increasing order *
* *increasing_Y *
* SDDAS_LONG terms_minus_one number of terms to integrate reduced by one *
* SDDAS_LONG terms_plus_one number of terms to integrate increaded by one*
* SDDAS_LONG inc_skip number of elements to skip over to get to *
* next data element in increasing order Y array*
* *
* SUBSYSTEM *
* Display Level *
* *
******************************************************************************/
SDDAS_FLOAT IDFSMath_trapezoidal_int (SDDAS_FLOAT *X, SDDAS_FLOAT *Y,
SDDAS_DOUBLE *X_rad, SDDAS_DOUBLE *X_centers, SDDAS_DOUBLE *Sin_Xc,
SDDAS_DOUBLE *Cos_Xc, SDDAS_LONG skip, SDDAS_LONG terms, SDDAS_FLOAT start,
SDDAS_FLOAT stop, SDDAS_CHAR which_dimen, SDDAS_CHAR norm, SDDAS_INT power_sx,
SDDAS_INT power_c)
{
std::vector reorder_X, reorder_Y;
register SDDAS_FLOAT *back_x, *back_y, *inc_X, *inc_Y, *stop_X;
SDDAS_DOUBLE sum;
SDDAS_FLOAT *increasing_X, *increasing_Y;
SDDAS_LONG terms_minus_one, terms_plus_one, inc_skip;
/**************************************************************************/
/* Indexing by terms is okay since the array of band values are used and */
/* there is always one more element at the end. */
/**************************************************************************/
terms_minus_one = terms - 1;
terms_plus_one = terms + 1;
if (X[terms] > X[0]) /* X values increasing */
{
increasing_X = X;
increasing_Y = Y;
inc_skip = skip;
}
else
{
/**************************************************************************/
/* Allocate space to hold the X-Y pairs once they have been rearranged */
/* in increasing order. X values are banded (terms+1), but Y values are */
/* not (terms) */
/**************************************************************************/
reorder_X.resize (terms_plus_one);
reorder_Y.resize (terms);
increasing_X = &reorder_X[0];
increasing_Y = &reorder_Y[0];
inc_skip = 1;
/**********************************************************************/
/* Rearrange the data to be in increasing order. */
/**********************************************************************/
inc_X = increasing_X;
inc_Y = increasing_Y;
stop_X = inc_X + terms;
back_x = &X[terms];
back_y = Y + terms_minus_one * skip; /* ptr to Y value of last band */
for (; inc_X < stop_X; ++inc_X, ++inc_Y, --back_x, back_y -= skip)
{
*inc_X = *back_x;
*inc_Y = *back_y;
}
/* After last iteration of loop above, pointers are set for last X value.*/
*inc_X = *back_x;
}
if (which_dimen == PHI_DIMEN || which_dimen == THETA_DIMEN)
sum = IDFSMath_trapezoidal_int_angle (increasing_X, increasing_Y, X_rad,
X_centers, Sin_Xc, Cos_Xc, inc_skip, terms,
start, stop, which_dimen, norm,
power_sx, power_c);
else
sum = IDFSMath_trapezoidal_int_scan (increasing_X, increasing_Y, inc_skip,
terms, start, stop, norm, power_sx);
return ((SDDAS_DOUBLE) sum);
}