egs_circle_perpendicular.cpp

Go to the documentation of this file.

/*
###############################################################################
#
#  EGSnrc egs++ circle perpendicular shape
#  Copyright (C) 2015 National Research Council Canada
#
#  This file is part of EGSnrc.
#
#  EGSnrc is free software: you can redistribute it and/or modify it under
#  the terms of the GNU Affero General Public License as published by the
#  Free Software Foundation, either version 3 of the License, or (at your
#  option) any later version.
#
#  EGSnrc is distributed in the hope that it will be useful, but WITHOUT ANY
#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
#  FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for
#  more details.
#
#  You should have received a copy of the GNU Affero General Public License
#  along with EGSnrc. If not, see <http://www.gnu.org/licenses/>.
#
###############################################################################
#
#  Author:          Reid Townson, 2020
#
#  Contributors:
#
###############################################################################
*/
 
 
#include "egs_circle_perpendicular.h"
#include "egs_input.h"
#include "egs_functions.h"
 
static bool EGS_CIRCLE_PERPENDICULAR_LOCAL inputSet = false;
static shared_ptr<EGS_BlockInput> EGS_CIRCLE_PERPENDICULAR_LOCAL shapeBlockInput = make_shared<EGS_BlockInput>("shape");
 
extern "C" {
 
    static void setInputs() {
        inputSet = true;
 
        setShapeInputs(shapeBlockInput);
        shapeBlockInput->getSingleInput("library")->setValues({"egs_circle_perpendicular"});
 
        shapeBlockInput->addSingleInput("radius", false, "The radius of the circle.");
        shapeBlockInput->addSingleInput("midpoint", false, "The x, y midpoint of the circle, which is in the x-y plane located at z=0. Use an EGS_AffineTransform block to translate or rotate the shape.");
        shapeBlockInput->addSingleInput("inner radius", false, "The inner radius, to define a ring. Points will only be sampled within the ring between the 'inner radius' and 'radius'.");
    }
 
    EGS_CIRCLE_PERPENDICULAR_EXPORT string getExample() {
        string example {
            R"(
        #:start shape:
            library = egs_circle_perpendicular
            radius = the circle radius
            midpoint = Ox, Oy (optional)
            inner radius = the inner radius (optional)
        :stop shape:
)"};
        return example;
    }
 
    EGS_CIRCLE_PERPENDICULAR_EXPORT shared_ptr<EGS_BlockInput> getInputs() {
        if(!inputSet) {
            setInputs();
        }
        return shapeBlockInput;
    }
 
    EGS_CIRCLE_PERPENDICULAR_EXPORT EGS_BaseShape *createShape(EGS_Input *input,
            EGS_ObjectFactory *f) {
        if (!input) {
            egsWarning("createShape(circle): null input?\n");
            return 0;
        }
        EGS_Float radius;
        int err = input->getInput("radius",radius);
        if (err) {
            egsWarning("createShape(circle): no 'radius' input\n");
            return 0;
        }
        EGS_Float Ro;
        err = input->getInput("inner radius",Ro);
        if (err) {
            Ro = 0;
        }
        vector<EGS_Float> pos;
        err = input->getInput("midpoint",pos);
        if (err) {
            pos.clear();
            pos.push_back(0);
            pos.push_back(0);
        }
        else {
            if (pos.size() != 2) {
                egsWarning("createShape(circle): 2 instead of %d inputs expected"
                           " for keyword 'midpoint'. Reseting midpoint to (0,0)\n",
                           pos.size());
                pos.clear();
                pos.push_back(0);
                pos.push_back(0);
            }
        }
        EGS_CirclePerpendicularShape *shape = new EGS_CirclePerpendicularShape(pos[0],pos[1],radius,Ro,"",f);
        shape->setName(input);
        shape->setTransformation(input);
        return shape;
    }
 
}