source: TI03-DataExtractor/branches/old_stuff/dx/doc/products_module.txt @ 793

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/dx/doc/products_module.txt@793
Revision 793, 3.3 KB checked in by astephen, 13 years ago (diff)

Put all the old code in the old_stuff branch.

  • Property svn:executable set to *
Line 
1Help on module products:
2
3NAME
4    products
5
6FILE
7    /usr/local/dx-0.1.1/products.py
8
9DESCRIPTION
10    products.py
11    ===========
12   
13    Procucts module for the extractor package.
14   
15    This module holds the Product, Plot, DataFile and other classes
16    used to generate products from the data extractor.
17
18CLASSES
19    extractMetadata.MetadataExtractor
20        Product
21            DataFile
22   
23    class DataFile(Product)
24     |  DataFile class - sub-class of Product. Holds the process method to actually write the
25     |  output to a file.
26     | 
27     |  Method resolution order:
28     |      DataFile
29     |      Product
30     |      extractMetadata.MetadataExtractor
31     | 
32     |  Methods defined here:
33     | 
34     |  process(self)
35     |      process method - creates an output NetCDF file and writes to it. Also checks if
36     |      it can pick up any CF-Compliant Global Attributes to put them in the file.
37     | 
38     |  ----------------------------------------------------------------------
39     |  Methods inherited from Product:
40     | 
41     |  __init__(self, filenames, request)
42     | 
43     |  getParam(self)
44     |      getParam method - uses the requests information and data/metadata files
45     |      to extract the data objects requested by the user. These are then stored in
46     |      the list self.variables.
47     | 
48     |  ----------------------------------------------------------------------
49     |  Methods inherited from extractMetadata.MetadataExtractor:
50     | 
51     |  getFileList(self)
52     |      Method that returns the list of files associated with a particular
53     |      request. If more than one variable has been selected then the list
54     |      contains a concatenation of allVar1Files+allVar2Files.....+allVarNFiles.
55     | 
56     |  getRequestSizeInBytes(self)
57     |      Method to get the size of the request in bytes.
58     | 
59     |  getTimeStepCount(self)
60     |      Method to return the number of time steps requested.
61     | 
62     |  getTimeSteps(self, dset_num=1)
63     |      Method to return a list of tuples for all timesteps requested.
64   
65    class Product(extractMetadata.MetadataExtractor)
66     |  Base class for extracting data from input files. Other sub-classes actually
67     |  write output to files.
68     | 
69     |  Methods defined here:
70     | 
71     |  __init__(self, filenames, request)
72     | 
73     |  getParam(self)
74     |      getParam method - uses the requests information and data/metadata files
75     |      to extract the data objects requested by the user. These are then stored in
76     |      the list self.variables.
77     | 
78     |  ----------------------------------------------------------------------
79     |  Methods inherited from extractMetadata.MetadataExtractor:
80     | 
81     |  getFileList(self)
82     |      Method that returns the list of files associated with a particular
83     |      request. If more than one variable has been selected then the list
84     |      contains a concatenation of allVar1Files+allVar2Files.....+allVarNFiles.
85     | 
86     |  getRequestSizeInBytes(self)
87     |      Method to get the size of the request in bytes.
88     | 
89     |  getTimeStepCount(self)
90     |      Method to return the number of time steps requested.
91     | 
92     |  getTimeSteps(self, dset_num=1)
93     |      Method to return a list of tuples for all timesteps requested.
94
Note: See TracBrowser for help on using the repository browser.