def assign(value, error=None, unit=None, name=None, longname=None, value_unit=None, error_unit=None, ignore_dim=False): """ function to create a new quantity Args: value: number or string that can be parsed by numpy, or sympy expression. If it's a sympy expression containing quantities, it will perform the calculation, otherwise it just saves the value. error: number that is saved as the value's uncertainty. this will replace any error coming from a calculation. unit: sympy expression of Unit objects. This is used to convert and save value and error in base units. Replaces value_unit and error_unit if specified. name: short name of the quantity (usually one letter). If not specified, quantity will get a dummy name. longname: optional additional description of the quantity value_unit: unit of value. Use this if value and error have different units. error_unit: unit of error. ignore_dim: bool. Keeps function from raising an error even if calculated and given unit don't match. Then given unit is used instead. """ value_formula = None value_factor = 1 value_dim = Dimension() error_formula = None error_factor = 1 error_dim = Dimension() # parse units if unit is not None: # if one general unit is given value_factor, value_dim, value_unit = parse_unit(unit) error_factor = value_factor error_dim = value_dim error_unit = value_unit else: # if value unit is given if value_unit is not None: value_factor, value_dim, value_unit = parse_unit(value_unit) # if error unit is given if error_unit is not None: error_factor, error_dim, error_unit = parse_unit(error_unit) # check dimension consistency between value_dim and error_dim if value_unit is not None and not value_dim == error_dim: raise RuntimeError("dimension mismatch\n%s != %s" % (value_dim, error_dim)) # process value # if it's a calculation if isinstance(value, Expr) and not value.is_number: value_formula = value value = get_value(value_formula) if ignore_dim: # with ignore_dim=True, calculated value is converted to given unit value = np.float_(value_factor)*np.float_(value) else: # calculate dimension from dependency calculated_dim = get_dimension(value_formula) if value_unit is None: value_dim = calculated_dim else: if not calculated_dim == value_dim: raise RuntimeError("dimension mismatch \n%s != %s" % (value_dim, calculated_dim)) # if it's a number else: value=np.float_(value_factor)*np.float_(value) # process error if error is not None: error=np.float_(error_factor)*np.float_(error) # check value and error shapes and duplicate error in case if error.shape == () or value.shape[-len(error.shape):] == error.shape: error = np.resize(error, value.shape) else: raise RuntimeError("length of value and error don't match and "\ "can't be adjusted by duplicating.\n"\ "%s and %s" % (value.shape, error.shape)) # if error can be calculated elif value_formula is not None: error, error_formula = get_error(value_formula) if ignore_dim: # with ignore_dim=True, calculated error is converted to given unit error = np.float_(error_factor)*np.float_(error) q = Quantity(name, longname) q.value = value q.value_formula = value_formula q.error = error q.error_formula = error_formula if value_unit is not None: q.prefer_unit = value_unit else: q.prefer_unit = error_unit q.dim = value_dim return q
def plot(expr_pairs, config, save=None, xunit=None, yunit=None, xrange=None, yrange=None, ignore_dim=False): # TODO it should be possible to e.g. plot the function [t,2*r] if r depends on t # one or multiple things to plot if len(expr_pairs) > 1: single_plot = False else: single_plot = True x_dim = None y_dim = None data_sets = [] functions = [] if ignore_dim: xunit = S.One yunit = S.One for expr_pair in expr_pairs: x = expr_pair[0] y = expr_pair[1] if not ignore_dim: # check dimensions if x_dim is None: x_dim = get_dimension(x) else: if not x_dim == get_dimension(x): raise RuntimeError("dimension mismatch\n%s != %s" % (x_dim, get_dimension(x))) if y_dim is None: y_dim = get_dimension(y) else: if not y_dim == get_dimension(y): raise RuntimeError("dimension mismatch\n%s != %s" % (y_dim, get_dimension(y))) # if y contains x, it must be a function dummy = Quantity() rep_y = y.subs(x,dummy) if rep_y.has(dummy): # get titles if isinstance(x, Quantity): x_title = ((x.longname + " ") if x.longname else "") + str(x) else: x_title = str(x) y_title = str(y) # check if x not only quantity but more complicated expression if not isinstance(x,Quantity): # replace by Dummy y = rep_y x = dummy if not ignore_dim: # get factors x_factor, xunit = convert_to_unit(x_dim, outputUnit=xunit) y_factor, yunit = convert_to_unit(y_dim, outputUnit=yunit) # scale function to units y = y.subs(x,x*x_factor) / y_factor # if only one thing on plot, write labels to x-axis and y-axis if single_plot: title = None x_label = x_title + ("" if xunit == S.One else " [" + str(xunit) + "]") y_label = y_title + ("" if yunit == S.One else " [" + str(yunit) + "]") # if more than one thing, use legend for title else: title = y_title functions.append({"x":x,"term":y,"title":title}) # if y doesn't contain x, it must be a data set else: # calculate expressions first if necessary if isinstance(expr_pair[0], Quantity): x = expr_pair[0] x_title = ((x.longname + " ") if x.longname else "") + str(x) else: # dummy quantity for calculation x = Quantity() x.value = get_value(expr_pair[0]) x.error = get_error(expr_pair[0])[0] x.dim = x_dim x_title = str(expr_pair[0]) if isinstance(expr_pair[1], Quantity): y = expr_pair[1] y_title = ((y.longname + " ") if y.longname else "") + str(y) else: # dummy quantity for calculation y = Quantity() y.value = get_value(expr_pair[1]) y.error = get_error(expr_pair[1])[0] y.dim = y_dim y_title = str(expr_pair[1]) if ignore_dim: x_values = x.value x_errors = x.error y_values = y.value y_errors = y.error else: # get values and errors all in one unit x_values, x_errors, xunit = adjust_to_unit(x, unit = xunit) y_values, y_errors, yunit = adjust_to_unit(y, unit = yunit) # if only one thing on plot, write labels to x-axis and y-axis if single_plot: title = None x_label = x_title + ("" if xunit == S.One else " [" + str(xunit) + "]") y_label = y_title + ("" if yunit == S.One else " [" + str(yunit) + "]") # if more than one thing, use legend for title else: title = y_title data_sets.append({"x_values": x_values, "y_values": y_values, "x_errors": x_errors, "y_errors":y_errors, "title": title}) # if more than one thing on plot, write only units to axes if not single_plot: x_label = ("" if xunit == S.One else "[" + str(xunit) + "]") y_label = ("" if yunit == S.One else "[" + str(yunit) + "]") # plot if config["plot_module"] == "matplotlib": from errorpro import plot_mat return plot_mat.plot(data_sets, functions, save=save, xrange=xrange, yrange=yrange, x_label=x_label, y_label=y_label) elif config["plot_module"] == "gnuplot": from errorpro import plot_gnu return plot_gnu.plot(data_sets, functions, save=save, xrange=xrange, yrange=yrange, x_label=x_label, y_label=y_label) else: raise ValueError("There is not plot module called '%s'" % config["plot_module"])
def plot(expr_pairs, config, save=None, xunit=None, yunit=None, xrange=None, yrange=None, ignore_dim=False): # TODO it should be possible to e.g. plot the function [t,2*r] if r depends on t # one or multiple things to plot if len(expr_pairs) > 1: single_plot = False else: single_plot = True x_dim = None y_dim = None data_sets = [] functions = [] if ignore_dim: xunit = S.One yunit = S.One for expr_pair in expr_pairs: x = expr_pair[0] y = expr_pair[1] if not ignore_dim: # check dimensions if x_dim is None: x_dim = get_dimension(x) else: if not x_dim == get_dimension(x): raise RuntimeError("dimension mismatch\n%s != %s" % (x_dim, get_dimension(x))) if y_dim is None: y_dim = get_dimension(y) else: if not y_dim == get_dimension(y): raise RuntimeError("dimension mismatch\n%s != %s" % (y_dim, get_dimension(y))) # if y contains x, it must be a function dummy = Quantity() rep_y = y.subs(x, dummy) if rep_y.has(dummy): # get titles if isinstance(x, Quantity): x_title = ((x.longname + " ") if x.longname else "") + str(x) else: x_title = str(x) y_title = str(y) # check if x not only quantity but more complicated expression if not isinstance(x, Quantity): # replace by Dummy y = rep_y x = dummy if not ignore_dim: # get factors x_factor, xunit = convert_to_unit(x_dim, outputUnit=xunit) y_factor, yunit = convert_to_unit(y_dim, outputUnit=yunit) # scale function to units y = y.subs(x, x * x_factor) / y_factor # if only one thing on plot, write labels to x-axis and y-axis if single_plot: title = None x_label = x_title + ("" if xunit == S.One else " [" + str(xunit) + "]") y_label = y_title + ("" if yunit == S.One else " [" + str(yunit) + "]") # if more than one thing, use legend for title else: title = y_title functions.append({"x": x, "term": y, "title": title}) # if y doesn't contain x, it must be a data set else: # calculate expressions first if necessary if isinstance(expr_pair[0], Quantity): x = expr_pair[0] x_title = ((x.longname + " ") if x.longname else "") + str(x) else: # dummy quantity for calculation x = Quantity() x.value = get_value(expr_pair[0]) x.error = get_error(expr_pair[0])[0] x.dim = x_dim x_title = str(expr_pair[0]) if isinstance(expr_pair[1], Quantity): y = expr_pair[1] y_title = ((y.longname + " ") if y.longname else "") + str(y) else: # dummy quantity for calculation y = Quantity() y.value = get_value(expr_pair[1]) y.error = get_error(expr_pair[1])[0] y.dim = y_dim y_title = str(expr_pair[1]) if ignore_dim: x_values = x.value x_errors = x.error y_values = y.value y_errors = y.error else: # get values and errors all in one unit x_values, x_errors, xunit = adjust_to_unit(x, unit=xunit) y_values, y_errors, yunit = adjust_to_unit(y, unit=yunit) # if only one thing on plot, write labels to x-axis and y-axis if single_plot: title = None x_label = x_title + ("" if xunit == S.One else " [" + str(xunit) + "]") y_label = y_title + ("" if yunit == S.One else " [" + str(yunit) + "]") # if more than one thing, use legend for title else: title = y_title data_sets.append({ "x_values": x_values, "y_values": y_values, "x_errors": x_errors, "y_errors": y_errors, "title": title }) # if more than one thing on plot, write only units to axes if not single_plot: x_label = ("" if xunit == S.One else "[" + str(xunit) + "]") y_label = ("" if yunit == S.One else "[" + str(yunit) + "]") # plot if config["plot_module"] == "matplotlib": from errorpro import plot_mat return plot_mat.plot(data_sets, functions, save=save, xrange=xrange, yrange=yrange, x_label=x_label, y_label=y_label) elif config["plot_module"] == "gnuplot": from errorpro import plot_gnu return plot_gnu.plot(data_sets, functions, save=save, xrange=xrange, yrange=yrange, x_label=x_label, y_label=y_label) else: raise ValueError("There is not plot module called '%s'" % config["plot_module"])