OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022
hico.astreduc Namespace Reference

Classes

class  UT2time
 

Functions

def get_astrodate (delta_seconds)
 
def isLeapYear (yyyy)
 
def increment_seconds_to_date (delta)
 
def initReduc (filename)
 
def getEDFData (filename, year, mon, day)
 
def parseEDFfile (filename, skiphdr=0)
 
def getLSData (filename, year, mon, day)
 
def parseLSfile (filename, skiphdr=0)
 
def polarm (xp, yp)
 
def quat_to_rot (q)
 
def hms2ut (Hr, Minute, Sec)
 
def ut2hms (UTSec)
 
def JDay (Year, Mon, Day, Hr, minute, Sec)
 
def precession (TTT)
 
def nutation (TTT, nut_data)
 
def sidereal (jdut1, DeltaPsi, MeanEps, Omega, LOD, terms)
 
def gstime (jd)
 
def ecef2latlon (xyz)
 
def wgs84_intercept (rsc, u)
 
def solar_geometry (iyr, imn, idy, xh, xm, xs, xlat, xlong)
 
def suncor (iday, month, iyr, tz)
 
def julian (iday, month, iyr)
 
def hazel (h, d, xlat)
 
def solcor (jd, fjd)
 
def frac2DegMinSec (fracd, fracm, fracs)
 

Variables

dictionary MMM = {'JAN':1,'FEB':2,'MAR':3,'APR':4,'MAY':5,'JUN':6,'JUL':7,'AUG':8,'SEP':9,'OCT':10,'NOV':11,'DEC':12}
 
list edf_delimiter = [2,2,2,9,3,9,9,1,9,9,3,10,10,1,7,7]
 
list edf_usecols = [0,1,2,5,8,11,14]
 
list edf_dtype = [np.int32,np.int32,np.int32,np.float64,np.float64,np.float64,np.float64]
 
list edf_names = ['year','month','day','pmx','pmy','ut1mutc','loda']
 
list ls_delimiter = [6,3,3,5,10,10,12]
 
list ls_usecols = [0,1,2,6]
 
list ls_dtype = [np.int32,(np.str_,3),np.int32,np.float64]
 
list ls_names = ['yfo','mco','dfo','taimutco']
 
float rad2Deg = 180.0/np.pi
 
float deg2Rad = np.pi/180.0
 
float as2Deg = 1.0/3600.0
 
float as2Rad = as2Deg*deg2Rad
 

Detailed Description

Created on Nov 24, 2015

@author: rhealy (richard.healy@nasa.gov)

Function Documentation

◆ ecef2latlon()

def hico.astreduc.ecef2latlon (   xyz)

Definition at line 895 of file astreduc.py.

◆ frac2DegMinSec()

def hico.astreduc.frac2DegMinSec (   fracd,
  fracm,
  fracs 
)

Definition at line 1135 of file astreduc.py.

◆ get_astrodate()

def hico.astreduc.get_astrodate (   delta_seconds)

Definition at line 112 of file astreduc.py.

◆ getEDFData()

def hico.astreduc.getEDFData (   filename,
  year,
  mon,
  day 
)

Definition at line 200 of file astreduc.py.

◆ getLSData()

def hico.astreduc.getLSData (   filename,
  year,
  mon,
  day 
)

Definition at line 210 of file astreduc.py.

◆ gstime()

def hico.astreduc.gstime (   jd)

Definition at line 847 of file astreduc.py.

◆ hazel()

def hico.astreduc.hazel (   h,
  d,
  xlat 
)

Definition at line 1090 of file astreduc.py.

◆ hms2ut()

def hico.astreduc.hms2ut (   Hr,
  Minute,
  Sec 
)
* Converted to python by R. Healy 11/30/2015
* broken into two functions from fortran sub HMS_SEC:
        hms2ut
        ut2hms
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
*
*                              SUBROUTINE HMS_SEC
*
*  this subroutine converts Hours, Minutes and Seconds into seconds from the
* beginning of the day.
*
*  Author        : David Vallado                  719 - 573 - 2600    1 Mar 2001
*
*  Inputs          Description                    Range / Units
* Hr - Hours                          0 .. 24
* minute - Minutes                        0 .. 59
* Sec - Seconds                        0.0D0 .. 59.99D0
* Direction - Which set of vars to output    FROM  TOO
*
*  OutPuts       :
*    Sec - Seconds                        0.0D0 .. 86400.0D0
*
*  Locals        :
*    Temp - Temporary variable
*
*  Coupling      :
*    None.
*
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Definition at line 348 of file astreduc.py.

◆ increment_seconds_to_date()

def hico.astreduc.increment_seconds_to_date (   delta)

Definition at line 131 of file astreduc.py.

◆ initReduc()

def hico.astreduc.initReduc (   filename)

Definition at line 188 of file astreduc.py.

◆ isLeapYear()

def hico.astreduc.isLeapYear (   yyyy)

Definition at line 117 of file astreduc.py.

◆ JDay()

def hico.astreduc.JDay (   Year,
  Mon,
  Day,
  Hr,
  minute,
  Sec 
)
* Converted to python by R. Healy
* -----------------------------------------------------------------------------
*
*                           SUBROUTINE JDay
*
*  this subroutine finds the Julian date given the Year, Month, Day, and Time.
*
*  Author        : David Vallado                  719-573-2600    1 Mar 2001
*
*  Inputs          Description                    Range / Units
*    Year        - Year                           1900 .. 2100
*    Mon         - Month                          1 .. 12
*    Day         - Day                            1 .. 28,29,30,31
*    Hr          - Universal Time Hour            0 .. 23
*    minute         - Universal Time minute             0 .. 59
*    Sec         - Universal Time Sec             0.0D0 .. 59.999D0
*    WhichType   - Julian .or. Gregorian calender   'J' .or. 'G'
*
*  Outputs       :
*    JD          - Julian Date                    days from 4713 BC
*
*  Locals        :
*    B           - Var to aid Gregorian dates
*
*  Coupling      :
*    None.
*
*  References    :
*    Vallado       2007, 189, Alg 14, Ex 3-14
* -----------------------------------------------------------------------------

Definition at line 425 of file astreduc.py.

◆ julian()

def hico.astreduc.julian (   iday,
  month,
  iyr 
)

Definition at line 1068 of file astreduc.py.

◆ nutation()

def hico.astreduc.nutation (   TTT,
  nut_data 
)
# * ----------------------------------------------------------------------------
# *
# *                           SUBROUTINE NUTATION
# *
# *  this function calulates the transformation matrix for nutation.
# *
# *  Author        : David Vallado                  719-573-2600    1 Mar 2001
# *
# *  Inputs          Description                    Range / Units
# *    TTT         - Julian Centuries of TT
# *
# *  Outputs       :
# *    Nut         - Nutation transformation (mod-tod)
# *    DeltaPsi    - NUTATION ANGLE                 rad
# *    TrueEps     - True obliquity of the ecliptic rad
# *    Omega       -                                rad
# *    MeanEps     - Mean obliquity of the ecliptic rad
# *
# *  Locals        :
# *    TTT2        - TTT squared
# *    TTT3        - TTT cubed
# *    MeanEps     - Mean obliquity of the ecliptic rad
# *    l           -                                rad
# *    ll          -                                rad
# *    F           -                                rad
# *    D           -                                rad
# *    DeltaEps    - Change in obliquity            rad
# *
# *  Coupling      :
# *    none
# *
# *  References    :
# *    Vallado       2007, 228
# *
# * ----------------------------------------------------------------------------

Definition at line 633 of file astreduc.py.

◆ parseEDFfile()

def hico.astreduc.parseEDFfile (   filename,
  skiphdr = 0 
)

Definition at line 203 of file astreduc.py.

◆ parseLSfile()

def hico.astreduc.parseLSfile (   filename,
  skiphdr = 0 
)

Definition at line 216 of file astreduc.py.

◆ polarm()

def hico.astreduc.polarm (   xp,
  yp 
)

Definition at line 254 of file astreduc.py.

◆ precession()

def hico.astreduc.precession (   TTT)
#     * ----------------------------------------------------------------------------
#     *
#     *                           SUBROUTINE PRECESSION
#     *
#     *  this function calulates the transformation matrix for precession.
#     *
#     *  Author        : David Vallado                  719-573-2600    1 Mar 2001
#     *
#     *  Inputs          Description                    Range / Units
#     *    TTT         - Julian Centuries of TT         centuries
#     *
#     *  Outputs       :
#     *    Prec        - Precession transformation (eci-mod)
#     *
#     *  Locals        :
#     *    TTT2        - TTT squared
#     *    TTT3        - TTT cubed
#     *    Zeta        - PRECESSION ANGLE               rad
#     *    z           - PRECESSION ANGLE               rad
#     *    Theta       - PRECESSION ANGLE               rad
#     *
#     *  Coupling      :
#     *    none
#     *
#     *  References    :
#     *    Vallado       2007, 228
#     *
#     * ----------------------------------------------------------------------------

Definition at line 567 of file astreduc.py.

◆ quat_to_rot()

def hico.astreduc.quat_to_rot (   q)
#*****************************************************************************80
# Converted to Python by R. Healy 11/30/2015
#  from q_to_r.f90
#
# Very slightly modified my Marcos Montes.
# MJM Note: scalar is q(1).
## ROTATION_QUAT2MAT_3D converts rotation from quaternion to matrix form in 3D.
#
#  Licensing:
#
#    This code is distributed under the GNU LGPL license.
#
#  Modified:
#
#    27 July 1999
#
#  Author:
#
#    John Burkardt
#
#  Reference:
#
#    James Foley, Andries van Dam, Steven Feiner, John Hughes,
#    Computer Graphics, Principles and Practice,
#    Second Edition,
#    Addison Wesley, 1990.
#
#  Parameters:
#
#    Input, real ( kind = 8 ) Q(4), the quaternion representing the rotation.
#
#    Output, real ( kind = 8 ) a[3,3), the rotation matrix.
#

Definition at line 278 of file astreduc.py.

◆ sidereal()

def hico.astreduc.sidereal (   jdut1,
  DeltaPsi,
  MeanEps,
  Omega,
  LOD,
  terms 
)

Definition at line 760 of file astreduc.py.

◆ solar_geometry()

def hico.astreduc.solar_geometry (   iyr,
  imn,
  idy,
  xh,
  xm,
  xs,
  xlat,
  xlong 
)

Definition at line 1020 of file astreduc.py.

◆ solcor()

def hico.astreduc.solcor (   jd,
  fjd 
)

Definition at line 1099 of file astreduc.py.

◆ suncor()

def hico.astreduc.suncor (   iday,
  month,
  iyr,
  tz 
)

Definition at line 1059 of file astreduc.py.

◆ ut2hms()

def hico.astreduc.ut2hms (   UTSec)
* Converted to python by R. Healy 11/30/2015
* broken into two functions from fortran sub HMS_SEC:
        hms2ut
        ut2hms
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
*
*                              SUBROUTINE HMS_SEC
*
*  this subroutine converts Hours, Minutes and Seconds into seconds from the
* beginning of the day.
*
*  Author        : David Vallado                  719 - 573 - 2600    1 Mar 2001
*
*  Inputs          Description                    Range / Units
* Hr - Hours                          0 .. 24
* minute - Minutes                        0 .. 59
* Sec - Seconds                        0.0D0 .. 59.99D0
* Direction - Which set of vars to output    FROM  TOO
*
*  OutPuts       :
*    Sec - Seconds                        0.0D0 .. 86400.0D0
*
*  Locals        :
*    Temp - Temporary variable
*
*  Coupling      :
*    None.
*
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Definition at line 384 of file astreduc.py.

◆ wgs84_intercept()

def hico.astreduc.wgs84_intercept (   rsc,
  u 
)

Definition at line 941 of file astreduc.py.

Variable Documentation

◆ as2Deg

float as2Deg = 1.0/3600.0

Definition at line 28 of file astreduc.py.

◆ as2Rad

float as2Rad = as2Deg*deg2Rad

Definition at line 29 of file astreduc.py.

◆ deg2Rad

float deg2Rad = np.pi/180.0

Definition at line 27 of file astreduc.py.

◆ edf_delimiter

list edf_delimiter = [2,2,2,9,3,9,9,1,9,9,3,10,10,1,7,7]

Definition at line 16 of file astreduc.py.

◆ edf_dtype

list edf_dtype = [np.int32,np.int32,np.int32,np.float64,np.float64,np.float64,np.float64]

Definition at line 18 of file astreduc.py.

◆ edf_names

list edf_names = ['year','month','day','pmx','pmy','ut1mutc','loda']

Definition at line 19 of file astreduc.py.

◆ edf_usecols

list edf_usecols = [0,1,2,5,8,11,14]

Definition at line 17 of file astreduc.py.

◆ ls_delimiter

list ls_delimiter = [6,3,3,5,10,10,12]

Definition at line 21 of file astreduc.py.

◆ ls_dtype

list ls_dtype = [np.int32,(np.str_,3),np.int32,np.float64]

Definition at line 23 of file astreduc.py.

◆ ls_names

list ls_names = ['yfo','mco','dfo','taimutco']

Definition at line 24 of file astreduc.py.

◆ ls_usecols

list ls_usecols = [0,1,2,6]

Definition at line 22 of file astreduc.py.

◆ MMM

dictionary MMM = {'JAN':1,'FEB':2,'MAR':3,'APR':4,'MAY':5,'JUN':6,'JUL':7,'AUG':8,'SEP':9,'OCT':10,'NOV':11,'DEC':12}

Definition at line 14 of file astreduc.py.

◆ rad2Deg

float rad2Deg = 180.0/np.pi

Definition at line 26 of file astreduc.py.