nrroKind.cpp

Go to the documentation of this file.

//------------------------------------------------------------------------
//
//   Joe Kniss
//     6-27-03
//                   ________    ____   ___ 
//                  |        \  /    | /  /
//                  +---+     \/     |/  /
//                  +--+|  |\    /|     < 
//                  |  ||  | \  / |  |\  \ 
//                  |      |  \/  |  | \  \ 
//                   \_____|      |__|  \__\
//                       Copyright  2003 
//                      Joe Michael Kniss
//                   <<< jmk@cs.utah.edu >>>
//               "All Your Base are Belong to Us"
//-------------------------------------------------------------------------

// nrroKind.cpp

// handles things related to the extended symantics of a nrro

// if you add a new kind, beware, this is used in many places
// it is handled here, and in nrroExtended.cpp, but may also
// play a role in other things, like position and pads, these
// are affected by Ginsu, so check there too, to make sure
// you get the desired behavior.  

// Most likely you should have subclassed, but tried to 
// duplicate the "hacky" symantics provided here.

#include "nrro.h"
#include <iostream>

using namespace gutz;
using namespace std;

/////////////////////////////////////////////////////////////////////////
// printKind
/////////////////////////////////////////////////////////////////////////
void Nrro::printKind() const
{
   cerr << "  Nrro::KIND = ";
   if(_kind == KIND_NOT_SET)
      cerr << " Not Set ";
   if(_kind & KIND_UNKNOWN)
      cerr << " Unknown ";
   if(_kind & IMAGE)
      cerr << " Image ";
   if(_kind & VOLUME)
      cerr << " Volume ";
   if(_kind & TIME_SERIES)
      cerr << " Time Series ";
   if(_kind & PROXY)
      cerr << " Proxy ";
   cerr << endl;
}

/////////////////////////////////////////////////////////////////////////
// guessKind
/////////////////////////////////////////////////////////////////////////
int Nrro::guessKind() const
{
   //TODO: how do we differentiate a volume from a 
   //image time series?? we can't, the user must tell us

   int myKind = KIND_NOT_SET;

   //must be a proxy if there is no data
   if(0 == _nrrd->data)
   {
      myKind |= PROXY;
   }

   //2D data, must be an image
   if(dim() == 2)
   {
      //NrroDbg("guessKind(), IMAGE");
      return (IMAGE | (myKind & PROXY));
   }

   //3D data, could be image+channels, or volume
   if(dim() == 3)
   {
      //ahh, probably a color or color+alpha image
      if(dim(0)<5)
      {
         //NrroDbg("guessKind(), IMAGE");
         return ( IMAGE | (myKind & PROXY) );
      }
      //ok, must be a volume
      //NrroDbg("guessKind(), VOLUME");
      return ( VOLUME | (myKind & PROXY) );
   }

   //could be a multi-channel volume or a volume time series
   if(dim() == 4)
   {
      //we will assume for now that we have at most 4 channels
      //TODO: is this a good assumption???, who cares the 
      //user really should be setting this, a guess is a guess
      if(dim(0)<5)
      {
         //NrroDbg("guessKind(), VOLUME");
         return ( VOLUME | (myKind & PROXY) );
      }
      //ok, must be a volume time series
      //NrroDbg("guessKind(), VOLUME_TIME");
      return ( VOLUME | TIME_SERIES | (myKind & PROXY) );
   }

   //could only be a muti-channel time series volume
   if(dim() == 5)
   {
      //NrroDbg("guessKind(), VOLUME_TIME");
      return ( VOLUME | TIME_SERIES | (myKind & PROXY) );
   }
   //if we made it this far, we just dont know!
   NrroDbg("guessKind(), KIND_UNKNOWN");
   return KIND_UNKNOWN;
}

/////////////////////////////////////////////////////////////////////////
// force Multi Channel
/////////////////////////////////////////////////////////////////////////
int Nrro::forceMultiChannel()  //3 spatial axies and N channels 
{
   if((_kind & KIND_UNKNOWN) || (_kind == KIND_NOT_SET) || (_kind >= KIND_LAST))
   {
      NrroDbg("forceMultiChannel(), can't force, don't know what kind of data we have");
      return 1; //cant do it!
   }

   //correct dimension for image
   if((IMAGE & _kind) && (!(_kind & TIME_SERIES)) && (dim() == 3))
      return 0; //ay okay

   //scalar image, up the dimension
   if((IMAGE & _kind) && (!(_kind & TIME_SERIES)) && (dim() == 2))
   {
      //make it a 3D volume
      //NrroDbg("forceMultiChannel(), Image: forcing 3D");
      insertAxis(0);
      return 0; //worked
   }

   //correct dimension for volume and time images
   if(( (VOLUME & _kind) || ((IMAGE & _kind) && (TIME_SERIES & _kind)) )  
      && (dim() == 4))
      return 0; //ay okay

   //scalar volume or time images, up the dimension
   if( ( (VOLUME & _kind) || ((IMAGE & _kind) && (TIME_SERIES & _kind)) ) 
      && (dim() == 3))
   {
      //make it a 4D volume
      //NrroDbg("forceMultiChannel(), Time Series Image or Volume: forcing 4D");
      insertAxis(0);
      return 0; //worked
   }

   //correct dimension for time volumes
   if((VOLUME & _kind) && (TIME_SERIES & _kind) && (dim() ==5))
      return 0; //ay okay

   //scalar time volume up the dimension
   if((VOLUME & _kind) && (TIME_SERIES & _kind) && (dim() ==4))
   {
      //make it a 5D volume
      //NrroDbg("forceMultiChannel(), Time Series Volume: forcing 5D");
      insertAxis(0);
      return 0;
   }

   //we don't have symantics for these dimensions
   if((dim() > 5) || (dim()<2))
   {
      NrroDbg("forceMultiChannel(), WARNING: can't force volume to multi-channel");
      return 1;
   }

   //oh boy, how did we get here?
   NrroDbg("forceMultiChannel(), end: no action, no detection");
   return 1;
}

---

Send questions, comments, and bug reports to: