3 # calibcant - tools for thermally calibrating AFM cantilevers
5 # Copyright (C) 2007,2008, William Trevor King
7 # This program is free software; you can redistribute it and/or
8 # modify it under the terms of the GNU General Public License as
9 # published by the Free Software Foundation; either version 3 of the
10 # License, or (at your option) any later version.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15 # See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
22 # The author may be contacted at <wking@drexel.edu> on the Internet, or
23 # write to Trevor King, Drexel University, Physics Dept., 3141 Chestnut St.,
24 # Philadelphia PA 19104, USA.
27 Separate the more general T_analyze() from the other T_*()
28 functions in calibcant. Also provide a command line interface
29 for analyzing data acquired through other workflows.
31 The relevant physical quantities are :
32 T Temperature at which thermal vibration measurements were aquired
36 import common # common module for the calibcant package
37 import config # config module for the calibcant package
40 from splittable_kwargs import splittableKwargsFunction, \
41 make_splittable_kwargs_function
44 "Convert Celsius -> Kelvin."
45 return celsius + 273.15
48 "Convert Kelvin -> Kelvin."
51 @splittableKwargsFunction()
52 def T_analyze(T, convert_to_K=C_to_K) :
54 Not much to do here, just convert to Kelvin.
55 Uses C_to_K (defined above) by default.
57 try : # if T is an array, convert element by element
58 for i in range(len(T)) :
59 T[i] = convert_to_K(T[i])
60 except TypeError : # otherwise, make an array from a single T
64 @splittableKwargsFunction()
65 def T_save(T, log_dir=None) :
67 Save either a single T (if you are crazy :p),
68 or an array of them (more reasonable)
70 T = numpy.array(T, dtype=numpy.float)
72 log = data_logger.data_log(log_dir, noclobber_logsubdir=False,
74 log.write_binary(T.tostring())
75 if config.LOG_DATA != None :
76 log = data_logger.data_log(config.LOG_DIR, noclobber_logsubdir=False,
78 log.write_binary(T.tostring())
80 def T_load(datafile=None) :
82 Load the saved T array (possibly of length 1), and return it. If
83 datafile == None, return an array of one config.DEFAULT_TEMP
87 return numpy.array([config.DEFAULT_TEMP], dtype=numpy.float)
89 dl = data_logger.data_load()
90 return dl.read_binary(datafile)
92 @splittableKwargsFunction()
93 def T_plot(T, plotVerbose=False) :
95 Umm, just print the temperature?
97 if plotVerbose or config.PYLAB_VERBOSE or config.TEXT_VERBOSE :
98 print "Temperature ", T
100 @splittableKwargsFunction((T_analyze, 'T', 'convert_to_K'),
102 def T_load_analyze_tweaked(tweak_file, convert_to_K=C_to_K, textVerboseFile=None, **kwargs) :
103 "Load all the T array files from a tweak file and return a single array"
104 T_analyze_kwargs,T_plot_kwargs = \
105 T_load_analyze_tweaked._splitargs(T_load_analyze_tweaked, kwargs)
107 for line in file(tweak_file, 'r') :
108 parsed = line.split()
109 path = parsed[0].split('\n')[0]
110 if textVerboseFile != None :
111 print >> textVerboseFile, "Reading data from %s" % (path)
115 T_analyze(Ts, convert_to_K=convert_to_K)
116 return numpy.array(Ts, dtype=numpy.float)
118 # commandline interface functions
121 def read_data(ifile):
122 "ifile can be a filename string or open (seekable) file object"
123 if ifile == None : ifile = sys.stdin
124 unlabeled_data=scipy.io.read_array(ifile)
125 return unlabeled_data
127 if __name__ == '__main__' :
128 # command line interface
129 from optparse import OptionParser
131 usage_string = ('%prog <input-file>\n'
132 '2008, W. Trevor King.\n'
134 'There are two operation modes, one to analyze a single T (temperature) file,\n'
135 'and one to analyze tweak files.\n'
137 'Single file mode (the default) :\n'
138 'Reads in single column ASCII file of temperatures and... prints them back out.\n'
139 'No need to do this, but the option is available for consistency with the other\n'
140 'calibcant modules.\n'
143 'Runs the same analysis as in single file mode for each T file in\n'
144 'a tweak file. Each line in the tweak file specifies a single T file.\n'
145 'A T file contains a sequence of 32 bit floats representing temperature in K.\n'
147 parser = OptionParser(usage=usage_string, version='%prog 0.1')
148 parser.add_option('-C', '--celsius', dest='celsius',
149 help='Use Celsius input temperatures instead of Kelvin (default %default)\n',
150 action='store_true', default=False)
151 parser.add_option('-o', '--output-file', dest='ofilename',
152 help='write output to FILE (default stdout)',
153 type='string', metavar='FILE')
154 parser.add_option('-c', '--comma-out', dest='comma_out', action='store_true',
155 help='Output comma-seperated values (default %default)',
157 parser.add_option('-t', '--tweak-mode', dest='tweakmode', action='store_true',
158 help='Run in tweak-file mode',
160 parser.add_option('-v', '--verbose', dest='verbose', action='store_true',
161 help='Print lots of debugging information',
164 options,args = parser.parse_args()
166 assert len(args) >= 1, "Need an input file"
170 if options.ofilename != None :
171 ofile = file(options.ofilename, 'w')
174 if options.verbose == True :
178 config.TEXT_VERBOSE = options.verbose
179 config.PYLAB_VERBOSE = False
180 config.GNUPLOT_VERBOSE = False
182 convert_to_K = C_to_K
184 convert_to_K = K_to_K
186 if options.tweakmode == False :
187 data = read_data(ifilename)
188 Ts = T_analyze(data, convert_to_K)
189 else : # tweak file mode
190 Ts = T_load_analyze_tweaked(ifilename, convert_to_K, textVerboseFile=vfile)
192 if options.comma_out :
196 common.write_array(ofile, Ts, sep)
198 if options.ofilename != None :