cxSyntheticVolume.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 SYNTHETIC_VOLUME_HPP
#define SYNTHETIC_VOLUME_HPP

#include "cxtestutilities_export.h"

#include "cxUSFrameData.h"
#include <vector>
#include <cstdlib>
#include <time.h>
#include "cxMathBase.h"


namespace cx {

class CXTESTUTILITIES_EXPORT cxSyntheticVolume {
public:

        cxSyntheticVolume(Vector3D bounds)
        {
                // Seed the random number generator
                srand(time(NULL));
                mBounds = bounds;
        }
        virtual ~cxSyntheticVolume() { };

        virtual Vector3D
        getBounds()
        {
                return mBounds;
        }

        virtual ProcessedUSInputDataPtr
        sampleUsData(const std::vector<Transform3D>& planes_rMf,
                     const Eigen::Array2f& pixelSpacing,
                     const Eigen::Array2i& sliceDimension,
                                 const Transform3D& output_dMr,
                     const double noiseSigma,
                     const unsigned char noiseMean) const;
        virtual ProcessedUSInputDataPtr
        sampleUsData(const std::vector<Transform3D>& planes_rMt,
                                 const ProbeDefinition& probe,
                                 const Transform3D& output_dMr,
                                 const double noiseSigma=0,
                                 const unsigned char noiseMean=0) const;
        vtkImageDataPtr
        sampleUsData(const Transform3D& plane_rMt,
                                 const ProbeDefinition& probe,
                                 const double noiseSigma=0,
                                 const unsigned char noiseMean=0) const;
        vtkImageDataPtr
        sampleUsData(const Transform3D& plane_rMf,
                                 const Eigen::Array2f& pixelSpacing,
                                 const Eigen::Array2i& sliceDimension,
                                 const double noiseSigma,
                                 const unsigned char noiseMean) const;

        virtual unsigned char evaluate(const Vector3D& p) const = 0;
        virtual void printInfo() const {}

        void fillVolume(cx::ImagePtr vol);
        virtual float computeRMSError(cx::ImagePtr vol);

protected:
        unsigned char constrainToUnsignedChar(const int val) const;
        vtkImageDataPtr createEmptyMask(const Eigen::Array2i& sliceDimension) const;

        Vector3D mBounds;

};

typedef boost::shared_ptr<cxSyntheticVolume> cxSyntheticVolumePtr;

CXTESTUTILITIES_EXPORT double calculateRMSError(vtkImageDataPtr a, vtkImageDataPtr b);
CXTESTUTILITIES_EXPORT cx::Vector3D calculateCentroid(cx::ImagePtr image);
CXTESTUTILITIES_EXPORT double calculateMass(cx::ImagePtr image);

}
#endif