Documentation ¶
Overview ¶
Package tzf is a package convert (lng,lat) to timezone.
Inspired by timezonefinder https://github.com/jannikmi/timezonefinder, fast python package for finding the timezone of any point on earth (coordinates) offline.
Index ¶
- Variables
- func SetDropPBTZ(opt *Option)
- type DefaultFinder
- type F
- func NewDefaultFinder() (F, error)
- func NewFinderFromCompressed(input *pb.CompressedTimezones, opts ...OptionFunc) (F, error)
- func NewFinderFromPB(input *pb.Timezones, opts ...OptionFunc) (F, error)
- func NewFinderFromRawJSON(input *convert.BoundaryFile, opts ...OptionFunc) (F, error)
- func NewFuzzyFinderFromPB(input *pb.PreindexTimezones) (F, error)
- type Finder
- func (f *Finder) DataVersion() string
- func (f *Finder) GetTimezoneName(lng float64, lat float64) string
- func (f *Finder) GetTimezoneName2(lng, lat float64) string
- func (f *Finder) GetTimezoneNames(lng float64, lat float64) ([]string, error)
- func (f *Finder) IsKoreaTimezone(lng float64, lat float64) bool
- func (f *Finder) TimezoneNames() []string
- type FuzzyFinder
- type Option
- type OptionFunc
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var ErrNoTimezoneFound = errors.New("tzf: no timezone found")
Functions ¶
func SetDropPBTZ ¶
func SetDropPBTZ(opt *Option)
SetDropPBTZ will make Finder not save github.com/Alfex4936/tzf/pb.Timezone in memory
Types ¶
type DefaultFinder ¶
type DefaultFinder struct {
// contains filtered or unexported fields
}
DefaultFinder is a finder impl combine both FuzzyFinder and Finder.
It's designed for performance first and allow some not so correct return at some area.
func (*DefaultFinder) DataVersion ¶
func (f *DefaultFinder) DataVersion() string
func (*DefaultFinder) GetTimezoneName ¶
func (f *DefaultFinder) GetTimezoneName(lng float64, lat float64) string
Optimized GetTimezoneName considers initial direct lookups before falling back to concurrent offset checks
Example ¶
package main import ( "fmt" "github.com/Alfex4936/tzf" ) func main() { finder, err := tzf.NewDefaultFinder() if err != nil { panic(err) } fmt.Println(finder.GetTimezoneName(116.6386, 40.0786)) }
Output: Asia/Shanghai
func (*DefaultFinder) GetTimezoneNames ¶
func (f *DefaultFinder) GetTimezoneNames(lng float64, lat float64) ([]string, error)
Example ¶
package main import ( "fmt" "github.com/Alfex4936/tzf" ) func main() { finder, err := tzf.NewDefaultFinder() if err != nil { panic(err) } fmt.Println(finder.GetTimezoneNames(87.6168, 43.8254)) }
Output: [Asia/Shanghai Asia/Urumqi] <nil>
func (*DefaultFinder) TimezoneNames ¶
func (f *DefaultFinder) TimezoneNames() []string
Example ¶
package main import ( "fmt" "github.com/Alfex4936/tzf" ) func main() { finder, err := tzf.NewDefaultFinder() if err != nil { panic(err) } fmt.Println(finder.TimezoneNames()) }
Output:
type F ¶
type F interface { GetTimezoneName(lng float64, lat float64) string GetTimezoneNames(lng float64, lat float64) ([]string, error) TimezoneNames() []string DataVersion() string }
func NewDefaultFinder ¶
func NewFinderFromCompressed ¶
func NewFinderFromCompressed(input *pb.CompressedTimezones, opts ...OptionFunc) (F, error)
func NewFinderFromPB ¶
func NewFinderFromPB(input *pb.Timezones, opts ...OptionFunc) (F, error)
func NewFinderFromRawJSON ¶
func NewFinderFromRawJSON(input *convert.BoundaryFile, opts ...OptionFunc) (F, error)
func NewFuzzyFinderFromPB ¶
func NewFuzzyFinderFromPB(input *pb.PreindexTimezones) (F, error)
type Finder ¶
type Finder struct {
// contains filtered or unexported fields
}
Finder is based on point-in-polygon search algo.
Memory will use about 100MB if lite data and 1G if full data. Performance is very stable and very accuate.
func (*Finder) DataVersion ¶
func (*Finder) GetTimezoneName ¶
GetTimezoneName will use alphabet order and return first matched result.
Example ¶
package main import ( "fmt" "github.com/Alfex4936/tzf" "github.com/Alfex4936/tzf/pb" tzfrellite "github.com/ringsaturn/tzf-rel-lite" "google.golang.org/protobuf/proto" ) func main() { input := &pb.Timezones{} if err := proto.Unmarshal(tzfrellite.LiteData, input); err != nil { panic(err) } finder, _ := tzf.NewFinderFromPB(input) fmt.Println(finder.GetTimezoneName(116.6386, 40.0786)) }
Output: Asia/Shanghai
func (*Finder) GetTimezoneName2 ¶ added in v1.0.4
func (*Finder) GetTimezoneNames ¶
Example ¶
package main import ( "fmt" "github.com/Alfex4936/tzf" "github.com/Alfex4936/tzf/pb" tzfrellite "github.com/ringsaturn/tzf-rel-lite" "google.golang.org/protobuf/proto" ) func main() { input := &pb.Timezones{} if err := proto.Unmarshal(tzfrellite.LiteData, input); err != nil { panic(err) } finder, _ := tzf.NewFinderFromPB(input) fmt.Println(finder.GetTimezoneNames(87.6168, 43.8254)) }
Output: [Asia/Shanghai Asia/Urumqi] <nil>
func (*Finder) IsKoreaTimezone ¶ added in v1.0.6
IsKoreaTimezone will check if the point is in the timezone of South Korea. (Asia/Seoul)
func (*Finder) TimezoneNames ¶
type FuzzyFinder ¶
type FuzzyFinder struct {
// contains filtered or unexported fields
}
FuzzyFinder use a tile map to store timezone name. Data are made by github.com/Alfex4936/tzf/cmd/preindextzpb which powerd by github.com/Alfex4936/tzf/preindex.PreIndexTimezones.
func (*FuzzyFinder) DataVersion ¶
func (f *FuzzyFinder) DataVersion() string
func (*FuzzyFinder) GetTimezoneName ¶
func (f *FuzzyFinder) GetTimezoneName(lng float64, lat float64) string
Example ¶
package main import ( "fmt" "github.com/Alfex4936/tzf" "github.com/Alfex4936/tzf/pb" tzfrellite "github.com/ringsaturn/tzf-rel-lite" "google.golang.org/protobuf/proto" ) func main() { input := &pb.PreindexTimezones{} if err := proto.Unmarshal(tzfrellite.PreindexData, input); err != nil { panic(err) } finder, _ := tzf.NewFuzzyFinderFromPB(input) fmt.Println(finder.GetTimezoneName(116.6386, 40.0786)) }
Output: Asia/Shanghai
func (*FuzzyFinder) GetTimezoneNames ¶
func (f *FuzzyFinder) GetTimezoneNames(lng float64, lat float64) ([]string, error)
Example ¶
package main import ( "fmt" "github.com/Alfex4936/tzf" "github.com/Alfex4936/tzf/pb" tzfrellite "github.com/ringsaturn/tzf-rel-lite" "google.golang.org/protobuf/proto" ) func main() { input := &pb.PreindexTimezones{} if err := proto.Unmarshal(tzfrellite.PreindexData, input); err != nil { panic(err) } finder, _ := tzf.NewFuzzyFinderFromPB(input) fmt.Println(finder.GetTimezoneNames(87.6168, 43.8254)) }
Output: [Asia/Shanghai Asia/Urumqi] <nil>
func (*FuzzyFinder) TimezoneNames ¶
func (f *FuzzyFinder) TimezoneNames() []string
Example ¶
package main import ( "fmt" "github.com/Alfex4936/tzf" "github.com/Alfex4936/tzf/pb" tzfrellite "github.com/ringsaturn/tzf-rel-lite" "google.golang.org/protobuf/proto" ) func main() { input := &pb.PreindexTimezones{} if err := proto.Unmarshal(tzfrellite.PreindexData, input); err != nil { panic(err) } finder, _ := tzf.NewFuzzyFinderFromPB(input) fmt.Println(finder.TimezoneNames()) }
Output:
type OptionFunc ¶
type OptionFunc = func(opt *Option)
Directories ¶
Path | Synopsis |
---|---|
cmd
|
|
compresstzpb
CLI tool to reduce polygon filesize
|
CLI tool to reduce polygon filesize |
geojson2tzpb
CLI tool to convert GeoJSON based Timezone boundary to tzf's Probuf format.
|
CLI tool to convert GeoJSON based Timezone boundary to tzf's Probuf format. |
preindextzpb
CLI tool to preindex timezone shape.
|
CLI tool to preindex timezone shape. |
reducetzpb
CLI tool to reduce polygon filesize
|
CLI tool to reduce polygon filesize |
tzf
tzf-cli tool for local query.
|
tzf-cli tool for local query. |
Package preindex
|
Package preindex |
Package reduce could reduce Polygon size both polygon lines and float precise.
|
Package reduce could reduce Polygon size both polygon lines and float precise. |