TraceContainerBase.h

Go to the documentation of this file.

/*=========================================================================
 Authors: The GoFigure Dev. Team.
 at Megason Lab, Systems biology, Harvard Medical school, 2009-11

 Copyright (c) 2009-11, President and Fellows of Harvard College.
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

 Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
 Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.
 Neither the name of the  President and Fellows of Harvard College
 nor the names of its contributors may be used to endorse or promote
 products derived from this software without specific prior written
 permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/

#ifndef __TraceContainerBase_h
#define __TraceContainerBase_h

#include <Qt>
#include <QObject>
#include "QGoImageView3D.h"

#include "vtkProperty.h"
#include "StructureHelper.h"
#include "QGoGUILibConfigure.h"

#include "vtkIntArray.h"
#include "vtkActor.h"
#include "vtkMapper.h"
#include "vtkDataSet.h"
#include "vtkPointData.h"

#include "TraceStructure.h"

#include "boost/multi_index_container.hpp"
#include "boost/multi_index/member.hpp"
#include "boost/multi_index/hashed_index.hpp"
#include "boost/multi_index/ordered_index.hpp"
#include "boost/numeric/conversion/cast.hpp"
#include "boost/lexical_cast.hpp"


//-----------------------------------------------------------------------------

template <class T> struct change_highlighted
{
  change_highlighted(bool& iHighlight):highlighted(iHighlight){}

  void operator()(T& iStructure)
  {
    iStructure.Highlighted = highlighted;
  }

private:
  bool highlighted;
};

//-----------------------------------------------------------------------------

//-----------------------------------------------------------------------------

template <class T> struct change_visible
{
  change_visible(const bool& iVisibile):visible(iVisibile){}

  void operator()(T& iStructure)
  {
    iStructure.Visible = visible;
  }

private:
  bool visible;
};

//-----------------------------------------------------------------------------

//-----------------------------------------------------------------------------

template <class T> struct change_actors
{
  change_actors(std::vector<vtkActor*>& iActors):actor(iActors){}

  void operator()(T& iStructure)
  {
    iStructure.ActorXY = actor[0];
    iStructure.ActorXZ = actor[1];
    iStructure.ActorYZ = actor[2];
    iStructure.ActorXYZ = actor[3];
  }

private:
  std::vector<vtkActor*> actor;
};

//-----------------------------------------------------------------------------

//-----------------------------------------------------------------------------

template <class T> struct change_color
{
  change_color(QColor iColor):color(iColor){}

  void operator()(T& iStructure)
  {
    iStructure.rgba[0] = color.redF();
    iStructure.rgba[1] = color.greenF();
    iStructure.rgba[2] = color.blueF();
    iStructure.rgba[3] = color.alphaF();
  }

private:
  QColor color;
};

//-----------------------------------------------------------------------------

template< class TContainer >
class TraceContainerBase : public QObject
{
public:
  typedef TContainer                                    MultiIndexContainerType;
  typedef typename MultiIndexContainerType::value_type  MultiIndexContainerElementType;

  typedef typename MultiIndexContainerType::template index< TraceID >::type::iterator
  MultiIndexContainerTraceIDIterator;

  typedef typename MultiIndexContainerType::template index< CollectionID >::type::iterator
  MultiIndexContainerCollectionIDIterator;

  typedef typename MultiIndexContainerType::template index< Highlighted >::type::iterator
  MultiIndexContainerHighlightedIterator;

  typedef typename MultiIndexContainerType::template index< Visible >::type::iterator
  MultiIndexContainerVisibleIterator;

  explicit TraceContainerBase( QObject* iParent, QGoImageView3D* iView );

  virtual ~TraceContainerBase();

  MultiIndexContainerType m_Container;

  QGoImageView3D *m_ImageView;

  MultiIndexContainerElementType m_CurrentElement;

  // ----------------------------------------------------------------------

  template< class TIterator >
  void Print(TIterator iBegin, TIterator iEnd)
    {
    TIterator it = iBegin;

    while ( it != iEnd )
      {
      std::cout << *it;
      std::cout << "***" << std::endl;
      std::cout << std::endl;
      ++it;
      }
    }

  template< class TIndex >
  void Print()
    {
    using boost::multi_index::get;

    this->Print(  this->m_Container.get< TIndex >().begin(),
                  this->m_Container.get< TIndex >().end() );
    }

  void Print();

  // ----------------------------------------------------------------------

  void SetHighlightedProperty(vtkProperty *iProperty);

  vtkProperty * GetHighlightedProperty();

  unsigned int GetCollectionIDOfGivenTraceID( unsigned int iTraceID);

  template< class TList >
  void UpdateVisualizationForGivenIDs(TList iList)
    {
    using boost::multi_index::get;

    typename TList::iterator it = iList.begin();

    while ( it != iList.end() )
      {
      MultiIndexContainerTraceIDIterator id_it =
        m_Container.get< TraceID >().find( static_cast< unsigned int >( *it ) );

      if ( id_it != m_Container.get< TraceID >().end() )
        {
        bool test = false;
        m_Container.get< TraceID >().
            modify( id_it , change_visible<MultiIndexContainerElementType>(test) );
        m_Container.get< TraceID >().
            modify( id_it , change_highlighted<MultiIndexContainerElementType>(test) );

        vtkProperty *tproperty = vtkProperty::New();
        tproperty->SetColor(id_it->rgba[0], id_it->rgba[1], id_it->rgba[2]);
        tproperty->SetOpacity(id_it->rgba[3]);
        tproperty->SetLineWidth( this->m_IntersectionLineWidth );

        if ( id_it->Nodes )
          {
          bool test2 = id_it->Visible;
          m_Container.get< TraceID >().
              modify( id_it , change_visible<MultiIndexContainerElementType>( test2 ) );

          std::vector< vtkActor * > actor =
              this->m_ImageView->AddContour( id_it->Nodes, tproperty );

          m_Container.get< TraceID >().
              modify( id_it , change_actors<MultiIndexContainerElementType>( actor ) );

          typedef void ( QGoImageView3D::*ImageViewMember )(const int &, vtkActor *);
          ImageViewMember f;

          if ( id_it->Visible )
            {
            f = &QGoImageView3D::AddActor;
            }
          else
            {
            f = &QGoImageView3D::RemoveActor;
            }

          assert( m_ImageView );
          for ( int i = 0; i < 4; i++ )
            {
            ( m_ImageView->*f )(i, actor[i]);
            }
          }
        else
          {
          m_Container.get< TraceID >().
              modify( id_it , change_visible<MultiIndexContainerElementType>(test) );
          }
        }
      ++it;
      }
    }

  template< class TIndex >
  void UpdateVisualizationForGivenElement(
    typename MultiIndexContainerType::template index< TIndex >::type::iterator& iIt,
    std::vector< vtkActor * > iActors,
    const bool & iHighlighted,
    const bool & iVisible)
    {

    using boost::multi_index::get;

    if ( iActors.size() == 4 )
      {
      m_Container.get< TIndex >().
          modify( iIt , change_actors<MultiIndexContainerElementType>(iActors) );
      }
    bool highlighted = iHighlighted;
    bool visible = iVisible;
    m_Container.get< TIndex >().
        modify( iIt , change_visible<MultiIndexContainerElementType>(visible) );
    m_Container.get< TIndex >().
        modify( iIt , change_highlighted<MultiIndexContainerElementType>(highlighted) );

    typedef void ( QGoImageView3D::*ImageViewMember )(const int &, vtkActor *);
    ImageViewMember f;

    if ( iVisible )
      {
      f = &QGoImageView3D::AddActor;
      }
    else
      {
      f = &QGoImageView3D::RemoveActor;
      }

    assert( m_ImageView );
    for ( int i = 0; i < 4; i++ )
      {
      ( m_ImageView->*f )(i, iActors[i]);
      }
    }

  void Insert(const MultiIndexContainerElementType & iE);

  void InsertCurrentElement();

  void ResetCurrentElement();

  void UpdateCurrentElementFromDB(unsigned int iTraceID, double irgba[4],
    bool IsVisible = false);

  void UpdateCurrentElementCollection(unsigned int iCollectionID);

  vtkPolyData* GetCurrentElementNodes();

  double* GetCurrentElementColor();

  std::vector<vtkActor*> GetActorGivenTraceID( unsigned int iTraceID );

  bool UpdateCurrentElementFromExistingOne(unsigned int iTraceID, bool iErase = true);

  template< class TIndex >
  bool UpdateCurrentElementFromExistingOne(
    typename MultiIndexContainerType::template index< TIndex >::type::iterator iIt )
    {
    using boost::multi_index::get;

    // update current element
    this->m_CurrentElement = *iIt;

    // clean the container but don't erase the pointers since we still have the
    // adresses in the m_CurrentElement
    m_Container.get< TIndex >().erase( iIt );

    return true;
    }

  bool UpdateElementVisibilityWithGivenTraceID(const unsigned int & iId);

  //-------------------------------------------------------------------------

  bool
  RemoveElementFromVisualizationWithGivenTraceID(
    const unsigned int & iId);

  bool UpdateElementHighlightingWithGivenTraceID(const unsigned int & iId);

  //-------------------------------------------------------------------------

  std::list< unsigned int > GetHighlightedElementsTraceID();

  std::list< unsigned int > GetHighlightedElementsCollectionID();

  std::list< vtkPolyData* > GetHighlightedElements();

  virtual bool DeleteElement(const unsigned int & iId) = 0;

  virtual bool DeleteElement(MultiIndexContainerTraceIDIterator iIter) = 0;

  virtual std::list< unsigned int > DeleteAllHighlightedElements() = 0;

  std::list< unsigned int > UpdateAllHighlightedElementsWithGivenColor(
    QColor iColor);

  void SetColorCode( const std::string& iColumnName,
                     const std::map< unsigned int, std::string >& iValues );

  template< typename TValue >
  void SetColorCode( const std::string& iColumnName,
                     const std::map< unsigned int, TValue >& iValues )
    {
    typedef TValue                                        ValueType;
    typedef typename std::map< unsigned int, ValueType >  MapType;
    typedef typename MapType::const_iterator              MapConstIterator;

    using boost::multi_index::get;

    if( iColumnName.empty() || iValues.empty() )
      {
      RenderAllElementsWithOriginalColors();
      return;
      }

    MapConstIterator it = iValues.begin();

    double temp = 0.;
    try
      {
      temp = boost::numeric_cast< double >( it->second );
      }
    catch( boost::numeric::bad_numeric_cast& e )
      {
      std::cout <<  e.what() <<std::endl;
      return;
      }

    double min_value = temp;
    double max_value = temp;

    while( it != iValues.end() )
      {
      MultiIndexContainerTraceIDIterator
          trace_it = this->m_Container.get<TraceID>().find( it->first );

      if( trace_it != this->m_Container.get<TraceID>().end() )
        {
          if (trace_it->Nodes) //make sure the trace has points !!!
          {
          // Here let's make sure you are not passing crazy values!
          try
            {
            temp = boost::numeric_cast< double >( it->second );
            }
          catch( boost::numeric::bad_numeric_cast& e )
            {
            std::cout << e.what() <<std::endl;
            return;
            }

          if( temp > max_value )
            {
            max_value = temp;
            }
          if( temp < min_value )
            {
            min_value = temp;
            }

          trace_it->SetScalarData( iColumnName, temp );
          }
        } //end make sure the trace has points !!!
      ++it;
      }

    SetScalarRangeForAllElements( min_value, max_value );

    if( m_ImageView )
      {
      this->m_ImageView->UpdateRenderWindows();
      }
    }

  void SetRandomColor( const std::string& iColumnName,
                       const std::map< unsigned int, unsigned int >& iIds );

  void SetRandomColor( const std::string& iColumnName,
                       const std::map< unsigned int, std::string >& iValues );

  void SetLookupTableForColorCoding( vtkLookupTable* iLut );

  void SetIntersectionLineWidth( const float& iWidth );


protected:
  vtkProperty *m_HighlightedProperty;
  float m_IntersectionLineWidth;

  virtual void UpdateElementHighlightingWithGivenTraceIDsBase( const QStringList& iList,
                                                   const Qt::CheckState& iCheck );

  virtual void UpdateElementVisibilityWithGivenTraceIDsBase( const QStringList& iList,
                                                 const Qt::CheckState& iCheck );


  void RenderAllElementsWithOriginalColors();

  void SetScalarRangeForAllElements(const double& iMin, const double& iMax );

  void UpdateCurrentElementFromVisuBase( std::vector< vtkActor* >& iActors,
                                         vtkPolyData* iNodes,
                                         const bool& iHighlighted,
                                         const bool& iVisible );

  void UpdateElementHighlightingWithTraceID(
      const unsigned int& oTraceId,
      Qt::CheckState& oState )
    {
      using boost::multi_index::get;

      typedef typename MultiIndexContainerType::template index< TraceID >::type::iterator
      IteratorType;
      IteratorType it = m_Container.get< TraceID >().find(oTraceId);

      vtkProperty *temp_property = vtkProperty::New();

      assert ( it != m_Container.get< TraceID >().end() );

      if ( it->Highlighted )
        {
        temp_property->SetColor(it->rgba[0],
                                it->rgba[1],
                                it->rgba[2]);
        temp_property->SetOpacity(it->rgba[3]);
        temp_property->SetLineWidth( this->m_IntersectionLineWidth );
        }
      else
        {
        temp_property->DeepCopy(this->m_HighlightedProperty);
        }

      it->SetActorProperties( temp_property );

      temp_property->Delete();

      // Note: it->Highlighted is the status before picking the actor
      bool checked = false;
      if ( !it->Highlighted )
        {
        oState = Qt::Checked;
        checked = true;
        }
      else
        {
        oState = Qt::Unchecked;
        }

      m_Container.get< TraceID >().
          modify( it , change_highlighted<MultiIndexContainerElementType>(checked) );

      assert( m_ImageView );

      m_ImageView->UpdateRenderWindows();
    }

  void UpdateElementVisibilityWithTraceID(
      const unsigned int& oTraceId,
      const bool& iState)
    {
    using boost::multi_index::get;

    typedef typename MultiIndexContainerType::template index< TraceID >::type::iterator
    IteratorType;
    IteratorType it = m_Container.get< TraceID >().find(oTraceId);

    assert ( it != m_Container.get< TraceID >().end() );

    if ( it->Visible != iState )
      {
      it->SetActorVisibility( iState );
      m_Container.get< TraceID >().
          modify( it , change_visible<MultiIndexContainerElementType>(iState) );
      }
    }
};

#include "TraceContainerBase.txx"

#endif // __TraceContainerBase_h