svkMrsImageData.h

Go to the documentation of this file.

/*
 *  Copyright © 2009-2014 The Regents of the University of California.
 *  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.
 *  •   None of the names of any campus of the University of California, the name 
 *      "The Regents of the University of California," or the names of any 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 HOLDERS 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.
 */



/*
 *  $URL$
 *  $Rev$
 *  $Author$
 *  $Date$
 *
 *  Authors:
 *      Jason C. Crane, Ph.D.
 *      Beck Olson
 */


#ifndef SVK_MRS_IMAGE_DATA_H
#define SVK_MRS_IMAGE_DATA_H


#include <vtkObjectFactory.h>
#include <vtkImageData.h>
#include <vtkUnstructuredGrid.h>
#include <vtkPlanesIntersection.h>
#include <vtkHexahedron.h>
#include <svk4DImageData.h>
#include <svkMriImageData.h>


namespace svk {


class svkMrsImageData: public svk4DImageData
{

    public:

        typedef enum {
            TIMEPOINT = 0,
            CHANNEL
        } MrsVolumeIndex;

        vtkTypeMacro( svkMrsImageData, svk4DImageData);
        static svkMrsImageData* New();
        static vtkObject*       NewObject();

        void           GetIndexArray( int timePoint, int channel, int* indexArray );
        vtkDataArray*  GetSpectrum( int i );
        vtkDataArray*  GetSpectrum( int i, int j, int k, int timePoint = 0, int channel=0 );
        vtkDataArray*  GetSpectrumFromID( int index, int timePoint = 0, int channel = 0 );
        void           GetImage(
                            svkMriImageData* image,
                            int point,
                            int timePoint,
                            int channel,
                            int component,
                            vtkstd::string seriesDescription, 
                            int vtkDataType = VTK_VOID
                       );

        void           GetImage( 
                            svkMriImageData* image, 
                            int point, 
                            svkDcmHeader::DimensionVector* dimensionVector, 
                            int component, 
                            string seriesDescription, 
                            int vtkDataType = VTK_VOID
                       ); 

        void           SetImage( vtkImageData* image, int point, int timePoint = 0, int channel = 0 );
        void           SetImage( vtkImageData* image, int point, svkDcmHeader::DimensionVector* dimensionVector );
        void           SetImageComponent( vtkImageData* image, int point, int timePoint = 0, int channel = 0, int component = 0); // real

        int            GetClosestSlice(double* posLPS, svkDcmHeader::Orientation sliceOrientation, double tolerance = -1 );

        void           EstimateDataRange( double range[2], int minPt, int maxPt, int component, int* tlcBrc = NULL, int timePoint = 0, int channel = 0   );

        int            GetVolumeIndexSize( int volumeIndex );
        int            GetNumberOfVolumeDimensions( );
        int            GetNumberOfChannels();

        bool           HasSelectionBox( );
        void           GenerateSelectionBox( vtkUnstructuredGrid* selectionBox );
        void           GetSelectionBoxCenter( double* selBoxCenter );
        void           GetSelectionBoxDimensions( float* dims );
        bool           IsSliceInSelectionBox( int slice, svkDcmHeader::Orientation orientation = svkDcmHeader::UNKNOWN_ORIENTATION );
        void           GetSelectionBoxSpacing( double spacing[3] );
        void           GetSelectionBoxOrigin(  double origin[3] );
        void           GetSelectionBoxMaxMin( double minPoint[3], double maxPoint[3], double tolerance = DEFAULT_SELECTION_TOLERANCE );
        void           Get2DProjectedTlcBrcInSelectionBox(
                            int tlcBrc[2],
                            svkDcmHeader::Orientation orientation,
                            int slice,
                            double tolerance = DEFAULT_SELECTION_TOLERANCE
                       );

        void           Get3DVoxelsInSelectionBox(
                            int tlcVoxel[3],
                            int brcVoxel[3],
                            double tolerance = DEFAULT_SELECTION_TOLERANCE
                       );

        void           GetSelectionBoxMask( short* mask, double tolerance = DEFAULT_SELECTION_TOLERANCE );

        void           Get3DTlcBrcInSelectionBox(
                            int tlcBrc[2],
                            double tolerance = DEFAULT_SELECTION_TOLERANCE
                       );
        void           Redimension( svkDcmHeader::DimensionVector* dimensionVector, double* newOrigin, double* newSpacing, bool resizeSelectionBoxToFOV = false );
        void           InitializeDataArrays( );

    protected:

        svkMrsImageData();
        ~svkMrsImageData();

    private:

        int            numChannels;

        void           GetTlcBrcInSelectionBox(
                            int tlcBrc[2],
                            svkDcmHeader::Orientation orientation = svkDcmHeader::UNKNOWN_ORIENTATION,
                            int slice = -1 ,
                            double tolerance = DEFAULT_SELECTION_TOLERANCE
                       );
    
};


}   //svk


#endif //SVK_MRS_IMAGE_DATA_H