def zoom_time(self, start=None, end=None, copy=True): """ Selects a strech of time from a housekeeping instance. Arguments --------- start (optional): string - Timestamp of format '%Y-%m-%d %H:%M:%S.%f' or '%Y-%m-%d %H:%M:%S' end (optional): string ... as start copy (optional): bool - if False the instance will be changed. Else, a copy is returned Returns ------- If copy is True: housekeeping instance else: nothing (instance is changed in place) Example ------- >>> from atmPy.aerosols.instruments.piccolo import piccolo >>> launch = '2015-04-19 08:20:22' >>> landing = '2015-04-19 10:29:22' >>> hk = piccolo.read_file(filename) # create housekeeping instance >>> hk_zoom = zoom_time(hk, start = launch, end= landing) """ if copy: housek = self.copy() else: housek = self if start: start = _time_tools.string2timestamp(start) if end: end = _time_tools.string2timestamp(end) try: housek.data = housek.data.truncate(before=start, after=end) except KeyError: txt = '''This error is most likely related to the fact that the index of the timeseries is not in order. Run the sort_index() attribute of the DataFrame''' raise KeyError(txt) if copy: return housek else: return
def zoom_time(self, start=None, end=None, copy=True): """ Selects a strech of time from a housekeeping instance. Arguments --------- start (optional): string - Timestamp of format '%Y-%m-%d %H:%M:%S.%f' or '%Y-%m-%d %H:%M:%S' end (optional): string ... as start copy (optional): bool - if False the instance will be changed. Else, a copy is returned Returns ------- If copy is True: housekeeping instance else: nothing (instance is changed in place) Example ------- >>> from atmPy.for_removal.piccolo import piccolo >>> launch = '2015-04-19 08:20:22' >>> landing = '2015-04-19 10:29:22' >>> hk = piccolo.read_file(filename) # create housekeeping instance >>> hk_zoom = zoom_time(hk, start = launch, end= landing) """ if copy: housek = self.copy() else: housek = self if start: start = time_tools.string2timestamp(start) if end: end = time_tools.string2timestamp(end) try: housek.data = housek.data.truncate(before=start, after=end) except KeyError: txt = '''This error is most likely related to the fact that the index of the timeseries is not in order. Run the sort_index() attribute of the DataFrame''' raise KeyError(txt) if copy: return housek else: return
def zoom_time(self, start=None, end=None, copy=True): """ Selects a strech of time from a housekeeping instance. Arguments --------- start (optional): string - Timestamp of format '%Y-%m-%d %H:%M:%S.%f' or '%Y-%m-%d %H:%M:%S' end (optional): string ... as start copy (optional): bool - if False the instance will be changed. Else, a copy is returned Returns ------- If copy is True: housekeeping instance else: nothing (instance is changed in place) Example ------- >>> from atmPy.aerosols.instruments.piccolo import piccolo >>> launch = '2015-04-19 08:20:22' >>> landing = '2015-04-19 10:29:22' >>> hk = piccolo.read_file(filename) # create housekeeping instance >>> hk_zoom = zoom_time(hk, start = launch, end= landing) """ if copy: housek = self.copy() else: housek = self if start: start = time_tools.string2timestamp(start) if end: end = time_tools.string2timestamp(end) housek.data = housek.data.truncate(before=start, after=end) if copy: return housek else: return