Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Curve values view code refactoring #2646

Merged
merged 5 commits into from
Feb 6, 2025
Merged

Curve values view code refactoring #2646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
80827da
Curve values view code refactoring
robertbasti Feb 4, 2025
7e73b62
test
robertbasti Feb 4, 2025
1389bd1
test
robertbasti Feb 4, 2025
2e53aa9
remove props from input
eliasbruvik Feb 6, 2025
8214eca
range refactor
eliasbruvik Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 21 additions & 16 deletions Src/WitsmlExplorer.Frontend/components/ContentViews/CurveDataTransformation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { ExportableContentTableColumn } from "components/ContentViews/table";
import { CurveSpecification } from "models/logData";
import { CustomCurveRange } from "./CurveValuesPlot";
import { CurveRanges } from "./CurveValuesPlot";

const calculateMean = (arr: number[]): number =>
arr.reduce((a, b) => a + b, 0) / arr.length;
Expand Down Expand Up @@ -115,30 +115,35 @@ export const transformCurveData = (
columns: ExportableContentTableColumn<CurveSpecification>[],
thresholdLevel: ThresholdLevel,
removeOutliers: boolean,
ranges: CustomCurveRange[],
customRanges: CurveRanges,
applyCustomRanges: boolean
) => {
let transformedData = data;

if (removeOutliers) {
transformedData = removeCurveDataOutliers(data, columns, thresholdLevel);
}
// Other potential transformations should be added here.

if (applyCustomRanges === true) {
const dataWithRange = transformedData.map((dataRow) => ({ ...dataRow }));
ranges.forEach((range) => {
for (let i = 0; i < dataWithRange.length; i++) {
if (
dataWithRange[i][range.curve] < range.minValue ||
dataWithRange[i][range.curve] > range.maxValue
) {
delete dataWithRange[i][range.curve];
}
}
});
return dataWithRange;
if (applyCustomRanges) {
transformedData = removeDataOutOfRange(transformedData, customRanges);
}

// Other potential transformations should be added here.

return transformedData;
};

const removeDataOutOfRange = (data: any[], customRanges: CurveRanges) => {
const dataWithRange = data.map((dataRow) => ({ ...dataRow }));
Object.entries(customRanges).forEach(([curve, range]) => {
for (let i = 0; i < dataWithRange.length; i++) {
if (
dataWithRange[i][curve] < range.minValue ||
dataWithRange[i][curve] > range.maxValue
) {
delete dataWithRange[i][curve];
}
}
});
return dataWithRange;
};
146 changes: 53 additions & 93 deletions Src/WitsmlExplorer.Frontend/components/ContentViews/CurveValuesPlot.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
Switch,
Typography
} from "@equinor/eds-core-react";
import { Box } from "@mui/material";
import {
ThresholdLevel,
transformCurveData
Expand Down Expand Up @@ -38,7 +39,6 @@ import { RouterLogType } from "routes/routerConstants";
import { Colors } from "styles/Colors";
import { normaliseThemeForEds } from "../../tools/themeHelpers.ts";
import { SettingCustomRanges } from "./SettingCustomRanges.tsx";
import { Box } from "@mui/material";

const COLUMN_WIDTH = 135;
const MNEMONIC_LABEL_WIDTH = COLUMN_WIDTH - 10;
Expand All @@ -51,11 +51,12 @@ interface ControlledTooltipProps {
content: string;
}

export interface CustomCurveRange {
curve: string;
interface CurveRange {
minValue: number;
maxValue: number;
}
export type CurveRanges = Record<string, CurveRange>;

interface CurveValuesPlotProps {
data: any[];
columns: ExportableContentTableColumn<CurveSpecification>[];
Expand All @@ -73,16 +74,19 @@ export const CurveValuesPlot = React.memo(
autoRefresh,
isDescending = false
} = props;
const columns = rawColumns.filter(
(col, index) => col.type === ContentType.Number || index === 0
const columns = useMemo(
() =>
rawColumns.filter(
(col, index) => col.type === ContentType.Number || index === 0
),
[rawColumns]
);
const {
operationState: { colors, dateTimeFormat, theme }
} = useOperationState();
const [enableScatter, setEnableScatter] = useState<boolean>(false);
const [removeOutliers, setRemoveOutliers] = useState<boolean>(false);
const [useCustomRanges, setUseCustomRanges] = useState<boolean>(false);
const [refreshGraph, setRefreshGraph] = useState<boolean>(false);
const [outliersThresholdLevel, setOutliersThresholdLevel] =
useState<ThresholdLevel>(ThresholdLevel.Medium);
const chart = useRef<ECharts>(null);
Expand All @@ -109,32 +113,14 @@ export const CurveValuesPlot = React.memo(
visible: false
} as ControlledTooltipProps);

const minMaxValuesCalculation = (
myColumns: ExportableContentTableColumn<CurveSpecification>[]
) =>
myColumns
.map((col) => col.columnOf.mnemonic)
.map((curve) => {
const curveData = props.data
.map((obj) => obj[curve])
.filter(Number.isFinite);
return {
curve: curve,
minValue:
curveData.length == 0
? null
: curveData.reduce((min, v) => (min <= v ? min : v), Infinity),
maxValue:
curveData.length == 0
? null
: curveData.reduce((max, v) => (max >= v ? max : v), -Infinity)
};
})
.slice(1);

const [ranges, setRanges] = useState<CustomCurveRange[]>(
minMaxValuesCalculation(columns)
const [customRanges, setCustomRanges] = useState<CurveRanges>({});
const rawDataRanges = useMemo(
() => getDataRanges(columns, data),
[columns, data]
);
const dataRanges = useCustomRanges
? { ...rawDataRanges, ...customRanges }
: rawDataRanges;

const transformedData = useMemo(
() =>
Expand All @@ -143,7 +129,7 @@ export const CurveValuesPlot = React.memo(
columns,
outliersThresholdLevel,
!autoRefresh && removeOutliers,
ranges,
customRanges,
useCustomRanges
),
[
Expand All @@ -152,7 +138,7 @@ export const CurveValuesPlot = React.memo(
outliersThresholdLevel,
removeOutliers,
autoRefresh,
ranges,
customRanges,
useCustomRanges
]
);
Expand All @@ -168,18 +154,6 @@ export const CurveValuesPlot = React.memo(
}
}, [contentViewWidth]);

useMemo(() => {
if (useCustomRanges) {
const found = rawColumns.filter((column) =>
ranges.find((range) => range.curve === column.property)
);
const filter = rawColumns.filter((column) => !found.includes(column));
const missingRanges = minMaxValuesCalculation(filter);
const newRanges = [...ranges, ...missingRanges];
setRanges(newRanges);
}
}, [rawColumns]);

const chartOption = getChartOption(
transformedData,
columns,
Expand All @@ -195,9 +169,7 @@ export const CurveValuesPlot = React.memo(
verticalZoom.current,
isTimeLog,
enableScatter,
refreshGraph,
useCustomRanges,
ranges
dataRanges
);

const onMouseOver = (e: any) => {
Expand Down Expand Up @@ -293,9 +265,8 @@ export const CurveValuesPlot = React.memo(
mouseout: onMouseOut
};

const onChange = (curveRanges: CustomCurveRange[]) => {
setRanges(curveRanges);
setRefreshGraph(!refreshGraph);
const onChange = (curveRanges: CurveRanges) => {
setCustomRanges(curveRanges);
};

const onClose = () => {
Expand Down Expand Up @@ -380,7 +351,8 @@ export const CurveValuesPlot = React.memo(
}}
>
<SettingCustomRanges
minMaxValuesCalculation={ranges}
rawDataRanges={rawDataRanges}
customRanges={customRanges}
onChange={onChange}
onClose={onClose}
/>
Expand Down Expand Up @@ -449,40 +421,16 @@ const getChartOption = (
verticalZoom: [number, number],
isTimeLog: boolean,
enableScatter: boolean,
_refreshGraph: boolean,
showCustomRanges: boolean,
customRanges: CustomCurveRange[]
dataRanges: CurveRanges
) => {
_refreshGraph = true;
const VALUE_OFFSET_FROM_COLUMN = 0.01;
const AUTO_REFRESH_SIZE = 300;
const LABEL_MAXIMUM_LENGHT = 13;
const LABEL_NUMBER_MAX_LENGTH = 9;
if (autoRefresh && _refreshGraph) data = data.slice(-AUTO_REFRESH_SIZE); // Slice to avoid lag while streaming
if (autoRefresh) data = data.slice(-AUTO_REFRESH_SIZE); // Slice to avoid lag while streaming
const indexCurve = columns[0].columnOf.mnemonic;
const indexUnit = columns[0].columnOf.unit;
const dataColumns = columns.filter((col) => col.property != indexCurve);
const minMaxValues = columns
.map((col) => col.columnOf.mnemonic)
.map((curve) => {
const curveData = data.map((obj) => obj[curve]).filter(Number.isFinite);
const customRange = customRanges.find((x) => x.curve === curve);
return {
curve: curve,
minValue:
curveData.length == 0
? null
: showCustomRanges && customRange !== undefined
? customRange.minValue
: curveData.reduce((min, v) => (min <= v ? min : v), Infinity),
maxValue:
curveData.length == 0
? null
: showCustomRanges && customRange != undefined
? customRange.maxValue
: curveData.reduce((max, v) => (max >= v ? max : v), -Infinity)
};
});

return {
title: {
Expand Down Expand Up @@ -550,20 +498,13 @@ const getChartOption = (
const index = Math.floor(param);
if (index >= dataColumns.length) return "";
const curve = dataColumns[index].columnOf.mnemonic;
const minMaxValue = minMaxValues.find((v) => v.curve == curve);
const range = dataRanges[curve];
const title =
curve.length > LABEL_MAXIMUM_LENGHT
? curve.substring(0, LABEL_MAXIMUM_LENGHT) + "..."
: curve;
let minValue = minMaxValue.minValue?.toFixed(3) ?? "NaN";
let maxValue = minMaxValue.maxValue?.toFixed(3) ?? "NaN";
if (showCustomRanges) {
const customRange = customRanges.find((x) => x.curve === curve);
if (customRange != undefined) {
minValue = customRange.minValue.toFixed(3);
maxValue = customRange.maxValue.toFixed(3);
}
}
let minValue = range.minValue?.toFixed(3) ?? "NaN";
let maxValue = range.maxValue?.toFixed(3) ?? "NaN";
if (minValue.length > LABEL_NUMBER_MAX_LENGTH) {
minValue =
minValue.substring(0, LABEL_NUMBER_MAX_LENGTH - 2) + "...";
Expand Down Expand Up @@ -653,9 +594,7 @@ const getChartOption = (
animation: false,
backgroundColor: colors.ui.backgroundDefault,
series: dataColumns.map((col, i) => {
const minMaxValue = minMaxValues.find(
(v) => v.curve == col.columnOf.mnemonic
);
const range = dataRanges[col.columnOf.mnemonic];

const offsetData = data
.map((row, rowIndex) => {
Expand All @@ -674,8 +613,7 @@ const getChartOption = (
return null; // Return null and filter it away later to draw lines over small gaps.
}
const normalizedValue =
(value - minMaxValue.minValue) /
(minMaxValue.maxValue - minMaxValue.minValue || 1);
(value - range.minValue) / (range.maxValue - range.minValue || 1);
const offsetNormalizedValue =
normalizedValue * (1 - 2 * VALUE_OFFSET_FROM_COLUMN) +
VALUE_OFFSET_FROM_COLUMN +
Expand Down Expand Up @@ -714,6 +652,28 @@ const getChartOption = (
};
};

const getDataRanges = (
myColumns: ExportableContentTableColumn<CurveSpecification>[],
data: any[]
): CurveRanges =>
myColumns.slice(1).reduce<CurveRanges>((acc, col) => {
const curve = col.columnOf.mnemonic;
const curveData = data.map((obj) => obj[curve]).filter(Number.isFinite);

acc[curve] = {
minValue:
curveData.length === 0
? null
: curveData.reduce((min, v) => (min <= v ? min : v), Infinity),
maxValue:
curveData.length === 0
? null
: curveData.reduce((max, v) => (max >= v ? max : v), -Infinity)
};

return acc;
}, {});

const hasDataWithinRange = (
data: any[],
valueIndex: number,
Expand Down
Loading