Due to the lapse in federal government funding, NASA is not updating this website. We sincerely regret this inconvenience.
NASA Logo
Ocean Color Science Software

ocssw V2022

Public Member Functions

def __init__ (self, params=None, parfile=None, parstr='', sensor=None, verbose=False)
 
def buildParameterFile (self, prog)
 
def parseParFile (self, prog='main')
 
def genOutputFilename (self, prog=None)
 

Public Attributes

 params
 
 parfile
 
 parstr
 
 sensor
 
 verbose
 

Detailed Description

Parameter processing class - build and parse par files

Definition at line 9 of file ParamUtils.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  params = None,
  parfile = None,
  parstr = '',
  sensor = None,
  verbose = False 
)
Set up parameter processing methods

Definition at line 13 of file ParamUtils.py.

Member Function Documentation

◆ buildParameterFile()

def buildParameterFile (   self,
  prog 
)
Build a parameter file  from a dictionary of parameters.
Writes parfile if pfile is defined, else Returns parfile string.

Definition at line 25 of file ParamUtils.py.

◆ genOutputFilename()

def genOutputFilename (   self,
  prog = None 
)
Given a program, derive a standard output filename

Definition at line 116 of file ParamUtils.py.

◆ parseParFile()

def parseParFile (   self,
  prog = 'main' 
)
Parse a parameter file, returning a dictionary listing

Definition at line 65 of file ParamUtils.py.

Member Data Documentation

◆ params

params

Definition at line 18 of file ParamUtils.py.

◆ parfile

parfile

Definition at line 19 of file ParamUtils.py.

◆ parstr

parstr

Definition at line 20 of file ParamUtils.py.

◆ sensor

sensor

Definition at line 21 of file ParamUtils.py.

◆ verbose

verbose

Definition at line 22 of file ParamUtils.py.


The documentation for this class was generated from the following file:
  • /gfs-oceanweb/web/ocssw/ocssw_src/src/scripts/seadasutils/ParamUtils.py