diff options
| author | Théo de la Hogue | 2024-04-25 22:57:21 +0200 |
|---|---|---|
| committer | Théo de la Hogue | 2024-04-25 22:57:21 +0200 |
| commit | 6e150b914e3bb0a7718410363498efb794b4ecbc (patch) | |
| tree | 8a658524112ba213d2c1b9536fd2c4722195ec01 | |
| parent | 8252697b266ffd2e6552d6a8bc70e659f58e014b (diff) | |
| parent | e7d7c073d5ca505b79c321e32d451e5a71faf566 (diff) | |
| download | argaze-main.zip argaze-main.tar.gz argaze-main.tar.bz2 argaze-main.tar.xz | |
6 files changed, 12 insertions, 8 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md index 9759c23..6a13abe 100644 --- a/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md +++ b/docs/user_guide/gaze_analysis_pipeline/aoi_2d_description.md @@ -55,3 +55,5 @@ JSON file format allows describing AOI. } } ``` +!!! note "" + Now we have AOI description, read the next chapter to learn [how to enable AOI analysis](./aoi_analysis.md).
\ No newline at end of file diff --git a/docs/user_guide/gaze_analysis_pipeline/timestamped_gaze_positions_edition.md b/docs/user_guide/gaze_analysis_pipeline/timestamped_gaze_positions_edition.md index 022899e..026d287 100644 --- a/docs/user_guide/gaze_analysis_pipeline/timestamped_gaze_positions_edition.md +++ b/docs/user_guide/gaze_analysis_pipeline/timestamped_gaze_positions_edition.md @@ -66,9 +66,10 @@ start_time = time.time() Timestamps can either be integers or floats, seconds, milliseconds or what ever you need. The only concern is that all time values used in further configurations have to be in the same unit. <!-- -!!! Note "Eyetracker connectors" +!!! note "Eyetracker connectors" [Read the use cases section to discover examples using specific eyetrackers](./user_cases/introduction.md). !--> -Now we have timestamped gaze positions at expected format, let's see how to analyze them.
\ No newline at end of file +!!! note "" + Now we have timestamped gaze positions at expected format, read the next chapter to start learning [how to analyze them](./configuration_and_execution.md).
\ No newline at end of file diff --git a/docs/user_guide/pipeline_input_context/configuration_and_connection.md b/docs/user_guide/pipeline_input_context/configuration_and_connection.md index 392860f..4aac88a 100644 --- a/docs/user_guide/pipeline_input_context/configuration_and_connection.md +++ b/docs/user_guide/pipeline_input_context/configuration_and_connection.md @@ -5,7 +5,7 @@ Once an [ArContext is defined](context_definition.md), it have to be connected t # Load JSON configuration file -An [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) can be loaded from a JSON configuration file thanks to the argaze.load package method. +An [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) can be loaded from a JSON configuration file thanks to the [argaze.load](../../argaze.md/#argaze.load) package method. Here is a JSON configuration file related to the [previously defined Example context](context_definition.md): diff --git a/docs/user_guide/pipeline_input_context/context_definition.md b/docs/user_guide/pipeline_input_context/context_definition.md index 5456243..7d30438 100644 --- a/docs/user_guide/pipeline_input_context/context_definition.md +++ b/docs/user_guide/pipeline_input_context/context_definition.md @@ -25,7 +25,7 @@ class Example(ArFeatures.ArContext): @property def parameter(self): - """Any required parameter.""" + """Any context specific parameter.""" return self.__parameter @parameter.setter @@ -35,7 +35,7 @@ class Example(ArFeatures.ArContext): @DataFeatures.PipelineStepEnter def __enter__(self): - # Start context according any required parameter + # Start context according any specific parameter ... self.parameter # Assuming that timestamp, x and y values are available @@ -53,4 +53,5 @@ class Example(ArFeatures.ArContext): !!! note "" - The next chapter explains how to [load a context to connect it with a pipeline](configuration_and_connection.md).
\ No newline at end of file + The next chapter explains how to [load a context to connect it with a pipeline](configuration_and_connection.md). +
\ No newline at end of file diff --git a/docs/user_guide/pipeline_input_context/introduction.md b/docs/user_guide/pipeline_input_context/introduction.md index 76c560e..e31ad54 100644 --- a/docs/user_guide/pipeline_input_context/introduction.md +++ b/docs/user_guide/pipeline_input_context/introduction.md @@ -14,7 +14,7 @@ To build your own input context, you need to know: !!! warning "Documentation in progress" - This section is not yet fully done. Please look at the [demo](../utils/demonstrations_scripts.md) to know more about this notion. + This section is not yet fully done. Please look at the [demonstrations scripts chapter](../utils/demonstrations_scripts.md) to know more about this notion. <!-- * [How to stop a context](stop.md), diff --git a/docs/user_guide/utils/ready-made_scripts.md b/docs/user_guide/utils/ready-made_scripts.md index 2c657e0..5f521e1 100644 --- a/docs/user_guide/utils/ready-made_scripts.md +++ b/docs/user_guide/utils/ready-made_scripts.md @@ -22,7 +22,7 @@ python -m argaze CONFIGURATION Use -p option to enable pipe communication at given address: ```shell -python -m argaze post_processing_context.json -p /tmp/argaze +python -m argaze CONFIGURATION -p /tmp/argaze ``` Open another tab in the **same** Terminal window then, you can send any Python command into the pipe. |