StepWedgeMesh.h

Go to the documentation of this file.

/*

Copyright (c) 2024-present, Prof Franck P. Vidal (franck.vidal@stfc.ac.uk), 
UK Research and Innovation, All rights reserved.
Copyright (c) 2024-present, Mr Nalin Gupta, UK Research and Innovation, 
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 Bangor University 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 __StepWedgeMesh_h
#define __StepWedgeMesh_h


//******************************************************************************
//  Include
//******************************************************************************
#ifndef __gVirtualXRayConfig_h
#include "gVirtualXRay/gVirtualXRayConfig.h"
#endif

#ifndef __PolygonMesh_h
#include "gVirtualXRay/PolygonMesh.h"
#endif

#ifndef __ConstantValues_h
#include "gVirtualXRay/ConstantValues.h"
#endif


//******************************************************************************
//  namespace
//******************************************************************************
namespace gVirtualXRay {


//==============================================================================
//==============================================================================
template<typename T> class StepWedgeMesh: public PolygonMesh
//------------------------------------------------------------------------------
{
//******************************************************************************
public:
    //--------------------------------------------------------------------------
    /*
    *  @param aNumberOfSteps:   the number of steps in the stepwedge (default value: 10)
    *  @param aTotalLength:  the length of the step wedge, i.e. its length along the X-axis (default value: 10)
    *  @param aWidth:   the width of the step wedge, i.e. its length along the Y-axis (default value: 1)
    *  @param aFirstStepHeight:  the height of the first step on the step wedge, i.e. its length along the Z-axis (default value: 1)
    *  @param anOtherStepHeight:  the height of the rest of the steps on the step wedge, i.e. its length along the Z-axis (default value: 0.1)
    */
    //--------------------------------------------------------------------------
    StepWedgeMesh(unsigned int aNumberOfSteps = 2,
        T aTotalLength = 10.0 * cm,
        T aWidth = 1.0 * cm,
        T aFirstStepHeight = 1.0 * cm,
        T anOtherStepHeight = 0.1 * cm,
        int anIndexDataType = 0);


    //--------------------------------------------------------------------------
    /*
    *  @param aNumberOfSteps:   the number of steps in the stepwedge (default value: 10)
    *  @param aTotalLength:  the length of the step wedge, i.e. its length along the X-axis (default value: 10)
    *  @param aWidth:   the width of the step wedge, i.e. its length along the Y-axis (default value: 1)
    *  @param aFirstStepHeight:  the height of the first step on the step wedge, i.e. its length along the Z-axis (default value: 1)
    *  @param anOtherStepHeight:  the height of the rest of the steps on the step wedge, i.e. its length along the Z-axis (default value: 0.1)
    */
    //--------------------------------------------------------------------------
    void create(unsigned int aNumberOfSteps = 2,
        T aTotalLength = 10.0 * cm,
        T aWidth = 1.0 * cm,
        T aFirstStepHeight = 1.0 * cm,
        T anOtherStepHeight = 0.1 * cm,
        int anIndexDataType = 0);
};


} // namespace gVirtualXRay


//******************************************************************************
#include "StepWedgeMesh.inl"


#endif // __StepWedgeMesh_h