svkBrukerDCMMRSReader.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_BRUKER_DCM_MRS_READER_H
#define SVK_BRUKER_DCM_MRS_READER_H

#include <svkDcmVolumeReader.h>


namespace svk {


class svkBrukerDCMMRSReader : public svkDcmVolumeReader 
{

    public:

        static svkBrukerDCMMRSReader* New();
        vtkTypeMacro( svkBrukerDCMMRSReader, svkDcmVolumeReader );


        // Description: 
        // A descriptive name for this format
        virtual const char* GetDescriptiveName() {
            return "Bruker DCM MRS File";
        }

        //  Enum reader type
        virtual svkImageReader2::ReaderType GetReaderType()
        {
            return svkImageReader2::BRUKER_MRS;
        }

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


    protected:

        svkBrukerDCMMRSReader();
        ~svkBrukerDCMMRSReader();

        virtual int                              FillOutputPortInformation(int port, vtkInformation* info);
        virtual svkDcmHeader::DcmPixelDataFormat GetFileType();
        virtual void                             InitDcmHeader(); 
        virtual bool                             CheckForMultiVolume(); 
        virtual void                             CleanAttributes( set < string >* uniqueSlices ); 

    private:

        void            InitMultiFrameFunctionalGroupsModule(); 
        void            InitSharedFunctionalGroupMacros();
        void            InitMRTimingAndRelatedParametersMacro(); 
        void            InitMREchoMacro(); 
        void            InitMRReceiveCoilMacro();
        void            InitMRAveragesMacro(); 
        void            InitMRSpectroscopyFOVGeometryMacro(); 
        void            InitMRSpectroscopyModule(); 
        void            InitMRSpectroscopyDataModule(); 
        void            InitPerFrameFunctionalGroupMacros(); 
        void            InitPixelMeasuresMacro(); 
        void            InitVolumeLocalizationSeq(); 
        void            InitMRSpatialSaturationMacro(); 
        void            InitSatBand( float satRAS[3], float translation, int satBandNumber ); 
        void            GetColsAndRows(int* numCols, int* numRows); 
        float           GetFieldStrength(); 


        virtual void    LoadData(svkImageData* data); 
        virtual void    InitPrivateHeader(); 
        void            SetCellSpectrum(
                            svkImageData* data, 
                            short* specData, 
                            int freqPt 
                        ); 

        int             numFreqPts;
        int             numTimePts;
        int             imageCols; 
        int             imageRows; 

};


}   //svk


#endif //SVK_BRUKER_DCM_MRS_READER_H