SeparableConvolutionImageFilter.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2002- 2009, Hammersmith Imanet Ltd
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
*/

#ifndef __stir_SeparableConvolutionImageFilter_H__
#define __stir_SeparableConvolutionImageFilter_H__

#include "stir/SeparableArrayFunctionObject.h"
#include "stir/RegisteredParsingObject.h"
#include "stir/DataProcessor.h"
#include "stir/DiscretisedDensity.h"
#include "stir/VectorWithOffset.h"
#include <vector>

START_NAMESPACE_STIR

// TODO!! remove define
// currently fixed at 3 because I didn't really have a good idea for the parsing
// keywords in n dimensions.
//
#define num_dimensions 3

template <typename elemT>
class SeparableConvolutionImageFilter : public RegisteredParsingObject<SeparableConvolutionImageFilter<elemT>,
                                                                       DataProcessor<DiscretisedDensity<3, elemT>>,
                                                                       DataProcessor<DiscretisedDensity<3, elemT>>>
{
private:
  typedef RegisteredParsingObject<SeparableConvolutionImageFilter<elemT>,
                                  DataProcessor<DiscretisedDensity<3, elemT>>,
                                  DataProcessor<DiscretisedDensity<3, elemT>>>
      base_type;

public:
  static const char* const registered_name;

  SeparableConvolutionImageFilter();


  SeparableConvolutionImageFilter(const VectorWithOffset<VectorWithOffset<elemT>>& filter_coefficients);


  VectorWithOffset<VectorWithOffset<elemT>> get_filter_coefficients();
  void set_filter_coefficients(const VectorWithOffset<VectorWithOffset<elemT>>& v);
  // These methods are made available as VectorWithOffset<VectorWithOffset<elemT>> is not accessable via swig
  VectorWithOffset<elemT> get_filter_coefficients(const int axis);
  void set_filter_coefficients(const int axis, const VectorWithOffset<elemT>& v);

private:
  // silly business because KeyParser supports only LIST_OF_DOUBLES
  // TODO remove
  std::vector<std::vector<double>> filter_coefficients_for_parsing;

  VectorWithOffset<VectorWithOffset<elemT>> filter_coefficients;

  SeparableArrayFunctionObject<num_dimensions, elemT> filter;

  void set_defaults() override;
  void initialise_keymap() override;
  bool post_processing() override;

  Succeeded virtual_set_up(const DiscretisedDensity<num_dimensions, elemT>& image) override;
  void virtual_apply(DiscretisedDensity<num_dimensions, elemT>& out_density,
                     const DiscretisedDensity<num_dimensions, elemT>& in_density) const override;
  void virtual_apply(DiscretisedDensity<num_dimensions, elemT>& density) const override;
};

#undef num_dimensions

END_NAMESPACE_STIR

#endif