cxUSFrameData.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.

Copyright (c) 2008-2014, SINTEF Department of Medical Technology
All rights reserved.

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

1. Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.

2. 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.

3. Neither the name of the copyright holder 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 HOLDER 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 CXUSFRAMEDATA_H_
#define CXUSFRAMEDATA_H_

#include "cxResourceExport.h"

#include "cxProbeSector.h"
#include "cxUSReconstructInputData.h"
typedef vtkSmartPointer<class vtkImageImport> vtkImageImportPtr;

namespace cx
{
typedef boost::shared_ptr<class ImageDataContainer> ImageDataContainerPtr;
typedef boost::shared_ptr<class CachedImageDataContainer> CachedImageDataContainerPtr;
}

namespace cx
{


typedef boost::shared_ptr<class USFrameData> USFrameDataPtr;
//typedef boost::shared_ptr<class TimedPosition> TimedPositionPtr;

class cxResource_EXPORT ProcessedUSInputData
{
public:
        ProcessedUSInputData(std::vector<vtkImageDataPtr> frames, std::vector<TimedPosition> pos, vtkImageDataPtr mask, QString path, QString uid);

        unsigned char* getFrame(unsigned int index) const;
        Eigen::Array3i getDimensions() const;
        Vector3D getSpacing() const;
        std::vector<TimedPosition> getFrames() const;
        vtkImageDataPtr getMask();

        QString getFilePath();
        QString getUid();
        bool validate() const;

private:
        std::vector<vtkImageDataPtr> mProcessedImage;
        std::vector<TimedPosition> mFrames;
        vtkImageDataPtr mMask;
        QString mPath;
        QString mUid;
};
typedef boost::shared_ptr<ProcessedUSInputData> ProcessedUSInputDataPtr;


class cxResource_EXPORT USFrameData
{
public:
        static USFrameDataPtr create(ImagePtr inputFrameData);
        static USFrameDataPtr create(QString inputFilename);
        static USFrameDataPtr create(QString name, cx::ImageDataContainerPtr images);
        static USFrameDataPtr create(QString name, std::vector<vtkImageDataPtr> frames);
        ~USFrameData();

        Eigen::Array3i getDimensions() const;
        Vector3D getSpacing() const;
        QString getName() const;
        cx::ImageDataContainerPtr getImageContainer() { return mImageContainer; }
        unsigned getNumImages();

        void resetRemovedFrames();
        void removeFrame(unsigned int index);
        void setCropBox(IntBoundingBox3D mCropbox);
        void fillImageImport(vtkImageImportPtr import, int index); 
        void setPurgeInputDataAfterInitialize(bool value);

        std::vector<std::vector<vtkImageDataPtr> > initializeFrames(std::vector<bool> angio);

        virtual USFrameDataPtr copy();
        void purgeAll();

        bool is4D();//Do this object contain 4D data? (Opposed to the usual 3D data)
        bool is8bit() const;

protected:
        USFrameData();
        vtkImageDataPtr useAngio(vtkImageDataPtr inData, vtkImageDataPtr grayFrame, int frameNum) const;

        vtkImageDataPtr cropImageExtent(vtkImageDataPtr input, IntBoundingBox3D cropbox) const;
        vtkImageDataPtr to8bitGrayscaleAndEffectuateCropping(vtkImageDataPtr input) const;

        std::vector<int> mReducedToFull; 
        IntBoundingBox3D mCropbox;

        QString mName;
        cx::ImageDataContainerPtr mImageContainer;
        bool mPurgeInput;
private:
        vtkImageDataPtr convertTo8bit(vtkImageDataPtr input) const;
};

}//namespace cx

#endif // CXUSFRAMEDATA_H_