Click or drag to resize

HistogramCreationOptions Class

Options to create histograms.
Inheritance Hierarchy
SystemObject
  Altaxo.Analysis.Statistics.HistogramsHistogramCreationOptions

Namespace: Altaxo.Analysis.Statistics.Histograms
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public class HistogramCreationOptions : ICloneable

The HistogramCreationOptions type exposes the following members.

Constructors
 NameDescription
Public methodHistogramCreationOptionsInitializes a new instance of the HistogramCreationOptions class
Top
Properties
 NameDescription
Public propertyBinning Gets or sets the user defined binning. If this property is defined, the binning defined in this property is used. If this property is null, the binning is done automatically.
Public propertyIgnoreInfinity Gets or sets a value indicating whether to ignore infinite values.
Public propertyIgnoreNaN Gets or sets a value indicating whether to ignore NaN (Not-A-Number) values.
Public propertyIsLowerBoundaryInclusive Designates whether the lower boundary is inclusive. If true, all values less than or equal to LowerBoundaryToIgnore are ignored. If false, only values less than LowerBoundaryToIgnore are ignored.
Public propertyIsUpperBoundaryInclusive Designates whether the upper is boundary inclusive. If true, all values greater than or equal to UpperBoundaryToIgnore are ignored. If false, only values greater than UpperBoundaryToIgnore are ignored.
Public propertyIsUserDefinedBinningType Gets or sets a value indicating whether the binning type is defined by the user or is determined automatically.
Public propertyLowerBoundaryToIgnore If not null, all values less than that value are ignored. Use IsLowerBoundaryInclusive to determine whether this boundary is inclusive or exclusive.
Public propertyUpperBoundaryToIgnore If not null, all values greater than that value are ignored. Use IsUpperBoundaryInclusive to determine whether this boundary is inclusive or exclusive.
Top
Methods
 NameDescription
Public methodCloneCreates a new object that is a copy of the current instance.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetValueExcludingFunction Gets a function that can be used to determine whether a value of a data ensemble should be excluded.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
See Also