svkDdfVolumeReader.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_DDF_VOLUME_READER_H
#define SVK_DDF_VOLUME_READER_H

#include <vtkImageData.h>
#include <vtkInformation.h>
#include <vtkDataObject.h>
#include <vtkPointData.h>
#include <vtkStringArray.h>

#include <svkImageReader2.h>
#include <svkMRSIOD.h>
#include <svkUtils.h>

#include <map>
#include <string>


namespace svk {


class svkDdfVolumeReader : public svkImageReader2 
{

    public:

        static svkDdfVolumeReader* New();
        vtkTypeMacro( svkDdfVolumeReader, svkImageReader2 );

        // Description: 
        // A descriptive name for this format
        virtual const char* GetDescriptiveName() {
            return "UCSF DDF Spectroscopy File";
        }

        virtual svkImageReader2::ReaderType GetReaderType()
        {
            return svkImageReader2::DDF;
        }

        //  Methods:
        virtual int     CanReadFile( const char* fname );


    protected:

        svkDdfVolumeReader();
        ~svkDdfVolumeReader();
  
        virtual int                              FillOutputPortInformation(int port, vtkInformation* info);
        virtual void                             ExecuteInformation();
        virtual void                             ExecuteDataWithInformation( vtkDataObject *output, vtkInformation* outInfo );
        virtual svkDcmHeader::DcmPixelDataFormat GetFileType();


    private:

        //  Methods:
        virtual void    InitDcmHeader();
        void            InitPatientModule();
        void            InitGeneralStudyModule();
        void            InitGeneralSeriesModule();
        void            InitGeneralEquipmentModule();
        void            InitMultiFrameFunctionalGroupsModule();
        void            InitMultiFrameDimensionModule();
        void            InitAcquisitionContextModule();
        void            InitMRSpectroscopyPulseSequenceModule();
        void            InitSharedFunctionalGroupMacros();
        void            InitPerFrameFunctionalGroupMacros();
        void            InitPixelMeasuresMacro();
        void            InitFrameContentMacro();
        void            InitPlanePositionMacro();
        void            InitPlaneOrientationMacro();
        void            InitMRSpectroscopyFrameTypeMacro();
        void            InitMRTimingAndRelatedParametersMacro();
        void            InitMRSpectroscopyFOVGeometryMacro();
        void            InitMREchoMacro();
        void            InitMRModifierMacro();
        void            InitMRReceiveCoilMacro();
        void            InitMRTransmitCoilMacro();
        void            InitMRAveragesMacro();
        void            InitMRSpatialSaturationMacro();
        void            InitMRSpatialVelocityEncodingMacro();
        void            InitMRSpectroscopyModule();
        void            InitVolumeLocalizationSeq();
        void            InitMRSpectroscopyDataModule();
        void            ReadComplexFile( vtkImageData* data );
        int             GetNumSlices();
        void            SetCellSpectrum( vtkImageData* data, int x, int y, int z, int timePt = 0, int coilNum = 0 );
        void            ParseDdf();
        void            PrintKeyValuePairs(); 
        int             GetHeaderValueAsInt(map <string, string> hdrMap, 
                            string keyString, int valueIndex = 0); 
        float           GetHeaderValueAsFloat(map <string, string> hdrMap, 
                            string keyString, int valueIndex = 0); 
        int             GetNumPixelsInVol(); 
        bool            IsMultiCoil(); 
        string  GetDimensionDomain( string ddfDomainString ); 


        //  Members:
        float*                                  specData; 
        int                                     numFrames;
        int                                     numSlices;
        int                                     numCoils;
        int                                     numTimePts;
        static const string                     MFG_STRING;
        double                                  dcos[3][3];
        svkDcmHeader::DcmDataOrderingDirection  dataSliceOrder;
        ifstream*                               ddfHdr;
        map <string, string>                    
                                                ddfMap; 
        vtkStringArray*                         tmpFileNames;
        svkMRSIOD*                              iod; 


};


}   //svk

#endif //SVK_DDF_VOLUME_READER_H