igc

type CirclingType ¶ added in v0.3.0

type CirclingType int

CirclingType indicates Left, Right or Mixed circling.

const (
	Mixed CirclingType = 0
	Left  CirclingType = 1
	Right CirclingType = 2
)

type Crawler ¶ added in v0.4.0

type Crawler interface {
	Crawl(time.Time, time.Time) ([]Flight, error)
}

type Event ¶

type Event struct {
	Time time.Time
	Type string
	Data string
}

Event holds data records triggered at a given time.

This is the E record in the IGC specification, section A4.2. The events can be pilot initiated (with a PEV code), proximity alerts, etc.

type Flight ¶ added in v0.4.0

type Flight struct {
	URL            string
	ID             string
	Pilot          string
	Club           string
	Date           time.Time
	Takeoff        string
	Region         string
	Country        string
	Distance       float64
	Points         float64
	Glider         string
	Type           string
	TrackURL       string
	TrackID        string
	CompetitionID  string
	CompetitionURL string
	Speed          float64
	Comments       string
}

Flight represents a flight submission in an online competition.

It includes all the flight metadata available in the online competition, including computed data like speed or distance. It also includes a url to the flight track file (usually in IGC format).

type FlightID ¶ added in v0.4.0

type FlightID string

type Header ¶

type Header struct {
	Manufacturer      string
	UniqueID          string
	AdditionalData    string
	Date              time.Time
	Site              string
	FixAccuracy       int64
	Pilot             string
	PilotBirth        time.Time
	Crew              string
	GliderType        string
	GliderID          string
	Observation       string
	GPSDatum          string
	FirmwareVersion   string
	HardwareVersion   string
	SoftwareVersion   string // for non-igc flight recorders
	Specification     string
	FlightRecorder    string
	GPS               string
	GNSSModel         string
	PressureModel     string
	PressureSensor    string
	AltimeterPressure float64
	CompetitionID     string
	CompetitionClass  string
	Timezone          int
	MOPSensor         string
}

Header holds the meta information of a track.

This is the H record in the IGC specification, section A3.2.

type K ¶

type K struct {
	Time   time.Time
	Fields map[string]string
}

K holds flight data needed less often than Points.

This is the K record in the IGC specification, section A4.4. Fields is a map between a given content type and its value, with the possible content types being defined in the J record.

Examples of content types include heading true (HDT) or magnetic (HDM), airspeed (IAS), etc.

type Manufacturer ¶

type Manufacturer struct {
	// contains filtered or unexported fields
}

Manufacturer holds manufacturer name, short ID and char identifier.

The list of manufacturers is defined in the IGC specification, section A2.5.6. A map Manufacturers is available in this library.

type Optimizer ¶

type Optimizer interface {
	Optimize(track Track, nPoints int, score Score) (Task, error)
}

Optimizer returns an optimal Task for the given turnpoints and Score function.

Available score functions include MaxDistance and MaxPoints, but it is possible to pass the Optimizer a custom function.

Optimizers might not support a high number of turnpoints. As an example, the BruteForceOptimizer does not perform well with nPoints > 2, and might decide to return an error instead of attempting to finalize the optimization indefinitely.

func NewBruteForceOptimizer(cache bool) Optimizer

type Phase ¶ added in v0.3.0

type Phase struct {
	Type         PhaseType
	CirclingType CirclingType
	Start        Point
	StartIndex   int
	End          Point
	EndIndex     int
	AvgVario     float64
	TopVario     float64
	AvgGndSpeed  float64
	TopGndSpeed  float64
	Distance     float64
	LD           float64
	Centroid     s2.LatLng
	CellID       s2.CellID
}

Phase is a flight phase (towing, cruising, circling).

func (p *Phase) Duration() time.Duration

type PhaseType ¶ added in v0.3.0

type PhaseType int

PhaseType represents a flight phase.

Possible values include Towing, PossibleCruising/Cruising, PossibleCircling/Circling, Unknown.

const (
	Unknown          PhaseType = 0
	Towing           PhaseType = 1
	PossibleCruising PhaseType = 2
	Cruising         PhaseType = 3
	PossibleCircling PhaseType = 4
	Circling         PhaseType = 5
)

type Point ¶

type Point struct {
	s2.LatLng
	Time             time.Time
	FixValidity      byte
	PressureAltitude int64
	GNSSAltitude     int64
	IData            map[string]string
	NumSatellites    int
	Description      string
	// contains filtered or unexported fields
}

Point represents a GPS recording (single point in the track).

It is based on a golang-geo s2 LatLng, adding extra metadata such as the Time the point was recorded, pressure and GNSS altitude, number of satellites available and extra metadata added by the recorder.

You can use all methods available for a s2.LatLng on this struct.

func NewPoint() Point

func NewPointFromDMD(lat string, lng string) Point

func NewPointFromDMS(lat string, lng string) Point

func NewPointFromLatLng(lat float64, lng float64) Point

func (p *Point) Bearing(b Point) s1.Angle

func (p *Point) Distance(b Point) float64

func (p *Point) Speed(b Point) float64

type Satellite ¶

type Satellite struct {
	Time time.Time
	Ids  []string
}

Satellite holds the IDs of the available satellites at a given Time.

This is the F record in the IGC specification, section A4.3.

type Score ¶

type Score func(task Task) float64

Score functions calculate a score for the given Task.

The main use of these functions is in passing them to the Optimizers, so they can evaluate each Task towards different goals.

Example functions include the total distance between all turn points or an online competition (netcoupe, online contest) score which takes additional metrics of each leg into account.

type Task ¶

type Task struct {
	DeclarationDate time.Time
	Date            time.Time
	Number          int
	Takeoff         Point
	Start           Point
	Turnpoints      []Point
	Finish          Point
	Landing         Point
	Description     string
}

Task holds all the metadata put in a pre-declared task to be performed.

This is the C record in the IGC specification, section A3.5.

func (task *Task) Distance() float64

type Track ¶

type Track struct {
	Header
	ID            string
	Points        []Point
	K             []K
	Events        []Event
	Satellites    []Satellite
	Logbook       []string
	Task          Task
	DGPSStationID string
	Signature     string
	// contains filtered or unexported fields
}

Track holds all IGC flight data (header and GPS points).

func NewTrack() Track

func Parse(content string) (Track, error)

func ParseClean(content string) (Track, error)

func ParseCleanLocation(location string) (Track, error)

func ParseLocation(location string) (Track, error)

func (track *Track) Cleanup() (Track, error)

func (track *Track) Encode(format string) ([]byte, error)

func (track *Track) EncodePhases(format string) ([]byte, error)

func (track *Track) Phases() ([]Phase, error)

func (track *Track) Simplify(tolerance float64) (Track, error)