DocumentFileEntropy Property

Shannon entropy calculated from the document's raw bytes.

Definition

Namespace: OpenDiscoverSDK.Interfaces.Platform
Assembly: OpenDiscoverSDK.Interfaces (in OpenDiscoverSDK.Interfaces.dll) Version: 2026.2.6.0 (2026.02.06)
C#
[DataMemberAttribute]
public double? FileEntropy { get; set; }

Property Value

NullableDouble

Remarks

This property is only calculated if property DocumentTaskSettings.Hashing.CalculateFileEntropy is true.

An important detection method for detecting compressed and encrypted files is the randomness of the bytes in the file. Values of this property that approach the upper limit of 8.0 are very random (with 8.0 being completely random).

See Also