Skip to content

Commit

Permalink
Correct grammar in README
Browse files Browse the repository at this point in the history
  • Loading branch information
rahulbhadani authored Sep 15, 2019
1 parent 025ca7e commit 4acb95c
Showing 1 changed file with 13 additions and 18 deletions.
31 changes: 13 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
# ROSBagReader
__A MATLAB Class to facilitate reading of rosbag file based on semantic datatypes.__
__A MATLAB Class to facilitate the reading of rosbag file based on semantic datatypes.__

__`ROSBagReader`__ is a wrapper class written in MATLAB that provides an easy to use interface for
reading [bag files](http://wiki.ros.org/Bags) recorded by `rosbag record` command. This wrapper class uses MATLAB's API `rosbag()`
internally to perform all operations. One of the interesting feature about using __`ROSBagReader`__ is that a user doesn't need to
__`ROSBagReader`__ is a wrapper class written in MATLAB that provides an easy to use interface for reading [bag files](http://wiki.ros.org/Bags) recorded by `rosbag record` command. This wrapper class uses MATLAB's API `rosbag()`
internally to perform all operations. One of the interesting features about using __`ROSBagReader`__ is that a user doesn't need to
supply [rostopic name](http://wiki.ros.org/rostopic) to extract relevant data. One can extract data based on the type of data the
user is seeking.

## Usage principle
The philosophy behind developing this project is to make everything as simple and less confusing as possible. As a result, there are
not too many options or freedom of usage being provided by __`ROSBagReader`__ class. If you really need wide variety of options, users
not too many options or freedom of usage being provided by __`ROSBagReader`__ class. If you need a wide variety of options, users
can directly use Robotics System Toolbox APIs provided by MATLAB. However, if you are looking for simplicity, __`ROSBagReader`__ is an
elegant choice.

An object/instance of __`ROSBagReader`__ class takes absolute path of the bag file as an argument and provides several member functions
An object/instance of __`ROSBagReader`__ class takes the absolute path of the bag file as an argument and provides several member functions
to extract data of choice. Data are extracted in a subfolder with the same name as of the provided bag file in the directory where bag
file is located. Further, data are extracted in two formats: csv and mat file. To further process the data in MATLAB, mat file is a
recommended choice but csv file format is a good start for ameteurs or working with other languages such as python or C++. However,
image data are exception. Image frames are extracted as png files in a subsubfolder of the subfolder with the same name as the topic name.
recommended choice but CSV file format is a good start for amateurs or working with other languages such as Python or C++. However,
image data are an exception. Image frames are extracted as png files in a subsubfolder of the subfolder with the same name as the topic name.
Image's timestamp is used as the file name for image frames.


## System Requirements and Dependencies
- A basic knowledge of Object-Oriented Program (OOP) is recommended but not required. Usages are really simple but knowledge of
- Basic knowledge of Object-Oriented Program (OOP) is recommended but not required. Usages are simple but knowledge of
OOP can boost the understanding of the core principle behind this package.
- Operating System: Windows 8 or higher, Ubuntu 16.04 LTS or higher, Mac (not tested on Mac)
- MATLAB 2018a or higher (MATLAB 2019a or higher recommended)
Expand All @@ -34,13 +33,13 @@ OOP can boost the understanding of the core principle behind this package.
Currently, __`ROSBagReader`__ does not support every ROS datatype. However, __`ROSBagReader`__ supports only those ROS data types
that are important when working with Autonomous Vehicle Testbed [CAT Vehicle Testbed](https://github.com/jmscslgroup/catvehicle)
developed at the University of Arizona. The testbed publishes and subscribes to topics on laser data, camera data, velocity data,
steering data, brake and acceleration data. As a result, developers provide support for only following data types:
steering data, brake and acceleration data. As a result, developers provide support for only the following data types:

- sensor_msgs/LaserScan (For laser data)
- geometry_msgs/Twist (For input and output velocity data)
- sensor_msgs/CompressedImage (For compressed images captured from cameras)
- nav_msgs/Odometry (For GPS odometry data)
- geometry_msgs/Wrench (For output steering, output brake and output accelerator data)
- geometry_msgs/Wrench (For output steering, output brake, and output accelerator data)

## Installation and Usage
1. Clone this git repository
Expand All @@ -59,7 +58,7 @@ Windows Example:

`>> B = ROSBagReader('C:\Users\WildCat\Documents\VersionControl\2019-09-11-14-59-34.bag');`

4. Now we are ready extract data from bag file:
4. Now we are ready to extract data from bag file:

Extract Laser Scan Data:

Expand All @@ -82,12 +81,12 @@ Extract Wrench Data
`>>B.extractWrenchData();`

## Issues
If you run into any issues, please issue feature of the GitHub to log your issues. I will try my best to address any issue as soon as
If you run into any issues, please use the issue feature of the GitHub to log your issues. I will try my best to address any issue as soon as
possible.

## Contributing to this project
If you like to contribute to this project, please fork this repository to your GitHub account, create a new branch for yourself and
send pull request for the merge. After reviewing the changes, we will decide if this is a good place to add your changes.
send a pull request for the merge. After reviewing the changes, we will decide if this is a good place to add your changes.

If you like to see new data types being supported, please raise an enhancement issue and provide a relevant bag file that contains the
ros message of desired data types.
Expand Down Expand Up @@ -120,7 +119,3 @@ ros message of desired data types.
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
OR OTHER DEALINGS IN THE SOFTWARE.




0 comments on commit 4acb95c

Please sign in to comment.