cxProbeDefinition.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 CXPROBEDATA_H_
#define CXPROBEDATA_H_

#include "cxResourceExport.h"

#include <QSize>
#include <QMap>
#include <QVariant>
class QDomNode;
#include "cxVector3D.h"
#include "cxBoundingBox3D.h"

namespace cx
{

class cxResource_EXPORT ProbeDefinition
{
public: 
        enum TYPE { tNONE=0,   
                                tSECTOR=1, 
                                tLINEAR=2  
                                };

public:
        ProbeDefinition(TYPE type = tNONE);
        void addXml(QDomNode dataNode) const;
        void parseXml(QDomNode dataNode);

        TYPE getType() const;
        double getDepthStart() const;
        double getDepthEnd() const;
        double getWidth() const;
        double getTemporalCalibration() const;
        double getCenterOffset() const;
        void resample(QSize mSize); 
        QString getUid() const;

        void setTemporalCalibration(double value);
        void setType(TYPE type);
        void setSector(double depthStart, double depthEnd, double width, double centerOffset = 0);
        void setUid(QString uid);

        void updateClipRectFromSector();
        void updateSectorFromClipRect();
        void applySoundSpeedCompensationFactor(double factor);
    double getSoundSpeedCompensationFactor() const;

        Vector3D getOrigin_u() const; 
        DoubleBoundingBox3D getClipRect_u() const; 

        Vector3D getOrigin_p() const;
        Vector3D getSpacing() const;
        DoubleBoundingBox3D getClipRect_p() const;
        QSize getSize() const;

        void setOrigin_p(Vector3D origin_p);
        void setSpacing(Vector3D spacing);
        void setClipRect_p(DoubleBoundingBox3D clipRect_p);
        void setSize(QSize size);

        void setUseDigitalVideo(bool val); 
        bool getUseDigitalVideo() const;

        void setVariable(QString variableName, QVariant value);
        QVariant getVariable(QString variableName);

private:
        TYPE mType; 
        double mDepthStart; 
        double mDepthEnd; 
        double mWidth; 
        double mTemporalCalibration;
        double mCenterOffset; 
        double mSoundSpeedCompensationFactor; 
        QString mUid; 

        //ProbeImageData variables
        Vector3D mOrigin_p; 
        Vector3D mSpacing;//(_p)
        DoubleBoundingBox3D mClipRect_p; 
        QSize mSize;//_p
        bool mDigital; 

        //ProbeImageData
        Vector3D transform_p_to_u(const Vector3D& q_p) const;
        void addImageXml(QDomNode dataNode) const;
        void parseImageXml(QDomNode dataNode);

        QMap<QString, QVariant> mAdditionalVariables;
};

typedef boost::shared_ptr<ProbeDefinition> ProbeDefinitionPtr;

} // namespace cx

#endif /*CXPROBEDATA_H_*/