artemis_gnss.process package

Subpackages

• artemis_gnss.process.iterative package
  • Submodules
  • artemis_gnss.process.iterative.C_split_trace_to_portions module
    • SplitTraceStep
      • SplitTraceStep.append()
      • SplitTraceStep.flush()
      • SplitTraceStep.get_state()
      • SplitTraceStep.initialize()
      • SplitTraceStep.purge()
      • SplitTraceStep.restore()
  • artemis_gnss.process.iterative.E_merge_portions module
    • MergePortionStep
      • MergePortionStep.append()
      • MergePortionStep.flush()
      • MergePortionStep.get_state()
      • MergePortionStep.initialize()
      • MergePortionStep.purge()
      • MergePortionStep.restore()
    • portion_decide_merge()
  • artemis_gnss.process.iterative.abc module
    • StatefulStep
      • StatefulStep.append()
      • StatefulStep.flush()
      • StatefulStep.get_state()
      • StatefulStep.initialize()
      • StatefulStep.purge()
      • StatefulStep.restore()
  • artemis_gnss.process.iterative.main_iterative module
    • CleanProcess
      • CleanProcess.append()
      • CleanProcess.flush()
      • CleanProcess.get_debug()
      • CleanProcess.get_init_last_trip_edit()
      • CleanProcess.get_output()
      • CleanProcess.get_output_trips()
      • CleanProcess.get_state()
      • CleanProcess.initialize()
      • CleanProcess.process_all()
      • CleanProcess.purge()
      • CleanProcess.restore()
  • Module contents

Submodules

artemis_gnss.process.a_time_base module

Functions to define a common time base

timestamp: np.datetime64 format (0 = 01/01/1970 0:0:0) time: numeric vector in seconds (0 = trace.attrs[“timestamp”]) The treatments require a time vector. If the user gives a timestamp vector, this vector is generated below.

Created on 20/09/24

artemis_gnss.process.a_time_base.apply_common_timestamp_init_time_vect(trace: DataFrame, common_timestamp: datetime64 = None, *, default_time_step: float = None)

artemis_gnss.process.a_time_base.compute_first_timeval(trace: DataFrame, common_timestamp: datetime64 = None)

Apply to a trace with the time field -> gives the value of time for the first sample The value is also stored in trace.attrs :param trace: :param common_timestamp: :return:

artemis_gnss.process.a_time_base.negotiate_common_timestamp(traces: List[DataFrame], *, common_timestamp: datetime64 = None) → datetime64

artemis_gnss.process.b_clean_raw_stop_detection module

Minimal data corrections on raw trace in order to perform stop detection

re-order data here if necessary

Created on 20/09/24

artemis_gnss.process.b_clean_raw_stop_detection.clean_raw_steps(trace: DataFrame, options: CleanOptions)

artemis_gnss.process.b_clean_raw_stop_detection.stop_or_gap_divide(trace: DataFrame, *, duration_cut_s: float = 0) → Tuple[List[DataFrame], DataFrame]

artemis_gnss.process.d_clean_portion module

Anomaly detection and signal treatment on a trace between prolonged stops Created on 20/09/24

artemis_gnss.process.d_clean_portion.clean_portion_steps(portion: DataFrame, *, previous_portion: DataFrame, options: CleanOptions) → DataFrame

Function to clean a portion between two prolongated stops :param portion: :param options: :return: True if portion contains information on movement

artemis_gnss.process.d_clean_portion.portion_imt(trace: DataFrame) → IMTransport

Identification of means of transportation :param trace: :return:

artemis_gnss.process.f_clean_trip_post_merge module

Computations on a finalized trip and final validation Created on 20/09/24

artemis_gnss.process.f_clean_trip_post_merge.clean_trip_post_merge_steps(trip: DataFrame, options: CleanOptions, previous_trip: DataFrame, is_last_trip: bool) → Tuple[List[DataFrame], DataFrame]

artemis_gnss.process.f_clean_trip_post_merge.curate_trip_post_merge_div(trip: DataFrame, options: CleanOptions)

Steps after points removal in clean_trip_post_merge_steps :param trip: :return:

artemis_gnss.process.f_clean_trip_post_merge.merge_new_trip_check_space_gap(new_trip: DataFrame, previous_trip: DataFrame) → List[DataFrame]

This function tests if there is a space gap between the previous trip and the first point of the new trip under construction. It adds the last point of the previous trip and the first point as a new trip if there was a gap. This ensures the algorithm will send a continuous trace of localizations. :param new_trip: first portion of the trip under construction :param previous_trip: previously finished trip :return: list of missing trips

artemis_gnss.process.f_clean_trip_post_merge.merge_stationary_trips(reformated_stationary_trip_1: DataFrame, reformated_stationary_trip_2: DataFrame) → List[DataFrame]

artemis_gnss.process.f_clean_trip_post_merge.reformat_stationary_trip(portion: DataFrame) → DataFrame

artemis_gnss.process.main module

Displacement identification from a set of raw traces Created on 20/09/24

artemis_gnss.process.main.process_traces(traces: DataFrame | dict | Trace | List[dict | DataFrame | Trace], *, options: CleanOptions = None, init_last_trip: DataFrame = None, iterative_implementation: bool = False) → CleanOutput

artemis_gnss.process.main.sanitize_traces(traces: DataFrame | dict | Trace | List[dict | DataFrame | Trace], *, common_timestamp: datetime64 = None, sort_traces=True, deep_copy=True) → Tuple[datetime64, List[DataFrame]]

artemis_gnss.process.options module

Clean treatment options Created on 20/09/24

class artemis_gnss.process.options.CleanOptions(common_timestamp: datetime64 = None)

Bases: object

Options for the process process :attrib common_timestamp: reference timestamp to use in output routes, for t=0 :attrib inputs_deepcopy: option to activate deep copy and remove any side effects of the algorithm on the inputs :attrib output_timestamp: option to recompute the timestamp vector for the output (if possible) :attrib default_time_step: default time step to consider if no time vector / timestamp vector is given

copy()

static from_dict(d: dict)

to_dict()

class artemis_gnss.process.options.StepDeepCopy(*values)

Bases: IntEnum

Beginning_NoSideEffect = 0

None_CleanRaw = 3

Post_Init = 1

Post_TimeBase = 2

artemis_gnss.process.tests module

Functions to test properties of the output of the process Created on 20/09/24

artemis_gnss.process.tests.test_position_continuity(output: CleanOutput) → Tuple[bool, List]

Verify the continuity of position in a sequence of displacements :param output: output of the clean process :return:

Module contents

Package for cleaning traces Created on 20/09/24