Procedures

Data Reader:

• read_HDF.proReads data file in HDF format into structure variable. Syntax:read_HDF, filename, data, attributes, [,sdsNames] [,status].

GlobColour Tools:

• read_GCnetCDF.pro Read GlobColour Global netCDF file into structure variable (Modified version of SEE software read_netCDF.pro). Requires get_gcCntOffset() function. Syntax:read_GCnetCDF, filename, data, attributes, status [[,/SUBSET] [,COUNT=value] [,OFFSET=value]].
• view_GCDDS.pro Renders GlobColour Diagnostic Data Set (DDS) layers from one or many GlobColour DDS files. Syntax: view_GCDDS [,DDSFilename] [,/MN | ,/SD | ,/CNT, | ,/WT | ,/ER] [,/ALL | [[,/CHL1] [,/CHL2] [,/KD490] [,/TSM] [,/CDM] [,/BBP] [,/T865] [,/L412] [,/L443] [,/L490] [,/L510] [,/L531] [,/L555] [,/L620] [,/L670] [,/L681] [,/L709]]].

Oceancolor Tools:

• read_l3m_oceancolor.pro To rip Geophysical data from Oceancolor HDF SDs for a specified ROI and do some statistics. Reads Level 3 AQUA (4km and 9km) and SeaWiFS (9km) Mapped Products (HDF SDs). Syntax: read_l3m_oceancolor [,/WRITEBIN] [,/BINSTACK] [,/WRITEASC] [,/WRITEPNG] [,/TIMESERIES] [,/TIME_LAT] [,/LON_TIME] [,/BASIN_STAT] [,/AD] [,/DESC].
  

Functions

• ALOGBASE.pro Returns logarithm of a value (or an array) to a given base. Syntax: Result = ALOGBASE( Base, Array ).

• AVERAGE.proReturns the average value of an array in a sepcified dimention. Syntax: Result = AVERAGE( Array [,dim] [,/DOUBLE] [,/NaN] ).

• DEG2KM.pro Returns the equivalent of 1 km in degrees at a given location on the Earth. Syntax: Result = KM2DEG( Kilometers, Longitude, Latitude ).

• DETREND.pro Removes the "linear trend" from a time-series data and standardise the detrend data. Syntax: Result = DETREND( Y [,X] [,RANGE=[min, max]] [,REMOVE_MEAN=variable] [,/STANDARDISE] [,/DIAG] ).

• DIFF.pro Returns the absolute difference between two numbers OR arrays of equal size. Syntax: Result = DIFF( Array1, Array2 ).

• FILTERED_AVERAGE.pro Returns the average value of an array with specific Sigma and coefficient of variation threshold limits. Syntax: Result = FILTERED_AVERAGE( Array [,SD=value] [,CV=value] [,/NAN] [,/VERB] ).

• FLTSCL.pro Scales all values in an Array that lie in the range (Min <= x <= Max) into the range (low <= x <= High). Syntax: Result = FLTSCL( Array [,HIGH=value] [,LOW=value] ).

• GET_GCCNTOFFSET.pro Returns the offset and count for a GlobColour netCDF (Isin Grid) hyperslab. Syntax: Result = getgcCntOffset( Filename, Latitude [,LAT_STEP=value] [,NR=value] ).

• GCDDSFLAG2NAME.pro Converts ESA GlobColour (http://www.globcolour.info) Diagnostics Dataset (DDS) 16-bit Flags to Names; Storer Depth/Cloud/Turbid/Valid info if necessary. Syntax: Result = GDDDSFLAG2NAME( Flag [,DEPTH=variable] [,CLOUD=variable] [,TURBID=variable] [,VALID=variable] [,/ALLOW_REPLICA] [,/ALLOW_LAND] ).

• IS_BIG_END.pro Returns the current machine type; TRUE if big endian and vice-versa. Syntax: Result = IS_BIG_END( [variable] ).

• IS_LITTLE_END.pro Returns the current machine type; TRUE if little endian and vice-versa. Syntax: Result = IS_LITTLE_END( [variable] ).

• KM2DEG.pro Returns the equivalent of 1 km in degrees at a given location on the Earth. Syntax: Result = DEG2KM( Degreess, Longitude, Latitude ).

• MOREL_CHL_KD_CASE1.pro Returns Diffuse attenuation coefficient @ 490nm (Kd490) from Chlorophyll-a concentration and vice-versa in Case-1 waters (Morel et al, ????). Syntax: Result = MOREL_CHL_KD_CASE1( [CHL=value] | [KD490=value] ).

• NearestPoint.pro Returns the nearest point of a given loacation (Lon,Lat) from a set of points and retruns the position [col, row] of Nearest pixel. Calculation is based on Cartesian coordinate system minimum distance formula. Syntax: Result = NearestPoint( LonArray, LatArray, LonPoint, LatPoint [,MAXDIST=value] [,SR=value] [,nP=value] [,/SPH] [,/VERB] ).

• NORMALISE.pro Normalise a skewed data series using four different power transformation methods, default method is BoxCox. Syntax: Result = NORMALISE( Array | /TEST [,/BOXCOX | ,/MANLY | ,/JOHNDRAPER | ,/YEOJOHNSON] [,/DIAG] [,GET_LAMBDA=variable] ).

• OCFLAG2NAME.pro Converts NASA Oceancolor (http://oceancolor.gsfc.nasa.gov) 32-bit Flag values to Falg Names. Syntax: Result = OCFLAG2NAME( Value [,GET_FLAG_TABLE=variable]).

• ORIFIT.pro Returns linear regression results through origin. Syntax: Result = ORIFIT( X, Y [,YFIT=variable] [/VERB] ).

• PPOINTS.pro Returns an array of N probability points between 0 and 1 (exclusive). Syntax: Result = PPOINTS( N ).

• READ_MORELfQ_LUT.proReturns the Morel et al f/Q Look-up table (LUT) as a 5D double array. You will need 'morel_fq.dat' file. Syntax: Result = READ_MORELfQ_LUT( ['filepath/morel_fq.dat'] ).

• RMAFIT.pro Parameter estimation using reduced-major axis regression (Model II) method. Syntax: Result = RMAFIT( X, Y [,SERROR=variable] [,CONF95=variable] [,R2=variable [,RANK_R=variable] ).

• sdy.pro Returns the Serial Day of Year [1...366] for given date, month, year. Syntax: Result = SDY( [dd, mm, yyyy]  [,/VERB] ).

• SIGTEST.proSignificance Test of correlation for a sample size = N. Syntax: Result = SIGTEST( r, N ).

• SunZenith.pro Returns the Solar Zenith angle (in radians) for a given location, date and time (in ISO8601 standard). Syntax: Result = SunZenith( LATITUDE=value, LONGITUDE=value, TIME=string).

• YMDhms2isoTIME.proReturns ISO19115 compliant Date Time in YYYYMMDDThhmmssZ (see ISO 8601 date time) format. Syntax: Result = YMDHMS2ISOTIME( [[Year] [,Month] [,Day]][,Hour] [,Minute] [,Second] [,/DOY] [,/VERB] ).

Datafiles

Some ocean colour related data and look-up-table (LUT) files that are used in some of the library routines/functions can be found in Geomatics Data area.