kde

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 13, 2025 License: BSD-2-Clause Imports: 14 Imported by: 0

Documentation

Overview

Package kde implements a command to estimate the range distributions using a kernel density estimator.

Index

Constants

This section is empty.

Variables

View Source
var Command = &command.Command{
	Usage: `kde [--lambda <value>] [--bound <value>]
	[-f|--file <file>] <project-file> [<taxon-list>]`,
	Short: "estimate geographic ranges using a KDE",
	Long: `
Command kde reads the point locations from a PhyGeo project and produces new
range maps using a kernel density estimation based on a spherical normal. It
will only add taxa without a defined range map.

The argument of the command is the name of the project file.

By default, all taxa with ranges defined as points will be transformed, but if
a file with taxon names is given as a second argument, only the taxa in that
file will be updated. The format of the file is a single name per line, while
ignoring empty lines and lines starting with '#' .
	
The flag --lambda defines the concentration parameter of the spherical normal
(equivalent to the kappa parameter in the von Mises-Fisher distribution) in
1/radians^2 units. If no value is defined, it will use the 1/size^2 of a pixel
in the pixelation used for the project.
	
By default, only the pixel at 0.95 of the spherical normal CDF will be used.
Use the flag --bound to set the bound of the normal CDF.
	
By default, the range maps will be stored in the range file currently defined
for the project. A different file name can be defined with the flag --file or
-f. If this flag is used a new file will be created and used as the range file
of the project (previously defined ranges will be kept).
	`,
	SetFlags: setFlags,
	Run:      run,
}

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL