Changeset 09a0be5 in sasview

Timestamp:

Apr 4, 2017 10:03:52 AM (8 years ago)

Author:

Adam Washington <adam.washington@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

2d866370

Parents:

388bd51

Message:

Add docstrings to sesans_reader utility functions

File:

• src/sas/sascalc/dataloader/readers/sesans_reader.py (modified) (3 diffs)

src/sas/sascalc/dataloader/readers/sesans_reader.py

@@ -117 +117 @@
 
     def _unit_conversion(self, value, value_unit, default_unit):
+        """
+        Performs unit conversion on a measurement.
+
+        :param value: The magnitude of the measurement
+        :type value: Number
+        :param value_unit: a string containing the final desired unit
+        :type value_unit: String
+        :param default_unit: a string containing the units of the original measurement
+        :type default_unit: String
+        :return: The magnitude of the measurement in the new units
+        """
         if has_converter and value_unit != default_unit:
             data_conv_q = Converter(value_unit)
@@ -126 +137 @@
 
     def _header_fetch(self, headers, key):
+        """
+        Pull the value of a unit defined header from a dict. Example::
+
+         d = {"Length [m]": 17}
+         self._header_fetch(d, "Length") == 17
+
+        :param header: A dictionary of values
+        :type header: Dictionary
+        :param key: A string which is a prefix for one of the keys in the dict
+        :type key: String
+        :return: The value of the dictionary for the specified key
+        """
         index = [k for k in headers.keys()
                  if k.startswith(key)][0]
@@ -131 +154 @@
 
     def _fetch_unit(self, params, key):
+        """
+        Pull the unit off of a dictionary header. Example::
+
+         d = {"Length [m]": 17}
+         self._fetch_unit(d, "Length") == "m"
+
+        :param header: A dictionary of values, where the keys are strings
+        with the units for the values appended onto the string within square
+        brackets (See the example above)
+        :type header: Dictionary
+        :param key: A string with the prefix of the dictionary key whose unit
+        is being fetched
+        :type key: String
+        :return: A string containing the unit specifed in the header
+        """
         index = [k for k in params.keys()
                  if k.startswith(key)][0]