Skip to content

Commit 484a7a0

Browse files
committed
Added comments and licences.
1 parent 359a874 commit 484a7a0

File tree

5 files changed

+101
-13
lines changed

5 files changed

+101
-13
lines changed

fsensor/src/main/java/com/kircherelectronics/fsensor/filter/averaging/AveragingFilter.java

+18
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,25 @@
22

33
import com.kircherelectronics.fsensor.filter.BaseFilter;
44

5+
/*
6+
* Copyright 2017, Kircher Electronics, LLC
7+
*
8+
* Licensed under the Apache License, Version 2.0 (the "License");
9+
* you may not use this file except in compliance with the License.
10+
* You may obtain a copy of the License at
11+
*
12+
* http://www.apache.org/licenses/LICENSE-2.0
13+
*
14+
* Unless required by applicable law or agreed to in writing, software
15+
* distributed under the License is distributed on an "AS IS" BASIS,
16+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
* See the License for the specific language governing permissions and
18+
* limitations under the License.
19+
*/
20+
521
/**
22+
* A base implementation of an averaging filter.
23+
*
624
* Created by kaleb on 7/6/17.
725
*/
826

fsensor/src/main/java/com/kircherelectronics/fsensor/filter/fusion/OrientationKalmanFusion.java

+38
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,45 @@
1111

1212
import java.util.Arrays;
1313

14+
/*
15+
* Copyright 2017, Kircher Electronics, LLC
16+
*
17+
* Licensed under the Apache License, Version 2.0 (the "License");
18+
* you may not use this file except in compliance with the License.
19+
* You may obtain a copy of the License at
20+
*
21+
* http://www.apache.org/licenses/LICENSE-2.0
22+
*
23+
* Unless required by applicable law or agreed to in writing, software
24+
* distributed under the License is distributed on an "AS IS" BASIS,
25+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
26+
* See the License for the specific language governing permissions and
27+
* limitations under the License.
28+
*/
29+
1430
/**
31+
* An implementation of a Kalman filter based orientation sensor fusion.
32+
* * <p>
33+
* The filter attempts to fuse magnetometer, gravity and gyroscope
34+
* sensors together to produce an accurate measurement of the rotation of the
35+
* device.
36+
* <p>
37+
* The magnetometer and acceleration sensors are used to determine one of the
38+
* two orientation estimations of the device. This measurement is subject to the
39+
* constraint that the device must not be accelerating and hard and soft-iron
40+
* distortions are not present in the local magnetic field.
41+
* <p>
42+
* The gyroscope is used to determine the second of two orientation estimations
43+
* of the device. The gyroscope can have a shorter response time and is not
44+
* effected by linear acceleration or magnetic field distortions, however it
45+
* experiences drift and has to be compensated periodically by the
46+
* acceleration/magnetic sensors to remain accurate.
47+
* <p>
48+
* Quaternions are used to integrate the measurements of the gyroscope and apply
49+
* the rotations to each sensors measurements via Kalman filter. This the
50+
* ideal method because quaternions are not subject to many of the singularties
51+
* of rotation matrices, such as gimbal lock.
52+
* <p>
1553
* Created by kaleb on 7/6/17.
1654
*/
1755

fsensor/src/main/java/com/kircherelectronics/fsensor/linearacceleration/LinearAcceleration.java

+10-12
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,19 @@
55
import java.util.Arrays;
66

77
/*
8-
* Acceleration Explorer
9-
* Copyright (C) 2013-2015, Kaleb Kircher - Kircher Engineering, LLC
8+
* Copyright 2017 Kircher Electronics, LLC
109
*
11-
* This program is free software: you can redistribute it and/or modify
12-
* it under the terms of the GNU General Public License as published by
13-
* the Free Software Foundation, either version 3 of the License, or
14-
* (at your option) any later version.
10+
* Licensed under the Apache License, Version 2.0 (the "License");
11+
* you may not use this file except in compliance with the License.
12+
* You may obtain a copy of the License at
1513
*
16-
* This program is distributed in the hope that it will be useful,
17-
* but WITHOUT ANY WARRANTY; without even the implied warranty of
18-
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19-
* GNU General Public License for more details.
14+
* http://www.apache.org/licenses/LICENSE-2.0
2015
*
21-
* You should have received a copy of the GNU General Public License
22-
* along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
* Unless required by applicable law or agreed to in writing, software
17+
* distributed under the License is distributed on an "AS IS" BASIS,
18+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19+
* See the License for the specific language governing permissions and
20+
* limitations under the License.
2321
*/
2422

2523
/**

fsensor/src/main/java/com/kircherelectronics/fsensor/linearacceleration/LinearAccelerationAveraging.java

+17
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,24 @@
22

33
import com.kircherelectronics.fsensor.filter.averaging.AveragingFilter;
44

5+
/*
6+
* Copyright 2017, Kircher Electronics, LLC
7+
*
8+
* Licensed under the Apache License, Version 2.0 (the "License");
9+
* you may not use this file except in compliance with the License.
10+
* You may obtain a copy of the License at
11+
*
12+
* http://www.apache.org/licenses/LICENSE-2.0
13+
*
14+
* Unless required by applicable law or agreed to in writing, software
15+
* distributed under the License is distributed on an "AS IS" BASIS,
16+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
* See the License for the specific language governing permissions and
18+
* limitations under the License.
19+
*/
20+
521
/**
22+
* A wrapper for Linear Acceleration filters that are backed by Averaging filters.
623
* Created by kaleb on 7/6/17.
724
*/
825

fsensor/src/main/java/com/kircherelectronics/fsensor/linearacceleration/LinearAccelerationFusion.java

+18-1
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,27 @@
33
import com.kircherelectronics.fsensor.filter.fusion.OrientationFusion;
44
import com.kircherelectronics.fsensor.util.Util;
55

6+
/*
7+
* Copyright 2017, Kircher Electronics, LLC
8+
*
9+
* Licensed under the Apache License, Version 2.0 (the "License");
10+
* you may not use this file except in compliance with the License.
11+
* You may obtain a copy of the License at
12+
*
13+
* http://www.apache.org/licenses/LICENSE-2.0
14+
*
15+
* Unless required by applicable law or agreed to in writing, software
16+
* distributed under the License is distributed on an "AS IS" BASIS,
17+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18+
* See the License for the specific language governing permissions and
19+
* limitations under the License.
20+
*/
21+
622
/**
23+
* A wrapper for Linear Acceleration filters that are backed by sensor fusions.
24+
*
725
* Created by kaleb on 7/6/17.
826
*/
9-
1027
public class LinearAccelerationFusion extends LinearAcceleration {
1128

1229
public LinearAccelerationFusion(OrientationFusion orientationFusion) {

0 commit comments

Comments
 (0)