freq

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Jun 14, 2024 License: BSD-2-Clause Imports: 18 Imported by: 0

Documentation

Overview

Package freq implements a command to calculate pixel frequencies from a simulation or inference output.

Index

Constants

This section is empty.

Variables

View Source
var Command = &command.Command{
	Usage: `freq [--kde <value>] [--cpu <number>]
	-i|--input <file> [-o|--output <file>] <project-file>`,
	Short: "calculate pixel frequencies",
	Long: `
Command freq reads a file from a the command sim or the command infer with the
particles simulated or inferred from the simulated data, and produces an
equivalent file with pixel frequencies.

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

The flag --input, or -i, is required and indicates the input file.

By default, it return the particle frequencies. If the flag --kde is defined,
a kernel density estimation using a spherical normal will be used to smooth
the results with the indicated concentration parameter (in 1/radians^2). As
calculating the KDE can be computationally expensive, this procedure is run in
parallel using all available processors. Use the flag --cpu to change the
number of processors.

By default, the output file will have the name of the input file with the
prefix "freq" or "kde" if the --kde flag is used. With the flag --output, or
-o, a different file name can be defined.
	`,
	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