Class Generate

Namespace

ScottPlot

Assembly

ScottPlot.dll

This class contains methods which generate sample data for testing and demonstration purposes

public static class Generate

Inheritance

object

Generate

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Fields

RandomWalker

public static readonly RandomWalker RandomWalker

Field Value

RandomWalker

Properties

Financial

public static FinancialDataGenerator Financial { get; }

Property Value

FinancialDataGenerator

RandomData

public static RandomDataGenerator RandomData { get; }

Property Value

RandomDataGenerator

Methods

AddNoise(double[], double)

Return a copy of the given array with random values added to each point

public static double[] AddNoise(double[] input, double magnitude = 1)

Parameters

input double[]

magnitude double

Returns

double[]

AddNoiseInPlace(double[], double)

Mutate the given array by adding a random value to each point

public static void AddNoiseInPlace(double[] values, double magnitude = 1)

Parameters

values double[]

magnitude double

AddSin(double[], double, double, double, double)

Return a new array containing the given one plus a sine wave with the given parameters

public static double[] AddSin(double[] values, double mult = 1, double offset = 0, double oscillations = 1, double phase = 0)

Parameters

values double[]

mult double

offset double

oscillations double

phase double

Returns

double[]

AddSinInPlace(double[], double, double, double, double)

Modify the array to add a sine wave with the given parameters

public static double[] AddSinInPlace(double[] values, double mult = 1, double offset = 0, double oscillations = 1, double phase = 0)

Parameters

values double[]

mult double

offset double

oscillations double

phase double

Returns

double[]

Consecutive(int, DateTime, TimeSpan)

public static DateTime[] Consecutive(int count, DateTime start, TimeSpan timeSpan)

Parameters

count int

start DateTime

timeSpan TimeSpan

Returns

DateTime[]

Consecutive(int, DateTimeOffset, TimeSpan)

public static DateTimeOffset[] Consecutive(int count, DateTimeOffset start, TimeSpan timeSpan)

Parameters

count int

start DateTimeOffset

timeSpan TimeSpan

Returns

DateTimeOffset[]

Consecutive(int, double, double)

Return an array of evenly-spaced numbers

public static double[] Consecutive(int count = 51, double delta = 1, double first = 0)

Parameters

count int

delta double

first double

Returns

double[]

Consecutive2D(int, int, double, double)

Generates a 2D array of numbers with constant spacing.

public static double[,] Consecutive2D(int rows, int columns, double spacing = 1, double offset = 0)

Parameters

rows int

columns int

spacing double

The space between points.

offset double

The first point.

Returns

double[,]

ConsecutiveDateTimes(int, DateTime, TimeSpan)

public static DateTime[] ConsecutiveDateTimes(int count, DateTime start, TimeSpan timeSpan)

Parameters

count int

start DateTime

timeSpan TimeSpan

Returns

DateTime[]

ConsecutiveDateTimes(int, DateTimeOffset, TimeSpan)

public static DateTimeOffset[] ConsecutiveDateTimes(int count, DateTimeOffset start, TimeSpan timeSpan)

Parameters

count int

start DateTimeOffset

timeSpan TimeSpan

Returns

DateTimeOffset[]

ConsecutiveDays(int, DateTime)

public static DateTime[] ConsecutiveDays(int count, DateTime start)

Parameters

count int

start DateTime

Returns

DateTime[]

ConsecutiveDays(int, DateTimeOffset)

public static DateTimeOffset[] ConsecutiveDays(int count, DateTimeOffset start)

Parameters

count int

start DateTimeOffset

Returns

DateTimeOffset[]

ConsecutiveDays(int, int, int, int)

public static DateTime[] ConsecutiveDays(int count, int year = 2023, int month = 1, int day = 1)

Parameters

count int

year int

month int

day int

Returns

DateTime[]

ConsecutiveHours(int)

public static DateTime[] ConsecutiveHours(int count)

Parameters

count int

Returns

DateTime[]

ConsecutiveHours(int, DateTime)

public static DateTime[] ConsecutiveHours(int count, DateTime start)

Parameters

count int

start DateTime

Returns

DateTime[]

ConsecutiveHours(int, DateTimeOffset)

public static DateTimeOffset[] ConsecutiveHours(int count, DateTimeOffset start)

Parameters

count int

start DateTimeOffset

Returns

DateTimeOffset[]

ConsecutiveMinutes(int, DateTime)

public static DateTime[] ConsecutiveMinutes(int count, DateTime start)

Parameters

count int

start DateTime

Returns

DateTime[]

ConsecutiveMinutes(int, DateTimeOffset)

public static DateTimeOffset[] ConsecutiveMinutes(int count, DateTimeOffset start)

Parameters

count int

start DateTimeOffset

Returns

DateTimeOffset[]

ConsecutiveQuarterHours(int, DateTime)

public static DateTime[] ConsecutiveQuarterHours(int count, DateTime start)

Parameters

count int

start DateTime

Returns

DateTime[]

ConsecutiveQuarterHours(int, DateTimeOffset)

public static DateTimeOffset[] ConsecutiveQuarterHours(int count, DateTimeOffset start)

Parameters

count int

start DateTimeOffset

Returns

DateTimeOffset[]

ConsecutiveSeconds(int, DateTime)

public static DateTime[] ConsecutiveSeconds(int count, DateTime start)

Parameters

count int

start DateTime

Returns

DateTime[]

ConsecutiveSeconds(int, DateTimeOffset)

public static DateTimeOffset[] ConsecutiveSeconds(int count, DateTimeOffset start)

Parameters

count int

start DateTimeOffset

Returns

DateTimeOffset[]

ConsecutiveWeekdays(int, DateTime)

public static DateTime[] ConsecutiveWeekdays(int count, DateTime start)

Parameters

count int

start DateTime

Returns

DateTime[]

ConsecutiveWeekdays(int, DateTimeOffset)

public static DateTimeOffset[] ConsecutiveWeekdays(int count, DateTimeOffset start)

Parameters

count int

start DateTimeOffset

Returns

DateTimeOffset[]

ConsecutiveWeekdays(int, int, int, int)

public static DateTime[] ConsecutiveWeekdays(int count, int year = 2023, int month = 1, int day = 1)

Parameters

count int

year int

month int

day int

Returns

DateTime[]

Cos(int, double, double, double, double)

Return an array of cosine waves between -1 and 1. Values are multiplied by mult then shifted by offset. Phase shifts the sine wave horizontally between 0 and 2 Pi.

public static double[] Cos(int count = 51, double mult = 1, double offset = 0, double oscillations = 1, double phase = 0)

Parameters

count int

mult double

offset double

oscillations double

phase double

Returns

double[]

NaN(int)

public static double[] NaN(int count)

Parameters

count int

Returns

double[]

NoisyExponential(int, double, double, double)

An exponential curve that rises from 0 to mult over count points with random positive noise that scales with the underlying signal. The rate constant of the exponential curve is tau.

public static double[] NoisyExponential(int count, double mult = 1000, double noise = 0.5, double tau = 5)

Parameters

count int

mult double

noise double

tau double

Returns

double[]

NoisySin(int, double)

[Obsolete("use Generate.Sin() then Generate.AddNoise()")]
public static double[] NoisySin(int count = 51, double magnitude = 1)

Parameters

count int

magnitude double

Returns

double[]

Ones(int)

public static double[] Ones(int count)

Parameters

count int

Returns

double[]

Ramp2D(int, int, double, double)

Generate a 2D array in a diagonal gradient pattern

public static double[,] Ramp2D(int width, int height, double min = 0, double max = 1)

Parameters

width int

height int

min double

max double

Returns

double[,]

Random(int, double, double)

[Obsolete("use RandomSample()")]
public static double[] Random(int count, double min = 0, double max = 1)

Parameters

count int

min double

max double

Returns

double[]

RandomAscending(int, double, double)

Sequence of ascending numbers with random spacing between values.

public static double[] RandomAscending(int count, double minDelta = 0, double maxDelta = 1)

Parameters

count int

minDelta double

maxDelta double

Returns

double[]

RandomBox(double)

public static Box RandomBox(double position)

Parameters

position double

Returns

Box

RandomChar()

public static char RandomChar()

Returns

char

RandomColor()

public static Color RandomColor()

Returns

Color

RandomColor(IColormap)

public static Color RandomColor(IColormap colormap)

Parameters

colormap IColormap

Returns

Color

RandomColor(byte)

Generate a dark color by defining the maximum value to use for R, G, and B

public static Color RandomColor(byte max)

Parameters

max byte

Returns

Color

RandomColors(int, IColormap)

public static Color[] RandomColors(int count, IColormap colormap)

Parameters

count int

colormap IColormap

Returns

Color[]

RandomCoordinates(double, double, double, double)

public static Coordinates RandomCoordinates(double xMult = 1, double yMult = 1, double xOffset = 0, double yOffset = 0)

Parameters

xMult double

yMult double

xOffset double

yOffset double

Returns

Coordinates

RandomCoordinates(int, double, double, double, double)

public static Coordinates[] RandomCoordinates(int count, double xMult = 1, double yMult = 1, double xOffset = 0, double yOffset = 0)

Parameters

count int

xMult double

yMult double

xOffset double

yOffset double

Returns

Coordinates[]

RandomHue()

public static Color RandomHue()

Returns

Color

RandomInteger(int)

RandomSample integer between zero (inclusive) and max (exclusive)

public static int RandomInteger(int max)

Parameters

max int

Returns

int

RandomInteger(int, int)

RandomSample integer between min (inclusive) and max (exclusive)

public static int RandomInteger(int min, int max)

Parameters

min int

max int

Returns

int

RandomIntegers(int, int)

RandomSample integers between zero (inclusive) and max (exclusive)

public static int[] RandomIntegers(int count, int max)

Parameters

count int

max int

Returns

int[]

RandomIntegers(int, int, int)

RandomSample integers between min (inclusive) and max (exclusive)

public static int[] RandomIntegers(int count, int min, int max)

Parameters

count int

min int

max int

Returns

int[]

RandomLine()

public static CoordinateLine RandomLine()

Returns

CoordinateLine

RandomLinePattern()

public static LinePattern RandomLinePattern()

Returns

LinePattern

RandomLocation()

public static Coordinates RandomLocation()

Returns

Coordinates

RandomLocation(AxisLimits)

public static Coordinates RandomLocation(AxisLimits limits)

Parameters

limits AxisLimits

Returns

Coordinates

RandomLocations(int)

public static Coordinates[] RandomLocations(int count)

Parameters

count int

Returns

Coordinates[]

RandomLocations(int, AxisLimits)

public static Coordinates[] RandomLocations(int count, AxisLimits limits)

Parameters

count int

limits AxisLimits

Returns

Coordinates[]

RandomMarkerShape()

public static MarkerShape RandomMarkerShape()

Returns

MarkerShape

RandomNormal(int, double, double)

public static double[] RandomNormal(int count, double mean = 0, double stdDev = 1)

Parameters

count int

mean double

stdDev double

Returns

double[]

RandomNormalNumber(double, double)

Return a number normally distributed around the given mean according to the stdDev standard deviation.

public static double RandomNormalNumber(double mean = 0, double stdDev = 1)

Parameters

mean double

stdDev double

Returns

double

RandomNumber()

RandomSample integer between 0 (inclusive) and 1 (exclusive)

public static double RandomNumber()

Returns

double

RandomNumber(double)

RandomSample integer between 0 (inclusive) and max (exclusive)

public static double RandomNumber(double max)

Parameters

max double

Returns

double

RandomNumber(double, double)

RandomSample integer between min (inclusive) and max (exclusive)

public static double RandomNumber(double min, double max)

Parameters

min double

max double

Returns

double

RandomNumbers(int, double)

Random numbers between zero (inclusive) and max (exclusive)

public static double[] RandomNumbers(int count, double max)

Parameters

count int

max double

Returns

double[]

RandomNumbers(int, double, double)

Random numbers between min (inclusive) and max (exclusive)

public static double[] RandomNumbers(int count, double min, double max)

Parameters

count int

min double

max double

Returns

double[]

RandomOHLC()

public static OHLC RandomOHLC()

Returns

OHLC

RandomOHLC(DateTime)

public static OHLC RandomOHLC(DateTime date)

Parameters

date DateTime

Returns

OHLC

RandomOHLCs(int)

public static List<OHLC> RandomOHLCs(int count)

Parameters

count int

Returns

List<OHLC>

RandomOHLCs(int, DateTime)

public static List<OHLC> RandomOHLCs(int count, DateTime startDate)

Parameters

count int

startDate DateTime

Returns

List<OHLC>

RandomSample(int, double, double)

Return an array of count random values from min to max

public static double[] RandomSample(int count, double min = 0, double max = 1)

Parameters

count int

min double

max double

Returns

double[]

RandomString(int)

public static string RandomString(int length)

Parameters

length int

Returns

string

RandomWalk(int, double, double)

Return a series of values starting with offset and each randomly deviating from the previous by at most mult.

public static double[] RandomWalk(int count, double mult = 1, double offset = 0)

Parameters

count int

mult double

offset double

Returns

double[]

Range(double, double, double)

Return values from start to stop (inclusive) separated by step

public static double[] Range(double start, double stop, double step = 1)

Parameters

start double

stop double

step double

Returns

double[]

RangeWithCount(double, double, int)

Return count values from start to stop (inclusive)

public static double[] RangeWithCount(double start, double stop, int count)

Parameters

start double

stop double

count int

Returns

double[]

RangeWithStep(double, double, double)

Return values from start to stop (inclusive) separated by step

public static double[] RangeWithStep(double start, double stop, double step = 1)

Parameters

start double

stop double

step double

Returns

double[]

Repeating(int, double)

public static double[] Repeating(int count, double value)

Parameters

count int

value double

Returns

double[]

SampleVectors(int, int, double)

public static RootedCoordinateVector[] SampleVectors(int columns = 10, int rows = 10, double oscillations = 1)

Parameters

columns int

rows int

oscillations double

Returns

RootedCoordinateVector[]

Sigmoidal(int, double, double)

Return an array for a sigmoidal curve that rises from zero to mult

public static double[] Sigmoidal(int count, double mult = 1, double steepness = 1)

Parameters

count int

mult double

steepness double

Returns

double[]

Sin(int, double, double, double, double)

Return an array of sine waves between -1 and 1. Values are multiplied by mult then shifted by offset. Phase shifts the sine wave horizontally between 0 and 2 Pi.

public static double[] Sin(int count = 51, double mult = 1, double offset = 0, double oscillations = 1, double phase = 0)

Parameters

count int

mult double

offset double

oscillations double

phase double

Returns

double[]

Sin2D(int, int, double, double, double)

Generates a 2D sine pattern.

public static double[,] Sin2D(int width, int height, double xPeriod = 0.2, double yPeriod = 0.2, double multiple = 100)

Parameters

width int

height int

xPeriod double

Frequency factor in x direction.

yPeriod double

Frequency factor in y direction.

multiple double

Intensity factor.

Returns

double[,]

SquareWave(uint, uint, double, double, double)

public static double[] SquareWave(uint cycles = 20, uint pointsPerCycle = 1000, double duty = 0.5, double low = 0, double high = 1)

Parameters

cycles uint

pointsPerCycle uint

duty double

low double

high double

Returns

double[]

SquareWaveFromSines(int, double, int)

Generate a square wave by summing sine waves with decreasing amplitudes at odd harmonics of the fundamental frequency

public static double[] SquareWaveFromSines(int pointCount = 1000, double oscillations = 2, int sineCount = 5)

Parameters

pointCount int

oscillations double

sineCount int

Returns

double[]

Zeros(int)

public static double[] Zeros(int count)

Parameters

count int

Returns

double[]