cmtkStudyList.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2011 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2752 $
//
//  $LastChangedDate: 2011-01-17 11:33:31 -0800 (Mon, 17 Jan 2011) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkStudyList_h_included_
#define __cmtkStudyList_h_included_

#include <cmtkconfig.h>

#include <IO/cmtkStudy.h>

#include <Base/cmtkAffineXform.h>
#include <Base/cmtkWarpXform.h>

#include <map>
#include <list>

namespace
cmtk
{


typedef std::multimap<Study::SmartPtr, Xform::SmartPtr> StudyToXform;
typedef std::map< Study::SmartPtr, StudyToXform > StudyToStudyToXform;

class StudyList :
  public StudyToStudyToXform
{
public:
  typedef StudyList Self;

  typedef SmartPointer<Self> SmartPtr;

  typedef StudyToStudyToXform Superclass;

  StudyList() {};

  StudyList( const StudyList& slist ) : Superclass( slist ) {};

  const Study *GetStudy( const unsigned int studyIndex ) const;

  Study::SmartPtr GetStudy( const unsigned int studyIndex );  

  const Study *FindStudyPath( const char *fileSystemPath ) const;

  Study::SmartPtr FindStudyPath( const char *fileSystemPath , const bool create = false  );

  const Study *FindStudyName( const char *name  ) const;

  Study::SmartPtr FindStudyName( const char *name  );

  Study::SmartPtr AddStudy( const char *fileSystemPath  );
  
  void AddStudy( Study::SmartPtr& study  );
  
  void AddXform( Study::SmartPtr& fromStudy, Study::SmartPtr& toStudy, AffineXform::SmartPtr& affineXform, WarpXform::SmartPtr& warpXform = WarpXform::SmartPtr::Null );

  void AddXform( const char *fromStudyPath , 
                 const char *toStudyPath , 
                 AffineXform::SmartPtr& affineXform , 
                 WarpXform::SmartPtr& warpXform = WarpXform::SmartPtr::Null );
  
  void DeleteStudy( const Study* study  );

  void DeleteStudy( const unsigned int studyIndex  );
};


} // namespace cmtk

#endif // #ifndef __cmtkStudyList_h_included_