vcsl_matrix.h

Go to the documentation of this file.

// This is core/vcsl/vcsl_matrix.h
#ifndef vcsl_matrix_h_
#define vcsl_matrix_h_
//:
// \file
// \brief A coordinate transformation specified by a transformation matrix
// \author Francois BERTEL
//
// \verbatim
//  Modifications
//   2000/07/19 Francois BERTEL Creation.
//   2002/01/22 Peter Vanroose - return type of execute() and inverse() changed to non-ptr
//   2002/01/28 Peter Vanroose - std::vector member matrix_ changed to non-ptr
//   2002/12/30 Peter Vanroose - removed unused and commented out member _vector
//   2004/09/17 Peter Vanroose - made matrix_list() non-virtual - it just returns a member and should not be overloaded
// \endverbatim

#include <vcsl/vcsl_spatial_transformation.h>
#include <vcsl/vcsl_matrix_sptr.h>
#include <vcsl/vcsl_matrix_param.h>
#include <vnl/vnl_vector.h>
#include <vnl/vnl_matrix.h>

//: A coordinate transformation specified by a transformation matrix
class vcsl_matrix
  :public vcsl_spatial_transformation
{
 public:
  //***************************************************************************
  // Constructors/Destructor
  //***************************************************************************

  // Default constructor
  vcsl_matrix() = default;

  // Destructor
  ~vcsl_matrix() override = default;

  //***************************************************************************
  // Status report
  //***************************************************************************

  //: Is `this' invertible at time `time'?
  //  REQUIRE: valid_time(time)
  // Pure virtual function of vcsl_spatial_transformation
  bool is_invertible(double time) const override;

  //: Is `this' correctly set ?
  // Virtual function of vcsl_spatial_transformation
  bool is_valid() const override
  { return vcsl_spatial_transformation::is_valid() && this->duration()==matrix_.size(); }

  //***************************************************************************
  // Transformation parameters
  //***************************************************************************

  //: Set the parameters of a static translation
  void set_static( const vcsl_matrix_param_sptr& new_matrix);

  //: Set the direction vector variation along the time
  void set_matrix(list_of_vcsl_matrix_param_sptr const& m) { matrix_=m; }

  list_of_vcsl_matrix_param_sptr matrix_list() const { return matrix_; }

  // Pure virtual function of vcsl_spatial_transformation
  vnl_vector<double> execute(const vnl_vector<double> &v,
                                     double time) const override;

  // Pure virtual function of vcsl_spatial_transformation
  vnl_vector<double> inverse(const vnl_vector<double> &v,
                                     double time) const override;

 protected:
  vnl_matrix<double> param_to_matrix(const vcsl_matrix_param_sptr& from,bool type) const;
  vnl_matrix<double> matrix_value(double time, bool type) const;
  list_of_vcsl_matrix_param_sptr matrix_;
};

#endif // vcsl_matrix_h_