vtkImageMathematics.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkImageMathematics_h
#define vtkImageMathematics_h

// Operation options.
#define VTK_ADD 0
#define VTK_SUBTRACT 1
#define VTK_MULTIPLY 2
#define VTK_DIVIDE 3
#define VTK_INVERT 4
#define VTK_SIN 5
#define VTK_COS 6
#define VTK_EXP 7
#define VTK_LOG 8
#define VTK_ABS 9
#define VTK_SQR 10
#define VTK_SQRT 11
#define VTK_MIN 12
#define VTK_MAX 13
#define VTK_ATAN 14
#define VTK_ATAN2 15
#define VTK_MULTIPLYBYK 16
#define VTK_ADDC 17
#define VTK_CONJUGATE 18
#define VTK_COMPLEX_MULTIPLY 19
#define VTK_REPLACECBYK 20

#include "vtkImagingMathModule.h" // For export macro
#include "vtkThreadedImageAlgorithm.h"

VTK_ABI_NAMESPACE_BEGIN
// Excluded from JavaScript wrapping because it provides overloads for SetInputConnection which
// take precedence for all vtkAlgorithm(s)
class VTKIMAGINGMATH_EXPORT VTK_WRAPEXCLUDE_JAVASCRIPT vtkImageMathematics
  : public vtkThreadedImageAlgorithm
{
public:
  static vtkImageMathematics* New();
  vtkTypeMacro(vtkImageMathematics, vtkThreadedImageAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetMacro(Operation, int);
  vtkGetMacro(Operation, int);

  void SetOperationToAdd() { this->SetOperation(VTK_ADD); }

  void SetOperationToSubtract() { this->SetOperation(VTK_SUBTRACT); }

  void SetOperationToMultiply() { this->SetOperation(VTK_MULTIPLY); }

  void SetOperationToDivide() { this->SetOperation(VTK_DIVIDE); }

  void SetOperationToConjugate() { this->SetOperation(VTK_CONJUGATE); }

  void SetOperationToComplexMultiply() { this->SetOperation(VTK_COMPLEX_MULTIPLY); }

  void SetOperationToInvert() { this->SetOperation(VTK_INVERT); }

  void SetOperationToSin() { this->SetOperation(VTK_SIN); }

  void SetOperationToCos() { this->SetOperation(VTK_COS); }

  void SetOperationToExp() { this->SetOperation(VTK_EXP); }

  void SetOperationToLog() { this->SetOperation(VTK_LOG); }

  void SetOperationToAbsoluteValue() { this->SetOperation(VTK_ABS); }

  void SetOperationToSquare() { this->SetOperation(VTK_SQR); }

  void SetOperationToSquareRoot() { this->SetOperation(VTK_SQRT); }

  void SetOperationToMin() { this->SetOperation(VTK_MIN); }

  void SetOperationToMax() { this->SetOperation(VTK_MAX); }

  void SetOperationToATAN() { this->SetOperation(VTK_ATAN); }

  void SetOperationToATAN2() { this->SetOperation(VTK_ATAN2); }

  void SetOperationToMultiplyByK() { this->SetOperation(VTK_MULTIPLYBYK); }

  void SetOperationToAddConstant() { this->SetOperation(VTK_ADDC); }

  void SetOperationToReplaceCByK() { this->SetOperation(VTK_REPLACECBYK); }


  vtkSetMacro(ConstantK, double);
  vtkGetMacro(ConstantK, double);


  vtkSetMacro(ConstantC, double);
  vtkGetMacro(ConstantC, double);


  vtkSetMacro(DivideByZeroToC, vtkTypeBool);
  vtkGetMacro(DivideByZeroToC, vtkTypeBool);
  vtkBooleanMacro(DivideByZeroToC, vtkTypeBool);


  virtual void SetInput1Data(vtkDataObject* in) { this->SetInputData(0, in); }
  virtual void SetInput2Data(vtkDataObject* in) { this->AddInputData(0, in); }
  void SetInputConnection(int idx, vtkAlgorithmOutput* input) override;
  void SetInputConnection(vtkAlgorithmOutput* input) override
  {
    this->SetInputConnection(0, input);
  }

  virtual void ReplaceNthInputConnection(int idx, vtkAlgorithmOutput* input);


  void SetInputData(int idx, vtkDataObject* input);
  void SetInputData(vtkDataObject* input) { this->SetInputData(0, input); }


  vtkDataObject* GetInput(int idx);
  vtkDataObject* GetInput() { return this->GetInput(0); }

  int GetNumberOfInputs() { return this->GetNumberOfInputConnections(0); }

protected:
  vtkImageMathematics();
  ~vtkImageMathematics() override = default;

  int Operation;
  double ConstantK;
  double ConstantC;
  vtkTypeBool DivideByZeroToC;

  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  void ThreadedRequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData,
    VTK_FUTURE_CONST int outExt[6], int threadId) override;

  int FillInputPortInformation(int port, vtkInformation* info) override;

private:
  vtkImageMathematics(const vtkImageMathematics&) = delete;
  void operator=(const vtkImageMathematics&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif