itkPSMProject.h

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkPSMProject_h
#define __itkPSMProject_h

#include "itkMacro.h"
#include "itkPSMDOMNode.h"
#include "itkDataObject.h"
#include "itkObjectFactory.h"
#include "itkEventObject.h"
#include "itkExceptionObject.h"
#include <vnl/vnl_vector_fixed.h>

namespace itk
{

  class ITK_EXPORT PSMProject : public Object
{
 public:
  typedef PSMProject Self;
  typedef Object Superclass;
  typedef SmartPointer<Self>  Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(PSMProject, Object);

  static const std::string                data_tag;
  static const std::string  distance_transform_tag;
  static const std::string distance_transforms_tag;
  static const std::string              domain_tag;
  static const std::string     correspondences_tag;
  static const std::string       cutting_plane_tag;
  static const std::string               model_tag;
  static const std::string                name_tag;
  static const std::string        optimization_tag;
  static const std::string    number_of_scales_tag;
  static const std::string       preprocessing_tag;
  static const std::string          procrustes_tag;
  static const std::string         psm_project_tag;
  static const std::string               scale_tag;
  static const std::string        scale_number_tag;
  static const std::string           variables_tag;


  void SetDOMNode(PSMDOMNode *p);

  PSMDOMNode::Pointer &GetDOMNode() 
    { return m_DOMNode; }


  bool HasDomains() const;

  const DOMNode *GetDomainNode(const std::string &name) const;

  bool HasDomainDistanceTransform(const std::string &name) const;

  const std::vector<std::string > &
    GetDomainDistanceTransform(const std::string &name) const;

  bool HasDomainCuttingPlanes(const std::string &name) const;

  std::vector<vnl_vector_fixed<double,3> > 
    GetDomainCuttingPlanes(const std::string &name) const;
    
  std::vector<std::string> GetDomainNames() const;    
  
  const std::vector<std::string> &GetModel(const std::string &name);
  
  bool HasModel(const std::string &name) const;

  const std::vector<std::string> &GetDistanceTransforms() const;

  const DOMNode *GetOptimization() const
  {
    return m_DOMNode->GetChild(optimization_tag);
  }

  unsigned int GetNumberOfOptimizationScales() const;

  bool HasOptimizationAttribute(const std::string& name, unsigned int i = 0) const;

  double GetOptimizationAttribute(const std::string &name, unsigned int i = 0) const;

  bool HasProcrustes() const;
  
  bool HasVariables(const std::string &name) const;

  std::vector<double> GetVariables(const std::string &name) const;

  const std::vector<std::string > &GetVariablesText(const std::string &name) const;

  void Stream(std::ostream &os);

 protected:
  PSMProject() {}; 
  void PrintSelf(std::ostream& os, Indent indent) const;
  virtual ~PSMProject() {};

  void StreamChildren(PSMDOMNode *,std::ostream &os, Indent indent);

  const PSMDOMNode *GetDataNode() const;

 private:
  PSMProject(const Self &); // purposely not implemented
  void operator=(const Self &); // purposely not implemented

  PSMDOMNode::Pointer m_DOMNode;
};

} // end namespace itk

#endif