Skip to main content

ValueDescriptor

Describes a single column in the export schema — its name, data source, kind, and how to retrieve the value.

Namespace: MZpack.NT8.Algo

Properties

PropertyTypeDefaultDescription
NamestringColumn name (used in CSV header)
IndValueIndValueNoneBuilt-in indicator value type
IndexintSub-index for multi-value descriptors (e.g., order book level)
KindValueKindFeatureColumn kind: Feature, Label, or Internal
IsManybooltrue if the descriptor produces multiple values per bar
SourceValueSorceIndicatorHow the value is obtained
SourceNamestringFor DataSet source: name of the column to reference
SourceColumnint−1For DataSet source: resolved column index
ColumnintPosition in the schema's descriptor list
Shiftint0Historical shift (0 = current bar)
ChartObjectDescriptorChartObjectDescriptorFor DrawingObject source: mapping descriptor

Delegate Properties

PropertyTypeDescription
GetValueGetExportValueDelegateRetrieve a single value from indicator data
GetValuesGetExportValuesDelegateRetrieve multiple values from indicator data
CalculateValueCalculateExportValueDelegateCalculate a single value from custom logic
CalculateValuesCalculateExportValuesDelegateCalculate multiple values from custom logic

Delegates

Single-Value Delegates

public delegate double GetExportValueDelegate(
GeneralExport export, ValueDescriptor desc, object data);

public delegate double CalculateExportValueDelegate(
GeneralExport export, ValueDescriptor desc, object data);

Multi-Value Delegates

public delegate List<double> GetExportValuesDelegate(
GeneralExport export, ValueDescriptor desc, object data);

public delegate List<double> CalculateExportValuesDelegate(
GeneralExport export, ValueDescriptor desc, object data);

GetExportValueDelegate / GetExportValuesDelegate are set automatically by ExportedIndicator.SetExportValueHandler() when the source is Indicator. CalculateExportValueDelegate / CalculateExportValuesDelegate are user-provided when the source is Calculate.

ValueKind Enum

ValueDescription
FeatureInput/feature column (exported before labels in CSV)
LabelLabel/target column (exported after features in CSV)
InternalInternal column (not exported, used for intermediate calculations)

ValueSorce Enum

note

The enum name contains a typo (ValueSorce instead of ValueSource) in the source code.

ValueDescription
IndicatorValue retrieved from an indicator via GetValue/GetValues delegates
DrawingObjectValue mapped from a chart drawing object via ChartObjectDescriptor
CalculateValue computed by a user-provided CalculateValue/CalculateValues delegate
DataSetValue referenced from another column in the same DataSet

IndValue Enum

Built-in indicator value identifiers. Used to specify which indicator metric to export.

Bar Values

ValueDescription
OpenBar open price
CloseBar close price
HighBar high price
LowBar low price
RangeTicksBar range in ticks
RangeLevelsNumber of price levels in bar
SideBar side (buy/sell)
DurationMsBar duration in milliseconds

Order Flow — Single Values

ValueDescription
VolumeTotal bar volume
BuyVolumeBuy (ask) volume
SellVolumeSell (bid) volume
DeltaDelta (BuyVolume − SellVolume)
DeltaPercentageDelta as percentage of volume
DeltaChangeDelta change from prior bar
DeltaCumulativeCumulative delta
DeltaRateDelta rate
DeltaRateHighDelta rate high
DeltaRateLowDelta rate low
MinDeltaMinimum delta in bar
MaxDeltaMaximum delta in bar
AbsoluteDeltaAverageAverage absolute delta
AbsoluteDeltaTotalTotal absolute delta
BuyPercentageBuy percentage
SellPercentageSell percentage
TradesNumberNumber of trades
VolumePerSecondVolume per second
RatioNumbersRatio numbers

Order Flow — Multi-Value (per price level)

ValueDescription
VolumesVolume at each price level
BidsBid volume at each level
AsksAsk volume at each level
DeltasDelta at each level
TradesNumbersTrade count at each level
TicksTick data at each level

Profile & Session

ValueDescription
POCPoint of Control price
POCVolumeVolume at POC
VAHValue Area High
VALValue Area Low
VWAPVolume Weighted Average Price
_1StdDeviationPos+1 standard deviation
_1StdDeviationNeg−1 standard deviation
_2StdDeviationPos+2 standard deviation
_2StdDeviationNeg−2 standard deviation
IBHighInitial Balance High
IBLowInitial Balance Low
MIDMid price
TPO_POCTPO Point of Control
TPO_VAHTPO Value Area High
TPO_VALTPO Value Area Low
TPOLettersCountTPO letter count
BuyPOCVolumeBuy POC volume
SellPOCVolumeSell POC volume
TickPOCTick POC
TickPOCVolumeTick POC volume
VAVolumeValue Area volume
SessionOpenSession open price
SessionCloseSession close price
SessionHighSession high
SessionLowSession low
SessionVAHSession Value Area High
SessionVALSession Value Area Low
SessionPOCSession POC

Imbalance & Absorption

ValueDescription
BuyImbalanceCountBuy imbalance count
SellImbalanceCountSell imbalance count
BuyAbsorptionCountBuy absorption count
SellAbsorptionCountSell absorption count
BuyStackedImbalanceCountStacked buy imbalance count
SellStackedImbalanceCountStacked sell imbalance count
BuyStackedAbsorptionCountStacked buy absorption count
SellStackedAbsorptionCountStacked sell absorption count
BuyStackedImbalanceMaxConsecMax consecutive buy stacked imbalances
SellStackedImbalanceMaxConsecMax consecutive sell stacked imbalances
BuyStackedAbsorptionMaxConsecMax consecutive buy stacked absorptions
SellStackedAbsorptionMaxConsecMax consecutive sell stacked absorptions
UnfinishedAuctionHighUnfinished auction at high
UnfinishedAuctionLowUnfinished auction at low
COTHighCOT high
COTLowCOT low

Big Trade

ValueDescription
IcebergVolumeIceberg volume
TicksNumberNumber of ticks
DomPressureVolumeDOM pressure volume
DomSupportVolumeDOM support volume
SmartSmart order flag

Market Depth

ValueDescription
MarketDepthMarket depth snapshot
RealMarketDepthReal market depth
RealtimeBidReal-time best bid volume
RealtimeOfferReal-time best offer volume
RealtimeBidPriceReal-time best bid price
RealtimeOfferPriceReal-time best offer price
RealtimeBidsReal-time bid levels (multi-value)
RealtimeOffersReal-time offer levels (multi-value)
RealtimeBidsWithPricesBid levels with prices (multi-value)
RealtimeOffersWithPricesOffer levels with prices (multi-value)
RealtimeOffersTotalTotal offer volume
RealtimeBidsTotalTotal bid volume
BestBidBest bid
BestOfferBest offer

Divergence & Other

ValueDescription
DeltaDivergenceDelta divergence value
HQAHQA value
UQUQ value
ACAC value
UpdatesNumberNumber of updates

Liquidity

ValueDescription
LiquidityOpenLiquidity open
LiquidityCloseLiquidity close
LiquidityHighLiquidity high
LiquidityLowLiquidity low
LiquidityMigrationOpenLiquidity migration open
LiquidityMigrationCloseLiquidity migration close
LiquidityMigrationHighLiquidity migration high
LiquidityMigrationLowLiquidity migration low