Home > ctdcal > oxy_struct.m

oxy_struct

PURPOSE ^

oxy_struct: Return an empty oxygen calibration struct with minimum required fields

SYNOPSIS ^

function varargout = oxy_struct

DESCRIPTION ^

 oxy_struct: Return an empty oxygen calibration struct with minimum required fields

 AOML/PhOD CTDCalibration toolbox.

 USAGE:  cal = cal_struct
 
 INPUT: NA
 
 OUTPUT: sample: a structure containing the required fields for ctd calibration
 using the CTDCalib toolbox.
 
 DESCRIPTION: The data sturcture used here follows the WOCE 
 Hydrographic Program naming conventions.
 
 AUTHORS: Derrick Snowden
          NOAA/AOML/PhOD
          Carlos Fonseca
          UM/CIMAS
         Wed May 12 16:31:39 EDT 2004
 
 SEE ALSO:

 DEPENDENCIES: None

 EXAMPLES:
 >> oxy_cal = oxy_struct % returns the empty structure
 >> oxy_struct % displays the necessary fields at the terminal.

 REFERENCES: WOCE Data Reporting Requirements (Rev. 2, Feb 1998)
 http://whpo.ucsd.edu/  http://woce.nodc.noaa.gov/

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function varargout  = oxy_struct
0002 % oxy_struct: Return an empty oxygen calibration struct with minimum required fields
0003 %
0004 % AOML/PhOD CTDCalibration toolbox.
0005 %
0006 % USAGE:  cal = cal_struct
0007 %
0008 % INPUT: NA
0009 %
0010 % OUTPUT: sample: a structure containing the required fields for ctd calibration
0011 % using the CTDCalib toolbox.
0012 %
0013 % DESCRIPTION: The data sturcture used here follows the WOCE
0014 % Hydrographic Program naming conventions.
0015 %
0016 % AUTHORS: Derrick Snowden
0017 %          NOAA/AOML/PhOD
0018 %          Carlos Fonseca
0019 %          UM/CIMAS
0020 %         Wed May 12 16:31:39 EDT 2004
0021 %
0022 % SEE ALSO:
0023 %
0024 % DEPENDENCIES: None
0025 %
0026 % EXAMPLES:
0027 % >> oxy_cal = oxy_struct % returns the empty structure
0028 % >> oxy_struct % displays the necessary fields at the terminal.
0029 %
0030 % REFERENCES: WOCE Data Reporting Requirements (Rev. 2, Feb 1998)
0031 % http://whpo.ucsd.edu/  http://woce.nodc.noaa.gov/
0032 
0033 
0034 units = struct('cruiseid','None',...
0035 'stnnbr','None', ...
0036 'castnbr','None',...
0037 'sampnbr','None',...
0038 'btlnbr','None',...
0039 'niskinbtlpos','None' ,...% AOML addition
0040 'fireorder','None',...
0041 'btloxy','ml/l',...
0042 'ctdraw','dbar',...
0043 'ctdprs','dbar',...
0044 'ctdtemp1','degC',...% AOML/Carlos addition
0045 'ctdtemp2','degC',...% AOML/Carlos addition
0046 'ctdoxy1','ml/l',... % AOML/Carlos addition
0047 'ctdoxy2','ml/l',... % AOML/Carlos addition
0048 'ctdcon1','User defined',... % AOML/Carlos addition
0049 'ctdcon2','User defined' );% AOML/Carlos addition
0050 
0051 description = struct('cruiseid','Character array identifying cruise e.g. file naming etc.',...
0052 'stnnbr','Station number', ...
0053 'castnbr','Cast number if there are multiple casts per station',...
0054 'sampnbr','Cell array with the alphanumeric label on the sample bottle',...
0055 'btlnbr','Permanent unique serial number on the sample bottle',...
0056 'niskinbtlpos','The position of the Niskin bottle on the rosette.',...% AOML addition
0057 'fireorder','The order in which the bottle was fired.', ... ;% AOML addition
0058 'btloxy','Bottle sample oxygen',...
0059 'ctdraw','Optional: nominal ctd pressure recorded at bottle closure. Uncalibrated pressure.',...
0060 'ctdprs','Pressure ',...
0061 'ctdtmp1','Temperature in ITS-90 (Primary Sensor)',...% AOML/Carlos addition
0062 'ctdtmp2','Temperature in ITS-90 (Secondary Sensor)',...% AOML/Carlos addition
0063 'ctdoxy1','CTD Oxygen (Primary Sensor)',...% AOML/Carlos addition
0064 'ctdoxy2','CTD Oxygen (Secondary Sensor)',...% AOML/Carlos addition
0065 'ctdcon1','CTD Conductivity (Primary Sensor)',...% AOML/Carlos addition
0066 'ctdcon2','CTD Conductivity (Secondary Sensor)' ); % AOML/Carlos addition
0067 
0068 out = struct('cruiseid', [NaN], ...
0069 'stnnbr', [NaN], ...
0070 'castnbr', [NaN],...
0071 'sampnbr',{NaN},...
0072 'btlnbr', [NaN],...
0073 'niskinbtlpos', [NaN],...% AOML addition
0074 'fireorder', [NaN],...
0075 'btloxy', [NaN],...
0076 'ctdraw', [NaN],...
0077 'ctdprs', [NaN],...
0078 'ctdtmp1', [NaN],... % AOML/Carlos addition
0079 'ctdtmp2', [NaN],... % AOML/Carlos addition
0080 'ctdoxy1', [NaN],...% AOML/Carlos addition
0081 'ctdoxy2', [NaN],...% AOML/Carlos addition
0082 'ctdcon1', [NaN],...% AOML/Carlos addition
0083 'ctdcon2', [NaN],...% AOML/Carlos addition
0084 'units',units,...
0085 'description',description) ;% AOML addition
0086 
0087 
0088 if nargout ~= 1
0089     assignin('caller','ans',out)
0090     disp(out.description)
0091     return
0092 else
0093     varargout{1} = out;
0094     return
0095 end
0096

Generated on Fri 08-Oct-2004 11:57:17 by m2html © 2003