Skip to content

Commit

Permalink
Merge pull request #65 from Gavin-Furtado/Experimenting
Browse files Browse the repository at this point in the history
Updated docstring of graph module
  • Loading branch information
Gavin-Furtado committed Feb 21, 2024
2 parents 06f47c5 + 9c8b571 commit fabdf96
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 1 deletion.
40 changes: 40 additions & 0 deletions Phase 2/filter_py_lib_test/graph.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
'''
Modue name
----------
graph
Module summary
--------------
Module that simplifies the coding process to plot graphs
Usage
-----
This module is is used to plot different graphs like scatter plot, gaussian plot
and reduces number of lines of repetitive code.
Example
-------
Here is an example of how to use this module in projects.
```python
import graph as gr
position_graph =gr.PlotGraph(plot_number=221, y1_data=position[:,0],
y2_data=position[:,1],title='Position data from sensor', xlabel='Time (s)',
ylabel='Position (m)',label_1='X-position',label_2='Y-position')
position_graph.scatter_plot()
## Display graph
plt.tight_layout()
plt.show()
```python
Author
------
Gavin Furtado
Role
----
AOCS Engineer
'''
import numpy as np
import matplotlib.pyplot as plt

Expand Down
2 changes: 1 addition & 1 deletion Phase 2/filter_py_lib_test/high_level.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ def main():
position, velocity, acceleration, noise = sensor.data_set()

## Data Visualisation ##
#visulaise_data(position, velocity, acceleration, noise, True)
visulaise_data(position, velocity, acceleration, noise, True)

## Initalisation ##
covar = kal.kalman_initial(position,velocity, acceleration)
Expand Down

0 comments on commit fabdf96

Please sign in to comment.