TheTechIdea.OilGas.WellLogs
43 public types. Summaries come from the XML documentation of the compiled assembly.
TheTechIdea.OilGas.WellLogs
| Type | Summary |
|---|---|
BondIntervalclass | A contiguous interval of one bond class (depths in the data unit). |
BondQualityenum | Cement bond quality from the bond index: good, partial or poor. |
CblCalibrationclass | CBL calibration for one casing size (amplitudes at the tool's CBL spacing, same unit as the curve, e.g. mV). |
CementBondTracksstatic class | Standard cement-evaluation presentation: CBL amplitude, bond index with good-bond shading, VDL, bond quality. |
CementEvaluationstatic class | Cement bond screening from CBL amplitude: bond index BI = log(A_free / A) / log(A_free / A_100%) (clamped 0-1), classified good / partial / poor, contiguous intervals, and the longest continuous good-bond length — what isolation depends on. Cutoffs and required lengths are operator- and casing-specific; defaults are screening values only. |
CrossplotKindenum | Kinds of crossplot (they decide the axes and overlays). |
CrossplotPanelclass | A crossplot: kind, axes (range, log, direction), points and the overlays of its kind. Built by Crossplots. |
CrossplotPointclass | One crossplot sample: values, depth, zone (from tops) and optional colour value. |
Crossplotsstatic class | Builds crossplots from a depth log set (inputs through the curve-mnemonic vocabulary, as for the computed curves) and their overlays: density-neutron lithology lines (matrix point to fluid point, porosity ticks) and Pickett lines of constant water saturation from Archie (phi = (a Rw / (Rt Sw^n))^(1/m)) with the environment's petrophysics parameters. |
CrossplotViewclass | Host-independent crossplot view: axes (linear or log, density downward), grid, the overlays of the kind, points coloured by zone or by a colour curve, legend, and a hover readout of the nearest point (depth, values, zone). |
CurveEditingstatic class | Depth matching and splicing of display curves (the data-level equivalent is LogSet)). |
CuttingsTrackclass | Percentage lithology (cuttings) track: each sample interval split into horizontal bands proportional to its lithology percentages (shared lithology fills), with an interpreted column showing the dominant lithology. Missing percentage (total below 100) is left blank rather than stretched, so incomplete descriptions stay visible. |
DipReferenceCasesstatic class | Reference case kind "dipSinusoid": the image-log sinusoid of a planar feature (peak-to-trough = diameter x tan(dip), deepest point at the dip azimuth). |
DipTrackclass | Dip tadpole track: head at (dip angle 0-90°, depth), tail pointing in the dip-azimuth direction (north up, clockwise), colour / shape by pick type. Dips are TRUE (geographic) dips. |
FlagIntervalclass | One categorical interval (axis units). |
FlagStyleclass | Display of a flag code. |
FlagTrackclass | Discrete / flag track: categorical intervals (net pay, perforation status, facies, quality flags). Build from intervals or from a discrete curve (String)). Codes without a style are left blank. |
ImageLogDataclass | A borehole image: rows of azimuthal samples (0-360°, first column at the reference azimuth) per depth. |
ImageLogTrackclass | Borehole image track: unrolled image (heated palette, static or dynamic normalization) with sinusoid picks for planar features — depth(φ) = z0 + (D/2)·tan(dip)·cos(φ − dip azimuth), deepest on the down-dip side. Rendered as run-length merged ~2 px cells (no raster APIs; SkiaSharp-4 safe), like the VDL. |
ImageNormalizationenum | Borehole-image normalization: static (whole image) or dynamic (sliding depth window). |
LiveLogFeedclass | Appends live rows to the curves of a log document in place: matched by mnemonic, kept depth-sorted, re-delivered depths ignored (idempotent), nulls skipped, scales optionally expanded, axis extended as the hole deepens, revision touched so a cached scene redraws. Unknown mnemonics become new curves in NewCurveTrack when set, else are reported. |
MudLogTracksstatic class | Mud-log presentation from canonical data: cuttings, gas (TG, C1-C5 log), Haworth ratios, fluid character flags. |
PaySummaryTrackclass | The pay summary as a depth-aligned table: one row per zone between its top and base. |
PressureTrackclass | Formation pressure track: tests plotted as pressure vs depth (styled by quality), fitted fluid gradients and the free-fluid levels at their intersections. Analysis runs in TVD (the document's depth reference), so gradients are true fluid densities even in deviated wells; lines are drawn correctly on MD, TVD and TVDSS axes. |
WaveformSetclass | Full-wave sonic data for VDL display: one waveform per depth, uniform time sampling (µs). |
WaveformTrackclass | Variable-density (VDL) waveform track: time across (µs), depth down; positive amplitude dark, negative light. Drawn with run-length merged rectangles (no raster APIs; resampled to ~2 px cells, 9 grey levels) so it works with SkiaSharp 4 and stays cheap inside the cached scene. |
WellLogCurveclass | Gets or sets the well log curve. |
WellLogCurveSampleclass | Gets or sets the well log curve sample. |
WellLogCurveStyleclass | Gets or sets the well log curve style. |
WellLogCutoffSideenum | Which side of a cutoff value is shaded. |
WellLogDataStandardenum | Data standard a log document came from (for example LAS 2.0). |
WellLogDocumentsstatic class | Stand-alone log documents from canonical data (whatever loader produced it). |
WellLogFillModeenum | How the area around a curve is filled: none, left or right of the curve, between curves, or cutoff shading. |
WellLogLithologyIntervalclass | Gets or sets the well log lithology interval. |
WellLogPointSeriesclass | Discrete measurements drawn as markers in a log track (e.g. core porosity over the neutron / density curves). Depths are data depths; DepthShift (core-to-log) is added when drawing and reading out. |
WellLogPointShapeenum | Marker shape for point series such as core data. |
WellLogScaleTypeenum | Curve scale: linear or logarithmic. |
WellLogTemplatesstatic class | Gets or sets the well log templates. |
WellLogTrackclass | Log track (curves or lithology) on the shared wellbore axis. Curve depths are in the axis unit of the document they belong to; all depth mapping goes through the shared DepthMapper. |
WellLogTrackRoleenum | Role of a log track, such as curves or lithology. |
WellLogTracksstatic class | Log-family tracks built from a canonical well model (pass to WellModelConversionOptions.ExtraTracks). |
WellLogViewclass | Well-log view: a WellboreView preloaded with the triple-combo demo, plus LAS loading. |
WellLogWrapModeenum | Backup-scale wrapping for curves that leave their scale. |
BondInterval class
A contiguous interval of one bond class (depths in the data unit).
| Member | Summary |
|---|---|
float Bottom { get; set; } | Bottom of the interval. |
float Length { get; } | Length of the interval. |
float MeanBondIndex { get; set; } | Mean bond index over the interval. |
BondQuality Quality { get; set; } | Bond quality of the interval. |
float Top { get; set; } | Top of the interval (document depth unit). |
BondQuality enum
Cement bond quality from the bond index: good, partial or poor.
| Member | Summary |
|---|---|
Good | Bond index at or above the good cut-off. |
Partial | Between the cut-offs. |
Poor | Below the poor cut-off. |
CblCalibration class
CBL calibration for one casing size (amplitudes at the tool's CBL spacing, same unit as the curve, e.g. mV).
| Member | Summary |
|---|---|
string AmplitudeUnit { get; set; } | Unit of the amplitudes (cement.amplitudeUnit, mV). |
float BondedAmplitude { get; set; } | Amplitude at 100 % bond. |
float FreePipeAmplitude { get; set; } | Amplitude in free (uncemented) pipe. |
float GoodCutoff { get; set; } | BI at or above which bond is "good" (screening default 0.8). |
float PoorCutoff { get; set; } | BI below which bond is "poor". |
CementBondTracks static class
Standard cement-evaluation presentation: CBL amplitude, bond index with good-bond shading, VDL, bond quality.
| Member | Summary |
|---|---|
static List<WellTrack> Build(WellLogCurve cbl, WaveformSet vdl, CblCalibration cal) | Tracks for a cement bond log: CBL amplitude, bond index with the good / poor cut-offs, bond flags and (when given) the VDL. |
static List<CementBondEvidence> Evidence(IEnumerable<BondInterval> intervals) | Bond intervals as source-neutral barrier evidence. |
CementEvaluation static class
Cement bond screening from CBL amplitude: bond index BI = log(A_free / A) / log(A_free / A_100%) (clamped 0-1), classified good / partial / poor, contiguous intervals, and the longest continuous good-bond length — what isolation depends on. Cutoffs and required lengths are operator- and casing-specific; defaults are screening values only.
| Member | Summary |
|---|---|
static float BondIndex(float amplitude, CblCalibration cal) | Bond index from CBL amplitude: log10(free-pipe / amplitude) / log10(free-pipe / bonded), limited to 0-1. |
static WellLogCurve BondIndexCurve(WellLogCurve cbl, CblCalibration cal) | BI curve from a CBL amplitude curve (nulls skipped); empty, with the reason in its name, when the curve's unit is not an amplitude. |
static BondQuality Classify(float bi, CblCalibration cal) | Quality class of a bond index with the calibration's cut-offs. |
static List<BondInterval> Intervals(WellLogCurve cbl, CblCalibration cal, float top = -3.4028235E+38, float bottom = 3.4028235E+38) | Contiguous bond-class intervals over [top, bottom] (boundaries midway between samples). |
static BondInterval LongestGood(IEnumerable<BondInterval> intervals, float top, float bottom) | Longest continuous good-bond interval within [top, bottom] (null if none). |
CrossplotKind enum
Kinds of crossplot (they decide the axes and overlays).
| Member | Summary |
|---|---|
DensityNeutron | Bulk density against neutron porosity (lithology lines). |
Pickett | Resistivity against porosity on log axes (saturation lines). |
CrossplotPanel class
A crossplot: kind, axes (range, log, direction), points and the overlays of its kind. Built by Crossplots.
Inherits / implements: IJsonPersistable
| Member | Summary |
|---|---|
string ColorCurve { get; set; } | Mnemonic of the colour curve; null = colour by zone. |
string DepthUnit { get; set; } | Unit of the point depths. |
CrossplotKind Kind { get; set; } | Chart kind (decides the overlays). |
string Name { get; set; } | Title. |
List<CrossplotPoint> Points { get; } | The samples. |
string XLabel { get; set; } | X-axis label. |
bool XLog { get; set; } | Logarithmic x axis. |
double XMax { get; set; } | X-axis maximum. |
double XMin { get; set; } | X-axis minimum. |
bool YDownward { get; set; } | Y grows downward (density axis of the density-neutron chart). |
string YLabel { get; set; } | Y-axis label. |
bool YLog { get; set; } | Logarithmic y axis. |
double YMax { get; set; } | Y-axis maximum. |
double YMin { get; set; } | Y-axis minimum. |
static CrossplotPanel FromJson(string json) | Reads a panel. |
string ToJson() | Serializes the panel (axes, points, zones, colour values). |
CrossplotPoint class
One crossplot sample: values, depth, zone (from tops) and optional colour value.
| Member | Summary |
|---|---|
double? ColorValue { get; set; } | Value of the colour curve at the sample, when one is set. |
double Depth { get; set; } | Depth of the sample (log index unit). |
double X { get; set; } | X value (axis units). |
double Y { get; set; } | Y value (axis units). |
string Zone { get; set; } | Zone from the formation tops, when given. |
Crossplots static class
Builds crossplots from a depth log set (inputs through the curve-mnemonic vocabulary, as for the computed curves) and their overlays: density-neutron lithology lines (matrix point to fluid point, porosity ticks) and Pickett lines of constant water saturation from Archie (phi = (a Rw / (Rt Sw^n))^(1/m)) with the environment's petrophysics parameters.
| Member | Summary |
|---|---|
static CrossplotPanel DensityNeutron(LogSet set, IEnumerable<FormationTop> tops = null, string colorCurve = null, double? top = null, double? bottom = null, List<string> warnings = null) | A density-neutron crossplot of a log set (neutron in limestone units across, density downward); optional tops (zones), colour curve and depth window; missing inputs are reported. |
static ((double, double), (double, double)) LithologyLine(LithologyLine line) | Density-neutron lithology line (neutron, density) from the matrix point to the fluid point. |
static (double, double) LithologyPoint(LithologyLine line, double phi) | A point on a lithology line at porosity phi (linear mixing of matrix and fluid). |
static CrossplotPanel Pickett(LogSet set, IEnumerable<FormationTop> tops = null, string colorCurve = null, double? top = null, double? bottom = null, List<string> warnings = null) | A Pickett plot of a log set (Rt across, porosity up, both logarithmic); porosity from PHIT / PHID or computed from density; optional tops, colour curve and depth window. |
static double PickettRt(double phi, double sw) | Resistivity on the Pickett line of saturation sw at porosity phi (Archie, environment parameters). |
CrossplotView class
Host-independent crossplot view: axes (linear or log, density downward), grid, the overlays of the kind, points coloured by zone or by a colour curve, legend, and a hover readout of the nearest point (depth, values, zone).
Inherits / implements: ViewSurface
| Member | Summary |
|---|---|
string AccessibleDescription { get; } | What the view shows now, for screen readers (updated with the view). |
string AccessibleName { get; } | Short name for assistive technology. |
CrossplotPoint Hovered { get; } | The point under the pointer (keyboard: the point stepped to), or null. |
CrossplotPanel Panel { get; set; } | The crossplot shown. |
SKRect Plot { get; } | The plot area on screen. |
bool HandleKey(ViewKey key, ViewModifiers modifiers = None) | Keys: Tab / Shift+Tab step through the points in depth order (the readout follows), Escape clears. |
bool HandleMouseHover(SKPoint point) | Pointer moved with no button pressed; true requests a redraw. |
bool HandleMouseLeave() | Pointer left the view; true requests a redraw. |
CrossplotPoint PointAt(SKPoint s) | The point nearest to s within 8 px. |
string Readout(CrossplotPoint q) | Readout of a point: depth, values and zone. |
SKPoint ToScreen(double x, double y) | Axis values to a screen point (log and downward axes handled). |
CurveEditing static class
Depth matching and splicing of display curves (the data-level equivalent is LogSet)).
| Member | Summary |
|---|---|
static void Shift(WellLogCurve curve, CurveDepthShift shift, string unit) | Applies a recorded shift (bulk or tie points) to a curve's samples (depths in unit); samples stay depth-ordered. |
static WellLogCurve Splice(WellLogCurve upper, WellLogCurve lower, float spliceDepth, string mnemonic = null) | A new curve from two runs: upper above spliceDepth, lower from it down (samples copied; scale and style from the upper run; the name records the splice). |
CuttingsTrack class
Percentage lithology (cuttings) track: each sample interval split into horizontal bands proportional to its lithology percentages (shared lithology fills), with an interpreted column showing the dominant lithology. Missing percentage (total below 100) is left blank rather than stretched, so incomplete descriptions stay visible.
Inherits / implements: WellTrack, ITrackFrame
| Member | Summary |
|---|---|
float InterpretedFraction { get; set; } | Share of the track width (0.05-0.5) used by the interpreted-lithology column on the right. |
List<CuttingsSample> Samples { get; } | The cuttings samples. |
bool ShowInterpreted { get; set; } | Right-hand column with the dominant lithology. |
string Subtitle { get; } | Second header line (units, mnemonic); null = none. |
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
const string TypeKeyValue = "cuttings" | Type key of the track (serialization). |
static List<(string, float, float)> Bands(CuttingsSample s, float left, float width) | Band rectangles for one interval (pure; used for drawing and tests): code -> x range. |
static string Dominant(CuttingsSample s) | The lithology with the largest percentage in a sample, or null. |
void DrawContent(SKCanvas canvas, WellTrackContext ctx) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
IEnumerable<LegendEntry> LegendEntries() | Legend items this track contributes to printed / exported views. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
string ReadoutAt(WellTrackContext context, float depth) | Cursor readout at depth (axis units), e.g. "GR 65.2 API"; null = nothing to show. |
JsonObject SavePayload() | Type-specific settings for persistence. |
IEnumerable<WellboreIssue> Validate(WellboreDocument document) | Track-level validation (called by WellboreValidator); families add their own data rules. |
DipReferenceCases static class
Reference case kind "dipSinusoid": the image-log sinusoid of a planar feature (peak-to-trough = diameter x tan(dip), deepest point at the dip azimuth).
| Member | Summary |
|---|---|
static IReadOnlyDictionary<string, Func<ReferenceCase, ReferenceCaseResult>> Evaluators { get; } | Evaluators this library adds to ReferenceCaseResult}}). |
static ReferenceCaseResult Evaluate(ReferenceCase c) | Compares the sinusoid's peak-to-trough amplitude (and the azimuth of its deepest point) with the expected values. |
DipTrack class
Dip tadpole track: head at (dip angle 0-90°, depth), tail pointing in the dip-azimuth direction (north up, clockwise), colour / shape by pick type. Dips are TRUE (geographic) dips.
Inherits / implements: WellTrack, ITrackFrame
| Member | Summary |
|---|---|
List<DipMeasurement> Dips { get; } | The dips shown. |
float HeadRadius { get; set; } | Radius of the tadpole head (pixels). |
string Subtitle { get; } | Second header line (units, mnemonic); null = none. |
float TailLength { get; set; } | Tail length (pixels); the tail points in the dip azimuth. |
static IReadOnlyDictionary<DipType, SKColor> TypeColors { get; } | Colours by pick type from the environment's styles. |
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
const string TypeKeyValue = "dips" | Type key of the track (serialization). |
void DrawContent(SKCanvas canvas, WellTrackContext ctx) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
static float HeadX(double dip, SKRect plot) | Head x for a dip angle (linear 0-90°). |
IEnumerable<LegendEntry> LegendEntries() | Legend items this track contributes to printed / exported views. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
string ReadoutAt(WellTrackContext context, float depth) | Cursor readout at depth (axis units), e.g. "GR 65.2 API"; null = nothing to show. |
JsonObject SavePayload() | Type-specific settings for persistence. |
static (float, float) TailOffset(double azimuth, float length) | Tail end offset for an azimuth: north = up (-y), east = right (+x), clockwise. |
IEnumerable<WellboreIssue> Validate(WellboreDocument document) | Track-level validation (called by WellboreValidator); families add their own data rules. |
FlagInterval class
One categorical interval (axis units).
| Member | Summary |
|---|---|
float Bottom { get; set; } | Bottom of the interval. |
string Code { get; set; } | Flag code (selects the style). |
float Top { get; set; } | Top of the interval. |
FlagStyle class
Display of a flag code.
| Member | Summary |
|---|---|
string Fill { get; set; } | Fill colour (#rrggbb) or a lithology code from the shared library. |
string Label { get; set; } | Label shown in the interval. |
FlagTrack class
Discrete / flag track: categorical intervals (net pay, perforation status, facies, quality flags). Build from intervals or from a discrete curve (String)). Codes without a style are left blank.
Inherits / implements: WellTrack, ITrackFrame
| Member | Summary |
|---|---|
List<FlagInterval> Intervals { get; } | The flagged intervals. |
bool ShowLabels { get; set; } | Show the labels inside the intervals. |
Dictionary<string, FlagStyle> Styles { get; } | Styles by flag code. |
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
const string TypeKeyValue = "flags" | Type key of the track (serialization). |
void ConvertDepthUnit(DepthUnit from, DepthUnit to) | Converts depth data the track stores in the document axis unit (called by DepthUnit) and Boolean)). Tracks whose data carries its own unit (e.g. schematics) need not override. |
void DrawContent(SKCanvas canvas, WellTrackContext ctx) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
static FlagTrack FromCurve(WellLogCurve curve, IDictionary<string, FlagStyle> styles, string name = null) | Runs of identical (rounded) values become intervals; boundaries fall midway between samples. Samples whose code has no style become gaps. |
string HitTest(WellTrackContext context, float x, float y) | Id of the object under a point, or null. |
IEnumerable<LegendEntry> LegendEntries() | Legend items this track contributes to printed / exported views. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
string ReadoutAt(WellTrackContext context, float depth) | Cursor readout at depth (axis units), e.g. "GR 65.2 API"; null = nothing to show. |
JsonObject SavePayload() | Type-specific settings for persistence. |
IEnumerable<WellboreIssue> Validate(WellboreDocument document) | Track-level validation (called by WellboreValidator); families add their own data rules. |
ImageLogData class
A borehole image: rows of azimuthal samples (0-360°, first column at the reference azimuth) per depth.
| Member | Summary |
|---|---|
string AzimuthReference { get; set; } | Azimuth of the first column: "North" (oriented images) or "TopOfHole". |
float BoreholeDiameterIn { get; set; } | Borehole diameter (in) — sets sinusoid amplitude. |
int Columns { get; } | Values per row (azimuthal samples). |
List<float> Depths { get; } | Depth of each row. |
string Name { get; set; } | Name of the image. |
List<float[]> Rows { get; } | Rows of values around the borehole (same length each). |
ImageLogTrack class
Borehole image track: unrolled image (heated palette, static or dynamic normalization) with sinusoid picks for planar features — depth(φ) = z0 + (D/2)·tan(dip)·cos(φ − dip azimuth), deepest on the down-dip side. Rendered as run-length merged ~2 px cells (no raster APIs; SkiaSharp-4 safe), like the VDL.
Inherits / implements: WellTrack, ITrackFrame
| Member | Summary |
|---|---|
float? DynamicWindow { get; set; } | Dynamic normalization window in the document's depth unit; null = the environment's window (imageLogs.dynamicWindow) converted to that unit. |
float HeaderHeight { get; set; } | Requested header height; tracks may grow it (e.g. one scale bar per curve). The view uses the tallest. |
ImageLogData Image { get; set; } | The image data. |
int Levels { get; set; } | Number of colour levels (default from the environment). |
ImageNormalization Normalization { get; set; } | Static or dynamic normalization (default from the environment). |
List<DipMeasurement> Picks { get; } | Planar-feature picks drawn as sinusoids (true dips; vertical-hole geometry). |
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
const string TypeKeyValue = "image" | Type key of the track (serialization). |
void ConvertDepthUnit(DepthUnit from, DepthUnit to) | Converts depth data the track stores in the document axis unit (called by DepthUnit) and Boolean)). Tracks whose data carries its own unit (e.g. schematics) need not override. |
void DrawContent(SKCanvas canvas, WellTrackContext ctx) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
void DrawHeader(SKCanvas canvas, WellTrackContext ctx) | Draws the header box (default: title + optional subtitle with the shared chrome). |
IEnumerable<LegendEntry> LegendEntries() | Legend items this track contributes to printed / exported views. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
static float[][] Normalize(ImageLogData img, ImageNormalization mode, float window) | Normalized rows (0..1): static = global 2-98 % percentiles; dynamic = percentiles within a sliding depth window. |
static DipMeasurement OnImage(DipMeasurement pick, double md, Trajectory trajectory, string imageAzimuthReference) | A true dip pick as the image sees it: its dip relative to the borehole at md (from the view's survey; none: a vertical hole) and the azimuth of its deepest point in the image's own orientation (North - north projected across the hole - or TopOfHole). |
static SKColor Palette(float v) | Heated palette colour of a normalized value (0-1). |
string ReadoutAt(WellTrackContext context, float depth) | Cursor readout at depth (axis units), e.g. "GR 65.2 API"; null = nothing to show. |
float ResolvedWindow(DepthUnit axisUnit) | The window used for drawing, in axisUnit: the explicit value, else the environment's window converted (no feet assumption). |
JsonObject SavePayload() | Type-specific settings for persistence. |
static List<(double, double)> Sinusoid(DipMeasurement pick, double md, float diameterIn, string depthUnit, int points = 72) | Sinusoid of a planar feature: (azimuth°, depth) points; amplitude (D/2)·tan(dip) in the depth unit. |
IEnumerable<WellboreIssue> Validate(WellboreDocument document) | Track-level validation (called by WellboreValidator); families add their own data rules. |
ImageNormalization enum
Borehole-image normalization: static (whole image) or dynamic (sliding depth window).
| Member | Summary |
|---|---|
Static | One colour scale over the whole image. |
Dynamic | Colour scale per sliding depth window (brings out local contrast). |
LiveLogFeed class
Appends live rows to the curves of a log document in place: matched by mnemonic, kept depth-sorted, re-delivered depths ignored (idempotent), nulls skipped, scales optionally expanded, axis extended as the hole deepens, revision touched so a cached scene redraws. Unknown mnemonics become new curves in NewCurveTrack when set, else are reported.
Inherits / implements: ILiveStatus
| Member | Summary |
|---|---|
LiveLogFeed(WellboreDocument document) | A feed updating document (curves matched by mnemonic). |
bool AutoRange { get; set; } | Expand curve scales when live values fall outside them (log scales stay positive). |
DateTime? LastUpdateUtc { get; } | When data last arrived (UTC). |
float? LatestDepth { get; } | Deepest index received so far. |
WellLogTrack NewCurveTrack { get; set; } | Track receiving curves for mnemonics not yet in the document (null = report them instead). |
TimeSpan StaleAfter { get; set; } | Time without new data after which the feed counts as stale. |
HashSet<string> UnknownMnemonics { get; } | Mnemonics received that no curve in the document shows. |
int Apply(GrowingLogRows rows, DateTime? nowUtc = null) | Appends rows; returns the number of samples added. |
bool IsStale(DateTime nowUtc) | True when data has arrived before but not within StaleAfter. |
Task<int> PollAsync(IGrowingLogSource source, DateTime? nowUtc = null, CancellationToken cancellationToken = null) | Fetches rows after the last received index and appends them. |
MudLogTracks static class
Mud-log presentation from canonical data: cuttings, gas (TG, C1-C5 log), Haworth ratios, fluid character flags.
| Member | Summary |
|---|---|
static IReadOnlyDictionary<GasCharacter, string> CharacterColors { get; } | Fluid character colours from the environment's styles. |
static IEnumerable<WellTrack> FromModel(WellModel model, string unit = null, double? minShowGas = null) | Mud-log tracks from a model: cuttings, chromatograph, gas ratios and fluid character (Haworth); shows below minShowGas are background. |
PaySummaryTrack class
The pay summary as a depth-aligned table: one row per zone between its top and base.
Inherits / implements: WellTrack, ITrackFrame
| Member | Summary |
|---|---|
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
string Unit { get; set; } | Thickness unit label (the document's depth unit). |
List<PayZone> Zones { get; } | Zones (depths and thicknesses in the document's depth unit). |
const string TypeKeyValue = "paySummary" | Type key of this track. |
void ConvertDepthUnit(DepthUnit from, DepthUnit to) | Converts depth data the track stores in the document axis unit (called by DepthUnit) and Boolean)). Tracks whose data carries its own unit (e.g. schematics) need not override. |
void DrawContent(SKCanvas canvas, WellTrackContext ctx) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
string HitTest(WellTrackContext context, float x, float y) | Id of the object under a point, or null. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
string ReadoutAt(WellTrackContext context, float depth) | Cursor readout at depth (axis units), e.g. "GR 65.2 API"; null = nothing to show. |
JsonObject SavePayload() | Type-specific settings for persistence. |
PressureTrack class
Formation pressure track: tests plotted as pressure vs depth (styled by quality), fitted fluid gradients and the free-fluid levels at their intersections. Analysis runs in TVD (the document's depth reference), so gradients are true fluid densities even in deviated wells; lines are drawn correctly on MD, TVD and TVDSS axes.
Inherits / implements: WellTrack, ITrackFrame
| Member | Summary |
|---|---|
float HeaderHeight { get; set; } | Requested header height; tracks may grow it (e.g. one scale bar per curve). The view uses the tallest. |
double MaxRmsResidual { get; set; } | RMS residual (psi) above which a gradient fit is flagged (tester resolution ~1 psi). |
int MaxZones { get; set; } | Maximum number of gradient zones (default from the environment). |
double? PressureMax { get; set; } | Upper end of the pressure scale (psi); null = fit the data. |
double? PressureMin { get; set; } | Pressure scale in psi; null = automatic from the data. |
bool ShowGradients { get; set; } | Draw the fitted gradients. |
bool ShowLevels { get; set; } | Draw the free-fluid levels. |
List<PressureTest> Tests { get; } | The pressure tests. |
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
const string TypeKeyValue = "pressure" | Type key of the track (serialization). |
PressureAnalysisResult Analyze(WellboreDocument doc) | Analysis in the document's axis unit, using its depth reference for TVD (vertical well if none). |
void ConvertDepthUnit(DepthUnit from, DepthUnit to) | Converts depth data the track stores in the document axis unit (called by DepthUnit) and Boolean)). Tracks whose data carries its own unit (e.g. schematics) need not override. |
void DrawContent(SKCanvas canvas, WellTrackContext ctx) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
void DrawHeader(SKCanvas canvas, WellTrackContext ctx) | Draws the header box (default: title + optional subtitle with the shared chrome). |
IEnumerable<LegendEntry> LegendEntries() | Legend items this track contributes to printed / exported views. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
string ReadoutAt(WellTrackContext context, float depth) | Cursor readout at depth (axis units), e.g. "GR 65.2 API"; null = nothing to show. |
JsonObject SavePayload() | Type-specific settings for persistence. |
(double, double) Scale() | The pressure scale in psi (fixed, or fitted to the tests with padding). |
IEnumerable<WellboreIssue> Validate(WellboreDocument document) | Track-level validation (called by WellboreValidator); families add their own data rules. |
WaveformSet class
Full-wave sonic data for VDL display: one waveform per depth, uniform time sampling (µs).
| Member | Summary |
|---|---|
List<float> Depths { get; } | Depth of each waveform. |
string Name { get; set; } | Name of the waveform set. |
int SampleCount { get; } | Samples per waveform. |
float TimeEnd { get; } | Time of the last sample (microseconds). |
float TimeStart { get; set; } | Time of the first sample (microseconds). |
float TimeStep { get; set; } | Sampling interval (microseconds). |
List<float[]> Traces { get; } | Samples per depth (same length for all); amplitude in arbitrary units, signed. |
WaveformTrack class
Variable-density (VDL) waveform track: time across (µs), depth down; positive amplitude dark, negative light. Drawn with run-length merged rectangles (no raster APIs; resampled to ~2 px cells, 9 grey levels) so it works with SkiaSharp 4 and stays cheap inside the cached scene.
Inherits / implements: WellTrack, ITrackFrame
| Member | Summary |
|---|---|
float? Gain { get; set; } | Amplitude giving full black / white (auto = 95th percentile of |amplitude|). |
float HeaderHeight { get; set; } | Requested header height; tracks may grow it (e.g. one scale bar per curve). The view uses the tallest. |
float? TimeMax { get; set; } | End of the time window (microseconds); null = the last sample. |
float? TimeMin { get; set; } | Displayed time window (µs); null = whole trace. |
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
WaveformSet Waveforms { get; set; } | The waveforms. |
const int Levels = 9 | Number of grey levels of the VDL. |
const string TypeKeyValue = "waveform" | Type key of the track (serialization). |
List<(SKRect, int)> Cells(WellTrackContext ctx) | Run-length rectangles for the visible part: (rect, grey level). Pure — used for drawing and tests. |
void ConvertDepthUnit(DepthUnit from, DepthUnit to) | Converts depth data the track stores in the document axis unit (called by DepthUnit) and Boolean)). Tracks whose data carries its own unit (e.g. schematics) need not override. |
void DrawContent(SKCanvas canvas, WellTrackContext ctx) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
void DrawHeader(SKCanvas canvas, WellTrackContext ctx) | Draws the header box (default: title + optional subtitle with the shared chrome). |
float EffectiveGain() | The gain used: the set value, else the 95th percentile of the absolute amplitude (spikes do not wash out the display). |
static int Level(float amplitude, float gain) | Grey level 0 (white) .. Levels-1 (black) for an amplitude: 0 amplitude = mid grey. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
JsonObject SavePayload() | Type-specific settings for persistence. |
IEnumerable<WellboreIssue> Validate(WellboreDocument document) | Track-level validation (called by WellboreValidator); families add their own data rules. |
(float, float) Window() | The time window shown (microseconds). |
WellLogCurve class
Gets or sets the well log curve.
| Member | Summary |
|---|---|
bool IsVisible { get; set; } | Gets or sets the is visible. |
float MaximumValue { get; set; } | Gets or sets the maximum value. |
float MinimumValue { get; set; } | Gets or sets the minimum value. |
string Mnemonic { get; set; } | Gets or sets the mnemonic. |
string Name { get; set; } | Gets or sets the name. |
List<WellLogCurveSample> Samples { get; } | Gets or sets the samples. |
WellLogScaleType ScaleType { get; set; } | Gets or sets the scale type. |
WellLogCurveStyle Style { get; set; } | Gets or sets the style. |
string Unit { get; set; } | Gets or sets the unit. |
WellLogCurveSample class
Gets or sets the well log curve sample.
| Member | Summary |
|---|---|
float Depth { get; set; } | Gets or sets the depth. |
float Value { get; set; } | Gets or sets the value. |
WellLogCurveStyle class
Gets or sets the well log curve style.
| Member | Summary |
|---|---|
string BrushKey { get; set; } | Gets or sets the brush key. |
string CompanionCurveMnemonic { get; set; } | Gets or sets the companion curve mnemonic. |
WellLogCutoffSide CutoffSide { get; set; } | Cutoff shading side: shade where the value is below (e.g. GR sand) or above the cutoff (FillReference). |
float[] Dash { get; set; } | Optional dash pattern for the primary trace. |
WellLogFillMode FillMode { get; set; } | Gets or sets the fill mode. |
float? FillReference { get; set; } | Gets or sets the fill reference. |
SKColor LineColor { get; set; } | Gets or sets the line color. |
int MaxWraps { get; set; } | Maximum number of backup scales (1 = one backup). |
float StrokeWidth { get; set; } | Gets or sets the stroke width. |
WellLogWrapMode WrapMode { get; set; } | Wrap: values beyond the scale re-enter on backup scales (drawn dashed) instead of pinning at the edge. |
WellLogCutoffSide enum
Which side of a cutoff value is shaded.
| Member | Summary |
|---|---|
Below | Shade values below the cut-off. |
Above | Shade values above the cut-off. |
WellLogDataStandard enum
Data standard a log document came from (for example LAS 2.0).
| Member | Summary |
|---|---|
Las20 | LAS 2.0. |
Las30 | LAS 3.0. |
DlisRp66V1 | DLIS (RP66 version 1). |
DlisRp66V2 | DLIS (RP66 version 2). |
Lis79 | LIS 79. |
Csv | CSV. |
Json | JSON. |
WellLogDocuments static class
Stand-alone log documents from canonical data (whatever loader produced it).
| Member | Summary |
|---|---|
static WellboreDocument FromModel(WellModel model, string standard = null) | A log view for the model's first depth log set: "Depth" track plus family tracks; axis unit and range from the index (feet index -> feet axis). Header name / service company carried into the document. |
WellLogFillMode enum
How the area around a curve is filled: none, left or right of the curve, between curves, or cutoff shading.
| Member | Summary |
|---|---|
None | No fill. |
LeftToCurve | Fill from the track's left edge to the curve. |
RightToCurve | Fill from the curve to the track's right edge. |
BetweenCurves | Fill between two curves. |
CutoffShading | Shade where the curve passes a cut-off. |
LithologyBands | Lithology bands. |
WellLogLithologyInterval class
Gets or sets the well log lithology interval.
| Member | Summary |
|---|---|
float BottomDepth { get; set; } | Gets or sets the bottom depth. |
string BrushKey { get; set; } | Gets or sets the brush key. |
string Label { get; set; } | Gets or sets the label. |
float TopDepth { get; set; } | Gets or sets the top depth. |
WellLogPointSeries class
Discrete measurements drawn as markers in a log track (e.g. core porosity over the neutron / density curves). Depths are data depths; DepthShift (core-to-log) is added when drawing and reading out.
| Member | Summary |
|---|---|
SKColor Color { get; set; } | Marker colour. |
float DepthShift { get; set; } | Depth shift applied when drawing (core-to-log). |
bool IsVisible { get; set; } | Draw the series. |
float MaximumValue { get; set; } | Scale maximum. |
float MinimumValue { get; set; } | Scale minimum. |
string Mnemonic { get; set; } | Mnemonic of the point series. |
string Name { get; set; } | Display name. |
List<WellLogCurveSample> Samples { get; } | The points. |
WellLogScaleType ScaleType { get; set; } | Scale type. |
WellLogPointShape Shape { get; set; } | Marker shape. |
float Size { get; set; } | Marker size (pixels). |
string Unit { get; set; } | Unit. |
WellLogCurve AsScale() | Scale proxy so points map exactly like curves. |
WellLogPointShape enum
Marker shape for point series such as core data.
| Member | Summary |
|---|---|
Circle | Circle. |
Square | Square. |
Diamond | Diamond. |
Triangle | Triangle. |
WellLogScaleType enum
Curve scale: linear or logarithmic.
| Member | Summary |
|---|---|
Linear | Linear scale. |
Log10 | Logarithmic (base 10) scale. |
WellLogTemplates static class
Gets or sets the well log templates.
| Member | Summary |
|---|---|
static WellboreDocument CreateTripleComboDemo() | Gets or sets the create triple combo demo. |
static WellboreDocument CreateTripleComboDemo(float top, float bottom, DepthUnit unit, float step = 0.5) | Triple-combo demo over any interval; step = sample spacing (axis units). |
WellLogTrack class
Log track (curves or lithology) on the shared wellbore axis. Curve depths are in the axis unit of the document they belong to; all depth mapping goes through the shared DepthMapper.
Inherits / implements: WellTrack, ITrackFrame
| Member | Summary |
|---|---|
List<WellLogCurve> Curves { get; } | The curves. |
int GridDivisions { get; set; } | Linear value grid divisions. |
float HeaderHeight { get; set; } | One scale bar per visible curve below the title. |
List<WellLogLithologyInterval> LithologyIntervals { get; } | Lithology intervals (lithology role). |
List<WellLogPointSeries> Points { get; } | Discrete point series (core data…) drawn over the curves on their own scales. |
WellLogTrackRole Role { get; set; } | Role of the track (curve, depth, lithology...). |
List<CurveDepthShift> Shifts { get; } | Depth corrections applied to this track's curves (audit trail, saved with the document). |
bool ShowValueGrid { get; set; } | Vertical value grid (linear divisions or log decades) behind the curves. |
string Subtitle { get; } | Single visible curve: "MNEM [unit]" as the second header line. |
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
const string TypeKeyValue = "welllog" | Type key of the track (serialization). |
TrackEdit CommitDepthShift(string key, float delta, float referenceDepth, string depthUnit) | Commits the previewed shift as a recorded CurveDepthShift (bulk, tie point at the drag start) with undo / redo. |
void ConvertDepthUnit(DepthUnit from, DepthUnit to) | Converts sample depths and lithology intervals (stored in the document axis unit). |
static bool CutoffKeepsLeft(WellLogCurve curve) | True when the shaded side (below/above the cutoff) is left of the cutoff line on screen. Reversed scales (maximum < minimum, e.g. neutron porosity 0.45 -> -0.15) flip it. |
static List<(float, float)> CutoffPolygon(IReadOnlyList<(float, float)> pts, float cutoffX, bool keepLeft) | Polygon for cutoff shading: x is pinned to the cutoff line wherever the curve is on the other side and exact crossing points are inserted, so only the part beyond the cutoff is shaded. keepLeft: shade x < cutoff. |
void DrawContent(SKCanvas canvas, WellTrackContext ctx) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
void DrawHeader(SKCanvas canvas, WellTrackContext ctx) | Title plus one scale bar per curve: a sample of the curve's line style, "MNEM [unit]" centred above it, scale minimum at the left and maximum at the right (a wrap mark when backup scales are on). |
static void DrawMarker(SKCanvas canvas, WellLogPointShape shape, float x, float y, float r, SKColor color) | Draws a point marker of a shape and radius at (x, y). |
static string FormatScale(float v) | A scale value as shown in the header (compact, invariant culture). |
static bool IsNull(float v) | LAS null values and non-finite numbers. |
IEnumerable<LegendEntry> LegendEntries() | Legend items this track contributes to printed / exported views. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
static float MapValueToX(WellLogCurve curve, float value, SKRect plot) | Maps a curve value to x within the plot (linear or log10 scale). |
static float Normalized(WellLogCurve c, float value) | Scale position (0..1 on the main scale; >1 past the maximum) of a value. |
bool PreviewDepthShift(string key, float delta) | Moves a curve (by mnemonic) by delta for preview; the original depths are kept until commit. |
string ReadoutAt(WellTrackContext context, float depth) | Visible curve values at depth (linear interpolation between samples). |
JsonObject SavePayload() | Type-specific settings for persistence. |
static List<(float, float)> ScreenPoints(WellLogCurve curve, DepthMapper mapper, SKRect plot) | Screen points for a curve: only the samples of the visible depth window (plus one beyond each edge), thinned per pixel row (min/max, spikes kept). Point count is bounded by 4 x plot height whatever the sample count. |
IEnumerable<WellboreIssue> Validate(WellboreDocument document) | Log data checks (WL001-WL013): scales, samples, nulls, gaps, clipping, fills, lithology. |
static float? ValueAt(WellLogCurve curve, float depth) | Interpolated curve value at a depth; null outside the curve or across a gap larger than 10 steps. |
static List<(float, bool)> ValueGrid(WellLogCurve curve, SKRect plot, int divisions) | Value grid x positions: linear divisions, or decades (major) and 2..9 (minor) for log scales. |
static List<(int, List<(float, float)>)> WrappedSegments(WellLogCurve curve, DepthMapper mapper, SKRect plot) | Polyline segments per scale level. Level 0 = main scale; with Wrap, values past the scale re-enter on backup scales (level 1..MaxWraps) and segments break at each level change. |
WellLogTrackRole enum
Role of a log track, such as curves or lithology.
| Member | Summary |
|---|---|
Depth | Depth track. |
Lithology | Lithology column. |
Curve | Curve track. |
Overlay | Overlay on another track. |
Annotation | Annotation track. |
WellLogTracks static class
Log-family tracks built from a canonical well model (pass to WellModelConversionOptions.ExtraTracks).
| Member | Summary |
|---|---|
static void ApplyStyle(WellLogCurve c, CurvePresentation p) | Applies a resolved presentation (colour, width, scale, brush, fill) to a curve; unset values are left alone. |
static IEnumerable<WellTrack> CoreTracks(WellModel model, string unit = null) | Core porosity (v/v, linear 0.4-0) and permeability (mD, log 0.1-10000) as point tracks; core shifts applied. |
static IEnumerable<WellTrack> FromModel(WellModel model) | Log-family tracks in feet (kept for existing callers; prefer the unit-aware overload). |
static IEnumerable<WellTrack> FromModel(WellModel model, DepthUnit unit) | Log-family tracks for a view whose depth axis is in unit. |
static IEnumerable<WellTrack> FromModel(WellModel model, DepthUnit unit, List<string> warnings) | As DepthUnit); dip picks are shown as true dips in the working north (borehole-relative picks converted with the well's survey), problems said in warnings. |
static List<WellTrack> GroupCurves(List<WellLogCurve> curves) | Standard log presentation for curves from any source (LAS, WITSML, DLIS…): conventional styles (colours, fills, log scale for resistivity) and one track per curve family in a stable order (Gamma Ray, Resistivity, Porosity, Sonic, Caliper, Other). Styling and grouping are presentation, so they live here, not in the loaders. |
static IEnumerable<WellTrack> LogSetTracks(WellModel model, DepthUnit unit) | Depth-indexed log sets as log tracks, grouped exactly like LAS curves (same layout whatever the source format); indices converted to the view unit, null values skipped. Time-indexed sets are not depth tracks and are skipped. |
static PaySummaryTrack PaySummaryTrack(WellModel model, DepthUnit unit, List<string> warnings = null, LogSet set = null) | The pay summary of the model as a track in unit (zones from formation tops). |
static SKColor RuleColor(string mnemonic, SKColor fallback) | The colour the environment's curve rules (logs.styles) give a mnemonic, else fallback - for curves the library creates itself. |
static (float, float) RuleRange(string mnemonic, string unit, float defaultMin, float defaultMax) | The scale range the curve rules give a mnemonic (in unit), else the given defaults - for curves the library creates. |
WellLogView class
Well-log view: a WellboreView preloaded with the triple-combo demo, plus LAS loading.
Inherits / implements: WellboreView
| Member | Summary |
|---|---|
string PrimaryStandard { get; set; } | Primary storage standard of the loaded data (metadata). |
void LoadModel(WellModel model, string standard = null) | Shows the model's log data (from any loader, e.g. Loaders' LasReader / WitsmlReader). |
WellLogWrapMode enum
Backup-scale wrapping for curves that leave their scale.
| Member | Summary |
|---|---|
None | No wrapping: values beyond the scale are clipped. |
Wrap | Values beyond the scale wrap onto a backup scale. |