-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
created data structure to hold local odometry data #2
Merged
Merged
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
99024a9
created data structure to hold local odometry data
ashum68 848ffd7
added create keys to ensure create method is used
ashum68 453c38d
added string representations
ashum68 3cd407e
added module docstrings
ashum68 cf26201
added function docstrings
ashum68 45b3600
added init function docstrings
ashum68 5a9cef1
reformatting
ashum68 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
""" | ||
Data structure for local odometry data (local position, orientation, and timestamp) | ||
""" | ||
|
||
import time | ||
|
||
from .common.mavlink.modules import drone_odometry | ||
|
||
|
||
class DronePositionLocal: | ||
""" | ||
Drone position using NED. | ||
""" | ||
|
||
__create_key = object() | ||
|
||
@classmethod | ||
def create( | ||
cls, north: float, east: float, down: float | ||
) -> "tuple[bool, DronePositionLocal | None]": | ||
""" | ||
Local position (NED) | ||
""" | ||
return True, DronePositionLocal(cls.__create_key, north, east, down) | ||
|
||
def __init__(self, create_key: object, north: float, east: float, down: float) -> None: | ||
|
||
assert create_key is DronePositionLocal.__create_key, "Use create() method" | ||
|
||
self.north = north | ||
self.east = east | ||
self.down = down | ||
|
||
def __str__(self) -> str: | ||
return f"{self.__class__}: North: {self.north}, East: {self.east}, Down: {self.down}." | ||
|
||
|
||
class DroneOdometryLocal: | ||
""" | ||
Data structure combining drone's local position, local orientation | ||
and timestamp. | ||
""" | ||
|
||
__create_key = object() | ||
|
||
@classmethod | ||
def create( | ||
cls, local_position: DronePositionLocal, drone_orientation: drone_odometry.DroneOrientation | ||
) -> "tuple[bool, DroneOdometryLocal | None]": | ||
""" | ||
Combines local odometry data with timestamp | ||
""" | ||
|
||
if local_position is None: | ||
return False, None | ||
|
||
if drone_orientation is None: | ||
return False, None | ||
|
||
timestamp = time.time() | ||
|
||
return True, DroneOdometryLocal( | ||
cls.__create_key, local_position, drone_orientation, timestamp | ||
) | ||
|
||
def __init__( | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. add a docstring for this function |
||
self, | ||
create_key: object, | ||
local_position: DronePositionLocal, | ||
drone_orientation: drone_odometry.DroneOrientation, | ||
timestamp: float, | ||
) -> None: | ||
|
||
assert create_key is DroneOdometryLocal.__create_key, "Use create() method" | ||
|
||
self.local_position = local_position | ||
self.drone_orientation = drone_orientation | ||
self.timestamp = timestamp | ||
|
||
def __str__(self) -> str: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. add a docstring for this function |
||
return f"{self.__class__},\ | ||
{self.local_position}, \ | ||
DroneOrientation: Roll: {self.drone_orientation.roll}, Pitch: {self.drone_orientation.pitch}, Yaw: {self.drone_orientation.yaw}.\ | ||
Time: {self.timestamp}." |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
include string representation function