sample_struct

 sample_struct: Return an empty  data  structure with the minimum required fields

 AOML/PhOD CTDCalibration toolbox.

 USAGE:  sample_data = sample_struct
 
 INPUT: None
 
 OUTPUT: cond: a structure containing the required fields for conductivity 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:
 >> btl = sample_struct % returns the empty structure
 >> sample_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/

0001 function varargout  = sample_struct
0002 % sample_struct: Return an empty  data  structure with the minimum required fields
0003 %
0004 % AOML/PhOD CTDCalibration toolbox.
0005 %
0006 % USAGE:  sample_data = sample_struct
0007 %
0008 % INPUT: None
0009 %
0010 % OUTPUT: cond: a structure containing the required fields for conductivity 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 % >> btl = sample_struct % returns the empty structure
0028 % >> sample_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 'btlsal','psu',...
0042 'btloxy','ml/l',...
0043 'btlcon1','User defined',...% AOML/Carlos addition
0044 'btlcon2','User defined',...% AOML/Carlos addition
0045 'ctdraw','dbar',...
0046 'ctdprs','dbar',...
0047 'ctdtemp1','degC',...% AOML/Carlos addition
0048 'ctdtemp2','degC',...% AOML/Carlos addition
0049 'ctdsal1','psu',...% AOML/Carlos addition
0050 'ctdsal2','psu',...% AOML/Carlos addition
0051 'ctdcon1','User defined',... % AOML/Carlos addition
0052 'ctdcon2','User defined',...% AOML/Carlos addition
0053 'dcdp1','User defined',...% AOML/Carlos addition
0054 'dcdp2','User defined' );% AOML/Carlos addition
0055 description = struct('cruiseid','Character array identifying cruise e.g. file naming etc.',...
0056 'stnnbr','Station number', ...
0057 'castnbr','Cast number if there are multiple casts per station',...
0058 'sampnbr','Cell array with the alphanumeric label on the sample bottle',...
0059 'btlnbr','Permanent unique serial number on the sample bottle',...
0060 'niskinbtlpos','The position of the Niskin bottle on the rosette.',...% AOML addition
0061 'fireorder','The order in which the bottle was fired.', ... ;% AOML addition
0062 'btlsal','Bottle sample salinity PSS-78',...
0063 'btlcon1','Bottle conductivity based on salinity/primary ctd temperature',...% AOML/Carlos addition
0064 'btlcon2','Bottle conductivity based on salinity/secondary ctd temperature',...% AOML/Carlos addition
0065 'ctdraw','Optional: nominal ctd pressure recorded at bottle closure. Uncalibrated pressure.',...
0066 'ctdprs','Pressure ',...
0067 'ctdtmp1','Temperature in ITS-90 (Primary Sensor)',...% AOML/Carlos addition
0068 'ctdtmp2','Temperature in ITS-90 (Secondary Sensor)',...% AOML/Carlos addition
0069 'ctdsal1','Salinity PSS-78 (Primary Sensor)',... % AOML/Carlos addition
0070 'ctdsal2','Salinity PSS-78 (Secondary Sensor)',... % AOML/Carlos addition
0071 'ctdcon1','CTD Conductivity (Primary Sensor)',...% AOML/Carlos addition
0072 'ctdcon2','CTD Conductivity (Secondary Sensor)',... % AOML/Carlos addition
0073 'dcdp1','CTD Pressure rate of change in conductivity  (Primary Sensor)',...% AOML/Carlos addition
0074 'dcdp2','CTD Pressure rate of change in conductivity  (Secondary Sensor)' ); % AOML/Carlos addition
0075 out = struct('cruiseid', [NaN], ...
0076 'stnnbr', [NaN], ...
0077 'castnbr', [NaN],...
0078 'sampnbr',{NaN},...
0079 'btlnbr', [NaN],...
0080 'niskinbtlpos', [NaN],...% AOML addition
0081 'fireorder', [NaN],...
0082 'btlsal', [NaN],...
0083 'btlcon1', [NaN],...% AOML/Carlos addition
0084 'btlcon2', [NaN],...% AOML/Carlos addition
0085 'ctdraw', [NaN],...
0086 'ctdprs', [NaN],...
0087 'ctdtmp1', [NaN],... % AOML/Carlos addition
0088 'ctdtmp2', [NaN],... % AOML/Carlos addition
0089 'ctdsal1', [NaN],...  % AOML/Carlos addition
0090 'ctdsal2', [NaN],...  % AOML/Carlos addition
0091 'ctdcon1', [NaN],...% AOML/Carlos addition
0092 'ctdcon2', [NaN],...% AOML/Carlos addition
0093 'dcdp1', [NaN],...% AOML/Carlos addition
0094 'dcdp2', [NaN],...% AOML/Carlos addition
0095 'units',units,...
0096 'description',description) ;% AOML addition
0097 
0098 
0099 if nargout ~= 1
0100     assignin('caller','ans',out)
0101     disp(out.description)
0102     return
0103 else
0104     varargout{1} = out;
0105     return
0106 end
0107