Package org.hortonmachine.gears.utils.coverage

Class ProfilePoint

java.lang.Object

org.hortonmachine.gears.utils.coverage.ProfilePoint

All Implemented Interfaces:

Comparable<ProfilePoint>

public class ProfilePoint
extends Object
implements Comparable<ProfilePoint>

A point representing a position in a raster profile.

The point is sortable by its progressive value.

Note that two ProfilePoints are meant to be equal if the position and elevation are. This can be used to find touch points of two different profiles.

The sort order of the ProfilePoint is handled only through its progressive value.

Author:

Andrea Antonello (www.hydrologis.com)

Constructor Summary

Constructors

Constructor	Description
ProfilePoint(double progressive, double elevation, double easting, double northing)
ProfilePoint(double progressive, double elevation, org.locationtech.jts.geom.Coordinate position)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ProfilePoint o)
boolean	equals(Object obj)
double	getElevation()
static double[]	getLastVisiblePointData(List<ProfilePoint> profile)	Return last visible point data for a profile points list.
static double	getMeanSlope(List<ProfilePoint> points)	Calculates the mean slope of a given set of profilepoints.
org.locationtech.jts.geom.Coordinate	getPosition()
double	getProgressive()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProfilePoint

public ProfilePoint(double progressive,
                    double elevation,
                    org.locationtech.jts.geom.Coordinate position)

ProfilePoint

public ProfilePoint(double progressive,
                    double elevation,
                    double easting,
                    double northing)

Method Detail

getProgressive

public double getProgressive()

getElevation

public double getElevation()

getPosition

public org.locationtech.jts.geom.Coordinate getPosition()

getMeanSlope

public static double getMeanSlope(List<ProfilePoint> points)

Calculates the mean slope of a given set of profilepoints.

Parameters:

points - the points of the profile.

Returns:

the mean slope.

getLastVisiblePointData

public static double[] getLastVisiblePointData(List<ProfilePoint> profile)

Return last visible point data for a profile points list.

For the profile the min and max angles of "sight" are calculated. The min azimuth angle represents the "upper" line of sight, as thoght from the zenith.

The max azimuth angle represents the "below the earth" line of sight (think of a viewer looking in direction nadir).

The return values are in an array of doubles containing:

• [0] min point elev,
• [1] min point x,
• [2] min point y,
• [3] min point progressive,
• [4] min point azimuth,
• [5] max point elev,
• [6] max point x,
• [7] max point y,
• [8] max point progressive,
• [9] max point azimuth

Parameters:

profile - the profile to analize.

Returns:

the last visible point parameters.

compareTo

public int compareTo(ProfilePoint o)

Specified by:

compareTo in interface Comparable<ProfilePoint>

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object