Adjust slope terminology #29087
Adjust slope terminology #29087
Conversation
Smooth altitude changes were always referred to as "glide slopes" despite this not being the appropriate aviation term in the case of a climb. A better option is "altitude slope", which encompasses both smooth climbs and descents. Changed all references to glide slopes, except those that specifically refer to a single kind (like those used for landings), to the more general term. This also includes changing the GLIDE_SLOPE_MIN and GLIDE_SLOPE_THR parameters to ALT_SLOPE_MIN and ALT_SLOPE_THRESH, respectively.
Smooth altitude changes were always referred to as "glide slopes" despite this not being the appropriate aviation term in the case of a climb. A better option is "altitude slope", which encompasses both smooth climbs and descents. Changed all references to glide slopes, except those that specifically refer to a single kind (like those used for landings), to the more general term. This also includes changing the GLIDE_SLOPE_MIN and GLIDE_SLOPE_THR parameters to ALT_SLOPE_MIN and ALT_SLOPE_THRESH, respectively.
Smooth altitude changes were always referred to as "glide slopes" despite this not being the appropriate aviation term in the case of a climb. A better option is "altitude slope", which encompasses both smooth climbs and descents. Changed all references to glide slopes, except those that specifically refer to a single kind (like those used for landings), to the more general term. This also includes changing the GLIDE_SLOPE_MIN and GLIDE_SLOPE_THR parameters to ALT_SLOPE_MIN and ALT_SLOPE_THRESH, respectively.
|
@peterbarker this can go in before #29077 |
Smooth altitude changes were always referred to as "glide slopes" despite this not being the appropriate aviation term in the case of a climb. A better option is "altitude slope", which encompasses both smooth climbs and descents. Changed all references to glide slopes, except those that specifically refer to a single kind (like those used for landings), to the more general term. This also includes changing the GLIDE_SLOPE_MIN and GLIDE_SLOPE_THR parameters to ALT_SLOPE_MIN and ALT_SLOPE_THRESH, respectively.
rubenp02
force-pushed
the
chore/change-glide-slope-to-alt-slope
branch
from
e2dbeb0 to
a322f1d
Compare
|
@peterbarker Can you confirm if param conversion is needed for the name changes? |
|
This is failing the
No param conversion needed. The value is stored based on the table and index within, name doesn't matter. |
Thanks, figured as much but wanted to be sure |
| // @Param: GLIDE_SLOPE_MIN | ||
| // @DisplayName: Glide slope minimum | ||
| // @Description: This controls the minimum altitude change for a waypoint before a glide slope will be used instead of an immediate altitude change. The default value is 15 meters, which helps to smooth out waypoint missions where small altitude changes happen near waypoints. If you don't want glide slopes to be used in missions then you can set this to zero, which will disable glide slope calculations. Otherwise you can set it to a minimum number of meters of altitude error to the destination waypoint before a glide slope will be used to change altitude. | ||
| // @Param: ALT_SLOPE_MIN |
There was a problem hiding this comment.
maybe ALT_DELTA_MIN is better? The problem with "SLOPE" is it sounds like an angle
There was a problem hiding this comment.
Sure but if you read the description, the word "slope" appears multiple times as it describes what the functionality is - altitude slope calculations.
There was a problem hiding this comment.
I agree that we cannot omit the ALT_SLOPE_* prefix
| // @Param: GLIDE_SLOPE_THR | ||
| // @DisplayName: Glide slope threshold | ||
| // @Description: This controls the height above the glide slope the plane may be before rebuilding a glide slope. This is useful for smoothing out an autotakeoff | ||
| // @Param: ALT_SLOPE_THRESH |
There was a problem hiding this comment.
docs should also make it clear it is only when above, not below
There was a problem hiding this comment.
definitely not ALT_ERROR_THRESH that could mean any ALT error that has nothing to do with this slope functionality. IMO it would be confusing.
There was a problem hiding this comment.
IMO that doesn't convey what the parameter does. ALT_SLOPE_RECALC is the best I can think of, and the display name could be "Altitude slope recalculation threshold". I think the description already makes it clear that this only applies when above the slope but maybe it should be a part of the display name too
There was a problem hiding this comment.
Perhaps, but I think ALT_SLOPE_MAXHGT does convey what it refers to. Specifically its height (not altitude) and its above (but not below) the altitude slope, which triggers the recalculation.
There was a problem hiding this comment.
It does make sense, I agree. Is there anything else in the display name or description that you think should be changed?
| // @Param: GLIDE_SLOPE_MIN | ||
| // @DisplayName: Glide slope minimum | ||
| // @Description: This controls the minimum altitude change for a waypoint before a glide slope will be used instead of an immediate altitude change. The default value is 15 meters, which helps to smooth out waypoint missions where small altitude changes happen near waypoints. If you don't want glide slopes to be used in missions then you can set this to zero, which will disable glide slope calculations. Otherwise you can set it to a minimum number of meters of altitude error to the destination waypoint before a glide slope will be used to change altitude. | ||
| // @Param: ALT_SLOPE_MIN |
There was a problem hiding this comment.
Sure but if you read the description, the word "slope" appears multiple times as it describes what the functionality is - altitude slope calculations.
| // @Param: GLIDE_SLOPE_THR | ||
| // @DisplayName: Glide slope threshold | ||
| // @Description: This controls the height above the glide slope the plane may be before rebuilding a glide slope. This is useful for smoothing out an autotakeoff | ||
| // @Param: ALT_SLOPE_THRESH |
There was a problem hiding this comment.
definitely not ALT_ERROR_THRESH that could mean any ALT error that has nothing to do with this slope functionality. IMO it would be confusing.
| // @Param: GLIDE_SLOPE_THR | ||
| // @DisplayName: Glide slope threshold | ||
| // @Description: This controls the height above the glide slope the plane may be before rebuilding a glide slope. This is useful for smoothing out an autotakeoff | ||
| // @Param: ALT_SLOPE_THRESH |
| // @Param: GLIDE_SLOPE_MIN | ||
| // @DisplayName: Glide slope minimum | ||
| // @Description: This controls the minimum altitude change for a waypoint before a glide slope will be used instead of an immediate altitude change. The default value is 15 meters, which helps to smooth out waypoint missions where small altitude changes happen near waypoints. If you don't want glide slopes to be used in missions then you can set this to zero, which will disable glide slope calculations. Otherwise you can set it to a minimum number of meters of altitude error to the destination waypoint before a glide slope will be used to change altitude. | ||
| // @Param: ALT_SLOPE_MIN |
| // @Param: GLIDE_SLOPE_THR | ||
| // @DisplayName: Glide slope threshold | ||
| // @Description: This controls the height above the glide slope the plane may be before rebuilding a glide slope. This is useful for smoothing out an autotakeoff | ||
| // @Param: ALT_SLOPE_THRESH |
There was a problem hiding this comment.
Perhaps, but I think ALT_SLOPE_MAXHGT does convey what it refers to. Specifically its height (not altitude) and its above (but not below) the altitude slope, which triggers the recalculation.
Adjust slope terminology
Description
Tools/SITL/autotest/Plane: Change glide slope to altitude slope:
Smooth altitude changes were always referred to as "glide slopes" despite this not being the appropriate aviation term in the case of a climb. A better option is "altitude slope", which encompasses both smooth climbs and descents.
Changed all references to glide slopes, except those that specifically refer to a single kind (like those used for landings), to the more general term. This also includes changing the GLIDE_SLOPE_MIN and GLIDE_SLOPE_THR parameters to ALT_SLOPE_MIN and ALT_SLOPE_THRESH, respectively.
This PR is related to #29077