tdf#74664 : add Fourier analysis tool

Add Fourier analysis tool to Statistics submenu.
Use FOURIER() formula to do all the work here.

Change-Id: Ifdaa79d8ee367f1c1f5054248e01853ffe4c6823
Reviewed-on: https://gerrit.libreoffice.org/69472
Tested-by: Jenkins
Reviewed-by: Dennis Francis <dennis.francis@collabora.com>

2 files changed, 265 insertions, 10 deletions

diff --git a/sc/source/ui/StatisticsDialogs/FourierAnalysisDialog.cxx b/sc/source/ui/StatisticsDialogs/FourierAnalysisDialog.cxx
new file mode 100644
index 000000000000..7ccabfcb0ed5
--- /dev/null
+++ b/sc/source/ui/StatisticsDialogs/FourierAnalysisDialog.cxx
@@ -0,0 +1,247 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ */
+
+#include <sfx2/dispatch.hxx>
+#include <svl/zforlist.hxx>
+#include <svl/undo.hxx>
+
+#include <formulacell.hxx>
+#include <rangelst.hxx>
+#include <scitems.hxx>
+#include <docsh.hxx>
+#include <document.hxx>
+#include <uiitems.hxx>
+#include <reffact.hxx>
+#include <docfunc.hxx>
+#include <TableFillingAndNavigationTools.hxx>
+#include <FourierAnalysisDialog.hxx>
+#include <scresid.hxx>
+#include <strings.hrc>
+
+ScFourierAnalysisDialog::ScFourierAnalysisDialog(SfxBindings* pSfxBindings,
+                                                 SfxChildWindow* pChildWindow, vcl::Window* pParent,
+                                                 ScViewData* pViewData)
+    : ScStatisticsInputOutputDialog(pSfxBindings, pChildWindow, pParent, pViewData,
+                                    "FourierAnalysisDialog",
+                                    "modules/scalc/ui/fourieranalysisdialog.ui")
+    , maLabelAddr(ScAddress::INITIALIZE_INVALID)
+    , maActualInputRange(ScAddress::INITIALIZE_INVALID)
+    , mnLen(0)
+    , mfMinMag(0.0)
+    , mbUse3DAddresses(false)
+    , mbGroupedByColumn(true)
+    , mbWithLabels(false)
+    , mbInverse(false)
+    , mbPolar(false)
+{
+    SetText(ScResId(STR_FOURIER_ANALYSIS));
+    get(mpWithLabelsCheckBox, "withlabels-check");
+    get(mpInverseCheckBox, "inverse-check");
+    get(mpPolarCheckBox, "polar-check");
+    get(mpMinMagnitudeField, "minmagnitude-spin");
+    get(mpErrorMessage, "error-message");
+
+    mpWithLabelsCheckBox->SetToggleHdl(LINK(this, ScFourierAnalysisDialog, CheckBoxHdl));
+}
+
+ScFourierAnalysisDialog::~ScFourierAnalysisDialog() { disposeOnce(); }
+
+bool ScFourierAnalysisDialog::Close()
+{
+    return DoClose(ScFourierAnalysisDialogWrapper::GetChildWindowId());
+}
+
+void ScFourierAnalysisDialog::dispose()
+{
+    mpWithLabelsCheckBox.disposeAndClear();
+    mpInverseCheckBox.disposeAndClear();
+    mpPolarCheckBox.disposeAndClear();
+    mpMinMagnitudeField.disposeAndClear();
+    mpErrorMessage.disposeAndClear();
+    ScStatisticsInputOutputDialog::dispose();
+}
+
+const char* ScFourierAnalysisDialog::GetUndoNameId() { return STR_FOURIER_ANALYSIS; }
+
+ScRange ScFourierAnalysisDialog::ApplyOutput(ScDocShell* pDocShell)
+{
+    getOptions();
+    AddressWalkerWriter aOutput(mOutputAddress, pDocShell, mDocument,
+                                formula::FormulaGrammar::mergeToGrammar(
+                                    formula::FormulaGrammar::GRAM_ENGLISH, mAddressDetails.eConv));
+    FormulaTemplate aTemplate(mDocument);
+    aTemplate.autoReplaceUses3D(mbUse3DAddresses);
+
+    aOutput.writeBoldString(mbInverse ? ScResId(STR_INVERSE_FOURIER_TRANSFORM)
+                                      : ScResId(STR_FOURIER_TRANSFORM));
+    aOutput.newLine();
+    OUString aLabel;
+    getDataLabel(aLabel);
+    if (aLabel.startsWith("="))
+        aOutput.writeFormula(aLabel);
+    else
+        aOutput.writeString(aLabel);
+
+    aOutput.newLine();
+    // Components header
+    if (!mbPolar)
+    {
+        aOutput.writeString(ScResId(STR_REAL_PART));
+        aOutput.nextColumn();
+        aOutput.writeString(ScResId(STR_IMAGINARY_PART));
+    }
+    else
+    {
+        aOutput.writeString(ScResId(STR_MAGNITUDE_PART));
+        aOutput.nextColumn();
+        aOutput.writeString(ScResId(STR_PHASE_PART));
+    }
+
+    aOutput.newLine();
+    aTemplate.autoReplaceRange("%INPUTRANGE%", maActualInputRange);
+
+    OUString aFormula;
+    genFormula(aFormula);
+
+    aTemplate.setTemplate(aFormula);
+    aOutput.writeMatrixFormula(aTemplate.getTemplate(), 2, mnLen);
+
+    return ScRange(aOutput.mMinimumAddress, aOutput.mMaximumAddress);
+}
+
+bool ScFourierAnalysisDialog::InputRangesValid()
+{
+    if (!mInputRange.IsValid())
+    {
+        mpErrorMessage->SetText(ScResId(STR_MESSAGE_INVALID_INPUT_RANGE));
+        return false;
+    }
+
+    if (!mOutputAddress.IsValid())
+    {
+        mpErrorMessage->SetText(ScResId(STR_MESSAGE_INVALID_OUTPUT_ADDR));
+        return false;
+    }
+
+    mInputRange.PutInOrder();
+
+    mbGroupedByColumn = mGroupedBy == BY_COLUMN;
+    mbWithLabels = mpWithLabelsCheckBox->IsChecked();
+
+    mbUse3DAddresses = mInputRange.aStart.Tab() != mOutputAddress.Tab();
+
+    SCSIZE nRows = mInputRange.aEnd.Row() - mInputRange.aStart.Row() + 1;
+    SCSIZE nCols = mInputRange.aEnd.Col() - mInputRange.aStart.Col() + 1;
+
+    SCSIZE nLen = mbGroupedByColumn ? nRows : nCols;
+    SCSIZE nComponents = mbGroupedByColumn ? nCols : nRows;
+
+    if (nComponents > 2)
+    {
+        OUString aMsg = mbGroupedByColumn ? ScResId(STR_MESSAGE_INVALID_NUMCOLS)
+                                          : ScResId(STR_MESSAGE_INVALID_NUMROWS);
+        mpErrorMessage->SetText(aMsg);
+        return false;
+    }
+
+    if (mbWithLabels && nLen < 2)
+    {
+        mpErrorMessage->SetText(ScResId(STR_MESSAGE_NODATA_IN_RANGE));
+        return false;
+    }
+
+    // Include space for writing the title, label and Real/Imaginary/Magnitude/Phase heading.
+    SCSIZE nLastOutputRow = mOutputAddress.Row() + nLen + 2;
+    if (mbWithLabels)
+        --nLastOutputRow;
+
+    if (nLastOutputRow > MAXROW)
+    {
+        mpErrorMessage->SetText(ScResId(STR_MESSAGE_OUTPUT_TOO_LONG));
+        return false;
+    }
+
+    ScAddress aActualStart(mInputRange.aStart);
+
+    if (mbWithLabels)
+    {
+        if (mbGroupedByColumn)
+            aActualStart.IncRow();
+        else
+            aActualStart.IncCol();
+
+        if (nComponents == 1)
+            maLabelAddr = mInputRange.aStart;
+        else
+            mbWithLabels = false;
+
+        mnLen = nLen - 1;
+    }
+    else
+    {
+        mnLen = nLen;
+    }
+
+    maActualInputRange = ScRange(aActualStart, mInputRange.aEnd);
+    mpErrorMessage->SetText("");
+
+    return true;
+}
+
+void ScFourierAnalysisDialog::getOptions()
+{
+    mbInverse = mpInverseCheckBox->IsChecked();
+    mbPolar = mpPolarCheckBox->IsChecked();
+
+    sal_Int32 nDeciBels = static_cast<sal_Int32>(mpMinMagnitudeField->GetValue());
+    if (nDeciBels <= -150)
+        mfMinMag = 0.0;
+    else
+        mfMinMag = pow(10.0, static_cast<double>(nDeciBels) / 10.0);
+}
+
+void ScFourierAnalysisDialog::getDataLabel(OUString& rLabel)
+{
+    if (mbWithLabels)
+    {
+        rLabel = "="
+                 + maLabelAddr.Format(mbUse3DAddresses ? ScRefFlags::ADDR_ABS_3D
+                                                       : ScRefFlags::ADDR_ABS,
+                                      mDocument, mAddressDetails);
+
+        return;
+    }
+
+    OUString aDataSrc(
+        mInputRange.Format(mbUse3DAddresses ? ScRefFlags::RANGE_ABS_3D : ScRefFlags::RANGE_ABS,
+                           mDocument, mAddressDetails));
+
+    rLabel = ScResId(STR_INPUT_DATA_RANGE) + " : " + aDataSrc;
+    return;
+}
+
+void ScFourierAnalysisDialog::genFormula(OUString& rFormula)
+{
+    static const OUString aSep(";");
+
+    if (!mbPolar)
+    {
+        rFormula = "FOURIER(%INPUTRANGE%;" + OUString::boolean(mbGroupedByColumn) + aSep
+                   + OUString::boolean(mbInverse) + ")";
+        return;
+    }
+
+    rFormula = "FOURIER(%INPUTRANGE%;" + OUString::boolean(mbGroupedByColumn) + aSep
+               + OUString::boolean(mbInverse) + ";true;" + OUString::number(mfMinMag) + ")";
+}
+
+IMPL_LINK_NOARG(ScFourierAnalysisDialog, CheckBoxHdl, CheckBox&, void) { ValidateDialogInput(); }
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sc/source/ui/StatisticsDialogs/StatisticsInputOutputDialog.cxx b/sc/source/ui/StatisticsDialogs/StatisticsInputOutputDialog.cxx
index 7cb6e8724774..8d630ebc7e63 100644
--- a/sc/source/ui/StatisticsDialogs/StatisticsInputOutputDialog.cxx
+++ b/sc/source/ui/StatisticsDialogs/StatisticsInputOutputDialog.cxx
@@ -180,11 +180,7 @@ void ScStatisticsInputOutputDialog::SetReference( const ScRange& rReferenceRange
         }
     }
 
-    // Enable OK if both, input range and output address are set.
-    if (mInputRange.IsValid() && mOutputAddress.IsValid())
-        mpButtonOk->Enable();
-    else
-        mpButtonOk->Disable();
+    ValidateDialogInput();
 }
 
 IMPL_LINK_NOARG( ScStatisticsInputOutputDialog, OkClicked, Button*, void )
@@ -217,6 +213,8 @@ IMPL_LINK_NOARG( ScStatisticsInputOutputDialog, GroupByChanged, RadioButton&, vo
         mGroupedBy = BY_COLUMN;
     else if (mpGroupByRowsRadio->IsChecked())
         mGroupedBy = BY_ROW;
+
+    ValidateDialogInput();
 }
 
 IMPL_LINK_NOARG( ScStatisticsInputOutputDialog, RefInputModifyHandler, Edit&, void )
@@ -268,11 +266,7 @@ IMPL_LINK_NOARG( ScStatisticsInputOutputDialog, RefInputModifyHandler, Edit&, vo
         }
     }
 
-    // Enable OK if both, input range and output address are set.
-    if (mInputRange.IsValid() && mOutputAddress.IsValid())
-        mpButtonOk->Enable();
-    else
-        mpButtonOk->Disable();
+    ValidateDialogInput();
 }
 
 void ScStatisticsInputOutputDialog::CalculateInputAndWriteToOutput()
@@ -288,4 +282,18 @@ void ScStatisticsInputOutputDialog::CalculateInputAndWriteToOutput()
     pDocShell->PostPaint( aOutputRange, PaintPartFlags::Grid );
 }
 
+bool ScStatisticsInputOutputDialog::InputRangesValid()
+{
+    return mInputRange.IsValid() && mOutputAddress.IsValid();
+}
+
+void ScStatisticsInputOutputDialog::ValidateDialogInput()
+{
+    // Enable OK button if all inputs are ok.
+    if (InputRangesValid())
+        mpButtonOk->Enable();
+    else
+        mpButtonOk->Disable();
+}
+
 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */