Outlieraway

This small utility generates a point cloud sample with two components (signal and outliers) and applies an outlier elimination algorithm. Use the -h flag for more information.

Install requirements with pip install -r requirements.txt.

Usage:

usage: outlieraway [-h] [-n NUM_SAMPLES] [-o PERC_OUTLIERS] [-s1 SIGMA_F1] [-s2 SIGMA_F2]
 [-ms MU_SIGNAL] [-mo MU_OUTLIERS] [-ss SIGMA_SIGNAL] [-so SIGMA_OUTLIERS]
 [-sin-amp SIN_AMP] [-sin-phase SIN_PHASE] [-sin-freq SIN_FREQ] [-cos-amp COS_AMP]
 [-cos-phase COS_PHASE] [-cos-freq COS_FREQ] [-slope SLOPE] [-tp TOP_PERCENTAGE]
 [-bp BOTTOM_PERCENTAGE] [-tf TOP_FACTOR] [-bf BOTTOM_FACTOR] [-f FILE]
Outlier elimination and signal/noise simulator.
options:
 -h, --help show this help message and exit
 -n NUM_SAMPLES, --num-samples NUM_SAMPLES
 Total number of samples to create.
 -o PERC_OUTLIERS, --perc-outliers PERC_OUTLIERS
 Percentage of outliers in the sample.
 -s1 SIGMA_F1, --sigma-f1 SIGMA_F1
 The sigma filter factor for the iterative outlier elimination.
 -s2 SIGMA_F2, --sigma-f2 SIGMA_F2
 The sigma filter factor for final sample.
 -ms MU_SIGNAL, --mu-signal MU_SIGNAL
 The mean for the signal samples.
 -mo MU_OUTLIERS, --mu-outliers MU_OUTLIERS
 The mean for the outlier samples.
 -ss SIGMA_SIGNAL, --sigma-signal SIGMA_SIGNAL
 The sigma for the signal samples.
 -so SIGMA_OUTLIERS, --sigma-outliers SIGMA_OUTLIERS
 The sigma for the outlier samples.
 -sin-amp SIN_AMP Amplitude of the sine function to apply to the signal. Set to 0 to disable.
 -sin-phase SIN_PHASE Phase of the sine function to apply to the signal, in radians.
 -sin-freq SIN_FREQ Frequency of the sine function to apply to the signal.
 -cos-amp COS_AMP Amplitude of the cosine function to apply to the signal. Set to 0 to disable.
 -cos-phase COS_PHASE Phase of the cosine function to apply to the signal, in radians.
 -cos-freq COS_FREQ Frequency of the cosine function to apply to the signal.
 -slope SLOPE Slope trend factor. Positive produces an 'uphill' slope, negative produces a
 'downhill' slope.
 -tp TOP_PERCENTAGE, --top-percentage TOP_PERCENTAGE
 Percentage of outliers above the mean to be kept. In [0,1].
 -bp BOTTOM_PERCENTAGE, --bottom-percentage BOTTOM_PERCENTAGE
 Percentage of outliers below the mean to be kept. In [0,1].
 -tf TOP_FACTOR, --top-factor TOP_FACTOR
 Factor to apply to outliers above the mean.
 -bf BOTTOM_FACTOR, --bottom-factor BOTTOM_FACTOR
 Factor to apply to outliers below the mean.
 -f FILE, --file FILE If present, the output is saved to the given file name instead of displayed in
 an interactive plot.